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 కు సరిపోతుందా చర్చించండి.

BookField కు తిరిగి వెళ్లండి Content distribution గురించి చర్చించండి