Назад към 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 може да валидира, инсталира и чете

Един installable boundary за едно work и едно edition. manifest.json е публичният contract, който BookField чете преди import. Legacy packageKind и presentation fields не са част от текущата package shape.

Инсталиращ се контейнер

Един installable boundary за едно work и едно edition.

Manifest v5

manifest.json е публичният contract, който BookField чете преди import. Legacy packageKind и presentation fields не са част от текущата package shape.

ReaderDoc v3

ReaderDoc content е подготвено за import, така че reader не parse-ва EPUB, HTML или CSS при runtime.

Navigation tree

navigationTree определя entry point и package-level съдържанието на reader.

Locator indexes

Когато canonical docs или schema files се променят, първо обновете source, после този public snapshot и обясненията.

Study plans

Authored study plans се записват в manifest.json само когато package съдържа schedule data.

Структура на package

Canonical файлове в wbpkg

Package paths са package-root-relative POSIX paths. 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 договор

Manifest v5 дефинира install contract

manifest.json е публичният contract, който BookField чете преди import. Legacy packageKind и presentation fields не са част от текущата package shape.

packageId / packageVersion

manifest.json е публичният contract, който BookField чете преди import. Legacy packageKind и presentation fields не са част от текущата package shape.

work / edition

Един installable boundary за едно work и едно edition.

assets

Package paths са package-root-relative POSIX paths. 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

Дръжте production tooling отделено от публичната package граница

  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 и reject-ва unsupported или malformed packages.

  2. 2

    Разархивиране

    Supported package assets се unpack-ват в app-owned local storage.

  3. 3

    Import в SQLite

    ReaderDoc payloads, navigation, locator indexes, search records и schedules се регистрират за offline use.

Съвместимост

Правила, които пазят packages предвидими

  • Отхвърляйте legacy packageKind values.
  • Отхвърляйте legacy presentation fields.
  • Отхвърляйте non-canonical package paths.
  • Отхвърляйте malformed structured references.
  • Не включвайте source EPUB files в installable wbpkg.

Canonical references

Update policy

Тази публична страница е implementation-facing overview, не canonical schema source. Canonical docs и schema files живеят със source materials на BookField.

Source docs и schema files

  • 00-spec-index.md

    Тази публична страница е implementation-facing overview, не canonical schema source. Canonical docs и schema files живеят със source materials на BookField.

  • 04-manifest-json-schema.md

    manifest.json е публичният 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

    Тази публична страница е implementation-facing overview, не canonical schema source. Canonical docs и schema files живеят със source materials на BookField.

Когато canonical docs или schema files се променят, първо обновете source, после този public snapshot и обясненията.

Планирайте BookField package distribution

Върнете се към product overview или обсъдете дали wbpkg distribution flow пасва на вашия content model.

Назад към BookField Обсъдете content distribution