Documentation

Utilisation

modifier

Permet de représenter un modèle dans un tableau parmi une série. Affiche un lien vers le modèle représenté et récupère sa description si ce dernier a été adapté, comme indiqué ci-dessous.

Remarques

modifier

Dans le modèle représenté, le texte descriptif est encadré par le balisage <section begin=description /> ... texte à transclure ... <section end=description />. Ainsi extrait, le texte balisé doit convenir (se suffire à lui même) à cette liste de résumés ; à savoir qu'il devrait commencer sans majuscule et se finir par un point.

Ce modèle utilise {{#lst:Modèle:nom-du-modèle|description}} pour copier (transclure) la description du modèle concerné.

Syntaxe

modifier

{{descriptif|modèle|séparateur|page=}}

Paramètres

modifier

Permet de représenter un modèle dans un tableau parmi une série. Affiche un lien vers le modèle représenté et récupère sa description si ce dernier a été adapté

Paramètres du modèle[Modifier les données du modèle]

La mise en forme sur une seule ligne est préférée pour ce modèle.

ParamètreDescriptionTypeÉtat
Modèle1

Nom du modèle à récupérer la description

Exemple
Alinéa
Chaîneobligatoire
Séparateur2

Défini la mise en forme en tableau

Exemple
début, fin, unique, :, (vide)
Chaînefacultatif
Page de documentationpage

Spécifie une page de documentation différente de « /documentation »

Exemple
/Notice
Chaînefacultatif
  • nom-du-modèle : le nom du modèle représenté. Sa documentation doit être balisée dans la page nom-du-modèle/documentation.
  • séparateur (optionnel) :
    • début : intègre la première description de modèle au début du tableau.
    • absence de valeur : {{descriptif|nom-du-modèle}} : intercale la description de modèle à l'intérieur du tableau.
    • fin : intègre la dernière description de modèle à la fin du tableau.
    • unique : affiche un tableau à une seule ligne.
    • : : le séparateur deux-points pour donner une description en texte courant.
  • page= (optionnel) : suivi du nom de la page, définit une page de documentation particulière autre que la sous-page standard du modèle (qui est suffixée /documentation).

Exemple

modifier
  • Description en texte courant
Code wiki Rendu
{{descriptif|personnage|:}}
{{personnage}} : affiche le nom des personnages dans les pièces de théâtre.
  • Descriptions en tableau
Code wiki Rendu
{{descriptif|didascalie|début}}
{{descriptif|4/4}}
{{descriptif|Grec}}
{{descriptif|Classement|fin}}
{{didascalie}} afficher en italique les didascalies dans les pièces de théâtre
{{4/4}} afficher une icône Relu et corrigé indiquant l’état d’avancement du texte : relu et corrigé par un premier contributeur, ce qui demande une ou plusieurs relectures par d’autres contributeurs pour validation, ou bien qu’un projet est arrivé en fin de réalisation.
{{Grec}} signale un passage en grec et fait une demande pour écrire, transcrire en grec ou corriger ce passage.
{{Classement}} permet de classer, dans des catégories, la page « L’Avare » avant « Avertissement », ce que ne fait pas par défaut MediaWiki qui classe un titre toujours d’après son premier caractère (et donc « L’Avare » sera classé à la lettre « L »).
  • Description en tableau à une ligne
Code wiki Rendu
{{descriptif|Document|unique}}
{{Document}}
  • Documentation en provenance d’une page particulière
Code wiki Rendu
{{descriptif|Boîte déroulante/fin|début}}
{{descriptif|Boîte déroulante/fin|fin|page=Modèle:Boîte déroulante/documentation}}
{{Boîte déroulante/fin}} Modèle:Boîte déroulante/fin/documentation
{{Boîte déroulante/fin}} placer un cadre d’une zone de texte rétractable sur une ligne

Voir aussi

modifier