Vissza a BookFieldhez

BookField package formátum

wbpkg

Package, amelyet a BookField validálhat, installálhat és olvashat

Verzió-pillanatkép

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

Röviden

Package, amelyet a BookField validálhat, installálhat és olvashat

Egyetlen installable boundary egy work és egy edition számára. A manifest.json az a public contract, amelyet a BookField import előtt olvas. A legacy packageKind és presentation fields nem részei a jelenlegi package shape-nek.

Telepíthető konténer

Egyetlen installable boundary egy work és egy edition számára.

Manifest v5

A manifest.json az a public contract, amelyet a BookField import előtt olvas. A legacy packageKind és presentation fields nem részei a jelenlegi package shape-nek.

ReaderDoc v3

ReaderDoc content importhoz előkészített, ezért a reader runtime alatt nem parse-ol EPUB, HTML vagy CSS tartalmat.

Navigation tree

navigationTree meghatározza az entry pointot és a reader package-level tartalomjegyzékét.

Locator indexes

Ha canonical docs vagy schema files változnak, először a source frissüljön, utána ez a public snapshot és magyarázat.

Study plans

Authored study plans csak akkor vannak a manifest.json fájlban, ha a package schedule data-t tartalmaz.

Package layout

Canonical files egy wbpkg-ben

A package paths package-root-relative POSIX paths. A text packages ReaderDoc files elemeket tartalmaznak reader/ alatt, míg image, audio vagy video only packages kihagyhatják a reader/ részt.

.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

A Manifest v5 meghatározza az install contractot

A manifest.json az a public contract, amelyet a BookField import előtt olvas. A legacy packageKind és presentation fields nem részei a jelenlegi package shape-nek.

packageId / packageVersion

A manifest.json az a public contract, amelyet a BookField import előtt olvas. A legacy packageKind és presentation fields nem részei a jelenlegi package shape-nek.

work / edition

Egyetlen installable boundary egy work és egy edition számára.

assets

A package paths package-root-relative POSIX paths. A text packages ReaderDoc files elemeket tartalmaznak reader/ alatt, míg image, audio vagy video only packages kihagyhatják a reader/ részt.

navigationTree

navigationTree meghatározza az entry pointot és a reader package-level tartalomjegyzékét.

studyPlans

Authored study plans csak akkor vannak a manifest.json fájlban, ha a package schedule data-t tartalmaz.

bindings

Ha canonical docs vagy schema files változnak, először a source frissüljön, utána ez a public snapshot és magyarázat.

Package creation

A production tooling maradjon külön a public package boundary-től

  1. 1

    Source content előkészítése

    Készítse elő a source content, metadata, media és authored schedules vagy references elemeket.

  2. 2

    wbpkg létrehozása

    Hozzon létre installable package-et manifest metadata, ReaderDoc content, media, navigation és locator files elemekkel.

  3. 3

    Megosztás előtti ellenőrzés

    Distribution előtt ellenőrizze a package structure és schema compatibility állapotát.

Reader import

A BookField lokálisan olvassa az installed package-et

  1. 1

    Validate

    A BookField ellenőrzi a package shape-et és elutasítja az unsupported vagy malformed packages elemeket.

  2. 2

    Unpack

    A supported package assets app-owned local storage területre kerülnek unpack után.

  3. 3

    Import SQLite-ba

    ReaderDoc payloads, navigation, locator indexes, search records és schedules offline use célra regisztrálódnak.

Compatibility

Rules, amelyek kiszámíthatóvá teszik a packages működését

  • Utasítsa el legacy packageKind values.
  • Utasítsa el legacy presentation fields.
  • Utasítsa el non-canonical package paths.
  • Utasítsa el malformed structured references.
  • Ne tegyen source EPUB files elemeket installable wbpkg-be.

Canonical references

Update policy

Ez a public page implementation-facing overview, nem canonical schema source. A canonical docs és schema files a BookField source materials mellett vannak.

Source docs és schema files

  • 00-spec-index.md

    Ez a public page implementation-facing overview, nem canonical schema source. A canonical docs és schema files a BookField source materials mellett vannak.

  • 04-manifest-json-schema.md

    A manifest.json az a public contract, amelyet a BookField import előtt olvas. A legacy packageKind és presentation fields nem részei a jelenlegi package shape-nek.

  • 08-reader-app-design.md

    A BookField lokálisan olvassa az installed package-et

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

    Ez a public page implementation-facing overview, nem canonical schema source. A canonical docs és schema files a BookField source materials mellett vannak.

Ha canonical docs vagy schema files változnak, először a source frissüljön, utána ez a public snapshot és magyarázat.

BookField package distribution tervezése

Térjen vissza a product overview oldalra, vagy beszélje meg, hogy a wbpkg distribution flow illik-e a content modelhez.

Vissza a BookFieldhez Content distribution megbeszélése