แม่แบบ:Abbr/doc

สำหรับแม่แบบที่ใช้สำหรับการลบเนื้อหาแบบสั้น ๆ ที่ต้องการคำจำกัดความหรือคำอธิบายเพิ่มเติม โปรดดูที่ {{Definition}} และ {{Explain}}.

วิกิพีเดียใช้แม่แบบแยกต่างหากสองแบบเพื่อสร้างป๊อปอัปคำอธิบาย แม่แบบ {{abbr}} ใช้สำหรับเขียนตัวย่อ (รวมถึงชื่อย่อหรือชื่อย่อ) พร้อมความหมายที่ขยาย เป็นตัวห่อสำหรับองค์ประกอบ HTML element <abbr>...</abbr> แม่แบบ {{tooltip}} ใช้องค์ประกอบ <span>...</span> เพื่อแสดงหมายเหตุทั่วไป

ใช้ {{abbr}} หรือ <abbr> เฉพาะเพื่อระบุตัวย่อ (รวมถึงชื่อย่อและชื่อย่อ) เท่านั้น การใช้เพื่อสร้างป๊อปอัปคำอธิบายในกรณีอื่นถือเป็นการใช้รหัส HTML พื้นฐานผิดวัตถุประสงค์ และก่อให้เกิดปัญหาการเข้าถึง ข้อมูล สำหรับการสร้างป๊อปอัปคำอธิบายทั่วไป ให้ใช้ {{tooltip}} แทน

ผู้ใช้บนอุปกรณ์มือถือโดยทั่วไปไม่มีเมาส์เพื่อวางเมาส์เหนือข้อความ ดังนั้นจึงไม่สามารถเห็นเนื้อหาป๊อปอัปคำอธิบายได้ ข้อมูล ณ ปี พ.ศ. 2566 แสดงว่ามีการเข้าชมหน้าวิกิพีเดียภาษาอังกฤษบนมือถือมากกว่าบนเดสก์ท็อป[1]

วิธีใช้

{{Abbr|ตัวย่อ|คำเต็มที่จะแสดงตอนที่เอาเมาส์ไปชี้}}

พารามิเตอร์

พารามิเตอร์ 2 อันที่ไม่มีชื่อแต่ต้องใส่ทุกครั้ง และพารามิเตอร์ 3 อันที่มีชื่อ(ไม่บังคับ):

เขียนเป็นแบบเต็มได้ดังนี้ {{Abbr|จำเป็น1|จำเป็น2|class|id|style}}

• |จำเป็น1= – ตัวย่อที่จะให้แสดงในบรรทัด (สามารถมาร์กอัปวิกิได้ แต่จะทำงานได้ดีกว่าถ้าใช้กับแม่แบบ) โปรดดูตัวอย่างการลิงก์ด้านล่าง
• |จำเป็น2= – ตัวเต็มที่จะให้แสดงตอนที่เอาเมาส์ชี้ (ใช้แบบอักษรพิเศษของวิกิ หรือ HTML ไม่ได้) ป๊อปอัปนี้สร้างขึ้นโดยใช้คุณลักษณะ title= ของ HTML ดังนั้น จึงไม่สามารถใส่ HTML (หรือ markup ที่แปลงเป็น HTML เมื่อแสดงผล) ไว้ด้านในได้ ซึ่งรวมไปถึงฟังก์ชันง่ายๆ อย่าง ''ตัวเอียง'' ด้วย
• |class= – หนึ่งหรือหลายคลาส CSS (คั่นด้วยช่องว่างหากมีมากกว่าหนึ่งคลาส)
• |id= – ไอดี HTML ต้องไม่ซ้ำกันบนหน้าเว็บทั้งหมด
• |style= – CSS สำหรับใช้กับข้อความที่แสดง (ไม่มีผลต่อเครื่องมือ/ป๊อปอัป) ค่าสไตล์ใดๆ ที่มีช่องว่างอยู่ภายใน ต้องใส่เครื่องหมายอัญประกาศเดี่ยว (') เช่น |style=font-family: 'Times New Roman', serif;

สรุป ถ้าจะใช้ {{Abbr}} อย่างน้อยต้องมีส่วนประกอบ 2 ส่วนหลัก ได้แก่

1. จำเป็น1 ส่วนที่ต้องการให้ปรากฏบนหน้าจอ
2. จำเป็น2 ส่วนที่อธิบายตัวเต็มของอักษรย่อ

ตัวอย่าง

มาร์กอัป	แสดงผลเป็น
{{abbr|พ.ศ.|พุทธศักราช}}	พ.ศ.

เมื่อเอาเมาส์ไปชี้ที่ตัวย่อ "พ.ศ." จำมีคำว่า พุทธศักราช แสดงขึ้นมาเป็นป๊อปอัปบนคอมพิวเตอร์ ในมือถืออาจแสดงจุดไข่ปลาหรือสัญลักษณ์อื่น ๆ เพื่อบอกว่าเป็นคำย่อ แต่จะไม่แสดงคำอธิบายแบบป๊อปอัป สำหรับผู้พิการทางสายตาตัวช่วยอ่านหน้าจอจะไม่อ่านคำเต็มของคำย่อโดยอัตโนมัติ แต่บางเครื่องอาจมีการตั้งค่าเพิ่มเติมเพื่ออ่านคำเต็มออกเสียงได้

ตัวอย่าง Abbr

เมื่อใช้ควบคู่กับการขยายความหมายในบรรทัดจะเข้าถึงได้ง่ายกว่า

มาร์กอัป	แสดงผลเป็น
ประเทศไทย มีชื่ออย่างเป็นทางการว่า ''ราชอาณาจักรไทย'' เป็นรัฐชาติอันตั้งอยู่ในภูมิภาคเอเชียตะวันออกเฉียงใต้ เดิมมีชื่อว่า "สยาม" รัฐบาลประกาศเปลี่ยนชื่อเป็นประเทศไทยอย่างเป็นทางการตั้งแต่ปี {{abbr|พ.ศ.|พุทธศักราช}} 2482 ประเทศไทยมีขนาดใหญ่เป็นอันดับที่ 50 ของโลก มีเนื้อที่ 513,120 ตารางกิโลเมตร ({{abbr|ตร.กม.|ตารางกิโลเมตร}})	ประเทศไทย มีชื่ออย่างเป็นทางการว่า ราชอาณาจักรไทย เป็นรัฐชาติอันตั้งอยู่ในภูมิภาคเอเชียตะวันออกเฉียงใต้ เดิมมีชื่อว่า "สยาม" รัฐบาลประกาศเปลี่ยนชื่อเป็นประเทศไทยอย่างเป็นทางการตั้งแต่ปี พ.ศ. 2482 ประเทศไทยมีขนาดใหญ่เป็นอันดับที่ 50 ของโลก มีเนื้อที่ 513,120 ตารางกิโลเมตร (ตร.กม.)

ในตัวอย่างด้านบน คำย่อแต่ละคำ(จำเป็น1) จะถูกขยายความหมายไว้ในเนื้อหาหลัก(จำเป็น2) ภายในวงเล็บก่อน แม่แบบนี้เป็นอีกวิธีหนึ่งสำหรับผู้ใช้บางคนในการเข้าถึงความหมายของคำย่อในภายหลังของข้อความ สำหรับข้อมูลเพิ่มเติมดูที่ MOS:ABBR

ตัวอย่าง tooltip

มาร์กอัป	แสดงผลเป็น
[[WP:COI|{{tooltip|conflict of interest|in the specific sense employed in Wikipedia policy}}]]	conflict of interest

การลิงก์

หากต้องการลิงก์วิกิกับตัวย่อที่เทมเพลตนี้ทำเครื่องหมายไว้ ให้ล้อมเทมเพลตไว้ในลิงก์ ไม่เช่นนั้นคำแนะนำเครื่องมือจะไม่ปรากฏในเบราว์เซอร์บางตัว

ความเข้ากันได้	มาร์กอัป	แสดงผลเป็น
ดี	[[Knockout#Technical knockout|{{abbr|TKO|technical knockout}}]]	TKO
ไม่ค่อยดี	{{abbr|[[Knockout#Technical knockout|TKO]]|technical knockout}}	TKO

แม่แบบเปลี่ยนทาง

แม่แบบดังต่อไปนี้ เปลี่ยนทางมาที่หน้าแม่แบบนี้

• {{Explain}}
• {{Tool tip}}
• {{Tooltip}}