Nazaj na BookField

BookField format package

wbpkg

Package, ki ga BookField lahko preveri, namesti in bere

Posnetek različic

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

Na kratko

Package, ki ga BookField lahko preveri, namesti in bere

En package je ena installable meja za en work in eno edition. manifest.json je public contract, ki ga BookField prebere pred importom. Legacy packageKind in presentation fields niso del trenutnega package shape.

Namestitveni vsebnik

En package je ena installable meja za en work in eno edition.

Manifest v5

manifest.json je public contract, ki ga BookField prebere pred importom. Legacy packageKind in presentation fields niso del trenutnega package shape.

ReaderDoc v3

ReaderDoc content je pripravljen za import, zato reader med runtime ne razčlenjuje EPUB, HTML ali CSS.

Navigacijsko drevo

navigationTree določa entry point in package-level kazalo readerja.

Locator indeksi

Ko se canonical docs ali schema files spremenijo, najprej posodobite source, nato osvežite ta public snapshot in razlago.

Študijski načrti

Authored study plans so v manifest.json samo, kadar package vsebuje schedule data.

Package layout

Canonical files znotraj wbpkg

Package paths so POSIX paths relativne na package root. Text packages vsebujejo ReaderDoc files pod reader/, medtem ko image, audio ali video only packages lahko izpustijo 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 določa install contract

manifest.json je public contract, ki ga BookField prebere pred importom. Legacy packageKind in presentation fields niso del trenutnega package shape.

packageId / packageVersion

manifest.json je public contract, ki ga BookField prebere pred importom. Legacy packageKind in presentation fields niso del trenutnega package shape.

work / edition

En package je ena installable meja za en work in eno edition.

assets

Package paths so POSIX paths relativne na package root. Text packages vsebujejo ReaderDoc files pod reader/, medtem ko image, audio ali video only packages lahko izpustijo reader/.

navigationTree

navigationTree določa entry point in package-level kazalo readerja.

studyPlans

Authored study plans so v manifest.json samo, kadar package vsebuje schedule data.

bindings

Ko se canonical docs ali schema files spremenijo, najprej posodobite source, nato osvežite ta public snapshot in razlago.

Package creation

Production tooling naj bo ločen od public package boundary

  1. 1

    Pripravite source content

    Pripravite source content, metadata, media ter authored schedules ali references.

  2. 2

    Ustvarite wbpkg

    Ustvarite installable package z manifest metadata, ReaderDoc content, media, navigation in locator files.

  3. 3

    Preverite pred deljenjem

    Pred distribution preverite package structure in schema compatibility.

Reader import

BookField lokalno bere installed package

  1. 1

    Preverjanje

    BookField preveri package shape in zavrne unsupported ali malformed packages.

  2. 2

    Razpakiranje

    Supported package assets se razpakirajo v app-owned local storage.

  3. 3

    Import v SQLite

    ReaderDoc payloads, navigation, locator indexes, search records in schedules se registrirajo za offline use.

Združljivost

Pravila, ki ohranjajo packages predvidljive

  • Zavrnite legacy packageKind values.
  • Zavrnite legacy presentation fields.
  • Zavrnite non-canonical package paths.
  • Zavrnite malformed structured references.
  • V installable wbpkg ne vključujte source EPUB files.

Canonical references

Update policy

Ta javna stran je implementation-facing overview, ne canonical schema source. Canonical docs in schema files ostanejo pri BookField source materials.

Source docs in schema files

  • 00-spec-index.md

    Ta javna stran je implementation-facing overview, ne canonical schema source. Canonical docs in schema files ostanejo pri BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json je public contract, ki ga BookField prebere pred importom. Legacy packageKind in presentation fields niso del trenutnega package shape.

  • 08-reader-app-design.md

    BookField lokalno bere installed package

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

    Ta javna stran je implementation-facing overview, ne canonical schema source. Canonical docs in schema files ostanejo pri BookField source materials.

Ko se canonical docs ali schema files spremenijo, najprej posodobite source, nato osvežite ta public snapshot in razlago.

Načrtujte BookField package distribution

Vrnite se na product overview ali se pogovorite, ali wbpkg distribution flow ustreza vašemu content modelu.

Nazaj na BookField Pogovor o content distribution