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 ಬಗ್ಗೆ ಚರ್ಚಿಸಿ