Tilbage til BookField

BookField package-format

wbpkg

En package, som BookField kan validere, installere og læse

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 fortalt

En package, som BookField kan validere, installere og læse

En enkelt installable grænse for ét work og én edition. manifest.json er den offentlige contract, som BookField læser før import. Legacy packageKind og presentation fields er ikke en del af den aktuelle package shape.

Installerbar container

En enkelt installable grænse for ét work og én edition.

Manifest v5

manifest.json er den offentlige contract, som BookField læser før import. Legacy packageKind og presentation fields er ikke en del af den aktuelle package shape.

ReaderDoc v3

ReaderDoc content er klargjort til import, så reader ikke parser EPUB, HTML eller CSS ved runtime.

Navigation tree

navigationTree bestemmer entry point og readerens package-level indholdsfortegnelse.

Locator indexes

Når canonical docs eller schema files ændres, opdater først source og derefter dette public snapshot og forklaringen.

Study plans

Authored study plans ligger kun i manifest.json, når package indeholder schedule data.

Package layout

Canonical filer 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 udelade 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 den offentlige contract, som BookField læser før import. Legacy packageKind og presentation fields er ikke en del af den aktuelle package shape.

packageId / packageVersion

manifest.json er den offentlige contract, som BookField læser før import. Legacy packageKind og presentation fields er ikke en del af den aktuelle package shape.

work / edition

En enkelt installable grænse for ét 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 udelade reader/.

navigationTree

navigationTree bestemmer entry point og readerens package-level indholdsfortegnelse.

studyPlans

Authored study plans ligger kun i manifest.json, når package indeholder schedule data.

bindings

Når canonical docs eller schema files ændres, opdater først source og derefter dette public snapshot og forklaringen.

Package creation

Hold production tooling adskilt fra den offentlige package boundary

  1. 1

    Forbered source content

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

  2. 2

    Lav en wbpkg

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

  3. 3

    Verificer før deling

    Kontroller package structure og schema compatibility før distribution.

Reader import

BookField læser den installed package lokalt

  1. 1

    Validér

    BookField kontrollerer package shape og afviser unsupported eller malformed packages.

  2. 2

    Pak ud

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

  3. 3

    Import til SQLite

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

Kompatibilitet

Rules der holder packages forudsigelige

  • Afvis legacy packageKind values.
  • Afvis legacy presentation fields.
  • Afvis non-canonical package paths.
  • Afvis malformed structured references.
  • Medtag ikke source EPUB files i en installable wbpkg.

Canonical references

Update policy

Denne offentlige side 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 offentlige side 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 den offentlige contract, som BookField læser før import. Legacy packageKind og presentation fields er ikke en del af den aktuelle package shape.

  • 08-reader-app-design.md

    BookField læser den installed package lokalt

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

    Denne offentlige side 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 ændres, opdater først source og derefter dette public snapshot og forklaringen.

Planlæg BookField package distribution

Gå tilbage til product overview, eller drøft om en wbpkg distribution flow passer til din content model.

Tilbage til BookField Drøft content distribution