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 ярилцах