Takaisin BookFieldiin

BookField package-muoto

wbpkg

Package, jonka BookField voi validoida, asentaa ja lukea

Versiotilanne

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

Yhdellä silmäyksellä

Package, jonka BookField voi validoida, asentaa ja lukea

Yksi installable boundary yhdelle workille ja yhdelle editionille. manifest.json on public contract, jonka BookField lukee ennen importia. Legacy packageKind ja presentation fields eivät kuulu nykyiseen package shapeen.

Asennettava säiliö

Yksi installable boundary yhdelle workille ja yhdelle editionille.

Manifest v5

manifest.json on public contract, jonka BookField lukee ennen importia. Legacy packageKind ja presentation fields eivät kuulu nykyiseen package shapeen.

ReaderDoc v3

ReaderDoc content on valmisteltu importia varten, joten reader ei jäsennä EPUB-, HTML- tai CSS-sisältöä runtime-aikana.

Navigation tree

navigationTree määrittää entry pointin ja readerin package-level sisällysluettelon.

Locator indexes

Kun canonical docs tai schema files muuttuvat, päivitä ensin source ja sitten tämä public snapshot ja sen selitys.

Study plans

Authored study plans ovat manifest.jsonissa vain, kun package sisältää schedule dataa.

Package layout

Canonical files wbpkg:n sisällä

Package paths ovat package-root-relative POSIX paths. Text packages sisältävät ReaderDoc files reader/-hakemistossa; image, audio tai video only packages voivat jättää reader/ pois.

.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 määrittää install contractin

manifest.json on public contract, jonka BookField lukee ennen importia. Legacy packageKind ja presentation fields eivät kuulu nykyiseen package shapeen.

packageId / packageVersion

manifest.json on public contract, jonka BookField lukee ennen importia. Legacy packageKind ja presentation fields eivät kuulu nykyiseen package shapeen.

work / edition

Yksi installable boundary yhdelle workille ja yhdelle editionille.

assets

Package paths ovat package-root-relative POSIX paths. Text packages sisältävät ReaderDoc files reader/-hakemistossa; image, audio tai video only packages voivat jättää reader/ pois.

navigationTree

navigationTree määrittää entry pointin ja readerin package-level sisällysluettelon.

studyPlans

Authored study plans ovat manifest.jsonissa vain, kun package sisältää schedule dataa.

bindings

Kun canonical docs tai schema files muuttuvat, päivitä ensin source ja sitten tämä public snapshot ja sen selitys.

Package creation

Pidä production tooling erillään public package boundarysta

  1. 1

    Valmistele source content

    Valmistele source content, metadata, media sekä authored schedules tai references.

  2. 2

    Tuota wbpkg

    Tuota installable package, jossa on manifest metadata, ReaderDoc content, media, navigation ja locator files.

  3. 3

    Varmista ennen jakamista

    Tarkista package structure ja schema compatibility ennen distributionia.

Reader import

BookField lukee installed package -sisällön paikallisesti

  1. 1

    Validoi

    BookField tarkistaa package shapen ja hylkää unsupported tai malformed packages.

  2. 2

    Pura

    Supported package assets puretaan app-owned local storageen.

  3. 3

    Import SQLiteen

    ReaderDoc payloads, navigation, locator indexes, search records ja schedules rekisteröidään offline useen.

Yhteensopivuus

Rules, jotka pitävät packages ennustettavina

  • Hylkää legacy packageKind values.
  • Hylkää legacy presentation fields.
  • Hylkää non-canonical package paths.
  • Hylkää malformed structured references.
  • Älä sisällytä source EPUB files installable wbpkg -pakettiin.

Canonical references

Update policy

Tämä public page on implementation-facing overview, ei canonical schema source. Canonical docs ja schema files ovat BookField source materials -aineiston yhteydessä.

Source docs ja schema files

  • 00-spec-index.md

    Tämä public page on implementation-facing overview, ei canonical schema source. Canonical docs ja schema files ovat BookField source materials -aineiston yhteydessä.

  • 04-manifest-json-schema.md

    manifest.json on public contract, jonka BookField lukee ennen importia. Legacy packageKind ja presentation fields eivät kuulu nykyiseen package shapeen.

  • 08-reader-app-design.md

    BookField lukee installed package -sisällön paikallisesti

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

    Tämä public page on implementation-facing overview, ei canonical schema source. Canonical docs ja schema files ovat BookField source materials -aineiston yhteydessä.

Kun canonical docs tai schema files muuttuvat, päivitä ensin source ja sitten tämä public snapshot ja sen selitys.

Suunnittele BookField package distribution

Palaa product overview -sivulle tai keskustele, sopiiko wbpkg distribution flow content modeliisi.

Takaisin BookFieldiin Keskustele content distributionista