Utilisateur:Hexasoft/Test taxobox/Documentation/Syntaxe

La syntaxe du modèle se décompose en deux parties :

les paramètres nommés
les « commandes » (qui correspondent aux différents éléments des taxobox), qui sont des paramètres non nommés

Les paramètres nommés

Il n'y en a qu'un qui est obligatoire : charte=<nom de la charte graphique>
Ceci sélectionne la charte utilisée dans la taxobox : le jeu de couleurs ainsi que la convention typographique suivie. Cela sélectionne également les catégories techniques qui sont insérées.

Un autre paramètre nommé est : nom vernaculaire. S'il est fournit le module l'utilisera le cas échéant pour compléter le sous-titre de l'article (s'il est titré avec le nom scientifique).

Il existe également plusieurs autres paramètres nommés qui servent à contrôler le comportement des taxobox :

force titre : indique à la taxobox de considérer que le titre de l'article est la valeur indiquée. À n'utiliser qu'à des fins de test
titre : contrôle la modification typographique du titre (oui, non, boîte, auto)
sous titre : contrôle l'insertion du sous-titre (oui, non, boîte, auto)
erreurs : contrôle l'insertion d'une boîte décrivant les erreurs éventuelles (oui, non, auto)
catégories : contrôle l'insertion des catégories techniques (en ligne, non, boîte, auto)
catégorie erreurs : contrôle l'insertion des catégories d'erreur d'utilisation (en ligne, non, boîte, auto)

Pour ces différentes options de contrôle le sens des paramètres est :

non : ne pas insérer/modifier l'élément
oui : toujours insérer/modifier l'élément
boîte : toujours insérer sous forme d'une boîte (sous la taxobox) l'élément
en ligne : comme oui pour les catégories (c'est-à-dire les mettre en tant que catégorie)
auto : comportement par défaut, qui dépend de l'espace de l'article. Pour les catégories : insertion en ligne si espace encyclopédique, en boîte sinon. Pour les erreurs : non si espace encyclopédique, en boîte sinon. Pour titre et sous-titre : oui si espace encyclopédique, boîte sinon.

Il existe de plus les paramètres nommés raw et debug, à n'utiliser que lorsqu'on analyse le fonctionnement du code interne.

Les commandes

Les commandes reprennent quasiment la syntaxe des différents éléments des taxobox. Voici les éléments et leur syntaxe :

début : équivalent à taxobox début
- syntaxe : | début | nom image | légende | classification | nom classification | phylo | cacher règne
- nom image : le nom de l'image à insérer
- légende : la légende associée
- classification + valeur suivante : le nom de la classification suivie
- phylo : si présent indique que ce taxon n'existe qu'en classification phylogénique (pas d'insertion des lignes de classification initiales, insertion d'un message spécifique)
- cacher règne : ne pas insérer les premières lignes de classification automatiquement insérée en début de classification, selon la charte choisie
fin : termine la taxobox. Cet élément est optionnel.
- syntaxe : aucun paramètre
rang : insert un élément de classification.
- syntaxe : | rang | rang de l'élément | nom | cible | ancien | lien | cible du lien
- rang de l'élément : le rang taxinomique de l'élément
- nom : le nom (scientifique) de l'élément
- cible : optionnel. Si présent le lien sera [[lien|cible]]
- ancien : optionnel. Non implémenté pour le moment
- lien : optionnel. Si présent le lien généré sera cible du lien sans tenir compte de nom et de cible
taxon : insert la description du taxon décrit dans la taxobox
- syntaxe : | taxon | rang | nom | auteur | obsolète | nom obsolète | sans auteur | titre
- rang : le rang du taxon décrit
- nom : le nom du taxon décrit
- auteur : l'auteur + date du taxon
- sans auteur : optionnel. Si présent l'absence d'auteur ne génère pas l'insertion du message "auteur manquant" (et l'insertion dans une catégorie spécifique)
- obsolète : optionnel. Si présent indique que le nom du taxon est considéré comme obsolète. La valeur nom obsolète est considérée comme le nouveau nom, inséré après le précédent (qui est affiché barré)
- titre : optionnel. Non implémenté pour le moment
UICN : insert une description du statut UICN
- syntaxe : | UICN | risque | critère | lien
- risque : le risque UICN (EX, VU, EN…)
- critère : optionnel. Le critère de ce risque selon UICN
- lien : non implémenté pour le moment
CITES : insert une description du statut CITES
- syntaxe : | CITES | annexe | date | précision


synonymes : insert une liste de synonymes du taxon.
syntaxe : | synonymes | liste des synonymes
liste des synonymes : la liste des synonymes à insérer. C'est en général une liste à puce
phylogénie bandeau : insert l'entête de début de classification phylogénique
syntaxe : | phylogénie bandeau | image | classification | nom classification
image : optionnel. Une image de la classification à insérer
classification : optionnel. Si présent nom classification est utilisée dans le bandeau de titre
phylogénie inexistant : insert un entête indiquant que ce taxon n'existe pas dans la classification phylogénique
syntaxe : | phylogénie inexistant | classification | nom classification
classification : optionnel. Permet de préciser le nom de la classification dans le bandeau de titre
séparateur : insert un séparateur (une fine ligne horizontale)
syntaxe : aucun paramètre
parents : insert les parents d'un hybride.
syntaxe : "| parents | sexe1 | taxon1 | sexe2 | taxon2
sexe1 : le sexe du premier parent (mâle/femelle). Si indifférent utilisez A (valeur par défaut si ce paramètre est vide)
nom1 : le nom du premier parent (mettre un wikilien si nécessaire)
sexe2 : le sexe du second parent (mâle/femelle). Si indifférent utilisez B (valeur par défaut si ce paramètre est vide)
nom2 : le nom du second parent (mettre un wikilien si nécessaire)
image et répartition image : ces deux éléments permettent d'insérer une image et ont la même syntaxe
syntaxe : | image | nom image | légende | séparateur
nom image : le nom de l'image à insérer
légende : optionnel. La légende de l'image
séparateur : optionnel. Si présent un séparateur est inséré avant l'image
légende : insert une légende. Utilisé pour insérer une légende additionnelle
syntaxe : | légende | contenu
contenu : la légende à insérer
répartition légende : insert une légende pour carte de répartition
syntaxe : | répartition légende | légende | couleur | couleur2
légende : la légende à insérer
couleur : la couleur (dans un rectangle avant la légende)
couleur2 : optionnel. La couleur des hachures (dans un rectangle avant la légende)
taxons : liste des taxons de rang inférieur
syntaxe : | taxons | texte | texte2
texte : la liste des taxons de rang inférieur, en général une liste à puce
texte2 : optionnel. Permet d'indiquer le nom du rang des taxons inférieurs. Modifie le titre de la zone de "Taxons de rang inférieur" en "XXX de rang inférieur" (exemple : "Espèces")
conflit : même rôle que rang mais permet d'indiquer plusieurs noms pour un même rang, ainsi que selon quelle référence (pour chaque nom)
syntaxe : | conflit | rang | nom1 | site1 | nom2 | site2 | nom3 | site3
rang : le rang du taxon
nom1 : le premier nom du taxon
site1 : le ou les éléments de référence utilisant ce nom. Il s'agit d'une liste de codes séparés par des espaces, des virgules ou des "&". Chacun est inséré. Si un élément n'existe pas il est inséré tel quel et une erreur est ajoutée
nom2 / site2 ; nom3 / site3 : même rôle que ci-dessus
position : insert la position phylogénique du taxon
syntaxe : | position | arbre | frère
arbre : un texte décrivant la classification phylogénique
frère : optionnel. Le nom du taxon frère du taxon décrit

Exemple


    
modifier

Une taxobox correspondant à l'article Uroplatus guentheri :

{{user:Hexasoft/Taxobox2
|charte=animal
|nom vernaculaire=Gecko à large queue de Günther
|début | Uroplatus guentheri male.jpg | ''Uroplatus guentheri'' mâle | classification|reptileDB
|rang | embranchement | Chordata
|rang | classe | Reptilia
|rang | sous-classe | Lepidosauria
|rang | ordre | Squamata
|rang | sous-ordre | Sauria
|rang | infra-ordre | Gekkota
|rang | famille | Gekkonidae
|rang | genre | Uroplatus
|taxon | espèce | Uroplatus guentheri | [[François Mocquard|Mocquard]], [[1908]]
|uicn | EN | B1ab(iii) 
|cites | II | 12/01/05
|fin
}}