« Aide:Documentation de modèle » : différence entre les versions
Contenu supprimé Contenu ajouté
Révocation des modifications de 80.214.115.174 (retour à la dernière version de Framawiki) ; Vandalisme |
corriger / mettre à jour |
||
| (19 versions intermédiaires par 12 utilisateurs non affichées) | |||
Ligne 4 :
== Contenu de la documentation ==
L'[[Aide:ÉditeurVisuel|éditeur visuel]] demande que les documentations de modèles utilisent [[Aide:TemplateData|la balise ''TemplateData'']].
* S'il n'y a PAS de sous page de documentation, la balise ''TemplateData'' doit être incluse dans le paramètre <code>contenu</code>.
* S'il existe une sous page de documentation, la balise ''TemplateData'' doit être placée obligatoirement dans la sous-page de documentation.
== Utilisation ==
Ligne 10 ⟶ 14 :
La documentation d'un modèle peut être faite :
* Soit [[#Dans la page du modèle|directement dans la page du modèle]],
* Soit [[#En sous-page dédiée|dans la sous-page <code>/Documentation</code> du modèle]]
Il est préférable de systématiquement séparer le code (le modèle) de sa documentation (la sous-page) pour faciliter la prise en main par les nouveaux, et éviter les modèles brisés dont le code a été cassé par une correction de documentation mal faite.
=== Dans la page du modèle ===▼
Il est possible d'inclure le contenu de la documentation directement dans le corps du modèle. Pour ce faire, il faut placer en fin de page du modèle :
<pre>(...Le code Wiki du modèle est en premier...)
<pre><noinclude>{{Documentation|contenu=▼
== Utilisation ==
...
}}
<!-- Catégories pour le modèle -->
</noinclude></pre>
Notes :
* L'inclusion de la documentation dans la page du modèle est utile lorsque le modèle est simple.
* Si le modèle est protégé, le contenu de la documentation doit obligatoirement être
* Le modèle {{m|Documentation}} doit obligatoirement être borné avec les balises <nowiki><noinclude>...</noinclude></nowiki> pour éviter l'inclusion de celui-ci lors de l'appel du modèle.
* Le paramètre <code><nowiki>|contenu=</nowiki></code> ne prend pas en charge la syntaxe MediaWiki des tableaux. Pour résoudre ce problème, il est nécessaire de transformer la syntaxe MediaWiki en code [[HTML]] ou alors de transférer le contenu de la documentation en sous-page /Documentation.
* Seuls le modèle {{m|Documentation}} et les catégories sont autorisés entre les balises {{balise|noinclude}}. Tout texte, modèle, bandeau ou [[Aide:Templatedata|Templatedata]] doit obligatoirement être placé dans le paramètre <code>contenu</code>.
===
Il faut
* Le modèle est très employé et utilise des paramètres qui prennent de multiples valeurs (il faut alors réduire au minimum le contenu des balises <nowiki><noinclude>...</noinclude></nowiki> et surtout ne pas inclure la documentation directement dans le modèle).
* Le modèle et/ou sa documentation sont particulièrement longs.
* Avant de protéger un modèle, il faut déplacer sa documentation en sous-page.
L'usage d'une sous page de documentation du modèle permet aussi de séparer le code (le modèle) de sa documentation (la sous-page) pour faciliter la prise en main par les nouveaux, et éviter les modèles brisés dont le code a été cassé par une correction de documentation mal faite.
Il faut placer en fin de page du modèle :▼
<pre><noinclude>{{Documentation}}</noinclude></pre>▼
▲:<pre><noinclude>{{Documentation}}</noinclude></pre>
Ensuite, sur la page du modèle, cliquez sur le lien « <span style="color:blue">/Documentation</span> » pour précharger le format de base d'une page de documentation.▼
:Pré-visualisez ou publiez le modèle.
▲:Ensuite, sur la page du modèle, cliquez sur le lien
:Puis complétez la documentation et publiez-la.
Notes :
* L'appel de <code><nowiki>{{Documentation}}</nowiki></code> permet de charger automatiquement le contenu de la sous-page /Documentation.
* Le modèle {{m|Documentation}} doit obligatoirement être entouré par les balises <nowiki><noinclude>...</noinclude></nowiki> pour éviter d'être lui-même inclus lors de l'appel du modèle.
* Seul le modèle {{m|Documentation}} est autorisé entre les balises {{balise|noinclude}}. Toute catégorie, texte, modèle, bandeau ou Templatedata doit obligatoirement être placé dans la sous-page.
== Exemples ==
Ligne 62 ⟶ 66 :
* [[Modèle:Icône de titre]]
* [[Modèle:Infobox Musique (œuvre)]]
=== Documentations spécifiques ===
Ligne 76 ⟶ 79 :
== Voir aussi ==
* {{m|Documentation attendue}}
<noinclude>
[[Catégorie:Aide:Modèle|Documentation]]
</noinclude>
| |||