Rudi kwenye BookField

BookField muundo wa package

wbpkg

Package ambayo BookField inaweza kuthibitisha, kusakinisha na kusoma

Picha ya matoleo

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

Kwa kifupi

Package ambayo BookField inaweza kuthibitisha, kusakinisha na kusoma

Package moja ni mpaka mmoja wa kusakinisha kwa work moja na edition moja. manifest.json ni public contract ambayo BookField husoma kabla ya import. Legacy packageKind na presentation fields si sehemu ya package shape ya sasa.

Container inayosakinika

Package moja ni mpaka mmoja wa kusakinisha kwa work moja na edition moja.

Manifest v5

manifest.json ni public contract ambayo BookField husoma kabla ya import. Legacy packageKind na presentation fields si sehemu ya package shape ya sasa.

ReaderDoc v3

ReaderDoc content imeandaliwa kwa import, hivyo reader haiparse EPUB, HTML au CSS wakati wa runtime.

Mti wa navigation

navigationTree huamua entry point na jedwali la maudhui la reader katika kiwango cha package.

Locator indexes

Canonical docs au schema files zikibadilika, sasisha source kwanza, kisha onyesha upya public snapshot hii na maelezo yake.

Study plans

Authored study plans huwepo kwenye manifest.json tu package ikiwa na schedule data.

Package layout

Canonical files ndani ya wbpkg

Package paths ni POSIX paths zinazohusiana na package root. Text packages zina ReaderDoc files chini ya reader/, na image, audio au video only packages zinaweza kuacha 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 hufafanua install contract

manifest.json ni public contract ambayo BookField husoma kabla ya import. Legacy packageKind na presentation fields si sehemu ya package shape ya sasa.

packageId / packageVersion

manifest.json ni public contract ambayo BookField husoma kabla ya import. Legacy packageKind na presentation fields si sehemu ya package shape ya sasa.

work / edition

Package moja ni mpaka mmoja wa kusakinisha kwa work moja na edition moja.

assets

Package paths ni POSIX paths zinazohusiana na package root. Text packages zina ReaderDoc files chini ya reader/, na image, audio au video only packages zinaweza kuacha reader/.

navigationTree

navigationTree huamua entry point na jedwali la maudhui la reader katika kiwango cha package.

studyPlans

Authored study plans huwepo kwenye manifest.json tu package ikiwa na schedule data.

bindings

Canonical docs au schema files zikibadilika, sasisha source kwanza, kisha onyesha upya public snapshot hii na maelezo yake.

Package creation

Tenganisha production tooling na public package boundary

  1. 1

    Andaa source content

    Andaa source content, metadata, media na authored schedules au references.

  2. 2

    Tengeneza wbpkg

    Tengeneza installable package yenye manifest metadata, ReaderDoc content, media, navigation na locator files.

  3. 3

    Thibitisha kabla ya kushiriki

    Kagua package structure na schema compatibility kabla ya distribution.

Reader import

BookField husoma installed package ndani ya kifaa

  1. 1

    Thibitisha

    BookField hukagua package shape na kukataa unsupported au malformed packages.

  2. 2

    Fungua

    Supported package assets hufunguliwa kwenye app-owned local storage.

  3. 3

    Import kwenye SQLite

    ReaderDoc payloads, navigation, locator indexes, search records na schedules husajiliwa kwa offline use.

Compatibility

Rules zinazofanya packages zitabirike

  • Kataa legacy packageKind values.
  • Kataa legacy presentation fields.
  • Kataa non-canonical package paths.
  • Kataa malformed structured references.
  • Usijumuishe source EPUB files ndani ya installable wbpkg.

Canonical references

Update policy

Ukurasa huu wa umma ni implementation-facing overview, si canonical schema source. Canonical docs na schema files hukaa pamoja na BookField source materials.

Source docs na schema files

  • 00-spec-index.md

    Ukurasa huu wa umma ni implementation-facing overview, si canonical schema source. Canonical docs na schema files hukaa pamoja na BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json ni public contract ambayo BookField husoma kabla ya import. Legacy packageKind na presentation fields si sehemu ya package shape ya sasa.

  • 08-reader-app-design.md

    BookField husoma installed package ndani ya kifaa

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

    Ukurasa huu wa umma ni implementation-facing overview, si canonical schema source. Canonical docs na schema files hukaa pamoja na BookField source materials.

Canonical docs au schema files zikibadilika, sasisha source kwanza, kisha onyesha upya public snapshot hii na maelezo yake.

Panga BookField package distribution

Rudi kwenye product overview au jadili kama wbpkg distribution flow inafaa content model yako.

Rudi kwenye BookField Jadili content distribution