net.olamaelcu.livtet.biblio.readingProgress

A reader's relation to one catalog edition, published from the copy they are holding. Two shapes share this collection: a position record (one per edition and format, its rkey the edition's rkey and the format's slug, rewritten as the reader moves) and an annotation record (one per note, under a TID, rewritten when the note is edited). `createdAt` is when the record was first published — the position's first save, the note's own creation — and `updatedAt` when it last changed. Written by Livtet in the reader's own repo and indexed by the catalog.

Details · record, key any
Kindrecord
Record keyany
Authoritybiblio.livtet.olamaelcu.net
Indexed

Record

record · key any

Properties

The note this record mirrors. A record carries either a `position` or an `annotation`; the rkey is a TID, so a note's record is found through the reader's own database rather than derived.

Reference

book

requiredstring · at-uri

The catalog edition being read.

createdAt

requiredstring · datetime

When this record was first published.

format

requiredstring

The reader's format name as the app's seeded formats table spells it (`Hardcover`, `ePub`, `Audiobook`). It is the reader's own copy, not the edition's merged medium: two readers of one edition can report a print and an audio position against it.

  • minLength: 1
  • maxGraphemes: 40

The product identifier this position's `total` came from; absent when the total came from the edition record.

Reference

The reading position. Present on a position record, absent on an annotation record.

Reference

updatedAt

requiredstring · datetime

When the reader last moved to this position, or last edited this note.

#annotation

object

One note taken while reading, mirrored from the reader's own database. `id` is the note's id there, so an edit rewrites the same record instead of appending one.

Properties

color

string

The highlight colour, as the reader's app spells it.

  • maxLength: 32

id

requiredstring

The note's id in the reader's database.

  • maxLength: 128

locator

string

Where in the copy the note sits: a printed page, a chapter, a CFI.

  • maxLength: 512

pageNumber

integer
  • minimum: 1

quote

string

The passage the note is attached to.

  • maxGraphemes: 2000

text

requiredstring
  • maxGraphemes: 10000

#identifier

object

The catalog identifier a total belongs to, such as the print ISBN-13 whose page count `position.total` holds. The edition record's own page count and duration are separate rank winners over these claims, so without this a consumer cannot tell which product a total describes.

Properties

issuer

requiredstring

The identifier's issuing scheme, as the catalog spells it (`isbn13`, `isbn10`, `asin`).

value

requiredstring

The identifier value as issued.

#position

object

The position, on the unit's own scale. `per_mille` is tenths of a percent (0–1000); `page` and `virtual_page` are counts; `timestamp` is seconds; `chapter` is the whole chapter number, with any fraction in `locator`; `cfi` is not a scale, so the CFI rides in `locator` and `value` is 0.

Properties

locator

string

The precise position the integer rounds off: an EPUB CFI, a printed page label, or a clock time.

  • maxLength: 512

total

integer

The whole in the same unit: a page count (`identifier`'s claim), a chapter count (the edition's), or a duration in seconds (the audio claim's). Absent when no extent is known.

  • minimum: 1

unit

requiredstring
  • knownValues: per_mille | page | virtual_page | timestamp | chapter | cfi

value

requiredinteger

The position in `unit`. Only `per_mille` has a fixed range (0–1000).

  • minimum: 0

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Reading progress for one book, written to the reader's own repo. One record per (reader, publication) by convention: clients list their own repo and update the existing record for a publication rather than create a second (the BookHive shelf pattern). The publication AT-URI makes records discoverable by backlink index (Microcosm/Constellation), so 'who is reading this book' needs no app-side database. Positions anchor documents by strongRef: the cid pins the chunk *as read*, so a later edit to a

  • Where the reader stands with a Work. One per Work: the record key is the Work's Catalog identifier. Exists with or without a Copy. No record means unread.

  • A reader's reading of a book BookHive's catalogue doesn't hold, or can't be matched to for certain: the home of last resort, so any book can be added to a library and reviewed. One per book. Status, dates, rating, review and progress live here as they do on a buzz.bookhive.book; the book is named in every key anyone uses, so any app that recognises one of them can show the reading. When BookHive's catalogue has the book, Resenha moves the reading there: it writes a buzz.bookhive.book with everyt

  • One book on a reading list, stored in the owner's repo inside the list's space.

  • A reading-state record for one edition per actor. Duplicate convention: the rkey is a TID minted once at first create and never changes. Several records may exist for one actor and edition (for example from out-of-band writers); consumers SHOULD treat the record with the greatest `updatedAt` (falling back to `createdAt`) as the winner and break ties by the lowest TID, ignoring the others. This is a convention, not an enforced contract: AppViews MUST tolerate a differing winner, and may see a rec