Volver a BookField

BookField formato de package

wbpkg

Un package que BookField puede validar, instalar y leer

Instantánea de versiones

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

De un vistazo

Un package que BookField puede validar, instalar y leer

Un único installable boundary para un work y una edition. manifest.json es el contract público que BookField lee antes del import. Legacy packageKind y presentation fields no forman parte del package shape actual.

Contenedor instalable

Un único installable boundary para un work y una edition.

Manifest v5

manifest.json es el contract público que BookField lee antes del import. Legacy packageKind y presentation fields no forman parte del package shape actual.

ReaderDoc v3

ReaderDoc content se prepara para importación, de modo que el reader no analiza EPUB, HTML ni CSS en runtime.

Navigation tree

navigationTree decide el entry point y la tabla de contenidos package-level del reader.

Locator indexes

Cuando cambien canonical docs o schema files, actualice primero source y luego refresque este public snapshot y su explicación.

Study plans

Authored study plans viven en manifest.json solo cuando el package incluye schedule data.

Package layout

Archivos canonical dentro de un wbpkg

Los package paths son package-root-relative POSIX paths. Los text packages incluyen ReaderDoc files bajo reader/, mientras que image, audio o video only packages pueden 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 el install contract

manifest.json es el contract público que BookField lee antes del import. Legacy packageKind y presentation fields no forman parte del package shape actual.

packageId / packageVersion

manifest.json es el contract público que BookField lee antes del import. Legacy packageKind y presentation fields no forman parte del package shape actual.

work / edition

Un único installable boundary para un work y una edition.

assets

Los package paths son package-root-relative POSIX paths. Los text packages incluyen ReaderDoc files bajo reader/, mientras que image, audio o video only packages pueden omitir reader/.

navigationTree

navigationTree decide el entry point y la tabla de contenidos package-level del reader.

studyPlans

Authored study plans viven en manifest.json solo cuando el package incluye schedule data.

bindings

Cuando cambien canonical docs o schema files, actualice primero source y luego refresque este public snapshot y su explicación.

Package creation

Mantener production tooling separado del public package boundary

  1. 1

    Preparar source content

    Prepare source content, metadata, media y cualquier authored schedule o reference.

  2. 2

    Producir un wbpkg

    Produzca un installable package con manifest metadata, ReaderDoc content, media, navigation y locator files.

  3. 3

    Verificar antes de compartir

    Revise package structure y schema compatibility antes de distribution.

Reader import

BookField lee localmente el installed package

  1. 1

    Validar

    BookField revisa package shape y rechaza packages unsupported o malformed.

  2. 2

    Desempaquetar

    Los supported package assets se unpack en app-owned local storage.

  3. 3

    Importar a SQLite

    ReaderDoc payloads, navigation, locator indexes, search records y schedules se registran para offline use.

Compatibilidad

Rules que mantienen los packages predecibles

  • Rechazar legacy packageKind values.
  • Rechazar legacy presentation fields.
  • Rechazar non-canonical package paths.
  • Rechazar malformed structured references.
  • No incluya source EPUB files en un installable wbpkg.

Canonical references

Update policy

Esta página pública es un implementation-facing overview, no la canonical schema source. Los canonical docs y schema files viven junto a los BookField source materials.

Source docs y schema files

  • 00-spec-index.md

    Esta página pública es un implementation-facing overview, no la canonical schema source. Los canonical docs y schema files viven junto a los BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json es el contract público que BookField lee antes del import. Legacy packageKind y presentation fields no forman parte del package shape actual.

  • 08-reader-app-design.md

    BookField lee localmente el installed package

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

    Esta página pública es un implementation-facing overview, no la canonical schema source. Los canonical docs y schema files viven junto a los BookField source materials.

Cuando cambien canonical docs o schema files, actualice primero source y luego refresque este public snapshot y su explicación.

Planificar BookField package distribution

Vuelva al product overview o analice si un wbpkg distribution flow encaja con su content model.

Volver a BookField Hablar sobre content distribution