postext.dev

sandbox_get_config

The book's configuration — page size and margins, columns, body text, headings, lists, figures, running heads, notes, colours, print and so on. A book stores only what departs from the defaults: "set" is what it stores at the path, "effective" what the setting comes to with the defaults filled in (which also shows every setting that exists there). Paths look like page.margins.top, bodyText.hyphenation, headings.levels[level=2].fontSize, header.elements[id=titleOdd], calloutStyles[id=note].title; an item of a list can also be named by its position in the effective list ([0]), and the answer gives the path by what tells the item apart. Without a path: everything the book sets, and the names of the top-level sections. The settings are documented at /docs/configuration.

Page: /en/sandbox

Input schema

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The setting, or the section, to read."
    },
    "effective": {
      "type": "boolean",
      "description": "Include the value with defaults filled in (default true when a path is given)."
    },
    "scope": {
      "type": "string",
      "enum": [
        "all",
        "edition"
      ],
      "description": "A book in several languages: all reads the general settings every edition reads, edition the edition on screen (its own fields over the general ones). Default: the scope the Design panel is in."
    }
  },
  "additionalProperties": false
}