Späť na BookField

BookField formát package

wbpkg

Package, ktorý BookField vie overiť, nainštalovať a čítať

Snímka verzií

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čne

Package, ktorý BookField vie overiť, nainštalovať a čítať

Jeden package je jedna installable hranica pre jedno work a jednu edition. manifest.json je public contract, ktorý BookField číta pred importom. Legacy packageKind a presentation fields nie sú súčasťou aktuálneho package shape.

Inštalovateľný kontajner

Jeden package je jedna installable hranica pre jedno work a jednu edition.

Manifest v5

manifest.json je public contract, ktorý BookField číta pred importom. Legacy packageKind a presentation fields nie sú súčasťou aktuálneho package shape.

ReaderDoc v3

ReaderDoc content je pripravený na import, takže reader za runtime neparsuje EPUB, HTML ani CSS.

Navigačný strom

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

Locator indexy

Keď sa canonical docs alebo schema files zmenia, najprv aktualizujte source a potom tento public snapshot a vysvetlenie.

Študijné plány

Authored study plans sú v manifest.json iba vtedy, keď package obsahuje schedule data.

Package layout

Canonical files vo vnútri wbpkg

Package paths sú POSIX paths relatívne ku package root. Text packages obsahujú ReaderDoc files pod reader/, zatiaľ čo image, audio alebo video only packages môžu reader/ vynechať.

.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 public contract, ktorý BookField číta pred importom. Legacy packageKind a presentation fields nie sú súčasťou aktuálneho package shape.

packageId / packageVersion

manifest.json je public contract, ktorý BookField číta pred importom. Legacy packageKind a presentation fields nie sú súčasťou aktuálneho package shape.

work / edition

Jeden package je jedna installable hranica pre jedno work a jednu edition.

assets

Package paths sú POSIX paths relatívne ku package root. Text packages obsahujú ReaderDoc files pod reader/, zatiaľ čo image, audio alebo video only packages môžu reader/ vynechať.

navigationTree

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

studyPlans

Authored study plans sú v manifest.json iba vtedy, keď package obsahuje schedule data.

bindings

Keď sa canonical docs alebo schema files zmenia, najprv aktualizujte source a potom tento public snapshot a vysvetlenie.

Package creation

Oddeľte production tooling od public package boundary

  1. 1

    Pripravte source content

    Pripravte source content, metadata, media a authored schedules alebo references.

  2. 2

    Vytvorte wbpkg

    Vytvorte installable package s manifest metadata, ReaderDoc content, media, navigation a locator files.

  3. 3

    Overte pred zdieľaním

    Pred distribution skontrolujte package structure a schema compatibility.

Reader import

BookField číta installed package lokálne

  1. 1

    Overenie

    BookField kontroluje package shape a odmieta unsupported alebo malformed packages.

  2. 2

    Rozbalenie

    Supported package assets sa rozbalia do app-owned local storage.

  3. 3

    Import do SQLite

    ReaderDoc payloads, navigation, locator indexes, search records a schedules sa zaregistrujú na offline use.

Kompatibilita

Pravidlá, ktoré držia packages predvídateľné

  • Odmietnite legacy packageKind values.
  • Odmietnite legacy presentation fields.
  • Odmietnite non-canonical package paths.
  • Odmietnite malformed structured references.
  • Do installable wbpkg nevkladajte source EPUB files.

Canonical references

Update policy

Táto verejná stránka je implementation-facing overview, nie canonical schema source. Canonical docs a schema files zostávajú pri BookField source materials.

Source docs a schema files

  • 00-spec-index.md

    Táto verejná stránka je implementation-facing overview, nie canonical schema source. Canonical docs a schema files zostávajú pri BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json je public contract, ktorý BookField číta pred importom. Legacy packageKind a presentation fields nie sú súčasťou aktuálneho package shape.

  • 08-reader-app-design.md

    BookField číta installed package lokálne

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

    Táto verejná stránka je implementation-facing overview, nie canonical schema source. Canonical docs a schema files zostávajú pri BookField source materials.

Keď sa canonical docs alebo schema files zmenia, najprv aktualizujte source a potom tento public snapshot a vysvetlenie.

Naplánujte BookField package distribution

Vráťte sa na product overview alebo prediskutujte, či wbpkg distribution flow sedí vášmu content modelu.

Späť na BookField Prediskutovať content distribution