Ajuda:Documentacion de modèl
Los modèls pòdon esser modificats per totes los contributors mas d'unes modèls son complicats. Per aquesta rason los cal documentar e explicar clarament çò que fa lo modèl. Un utilizaire pas forçadament experimentat deu poder utilizar lo modèl corrèctament .
Utilizacion[modificar | modificar la font]
La documentacion d'un modèl se pòt far de dos biais :
- directament dins la pagina del modèl ,
- dins una sos-pagina dedicada del modèl /Documentacion.
Dins la pagina del modèl[modificar | modificar la font]
Cal metre a la fin de la pagina del modèl :
<noinclude>{{Documentacion|contenu= == Utilizacion == ... }} <!-- Categorias del modèl --> </noinclude>
Nòtas :
- L'inclusion de la documentacion dins la pagina del modèl es utila quand lo modèl es simple.
- Se lo modèl es protegit, lo contengut de la documentacion deu esser desplaçat dins la sos-pagina /Documentacion.
- Lo modèl deu esser enrodat de las balisas <noinclude>...</noinclude> pour evitar son inclusion quand es demandat.
- Lo paramètre
|contenu=
pren pas en carga la sintaxi MediaWiki dels tablèus. Per resòlvre aqueste problèma, cal transformar la sintaxi MediaWiki en còdi HTML o transferir lo contengut de la documentacion dins la sos-pagina /Documentacion.
En sos-pagina dedicada[modificar | modificar la font]
Cal metre a la fin de la pagina del modèl :
<noinclude>{{Documentacion}}</noinclude>
Puèi publicar lo modèl. Aprèp, crear la pagina Modèl:<nom del modèl>/Documentacion Ajustar al cap de la pagina Puèi completar la documentacion e publicar.
Cal documentar en sos-pagina dins los cases seguents :
- Lo modèl es fòrça emplegat e utiliza de paramètres que prenon mantun valor
- Lo modèle e/o sa documentacion son fòrça longs .
- Vòlon inclure la documentacion dins una pagina d'ajuda.
- Abans de protegir un modèl, cal desplaçar sa documentacion dins una sos-pagina.