ข้อมูลอ้างอิง

ภาพรวมโดยย่อ

ใช้ส่วนนี้เป็นจุดเริ่มต้นสำหรับเอกสารอ้างอิง เช่น รายการ API คีย์การกำหนดค่า ตารางความเข้ากันได้ พฤติกรรม CSS ที่รองรับ และรายการขอบเขตข้ามแพ็กเกจ

แผนผังข้อมูลอ้างอิง

ข้อมูลอ้างอิง	สิ่งที่ตอบได้
เมทริกซ์การรองรับ CSS	คุณลักษณะ CSS ใดที่ไปป์ไลน์ HTML ตรวจสอบยืนยันแล้ว ระบุไว้ รองรับบางส่วน หรือไม่รองรับ
ดัชนี API ของการผสานรวม	หน้า extension API ใดครอบคลุมเฟรมเวิร์ก ตัวเรนเดอร์ ทรานสปอร์ต และส่วนประกอบของเครื่องมือ build แต่ละรายการ
ส่วนการผสานรวม	ตำแหน่งสำหรับค้นหาเอกสารอ้างอิง API และการกำหนดค่าเฉพาะแพ็กเกจ
เอกสารอ้างอิงโมดูล Core	หน้า API และสถาปัตยกรรมระดับโมดูลที่สร้างจากที่เก็บโค้ด core

ข้อกำหนดสำหรับรายการอ้างอิง

รายการ API ทุกรายการต้องตอบคำถามชุดเดียวกันนี้:

คำถาม	คำตอบที่ต้องระบุ
ต้องเรียกใช้อะไร?	สัญลักษณ์ที่ระบุคุณสมบัติครบถ้วน เอนด์พอยต์ คำสั่ง command-line interface (CLI) หรือคีย์การกำหนดค่า
รับอินพุตใดได้บ้าง?	ตารางพารามิเตอร์ที่ระบุชนิด สถานะที่จำเป็น ค่าเริ่มต้น และค่าที่ยอมรับ
เกิดอะไรขึ้นตามค่าเริ่มต้น?	พฤติกรรมเมื่อไม่ได้ระบุอินพุตที่ไม่บังคับ
ได้รับอะไรกลับมา?	ชนิดที่ส่งคืน เนื้อหาการตอบกลับ เอาต์พุตไฟล์ สตรีม หรือผลข้างเคียง
อะไรที่อาจล้มเหลวได้?	ข้อยกเว้น ข้อผิดพลาดจากการตรวจสอบความถูกต้อง สถานะ HTTP หรือโหมดความล้มเหลวของการทำงาน
จะใช้งานอย่างปลอดภัยได้อย่างไร?	ข้อควรทราบด้านความปลอดภัย ความปลอดภัยของ worker ขีดจำกัดขนาด พาธ การหมดเวลา และการจัดการข้อมูลลับ

นโยบายขอบเขต

หน้าข้อมูลอ้างอิงอิงจากซอร์สโค้ด เอกสารของ API สาธารณะจัดทำจากซอร์สของแพ็กเกจ ไฟล์การกำหนดค่า การทดสอบ และตัวอย่าง คลาสตัวช่วยภายในจะมีเอกสารประกอบเฉพาะเมื่อนักพัฒนาแอปพลิเคชันต้องเข้าใจพฤติกรรมของคลาสเหล่านั้นเพื่อกำหนดค่าหรือใช้งานแพ็กเกจ

ความพร้อมสำหรับการแปล

หน้าข้อมูลอ้างอิงใช้ตารางแทนย่อหน้าที่แน่นด้วยเนื้อหา แต่ละแถวจึงควรสมบูรณ์ในตัวเอง เพราะการแบ่งเซกเมนต์ Extensible Localization Interchange File Format (XLIFF) ในภายหลังจะแยกเนื้อหาตามบล็อก