Referans

Bir bakışta

Referans materyalleri belirli soruları yanıtlar: hangi sembolün, hangi değerin, hangi destek düzeyinin veya hangi maddenin geçerli olduğunu gösterir. Bu bölüm, NextPDF’in doğrulanmış yüzeyini kapsar: modül referansı, destek matrisleri, API yüzeyi, hata referansı, standartlara uygunluk ve projenin yayımladığı ilkeler. Buradaki içerik, bir hedefe nasıl ulaşacağınızı açıklamaz; bunun için Kılavuzlar veya Tarif defteri bölümlerine bakın.

Referans haritası

Çekirdek motor

nextpdf/core motoru, her seferinde bir modül belgelenerek açıklanır.

Sayfa	Ne için kullanılır
Çekirdek motor referansı	Her modül sayfası ve dört alt aile için ad alanı haritası.
Contracts: 41 genel arabirim (SPI)	Kararlılığı izlenen genel arabirimler ve sabit liste değerleri.
Core: Document cephesi + concern trait ailesi	Document cephesi ve Has* trait ailesi.
HTML: HTML+CSS’ten PDF’ye işleyen alt sistem	Tek geçişli ve akışlı HTML oluşturucu.
Güvenlik: şifreleme, kripto politikası ve imzalama yüzeyi	Şifreleme, izinler ve imzalama entegrasyon noktaları.

Oluşturma desteği

Oluşturucunun neleri doğruladığı, neleri beyan ettiği, neleri kısmen desteklediği veya desteklemediği.

Sayfa	Ne için kullanılır
CSS destek matrisi	HTML işlem hattında, özellik bazında Cascading Style Sheets (CSS) destek düzeyleri.
Desteklenmeyen CSS özellikleri ve geçici çözümleri	Neyin kapsam dışı olduğu ve bunun yerine ne yapılacağı.
Yazı tipi ve yazı sistemi desteği matrisi	Yazı tipi teknolojileri ile yazı sistemi desteği.
CJK dikey yazma desteği	Çince, Japonca ve Korece metinlerde dikey yazma kipi desteği.
Karmaşık betik şekillendirme desteği	Bu desteğe ihtiyaç duyan betikler için şekillendirme desteği.

API yüzeyi

Tam semboller, izin verilen değerler ve hizmet sözleşmeleri.

Sayfa	Ne için kullanılır
Sabit liste referansı	Genel sabit listeler ve her biri için izin verilen değerler.
TSA yapılandırması	Varsayılan zaman damgası yetkilisi (TSA) ve bunu nasıl değiştireceğiniz.
Connect REST API başvuru belgesi	OpenAPI 3.1 belgesindeki NextPDF Connect REST uç noktaları.
Connect API gezgini	Aynı sözleşmeye yönelik etkileşimli gezgin.

Paket düzeyindeki Application Programming Interface (API) referansları, ilgili paketlerin yanında yer alır: Kılavuzlar bölümündeki NextPDF Connect API referansı, Entegrasyon API referansları dizini ve Python API referansı.

Hata referansı

Motorun ürettiği her istisna etki alanına göre düzenlenir; yapılandırılmış bağlamı ve kurtarma yönergeleriyle birlikte verilir.

Sayfa	Ne için kullanılır
Hata başvurusu	İstisna modeli: NextPdfException tabanı ve bağlam sözleşmesi.
Çekirdek ve genel hatalar	Belge yaşam döngüsü ve genel motor arızaları.
Oluşturma ve G/Ç hataları	HTML, yazı tipi, yazıcı ve okuyucu arızaları.
Güvenlik ve imzalama hataları	Şifreleme, imzalama ve PKI arızaları.
Çalışma zamanı ve destek hataları	HTTP, dayanıklılık ve gözlemlenebilirlik arızaları.
Accelerator hataları	İsteğe bağlı hızlandırma yardımcı bileşeninin arızaları.
Uygunluk hataları	Doğrulama ve uygunluk aracı arızaları.

Standartlara uygunluk

NextPDF Core’un hedeflediği standart profiller ve her birinin belirtilen sınırları: motor, uygun olması amaçlanan çıktıyı üretir; uygunluk kararını ise harici bir doğrulayıcı verir.

Sayfa	Ne için kullanılır
Standartlara uygunluk	Uygunluk yaklaşımı ve profil dizini.
PDF 2.0 uygunluğu	Motorun hedeflediği ISO 32000-2 temel düzeyi.
PDF/A-4 uygunluğu	Arşivleme uygunluğu; PDF/A-4 madde eşlemesi ile birlikte.
PDF/UA-2 uygunluğu	Erişilebilirlik uygunluğu; PDF/UA-2 madde eşlemesi ile birlikte.
PDF/X uygunluğu	Baskı üretimi uygunluğu.
PAdES madde eşlemesi	PDF imzaları için ETSI EN 319 142 taban profili eşlemesi.
ZUGFeRD / Factur-X uygunluğu	Karma elektronik fatura uygunluğu.

Güven merkezi

Çekirdek motorun mühendislik yaklaşımı ve her iddianın sınırları.

Sayfa	Ne için kullanılır
Güven merkezi	Güven duruşu dizini.
Ürün lisanslama	Açık çekirdek ve ticari sürümler için lisans koşulları.
Ticari marka ve marka kullanımı	NextPDF adının ve markalarının nasıl kullanılabileceği.
Veri işleme, PII ve telemetri	Motorun neyi okuduğu, sakladığı ve ilettiği.
İmza ve şifreleme için güvenlik modeli	Kriptografik tasarım ve sınırları.
Motorun tehdit modeli	Motorun nelere karşı koruma sağladığı ve sağlamadığı.
Güvenlik açığı bildirim politikası	Bir güvenlik açığının nasıl bildirileceği.

Proje ve sürümler

Sayfa	Ne için kullanılır
Değişiklik günlüğü	Her sürümde nelerin değiştiği.
Değişiklik günlüğü kuralları	Değişiklik günlüğü girdilerinin nasıl yazıldığı ve sınıflandırıldığı.
Sürümleme, kararlılık, kullanımdan kaldırma ve destek ilkesi	Sürümler arası uyumluluk taahhütleri.
NextPDF belgelendirmesinin yapısı	Bu belge kümesinin yapısı ve yönetişimi.

Sözlük

Sözlük: Bu belgelerde kullanılan ve belge kümesi genelinde yeniden kullanılmak üzere bir kez tanımlanan terimler.

Referans girişi sözleşmesi

Her API girişi aynı soruları yanıtlamalıdır:

Soru	Gerekli yanıt
Neyi çağırırsınız?	Tam nitelikli sembol, uç nokta, komut satırı arabirimi (CLI) komutu veya yapılandırma anahtarı.
Hangi girdi kabul edilir?	Türü, zorunlu olup olmadığı, varsayılan değeri ve kabul edilen değerleri içeren parametre tablosu.
Varsayılan olarak ne olur?	İsteğe bağlı girdi atlandığında oluşan davranış.
Ne döndürür?	Dönüş türü, yanıt gövdesi, dosya çıktısı, akış veya yan etki.
Hangi durumlarda başarısız olabilir?	İstisna, doğrulama hatası, HTTP durumu veya işletimsel arıza.
Bunu güvenli bir şekilde nasıl kullanırsınız?	Güvenlik, çalışan güvenliği, boyut sınırı, yol, zaman aşımı ve gizli bilgilerin işlenmesine ilişkin notlar.

Kapsam ilkesi

API ve davranış referans sayfaları kaynaklarla temellendirilir. Genel API’ler paket kaynak kodu, yapılandırma dosyaları, testler ve örnekler esas alınarak belgelenir. Dahili yardımcı sınıflar, yalnızca uygulama geliştiricilerin paketi yapılandırırken veya işletirken bu sınıfların davranışını anlaması gerektiğinde belgelenir.

Çeviriye hazırlık

Referans sayfalarında yoğun paragraflar yerine tablolar tercih edilir. Her satır kendi başına anlamlı olmalıdır; çünkü ileride Extensible Localization Interchange File Format (XLIFF) bölümlemesi içeriği bloklara ayıracaktır.