Retour à BookField

BookField format de package

wbpkg

Un package que BookField peut valider, installer et lire

Instantané des versions

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

En bref

Un package que BookField peut valider, installer et lire

Une limite installable unique pour un work et une edition. manifest.json est le contract public que BookField lit avant l’import. Les legacy packageKind et presentation fields ne font pas partie du package shape actuel.

Conteneur installable

Une limite installable unique pour un work et une edition.

Manifest v5

manifest.json est le contract public que BookField lit avant l’import. Les legacy packageKind et presentation fields ne font pas partie du package shape actuel.

ReaderDoc v3

ReaderDoc content est préparé pour l’import, afin que le reader ne parse pas EPUB, HTML ou CSS au runtime.

Navigation tree

navigationTree détermine l’entry point et la table des matières package-level du reader.

Locator indexes

Lorsque canonical docs ou schema files changent, mettez d’abord à jour source, puis ce public snapshot et son explication.

Study plans

Authored study plans sont dans manifest.json uniquement lorsque le package inclut schedule data.

Package layout

Fichiers canonical dans un wbpkg

Les package paths sont des package-root-relative POSIX paths. Les text packages incluent des ReaderDoc files sous reader/, tandis que les packages image, audio ou video only peuvent omettre 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 définit l’install contract

manifest.json est le contract public que BookField lit avant l’import. Les legacy packageKind et presentation fields ne font pas partie du package shape actuel.

packageId / packageVersion

manifest.json est le contract public que BookField lit avant l’import. Les legacy packageKind et presentation fields ne font pas partie du package shape actuel.

work / edition

Une limite installable unique pour un work et une edition.

assets

Les package paths sont des package-root-relative POSIX paths. Les text packages incluent des ReaderDoc files sous reader/, tandis que les packages image, audio ou video only peuvent omettre reader/.

navigationTree

navigationTree détermine l’entry point et la table des matières package-level du reader.

studyPlans

Authored study plans sont dans manifest.json uniquement lorsque le package inclut schedule data.

bindings

Lorsque canonical docs ou schema files changent, mettez d’abord à jour source, puis ce public snapshot et son explication.

Package creation

Séparer le production tooling de la public package boundary

  1. 1

    Préparer source content

    Préparez source content, metadata, media et les authored schedules ou references nécessaires.

  2. 2

    Produire un wbpkg

    Produisez un installable package avec manifest metadata, ReaderDoc content, media, navigation et locator files.

  3. 3

    Vérifier avant partage

    Vérifiez package structure et schema compatibility avant distribution.

Reader import

BookField lit localement l’installed package

  1. 1

    Valider

    BookField vérifie le package shape et rejette les packages unsupported ou malformed.

  2. 2

    Décompresser

    Les supported package assets sont unpack dans app-owned local storage.

  3. 3

    Importer dans SQLite

    ReaderDoc payloads, navigation, locator indexes, search records et schedules sont enregistrés pour offline use.

Compatibilité

Rules qui gardent les packages prévisibles

  • Rejeter legacy packageKind values.
  • Rejeter legacy presentation fields.
  • Rejeter non-canonical package paths.
  • Rejeter malformed structured references.
  • N’incluez pas de source EPUB files dans un installable wbpkg.

Canonical references

Update policy

Cette public page est un implementation-facing overview, pas la canonical schema source. Les canonical docs et schema files vivent avec les BookField source materials.

Source docs et schema files

  • 00-spec-index.md

    Cette public page est un implementation-facing overview, pas la canonical schema source. Les canonical docs et schema files vivent avec les BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json est le contract public que BookField lit avant l’import. Les legacy packageKind et presentation fields ne font pas partie du package shape actuel.

  • 08-reader-app-design.md

    BookField lit localement l’installed package

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

    Cette public page est un implementation-facing overview, pas la canonical schema source. Les canonical docs et schema files vivent avec les BookField source materials.

Lorsque canonical docs ou schema files changent, mettez d’abord à jour source, puis ce public snapshot et son explication.

Planifier la BookField package distribution

Retournez au product overview ou discutez de l’adéquation d’un wbpkg distribution flow à votre content model.

Retour à BookField Discuter content distribution