Til baka í BookField

BookField package-snið

wbpkg

Package sem BookField getur validate, install og read

Útgáfuyfirlit

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

Í stuttu máli

Package sem BookField getur validate, install og read

Eitt installable boundary fyrir eitt work og eina edition. manifest.json er public contract sem BookField les fyrir import. Legacy packageKind og presentation fields eru ekki hluti af núverandi package shape.

Uppsetjanlegt ílát

Eitt installable boundary fyrir eitt work og eina edition.

Manifest v5

manifest.json er public contract sem BookField les fyrir import. Legacy packageKind og presentation fields eru ekki hluti af núverandi package shape.

ReaderDoc v3

ReaderDoc content er undirbúið fyrir import, þannig að reader parse-ar ekki EPUB, HTML eða CSS í runtime.

Navigation tree

navigationTree ákveður entry point og package-level efnisyfirlit reader.

Locator indexes

Þegar canonical docs eða schema files breytast skal fyrst uppfæra source og síðan þetta public snapshot og skýringuna.

Study plans

Authored study plans eru aðeins í manifest.json þegar package inniheldur schedule data.

Package layout

Canonical files inni í wbpkg

Package paths eru package-root-relative POSIX paths. Text packages hafa ReaderDoc files undir reader/, en image, audio eða video only packages mega sleppa 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 skilgreinir install contract

manifest.json er public contract sem BookField les fyrir import. Legacy packageKind og presentation fields eru ekki hluti af núverandi package shape.

packageId / packageVersion

manifest.json er public contract sem BookField les fyrir import. Legacy packageKind og presentation fields eru ekki hluti af núverandi package shape.

work / edition

Eitt installable boundary fyrir eitt work og eina edition.

assets

Package paths eru package-root-relative POSIX paths. Text packages hafa ReaderDoc files undir reader/, en image, audio eða video only packages mega sleppa reader/.

navigationTree

navigationTree ákveður entry point og package-level efnisyfirlit reader.

studyPlans

Authored study plans eru aðeins í manifest.json þegar package inniheldur schedule data.

bindings

Þegar canonical docs eða schema files breytast skal fyrst uppfæra source og síðan þetta public snapshot og skýringuna.

Package creation

Halda production tooling aðskildu frá public package boundary

  1. 1

    Undirbúa source content

    Undirbúðu source content, metadata, media og authored schedules eða references.

  2. 2

    Búa til wbpkg

    Búðu til installable package með manifest metadata, ReaderDoc content, media, navigation og locator files.

  3. 3

    Staðfesta fyrir deilingu

    Athugaðu package structure og schema compatibility fyrir distribution.

Reader import

BookField les installed package staðbundið

  1. 1

    Validate

    BookField athugar package shape og hafnar unsupported eða malformed packages.

  2. 2

    Unpack

    Supported package assets eru unpack í app-owned local storage.

  3. 3

    Import í SQLite

    ReaderDoc payloads, navigation, locator indexes, search records og schedules eru skráð fyrir offline use.

Compatibility

Rules sem halda packages fyrirsjáanlegum

  • Hafna legacy packageKind values.
  • Hafna legacy presentation fields.
  • Hafna non-canonical package paths.
  • Hafna malformed structured references.
  • Ekki setja source EPUB files í installable wbpkg.

Canonical references

Update policy

Þessi public page er implementation-facing overview, ekki canonical schema source. Canonical docs og schema files eru með BookField source materials.

Source docs og schema files

  • 00-spec-index.md

    Þessi public page er implementation-facing overview, ekki canonical schema source. Canonical docs og schema files eru með BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json er public contract sem BookField les fyrir import. Legacy packageKind og presentation fields eru ekki hluti af núverandi package shape.

  • 08-reader-app-design.md

    BookField les installed package staðbundið

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

    Þessi public page er implementation-facing overview, ekki canonical schema source. Canonical docs og schema files eru með BookField source materials.

Þegar canonical docs eða schema files breytast skal fyrst uppfæra source og síðan þetta public snapshot og skýringuna.

Skipuleggja BookField package distribution

Farðu aftur í product overview eða ræddu hvort wbpkg distribution flow passi við content model þitt.

Til baka í BookField Ræða content distribution