Kthehu te BookField

BookField format package

wbpkg

Package që BookField mund ta verifikojë, instalojë dhe lexojë

Pamje versionesh

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

Shkurt

Package që BookField mund ta verifikojë, instalojë dhe lexojë

Një package është një kufi i vetëm installable për një work dhe një edition. manifest.json është public contract që BookField lexon para import. Legacy packageKind dhe presentation fields nuk janë pjesë e package shape aktual.

Kontejner i instalueshëm

Një package është një kufi i vetëm installable për një work dhe një edition.

Manifest v5

manifest.json është public contract që BookField lexon para import. Legacy packageKind dhe presentation fields nuk janë pjesë e package shape aktual.

ReaderDoc v3

ReaderDoc content është përgatitur për import, ndaj reader nuk parse EPUB, HTML ose CSS në runtime.

Pema e navigimit

navigationTree vendos entry point dhe tabelën e përmbajtjes package-level të reader.

Locator indexes

Kur ndryshojnë canonical docs ose schema files, përditësoni fillimisht source, pastaj këtë public snapshot dhe shpjegimin.

Plane studimi

Authored study plans qëndrojnë në manifest.json vetëm kur package përmban schedule data.

Package layout

Canonical files brenda wbpkg

Package paths janë POSIX paths relative ndaj package root. Text packages kanë ReaderDoc files nën reader/, ndërsa image, audio ose video only packages mund ta heqin 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 përcakton install contract

manifest.json është public contract që BookField lexon para import. Legacy packageKind dhe presentation fields nuk janë pjesë e package shape aktual.

packageId / packageVersion

manifest.json është public contract që BookField lexon para import. Legacy packageKind dhe presentation fields nuk janë pjesë e package shape aktual.

work / edition

Një package është një kufi i vetëm installable për një work dhe një edition.

assets

Package paths janë POSIX paths relative ndaj package root. Text packages kanë ReaderDoc files nën reader/, ndërsa image, audio ose video only packages mund ta heqin reader/.

navigationTree

navigationTree vendos entry point dhe tabelën e përmbajtjes package-level të reader.

studyPlans

Authored study plans qëndrojnë në manifest.json vetëm kur package përmban schedule data.

bindings

Kur ndryshojnë canonical docs ose schema files, përditësoni fillimisht source, pastaj këtë public snapshot dhe shpjegimin.

Package creation

Mbajeni production tooling të ndarë nga public package boundary

  1. 1

    Përgatit source content

    Përgatitni source content, metadata, media dhe authored schedules ose references.

  2. 2

    Krijo wbpkg

    Krijoni installable package me manifest metadata, ReaderDoc content, media, navigation dhe locator files.

  3. 3

    Verifiko para ndarjes

    Kontrolloni package structure dhe schema compatibility para distribution.

Reader import

BookField lexon installed package lokalisht

  1. 1

    Verifiko

    BookField kontrollon package shape dhe refuzon unsupported ose malformed packages.

  2. 2

    Hap

    Supported package assets hapen në app-owned local storage.

  3. 3

    Import në SQLite

    ReaderDoc payloads, navigation, locator indexes, search records dhe schedules regjistrohen për offline use.

Pajtueshmëri

Rules që i mbajnë packages të parashikueshme

  • Refuzoni legacy packageKind values.
  • Refuzoni legacy presentation fields.
  • Refuzoni non-canonical package paths.
  • Refuzoni malformed structured references.
  • Mos përfshini source EPUB files në installable wbpkg.

Canonical references

Update policy

Kjo public page është implementation-facing overview, jo canonical schema source. Canonical docs dhe schema files qëndrojnë me BookField source materials.

Source docs dhe schema files

  • 00-spec-index.md

    Kjo public page është implementation-facing overview, jo canonical schema source. Canonical docs dhe schema files qëndrojnë me BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json është public contract që BookField lexon para import. Legacy packageKind dhe presentation fields nuk janë pjesë e package shape aktual.

  • 08-reader-app-design.md

    BookField lexon installed package lokalisht

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

    Kjo public page është implementation-facing overview, jo canonical schema source. Canonical docs dhe schema files qëndrojnë me BookField source materials.

Kur ndryshojnë canonical docs ose schema files, përditësoni fillimisht source, pastaj këtë public snapshot dhe shpjegimin.

Planifikoni BookField package distribution

Kthehuni te product overview ose diskutoni nëse wbpkg distribution flow përshtatet me content model tuaj.

Kthehu te BookField Diskuto content distribution