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 lo còdi]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.
- Categorias e ligams interwiki se n'i a. Aital coma la documentacion, aqueles lorcal èsser dins de las etiquetas <noinclude>...</noinclude>.La documentacion d'usatge del modèl se met sovent en una subpàgina del meteis modèl e se compren a la fin de la pagina de modèl. Se separa aital lo còdi del modèl, sovent complèx, del tèxt explicatiu en fasent mai facil lo modificar. Aiçò permet tanben protegir los modèls quand serà necessari mentre demòra dobèrta la modificacion del tèxt de la documentacion per quin usatgièr que siá. En cas que s'aponda lo tèxt de documentacion en lo meteis modèl, en l'utilizar aquel tèxt se lical tanben tractar en la fasent mens efectiva e en redusint los limits impausats de procès pel MediaWiki. En quin cas que siá, la documentacion cal la comprene dins de las etiquetas <noinclude>...</noinclude> de sòrta qu'aparesca pas quand s'utiliza lo modèl en una autre pagina.
Dins la pagina del modèl
[modificar | Modificar lo còdi]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 lo còdi]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.