Kembali ke BookField

BookField format package

wbpkg

Package yang boleh disahkan, dipasang dan dibaca oleh BookField

Petikan versi

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

Ringkasnya

Package yang boleh disahkan, dipasang dan dibaca oleh BookField

Satu package ialah satu sempadan installable untuk satu work dan satu edition. manifest.json ialah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan sebahagian daripada package shape semasa.

Bekas boleh dipasang

Satu package ialah satu sempadan installable untuk satu work dan satu edition.

Manifest v5

manifest.json ialah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan sebahagian daripada package shape semasa.

ReaderDoc v3

ReaderDoc content disediakan untuk import, jadi reader tidak parse EPUB, HTML atau CSS semasa runtime.

Pokok navigasi

navigationTree menentukan entry point dan jadual kandungan package-level untuk reader.

Indeks locator

Apabila canonical docs atau schema files berubah, kemas kini source dahulu, kemudian segarkan public snapshot dan penjelasan ini.

Pelan pembelajaran

Authored study plans berada dalam manifest.json hanya apabila package mengandungi schedule data.

Package layout

Canonical files dalam wbpkg

Package paths ialah POSIX paths relatif kepada package root. Text packages menyertakan ReaderDoc files di bawah reader/, manakala image, audio atau video only packages boleh meninggalkan 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 mentakrifkan install contract

manifest.json ialah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan sebahagian daripada package shape semasa.

packageId / packageVersion

manifest.json ialah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan sebahagian daripada package shape semasa.

work / edition

Satu package ialah satu sempadan installable untuk satu work dan satu edition.

assets

Package paths ialah POSIX paths relatif kepada package root. Text packages menyertakan ReaderDoc files di bawah reader/, manakala image, audio atau video only packages boleh meninggalkan reader/.

navigationTree

navigationTree menentukan entry point dan jadual kandungan package-level untuk reader.

studyPlans

Authored study plans berada dalam manifest.json hanya apabila package mengandungi schedule data.

bindings

Apabila canonical docs atau schema files berubah, kemas kini source dahulu, kemudian segarkan public snapshot dan penjelasan ini.

Package creation

Asingkan production tooling daripada public package boundary

  1. 1

    Sediakan source content

    Sediakan source content, metadata, media dan authored schedules atau references.

  2. 2

    Hasilkan wbpkg

    Hasilkan installable package dengan manifest metadata, ReaderDoc content, media, navigation dan locator files.

  3. 3

    Sahkan sebelum berkongsi

    Semak package structure dan schema compatibility sebelum distribution.

Reader import

BookField membaca installed package secara setempat

  1. 1

    Sahkan

    BookField menyemak package shape dan menolak unsupported atau malformed packages.

  2. 2

    Buka

    Supported package assets dibuka ke app-owned local storage.

  3. 3

    Import ke SQLite

    ReaderDoc payloads, navigation, locator indexes, search records dan schedules didaftarkan untuk offline use.

Keserasian

Rules yang memastikan packages boleh dijangka

  • Tolak legacy packageKind values.
  • Tolak legacy presentation fields.
  • Tolak non-canonical package paths.
  • Tolak malformed structured references.
  • Jangan sertakan source EPUB files dalam installable wbpkg.

Canonical references

Update policy

Public page ini ialah implementation-facing overview, bukan canonical schema source. Canonical docs dan schema files berada bersama BookField source materials.

Source docs dan schema files

  • 00-spec-index.md

    Public page ini ialah implementation-facing overview, bukan canonical schema source. Canonical docs dan schema files berada bersama BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json ialah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan sebahagian daripada package shape semasa.

  • 08-reader-app-design.md

    BookField membaca installed package secara setempat

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

    Public page ini ialah implementation-facing overview, bukan canonical schema source. Canonical docs dan schema files berada bersama BookField source materials.

Apabila canonical docs atau schema files berubah, kemas kini source dahulu, kemudian segarkan public snapshot dan penjelasan ini.

Rancang BookField package distribution

Kembali ke product overview atau bincangkan sama ada wbpkg distribution flow sesuai dengan content model anda.

Kembali ke BookField Bincang content distribution