postext.dev

{
  "type": "object",
  "properties": {
    "chapter": {
      "type": [
        "integer",
        "string"
      ],
      "description": "The chapter: its position in the book (from 1), its title or its id. The chapter the reader is at when left out."
    },
    "page": {
      "type": "integer",
      "description": "The page number as printed on the page and shown in the viewer's page field."
    },
    "position": {
      "type": "integer",
      "minimum": 1,
      "description": "The page by its position among the chapter's pages (from 1)."
    },
    "count": {
      "type": "integer",
      "minimum": 1,
      "maximum": 6,
      "description": "How many consecutive pages, from that one (default 1, at most 6)."
    },
    "width": {
      "type": "integer",
      "minimum": 160,
      "maximum": 2400,
      "description": "Width of each picture in pixels (default 900). A crop is given at this width too, so it shows more detail."
    },
    "format": {
      "type": "string",
      "enum": [
        "jpeg",
        "png",
        "webp"
      ],
      "description": "Default jpeg."
    },
    "quality": {
      "type": "number",
      "minimum": 0.3,
      "maximum": 1,
      "description": "JPEG or WebP quality (default 0.82)."
    },
    "crop": {
      "type": "object",
      "description": "A part of the page, as fractions of its width and height from the top left corner: { x: 0, y: 0, width: 1, height: 0.5 } is the top half.",
      "properties": {
        "x": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "y": {
          "type": "number",
          "minimum": 0,
          "maximum": 1
        },
        "width": {
          "type": "number",
          "minimum": 0.02,
          "maximum": 1
        },
        "height": {
          "type": "number",
          "minimum": 0.02,
          "maximum": 1
        }
      },
      "required": [
        "x",
        "y",
        "width",
        "height"
      ],
      "additionalProperties": false
    },
    "trimmed": {
      "type": "boolean",
      "description": "Leave out the margin with the bleed and crop marks, when the layout has cut lines."
    },
    "printPreview": {
      "type": "boolean",
      "description": "Paint the soft proof of the print output profile, with the trim, bleed and safe-zone guides and the preflight marks."
    }
  },
  "additionalProperties": false
}