Terug naar BookField

BookField package-formaat

wbpkg

Een package dat BookField kan valideren, installeren en lezen

Versiesnapshot

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

In één oogopslag

Een package dat BookField kan valideren, installeren en lezen

Eén installable boundary voor één work en één edition. manifest.json is het public contract dat BookField vóór import leest. Legacy packageKind en presentation fields horen niet bij de huidige package shape.

Installeerbare container

Eén installable boundary voor één work en één edition.

Manifest v5

manifest.json is het public contract dat BookField vóór import leest. Legacy packageKind en presentation fields horen niet bij de huidige package shape.

ReaderDoc v3

ReaderDoc content is voorbereid voor import, zodat de reader tijdens runtime geen EPUB, HTML of CSS parseert.

Navigation tree

navigationTree bepaalt het entry point en de package-level inhoudsopgave van de reader.

Locator indexes

Wanneer canonical docs of schema files veranderen, werk eerst source bij en vernieuw daarna deze public snapshot en uitleg.

Study plans

Authored study plans staan alleen in manifest.json wanneer het package schedule data bevat.

Package layout

Canonical files in een wbpkg

Package paths zijn package-root-relative POSIX paths. Text packages bevatten ReaderDoc files onder reader/, terwijl image, audio of video only packages reader/ kunnen weglaten.

.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 definieert het install contract

manifest.json is het public contract dat BookField vóór import leest. Legacy packageKind en presentation fields horen niet bij de huidige package shape.

packageId / packageVersion

manifest.json is het public contract dat BookField vóór import leest. Legacy packageKind en presentation fields horen niet bij de huidige package shape.

work / edition

Eén installable boundary voor één work en één edition.

assets

Package paths zijn package-root-relative POSIX paths. Text packages bevatten ReaderDoc files onder reader/, terwijl image, audio of video only packages reader/ kunnen weglaten.

navigationTree

navigationTree bepaalt het entry point en de package-level inhoudsopgave van de reader.

studyPlans

Authored study plans staan alleen in manifest.json wanneer het package schedule data bevat.

bindings

Wanneer canonical docs of schema files veranderen, werk eerst source bij en vernieuw daarna deze public snapshot en uitleg.

Package creation

Houd production tooling gescheiden van de public package boundary

  1. 1

    Source content voorbereiden

    Bereid source content, metadata, media en authored schedules of references voor.

  2. 2

    wbpkg maken

    Maak een installable package met manifest metadata, ReaderDoc content, media, navigation en locator files.

  3. 3

    Controleren vóór delen

    Controleer package structure en schema compatibility vóór distribution.

Reader import

BookField leest het installed package lokaal

  1. 1

    Valideren

    BookField controleert package shape en weigert unsupported of malformed packages.

  2. 2

    Uitpakken

    Supported package assets worden unpacked naar app-owned local storage.

  3. 3

    Importeren in SQLite

    ReaderDoc payloads, navigation, locator indexes, search records en schedules worden geregistreerd voor offline use.

Compatibiliteit

Rules die packages voorspelbaar houden

  • Weiger legacy packageKind values.
  • Weiger legacy presentation fields.
  • Weiger non-canonical package paths.
  • Weiger malformed structured references.
  • Neem geen source EPUB files op in een installable wbpkg.

Canonical references

Update policy

Deze public page is een implementation-facing overview, niet de canonical schema source. Canonical docs en schema files staan bij de BookField source materials.

Source docs en schema files

  • 00-spec-index.md

    Deze public page is een implementation-facing overview, niet de canonical schema source. Canonical docs en schema files staan bij de BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json is het public contract dat BookField vóór import leest. Legacy packageKind en presentation fields horen niet bij de huidige package shape.

  • 08-reader-app-design.md

    BookField leest het installed package lokaal

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

    Deze public page is een implementation-facing overview, niet de canonical schema source. Canonical docs en schema files staan bij de BookField source materials.

Wanneer canonical docs of schema files veranderen, werk eerst source bij en vernieuw daarna deze public snapshot en uitleg.

Plan de BookField package distribution

Ga terug naar de product overview of bespreek of een wbpkg distribution flow past bij uw content model.

Terug naar BookField Content distribution bespreken