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 ਨੂੰ 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 ਅਤੇ ਵਿਆਖਿਆ refresh ਕਰੋ।

BookField package distribution ਦੀ ਯੋਜਨਾ ਬਣਾਓ

Product overview ਤੇ ਵਾਪਸ ਜਾਓ ਜਾਂ ਗੱਲ ਕਰੋ ਕਿ wbpkg distribution flow ਤੁਹਾਡੇ content model ਲਈ ਫਿੱਟ ਹੈ ਜਾਂ ਨਹੀਂ।

BookField ਵੱਲ ਵਾਪਸ Content distribution ਤੇ ਚਰਚਾ ਕਰੋ