Atpakaļ uz BookField

BookField package formāts

wbpkg

Package, ko BookField var validate, install un read

Versiju momentuzņēmums

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

Īsumā

Package, ko BookField var validate, install un read

Viena installable robeža vienam work un vienai edition. manifest.json ir public contract, ko BookField lasa pirms import. Legacy packageKind un presentation fields nav pašreizējās package shape daļa.

Instalējams konteiners

Viena installable robeža vienam work un vienai edition.

Manifest v5

manifest.json ir public contract, ko BookField lasa pirms import. Legacy packageKind un presentation fields nav pašreizējās package shape daļa.

ReaderDoc v3

ReaderDoc content ir sagatavots importam, tāpēc reader runtime laikā neparse EPUB, HTML vai CSS.

Navigation tree

navigationTree nosaka entry point un reader package-level satura rādītāju.

Locator indexes

Kad canonical docs vai schema files mainās, vispirms atjauniniet source, pēc tam šo public snapshot un skaidrojumu.

Study plans

Authored study plans atrodas manifest.json tikai tad, ja package satur schedule data.

Package layout

Canonical files wbpkg iekšpusē

Package paths ir package-root-relative POSIX paths. Text packages satur ReaderDoc files zem reader/, bet image, audio vai video only packages var izlaist 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 definē install contract

manifest.json ir public contract, ko BookField lasa pirms import. Legacy packageKind un presentation fields nav pašreizējās package shape daļa.

packageId / packageVersion

manifest.json ir public contract, ko BookField lasa pirms import. Legacy packageKind un presentation fields nav pašreizējās package shape daļa.

work / edition

Viena installable robeža vienam work un vienai edition.

assets

Package paths ir package-root-relative POSIX paths. Text packages satur ReaderDoc files zem reader/, bet image, audio vai video only packages var izlaist reader/.

navigationTree

navigationTree nosaka entry point un reader package-level satura rādītāju.

studyPlans

Authored study plans atrodas manifest.json tikai tad, ja package satur schedule data.

bindings

Kad canonical docs vai schema files mainās, vispirms atjauniniet source, pēc tam šo public snapshot un skaidrojumu.

Package creation

Turiet production tooling atsevišķi no public package boundary

  1. 1

    Sagatavot source content

    Sagatavojiet source content, metadata, media un authored schedules vai references.

  2. 2

    Izveidot wbpkg

    Izveidojiet installable package ar manifest metadata, ReaderDoc content, media, navigation un locator files.

  3. 3

    Pārbaudīt pirms koplietošanas

    Pirms distribution pārbaudiet package structure un schema compatibility.

Reader import

BookField lokāli lasa installed package

  1. 1

    Validate

    BookField pārbauda package shape un noraida unsupported vai malformed packages.

  2. 2

    Unpack

    Supported package assets tiek unpack app-owned local storage.

  3. 3

    Import SQLite

    ReaderDoc payloads, navigation, locator indexes, search records un schedules tiek reģistrēti offline use.

Compatibility

Rules, kas uztur packages paredzamus

  • Noraidīt legacy packageKind values.
  • Noraidīt legacy presentation fields.
  • Noraidīt non-canonical package paths.
  • Noraidīt malformed structured references.
  • Neiekļaujiet source EPUB files installable wbpkg.

Canonical references

Update policy

Šī public page ir implementation-facing overview, ne canonical schema source. Canonical docs un schema files atrodas kopā ar BookField source materials.

Source docs un schema files

  • 00-spec-index.md

    Šī public page ir implementation-facing overview, ne canonical schema source. Canonical docs un schema files atrodas kopā ar BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json ir public contract, ko BookField lasa pirms import. Legacy packageKind un presentation fields nav pašreizējās package shape daļa.

  • 08-reader-app-design.md

    BookField lokāli lasa installed package

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

    Šī public page ir implementation-facing overview, ne canonical schema source. Canonical docs un schema files atrodas kopā ar BookField source materials.

Kad canonical docs vai schema files mainās, vispirms atjauniniet source, pēc tam šo public snapshot un skaidrojumu.

Plānojiet BookField package distribution

Atgriezieties product overview vai apspriediet, vai wbpkg distribution flow atbilst jūsu content model.

Atpakaļ uz BookField Apspriest content distribution