Վերադառնալ BookField

BookField package ձևաչափ

wbpkg

Package, որը BookField-ը կարող է validate, install և read անել

Տարբերակի snapshot

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

Կարճ

Package, որը BookField-ը կարող է validate, install և read անել

Մեկ package-ը մեկ work-ի և մեկ edition-ի համար մեկ installable boundary է։ manifest.json-ը public contract է, որը BookField-ը կարդում է import-ից առաջ։ Legacy packageKind և presentation fields-ը ներկա package shape-ի մաս չեն։

Installable container

Մեկ package-ը մեկ work-ի և մեկ edition-ի համար մեկ installable boundary է։

Manifest v5

manifest.json-ը public contract է, որը BookField-ը կարդում է import-ից առաջ։ Legacy packageKind և presentation fields-ը ներկա package shape-ի մաս չեն։

ReaderDoc v3

ReaderDoc content պատրաստված է import-ի համար, ուստի reader-ը runtime-ում EPUB, HTML կամ CSS չի parse անում։

Navigation tree

navigationTree որոշում է reader-ի entry point-ը և package-level table of contents-ը։

Locator indexes

canonical docs կամ schema files փոխվելու դեպքում նախ update արեք source-ը, ապա refresh արեք այս public snapshot-ը և բացատրությունը։

Study plans

Authored study plans manifest.json-ում լինում են միայն երբ package-ը պարունակում է schedule data։

Package layout

Canonical files wbpkg-ի ներսում

Package paths-ը package-root-relative POSIX paths են։ Text packages-ը reader/-ի տակ պահում են ReaderDoc files, իսկ image, audio կամ video only packages-ը կարող են բաց թողնել 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-ը սահմանում է install contract-ը

manifest.json-ը public contract է, որը BookField-ը կարդում է import-ից առաջ։ Legacy packageKind և presentation fields-ը ներկա package shape-ի մաս չեն։

packageId / packageVersion

manifest.json-ը public contract է, որը BookField-ը կարդում է import-ից առաջ։ Legacy packageKind և presentation fields-ը ներկա package shape-ի մաս չեն։

work / edition

Մեկ package-ը մեկ work-ի և մեկ edition-ի համար մեկ installable boundary է։

assets

Package paths-ը package-root-relative POSIX paths են։ Text packages-ը reader/-ի տակ պահում են ReaderDoc files, իսկ image, audio կամ video only packages-ը կարող են բաց թողնել reader/-ը։

navigationTree

navigationTree որոշում է reader-ի entry point-ը և package-level table of contents-ը։

studyPlans

Authored study plans manifest.json-ում լինում են միայն երբ package-ը պարունակում է schedule data։

bindings

canonical docs կամ schema files փոխվելու դեպքում նախ update արեք source-ը, ապա refresh արեք այս public snapshot-ը և բացատրությունը։

Package creation

Production tooling-ը առանձնացրեք public package boundary-ից

  1. 1

    Պատրաստել source content

    Պատրաստեք source content, metadata, media և authored schedules կամ references։

  2. 2

    Ստեղծել wbpkg

    Ստեղծեք installable package՝ manifest metadata, ReaderDoc content, media, navigation և locator files-ով։

  3. 3

    Ստուգել տարածելուց առաջ

    distribution-ից առաջ ստուգեք package structure և schema compatibility։

Reader import

BookField-ը installed package-ը կարդում է տեղային

  1. 1

    Validate

    BookField-ը ստուգում է package shape-ը և reject է անում unsupported կամ malformed packages-ը։

  2. 2

    Unpack

    Supported package assets-ը unpack են լինում app-owned local storage-ում։

  3. 3

    Import SQLite-ում

    ReaderDoc payloads, navigation, locator indexes, search records և schedules-ը register են լինում offline use-ի համար։

Compatibility

Rules, որոնք packages-ը կանխատեսելի են պահում

  • Reject: արեք legacy packageKind values.
  • Reject: արեք legacy presentation fields.
  • Reject: արեք non-canonical package paths.
  • Reject: արեք malformed structured references.
  • installable wbpkg-ի մեջ source EPUB files մի ներառեք։

Canonical references

Update policy

Այս public page-ը implementation-facing overview է, ոչ թե canonical schema source։ Canonical docs և schema files-ը պահվում են BookField source materials-ի հետ։

Source docs և schema files

  • 00-spec-index.md

    Այս public page-ը implementation-facing overview է, ոչ թե canonical schema source։ Canonical docs և schema files-ը պահվում են BookField source materials-ի հետ։

  • 04-manifest-json-schema.md

    manifest.json-ը public contract է, որը BookField-ը կարդում է import-ից առաջ։ Legacy packageKind և presentation fields-ը ներկա package shape-ի մաս չեն։

  • 08-reader-app-design.md

    BookField-ը installed package-ը կարդում է տեղային

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

    Այս public page-ը implementation-facing overview է, ոչ թե canonical schema source։ Canonical docs և schema files-ը պահվում են BookField source materials-ի հետ։

canonical docs կամ schema files փոխվելու դեպքում նախ update արեք source-ը, ապա refresh արեք այս public snapshot-ը և բացատրությունը։

Պլանավորեք BookField package distribution

Վերադարձեք product overview կամ քննարկեք, արդյոք wbpkg distribution flow-ը համապատասխանում է ձեր content model-ին։

Վերադառնալ BookField Քննարկել content distribution