Tagasi BookFieldi juurde

BookField package vorming

wbpkg

Package, mida BookField saab valideerida, installida ja lugeda

Versioonide hetkeseis

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

Lühidalt

Package, mida BookField saab valideerida, installida ja lugeda

Üks installable boundary ühe work ja ühe edition jaoks. manifest.json on public contract, mida BookField loeb enne importi. Legacy packageKind ja presentation fields ei kuulu praeguse package shape hulka.

Installitav konteiner

Üks installable boundary ühe work ja ühe edition jaoks.

Manifest v5

manifest.json on public contract, mida BookField loeb enne importi. Legacy packageKind ja presentation fields ei kuulu praeguse package shape hulka.

ReaderDoc v3

ReaderDoc content on importimiseks ette valmistatud, nii et reader ei parse EPUB, HTML ega CSS runtime ajal.

Navigation tree

navigationTree määrab entry pointi ja readeri package-level sisukorra.

Locator indexes

Kui canonical docs või schema files muutuvad, uuendage esmalt source ja seejärel värskendage seda public snapshoti ning selgitust.

Study plans

Authored study plans on manifest.json-is ainult siis, kui package sisaldab schedule data.

Package layout

Canonical failid wbpkg sees

Package paths on package-root-relative POSIX paths. Text packages sisaldavad ReaderDoc files reader/ all, image, audio või video only packages võivad reader/ välja jätta.

.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 määrab install contracti

manifest.json on public contract, mida BookField loeb enne importi. Legacy packageKind ja presentation fields ei kuulu praeguse package shape hulka.

packageId / packageVersion

manifest.json on public contract, mida BookField loeb enne importi. Legacy packageKind ja presentation fields ei kuulu praeguse package shape hulka.

work / edition

Üks installable boundary ühe work ja ühe edition jaoks.

assets

Package paths on package-root-relative POSIX paths. Text packages sisaldavad ReaderDoc files reader/ all, image, audio või video only packages võivad reader/ välja jätta.

navigationTree

navigationTree määrab entry pointi ja readeri package-level sisukorra.

studyPlans

Authored study plans on manifest.json-is ainult siis, kui package sisaldab schedule data.

bindings

Kui canonical docs või schema files muutuvad, uuendage esmalt source ja seejärel värskendage seda public snapshoti ning selgitust.

Package creation

Hoidke production tooling public package boundary-st eraldi

  1. 1

    Valmista source content

    Valmistage ette source content, metadata, media ning authored schedules või references.

  2. 2

    Loo wbpkg

    Looge installable package manifest metadata, ReaderDoc content, media, navigation ja locator files abil.

  3. 3

    Kontrolli enne jagamist

    Kontrollige enne distributionit package structure ja schema compatibility.

Reader import

BookField loeb installed package kohalikult

  1. 1

    Valideeri

    BookField kontrollib package shape ja lükkab unsupported või malformed packages tagasi.

  2. 2

    Paki lahti

    Supported package assets pakitakse app-owned local storage sisse.

  3. 3

    Impordi SQLite’i

    ReaderDoc payloads, navigation, locator indexes, search records ja schedules registreeritakse offline use jaoks.

Ühilduvus

Rules, mis hoiavad packages etteaimatavana

  • Lükake tagasi legacy packageKind values.
  • Lükake tagasi legacy presentation fields.
  • Lükake tagasi non-canonical package paths.
  • Lükake tagasi malformed structured references.
  • Ärge lisage source EPUB files installable wbpkg sisse.

Canonical references

Update policy

See public page on implementation-facing overview, mitte canonical schema source. Canonical docs ja schema files asuvad BookField source materials juures.

Source docs ja schema files

  • 00-spec-index.md

    See public page on implementation-facing overview, mitte canonical schema source. Canonical docs ja schema files asuvad BookField source materials juures.

  • 04-manifest-json-schema.md

    manifest.json on public contract, mida BookField loeb enne importi. Legacy packageKind ja presentation fields ei kuulu praeguse package shape hulka.

  • 08-reader-app-design.md

    BookField loeb installed package kohalikult

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

    See public page on implementation-facing overview, mitte canonical schema source. Canonical docs ja schema files asuvad BookField source materials juures.

Kui canonical docs või schema files muutuvad, uuendage esmalt source ja seejärel värskendage seda public snapshoti ning selgitust.

Planeeri BookField package distribution

Naaske product overview juurde või arutage, kas wbpkg distribution flow sobib teie content modeliga.

Tagasi BookFieldi juurde Arutage content distributionit