Bumalik sa BookField

BookField format ng package

wbpkg

Package na kayang i-validate, i-install at basahin ng BookField

Snapshot ng bersyon

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

Sa isang tingin

Package na kayang i-validate, i-install at basahin ng BookField

Ang isang package ay iisang installable boundary para sa isang work at isang edition. Ang manifest.json ay public contract na binabasa ng BookField bago mag-import. Hindi bahagi ng kasalukuyang package shape ang legacy packageKind at presentation fields.

Installable container

Ang isang package ay iisang installable boundary para sa isang work at isang edition.

Manifest v5

Ang manifest.json ay public contract na binabasa ng BookField bago mag-import. Hindi bahagi ng kasalukuyang package shape ang legacy packageKind at presentation fields.

ReaderDoc v3

ReaderDoc content inihahanda para sa import, kaya hindi nagpa-parse ang reader ng EPUB, HTML o CSS sa runtime.

Navigation tree

navigationTree nagtatakda ng entry point at package-level table of contents ng reader.

Locator indexes

Kapag nagbago ang canonical docs o schema files, i-update muna ang source, pagkatapos ay i-refresh ang public snapshot at paliwanag na ito.

Study plans

Authored study plans nasa manifest.json lamang kapag may schedule data ang package.

Package layout

Canonical files sa loob ng wbpkg

Ang package paths ay package-root-relative POSIX paths. May ReaderDoc files sa ilalim ng reader/ ang text packages; maaaring alisin ng image, audio o video only packages ang 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

Tinutukoy ng Manifest v5 ang install contract

Ang manifest.json ay public contract na binabasa ng BookField bago mag-import. Hindi bahagi ng kasalukuyang package shape ang legacy packageKind at presentation fields.

packageId / packageVersion

Ang manifest.json ay public contract na binabasa ng BookField bago mag-import. Hindi bahagi ng kasalukuyang package shape ang legacy packageKind at presentation fields.

work / edition

Ang isang package ay iisang installable boundary para sa isang work at isang edition.

assets

Ang package paths ay package-root-relative POSIX paths. May ReaderDoc files sa ilalim ng reader/ ang text packages; maaaring alisin ng image, audio o video only packages ang reader/.

navigationTree

navigationTree nagtatakda ng entry point at package-level table of contents ng reader.

studyPlans

Authored study plans nasa manifest.json lamang kapag may schedule data ang package.

bindings

Kapag nagbago ang canonical docs o schema files, i-update muna ang source, pagkatapos ay i-refresh ang public snapshot at paliwanag na ito.

Package creation

Ihiwalay ang production tooling sa public package boundary

  1. 1

    Ihanda ang source content

    Ihanda ang source content, metadata, media at authored schedules o references.

  2. 2

    Gumawa ng wbpkg

    Gumawa ng installable package na may manifest metadata, ReaderDoc content, media, navigation at locator files.

  3. 3

    I-verify bago ibahagi

    Suriin ang package structure at schema compatibility bago ang distribution.

Reader import

Binabasa ng BookField ang installed package nang lokal

  1. 1

    I-validate

    Sinusuri ng BookField ang package shape at nire-reject ang unsupported o malformed packages.

  2. 2

    I-unpack

    Ina-unpack ang supported package assets sa app-owned local storage.

  3. 3

    Import sa SQLite

    Nire-register ang ReaderDoc payloads, navigation, locator indexes, search records at schedules para sa offline use.

Compatibility

Rules na nagpapanatiling predictable ang packages

  • I-reject legacy packageKind values.
  • I-reject legacy presentation fields.
  • I-reject non-canonical package paths.
  • I-reject malformed structured references.
  • Huwag isama ang source EPUB files sa installable wbpkg.

Canonical references

Update policy

Ang public page na ito ay implementation-facing overview, hindi canonical schema source. Nasa BookField source materials ang canonical docs at schema files.

Source docs at schema files

  • 00-spec-index.md

    Ang public page na ito ay implementation-facing overview, hindi canonical schema source. Nasa BookField source materials ang canonical docs at schema files.

  • 04-manifest-json-schema.md

    Ang manifest.json ay public contract na binabasa ng BookField bago mag-import. Hindi bahagi ng kasalukuyang package shape ang legacy packageKind at presentation fields.

  • 08-reader-app-design.md

    Binabasa ng BookField ang installed package nang lokal

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

    Ang public page na ito ay implementation-facing overview, hindi canonical schema source. Nasa BookField source materials ang canonical docs at schema files.

Kapag nagbago ang canonical docs o schema files, i-update muna ang source, pagkatapos ay i-refresh ang public snapshot at paliwanag na ito.

Planuhin ang BookField package distribution

Bumalik sa product overview o pag-usapan kung bagay ang wbpkg distribution flow sa content model mo.

Bumalik sa BookField Pag-usapan ang content distribution