MS Word Options

MS Word is the word processor included with Microsoft Office. Word uses the OpenXML document format, which you can learn more about at https://en.wikipedia.org/wiki/Office_Open_XML.

See the MS Word format user guide for more details on creating MS Word output with Quarto.

format: docx

Title & Author

`title`	Document title
`subtitle`	Identifies the subtitle of the document.
`date`	Document date
`author`	Author or authors of the document
`abstract`	Summary of document
`abstract-title`	Title used to label document abstract
`order`	Order for document when included in a website automatic sidebar menu.

Format Options

reference-doc

Use the specified file as a style reference in producing a docx, pptx, or odt file.

brand

Branding information to use for this document. If a string, the path to a brand file. If false, don’t use branding on this document. If an object, an inline brand definition.

quarto-required

A semver version range describing the supported quarto versions for this document or project.

Examples:

>= 1.1.0: Require at least quarto version 1.1
1.*: Require any quarto versions whose major version number is 1

toc

Include an automatically generated table of contents (or, in the case of latex, context, docx, odt, opendocument, rst, or ms, an instruction to create one) in the output document.

Note that if you are producing a PDF via ms, the table of contents will appear at the beginning of the document, before the title. If you would prefer it to be at the end of the document, use the option pdf-engine-opt: --no-toc-relocation.

toc-depth

Specify the number of section levels to include in the table of contents. The default is 3

toc-title

The title used for the table of contents.

Numbering

`number-sections`	Number section headings rendered output. By default, sections are not numbered. Sections with class `.unnumbered` will never be numbered, even if `number-sections` is specified.
`number-depth`	By default, all headings in your document create a numbered section. You customize numbering depth using the `number-depth` option. For example, to only number sections immediately below the chapter level, use this: `number-depth: 1`
`number-offset`	Offset for section headings in output (offsets are 0 by default) The first number is added to the section number for top-level headings, the second for second-level headings, and so on. So, for example, if you want the first top-level heading in your document to be numbered “6”, specify `number-offset: 5`. If your document starts with a level-2 heading which you want to be numbered “1.5”, specify `number-offset: [1,4]`. Implies `number-sections`
`shift-heading-level-by`	Shift heading levels by a positive or negative integer. For example, with `shift-heading-level-by: -1`, level 2 headings become level 1 headings, and level 3 headings become level 2 headings. Headings cannot have a level less than 1, so a heading that would be shifted below level 1 becomes a regular paragraph. Exception: with a shift of -N, a level-N heading at the beginning of the document replaces the metadata title.

Layout

`page-width`	Target body page width for output (used to compute columns widths for `layout` divs). Defaults to 6.5 inches, which corresponds to default letter page settings in docx and odt (8.5 inches with 1 inch for each margins).
`grid`	Properties of the grid system used to layout Quarto HTML pages.

Code

`code-annotations`	The style to use when displaying code annotations. Set this value to false to hide code annotations.
`highlight-style`	Specifies the coloring style to be used in highlighted source code. Instead of a STYLE name, a JSON file with extension `.theme` may be supplied. This will be parsed as a KDE syntax highlighting theme and (if valid) used as the highlighting style.
`syntax-definitions`	KDE language syntax definition files (XML)
`indented-code-classes`	Specify classes to use for all indented code blocks

Execution

Execution options should be specified within the execute key. For example:

execute:
  echo: false
  warning: false

`eval`	Evaluate code cells (if `false` just echos the code into output). `true` (default): evaluate code cell `false`: don’t evaluate code cell `[...]`: A list of positive or negative line numbers to selectively include or exclude lines (explicit inclusion/excusion of lines is available only when using the knitr engine)
`echo`	Include cell source code in rendered output. `true` (default in most formats): include source code in output `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output `fenced`: in addition to echoing, include the cell delimiter as part of the output. `[...]`: A list of positive or negative line numbers to selectively include or exclude lines (explicit inclusion/excusion of lines is available only when using the knitr engine)
`output`	Include the results of executing the code in the output. Possible values: `true`: Include results. `false`: Do not include results. `asis`: Treat output as raw markdown with no enclosing containers.
`warning`	Include warnings in rendered output.
`error`	Include errors in the output (note that this implies that errors executing code will not halt processing of the document).
`include`	Catch all for preventing any output (code or results) from being included in output.
`cache`	Cache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents). Note that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined). `true`: Cache results `false`: Do not cache results `refresh`: Force a refresh of the cache even if has not been otherwise invalidated.
`freeze`	Control the re-use of previous computational output when rendering. `true`: Never recompute previously generated computational output during a global project render `false` (default): Recompute previously generated computational output `auto`: Re-compute previously generated computational output only in case their source file changes

Figures

`fig-align`	Figure horizontal alignment (`default`, `left`, `right`, or `center`)
`fig-width`	Default width for figures generated by Matplotlib or R graphics. Note that with the Jupyter engine, this option has no effect when provided at the cell level; it can only be provided with document or project metadata.
`fig-height`	Default height for figures generated by Matplotlib or R graphics. Note that with the Jupyter engine, this option has no effect when provided at the cell level; it can only be provided with document or project metadata.
`fig-format`	Default format for figures generated by Matplotlib or R graphics (`retina`, `png`, `jpeg`, `svg`, or `pdf`)
`fig-dpi`	Default DPI for figures generated by Matplotlib or R graphics. Note that with the Jupyter engine, this option has no effect when provided at the cell level; it can only be provided with document or project metadata.
`fig-asp`	The aspect ratio of the plot, i.e., the ratio of height/width. When `fig-asp` is specified, the height of a plot (the option `fig-height`) is calculated from `fig-width * fig-asp`. The `fig-asp` option is only available within the knitr engine.

Tables

df-print

Method used to print tables in Knitr engine documents:

default: Use the default S3 method for the data frame.
kable: Markdown table using the knitr::kable() function.
tibble: Plain text table using the tibble package.
paged: HTML table with paging for row and column overflow.

The default printing method is kable.

References

`bibliography`	Document bibliography (BibTeX or CSL). May be a single file or a list of files
`csl`	Citation Style Language file to use for formatting references.
`citeproc`	Turn on built-in citation processing. To use this feature, you will need to have a document containing citations and a source of bibliographic data: either an external bibliography file or a list of `references` in the document’s YAML metadata. You can optionally also include a `csl` citation style file.
`citation-abbreviations`	JSON file containing abbreviations of journals that should be used in formatted bibliographies when `form="short"` is specified. The format of the file can be illustrated with an example: `{ "default": { "container-title": { "Lloyd's Law Reports": "Lloyd's Rep", "Estates Gazette": "EG", "Scots Law Times": "SLT" } } }`
`link-citations`	If true, citations will be hyperlinked to the corresponding bibliography entries (for author-date and numerical styles only). Defaults to false.
`link-bibliography`	If true, DOIs, PMCIDs, PMID, and URLs in bibliographies will be rendered as hyperlinks. (If an entry contains a DOI, PMCID, PMID, or URL, but none of these fields are rendered by the style, then the title, or in the absence of a title the whole entry, will be hyperlinked.) Defaults to true.
`notes-after-punctuation`	If true (the default for note styles), Quarto (via Pandoc) will put footnote references or superscripted numerical citations after following punctuation. For example, if the source contains `blah blah [@jones99]`., the result will look like `blah blah.[^1]`, with the note moved after the period and the space collapsed. If false, the space will still be collapsed, but the footnote will not be moved after the punctuation. The option may also be used in numerical styles that use superscripts for citation numbers (but for these styles the default is not to move the citation).

Cross-References

crossref

Configuration for cross-reference labels and prefixes. See Cross-Reference Options for more details.

Citation

citation

Citation information for the document itself specified as CSL YAML in the document front matter.

For more on supported options, see Citation Metadata.

Language

lang

Identifies the main language of the document using IETF language tags (following the BCP 47 standard), such as en or en-GB. The Language subtag lookup tool can look up or verify these tags.

This affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.

language

YAML file containing custom language translations

dir

The base script direction for the document (rtl or ltr).

For bidirectional documents, native pandoc spans and divs with the dir attribute can be used to override the base direction in some output formats. This may not always be necessary if the final renderer (e.g. the browser, when generating HTML) supports the [Unicode Bidirectional Algorithm].

When using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).

Includes

metadata-files

Read metadata from the supplied YAML (or JSON) files. This option can be used with every input format, but string scalars in the YAML file will always be parsed as Markdown. Generally, the input will be handled the same as in YAML metadata blocks. Values in files specified later in the list will be preferred over those specified earlier. Metadata values specified inside the document, or by using -M, overwrite values specified with this option.

Metadata

`keywords`	List of keywords to be included in the document metadata.
`subject`	The document subject
`description`	The document description. Some applications show this as `Comments` metadata.
`category`	The document category.

Rendering

`from`	Format to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).
`output-file`	Output file to write to
`output-ext`	Extension to use for generated output file
`filters`	Specify executables or Lua scripts to be used as a filter transforming the pandoc AST after the input is parsed and before the output is written.
`shortcodes`	Specify Lua scripts that implement shortcode handlers
`keep-md`	Keep the markdown file generated by executing code
`keep-ipynb`	Keep the notebook file generated from executing code.
`ipynb-filters`	Filters to pre-process ipynb files before rendering to markdown
`ipynb-shell-interactivity`	Specify which nodes should be run interactively (displaying output from expressions)
`plotly-connected`	If true, use the “notebook_connected” plotly renderer, which downloads its dependencies from a CDN and requires an internet connection to view.
`extract-media`	Extract images and other media contained in or linked from the source document to the path DIR, creating it if necessary, and adjust the images references in the document so they point to the extracted files. Media are downloaded, read from the file system, or extracted from a binary container (e.g. docx), as needed. The original file paths are used if they are relative paths not containing … Otherwise filenames are constructed from the SHA1 hash of the contents.
`resource-path`	List of paths to search for images and other resources.
`default-image-extension`	Specify a default extension to use when image paths/URLs have no extension. This allows you to use the same source for formats that require different kinds of images. Currently this option only affects the Markdown and LaTeX readers.
`abbreviations`	Specifies a custom abbreviations file, with abbreviations one to a line. This list is used when reading Markdown input: strings found in this list will be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX. The strings may not contain spaces.
`dpi`	Specify the default dpi (dots per inch) value for conversion from pixels to inch/ centimeters and vice versa. (Technically, the correct term would be ppi: pixels per inch.) The default is `96`. When images contain information about dpi internally, the encoded value is used instead of the default specified by this option.
`html-table-processing`	If `none`, do not process tables in HTML input.