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 એ public contract છે જે BookField import પહેલાં વાંચે છે. Legacy packageKind અને presentation fields હાલની package shape નો ભાગ નથી.

Installable container

એક package એક work અને એક edition માટે એક installable boundary છે.

Manifest v5

manifest.json એ public contract છે જે BookField import પહેલાં વાંચે છે. 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 એ 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 એક 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 એ public contract છે જે BookField import પહેલાં વાંચે છે. 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 ચર્ચો