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 ஐ locally படிக்கிறது

  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 ஐ locally படிக்கிறது

  • 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 பற்றி பேசவும்