Patrono:Documentation

[] [] []

Info

Documentation del patrono

Description

Da un description del maniera de utilisar un patrono. Iste description generalmente se mantene in le subpagina /doc del patrono in question.

Parametros del patrono[Modificar le datos del patrono]

Parametro		Description	Typo	Stato
Pagina de documentation	pagina	Nomine del pagina de documentation a usar in loco del subpagina /doc del presente patrono. Specificar solmente in casos exceptional, p.ex. quando un serie de patronos debe condivider un pagina de documentation. Valor predefinite {{FULLPAGENAME}}/doc	Nomine de pagina	optional

Ubi e como usar lo

Mitte un simple {{Documentation}} sin parametros inter <noinclude>…</noinclude> in le patrono mesme (non in un subpagina). Isto inquadra automaticamente le contento del subpagina /doc, le qual pote esser scribite como pagina wiki normal. Si iste subpagina non existe, appare un texto que invita le usator a crear lo; le formulario de modification essera pre-completate con un modello que pote adjutar te a comenciar, e le editor graphic de datos de patrono (TemplateData) se invoca automaticamente pro facilitar le documentation structurate de parametros.

Notas

• Nomines alternative de iste patrono: {{Docpatrono}}, {{Template doc}}.
• Le ligamine “[refrescar]” vacua le cache del pagina. Isto es utile pro facer le ultime modificationes del documentation apparer immediatemente in le pagina del patrono mesme. Alteremente, il pote durar alcun dies ante que le cache expira.
• Vide etiam: {{Documentation libere}}, {{tl}}, {{tlx}}.

Si tu crea nove documentation pro un patrono, tu pote cessar de leger ora. Le resto de iste pagina describe un practica historic que, a causa de su complicationes e manco de flexibilitate, non es recommendate pro crear nove documentation.

Uso obsolete

Pro mantener le compatibilitate con le usage historic sur Wikipedia in interlingua, iste patrono ha duo altere modos de uso:

1. Usage con parametros in un subpagina del patrono:

   Transclude iste patrono in un subpagina /doc del patrono; i.e., in un pagina con le mesme titulo con /doc adjungite. Postea, include lo in le patrono mesme como <noinclude>{{/doc}}</noinclude>. Le documentation in iste forma crea un quadro dividite in quatro sectiones fixe: "Description", "Quando usar lo", "Como usar lo" e "Notas". Le sequente duo formas de syntaxe se applica:

   a. {{Documentation|Describe le patrono in question|Dice quando usar le patrono|<nowiki>Da un exemplo pro le correcte utilisation del patrono</nowiki>|indicationes additional}}

   b. {{Documentation|description = Describe le patrono in question|quando = Dice quando usar le patrono|como = <nowiki>Da un exemplo pro le correcte utilisation del patrono</nowiki>|notas = indicationes additional}}

2. Usage con parametros in le pagina principal del patrono:

   Mitte {{Documentation}} con le quatro parametros del modo 1 (describite supra) inter <noinclude>…</noinclude> in le patrono mesme. Iste modo es identic al modo 1 excepte le uso del subpagina /doc. Pro modificar le documentation, es necessari modificar le patrono mesme (isto pote esser un problema si su modification es limitate pro impedir le vandalismo).

Notas pro le modos obsolete

• Iste modos non es recommendate pro le documentation de nove patronos, perque illos es troppo complexe a mantener e care de flexibilitate.
• Le forma 1(b) hic supra, con le parametros a nomine, es plus facile a usar que 1(a), perque le forma 1(b) remove automaticamente omne spatios blanc al initio e fin del valores. Isto stoppa problemas impreviste de disposition graphic. In ultra, iste forma permitte mitter le parametros in qualcunque ordine desirate.
• Importante! Insere <nowiki> e </nowiki> in le valor del parametro como (le tertie). Inter le etiquettas nowiki tu pote scriber normalmente le symbolos {{, }} e |.
• Si un subpagina /doc existe, le ligamine "modificar" in le quadro se adapta automaticamente pro punctar verso le subpagina. Alteremente, illo puncta verso le patrono mesme.