Kembali ke BookField

BookField format package

wbpkg

Package yang dapat divalidasi, diinstal, dan dibaca BookField

Snapshot 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

Sekilas

Package yang dapat divalidasi, diinstal, dan dibaca BookField

Satu installable boundary untuk satu work dan satu edition. manifest.json adalah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan bagian dari package shape saat ini.

Kontainer yang dapat diinstal

Satu installable boundary untuk satu work dan satu edition.

Manifest v5

manifest.json adalah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan bagian dari package shape saat ini.

ReaderDoc v3

ReaderDoc content disiapkan untuk import, sehingga reader tidak mem-parse EPUB, HTML, atau CSS saat runtime.

Navigation tree

navigationTree menentukan entry point dan daftar isi package-level milik reader.

Locator indexes

Saat canonical docs atau schema files berubah, perbarui source terlebih dahulu, lalu refresh public snapshot dan penjelasan ini.

Study plans

Authored study plans berada di manifest.json hanya saat package memiliki schedule data.

Package layout

Canonical files di dalam wbpkg

Package paths adalah package-root-relative POSIX paths. Text packages menyertakan ReaderDoc files di bawah reader/, sementara image, audio, atau video only packages dapat menghilangkan 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 mendefinisikan install contract

manifest.json adalah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan bagian dari package shape saat ini.

packageId / packageVersion

manifest.json adalah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan bagian dari package shape saat ini.

work / edition

Satu installable boundary untuk satu work dan satu edition.

assets

Package paths adalah package-root-relative POSIX paths. Text packages menyertakan ReaderDoc files di bawah reader/, sementara image, audio, atau video only packages dapat menghilangkan reader/.

navigationTree

navigationTree menentukan entry point dan daftar isi package-level milik reader.

studyPlans

Authored study plans berada di manifest.json hanya saat package memiliki schedule data.

bindings

Saat canonical docs atau schema files berubah, perbarui source terlebih dahulu, lalu refresh public snapshot dan penjelasan ini.

Package creation

Pisahkan production tooling dari public package boundary

  1. 1

    Siapkan source content

    Siapkan source content, metadata, media, serta authored schedules atau references.

  2. 2

    Buat wbpkg

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

  3. 3

    Verifikasi sebelum berbagi

    Periksa package structure dan schema compatibility sebelum distribution.

Reader import

BookField membaca installed package secara lokal

  1. 1

    Validasi

    BookField memeriksa package shape dan menolak unsupported atau malformed packages.

  2. 2

    Unpack

    Supported package assets di-unpack ke app-owned local storage.

  3. 3

    Import ke SQLite

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

Compatibility

Rules yang menjaga packages tetap predictable

  • 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 adalah 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 adalah implementation-facing overview, bukan canonical schema source. Canonical docs dan schema files berada bersama BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json adalah public contract yang dibaca BookField sebelum import. Legacy packageKind dan presentation fields bukan bagian dari package shape saat ini.

  • 08-reader-app-design.md

    BookField membaca installed package secara lokal

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

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

Saat canonical docs atau schema files berubah, perbarui source terlebih dahulu, lalu refresh public snapshot dan penjelasan ini.

Rencanakan BookField package distribution

Kembali ke product overview, atau diskusikan apakah wbpkg distribution flow cocok dengan content model Anda.

Kembali ke BookField Diskusikan content distribution