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 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 යනු BookField import කිරීමට පෙර කියවන public contract එකකි. 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 එකට ගැළපේදැයි සාකච්ඡා කරන්න.