العودة إلى 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 حد تثبيت واحدا لعمل واحد وإصدار واحد. manifest.json هو contract العام الذي يقرأه BookField قبل import. لا تنتمي legacy packageKind و presentation fields إلى package shape الحالية.

حاوية قابلة للتثبيت

يمثل package حد تثبيت واحدا لعمل واحد وإصدار واحد.

Manifest v5

manifest.json هو contract العام الذي يقرأه BookField قبل import. لا تنتمي legacy packageKind و presentation fields إلى package shape الحالية.

ReaderDoc v3

ReaderDoc content معد للاستيراد، لذلك لا يفسر reader ملفات EPUB أو HTML أو CSS وقت التشغيل.

شجرة التنقل

navigationTree يحدد entry point وجدول محتويات reader على مستوى package.

فهارس 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 حد تثبيت واحدا لعمل واحد وإصدار واحد.

assets

Package paths هي POSIX paths نسبية إلى جذر package. تحتوي text packages على ReaderDoc files تحت reader/، ويمكن لحزم image أو audio أو video only حذف reader/.

navigationTree

navigationTree يحدد entry point وجدول محتويات reader على مستوى package.

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

    استيراد إلى 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

ارجع إلى product overview أو ناقش ما إذا كان wbpkg distribution flow يناسب content model لديك.

العودة إلى BookField مناقشة content distribution