|
|
(2 révisions intermédiaires par un utilisateur sont masquées) |
Ligne 1 : |
Ligne 1 : |
− | <!-- noinclude nécessaire ici --><noinclude>{{Sous-page de documentation}}</noinclude> | + | <includeonly>{{#invoke:Documentation | documentation |
− | {{Modèle utilisant les modules Lua|Module:Documentation}}
| + | | contenu sous-page = {{ {{#invoke:Documentation | nomDocumentation| {{{1|}}} }} }} |
− | <nowiki>{{</nowiki>'''Documentation'''<nowiki>}}</nowiki> est un modèle de mise en forme de [[Aide:Documentation de modèle|documentation]] affichant une boîte verte (comme vous pouvez le voir actuellement). Ce modèle charge automatiquement le contenu d'une sous-page /Documentation. Il est à placer à la fin du modèle et doit être inséré dans une section <tt>noinclude</tt>. L'utilisation de ce modèle permet à quiconque d'éditer la documentation et les catégories d'un modèle protégé.
| + | }}</includeonly><noinclude> |
− | | + | {{documentation}} |
− | Si la page de documentation n'existe pas, le lien [créer] comporte une page de préchargement avec le format de page de documentation de base. Dans la notice disponible en bas de page de documentation, ce préchargement est également utilisé pour les sous-pages /Bac à sable et /Test en cliquant sur le lien (créer). Lorsque le modèle est un bac à sable, il ajoute automatiquement le modèle {{m|Sous-page de bac à sable}} en haut de page.
| + | </noinclude> |
− | | + | |
− | == Syntaxe ==
| + | |
− | En général, ce modèle est utilisé sans aucun paramètre, placé en bas du modèle ou de la page documentée, entre « <nowiki><noinclude></nowiki> » :
| + | |
− | <pre><noinclude>{{Documentation}}</noinclude></pre>
| + | |
− | | + | |
− | De cette façon, le contenu de la sous-page /Documentation du modèle se chargera automatiquement. <nowiki>{{</nowiki>Documentation<nowiki>}}</nowiki> peut également charger le contenu à partir de n'importe quelle autre page :
| + | |
− | <pre><noinclude>{{Documentation|Modèle:Exemple/Documentation}}</noinclude></pre>
| + | |
− | | + | |
− | De cette façon, le contenu de la sous-page /Documentation du modèle <nowiki>{{</nowiki>Exemple<nowiki>}}</nowiki> se chargera automatiquement. Notez bien que l'espace de nom (« Modèle: » ici) doit être indiqué. Le contenu peut également être rédigé dans le corps du modèle :
| + | |
− | <pre><noinclude>{{Documentation|contenu=
| + | |
− | == Utilisation ==
| + | |
− | Lorem ipsum...
| + | |
− | }}</noinclude></pre> | + | |
− | | + | |
− | Cependant, cette méthode est restrictive. Lorsque le modèle est protégé, le contenu doit être transféré en sous-page. Il suffit de suivre les instructions de la notice, disponible en bas de page de chaque documentation. À noter que la syntaxe MediaWiki des tableaux ne peut être associée au paramètre ''contenu''.
| + | |
− | | + | |
− | == Paramètres ==
| + | |
− | * '''<premier paramètre sans nom>''' : Paramètre servant à mentionner le nom d'une page de documentation alternative, qui peut être partagée par plusieurs modèles.
| + | |
− | * '''contenu''' : Paramètre servant à inclure le contenu de la documentation directement dans le corps du modèle.
| + | |
− | * '''notice''' : Paramètre permettant de personnaliser la notice de la documentation. Ce paramètre est opérationnel seulement lorsque le paramètre contenu est renseigné.
| + | |
− | * '''titre''' : Paramètre permettant la modification du titre de la documentation.
| + | |
− | * '''couleur''' : Paramètre modifiant la couleur par défaut le la documentation.
| + | |
− | | + | |
− | == Exemples ==
| + | |
− | Voir la [[Modèle:Documentation/Test#Version du modèle de base|sous-page de test]].
| + | |
− | | + | |
− | == Voir aussi ==
| + | |
− | * {{m|Sous-page de documentation}}
| + | |
− | * {{m|Sous-page de bac à sable}}
| + | |
− | * {{m|Sous-page de test}}
| + | |
− | * [[wikt:Modèle:Documentation]] : modèle équivalent sur le Wiktionnaire francophone
| + | |
− | <includeonly>
| + | |
− | [[Catégorie:Bandeau de documentation modèle| *]]
| + | |
− | [[Catégorie:Modèle appelant des modules en langage Lua]]
| + | |
− | </includeonly> | + | |