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 талкуулоо