Modèle:Méta documentation de modèle/Documentation

Une page de Wikipédia, l'encyclopédie libre.
Sauter à la navigation Sauter à la recherche

{{Méta documentation de modèle}} est un méta-modèle pour la création de modèles de documentation affichant une boîte verte (comme celle contenant le texte que vous lisez actuellement).

Fonctionnement[modifier le code]

Ce modèle est basé sur le module Documentation 2. L'affichage est constitué d'un titre affiché en haut, de la documentation elle même, et d'une notice affichée en bas.

Le contenu de la documentation est généré depuis différentes sources :

  • Le contenu de la documentation est obtenu depuis la sous-page /Documentation, sauf si le paramètre contenu est renseigné. C'est alors sa valeur qui est utilisée.
  • Le paramètre page doc permet de cibler une page de documentation différente de la sous-page /Documentation, par exemple pour mutualiser une page entre plusieurs modèles.
  • Il est possible de définir un contenu automatique pour la documentation, qui s'affichera sur toutes les pages utilisant le modèle, en utilisant les paramètres contenu auto haut et contenu auto bas. Leur valeur sera alors affichée respectivement au dessus et en dessous du contenu, qu'il provienne de la sous-page de documentation ou du paramètre contenu.

Différents bandeaux sont affichés en fonction du contexte :

  • Si le modèle est protégé, un bandeau décrivant la protection est affiché. Le paramètre message protection permet de modifier le titre de celui-ci. Une icône de titre est également placée en haut de la page.
  • Lorsque le modèle est un bac à sable, il ajoute automatiquement le modèle {{Sous-page de bac à sable}} en haut de page.
  • En l'absence de contenu pour la documentation, c'est-à-dire lorsqu'il n'y a ni sous-page de documentation ni valeur fournie paramètre contenu, un bandeau incitant à création de celle-ci est affiché, et le modèle est placé dans la catégorie « Modèle sans documentation ». Si les paramètres contenu auto haut ou contenu auto bas sont renseignés et jouent déjà ce rôle, il est possible de fournir le paramètre contenu facultatif (avec n'importe quelle valeur) pour éviter l'affichage du bandeau.

Enfin, des liens sont également générés automatiquement :

  • En l'absence de contenu pour la documentation, un lien [créer] est affiché, qui permet de débuter la création de la page en préchargeant le format de page de documentation de base.
  • Des liens disponibles au bas de la notice permettent également de créer les sous-pages /Bac à sable et /Test.

Quand utiliser ce méta-modèle ?[modifier le code]

Pour documenter un modèle seul, il vaut mieux utiliser directement le modèle {{Documentation}} associé à une sous-page de documentation. Lorsqu'une poignée de modèles doivent utiliser une documentation commune, le plus simple est de créer une page de documentation, et de la référencer sur tous ces modèles à l'aide du paramètre 1 du modèle {{Documentation}}.

Il devient utile de disposer d'un modèle de documentation spécifique lorsque de nombreux modèles doivent avoir la même documentation, ou que plusieurs modèles doivent utiliser la même documentation mais que celle-ci contient des paramètres propres à chaque modèle. Dans ce cas, il faut créer un modèle de documentation spécifique faisant appel au modèle Méta documentation de modèle.

Comment utiliser ce méta-modèle ?[modifier le code]

Lorsque l'utilisation d'un modèle de documentation spécifique est nécessaire, il faut alors créer un modèle faisant appel au modèle Méta documentation de modèle. Dans ce cas, ce modèle doit comporter le contenu suivant :

  • Renseigner le paramètre nom modèle pour générer automatiquement la notice du modèle.
  • Optionnellement, renseigner le paramètre titre, qui fournit la valeur du titre à indiquer en tête du modèle de documentation. Par défaut, le titre affiche Documentation.
  • Renseigner les paramètres contenu auto haut et/ou contenu auto bas, qui doivent contenir le texte à afficher automatiquement dans la documentation.
  • Si un contenu supplémentaire doit pouvoir être ajouté au modèle, ajouter le paramètre contenu = {{{contenu|}}} pour permettre d'ajouter un contenu entre contenu auto haut et contenu auto bas. En l'absence de ce paramètre, le contenu de la sous-page de documentation s'affichera automatiquement.
  • Éventuellement, ajouter le paramètre contenu facultatif = oui si la documentation est complète sans que l'on ait obligatoiremennt à renseigner un paramètre contenu ou une sous-page de documentation, qui sont alors facultatifs.
  • Enfin, on peut ajouter les paramètres page doc = {{{page doc|}}} et/ou message protection = {{{message protection|}}} pour permettre de personnaliser ces éléments (voir la liste des paramètres ci-dessous pour le détail de leur comportement).

Paramètres[modifier le code]

Il faut différencier les méta-paramètres, destinés à être utilisés directement par les modèles qui utilisent ce méta-modèle, et les paramètres, qui sont destinés à l'usage final et que les modèles peuvent se contenter de transmettre.

Liste des paramètres[modifier le code]

Ces paramètres peuvent être transmis par les modèles qui utilisent ce méta-modèle, pour utilisation dans l'inclusion finale.

  • contenu : Contenu brut à afficher dans la documentation. Remplace le contenu affiché depuis la sous-page si elle existe.
  • page doc : Indique la page de documentation à charger si elle est différente de la sous-page /Documentation. Permet de mutualiser une sous-page de documentation entre plusieurs modèles.
  • message protection : Personnalise le titre du bandeau de protection si le modèle est protégé.

Liste des méta-paramètes[modifier le code]

Ces paramètres sont destinés uniquement aux modèles de documentation qui utilisent ce méta-modèle. Ils ne doivent pas être transmis pour utilisation finale.

  • nom modèle : À renseigner avec le nom du modèle de documentation (sans le préfixe Modèle:). Génère automatiquement une notice affichant un lien vers celui-ci.
  • titre : Permet de personnaliser le titre du modèle de documentation. En son absence, le titre est simplement Documentation.
  • contenu auto haut : Ajoute un contenu au-dessus du contenu de la documentation.
  • contenu auto bas : Ajoute un contenu en dessous du contenu de la documentation.
  • contenu facultatif : Indique que la présence d'un contenu de documentation n'est pas obligatoire pour éviter l'affichage du bandeau. À ne renseigner que si le paramètre contenu auto haut ou le paramètre contenu auto bas remplissent déjà ce rôle.

Template data[modifier le code]

Ce modèle est un méta-modèle pour la création de modèles de documentation.

Paramètres du modèle

ParamètreDescriptionTypeStatut
Page docpage doc

Spécifie le nom d'une page de documentation à utiliser différente, qui peut être partagée par plusieurs modèles

Chaînefacultatif
Contenucontenu

Spécifie le contenu de la documentation, pour qu'il soit directement inclus dans le corps du modèle. Ne pas utiliser si vous voulez créer une sous page.

Chaînefacultatif
Message protectionmessage protection

Modifie le titre du bandeau ajouté lorsque la page est en protection complète.

Chaînefacultatif
Nom modèlenom modèle

Méta-paramètre : à renseigner avec le nom du modèle de documentation.

Chaînefacultatif
Noticenotice

Méta-paramètre : personnalise la notice de la documentation.

Chaînefacultatif
Titretitre

Méta-paramètre : modifie le titre de la documentation.

Chaînefacultatif
Contenu auto hautcontenu auto haut

Méta-paramètre : ajoute un contenu statique au dessus du contenu.

Chaînefacultatif
Contenu auto bascontenu auto bas

Méta-paramètre : ajoute un contenu statique en-dessous du contenu.

Chaînefacultatif
Contenu facultatifcontenu facultatif

Renseigner à n'importe quelle valeur pour indiquer que la présence d'un contenu de documentation n'est pas obligatoire. À ne renseigner que si le paramètre <code>contenu auto haut</code> ou le paramètre <code>contenu auto bas</code> remplissent déjà ce rôle.

Chaînefacultatif

Voir aussi[modifier le code]