Modulo:Çitaçión/man

Questa è la pagina di documentazione per Modulo:Çitaçión

Quésto Mòdolo Lua o sèrve pò-u fonçionaménto di template {{Çitta lìbbro}}, {{Çitta web}} e {{Çitta publicaçión}}.

Chi de sótta gh'é e instruçioìn e-e nòtte técniche in sciô fonçionaménto do mòdolo.

Sotomòdoli

Modulo:Çitaçión/Configurazione: o contêgne e tabélle de configuraçión co-i nómmi di paràmetri, i mesàggi d'erô e-e âtre fonçionalitæ.
Modulo:Çitaçión/Whitelist: o contêgne e tabélle di paràmetri acetæ da-o mòdolo pe poéi identificâ paràmetri co-in nómme eròu.
Modulo:Çitaçión/Sugeriménti: o contêgne 'na tabélla dónde l'é poscìbile inserî i nómmi di paràmetri inaræ de spésso e sugerî into mesàggio d'erô o nómme do paràmetro corètto.
Modulo:Çitaçión/Argoménti: o sèrve a generâ Modulo:Çitaçión/Whitelist e o l'é dêuviòu una tantum.

Fonçioìn acesòrie

Nòtta che pe çernûa se inténde 'na variàbile despægia da nil e da-a strìnga vêua.

is_set(var)

o l'é vêo se 'na variàbile a l'é çernûa.

first_set(...)

o restitoìsce a prìmma variàbile çernûa.

inArray(needle, haystack)

o scandìsce l'array haystack e o restitoìsce a poxiçión dónde se trêuva o valô needle. Se needle o l'é 'n valô ch'o no se trêuva inte haystack o l'é nil e o restitoìsce false.

substitute(msg, args)

o restitoìsce a strìnga msg compilaa adêuviando a tabélla di valoî args. Se baza in sciâ fonçión mw.message.newRawMessage e se args l'è nil restitoìsce nil.

wrap(key, str, lower)

o l'elàbora o mesàggio key co-a strìnga str. O paràmetro key o dêv'êse 'n ìndice da tabélla citation_config.messages. Se lower o l'é vêo o mesàggio o vêgne scrîto in minóscolo prìmma de inserîghe str.

debug_msg(msg)

o l'inserìsce 'n mesàggio de debug inta côa di mesàggi d'erô pe êse emìsso in sciô vìdeo.

debug_value(name, value)

o l'inserìsce o mesàggio de debug name = value. Dêuviâ pe emétte o valô de 'na variàbile, da uzâ prezénpio cómme debug_value ('name', name).

argument_wrapper( args )

o restitoìsce 'na tabélla pe acêde a-i valoî da tabélla òriginâle args pe mêzo de 'na tabélla de alias. Dæta l'instruçión A=argument_wrapper(args), a ciamâ A[key] e o valô args[first_set(citation_config.aliases[key])], o fâ vegnî poscìbile a localizaçión di paràmetri e a creaçión de alias pò-u mæximo valô.
Prezénpio se citation_config.aliases['Chapter'] = {'capitolo', 'contributo', 'voce', 'articolo', 'sezione' } a ciamâ A['Chapter'] a restitoiâ un di valoî çernûi tra args['capitolo'], args['contributo'], args['voce'], args['articolo'] e args['sezione']. De ciù, o l'azónze o método A:ORIGIN, ch'o restitoìsce l'alias ch'o gh'é stæto atrovòu insémme e 'n valô. I valoî coscì trovæ són inserîi inte 'na tabélla intèrna.

Azónze 'n mesàggio a-a côa d'eroî se:

key o no l'é prezénte inte citation_config.aliases.
key o l'é 'na tabélla de valoî e ciù d'un de sti valoî chi o l'é stæto çernûo.
se in args o no l'é stæto trovòu nisciùn valô corispondénte a un di alias de key o restitoìsce 'na strìnga vêua "".

validate(name): o restitoìsce true se name o no l'é nil e se o l'é o nómme de 'n paràmetro acetòu, sedónca o restitoìsce false.
errorcomment( content, hidden ): o l'elàbora o coménto comment pi-â vizoalizaçión, se hidden o l'é true o còdice o saiâ inserîo ma sénse êse vixìbile (se doviâ analizâ o còdice html da pàgina), âtriménti o saiâ formatòu segóndo e inpostaçión de clàsse "error" e "citation-comment" into css, normalménte scrîte in rósso.
seterror( error_id, arguments, raw, prefix, suffix ): o l'elàbora o coménto co-o còdice error_id e co-a tabélla de argoménti arguments. Se in scàngio de prefix ò de suffix l'é stæto inserîo 'n valô, són poxiçionæ rispetivaménte prìmma ò dòppo o mesàggio. Se raw o l'é true o mesàggio o l'é restitoîo sénsa êse pasòu prìmma pe errorcomment.; a ciâve error_id a fà riferiménto a-a tabélla de mesàggi citation_config.error_conditions , che pe ògni còdice d'erô a restitoìsce o mesàggio da formatâ, a categorîa d'erô dónde inserî a vôxe e se o mesàggio gh'à da êse vixìbile ò ascôzo.

Fragment

Pe gestî l'unión di tòcchi de çitaçion l'é definîo 'n ògètto Lua scìmile a 'na tabélla formâ da di fragment ch'én costitoîi da 'n array ch'o gh'à cómme prìmmo eleménto 'na strìnga da inserî a l'inprinçìpio da sequénsa, con dòppo unn-a o ciù strìnghe e terminànte co-ina strìnga da inserî a-a fìn da sequénsa. Quànde i doî fragment f1 e f2 són unîi (véddi fragment.append e fragment.appends) l'é decîzo a prioritæ de l'ùrtimo separatô de f1 con quélla do prìmmo de f2 e conservòu sôlo quéllo co-a prioritæ ciù èrta. O nêuvo fragment o l'aviâ o separatô iniçiâle de f1 e quéllo finâle de f2.

Fragment.new(text, sep_key)

crêa 'n squæxi-ògètto Lua ch'o memorìzza l'array de strìnghe text dêuviando còmme separatô tra 'na strìnga e 'n'âtra sep_key. Fisâ còmme separatô iniçiâle pi-â sequénsa 'na strìnga vêua e cómmme separatô finâle sep_key. O restitoìsce l'ògètto creòu.

Sep_key o dêv'êse 'a ciâve da tabélla Fragment.priority che pe ògni separatô a l'ìndica a sò prioritæ (dónca o separatô ch'o prevâ quànde doî tòcchi són unîi) e cösa inserî ezataménte (prezénpio pe "," o l'inserìsce ", " - azonzendoghe 'n spàçio). A tabèlla a l'é caregâ da-o mòdolo de configuraçión, prezénpio:

[""] = { order=0, sep = ""},

[" "] = { order=1, sep = " "},

[","] = { order=2, sep = ", "},

["."] = { order=3, sep = ". "},

["in"] = {order=4, sep = " in "},

[" "] = { order=5, sep = " "}, spàçio sénplice ch'o prevâ in scî âtri separatô.

["nothing"] = {order=6, sep="" } strìnga vêua ch'a prevâ in sce tùtto.

Fragment:start(sep_key): o çèrne còmme separatô iniçiâle sep_key.
Fragment:last(sep_key): o çèrne còmme separatô finâle sep_key.
Fragment:empy(sep_key): o restitoìsce true se fragment o l'P 'n tòcco vêuo (o contêgne 'n array de strìnghe vêuo).
Fragment:append(txr): o l'apénde o fragment ò a strìgna txr a-a fìn de fragment (into câxo che txr o ségge 'na strìnga a scàngia inte fragment con sep_key pægia a quélla apéiza a-o fragment).
Fragment:appends(txr): o l'apénde 'n array mésccio de fragment/strìnghe.