Tài liệu tham khảo

Tổng quan nhanh

Tài liệu tham khảo trả lời những câu hỏi cụ thể: symbol nào, giá trị nào, mức hỗ trợ nào, điều khoản nào. Tab này tập hợp các bề mặt đã được kiểm chứng của NextPDF — tài liệu tham khảo theo module, ma trận hỗ trợ, bề mặt API, tài liệu tham khảo lỗi, tuân thủ tiêu chuẩn và các chính sách do dự án công bố. Phần này không giải thích cách hoàn thành một mục tiêu; để thực hiện việc đó, hãy dùng Hướng dẫn hoặc Cookbook.

Bản đồ tài liệu tham khảo

Engine Core

Engine nextpdf/core được tài liệu hóa theo từng module.

Trang	Công dụng
Tài liệu tham khảo engine Core	Bản đồ namespace cho tất cả các trang module và bốn nhóm con.
Contracts: 41 giao diện công khai (SPI)	Các giao diện công khai và enum được theo dõi về độ ổn định.
Core: facade Document + bộ concern trait	Facade Document và nhóm trait Has*.
HTML: hệ thống con kết xuất HTML+CSS sang PDF	Bộ kết xuất HTML dạng luồng, chạy một lượt.
Bảo mật: mã hóa, chính sách mật mã và bề mặt chữ ký	Mã hóa, quyền và các điểm tích hợp ký.

Hỗ trợ kết xuất

Những gì bộ kết xuất đã kiểm chứng, đã công bố, hỗ trợ một phần hoặc không hỗ trợ.

Trang	Công dụng
Ma trận hỗ trợ CSS	Mức hỗ trợ theo từng tính năng của Cascading Style Sheets (CSS) trong quy trình xử lý HTML.
Các tính năng CSS không được hỗ trợ và cách khắc phục	Những nội dung nằm ngoài phạm vi và các phương án thay thế.
Ma trận hỗ trợ phông chữ và chữ viết	Công nghệ phông chữ và mức hỗ trợ cho từng hệ chữ viết.
Hỗ trợ chế độ viết dọc CJK	Hỗ trợ chế độ viết dọc cho văn bản tiếng Trung, tiếng Nhật và tiếng Hàn.
Hỗ trợ tạo hình chữ phức tạp	Hỗ trợ tạo hình chữ cho các hệ chữ viết cần HarfBuzz.

Bề mặt API

Những symbol chính xác, giá trị được phép và hợp đồng dịch vụ.

Trang	Công dụng
Tham chiếu enum	Mọi enum công khai và giá trị được phép của từng enum.
Cấu hình TSA	Cơ quan cấp dấu thời gian (TSA) mặc định và cách thay đổi.
Tham khảo Connect REST API	Các endpoint REST của NextPDF Connect, lấy từ tài liệu OpenAPI 3.1.
Trình khám phá Connect API	Trình khám phá tương tác cho cùng một hợp đồng.

Các tài liệu tham khảo giao diện lập trình ứng dụng (API) cấp gói nằm trong các gói tương ứng: Tài liệu tham chiếu API NextPDF Connect, Chỉ mục API cho tích hợp và Tài liệu tham khảo API Python SDK thuộc tab Hướng dẫn.

Tài liệu tham khảo lỗi

Mọi exception do engine ném ra đều được nhóm theo từng miền, kèm ngữ cảnh có cấu trúc và hướng dẫn khắc phục.

Trang	Công dụng
Tài liệu tham khảo lỗi	Mô hình exception: lớp cơ sở NextPdfException và hợp đồng ngữ cảnh.
Lỗi core và lỗi chung	Vòng đời tài liệu và các lỗi engine chung.
Lỗi kết xuất và I/O	Lỗi HTML, phông chữ, trình ghi và trình đọc.
Lỗi bảo mật và ký	Lỗi mã hóa, ký và PKI.
Lỗi môi trường chạy và hỗ trợ	Lỗi HTTP, khả năng phục hồi và khả năng quan sát.
Lỗi Accelerator	Lỗi của sidecar tăng tốc tùy chọn.
Lỗi tuân thủ	Lỗi của trình xác thực và công cụ tuân thủ.

Tuân thủ tiêu chuẩn

Các hồ sơ tiêu chuẩn mà NextPDF Core nhắm tới, mỗi hồ sơ đều nêu rõ ranh giới: engine tạo output hướng tới tuân thủ; chỉ trình xác thực bên ngoài mới quyết định việc tuân thủ.

Trang	Công dụng
Tuân thủ tiêu chuẩn	Định hướng về tuân thủ và chỉ mục hồ sơ.
Tuân thủ PDF 2.0	Đường cơ sở ISO 32000-2 mà engine nhắm tới.
Tuân thủ PDF/A-4	Tuân thủ lưu trữ, kèm theo Ánh xạ điều khoản PDF/A-4.
Tuân thủ PDF/UA-2	Tuân thủ khả năng truy cập, kèm theo Ánh xạ điều khoản PDF/UA-2.
Tuân thủ PDF/X	Tuân thủ cho sản xuất in.
Ánh xạ điều khoản PAdES	Ánh xạ hồ sơ cơ sở ETSI EN 319 142 cho chữ ký PDF.
Tuân thủ ZUGFeRD / Factur-X	Tuân thủ hóa đơn điện tử lai.

Trung tâm tin cậy

Định hướng kỹ thuật cho engine Core, kèm ranh giới cho từng tuyên bố.

Trang	Công dụng
Trung tâm tin cậy	Chỉ mục điều hướng.
Cấp phép sản phẩm	Các điều khoản cấp phép cho bản open core và các phiên bản thương mại.
Sử dụng nhãn hiệu và thương hiệu	Cách sử dụng tên và nhãn hiệu NextPDF.
Xử lý dữ liệu, PII và telemetry	Những gì engine đọc, lưu trữ và truyền đi.
Mô hình bảo mật cho ký và mã hóa	Thiết kế mật mã và các giới hạn của thiết kế đó.
Mô hình mối đe dọa cho engine	Những gì engine có thể phòng vệ trước và những gì không.
Chính sách công bố lỗ hổng bảo mật	Cách báo cáo một lỗ hổng bảo mật.

Dự án và phát hành

Trang	Công dụng
Changelog	Những thay đổi trong mỗi bản phát hành.
Quy ước changelog	Cách viết và phân loại các mục trong changelog.
Chính sách đánh phiên bản, độ ổn định, ngừng dùng, và hỗ trợ	Các cam kết về khả năng tương thích qua các bản phát hành.
Cấu trúc tài liệu NextPDF	Cấu trúc và cách quản trị bộ tài liệu này.

Bảng thuật ngữ

Bảng thuật ngữ — các thuật ngữ được dùng trong bộ tài liệu này, được định nghĩa một lần để dùng lại xuyên suốt.

Quy ước cho mỗi mục tham khảo

Mỗi mục API phải trả lời cùng một bộ câu hỏi:

Câu hỏi	Câu trả lời bắt buộc
Bạn cần gọi gì?	Symbol có tên đầy đủ, endpoint, lệnh của giao diện dòng lệnh (CLI) hoặc khóa cấu hình.
Đầu vào nào được chấp nhận?	Bảng tham số gồm kiểu, mức bắt buộc, giá trị mặc định và các giá trị được chấp nhận.
Điều gì xảy ra theo mặc định?	Hành vi khi bỏ qua đầu vào tùy chọn.
Kết quả trả về là gì?	Kiểu trả về, nội dung phản hồi, tệp đầu ra, luồng hoặc tác dụng phụ.
Điều gì có thể thất bại?	Exception, lỗi xác thực, mã trạng thái HTTP hoặc chế độ lỗi trong vận hành.
Bạn dùng nó an toàn như thế nào?	Lưu ý về bảo mật, an toàn cho worker, giới hạn kích thước, đường dẫn, thời gian chờ và cách xử lý thông tin nhạy cảm.

Chính sách về phạm vi

Các trang tham khảo về API và hành vi đều dựa trên các nguồn triển khai thực tế. Các API công khai được tài liệu hóa từ mã nguồn của gói, tệp cấu hình, bài kiểm thử và ví dụ. Các lớp helper nội bộ chỉ được tài liệu hóa khi nhà phát triển ứng dụng cần hiểu hành vi của chúng để cấu hình hoặc vận hành gói.

Mức độ sẵn sàng cho dịch thuật

Các trang tham khảo ưu tiên dùng bảng thay cho các đoạn văn dày đặc. Mỗi hàng nên tự đầy đủ về nội dung, vì về sau việc phân đoạn theo Extensible Localization Interchange File Format (XLIFF) sẽ tách nội dung thành từng khối.