Plantilla:Parameter names example/ús
Aquesta és una subpàgina de documentació per a la Plantilla:Parameter names example Té la informació d'ús, les categories i qualsevol altre contingut que no forma part essencial del codi de la plantilla. |
Aquesta plantilla utilitza una crida a un mòdul de tipus Lua, nom que li ve del llenguatge Lua que utilitza. Per tant, si volguéssiu modificar-la, abans hauríeu d'estar familiaritzats amb aquest llenguatge i les funcions de l'extensió Scribunto. Vegeu com fer proves de plantilles.
Aquesta plantilla utilitza el següent mòdul: |
{{Parameter names example}} – o, alternativament, {{Generic template demo}} – està destinat a ajudar en la documentació de plantilles mitjançant la producció d'una instància genèrica de la plantilla que utilitza noms dels paràmetres com a valors dels paràmetres.
Exemple
[modifica]Aquí utilitzant alguns dels paràmetres d'{{Infobox}}, es mostraria:
{{{above}}} | |
---|---|
{{{subheader}}} | |
{{{subheader2}}} | |
{{{image}}} {{{caption}}} | |
{{{header1}}} | |
{{{label2}}} | {{{data2}}} |
{{{label3}}} | {{{data3}}} |
{{{header4}}} | |
{{{data5}}} | |
{{{data6}}} | |
{{{below}}} |
{{Parameter names example |_template=Infobox |title |above |subheader |subheader2 |image |caption |header1 |label2 |data2 |label3 |data3 |header4 |data5 |data6 |below }}
Notes s'ús
[modifica]Quan {{Parameter names example}} s'utilitza en una subpàgina immediata de la seva plantilla de destinació – per exemple, en la pàgina /ús de la plantilla de destinació – el propi paràmetre |_template=
es pot ometre. En altres paraules, el codi anterior, si s'utilitza en Plantilla:Infobox/pàgina (on la pàgina podria ser "ús", "casos de prova", etc), es convertiria en:
{{Parameter names example |title |above |subheader |subheader2 |image |caption |header1 |label2 |data2 |label3 |data3 |header4 |data5 |data6 |below }}
Un excepció a això és la subpàgina de "proves". Si el mòdul es cridat des de la pàgina "/proves" llavors s'utilitza la mateixa pàgina de proves per generar la plantilla de sortida, no la pàgina base. Per anul·lar aquest comportament només cal especificar el paràmetre |_template=
de forma explícita.
El format dels noms dels paràmetres es pot canviar amb el paràmetre |_display=
. Per defecte, els noms dels paràmetres es mostren entre claus triples, però si s'estableix |_display=italics
o |_display=italic
llavors es mostren en cursiva.
Per assignar un valor personalitzat per a un paràmetre utilitzeu |[parameter name]=[value]
en lloc de |[parameter name]
. Qualsevol format d'un valor tal – incloent, per exemple, cursiva – ha de ser assignat com a part del valor (per exemple |parameter=''valor''<br/>
). Els valors personalitzats no es poden utilitzar per als paràmetres que comencen amb un guió baix ("_").
Vegeu també
[modifica]- Viquipèdia:Documentació de plantilles
- Plantilla:Parameters i Mòdul:Parameters – genera una llista amb els noms dels paràmetres per a una plantilla determinada.