Înapoi la BookField

BookField format package

wbpkg

Package pe care BookField îl poate validate, install și read

Instantaneu de versiune

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

Pe scurt

Package pe care BookField îl poate validate, install și read

Un singur installable boundary pentru un work și o edition. manifest.json este public contract pe care BookField îl citește înainte de import. Legacy packageKind și presentation fields nu fac parte din package shape curent.

Container instalabil

Un singur installable boundary pentru un work și o edition.

Manifest v5

manifest.json este public contract pe care BookField îl citește înainte de import. Legacy packageKind și presentation fields nu fac parte din package shape curent.

ReaderDoc v3

ReaderDoc content este pregătit pentru import, astfel încât reader nu parsează EPUB, HTML sau CSS la runtime.

Navigation tree

navigationTree decide entry point și cuprinsul package-level al readerului.

Locator indexes

Când canonical docs sau schema files se schimbă, actualizați mai întâi source, apoi acest public snapshot și explicația lui.

Study plans

Authored study plans există în manifest.json doar când package include schedule data.

Package layout

Canonical files în interiorul unui wbpkg

Package paths sunt package-root-relative POSIX paths. Text packages includ ReaderDoc files sub reader/, iar image, audio sau video only packages pot omite 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 definește install contract

manifest.json este public contract pe care BookField îl citește înainte de import. Legacy packageKind și presentation fields nu fac parte din package shape curent.

packageId / packageVersion

manifest.json este public contract pe care BookField îl citește înainte de import. Legacy packageKind și presentation fields nu fac parte din package shape curent.

work / edition

Un singur installable boundary pentru un work și o edition.

assets

Package paths sunt package-root-relative POSIX paths. Text packages includ ReaderDoc files sub reader/, iar image, audio sau video only packages pot omite reader/.

navigationTree

navigationTree decide entry point și cuprinsul package-level al readerului.

studyPlans

Authored study plans există în manifest.json doar când package include schedule data.

bindings

Când canonical docs sau schema files se schimbă, actualizați mai întâi source, apoi acest public snapshot și explicația lui.

Package creation

Țineți production tooling separat de public package boundary

  1. 1

    Pregătiți source content

    Pregătiți source content, metadata, media și authored schedules sau references.

  2. 2

    Produceți wbpkg

    Produceți un installable package cu manifest metadata, ReaderDoc content, media, navigation și locator files.

  3. 3

    Verificați înainte de partajare

    Verificați package structure și schema compatibility înainte de distribution.

Reader import

BookField citește local installed package

  1. 1

    Validate

    BookField verifică package shape și respinge unsupported sau malformed packages.

  2. 2

    Unpack

    Supported package assets sunt unpack în app-owned local storage.

  3. 3

    Import în SQLite

    ReaderDoc payloads, navigation, locator indexes, search records și schedules sunt înregistrate pentru offline use.

Compatibility

Rules care mențin packages previzibile

  • Respingeți legacy packageKind values.
  • Respingeți legacy presentation fields.
  • Respingeți non-canonical package paths.
  • Respingeți malformed structured references.
  • Nu includeți source EPUB files într-un installable wbpkg.

Canonical references

Update policy

Această public page este un implementation-facing overview, nu canonical schema source. Canonical docs și schema files stau cu BookField source materials.

Source docs și schema files

  • 00-spec-index.md

    Această public page este un implementation-facing overview, nu canonical schema source. Canonical docs și schema files stau cu BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json este public contract pe care BookField îl citește înainte de import. Legacy packageKind și presentation fields nu fac parte din package shape curent.

  • 08-reader-app-design.md

    BookField citește local installed package

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

    Această public page este un implementation-facing overview, nu canonical schema source. Canonical docs și schema files stau cu BookField source materials.

Când canonical docs sau schema files se schimbă, actualizați mai întâi source, apoi acest public snapshot și explicația lui.

Planificați BookField package distribution

Reveniți la product overview sau discutați dacă un wbpkg distribution flow se potrivește cu content modelul dvs.

Înapoi la BookField Discutați content distribution