BookField-ზე დაბრუნება

BookField package ფორმატი

wbpkg

Package, რომლის validate, install და read BookField-ს შეუძლია

ვერსიის 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, რომლის validate, install და read BookField-ს შეუძლია

ერთი 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 runtime-ში EPUB-ს, HTML-ს ან CSS-ს არ parse-ავს.

Navigation tree

navigationTree განსაზღვრავს reader-ის entry point-ს და package-level table of contents-ს.

Locator indexes

canonical docs ან schema files-ის შეცვლისას ჯერ source განაახლეთ, შემდეგ ეს public snapshot და ახსნა refresh გააკეთეთ.

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 განსაზღვრავს reader-ის entry point-ს და package-level table of contents-ს.

studyPlans

Authored study plans manifest.json-ში მხოლოდ მაშინ ინახება, როცა package შეიცავს schedule data-ს.

bindings

canonical docs ან schema files-ის შეცვლისას ჯერ source განაახლეთ, შემდეგ ეს public snapshot და ახსნა refresh გააკეთეთ.

Package creation

Production tooling საჯარო 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

    გაზიარებამდე შემოწმება

    distribution-მდე შეამოწმეთ package structure და schema compatibility.

Reader import

BookField installed package-ს ადგილობრივად კითხულობს

  1. 1

    Validate

    BookField ამოწმებს package shape-ს და reject-ს უკეთებს unsupported ან malformed packages-ს.

  2. 2

    Unpack

    Supported package assets იხსნება app-owned local storage-ში.

  3. 3

    SQLite-ში import

    ReaderDoc payloads, navigation, locator indexes, search records და schedules რეგისტრირდება offline use-სთვის.

Compatibility

Rules, რომლებიც packages-ს პროგნოზირებადს ხდის

  • 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 არის 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-ის შეცვლისას ჯერ source განაახლეთ, შემდეგ ეს public snapshot და ახსნა refresh გააკეთეთ.

BookField package distribution დაგეგმეთ

დაბრუნდით product overview-ზე ან განიხილეთ, შეესაბამება თუ არა wbpkg distribution flow თქვენს content model-ს.

BookField-ზე დაბრუნება Content distribution-ის განხილვა