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

Navigation interactive dans l’historique

← Modification précédente

VisuelWikicode

Dernière version du 15 novembre 2025 à 11:04

📚 Modèle:Documentation

✏️ Documentation 🎨 CSS

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>
-<!-- Modèle de documentation pour les modèles MediaWiki (namespace 10) -->
+{{DISPLAYTITLE:{{PAGENAME}} (documentation)}}
-<!-- Applique automatiquement la catégorie uniquement aux pages /doc dans le namespace "Modèle" -->
+<!--
+  Système de documentation avec pré-chargement et CSS intégré
+  Dépendances : Extension:TemplateStyles
+  Utilisation : {{Documentation}}
+-->
+[[Catégorie:Modèles système]]
+{{Documentation}}
 </noinclude>
-<includeonly>
+<includeonly><templatestyles src="Modèle:Documentation/styles.css" />
+<div class="nef-doc-system">
+<!-- Bandeau de documentation -->
+<div class="nef-doc-header">
+<div class="nef-doc-header-content">
+<span class="nef-doc-header-icon">📚</span>
+<strong>{{FULLPAGENAME}}</strong>
+</div>
+<div class="nef-doc-header-actions">
+{{#ifexist:{{{page|{{FULLPAGENAME}}/doc}}}
+|<span class="nef-doc-btn">[[{{{page|{{FULLPAGENAME}}/doc}}}|<span class="nef-doc-btn-icon">✏️</span> Documentation]]</span>
+|<span class="nef-doc-btn nef-doc-btn-create">[[{{{page|{{FULLPAGENAME}}/doc}}}|<span class="nef-doc-btn-icon">➕</span> Créer la documentation]]</span>
+}}
+{{#ifexist:{{{page|{{FULLPAGENAME}}/styles.css}}}
+|<span class="nef-doc-btn">[[{{{page|{{FULLPAGENAME}}/styles.css}}}|<span class="nef-doc-btn-icon">🎨</span> CSS]]</span>
+|<span class="nef-doc-btn nef-doc-btn-create">[[{{{page|{{FULLPAGENAME}}/styles.css}}}|<span class="nef-doc-btn-icon">➕</span> CSS]]</span>
+}}
+</div>
+</div>
 {{#ifexist: {{FULLPAGENAME}}/doc
-  | {{ {{FULLPAGENAME}}/doc | 1=<noinclude>{{DISPLAYTITLE:{{PAGENAME}} (documentation)}}</noinclude> }}
+| <!-- Mode avec documentation existante -->
-  | <div class="mw-documentation-missing" style="
+<div class="nef-doc-box nef-doc-exists">
-      border: 1px solid #c8ccd1;
+{{ {{FULLPAGENAME}}/doc }}
-      background-color: #f8f9fa;
+</div>
-      padding: 15px;
+| <!-- Mode sans documentation -->
-      margin: 10px 0;
+<div class="nef-doc-box nef-doc-missing">
-      border-radius: 4px;
+<div class="nef-doc-icon" aria-hidden="true">📄</div>
-    ">
+<div class="nef-doc-content">
-      <h2 style="margin-top: 0; border-bottom: 1px solid #c8ccd1; padding-bottom: 0.2em;">
+<p><strong>Ce modèle n'a pas encore de documentation.</strong></p>
-        Documentation manquante
+<p>Vous pouvez [{{fullurl:{{FULLPAGENAME}}/doc
-      </h2>
+| action=edit
-      <div class="mw-documentation-notice" style="margin-left: 20px;">
+| preload=Modèle:Preload/Documentation
-        '''Ce modèle n’a pas de documentation.'''
+| preloadparams[]={{urlencode:{{BASEPAGENAME}}}}
-        <br>
+}} créer la documentation] pour expliquer son utilisation.</p>
-        Vous pouvez [[{{FULLPAGENAME}}/doc|créer la sous-page <code>/doc</code>]] pour décrire son fonctionnement.
-        <br><br>
+<div class="nef-doc-instructions">
-        <small>
+<strong>Instructions :</strong>
-          <strong>Règles :</strong>
+<ul>
-          <ul style="margin-top: 0.3em;">
+<li>Le système pré-remplira automatiquement la structure</li>
-            <li>La documentation doit être dans <code>&lt;noinclude&gt;...&lt;/noinclude&gt;</code>.</li>
+<li>Décrivez chaque paramètre du modèle</li>
-            <li>Utilisez <code>{{DISPLAYTITLE:Nom (documentation)}}</code>.</li>
+<li>Ajoutez des exemples concrets</li>
-            <li>Les pages <code>/doc</code> sont automatiquement [[Catégorie:Documentation de modèle|catégorisées]].</li>
+<li>Sauvegardez quand vous avez terminé</li>
-          </ul>
+</ul>
-        </small>
+</div>
-      </div>
+</div>
-    </div>
+</div>
-}}
-{{#ifeq: {{NAMESPACE}} | Modèle
-  | {{#if: {{SUBPAGENAME}}
-    | {{#ifeq: {{SUBPAGENAME}} | doc
-      | [[Catégorie:Documentation de modèle|{{PAGENAME}}]]
-      | <!-- Pas de catégorie pour les autres sous-pages -->
-    }}
-    | <!-- Pas de catégorie pour la page principale du modèle -->
-  }}
 }}
-</includeonly>
+</div></includeonly>