Reader records

work.sequential.feed.annotation

A note pinned to a point on a page, slice or strip.

main

record · key: tid

A note pinned to a point on a page, slice or strip. Anyone can write one in their own repo; AppViews decide whose annotations to show, e.g. only those from the repo that owns the subject.

Property	Type	Description
`subject`required	at-uri	AT-URI of the work.sequential.page, work.sequential.slice or work.sequential.strip being annotated. AppViews ignore annotations on any other record. Use the DID form (at://did:...), not a handle.
`x`required	integer	Horizontal position of the annotation, in ten-thousandths of the image's width (0-10000), from the left. 0–10000
`y`required	integer	Vertical position of the annotation, in ten-thousandths of the image's height (0-10000), from the top. 0–10000
`text`required	defs#localizedText[]	Localized annotation text. 1–100 items
`createdAt`required	datetime	The date and time the annotation was created.

Raw schema

work.sequential.feed.annotation.json

{
  "lexicon": 1,
  "id": "work.sequential.feed.annotation",
  "defs": {
    "main": {
      "type": "record",
      "key": "tid",
      "record": {
        "type": "object",
        "properties": {
          "subject": {
            "type": "string",
            "format": "at-uri",
            "description": "AT-URI of the work.sequential.page, work.sequential.slice or work.sequential.strip being annotated. AppViews ignore annotations on any other record. Use the DID form (at://did:...), not a handle."
          },
          "x": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000,
            "description": "Horizontal position of the annotation, in ten-thousandths of the image's width (0-10000), from the left."
          },
          "y": {
            "type": "integer",
            "minimum": 0,
            "maximum": 10000,
            "description": "Vertical position of the annotation, in ten-thousandths of the image's height (0-10000), from the top."
          },
          "text": {
            "type": "array",
            "items": {
              "type": "ref",
              "ref": "work.sequential.defs#localizedText"
            },
            "maxLength": 100,
            "minLength": 1,
            "description": "Localized annotation text."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "The date and time the annotation was created."
          }
        },
        "required": [
          "subject",
          "x",
          "y",
          "text",
          "createdAt"
        ]
      },
      "description": "A note pinned to a point on a page, slice or strip. Anyone can write one in their own repo; AppViews decide whose annotations to show, e.g. only those from the repo that owns the subject."
    }
  }
}