Package Metadata/fr

Introduction
A partir de la version 0.20 de FreeCAD, les add-ons externes (ateliers, macros, et kits de préférences) peuvent être distribués avec un fichier de métadonnées décrivant le contenu du package. Si le fichier "package.xml" est présent, il est lu par FreeCAD et son contenu est utilisé dans diverses parties de l'interface utilisateur. Il est actuellement facultatif pour les blocs de travail et les macros, et obligatoire pour les packs de préférences. Cette page documente le format de ce fichier de métadonnées. Le format (et le contenu de cette page Wiki) est basé sur REP 149.

Format général du fichier
Ce document décrit actuellement la version 1 du format de fichier.

Le fichier de métadonnées doit être un document XML 1.0 valide et bien formé. Il doit s'appeler "package.xml", et doit exister dans le répertoire de base de la branche principale du logiciel (comme spécifié par le fichier .gitmodules des addons de FreeCAD) dans son dépôt git. Seul le fichier package.xml de la branche principale est pris en compte par le gestionnaire d'addons. Toutes les balises XML comprises sont en minuscules, mais les balises non reconnues ne sont pas une erreur. La plupart des balises sont facultatives, et certaines ne s'appliquent qu'à certains types de contenu de paquet (par exemple, seuls les ateliers fournissent actuellement un élément "classname"). Les éléments inutiles ou non reconnus sont ignorés.

Tout chemin de fichier spécifié dans package.xml doit utiliser la barre oblique ("/") comme séparateur de répertoire : sur les systèmes qui attendent un séparateur différent pendant l'exécution (par exemple Windows) FreeCAD convertira automatiquement vers le séparateur correct.

Le seul élément de haut niveau autorisé est, et le fichier ne peut contenir qu'un seul élément. Immédiatement subordonnés à celui-ci se trouvent plusieurs éléments obligatoires ou facultatifs, définis ici. Aucune autre balise n'est autorisée directement sous l'élément.



La balise est la balise unique de premier niveau dans un fichier package.xml. Toutes les autres balises sont imbriquées sous elle.

Attributs

 * format="NUMERO" : Spécifier le format package.xml utilisé. Pour cette interface, vous devez spécifier format="1".
 * xmlns="NAMESPACE" : Spécifie l'espace de noms XML pour ce paquet, et doit être inclus exactement comme indiqué ci-dessus, comme un lien vers https://wiki.freecad.org/Package_Metadata.

Balises enfant requises
L'élément de niveau supérieur doit contenir au moins les balises suivantes :


 * 
 * 
 * 
 * 
 * (plusieurs, mais au moins un)
 * (multiple, mais au moins un) (plusieurs, mais au moins un)
 * (multiple, mais au moins un)
 * (élément conteneur pour les éléments de contenu du paquet)

Balises enfant facultatives

 * (multiple)
 * (multiple)
 * (multiple)
 * (multiple)
 * (multiple)
 * (multiple)
 * 
 * 

OBLIGATOIRE

Le nom de ce paquet. Ne doit contenir que des caractères valides pour les noms de fichiers (les caractères non autorisés sont /\?%*:|"<> ).

OBLIGATOIRE

Un numéro de version qui suit soit la norme de versionnement sémantique 2.0 (par exemple 1.0.2-beta), soit le style CalVer (par exemple 2021.12.08). Notez que vous ne pouvez pas inclure les deux types, et que le passage d'un type à l'autre n'est pas pris en charge. En interne, le code n'a aucune notion du type choisi, lors de la comparaison des versions, il effectue une simple comparaison numérique entre chaque composant numérique successif, quel que soit le type. Notez que ce champ ne peut pas être laissé vide, un numéro de version doit être attribué. Lorsque le gestionnaire d'addons détecte une augmentation du numéro de version, il affiche l'information "mise à jour disponible" aux utilisateurs.

OBLIGATOIRE

La date de la version en cours, au format AAAA-MM-JJ ou AAA.MM.JJ.

OBLIGATOIRE

Une description textuelle concise (plusieurs phrases maximum) de ce paquet. Aucun balisage n'est pris en charge.

AU MOINS UN OBLIGATOIRE (plusieurs autorisés)

Le nom de la personne qui maintient le paquet. Tous les paquets nécessitent un mainteneur. Pour les paquets orphelins, voir ci-dessous.

Attributs

 * email="name@domain.tld" (obligatoire) : Adresse électronique du responsable.

Un paquet orphelin est un paquet qui n'a pas de mainteneur attitré. Les paquets orphelins doivent utiliser les informations suivantes sur le mainteneur :

No current maintainer

AU MOINS UN OBLIGATOIRE (plusieurs autorisés)

Nom de la licence pour ce paquet, par exemple BSD, GPL, LGPL. Afin de faciliter la lecture par les machines, n'incluez que le nom de la licence dans cette balise. Pour les licences multiples, plusieurs balises distinctes doivent être utilisées. Un paquet aura plusieurs licences si les différents fichiers sources ont des licences différentes. Chaque licence apparaissant dans les fichiers sources doit avoir une balise correspondante. Pour tout texte explicatif sur les mises en garde relatives aux licences, veuillez utiliser la balise.

Les licences de logiciels libres les plus courantes sont décrites sur le site web de l'OSI.

Les licences les plus utilisées :
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)
 * (Public Domain dedication)

Attributs

 * (facultatif) : Un chemin relatif au fichier contenant le texte complet de la licence. De nombreuses licences exigent l'inclusion du texte de la licence lors de la redistribution du logiciel. Par exemple, la licence Apache, version 2.0, stipule au paragraphe 4.1 : "Vous devez remettre à tout autre destinataire de l'œuvre ou des œuvres dérivées une copie de la présente licence".

OBLIGATOIRE

La balise décrit le contenu réel du paquet. Elle n'a pas d'attributs, et contient un nombre quelconque d'enfants. Ces enfants peuvent avoir des noms de balises arbitraires, dont seuls certains peuvent être reconnus par FreeCAD. FreeCAD supporte actuellement les éléments "workbench", "macro", et "preferencepack". Chaque enfant est ensuite défini récursivement par cette norme, contenant n'importe quel ou tous les éléments autorisés pour le noeud racine. Par exemple :

Unicorn Sparkles Theme 1.0.0    https://github.com/chennes/FreeCAD-themes/blob/main/Unicorn%20Sparkles%20Theme/Readme.md     sparkles.svg

L'existence d'éléments implique un ensemble de sous-dossiers, un pour chaque élément de contenu, nommé exactement comme le nom donné à l'élément. Ainsi, pour l'exemple ci-dessus, la structure des dossiers du paquet est la suivante :

Package Directory/ package.xml Unicorn Sparkles Theme/ Unicorn Sparkles Theme.cfg sparkles.svg (the theme's other files)

Outre les autres éléments de, les éléments de contenu peuvent éventuellement fournir des informations dans les balises , et (techniquement, celles-ci peuvent également être fournies à la balise racine , mais elles y sont généralement inutilisées).

Note de rétrocompatibilité : pour éviter de devoir restructurer les paquets antérieurs à cette norme de métadonnées, la balise facultative  est autorisée à spécifier "./" comme sous-répertoire pour un élément de contenu, auquel cas aucun sous-répertoire n'est nécessaire. Cela correspond au système pré-standard où un seul poste de travail était situé au sommet de la structure des répertoires.

OBLIGATOIRE pour les ateliers

Le chemin d'accès à un fichier d'icône. S'il s'agit d'une icône pour le paquet de premier niveau, ce chemin est relatif au fichier package.xml lui-même. Si l'icône est un élément d'un élément, le chemin est relatif au dossier du contenu. Le gestionnaire d'addons affichera l'icône de niveau supérieur comme l'icône du paquetage global. Si aucune icône de niveau supérieur n'est présente, la première icône de banc de travail spécifiée sera utilisée comme icône du paquet.

Optionnel.

Normalement, un élément de contenu est supposé se trouver dans un sous-répertoire portant le même nom que l'élément. Dans certains cas, cependant, il est utile de spécifier explicitement le sous-répertoire. Par exemple, de nombreuses macros peuvent se trouver dans un seul sous-répertoire, mais chacune a sa propre entrée dans le fichier package.xml. Cela fournit également un support de rétrocompatibilité pour les paquets antérieurs à la spécification du format de fichier package.xml, et qui ne suivent pas la structure de sous-répertoire attendue. Souvent, dans ces cas, un " ./ " est utilisé pour indiquer que l'élément n'est pas situé dans un sous-répertoire du tout.

OBLIGATOIRE pour les ateliers

Pour les ateliers, le nom de la classe d'entrée principale en Python. C'est la classe que FreeCAD essaiera de charger au démarrage pour localiser l'icône de l'atelier, qui doit être définie comme une variable membre de la classe. Par exemple, si votre atelier définit la classe suivante (généralement dans InitGui.py) :

alors le fichier package.xml attend :

MyNewWB

Optionnel.

Fournis pour la convivialité d'autres outils, un certain nombre d'autres fichiers peuvent être répertoriés ici. Leur utilisation dépend du type de contenu. Dans un élément de contenu macro, chaque entrée de fichier est une macro unique et sera liée au répertoire d'installation Macros de l'utilisateur par le Gestionnaire d'Addon.

Plusieurs autorisés : Le type "repository" est obligatoire, et le type "readme" est fortement recommandé.

Un URL (Uniform Resource Locator) pour le site web du paquet, le système de suivi des bogues, le dépôt des sources, le lien de téléchargement du zip, le fichier readme ou la documentation (comme spécifié par l'attribut "type", voir ci-dessous).

Lorsque vous spécifiez le type "readme", un lien direct vers une version restituée du fichier README doit être fourni. Par exemple, sur GitHub, il s'agit d'un lien de type "blob" tel que "https://github.com/FreeCAD/FreeCAD-addons/blob/master/README.md", ou sur une instance GitLab, "https://gitlab.com/opensimproject/cfdof/-/blob/master/README.md" (notez le format d'URL légèrement différent entre les deux).

C'est une bonne idée d'inclure des balises pointant les utilisateurs vers les ressources en ligne de votre paquet. Il s'agit généralement d'une page wiki de wiki.freecad.org où les utilisateurs peuvent trouver et mettre à jour des informations sur le paquet, par exemple. Le gestionnaire d'addons répertorie ces URL et fournit des liens cliquables vers celles-ci dans la description du paquet.

Attributs

 * type="TYPE" (obligatoire) : Le type doit être l'un des identifiants suivants : "website", "bugtracker", "repository", "readme" ou "documentation".
 * branch="BRANCH" (obligatoire pour type="repository") : Le nom de la branche à extraire pour obtenir ce paquet. Il s'agit généralement du nom de votre branche de développement principale. Peut également spécifier tout autre type de référence git, par exemple une balise ou un commit spécifique.

Multiple autorisé

Le nom d'une personne qui est un auteur du paquet, comme reconnaissance de son travail et pour les questions.

Attributs

 * email="name@domain.tld" (facultatif) : Adresse électronique de l'auteur.

Multiple autorisé

Déclare une dépendance sur un autre addon de FreeCAD ou un atelier interne, ou un module en Python. La dépendance nommée est d'abord vérifiée par rapport à la liste des modules complémentaires connus (par exemple ceux disponibles soit dans le dépôt git officiel des modules complémentaires de FreeCAD, soit dans un dépôt personnalisé spécifié par l'utilisateur). La vérification porte sur le nom canonique de l'addon. Si un fichier package.xml est présent pour cet addon, le nom est l'élément de ce package. Une correspondance exacte est requise. Si aucune correspondance n'est trouvée, le nom est comparé à la liste des ateliers internes connus (installés et désinstallés). Enfin, si la dépendance nommée n'a pas été localisée lors des deux étapes précédentes, elle est supposée être une dépendance du module en Python. Notez que toutes les fonctionnalités liées aux dépendances ne sont pas encore complètement implémentées.

Attributs
Toutes les dépendances et relations peuvent restreindre leur applicabilité à des versions particulières. Un attribut peut être utilisé pour chaque opérateur de comparaison. Deux de ces attributs peuvent être utilisés ensemble pour décrire une gamme de versions.


 * version_lt="VERSION" (facultatif) : La dépendance au paquet est limitée aux versions inférieures au numéro de version indiqué.
 * version_lte="VERSION" (facultatif) : La dépendance au paquet est limitée aux versions inférieures ou égales au numéro de version indiqué.
 * version_eq="VERSION" (facultatif) : La dépendance au paquet est restreinte à une version égale au numéro de version indiqué.
 * version_gte="VERSION" (facultatif) : La dépendance au paquet est limitée aux versions supérieures ou égales au numéro de version indiqué.
 * version_gt="VERSION" (facultatif) : La dépendance au paquet est limitée aux versions supérieures au numéro de version indiqué.
 * condition="CONDITION_EXPRESSION" : Chaque dépendance peut être conditionnée par une expression de condition. Si l'expression de condition vaut "true", la dépendance est utilisée et considérée comme si elle n'avait pas d'attribut de condition. Si l'expression conditionnelle vaut "false", la dépendance est ignorée et considérée comme si elle n'existait pas. L'expression doit être une expression FreeCAD valide (i.e. syntaxe en Python), et peut faire référence aux variables "$BuildVersionMajor", "$BuildVersionMinor", et "$BuildRevision" représentant la version de FreeCAD en cours d'exécution.

Multiple autorisé

Déclare un nom de paquet avec lequel ce paquet est en conflit. Ce paquet et le paquet en conflit ne doivent pas être installés en même temps.

Attributs
Voir.

Multiple autorisé

Déclare un nom de paquet que ce paquet est destiné à remplacer.

Attributs
Voir.

Une simple balise texte utilisée pour la catégorisation lors de l'utilisation d'un gestionnaire de paquets. Plusieurs éléments peuvent être spécifiés.

La version minimale de FreeCAD requise pour utiliser ce paquetage/élément, sous la forme d'une chaîne sémantique version 2.0 au format MAJOR.MINOR.BUILD

La version maximale de FreeCAD requise pour utiliser le paquetage/élément, sous la forme d'une chaîne sémantique de la version 2.0 au format MAJOR.MINOR.BUILD.

Validation
Pour valider votre fichier package.xml, vous pouvez activer le "mode développeur" dans le gestionnaire d'addons : créez une variable booléenne appelée "developerMode" dans le groupe de paramètres "Addons" et définissez-la sur True :. Lorsque le gestionnaire d'addons a fini de lire la base de données des addons, il examine tous les fichiers package.xml disponibles à la recherche d'erreurs.

Exemples
Notez que les commentaires (le texte entre et ) sont ignorés par l'analyseur XML et ne sont pas une partie obligatoire du format de fichier. Ils sont fournis ici à titre d'information et peuvent être omis du package.xml final si vous le souhaitez.

Un paquet simple réservé à l'atelier (par exemple, pour ajouter un fichier de métadonnées à un paquet antérieur à ce format de métadonnées) :

  Legacy Workbench Text that the Addon Manager shows for the Addon. Any length, but remember that Addon Manager's compact view only shows the first sentence or so. 1.0.1  2022-01-07   Your Name LGPL-2.1 https://github.com/chennes/FreeCAD-Package https://github.com/chennes/FreeCAD-Package/blob/main/README.md  Resources/icons/PackageIcon.svg

MyLegacyWorkbench ./

Un paquet complexe, à plusieurs composantes :

  Example Package Format An example of the package.xml file format 2022.01  2022-01-07   No Maintainer GPL-3 https://github.com/chennes/FreeCAD-Package PackageIcon.svg

FreeCAD Classic Colors FreeCAD default colors for core app and included Mods. 1.0.0      color stylesheet Metadata Creation Workbench A set of tools to assist in creation of package.xml metadata files MetadataCreationWorkbench MCW Resources/mcw.svg developers 0.9.0-alpha Problem Solver 9000 Deletes all emails in your inbox ./      PS9000.FCMacro

Un paquet avec des dépendances :

  Example with Dependencies An example of the package.xml file format 1.0.1-beta3 2022-01-07  No Maintainer GPL-3 <url type="repository" branch="main">https://github.com/chennes/FreeCAD-Package PackageIcon.svg

Metadata Creation Workbench A set of tools to assist in creation of package.xml metadata files MetadataCreationWorkbench MCW Resources/mcw.svg developers

FEM <depend version_gte="0.3.0">Curves workbench <depend version_gte="3.3" version_lt="4">Steel column

<depend optional="true" type="python">markdown TabBar

Metadata Creation Workbench Beta

<conflict condition="$BuildRevision==24267">Do not use with build 24267

matplotlib some_other_package