Natrag na BookField

BookField package format

wbpkg

Package koji BookField može validate, install i read

Pregled verzija

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

Ukratko

Package koji BookField može validate, install i read

Jedan installable boundary za jedan work i jednu edition. manifest.json je public contract koji BookField čita prije importa. Legacy packageKind i presentation fields nisu dio trenutnog package shapea.

Installable container

Jedan installable boundary za jedan work i jednu edition.

Manifest v5

manifest.json je public contract koji BookField čita prije importa. Legacy packageKind i presentation fields nisu dio trenutnog package shapea.

ReaderDoc v3

ReaderDoc content pripremljen je za import, pa reader u runtimeu ne parsea EPUB, HTML ni CSS.

Navigation tree

navigationTree određuje entry point i package-level sadržaj readera.

Locator indexes

Kad se canonical docs ili schema files promijene, prvo ažurirajte source, zatim ovaj public snapshot i objašnjenje.

Study plans

Authored study plans nalaze se u manifest.json samo kada package uključuje schedule data.

Package layout

Canonical files unutar wbpkg

Package paths su package-root-relative POSIX paths. Text packages sadrže ReaderDoc files pod reader/, dok image, audio ili video only packages mogu izostaviti 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 definira install contract

manifest.json je public contract koji BookField čita prije importa. Legacy packageKind i presentation fields nisu dio trenutnog package shapea.

packageId / packageVersion

manifest.json je public contract koji BookField čita prije importa. Legacy packageKind i presentation fields nisu dio trenutnog package shapea.

work / edition

Jedan installable boundary za jedan work i jednu edition.

assets

Package paths su package-root-relative POSIX paths. Text packages sadrže ReaderDoc files pod reader/, dok image, audio ili video only packages mogu izostaviti reader/.

navigationTree

navigationTree određuje entry point i package-level sadržaj readera.

studyPlans

Authored study plans nalaze se u manifest.json samo kada package uključuje schedule data.

bindings

Kad se canonical docs ili schema files promijene, prvo ažurirajte source, zatim ovaj public snapshot i objašnjenje.

Package creation

Odvojite production tooling od public package boundary

  1. 1

    Pripremite source content

    Pripremite source content, metadata, media i authored schedules ili references.

  2. 2

    Izradite wbpkg

    Proizvedite installable package s manifest metadata, ReaderDoc content, media, navigation i locator files.

  3. 3

    Provjerite prije dijeljenja

    Prije distribution provjerite package structure i schema compatibility.

Reader import

BookField lokalno čita installed package

  1. 1

    Validate

    BookField provjerava package shape i odbija unsupported ili malformed packages.

  2. 2

    Unpack

    Supported package assets se raspakiraju u app-owned local storage.

  3. 3

    Import u SQLite

    ReaderDoc payloads, navigation, locator indexes, search records i schedules registriraju se za offline use.

Compatibility

Rules koje održavaju packages predvidljivima

  • Odbij legacy packageKind values.
  • Odbij legacy presentation fields.
  • Odbij non-canonical package paths.
  • Odbij malformed structured references.
  • Nemojte uključivati source EPUB files u installable wbpkg.

Canonical references

Update policy

Ova public page je implementation-facing overview, a ne canonical schema source. Canonical docs i schema files nalaze se uz BookField source materials.

Source docs i schema files

  • 00-spec-index.md

    Ova public page je implementation-facing overview, a ne canonical schema source. Canonical docs i schema files nalaze se uz BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json je public contract koji BookField čita prije importa. Legacy packageKind i presentation fields nisu dio trenutnog package shapea.

  • 08-reader-app-design.md

    BookField lokalno čita installed package

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

    Ova public page je implementation-facing overview, a ne canonical schema source. Canonical docs i schema files nalaze se uz BookField source materials.

Kad se canonical docs ili schema files promijene, prvo ažurirajte source, zatim ovaj public snapshot i objašnjenje.

Planirajte BookField package distribution

Vratite se na product overview ili razgovarajte odgovara li wbpkg distribution flow vašem content modelu.

Natrag na BookField Razgovarajte o content distribution