Mòdul:Labelled list hatnote/ús
 | Aquesta és una subpàgina de documentació per a la Mòdul:Labelled list hatnote Té la informació d'ús, les categories i qualsevol altre contingut que no forma part essencial del codi del mòdul. |
 | 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 els següents mòduls: |
Aquest mòdul ofereix un grapat de funcions que faciliten la implementació de notes de text que prenen la forma d'una etiqueta davant d'una llista de pàgines, per exemple:
Ús[modifica]
labelledList[modifica]
Invocar la funció labelledList() és suficient per implementar la majoria de plantilles d'aquest tipus:
{{#invoke:Labelled list hatnote|labelledList|Etiqueta universal}}
o
{{#invoke:Labelled list hatnote|labelledList|Etiqueta singular|Etiqueta plural}}
Per exemple, proporcionar "Vegeu també" en lloc d'"Etiqueta universal" duplica la funcionalitat de {{Vegeu també}}, mentre que proporcionar "Article principal" i "Articles principals" en lloc d'"Etiqueta singular" i "Etiqueta plural" duplica la funcionalitat de l'(espai de noms de l'article) d'{{Article principal}}.
Si es proporcionen una tercera i una quarta etiquetes, s'utilitzaran en el cas que qualsevol de les pàgines de destinació estigui fora de l'espai de noms de l'article, per exemple a {{Article principal}} es pot implementar així:
{{#invoke:Labelled list hatnote|labelledList|Article principal|Articles principals|Pàgina principal|Pàgines principals}}
preprocessDisplays[modifica]
La funció preprocessDisplays() pren una llista bruta d'arguments i es combina en qualsevol argument de visualització. Per exemple, {{see also|1|l1=Un}} inicialment té la taula d'arguments {'1', ['l1'] = 'Un'}; aquesta taula les combinaria a la taula {'1|Un'}. Anul·la la canalització manual (p. ex., {{vegeu també|1{{!}}2|l1=Un}} → {'1|Un'} i comprimeix les matrius disperses si s'omet un paràmetre o es deixa buit.
Exemple:
Example:
local mLabelledList = require('Module:Labelled list hatnote')
local pages = mLabelledList.preprocessDisplays(args)
_labelledList[modifica]
Per als mòduls que necessiten modificar lleugerament la funcionalitat mentre encara l'utilitzen, _labelledList() ofereix certa flexibilitat. Es necessita tres paràmetres:
- Una llista de pàgines, preferiblement preprocessades i comprimides per
preprocessDisplays - Una taula d'etiquetes, on el primer element és l'etiqueta singular o universal, i el segon una etiqueta plural o una còpia de la primera.
- Una taula d'opcions, preferiblement que contingui:
- una cadena de
templateamb el títol complet de la plantilla. Per defecte el títol d'aquest mòdul. - una cadena de
category(o nil) tal com la presamakeWikitextErrordelModule:Hatnote, per desactivar les categories d'error opcionalment - una cadena de
selfref(o nil) tal com la pren_hatnoteper habilitar l'opció selfref
- una cadena de
Exemple:
local mLabelledList = require('Module:Labelled list hatnote')
return mLabelledList._labelledList(pages, labels, options)
Errors[modifica]
Aquest mòdul fa que les plantilles basades en ell produeixin un missatge d'error si no es proporcionen noms de pàgina com a paràmetres de plantilla. Normalment, haurien de tornar a les seccions "Errors" de la documentació d'aquestes plantilles. Tanmateix, si aquestes plantilles utilitzen un mòdul amb _labelledList() i no proporcionen un element de plantilla a la seva taula d'opcions, aquest error es mostra per defecte aquí. L'error es pot resoldre proporcionant almenys un paràmetre de nom de pàgina vàlid a la plantilla en qüestió; el problema de la plantilla es pot solucionar proporcionant algun valor a l'element de template de la taula d'options _labelledList().