BookField’a dön

BookField package biçimi

wbpkg

BookField’ın doğrulayabildiği, yükleyebildiği ve okuyabildiği package

Sürüm anlık görünümü

workbook.toml
schema_version = 4
.wbpkg/manifest.json
schemaVersion = 5
reader_manifest.json
schemaVersion = 3
reader.rdoc
schemaVersion = 3
Reader SQLite schema
db_schema_version = 17

Kısa bakış

BookField’ın doğrulayabildiği, yükleyebildiği ve okuyabildiği package

Bir package, bir work ve bir edition için tek installable sınırdır. manifest.json, BookField’ın import öncesi okuduğu public contract’tır. Legacy packageKind ve presentation fields geçerli package shape’in parçası değildir.

Yüklenebilir container

Bir package, bir work ve bir edition için tek installable sınırdır.

Manifest v5

manifest.json, BookField’ın import öncesi okuduğu public contract’tır. Legacy packageKind ve presentation fields geçerli package shape’in parçası değildir.

ReaderDoc v3

ReaderDoc content import için hazırlanmıştır; bu yüzden reader runtime sırasında EPUB, HTML veya CSS parse etmez.

Navigasyon ağacı

navigationTree reader için entry point ve package-level içindekiler tablosunu belirler.

Locator indexleri

canonical docs veya schema files değiştiğinde önce source güncelleyin, sonra bu public snapshot ve açıklamayı yenileyin.

Çalışma planları

Authored study plans package schedule data içerdiğinde manifest.json içinde yer alır.

Package layout

wbpkg içindeki canonical files

Package paths, package root’a göre POSIX paths olarak yazılır. Text packages reader/ altında ReaderDoc files içerir; image, audio veya video only packages reader/ bölümünü atlayabilir.

.wbpkg
manifest.json
reader/{assetId}/reader_manifest.json
reader/{assetId}/reader.rdoc
images/{assetId}.{ext}
images/{assetId}-thumb.{ext}
media/{assetId}.{ext}
locator/{profileId}.json

Manifest contract

Manifest v5 install contract tanımlar

manifest.json, BookField’ın import öncesi okuduğu public contract’tır. Legacy packageKind ve presentation fields geçerli package shape’in parçası değildir.

packageId / packageVersion

manifest.json, BookField’ın import öncesi okuduğu public contract’tır. Legacy packageKind ve presentation fields geçerli package shape’in parçası değildir.

work / edition

Bir package, bir work ve bir edition için tek installable sınırdır.

assets

Package paths, package root’a göre POSIX paths olarak yazılır. Text packages reader/ altında ReaderDoc files içerir; image, audio veya video only packages reader/ bölümünü atlayabilir.

navigationTree

navigationTree reader için entry point ve package-level içindekiler tablosunu belirler.

studyPlans

Authored study plans package schedule data içerdiğinde manifest.json içinde yer alır.

bindings

canonical docs veya schema files değiştiğinde önce source güncelleyin, sonra bu public snapshot ve açıklamayı yenileyin.

Package creation

Production tooling’i public package boundary’den ayrı tutun

  1. 1

    Source content hazırlayın

    source content, metadata, media ve authored schedules veya references hazırlayın.

  2. 2

    wbpkg üretin

    manifest metadata, ReaderDoc content, media, navigation ve locator files içeren installable package üretin.

  3. 3

    Paylaşmadan önce doğrulayın

    distribution öncesi package structure ve schema compatibility kontrol edin.

Reader import

BookField installed package öğesini yerel olarak okur

  1. 1

    Doğrula

    BookField package shape’i kontrol eder ve unsupported veya malformed packages öğelerini reddeder.

  2. 2

    Aç

    Supported package assets app-owned local storage içine unpack edilir.

  3. 3

    SQLite’a import

    ReaderDoc payloads, navigation, locator indexes, search records ve schedules offline use için kaydedilir.

Uyumluluk

Packages öğelerini öngörülebilir tutan rules

  • Reddedin legacy packageKind values.
  • Reddedin legacy presentation fields.
  • Reddedin non-canonical package paths.
  • Reddedin malformed structured references.
  • installable wbpkg içine source EPUB files eklemeyin.

Canonical references

Update policy

Bu public page, implementation-facing overview niteliğindedir; canonical schema source değildir. Canonical docs ve schema files BookField source materials ile birlikte bulunur.

Source docs ve schema files

  • 00-spec-index.md

    Bu public page, implementation-facing overview niteliğindedir; canonical schema source değildir. Canonical docs ve schema files BookField source materials ile birlikte bulunur.

  • 04-manifest-json-schema.md

    manifest.json, BookField’ın import öncesi okuduğu public contract’tır. Legacy packageKind ve presentation fields geçerli package shape’in parçası değildir.

  • 08-reader-app-design.md

    BookField installed package öğesini yerel olarak okur

  • schemas/manifest-v5.schema.json / readerdoc-v3.schema.json

    Bu public page, implementation-facing overview niteliğindedir; canonical schema source değildir. Canonical docs ve schema files BookField source materials ile birlikte bulunur.

canonical docs veya schema files değiştiğinde önce source güncelleyin, sonra bu public snapshot ve açıklamayı yenileyin.

BookField package distribution planlayın

Product overview’a dönün veya wbpkg distribution flow’un content modelinize uyup uymadığını konuşun.

BookField’a dön Content distribution konuş