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

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

เอกสารอ้างอิงตอบคำถามที่ต้องการคำตอบแม่นยำ: ควรใช้สัญลักษณ์ใด ค่าใด ระดับการรองรับใด หรือข้อกำหนดใด แท็บนี้รวบรวมส่วนต่างๆ ของ NextPDF ที่ผ่านการตรวจสอบยืนยันแล้ว ได้แก่เอกสารอ้างอิงโมดูล เมทริกซ์การรองรับ ส่วนติดต่อ API การอ้างอิงข้อผิดพลาด ความสอดคล้องตามมาตรฐาน และนโยบายที่โปรเจกต์เผยแพร่ ส่วนนี้ไม่ได้อธิบายวิธีบรรลุเป้าหมาย หากต้องการเนื้อหาประเภทนั้น ให้ใช้ คู่มือ หรือ Cookbook (สูตรการใช้งาน)

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

เอนจิน Core

เอกสารของเอนจิน nextpdf/core จัดแบ่งตามโมดูล

หน้า	ใช้สำหรับ
เอกสารอ้างอิงสำหรับเอนจิน Core	แผนผัง namespace: หน้าโมดูลทั้งหมดและกลุ่มย่อยทั้งสี่กลุ่ม
Contracts: อินเทอร์เฟซสาธารณะ 41 รายการ (SPI)	อินเทอร์เฟซสาธารณะและอีนัมที่มีการติดตามสถานะความเสถียร
Core: facade ของ Document และ concern trait	facade ของ Document และตระกูล trait Has*
HTML: ระบบย่อยสำหรับเรนเดอร์ HTML+CSS เป็น PDF	ตัวเรนเดอร์ HTML แบบสตรีมมิงที่ประมวลผลรอบเดียว
ความปลอดภัย: การเข้ารหัสลับ นโยบายการเข้ารหัสลับ และส่วนติดต่อการลงนาม	การเข้ารหัสลับ สิทธิ์ และจุดผสานรวมสำหรับการลงนาม

การรองรับการเรนเดอร์

สิ่งที่ตัวเรนเดอร์ตรวจสอบยืนยันแล้ว อ้างว่ารองรับ รองรับบางส่วน หรือไม่รองรับ

หน้า	ใช้สำหรับ
เมทริกซ์สถานะการรองรับ CSS	ระดับการรองรับ Cascading Style Sheets (CSS) แยกตามคุณสมบัติในไปป์ไลน์ HTML
คุณสมบัติ CSS ที่ไม่รองรับและวิธีแก้ไขทดแทน	คุณสมบัติที่อยู่นอกขอบเขตและแนวทางที่ควรใช้แทน
เมทริกซ์การรองรับฟอนต์และสคริปต์	เทคโนโลยีฟอนต์และการรองรับระบบการเขียน
การรองรับการเขียนแนวตั้ง CJK	การรองรับ writing-mode แนวตั้งสำหรับข้อความภาษาจีน ญี่ปุ่น และเกาหลี
การรองรับการ shaping สคริปต์ซับซ้อน	การรองรับการ shaping สำหรับสคริปต์ที่ต้องใช้ฟีเจอร์นี้

ส่วนติดต่อ API

สัญลักษณ์ที่แน่นอน ค่าที่อนุญาต และสัญญาของ API

หน้า	ใช้สำหรับ
เอกสารอ้างอิงอีนัม	ทุกอีนัมสาธารณะและค่าที่อนุญาต
การกำหนดค่า TSA	Time-Stamping Authority (TSA) เริ่มต้นและวิธีเปลี่ยน
ข้อมูลอ้างอิง Connect REST API	เอนด์พอยต์ REST ของ NextPDF Connect จากเอกสาร OpenAPI 3.1
เครื่องมือสำรวจ Connect API	เครื่องมือสำรวจแบบโต้ตอบสำหรับสัญญาเดียวกัน

เอกสารอ้างอิง Application Programming Interface (API) ระดับแพ็กเกจอยู่ในส่วนของแต่ละแพ็กเกจ: เอกสารอ้างอิง Connect API, ดัชนี API สำหรับงานผสานรวม และ ข้อมูลอ้างอิง API ของ Python SDK ในแท็บคู่มือ

การอ้างอิงข้อผิดพลาด

ข้อยกเว้นทั้งหมดที่เอนจินโยนจะจัดกลุ่มตามโดเมน พร้อมบริบทเชิงโครงสร้างและคำแนะนำสำหรับการกู้คืน

หน้า	ใช้สำหรับ
การอ้างอิงข้อผิดพลาด	โมเดลข้อยกเว้น: คลาสฐาน NextPdfException และสัญญาบริบท
ข้อผิดพลาด core และทั่วไป	วงจรชีวิตของ Document และความล้มเหลวทั่วไปของเอนจิน
ข้อผิดพลาดการเรนเดอร์และ I/O	ความล้มเหลวของ HTML ฟอนต์ writer และ reader
ข้อผิดพลาดความปลอดภัยและการเซ็น	ความล้มเหลวของการเข้ารหัสลับ การลงนาม และ PKI
ข้อผิดพลาดรันไทม์และการสนับสนุน	ความล้มเหลวของ HTTP ความยืดหยุ่น และการสังเกตการณ์
ข้อผิดพลาด Accelerator	ความล้มเหลวของ sidecar เสริมสำหรับการเร่งความเร็ว
ข้อผิดพลาด compliance	ความล้มเหลวของการตรวจสอบความถูกต้องและเครื่องมือด้านความสอดคล้อง

ความสอดคล้องตามมาตรฐาน

โปรไฟล์มาตรฐานที่ NextPDF Core ตั้งเป้าให้สอดคล้อง โดยแต่ละโปรไฟล์ระบุขอบเขตไว้อย่างชัดเจน: เอนจินสร้างเอาต์พุตที่ตั้งใจให้เป็นไปตามข้อกำหนด ส่วนผลความสอดคล้องให้ตัวตรวจสอบภายนอกเป็นผู้ตัดสิน

หน้า	ใช้สำหรับ
ความสอดคล้องตามมาตรฐาน	จุดยืนด้านความสอดคล้องและดัชนีโปรไฟล์
ความสอดคล้อง PDF 2.0	baseline ISO 32000-2 ที่เอนจินตั้งเป้าให้เป็นไปตาม
ความสอดคล้อง PDF/A-4	ความสอดคล้องสำหรับการจัดเก็บถาวร พร้อม การแมปข้อกำหนด PDF/A-4
ความสอดคล้อง PDF/UA-2	ความสอดคล้องด้านการเข้าถึง พร้อม การแมปข้อกำหนด PDF/UA-2
ความสอดคล้อง PDF/X	ความสอดคล้องสำหรับงานผลิตสิ่งพิมพ์
การแมปข้อกำหนด PAdES	การแมปโปรไฟล์ระดับพื้นฐาน ETSI EN 319 142 สำหรับลายเซ็น PDF
ความสอดคล้อง ZUGFeRD / Factur-X	ความสอดคล้องของใบแจ้งหนี้อิเล็กทรอนิกส์แบบไฮบริด

ศูนย์ความน่าเชื่อถือ

จุดยืนด้านวิศวกรรมของเอนจิน core พร้อมขอบเขตของคำกล่าวอ้างแต่ละข้อ

หน้า	ใช้สำหรับ
ศูนย์ความน่าเชื่อถือ	ดัชนีจุดยืนด้านความน่าเชื่อถือ
การออกใบอนุญาตผลิตภัณฑ์	เงื่อนไขใบอนุญาตของ open core และรุ่นเชิงพาณิชย์
เครื่องหมายการค้าและการใช้แบรนด์	วิธีใช้ชื่อและเครื่องหมาย NextPDF ที่อนุญาต
การจัดการข้อมูล PII และ telemetry	สิ่งที่เอนจินอ่าน จัดเก็บ และส่งต่อ
โมเดลความปลอดภัยสำหรับลายเซ็นและการเข้ารหัสลับ	การออกแบบด้านการเข้ารหัสลับและข้อจำกัด
โมเดลภัยคุกคามของเอนจิน	สิ่งที่เอนจินป้องกันและสิ่งที่ไม่ป้องกัน
นโยบายการเปิดเผยช่องโหว่	วิธีรายงานช่องโหว่

โปรเจกต์และการเผยแพร่

หน้า	ใช้สำหรับ
บันทึกการเปลี่ยนแปลง	สิ่งที่เปลี่ยนแปลงในแต่ละรุ่น
ข้อกำหนดสำหรับ Changelog	วิธีเขียนและจัดหมวดหมู่รายการใน changelog
การกำหนดเวอร์ชัน เสถียรภาพ การเลิกใช้ และนโยบายการสนับสนุน	คำมั่นด้านความเข้ากันได้ระหว่างรุ่นต่างๆ
โครงสร้างเอกสารประกอบ NextPDF	โครงสร้างและการกำกับดูแลของชุดเอกสารนี้

อภิธานศัพท์

อภิธานศัพท์ รวบรวมคำศัพท์ที่ใช้ในเอกสารชุดนี้ โดยนิยามไว้ครั้งเดียวเพื่อนำไปใช้ซ้ำทั่วทั้งชุดเอกสาร

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

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

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

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

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

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

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