Module:Taxobox fonctions/Documentation

Ce module fournit diverses fonctions de traitement de l'information d'une taxobox. Ce sont des fonctions annexes qui sont déportées ici afin d'alléger le code principal.

Utilisation

Fonctions exportables :
aucune (sous-module)

Fonctions utilitaires fournies pour le module principal :

• Gestion des données externes :
  • p.erreur_fatale(message, cat) : insert une erreur (message) avec l'éventuelle clé de catégorie d'erreur (cat), et indique au module principal que l'erreur est fatale
  • p.erreur_normale(message, cat) : comme la précédente sans l'erreur fatale
  • p.ajoute_categorie(cat) : insert une catégorie dans la liste des catégories à insérer
  • p.erreur_globale(def, cat) : retourne une boîte d'erreur contenant def et insert la catégorie cat si présente
• Gestion des boîtes d'information :
  • p.box_ouverture(titre) : ouvre une boîte d'information (utilisé hors espace encyclopédique pour présenter les erreurs, catégories, modifications de titre…)
  • p.box_fermeture() : ferme la boîte précédente
  • p.box_sous_titre(titre) : ajoute un sous-titre à la boîte précédente
  • p.box_texte(texte, cat) : ajoute le texte indiqué à la boîte précédente
• Gestion des éléments d'une taxobox :
  • p.tb_ligne_mixte_champs(texte) : insert la partie "champs" d'une ligne champs+valeur (utilisée par ligne_mixte())
  • p.tb_ligne_mixte_valeur(texte) : insert la partie "valeur" d'une ligne champs+valeur (utilisée par ligne_mixte())
  • p.tb_ligne_mixte(rang, nom) : insert une ligne champs+valeur
  • p.tb_bloc(texte) : insert un bloc (sous-titre)
  • p.tb_texte(texte) : insert une zone de texte
• Gestion du formatage des noms scientifiques :
  • p.italiques(regne, rang) : retourne vrai si le règne+rang doit être en italique
  • p.italiques_ns(nom, cible, regne, rang, lien) : retourne nom avec la mise en forme nécessaire (si besoin) en fonction du règne et du rang. lien indique qu'il faut retourner un wikilien. cible indique la cible du wikilien (ou nil).
  • p.italique_cultivar(nom) : retourne nom mis en italiques selon les conventions des cultivars
  • p.italiques_titre(titre, ns, rang) : retourne l'action à faire sur le titre de l'article (DISPLAYTITLE) à partir du titre de l'article (titre), du nom scientifique du taxon concerné (ns) et du rang de celui-ci (rang)
• Gestion des paramètres passés à la taxobox et autres outils :
  • p.genere_titre_taxobox() : détermine le titre de la taxobox à partir des entrées taxon présentes
  • p.lit_parametre(nom, valides, flag, fatal) : lit un paramètre nommé passé à la taxobox. nom est le nom du paramètre nommé, valides est une liste de textes (si différent de nil la valeur doit être dans cette liste), fatal vrai indique que l'absence de valeur est une erreur fatale, flag indique si vrai que le paramètre vaudra true quelque soit sa valeur ou false si absent
  • p.est_dans_liste(nom, liste) : indique si nom est présent dans liste
  • p.tri_parametres(conf) : parcours les paramètres non nommés pour créer donnees.defauts.commandes qui contient une ligne par « ligne de commande »
  • p.tri_taxons() : parcours les commandes trouvées par la fonction ci-dessus pour trouver les entrées taxon présentes. Note également le dernier, et cherche en même temps si l'un d'entre eux correspond au titre de l'article
  • p.existe(page) : retourne vrai si la page existe
• Outils pour la génération de la sortie :
  • p.insert_image(image, legende, complet) : insert l'image indiquée. La légende sert ici uniquement pour mettre un champs de description correct. complet indique que l'image est déjà sous la forme "Fichier:XXX", sinon suppose que c'est "XXX"
  • p.lien_en_minuscule(lien) : retourne le lien passé en passant la première lettre en minuscule (pour insertion dans un texte)
  • p.lecture_parametres(ligne, depart, desc) : analyse une ligne de commande (commande + ses paramètres) à partir de depart (entier) en suivant la description desc
• Functions servant à générer les différentes lignes fonctionnelles d'une taxobox. Tous sont équivalent au taxobox "nom" correspondant
  • p.cmd_debut(params) :
  • p.cmd_fin(params) :
  • p.cmd_phylo_bandeau(params) :
  • p.cmd_rang(params) :
  • p.cmd_taxon(params) :
  • p.cmd_uicn(params) :
  • p.cmd_cites(params) :
  • p.cmd_synonymes(params) :
  • p.cmd_taxons(params) :
  • p.cmd_phylo_inexistant(params) :
  • p.cmd_position(params) :