Tillbaka till BookField

BookField package-format

wbpkg

Ett package som BookField kan validera, installera och läsa

Versionssnapshot

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 sagt

Ett package som BookField kan validera, installera och läsa

Ett package är en enda installable gräns för ett work och en edition. manifest.json är det public contract som BookField läser före import. Legacy packageKind och presentation fields ingår inte i aktuell package shape.

Installerbar container

Ett package är en enda installable gräns för ett work och en edition.

Manifest v5

manifest.json är det public contract som BookField läser före import. Legacy packageKind och presentation fields ingår inte i aktuell package shape.

ReaderDoc v3

ReaderDoc content är förberett för import, så reader tolkar inte EPUB, HTML eller CSS vid runtime.

Navigeringsträd

navigationTree bestämmer entry point och readerns package-level innehållsförteckning.

Locator-index

När canonical docs eller schema files ändras, uppdatera source först och uppdatera sedan detta public snapshot och förklaringen.

Studieplaner

Authored study plans finns i manifest.json endast när package innehåller schedule data.

Package layout

Canonical files i en wbpkg

Package paths är package-root-relative POSIX paths. Text packages innehåller ReaderDoc files under reader/, medan image, audio eller video only packages kan utelämna 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 definierar install contract

manifest.json är det public contract som BookField läser före import. Legacy packageKind och presentation fields ingår inte i aktuell package shape.

packageId / packageVersion

manifest.json är det public contract som BookField läser före import. Legacy packageKind och presentation fields ingår inte i aktuell package shape.

work / edition

Ett package är en enda installable gräns för ett work och en edition.

assets

Package paths är package-root-relative POSIX paths. Text packages innehåller ReaderDoc files under reader/, medan image, audio eller video only packages kan utelämna reader/.

navigationTree

navigationTree bestämmer entry point och readerns package-level innehållsförteckning.

studyPlans

Authored study plans finns i manifest.json endast när package innehåller schedule data.

bindings

När canonical docs eller schema files ändras, uppdatera source först och uppdatera sedan detta public snapshot och förklaringen.

Package creation

Håll production tooling separat från public package boundary

  1. 1

    Förbered source content

    Förbered source content, metadata, media och authored schedules eller references.

  2. 2

    Skapa wbpkg

    Skapa ett installable package med manifest metadata, ReaderDoc content, media, navigation och locator files.

  3. 3

    Verifiera före delning

    Kontrollera package structure och schema compatibility före distribution.

Reader import

BookField läser installed package lokalt

  1. 1

    Validera

    BookField kontrollerar package shape och avvisar unsupported eller malformed packages.

  2. 2

    Packa upp

    Supported package assets packas upp till app-owned local storage.

  3. 3

    Import till SQLite

    ReaderDoc payloads, navigation, locator indexes, search records och schedules registreras för offline use.

Kompatibilitet

Rules som håller packages förutsägbara

  • Avvisa legacy packageKind values.
  • Avvisa legacy presentation fields.
  • Avvisa non-canonical package paths.
  • Avvisa malformed structured references.
  • Inkludera inte source EPUB files i ett installable wbpkg.

Canonical references

Update policy

Den här offentliga sidan är en implementation-facing overview, inte canonical schema source. Canonical docs och schema files finns med BookField source materials.

Source docs och schema files

  • 00-spec-index.md

    Den här offentliga sidan är en implementation-facing overview, inte canonical schema source. Canonical docs och schema files finns med BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json är det public contract som BookField läser före import. Legacy packageKind och presentation fields ingår inte i aktuell package shape.

  • 08-reader-app-design.md

    BookField läser installed package lokalt

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

    Den här offentliga sidan är en implementation-facing overview, inte canonical schema source. Canonical docs och schema files finns med BookField source materials.

När canonical docs eller schema files ändras, uppdatera source först och uppdatera sedan detta public snapshot och förklaringen.

Planera BookField package distribution

Gå tillbaka till product overview eller diskutera om ett wbpkg distribution flow passar din content model.

Tillbaka till BookField Diskutera content distribution