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

Contenu supprimé Contenu ajouté
Ligne 1 :
<div style="backgroundclear:#BBFboth; margin-top:2em;0.3em 0;border-top:1px solid #AAAAAAAAA; clearbackground-color: both#ECFCF4;padding:5px" class="template-documentation"><!--
Voici des définitions littérales de classe pour common.css :
<div style="text-align:center; padding-top:.7em; height:1.5em">
/* Pour la documentation des modèles */
<big><strong>Documentation</strong></big>
.template-documentation {
</div>
clear: both;
<div style="text-align:right; margin-right:.5em; margin-bottom:0 !important;"><small>''{{Purger le cache}}''</small>
margin: 0.3em 0;
</div>
border: 1px solid #AAAAAA;
</div>
background-color: #ECFCF4;
<div style="border:1px dashed #AAA; border-top:none; padding:1em"><includeonly>
padding: 5px;
{{#if:{{{nocat|}}}||[[Catégorie:Documentations des modèles|{{PAGENAME}}]]}}</includeonly><noinclude>
}
<!--{{Documentation modèle}}-->
 
** ENTÊTE STANDARD AVEC ICÔNE **
; Utilisation
-->{{#ifeq:{{{heading|μ}}}|<!-- heading DÉFINI MAIS VIDE -->|<!--
: Pour documenter un modèle, copiez, collez et adaptez le code ci-dessous à la fin de la source d’un modèle (c’est-à-dire juste avant son dernier saut de ligne existant, et sans aucun autre saut de ligne inutile ajouté après)&nbsp;:
** SUPPRIME L’ENTÊTE AVANT LES LIENS, content OU SOUS-PAGE DE DOCUMENTATION **
<pre>&lt;noinclude&gt;&lt;!--
-->|<!--
NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats !
--><div style="border-bottom: 1px solid #AAAAAA;padding-bottom:3px;margin-bottom:1ex"><!--
--&gt;
--><span style="<!--
{{Documentation modèle}}
-->{{#if:{{{heading-style|}}}|<!--
-->{{{heading-style}}}<!--
-->|<!--
-->{{#ifeq:{{NAMESPACE}}|{{ns:template}}|<!--
-->font-weight:bold;font-size:125%<!--
-->|<!--
-->font-size:150%<!--
-->}}<!--
-->}}"><!--
-->{{#if:{{{heading|}}}|<!--
-->{{{heading}}}<!--
-->|<!--
-->{{#ifeq:{{NAMESPACE}}|{{ns:template}}|<!--
-->[[Image:Template-info.svg|50px]] Documentation du modèle<!--
-->|<!--
-->Documentation<!--
-->}}<!--
-->}}<!--
--></span><!--
--></div><!--
-->}}<!--
 
** LIENS VERS SOUS-PAGES DE DOCUMENTATION, BAC À SABLE ET TESTS **
; Utilisation
--><div id="template_doc_page_transcluded" class="dablink"><!--
: Indiquez quand utiliser ce modèle.
 
-->{{#ifeq:{{{1|{{Documentation/docname}}}}}|{{FULLPAGENAME}}|<!--
; Syntaxe
** LIEN VERS LA PAGE DU MODÈLE, AFFICHÉ SUR UNE SOUS-PAGE DE DOCUMENTATION**
: &lt;pre&gt;&lt;nowiki&gt;{{{{PAGENAME}}|
--><nowiki />
argument1=valeur1|
: ''Ceci est la page de documentation de '''[[{{NAMESPACE}}:{{BASEPAGENAME}}]]'''.'' <!--
argument2=valeur2|
--><small class="plainlinks" style="font-style:normal"><!--
argument3=valeur3|
-->[[{{fullurl:{{FULLPAGENAME}}|action=purge}} rafraîchir]]<!--
etc.|
--> '''·''' <!--
}}&lt;/nowiki&gt;&lt;/pre&gt;
-->{{#ifexist:{{{1|{{NAMESPACE}}:{{BASEPAGENAME}}}}}|<!--
** LE MODÈLE DE BASE EXISTE DÉJÀ **
-->[[{{fullurl:{{{1|{{NAMESPACE}}:{{BASEPAGENAME}}}}}|action=edit}} modifier]]<!--
-->|<!--
** LE MODÈLE DE BASE N’EXISTE PAS ENCORE **
-->[[{{fullurl:{{{1|{{NAMESPACE}}:{{BASEPAGENAME}}}}}|action=edit}} créer]]<!--
-->}}<!--
--> '''·''' <!--
-->[[{{fullurl:{{{1|{{NAMESPACE}}:{{BASEPAGENAME}}}}}|action=history}} historique]]<!--
--></small><!--
-->|<!--
** LIEN VERS SOUS-PAGE DE DOCUMENTATION, AFFICHÉ SUR LA PAGE DU MODÈLE ELLE-MÊME **
-->{{#ifexist:{{{1|{{Documentation/docname}}}}}|<!--
** /Documentation EXISTE **
--><nowiki />
: ''Cette [[Wikipedia:Template documentation|documentation]] est [[w:Aide:Inclusion|incluse]] depuis '''[[{{{1|{{Documentation/docname}}}}}]]'''.'' <!--
--><small class="plainlinks" style="font-style:normal"><!--
-->[[{{fullurl:{{FULLPAGENAME}}|action=purge}} rafraîchir]]<!--
--> '''·''' <!--
-->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} modifier]] <!--
--> '''·''' <!--
-->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} historique]]<!--
--></small><!--
-->|<!--
** /Documentation N’EXISTE PAS ENCORE **
--><nowiki />
: ''Ce modèle n’a pas de sous-page de [[Wikipedia:Template documentation|documentation]] dans '''{{{1|{{Documentation/docname}}}}}'''.''[[Catégorie:Wikilivres:Modèles à documenter]] <!--
--><small class="plainlinks" style="font-style:normal"><!--
-->[[{{fullurl:{{FULLPAGENAME}}|action=purge}} rafraîchir]]<!--
--> '''·''' <!--
-->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit&preload={{urlencode:Modèle:documentation/patron}}}} créer]]<!--
--> '''·''' <!--
-->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} historique]]<!--
--></small><!--
-->}}<!--
-->}}<!--
 
-->{{#switch: {{SUBPAGENAME}}<!--
; Paramètres
-->|bac à sable|tests<!--
:* argument1 : description1 (obligatoire).
--><!--=--><!-- ne pas mettre le "=" en commentaire pour
:* argument2 : description2 (falcultatif, ''défaut2'' par défaut).
** NE PAS AFFICHER CES LIENS SUR LES PAGES DE BAC À SABLE/TESTS **
:* argument3 : description3 (optionnel, lorsque argument2 est fournit, ''défaut2'' par défaut).
-->|#default<!--
:* etc.
-->=<!--
-->{{#switch: {{SUBJECTSPACE}}<!--
-->|{{ns:template}}<!--
-->|{{ns:user}}<!--
-->=<!--
-->{{#ifexist: {{FULLPAGENAME}}/bac à sable|<!--
--><br /><!--
-->Ce modèle dispose d’un [[/bac à sable|bac à sable]] <small style="font-style: normal">([{{fullurl:{{#rel2abs:/bac à sable}}|action=edit}} modifier])</small> <!--
-->{{#ifexist: {{FULLPAGENAME}}/tests|<!--
-->et d’une page de [[/tests|tests]] <small style="font-style:normal">([{{fullurl:{{#rel2abs:/tests}}|action=edit}} modifier])</small><!--
-->}}<!--
--> permettant aux éditeurs d’expérimenter leurs modifications.<!--
-->|<!--
-->{{#ifexist: {{FULLPAGENAME}}/tests|<!--
--><br /><!--
-->Ce modèle dispose d’une page de [[/tests|tests]] <small style="font-style:normal">([{{fullurl:{{#rel2abs:/tests}}|action=edit}} modifier])</small><!--
--> permettant aux éditeurs d’expérimenter avec ce modèle ou de démontrer des anomalies.<!--
-->}}<!--
-->}}<!-- endifexist
-->}}<!-- endswitch subjectspace
-->}}<!-- endswitch subpagename
--></div><!--
 
** AFFICHAGE DU CONTENU OU INCLUSION DE LA SOUS-PAGE DE DOCUMENTATION (SAUF SUR LA PAGE D’AIDE ELLE-MÊME) **
; Variantes
-->{{#if:{{{contenu|{{{content|}}}}}}|<!--
:* [[Modèle:Variantes de ce modèle]]
--><nowiki />
{{{content|}}}<!--
-->|<!--
-->{{#ifeq:{{{1|{{Documentation/docname}}}}}|{{FULLPAGENAME}}|<!--
** PAS DE RÉCURSION SUR LA PAGE DOCUMENTATION ELLE-MÊME, QUI CONTIENT LE RESTE DU TEXTE APRÈS CE MODÈLE **
-->{{#if:{{{nocat|}}}||[[Catégorie:Documentation_de_modèles|{{PAGENAME}}]]}}<!-- Utiliser {{clé de tri}} dans la sous-page pour la trier dans cette catégorie
-->|<!--
-->{{#ifexist:{{{1|{{Documentation/docname}}}}}|<!--
--><nowiki />
{{{{{1|{{Documentation/docname}}}}}|
{{{2|dummy}}}={{{3|}}}|
{{{4|dummy}}}={{{5|}}}|
{{{6|dummy}}}={{{7|}}}|
{{{8|dummy}}}={{{9|}}}<!--
-->}}<!--
-->}}<!--
-->}}<!--
-->}}<!--
 
--><div style="clear:both"></div>
; Voir aussi
</div><!--
:* [[Pages à voir]]
 
NOTE :
[[de:Template:Nom du modèle germanophone équivalent]]
TOUTE LA DOCUMENTATION POUR CE MODÈLE EST INCLUSE CI-DESSUS DEPUIS SA SOUS-PAGE /Documentation
[[en:Template:Nom du modèle anglophone équivalent]]
Les catégories et interwikis sont donc inscrits dans [[Modèle:Documentation/Documentation]]
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
&lt;/noinclude&gt;
</pre>
 
{{NoRobot}}
:Une variante pour de "petits" modèles simples, sans paramètres nommées, "sur une ligne", et avec un exemple :
-->
<pre>&lt;noinclude&gt;&lt;!--
<noinclude>
NE PAS insérer de blanc ou de saut de ligne dans la ligne précédente, sinon cela fausse les résultats !
[[Catégorie:Modèles|{{PAGENAME}}]]
--&gt;
{{Documentation modèle}}
 
; Utilisation : Indiquez quand utiliser ce modèle.
 
; Syntaxe : &lt;code&gt;&lt;nowiki&gt;{{{{PAGENAME}}|1|2|etc.}}&lt;/nowiki&gt;&lt;/code&gt;
:* 1 : description1 (obligatoire).
:* 2 : description2 (falcultatif, ''défaut2'' par défaut).
:* etc.
 
; Exemple : &lt;code&gt;&lt;nowiki&gt;{{<!---->{{PAGENAME}}|..à compléter..}}&lt;/nowiki&gt;&lt;/code&gt; donne <!--
-->{{ {{PAGENAME}}|..idem..}}
 
; Variantes :
:* [[Modèle:Variantes de ce modèle]]
 
; Voir aussi :
:* [[Pages à voir]]
 
[[de:Template:Nom du modèle germanophone équivalent]]
[[en:Template:Nom du modèle anglophone équivalent]]
[[es:Template:Nom du modèle hispanophone équivalent]]
[[it:Template:Nom du modèle italophone équivalent]]
&lt;/noinclude&gt;
</pre>
 
; Voir aussi
:* [[Aide:Modèle#Documentation_du_modèle]]
 
; Variante
:* {{m|Documentation modèle compliqué}} pour documenter un modèle compliqué
 
; Exemples de modèles bien documentés
:* [[Modèle:Coloré]]
:* [[Modèle:Icône de titre]]
:* [[Modèle:Test 2]]
:* [[Modèle:Voir l'aide]] (variante), etc.[[Catégorie:Modèles pour l'espace "Modèle"|Documentation modèle]]
[[Catégorie:Modèles bandeau|Documentation modèle]]
[[en:Template:Template documentation]]
</noinclude>