Utilisateur:Hexasoft/Test taxobox/Documentation/Présentation
Présentation rapide utilisateur des taxobox « module ».
Généralités[modifier | modifier le code]
Les modules ont fait leur apparition pour des raisons de performance et de puissance de traitement plus grande (et aussi de meilleur lisibilité, en tout cas pour un développeur).
Ils ont commencé à faire leur apparition dans les taxobox pour le traitement des noms scientifiques et des titres, de part la capacité de traitement des textes que permet ce langage.
Cette version des taxobox est intégralement écrite en Lua, ce qui augmente les fonctionnalités et l'efficacité mais implique également certains changements.
Les changements[modifier | modifier le code]
Le plus important je pense : la taxobox devient un modèle monolythique. Il n'existe qu'un seul modèle servant à créer tous les cas de figure. Toutefois ce modèle monolytique conserve toute la souplesse des modèles « en brique » car il propose une syntaxe similaire basée sur une suite d'éléments qu'on construit en les indiquant les uns à la suite des autres.
L'autre changement important est qu'aucun paramètre n'a plus besoin d'être répété plusieurs fois. C'est en particulier le cas du paramètre « règne » (maintenant « charte ») qui n'est donné qu'une fois en tant que paramètre nommé.
Il y a également quelques changements mineurs dans le fonctionnement :
- on ne donne plus le titre de la taxobox. Il est déterminé automatiquement par le module en fonction des "taxons" décrits
- la taxobox récupère un champs « nom vernaculaire » et gère l'éventuel sous-titre automatiquement si l'article est titré en nom scientifique
- la fin de la taxobox devient optionnel (dans un modèle monolytique on sait quand on a terminé)
Fonctionnalités[modifier | modifier le code]
Le passage aux modules permet divers traitement additionnels − certains sans effets visibles − qui pour la plupart semblent intéressants.
Voici une liste des fonctionnalités de la taxobox-module :
- sélection automatique du titre de la taxobox : le module considère que c'est la dernière entrée "taxon" qui correspond au titre (taxon le plus précis). Sa typographie est respectée
- gestion « évoluée » de la mise en italique du titre : détection des homonymies, détection d'un titre correspondant à un taxon intermédiaire, respect des conventions typographiques pour la mise en italique, gestion de diverses exceptions et cas particuliers…
- gestion des sous-titres : sous-titre vernaculaire si présent et si titré en scientifique ; sous-titre nom scientifique si titré en nom vernaculaire
- gestion des erreurs :
- si une erreur fatale se produit (règne invalide, taxon absent, structure impossible…) une box d'erreur est affichée à la place de la taxobox, avec un message décrivant l'erreur rencontrée (+ ajout d'une catégorie d'erreur)
- si des erreurs de structuration du contenu se produisent (rang en dehors des zones correspondantes, entrées taxon non consécutives, paramètre d'une ligne invalide…) une erreur est générée avec un message explicatif (+ catégorie). Selon les options et le namespace cette erreur se résume à une catégorie (dans les articles) ou celle-ci est affichée dans une boîte distincte sous la taxobox, reprenant la description claire de chaque erreur.
- gestion des catégories : il est possible de désactiver l'insertion des catégories (d'information et d'erreur) ou bien de les faire afficher dans une boîte séparée après la taxobox
- sécurité de la structure : même si le contenu structurel de la taxobox est faux le module prend soin de mettre tout « au propre » avant de terminer la taxobox (fermeture de tables restées ouvertes par exemple) (+ génération d'une erreur, bien sûr)
- vérifications de cohérence : le module vérifie certains points de cohérence dans l'enchainement des éléments de la taxobox (éléments "taxon" successifs, éléments "rang" au bon endroit, correspondance titre/taxons, …) et génère des erreurs pour informer de ces cas
- tous les éléments spécifiques (titre, sous-titre, catégories, catégories d'erreurs, messages d'erreurs) peuvent être contrôlés : absent, présent, automatique, et pour les catégories et messages possibilité de demander leur affichage dans une boîte séparée (pour test, debug…)
Ce qui change avec les taxobox modulaires[modifier | modifier le code]
Les différences précises par rapport aux taxobox modulaires :
- un seul modèle pour toute la taxobox
- le règne est le seul paramètre nommé (obligatoire)
- les « lignes » de taxobox sont des paramètres non nommés de la forme :
| mot-clé | param1 | param2 | …. Les mot-clés sont les mêmes que les noms des modèles des taxobox, sans le "taxobox". Exemple : taxobox taxon → taxon, taxobox UICN → UICN, … Seule exception : taxobox devient rang. - les paramètres des lignes qui sont des "présent ou absent" changent de syntaxe, il suffit d'indiquer le mot-clé. Exemple : le paramètre "obsolète=oui" de Taxobox taxon devient simplement
|obsolète - les paramètres nommés des lignes n'ont plus de "=" mais deviennent
|paramètre|valeur. Exemple : le paramètre "classification" de Taxobox début devient|classification|reptiledb - chaque ligne se termine lorsqu'un retour à la ligne est rencontré (note : ceci va peut-être changer)
Comparaison[modifier | modifier le code]
Voici sur deux colonnes le code modulaire d'un coté et le code monolytique de l'autre :
| code monolytique | code modulaire | ||
{{user:Hexasoft/Taxobox2 | règne=animal
|début | image.jpg | légende | 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 }}
|
{{Taxobox début | animal | ''Uroplatus guentheri'' | image.jpg | légende | classification=reptileDB }}
{{Taxobox | embranchement | Chordata }}
{{Taxobox | classe | Reptilia }}
{{Taxobox | sous-classe | Lepidosauria }}
{{Taxobox | ordre | Squamata }}
{{Taxobox | sous-ordre | Sauria }}
{{Taxobox | infra-ordre | Gekkota }}
{{Taxobox | famille | Gekkonidae }}
{{Taxobox | genre | Uroplatus }}
{{Taxobox taxon | animal | espèce | Uroplatus guentheri | [[François Mocquard|Mocquard]], [[1908]] }}
{{Taxobox UICN | EN | B1ab(iii) }}
{{Taxobox CITES | II | 12/01/05 }}
{{Taxobox fin}}
|
| Règne | Animalia |
|---|---|
| Embranchement | Chordata |
| Classe | Reptilia |
| Sous-classe | Lepidosauria |
| Ordre | Squamata |
| Sous-ordre | Sauria |
| Infra-ordre | Gekkota |
| Famille | Gekkonidae |
| Genre | Uroplatus |
EN B1ab(iii) : En danger
Statut CITES
Annexe II , Rév. du 12/01/05
|
Uroplatus guentheri Uroplatus guentheri mâle
Uroplatus guentheri
Statut CITES
Sous-titre Uroplatus guentheri |