Module:Message box/doc

Patungkol

Isa itong meta module na gumagawa sa mga padron na kahong pangmensahe (message box): {{mbox}}, {{ambox}}, {{cmbox}}, {{fmbox}}, {{imbox}}, {{ombox}}, at {{tmbox}}. Ginawa ito upang gamitin lang sa ibang mga module ng Lua, at hindi para gamitin nang direkta sa mga pahina ng wiki. Kung gusto niyong gamitin ang kakayahan ng module na ito sa isang pahina ng wiki, pakigamkt po ang mga indibidwal na kahong pangmensahe.

Paggamit

Para magamit ang module na ito sa isang module ng Lua, dapat i-load mo muna ito.

local messageBox = require('Module:Message box')

Para makagawa ng isang kahong pangmensahe, gamitin ang main function. May dalawang parameter ito: ang uri ng kahon (sa string), at ang talahanayan na naglalaman ng mga parameter ng kahong pangmensahe.

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- at iba pang mga parameter...
})

May pitong magagamit na uri ng kahon:

Uri ng kahon	Padron	Gamit
mbox	{{mbox}}	Para sa mga kahong pangmensaheng gagamitin sa maraming namespace.
ambox	{{ambox}}	Para sa mga kahong pangmensahe sa mga artikulo.
cmbox	{{cmbox}}	Para sa mga kahong pangmensahe sa mga kategorya.
fmbox	{{fmbox}}	Para sa mga kahong pangmensahe sa interface.
imbox	{{imbox}}	Para sa mga kahong pangmensahe sa file namespace.
tmbox	{{tmbox}}	Para sa mga kahong pangmensahe sa mga pahina ng usapan.
ombox	{{ombox}}	Para sa mga kahong pangmensahe sa mga namespace na hindi nabanggit dito.

Tingnan ang dokumentasyon ng mga indibidwal na padron para sa mas detalyadong impormasyon.

Paggamit sa #invoke

Bukod sa main function, may mga hiwalay na function ang module na ito para sa bawat uri ng kahon. Maa-access sila gamit ang code na {{#invoke:Message box|mbox|...}}, {{#invoke:Message box|ambox|...}}, atbp. Gagana sila kapag tinawag sa ibang mga module, pero kaya nilang ma-access ang code na ginamit para iproseso ang mga argumentong pinasa sa #invoke, kaya naman mas mahina ito kesa sa pagtawag sa main.

Mga detalyeng teknikal

Ginagamit ng module ang parehong basic code para sa bawat padron na nakalista sa taas; makikita at masasaayos sa Module:Message box/configuration ang kani-kanilang pagkakaiba. Heto ang iba't-ibang mga pagsasaayos at kung ano-ano ang ibig sabihin nila:

• types – talahanayan na naglalaman ng data na ginagamit ng |type= parameter ng kahong pangmensahe. Mga value ang mga key ng talahanayan na maipapasa sa |type=, at talahanayan ang mga value na naglalaman ng class at ang image na ginamit ng uri na yon.
• default – ang uri na na gagamitin kung walang value na pinasa sa |type=, kung invalid yung binigay na value.
• showInvalidTypeError – kung magpapakita ng error kung invalid ang pinasang value sa |type= parameter.
• allowBlankParams – madalas, tinatanggal ang mga blangkong value mula sa mga parameter na pinasa sa module. Gayunpaman, pinepreserba ang whitespace para sa mga parameter na sinama sa talahanayan ng allowBlankParams.
• allowSmall – kung gagawa ba ng maliit na bersyon ng kahong pangmensahe (|small=yes).
• smallParam – custom na pangalan para sa |small= parameter. Halimbawa, kung "left" ito, makakagawa ka ng maliit na kahong pangmensahe gamit ang |small=left.
• smallClass – ang class na gagamitin para sa mga maliliit na kahong pangmensahe.
• substCheck – kung magsasagawa ng subst check o hindi.
• classes – array ng mga class na gagamitin sa kahong pangmensahe.
• imageEmptyCell – kung gagamit ba ng isang blangkong <td>...</td> cell kung walang nakatakdang larawan. Gagamitin ito para mapreserba ang espasyo para sa mga kahong pangmensahe na may width na mas maliit para sa 100% ng screen.
• imageEmptyCellStyle – kung lalagyan ba ng istilo ang mga blangkong cell ng larawan.
• imageCheckBlank – kung magreresulta ba ang |image=blank sa walang larawang ipapakita.
• imageSmallSize – madalasz nakatakda sa 30×30px ang mga larawang ginagamit sa mga maliliit na kahong pangmensahe. Nagtatakda ito ng isang custom na sukat.
• imageCellDiv – kung ilalagay ba ang larawan sa isang <div>...</div> na may maximum na sukat ng larawan.
• useCollapsibleTextFields – kung gagamit ba ng mga text field na pwedeng masara, hal. "isyu", "ayos", "usap", atbp. Ginagamit lang ng ambox sa ngayon.
• imageRightNone – kung magreresulta ba ang |imageright=none sa walang ipinapakitang larawan sa kanang bahagi ng kahong pangmensahe.
• sectionDefault – ang default na pangalan na gagamitin ng |section= parameter. Nakadepende sa useCollapsibleTextFields.
• allowMainspaceCategories – nagpapahintulot sa pagkakategorya sa main namespace.
• templateCategory – ang pangalan ng kategoryang ilalagay sa pahina ng padron.
• templateCategoryRequireName – kung gagawin bang required ang |name= para maipakita ang kategorya ng padron.
• templateErrorCategory – ang pangalan ng kategorya ng error na gagamitin sa pahina ng padron.
• templateErrorParamsToCheck – array ng mga pangalan ng parameter na sisilipin. Kung wala ang alinman sa mga ito, ilalagay ang templateErrorCategory sa pahina ng padron.