Voltar ao BookField

BookField formato de package

wbpkg

Um package que o BookField pode validar, instalar e ler

Resumo de versões

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

Visão geral

Um package que o BookField pode validar, instalar e ler

Um único installable boundary para um work e uma edition. manifest.json é o public contract que o BookField lê antes do import. Legacy packageKind e presentation fields não fazem parte do package shape atual.

Contêiner instalável

Um único installable boundary para um work e uma edition.

Manifest v5

manifest.json é o public contract que o BookField lê antes do import. Legacy packageKind e presentation fields não fazem parte do package shape atual.

ReaderDoc v3

ReaderDoc content é preparado para importação, então o reader não analisa EPUB, HTML ou CSS em runtime.

Navigation tree

navigationTree decide o entry point e o índice package-level do reader.

Locator indexes

Quando canonical docs ou schema files mudarem, atualize source primeiro e depois este public snapshot e sua explicação.

Study plans

Authored study plans ficam em manifest.json somente quando o package inclui schedule data.

Package layout

Canonical files dentro de um wbpkg

Package paths são package-root-relative POSIX paths. Text packages incluem ReaderDoc files em reader/, enquanto image, audio ou video only packages podem omitir 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 define o install contract

manifest.json é o public contract que o BookField lê antes do import. Legacy packageKind e presentation fields não fazem parte do package shape atual.

packageId / packageVersion

manifest.json é o public contract que o BookField lê antes do import. Legacy packageKind e presentation fields não fazem parte do package shape atual.

work / edition

Um único installable boundary para um work e uma edition.

assets

Package paths são package-root-relative POSIX paths. Text packages incluem ReaderDoc files em reader/, enquanto image, audio ou video only packages podem omitir reader/.

navigationTree

navigationTree decide o entry point e o índice package-level do reader.

studyPlans

Authored study plans ficam em manifest.json somente quando o package inclui schedule data.

bindings

Quando canonical docs ou schema files mudarem, atualize source primeiro e depois este public snapshot e sua explicação.

Package creation

Mantenha production tooling separado do public package boundary

  1. 1

    Preparar source content

    Prepare source content, metadata, media e authored schedules ou references.

  2. 2

    Produzir um wbpkg

    Produza um installable package com manifest metadata, ReaderDoc content, media, navigation e locator files.

  3. 3

    Verificar antes de compartilhar

    Verifique package structure e schema compatibility antes da distribution.

Reader import

BookField lê o installed package localmente

  1. 1

    Validar

    BookField verifica package shape e rejeita unsupported ou malformed packages.

  2. 2

    Descompactar

    Supported package assets são unpack em app-owned local storage.

  3. 3

    Importar para SQLite

    ReaderDoc payloads, navigation, locator indexes, search records e schedules são registrados para offline use.

Compatibility

Rules que mantêm packages previsíveis

  • Rejeitar legacy packageKind values.
  • Rejeitar legacy presentation fields.
  • Rejeitar non-canonical package paths.
  • Rejeitar malformed structured references.
  • Não inclua source EPUB files em um installable wbpkg.

Canonical references

Update policy

Esta public page é um implementation-facing overview, não a canonical schema source. Canonical docs e schema files ficam com BookField source materials.

Source docs e schema files

  • 00-spec-index.md

    Esta public page é um implementation-facing overview, não a canonical schema source. Canonical docs e schema files ficam com BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json é o public contract que o BookField lê antes do import. Legacy packageKind e presentation fields não fazem parte do package shape atual.

  • 08-reader-app-design.md

    BookField lê o installed package localmente

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

    Esta public page é um implementation-facing overview, não a canonical schema source. Canonical docs e schema files ficam com BookField source materials.

Quando canonical docs ou schema files mudarem, atualize source primeiro e depois este public snapshot e sua explicação.

Planeje BookField package distribution

Volte ao product overview ou discuta se um wbpkg distribution flow combina com seu content model.

Voltar ao BookField Discutir content distribution