postext.dev

{
  "type": "object",
  "properties": {
    "viewer": {
      "type": "string",
      "enum": [
        "canvas",
        "pdf",
        "folio",
        "html",
        "epub",
        "scorm"
      ],
      "description": "The viewer tab to show."
    },
    "mode": {
      "type": "string",
      "enum": [
        "content",
        "design"
      ],
      "description": "content: the text is edited (the editor, the frames of composed pages on the page); design: page templates and styles are edited and the text is read only. The person switches with Alt+Shift+M."
    },
    "panel": {
      "type": "string",
      "enum": [
        "projects",
        "chapters",
        "markdown",
        "resources",
        "fonts",
        "config",
        "warnings",
        "none"
      ],
      "description": "The side panel to open (projects = Books, markdown = Text, config = Design, warnings = Checks), or none to close it."
    },
    "sidebarWidth": {
      "type": "number",
      "minimum": 5,
      "maximum": 80,
      "description": "Width of the side panel, as a percentage of the window."
    },
    "settingsGroup": {
      "type": "string",
      "enum": [
        "page",
        "writing",
        "colors",
        "text",
        "headings",
        "lists",
        "figures",
        "callouts",
        "exercises",
        "comics",
        "running",
        "parts",
        "output",
        "folio",
        "advanced"
      ],
      "description": "Open the Design panel on this group of settings."
    },
    "settingsHelp": {
      "type": "boolean",
      "description": "Design panel: show the explanation under each setting. Kept for the next time the panel opens."
    },
    "settingsChangedOnly": {
      "type": "boolean",
      "description": "Design panel: list only the settings the book changed. Turning it on opens the panel; the filter goes when the panel closes."
    },
    "resource": {
      "type": [
        "string",
        "null"
      ],
      "description": "Open the Resources panel on the resource with this id; null closes the resource that is open and goes back to the list."
    },
    "scope": {
      "type": "string",
      "enum": [
        "chapter",
        "book"
      ],
      "description": "What the viewer lays out: the chapter on screen or the whole book. Applies to the PDF when that is the viewer, to Canvas, Folio and HTML otherwise."
    },
    "epubLayout": {
      "type": "string",
      "enum": [
        "reflowable",
        "fixed"
      ],
      "description": "The EPUB rendition: text that reflows, or the printed pages kept."
    },
    "scormLayout": {
      "type": "string",
      "enum": [
        "fixed",
        "reflowable"
      ],
      "description": "The SCORM package's content: the printed pages, or text that reflows."
    },
    "scormVersion": {
      "type": "string",
      "enum": [
        "1.2",
        "2004"
      ],
      "description": "The SCORM data model of the package: 1.2 (every LMS) or 2004 4th edition."
    },
    "scormPick": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "SCORM: the ids of the tree nodes (chapters and headings, the status's contents[].href) the package takes, each one whole; every other node is left out. A chapter or section ticked whole is one SCO."
    },
    "zoom": {
      "type": "number",
      "minimum": 0.25,
      "maximum": 4,
      "description": "Canvas: magnification (1 = 100%). Turns the fit off unless fit is given too."
    },
    "fit": {
      "type": "string",
      "enum": [
        "width",
        "height",
        "none"
      ],
      "description": "Canvas: fit the page to the width or height of the viewer."
    },
    "pages": {
      "type": "string",
      "enum": [
        "single",
        "spread"
      ],
      "description": "Canvas: one page per row, or facing pages."
    },
    "fontScale": {
      "type": "number",
      "minimum": 0.6,
      "maximum": 2.5,
      "description": "HTML and reflowable EPUB: the reader's type size (1 = as designed)."
    },
    "columns": {
      "type": "string",
      "enum": [
        "single",
        "multi"
      ],
      "description": "HTML: one scrolling column, or columns paged sideways."
    },
    "interaction": {
      "type": "string",
      "enum": [
        "hand",
        "orbit",
        "select",
        "magnify"
      ],
      "description": "Folio: what the pointer does on the 3D book."
    },
    "folioView": {
      "type": "string",
      "enum": [
        "reset",
        "save"
      ],
      "description": "Folio: ease the camera back to the configured view, or keep the view on screen as the book's. The viewer has no way to set the camera to a given angle: to look from one, set folio.tilt and folio.yaw with sandbox_set_config, then reset. The status gives the view on screen."
    },
    "magnification": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 1.5,
      "maximum": 10,
      "description": "Folio: hold the magnifying glass over the middle of the open spread, magnifying this many times; null puts it away. The glass belongs to the magnify pointer mode, which the viewer is switched to."
    },
    "toolbarPinned": {
      "type": "boolean",
      "description": "Keep the viewer's floating toolbar on screen."
    },
    "printPreview": {
      "type": "boolean",
      "description": "Canvas and Folio: the soft proof of the output profile with trim, bleed and safe-zone guides."
    },
    "fitMarks": {
      "type": "string",
      "enum": [
        "all",
        "problems",
        "none",
        "book"
      ],
      "description": "Canvas: the marks of how composed frames fit — all (scaled text and pictures too), problems (frames that do not fit, unknown looks) or none. Kept as the reader's choice in this browser, over the book's debug.fitMarks (problems unless the book sets another); book forgets the choice and follows the book again. Never drawn in the PDF, HTML, EPUB or Folio."
    },
    "largeTargets": {
      "type": "boolean",
      "description": "Controls at least 44 px, for touch."
    },
    "guides": {
      "type": "object",
      "description": "Guides drawn on the pages; they are settings of the book (debug.*, page.baselineGrid, cjk.grid).",
      "properties": {
        "baselineGrid": {
          "type": "boolean"
        },
        "characterGrid": {
          "type": "boolean",
          "description": "The CJK character grid."
        },
        "looseLines": {
          "type": "boolean",
          "description": "Highlight justified lines with wide word spaces."
        },
        "looseLineThreshold": {
          "type": "number",
          "minimum": 1,
          "maximum": 5,
          "description": "How wide the spaces are, as a multiple of the normal space, before a line is highlighted."
        },
        "pageNegative": {
          "type": "boolean",
          "description": "Pages light on dark."
        },
        "cursorSync": {
          "type": "boolean",
          "description": "Show the editor's caret on the page."
        },
        "selectionSync": {
          "type": "boolean",
          "description": "Show the editor's selection on the page."
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}