Wróć do BookField

BookField format package

wbpkg

Package, który BookField może validate, install i read

Migawka wersji

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

W skrócie

Package, który BookField może validate, install i read

Jedna installable boundary dla jednego work i jednej edition. manifest.json to public contract, który BookField czyta przed importem. Legacy packageKind i presentation fields nie należą do obecnego package shape.

Instalowalny kontener

Jedna installable boundary dla jednego work i jednej edition.

Manifest v5

manifest.json to public contract, który BookField czyta przed importem. Legacy packageKind i presentation fields nie należą do obecnego package shape.

ReaderDoc v3

ReaderDoc content jest przygotowany do importu, więc reader nie parsuje EPUB, HTML ani CSS w runtime.

Navigation tree

navigationTree ustala entry point i package-level spis treści readera.

Locator indexes

Gdy canonical docs lub schema files się zmienią, najpierw zaktualizuj source, potem ten public snapshot i wyjaśnienie.

Study plans

Authored study plans są w manifest.json tylko wtedy, gdy package zawiera schedule data.

Package layout

Canonical files wewnątrz wbpkg

Package paths to package-root-relative POSIX paths. Text packages zawierają ReaderDoc files pod reader/, a image, audio lub video only packages mogą pominąć reader/.

.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 definiuje install contract

manifest.json to public contract, który BookField czyta przed importem. Legacy packageKind i presentation fields nie należą do obecnego package shape.

packageId / packageVersion

manifest.json to public contract, który BookField czyta przed importem. Legacy packageKind i presentation fields nie należą do obecnego package shape.

work / edition

Jedna installable boundary dla jednego work i jednej edition.

assets

Package paths to package-root-relative POSIX paths. Text packages zawierają ReaderDoc files pod reader/, a image, audio lub video only packages mogą pominąć reader/.

navigationTree

navigationTree ustala entry point i package-level spis treści readera.

studyPlans

Authored study plans są w manifest.json tylko wtedy, gdy package zawiera schedule data.

bindings

Gdy canonical docs lub schema files się zmienią, najpierw zaktualizuj source, potem ten public snapshot i wyjaśnienie.

Package creation

Oddziel production tooling od public package boundary

  1. 1

    Przygotuj source content

    Przygotuj source content, metadata, media oraz authored schedules lub references.

  2. 2

    Utwórz wbpkg

    Utwórz installable package z manifest metadata, ReaderDoc content, media, navigation i locator files.

  3. 3

    Sprawdź przed udostępnieniem

    Przed distribution sprawdź package structure i schema compatibility.

Reader import

BookField czyta installed package lokalnie

  1. 1

    Validate

    BookField sprawdza package shape i odrzuca unsupported lub malformed packages.

  2. 2

    Unpack

    Supported package assets są unpack do app-owned local storage.

  3. 3

    Import do SQLite

    ReaderDoc payloads, navigation, locator indexes, search records i schedules są rejestrowane do offline use.

Compatibility

Rules, które utrzymują packages przewidywalne

  • Odrzuć legacy packageKind values.
  • Odrzuć legacy presentation fields.
  • Odrzuć non-canonical package paths.
  • Odrzuć malformed structured references.
  • Nie dodawaj source EPUB files do installable wbpkg.

Canonical references

Update policy

Ta public page to implementation-facing overview, nie canonical schema source. Canonical docs i schema files są razem z BookField source materials.

Source docs i schema files

  • 00-spec-index.md

    Ta public page to implementation-facing overview, nie canonical schema source. Canonical docs i schema files są razem z BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json to public contract, który BookField czyta przed importem. Legacy packageKind i presentation fields nie należą do obecnego package shape.

  • 08-reader-app-design.md

    BookField czyta installed package lokalnie

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

    Ta public page to implementation-facing overview, nie canonical schema source. Canonical docs i schema files są razem z BookField source materials.

Gdy canonical docs lub schema files się zmienią, najpierw zaktualizuj source, potem ten public snapshot i wyjaśnienie.

Zaplanuj BookField package distribution

Wróć do product overview albo omów, czy wbpkg distribution flow pasuje do Twojego content model.

Wróć do BookField Omów content distribution