Modèle:Documentation palette/Documentation

Utilisation

{{Documentation palette}} et {{Documentation palette/fin}} sont des modèles préformaté de documentation de modèles de type « Palette de navigation ». Le premier doit être insérer en début de modèle entre des balises <noinclude> ; de même le second doit être insérer à la fin du modèle, lui aussi entre des balises <noinclude>.

Syntaxe

• {{Documentation palette|heading=titre|nocat=valeur}}
• {{Documentation palette/fin|1|2}}

Paramètres

• Documentation palette :
  • heading = titre – Paramètre permettant de changer l'intitulé de l'entête de documentation (optionnel, par défaut Documentation)
  • nocat = 1 – Paramètre permettant d'ajouter un texte d'avertissement si la palette documentée contient un paramètre nocat= (optionnel, par défaut 0)
• Documentation palette/fin :
  • 1 = Texte – Paramètre permettant d'écrire une section après la palette (optionnel, par défaut vide)
  • 2 = Titre – Paramètre permettant de changer l'intitulé de la section suivant la palette (optionnel, par défaut Instructions supplémentaires, n’apparaît que si 1 en renseigner)

Exemples

<noinclude>{{Documentation palette}}</noinclude>
Code palette
<noinclude>{{Documentation palette/fin}}
[[Catégorie:xxx]]</noinclude>

 Documentation de palette[voir] [modifier] [historique] [purger]

Ceci est la documentation du modèle {{Documentation palette/Documentation}}.

Syntaxe

L’utilisation de cette palette se fait par l’ajout, en fin de page, avant les portails, du code {{Palette|Documentation palette/Documentation}}, ou en l’ajoutant à une ou des palettes existantes sous la forme {{Palette|nom-palette-1|Documentation palette/Documentation}}.

Il est déconseillé d’utiliser la forme {{Documentation palette/Documentation}}, qui ne permet pas, contrairement au modèle {{Palette}}, de séparer correctement la ou les palettes du texte qui précède par de l’espace vide.

Maintenance

Afin de vérifier la bonne diffusion de la palette dans l'encyclopédie, vous pouvez vérifier sa transclusion :

• la section « Inclusion sans lien » liste les articles qui incluent la palette mais qui ne sont pas présents dans celle-ci ;
• la section « Lien sans inclusion » liste les articles présents dans la palette mais qui ne l'incluent pas.

Cependant, les manques ne doivent pas systématiquement être comblés : sinon, des articles présents dans de nombreuses palettes en incluraient trop.

Utilisation

{{Documentation palette}} et {{Documentation palette/fin}} sont des modèles préformaté de documentation de modèles de type « Palette de navigation ». Le premier doit être insérer en début de modèle entre des balises <noinclude> ; de même le second doit être insérer à la fin du modèle, lui aussi entre des balises <noinclude>.

Syntaxe

• {{Documentation palette|heading=titre|nocat=valeur}}
• {{Documentation palette/fin|1|2}}

Paramètres

• Documentation palette :
  • heading = titre – Paramètre permettant de changer l'intitulé de l'entête de documentation (optionnel, par défaut Documentation)
  • nocat = 1 – Paramètre permettant d'ajouter un texte d'avertissement si la palette documentée contient un paramètre nocat= (optionnel, par défaut 0)
• Documentation palette/fin :
  • 1 = Texte – Paramètre permettant d'écrire une section après la palette (optionnel, par défaut vide)
  • 2 = Titre – Paramètre permettant de changer l'intitulé de la section suivant la palette (optionnel, par défaut Instructions supplémentaires, n’apparaît que si 1 en renseigner)

Exemples

<noinclude>{{Documentation palette}}</noinclude>
Code palette
<noinclude>{{Documentation palette/fin}}
[[Catégorie:xxx]]</noinclude>

<noinclude>{{Documentation palette|heading=Exemple|nocat=1}}</noinclude>
Code palette
<noinclude>{{Documentation palette/fin|texte|titre}}
[[Catégorie:xxx]]</noinclude>

La documentation de ce modèle est générée par le modèle {{Documentation palette}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (modifier) et la page de test (modifier).
Voir les statistiques d'utilisation du modèle sur l'outil wstat.

<noinclude>{{Documentation palette|heading=Exemple|nocat=1}}</noinclude>
Code palette
<noinclude>{{Documentation palette/fin|texte|titre}}
[[Catégorie:xxx]]</noinclude>

 Documentation de palette[voir] [modifier] [historique] [purger]

Ceci est la documentation du modèle {{Documentation palette/Documentation}}.

Syntaxe

L’utilisation de cette palette se fait par l’ajout, en fin de page, avant les portails, du code {{Palette|Documentation palette/Documentation}}, ou en l’ajoutant à une ou des palettes existantes sous la forme {{Palette|nom-palette-1|Documentation palette/Documentation}}.

Il est déconseillé d’utiliser la forme {{Documentation palette/Documentation}}, qui ne permet pas, contrairement au modèle {{Palette}}, de séparer correctement la ou les palettes du texte qui précède par de l’espace vide.

Maintenance

Afin de vérifier la bonne diffusion de la palette dans l'encyclopédie, vous pouvez vérifier sa transclusion :

• la section « Inclusion sans lien » liste les articles qui incluent la palette mais qui ne sont pas présents dans celle-ci ;
• la section « Lien sans inclusion » liste les articles présents dans la palette mais qui ne l'incluent pas.

Cependant, les manques ne doivent pas systématiquement être comblés : sinon, des articles présents dans de nombreuses palettes en incluraient trop.

Catégorisation

Ce modèle propose une catégorisation automatique, si toutefois la ou les catégories ne sont pas pertinentes, il est possible de les supprimer avec le paramètre nocat.
Il faut alors utiliser exclusivement la syntaxe suivante : {{Documentation palette/Documentation|nocat=1}}.

Utilisation

{{Documentation palette}} et {{Documentation palette/fin}} sont des modèles préformaté de documentation de modèles de type « Palette de navigation ». Le premier doit être insérer en début de modèle entre des balises <noinclude> ; de même le second doit être insérer à la fin du modèle, lui aussi entre des balises <noinclude>.

Syntaxe

• {{Documentation palette|heading=titre|nocat=valeur}}
• {{Documentation palette/fin|1|2}}

Paramètres

• Documentation palette :
  • heading = titre – Paramètre permettant de changer l'intitulé de l'entête de documentation (optionnel, par défaut Documentation)
  • nocat = 1 – Paramètre permettant d'ajouter un texte d'avertissement si la palette documentée contient un paramètre nocat= (optionnel, par défaut 0)
• Documentation palette/fin :
  • 1 = Texte – Paramètre permettant d'écrire une section après la palette (optionnel, par défaut vide)
  • 2 = Titre – Paramètre permettant de changer l'intitulé de la section suivant la palette (optionnel, par défaut Instructions supplémentaires, n’apparaît que si 1 en renseigner)

Exemples

<noinclude>{{Documentation palette}}</noinclude>
Code palette
<noinclude>{{Documentation palette/fin}}
[[Catégorie:xxx]]</noinclude>

<noinclude>{{Documentation palette|heading=Exemple|nocat=1}}</noinclude>
Code palette
<noinclude>{{Documentation palette/fin|texte|titre}}
[[Catégorie:xxx]]</noinclude>

La documentation de ce modèle est générée par le modèle {{Documentation palette}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (modifier) et la page de test (modifier).
Voir les statistiques d'utilisation du modèle sur l'outil wstat.