Бозгашт ба BookField

BookField формати package

wbpkg

Package, ки BookField метавонад validate, install ва read кунад

Version 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 entry point ва package-level table of contents-и reader-ро муайян мекунад.

Locator indexes

Вақте canonical docs ё schema files тағйир меёбанд, аввал source-ро update кунед, баъд ин public snapshot ва тавзеҳро refresh кунед.

Study plans

Authored study plans танҳо вақте package schedule data дорад, дар manifest.json мемонад.

Package layout

Canonical files дар wbpkg

Package paths package-root-relative POSIX paths мебошанд. Text packages ReaderDoc files-ро дар reader/ нигоҳ медоранд; 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 ReaderDoc files-ро дар reader/ нигоҳ медоранд; image, audio ё video only packages метавонанд reader/-ро гузаронанд.

navigationTree

navigationTree entry point ва package-level table of contents-и reader-ро муайян мекунад.

studyPlans

Authored study plans танҳо вақте package schedule data дорад, дар manifest.json мемонад.

bindings

Вақте canonical docs ё schema files тағйир меёбанд, аввал source-ро update кунед, баъд ин public snapshot ва тавзеҳро refresh кунед.

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-ро месанҷад ва unsupported ё malformed packages-ро reject мекунад.

  2. 2

    Unpack

    Supported package assets ба app-owned local storage unpack мешаванд.

  3. 3

    Import ба SQLite

    ReaderDoc payloads, navigation, locator indexes, search records ва schedules барои offline use register мешаванд.

Compatibility

Rules, ки packages-ро predictable нигоҳ медоранд

  • Reject: кунед legacy packageKind values.
  • Reject: кунед legacy presentation fields.
  • Reject: кунед non-canonical package paths.
  • Reject: кунед malformed structured references.
  • source EPUB files-ро ба installable wbpkg дохил накунед.

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 тағйир меёбанд, аввал source-ро update кунед, баъд ин public snapshot ва тавзеҳро refresh кунед.

BookField package distribution-ро нақша гиред

Ба product overview баргардед ё муҳокима кунед, ки wbpkg distribution flow ба content model-и шумо мувофиқ аст ё не.

Бозгашт ба BookField Content distribution муҳокима кунед