Grįžti į BookField

BookField package formatas

wbpkg

Package, kurį BookField gali validate, install ir read

Versijų santrauka

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

Trumpai

Package, kurį BookField gali validate, install ir read

Vienas installable boundary vienam work ir vienai edition. manifest.json yra public contract, kurį BookField skaito prieš importą. Legacy packageKind ir presentation fields nėra dabartinės package shape dalis.

Įdiegiamas konteineris

Vienas installable boundary vienam work ir vienai edition.

Manifest v5

manifest.json yra public contract, kurį BookField skaito prieš importą. Legacy packageKind ir presentation fields nėra dabartinės package shape dalis.

ReaderDoc v3

ReaderDoc content paruoštas importui, todėl reader runtime metu neparseina EPUB, HTML ar CSS.

Navigation tree

navigationTree nustato entry point ir reader package-level turinį.

Locator indexes

Kai canonical docs ar schema files pasikeičia, pirmiausia atnaujinkite source, tada šį public snapshot ir paaiškinimą.

Study plans

Authored study plans yra manifest.json tik tada, kai package turi schedule data.

Package layout

Canonical files wbpkg viduje

Package paths yra package-root-relative POSIX paths. Text packages turi ReaderDoc files po reader/, o image, audio ar video only packages gali praleisti 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 apibrėžia install contract

manifest.json yra public contract, kurį BookField skaito prieš importą. Legacy packageKind ir presentation fields nėra dabartinės package shape dalis.

packageId / packageVersion

manifest.json yra public contract, kurį BookField skaito prieš importą. Legacy packageKind ir presentation fields nėra dabartinės package shape dalis.

work / edition

Vienas installable boundary vienam work ir vienai edition.

assets

Package paths yra package-root-relative POSIX paths. Text packages turi ReaderDoc files po reader/, o image, audio ar video only packages gali praleisti reader/.

navigationTree

navigationTree nustato entry point ir reader package-level turinį.

studyPlans

Authored study plans yra manifest.json tik tada, kai package turi schedule data.

bindings

Kai canonical docs ar schema files pasikeičia, pirmiausia atnaujinkite source, tada šį public snapshot ir paaiškinimą.

Package creation

Atskirkite production tooling nuo public package boundary

  1. 1

    Paruošti source content

    Paruoškite source content, metadata, media ir authored schedules ar references.

  2. 2

    Sukurti wbpkg

    Sukurkite installable package su manifest metadata, ReaderDoc content, media, navigation ir locator files.

  3. 3

    Patikrinti prieš dalijimąsi

    Prieš distribution patikrinkite package structure ir schema compatibility.

Reader import

BookField lokaliai skaito installed package

  1. 1

    Validate

    BookField tikrina package shape ir atmeta unsupported arba malformed packages.

  2. 2

    Unpack

    Supported package assets išpakuojami į app-owned local storage.

  3. 3

    Import į SQLite

    ReaderDoc payloads, navigation, locator indexes, search records ir schedules registruojami offline use.

Compatibility

Rules, kurios išlaiko packages nuspėjamus

  • Atmesti legacy packageKind values.
  • Atmesti legacy presentation fields.
  • Atmesti non-canonical package paths.
  • Atmesti malformed structured references.
  • Neįtraukite source EPUB files į installable wbpkg.

Canonical references

Update policy

Šis public page yra implementation-facing overview, ne canonical schema source. Canonical docs ir schema files yra su BookField source materials.

Source docs ir schema files

  • 00-spec-index.md

    Šis public page yra implementation-facing overview, ne canonical schema source. Canonical docs ir schema files yra su BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json yra public contract, kurį BookField skaito prieš importą. Legacy packageKind ir presentation fields nėra dabartinės package shape dalis.

  • 08-reader-app-design.md

    BookField lokaliai skaito installed package

  • schemas/manifest-v5.schema.json / readerdoc-v3.schema.json

    Šis public page yra implementation-facing overview, ne canonical schema source. Canonical docs ir schema files yra su BookField source materials.

Kai canonical docs ar schema files pasikeičia, pirmiausia atnaujinkite source, tada šį public snapshot ir paaiškinimą.

Planuokite BookField package distribution

Grįžkite į product overview arba aptarkite, ar wbpkg distribution flow tinka jūsų content model.

Grįžti į BookField Aptarti content distribution