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 သည် BookField က import မတိုင်မီဖတ်သော public contract ဖြစ်သည်။ Legacy packageKind နှင့် presentation fields သည် လက်ရှိ package shape ၏အစိတ်အပိုင်းမဟုတ်ပါ။

Installable container

package တစ်ခုသည် work တစ်ခုနှင့် edition တစ်ခုအတွက် installable boundary တစ်ခုဖြစ်သည်။

Manifest v5

manifest.json သည် BookField က import မတိုင်မီဖတ်သော public contract ဖြစ်သည်။ 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 သည် BookField က import မတိုင်မီဖတ်သော public contract ဖြစ်သည်။ Legacy packageKind နှင့် presentation fields သည် လက်ရှိ package shape ၏အစိတ်အပိုင်းမဟုတ်ပါ။

packageId / packageVersion

manifest.json သည် BookField က import မတိုင်မီဖတ်သော public contract ဖြစ်သည်။ 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 ကို local တွင်ဖတ်သည်

  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 သည် BookField က import မတိုင်မီဖတ်သော public contract ဖြစ်သည်။ Legacy packageKind နှင့် presentation fields သည် လက်ရှိ package shape ၏အစိတ်အပိုင်းမဟုတ်ပါ။

  • 08-reader-app-design.md

    BookField သည် installed package ကို local တွင်ဖတ်သည်

  • 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 ဆွေးနွေးပါ