ត្រឡប់ទៅ 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 មួយគឺជា installable boundary មួយសម្រាប់ work មួយ និង edition មួយ។ manifest.json គឺ public contract ដែល BookField អានមុន import។ Legacy packageKind និង presentation fields មិនមែនជាផ្នែកនៃ package shape បច្ចុប្បន្នទេ។

Installable container

package មួយគឺជា installable boundary មួយសម្រាប់ work មួយ និង edition មួយ។

Manifest v5

manifest.json គឺ public contract ដែល BookField អានមុន import។ Legacy packageKind និង presentation fields មិនមែនជាផ្នែកនៃ package shape បច្ចុប្បន្នទេ។

ReaderDoc v3

ReaderDoc content ត្រូវបានរៀបចំសម្រាប់ import ដូច្នេះ reader មិន parse EPUB, HTML ឬ CSS នៅ runtime ទេ។

Navigation tree

navigationTree កំណត់ entry point និង package-level table of contents របស់ reader។

Locator indexes

នៅពេល canonical docs ឬ schema files ផ្លាស់ប្តូរ សូម update source ជាមុន បន្ទាប់មក refresh public snapshot និងការពន្យល់នេះ។

Study plans

Authored study plans នៅក្នុង manifest.json តែពេល package មាន schedule data ប៉ុណ្ណោះ។

Package layout

Canonical files ក្នុង wbpkg

Package paths គឺ package-root-relative POSIX paths។ Text packages មាន ReaderDoc files ក្រោម reader/ ខណៈ 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 មួយគឺជា installable boundary មួយសម្រាប់ work មួយ និង edition មួយ។

assets

Package paths គឺ package-root-relative POSIX paths។ Text packages មាន ReaderDoc files ក្រោម reader/ ខណៈ image, audio ឬ video only packages អាចលុប reader/ ចេញ។

navigationTree

navigationTree កំណត់ entry point និង package-level table of contents របស់ reader។

studyPlans

Authored study plans នៅក្នុង manifest.json តែពេល package មាន schedule data ប៉ុណ្ណោះ។

bindings

នៅពេល canonical docs ឬ schema files ផ្លាស់ប្តូរ សូម update source ជាមុន បន្ទាប់មក refresh public snapshot និងការពន្យល់នេះ។

Package creation

បំបែក production tooling ចេញពី public package boundary

  1. 1

    រៀបចំ Source content

    រៀបចំ source content, metadata, media និង authored schedules ឬ references។

  2. 2

    បង្កើត wbpkg

    បង្កើត installable package ជាមួយ manifest metadata, ReaderDoc content, media, navigation និង locator files។

  3. 3

    ផ្ទៀងផ្ទាត់មុនចែករំលែក

    ពិនិត្យ package structure និង schema compatibility មុន distribution។

Reader import

BookField អាន installed package ក្នុង local

  1. 1

    Validate

    BookField ពិនិត្យ package shape ហើយ reject unsupported ឬ malformed packages។

  2. 2

    Unpack

    Supported package assets ត្រូវបាន unpack ទៅ app-owned local storage។

  3. 3

    Import ទៅ SQLite

    ReaderDoc payloads, navigation, locator indexes, search records និង schedules ត្រូវបាន register សម្រាប់ offline use។

Compatibility

Rules ដែលរក្សា packages ឱ្យ predictable

  • Reject: legacy packageKind values.
  • Reject: legacy presentation fields.
  • Reject: non-canonical package paths.
  • Reject: malformed structured references.
  • កុំដាក់ source EPUB files ក្នុង installable wbpkg។

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 ក្នុង 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 ផ្លាស់ប្តូរ សូម update source ជាមុន បន្ទាប់មក refresh public snapshot និងការពន្យល់នេះ។

រៀបចំ BookField package distribution

ត្រឡប់ទៅ product overview ឬពិភាក្សាថា wbpkg distribution flow សមនឹង content model របស់អ្នកឬទេ។

ត្រឡប់ទៅ BookField ពិភាក្សា content distribution