มอดูล:Class/doc

มีการใช้มอดูลนี้ ประมาณ 9,500,000 หน้า หรือประมาณ 841% ของหน้าทั้งหมด เพื่อหลีกเลี่ยงผลกระทบกว้างขวางและลดภาระของเซิร์ฟเวอร์ ดังนั้นก่อนแก้ไขมอดูลนี้จึงควรทดลองที่กระบะทราย หรือหน้าทดสอบ หรือในมอดูลกระบะทรายของคุณเองจนมั่นใจว่าไม่มีข้อผิดพลาด อนึ่ง อภิปรายเกี่ยวกับการแก้ไขมอดูลได้ที่หน้าอภิปรายก่อนที่จะนำไปใช้

มอดูลนี้ขึ้นอยู่กับมอดูลอื่น ๆ ดังต่อไปนี้ มอดูล:Arguments (กระบะทราย) มอดูล:Class/definition.json

This module uses TemplateStyles: มอดูล:Class/styles.css

มอดูลนี้ใช้ แม่แบบ:Class, แม่แบบ:Class/icon และแม่แบบ:Class/colour.

ต่อไปนี้เป็นบันทึกที่แสดงเอกสารแบบจำลองสำหรับคำจำกัดความคลาส JSON

• วัตถุ JSON ระดับบนสุดประกอบด้วยวัตถุจำนวนหนึ่ง วัตถุแต่ละชิ้นเป็นคำจำกัดความของคลาสหรือนามแฝง คีย์คือ "รหัสคลาส" ที่สามารถใช้เป็นอินพุตได้ คีย์ที่มีคำจำกัดความของคลาสคือรหัสคลาสมาตรฐาน รหัสคลาสควรเป็นตัวพิมพ์เล็ก (ยกเว้นรหัสพิเศษ DEFAULT) และรหัสคลาสมาตรฐานจนถึงขณะนี้เป็นตัวอักษรอย่างเคร่งครัด (bplus ไม่ใช่b+)
• นามแฝงควรเป็นอ็อบเจ็กต์ที่มีคุณสมบัติหนึ่งอย่างเท่านั้น alias ซึ่งประกอบด้วยสตริงโค้ดคลาสมาตรฐาน
• คำจำกัดความของคลาสสามารถมีคุณสมบัติได้หลายประการ ดังนี้

  categoryRoot

  (สตริง) รากของชื่อหมวดหมู่สำหรับบทความในคลาสคุณภาพ ตัวอย่างเช่น หมวดหมู่ระดับบนสุดสำหรับบทความเด่นคือ หมวดหมู่:บทความระดับคัดสรร และหมวดหมู่ระดับหัวเรื่องอาจมีอยู่ที่ "หมวดหมู่:บทความระดับคัดสรร" ดังนั้นรากของหมวดหมู่คือ FA-Class

  colour

(วัตถุ) วัตถุที่มีคุณสมบัติที่เกี่ยวข้องกับสี โดยค่าแต่ละค่าภายในนั้นควรเป็นสตริงที่สามารถใช้เป็นค่าสี CSS ได้ เช่น #6699ff

• base

  (สตริง) สตริงสีที่สะท้อนสีพื้นหลังพื้นฐาน^{[model 1]}

  textOnBlack

  (สตริง) สตริงสีที่สะท้อนสีที่เหมาะสมสำหรับใช้กับข้อความบนพื้นหลังสีดำ

  textOnWhite

  (สตริง) สตริงสีที่สะท้อนสีที่เหมาะสมสำหรับใช้กับข้อความบนพื้นหลังสีขาว

  icon

  (วัตถุ) วัตถุที่มีคุณสมบัติที่เกี่ยวข้องกับไอคอน:

  file

  (สตริง) ชื่อไฟล์ที่ไม่มี File: คำนำหน้า ควรจัดรูปแบบด้วยเครื่องหมายขีดล่าง^{[model 2]} เช่น Featured_article_star.svg

  default

  (บูล) ว่าควรแสดงไอคอนตามค่าเริ่มต้นหรือไม่ โดยปกติแล้วอันดับคุณภาพสูงเท่านั้นที่จะแสดงไอคอนตามค่าเริ่มต้น

  requiresAttribution

  (บูล) true หาก file คุณสมบัติอ้างอิงถึงไฟล์ที่ไม่ใช่สาธารณสมบัติหรือได้รับอนุญาตภายใต้ CC0 เมื่อไฟล์เป็น PD/CC0 และด้วยเหตุนี้คุณสมบัติ false จึงถูกปิดใช้งานการลิงก์รูปภาพและข้อความอื่น ซึ่งดีต่อการเข้าถึงรูปภาพที่เน้นการตกแต่งโดยเฉพาะ

  labels

  (วัตถุ) วัตถุที่มีสตริงป้ายกำกับ คุณสมบัติป้ายกำกับทั้งหมดเป็นเพียงการเบื้องต้นเท่านั้น

  adjective

  (สตริง) สตริงป้ายกำกับที่อธิบายคำคุณศัพท์ซึ่งสามารถใช้เพื่ออธิบายหน้าที่มีคลาสนี้ ควรใช้ตัวพิมพ์เล็กหรือตัวพิมพ์ใหญ่ในชื่อเรื่อง^{[model 3]} คุณสมบัตินี้ยังอยู่ในขั้นทดลอง

  full

  (สตริง) สตริงป้ายกำกับที่อธิบายวลีคำนามที่อาจใช้เพื่ออธิบายหน้าที่มีคลาสนี้ ควรใช้ตัวพิมพ์เล็กหรือตัวพิมพ์ใหญ่ในชื่อเรื่อง^{[model 3]} คุณสมบัตินี้เป็นเพียงการคาดเดา

  short

  (สตริง) สตริงป้ายกำกับที่อธิบายชื่อย่อของคลาสที่สามารถใช้ในบริบทต่างๆ ได้ โดยบ่อยครั้งอาจเป็นแบบเดียวกับรหัสคลาส แต่โดยปกติแล้วควรใช้ตัวพิมพ์ใหญ่ (เช่น Redirect หรือ GA) กฎเกณฑ์เฉพาะอย่างหนึ่งที่นำเข้าสู่คุณสมบัตินี้คือรหัสคลาส unassessed ใช้ ??? ป้ายกำกับย่อ คุณสมบัตินี้เป็นเพียงการคาดเดาเท่านั้น

  tooltip

  (สตริง) สตริงป้ายกำกับพร้อมคำอธิบายเครื่องมือที่ควรใช้เพื่ออธิบายคลาสหากต้องการรายละเอียดเพิ่มเติม คุณสมบัตินี้เป็นทางเลือกและอาจควรระบุเฉพาะเมื่อจำเป็นเท่านั้น

  page

  (สตริง) ชื่อหน้าเต็มของหน้าวิกิที่อธิบายคลาสคุณภาพ โดยควรจัดรูปแบบด้วยช่องว่าง^{[model 4]} เช่น วิกิพีเดีย:บทความคัดสรร

• ในขณะนี้ยังไม่มีคำจำกัดความว่าคุณสมบัติใดที่อาจเป็นข้อบังคับ หรือเป็นทางเลือกสำหรับคำจำกัดความของคลาส และสำหรับตอนนี้อาจจะปลอดภัยที่สุดที่จะถือว่าคุณสมบัติ "ป้ายกำกับ" นั้นเป็นข้อบังคับ
• วัตถุพิเศษ DEFAULT ซึ่งใช้ตัวพิมพ์ใหญ่เพื่อแยกออกจากคีย์อื่น ๆ จะกำหนดค่าเริ่มต้นที่สามารถใช้ไ���้โดยควรเป็นวัตถุที่สมบูรณ์ (คุณสมบัติทั้งหมดบังคับ) หรือเป็นนามแฝงของวัตถุที่สมบูรณ์ในกรณีของวิกิพีเดียภาษาอังกฤษ นามแฝงนี้ปัจจุบันเป็นนามแฝงของ unassessed คำจำกัดความของคลาส

1. ↑ ถือว่าเป็นสีโหมดสว่าง อาจต้องการแยกสีนี้ออกเป็นคุณสมบัติโหมดสว่าง และโหมดมืด
2. ↑ การใช้ตัวพิมพ์เล็กจะดีกว่าสำหรับคำเต็มหรือคำทั่วไป เช่น "ที่โดดเด่น" แต่การใช้ตัวพิมพ์ใหญ่จะดีกว่าสำหรับค่าที่สร้างขึ้น เช่น "ที่โดดเด่น"
3. ↑ ^{3.0 3.1} การใช้ช่องว่างน่าจะดีกว่าสำหรับการอ้างอิงหน้าวิกิ เนื่องจากสามารถใช้ในรูปแบบสตริงหรือในข้อความวิกิได้ง่าย การใช้ใน URL จะต้องมีการแปลงข้อมูลอื่น ๆ อยู่แล้ว
4. ↑ เครื่องหมายขีดล่างน่าจะดีกว่าสำหรับชื่อไฟล์ เนื่องจากสามารถใช้ใน URL ได้ง่ายกว่า และไม่ก่อให้เกิดอันตรายต่อสิ่งใด ๆ ที่ใช้ในข้อความวิกิ