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

Navigation interactive dans l’historique

Dernière 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)}}
-{{Documentation}}
+<!-- NE PAS INCLURE {{Documentation}} ici ! -->
 </noinclude>
-<includeonly>
-<div class="mw-documentation-header" style="
-    background-color: #f0f0f0;
-    border-bottom: 1px solid #ddd;
-    padding: 0.5em;
-    margin-bottom: 1em;
-    font-size: 90%;
-  ">
-  '''Ce modèle est utilisé sur {{PAGESINCATEGORY:Modèles utilisant Documentation|R}} pages.'''
-  [{{fullurl:Special:WhatLinksHere/Modèle:Documentation|limit=500}} Voir les utilisations]
-</div>
 == Description ==
-Ce modèle standardise l'affichage de la documentation pour **tous les modèles** du wiki.
+Ce modèle permet d’afficher automatiquement la documentation d’un modèle depuis sa sous-page <code>/doc</code>.
-Il vérifie automatiquement l'existence d'une sous-page <code>/doc</code> et :
-. **Affiche la documentation** si elle existe.
-. **Affiche un message d'avertissement** si la documentation est manquante, avec un lien pour la créer.
-=== Pourquoi utiliser <code>/doc</code> ? ===
-- **Convention large** : Adoptée par la plupart des wikis techniques (MediaWiki.org, Fandom, etc.).
-- **Compatibilité** : Plus court et plus intuitif que `/Documentation`.
-- **Maintenance** : Facilite les scripts de migration ou d'analyse.
-== Syntaxe ==
-{{msgnw:Documentation}}
-=== Paramètres ===
-| Nom       | Type    | Description                                                                 | Obligatoire |
-|-----------|---------|-----------------------------------------------------------------------------|--------------|
-| (aucun)   | -       | Le modèle s'utilise sans paramètre.                                        | Non          |
-== Exemples ==
+== Utilisation ==
+. Dans le modèle principal (ex: <code>Modèle:Exemple</code>), ajoutez :
+   <pre>{{Documentation}}</pre>
+. Créez une sous-page <code>Modèle:Exemple/doc</code> avec la documentation.
-=== 1. Modèle avec documentation ===
+== Exemple de structure pour une page /doc ==
-Si [[Modèle:Exemple/doc]] existe :
 <pre>
-{{Exemple}}
+&lt;noinclude&gt;
-{{Documentation}}
+{{DISPLAYTITLE:Exemple (documentation)}}
-</pre>
+&lt;/noinclude&gt;
-→ Affiche le contenu de <code>Modèle:Exemple/doc</code> dans un cadre dédié.
+== Description ==
+Ce modèle fait X et Y.
-=== 2. Modèle sans documentation ===
+== Paramètres ==
-Si [[Modèle:Test/doc]] n'existe pas :
+; param1
-<pre>
+: Description du paramètre 1.
-{{Test}}
-{{Documentation}}
-</pre>
-→ Affiche un message incitant à créer <code>Modèle:Test/doc</code>.
-== Personnalisation ==
+; param2
-=== CSS ===
+: Description du paramètre 2.
-Les classes suivantes sont disponibles pour le styling :
-- <code>.mw-documentation-missing</code> : Conteneur du message "documentation manquante".
-- <code>.mw-documentation-notice</code> : Texte du message.
-- <code>.mw-documentation-header</code> : En-tête avec le compteur d'utilisations.
-Exemple pour modifier les couleurs (à ajouter dans [[MediaWiki:Common.css]]) :
+== Exemples ==
-<pre>
+&lt;pre&gt;
-.mw-documentation-missing {
+{{Exemple
-    background-color: #fff5f5;
+| param1 = valeur1
-    border-color: #ffcccc;
+| param2 = valeur2}}
-}
+&lt;/pre&gt;
-</pre>
-=== Compatibilité avec Lua ===
+[[Catégorie:Documentation de modèle]]
-Pour utiliser ce modèle dans un [[Module:|module Lua]] :
-<pre>
-local p = {}
-function p.doc(frame)
-    return mw.getCurrentFrame():expandTemplate{
-        title = 'Documentation',
-        args = {}
-    }
-end
-return p
 </pre>
-== Bonnes pratiques ==
+== Catégorisation automatique ==
-. **Structure de <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:Nom (documentation)}}</code> pour le titre.
-   - Exemple minimal :
-     <pre>
-     &lt;noinclude&gt;
-     {{DISPLAYTITLE:Nom (documentation)}}
-     {{Documentation}}
-     == Description ==
-     ...
-     &lt;/noinclude&gt;
-     </pre>
-. **Catégorisation** :
-   - Ajouter [[Catégorie:Modèles documentés]] dans la page <code>/doc</code>.
-   - Utiliser [[Catégorie:Modèles non documentés]] pour les modèles sans <code>/doc</code> (via un [[Special:TrackingCategories|catégorie de suivi]]).
-. **Migration depuis <code>/Documentation</code>** :
-   - Utiliser [[Special:MovePage]] pour renommer les anciennes pages.
-   - Mettre à jour les liens avec [[Special:WhatLinksHere]].
-== Voir aussi ==
-- [[Aide:Créer un modèle]] – Guide pour créer des modèles.
-- [[Modèle:Boîte de navigation]] – Pour organiser les documentations.
-- [https://www.mediawiki.org/wiki/Help:Templates Documentation officielle MediaWiki] (en anglais).
-[[Catégorie:Modèles système]]
+[[Catégorie:Documentation de modèle|Documentation]]
-[[Catégorie:Documentation]]
-</includeonly>