postext.dev

sandbox_apply_proposal

Fix a frame of a composed page with one of the fixes the layout proposes for it: the proposals of its frameOverflow, frameCovered or frameOutsideArea warning in sandbox_get_warnings, by their number there (from 1) or their kind. A frame that does not fit (frameOverflow): allowShrink lets its text shrink further (fit.minScale, and fit.shrinkText when it was off), raiseMax raises its maxHeight, lowerMin lowers the minHeight of another frame of its group, continueNextPage sets overflow.continueIn to next-page, and useTemplate sets the page with another template (the fence's template attribute in the chapter's text); shortenText changes nothing: it selects the frame's text in the Manuscript panel and answers how many characters to cut and where, for sandbox_write_text. A frame under another (frameCovered): layer paints the covering frame under it, exclude makes the covering frame push its text round it. A frame past its edge (frameOutsideArea): maxHeight holds it to the room it has, minHeight raises the frame it is anchored inside, continueNextPage lets the rest go on. move shifts the moved frame's placement.offset by the proposed millimetres (refused for a frame with no placement, or an offset in ems or percent). continueNextPage of a frame past its edge also sets the maxHeight it proposes. Both overlap checks end with allowOverlap: overlap 'allow' on the frame placed so on purpose (the covering frame of a frameCovered, the frame itself of a frameOutsideArea), which the checks then leave out. It is the one-click fix of the Checks panel and the Reflow panel, without the question they ask the reader: one step of the history that sandbox_undo takes back. A design change applies to every page set with the template. Answers what was changed and whether the check is gone, laid out again.

Page: /en/sandbox

Input schema

{
  "type": "object",
  "properties": {
    "chapter": {
      "type": [
        "integer",
        "string"
      ],
      "description": "The chapter of the page: its position in the book (from 1), its title or its id. The chapter the reader is at when left out."
    },
    "frame": {
      "type": "string",
      "description": "The frame the check is about, by its name in the template (the warning's frame)."
    },
    "check": {
      "type": "string",
      "enum": [
        "frameOverflow",
        "frameCovered",
        "frameOutsideArea"
      ],
      "description": "Which check of the frame to fix, when it has more than one (the warning's kind)."
    },
    "coveredBy": {
      "type": "string",
      "description": "For frameCovered: the covering frame, when the frame lies under more than one."
    },
    "page": {
      "type": "integer",
      "description": "The page number as printed, when the check is on more than one page of the chapter."
    },
    "proposal": {
      "type": [
        "integer",
        "string"
      ],
      "description": "The fix: its number in the warning's proposals (from 1) or its kind (allowShrink, raiseMax, lowerMin, continueNextPage, useTemplate, shortenText; layer, exclude, move; maxHeight, minHeight; allowOverlap)."
    }
  },
  "required": [
    "frame",
    "proposal"
  ],
  "additionalProperties": false
}