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 ചർച്ച ചെയ്യുക