Zpět na BookField

BookField formát package

wbpkg

Package, který BookField umí ověřit, nainstalovat a číst

Snímek verzí

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

Stručně

Package, který BookField umí ověřit, nainstalovat a číst

Jedna installable hranice pro jedno work a jednu edition. manifest.json je veřejný contract, který BookField čte před importem. Legacy packageKind a presentation fields nejsou součástí současné package shape.

Instalovatelný kontejner

Jedna installable hranice pro jedno work a jednu edition.

Manifest v5

manifest.json je veřejný contract, který BookField čte před importem. Legacy packageKind a presentation fields nejsou součástí současné package shape.

ReaderDoc v3

ReaderDoc content je připravený pro import, takže reader za runtime neparsuje EPUB, HTML ani CSS.

Navigation tree

navigationTree určuje entry point a package-level obsah readeru.

Locator indexes

Když se canonical docs nebo schema files změní, nejprve aktualizujte source, potom tento public snapshot a vysvětlení.

Study plans

Authored study plans jsou v manifest.json jen tehdy, když package obsahuje schedule data.

Rozložení package

Canonical soubory uvnitř wbpkg

Package paths jsou package-root-relative POSIX paths. Text packages obsahují ReaderDoc files pod reader/, zatímco image, audio nebo video only packages mohou reader/ vynechat.

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

manifest.json je veřejný contract, který BookField čte před importem. Legacy packageKind a presentation fields nejsou součástí současné package shape.

packageId / packageVersion

manifest.json je veřejný contract, který BookField čte před importem. Legacy packageKind a presentation fields nejsou součástí současné package shape.

work / edition

Jedna installable hranice pro jedno work a jednu edition.

assets

Package paths jsou package-root-relative POSIX paths. Text packages obsahují ReaderDoc files pod reader/, zatímco image, audio nebo video only packages mohou reader/ vynechat.

navigationTree

navigationTree určuje entry point a package-level obsah readeru.

studyPlans

Authored study plans jsou v manifest.json jen tehdy, když package obsahuje schedule data.

bindings

Když se canonical docs nebo schema files změní, nejprve aktualizujte source, potom tento public snapshot a vysvětlení.

Vytvoření package

Oddělte production tooling od veřejné package hranice

  1. 1

    Připravte source content

    Připravte source content, metadata, media a případné authored schedules nebo references.

  2. 2

    Vytvořte wbpkg

    Vytvořte installable package s manifest metadata, ReaderDoc content, media, navigation a locator files.

  3. 3

    Ověřte před sdílením

    Před distribution zkontrolujte package structure a schema compatibility.

Reader import

BookField čte installed package lokálně

  1. 1

    Ověření

    BookField kontroluje package shape a odmítá unsupported nebo malformed packages.

  2. 2

    Rozbalení

    Supported package assets se rozbalí do app-owned local storage.

  3. 3

    Import do SQLite

    ReaderDoc payloads, navigation, locator indexes, search records a schedules se zaregistrují pro offline use.

Kompatibilita

Rules, které drží packages předvídatelné

  • Odmítnout legacy packageKind values.
  • Odmítnout legacy presentation fields.
  • Odmítnout non-canonical package paths.
  • Odmítnout malformed structured references.
  • Do installable wbpkg nevkládejte source EPUB files.

Canonical references

Update policy

Tato veřejná stránka je implementation-facing overview, ne canonical schema source. Canonical docs a schema files jsou u source materials BookField.

Source docs a schema files

  • 00-spec-index.md

    Tato veřejná stránka je implementation-facing overview, ne canonical schema source. Canonical docs a schema files jsou u source materials BookField.

  • 04-manifest-json-schema.md

    manifest.json je veřejný contract, který BookField čte před importem. Legacy packageKind a presentation fields nejsou součástí současné package shape.

  • 08-reader-app-design.md

    BookField čte installed package lokálně

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

    Tato veřejná stránka je implementation-facing overview, ne canonical schema source. Canonical docs a schema files jsou u source materials BookField.

Když se canonical docs nebo schema files změní, nejprve aktualizujte source, potom tento public snapshot a vysvětlení.

Naplánujte BookField package distribution

Vraťte se na product overview nebo proberte, zda wbpkg distribution flow sedí vašemu content modelu.

Zpět na BookField Probrat content distribution