Zurück zu BookField

BookField Package-Format

wbpkg

Ein Package, das BookField validieren, installieren und lesen kann

Versionsübersicht

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

Auf einen Blick

Ein Package, das BookField validieren, installieren und lesen kann

Eine einzelne installable Grenze für ein work und eine edition. manifest.json ist der öffentliche contract, den BookField vor dem Import liest. Legacy packageKind und presentation fields gehören nicht zur aktuellen package shape.

Installierbarer Container

Eine einzelne installable Grenze für ein work und eine edition.

Manifest v5

manifest.json ist der öffentliche contract, den BookField vor dem Import liest. Legacy packageKind und presentation fields gehören nicht zur aktuellen package shape.

ReaderDoc v3

ReaderDoc content ist für den Import vorbereitet, sodass der Reader zur Laufzeit kein EPUB, HTML oder CSS parst.

Navigation tree

navigationTree bestimmt entry point und das package-level Inhaltsverzeichnis des Readers.

Locator indexes

Wenn canonical docs oder schema files geändert werden, zuerst die source aktualisieren und dann diesen public snapshot samt Erklärung auffrischen.

Study plans

Authored study plans liegen nur in manifest.json, wenn das Package schedule data enthält.

Package layout

Canonical files in einer wbpkg

Package paths sind package-root-relative POSIX paths. Text packages enthalten ReaderDoc files unter reader/, während image, audio oder video only packages reader/ auslassen können.

.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 definiert den install contract

manifest.json ist der öffentliche contract, den BookField vor dem Import liest. Legacy packageKind und presentation fields gehören nicht zur aktuellen package shape.

packageId / packageVersion

manifest.json ist der öffentliche contract, den BookField vor dem Import liest. Legacy packageKind und presentation fields gehören nicht zur aktuellen package shape.

work / edition

Eine einzelne installable Grenze für ein work und eine edition.

assets

Package paths sind package-root-relative POSIX paths. Text packages enthalten ReaderDoc files unter reader/, während image, audio oder video only packages reader/ auslassen können.

navigationTree

navigationTree bestimmt entry point und das package-level Inhaltsverzeichnis des Readers.

studyPlans

Authored study plans liegen nur in manifest.json, wenn das Package schedule data enthält.

bindings

Wenn canonical docs oder schema files geändert werden, zuerst die source aktualisieren und dann diesen public snapshot samt Erklärung auffrischen.

Package creation

Production tooling von der öffentlichen package boundary trennen

  1. 1

    Source content vorbereiten

    Bereiten Sie source content, metadata, media sowie authored schedules oder references vor.

  2. 2

    wbpkg erzeugen

    Erzeugen Sie ein installable package mit manifest metadata, ReaderDoc content, media, navigation und locator files.

  3. 3

    Vor dem Teilen prüfen

    Prüfen Sie package structure und schema compatibility vor der distribution.

Reader import

BookField liest das installed package lokal

  1. 1

    Validieren

    BookField prüft die package shape und lehnt unsupported oder malformed packages ab.

  2. 2

    Entpacken

    Supported package assets werden in app-owned local storage entpackt.

  3. 3

    In SQLite importieren

    ReaderDoc payloads, navigation, locator indexes, search records und schedules werden für offline use registriert.

Kompatibilität

Rules, die Packages vorhersehbar halten

  • Ablehnen legacy packageKind values.
  • Ablehnen legacy presentation fields.
  • Ablehnen non-canonical package paths.
  • Ablehnen malformed structured references.
  • Keine source EPUB files in eine installable wbpkg aufnehmen.

Canonical references

Update policy

Diese öffentliche Seite ist ein implementation-facing overview, nicht die canonical schema source. Canonical docs und schema files liegen bei den BookField source materials.

Source docs und schema files

  • 00-spec-index.md

    Diese öffentliche Seite ist ein implementation-facing overview, nicht die canonical schema source. Canonical docs und schema files liegen bei den BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json ist der öffentliche contract, den BookField vor dem Import liest. Legacy packageKind und presentation fields gehören nicht zur aktuellen package shape.

  • 08-reader-app-design.md

    BookField liest das installed package lokal

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

    Diese öffentliche Seite ist ein implementation-facing overview, nicht die canonical schema source. Canonical docs und schema files liegen bei den BookField source materials.

Wenn canonical docs oder schema files geändert werden, zuerst die source aktualisieren und dann diesen public snapshot samt Erklärung auffrischen.

BookField package distribution planen

Zur product overview zurückkehren oder besprechen, ob ein wbpkg distribution flow zu Ihrem content model passt.

Zurück zu BookField Content distribution besprechen