חזרה ל-BookField

BookField פורמט package

wbpkg

Package ש-BookField יכול לאמת, להתקין ולקרוא

תמונת גרסאות

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 ש-BookField יכול לאמת, להתקין ולקרוא

package אחד הוא גבול התקנה יחיד עבור work אחד ו-edition אחת. manifest.json הוא ה-contract הציבורי ש-BookField קורא לפני import. Legacy packageKind ו-presentation fields אינם חלק מה-package shape הנוכחי.

מיכל ניתן להתקנה

package אחד הוא גבול התקנה יחיד עבור work אחד ו-edition אחת.

Manifest v5

manifest.json הוא ה-contract הציבורי ש-BookField קורא לפני import. Legacy packageKind ו-presentation fields אינם חלק מה-package shape הנוכחי.

ReaderDoc v3

ReaderDoc content מוכן ל-import, לכן ה-reader אינו מנתח EPUB, HTML או CSS בזמן runtime.

עץ ניווט

navigationTree קובע את ה-entry point ואת תוכן העניינים ברמת package של ה-reader.

אינדקסי locator

כאשר canonical docs או schema files משתנים, עדכנו תחילה את source ולאחר מכן רעננו את ה-public snapshot וההסבר.

תוכניות לימוד

Authored study plans נמצאים ב-manifest.json רק כאשר ה-package כולל schedule data.

מבנה package

קבצים canonical בתוך wbpkg

Package paths הם POSIX paths יחסיים לשורש ה-package. Text packages כוללים ReaderDoc files תחת reader/, וחבילות image, audio או video only יכולות להשמיט 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 הוא ה-contract הציבורי ש-BookField קורא לפני import. Legacy packageKind ו-presentation fields אינם חלק מה-package shape הנוכחי.

packageId / packageVersion

manifest.json הוא ה-contract הציבורי ש-BookField קורא לפני import. Legacy packageKind ו-presentation fields אינם חלק מה-package shape הנוכחי.

work / edition

package אחד הוא גבול התקנה יחיד עבור work אחד ו-edition אחת.

assets

Package paths הם POSIX paths יחסיים לשורש ה-package. Text packages כוללים ReaderDoc files תחת reader/, וחבילות image, audio או video only יכולות להשמיט reader/.

navigationTree

navigationTree קובע את ה-entry point ואת תוכן העניינים ברמת package של ה-reader.

studyPlans

Authored study plans נמצאים ב-manifest.json רק כאשר ה-package כולל schedule data.

bindings

כאשר canonical docs או schema files משתנים, עדכנו תחילה את source ולאחר מכן רעננו את ה-public snapshot וההסבר.

יצירת package

הפרידו production tooling מגבול ה-package הציבורי

  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

    בדיקה לפני שיתוף

    בדקו package structure ו-schema compatibility לפני distribution.

Reader import

BookField קורא את ה-installed package מקומית

  1. 1

    אימות

    BookField בודק את package shape ודוחה unsupported או malformed packages.

  2. 2

    פריקה

    Supported package assets נפרקים אל app-owned local storage.

  3. 3

    Import ל-SQLite

    ReaderDoc payloads, navigation, locator indexes, search records ו-schedules נרשמים לשימוש offline.

תאימות

כללים ששומרים על packages צפויים

  • דחו legacy packageKind values.
  • דחו legacy presentation fields.
  • דחו non-canonical package paths.
  • דחו malformed structured references.
  • אל תכללו source EPUB files בתוך installable wbpkg.

Canonical references

מדיניות עדכון

העמוד הציבורי הזה הוא implementation-facing overview, לא canonical schema source. Canonical docs ו-schema files נמצאים עם BookField source materials.

Source docs ו-schema files

  • 00-spec-index.md

    העמוד הציבורי הזה הוא implementation-facing overview, לא canonical schema source. Canonical docs ו-schema files נמצאים עם BookField source materials.

  • 04-manifest-json-schema.md

    manifest.json הוא ה-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

    העמוד הציבורי הזה הוא implementation-facing overview, לא canonical schema source. Canonical docs ו-schema files נמצאים עם BookField source materials.

כאשר canonical docs או schema files משתנים, עדכנו תחילה את source ולאחר מכן רעננו את ה-public snapshot וההסבר.

תכננו BookField package distribution

חזרו ל-product overview או דונו אם wbpkg distribution flow מתאים ל-content model שלכם.

חזרה ל-BookField דיון על content distribution