Module:Palette de navigation/Documentation

De Baripedia

Ce module implémente le modèle {{Utilisateur:Hlm Z./Palette de navigation}}. Voir la page du modèle pour les instructions d'utilisation.

Utilisation[modifier le wikicode]

Fonction exportable :

  • palette(frame) – Fonction principal du module renvoyant le code HTML de la palette de navigation.

Autres fonctions :

  • arg() – Fonction permettant la détection des paramètres vides interprétés par Lua.
  • erreur() – Fonction de mise en forme retournant un message d'erreur en rouge visible par l'utilisateur.
  • entete() – Fonction retournant l'entête de la palette (titre de la palette, état de la palette et bouton modifier).
  • style() – Fonction permettant d'ajouter un style en fin de balise HTML.
  • banniere(etat) – Fonction retournant les dessus/dessous de la palette. L'argument etat permet de choisir entre dessus (1) et dessous (2).
  • contenu() – Fonction retournant le corps de la palette (ligne ou section).
  • ligne(prefixe, n) – Fonction retournant la ligne de la palette (liste, groupe et sous-groupe). Cette méthode permet également les sous-groupes récursifs.
  • _liste(liste, n, bool) – Fonction retournant les listes simples pairs ou impairs. L'argument bool permet de désactiver les listes pairs (pour les sections notamment).
  • _groupe(groupe, liste, n) – Fonction retournant les groupes avec listes pairs ou impairs.
  • formatageLigne(liste) – Fonction de formatage renvoyant les lignes des palettes wikifiées.
  • _section(prefixe, n) – Fonction retournant les sections déroulantes de la palette (liste, sous-groupe et sous-liste). Cette méthode permet les sous-groupes grâce à l'appel de la méthode ligne(prefixe, n).

Exemples[modifier le wikicode]

Pour des exemples, voir la page de test permettant de tester diverses modifications apportées.