ກັບໄປ BookField

BookField ຮູບແບບ package

wbpkg

Package ທີ່ BookField ສາມາດ validate, install ແລະ read

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

ໂດຍຫຍໍ້

Package ທີ່ BookField ສາມາດ validate, install ແລະ read

package ໜຶ່ງເປັນ installable boundary ດຽວສໍາລັບ work ໜຶ່ງ ແລະ edition ໜຶ່ງ. manifest.json ແມ່ນ public contract ທີ່ BookField ອ່ານກ່ອນ import. Legacy packageKind ແລະ presentation fields ບໍ່ແມ່ນສ່ວນຂອງ package shape ປັດຈຸບັນ.

Installable container

package ໜຶ່ງເປັນ installable boundary ດຽວສໍາລັບ work ໜຶ່ງ ແລະ edition ໜຶ່ງ.

Manifest v5

manifest.json ແມ່ນ public contract ທີ່ BookField ອ່ານກ່ອນ import. Legacy packageKind ແລະ presentation fields ບໍ່ແມ່ນສ່ວນຂອງ package shape ປັດຈຸບັນ.

ReaderDoc v3

ReaderDoc content ຖືກກຽມໄວ້ສໍາລັບ import, ດັ່ງນັ້ນ reader ບໍ່ parse EPUB, HTML ຫຼື CSS ໃນ runtime.

Navigation tree

navigationTree ກໍານົດ entry point ແລະ package-level table of contents ຂອງ reader.

Locator indexes

ເມື່ອ canonical docs ຫຼື schema files ປ່ຽນ, update source ກ່ອນ, ແລ້ວ refresh public snapshot ແລະຄໍາອະທິບາຍນີ້.

Study plans

Authored study plans ຢູ່ໃນ manifest.json ເມື່ອ package ມີ schedule data ເທົ່ານັ້ນ.

Package layout

Canonical files ພາຍໃນ wbpkg

Package paths ແມ່ນ package-root-relative POSIX paths. Text packages ມີ ReaderDoc files ພາຍໃຕ້ reader/, ສ່ວນ 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 ແມ່ນ public contract ທີ່ BookField ອ່ານກ່ອນ import. Legacy packageKind ແລະ presentation fields ບໍ່ແມ່ນສ່ວນຂອງ package shape ປັດຈຸບັນ.

packageId / packageVersion

manifest.json ແມ່ນ public contract ທີ່ BookField ອ່ານກ່ອນ import. Legacy packageKind ແລະ presentation fields ບໍ່ແມ່ນສ່ວນຂອງ package shape ປັດຈຸບັນ.

work / edition

package ໜຶ່ງເປັນ installable boundary ດຽວສໍາລັບ work ໜຶ່ງ ແລະ edition ໜຶ່ງ.

assets

Package paths ແມ່ນ package-root-relative POSIX paths. Text packages ມີ ReaderDoc files ພາຍໃຕ້ reader/, ສ່ວນ image, audio ຫຼື video only packages ອາດຂ້າມ reader/.

navigationTree

navigationTree ກໍານົດ entry point ແລະ package-level table of contents ຂອງ reader.

studyPlans

Authored study plans ຢູ່ໃນ manifest.json ເມື່ອ package ມີ schedule data ເທົ່ານັ້ນ.

bindings

ເມື່ອ canonical docs ຫຼື schema files ປ່ຽນ, update source ກ່ອນ, ແລ້ວ refresh public snapshot ແລະຄໍາອະທິບາຍນີ້.

Package creation

ແຍກ production tooling ອອກຈາກ public package boundary

  1. 1

    ກຽມ Source content

    ກຽມ source content, metadata, media ແລະ authored schedules ຫຼື references.

  2. 2

    ສ້າງ wbpkg

    ສ້າງ installable package ທີ່ມີ manifest metadata, ReaderDoc content, media, navigation ແລະ locator files.

  3. 3

    ກວດກ່ອນແບ່ງປັນ

    ກວດ package structure ແລະ schema compatibility ກ່ອນ distribution.

Reader import

BookField ອ່ານ installed package ໃນເຄື່ອງ

  1. 1

    Validate

    BookField ກວດ package shape ແລະ reject unsupported ຫຼື malformed packages.

  2. 2

    Unpack

    Supported package assets ຖືກ unpack ໄປ app-owned local storage.

  3. 3

    Import ເຂົ້າ SQLite

    ReaderDoc payloads, navigation, locator indexes, search records ແລະ schedules ຖືກ register ສໍາລັບ offline use.

Compatibility

Rules ທີ່ເຮັດໃຫ້ packages predictable

  • Reject: legacy packageKind values.
  • Reject: legacy presentation fields.
  • Reject: non-canonical package paths.
  • Reject: malformed structured references.
  • ຢ່າລວມ source EPUB files ໃນ installable wbpkg.

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 ແມ່ນ public contract ທີ່ BookField ອ່ານກ່ອນ import. 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 ປ່ຽນ, update source ກ່ອນ, ແລ້ວ refresh public snapshot ແລະຄໍາອະທິບາຍນີ້.

ວາງແຜນ BookField package distribution

ກັບໄປ product overview ຫຼືຫາລືວ່າ wbpkg distribution flow ເໝາະກັບ content model ຂອງທ່ານບໍ່.

ກັບໄປ BookField ຫາລື content distribution