Ajuda:Modèl/Cossí documentar un modèl ?

Un article de Wikipèdia, l'enciclopèdia liura.
Salta a la navegació Salta a la cerca
Ont documentar ? 
La documentacion d’un modèl pòt èsser facha :
Cal documentar en sospagina dins los cases seguents :
  1. lo modèl es fòrt emplegat e utiliza de paramètres que prenon de valors multiplas (cal alara reduire al minimum lo contengut de las balisas <noinclude>, </noinclude> e sustot, inclure pas la documentacion).
  2. lo modèl e sa documentacion son particularament longs.
  3. se desira tornar prene (ie., inclure) la documentacion dins una pagina d’ajuda.
  4. abans de protegir un modèl, cal desplaçar sa documentacion en sospagina
Cossí documentar jol modèl ? 
Per dispausar d’un formulari de documentacion precargat al moment de la creacion d’un modèl novèl, metètz lo nom de modèl qu'avètz causit dins la boita seguenta e clicatz sul boton "Crear lo modèl" :

Per documentar un modèl ja existent, copiatz, empegatz e adaptatz un dels còdes çaijós a la fin de la font d’un modèl (es a dire just abans son darrièr saut de linha existent, e sens cap d'autre saut de linha inutil apondut aprèp).
Per un "pichon" modèl simple, sens paramètres nomenats, "sus una linha", e amb un exemple :
<noinclude><!--
  Inseriscatz PAS de blanc o de saut de linha dins la linha precedenta, siquenon aquò falsa los resultats !
-->
{{Documentacion modèl}}

; Utilizacion : <!--indicatz quand utilizar aqueste modèl-->.

; Sintaxi : <code><nowiki>{{</nowiki>{{PAGINANAME}}|1|2|etc.}}</code>
:* <code>1</code> : descripcion1 (obligatòri).
:* <code>2</code> : descripcion2 (facultatiu, ''defaut2'' per defaut).
:* etc.

; Exemple : « <code><nowiki>{{</nowiki>{{PAGINANAME}}|<!-- de completar -->}}</code> » balha <!--
-->« {{{{PAGINANAME}}|<!-- de completar a l’identic -->}} »<!--per un modèl simple (sus un linha) -->

; Varianta
:* {{M|<!--nom de modèl connèx-->}}

; Vejatz tanben
:* [[<!--nom de pagina de veire-->]]

[[Categoria:Nom de la categoria del modèl|{{PAGINANAME}}]]

[[de:Template:Nom del modèl germanofòn equivalent]]
[[en:Template:Nom del modèl anglofòn equivalent]]
[[es:Template:Nom del modèl ispanofòn equivalent]]
[[it:Template:Nom del modèl italofòn equivalent]]
</noinclude>
Per un modèl mai complèxe (amb arguments nomenats) :
<noinclude><!--
  Inserissetz PAS de blanc o de saut de linha dins la linha precedenta, siquenon aquò falsa los resultats !
-->
{{Documentacion modèl}}

; Utilizacion :
: <!--indicatz quand utilizar aqueste modèl-->.

; Sintaxi :
 <nowiki>{{</nowiki>{{PAGINANAME}}
 |paramètre1=valor1
 |paramètre2=valor2
 |paramètre3=valor3
 |etc.
 }}

; Paramètres :
:* <code>paramètre1</code> : descripcion1 (obligatòri).
:* <code>paramètre2</code> : descripcion2 (facultatiu, ''defaut2'' per defaut).
:* <code>paramètre3</code> : descripcion3 (opcional, quand <code>paramètre2</code> es provesit, ''defaut3'' per defaut).
:* etc.

; Exemple :
{{Entèsta tablèu "Còde Rendut"}}
|-
|<pre><!-- lo meteis còde --></pre>
|<!-- lo meteis còde -->
|}

; Varianta
:* {{M|<!--nom de modèl connèx-->}}

; Vejatz tanben
:* [[<!--nom de pagina de veire-->]]

[[Categoria:Nom de la categoria del modèl|{{PAGINANAME}}]]

[[de:Template:Nom del modèl germanofòn equivalent]]
[[en:Template:Nom del modèl anglofòn equivalent]]
[[es:Template:Nom del modèl ispanofòn equivalent]]
[[it:Template:Nom del modèl italofòn equivalent]]
</noinclude>
Cossí documentar dins la sospagina del modèl ? 
Copiatz, empegatz e adaptatz lo còde çaijós, dirèctament jos la font del modèl
<noinclude>
{{/Documentacion}}<!-- Metadonadas (categorias, interwikis, …) en sospagina de documentacion -->
</noinclude>
Puèi clicatz sul ligam roge per editar la pagina. La documentacion demòra globalament semblabla.
Per un modèl simple :
{{Documentacion modèl en sospagina}}

; Utilizacion : <!--indicatz quand utilizar aqueste modèl-->.

; Sintaxi : <code><nowiki>{{</nowiki>{{PAGINANAME}}|1|2|etc.}}</code>
:* <code>1</code> : descripcion1 (obligatòri).
:* <code>2</code> : descripcion2 (falcultatiu, ''defaut2'' per defaut).
:* etc.

; Exemple : « <code><nowiki>{{</nowiki>{{PAGINANAME}}|<!-- de completar -->}}</code> » balha <!--
-->« {{ {{PAGINANAME}}|<!-- de completar a l'identic -->}} »<!--per un modèl simple (sus un linha) -->

; Varianta
:* {{M|<!--nom de modèl connèx-->}}

; Vejatz tanben
:* [[<!--nom de pagina de veire-->]]

<includeonly>
<!-- Categorias e interwikis del modèl -->
[[Categoria:Nom de la categoria del modèl|{{PAGINANAME}}]]

[[de:Template:Nom del modèl germanofòn equivalent]]
[[en:Template:Nom del modèl anglofòn equivalent]]
[[es:Template:Nom del modèl ispanofòn equivalent]]
[[it:Template:Nom del modèl italofòn equivalent]]
</includeonly>
Per un modèl mai complèxe (amb arguments nomenats) :
{{Documentacion modèl complicat en sospagina}}


; Utilizacion
: <!--indicatz quand utilizar aqueste modèl-->.

; Sintaxi
 <nowiki>{{</nowiki><!-- nom du modèl -->
 |paramètre1={{Param|valor1}}
 |paramètre2={{Param|valor2}}
 |paramètre3={{Param|valor3}}
 |etc.
 }}

; Paramètres
:* <code>paramètre1</code> : descripcion1 (obligatòri).
:* <code>paramètre2</code> : descripcion2 (facultatiu, ''defaut2'' per defaut).
:* <code>paramètre3</code> : descripcion3 (opcional, quand <code>paramètre2</code> es provesit, ''defaut3'' per defaut).
:* etc.

; Exemple :
{{Entèsta tablèu "Còde Rendut"}}
|-
|<pre><!-- lo meteis còde --></pre>
|<!-- lo meteis còde -->
|}

; Varianta
:* {{M|<!--nom de modèl connèx-->}}

; Vejatz tanben
:* [[<!--nom de pagina de veire-->]]

<includeonly>
<!-- Categorias e interwikis del modèl -->
[[Categoria:Nom de la categoria del modèl|{{PAGINANAME}}]]

[[de:Template:Nom del modèl germanofòn equivalent]]
[[en:Template:Nom del modèl anglofòn equivalent]]
[[es:Template:Nom del modèl ispanofòn equivalent]]
[[it:Template:Nom del modèl italofòn equivalent]]
</includeonly>
Exemples de modèls plan documentats