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 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 پر بات کریں