Torna a BookField

BookField formato package

wbpkg

Un package che BookField può validare, installare e leggere

Snapshot versioni

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 sintesi

Un package che BookField può validare, installare e leggere

Un solo installable boundary per un work e una edition. manifest.json è il public contract che BookField legge prima dell’import. Legacy packageKind e presentation fields non fanno parte dell’attuale package shape.

Contenitore installabile

Un solo installable boundary per un work e una edition.

Manifest v5

manifest.json è il public contract che BookField legge prima dell’import. Legacy packageKind e presentation fields non fanno parte dell’attuale package shape.

ReaderDoc v3

ReaderDoc content è preparato per l’import, quindi il reader non analizza EPUB, HTML o CSS a runtime.

Navigation tree

navigationTree decide l’entry point e la tabella dei contenuti package-level del reader.

Locator indexes

Quando canonical docs o schema files cambiano, aggiorna prima source e poi questo public snapshot e la sua spiegazione.

Study plans

Authored study plans vivono in manifest.json solo quando il package include schedule data.

Package layout

Canonical files dentro un wbpkg

I package paths sono package-root-relative POSIX paths. I text packages includono ReaderDoc files sotto reader/, mentre image, audio o video only packages possono omettere 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 definisce l’install contract

manifest.json è il public contract che BookField legge prima dell’import. Legacy packageKind e presentation fields non fanno parte dell’attuale package shape.

packageId / packageVersion

manifest.json è il public contract che BookField legge prima dell’import. Legacy packageKind e presentation fields non fanno parte dell’attuale package shape.

work / edition

Un solo installable boundary per un work e una edition.

assets

I package paths sono package-root-relative POSIX paths. I text packages includono ReaderDoc files sotto reader/, mentre image, audio o video only packages possono omettere reader/.

navigationTree

navigationTree decide l’entry point e la tabella dei contenuti package-level del reader.

studyPlans

Authored study plans vivono in manifest.json solo quando il package include schedule data.

bindings

Quando canonical docs o schema files cambiano, aggiorna prima source e poi questo public snapshot e la sua spiegazione.

Package creation

Tenere il production tooling separato dal public package boundary

  1. 1

    Prepara source content

    Prepara source content, metadata, media e eventuali authored schedules o references.

  2. 2

    Produci un wbpkg

    Produci un installable package con manifest metadata, ReaderDoc content, media, navigation e locator files.

  3. 3

    Verifica prima della condivisione

    Controlla package structure e schema compatibility prima della distribution.

Reader import

BookField legge localmente l’installed package

  1. 1

    Valida

    BookField controlla package shape e rifiuta unsupported o malformed packages.

  2. 2

    Unpack

    I supported package assets vengono unpack in app-owned local storage.

  3. 3

    Importa in SQLite

    ReaderDoc payloads, navigation, locator indexes, search records e schedules sono registrati per offline use.

Compatibilità

Rules che mantengono prevedibili i packages

  • Rifiuta legacy packageKind values.
  • Rifiuta legacy presentation fields.
  • Rifiuta non-canonical package paths.
  • Rifiuta malformed structured references.
  • Non includere source EPUB files in un installable wbpkg.

Canonical references

Update policy

Questa public page è un implementation-facing overview, non la canonical schema source. Canonical docs e schema files vivono con i BookField source materials.

Source docs e schema files

  • 00-spec-index.md

    Questa public page è un implementation-facing overview, non la canonical schema source. Canonical docs e schema files vivono con i BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json è il public contract che BookField legge prima dell’import. Legacy packageKind e presentation fields non fanno parte dell’attuale package shape.

  • 08-reader-app-design.md

    BookField legge localmente l’installed package

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

    Questa public page è un implementation-facing overview, non la canonical schema source. Canonical docs e schema files vivono con i BookField source materials.

Quando canonical docs o schema files cambiano, aggiorna prima source e poi questo public snapshot e la sua spiegazione.

Pianifica BookField package distribution

Torna al product overview o discuti se un wbpkg distribution flow si adatta al tuo content model.

Torna a BookField Discuti content distribution