ماڊيول:Message box/doc

هي هڪ ميٽا-ماڊيول آهي، جيڪو پيغام خاني وارن سانچن {{mbox}}، {{ambox}}، {{cmbox}}، {{fmbox}}، {{imbox}}، {{ombox}} ۽ {{tmbox}} کي لاڳو ڪري ٿو. اهو Lua ماڊيولن مان استعمال ڪرڻ لاءِ ٺاهيو ويو آهي، ۽ ان کي سڌو سنئون وڪي صفحن تان استعمال نه ڪرڻ گهرجي. جيڪڏهن توهان هن ماڊيول جي ڪارڪردگي کي ڪنهن وڪي صفحي تان استعمال ڪرڻ چاهيو ٿا، ته پوءِ ان جي بدران انفرادي پيغام خاني وارا سانچا استعمال ڪريو.

استعمال

هن ماڊيول کي ڪنهن ٻئي Lua ماڊيول مان استعمال ڪرڻ لاءِ، سڀ کان پهرين ان کي لوڊ ڪرڻو پوندو.

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

پيغام خانو ٺاهڻ لاءِ main فنڪشن استعمال ڪيو ويندو آهي. اهو ٻه پيرا ميٽر وٺي ٿو: پهريون خاني جو قسم (string جي صورت ۾)، ۽ ٻيو هڪ ٽيبل جنهن ۾ پيغام خاني جا پيرا ميٽر شامل هجن.

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- وڌيڪ پيرا ميٽر...
})

خاني جا ست موجود قسم آهن:

خاني جو قسم	سانچو	مقصد
mbox	{{mbox}}	ڪيترن ئي نيم جڳهن ۾ استعمال ٿيندڙ پيغام خانن لاءِ
ambox	{{ambox}}	مقالي وارن پيغام خانن لاءِ
cmbox	{{cmbox}}	زمري وارن پيغام خانن لاءِ
fmbox	{{fmbox}}	مواجيهي پيغام خانن لاءِ
imbox	{{imbox}}	فائيل نيم جڳهه جي پيغام خانن لاءِ
tmbox	{{tmbox}}	بحث صفحي جي پيغام خانن لاءِ
ombox	{{ombox}}	ٻين نيم جڳهن جي پيغام خانن لاءِ

هر خاني جي قسم لاءِ موجود پيرا ميٽر ڏسڻ خاطر ان سانچي واري صفحي کي ڏسو.

#invoke مان استعمال

main فنڪشن کان علاوه، هن ماڊيول ۾ هر خاني جي قسم لاءِ الڳ فنڪشن به موجود آهن. انهن تائين {{#invoke:Message box|mbox|...}}، {{#invoke:Message box|ambox|...}} وغيره ذريعي پهچ حاصل ڪئي ويندي آهي. اهي فنڪشن ٻيا ماڊيول به سڏي سگهن ٿا، پر اهي انهن دليلن کي سنڀالڻ واري ڪوڊ تائين رسائي ڪن ٿا جيڪي #invoke مان پاس ڪيا وڃن ٿا، تنهن ڪري انهن کي سڌو main سڏڻ جي ڀيٽ ۾ گهٽ ڪارائتو سمجھيو ويندو آهي.

فني تفصيل

هي ماڊيول مٿي ڄاڻايل هر سانچي لاءِ ساڳيو بنيادي ڪوڊ استعمال ڪري ٿو؛ انهن جي وچ ۾ فرق Module:Message box/configuration ۾ ڏنل ڊيٽا ذريعي ترتيب ڏنل آهن. هيٺ مختلف ترتيب جا اختيار ۽ انهن جا مطلب ڏجن ٿا:

• types – هڪ ٽيبل، جنهن ۾ پيغام خاني جي type پيرا ميٽر لاءِ استعمال ٿيندڙ ڊيٽا هوندي آهي. ٽيبل جون ڪنجيون اهي قدر آهن جيڪي type پيرا ميٽر ڏانهن موڪليا وڃن ٿا، ۽ ٽيبل جون قيمتون اهي ٽيبلون آهن، جن ۾ انهيءَ قسم لاءِ class ۽ image هوندا آهن.
• default – اهو قسم جيڪو تڏهن استعمال ٿيندو جڏهن type پيرا ميٽر لاءِ ڪا قيمت نه ڏني وئي هجي، يا غلط قيمت ڏني وئي هجي.
• showInvalidTypeError – ڇا type پيرا ميٽر لاءِ ڏنل غلط قيمت جي صورت ۾ غلطي ڏيکارڻي آهي يا نه.
• allowBlankParams – عام طور تي ماڊيول ڏانهن موڪليل پيرا ميٽرن مان خالي قيمتون ڪڍي ڇڏيون وينديون آهن. پر allowBlankParams ٽيبل ۾ شامل پيرا ميٽرن لاءِ خالي جڳهه محفوظ رکي ويندي آهي.
• allowSmall – ڇا "small=yes" سان پيغام خاني جو ننڍو روپ ٺاهي سگهجي ٿو يا نه.
• smallParam – small پيرا ميٽر لاءِ ڪو خاص نالو. مثال طور، جيڪڏهن ان کي "left" رکيو وڃي، ته "small=left" ذريعي ننڍو پيغام خانو ٺاهي سگهجي ٿو.
• smallClass – ننڍن پيغام خانن لاءِ استعمال ٿيندڙ class.
• substCheck – ڇا subst چڪاس ڪرڻي آهي يا نه.
• classes – classes جي هڪ فهرست، جيڪي پيغام خاني سان استعمال ٿينديون.
• imageEmptyCell – جيڪڏهن ڪا تصوير مقرر نه هجي، ته ڇا خالي <td>...</td> خانو استعمال ڪجي. اهو انهن پيغام خانن جي فاصلي کي برقرار رکڻ لاءِ استعمال ٿيندو آهي، جن جي ويڪر اسڪرين جي 100٪ کان گهٽ هجي.
• imageEmptyCellStyle – ڇا خالي تصويري خانن کي طرز ڏني وڃي يا نه.
• imageCheckBlank – ڇا "image=blank" جي نتيجي ۾ ڪا تصوير نه ڏيکاري وڃي.
• imageSmallSize – عام طور تي ننڍن پيغام خانن ۾ تصويرون 30x30px تي مقرر ڪيون وينديون آهن. هي اختيار ڪا خاص ماپ مقرر ڪري ٿو.
• imageCellDiv – ڇا تصوير کي اهڙي div ۾ رکيو وڃي جيڪا تصوير جي وڌ ۾ وڌ ماپ تي ضابطو رکي.
• useCollapsibleTextFields – ڇا اهڙا متن وارا خانا استعمال ڪيا وڃن جيڪي ويڙهجي سگهن، جهڙوڪ "issue"، "fix"، "talk" وغيره. هن وقت اهو رڳو ambox ۾ استعمال ٿئي ٿو.
• imageRightNone – ڇا imageright=none جي صورت ۾ پيغام خاني جي ساڄي پاسي ڪا تصوير نه ڏيکاري وڃي.
• sectionDefault – "section" پيرا ميٽر لاءِ اڳواٽ نالو. اهو useCollapsibleTextFields تي دارومدار رکي ٿو.
• allowMainspaceCategories – مکيه نيم جڳهه ۾ زمري بندي جي اجازت ڏيڻ.
• templateCategory – اهو زمرو جنهن جو نالو سانچي واري صفحي تي رکيو وڃي.
• templateCategoryRequireName – ڇا name پيرا ميٽر لازمي آهي ته جيئن سانچي جو زمرو ڏيکاري سگهجي.
• templateErrorCategory – غلطي واري زمري جو نالو، جيڪو سانچي واري صفحي تي استعمال ٿيندو.
• templateErrorParamsToCheck – پيرا ميٽرن جي نالن جي هڪ فهرست، جن جي چڪاس ڪرڻي آهي. جيڪڏهن انهن مان ڪو به غير موجود هجي، ته templateErrorCategory سانچي واري صفحي تي لاڳو ڪيو ويندو.