« Modèle:Documentation/doc » : différence entre les versions

Version du 16 octobre 2025 à 14:05

Description

Ce modèle permet d’afficher automatiquement la documentation d’un modèle depuis sa sous-page /doc.

Utilisation

1. Dans le modèle principal (ex: Modèle:Exemple), ajoutez :

{{Documentation}}

2. Créez une sous-page Modèle:Exemple/doc avec la documentation.

Exemple de structure pour une page /doc

<noinclude>
{{DISPLAYTITLE:Exemple (documentation)}}
</noinclude>
== Description ==
Ce modèle fait X et Y.

== Paramètres ==
; param1
: Description du paramètre 1.

; param2
: Description du paramètre 2.

== Exemples ==
<pre>
{{Exemple
| param1 = valeur1
| param2 = valeur2}}
</pre>

[[Catégorie:Documentation de modèle]]

Catégorisation automatique

Les pages /doc dans l’espace de noms Modèle sont automatiquement ajoutées à .

@@ Ligne 1 : / Ligne 1 : @@
 <noinclude>
 {{DISPLAYTITLE:Documentation (documentation)}}
-<!-- NE PAS utiliser {{Documentation}} ici pour éviter les boucles -->
+<!-- NE PAS INCLURE {{Documentation}} ici ! -->
 </noinclude>
-<includeonly>
 == Description ==
-Ce modèle affiche la documentation des modèles via une sous-page <code>/doc</code>.
+Ce modèle permet d’afficher automatiquement la documentation d’un modèle depuis sa sous-page <code>/doc</code>.
-Il gère automatiquement :
-- L'inclusion de la documentation si <code>/doc</code> existe.
-- Un message d'avertissement sinon.
-- La catégorisation dans [[Catégorie:Documentation de modèle]].
-=== Fonctionnement technique ===
+== Utilisation ==
-. Utilise <code>{{FULLPAGENAME}}/doc</code> pour localiser la documentation.
+. Dans le modèle principal (ex: <code>Modèle:Exemple</code>), ajoutez :
-. Applique <code>{{DISPLAYTITLE:...}}</code> pour formater le titre.
+   <pre>{{Documentation}}</pre>
-. Catégorise **uniquement** les pages du namespace <code>Modèle</code> se terminant par <code>/doc</code>.
+. Créez une sous-page <code>Modèle:Exemple/doc</code> avec la documentation.
-== Syntaxe ==
+== Exemple de structure pour une page /doc ==
-<code>{{Documentation}}</code>
-== Exemple complet ==
-::: Exemple avec <code>Modèle:Exemple</code>
 <pre>
-// Dans Modèle:Exemple :
-{{Documentation}}
-</pre>
-<pre>
-// Dans Modèle:Exemple/doc :
 &lt;noinclude&gt;
 {{DISPLAYTITLE:Exemple (documentation)}}
+&lt;/noinclude&gt;
 == Description ==
 Ce modèle fait X et Y.
 == Paramètres ==
-| Nom  | Description          | Obligatoire |
+; param1
-|------|----------------------|-------------|
+: Description du paramètre 1.
-| foo  | Fait quelque chose   | Non         |
+; param2
+: Description du paramètre 2.
+== Exemples ==
+&lt;pre&gt;
+{{Exemple
+| param1 = valeur1
+| param2 = valeur2}}
+&lt;/pre&gt;
 [[Catégorie:Documentation de modèle]]
-&lt;/noinclude&gt;
 </pre>
-== Règles ==
+== Catégorisation automatique ==
-- Les sous-pages de documentation **doivent** s'appeler <code>/doc</code>.
+Les pages <code>/doc</code> dans l’espace de noms <code>Modèle</code> sont automatiquement ajoutées à [[Catégorie:Documentation de modèle]].
-- Toujours encapsuler la documentation dans <code>&lt;noinclude&gt;...&lt;/noinclude&gt;</code>.
-- Utiliser <code>{{DISPLAYTITLE}}</code> pour personnaliser le titre.
-== Bonnes pratiques ==
-- Pour les modèles complexes, ajoutez :
-  - Une section <code== Exemples ==</code> avec des cas concrets.
-  - Une section <code== Voir aussi ==</code> pour les modèles liés.
-  - Une [[Catégorie:Modèles avancés]] si nécessaire.
-== Dépannage ==
-- Si la documentation ne s'affiche pas :
-. Vérifiez que <code>/doc</code> existe bien.
-. Purgez le cache avec <code>?action=purge</code>.
-. Vérifiez l'absence de boucles (ex: <code>/doc</code> qui inclut le modèle parent).
 [[Catégorie:Documentation de modèle|Documentation]]
-</includeonly>