Tilbake til BookField

BookField package-format

wbpkg

Package som BookField kan validate, install og read

Versjonsoversikt

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

Kort fortalt

Package som BookField kan validate, install og read

Ett installable boundary for ett work og én edition. manifest.json er public contract som BookField leser før import. Legacy packageKind og presentation fields er ikke del av dagens package shape.

Installerbar container

Ett installable boundary for ett work og én edition.

Manifest v5

manifest.json er public contract som BookField leser før import. Legacy packageKind og presentation fields er ikke del av dagens package shape.

ReaderDoc v3

ReaderDoc content er klargjort for import, slik at reader ikke parser EPUB, HTML eller CSS ved runtime.

Navigation tree

navigationTree bestemmer entry point og readerens package-level innholdsfortegnelse.

Locator indexes

Når canonical docs eller schema files endres, oppdater først source og deretter dette public snapshot og forklaringen.

Study plans

Authored study plans ligger i manifest.json bare når package inneholder schedule data.

Package layout

Canonical files i en wbpkg

Package paths er package-root-relative POSIX paths. Text packages har ReaderDoc files under reader/, mens image, audio eller video only packages kan utelate 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 definerer install contract

manifest.json er public contract som BookField leser før import. Legacy packageKind og presentation fields er ikke del av dagens package shape.

packageId / packageVersion

manifest.json er public contract som BookField leser før import. Legacy packageKind og presentation fields er ikke del av dagens package shape.

work / edition

Ett installable boundary for ett work og én edition.

assets

Package paths er package-root-relative POSIX paths. Text packages har ReaderDoc files under reader/, mens image, audio eller video only packages kan utelate reader/.

navigationTree

navigationTree bestemmer entry point og readerens package-level innholdsfortegnelse.

studyPlans

Authored study plans ligger i manifest.json bare når package inneholder schedule data.

bindings

Når canonical docs eller schema files endres, oppdater først source og deretter dette public snapshot og forklaringen.

Package creation

Hold production tooling adskilt fra public package boundary

  1. 1

    Forbered source content

    Forbered source content, metadata, media og authored schedules eller references.

  2. 2

    Lag wbpkg

    Lag en installable package med manifest metadata, ReaderDoc content, media, navigation og locator files.

  3. 3

    Verifiser før deling

    Kontroller package structure og schema compatibility før distribution.

Reader import

BookField leser installed package lokalt

  1. 1

    Validate

    BookField sjekker package shape og avviser unsupported eller malformed packages.

  2. 2

    Unpack

    Supported package assets pakkes ut i app-owned local storage.

  3. 3

    Import til SQLite

    ReaderDoc payloads, navigation, locator indexes, search records og schedules registreres for offline use.

Compatibility

Rules som holder packages forutsigbare

  • Avvis legacy packageKind values.
  • Avvis legacy presentation fields.
  • Avvis non-canonical package paths.
  • Avvis malformed structured references.
  • Ikke inkluder source EPUB files i en installable wbpkg.

Canonical references

Update policy

Denne public page er et implementation-facing overview, ikke canonical schema source. Canonical docs og schema files ligger sammen med BookField source materials.

Source docs og schema files

  • 00-spec-index.md

    Denne public page er et implementation-facing overview, ikke canonical schema source. Canonical docs og schema files ligger sammen med BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json er public contract som BookField leser før import. Legacy packageKind og presentation fields er ikke del av dagens package shape.

  • 08-reader-app-design.md

    BookField leser installed package lokalt

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

    Denne public page er et implementation-facing overview, ikke canonical schema source. Canonical docs og schema files ligger sammen med BookField source materials.

Når canonical docs eller schema files endres, oppdater først source og deretter dette public snapshot og forklaringen.

Planlegg BookField package distribution

Gå tilbake til product overview, eller diskuter om en wbpkg distribution flow passer content modelen din.

Tilbake til BookField Diskuter content distribution