BookField-ке оралу

BookField package форматы

wbpkg

BookField validate, install және read ете алатын package

Version snapshot

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

Қысқаша

BookField validate, install және read ете алатын package

Бір package бір work және бір edition үшін жалғыз installable boundary болып табылады. manifest.json — BookField import алдында оқитын public contract. Legacy packageKind және presentation fields қазіргі package shape бөлігі емес.

Installable container

Бір package бір work және бір edition үшін жалғыз installable boundary болып табылады.

Manifest v5

manifest.json — BookField import алдында оқитын public contract. Legacy packageKind және presentation fields қазіргі package shape бөлігі емес.

ReaderDoc v3

ReaderDoc content import үшін дайындалған, сондықтан reader runtime кезінде EPUB, HTML немесе CSS parse етпейді.

Navigation tree

navigationTree reader үшін entry point және package-level table of contents анықтайды.

Locator indexes

canonical docs немесе schema files өзгерсе, алдымен source update жасаңыз, содан кейін осы public snapshot пен түсіндірмені refresh етіңіз.

Study plans

Authored study plans package ішінде schedule data болса ғана manifest.json ішінде болады.

Package layout

wbpkg ішіндегі canonical files

Package paths package-root-relative POSIX paths болып табылады. Text packages reader/ астында ReaderDoc files сақтайды; image, audio немесе video only packages 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 install contract анықтайды

manifest.json — BookField import алдында оқитын public contract. Legacy packageKind және presentation fields қазіргі package shape бөлігі емес.

packageId / packageVersion

manifest.json — BookField import алдында оқитын public contract. Legacy packageKind және presentation fields қазіргі package shape бөлігі емес.

work / edition

Бір package бір work және бір edition үшін жалғыз installable boundary болып табылады.

assets

Package paths package-root-relative POSIX paths болып табылады. Text packages reader/ астында ReaderDoc files сақтайды; image, audio немесе video only packages reader/ бөлімін өткізіп жібере алады.

navigationTree

navigationTree reader үшін entry point және package-level table of contents анықтайды.

studyPlans

Authored study plans package ішінде schedule data болса ғана manifest.json ішінде болады.

bindings

canonical docs немесе schema files өзгерсе, алдымен source update жасаңыз, содан кейін осы public snapshot пен түсіндірмені refresh етіңіз.

Package creation

Production tooling-ті public package boundary-ден бөлек ұстаңыз

  1. 1

    Source content дайындау

    source content, metadata, media және authored schedules немесе references дайындаңыз.

  2. 2

    wbpkg жасау

    manifest metadata, ReaderDoc content, media, navigation және locator files бар installable package жасаңыз.

  3. 3

    Бөліспес бұрын тексеру

    distribution алдында package structure және schema compatibility тексеріңіз.

Reader import

BookField installed package-ті жергілікті оқиды

  1. 1

    Validate

    BookField package shape тексеріп, unsupported немесе malformed packages-ті reject етеді.

  2. 2

    Unpack

    Supported package assets app-owned local storage ішіне unpack болады.

  3. 3

    SQLite-ке import

    ReaderDoc payloads, navigation, locator indexes, search records және schedules offline use үшін register болады.

Compatibility

Packages predictable болуын сақтайтын rules

  • Reject: етіңіз legacy packageKind values.
  • Reject: етіңіз legacy presentation fields.
  • Reject: етіңіз non-canonical package paths.
  • Reject: етіңіз malformed structured references.
  • installable wbpkg ішіне source EPUB files қоспаңыз.

Canonical references

Update policy

Бұл public page implementation-facing overview, canonical schema source емес. Canonical docs және schema files BookField source materials-пен бірге сақталады.

Source docs және schema files

  • 00-spec-index.md

    Бұл public page implementation-facing overview, canonical schema source емес. Canonical docs және schema files BookField source materials-пен бірге сақталады.

  • 04-manifest-json-schema.md

    manifest.json — BookField import алдында оқитын public contract. Legacy packageKind және presentation fields қазіргі package shape бөлігі емес.

  • 08-reader-app-design.md

    BookField installed package-ті жергілікті оқиды

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

    Бұл public page implementation-facing overview, canonical schema source емес. Canonical docs және schema files BookField source materials-пен бірге сақталады.

canonical docs немесе schema files өзгерсе, алдымен source update жасаңыз, содан кейін осы public snapshot пен түсіндірмені refresh етіңіз.

BookField package distribution жоспарлаңыз

Product overview-қа оралыңыз немесе wbpkg distribution flow сіздің content model-іңізге сәйкес келе ме, талқылаңыз.

BookField-ке оралу Content distribution талқылау