work.sequential.defs Documentation (EN)

aspectRatio object

No description available.

Properties

height integer Required

No description available.

minimum: 1

width integer Required

No description available.

minimum: 1

View raw schema

{
  "properties": {
    "height": {
      "minimum": 1,
      "type": "integer"
    },
    "width": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "width",
    "height"
  ],
  "type": "object"
}

bounds object

A rectangle relative to an image, in ten-thousandths of the image's width and height (0-10000), with the origin at the top left.

Properties

height integer Required

No description available.

minimum: 1maximum: 10000

width integer Required

No description available.

minimum: 1maximum: 10000

x integer Required

No description available.

minimum: 0maximum: 10000

y integer Required

No description available.

minimum: 0maximum: 10000

View raw schema

{
  "description": "A rectangle relative to an image, in ten-thousandths of the image's width and height (0-10000), with the origin at the top left.",
  "properties": {
    "height": {
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "width": {
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "x": {
      "maximum": 10000,
      "minimum": 0,
      "type": "integer"
    },
    "y": {
      "maximum": 10000,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "x",
    "y",
    "width",
    "height"
  ],
  "type": "object"
}

category string

A category for a series. AppViews may define their own categories.

ConstraintsmaxLength: 640 bytes, maxGraphemes: 64 graphemes

View raw schema

{
  "description": "A category for a series. AppViews may define their own categories.",
  "maxGraphemes": 64,
  "maxLength": 640,
  "type": "string"
}

credit object

No description available.

Properties

did string did Optional

A decentralized identifier (DID).

displayName string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

role string Required

The role of the credit. AppViews may define their own roles.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

Known values: writer, penciler, inker, colorist, flats, letterer, cover, creator, editor, editorInChief, associateEditor, assistantEditor, designer, artist, translator, painter, backgrounds

View raw schema

{
  "properties": {
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "maxGraphemes": 100,
      "maxLength": 1000,
      "type": "string"
    },
    "role": {
      "description": "The role of the credit. AppViews may define their own roles.",
      "knownValues": [
        "writer",
        "penciler",
        "inker",
        "colorist",
        "flats",
        "letterer",
        "cover",
        "creator",
        "editor",
        "editorInChief",
        "associateEditor",
        "assistantEditor",
        "designer",
        "artist",
        "translator",
        "painter",
        "backgrounds"
      ],
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    }
  },
  "required": [
    "displayName",
    "role"
  ],
  "type": "object"
}

localizedAlt object

Localized alt text. Describes the art and transcribes the dialogue, captions and sound effects.

Properties

lang string language Required

BCP-47 language tag for this text.

text string Required

No description available.

maxLength: 100000 bytesmaxGraphemes: 10000 graphemes

View raw schema

{
  "description": "Localized alt text. Describes the art and transcribes the dialogue, captions and sound effects.",
  "properties": {
    "lang": {
      "description": "BCP-47 language tag for this text.",
      "format": "language",
      "type": "string"
    },
    "text": {
      "maxGraphemes": 10000,
      "maxLength": 100000,
      "type": "string"
    }
  },
  "required": [
    "lang",
    "text"
  ],
  "type": "object"
}

localizedDescription object

No description available.

Properties

lang string language Required

BCP-47 language tag for this description.

text string Required

No description available.

maxLength: 30000 bytesmaxGraphemes: 3000 graphemes

View raw schema

{
  "properties": {
    "lang": {
      "description": "BCP-47 language tag for this description.",
      "format": "language",
      "type": "string"
    },
    "text": {
      "maxGraphemes": 3000,
      "maxLength": 30000,
      "type": "string"
    }
  },
  "required": [
    "lang",
    "text"
  ],
  "type": "object"
}

localizedImage object

No description available.

Properties

image blob Required

The localized image.

maxSize: 4.2 MB

lang string language Required

BCP-47 language tag for this image (e.g. 'en', 'pt-BR').

View raw schema

{
  "properties": {
    "image": {
      "accept": [
        "image/jpeg",
        "image/png",
        "image/webp",
        "image/avif"
      ],
      "description": "The localized image.",
      "maxSize": 4194304,
      "type": "blob"
    },
    "lang": {
      "description": "BCP-47 language tag for this image (e.g. 'en', 'pt-BR').",
      "format": "language",
      "type": "string"
    }
  },
  "required": [
    "image",
    "lang"
  ],
  "type": "object"
}

localizedTitle object

No description available.

Properties

lang string language Required

BCP-47 language tag for this title.

text string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

View raw schema

{
  "properties": {
    "lang": {
      "description": "BCP-47 language tag for this title.",
      "format": "language",
      "type": "string"
    },
    "text": {
      "maxGraphemes": 100,
      "maxLength": 1000,
      "type": "string"
    }
  },
  "required": [
    "lang",
    "text"
  ],
  "type": "object"
}

panel object

A panel on a page or strip. Carries the image's alt text, one description per panel, and optionally its position for panel-by-panel reading. A splash page or single-panel strip is a single panel.

Properties

alt array of refwork.sequential.defs#localizedAlt Optional

Localized alt text for this panel: describes the art and transcribes the dialogue, captions and sound effects.

maxLength: 100 items

background ref #rgba Optional

When reading panel-by-panel, fills the viewport around the panel if the panel's aspect ratio differs from the viewport's. The alpha is the opacity: 0 shows the panel with the surrounding page still visible, 100 hides the page behind a solid color so the panel stands on its own. Treated as fully transparent when omitted.

bounds ref #bounds Optional

Where the panel sits on the image. Optional, so alt text can be added without mapping panel positions.

mask blob Optional

Black and white mask of the panel's exact shape, for panels that aren't rectangles or whose art bleeds past the panel border. Covers the panel's bounds, at the same size or aspect ratio, so the bounds must enclose everything the mask shows. Ignored when bounds are omitted. White shows the art, black hides it, and grays blend for soft edges.

maxSize: 4.2 MB

transition string Optional

When reading panel-by-panel, how the app moves to this panel from the previous one. Played in reverse when reading backward. 'none' switches instantly, 'pan' moves the view across the image to the panel, 'fade' crossfades from the previous panel, and 'zoom' pulls back to show the whole image then pushes in to the panel. Duration is up to the AppView. AppViews treat unknown values as 'none'.

Known values: none, pan, fade, zoom

View raw schema

{
"description": "A panel on a page or strip. Carries the image's alt text, one description per panel, and optionally its position for panel-by-panel reading. A splash page or single-panel strip is a single panel.",
"properties": {
"alt": {
"description": "Localized alt text for this panel: describes the art and transcribes the dialogue, captions and sound effects.",
"items": {
"ref": "work.sequential.defs#localizedAlt",
"type": "ref"
},
"maxLength": 100,
"type": "array"
},
"background": {
"description": "When reading panel-by-panel, fills the viewport around the panel if the panel's aspect ratio differs from the viewport's. The alpha is the opacity: 0 shows the panel with the surrounding page still visible, 100 hides the page behind a solid color so the panel stands on its own. Treated as fully transparent when omitted.",
"ref": "#rgba",
"type": "ref"
},
"bounds": {
"description": "Where the panel sits on the image. Optional, so alt text can be added without mapping panel positions.",
"ref": "#bounds",
"type": "ref"
},
"mask": {
"accept": [
"image/png"
],
"description": "Black and white mask of the panel's exact shape, for panels that aren't rectangles or whose art bleeds past the panel border. Covers the panel's bounds, at the same size or aspect ratio, so the bounds must enclose everything the mask shows. Ignored when bounds are omitted. White shows the art, black hides it, and grays blend for soft edges.",
"maxSize": 4194304,
"type": "blob"
},
"transition": {
"default": "none",
"description": "When reading panel-by-panel, how the app moves to this panel from the previous one. Played in reverse when reading backward. 'none' switches instantly, 'pan' moves the view across the image to the panel, 'fade' crossfades from the previous panel, and 'zoom' pulls back to show the whole image then pushes in to the panel. Duration is up to the AppView. AppViews treat unknown values as 'none'.",
"knownValues": [
"none",
"pan",
"fade",
"zoom"
],
"type": "string"
}
},
"type": "object"
}

rgba object

A color with opacity.

Properties

a integer Required

Opacity, from 0 (fully transparent) to 100 (fully opaque).

minimum: 0maximum: 100

b integer Required

No description available.

minimum: 0maximum: 255

g integer Required

No description available.

minimum: 0maximum: 255

r integer Required

No description available.

minimum: 0maximum: 255

View raw schema

{
  "description": "A color with opacity.",
  "properties": {
    "a": {
      "description": "Opacity, from 0 (fully transparent) to 100 (fully opaque).",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "b": {
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    },
    "g": {
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    },
    "r": {
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "r",
    "g",
    "b",
    "a"
  ],
  "type": "object"
}

tag string

A free-form tag, without a leading '#'.

ConstraintsmaxLength: 640 bytes, maxGraphemes: 64 graphemes

View raw schema

{
  "description": "A free-form tag, without a leading '#'.",
  "maxGraphemes": 64,
  "maxLength": 640,
  "type": "string"
}

version object

Another version of the same artwork, such as a production stage (pencils, inks) or an alternate treatment (virgin, black and white).

Properties

image blob Required

The version image.

maxSize: 4.2 MB

kind string Required

What this version shows. AppViews may define their own kinds.

maxLength: 640 bytesmaxGraphemes: 64 graphemes

Known values: thumbnails, layout, roughs, pencils, lineart, inks, flats, colors, letters

View raw schema

{
  "description": "Another version of the same artwork, such as a production stage (pencils, inks) or an alternate treatment (virgin, black and white).",
  "properties": {
    "image": {
      "accept": [
        "image/jpeg",
        "image/png",
        "image/webp",
        "image/avif"
      ],
      "description": "The version image.",
      "maxSize": 4194304,
      "type": "blob"
    },
    "kind": {
      "description": "What this version shows. AppViews may define their own kinds.",
      "knownValues": [
        "thumbnails",
        "layout",
        "roughs",
        "pencils",
        "lineart",
        "inks",
        "flats",
        "colors",
        "letters"
      ],
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    }
  },
  "required": [
    "image",
    "kind"
  ],
  "type": "object"
}