Mòdul:Hatnote/ús
 | Aquesta és una subpàgina de documentació per a la Mòdul: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 utilitza TemplateStyles: |
Aquest és un metamòdul que proporciona diverses funcions per fer notes d'encapçalament. Implementa la plantilla {{hatnote}}, per utilitzar-la en notes d'encapçalament a la part superior de les pàgines, i la plantilla {{format link}}, que s'utilitza per formatar un enllaç wiki per utilitzar-lo en notes d'encapçalament. També conté una sèrie de funcions auxiliars per utilitzar-les en altres mòduls de Lua hatnote.
Ús des de wikitext[modifica]
Les funcions d'aquest mòdul no es poden utilitzar directament des de #invoke, sinó que s'han d'utilitzar mitjançant plantilles. Si us plau, vegeu Plantilla:Hatnote i Plantilla:Format link per a la documentació.
Ús des d'altres mòduls de Lua[modifica]
Per carregar aquest mòdul des d'un altre mòdul Lua, utilitzeu el codi següent.
local mHatnote = require('Mòdul:Hatnote')
A continuació, podeu utilitzar les funcions tal com es documenta a continuació.
Hatnote[modifica]
mHatnote._hatnote(s, opcions)
Formata la cadena s com a nota d'encapçalament. Això inclou s amb les etiquetes <div class="hatnote">...</div>. Les opcions es proporcionen a la taula options. Les opcions inclouen:
- options.extraclasses: una cadena de classes addicionals a proporcionar
- options.selfref: si això no és nul o fals, afegeix la classe "selfref", que s'utilitza per indicar les autoreferències a la Viquipèdia (vegeu Plantilla:Selfref))
El CSS de la classe hatnote es defineix a Mòdul:Hatnote/styles.css.
- Exemple 1
mHatnote._hatnote('Aquesta és una nota.')
Produeix:
<div class="hatnote">Aquesta és una nota.</div>
Es mostra com a:
- Exemple 2
mHatnote._hatnote('Aquesta és una nota.', {extraclasses = 'boilerplate seealso', selfref = true})
Produeix:
<div class="hatnote boilerplate seealso selfref">Aquesta és una nota.</div>
Es mostra com a:
Cerca l'identificador de l'espai de noms[modifica]
mHatnote.findNamespaceId(enllaç, remove Colon)
Troba l'identificador de l'espai de noms de la cadena enllaç, que hauria de ser un nom de pàgina vàlid, amb o sense el nom de la secció. Aquesta funció no funcionarà si el nom de la pàgina està entre claudàtors. Quan s'intenta analitzar el nom de l'espai de noms, els dos punts s'eliminen de l'inici de l'enllaç de manera predeterminada. Això és útil si els usuaris han especificat dos punts quan no són estrictament necessaris. Si no necessiteu comprovar els dos punts inicials, configureu removeColon com a false.
- Exemples
mHatnote.findNamespaceId('Lleó')→ 0mHatnote.findNamespaceId('Categoria:Lleons')→ 14mHatnote.findNamespaceId(':Categoria:Lleons')→ 14mHatnote.findNamespaceId(':Categoria:Lleons', false)→ 0 (l'espai de noms es detecta com a ":Categoria", en lloc de "Categoria")
Comenta un error de wikitext[modifica]
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
Formata la cadena msg com a missatge d'error wikitext en vermell, amb un enllaç opcional a una pàgina d'ajuda helpLink. Normalment aquesta funció també afegeix Categoria:Plantilles de Hatnote amb errors (0). Per suprimir la categorització, passeu false com a tercer paràmetre de la funció (addTrackingCategory).
Exemples:
mHatnote.makeWikitextError("s'ha produït un error")→ Error: s'ha produït un error.mHatnote.makeWikitextError("s'ha produït un error", 'Plantilla:Exemple#Errors')→ Error: s'ha produït un error (ajuda).