Πίσω στο BookField

BookField μορφή package

wbpkg

Package που το BookField μπορεί να validate, install και read

Στιγμιότυπο έκδοσης

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 μπορεί να validate, install και read

Ένα ενιαίο installable boundary για ένα work και μία edition. Το manifest.json είναι το δημόσιο contract που διαβάζει το BookField πριν από import. Τα legacy packageKind και presentation fields δεν ανήκουν στο τρέχον package shape.

Installable container

Ένα ενιαίο installable boundary για ένα work και μία edition.

Manifest v5

Το manifest.json είναι το δημόσιο contract που διαβάζει το BookField πριν από import. Τα legacy packageKind και presentation fields δεν ανήκουν στο τρέχον package shape.

ReaderDoc v3

ReaderDoc content είναι έτοιμο για import, ώστε ο reader να μην parse EPUB, HTML ή CSS στο runtime.

Navigation tree

navigationTree αποφασίζει το entry point και το package-level table of contents του reader.

Locator indexes

Όταν αλλάζουν canonical docs ή schema files, ενημερώστε πρώτα το source και μετά αυτό το public snapshot και την εξήγηση.

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 είναι το δημόσιο contract που διαβάζει το BookField πριν από import. Τα legacy packageKind και presentation fields δεν ανήκουν στο τρέχον package shape.

packageId / packageVersion

Το manifest.json είναι το δημόσιο contract που διαβάζει το BookField πριν από import. Τα legacy packageKind και presentation fields δεν ανήκουν στο τρέχον package shape.

work / edition

Ένα ενιαίο 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 αποφασίζει το entry point και το package-level table of contents του reader.

studyPlans

Authored study plans ζουν στο manifest.json μόνο όταν το package περιέχει schedule data.

bindings

Όταν αλλάζουν canonical docs ή schema files, ενημερώστε πρώτα το source και μετά αυτό το public snapshot και την εξήγηση.

Package creation

Κρατήστε το production tooling χωριστά από το public 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

    Έλεγχος πριν την κοινοποίηση

    Ελέγξτε package structure και schema compatibility πριν από distribution.

Reader import

Το BookField διαβάζει το installed package τοπικά

  1. 1

    Validate

    Το BookField ελέγχει package shape και απορρίπτει unsupported ή malformed packages.

  2. 2

    Unpack

    Supported package assets γίνονται unpack σε app-owned local storage.

  3. 3

    Import σε SQLite

    ReaderDoc payloads, navigation, locator indexes, search records και schedules καταχωρίζονται για offline use.

Compatibility

Rules που κρατούν τα packages προβλέψιμα

  • Απόρριψη legacy packageKind values.
  • Απόρριψη legacy presentation fields.
  • Απόρριψη non-canonical package paths.
  • Απόρριψη malformed structured references.
  • Μην συμπεριλαμβάνετε source EPUB files σε installable wbpkg.

Canonical references

Update policy

Αυτή η δημόσια σελίδα είναι 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