มอดูล:Message box/doc

นี่คือหน้าคู่มือการใช้งานของ มอดูล:Message box
ใช้ในการเขียนคำอธิบายแม่แบบหรือมอดูลและใส่หมวดหมู่ ส่วนลิงก์ข้ามภาษาโปรดใช้วิกิสนเทศ

แม่แบบนี้ใช้ในข้อความของระบบ
การเปลี่ยนแปลงแม่แบบนี้ทำให้เกิดการเปลี่ยนแปลงต่อส่วนติดต่อผู้ใช้ของวิกิพีเดียในทันที เพื่อหลีกเลี่ยงความผิดพลาด การทำการเปลี่ยนแปลงใด ๆ ควรทดลองในหน้าย่อย /sandbox ของแม่แบบก่อน หรืออาจจะทดลองในหน้าย่อยของหน้าผู้ใช้ของคุณ โปรดแจ้งในหน้าอภิปรายก่อนทำการแก้ไข

มอดูลนี้ขึ้นอยู่กับมอดูลอื่น ๆ ดังต่อไปนี้

มอดูลนี้ใช้ TemplateStyles:

การใช้งาน แก้

หากต้องการใช้มอดูลนี้จากมอดูลลูอาอื่น คุณต้องโหลดมอดูลก่อน

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

ในการสร้างกล่องข้อความ ให้ใช้ฟังก์ชัน main ต้องใช้พารามิเตอร์สองตัว ตัวแรกคือประเภทกล่อง (เป็นสตริง) และตัวที่สองคือตารางที่มีพารามิเตอร์ของกล่องข้อความ

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- More parameters...
})

มีกล่องที่ใช้ได้เจ็ดประเภท ดังนี้

ประเภทกล่อง	แม่แบบ	วัตถุประสงค์
`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