Modulo:Kahon ti mensahe/dok

Daytoy ket meta-modulo a mangiyasentar kadagiti plantilia ti kahon ti mensahe ti {{mbox}}, {{ambox}}, {{cmbox}}, {{fmbox}}, {{imbox}}, {{ombox}}, ken {{tmbox}}. Daytoy ket naikeddeng a mausar manipud kadagiti modulo ti Lua, ken nasken a saan a dagus a mausar manipud kadagiti panid ti wiki. No kayat nga usaren dagiti annong daytoy a modulo manipud kadagiti panid ti wiki, pangngaasi nga imbes ket nga usaren dagiti plantilia ti kahon ti mensahe.

Panagusar

Ti panagusar daytoy a modulo manipud iti sabali a modulo ti Lua, umuna nga ikarga daytoy.

local messageBox = require('Modulo:Kahon ti mensahe')

Ti agpartuat ti kahon ti mensahe, usaren ti annong ti main. Daytoy ket mangala kadagiti dua a parametro: ti umuna ket ti kita ti kahon (a kas kuerdas), ken ti maikadua ket ti tabla nga aglaon kadagiti parametro ti kahon ti mensahe.

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- Dagiti adu pay a parametro...
})

Adda dagiti pito a mabalin a magun-od a kita ti kahon:

Kita ti kahon	Plantilia	Panggep
mbox	{{mbox}}	Para kadagiti kahon ti mensahe a mabalin nga usaren kadagiti nadumaduma a nagan ti espasio
ambox	{{ambox}}	Para kadagiti kahon ti mensahe ti artikulo
cmbox	{{cmbox}}	Para kadagiti kahon ti mensahe ti kategoria
fmbox	{{fmbox}}	Para kadagiti kahon ti mensahe ti interface
imbox	{{imbox}}	Para kadagiti kahon ti mensahe ti nagan ti espasio ti papeles
tmbox	{{tmbox}}	Para kadagiti kahon ti mensahe ti tungtungan a panid
ombox	{{ombox}}	Para kadagiti kahon ti mensahe dagiti dadduma pay a nagan ti espasio

Kitaen ti panid ti plantilia para iti tunggal maysa a kita ti kahon para kadagiti magun-od a parametro.

Panagusar manipud iti #invoke

No mairaman pay ti annong timain , daytoy a modulo ket adda pay dagiti sabali nga annong para iti tunggal maysa a kita ti kahon. Dagitoy ket mabalin a magun-od babaen ti kodigo ti {{#invoke:Kahon ti mensahe|mbox|...}}, {{#invoke:Kahon ti mensahe|ambox|...}}, kdpy. Daytoy ket mabalin no tawagan manipud kadagiti sabali a modulo, ngem dagitoy ket sumrekda ti kodigo a mangproseso kadagiti argumento a maipasa manipud iti #invoke, isu a ti panagtawag kaniada ket saan a nasaysayaat ngem ti panagtawag ti main.

Dagiti teknikal a salaysay

Daytoy a modulo ket agus-usar ti isu met laeng a batayan a kodigo para kadagiti tunggal maysa a plantilia a nailista dita ngato; ti paggiddiatan a baetan ti tunggal maysa kaniada ket naaramidda nga agusar ti datos idiay Modulo:Kahon ti mensahe/pannakaaramid. Adda dita baba dagiti nadumaduma a pannakaaramid a pagplian ken no ania ti kaibuksilanda:

• types – ti tabla ng aglaon ti datos nga us-usaren babaen ti kita ti parametro ti kahon ti mensahe. Dagiti tekla ti tabla ket isu dagiti pateg a mabalin a maipasa iti kita ti parametro, ken dagiti pateg ti parametro nga aglaon ti klase ti ladawan nga inus-usar iti dayta a kita.
• default – ti kita nga inus-usar no awan ti pateg a naipasa iti kita ti parametro, wenno no nainaganan ti maysa nga imbalido a pateg.
• showInvalidTypeError -no iparang ti maysa a biddut no ti pateg a naipasa iti kita ti parametro ket imbalido.
• allowBlankParams – kadawyan a dagiti blanko a pateg ket maikkatda manipud kadagiti parametro a maipasa iti modulo. Nupay kasta, ti whitespace ket mapreserba para kadagiti parametro a nairaman iti tabla ti allowBlankParams.
• allowSmall – no ti maysa a bassit a bersion ti kahon ti mensahe ket mabalin a mapataud iti "small=yes".
• smallParam – ti naisangayan a nagan para iti bassit a parametro. Kas pagarigan, no maiyasentar iti "left" mabalin ti agpataud ti bassit a kahon ti mensahe no agusar ti "small=left".
• smallClass – ti klase nga usaren para kadagiti bassit a kahon ti mensahe.
• substCheck – no agaramid ti panagkita ti subst wenno saan.
• classes – dagiti nadumaduma a klase a mausar iti kahon ti mensahe.
• usePlainlinksParam – no palubosan ti "plainlinks=no" tapno maiddep ti klase ti plainlinks.
• imageEmptyCell – no agusar ti maysa nga awan linaon a selula ti <td>...</td> no awan ti naiyasentar a ladawan. Daytoy ket inus-usar a mangpreserba ti pagbaetan para kadagiti kahon ti mensahe nga addaan iti kaakaba ti basbassit ngem 100% ti pagbuyaan.
• imageEmptyCellStyle – no dagiti awan linaon a selula ti ladawan ket nasken a maestilo.
• imageCheckBlank – no ti "image=blank" ket pagresultaan iti awan a maiparang a ladawan.
• imageSmallSize – kadawyan, a dagiti ladawan kadagiti bassit a kahon ti mensahe ket naiyasentarda iti 30x30px. Daytoy ket mangiyasentar ti naisangayan a kadakkel.
• imageCellDiv – no rikpan ti ladawan iti div a mangpilit ti kadakkelan a ladawan.
• useCollapsibleTextFields – no usaren dagiti pagikabilan ti teksto a mabalin a marebba, a kas ti "issue", "fix", "talk", kdpy. Agdama laeng a maus-usar iti ambox.
• imageRightNone – no ti imageright=none ket pagresultaan ti awan a maiparang a ladawan iti kanawan a bangir ti kahon ti mensahe.
• sectionDefault – ti kasisigud a nagan ti parametro ti "section". Agdepdepende iti useCollapsibleTextFields.
• allowMainspaceCategories – mangpalubos ti panangikategoria iti umuna a nagan ti espasio.
• templateCategory – ti nagan ti kategoria a maikabilto iti panid ti plantilia.
• templateCategoryRequireName – no ti parametro ti name ket nasken tapno maiparang ti kategoria ti plantilia.
• templateErrorCategory – ti nagan ti kategoria ti biddut a mausarto iti panid ti plantilia.
• templateErrorParamsToCheck – dagiti nadumaduma a nagan ti parametro a kitaento. No adda ti ania man nga awan, ti templateErrorCategory ket maipakat iti panid ti plantilia.