BookField पर वापस जाएँ

BookField package format

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 कर सकता है

एक work और एक edition के लिए एक installable boundary। manifest.json वह public contract है जिसे BookField import से पहले पढ़ता है। Legacy packageKind और presentation fields वर्तमान package shape का भाग नहीं हैं।

Installable container

एक 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 और reader की package-level table of contents तय करता है।

Locator indexes

canonical docs या schema files बदलें तो पहले source update करें, फिर यह public snapshot और explanation refresh करें।

Study plans

Authored study plans manifest.json में तभी रहते हैं जब package में schedule data हो।

Package layout

wbpkg के canonical files

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

एक 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 entry point और reader की package-level table of contents तय करता है।

studyPlans

Authored study plans manifest.json में तभी रहते हैं जब package में schedule data हो।

bindings

canonical docs या schema files बदलें तो पहले source update करें, फिर यह public snapshot और explanation refresh करें।

Package creation

Production tooling को public package boundary से अलग रखें

  1. 1

    Source content तैयार करें

    source content, metadata, media और authored schedules या references तैयार करें।

  2. 2

    wbpkg बनाएं

    manifest metadata, ReaderDoc content, media, navigation और locator files वाला installable package बनाएं।

  3. 3

    साझा करने से पहले जाँचें

    distribution से पहले package structure और schema compatibility जाँचें।

Reader import

BookField installed package को locally पढ़ता है

  1. 1

    Validate

    BookField package shape जाँचता है और unsupported या malformed packages reject करता है।

  2. 2

    Unpack

    Supported package assets app-owned local storage में unpack होते हैं।

  3. 3

    SQLite में import

    ReaderDoc payloads, navigation, locator indexes, search records और schedules offline use के लिए register होते हैं।

Compatibility

Packages को predictable रखने वाले rules

  • 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 को locally पढ़ता है

  • 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 और explanation refresh करें।

BookField package distribution की योजना बनाएं

product overview पर लौटें, या चर्चा करें कि wbpkg distribution flow आपके content model में फिट बैठता है या नहीं।

BookField पर वापस जाएँ Content distribution पर चर्चा करें