BookField कडे परत

BookField package स्वरूप

wbpkg

BookField validate, install आणि read करू शकणारे package

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

थोडक्यात

BookField validate, install आणि read करू शकणारे package

एक 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 बदलल्यास आधी source update करा, नंतर हा public snapshot आणि स्पष्टीकरण refresh करा.

Study plans

Authored study plans package मध्ये schedule data असेल तेव्हाच manifest.json मध्ये राहतात.

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

एक 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 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 तयार करा

    manifest metadata, ReaderDoc content, media, navigation आणि locator files असलेले installable package तयार करा.

  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

    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 स्थानिकरीत्या वाचतो

  • 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 चर्चा करा