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

একটি 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 ও ব্যাখ্যা 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 text asset না থাকলে 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 text asset না থাকলে reader/ বাদ দিতে পারে।

navigationTree

navigationTree entry point এবং reader-এর 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 আলোচনা করুন