Назад до BookField

BookField формат package

wbpkg

Package, який BookField може перевірити, встановити й читати

Знімок версій

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

Коротко

Package, який BookField може перевірити, встановити й читати

Один package є однією installable межею для одного work і однієї edition. manifest.json — public contract, який BookField читає перед import. Legacy packageKind і presentation fields не є частиною поточної package shape.

Контейнер для встановлення

Один package є однією installable межею для одного work і однієї edition.

Manifest v5

manifest.json — public contract, який BookField читає перед import. Legacy packageKind і presentation fields не є частиною поточної package shape.

ReaderDoc v3

ReaderDoc content підготовлений для import, тому reader не parse-ить EPUB, HTML або CSS під час runtime.

Дерево навігації

navigationTree визначає entry point і package-level зміст reader.

Locator індекси

Коли canonical docs або schema files змінюються, спочатку оновіть source, потім цей public snapshot і пояснення.

Навчальні плани

Authored study plans зберігаються в manifest.json лише тоді, коли package містить schedule data.

Package layout

Canonical files усередині wbpkg

Package paths є POSIX paths відносно package root. Text packages містять ReaderDoc files у reader/, а 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 є однією installable межею для одного work і однієї edition.

assets

Package paths є POSIX paths відносно package root. Text packages містять ReaderDoc files у reader/, а image, audio або video only packages можуть не містити reader/.

navigationTree

navigationTree визначає entry point і package-level зміст reader.

studyPlans

Authored study plans зберігаються в manifest.json лише тоді, коли package містить schedule data.

bindings

Коли canonical docs або schema files змінюються, спочатку оновіть source, потім цей public snapshot і пояснення.

Package creation

Тримайте production tooling окремо від public package boundary

  1. 1

    Підготуйте source content

    Підготуйте source content, metadata, media та authored schedules або references.

  2. 2

    Створіть wbpkg

    Створіть installable package з manifest metadata, ReaderDoc content, media, navigation і locator files.

  3. 3

    Перевірте перед поширенням

    Перевірте package structure і schema compatibility перед distribution.

Reader import

BookField читає installed package локально

  1. 1

    Перевірка

    BookField перевіряє package shape і відхиляє unsupported або malformed packages.

  2. 2

    Розпакування

    Supported package assets розпаковуються в app-owned local storage.

  3. 3

    Import у SQLite

    ReaderDoc payloads, navigation, locator indexes, search records і schedules реєструються для offline use.

Сумісність

Rules, що роблять packages передбачуваними

  • Відхиляйте legacy packageKind values.
  • Відхиляйте legacy presentation fields.
  • Відхиляйте non-canonical package paths.
  • Відхиляйте malformed structured references.
  • Не додавайте source EPUB files до installable wbpkg.

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 локально

  • 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, потім цей public snapshot і пояснення.

Сплануйте BookField package distribution

Поверніться до product overview або обговоріть, чи підходить wbpkg distribution flow вашій content model.

Назад до BookField Обговорити content distribution