Path: blob/main/src/resources/schema/document-hidden.yml
12921 views
- name: to1alias: writer2schema: string3default: html4hidden: true5description:6short: "Format to write to (e.g. html)"7long: |8Format to write to. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. gfm+footnotes)910- name: input-file11schema: path12hidden: true13description: "Input file to read from"1415- name: input-files16schema:17arrayOf: path18hidden: true19description: "Input files to read from"2021- name: defaults22schema:23arrayOf: path24hidden: true25description: "Include options from the specified defaults files"2627- name: variables28schema: object29hidden: true30description: "Pandoc metadata variables"3132- name: metadata33schema: object34hidden: true35description: "Pandoc metadata variables"3637- name: request-headers38schema:39ref: pandoc-format-request-headers40hidden: true41description: "Headers to include with HTTP requests by Pandoc"4243- name: trace44schema: boolean45default: false46description: "Display trace debug output."4748- name: fail-if-warnings49schema: boolean50default: false51description: "Exit with error status if there are any warnings."5253- name: dump-args54schema: boolean55default: false56hidden: true57description: "Print information about command-line arguments to *stdout*, then exit."5859- name: ignore-args60schema: boolean61default: false62hidden: true63description: "Ignore command-line arguments (for use in wrapper scripts)."6465- name: file-scope66schema: boolean67hidden: true68default: false69description: "Parse each file individually before combining for multifile documents."7071- name: data-dir72schema: path73hidden: true74description: "Specify the user data directory to search for pandoc data files."7576- name: verbosity77schema:78enum: [ERROR, WARNING, INFO]79default: WARNING80hidden: true81description: "Level of program output (`INFO`, `ERROR`, or `WARNING`)"8283- name: log-file84hidden: true85schema: path86description: "Write log messages in machine-readable JSON format to FILE."8788- name: track-changes89tags:90formats: [docx]91hidden: true92schema:93enum: [accept, reject, all]94default: accept95description:96short: |97Specify what to do with insertions, deletions, and comments produced by98the MS Word “Track Changes” feature.99long: |100Specify what to do with insertions, deletions, and comments101produced by the MS Word "Track Changes" feature.102103- `accept` (default): Process all insertions and deletions.104- `reject`: Ignore them.105- `all`: Include all insertions, deletions, and comments, wrapped106in spans with `insertion`, `deletion`, `comment-start`, and107`comment-end` classes, respectively. The author and time of108change is included.109110Notes:111112- Both `accept` and `reject` ignore comments.113114- `all` is useful for scripting: only115accepting changes from a certain reviewer, say, or before a116certain date. If a paragraph is inserted or deleted,117`track-changes: all` produces a span with the class118`paragraph-insertion`/`paragraph-deletion` before the119affected paragraph break.120121- This option only affects the docx reader.122123- name: keep-source124tags:125formats: [$html-doc]126schema: boolean127default: false128hidden: true129description:130short: "Embed the input file source code in the generated HTML"131long: |132Embed the input file source code in the generated HTML. A hidden div with133class `quarto-embedded-source-code` will be added to the document. This134option is not normally used directly but rather in the implementation135of the `code-tools` option.136137- name: keep-hidden138tags:139formats: [$html-doc]140schema: boolean141default: false142hidden: true143description: "Keep hidden source code and output (marked with class `.hidden`)"144145- name: prefer-html146tags:147formats: [$markdown-all]148schema: boolean149default: false150hidden: true151description:152short: "Generate HTML output (if necessary) even when targeting markdown."153long: |154Generate HTML output (if necessary) even when targeting markdown. Enables the155embedding of more sophisticated output (e.g. Jupyter widgets) in markdown.156157- name: output-divs158schema: boolean159default: true160hidden: true161description: |162Indicates that computational output should not be written within divs.163This is necessary for some formats (e.g. `pptx`) to properly layout164figures.165166- name: merge-includes167schema: boolean168default: true169hidden: true170description: |171Disable merging of string based and file based includes (some formats,172specifically ePub, do not correctly handle this merging)173174175