work.sequential.chapter

sequential.work

Documentation

A chapter in a series.

main record

A chapter in a series.

Record Key tid Timestamp-based ID

Properties

covers array of string at-uri Required

Ordered list of work.sequential.cover records. The first is the primary cover; the rest are variants. Use the DID form (at://did:...), not a handle.

maxLength: 500 itemsminLength: 1 items
createdAt string datetime Required

The date and time the chapter was published. Drafts are kept by the AppView and only written to the repo when published.

credits array of ref work.sequential.defs#credit Optional

The credits for the people who worked on this chapter.

maxLength: 100 items
pages array of string at-uri Optional

Ordered list of work.sequential.page records. Used when the series format is 'page'. Use the DID form (at://did:...), not a handle.

maxLength: 1000 items
series string at-uri Required

AT-URI of the parent series. Use the DID form (at://did:...), not a handle.

slices array of string at-uri Optional

Ordered list of work.sequential.slice records. Used when the series format is 'vertical'. Use the DID form (at://did:...), not a handle.

maxLength: 1000 items
status string Optional

Publication status of the chapter. Use 'ongoing' while it is still being published, e.g. one page at a time. AppViews may define their own statuses.

Known values: ongoing, completed, hiatus, cancelled
Default: completed
View raw schema 
{
  "description": "A chapter in a series.",
  "key": "tid",
  "record": {
    "properties": {
      "covers": {
        "description": "Ordered list of work.sequential.cover records. The first is the primary cover; the rest are variants. Use the DID form (at://did:...), not a handle.",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 500,
        "minLength": 1,
        "type": "array"
      },
      "createdAt": {
        "description": "The date and time the chapter was published. Drafts are kept by the AppView and only written to the repo when published.",
        "format": "datetime",
        "type": "string"
      },
      "credits": {
        "description": "The credits for the people who worked on this chapter.",
        "items": {
          "ref": "work.sequential.defs#credit",
          "type": "ref"
        },
        "maxLength": 100,
        "type": "array"
      },
      "description": {
        "description": "Localized short description of the chapter.",
        "items": {
          "ref": "work.sequential.defs#localizedDescription",
          "type": "ref"
        },
        "maxLength": 100,
        "type": "array"
      },
      "pages": {
        "description": "Ordered list of work.sequential.page records. Used when the series format is 'page'. Use the DID form (at://did:...), not a handle.",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 1000,
        "type": "array"
      },
      "series": {
        "description": "AT-URI of the parent series. Use the DID form (at://did:...), not a handle.",
        "format": "at-uri",
        "type": "string"
      },
      "slices": {
        "description": "Ordered list of work.sequential.slice records. Used when the series format is 'vertical'. Use the DID form (at://did:...), not a handle.",
        "items": {
          "format": "at-uri",
          "type": "string"
        },
        "maxLength": 1000,
        "type": "array"
      },
      "status": {
        "default": "completed",
        "description": "Publication status of the chapter. Use 'ongoing' while it is still being published, e.g. one page at a time. AppViews may define their own statuses.",
        "knownValues": [
          "ongoing",
          "completed",
          "hiatus",
          "cancelled"
        ],
        "type": "string"
      },
      "tags": {
        "description": "Free-form tags for this chapter.",
        "items": {
          "ref": "work.sequential.defs#tag",
          "type": "ref"
        },
        "maxLength": 10,
        "type": "array"
      },
      "title": {
        "description": "Localized chapter title or number.",
        "items": {
          "ref": "work.sequential.defs#localizedTitle",
          "type": "ref"
        },
        "maxLength": 100,
        "type": "array"
      }
    },
    "required": [
      "series",
      "createdAt",
      "covers"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@