postext.dev

{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "enum": [
        "pdf",
        "epub",
        "postext",
        "docx",
        "markdown",
        "config"
      ]
    },
    "scope": {
      "type": "string",
      "enum": [
        "chapter",
        "book"
      ],
      "description": "pdf, docx: the chapter on screen or the whole book (default: as the PDF tab stands; docx: book)."
    },
    "epubLayout": {
      "type": "string",
      "enum": [
        "reflowable",
        "fixed"
      ],
      "description": "epub: the rendition (default: as the EPUB tab stands)."
    },
    "chapter": {
      "type": [
        "integer",
        "string"
      ],
      "description": "markdown: the chapter (position from 1, title or id); the one on screen when left out."
    },
    "deliver": {
      "type": "string",
      "enum": [
        "download",
        "data"
      ],
      "description": "download (default) saves the file through the browser; data hands a pdf or an epub back in the result."
    },
    "book": {
      "type": "object",
      "description": "postext: another book than the one on screen, exported without opening it, as its row of the Books panel does. A sample is exported as it ships, not with the reader's edits (open it, or duplicate it, to export those).",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "sample",
            "project"
          ]
        },
        "id": {
          "type": "string",
          "description": "The id, as sandbox_list_books gives it."
        },
        "language": {
          "type": "string",
          "description": "A sample in several languages: the one to export. The one on screen when the sample is on screen, else the interface language."
        }
      },
      "required": [
        "kind",
        "id"
      ],
      "additionalProperties": false
    },
    "template": {
      "type": "string",
      "description": "docx: the id of a saved Word template (sandbox_word_templates lists them), whose mapping names the Word styles and travels in the file for the way back, or \"none\". Left out, the template last used when it is still saved, as the export dialog opens."
    }
  },
  "required": [
    "format"
  ],
  "additionalProperties": false
}