Nazad na BookField

BookField format paketa

wbpkg

Package koji BookField može da proveri, instalira i čita

Snimak 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 da proveri, instalira i čita

Jedan package je jedna installable granica za jedan work i jednu edition. manifest.json je public contract koji BookField čita pre import-a. Legacy packageKind i presentation fields nisu deo trenutnog package shape-a.

Kontejner za instalaciju

Jedan package je jedna installable granica za jedan work i jednu edition.

Manifest v5

manifest.json je public contract koji BookField čita pre import-a. Legacy packageKind i presentation fields nisu deo trenutnog package shape-a.

ReaderDoc v3

ReaderDoc content pripremljen je za import, pa reader ne parsira EPUB, HTML ili CSS tokom runtime-a.

Stablo navigacije

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

Locator indeksi

Kada se canonical docs ili schema files promene, prvo ažurirajte source, zatim osvežite ovaj public snapshot i objašnjenje.

Planovi učenja

Authored study plans stoje u manifest.json samo kada package sadrži schedule data.

Package layout

Canonical files unutar wbpkg

Package paths su POSIX paths relativni na package root. 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 definiše install contract

manifest.json je public contract koji BookField čita pre import-a. Legacy packageKind i presentation fields nisu deo trenutnog package shape-a.

packageId / packageVersion

manifest.json je public contract koji BookField čita pre import-a. Legacy packageKind i presentation fields nisu deo trenutnog package shape-a.

work / edition

Jedan package je jedna installable granica za jedan work i jednu edition.

assets

Package paths su POSIX paths relativni na package root. 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 stoje u manifest.json samo kada package sadrži schedule data.

bindings

Kada se canonical docs ili schema files promene, prvo ažurirajte source, zatim osvežite ovaj public snapshot i objašnjenje.

Package creation

Držite production tooling odvojeno od public package boundary

  1. 1

    Pripremite source content

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

  2. 2

    Napravite wbpkg

    Napravite installable package sa manifest metadata, ReaderDoc content, media, navigation i locator files.

  3. 3

    Proverite pre deljenja

    Proverite package structure i schema compatibility pre distribution.

Reader import

BookField čita installed package lokalno

  1. 1

    Validacija

    BookField proverava package shape i odbija unsupported ili malformed packages.

  2. 2

    Raspakivanje

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

  3. 3

    Import u SQLite

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

Kompatibilnost

Pravila koja čine packages predvidljivim

  • Odbijte legacy packageKind values.
  • Odbijte legacy presentation fields.
  • Odbijte non-canonical package paths.
  • Odbijte malformed structured references.
  • Ne uključujte source EPUB files u installable wbpkg.

Canonical references

Update policy

Ova javna stranica je implementation-facing overview, ne canonical schema source. Canonical docs i schema files ostaju uz BookField source materials.

Source docs i schema files

  • 00-spec-index.md

    Ova javna stranica je implementation-facing overview, ne canonical schema source. Canonical docs i schema files ostaju uz BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json je public contract koji BookField čita pre import-a. Legacy packageKind i presentation fields nisu deo trenutnog package shape-a.

  • 08-reader-app-design.md

    BookField čita installed package lokalno

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

    Ova javna stranica je implementation-facing overview, ne canonical schema source. Canonical docs i schema files ostaju uz BookField source materials.

Kada se canonical docs ili schema files promene, prvo ažurirajte source, zatim osvežite ovaj public snapshot i objašnjenje.

Isplanirajte BookField package distribution

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

Nazad na BookField Razgovor o content distribution