FANDOM


Info.jpg

La documentation de ce modèle est incluse depuis sa sous-page de documentation [[[:Modèle:Modifier la sous-page]]]. Voir la liste des modèles.

Cliquez ici pour purger le cache lorsque vos modifications n’apparaissent pas.

Info

Ce modèle emploie quelques fonctionnalités complexes de la syntaxe des ParserFunctions. Veuillez ne pas tenter de le modifier à moins que vous ne soyez certain de bien comprendre sa conception et êtes préparé à réparer tous les dommages collatéraux si les résultats sont inattendus. Toute expérimentation devrait être conduite d’abord via une copie sur le Modèle bac à sable ou dans votre espace utilisateur (voir la page Aide:Modèle).


Utilisation :
Ce modèle affiche une boîte de « Documentation modèle » telle que celle que vous lisez en ce moment.
  • Ajoutez <noinclude>{{Documentation modèle en sous-page}}</noinclude> au modèle principal (ou plutôt <noinclude>{{Documentation modèle en sous-page|parser=1}}</noinclude> si le modèle principal modèle utilise des ParserFunctions).
  • Cliquez sur le lien « Créer la documentation » affiché dans le bandeau généré (ou « [modifier] » si la sous-page de documentation existe déjà), qui vous permet de créer ou modifier la sous-page /Documentation, utilisée sur la page du modèle comme documentation d’utilisation.
  • Si la sous-page de documentation n’existait pas encore, le lien « Créer la documentation » vous mène à l’édition de cette sous-page, pré-remplie à l’aide du contenu du sous-modèle Modèle:Documentation modèle en sous-page/Preload. Le contenu de ce modèle est relativement complexe car il gère le remplacement automatique du nom du modèle que vous allez documenter. Dans ce cas, le plus simple est de sauver immédiatement la page de documentation pour que les substitutions aient lieu, puis de la rééditer pour avoir une vue plus simple.
Syntaxe (dans le modèle principal à documenter) :
  • Cas le plus courant pour un modèle simple :
    code du modèle principal...<noinclude>{{Documentation modèle en sous-page}}</noinclude>
  • Affiche (sous le rendu par défaut du modèle principal, à moins qu’il soit lui-même caché dans une section « includeonly ») la sous-page de documentation du modèle, dans une boîte bleue commençant par un appel du modèle {{Documentation modèle en sous-page}}.
  • Cas pour un modèle compliqué utilisant les ParserFunctions :
    code du modèle principal...<noinclude>{{Documentation modèle en sous-page|parser=1}}</noinclude>
  • Dans les deux cas, il ne devrait rien y avoir d’autre dans la section « noinclude » de votre modèle que l’appel de {{Documentation modèle en sous-page}} ou {{Documentation modèle en sous-page|parser=1}}.
    Si des robots ajoutent des liens interwikis ou des catégories à votre modèle principal, il est préférable de replacer ces métadonnées dans la sous-page de documentation.
    Si le code du modèle principal est compliqué et ne permet pas de le visualiser correctement sans paramètres mais est destiné uniquement à être inclus dans une autre page avec ces paramètres, il peut être utile de mettre tout le code du modèle lui-même dans une section « includeonly », juste avant la section « noinclude » contenant l’appel de {{Documentation modèle en sous-page}}. On montrera alors des exemples d’utilisation et de rendu dans la sous-page de documentation.
    Syntaxe (dans la sous-page « /Documentation ») :
    <noinclude>{{Documentation modèle vue directement}}</noinclude>
    ...
    documentation du modèle
    ...
    {{DEFAULTSORT:nom du modèle sans accent}}
    <includeonly>
    [[Catégorie:nom de catégorie appropriée pour le modèle principal|éventuelle clé de tri spécifique pour cette catégorie]]
    ...
    <!-- Interwikis -->
    [[en:Template:nom du modèle anglophone équivalent]]
    ...
    </includeonly>
    En éditant votre sous-page de documentation, assurez-vous :
    • qu’elle commence bien par le code suivant sur la première ligne :
      <noinclude>{{Documentation modèle vue directement}}</noinclude>
    • que les métadonnées applicables au modèle principal (la clé de tri par défaut des catégories, la liste des catégories applicables au modèle principal, les éventuels liens interwikis) sont bien dans une section « includeonly » à la fin de la documentation (et non « noinclude » comme dans le cas des modèles simples dont les métadonnées ont été incluses directement dans le modèle et non dans une sous-page).
    Voir aussi :
  • Modèle:Documentation modèle en sous-page
    le bandeau apparaissant automatiquement dans la page principale du modèle.
  • Modèle:Documentation modèle utilisant les ParserFunctions en sous-page
    le bandeau alternatif apparaissant dans la page principale du modèle quand le paramètre parser= est non vide.
  • Sauf mention contraire, le contenu de la communauté est disponible sous licence CC-BY-SA  .