BookField-ə qayıt

BookField package formatı

wbpkg

BookField-in yoxlaya, quraşdıra və oxuya bildiyi package

Versiya 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

Qısa baxış

BookField-in yoxlaya, quraşdıra və oxuya bildiyi package

Bir package bir work və bir edition üçün tək installable sərhəddir. manifest.json BookField-in import-dan əvvəl oxuduğu public contract-dır. Legacy packageKind və presentation fields cari package shape-ə daxil deyil.

Quraşdırıla bilən konteyner

Bir package bir work və bir edition üçün tək installable sərhəddir.

Manifest v5

manifest.json BookField-in import-dan əvvəl oxuduğu public contract-dır. Legacy packageKind və presentation fields cari package shape-ə daxil deyil.

ReaderDoc v3

ReaderDoc content import üçün hazırlanıb, ona görə reader runtime-da EPUB, HTML və ya CSS parse etmir.

Naviqasiya ağacı

navigationTree reader üçün entry point və package-level contents-i müəyyən edir.

Locator indeksləri

canonical docs və ya schema files dəyişəndə əvvəl source-u update edin, sonra bu public snapshot və izahı refresh edin.

Tədris planları

Authored study plans package schedule data saxlayanda yalnız manifest.json-da olur.

Package layout

wbpkg içində canonical files

Package paths package-root-relative POSIX paths-dir. Text packages reader/ altında ReaderDoc files saxlayır; image, audio və ya video only packages reader/ hissəsini buraxa bilər.

.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-ı müəyyən edir

manifest.json BookField-in import-dan əvvəl oxuduğu public contract-dır. Legacy packageKind və presentation fields cari package shape-ə daxil deyil.

packageId / packageVersion

manifest.json BookField-in import-dan əvvəl oxuduğu public contract-dır. Legacy packageKind və presentation fields cari package shape-ə daxil deyil.

work / edition

Bir package bir work və bir edition üçün tək installable sərhəddir.

assets

Package paths package-root-relative POSIX paths-dir. Text packages reader/ altında ReaderDoc files saxlayır; image, audio və ya video only packages reader/ hissəsini buraxa bilər.

navigationTree

navigationTree reader üçün entry point və package-level contents-i müəyyən edir.

studyPlans

Authored study plans package schedule data saxlayanda yalnız manifest.json-da olur.

bindings

canonical docs və ya schema files dəyişəndə əvvəl source-u update edin, sonra bu public snapshot və izahı refresh edin.

Package creation

Production tooling-i public package boundary-dən ayrı saxlayın

  1. 1

    Source content hazırlayın

    source content, metadata, media və authored schedules və ya references hazırlayın.

  2. 2

    wbpkg yaradın

    manifest metadata, ReaderDoc content, media, navigation və locator files ilə installable package yaradın.

  3. 3

    Paylaşmadan əvvəl yoxlayın

    distribution-dan əvvəl package structure və schema compatibility yoxlayın.

Reader import

BookField installed package-i lokal oxuyur

  1. 1

    Yoxla

    BookField package shape-i yoxlayır və unsupported və ya malformed packages-i rədd edir.

  2. 2

    Supported package assets app-owned local storage-a unpack edilir.

  3. 3

    SQLite-a import

    ReaderDoc payloads, navigation, locator indexes, search records və schedules offline use üçün register edilir.

Uyğunluq

Packages-i proqnozlaşdırıla bilən saxlayan rules

  • Rədd edin legacy packageKind values.
  • Rədd edin legacy presentation fields.
  • Rədd edin non-canonical package paths.
  • Rədd edin malformed structured references.
  • installable wbpkg-ə source EPUB files daxil etməyin.

Canonical references

Update policy

Bu public page implementation-facing overview-dür, canonical schema source deyil. Canonical docs və schema files BookField source materials ilə birlikdə saxlanır.

Source docs və schema files

  • 00-spec-index.md

    Bu public page implementation-facing overview-dür, canonical schema source deyil. Canonical docs və schema files BookField source materials ilə birlikdə saxlanır.

  • 04-manifest-json-schema.md

    manifest.json BookField-in import-dan əvvəl oxuduğu public contract-dır. Legacy packageKind və presentation fields cari package shape-ə daxil deyil.

  • 08-reader-app-design.md

    BookField installed package-i lokal oxuyur

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

    Bu public page implementation-facing overview-dür, canonical schema source deyil. Canonical docs və schema files BookField source materials ilə birlikdə saxlanır.

canonical docs və ya schema files dəyişəndə əvvəl source-u update edin, sonra bu public snapshot və izahı refresh edin.

BookField package distribution planlayın

Product overview-a qayıdın və ya wbpkg distribution flow-un content modelinizə uyğun olub-olmadığını müzakirə edin.