{ // 获取包含Hugging Face文本的span元素 const spans = link.querySelectorAll('span.whitespace-nowrap, span.hidden.whitespace-nowrap'); spans.forEach(span => { if (span.textContent && span.textContent.trim().match(/Hugging\s*Face/i)) { span.textContent = 'AI快站'; } }); }); // 替换logo图片的alt属性 document.querySelectorAll('img[alt*="Hugging"], img[alt*="Face"]').forEach(img => { if (img.alt.match(/Hugging\s*Face/i)) { img.alt = 'AI快站 logo'; } }); } // 替换导航栏中的链接 function replaceNavigationLinks() { // 已替换标记，防止重复运行 if (window._navLinksReplaced) { return; } // 已经替换过的链接集合，防止重复替换 const replacedLinks = new Set(); // 只在导航栏区域查找和替换链接 const headerArea = document.querySelector('header') || document.querySelector('nav'); if (!headerArea) { return; } // 在导航区域内查找链接 const navLinks = headerArea.querySelectorAll('a'); navLinks.forEach(link => { // 如果已经替换过，跳过 if (replacedLinks.has(link)) return; const linkText = link.textContent.trim(); const linkHref = link.getAttribute('href') || ''; // 替换Spaces链接 - 仅替换一次 if ( (linkHref.includes('/spaces') || linkHref === '/spaces' || linkText === 'Spaces' || linkText.match(/^s*Spacess*$/i)) && linkText !== 'OCR模型免费转Markdown' && linkText !== 'OCR模型免费转Markdown' ) { link.textContent = 'OCR模型免费转Markdown'; link.href = 'https://fast360.xyz'; link.setAttribute('target', '_blank'); link.setAttribute('rel', 'noopener noreferrer'); replacedLinks.add(link); } // 删除Posts链接 else if ( (linkHref.includes('/posts') || linkHref === '/posts' || linkText === 'Posts' || linkText.match(/^s*Postss*$/i)) ) { if (link.parentNode) { link.parentNode.removeChild(link); } replacedLinks.add(link); } // 替换Docs链接 - 仅替换一次 else if ( (linkHref.includes('/docs') || linkHref === '/docs' || linkText === 'Docs' || linkText.match(/^s*Docss*$/i)) && linkText !== '模型下载攻略' ) { link.textContent = '模型下载攻略'; link.href = '/'; replacedLinks.add(link); } // 删除Enterprise链接 else if ( (linkHref.includes('/enterprise') || linkHref === '/enterprise' || linkText === 'Enterprise' || linkText.match(/^s*Enterprises*$/i)) ) { if (link.parentNode) { link.parentNode.removeChild(link); } replacedLinks.add(link); } }); // 查找可能嵌套的Spaces和Posts文本 const textNodes = []; function findTextNodes(element) { if (element.nodeType === Node.TEXT_NODE) { const text = element.textContent.trim(); if (text === 'Spaces' || text === 'Posts' || text === 'Enterprise') { textNodes.push(element); } } else { for (const child of element.childNodes) { findTextNodes(child); } } } // 只在导航区域内查找文本节点 findTextNodes(headerArea); // 替换找到的文本节点 textNodes.forEach(node => { const text = node.textContent.trim(); if (text === 'Spaces') { node.textContent = node.textContent.replace(/Spaces/g, 'OCR模型免费转Markdown'); } else if (text === 'Posts') { // 删除Posts文本节点 if (node.parentNode) { node.parentNode.removeChild(node); } } else if (text === 'Enterprise') { // 删除Enterprise文本节点 if (node.parentNode) { node.parentNode.removeChild(node); } } }); // 标记已替换完成 window._navLinksReplaced = true; } // 替换代码区域中的域名 function replaceCodeDomains() { // 特别处理span.hljs-string和span.njs-string元素 document.querySelectorAll('span.hljs-string, span.njs-string, span[class*="hljs-string"], span[class*="njs-string"]').forEach(span => { if (span.textContent && span.textContent.includes('huggingface.co')) { span.textContent = span.textContent.replace(/huggingface.co/g, 'aifasthub.com'); } }); // 替换hljs-string类的span中的域名（移除多余的转义符号） document.querySelectorAll('span.hljs-string, span[class*="hljs-string"]').forEach(span => { if (span.textContent && span.textContent.includes('huggingface.co')) { span.textContent = span.textContent.replace(/huggingface.co/g, 'aifasthub.com'); } }); // 替换pre和code标签中包含git clone命令的域名 document.querySelectorAll('pre, code').forEach(element => { if (element.textContent && element.textContent.includes('git clone')) { const text = element.innerHTML; if (text.includes('huggingface.co')) { element.innerHTML = text.replace(/huggingface.co/g, 'aifasthub.com'); } } }); // 处理特定的命令行示例 document.querySelectorAll('pre, code').forEach(element => { const text = element.innerHTML; if (text.includes('huggingface.co')) { // 针对git clone命令的专门处理 if (text.includes('git clone') || text.includes('GIT_LFS_SKIP_SMUDGE=1')) { element.innerHTML = text.replace(/huggingface.co/g, 'aifasthub.com'); } } }); // 特别处理模型下载页面上的代码片段 document.querySelectorAll('.flex.border-t, .svelte_hydrator, .inline-block').forEach(container => { const content = container.innerHTML; if (content && content.includes('huggingface.co')) { container.innerHTML = content.replace(/huggingface.co/g, 'aifasthub.com'); } }); // 特别处理模型仓库克隆对话框中的代码片段 try { // 查找包含"Clone this model repository"标题的对话框 const cloneDialog = document.querySelector('.svelte_hydration_boundary, [data-target="MainHeader"]'); if (cloneDialog) { // 查找对话框中所有的代码片段和命令示例 const codeElements = cloneDialog.querySelectorAll('pre, code, span'); codeElements.forEach(element => { if (element.textContent && element.textContent.includes('huggingface.co')) { if (element.innerHTML.includes('huggingface.co')) { element.innerHTML = element.innerHTML.replace(/huggingface.co/g, 'aifasthub.com'); } else { element.textContent = element.textContent.replace(/huggingface.co/g, 'aifasthub.com'); } } }); } // 更精确地定位克隆命令中的域名 document.querySelectorAll('[data-target]').forEach(container => { const codeBlocks = container.querySelectorAll('pre, code, span.hljs-string'); codeBlocks.forEach(block => { if (block.textContent && block.textContent.includes('huggingface.co')) { if (block.innerHTML.includes('huggingface.co')) { block.innerHTML = block.innerHTML.replace(/huggingface.co/g, 'aifasthub.com'); } else { block.textContent = block.textContent.replace(/huggingface.co/g, 'aifasthub.com'); } } }); }); } catch (e) { // 错误处理但不打印日志 } } // 当DOM加载完成后执行替换 if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', () => { replaceHeaderBranding(); replaceNavigationLinks(); replaceCodeDomains(); // 只在必要时执行替换 - 3秒后再次检查 setTimeout(() => { if (!window._navLinksReplaced) { console.log('[Client] 3秒后重新检查导航链接'); replaceNavigationLinks(); } }, 3000); }); } else { replaceHeaderBranding(); replaceNavigationLinks(); replaceCodeDomains(); // 只在必要时执行替换 - 3秒后再次检查 setTimeout(() => { if (!window._navLinksReplaced) { console.log('[Client] 3秒后重新检查导航链接'); replaceNavigationLinks(); } }, 3000); } // 增加一个MutationObserver来处理可能的动态元素加载 const observer = new MutationObserver(mutations => { // 检查是否导航区域有变化 const hasNavChanges = mutations.some(mutation => { // 检查是否存在header或nav元素变化 return Array.from(mutation.addedNodes).some(node => { if (node.nodeType === Node.ELEMENT_NODE) { // 检查是否是导航元素或其子元素 if (node.tagName === 'HEADER' || node.tagName === 'NAV' || node.querySelector('header, nav')) { return true; } // 检查是否在导航元素内部 let parent = node.parentElement; while (parent) { if (parent.tagName === 'HEADER' || parent.tagName === 'NAV') { return true; } parent = parent.parentElement; } } return false; }); }); // 只在导航区域有变化时执行替换 if (hasNavChanges) { // 重置替换状态，允许再次替换 window._navLinksReplaced = false; replaceHeaderBranding(); replaceNavigationLinks(); } }); // 开始观察document.body的变化，包括子节点 if (document.body) { observer.observe(document.body, { childList: true, subtree: true }); } else { document.addEventListener('DOMContentLoaded', () => { observer.observe(document.body, { childList: true, subtree: true }); }); } })(); tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nfooter\nThe footer for man pages.\n\n\nheader\nThe header for man pages.\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/man.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/man.html\"\n}"}}},{"rowIdx":101,"cells":{"page_content":{"kind":"string","value":"FictionBook is an open XML-based e-book format. You can learn more about FictionBook at https://en.wikipedia.org/wiki/FictionBook.\nformat: fb2\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/fb2.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/fb2.html\"\n}"}}},{"rowIdx":102,"cells":{"page_content":{"kind":"string","value":"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.\nSee the MS Word format user guide for more details on creating MS Word output with Quarto.\nformat: docx\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nreference-doc\nUse the specified file as a style reference in producing a docx, pptx, or odt file.\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\ntoc-title\nThe title used for the table of contents.\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-depth\nBy default, all headings in your document create a numbered section. You customize numbering depth using the number-depth option.\nFor example, to only number sections immediately below the chapter level, use this:\nnumber-depth: 1\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\npage-width\nTarget 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.\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\nhighlight-style\nSpecifies the coloring style to be used in highlighted source code.\nInstead 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.\n\n\nsyntax-definitions\nKDE language syntax definition files (XML)\n\n\nindented-code-classes\nSpecify classes to use for all indented code blocks\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-align\nFigure horizontal alignment (default, left, right, or center)\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\nlink-citations\nIf true, citations will be hyperlinked to the corresponding bibliography entries (for author-date and numerical styles only). Defaults to false.\n\n\nlink-bibliography\nIf 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.\n\n\nnotes-after-punctuation\nIf 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.\nIf 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).\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nMetadata\n\n\n\n\n\n\n\nsubject\nThe document subject\n\n\ndescription\nThe document description. Some applications show this as Comments metadata.\n\n\ncategory\nThe document category.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/docx.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/docx.html\"\n}"}}},{"rowIdx":103,"cells":{"page_content":{"kind":"string","value":"HTML is a markup language used for structuring and presenting content on the web. To learn more about HTML see https://en.wikipedia.org/wiki/HTML5.\nSee the HTML format user guide for more details on creating HTML output with Quarto.\nformat: html\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\nsubtitle\nIdentifies the subtitle of the document.\n\n\ndate\nDocument date\n\n\ndate-modified\nDocument date modified\n\n\nauthor\nAuthor or authors of the document\n\n\nabstract\nSummary of document\n\n\nabstract-title\nTitle used to label document abstract\n\n\ndoi\nDisplays the document Digital Object Identifier in the header.\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\ntheme\nTheme name, theme scss file, or a mix of both.\n\n\nminimal\nDisables the built in html features like theming, anchor sections, code block behavior, and more.\n\n\ncss\nOne or more CSS style sheets.\n\n\nanchor-sections\nEnables hover over a section title to see an anchor link.\n\n\nsmooth-scroll\nEnables smooth scrolling within the page.\n\n\nhtml-math-method\nMethod use to render math in HTML output (plain, webtex, gladtex, mathml, mathjax, katex).\nSee the Pandoc documentation on Math Rendering in HTML for additional details.\n\n\nsection-divs\nWrap sections in

tags and attach identifiers to the enclosing

rather than the heading itself.\n\n\nidentifier-prefix\nSpecify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.\n\n\nemail-obfuscation\nSpecify a method for obfuscating mailto: links in HTML documents.\n\njavascript: Obfuscate links using JavaScript.\nreferences: Obfuscate links by printing their letters as decimal or hexadecimal character references.\nnone (default): Do not obfuscate links.\n\n\n\nhtml-q-tags\nUse tags for quotes in HTML.\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\ntoc-location\nLocation for table of contents (body, left, or right (default)).\n\n\ntoc-title\nThe title used for the table of contents.\n\n\ntoc-expand\nSpecifies the depth of items in the table of contents that should be displayed as expanded in HTML output. Use true to expand all or false to collapse all.\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-depth\nBy default, all headings in your document create a numbered section. You customize numbering depth using the number-depth option.\nFor example, to only number sections immediately below the chapter level, use this:\nnumber-depth: 1\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nFonts\n\n\n\nmainfont\nFor HTML output, sets the CSS font-family on the HTML element.\nFor LaTeX output, the main font family for use with xelatex or lualatex. Takes the name of any system font, using the fontspec package.\nFor ConTeXt output, the main font family. Use the name of any system font. See ConTeXt Fonts for more information.\n\n\nmonofont\nFor HTML output, sets the CSS font-family property on code elements.\nFor PowerPoint output, sets the font used for code.\nFor LaTeX output, the monospace font family for use with xelatex or lualatex: take the name of any system font, using the fontspec package.\nFor ConTeXt output, the monspace font family. Use the name of any system font. See ConTeXt Fonts for more information.\n\n\nfontsize\nFor HTML output, sets the base CSS font-size property.\nFor LaTeX and ConTeXt output, sets the font size for the document body text.\n\n\nlinestretch\nFor HTML output sets the CSS line-height property on the html element, which is preferred to be unitless.\nFor LaTeX output, adjusts line spacing using the setspace package, e.g. 1.25, 1.5.\n\n\n\n\n\nColors\n\n\n\nfontcolor\nSets the CSS color property.\n\n\nlinkcolor\nFor HTML output, sets the CSS color property on all links.\nFor LaTeX output, The color used for internal links using color options allowed by xcolor, including the dvipsnames, svgnames, and x11names lists.\nFor ConTeXt output, sets the color for both external links and links within the document.\n\n\nmonobackgroundcolor\nSets the CSS background-color property on code elements and adds extra padding.\n\n\nbackgroundcolor\nSets the CSS background-color property on the html element.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ncap-location\nWhere to place figure and table captions (top, bottom, or margin)\n\n\nfig-cap-location\nWhere to place figure captions (top, bottom, or margin)\n\n\ntbl-cap-location\nWhere to place table captions (top, bottom, or margin)\n\n\nclassoption\nFor LaTeX/PDF output, the options set for the document class.\nFor HTML output using KaTeX, you can render display math equations flush left using classoption: fleqn\n\n\npage-layout\nThe page layout to use for this document (article, full, or custom)\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\nappendix-style\nThe layout of the appendix for this document (none, plain, or default).\nTo completely disable any styling of the appendix, choose the appendix style none. For minimal styling, choose plain.\n\n\nappendix-cite-as\nControls the formats which are provided in the citation section of the appendix.\nUse false to disable the display of the ‘cite as’ appendix. Pass one or more of display or bibtex to enable that format in ‘cite as’ appendix.\n\n\ntitle-block-style\nThe layout of the title block for this document (none, plain, or default).\nTo completely disable any styling of the title block, choose the style none. For minimal styling, choose plain.\n\n\ntitle-block-banner\nApplies a banner style treatment for the title block. You may specify one of the following values:\n\ntrue\n\nWill enable the banner style display and automatically select a background color based upon the theme.\n\n\n\nIf you provide a CSS color value, the banner will be enabled and the background color set to the provided CSS color.\n\n\n\nIf you provide the path to a file, the banner will be enabled and the background image will be set to the file path.\n\n\nSee title-block-banner-color if you’d like to control the color of the title block banner text.\n\n\ntitle-block-banner-color\nSets the color of text elements in a banner style title block. Use one of the following values:\n\nbody | body-bg\n\nWill set the text color to the body text color or body background color, respectively.\n\n\n\nIf you provide a CSS color value, the text color will be set to the provided CSS color.\n\n\n\n\ntitle-block-categories\nEnables or disables the display of categories in the title block.\n\n\nmax-width\nAdds a css max-width to the body Element.\n\n\nmargin-left\nFor HTML output, sets the margin-left property on the Body element.\nFor LaTeX output, sets the left margin if geometry is not used (otherwise geometry overrides this value)\nFor ConTeXt output, sets the left margin if layout is not used, otherwise layout overrides these.\nFor wkhtmltopdf sets the left page margin.\n\n\nmargin-right\nFor HTML output, sets the margin-right property on the Body element.\nFor LaTeX output, sets the right margin if geometry is not used (otherwise geometry overrides this value)\nFor ConTeXt output, sets the right margin if layout is not used, otherwise layout overrides these.\nFor wkhtmltopdf sets the right page margin.\n\n\nmargin-top\nFor HTML output, sets the margin-top property on the Body element.\nFor LaTeX output, sets the top margin if geometry is not used (otherwise geometry overrides this value)\nFor ConTeXt output, sets the top margin if layout is not used, otherwise layout overrides these.\nFor wkhtmltopdf sets the top page margin.\n\n\nmargin-bottom\nFor HTML output, sets the margin-bottom property on the Body element.\nFor LaTeX output, sets the bottom margin if geometry is not used (otherwise geometry overrides this value)\nFor ConTeXt output, sets the bottom margin if layout is not used, otherwise layout overrides these.\nFor wkhtmltopdf sets the bottom page margin.\n\n\n\n\n\nCode\n\n\n\ncode-fold\nCollapse code into an HTML

tag so the user can display it on-demand.\n\ntrue: collapse code\nfalse (default): do not collapse code\nshow: use the

tag, but show the expanded code initially.\n\n\n\ncode-summary\nSummary text to use for code blocks collapsed using code-fold\n\n\ncode-overflow\nChoose how to handle code overflow, when code lines are too wide for their container. One of:\n\nscroll\nwrap\n\n\n\ncode-line-numbers\nInclude line numbers in code block output (true or false).\nFor revealjs output only, you can also specify a string to highlight specific lines (and/or animate between sets of highlighted lines).\n\nSets of lines are denoted with commas:\n\n3,4,5\n1,10,12\n\nRanges can be denoted with dashes and combined with commas:\n\n1-3,5\n5-10,12,14\n\nFinally, animation steps are separated by |:\n\n1-3|1-3,5 first shows 1-3, then 1-3,5\n|5|5-10,12 first shows no numbering, then 5, then lines 5-10 and 12\n\n\n\n\ncode-copy\nEnable a code copy icon for code blocks.\n\ntrue: Always show the icon\nfalse: Never show the icon\nhover (default): Show the icon when the mouse hovers over the code block\n\n\n\ncode-link\nEnables hyper-linking of functions within code blocks to their online documentation.\nCode linking is currently implemented only for the knitr engine (via the downlit package). A limitation of downlit currently prevents code linking if code-line-numbers is also true.\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\ncode-tools\nInclude a code tools menu (for hiding and showing code). Use true or false to enable or disable the standard code tools menu. Specify sub-properties source, toggle, and caption to customize the behavior and appearnce of code tools.\n\n\ncode-block-border-left\nSpecifies to apply a left border on code blocks. Provide a hex color to specify that the border is enabled as well as the color of the border.=\n\n\ncode-block-bg\nSpecifies to apply a background color on code blocks. Provide a hex color to specify that the background color is enabled as well as the color of the background.\n\n\nhighlight-style\nSpecifies the coloring style to be used in highlighted source code.\nInstead 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.\n\n\nsyntax-definitions\nKDE language syntax definition files (XML)\n\n\nindented-code-classes\nSpecify classes to use for all indented code blocks\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-align\nFigure horizontal alignment (default, left, right, or center)\n\n\nfig-cap-location\nWhere to place figure captions (top, bottom, or margin)\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\nfig-responsive\nWhether to make images in this document responsive.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ntbl-cap-location\nWhere to place table captions (top, bottom, or margin)\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nLinks\n\n\n\n\n\n\n\nlink-external-icon\nShow a special icon next to links that leave the current site.\n\n\nlink-external-newwindow\nOpen external links in a new browser window or tab (rather than navigating the current tab).\n\n\nlink-external-filter\nA regular expression that can be used to determine whether a link is an internal link. For example, the following will treat links that start with http://www.quarto.org as internal links (and others will be considered external):\n^(?:http:|https:)\\/\\/www\\.quarto\\.org\\/custom\n\n\nformat-links\nControls whether links to other rendered formats are displayed in HTML output.\nPass false to disable the display of format lengths or pass a list of format names for which you’d like links to be shown.\n\n\nnotebook-links\nControls the display of links to notebooks that provided embedded content or are created from documents.\nSpecify false to disable linking to source Notebooks. Specify inline to show links to source notebooks beneath the content they provide. Specify global to show a set of global links to source notebooks.\n\n\nnotebook-view\nConfigures the HTML viewer for notebooks that provide embedded content.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\ncitations-hover\nEnables a hover popup for citation that shows the reference information.\n\n\ncitation-location\nWhere citation information should be displayed (document or margin)\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nFootnotes\n\n\n\n\n\n\n\nfootnotes-hover\nEnables a hover popup for footnotes that shows the footnote contents.\n\n\nreference-location\nSpecify location for footnotes. Also controls the location of references, if reference-links is set.\n\nblock: Place at end of current top-level block\nsection: Place at end of current section\nmargin: Place at the margin\ndocument: Place at end of document\n\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nresources\nPath (or glob) to files to publish with this document.\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nMetadata\n\n\n\n\n\n\n\nkeywords\nList of keywords to be included in the document metadata.\n\n\ncopyright\nThe copyright for this document, if any.\n\n\nlicense\nThe license for this document, if any.\nCreative Commons licenses CC BY, CC BY-SA, CC BY-ND, CC BY-NC will automatically generate a license link in the document appendix. Other license text will be placed in the appendix verbatim.\n\n\npagetitle\nSets the title metadata for the document\n\n\ntitle-prefix\nSpecify STRING as a prefix at the beginning of the title that appears in the HTML header (but not in the title as it appears at the beginning of the body)\n\n\ndescription-meta\nSets the description metadata for the document\n\n\nauthor-meta\nSets the author metadata for the document\n\n\ndate-meta\nSets the date metadata for the document\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nembed-resources\nProduce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. The resulting file should be “self-contained,” in the sense that it needs no external files and no net access to be displayed properly by a browser. This option works only with HTML output formats, including html4, html5, html+lhs, html5+lhs, s5, slidy, slideous, dzslides, and revealjs. Scripts, images, and stylesheets at absolute URLs will be downloaded; those at relative URLs will be sought relative to the working directory (if the first source file is local) or relative to the base URL (if the first source file is remote). Elements with the attribute data-external=\"1\" will be left alone; the documents they link to will not be incorporated in the document. Limitation: resources that are loaded dynamically through JavaScript cannot be incorporated; as a result, some advanced features (e.g. zoom or speaker notes) may not work in an offline “self-contained” reveal.js slide show.\n\n\nself-contained\nProduce a standalone HTML file with no external dependencies. Note that this option has been deprecated in favor of embed-resources.\n\n\nself-contained-math\nEmbed math libraries (e.g. MathJax) within self-contained output. Note that math libraries are not embedded by default because they are quite large and often time consuming to download.\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nWebsite\n\n\n\n\n\n\n\nsearch\nSetting this to false prevents this document from being included in searches.\n\n\naliases\nURLs that alias this document, when included in a website.\n\n\nimage\nThe path to a preview image for this content. By default, Quarto will use the image value from the site: metadata. If you provide an image, you may also optionally provide an image-width and image-height to improve the appearance of your Twitter Card.\nIf image is not provided, Quarto will automatically attempt to locate a preview image.\n\n\nimage-height\nThe height of the preview image for this document.\n\n\nimage-width\nThe width of the preview image for this document.\n\n\nimage-alt\nThe alt text for preview image on this page.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nstrip-comments\nStrip out HTML comments in the Markdown source, rather than passing them on to Markdown, Textile or HTML output as raw HTML. This does not apply to HTML comments inside raw HTML blocks when the markdown_in_html_blocks extension is not set.\n\n\nascii\nUse only ASCII characters in output. Currently supported for XML and HTML formats (which use entities instead of UTF-8 when this option is selected), CommonMark, gfm, and Markdown (which use entities), roff ms (which use hexadecimal escapes), and to a limited degree LaTeX (which uses standard commands for accented characters when possible). roff man output uses ASCII by default."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/html.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/html.html\"\n}"}}},{"rowIdx":104,"cells":{"page_content":{"kind":"string","value":"AsciiDoc is a text document format for writing documentation, articles, and books, ebooks, slideshows, web pages, man pages and blogs. You can learn more about AsciiDoc at https://asciidoc.org/.\nformat: asciidoc\nformat: asciidoctor\n\n\n\n\n\n\nAsciidoc vs Asciidoctor Format\n\n\n\nPandoc includes support for both the asciidoc and asciidoctor formats. The asciidoc format produces older style syntax that is no longer typically used, while the asciidoctor format produces the more current markdown syntax that is part of the formal AsciiDoc specification.\nIn Quarto, both asciidoc and asciidoctor are aliases for the asciidoctor format.\n\n\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\nabstract\nSummary of document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nMetadata\n\n\n\n\n\n\n\nkeywords\nList of keywords to be included in the document metadata.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/asciidoc.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/asciidoc.html\"\n}"}}},{"rowIdx":105,"cells":{"page_content":{"kind":"string","value":"Markua is a markdown variant used by Leanpub. You can learn more about Markua at https://leanpub.com/markua/read.\nformat: markua\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nidentifier-prefix\nSpecify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.\n\n\nvariant\nEnable and disable extensions for markdown output (e.g. “+emoji”)\n\n\nmarkdown-headings\nSpecify whether to use atx (#-prefixed) or setext (underlined) headings for level 1 and 2 headings (atx or setext).\n\n\nkeep-yaml\nPreserve the original YAML front matter in rendered markdown\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nFootnotes\n\n\n\n\n\n\n\nreference-location\nSpecify location for footnotes. Also controls the location of references, if reference-links is set.\n\nblock: Place at end of current top-level block\nsection: Place at end of current section\nmargin: Place at the margin\ndocument: Place at end of document\n\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run).\n\n\n\nstrip-comments\nStrip out HTML comments in the Markdown source, rather than passing them on to Markdown, Textile or HTML output as raw HTML. This does not apply to HTML comments inside raw HTML blocks when the markdown_in_html_blocks extension is not set.\n\n\nascii\nUse only ASCII characters in output. Currently supported for XML and HTML formats (which use entities instead of UTF-8 when this option is selected), CommonMark, gfm, and Markdown (which use entities), roff ms (which use hexadecimal escapes), and to a limited degree LaTeX (which uses standard commands for accented characters when possible). roff man output uses ASCII by default."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/markdown/markua.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/markdown/markua.html\"\n}"}}},{"rowIdx":106,"cells":{"page_content":{"kind":"string","value":"You can provide citation data for Quarto documents in the document front matter. The citation options are based upon the Citation Style Language (CSL) specification for items, but as YAML (rather than XML).\n---\ncitation:\n type: article-journal\n container-title: ACM Transactions on Embedded Computing Systems\n volume: 21\n issue: 2\n issued: 2022-03\n issn: 1539-9087\n doi: 10.1145/3514174\n---\n\nCitation\n\n\n\n\n\n\n\nabstract\nAbstract of the item (e.g. the abstract of a journal article)\n\n\nauthor\nThe author(s) of the item.\n\n\ndoi\nDigital Object Identifier (e.g. “10.1128/AEM.02591-07”)\n\n\nreferences\nResources related to the procedural history of a legal case or legislation;\nCan also be used to refer to the procedural history of other items (e.g.  “Conference canceled” for a presentation accepted as a conference that was subsequently canceled; details of a retraction or correction notice)\n\n\ntitle\nThe primary title of the item."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/metadata/citation.html\",\n \"source\": \"https://quarto.org/docs/reference/metadata/citation.html\"\n}"}}},{"rowIdx":107,"cells":{"page_content":{"kind":"string","value":"Date Parsing\nWhen you write a date for Quarto document, Quarto will attempt to parse a date string by trying a number of standard forms before ultimately attempting to infer the date format. Quarto will try dates formatted as follows, in the following order:\n\nMM/dd/yyyy\nMM-dd-yyyy\nMM/dd/yy\nMM-dd-yy\nyyyy-MM-dd\ndd MM yyyy\nMM dd, yyyy\nYYYY-MM-DDTHH:mm:ssZ\n\nIn addition, you may also provide date keywords, which will provide a dynamic date.\n\n\n\n\n\n\n\nKeyword\nDate\n\n\n\n\ntoday\nThe current local date, with the time portion set to 0.\n\n\nnow\nThe current local date and time.\n\n\nlast-modified\nThe last modified date and time of the input file containing the date.\n\n\n\n\n\nDate Formatting\nWhen specifying a date format in Quarto, there are two ways to represent the format that you’d like.\n\nUsing a Date Style\nYou can specify a simple date style which will be used to format the date.\nFor example:\n---\ndate: 03/07/2005\ndate-format: long\n---\nValid styles and examples of the formatted output are as follows:\n\n\n\n\n\n\n\n\nStyle\nDescription\nExample\n\n\n\n\nfull\nA full date that includes the weekday name\nMonday, March 7, 2005\n\n\nlong\nA long date that includes a wide month name\nMarch 7, 2005\n\n\nmedium\nA medium date\nMar 7, 2005\n\n\nshort\nA short date with a numeric month\n3/7/05\n\n\niso\nA short date in ISO format\n2005-03-07\n\n\n\n\n\nUsing a Date Format\nYou can also specify a date format string that will be used to format the date. For example:\n---\ndate: 03/07/2005\ndate-format: \"MMM D, YYYY\"\nThe permissible values in this string include:\n\n\n\nFormat String\nOutput\nDescription\n\n\n\n\nYY\n18\nTwo-digit year\n\n\nYYYY\n2018\nFour-digit year\n\n\nM\n1-12\nThe month, beginning at 1\n\n\nMM\n01-12\nThe month, 2-digits\n\n\nMMM\nJan-Dec\nThe abbreviated month name\n\n\nMMMM\nJanuary-December\nThe full month name\n\n\nD\n1-31\nThe day of the month\n\n\nDD\n01-31\nThe day of the month, 2-digits\n\n\nd\n0-6\nThe day of the week, with Sunday as 0\n\n\ndd\nSu-Sa\nThe min name of the day of the week\n\n\nddd\nSun-Sat\nThe short name of the day of the week\n\n\ndddd\nSunday-Saturday\nThe name of the day of the week\n\n\nH\n0-23\nThe hour\n\n\nHH\n00-23\nThe hour, 2-digits\n\n\nh\n1-12\nThe hour, 12-hour clock\n\n\nhh\n01-12\nThe hour, 12-hour clock, 2-digits\n\n\nm\n0-59\nThe minute\n\n\nmm\n00-59\nThe minute, 2-digits\n\n\ns\n0-59\nThe second\n\n\nss\n00-59\nThe second, 2-digits\n\n\nSSS\n000-999\nThe millisecond, 3-digits\n\n\nZ\n+05:00\nThe offset from UTC, ±HH:mm\n\n\nZZ\n+0500\nThe offset from UTC, ±HHmm\n\n\nA\nAM PM\n\n\n\na\nam pm\n\n\n\nQ\n1-4\nQuarter\n\n\nDo\n1st 2nd … 31st\nDay of Month with ordinal\n\n\nk\n1-24\nThe hour, beginning at 1\n\n\nkk\n01-24\nThe hour, 2-digits, beginning at 1\n\n\nX\n1360013296\nUnix Timestamp in second\n\n\nx\n1360013296123\nUnix Timestamp in millisecond\n\n\nw\n1 2 … 52 53\nWeek of year ( dependent WeekOfYear plugin )\n\n\nww\n01 02 … 52 53\nWeek of year, 2-digits ( dependent WeekOfYear plugin )\n\n\nW\n1 2 … 52 53\nISO Week of year ( dependent IsoWeek plugin )\n\n\nWW\n01 02 … 52 53\nISO Week of year, 2-digits ( dependent IsoWeek plugin )\n\n\nwo\n1st 2nd … 52nd 53rd\nWeek of year with ordinal ( dependent WeekOfYear plugin )\n\n\ngggg\n2017\nWeek Year ( dependent WeekYear plugin )\n\n\nGGGG\n2017\nISO Week Year ( dependent IsoWeek plugin )\n\n\nz\nEST\nAbbreviated named offset ( dependent Timezone plugin )\n\n\nzzz\nEastern Standard Time\nUnabbreviated named offset ( dependent Timezoneplugin )\n\n\n\nTo escape characters, wrap them in square brackets (e.g. [MM]).\nExample formats and outputs include:\n\n\n\n\n\n\n\nFormat\nOutput\n\n\n\n\nMMM D, YYYY\nMar 7, 2005\n\n\nDD/MM/YYYY\n07/03/2005\n\n\n[YYYYescape] YYYY-MM-DDTHH:mm:ssZ[Z]\nYYYYescape 2005-03-07T00:00:00-05:00Z\n\n\nYYYY-MM-DDTHH:mm:ssZ\n2005-03-07T00:00:00-05:00\n\n\ndddd MMM D, YYYY\nMonday Mar 7, 2005"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/dates.html\",\n \"source\": \"https://quarto.org/docs/reference/dates.html\"\n}"}}},{"rowIdx":108,"cells":{"page_content":{"kind":"string","value":"Overview\nUse the docx format to create MS Word output. For example:\n---\ntitle: \"My Document\"\nformat:\n docx:\n toc: true\n number-sections: true\n highlight-style: github\n---\nThis example highlights a few of the options available for MS Word output. This document covers these and other options in detail. See the Word format reference for a complete list of all available options.\nTo learn about creating custom templates for use with the docx format, see the article on Word Templates.\n\n\nTable of Contents\nUse the toc option to include an automatically generated table of contents in the output document. Use the toc-depth option to specify the number of section levels to include in the table of contents. The default is 3 (which means that level-1, 2, and 3 headings will be listed in the contents). For example:\ntoc: true\ntoc-depth: 2\nYou can customize the title used for the table of contents using the toc-title option:\ntoc-title: Contents\nIf you want to exclude a heading from the table of contents, add both the .unnumbered and .unlisted classes to it:\n### More Options {.unnumbered .unlisted}\n\n\nSection Numbering\nUse the number-sections option to number section headings in the output document. For example:\nnumber-sections: true\nUse the number-depth option to specify the deepest level of heading to add numbers to (by default all headings are numbered). For example:\nnumber-depth: 3\nTo exclude an individual heading from numbering, add the .unnumbered class to it:\n### More Options {.unnumbered}\n\n\nSyntax Highlighting\nPandoc will automatically highlight syntax in fenced code blocks that are marked with a language name. For example:\n```python\n1 + 1\n```\nPandoc can provide syntax highlighting for over 140 different languages (see the output of quarto pandoc --list-highlight-languages for a list of all of them). If you want to provide the appearance of a highlighted code block for a language not supported, just use default as the language name.\nYou can specify the code highlighting style using highlight-style and specifying one of the supported themes. Supported themes include: arrow, pygments, tango, espresso, zenburn, kate, monochrome, breezedark, haddock, atom-one, ayu, breeze, dracula, github, gruvbox, monokai, nord, oblivion, printing, radical, solarized, and vim.\nFor example:\nhighlight-style: github\nHighlighting themes can provide either a single highlighting definition or two definitions, one optimized for a light colored background and another optimized for a dark color background. When available, Quarto will automatically select the appropriate style based upon the code chunk background color’s darkness. You may always opt to specify the full name (e.g. atom-one-dark) to bypass this automatic behavior.\nBy default, code is highlighted using the arrow theme, which is optimized for accessibility. Here are examples of the arrow light and dark themes:\n\nLightDark\n\n\n\n\n\n\n\n\n\n\n\nCode Annotation\nYou can add annotations to lines of code in code blocks and executable code cells. See Code Annotation for full details."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.703Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/ms-word.html\",\n \"source\": \"https://quarto.org/docs/output-formats/ms-word.html\"\n}"}}},{"rowIdx":109,"cells":{"page_content":{"kind":"string","value":"Overview\nDocusaurus is a popular markdown documentation system. Pages in Docusaurus websites are typically written in plain markdown, so don’t have a straightforward way to automatically and reproducibly incorporate computational output.\nUsing the Quarto docusaurus-md format, you can incorporate computational output (e.g. R or Python code that produces plots) into Docusaurus websites. This article explains how.\nIt’s important to note that many of the Quarto features related to theming, page layout, and navigation are not applicable when you are using Quarto with Docusaurus. Docusaurus has its own theming system, syntax highlighting, table of contents, page layout, navigational menus, and full text search. You’ll use Quarto to execute code and generate markdown that is rendered within the Docusaurus HTML publishing framework rather than Quarto’s own.\n\n\nWorkflow\nThe basic concept of using Quarto with Docusaurus is that you take computational markdown documents (.qmd) or Jupyter notebooks (.ipynb) and use them to generate plain markdown files (.md) that are rendered to HTML by Docusaurus.\nindex.qmd   quarto =>   index.md   docusaurus =>   index.html\nThe quarto render and quarto preview commands are used to transform .qmd or .ipynb files to Docusaurus compatible markdown (.md). The computational files are located in the same place you would also locate ordinary markdown files (e.g. the blog directory).\nAfter rendering, a plain .md file is written right alongside the computational document. This markdown file is then processed by Docusaurus.\n\nLive Preview\nThe quarto preview command will automatically recognize when it is run from a directory that contains a Docusaurus website:\n\n\nTerminal\n\ncd my-docusaurus-website\nquarto preview\n\nThis will automatically run docusaurus start on your behalf to bring up a local preview server. In addition, it will monitor the filesystem for changes to .qmd and .ipynb inputs and automatically re-render them to Docusaurus compatible .md files when they change.\nNote that this also works for the integrated Render/Preview command within the Quarto VS Code Extension.\n\n\nRendering\nIf you are not previewing and want to render all of the Quarto documents (.qmd) and notebooks (.ipynb) in your site, call quarto render from the root directory of the site:\n\n\nTerminal\n\ncd my-docusaurus-website\nquarto render \n\nTypically you’ll want to do a quarto render at the site level before you build the site for publishing:\n\n\nTerminal\n\nquarto render && npm run build\n\nYou can also render individual documents or notebooks:\n\n\nTerminal\n\nquarto render blog/2022-07-26/hello-quarto/index.qmd\n\nIf you have computationally expensive documents you may want to consider using Quarto’s freeze feature to only re-execute code when your document source code changes.\nNote that if aren’t ever rendering at the project level and just have individual files that you want to render with Quarto, you should specify the docusaurus-md format as follows:\n---\ntitle: \"My Blog Post\"\nformat: docusaurus-md\n---\n\n\nConfiguration\nWhile Quarto works well within a Docusaurus site that has no _quarto.yml project config file, you can add one if you want to customize the default behavior, add a bibliography, etc. For example, here is what a simple customized _quarto.yml file might look like:\n\n\n_quarto.yml\n\nproject:\n type: docusaurus\n \nformat: \n docusaurus-md:\n code-fold: true\n \nexecute: \n warning: false\n\nbiliography: references.lib\n\nIt’s important to note that if you do provide an explicit _quarto.yml file you need to explicitly specify the project type (type: docusaurus) as shown above.\n\nExternal Directory\nYou might decide that you prefer to keep all of your Quarto documents and/or notebooks in their own directory, separate from the Docusaurus website. In this configuration you would mirror the directory structure of your site in the Quarto directory, and then set the output-dir in the project file to point to the Docusaurus directory. For example:\n\n\n_quarto.yml\n\nproject:\n type: docusaurus\n output-dir: ../docusaurus-site\n\n\n\n\n\nCode Blocks\nCode blocks in Docusaurus are very similar to Quarto. One important thing to keep in mind is that the syntax highlighting theme comes from Docusaurus rather than Quarto. See the theming documentation for additional details.\nIf you use the filename attribute in Quarto, it will automatically become the code block title in Docusaurus:\n```{.python filename=\"hello.py\"}\n1 + 1\n```\n\nCode folding is also automatically applied. So, for example the following executable code block:\n```{python}\n#| code-fold: true\n1 + 1\nIs rendered as a collasable block in Docusaurus:\n\n\n\nCallouts & Tabsets\nLike Quarto, Docusaurus includes support for Callouts and Tabsets. When including these components in a document, you should use the Quarto standard markdown syntax, which will be automatically translated to the appropriate Docusaurus constructs.\nFor example, here is a Quarto callout:\n::: {.callout-important}\nNote the Quarto callout syntax is used here.\n:::\nWhich renders in Docusaurus as:\n\nHere is a Quarto tabset:\n::: {.panel-tabset group=\"fruits\"}\n\n## Apple\nThis is an apple 🍎\n\n## Orange\nThis is an orange 🍊\n\n## Banana\nThis is a banana 🍌\n\n:::\nWhich renders in Docusaurus as:\n\n\n\nHTML and MDX\nDocusaurus websites use a flavor of markdown (MDX) that has some major differences from Pandoc (Quarto’s native markdown renderer), the biggest of which is that while Quarto allows embedding of HTML, MDX does not. Rather, MDX allows direct embedding of JavaScript code and React JSX components (which look like HTML but have some significant differences in behavior).\nQuarto’s support for Docusaurus accounts for these differences, and enables you to embed raw HTML as well as use MDX components and JavaScript when required.\n\nHTML Blocks\nDocusaurus websites don’t allow arbitrary HTML content. Rather, JSX is used to emit HTML tags. While these JSX tags look and act like HTML tags most of the time, there are some important caveats and constraints, most notably that the class attribute must be written as className, and style attributes need to be specified as JavaScript objects rather than CSS strings.\nIf you need to include raw HTML that doesn’t conform to JSX, you should use a raw ```{=html} code block. For example:\n```{=html}\n

Paragraph

\n```\nIf you need to embed HTML code (e.g. a badge, video, or tweet) you should definitely use raw HTML blocks as shown above to avoid errors which will occur if JSX encounters tags it can’t parse.\nNote that HTML produced by computations (e.g. a Pandas data frame displayed in a notebook) often use raw HTML with class and/or style tags. This computational output is automatically included in a raw ```{=html} code block so that it renders correctly in Docusaurus.\n\n\nMDX Blocks\nYou can also use MDX components and JavaScript within Quarto documents that target Docusaurus. To do this, enclose them in an ```{=mdx} raw code block. For example:\n```{=mdx}\nexport const Highlight = ({children, color}) => (\n \n {children}\n \n);\n\nDocusaurus GREEN and Rams blue are my favorite colors.\n\nI can write **Markdown** alongside my _JSX_!\n```\nWhich is rendered as follows:\n\nNote that ordinary markdown content can also be included in mdx blocks alonside JavaScript and React components.\n\n\n\nLaTeX Math\nBy default, Quarto renders LaTeX math within Docusaurus projects using WebTeX, a service that creates PNG images for publishing on the web given TeX expressions as input.\nWebTeX works for any web page that can display images, and requires no special JavaScript or CSS. Any inline or display equations contained within your document will be converted to an image URL that requests a rendered version of the equation. For example, the following markdown:\n$x + 1$\nWill be converted to:\n\nWhich renders as:\n\n\nDark Mode\nSVG is used as the default rendering method because it has the best overall appearance. However, if your docusaurus document is being rendered on a dark background, you may want to switch to PNG with a dark background specified. You can do this as follows:\nformat:\n docusaurus:\n html-math-method: \n method: webtex\n url: https://latex.codecogs.com/png.image?%5Cbg_black&space;\n\n\nKaTeX\nIt is possible to configure Docusaurus to use KaTeX for math rendering. See the Docusaurus documentation on using KaTeX to learn more about this option.\nOnce you’ve confirmed that KaTeX is rendering equations correctly in your site, you should update your _quarto.yml file to specify that katex rather than webtex should be used for rendering equations:\n\n\n_quarto.yml\n\nformat:\n docusaurus-md:\n html-math-method: katex"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/docusaurus.html\",\n \"source\": \"https://quarto.org/docs/output-formats/docusaurus.html\"\n}"}}},{"rowIdx":110,"cells":{"page_content":{"kind":"string","value":"Overview\nPandoc supports the use of a wide range of TeX distributions and PDF compilation engines including pdflatex, xelatex, lualatex, tectonic, and latexmk.\nWhile you can employ whatever toolchain you like for LaTeX compilation, we strongly recommend the use of TinyTeX, which is a distribution of TeX Live that provides a reasonably sized initial download (~100 MB) that includes the 200 or so most commonly used TeX packages for Pandoc documents.\nWe also recommend the use of Quarto’s built in PDF compilation engine, which among other things performs automatic installation of any missing TeX packages.\n\n\nInstalling TeX\nTo install TinyTeX, use the following command:\n\n\nTerminal\n\nquarto install tinytex\n\nTinyTeX is not installed to the system PATH so will not affect other applications that use TeX. If you want to use TinyTeX with other applications, add the --update-path flag when installing (this will add TinyTex to the system path):\n\n\nTerminal\n\nquarto install tinytex --update-path\n\nIf you already have another installation of TeX that you prefer to use with Quarto, add the latex-tinytex: false in your project or document front matter to prevent Quarto from using its internal version.\nIf you prefer TeX Live, you can find instructions for installing it here: https://tug.org/texlive/.\nNote that Quarto’s automatic installation of missing TeX packages will work for TinyTeX and TeX Live, but not for other TeX distributions (as it relies on TeX Live’s tlmgr command).\n\n\nManaging TeX\nIn addition to installing TinyTeX, you may also update or remove the installation of TinyTex. To see the currently installed version of TinyTex, use the command:\n\n\nTerminal\n\nquarto list tools\n\nwhich will provide a list of available tools, the installed versions, and the latest available version:\n[✓] Inspecting tools\n\nTool Status Installed Latest\nchromium Not installed --- 869685\ntinytex Up to date v2022.10 v2022.10\nTo update to the latest version, use the command:\n\n\nTerminal\n\nquarto update tinytex\n\nwhich will download and install the latest version of TinyTex (following the same behavior as described for installing TinyTex above).\nTo remove TinyTex altogether, use the command:\n\n\nTerminal\n\nquarto uninstall tinytex\n\n\n\n\n\n\n\nTip\n\n\n\nEach year in April, TeXlive updates their remote package repository to the new year’s version of TeX. When this happens, previous year installations of TeX will not be able to download and install packages from the remote repository. When this happens, you may see an error like:\nYour TexLive version is not updated enough to connect to the remote repository and download packages. Please update your installation of TexLive or TinyTex.\nWhen this happens, you can use quarto update tinytex to download and install an updated version of tinytex.\n\n\n\n\nQuarto PDF Engine\nQuarto’s built-in PDF compilation engine handles running LaTeX multiple times to resolve index and bibliography entries, and also performs automatic LaTeX package installation. This section describes customizing the built-in engine (see the Alternate PDF Engines section below for docs on using other engines).\n\nPDF Compilation\nThe following options are available for customizing PDF compilation:\n\n\n\n\n\n\n\nOption\nDescription\n\n\n\n\nlatex-min-runs\nNumber (minimum number of compilation passes)\n\n\nlatex-max-runs\nNumber (maximum number of compilation passes)\n\n\nlatex-clean\nBoolean (clean intermediates after compilation, defaults to true)\n\n\nlatex-output-dir\nString (output directory for intermediates and PDF)\n\n\nlatex-makeindex\nString (program to use for makeindex)\n\n\nlatex-makeindex-opts\nArray (options for makeindexprogram)\n\n\n\n\n\nPackage Installation\nThe following options are available for customizing automatic package installation:\n\n\n\nOption\nDescription\n\n\n\n\nlatex-auto-install\nBoolean (enable/disable automatic package installation)\n\n\nlatex-tlmgr-opts\nArray (options for tlmgr)\n\n\n\n\n\n\nAlternate PDF Engines\nYou can use the pdf-engine and pdf-engine-opts to control the PDF engine that Quarto uses to compile the LaTeX output into a PDF. For example:\ntitle: \"My Document\"\npdf-engine: lualatex\npdf-engine-opt: -outdir=out\nThe above example will use the lualatex PDF engine rather than the default xelatex.\n\n\nLatexmk\nQuarto includes a built in Latexmk engine, which will run the pdf-engine more than once to generate your PDF (for example if you’re using cross references or a bibliography). In addition, this engine will detect and attempt to install missing packages, fonts, or commands if TeX Live is available.\nYou can disable Quarto’s built in Latexmk engine by settng the latex-auto-mk option to false. For example:\ntitle: \"My Document\"\nlatex-auto-mk: false"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.703Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/pdf-engine.html\",\n \"source\": \"https://quarto.org/docs/output-formats/pdf-engine.html\"\n}"}}},{"rowIdx":111,"cells":{"page_content":{"kind":"string","value":"Overview\nPandoc supports a huge array of output formats, all of which can be used with Quarto. To use any Pandoc format just use the format option or the --to command line option.\nFor example, here’s some YAML that specifies the use of the html format as well as a couple of format options:\n---\ntitle: \"My Document\"\nformat: \n html:\n toc: true\n code-fold: true\n---\nAlternatively you can specify the use of a format on the command line:\n\n\nTerminal\n\nquarto render document.qmd --to html\n\nSee below for a list of all output formats by type along with links to their reference documentation.\n\n\nDocuments\n\n\n\n\n\n\n\nHTML\nHTML is a markup language used for structuring and presenting content on the web.\n\n\nPDF\nPDF is a file format for creating print-ready paged documents.\n\n\nMS Word\nMS Word is the word processor included with Microsoft Office.\n\n\nOpenOffice\nOpenDocument is an open standard file format for word processing documents.\n\n\nePub\nePub is an e-book file format that is supported by many e-readers.\n\n\n\n\n\nPresentations\n\n\n\n\n\n\n\nRevealjs\nRevealjs is an open source HTML presentation framework.\n\n\nPowerPoint\nPowerPoint is the presentation editing software included with Microsoft Office.\n\n\nBeamer\nBeamer is a LaTeX class for producing presentations and slides.\n\n\n\n\n\nMarkdown\n\n\n\n\n\n\n\nGitHub\nGitHub Flavored Markdown (GFM) is the dialect of Markdown that is currently supported for user content on GitHub.\n\n\nCommonMark\nCommonMark is a strongly defined, highly compatible specification of Markdown.\n\n\nHugo\nHugo is an open-source static website generator.\n\n\nDocusaurus\nDocusaurus is an open-source markdown documentation system.\n\n\nMarkua\nMarkua is a markdown variant used by Leanpub.\n\n\n\n\n\nWikis\n\n\n\n\n\n\n\nMediaWiki\nMediaWiki is the native document format of Wikipedia.\n\n\nDokuWiki\nDokuWiki is a simple to use and highly versatile open source wiki software that doesn’t require a database.\n\n\nZimWiki\nZim is a graphical text editor used to maintain a collection of wiki pages.\n\n\nJira Wiki\nJira Wiki is the native document format for the Jira issue tracking and project management system from Atlassian.\n\n\nXWiki\nXWiki is an open-source enterprise wiki system.\n\n\n\n\n\nMore Formats\n\n\n\n\n\n\n\nJATS\nJATS (Journal Article Tag Suite) is an XML format for marking up and exchanging journal content.\n\n\nJupyter\nJupyter Notebooks combine software code, computational output, explanatory text and multimedia resources in a single document.\n\n\nConTeXt\nConTeXt is a system for typesetting documents based on TEX and METAPOST.\n\n\nRTF\nThe Rich Text Format (RTF) is a file format for for cross-platform document interchange.\n\n\nreST\nreStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system.\n\n\nAsciiDoc\nAsciiDoc is a text document format for writing documentation, articles, and books, ebooks, slideshows, web pages, man pages and blogs.\n\n\nOrg-Mode\nOrg-Mode is an Emacs major mode for keeping notes, authoring documents, creating computational notebooks, and more.\n\n\nMuse\nEmacs Muse is an authoring and publishing environment for Emacs.\n\n\nGNU Texinfo\nTexinfo is the official documentation format of the GNU project.\n\n\nGroff Man Page\nThe Groff (GNU troff) man page document formats consists of plain text mixed with formatting commands that produce ASCII/UTF8 for display at the terminal.\n\n\nGroff Manuscript\nThe Groff (GNU troff) manuscript format consists of plain text mixed with formatting commands that produces PostScript, PDF, or HTML.\n\n\nHaddock markup\nHaddock is a tool for automatically generating documentation from annotated Haskell source code.\n\n\nOPML\nOPML (Outline Processor Markup Language) is an XML format for outlines.\n\n\nTextile\nTextile is a simple text markup language that makes it easy to structure content for blogs, wikis, and documentation.\n\n\nDocBook\nDocBook is an XML schema particularly well suited to books and papers about computer hardware and software.\n\n\nInDesign\nICML is an XML representation of an Adobe InDesign document.\n\n\nTEI Simple\nTEI Simple aims to define a new highly-constrained and prescriptive subset of the Text Encoding Initiative (TEI) Guidelines suited to the representation of early modern and modern books.\n\n\nFictionBook\nFictionBook is an open XML-based e-book format."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/all-formats.html\",\n \"source\": \"https://quarto.org/docs/output-formats/all-formats.html\"\n}"}}},{"rowIdx":112,"cells":{"page_content":{"kind":"string","value":"As a part of Quarto, we’ve developed a simple single file format that describes declarations, variables, and rules that should be layered into Scss files when compiling them into css. The basic structure of a theme file is:\n\nA single text file that contains valid Scss\nSpecial comments are used to denote regions of functions, defaults, mixins, and rules (region decorators).\nAt least one of these region decorators must be present in order for the theme file to be valid.\nMore than one of each type of region decorator are permitted. If more than one of any type is present, all regions of a given type will be merged into a single block of that type in the order in which they are encountered in the file.\nWhen compiling, the sections will be layered according to type, functions first, then variables, then mixins, then rules.\nThe directory that contains your theme file will be added to the load path, allowing @use or @import statements to be resolved using the same directory that contains the theme file.\n\nHere is an example file:\n/*-- scss:functions --*/\n@function colorToRGB ($color) {\n @return \"rgb(\" + red($color) + \", \" + green($color) + \", \" + blue($color)+ \")\";\n}\n\n/*-- scss:defaults --*/\n$h2-font-size: 1.6rem !default;\n$headings-font-weight: 500 !default;\n$body-color: $gray-700 !default;\n\n/*-- scss:rules --*/\nh1, h2, h3, h4, h5, h6 {\n text-shadow: -1px -1px 0 rgba(0, 0, 0, .3);\n}\n\nBootswatch Sass Theme Files\nWe’ve merged Bootswatch themes for Bootstrap 5 into this single file theme format in our repo here:\nhttps://github.com/quarto-dev/quarto-cli/tree/main/src/resources/formats/html/bootstrap/themes\nFrom time to time, as the Bootswatch themes are updated, we will update these merged theme files.\n\n\nBootstrap / Bootswatch Layering\nWhen using the Quarto HTML format, we allow the user to specify theme information in the document front matter (or project YAML). The theme information consists of a list of one or more of\n\nA valid built in Bootswatch theme name\nA theme file (valid as described above).\n\nFor example the following would use the cosmo Bootswatch theme and provide customization using the custom.scss file:\ntheme:\n - cosmo\n - custom.scss\nWhen compiling the CSS for a Quarto website or HTML page, we merge any user provided theme file(s) or Bootswatch themes with the Bootstrap Scss in the following layers:\nUses\n Bootstrap\n Theme(s) /*-- scss:uses --*/\n \nFunctions\n Bootstrap\n Theme(s) /*-- scss:functions --*/\n\nVariables\n Themes(s) /*-- scss:defaults --*/\n Bootstrap\n \nMixins \n Bootstrap\n Theme(s) /* -- scss:mixins --*/\n\nRules\n Bootstrap\n Theme(s) /*-- scss:rules --*/\nWe order the themes according to the order that they are specified in the YAML, maintaining the order for declarations and rules and reversing the order for variables (allowing the files specified later in the list to provide defaults variable values to the files specified earlier in the list). Layering of the example themes above would be as follows:\nUses\n Bootstrap\n cosmo /*-- scss:uses --*/\n custom.scss /*-- scss:uses --*/\n\nFunctions\n Bootstrap\n cosmo /*-- scss:functions --*/\n custom.scss /*-- scss:functions --*/\n\nVariables\n custom.scss /*-- scss:defaults --*/\n cosmo /*-- scss:defaults --*/\n Bootstrap\n\nMixins\n Bootstrap\n cosmo /* -- scss:mixins --*/\n custom.scss /* -- scss:mixins --*/\n\nRules\n Bootstrap\n cosmo /*-- scss:rules --*/\n custom.scss /*-- scss:rules --*/"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/html-themes-more.html\",\n \"source\": \"https://quarto.org/docs/output-formats/html-themes-more.html\"\n}"}}},{"rowIdx":113,"cells":{"page_content":{"kind":"string","value":"Overview\nQuarto provides a default layout for HTML pages that should work well for many documents. However, if the default layout isn’t working for your content, you can adjust it.\nOn this page, learn about:\n\nThe three high level layout options for your pages in Page Layout.\nHow to adjust the width of the individual layout components (sidebar, body, margins, and gutter) to fit your content in Grid Customization.\n\n\n\nPage Layout\nBy default Quarto HTML documents display content centered at a width optimized for readability (typically from 600px to 900px wide). While this is a sound default layout for traditional articles, for other types of pages (e.g. landing or index pages) you may want to use other layouts.\nThe page-layout option can be use to control the layout used. For example:\nformat: \n html:\n page-layout: full\nThe various page-layout options are described below.\n\nArticle\npage-layout: article\nArticle layout provides a content area with a page based grid layout that provides margins, areas for sidebars, and a reading width optimized body region. The precise size of the document regions will vary slightly depending upon the sidebar (if present) and the presence or absence of margin or complex layout elements. To learn more, checkout the guide to Article Layout.\n\n\nFull\npage-layout: full\nFull layout uses the article grid system, but automatically expands the content area to use the sidebar and margin region if no content is placed within those regions. This is useful for layouts that don’t need to be constrained to reading width and that will benefit from additional horizontal space (e.g. landing or index pages)\n\n\nCustom\npage-layout: custom\nCustom layout provides a simple HTML content container with no default grid system, padding, or margins. The default HTML framing provided will look this this:\n

\n \n

\nIn websites, custom layouts do not include navigation sidebars but do include the site navbar and footer.\n\nCSS Grid\nIf you are using page-layout: custom, you’ll likely want to utilize the Bootstrap CSS Grid layout system (which is available by default in Quarto documents) for creating more sophisticated layouts.\nFor example, here’s a simple 2-column grid:\n::: {.grid}\n\n::: {.g-col-4}\nThis column takes 1/3 of the page\n:::\n\n::: {.g-col-8}\nThis column takes 2/3 of the page\n:::\n\n:::\nBootstrap’s CSS Grid system includes facilities for responsiveness, wrapping, nesting, and fine grained customization of column behavior.\nNote that this isn’t the traditional Bootstrap grid used in older versions of Bootstrap – rather, it’s a brand new layout system introduced in Bootstrap 5.1 based on the CSS Grid standard. Quarto uses this newer system because it has more sophisticated layout capabilities akin to what LaTeX offers for print documents.\nSee the Bootstrap CSS Grid documentation for additionals details.\n\n\n\n\nGrid Customization\n\n\n\n\n\n\nQuarto 1.3 Feature\n\n\n\nThis feature is new in Quarto 1.3, which you can download at https://quarto.org/docs/download/\n\n\nYou can control the width of the layout components in HTML documents with YAML options and SCSS. For example, if long entries in a sidebar are being wrapped, it may make sense to increase the width of sidebar:\n\n\n\n\n\n\nDefault Layout\n\n\n\n\n\n\n\nWider Sidebar\n\n\n\n\n\nThis change can be made by adding the grid option to the _quarto.yml file, increasing the sidebar-width from its default of 250px:\n\n\n_quarto.yml\n\nformat:\n html:\n grid:\n sidebar-width: 350px\n\nThere are four variables to control the four components of the layout: the sidebar, the body, the margin, and the gutters.\nThe rest of this section describes these components, and their default values, as well as how to customize them either with YAML or SCSS variables. You can also find Additional Examples of customization in action.\n\nHTML Page Layout\nQuarto HTML documents are arranged in a structure composed of a sidebar on the left, the body of the document, the margin of the document on the right, and the space between these elements, known as gutters. This is illustrated below:\n\nThe width of these four components is controlled by four variables. These variables, along with their default values are:\n\n\nDefault values for the width of layout components\n\n\nElement\nSize\n\n\n\n\nsidebar-width\n250px\n\n\nbody-width\n800px\n\n\nmargin-width\n250px\n\n\ngutter-width\n1.5em\n\n\n\n\nThe values of these variables don’t directly specify the display width of the corresponding component, instead they specify a maximum base value. The maximum values are scaled to create minimum values, and together they are used to compute the size and position of each component across different layout types (fixed vs. floating), responsive sizes (large screen vs. mobile size), and page contents (margin vs. no margin content).\n\n\nCustomizing Component Widths\nYou can control the component width variables using YAML or SCSS variables. To set these options in YAML, you may use the grid option :\n\n\n_quarto.yml\n\nformat:\n html: \n grid:\n sidebar-width: 300px\n body-width: 900px\n margin-width: 300px\n gutter-width: 1.5rem\n\n\n\n\n\n\n\nWebsites vs. Standalone HTML Pages\n\n\n\nCustomizing the layout of pages that are part of a Quarto website with YAML should happen at the site level in _quarto.yml. For HTML documents that aren’t part of a website, these options could also be set in the YAML at the top of the document.\n\n\nSimilarly, in a custom theme scss file, you may set variables like:\n// The left hand sidebar\n$grid-sidebar-width: 300px !default;\n\n// The main body\n$grid-body-width: 900px !default;\n\n// The right hand margin bar\n$grid-margin-width: 300px !default;\n\n// The gutter that appears between the above columns\n$grid-column-gutter-width: 1.5rem !default;\nsidebar-width, body-width, and margin-width should be specified in pixels (px) as the values will be used when computing other sizes. Requiring pixel sizing is a limitation of our approach to the Quarto’s layout, but also typically makes sense since the overall document width is usually tied to the browser size and responsive breakpoints rather than font size or other relative measures.\ngutter-width may be specified in pixels or other units such as em or rem which are responsive to the document font size.\n\n\nAdditional Examples\nIncreasing the margin width may make sense on a website that has many figures or tables in the margin. For example, this YAML increases the margin-width by 200px over the default value:\nformat:\n html:\n grid:\n margin-width: 450px\n\n\n\n\n\n\nDefault Layout\n\n\n\n\n\n\n\nWider Margin\n\n\n\n\n\nThe effect of changing margin-width without changing body-width is to increase the overall page width (there is less white space on the far left and right of the page). Alternatively, to keep the overall page width the same body-width can be decreased by the same amount as margin-width increased:\nformat:\n html:\n grid:\n margin-width: 450px\n body-width: 600px\n\n\n\n\n\n\nDefault Layout\n\n\n\n\n\n\n\nWider Margin, Narrower Body"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.703Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/page-layout.html\",\n \"source\": \"https://quarto.org/docs/output-formats/page-layout.html\"\n}"}}},{"rowIdx":114,"cells":{"page_content":{"kind":"string","value":"Overview\nUse the pdf format to create PDF output. For example:\n---\ntitle: \"My document\"\nformat:\n pdf:\n toc: true\n number-sections: true\n colorlinks: true\n---\nThis example highlights a few of the options available for PDF output. This article covers these and other options in detail. See the PDF format reference for a complete list of all available options.\nIf you want to produce raw LaTeX output (a .tex file) rather than a PDF, all of the options documented here are still available (see the LaTeX Output section below for additional details).\n\n\n\n\n\n\nNote\n\n\n\nNote that while we will focus here exclusively on the use LaTeX to create PDFs, Pandoc also has support for creating PDFs using ConTeXt, roff ms, or HTML (via wkhtmltopdf). See the Pandoc documentation on Creating a PDF for additional details.\n\n\n\nPrerequisites\nIn order to create PDFs you will need to install a recent distribution of TeX. We recommend the use of TinyTeX (which is based on TexLive), which you can install with the following command:\n\n\nTerminal\n\nquarto install tinytex\n\nSee the article on PDF Engines for details on using other TeX distributions and PDF compilation engines.\n\n\n\nDocument Class\nQuarto uses KOMA Script document classes by default for PDF documents and books. KOMA-Script classes are drop-in replacements for the standard classes with an emphasis on typography and versatility.\nFor PDF documents this results in the following Pandoc options set by default:\nformat:\n pdf:\n documentclass: scrartcl\n papersize: letter\nYou can set documentclass to the standard article, report or book classes, to the KOMA Script equivalents scrartcl, scrreprt, and scrbook respectively, or to any other class made available by LaTeX packages you have installed.\n\n\n\n\n\n\nNote\n\n\n\nSetting your documentclass to either book or scrbook will automatically handle many of the common needs for printing and binding PDFs into a physical book (i.e., chapters start on odd pages, alternating margin sizes, etc).\n\n\nSee the Output Options section below for additional details on customizing LaTeX document options.\n\n\nTable of Contents\nUse the toc option to include an automatically generated table of contents in the output document. Use the toc-depth option to specify the number of section levels to include in the table of contents. The default is 3 (which means that level-1, 2, and 3 headings will be listed in the contents). For example:\ntoc: true\ntoc-depth: 2\nYou can customize the title used for the table of contents using the toc-title option:\ntoc-title: Contents\nIf you want to exclude a heading from the table of contents, add both the .unnumbered and .unlisted classes to it:\n### More Options {.unnumbered .unlisted}\n\n\nSection Numbering\nUse the number-sections option to number section headings in the output document. For example:\nnumber-sections: true\nUse the number-depth option to specify the deepest level of heading to add numbers to (by default all headings are numbered). For example:\nnumber-depth: 3\nTo exclude an individual heading from numbering, add the .unnumbered class to it:\n### More Options {.unnumbered}\n\n\nSyntax Highlighting\nPandoc will automatically highlight syntax in fenced code blocks that are marked with a language name. For example:\n```python\n1 + 1\n```\nPandoc can provide syntax highlighting for over 140 different languages (see the output of quarto pandoc --list-highlight-languages for a list of all of them). If you want to provide the appearance of a highlighted code block for a language not supported, just use default as the language name.\nYou can specify the code highlighting style using highlight-style and specifying one of the supported themes. Supported themes include: arrow, pygments, tango, espresso, zenburn, kate, monochrome, breezedark, haddock, atom-one, ayu, breeze, dracula, github, gruvbox, monokai, nord, oblivion, printing, radical, solarized, and vim.\nFor example:\nhighlight-style: github\nHighlighting themes can provide either a single highlighting definition or two definitions, one optimized for a light colored background and another optimized for a dark color background. When available, Quarto will automatically select the appropriate style based upon the code chunk background color’s darkness. You may always opt to specify the full name (e.g. atom-one-dark) to bypass this automatic behavior.\nBy default, code is highlighted using the arrow theme, which is optimized for accessibility. Here are examples of the arrow light and dark themes:\n\nLightDark\n\n\n\n\n\n\n\n\n\n\n\nCode Annotation\nYou can add annotations to lines of code in code blocks and executable code cells. See Code Annotation for full details.\n\n\nOutput Options\nThere are numerous options available for customizing PDF output, including:\n\nSpecifying document classes and their options\nIncluding lists of figures and tables\nUsing the geometry and hyperref packages\nNumerous options for customizing fonts and colors.\n\nFor example, here we use a few of these options:\n---\ntitle: \"My Document\"\nformat: \n pdf: \n documentclass: report\n classoption: [twocolumn, landscape]\n lof: true\n lot: true\n geometry:\n - top=30mm\n - left=20mm\n - heightrounded\n fontfamily: libertinus\n colorlinks: true\n---\nSee the Pandoc documentation on metadata variables for LaTeX for documentation on all available options.\n\n\nCitations\nWhen creating PDFs, you can choose to use either the default Pandoc citation handling based on citeproc, or alternatively use natbib or BibLaTeX. This can be controlled using the cite-method option. For example:\nformat:\n pdf: \n cite-method: biblatex\nThe default is to use citeproc (Pandoc’s built in citation processor).\nSee the main article on using Citations with Quarto for additional details on citation syntax, available bibliography formats, etc.\n\nOptions\nWhen using natbib or biblatex you can specify the following additional options to affect how bibliographies are rendered:\n\n\n\nOption\nDescription\n\n\n\n\nbiblatexoptions\nList of options for biblatex\n\n\nnatbiboptions\nList of options for natbib\n\n\nbiblio-title\nTitle for bibliography\n\n\nbiblio-style\nStyle for bibliography\n\n\n\n\n\n\nRaw LaTeX\nWhen creating a PDF document, Pandoc allows the use of raw LaTeX directives intermixed with markdown. For example:\n\\begin{tabular}{|l|l|}\\hline\nAge & Frequency \\\\ \\hline\n18--25 & 15 \\\\\n26--35 & 33 \\\\\n36--45 & 22 \\\\ \\hline\n\\end{tabular}\nRaw LaTeX commands will be preserved and passed unchanged to the LaTeX writer.\n\n\n\n\n\n\nWarning\n\n\n\nWhile it’s very convenient to use raw LaTeX, raw LaTeX is ignored when rendering to other formats like HTML and MS Word. If you plan on rendering to other formats then the example above would be better written using native markdown tables.\n\n\nIn some cases raw LaTeX will require additional LaTeX packages. The LaTeX Includes section below describes how to include \\usepackage commands for these packages in your document.\n\n\nLaTeX Includes\nIf you want to include additional content in your document from another file, you can use the include-in-* options:\n\n\n\n\n\n\n\nOption\nDescription\n\n\n\n\ninclude-in-header\nInclude contents of file, verbatim, at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents or to inject commands into the LaTeX preamble.\n\n\ninclude-before-body\nInclude contents of file, verbatim, at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX). This can be used to include navigation bars or banners in HTML documents.\n\n\ninclude-after-body\nInclude contents of file, verbatim, at the end of the document body (before the tag in HTML, or the \\end{document} command in LaTeX).\n\n\n\nYou can specify a single file or multiple files for each of these options directly, or use the file: subkey. To include raw content in the YAML header, use the text subkey. When using text:, add the | character after text: to indicate that the value is a multi-line string. If you omit file: or text:, Quarto assumes you are providing a file.\nFor example:\nformat:\n pdf:\n include-in-header:\n - text: |\n \\usepackage{eplain}\n \\usepackage{easy-todo}\n - file: packages.tex\n - macros.tex \nAny packages specified using includes that you don’t already have installed locally will be installed by Quarto during the rendering of the document.\n\n\nLaTeX Output\nIf you want Quarto to produce a LaTeX file (.tex) rather than a PDF (for example, if you want to do your own processing of the PDF) there are two ways to accomplish this:\n\nUse the latex format rather than the pdf format. For example:\nformat:\n latex:\n documentclass: report\n classoption: [twocolumn, landscape]\n lof: true\n lot: true\nNote that all of the PDF format options documented above will also work for the latex format.\nUse the pdf format along with the keep-tex option. For example:\nformat:\n pdf:\n documentclass: report\n keep-tex: true\nThis technique will produce a PDF file for preview, but will also create a .tex file alongside it that you can do subsequent processing on.\n\n\n\nUnicode Characters\nBy default, Quarto uses the xelatex engine to produce PDFs from LaTeX. xelatex has native support for unicode characters, but it is possible some customization will be required in order to properly typeset specific unicode characters. In particular, it is important that you use a font that supports the characters that you using in your document. To identify fonts on your system that support specific language characters, you can use the following command:\n\n\nTerminal\n\nfc-list :lang=\n\nFor example, to see a list of fonts that support Japanese characters, use:\n\n\nTerminal\n\nfc-list :lang=ja\n\nSelect a font name from the list and use that as the document’s main font, like:\n---\ntitle: Unicode test\nformat: pdf\nmainfont: \"Hiragino Sans GB\"\n---\n\n## Test Document\n\n青黑體簡體中文,ヒラギノ角"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.703Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/pdf-basics.html\",\n \"source\": \"https://quarto.org/docs/output-formats/pdf-basics.html\"\n}"}}},{"rowIdx":115,"cells":{"page_content":{"kind":"string","value":"Overview\nWhile markdown is the input format for Quarto, it can also in some cases be an output format (for example, if you have a website or CMS that accepts markdown as input and want to incorporate computations from Python or R).\nThis article covers using Quarto to generate GitHub Flavored Markdown (GFM). You might want to do this in order to:\n\nGenerate a GitHub README.md from a Jupyter notebook\nCreate pages for a GitHub wiki that include computations (e.g. plot output).\n\n\n\nGFM Format\nUse the gfm format to create GitHub Flavored Markdown from Quarto. For example:\n---\ntitle: \"My Project\"\nformat: gfm\n---\nSee the GFM format reference for a complete list of all options available for GFM output.\nTo create a README.md using Quarto, start with a notebook (.ipynb) or computational markdown file (.qmd) that has README as its file name stem, for example:\n\n\nREADME.qmd\n\n---\ntitle: \"My Project\"\nformat: gfm\njupyter: python3\n---\n\nThis is a GitHub README that has content dynamically generated from Python:\n \n```{python}\n1 + 1\n```\n\nRender the README with:\n\n\nTerminal\n\nquarto render README.qmd\n\nWhich will create README.md alongside your input file.\n\n\nPreview Mode\nWhen you quarto preview a GitHub Flavored Markdown document, by default an HTML preview that approximates the look of markdown rendered on GitHub is shown. If you’d prefer to see the raw generated markdown, use the preview-mode: raw option. For example:\n---\ntitle: \"My Project\"\nformat: \n gfm:\n preview-mode: raw\n---\n\n\nWebTeX Math\nThe gfm format renders LaTeX equations using standard dollar-delimited inline ($...$) and display ($$...$$) syntax. However, if the web environment you are publishing into doesn’t support dollar-delimited math, you can alternatively use WebTeX to display math. This is done by setting the Pandoc html-math-method to webtex. For example:\nformat:\n gfm:\n html-math-method: webtex\nWebTeX works for any web page that can display images, and requires no special JavaScript or CSS. Any inline or display equations contained within your document will be converted to an image URL that requests a rendered version of the equation. For example, the following markdown:\n$x + 1$\nWill be converted to:\n\nWhich renders as:\n\n\nDark Mode\nSVG is used as the default rendering method because it has the best overall appearance. However, if your gfm document is being rendered on a dark background, you may want to switch to PNG with a dark background specified. You can do this as follows:\nformat:\n gfm:\n html-math-method: \n method: webtex\n url: https://latex.codecogs.com/png.image?%5Cbg_black&space;\n\n\n\nGitHub Wikis\nIf you want to use Quarto to incorporate computations into a GitHub wiki start by cloning the wiki for local editing.\nThen, simply create a computational markdown file (.ipynb, .qmd) for each page in the wiki. You can render all of these files at once into their corresponding .md files using Quarto Projects. For example:\n\n\nTerminal\n\nquarto render\n\nYou don’t even strictly need a Quarto project file to do this as quarto render will render all input files in a directory by default if there is no project file."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/gfm.html\",\n \"source\": \"https://quarto.org/docs/output-formats/gfm.html\"\n}"}}},{"rowIdx":116,"cells":{"page_content":{"kind":"string","value":"_ Find your operating system in the table below\n\n\nYou can install Quarto for a single user on Linux by using the Quarto tarball and following the below set of steps.\n1. Download the tarball\n\n\nTerminal\n\nwget https://github.com/quarto-dev/quarto-cli/releases/download/v^version^/quarto-^version^-linux-amd64.tar.gz\n\n2. Extract Files\nExtract the contents of the tarball to the location where you typically install software (e.g. ~/opt). For example:\n\n\nTerminal\n\nmkdir ~/opt\ntar -C ~/opt -xvzf quarto-^version^-linux-amd64.tar.gz\n\n3. Create a Symlink\nCreate a symlink to bin/quarto in a folder that is in your path. If there is no such folder, you can create a folder such as ~/bin and place the symlink there. For example:\nFor example:\n\n\nTerminal\n\nmkdir ~/bin\nln -s ~/opt/quarto-^version^/bin/quarto ~/bin/quarto\n\n4. Add Folder to Path\nEnsure that the folder where you created a symlink is in the path. For example:\n\n\nTerminal\n\n( echo \"\"; echo 'export PATH=$PATH:~/bin\\n' ; echo \"\" ) >> ~/.profile\nsource ~/.profile\n\n5. Check The Installation\nUse quarto check to confirm that the installation is successful:\n\n\nTerminal\n\nquarto check"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/download/tarball.html\",\n \"source\": \"https://quarto.org/docs/download/tarball.html\"\n}"}}},{"rowIdx":117,"cells":{"page_content":{"kind":"string","value":"Current Release — vPre-release — vOlder Releases\n\n\n\n\n_ Find your operating system in the table below\n\n\n\n\n\n\nRelease Notes\n\n\n\n\n\n\n\n\n_ Find your operating system in the table below\n\n\n\n\n\n\nHighlights\nQuarto 1.4 includes the following new features:\n\nTypst Format—Support for the typst output format. Typst is a new open-source markup-based typesetting system that is designed to be as powerful as LaTeX while being much easier to learn and use.\nLua changes—Quarto v1.4 adds new features to writers of Lua filters.\n\n\n\nRelease Notes\n\n\n\n\n\n\nPages containing all installers for the most recent releases of older versions of Quarto are linked below.\n\n\n\n\n\nTitle\n\n\nDate\n\n\nUrl\n\n\n\n\n\n\nv1.2.475\n\n\nMar 22, 2023\n\n\nhttps://github.com/quarto-dev/quarto-cli/releases/tag/v1.2.475\n\n\n\n\nv1.1.189\n\n\nSep 4, 2022\n\n\nhttps://github.com/quarto-dev/quarto-cli/releases/tag/v1.1.189\n\n\n\n\nv1.0.38\n\n\nAug 4, 2022\n\n\nhttps://github.com/quarto-dev/quarto-cli/releases/tag/v1.0.38\n\n\n\n\n\nNo matching items"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/download/index.html\",\n \"source\": \"https://quarto.org/docs/download/index.html\"\n}"}}},{"rowIdx":118,"cells":{"page_content":{"kind":"string","value":"In some cases you may want to create content that only displays for a given output format (or only displays when not rendering to a format). You can accomplish this by creating divs with the .content-visible and .content-hidden classes.\n\n.content-visible\nTo make content visible only for a given format, create a div (:::) with the .content-visible class. For example, here we mark content as only visible in HTML:\n::: {.content-visible when-format=\"html\"}\n\nWill only appear in HTML.\n\n:::\nYou can also mark content as visible for all formats except a specified format. For example:\n::: {.content-visible unless-format=\"pdf\"}\n\nWill not appear in PDF.\n\n:::\nThen when-format and unless-format attributes match the current Pandoc output format with some additional intelligence to alias related formats (e.g. html, html4, and html5). Details are provided below in Format Matching\n\n\n.content-hidden\nTo prevent content from being displayed when rendering to a given format, create a div (:::) with the .content-hidden class. For example, here we mark content as hidden in HTML:\n::: {.content-hidden when-format=\"html\"}\n\nWill not appear in HTML.\n\n:::\nYou can also mark content as hidden for all formats except a specified format. For example:\n::: {.content-hidden unless-format=\"pdf\"}\n\nWill only appear in PDF.\n\n:::\n\n\nFormat Matching\nThen when-format and unless-format clauses do some aliasing of related formats to make it more straightforward to target content. The following aliases are implemented:\n\n\n\nAlias\nFormats\n\n\n\n\nlatex\nlatex, pdf\n\n\npdf\nlatex, pdf\n\n\nepub\nepub*\n\n\nhtml\nhtml*, epub*, revealjs\n\n\nhtml:js\nhtml*, revealjs\n\n\nmarkdown\nmarkdown*, commonmark*, gfm, markua\n\n\n\nNote that the html:js alias indicates that the target format is capable of executing JavaScript (this maps to all HTML formats save for ePub)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.139Z\",\n \"loc\": \"https://quarto.org/docs/authoring/conditional.html\",\n \"source\": \"https://quarto.org/docs/authoring/conditional.html\"\n}"}}},{"rowIdx":119,"cells":{"page_content":{"kind":"string","value":"Overview\nHTML pages rendered with Quarto include a formatted appendix at the end of the article. The appendix includes sections for citations and footnotes in the document, as well the attribution information (if specified) for the document itself.\nA simple example document appendix looks like:\n\nTo learn more about including document attribution information in the appendix, see Creating Citeable Articles.\n\n\nCustom Appendix Sections\nSections of your document can be added to the Appendix that appears at the end of your article by adding the .appendix class to any header. For example:\n## Acknowledgments {.appendix}\n\nI am grateful for the insightful comments offered by the anonymous peer reviewers at Books & Texts. The generosity and expertise of one and all have improved this study in innumerable ways and saved me from many errors; those that inevitably remain are entirely my own responsibility.\nAny sections marked with the .appendix class will be included at the front of the appendix in the order in which they appear in the document. A more complete example appendix including attribution and the above custom appendix section looks like:\n\n\n\nLicense\nIf you include a license in the front matter or citation information for your document, a ‘Reuse’ section will automatically be added to the appendix. Read more about specifying a license in Front Matter.\nHere is an example of a complete appendix including all the fields with an Attribution-ShareAlike Creative Commons license.\n\n\n\nAppendix Style\nYou can control how Quarto process the appendix of your document using the appendix-style option. There are three options available:\n\ndefault\n\nThe default appendix treatment create a smaller font face and gathers the various sections into stylized groups at the end of the document.\n\nplain\n\nThe plain treatment will do all the appendix processing (gathering and organizing the sections at the end of the document, creating sections like ‘Reuse’), but will not apply the default appendix styling.\n\nnone\n\nnone disables appendix processing altogether. Content will not be processed or organized and information like ‘Citation’ and ‘Reuse’ will not be included in the document."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.135Z\",\n \"loc\": \"https://quarto.org/docs/authoring/appendices.html\",\n \"source\": \"https://quarto.org/docs/authoring/appendices.html\"\n}"}}},{"rowIdx":120,"cells":{"page_content":{"kind":"string","value":"Reveal Presentation\nlibrary(tidyverse)\nlibrary(palmerpenguins)\n1penguins |>\n2 mutate(\n bill_ratio = bill_depth_mm / bill_length_mm,\n bill_area = bill_depth_mm * bill_length_mm\n )\n\n1\n\nTake penguins, and then,\n\n2\n\nadd new columns for the bill ratio and bill area."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.139Z\",\n \"loc\": \"https://quarto.org/docs/authoring/code-annotation-example/revealjs.html\",\n \"source\": \"https://quarto.org/docs/authoring/code-annotation-example/revealjs.html\"\n}"}}},{"rowIdx":121,"cells":{"page_content":{"kind":"string","value":"Overview\nYou can embed videos in documents using the {{< video >}} shortcode. For example, here we embed a YouTube video:\n{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}\nVideos can refer to video files (e.g. .mp4) or can be links to videos published on YouTube, Vimeo, or BrightCove.\nHere are some additional examples that demonstrate using various video sources and options:\n{{< video local-video.mp4 >}}\n\n{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}\n\n{{< video https://vimeo.com/548291297 >}}\n\n{{< video https://youtu.be/wo9vZccmqwc width=\"400\" height=\"300\" >}}\n\n{{< video https://www.youtube.com/embed/wo9vZccmqwc\n title=\"What is the CERN?\"\n start=\"116\"\n aspect-ratio=\"21x9\" \n>}}\nIn HTML formats the video will be embedded within the document. For other formats, a simple link to the video will be rendered.\nNext, we’ll cover the various options available for video embedding. For additional details on using videos within Revealjs presentations (including how to create slides with full-screen video backgrounds), see the Revealjs section below.\n\n\nVideo URL\nThe video URL can specify either a path to a video file (e.g. a .mp4) alongside the document, a remote URL to a video file, or a URL to a video service (YouTube, Vimeo, or BrightCove).\nThese are valid URLs for video files:\n{{< video local-video.mp4 >}}\n{{< video https://videos.example.com/video.mp4 >}}\nFor video services, a variety of URL forms are supported. For example, the following video service URLs are all valid:\n{{< video https://youtu.be/wo9vZccmqwc >}}\n{{< video https://www.youtube.com/watch?v=wo9vZccmqwc >}}\n{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}\n{{< video https://vimeo.com/548291297 >}}\n{{< video https://players.brightcove.net/1460825906/default_default/index.html?videoId=5988531335001 >}}\nNote that YouTube videos support both the URL that is available in the address bar when watching a video as well as the standard URLs used for linking and embedding. BrightCove videos are embedded using the standard iframe embed code.\n\n\nOptions\n\nAspect Ratio\nVideos are automatically rendered responsively using the full width of the document’s main text column. The aspect-ratio specifies how the height should vary with changes in width. For example:\n{{< video https://youtu.be/wo9vZccmqwc aspect-ratio=\"4x3\" >}}\nAvailable aspect ratios include 1x1, 4x3, 16x9 (the default), and 21x9.\n\nWidth and Height\nYou can disable responsive sizing by providing explicit width and height attributes. For example:\n{{< video https://youtu.be/wo9vZccmqwc width=\"250\" height=\"175\" >}}\nThis will produce a video that redners at the specified dimensions and is not responsive. Note that when no height or width are specified, videos will size responsively given the space available to them.\n\n\n\nStart Time\nFor YouTube videos, you can specify a start option to indicate how many seconds into the video you want to start playing:\n{{< video https://youtu.be/wo9vZccmqwc start=\"10\" >}}\n\n\nFrame Title\nThe title option adds a title attribute to the video \n\nElephant\n:::\nNote that the last paragraph in the div block is used as the figure caption.\n\n\nLaTeX Figures\nThis section describes some figure handling options that are specific to LaTeX output.\nOne very important thing to note is that using the fig-env and fig-pos options described below will trigger the creation of a LaTeX floating environment (most often \\begin{figure}). Depending upon where this LaTeX is generated it (e.g. is it within another \\begin{figure}) this could generate invalid LaTeX. To be on the safe side these attributes should typically only be used for images at the very top level of your document.\n\nEnvironments\nThere are a number of LaTeX packages that provide custom figure environments. For example, the mdframed package includes an mdframed environment used to enclose figures in a special border style. By default, Quarto uses the standard figure environment, but you can use the fig-env attribute to specify a custom one. For example:\n---\ntitle: \"Sidenotes\"\nformat:\n pdf:\n include-in-header: \n text: |\n \\usepackage{mdframed}\n---\n\n{fig-env=\"mdframed\"}\n\n\nFigure Position\nThe default LaTeX figure is a floating environment, so the specific location it appears in your document will depend on its size and the nature of the other content around it. You can exercise some control over this behavior using the fig-pos option. The fig-pos option provides a placement specifier for the figure environment. For example, the ht in this LaTeX snippet is the fig-pos:\n\\begin{figure}[ht]\n\n\\end{figure}\nYou can specify fig-pos either at the document level, as a executable code block option, or within markdown. Here we do all three:\n---\ntitle: \"My Document\"\nformat:\n pdf:\n fig-pos: 'h'\n---\n\n```{python}\n#| fig-pos: 't'\n\n```\n\n{fig-pos='b'}\nSee this article for additional details on LaTeX figure positioning.\n\n\n\n\n\n\nFigures and Code Blocks\n\n\n\nIf your figure was generated by an executable code block and the code was included in the output (echo: true), then fig-pos will be set to H by default (to try to keep it alongside the code that generated it). In all other cases, default LaTeX handing of figure position is used unless you specify an explicit fig-pos.\n\n\n\n\nPGF/TikZ Graphics\nIf you are creating LaTeX output, Quarto will automatically emit the correct LaTeX for markdown images that reference .tex files containg PGF/TikZ vector graphics. For example, the following markdown images:\n\n\n{width=80%}\nWill be written to LaTeX as:\n\\input{image1.tex}\n\n\\resizebox{0.8\\linewidth}{!}{\\input{image2.tex}}\nAs shown above, width and height percentages are automatically converted to \\linewidth scaled. Alternatively you can specify custom LaTeX for the width and height arguments of \\resizebox.\n\n\n\nCaption Locations\nBy default, figure captions are positioned below figures. In HTML and PDF formats, you can modify this behavior using the fig-cap-location option. For example:\n---\nfig-cap-location: top\n---\nNote that this option is specified at the top level so that it can be shared by both PDF and HTML formats. If you are only targeting a single format you can place it alongside other format specific options.\nValid values for the caption location include:\n\n\n\nValue\nDescription\n\n\n\n\ntop\nPosition the caption above the figure.\n\n\nbottom\nPosition the caption below the figure.\n\n\nmargin\nPosition the caption in the margin.\n\n\n\nSee the article on Article Layout for additional details on placing captions in the margin.\n\n\nCustom Layouts\nThe examples above used the layout-ncol or layout-nrow attributes to create straightforward layouts where all columns are of equal sizes. The layout attribute enables the creation of much more complex layouts.\nFor example, this defines a layout with two equally sized figures in the first row, then another image that spans the entire second row:\n::: {layout=\"[[1,1], [1]]\"}\n\n\n\n\n\n:::\n\nThe layout attribute is a 2-dimensional array where the first dimension defines rows and the second columns. In this case \"layout=\"[[1,1], [1]]\" translates to: create two rows, the first of which has two columns of equal size and the second of which has a single column.\nNote that the numbers in a row are arbitrary and don’t need to add up to a particular total. You can therefore use whatever scheme is most natural. For example, here we define columns that occupy varying percentage widths of the row:\n::: {layout=\"[[70,30], [100]]\"}\n\n\n\n\n\n:::\nYou can also use negative values to create space between elements. For example:\n::: {layout=\"[[40,-20,40], [100]]\"}\n\n\n\n\n\n:::\n\n\nVertical Alignment\nIf you have a layout with a row of images of differing heights, you can control their vertical alignment using the layout-valign attribute. A simple example:\n::: {layout=\"[25,-2,10]\" layout-valign=\"bottom\"}\n\n\n\n:::\n\nNote that vertical alignment isn’t limited to images, you can also vertically align any other elements that are included in a panel.\n\n\n\nComputations\n\nFigures\nNote that figure layout attributes also work for figures produced by executable code blocks. Here are examples for both Jupyter and Knitr:\n\nJupyterKnitr\n\n\n```{python}\n#| layout-ncol: 2\n#| fig-cap: \n#| - \"Line Plot 1\"\n#| - \"Line Plot 2\"\n\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\n\nplt.plot([8,65,23,90])\nplt.show()\n```\n\n\n\n```{r}\n#| layout-ncol: 2\n#| fig-cap: \n#| - \"Speed and Stopping Distances of Cars\"\n#| - \"Vapor Pressure of Mercury as a Function of Temperature\"\n\nplot(cars)\nplot(pressure)\n```\n\n\n\n\nNote that in these examples we also use the fig-cap option to apply a caption to each of the generated figures.\n\n\nSubcaptions\nYou can create subcaptions for computational output by combining the fig-cap and fig-subcap options. When applying captions to computational output you can optionally include a label with a fig- prefix—if you do this then the figure will be numbered and cross-referenceable.\n\nJupyterKnitr\n\n\n```{python}\n#| label: fig-charts\n#| fig-cap: \"Charts\"\n#| fig-subcap: \n#| - \"First\"\n#| - \"Second\"\n#| layout-ncol: 2\n\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\n\nplt.plot([8,65,23,90])\nplt.show()\n```\n\n\n\n```{r}\n#| label: fig-charts\n#| fig-cap: \"Charts\"\n#| fig-subcap: \n#| - \"Cars\"\n#| - \"Pressure\"\n#| layout-ncol: 2\n\nplot(cars)\nplot(pressure)\n```\n\n\n\n\n\n\nCustom Layout\nThe layout works the same way for figures produced by Knitr or Jupyter. For example, here’s an Rmd code chunk that produces 3 plots and defines a custom layout for them:\n```{r}\n#| layout: [[45,-10, 45], [100]]\n\nplot(cars)\nplot(pressure)\nplot(mtcars)\n```\n\n\n\n\nBlock Layout\nWhile the examples above illustrate laying out figures, it’s important to note that layout attributes can be used to layout any sort of block content. For example, here we layout 2 lists side-by-side:\n::: {layout-ncol=2}\n### List One\n\n- Item A\n- Item B\n- Item C\n\n### List Two\n\n- Item X\n- Item Y\n- Item Z\n:::\nNote that headings are automatically combined with the block that follows them, so this markdown has a total of 2 columns to lay out. Here’s an example of a paragraph next to a bullet list (without headings):\n::: {layout-ncol=2}\n- Item X\n- Item Y\n- Item Z\n\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur gravida eu erat et fring. Morbi congue augue vel eros ullamcorper, eget convallis tortor sagittis. Fusce sodales viverra mauris a fringilla. Donec feugiat, justo eu blandit placerat, enim dui volutpat turpis, eu dictum lectus urna eu urna. Mauris sed massa ornare, interdum ipsum a, semper massa. \n:::"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.139Z\",\n \"loc\": \"https://quarto.org/docs/authoring/figures.html\",\n \"source\": \"https://quarto.org/docs/authoring/figures.html\"\n}"}}},{"rowIdx":150,"cells":{"page_content":{"kind":"string","value":"Overview\nQuarto includes a number of features aimed at making it easy to to author and customize markdown table output, including:\n\nSpecifying column alignment and widths.\nProviding captions, subcaptions, and cross-references.\nGenerating tables dynamically from executable code cells.\n\nThis article covers using these features in-depth.\n\n\nMarkdown Tables\nThe most commonly used markdown table is known as a pipe table. Pipe tables support specifying per column alignment as well as captions. For example:\n\n\n\n| Default | Left | Right | Center |\n|---------|:-----|------:|:------:|\n| 12 | 12 | 12 | 12 |\n| 123 | 123 | 123 | 123 |\n| 1 | 1 | 1 | 1 |\n\n: Demonstration of pipe table syntax\n\n\n\nDemonstration of pipe table syntax\n\n\nDefault\nLeft\nRight\nCenter\n\n\n\n\n12\n12\n12\n12\n\n\n123\n123\n123\n123\n\n\n1\n1\n1\n1\n\n\n\n\n\n\nThe beginning and ending pipe characters are optional, but pipes are required between all columns. The colons indicate column alignment as shown. The header cannot be omitted, however you can simulate a headerless table by including a header with blank cells.\nSince the pipes indicate column boundaries, columns need not be vertically aligned, as they are in the above example. So, this is a perfectly legal (though ugly) pipe table:\nfruit| price\n-----|-----:\napple|2.05\npear|1.37\norange|3.09\nThe cells of pipe tables cannot contain block elements like paragraphs and lists, and cannot span multiple lines. If a pipe table contains a row whose markdown content is wider than the column width (see columns option), then the table will take up the full text width and the cell contents will wrap, with the relative cell widths determined by the number of dashes in the line separating the table header from the table body.\nFor example ---|- would make the first column 3/4 and the second column 1/4 of the full text width. On the other hand, if no lines are wider than column width, then cell contents will not be wrapped, and the cells will be sized to their contents.\n\nUsing Bootstrap classes\nBootstrap table classes given as attributes next to a table caption are inserted into the element. The classes permitted are those that apply expressly to the entire table, and these are: \"primary\", \"secondary\", \"success\", \"danger\", \"warning\", \"info\", \"light\", \"dark\", \"striped\", \"hover\", \"active\", \"bordered\", \"borderless\", \"sm\", \"responsive\", \"responsive-sm\", \"responsive-md\", \"responsive-lg\", \"responsive-xl\", \"responsive-xxl\". For example, the following Markdown table will be rendered with row stripes and the rows will also be highlighted on hover:\n\n\n\n| fruit | price |\n|--------|--------|\n| apple | 2.05 |\n| pear | 1.37 |\n| orange | 3.09 |\n\n: Fruit prices {.striped .hover}\n\n\n\nFruit prices\n\n\nfruit\nprice\n\n\n\n\napple\n2.05\n\n\npear\n1.37\n\n\norange\n3.09\n\n\n\n\n\n\n\n\nAuthoring\nFor simple tables with only a few cells it’s straightforward to create them directly in markdown. As tables get larger, it makes sense to use an authoring tool. Some table authoring tools to consider include:\n\n\n\n\n\n\n\nTablesGenerator\nOnline tool for generating markdown tables\n\n\nEmacs TableMode\nText based table creation and editing capabilities for Emacs.\n\n\nQuarto Visual Editor\nVisual editor for .qmd files with table editing support.\n\n\n\n\n\n\nColumn Widths\nAbove we describe a means of specifying column widths using the relative number of dashes in each column header (e.g., ---|- to get a 75% / 25% split for a two-column table).\nYou can also explicitly specify columns widths using the tbl-colwidths attribute or document-level option. For an individual markdown table, add the attribute after the caption. For example:\n\n\n\n| fruit | price |\n|--------|--------|\n| apple | 2.05 |\n| pear | 1.37 |\n| orange | 3.09 |\n\n: Fruit prices {tbl-colwidths=\"[75,25]\"}\n\n\n\nFruit prices\n\n\n\n\n\n\nfruit\nprice\n\n\n\n\napple\n2.05\n\n\npear\n1.37\n\n\norange\n3.09\n\n\n\n\n\n\nIf your table doesn’t have a caption, then you can still specify only tbl-colwidths:\n\n\n\n| fruit | price |\n|--------|--------|\n| apple | 2.05 |\n| pear | 1.37 |\n| orange | 3.09 |\n\n: {tbl-colwidths=\"[75,25]\"}\n\n\n\n\n\n\n\n\n\nfruit\nprice\n\n\n\n\napple\n2.05\n\n\npear\n1.37\n\n\norange\n3.09\n\n\n\n\n\n\nColumn widths can also be specified at the document level (e.g., to have uniform widths across a set of tables):\n---\ntitle: \"My Document\"\nformat: html\ntbl-colwidths: [75,25]\n---\n\n\nCross References\nFor tables produced by executable code cells, include a label with a tbl- prefix to make them cross-referenceable. For example:\n\n```{python}\n#| label: tbl-planets\n#| tbl-cap: Astronomical object\n\nfrom IPython.display import Markdown\nfrom tabulate import tabulate\ntable = [[\"Sun\",\"696,000\",1.989e30],\n [\"Earth\",\"6,371\",5.972e24],\n [\"Moon\",\"1,737\",7.34e22],\n [\"Mars\",\"3,390\",6.39e23]]\nMarkdown(tabulate(\n table, \n headers=[\"Astronomical object\",\"R (km)\", \"mass (kg)\"]\n))\n```\n\n\n\nTable 1: Astronomical object\n\n\nAstronomical object\nR (km)\nmass (kg)\n\n\n\n\nSun\n696,000\n1.989e+30\n\n\nEarth\n6,371\n5.972e+24\n\n\nMoon\n1,737\n7.34e+22\n\n\nMars\n3,390\n6.39e+23\n\n\n\n\n\n\n\n\n\n\n\n\nLabel Prefix\n\n\n\nIn order for a table to be cross-referenceable, its label must start with the tbl- prefix.\n\n\nFor markdown tables, add a caption below the table, then include a #tbl- label in braces at the end of the caption. For example:\n| Col1 | Col2 | Col3 |\n|------|------|------|\n| A | B | C |\n| E | F | G |\n| A | G | G |\n\n: My Caption {#tbl-letters}\n\nSee @tbl-letters.\nWhich looks like this when rendered to HTML:\n\n\nSubtables\nYou may want to create a composition of several sub-tables. To do this, create a div with a main identifier, then apply sub-identifiers (and optional caption text) to the contained tables. For example:\n::: {#tbl-panel layout-ncol=2}\n| Col1 | Col2 | Col3 |\n|------|------|------|\n| A | B | C |\n| E | F | G |\n| A | G | G |\n\n: First Table {#tbl-first}\n\n| Col1 | Col2 | Col3 |\n|------|------|------|\n| A | B | C |\n| E | F | G |\n| A | G | G |\n\n: Second Table {#tbl-second}\n\nMain Caption\n:::\n\nSee @tbl-panel for details, especially @tbl-second.\nWhich looks like this when rendered to HTML:\n\nNote that the “Main Caption” for the table is provided as the last block within the containing div.\n\n\n\nCaption Location\nBy default, table captions are positioned above tables. You can modify this behavior using the tbl-cap-location option. For example:\n---\ntbl-cap-location: top\n---\nNote that this option is specified at the top level so that it can be shared by both PDF and HTML formats. If you are only targeting a single format you can place it alongside other format specific options.\nValid values for the caption location include:\n\n\n\nValue\nDescription\n\n\n\n\ntop\nPosition the caption above the table.\n\n\nbottom\nPosition the caption below the table.\n\n\nmargin\nPosition the caption in the margin.\n\n\n\nSee the article on Article Layout for additional details on placing captions in the margin.\n\n\nComputations\nAll of the options described above work for tables produced by executable code cells. For example, here we use the Python tabulate package along with the Markdown() function from the IPython display module to print a markdown table:\n\n```{python}\n#| label: tbl-planet-measures\n#| tbl-cap: Astronomical object\n\nfrom IPython.display import Markdown\nfrom tabulate import tabulate\ntable = [[\"Sun\",\"696,000\",1.989e30],\n [\"Earth\",\"6,371\",5.972e24],\n [\"Moon\",\"1,737\",7.34e22],\n [\"Mars\",\"3,390\",6.39e23]]\nMarkdown(tabulate(\n table, \n headers=[\"Astronomical object\",\"R (km)\", \"mass (kg)\"]\n))\n```\n\n\n\nTable 2: Astronomical object\n\n\nAstronomical object\nR (km)\nmass (kg)\n\n\n\n\nSun\n696,000\n1.989e+30\n\n\nEarth\n6,371\n5.972e+24\n\n\nMoon\n1,737\n7.34e+22\n\n\nMars\n3,390\n6.39e+23\n\n\n\n\n\n\nHere we apply the tbl-cap and tbl-colwidths options to a code cell that uses the knitr kable() function to write a markdown table:\n```{r}\n#| label: tbl-cars\n#| tbl-cap: \"Cars\"\n#| tbl-colwidths: [60,40]\n\nkable(head(cars))\n```\nIf your code cell produces multiple tables, you can also specify subcaptions and layout using cell options:\n```{r}\n#| label: tbl-example\n#| tbl-cap: \"Example\"\n#| tbl-subcap: \n#| - \"Cars\"\n#| - \"Pressure\"\n#| layout-ncol: 2\n#| echo: fenced\n\nlibrary(knitr)\nkable(head(cars))\nkable(head(pressure))\n```\n\n\nGrid Tables\nGrid tables are a more advanced type of markdown tables that allow arbitrary block elements (multiple paragraphs, code blocks, lists, etc.). For example:\n\n\n\n+-----------+-----------+--------------------+\n| Fruit | Price | Advantages |\n+===========+===========+====================+\n| Bananas | $1.34 | - built-in wrapper |\n| | | - bright color |\n+-----------+-----------+--------------------+\n| Oranges | $2.10 | - cures scurvy |\n| | | - tasty |\n+-----------+-----------+--------------------+\n\n: Sample grid table.\n\n\n\nSample grid table.\n\n\n\n\n\n\n\nFruit\nPrice\nAdvantages\n\n\n\n\nBananas\n$1.34\n\nbuilt-in wrapper\nbright color\n\n\n\nOranges\n$2.10\n\ncures scurvy\ntasty\n\n\n\n\n\n\n\nThe row of =s separates the header from the table body, and can be omitted for a headerless table. Cells that span multiple columns or rows are not supported.\nAlignments can be specified as with pipe tables, by putting colons at the boundaries of the separator line after the header:\n\n\n\n+---------+--------+------------------+\n| Right | Left | Centered |\n+========:+:=======+:================:+\n| Bananas | $1.34 | built-in wrapper |\n+---------+--------+------------------+\n\n\n\n\n\n\n\n\n\n\nRight\nLeft\nCentered\n\n\n\n\nBananas\n$1.34\nbuilt-in wrapper\n\n\n\n\n\n\nFor headerless tables, the colons go on the top line instead:\n\n\n\n+----------:+:----------+:--------:+\n| Right | Left | Centered |\n+-----------+-----------+----------+\n\n\n\n\n\n\n\n\n\n\nRight\nLeft\nCentered\n\n\n\n\n\n\nNote that grid tables are quite awkward to write with a plain text editor (because unlike pipe tables, the column indicators must align). Here are some tools that can assist with creating grid tables:\n\nEmacs’ table-mode (M-x table-insert)\nQuarto Visual Editor\nTables Generator’s Plain Text mode with Use reStructuredText syntax enabled\n\n\n\nHTML Tables\nQuarto can process HTML tables in html RawBlock nodes (i.e., {=html}) and convert them to Markdown tables, regardless of the output format (intentionally including non-HTML formats). As a result, you can use HTML table syntax in your documents and it will be converted to Markdown syntax for all formats. Additionally, libraries that emit computational tables in HTML format can work in other output formats.\nFor example, consider the following raw HTML block:\n```{=html}\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n

As described in the section above, Quarto tables are great.

Header 1	Header 2
	Regular output

\n```\nWhen rendered, this results in the following output for HTML and PDF formats:\n\n\n\nHTML Output\n\nAs described in the section above, Quarto tables are great.\n\n\nHeader 1\nHeader 2\n\n\n\n\n\nRegular output\n\n\n\n\n\nPDF Output\n\n\n\n\nIn addition, Quarto supports the specification of embedded Markdown content in tables. This is done by providing a data attribute qmd or qmd-base64 in an embedded span or div node. These nodes can appear anywhere that such content is allowed: table headers, footers, cells, captions, etc.\nFor example, the following table includes a cross reference, markdown formatting and a shortcode:\n\n\n\n## HTML Tables Example {#sec-html-tables}\n\n```{=html}\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n

}}\">	Regular output

\n```\n\n\n\n\nWhich renders as follows:\n\nHTML Tables Example\n\nAs described in Section 9, Quarto are great.\n\n\nHeader 1\nHeader 2\n\n\n\n\n\nRegular output\n\n\n\n\n\n\n\n\n\nDisabling Quarto Table Processing\nIt’s possible that Quarto’s processing of HTML tables interferes with your library’s processing. If this is the case, you can disable Quarto’s processing of HTML tables by adding the attribute data-quarto-disable-processing=\"true\" to your table, for example:\n\n ...\n"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.215Z\",\n \"loc\": \"https://quarto.org/docs/authoring/tables.html\",\n \"source\": \"https://quarto.org/docs/authoring/tables.html\"\n}"}}},{"rowIdx":151,"cells":{"page_content":{"kind":"string","value":"Note\n\n\n\nPre-release builds are intended for testing purposes, and are not recommended for general use. For stable builds, please visit Release Builds.\n\n\n\n\n_ Find your operating system in the table below\n\n\n\n\n\n\nHighlights\nQuarto 1.4 includes the following new features:\n\nTypst Format—Support for the typst output format. Typst is a new open-source markup-based typesetting system that is designed to be as powerful as LaTeX while being much easier to learn and use.\nLua changes—Quarto v1.4 adds new features to writers of Lua filters.\n\n\n\nRelease Notes"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/download/prerelease.html\",\n \"source\": \"https://quarto.org/docs/download/prerelease.html\"\n}"}}},{"rowIdx":152,"cells":{"page_content":{"kind":"string","value":"_ Find your operating system in the table below\n\n\n\n\n\n\nRelease Notes"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/download/release.html\",\n \"source\": \"https://quarto.org/docs/download/release.html\"\n}"}}},{"rowIdx":153,"cells":{"page_content":{"kind":"string","value":"Authoring\n\nCreate content with markdown\n\n\n\nMarkdown Basics\nFigures\nTables\nDiagrams\nCitations & Footnotes\nCross References\nArticle Layout\n\n\n\n\n\n\nComputations\n\nExecute code and display its output\n\n\n\nUsing Python\nUsing R\nUsing Julia\nUsing Observable\nExecution Options\nParameters\n\n\n\n\n\n\nTools\n\nUse your favorite tools with Quarto\n\n\n\nJupyterLab\nRStudio IDE\nVS Code\nNeovim\nText Editors\nVisual Editor\n\n\n\n\n\n\nDocuments\n\nGenerate output in many formats\n\n\n\nHTML\nPDF\nMS Word\nMarkdown\nAll Formats\n\n\n\n\n\n\nPresentations\n\nPresent code and technical content\n\n\n\nPresentation Basics\nRevealjs (HTML)\nPowerPoint (Office)\nBeamer (PDF)\n\n\n\n\n\n\nWebsites\n\nCreate websites and blogs\n\n\n\nCreating a Website\nWebsite Navigation\nCreating a Blog\nWebsite Search\nWebsite Listings\n\n\n\n\n\n\nBooks\n\nCreate books and manuscripts\n\n\n\nCreating a Book\nBook Structure\nBook Crossrefs\nCustomizing Output\n\n\n\n\n\n\nInteractivity\n\nEngage readers with interactivity\n\n\n\nOverview\nObservable JS\nShiny\nWidgets\nComponent Layout\n\n\n\n\n\n\nPublishing\n\nPublishing documents and sites\n\n\n\nPublishing Basics\nQuarto Pub\nGitHub Pages\nPosit Connect\nNetlify\nConfluence\nOther Services\n\n\n\n\n\n\nProjects\n\nScale up your work with projects\n\n\n\nProject Basics\nManaging Execution\nProject Profiles\nEnvironment Variables\nProject Scripts\nVirtual Environments\n\n\n\n\n\n\nAdvanced\n\nRefine documents with advanced tools\n\n\n\nIncludes\nVariables\nPage Layout\nDocument Language\nConditional Content\nNotebook Filters\n\n\n\n\n\nNo matching items"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.471Z\",\n \"loc\": \"https://quarto.org/docs/guide/index.html\",\n \"source\": \"https://quarto.org/docs/guide/index.html\"\n}"}}},{"rowIdx":154,"cells":{"page_content":{"kind":"string","value":"Quarto 1.3 Feature\n\n\n\nThis feature is new in Quarto 1.3, which you can download at https://quarto.org/docs/download/\n\n\n\nOverview\nHTML pages (either standalone or in a website) can automatically include links to other formats specified in the document front matter. For example, the following document front matter:\ntitle: Sample Page\nauthor: Norah Jones\ndate: last-modified\ntoc: true\nformat: \n html: default\n ipynb: default\nResults in an HTML page that includes a link to the additional notebook format in the right margin below the table of contents:\n\nIf a table of contents is enabled for the page, the additional formats will be automatically placed within the table of contents as a new section. If no table of contents is displayed, the additional formats will be displayed in the right margin at the top of the document.\nLinks to additional formats are displayed by default, but you can control whether they are shown or even which specific formats are included with the format-links YAML option.\n\n\n\n\n\n\nRendering All Formats in Standalone HTML Documents\n\n\n\nThe Render buttons in RStudio and VS Code will not automatically render all formats if the document isn’t part of a Quarto website. To render all formats use quarto render on the command line:\n\n\nTerminal\n\nquarto render multi-format.qmd\n\n\n\n\n\nRendering Formats with the Same Extension\nIf your formats share a file extension, for example, both HTML pages and Revealjs presentations use .html, their outputs will overwrite each other. To include formats with the same extension, use output-file to distinguish one. For example, to include a link to a RevealJS presentation provide a distinct output-file:\n\n\ndocument.qmd\n\ntitle: Sample Page\nformat: \n html: default\n revealjs: \n output-file: document-revealjs.html\n\n\n\nSpecifying Formats to Link\nYou can provide an explicit list of formats to include in the Other Formats section by providing a list as the value for format-links. For example, this document front matter will result in only the link to the Jupyter notebook format, excluding the PDF format:\ntitle: Sample Page\nauthor: Norah Jones\ndate: last-modified\ntoc: true\nformat: \n html: default\n ipynb: default\n pdf: default\nformat-links: [ipynb]\n\n\nHiding All Links\nTo prevent format links from being shown at all, specify format-links: false in your document front matter. For example this front matter will not display the Other Formats links:\ntitle: Sample Page\nauthor: Norah Jones\ndate: last-modified\ntoc: true\nformat: \n html: default\n ipynb: default\nformat-links: false\n\n\nControlling Formats at a Project Level\nIn a Quarto Project, to control the formats and their behavior for a specific folder, provide the format and format-links options in a _metadata.yml file. Similarly, you can specify these options for an entire project by including them in the _quarto.yml project file. See Directory Metadata or Project Metadata for additional details.\nThe format option isn’t merged like all other metadata across _quarto.yml, _metadata.yml, and the document YAML. If you have some formats specified at a project or directory level, you’ll also need to explicitly list them in the document YAML. For example, suppose you have HTML options set at the project level:\n\n\n_quarto.yml\n\nformat:\n html:\n toc: true\n\nIn order to get an HTML document with a link to the PDF format, you’ll need to list both formats in the YAML header:\n\n\ndocument.qmd\n\nformat: \n html: default\n pdf: default"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/html-multi-format.html\",\n \"source\": \"https://quarto.org/docs/output-formats/html-multi-format.html\"\n}"}}},{"rowIdx":155,"cells":{"page_content":{"kind":"string","value":"Overview\nHugo is a very popular open source website publishing system. Pages in Hugo websites are typically written in plain markdown, so don’t have a straightforward way to automatically and reproducibly incorporate computational output.\nUsing the Quarto hugo-md format, you can incorporate computational output (e.g. R or Python code that produces plots) into Hugo websites. This article explains how.\nIt’s important to note that many of the Quarto features related to theming, page layout, and navigation are not applicable when you are using Quarto with Hugo. Hugo has its own theming system, syntax highlighting, table of contents, page layout, navigational menus, and full text search. You’ll use Quarto to execute code and generate markdown that is rendered within the Hugo HTML publishing framework rather than Quarto’s own.\n\n\nSite Config\nThere are a couple of changes you should make to your Hugo config.toml in preparation for using Quarto with Hugo. First, make sure that .qmd and .ipynb files and other source code or data files are not published as part of the site. For example:\nignoreFiles = [ \"\\\\.qmd$\", \"\\\\.ipynb$\", \"\\\\.py$\" ]\nNext, configure Hugo’s markdown renderer to allow raw HTML (as many R and Python packages will produce computational output using raw HTML rather than markdown):\n[markup.goldmark.renderer]\nunsafe= true\n\n\nCreating a Page\nHugo articles and posts that use Quarto should live in their own directory (taking advantage of the Hugo Page Bundles feature). This allows any content generated/referenced by the page (e.g. plot output) to live right alongside the markdown source.\nTo add Quarto documents to a Hugo site:\n\nCreate a directory within content that will hold your Quarto article.\nAdd an index.qmd document to the directory. When rendered this will create an index.md, which in turn will ensure that Hugo treats it as a Page Bundle (automatically copying images and other referenced resources to the publish directory).\nAdd the requisite Hugo front matter, then also specify format: hugo-md and any other required Quarto options.\n\nFor example, let’s say we wanted to create a new article named hello-quarto within the content directory. The filesystem would look like this:\nmysite/\n content/\n hello-quarto/\n index.qmd\nHere’s what the source code of index.qmd might look like:\n---\ntitle: Hello, Quarto\ndate: \"2012-04-06\"\ncategories: \n - Matplotlib\n - Coordinates\nformat: hugo-md\njupyter: python3\n---\n\n## Polar Axis\n\nFor a demonstration of a line plot on a polar axis, see @fig-polar.\n\n```{python}\n#| label: fig-polar\n#| fig-cap: \"A line plot on a polar axis\"\n\nimport numpy as np\nimport matplotlib.pyplot as plt\n\nr = np.arange(0, 2, 0.01)\ntheta = 2 * np.pi * r\nfig, ax = plt.subplots(subplot_kw={'projection': 'polar'})\nax.plot(theta, r)\nax.set_rticks([0.5, 1, 1.5, 2])\nax.grid(True)\nplt.show()\n```\n\n\nWorkflow\nThe basic concept of using Quarto with Hugo is that you take computational markdown documents (.qmd) or Jupyter notebooks (.ipynb) and use them to generate plain markdown files (.md) that are rendered to HTML by Hugo.\nindex.qmd   quarto =>   index.md   hugo =>   index.html\nThe quarto render and quarto preview commands are used to transform .qmd or .ipynb files to Hugo compatible markdown (.md). The computational files are located in the same place you would also locate ordinary markdown files (e.g. the blog directory).\nAfter rendering, a plain .md file is written right alongside the computational document. This markdown file is then processed by Hugo.\n\nLive Preview\nThe quarto preview command will automatically recognize when it is run from a directory that contains a Hugo website:\n\n\nTerminal\n\ncd my-hugo-website\nquarto preview\n\nThis will automatically run hugo serve on your behalf to bring up a local preview server. In addition, it will monitor the filesystem for changes to .qmd and .ipynb inputs and automatically re-render them to Hugo compatible .md files when they change.\nNote that this also works for the integrated Render/Preview command within the Quarto VS Code Extension.\n\n\nRendering\nIf you are not previewing and want to render all of the Quarto documents (.qmd) and notebooks (.ipynb) in your site, call quarto render from the root directory of the site:\n\n\nTerminal\n\ncd my-hugo-website\nquarto render \n\nTypically you’ll want to do a quarto render at the site level before you build the site for publishing:\n\n\nTerminal\n\nquarto render && hugo\n\nYou can also render individual documents or notebooks:\n\n\nTerminal\n\nquarto render blog/2022-07-26/hello-quarto/index.qmd\n\nIf you have computationally expensive documents you may want to consider using Quarto’s freeze feature to only re-execute code when your document source code changes.\nNote that if aren’t ever rendering at the project level and just have individual files that you want to render with Quarto, you should specify the hugo-md format as follows:\n---\ntitle: \"My Blog Post\"\nformat: hugo-md\n---\n\n\nConfiguration\nWhile Quarto works well within a Hugo site that has no _quarto.yml project config file, you can add one if you want to customize the default behavior, add a bibliography, etc. For example, here is what a simple customized _quarto.yml file might look like:\n\n\n_quarto.yml\n\nproject:\n type: hugo\n \nformat: \n hugo-md:\n code-fold: true\n \nexecute: \n warning: false\n\nbiliography: references.lib\n\nIt’s important to note that if you do provide an explicit _quarto.yml file you need to explicitly specify the project type (type: hugo) as shown above.\n\nExternal Directory\nYou might decide that you prefer to keep all of your Quarto documents and/or notebooks in their own directory, separate from the Hugo website. In this configuration you would mirror the directory structure of your site in the Quarto directory, and then set the output-dir in the project file to point to the Hugo directory. For example:\n\n\n_quarto.yml\n\nproject:\n type: hugo\n output-dir: ../hugo-site\n\n\n\n\n\nShortcodes\nNote that Hugo shortcodes and Quarto shortcodes share the same basic syntax (e.g. {{< var foo >}}). This is normally not a problem as shortcodes not recognized by Quarto are passed through unmodified to Hugo.\nHowever, in some cases the use of a Hugo shortcode throws off Pandoc markdown processing, and its necessary to “protect” the Hugo shortcode from processing by Pandoc. This can typically be handled by escaping the shortcode with an extra brace. For example:\n{{{< ref \"foo/index.md\" >}}}\nIt’s possible that this won’t be enough if the presence of the shortcode changes how Pandoc processes the surrounding markdown (e.g. this is currently known to occur for links). In this case you need to use a markdown raw block around the entire construct. For example:\n```{=markdown}\n[click here]()\n```\nOr for inline content, use a markdown raw inline:\nFor more info, `[click here]()`{=markdown}\n\n\nWebTeX Math\nThe hugo format renders LaTeX equations using standard dollar-delimited inline ($...$) and display ($$...$$) syntax. However, if the web environment you are publishing into doesn’t support dollar-delimited math, you can alternatively use WebTeX to display math. This is done by setting the Pandoc html-math-method to webtex. For example:\nformat:\n hugo:\n html-math-method: webtex\nWebTeX works for any web page that can display images, and requires no special JavaScript or CSS. Any inline or display equations contained within your document will be converted to an image URL that requests a rendered version of the equation. For example, the following markdown:\n$x + 1$\nWill be converted to:\n\nWhich renders as:\n\n\nDark Mode\nSVG is used as the default rendering method because it has the best overall appearance. However, if your hugo document is being rendered on a dark background, you may want to switch to PNG with a dark background specified. You can do this as follows:\nformat:\n hugo:\n html-math-method: \n method: webtex\n url: https://latex.codecogs.com/png.image?%5Cbg_black&space;"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/hugo.html\",\n \"source\": \"https://quarto.org/docs/output-formats/hugo.html\"\n}"}}},{"rowIdx":156,"cells":{"page_content":{"kind":"string","value":"Overview\nHTML documents rendered with Quarto use Bootstrap 5 by default. This can be disabled or customized via the theme option:\ntheme: default # bootstrap 5 default\ntheme: cosmo # cosmo bootswatch theme\ntheme: pandoc # pandoc default html treatment\ntheme: none # no theme css added to document\nQuarto includes 25 themes from the Bootswatch project (for example, the website uses the cosmo theme). Available themes include:\n\n\n\n\ndefault\ncerulean\ncosmo\ncyborg\ndarkly\nflatly\njournal\nlitera\nlumen\nlux\nmateria\nminty\nmorph\npulse\nquartz\nsandstone\nsimplex\nsketchy\nslate\nsolar\nspacelab\nsuperhero\nunited\nvapor\nyeti\nzephyr\n\n\n\n\n\n\nUse of any of these themes via the theme option. For example:\nformat:\n html:\n theme: united\nYou can also customize these themes or create your own new themes. Learn how to do this below in Theme Options.\n\n\nBasic Options\nIf you are using a Bootstrap theme or the Pandoc theme, there are a set of options you can provide in document metadata to customize its appearance. These include:\n\n\n\nOption\nDescription\n\n\n\n\nmax-width\nThe maximum width occupied by page content. Defaults to 1400px for bootstrap themes and 36em for the pandoc theme.\n\n\nmainfont\nSets the font-family property for the document.\n\n\nfontsize\nSets the base CSS font-size for the document.\n\n\nfontcolor\nSets the default text color for the document.\n\n\nlinkcolor\nSets the default text color for hyperlinks.\n\n\nmonofont\nSets the font-family property for elements.\n\n\nmonobackgroundcolor\nSets the background-color property for elements.\n\n\nlinestretch\nSets the CSS line-height property (affects distance between lines of text, defaults to 1.5).\n\n\nbackgroundcolor\nSets the background-color for the document.\n\n\nmargin-left, margin-right, margin-top, margin-bottom\nSets the CSS margin properties for the document body.\n\n\n\nFor example. here we set the font-size a bit larger and specify that we want a bit more space between lines of text:\ntitle: \"My Document\"\nformat:\n html: \n theme: cosmo\n fontsize: 1.1em\n linestretch: 1.7\n\n\nTheme Options\nWhile the basic customization described above handles many common requirements, you can do extensive additional customization using SASS theme files. Bootstrap defines over 1,400 variables that control fonts, colors, padding, borders, and much more. You can see all of the variables here:\nhttps://github.com/twbs/bootstrap/blob/main/scss/_variables.scss\nSASS theme files can define both variables that globally set things like colors and fonts, as well as rules that define more fine grained behavior. To customize an existing Bootstrap theme with your own set of variables and/or rules, just provide the base theme and then your custom theme file(s):\ntheme:\n - cosmo\n - custom.scss\nYour custom.scss file might look something like this:\n/*-- scss:defaults --*/\n$h2-font-size: 1.6rem !default;\n$headings-font-weight: 500 !default;\n$body-color: $gray-700 !default;\n\n/*-- scss:rules --*/\nh1, h2, h3, h4, h5, h6 {\n text-shadow: -1px -1px 0 rgba(0, 0, 0, .3);\n}\nNote that the variables section is denoted by the /*-- scss:defaults --*/ comment and the rules section (where normal CSS rules go) is denoted by the /*-- scss:rules --*/ comment.\n\n\nCustom Themes\nYou can naturally also create an entirely custom theme and provide only that (in this case you will inherit from the default Bootstrap theme):\ntheme: custom.scss\nFor example, here are the theme files for the 25 built-in Bootswatch themes:\nhttps://github.com/quarto-dev/quarto-cli/tree/main/src/resources/formats/html/bootstrap/themes\nYou can read more about the custom theming design here.\n\n\nDark Mode\nIn addition to providing a single theme for your html output, you may also provide a light and dark theme. For example:\ntheme:\n light: flatly\n dark: darkly\nSetting the above themes in your _quarto.yml results in both a dark and light version of your output being available. For example:\n\n\nFlatly Themed Output\n\n\n\n\nDarkly Themed Output\n\n\nWhen providing both a dark and light mode for your html output, Quarto will automatically create a toggle to allow your reader to select the desired dark or light appearance. The toggle will automatically appear in the top right corner of your html output. When possible, the toggle will use browser local storage to maintain the user’s preference across sessions.\nThe first appearance (light or dark) elements in the theme to determine the default appearance for your html output. For example, since the light option appears first in the above example, a reader will see the light appearance by default.\nQuarto will automatically select the appropriate light or dark version of the text highlighter that you have specified when possible. For more information, see Code Highlighting.\n\n\nCustomizing Themes\nAs when providing a single theme, you may provide a custom theme for dark and light mode, or a list of scss files to customize the light and dark appearance. This website, for example uses the following to use a light cosmo theme and then customizes the cosmo theme with additional Sass variables when in dark mode:\ntheme:\n light: cosmo\n dark: [cosmo, theme-dark.scss]\nThe contents of theme-dark.scss which is customizing the cosmo document appearance is:\n/*-- scss:defaults --*/\n// Base document colors\n$body-bg: #181818;\n$body-color: white;\n$link-color: #75AADB;\n\n// Code blocks\n$code-block-bg-alpha: -.8;\nFor more information about available Sass variables, see HTML Customization Using Sass Variables.\n\n\n\nSass Variables\nThe following Sass Variables can be specified within SCSS files (note that these variables should always be prefixed with a $ and are specified within theme files rather than within YAML options):\n\nColors\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$body-bg\nThe page background color.\n\n\n$body-color\nThe page text color.\n\n\n$link-color\nThe link color.\n\n\n$input-bg\nThe background color for HTML inputs.\n\n\n$popover-bg\nThe background color for popovers (for example, when a citation preview is shown).\n\n\n\n\n\nFonts\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$font-family-sans-serif\nThe sans-serif font family for the page.\n\n\n$font-family-monospace\nThe monospace font family for the page.\n\n\n$font-size-root\nThe base font size for the page.\n\n\n$toc-font-size\nThe font size for the page TOC.\n\n\n$h1-font-size\n$h2-font-size\n$h3-font-size\n$h4-font-size\n$h5-font-size\nFont sizes for the specified headings.\n\n\n\n\n\nCode Blocks\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$code-block-border-left\nBy default, Quarto does not display a left border on code blocks. Set this variable to a truthy value or a CSS color to enable the left border.\n\n\n$code-block-border-left-style\nThe style of the left border displayed on code blocks. Defaults to solid.\n\n\n$code-block-border-left-size\nThe thickness of the left border displayed on code blocks. Defaults to 3px;\n\n\n$code-block-padding-left\nThe amount of padding applied between the code and the border. Defaults to 0.6em.\n\n\n$code-block-bg\nBy default, Quarto sets a background on code blocks by adding transparency to the theme’s progress-bg color. Set this variable to truthy value or a CSS color.\n\n\n$code-block-bg-padding\nThe padding applied to the code block. Defaults to 0.4em.\n\n\n$code-block-bg-alpha\nThe amount to alter the transparency fo the progress-bg color. This is not used if an explicit background color is set. Defaults to -0.35.\n\n\n\n\nCode Copy\nYou can also customize the colors of the button which appears for code-copy: true with the following variables:\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$btn-code-copy-color\nThe color used for the copy button at the top right of code blocks.\n\n\n$btn-code-copy-color-active\nThe hover color used for the copy button at the top right of code blocks.\n\n\n\n\n\n\nInline Code\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$code-bg\nThe background color of inline code. Defaults to a mix between the body-bg and body-color.\n\n\n$code-color\nThe text color of inline code. Defaults to a generated contrasting color against the code-bg.\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$toc-color\nThe color for table of contents text.\n\n\n$toc-font-size\nThe font-size for table of contents text.\n\n\n$toc-active-border\nThe left border color for the currently active table of contents item.\n\n\n$toc-inactive-border\nThe left border colors for inactive table of contents items.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$content-padding-top\nPadding that should appear before the main content area (including the sidebar, content, and TOC.\n\n\n\n\n\nNavigation\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$navbar-bg\nThe background color of the navbar. Defaults to the theme’s $primary color.\n\n\n$navbar-fg\nThe color of foreground elements (text and navigation) on the navbar. If not specified, a contrasting color is automatically computed.\n\n\n$navbar-hl\nThe highlight color for links in the navbar. If not specified, the $link-color is used or a contrasting color is automatically computed.\n\n\n$sidebar-bg\nThe background color for a sidebar. Defaults to $light except when a navbar is present or when the style is floating. In that case it defaults to the $body-bg color.\n\n\n$sidebar-fg\nThe color of foreground elements (text and navigation) on the sidebar. If not specified, a contrasting color is automatically computed.\n\n\n$sidebar-hl\nThe highlight color for links in the sidebar. If not specified, the $link-color is used.\n\n\n$footer-bg\nThe background color for a sidebar. Defaults to the $body-bg color.\n\n\n$footer-fg\nThe color of foreground elements (text and navigation) on the footer. If not specified, a contrasting color is automatically computed.\n\n\n\n\n\nCallouts\n\n\n\n\n\n\n\nVariable\nNotes\n\n\n\n\n$callout-border-width\nBy default, Quarto does not display a left border on code blocks. Set this variable to a truthy value or a CSS color to enable the left border. Defaults to 5px.\n\n\n$callout-border-scale\nThe border color of callouts computed by shifting the callout color by this amount. Defaults to 0%.\n\n\n$callout-icon-scale\nThe color of the callout icon computed by shifting the callout color by this amount. Defaults to 10%.\n\n\n$callout-margin-top\nThe amount of top margin on the callout. Defaults to 1.25rem.\n\n\n$callout-margin-bottom\nThe amount of bottom margin on the callout. Defaults to 1.25rem.\n\n\n$callout-color-\nThe colors for the various types of callouts. Defaults:\n\n\n\ntype\ndefault\n\n\n\n\nnote\n$blue\n\n\ntip\n$green\n\n\ncaution\n$orange\n\n\nwarning\n$yellow\n\n\nimportant\n$red\n\n\n\n\n\n\nIn addition to the above Sass variables, Bootstrap itself supports hundreds of additional variables. You can learn more about Bootstrap’s use of Sass variables or review the raw variables and their default values."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/html-themes.html\",\n \"source\": \"https://quarto.org/docs/output-formats/html-themes.html\"\n}"}}},{"rowIdx":157,"cells":{"page_content":{"kind":"string","value":"Overview\nThere are wide variety of options available to customize the display of source code within HTML documents, including:\n\nHiding some or all code that was executed by Knitr or Jupyter.\nCode folding for executed code (hidden by default and expandable by readers).\nHandling code that overflows the available horizontal display space.\nView the source code of the markdown file used to generate the document.\nSyntax highlighting themes and other options to control the appearance of code.\nCopy to clipboard button for code blocks.\nGenerating hyperlinks to online documentation for functions used within code blocks via the downlit package (note that this option currently only works when using the Knitr engine).\n\nDetails on using all of these options are provided below.\n\n\nHiding Code\nFor many documents you may want to hide all of the executable source code used to produce dynamic outputs. You can do this by specifying echo: false in the document execute options. For example:\n---\ntitle: \"My Document\"\nexecute:\n echo: false\njupyter: python3\n---\nNote that we can override this option on a per code-block basis. For example:\n```{python}\n#| echo: true\n\nimport matplotlib.pyplot as plt\nplt.plot([1,2,3,4])\nplt.show()\n```\nCode block options are included in a special comment at the top of the block (lines at the top prefaced with #| are considered options).\n\n\nFolding Code\nUse the code-fold option to include code but have it hidden by default using the HTML

tag. For example, click the Code button to see the code that produced this plot.\n\n\nCode\nlibrary(ggplot2)\ndat <- data.frame(cond = rep(c(\"A\", \"B\"), each=10),\n xvar = 1:20 + rnorm(20,sd=3),\n yvar = 1:20 + rnorm(20,sd=3))\n\nggplot(dat, aes(x=xvar, y=yvar)) +\n geom_point(shape=1) + \n geom_smooth() \n\n\n\n\n\nHere we specify both code-fold: true as well as custom summary text (the default is just “Code” as shown above):\nformat:\n html:\n code-fold: true\n code-summary: \"Show the code\"\nValid values for code-fold include:\n\n\n\nValue\nBehavior\n\n\n\n\nfalse\nNo folding (default)\n\n\ntrue\nFold code (initially hidden)\n\n\nshow\nFold code (initially shown)\n\n\n\nUse the code-fold and code-summary chunk attributes to control this on a chunk-by-chunk basis:\n```{r}\n#| code-fold: true\n#| code-summary: \"Show the code\"\n```\n\n\nCode Overflow\nIn some cases the width of source code will overflow the available horizontal display space. By default, this will result in a horizontal scroll bar for the code block. However if you prefer not to have scrollbars you can have the longer lines wrap instead.\nTo set the global default behavior use the code-overflow option. For example:\nformat:\n html:\n code-overflow: wrap\nValid values for code-overflow are:\n\n\n\n\n\n\n\nOption\nDescription\n\n\n\n\nscroll\nScroll code blocks that exceed available width (default, corresponds to white-space: pre).\n\n\nwrap\nWrap lines of code that exceed available width (corresponds to white-space: pre-wrap).\n\n\n\nYou can also override the global default on a per-code-block basis. For computational cells you do this with the code-overflow cell option:\n```{python}\n#| code-overflow: wrap\n\n# very long line of code....\n```\nFor a static code block, add the .code-overflow-scroll or .code-overflow-wrap CSS class:\n```{.python .code-overflow-wrap}\n# very long line of code....\n```\nNote that irrespective of these options, code will always wrap within printed HTML output (as it would otherwise be clipped off the edge of the page).\n\n\nCode Tools\nYou can include a Code menu in the header of your document that provides various tools for readers to interact with the source code. Specify code-tools: true to activate these tools:\nformat:\n html:\n code-fold: true\n code-tools: true\nIf you have a document that includes folded code blocks then the Code menu will present options to show and hide the folded code as well as view the full source code of the document:\n\nThis document specifies code-tools: true in its options so you should see the Code menu above next to the main header.\nYou can control which of these options are made available as well as the “Code” caption text using sub-options of code-tools. For example, here we specify that we want only “View Source” (no toggling of code visibility) and no caption on the code menu:\nformat:\n html: \n code-tools:\n source: true\n toggle: false\n caption: none\nBy default, the source code is embedded in the document and shown in a popup window like this:\n\nYou can alternatively specify a URL for the value of source:\nformat:\n html: \n code-tools:\n source: https://github.com/quarto-dev/quarto-web/blob/main/index.md\nIf you are within a project and have specified a repo-url option then you can just use repo and the correct link to your source file will be generated:\nformat:\n html: \n code-tools:\n source: repo\nNote that the code-tools option is not available when you disable the standard HTML theme (e.g. if you specify the theme: none option).\n\n\nAppearance\nBy default code blocks are rendered with a left border whose color is derived from the current theme. You can customize code chunk appearance with some simple options that control the background color and left border. Options can either be booleans to enable or disable the treatment or can be legal CSS color strings (or they could even be SASS variable names!).\nHere is the default appearance for code blocks (code-block-background: true):\n\nYou can instead use a left border treatment using the code-block-border-left option:\ncode-block-border-left: true\n\nYou can combine a background and border treatment as well as customize the left border color:\ncode-block-bg: true\ncode-block-border-left: \"#31BAE9\"\n\n\n\nCode Filename\nUse the filename attribute on code blocks If you are documenting the contents of a file and want to be especially clear about the name of the file the code is associated with.\nFor example, the following code:\n```{.python filename=\"matplotlib.py\"}\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\n```\nResults in this HTML output:\n\nNon-HTML formats will still have the filename, but it will simply be shown in bold above the code block.\n\n\nHighlighting\nPandoc will automatically highlight syntax in fenced code blocks that are marked with a language name. For example:\n```python\n1 + 1\n```\nPandoc can provide syntax highlighting for over 140 different languages (see the output of quarto pandoc --list-highlight-languages for a list of all of them). If you want to provide the appearance of a highlighted code block for a language not supported, just use default as the language name.\nYou can specify the code highlighting style using highlight-style and specifying one of the supported themes. These themes are “adaptive”, which means they will automatically switch between a dark and light mode based upon the theme of the website. These are designed to work well with sites that include a dark and light mode.\n\na11y\narrow\natom-one\nayu\nbreeze\ngithub\ngruvbox\n\nAll of the standard Pandoc themes are also available:\n\npygments\ntango\nespresso\nzenburn\nkate\nmonochrome\nbreezedark\nhaddock\n\nAs well as an additional set of extended themes, including:\n\ndracula\nmonokai\nnord\noblivion\nprinting\nradical\nsolarized\nvim-dark\n\nThe highlight-style option determines which theme is used. For example:\nhighlight-style: github\nHighlighting themes can provide either a single highlighting definition or two definitions, one optimized for a light colored background and another optimized for a dark color background. When available, Quarto will automatically select the appropriate style based upon the code chunk background color’s darkness. Users may always opt to specify the full name (e.g. atom-one-dark) to by pass this automatic behavior.\nBy default, code is highlighted using the arrow theme, which is optimized for accessibility. We’ve additionally introduced the arrow-dark theme which is designed to provide accessible highlighting against dark backgrounds.\nExamples of the light and dark themes:\n\nArrow (light)\n\n\n\nArrow (dark)\n\n\n\nAyu (light)\n\n\n\nAyu (dark)\n\n\n\nCustom Highlighting\nIn addition to the built in themes available for syntax highlighting, you can also specify your own syntax highlighting by providing the path to a valid theme file (which is based upon the KDE XML syntax highlighting descriptions). Highlighting is implemented using skylighting.\nFor example:\n---\nhighlight-style: custom.theme\n---\nIn addition, if you’d like to provide adaptive themes, you may also pass both a light and dark theme file:\n---\nhighlight-style:\n light: custom-light.theme\n dark: custom-dark.theme\n---\nNote that as with adaptive text higlighting themes, when you provide a dark and light highlight-style, background colors specified in the themes will be ignored in favor of the overall theme specified background colors.\n\n\n\nCode Annotation\nYou can add annotations to lines of code in code blocks and executable code cells. See Code Annotation for full details.\n\n\nLine Numbers\nIf you want to display line numbers alongside the code block, add the code-line-numbers option. For example:\nformat:\n html:\n code-line-numbers: true\nHere’s how a code block with line numbers would display:\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\nYou can also enable line numbers for an individual code block using the code-line-numbers attribute. For example:\n``` {.python code-line-numbers=\"true\"}\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\n```\n\n\nExecutable Blocks\nThe documentation on computations covers how to include executable code blocks (code which is actually executed, with its output being included in the rendered document). We won’t additionally cover that here, but we will talk about how to include code blocks that demonstrate executable syntax (e.g. for writing a tutorial).\nOften you’ll want to include a fenced code block purely as documentation (not executable). You can do this by using two curly braces around the language (e.g. python, r, etc.) rather than one. For example:\n```{{python}}\n1 + 1\n```\nWill be output into the document as:\n```{python}\n1 + 1\n```\nIf you want to show an example with multiple code blocks and other markdown, just enclose the entire example in 4 backticks (e.g. ````) and use the two curly brace syntax for code blocks within. For example:\n````\n---\ntitle: \"My document\"\n---\n\nSome markdown content.\n\n```{{python}}\n1 + 1\n```\n\nSome additional markdown content.\n\n````\n\n\nCopy Button\nHover over the code block below and you will see a copy icon in the top-right corner:\n\nlibrary(dygraphs)\ndygraph(nhtemp, main = \"New Haven Temperatures\") %>% \n dyRangeSelector(dateWindow = c(\"1920-01-01\", \"1960-01-01\"))\n\nThis behavior is enabled by default but you configure it using the code-copy option:\nformat:\n html:\n code-copy: false\nValid values for code-copy include:\n\n\n\nhover\nShow button on hover (default)\n\n\ntrue\nAlways show code copy button\n\n\nfalse\nNever show code copy button\n\n\n\n\n\nCode Linking\nThe code-link option enables hyper-linking of functions within code blocks to their online documentation:\nformat:\n html:\n code-link: true\nCode linking is currently implemented only for the knitr engine (via the downlit package). A limitation of downlit currently prevents code linking if code-line-numbers is also true.\n\n\n \n\n\nSource Code\n---\ntitle: \"HTML Code Blocks\"\nformat: \n html:\n code-tools: true\nexecute:\n warning: false\n---\n\n## Overview\n\nThere are wide variety of options available to customize the display of source code within HTML documents, including:\n\n1. Hiding some or all code that was executed by [Knitr](https://yihui.name/knitr) or [Jupyter](https://jupyter.org).\n2. Code folding for executed code (hidden by default and expandable by readers).\n3. Handling code that overflows the available horizontal display space.\n4. View the source code of the markdown file used to generate the document.\n5. Syntax highlighting themes and other options to control the appearance of code.\n6. Copy to clipboard button for code blocks.\n7. Generating hyperlinks to online documentation for functions used within code blocks via the [downlit](https://downlit.r-lib.org/) package (note that this option currently only works when using the Knitr engine).\n\nDetails on using all of these options are provided below.\n\n## Hiding Code\n\nFor many documents you may want to hide all of the executable source code used to produce dynamic outputs. You can do this by specifying `echo: false` in the document `execute` options. For example:\n\n``` yaml\n---\ntitle: \"My Document\"\nexecute:\n echo: false\njupyter: python3\n---\n```\n\nNote that we can override this option on a per code-block basis. For example:\n\n```{python}\n#| echo: true\n\nimport matplotlib.pyplot as plt\nplt.plot([1,2,3,4])\nplt.show()\n```\n\nCode block options are included in a special comment at the top of the block (lines at the top prefaced with `#|` are considered options).\n\n## Folding Code\n\nUse the `code-fold` option to include code but have it hidden by default using the HTML `

` tag. For example, click the **Code** button to see the code that produced this plot.\n\n```{r}\n#| code-fold: true\n\nlibrary(ggplot2)\ndat <- data.frame(cond = rep(c(\"A\", \"B\"), each=10),\n xvar = 1:20 + rnorm(20,sd=3),\n yvar = 1:20 + rnorm(20,sd=3))\n\nggplot(dat, aes(x=xvar, y=yvar)) +\n geom_point(shape=1) + \n geom_smooth() \n```\n\nHere we specify both `code-fold: true` as well as custom summary text (the default is just \"Code\" as shown above):\n\n``` yaml\nformat:\n html:\n code-fold: true\n code-summary: \"Show the code\"\n```\n\nValid values for `code-fold` include:\n\n| Value | Behavior |\n|---------|------------------------------|\n| `false` | No folding (default) |\n| `true` | Fold code (initially hidden) |\n| `show` | Fold code (initially shown) |\n\nUse the `code-fold` and `code-summary` chunk attributes to control this on a chunk-by-chunk basis:\n\n```{r}\n#| code-fold: true\n#| code-summary: \"Show the code\"\n```\n\n## Code Overflow\n\nIn some cases the width of source code will overflow the available horizontal display space. By default, this will result in a horizontal scroll bar for the code block. However if you prefer not to have scrollbars you can have the longer lines wrap instead.\n\nTo set the global default behavior use the `code-overflow` option. For example:\n\n``` yaml\nformat:\n html:\n code-overflow: wrap\n```\n\nValid values for `code-overflow` are:\n\n| Option | Description |\n|------------------|------------------------------------------------------|\n| `scroll` | Scroll code blocks that exceed available width (default, corresponds to `white-space: pre`). |\n| `wrap` | Wrap lines of code that exceed available width (corresponds to `white-space: pre-wrap`). |\n\nYou can also override the global default on a per-code-block basis. For computational cells you do this with the `code-overflow` cell option:\n\n```{python}\n#| code-overflow: wrap\n\n# very long line of code....\n```\n\nFor a static code block, add the `.code-overflow-scroll` or `.code-overflow-wrap` CSS class:\n\n```` python\n```{.python .code-overflow-wrap}\n# very long line of code....\n```\n````\n\nNote that irrespective of these options, code will always wrap within printed HTML output (as it would otherwise be clipped off the edge of the page).\n\n## Code Tools\n\nYou can include a **Code** menu in the header of your document that provides various tools for readers to interact with the source code. Specify `code-tools: true` to activate these tools:\n\n``` yaml\nformat:\n html:\n code-fold: true\n code-tools: true\n```\n\nIf you have a document that includes folded code blocks then the **Code** menu will present options to show and hide the folded code as well as view the full source code of the document:\n\n{.border fig-alt=\"A screen shot of the header of a rendered Quarto document showing the result of setting both the code-fold and code-tools option to true. There is a drop-down menu labeled 'Code' to the right of the page title with a triangle pointing down. The menu is open and there are three options listed vertically beneath it: 'Hide All Code,' 'Show All Code,' and 'View Source.'\"}\n\nThis document specifies `code-tools: true` in its options so you should see the **Code** menu above next to the main header.\n\nYou can control which of these options are made available as well as the \"Code\" caption text using sub-options of `code-tools`. For example, here we specify that we want only \"View Source\" (no toggling of code visibility) and no caption on the code menu:\n\n``` yaml\nformat:\n html: \n code-tools:\n source: true\n toggle: false\n caption: none\n```\n\nBy default, the source code is embedded in the document and shown in a popup window like this:\n\n{fig-alt=\"A screenshot of this webpage with a pop-up window labeled 'Source Code' over it. This 'Source Code' window contains the raw markdown and R code used to write this page. There is an 'X' on the upper right corner of the 'Source Code' pop up to close it.\"}\n\nYou can alternatively specify a URL for the value of `source`:\n\n``` yaml\nformat:\n html: \n code-tools:\n source: https://github.com/quarto-dev/quarto-web/blob/main/index.md\n```\n\nIf you are within a project and have specified a `repo-url` option then you can just use `repo` and the correct link to your source file will be generated:\n\n``` yaml\nformat:\n html: \n code-tools:\n source: repo\n```\n\nNote that the `code-tools` option is not available when you disable the standard HTML theme (e.g. if you specify the `theme: none` option).\n\n## Appearance\n\nBy default code blocks are rendered with a left border whose color is derived from the current theme. You can customize code chunk appearance with some simple options that control the background color and left border. Options can either be booleans to enable or disable the treatment or can be legal CSS color strings (or they could even be SASS variable names!).\n\nHere is the default appearance for code blocks (`code-block-background: true`):\n\n{fig-alt=\"A block of code with a gray background.\"}\n\nYou can instead use a left border treatment using the `code-block-border-left` option:\n\n``` yaml\ncode-block-border-left: true\n```\n\n{fig-alt=\"A block of code with a gray vertical stripe running along its left border. This code block has no background.\"}\n\nYou can combine a background and border treatment as well as customize the left border color:\n\n``` yaml\ncode-block-bg: true\ncode-block-border-left: \"#31BAE9\"\n```\n\n{fig-alt=\"A block of code with a gray background and a blue vertical stripe running along its left border.\"}\n\n## Code Filename\n\nUse the `filename` attribute on code blocks If you are documenting the contents of a file and want to be especially clear about the name of the file the code is associated with.\n\nFor example, the following code:\n\n```` markdown\n```{.python filename=\"matplotlib.py\"}\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\n```\n````\n\nResults in this HTML output:\n\n\n\nNon-HTML formats will still have the filename, but it will simply be shown in bold above the code block.\n\n## Highlighting\n\nPandoc will automatically highlight syntax in [fenced code blocks](https://pandoc.org/MANUAL.html#fenced-code-blocks) that are marked with a language name. For example:\n\n ```python\n 1 + 1\n ```\n\nPandoc can provide syntax highlighting for over 140 different languages (see the output of `quarto pandoc --list-highlight-languages` for a list of all of them). If you want to provide the appearance of a highlighted code block for a language not supported, just use `default` as the language name.\n\nYou can specify the code highlighting style using `highlight-style` and specifying one of the supported themes. These themes are \"adaptive\", which means they will automatically switch between a dark and light mode based upon the theme of the website. These are designed to work well with sites that include a dark and light mode.\n\n- a11y\n- arrow\n- atom-one\n- ayu\n- breeze\n- github\n- gruvbox\n\nAll of the standard Pandoc themes are also available:\n\n- pygments\n- tango\n- espresso\n- zenburn\n- kate\n- monochrome\n- breezedark\n- haddock\n\nAs well as an additional set of extended themes, including:\n\n- dracula\n- monokai\n- nord\n- oblivion\n- printing\n- radical\n- solarized\n- vim-dark\n\nThe `highlight-style` option determines which theme is used. For example:\n\n``` yaml\nhighlight-style: github\n```\n\nHighlighting themes can provide either a single highlighting definition or two definitions, one optimized for a light colored background and another optimized for a dark color background. When available, Quarto will automatically select the appropriate style based upon the code chunk background color's darkness. Users may always opt to specify the full name (e.g. `atom-one-dark`) to by pass this automatic behavior.\n\nBy default, code is highlighted using the `arrow` theme, which is optimized for accessibility. We've additionally introduced the `arrow-dark` theme which is designed to provide accessible highlighting against dark backgrounds.\n\nExamples of the light and dark themes:\n\n#### Arrow (light)\n\n{fig.alt=\"A block of code showcasing the Arrow (light) theme.\"}\n\n#### Arrow (dark)\n\n{fig.alt=\"A block of code showcasing the Arrow (dark) theme.\"}\n\n#### Ayu (light)\n\n{fig.alt=\"A block of code showcasing the Ayu (light) theme.\"}\n\n#### Ayu (dark)\n\n{.preview-image fig.alt=\"A block of code showcasing the Ayu (dark) theme.\"}\n\n### Custom Highlighting\n\nIn addition to the built in themes available for syntax highlighting, you can also specify your own syntax highlighting by providing the path to a valid theme file (which is based upon the KDE XML syntax highlighting descriptions). Highlighting is implemented using [skylighting](https://github.com/jgm/skylighting).\n\nFor example:\n\n``` yaml\n---\nhighlight-style: custom.theme\n---\n```\n\nIn addition, if you'd like to provide adaptive themes, you may also pass both a light and dark theme file:\n\n``` yaml\n---\nhighlight-style:\n light: custom-light.theme\n dark: custom-dark.theme\n---\n```\n\nNote that as with adaptive text higlighting themes, when you provide a dark and light `highlight-style`, background colors specified in the themes will be ignored in favor of the overall theme specified background colors.\n\n{{< include _code-annotation.md >}}\n\n## Line Numbers\n\nIf you want to display line numbers alongside the code block, add the `code-line-numbers` option. For example:\n\n``` yaml\nformat:\n html:\n code-line-numbers: true\n```\n\nHere's how a code block with line numbers would display:\n\n``` {.python code-line-numbers=\"true\"}\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\n```\n\nYou can also enable line numbers for an individual code block using the `code-line-numbers` attribute. For example:\n\n```` python\n``` {.python code-line-numbers=\"true\"}\nimport matplotlib.pyplot as plt\nplt.plot([1,23,2,4])\nplt.show()\n```\n````\n\n## Executable Blocks\n\nThe documentation on [computations](/docs/get-started/computations/) covers how to include executable code blocks (code which is actually executed, with its output being included in the rendered document). We won't additionally cover that here, but we will talk about how to include code blocks that demonstrate executable syntax (e.g. for writing a tutorial).\n\n\n{{< include ../computations/_unexecuted-blocks.md >}}\n\n## Copy Button\n\nHover over the code block below and you will see a copy icon in the top-right corner:\n\n```{r eval=FALSE}\nlibrary(dygraphs)\ndygraph(nhtemp, main = \"New Haven Temperatures\") %>% \n dyRangeSelector(dateWindow = c(\"1920-01-01\", \"1960-01-01\"))\n```\n\nThis behavior is enabled by default but you configure it using the `code-copy` option:\n\n``` yaml\nformat:\n html:\n code-copy: false\n```\n\nValid values for `code-copy` include:\n\n| | |\n|---------|--------------------------------|\n| `hover` | Show button on hover (default) |\n| `true` | Always show code copy button |\n| `false` | Never show code copy button |\n\n## Code Linking\n\nThe `code-link` option enables hyper-linking of functions within code blocks to their online documentation:\n\n``` yaml\nformat:\n html:\n code-link: true\n```\n\nCode linking is currently implemented only for the knitr engine (via the [downlit](https://downlit.r-lib.org) package). A limitation of downlit currently prevents code linking if `code-line-numbers` is also `true`."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/html-code.html\",\n \"source\": \"https://quarto.org/docs/output-formats/html-code.html\"\n}"}}},{"rowIdx":158,"cells":{"page_content":{"kind":"string","value":"Overview\nUse the html format to create HTML output. For example:\n---\ntitle: \"My document\"\nformat:\n html:\n toc: true\n html-math-method: katex\n css: styles.css\n---\nThis example highlights a few of the options available for HTML output. This document covers these and other options in detail. See the HTML format reference for a complete list of all available options.\n\n\nTable of Contents\nUse the toc option to include an automatically generated table of contents in the output document. Use the toc-depth option to specify the number of section levels to include in the table of contents. The default is 3 (which means that level-1, 2, and 3 headings will be listed in the contents). For example:\ntoc: true\ntoc-depth: 2\nUse the toc-expand option to specify how much of the table of contents to show initially (defaults to 1 with auto-expansion as the user scrolls). Use true to expand all or false to collapse all.\ntoc: true\ntoc-expand: 2\nYou can customize the title used for the table of contents using the toc-title option:\ntoc-title: Contents\nIf you want to exclude a heading from the table of contents, add both the .unnumbered and .unlisted classes to it:\n### More Options {.unnumbered .unlisted}\nThe HTML format by default floats the table of contents to the right. You can alternatively position it at the left, or in the body. For example:\nformat:\n html:\n toc: true\n toc-location: left\nThe floating table of contents can be used to navigate to sections of the document and also will automatically highlight the appropriate section as the user scrolls. The table of contents is responsive and will become hidden once the viewport becomes too narrow. See an example on the right of this page.\nNote that the toc-location option is not available when you disable the standard HTML theme (e.g. if you specify the theme: none or theme: pandoc option).\n\n\nSection Numbering\nUse the number-sections option to number section headings in the output document. For example:\nnumber-sections: true\nUse the number-depth option to specify the deepest level of heading to add numbers to (by default all headings are numbered). For example:\nnumber-depth: 3\nTo exclude an individual heading from numbering, add the .unnumbered class to it:\n### More Options {.unnumbered}\n\n\nCSS Styles\nTo add a CSS stylesheet to your document, just provide the css option. For example:\nformat:\n html: \n css: styles.css\nUsing the css option works well for simple tweaks to document appearance. If you want to do more extensive customization see the documentation on HTML Themes.\n\n\nLaTeX Equations\nBy default, LaTeX equations are rendered using MathJax. Use the html-math-method option to choose another method. For example:\nformat:\n html:\n html-math-method: katex\nYou can also specify a url for the library to load for a given method:\nhtml-math-method:\n method: mathjax\n url: \"https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js\"\nAvailable math rendering methods include:\n\n\n\nMethod\nDescription\n\n\n\n\nmathjax\nUse MathJax to display embedded TeX math in HTML output.\n\n\nkatex\nUse KaTeX to display embedded TeX math in HTML output.\n\n\nwebtex\nConvert TeX formulas to tags that link to an external script that converts formulas to images.\n\n\ngladtex\nEnclose TeX math in tags in HTML output. The resulting HTML can then be processed by GladTeX to produce images of the typeset formulas and an HTML file with links to these images.\n\n\nmathml\nConvert TeX math to MathML (note that currently only Firefox and Safari natively support MathML)\n\n\nplain\nNo special processing (formulas are put inside a span with class=\"math\").\n\n\n\nNote that this is more detailed documentation on each of these options in the Pandoc Math Rendering in HTML documentation.\n\n\nTabsets\nYou can use tabsets to present content that will vary in interest depending on the audience. For example, here we provide some example code in a variety of languages:\n\nRPythonJavaJulia\n\n\nfizz_buzz <- function(fbnums = 1:50) {\n output <- dplyr::case_when(\n fbnums %% 15 == 0 ~ \"FizzBuzz\",\n fbnums %% 3 == 0 ~ \"Fizz\",\n fbnums %% 5 == 0 ~ \"Buzz\",\n TRUE ~ as.character(fbnums)\n )\n print(output)\n}\n\n\ndef fizz_buzz(num):\n if num % 15 == 0:\n print(\"FizzBuzz\")\n elif num % 5 == 0:\n print(\"Buzz\")\n elif num % 3 == 0:\n print(\"Fizz\")\n else:\n print(num)\n\n\npublic class FizzBuzz\n{\n public static void fizzBuzz(int num)\n {\n if (num % 15 == 0) {\n System.out.println(\"FizzBuzz\");\n } else if (num % 5 == 0) {\n System.out.println(\"Buzz\");\n } else if (num % 3 == 0) {\n System.out.println(\"Fizz\");\n } else {\n System.out.println(num);\n }\n }\n}\n\n\nfunction FizzBuzz(num)\n if num % 15 == 0\n println(\"FizzBuzz\")\n elseif num % 5 == 0\n println(\"Buzz\")\n elseif num % 3 == 0\n println(\"Fizz\")\n else\n println(num)\n end\nend\n\n\n\nCreate a tabset via a markdown div with the class name panel-tabset (e.g. ::: {.panel-tabset}). Each top-level heading within the div creates a new tab. For example, here is the markdown used to implement the first two tabs displayed above:\n::: {.panel-tabset}\n## R\n\n``` {.r}\nfizz_buzz <- function(fbnums = 1:50) {\n output <- dplyr::case_when(\n fbnums %% 15 == 0 ~ \"FizzBuzz\",\n fbnums %% 3 == 0 ~ \"Fizz\",\n fbnums %% 5 == 0 ~ \"Buzz\",\n TRUE ~ as.character(fbnums)\n )\n print(output)\n}\n```\n\n## Python\n\n``` {.python}\ndef fizz_buzz(num):\n if num % 15 == 0:\n print(\"FizzBuzz\")\n elif num % 5 == 0:\n print(\"Buzz\")\n elif num % 3 == 0:\n print(\"Fizz\")\n else:\n print(num)\n```\n\n:::\n\nTabset Groups\nIf you have multiple tabsets that include the same tab names, you can define a tabset group. Tabs within a group are all switched together (so in the example above once a reader switches to R or Python in one tabset the others will follow along). For example:\n::: {.panel-tabset group=\"language\"}\n## R\n\nTab content\n\n## Python\n\nTab content\n:::\n\n\n\nSelf Contained\nHTML documents typically have a number of external dependencies (e.g. images, CSS style sheets, JavaScript, etc.). By default these dependencies are placed in a _files directory alongside your document. For example, if you render report.qmd to HTML:\n\n\nTerminal\n\nquarto render report.qmd --to html\n\nThen the following output is produced:\nreport.html\nreport_files/\nYou might alternatively want to create an entirely self-contained HTML document (with images, CSS style sheets, JavaScript, etc. embedded into the HTML file). You can do this by specifying the embed-resources option:\nformat:\n html:\n embed-resources: true\nThis will produce a standalone HTML file with no external dependencies, using data: URIs to incorporate the contents of linked scripts, style sheets, images, and videos. The resulting file should be self contained, in the sense that it needs no external files and no net access to be displayed properly by a browser.\n\n\nAnchor Sections\nHover over a section title to see an anchor link. Enable/disable this behavior with:\nformat:\n html:\n anchor-sections: true\nAnchor links are also automatically added to figures and tables that have a cross reference defined.\n\n\nSmooth Scrolling\nEnable smooth scrolling within the page. By default, smooth scroll is not enabled. Enable/disable it with:\nformat:\n html:\n smooth-scroll: true\n\n\nExternal Links\nBy default external links (i.e. links that don’t target the current site) receive no special visual adornment or navigation treatment (the current page is navigated). You can use the following options to modify this behavior:\n\n\n\nOption\nDescription\n\n\n\n\nlink-external-icon\ntrue to show an icon next to the link to indicate that it’s external (e.g. external).\n\n\nlink-external-newwindow\ntrue to open external links in a new browser window or tab (rather than navigating the current tab).\n\n\nlink-external-filter\nA regular expression that can be used to determine whether a link is an internal link. For example\n^(?:http:|https:)\\/\\/www\\.quarto\\.org\\/custom\nwill treat links that start with http://www.quarto.org as internal links (and others will be considered external).\n\n\n\nExternal links are identified either using the site-url (if provided) or using the window.host if no site-url or link-external-filter is provided. For example, here we enable both options and a custom filter:\nformat:\n html:\n link-external-icon: true\n link-external-newwindow: true\n link-external-filter: '^(?:http:|https:)\\/\\/www\\.quarto\\.org\\/custom'\nYou can also specify one or both of these behaviors for an individual link using the .external class and target attribute. For example:\n[example](https://example.com){.external target=\"_blank\"}\n\n\nReference Popups\nIf you hover your mouse over the citation and footnote in this sentence you’ll see a popup displaying the reference contents:\n   Hover over Xie (2015) to see a reference to the definitive book on knitr1.\nThis behavior is enabled by default. You can disable it with the following options:\nformat:\n html:\n citations-hover: false\n footnotes-hover: false\n\n\nCommenting\nThis page has commenting with Hypothes.is enabled via the following YAML option:\ncomments:\n hypothesis: true\nYou can see the Hypothesis UI at the far right of the page. Rather than true, you can specify any of the available Hypothesis embedding options as a sub-key of hypothesis. For example:\ncomments:\n hypothesis: \n theme: clean\nYou can enable Utterances commenting using the utterances option. Here you need to specify at least the GitHub repo you want to use for storing comments:\ncomments:\n utterances:\n repo: quarto-dev/quarto-docs\nYou can also specify the other options documented here.\nYou may also enable Giscus for commenting using the giscus option. Giscus will store comments in the ‘Discussions’ of a Github repo.\ncomments:\n giscus: \n repo: quarto-dev/quarto-docs\nLike utterances, you need to specify at least the Git repo you want to use for storing comments. In addition, the repo that you use must:\n\nBe public\nHave the Giscus app installed.\nHave discussion enabled\n\nReview the Giscus documentation for instructions on setting up Giscus in your repository. Additional options are covered here.\n\nDisabling Comments\nIf you have comments enabled for an entire website or book, you can selectively disable comments for a single page by specifying comments: false. For example:\ntitle: \"Home Page\"\ncomments: false\n\n\n\nIncludes\nIf you want to include additional content in your document from another file, you can use the include-in-* options:\n\n\n\n\n\n\n\nOption\nDescription\n\n\n\n\ninclude-in-header\nInclude contents of file, verbatim, at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents or to inject commands into the LaTeX preamble.\n\n\ninclude-before-body\nInclude contents of file, verbatim, at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX). This can be used to include navigation bars or banners in HTML documents.\n\n\ninclude-after-body\nInclude contents of file, verbatim, at the end of the document body (before the tag in HTML, or the \\end{document} command in LaTeX).\n\n\n\nYou can specify a single file or multiple files for each of these options directly, or use the file: subkey. To include raw content in the YAML header, use the text subkey. When using text:, add the | character after text: to indicate that the value is a multi-line string. If you omit file: or text:, Quarto assumes you are providing a file.\nFor example:\nformat:\n html:\n include-in-header:\n - text: |\n \n - file: analytics.html\n - comments.html\n include-before-body: header.html\n\n\nMinimal HTML\nThe default Quarto HTML output format includes several features by default, including bootstrap themes, anchor sections, reference popups, tabsets, code block copying, and responsive figures. You can disable all of these built in features at once using the minimal option. For example:\n---\ntitle: \"My Document\"\nformat:\n html:\n minimal: true\n---\nWhen specifying minimal: true you can still selectively re-enable features you do want, for example:\n---\ntitle: \"My Document\"\nformat:\n html:\n minimal: true\n code-copy: true\n---\n\nReferences\n\nXie, Yihui. 2015. Dynamic Documents with R and Knitr. 2nd ed. Boca Raton, Florida: Chapman; Hall/CRC. https://yihui.name/knitr/.\n\nFootnotes\n\nknitr is an R package for creating dynamic documents.↩︎"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/html-basics.html\",\n \"source\": \"https://quarto.org/docs/output-formats/html-basics.html\"\n}"}}},{"rowIdx":159,"cells":{"page_content":{"kind":"string","value":"Overview\nThis article covers the various ways you can publish Quarto HTML documents, including publishing to a hosting service or sharing a standalone HTML file using E-mail, Dropbox, etc.\nNote that it’s also possible to publish collections of Quarto documents as a website. See the article on Publishing Basics for additional details.\n\n\nPublish Command\nThe quarto publish command provides a straightforward way to publish documents to Quarto Pub, GitHub Pages, Netlify, and Posit Connect.\nFor example, here are the commands to publish document.qmd to each of these services:\n\n\nTerminal\n\nquarto publish quarto-pub document.qmd\nquarto publish gh-pages document.qmd\nquarto publish netlify document.qmd\nquarto publish connect document.qmd\n\nFor simple publishing of individual documents there’s not much more to learn than quarto publish.\nHere’s a brief overview of the various supported services and when they might be an appropriate choice:\n\n\n\n\n\n\n\nDestination\nDescription\n\n\n\n\nQuarto Pub\nPublishing service for Quarto documents, websites, and books. Use Quarto Pub when you want a free, easy to use service for publicly available content.\n\n\nGitHub Pages\nPublish content based on source code managed within a GitHub repository. Use GitHub Pages when the source code for your document or site is hosted on GitHub.\n\n\nPosit Connect\nPublishing platform for secure sharing of data products within an organization. Use Posit Connect when you want to publish content within an organization rather than on the public internet.\n\n\nNetlify\nProfessional web publishing platform. Use Netlify when you want support for custom domains, authentication, previewing branches, and other more advanced capabilities.\n\n\nOther Services\nContent rendered with Quarto uses standard formats (HTML, PDFs, MS Word, etc.) that can be published anywhere. Use this if one of the methods above don’t meet your requirements.\n\n\n\nNote that the documentation linked to above generally references publishing an entire project (website or book) but all of the commands work just the same if you publish an individual document or presentation as demonstrated above.\n\n\nStandalone HTML\nYou can optionally render Quarto documents into self contained HTML, whereby all of the content required to render the article (images generated by plots, required CSS and JavaScript, etc.) are bundled into a single HTML file. Use the embed-resources option to do this:\nformat:\n html:\n embed-resources: true\nThen, you can share this HTML file using the same means you use to share other document types like spreadsheets, presentations, and PDFs (e.g by uploading it to Dropbox or any other file sharing service).\nNote that when using embed-resources: true, math libraries like MathJax and KaTeX are not embedded by default because they are quite large and often time consuming to download. If you do want to embed math libraries, add the self-contained-math: true option:\nformat:\n html:\n embed-resources: true\n self-contained-math: true"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.675Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/html-publishing.html\",\n \"source\": \"https://quarto.org/docs/output-formats/html-publishing.html\"\n}"}}},{"rowIdx":160,"cells":{"page_content":{"kind":"string","value":"Using Templates\nIf you want to customize the appearance of MS Word output, Pandoc supports a special type of template called a reference document. Here’s an example of specifying a custom reference document for docx:\nformat:\n docx:\n reference-doc: custom-reference-doc.docx\nReference documents include sample text that uses all of the output styles used by Pandoc.\nTo use a reference doc template, just copy it to your document’s directory and reference it as shown above.\n\n\nCreating Templates\nTo create a new reference doc based on the Pandoc default, execute the following command:\n$ quarto pandoc -o custom-reference-doc.docx \\\n --print-default-data-file reference.docx\nThen, open custom-reference-doc.docx in MS Word and modify styles as you wish:\n\n\n\nYou can open the Styles pane from the HOME tab in the MS Word toolbar.\n\n\nWhen you move the cursor to a specific element in the document, an item in the styles list will be highlighted. If you want to modify the style of any type of element, you can click the drop-down menu on the highlighted item, and you will see a dialog box like this:\n\nAfter you finish modifying the styles, you can save the document and use it as the template for future Word documents."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.703Z\",\n \"loc\": \"https://quarto.org/docs/output-formats/ms-word-templates.html\",\n \"source\": \"https://quarto.org/docs/output-formats/ms-word-templates.html\"\n}"}}},{"rowIdx":161,"cells":{"page_content":{"kind":"string","value":"Overview\nQuarto sometimes allows you to provide a path or paths using glob syntax, providing wildcard expansion and other behavior that makes it simple to match a list of files without having to specify each file individually. Globs may be used:\n\nWhen specifying render targets in Quarto projects (see Render Targets).\nWhen defining resources for Quarto websites (see Site Resources).\nWhen defining documents to include in a listing (see Listing Contents).\nWhen automatically creating navigation for sidebars (see Auto Navigation).\n\n\n\nGlob Syntax\nThe below is a general reference of the syntax used for globs in Quarto. Note that globs match the filesystem recursively. If you prefer that they don’t, then prefix the pattern with a / (for example, use /*.qmd rather than *.qmd).\n\n* - Matches everything.\n{foo,bar} - Matches foo or bar.\n[abcd] - Matches a, b, c or d.\n[a-d] - Matches a, b, c or d.\n[!abcd] - Matches any single character besides a, b, c or d.\n[[::]] - Matches any character belonging to .\n\n[[:alnum:]] - Matches any digit or letter.\n[[:digit:]abc] - Matches any digit, a, b or c.\nSee https://facelessuser.github.io/wcmatch/glob/#posix-character-classes for a complete list of supported character classes.\n\n\\ - Escapes the next character for an os other than \"windows\".\n` - Escapes the next character for os set to \"windows\".\n/ - Path separator.\n\\ - Additional path separator only for os set to \"windows\".\n?(foo|bar) - Matches 0 or 1 instance of {foo,bar}.\n@(foo|bar) - Matches 1 instance of {foo,bar}. They behave the same.\n*(foo|bar) - Matches n instances of {foo,bar}.\n+(foo|bar) - Matches n > 0 instances of {foo,bar}.\n!(foo|bar) - Matches anything other than {foo,bar}.\n** - Matches any number of any path segments.\n\nMust comprise its entire path segment in the provided glob.\nSee https://www.linuxjournal.com/content/globstar-new-bash-globbing-option."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/globs.html\",\n \"source\": \"https://quarto.org/docs/reference/globs.html\"\n}"}}},{"rowIdx":162,"cells":{"page_content":{"kind":"string","value":"Documents\n\n\nHTML\nPDF\nMS Word\nOpen Office\nePub\n\n\n\n\n\n\nPresentations\n\n\nRevealjs\nPowerPoint\nBeamer\n\n\n\n\n\n\nMarkdown\n\n\nGitHub\nCommonMark\nMarkua\n\n\n\n\n\n\nWikis\n\n\nMediaWiki\nJira Wiki\nDokuWiki\nZimWiki\nXWiki\n\n\n\n\n\n\nCode Cells\n\n\nJupyter\nKnitr\nObservable JS\n\n\n\n\n\n\nProjects\n\n\nOptions\nWebsites\nBooks\n\n\n\n\n\n\nMetadata\n\n\nDates\nGlobs\nCitations\n\n\n\n\n\nNo matching items"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/index.html\",\n \"source\": \"https://quarto.org/docs/reference/index.html\"\n}"}}},{"rowIdx":163,"cells":{"page_content":{"kind":"string","value":"GitHub Flavored Markdown, often shortened as GFM, is the dialect of Markdown that is currently supported for user content on GitHub.com and GitHub Enterprise. To learn about GFM see https://github.github.com/gfm/.\nSee the GFM format user guide for more details on creating GFM output with Quarto.\nformat: gfm\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\nhtml-math-method\nMethod use to render math in HTML output (plain, webtex, gladtex, mathml, mathjax, katex).\nSee the Pandoc documentation on Math Rendering in HTML for additional details.\n\n\nidentifier-prefix\nSpecify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.\n\n\nvariant\nEnable and disable extensions for markdown output (e.g. “+emoji”)\n\n\nmarkdown-headings\nSpecify whether to use atx (#-prefixed) or setext (underlined) headings for level 1 and 2 headings (atx or setext).\n\n\nkeep-yaml\nPreserve the original YAML front matter in rendered markdown\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\npreview-mode\nThe mode to use when previewing this document. To disable any special previewing features, pass raw as the preview-mode.\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nFootnotes\n\n\n\n\n\n\n\nreference-location\nSpecify location for footnotes. Also controls the location of references, if reference-links is set.\n\nblock: Place at end of current top-level block\nsection: Place at end of current section\nmargin: Place at the margin\ndocument: Place at end of document\n\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run).\n\n\n\nstrip-comments\nStrip out HTML comments in the Markdown source, rather than passing them on to Markdown, Textile or HTML output as raw HTML. This does not apply to HTML comments inside raw HTML blocks when the markdown_in_html_blocks extension is not set.\n\n\nascii\nUse only ASCII characters in output. Currently supported for XML and HTML formats (which use entities instead of UTF-8 when this option is selected), CommonMark, gfm, and Markdown (which use entities), roff ms (which use hexadecimal escapes), and to a limited degree LaTeX (which uses standard commands for accented characters when possible). roff man output uses ASCII by default."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/markdown/gfm.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/markdown/gfm.html\"\n}"}}},{"rowIdx":164,"cells":{"page_content":{"kind":"string","value":"CommonMark is a strongly defined, highly compatible specification of Markdown. You can learn more about CommonMark at https://commonmark.org/.\nformat: commonmark\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nidentifier-prefix\nSpecify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.\n\n\nvariant\nEnable and disable extensions for markdown output (e.g. “+emoji”)\n\n\nmarkdown-headings\nSpecify whether to use atx (#-prefixed) or setext (underlined) headings for level 1 and 2 headings (atx or setext).\n\n\nkeep-yaml\nPreserve the original YAML front matter in rendered markdown\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nFootnotes\n\n\n\n\n\n\n\nreference-location\nSpecify location for footnotes. Also controls the location of references, if reference-links is set.\n\nblock: Place at end of current top-level block\nsection: Place at end of current section\nmargin: Place at the margin\ndocument: Place at end of document\n\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run).\n\n\n\nstrip-comments\nStrip out HTML comments in the Markdown source, rather than passing them on to Markdown, Textile or HTML output as raw HTML. This does not apply to HTML comments inside raw HTML blocks when the markdown_in_html_blocks extension is not set.\n\n\nascii\nUse only ASCII characters in output. Currently supported for XML and HTML formats (which use entities instead of UTF-8 when this option is selected), CommonMark, gfm, and Markdown (which use entities), roff ms (which use hexadecimal escapes), and to a limited degree LaTeX (which uses standard commands for accented characters when possible). roff man output uses ASCII by default."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/markdown/commonmark.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/markdown/commonmark.html\"\n}"}}},{"rowIdx":165,"cells":{"page_content":{"kind":"string","value":"JATS (Journal Article Tag Suite) is an XML format for marking up and exchanging journal content. You can learn more about JATS here https://jats.nlm.nih.gov/publishing/.\nformat: jats\nformat: jats_archiving\nformat: jats_articleauthoring\nformat: jats_publishing\n\nTitle & Author\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\naffiliation\nThe list of organizations with which contributors are affiliated. Each institution is added as an [] element to the author’s contrib-group. See the Pandoc JATS documentation for details on affiliation fields.\n\n\ncopyright\nLicensing and copyright information. This information is rendered via the element. The variables type, link, and text should always be used together. See the Pandoc JATS documentation for details on copyright fields.\n\n\narticle\nInformation concerning the article that identifies or describes it. The key-value pairs within this map are typically used within the element. See the Pandoc JATS documentation for details on article fields.\n\n\njournal\nInformation on the journal in which the article is published. See the Pandoc JATS documentation for details on journal fields.\n\n\nabstract\nSummary of document\n\n\nnotes\nAdditional notes concerning the whole article. Added to the article’s frontmatter via the element.\n\n\ntags\nList of keywords. Items are used as contents of the element; the elements are grouped in a with the kwd-group-type value author.\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\npreview-mode\nThe mode to use when previewing this document. To disable any special previewing features, pass raw as the preview-mode.\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nMetadata\n\n\n\n\n\n\n\ncopyright\nThe copyright for this document, if any.\n\n\nlicense\nThe license for this document, if any.\nCreative Commons licenses CC BY, CC BY-SA, CC BY-ND, CC BY-NC will automatically generate a license link in the document appendix. Other license text will be placed in the appendix verbatim.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/jats.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/jats.html\"\n}"}}},{"rowIdx":166,"cells":{"page_content":{"kind":"string","value":"OpenDocument, is an open standard file format for word processing documents It was developed with the aim of providing an open, XML-based file format specification for office applications. To learn more about OpenDocument see https://en.wikipedia.org/wiki/OpenDocument.\nformat: odt\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\nsubtitle\nIdentifies the subtitle of the document.\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\nabstract\nSummary of document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nreference-doc\nUse the specified file as a style reference in producing a docx, pptx, or odt file.\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\ntoc-title\nThe title used for the table of contents.\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\npage-width\nTarget 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.\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-align\nFigure horizontal alignment (default, left, right, or center)\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/odt.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/odt.html\"\n}"}}},{"rowIdx":167,"cells":{"page_content":{"kind":"string","value":"reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. You can learn more about reStructuredText at https://docutils.sourceforge.io/rst.html.\nformat: rst\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nFormatting\n\n\n\n\n\n\n\nlist-tables\nIf true, tables are formatted as RST list tables.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/rst.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/rst.html\"\n}"}}},{"rowIdx":168,"cells":{"page_content":{"kind":"string","value":"Org-Mode is an Emacs major mode for keeping notes, authoring documents, computational notebooks, literate programming, maintaining to-do lists, planning projects, and more. To learn more about Org-Mode see https://orgmode.org/.\nformat: org\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/org.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/org.html\"\n}"}}},{"rowIdx":169,"cells":{"page_content":{"kind":"string","value":"MediaWiki is the native document format of Wikipedia. To learn more about MediaWiki see https://www.mediawiki.org.\nformat: mediawiki\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/wiki/mediawiki.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/wiki/mediawiki.html\"\n}"}}},{"rowIdx":170,"cells":{"page_content":{"kind":"string","value":"Jira Wiki is the native document format for the Jira issue tracking and project management system from Atlassian. To learn more about Jira Wikis see https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all.\nformat: jira\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/wiki/jira.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/wiki/jira.html\"\n}"}}},{"rowIdx":171,"cells":{"page_content":{"kind":"string","value":"Zim is a graphical text editor used to maintain a collection of wiki pages. To learn more about ZimWiki see https://zim-wiki.org/.\nformat: zimwiki\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/wiki/zimwiki.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/wiki/zimwiki.html\"\n}"}}},{"rowIdx":172,"cells":{"page_content":{"kind":"string","value":"Emacs Muse is an authoring and publishing environment for Emacs. It simplifies the process of writing documents and publishing them to various output formats. To learn more about Emacs Muse see https://www.gnu.org/software/emacs-muse/manual/.\nformat: muse\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\nsubtitle\nIdentifies the subtitle of the document.\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nFootnotes\n\n\n\n\n\n\n\nreference-location\nSpecify location for footnotes. Also controls the location of references, if reference-links is set.\n\nblock: Place at end of current top-level block\nsection: Place at end of current section\nmargin: Place at the margin\ndocument: Place at end of document\n\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/muse.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/muse.html\"\n}"}}},{"rowIdx":173,"cells":{"page_content":{"kind":"string","value":"Haddock is a tool for automatically generating documentation from annotated Haskell source code. You can learn more about Haddock at https://haskell-haddock.readthedocs.io/.\nformat: haddock\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nidentifier-prefix\nSpecify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/haddock.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/haddock.html\"\n}"}}},{"rowIdx":174,"cells":{"page_content":{"kind":"string","value":"PowerPoint is the presentation editing software included with Microsoft Office. You can learn more about PowerPoint at https://en.wikipedia.org/wiki/Microsoft_PowerPoint.\nSee the PowerPoint format user guide for more details on creating PowerPoint output with Quarto.\nformat: pptx\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nreference-doc\nUse the specified file as a style reference in producing a docx, pptx, or odt file.\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\ntoc-title\nThe title used for the table of contents.\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nSlides\n\n\n\n\n\n\n\nincremental\nMake list items in slide shows display incrementally (one by one). The default is for lists to be displayed all at once.\n\n\nslide-level\nSpecifies that headings with the specified level create slides. Headings above this level in the hierarchy are used to divide the slide show into sections; headings below this level create subheads within a slide. Valid values are 0-6. If a slide level of 0 is specified, slides will not be split automatically on headings, and horizontal rules must be used to indicate slide boundaries. If a slide level is not specified explicitly, the slide level will be set automatically based on the contents of the document\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nMetadata\n\n\n\n\n\n\n\nsubject\nThe document subject\n\n\ndescription\nThe document description. Some applications show this as Comments metadata.\n\n\ncategory\nThe document category.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/presentations/pptx.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/presentations/pptx.html\"\n}"}}},{"rowIdx":175,"cells":{"page_content":{"kind":"string","value":"DocBook is an XML schema particularly well suited to books and papers about computer hardware and software (though it is by no means limited to these applications). You can learn more about DocBook at https://www.docbook.org/.\nformat: docbook\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nidentifier-prefix\nSpecify a prefix to be added to all identifiers and internal links in HTML and DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for preventing duplicate identifiers when generating fragments to be included in other pages.\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\ntop-level-division\nTreat top-level headings as the given division type (default, section, chapter, or part). The hierarchy order is part, chapter, then section; all headings are shifted such that the top-level heading becomes the specified type.\nThe default behavior is to determine the best division type via heuristics: unless other conditions apply, section is chosen. When the documentclass variable is set to report, book, or memoir (unless the article option is specified), chapter is implied as the setting for this option. If beamer is the output format, specifying either chapter or part will cause top-level headings to become \\part{..}, while second-level headings remain as their default type.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/docbook.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/docbook.html\"\n}"}}},{"rowIdx":176,"cells":{"page_content":{"kind":"string","value":"The Rich Text Format (RTF) is a proprietary document file format with published specification developed by Microsoft Corporation from 1987 until 2008 for cross-platform document interchange with Microsoft products. Learn more about RTF at https://en.wikipedia.org/wiki/Rich_Text_Format.\nformat: rtf\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-align\nFigure horizontal alignment (default, left, right, or center)\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/rtf.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/rtf.html\"\n}"}}},{"rowIdx":177,"cells":{"page_content":{"kind":"string","value":"ICML is an XML representation of an Adobe InDesign document. You can learn more about ICML at https://wwwimages.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-specification.pdf.\nformat: icml\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/icml.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/icml.html\"\n}"}}},{"rowIdx":178,"cells":{"page_content":{"kind":"string","value":"Texinfo is the official documentation format of the GNU project. Texinfo uses a single source file to produce output in a number of formats, both online and printed (DVI, HTML, Info, PDF, XML, etc.). To learn more about Texinfo see https://www.gnu.org/software/texinfo/.\nformat: texinfo\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\n\n\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nwrap\nDetermine how text is wrapped in the output (the source code, not the rendered version).\n\nauto (default): Pandoc will attempt to wrap lines to the column width specified by columns (default 72).\nnone: Pandoc will not wrap lines at all.\npreserve: Pandoc will attempt to preserve the wrapping from the source document. Where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well.\n\n\n\ncolumns\nSpecify length of lines in characters. This affects text wrapping in generated source code (see wrap). It also affects calculation of column widths for plain text tables.\n\n\ntab-stop\nSpecify the number of spaces per tab (default is 4). Note that tabs within normal textual input are always converted to spaces. Tabs within code are also converted, however this can be disabled with preserve-tabs: false.\n\n\npreserve-tabs\nPreserve tabs within code instead of converting them to spaces. (By default, pandoc converts tabs to spaces before parsing its input.) Note that this will only affect tabs in literal code spans and code blocks. Tabs in regular text are always treated as spaces.\n\n\neol\nManually specify line endings:\n\ncrlf: Use Windows line endings\nlf: Use macOS/Linux/UNIX line endings\nnative (default): Use line endings appropriate to the OS on which pandoc is being run)."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/texinfo.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/texinfo.html\"\n}"}}},{"rowIdx":179,"cells":{"page_content":{"kind":"string","value":"ePub is an e-book file format that is supported by many e-readers, and compatible software is available for most smartphones, tablets, and computers. You can learn more about ePub at https://en.wikipedia.org/wiki/EPUB.\nformat: epub\n\nTitle & Author\n\n\n\n\n\n\n\ntitle\nDocument title\n\n\nsubtitle\nIdentifies the subtitle of the document.\n\n\ndate\nDocument date\n\n\nauthor\nAuthor or authors of the document\n\n\nabstract\nSummary of document\n\n\nabstract-title\nTitle used to label document abstract\n\n\norder\nOrder for document when included in a website automatic sidebar menu.\n\n\n\n\n\nFormat Options\n\n\n\ncss\nOne or more CSS style sheets.\n\n\nhtml-math-method\nMethod use to render math in HTML output (plain, webtex, gladtex, mathml, mathjax, katex).\nSee the Pandoc documentation on Math Rendering in HTML for additional details.\n\n\nhtml-q-tags\nUse tags for quotes in HTML.\n\n\nquarto-required\nA semver version range describing the supported quarto versions for this document or project.\nExamples:\n\n>= 1.1.0: Require at least quarto version 1.1\n1.*: Require any quarto versions whose major version number is 1\n\n\n\n\n\n\nTable of Contents\n\n\n\n\n\n\n\ntoc\nInclude 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. This option has no effect if standalone is false.\nNote 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.\n\n\ntoc-depth\nSpecify the number of section levels to include in the table of contents. The default is 3\n\n\ntoc-title\nThe title used for the table of contents.\n\n\n\n\n\nNumbering\n\n\n\n\n\n\n\nnumber-sections\nNumber section headings rendered output. By default, sections are not numbered. Sections with class .unnumbered will never be numbered, even if number-sections is specified.\n\n\nnumber-depth\nBy default, all headings in your document create a numbered section. You customize numbering depth using the number-depth option.\nFor example, to only number sections immediately below the chapter level, use this:\nnumber-depth: 1\n\n\nnumber-offset\nOffset 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\n\n\nshift-heading-level-by\nShift 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.\n\n\n\n\n\nePub Options\n\n\n\nidentifier\nThe identifier for this publication.\n\n\ncreator\nCreators of this publication.\n\n\ncontributor\nContributors to this publication.\n\n\nsubject\nThe subject of the publication.\n\n\ntype\nText describing the specialized type of this publication.\nAn informative registry of specialized EPUB Publication types for use with this element is maintained in the TypesRegistry, but Authors may use any text string as a value.\n\n\nformat\nText describing the format of this publication.\n\n\nrelation\nText describing the relation of this publication.\n\n\ncoverage\nText describing the coverage of this publication.\n\n\nrights\nText describing the rights of this publication.\n\n\nbelongs-to-collection\nIdentifies the name of a collection to which the EPUB Publication belongs.\n\n\ngroup-position\nIndicates the numeric position in which this publication belongs relative to other works belonging to the same belongs-to-collection field.\n\n\npage-progression-direction\nSets the global direction in which content flows (ltr or rtl)\n\n\nibooks\niBooks specific metadata options.\n\n\nepub-metadata\nLook in the specified XML file for metadata for the EPUB. The file should contain a series of Dublin Core elements. For example:\nCreative Commons\nes-AR\nBy default, pandoc will include the following metadata elements: (from the document title), (from the document authors), (from the document date, which should be in [ISO 8601 format]), (from the lang variable, or, if is not set, the locale), and (a randomly generated UUID). Any of these may be overridden by elements in the metadata file.\nNote: if the source document is Markdown, a YAML metadata block in the document can be used instead.\n\n\nepub-subdirectory\nSpecify the subdirectory in the OCF container that is to hold the EPUB-specific contents. The default is EPUB. To put the EPUB contents in the top level, use an empty string.\n\n\nepub-fonts\nEmbed the specified fonts in the EPUB. Wildcards can also be used: for example, DejaVuSans-*.ttf. To use the embedded fonts, you will need to add declarations like the following to your CSS:\n@font-face {\n font-family: DejaVuSans;\n font-style: normal;\n font-weight: normal;\n src:url(\"DejaVuSans-Regular.ttf\");\n}\n\n\nepub-chapter-level\nSpecify the heading level at which to split the EPUB into separate chapter files. The default is to split into chapters at level-1 headings. This option only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users. Some readers may be slow if the chapter files are too large, so for large documents with few level-1 headings, one might want to use a chapter level of 2 or 3.\n\n\nepub-cover-image\nUse the specified image as the EPUB cover. It is recommended that the image be less than 1000px in width and height.\n\n\nepub-title-page\nIf false, disables the generation of a title page.\n\n\n\n\n\nLayout\n\n\n\n\n\n\n\ngrid\nProperties of the grid system used to layout Quarto HTML pages.\n\n\n\n\n\nFormatting\n\n\n\n\n\n\n\nsplit-level\nSpecify the heading level at which to split the EPUB into separate chapter files. The default is to split into chapters at level-1 headings. This option only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users. Some readers may be slow if the chapter files are too large, so for large documents with few level-1 headings, one might want to use a chapter level of 2 or 3.\n\n\n\n\n\nCode\n\n\n\n\n\n\n\ncode-fold\nCollapse code into an HTML

tag so the user can display it on-demand.\n\ntrue: collapse code\nfalse (default): do not collapse code\nshow: use the

tag, but show the expanded code initially.\n\n\n\ncode-summary\nSummary text to use for code blocks collapsed using code-fold\n\n\ncode-overflow\nChoose how to handle code overflow, when code lines are too wide for their container. One of:\n\nscroll\nwrap\n\n\n\ncode-line-numbers\nInclude line numbers in code block output (true or false).\nFor revealjs output only, you can also specify a string to highlight specific lines (and/or animate between sets of highlighted lines).\n\nSets of lines are denoted with commas:\n\n3,4,5\n1,10,12\n\nRanges can be denoted with dashes and combined with commas:\n\n1-3,5\n5-10,12,14\n\nFinally, animation steps are separated by |:\n\n1-3|1-3,5 first shows 1-3, then 1-3,5\n|5|5-10,12 first shows no numbering, then 5, then lines 5-10 and 12\n\n\n\n\ncode-copy\nEnable a code copy icon for code blocks.\n\ntrue: Always show the icon\nfalse: Never show the icon\nhover (default): Show the icon when the mouse hovers over the code block\n\n\n\ncode-annotations\nThe style to use when displaying code annotations. Set this value to false to hide code annotations.\n\n\nhighlight-style\nSpecifies the coloring style to be used in highlighted source code.\nInstead 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.\n\n\nsyntax-definitions\nKDE language syntax definition files (XML)\n\n\nindented-code-classes\nSpecify classes to use for all indented code blocks\n\n\n\n\n\nExecution\nExecution options should be specified within the execute key. For example:\nexecute:\n echo: false\n warning: false\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\ncache\nCache results of computations (using the knitr cache for R documents, and Jupyter Cache for Jupyter documents).\nNote that cache invalidation is triggered by changes in chunk source code (or other cache attributes you’ve defined).\n\ntrue: Cache results\nfalse: Do not cache results\nrefresh: Force a refresh of the cache even if has not been otherwise invalidated.\n\n\n\nfreeze\nControl the re-use of previous computational output when rendering.\n\ntrue: Never recompute previously generated computational output during a global project render\nfalse (default): Recompute previously generated computational output\nauto: Re-compute previously generated computational output only in case their source file changes\n\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-align\nFigure horizontal alignment (default, left, right, or center)\n\n\nfig-width\nDefault width for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-height\nDefault height for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-format\nDefault format for figures generated by Matplotlib or R graphics (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures generated by Matplotlib or R graphics.\nNote 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.\n\n\nfig-asp\nThe 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.\nThe fig-asp option is only available within the knitr engine.\n\n\nfig-responsive\nWhether to make images in this document responsive.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\ndf-print\nMethod used to print tables in Knitr engine documents:\n\ndefault: Use the default S3 method for the data frame.\nkable: Markdown table using the knitr::kable() function.\ntibble: Plain text table using the tibble package.\npaged: HTML table with paging for row and column overflow.\n\nThe default printing method is kable.\n\n\n\n\n\nReferences\n\n\n\n\n\n\n\nbibliography\nDocument bibliography (BibTeX or CSL). May be a single file or a list of files\n\n\ncsl\nCitation Style Language file to use for formatting references.\n\n\nciteproc\nTurn 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.\n\n\ncitation-abbreviations\nJSON 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:\n{ \"default\": {\n \"container-title\": {\n \"Lloyd's Law Reports\": \"Lloyd's Rep\",\n \"Estates Gazette\": \"EG\",\n \"Scots Law Times\": \"SLT\"\n }\n }\n}\n\n\n\n\n\nCitation\n\n\n\ncitation\nCitation information for the document itself specified as CSL YAML in the document front matter.\nFor more on supported options, see Citation Metadata.\n\n\n\n\n\nLanguage\n\n\n\nlang\nIdentifies 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.\nThis affects most formats, and controls hyphenation in PDF output when using LaTeX (through babel and polyglossia) or ConTeXt.\n\n\nlanguage\nYAML file containing custom language translations\n\n\ndir\nThe base script direction for the document (rtl or ltr).\nFor 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].\nWhen using LaTeX for bidirectional documents, only the xelatex engine is fully supported (use --pdf-engine=xelatex).\n\n\n\n\n\nIncludes\n\n\n\n\n\n\n\ninclude-before-body\nInclude contents at the beginning of the document body (e.g. after the tag in HTML, or the \\begin{document} command in LaTeX).\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-after-body\nInclude content at the end of the document body immediately after the markdown content. While it will be included before the closing tag in HTML and the \\end{document} command in LaTeX, this option refers to the end of the markdown content.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\ninclude-in-header\nInclude contents at the end of the header. This can be used, for example, to include special CSS or JavaScript in HTML documents.\nA string value or an object with key “file” indicates a filename whose contents are to be included\nAn object with key “text” indicates textual content to be included\n\n\nresources\nPath (or glob) to files to publish with this document.\n\n\nmetadata-files\nRead 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.\n\n\n\n\n\nMetadata\n\n\n\n\n\n\n\ndate-meta\nSets the date metadata for the document\n\n\n\n\n\nRendering\n\n\n\n\n\n\n\nfrom\nFormat to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n\n\noutput-file\nOutput file to write to\n\n\noutput-ext\nExtension to use for generated output file\n\n\ntemplate\nUse the specified file as a custom template for the generated document.\n\n\ntemplate-partials\nInclude the specified files as partials accessible to the template for the generated content.\n\n\nstandalone\nProduce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n\n\nfilters\nSpecify 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.\n\n\nshortcodes\nSpecify Lua scripts that implement shortcode handlers\n\n\nkeep-md\nKeep the markdown file generated by executing code\n\n\nkeep-ipynb\nKeep the notebook file generated from executing code.\n\n\nipynb-filters\nFilters to pre-process ipynb files before rendering to markdown\n\n\nextract-media\nExtract 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.\n\n\nresource-path\nList of paths to search for images and other resources.\n\n\ndefault-image-extension\nSpecify 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.\n\n\nabbreviations\nSpecifies 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.\n\n\ndpi\nSpecify 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.\n\n\n\n\n\nText Output\n\n\n\n\n\n\n\nascii\nUse only ASCII characters in output. Currently supported for XML and HTML formats (which use entities instead of UTF-8 when this option is selected), CommonMark, gfm, and Markdown (which use entities), roff ms (which use hexadecimal escapes), and to a limited degree LaTeX (which uses standard commands for accented characters when possible). roff man output uses ASCII by default."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/formats/epub.html\",\n \"source\": \"https://quarto.org/docs/reference/formats/epub.html\"\n}"}}},{"rowIdx":180,"cells":{"page_content":{"kind":"string","value":"All available options for book projects are documented below. See Creating a Book for an in-depth guide to creating books with Quarto.\n\nProject\nOptions that define the type, render targets, and output of a project. Project options are specified under the project key. For example:\n---\nproject:\n type: book\n output-dir: _book\n---\n\n\n\n\ntitle\n\n\n\ntype\nProject type (default, website, or book)\n\n\nrender\nFiles to render (defaults to all files)\n\n\nexecute-dir\nControl the working directory for computations.\n\nfile: Use the directory of the file that is currently executing.\nproject: Use the root directory of the project.\n\n\n\noutput-dir\nOutput directory\n\n\nlib-dir\nHTML library (JS/CSS/etc.) directory\n\n\nresources\nAdditional file resources to be copied to output directory\n\n\npreview\nOptions for quarto preview (see Preview)\n\n\npre-render\nScripts to run as a pre-render step\n\n\npost-render\nScripts to run as a post-render step\n\n\n\n\n\nPreview\nSpecify options that control the behavior of quarto preview within the preview key. For example:\n---\nproject:\n type: book\n output-dir: _book\n preview:\n port: 4200\n browser: false\n---\nAvailable preview options include:\n\n\n\n\nport\nPort to listen on (defaults to random value between 3000 and 8000)\n\n\nhost\nHostname to bind to (defaults to 127.0.0.1)\n\n\nserve\nOptions for external preview server (see Serve)\n\n\nbrowser\nOpen a web browser to view the preview (defaults to true)\n\n\nwatch-inputs\nRe-render input files when they change (defaults to true)\n\n\nnavigate\nNavigate the browser automatically when outputs are updated (defaults to true)\n\n\ntimeout\nTime (in seconds) after which to exit if there are no active clients\n\n\n\n\n\n\nServe\nIf you are creating a project extension for another publishing system that includes its own preview server (for example, Hugo or Docusaurus) then use the preview: serve options to customize the behavior of the preview server.\n\n\n\n\n\n\n\n\ncmd\nServe project preview using the specified command. Interpolate the --port into the command using {port}.\n\n\nargs\nAdditional command line arguments for preview command.\n\n\nenv\nEnvironment variables to set for preview command.\n\n\nready\nRegular expression for detecting when the server is ready.\n\n\n\n\nSee the Hugo and Docusaurus extension source code for example usages of preview: serve.\n\n\n\nBook\nOptions that affect book output. Book options are specified under the book key. For example:\n---\nbook:\n title: \"My Book\"\n image: opengraph.png\n page-navigation: true\n---\n\n\n\n\ntitle\nBook title\n\n\nsubtitle\nBook subtitle\n\n\nauthor\nAuthor or authors of the book\n\n\ndate\nBook publication date\n\n\ndate-format\nFormat string for dates in the book\n\n\nabstract\nBook abstract\n\n\ndescription\nDescription metadata for HTML version of book\n\n\nreferences\nBook references file\n\n\noutput-file\nBase name for single-file output (e.g. PDF, ePub)\n\n\ncover-image\nCover image (used in HTML and ePub formats)\n\n\ncover-image-alt\nAlternative text for cover image (used in HTML format)\n\n\nsharing\nSharing buttons to include on navbar or sidebar (one or more of twitter, facebook, linkedin)\n\n\ndownloads\nDownload buttons for other formats to include on navbar or sidebar (one or more of pdf, epub, and docx)\n\n\ntools\nCustom tools for navbar or sidebar\n\n\ndoi\nThe Digital Object Identifier for this book.\n\n\nabstract-url\nA url to the abstract for this item.\n\n\naccessed\nDate the item has been accessed.\n\n\nannote\nShort markup, decoration, or annotation to the item (e.g., to indicate items included in a review);\nFor descriptive text (e.g., in an annotated bibliography), use note instead\n\n\narchive\nArchive storing the item\n\n\narchive-collection\nCollection the item is part of within an archive.\n\n\narchive-location\nStorage location within an archive (e.g. a box and folder number).\n\n\narchive-place\nGeographic location of the archive.\n\n\nauthority\nIssuing or judicial authority (e.g. “USPTO” for a patent, “Fairfax Circuit Court” for a legal case).\n\n\navailable-date\nDate the item was initially available (e.g. the online publication date of a journal article before its formal publication date; the date a treaty was made available for signing).\n\n\ncall-number\nCall number (to locate the item in a library).\n\n\nchair\nThe person leading the session containing a presentation (e.g. the organizer of the container-title of a speech).\n\n\nchapter-number\nChapter number (e.g. chapter number in a book; track number on an album).\n\n\ncitation-key\nIdentifier of the item in the input data file (analogous to BiTeX entrykey);\nUse this variable to facilitate conversion between word-processor and plain-text writing systems; For an identifer intended as formatted output label for a citation (e.g. “Ferr78”), use citation-label instead\n\n\ncitation-label\nLabel identifying the item in in-text citations of label styles (e.g. “Ferr78”);\nMay be assigned by the CSL processor based on item metadata; For the identifier of the item in the input data file, use citation-key instead\n\n\ncollection-editor\nEditor of the collection holding the item (e.g. the series editor for a book).\n\n\ncollection-number\nNumber identifying the collection holding the item (e.g. the series number for a book)\n\n\ncollection-title\nTitle of the collection holding the item (e.g. the series title for a book; the lecture series title for a presentation).\n\n\ncompiler\nPerson compiling or selecting material for an item from the works of various persons or bodies (e.g. for an anthology).\n\n\ncomposer\nComposer (e.g. of a musical score).\n\n\ncontainer-author\nAuthor of the container holding the item (e.g. the book author for a book chapter).\n\n\ncontainer-title\nTitle of the container holding the item (e.g. the book title for a book chapter, the journal title for a journal article; the album title for a recording; the session title for multi-part presentation at a conference)\n\n\ncontributor\nA minor contributor to the item; typically cited using “with” before the name when listed in a bibliography.\n\n\ncurator\nCurator of an exhibit or collection (e.g. in a museum).\n\n\ndimensions\nPhysical (e.g. size) or temporal (e.g. running time) dimensions of the item.\n\n\ndirector\nDirector (e.g. of a film).\n\n\ndivision\nMinor subdivision of a court with a jurisdiction for a legal item\n\n\nedition\n(Container) edition holding the item (e.g. “3” when citing a chapter in the third edition of a book).\n\n\neditor\nThe editor of the item.\n\n\neditorial-director\nManaging editor (“Directeur de la Publication” in French).\n\n\neditor-translator\nCombined editor and translator of a work.\nThe citation processory must be automatically generate if editor and translator variables are identical; May also be provided directly in item data.\n\n\nevent-date\nDate the event related to an item took place.\n\n\nevent-title\nName of the event related to the item (e.g. the conference name when citing a conference paper; the meeting where presentation was made).\n\n\nevent-place\nGeographic location of the event related to the item (e.g. “Amsterdam, The Netherlands”).\n\n\nexecutive-producer\nExecutive producer of the item (e.g. of a television series).\n\n\nfulltext-url\nA url to the full text for this item.\n\n\ngenre\nType, class, or subtype of the item (e.g. “Doctoral dissertation” for a PhD thesis; “NIH Publication” for an NIH technical report);\nDo not use for topical descriptions or categories (e.g. “adventure” for an adventure movie)\n\n\nguest\nGuest (e.g. on a TV show or podcast).\n\n\nhost\nHost of the item (e.g. of a TV show or podcast).\n\n\nillustrator\nIllustrator (e.g. of a children’s book or graphic novel).\n\n\ninterviewer\nInterviewer (e.g. of an interview).\n\n\nisbn\nInternational Standard Book Number (e.g. “978-3-8474-1017-1”).\n\n\nissn\nInternational Standard Serial Number.\n\n\nissue\nIssue number of the item or container holding the item (e.g. “5” when citing a journal article from journal volume 2, issue 5);\nUse volume-title for the title of the issue, if any.\n\n\nissued\nDate the item was issued/published.\n\n\njurisdiction\nGeographic scope of relevance (e.g. “US” for a US patent; the court hearing a legal case).\n\n\nkeyword\nKeyword(s) or tag(s) attached to the item.\n\n\nlanguage\nThe language of the item (used only for citation of the item).\nShould be entered as an ISO 639-1 two-letter language code (e.g. “en”, “zh”), optionally with a two-letter locale code (e.g. “de-DE”, “de-AT”).\nThis does not change the language of the item, instead it documents what language the item uses (which may be used in citing the item).\n\n\nlicense\nThe license information applicable to an item (e.g. the license an article or software is released under; the copyright information for an item; the classification status of a document)\n\n\nlocator\nA cite-specific pinpointer within the item (e.g. a page number within a book, or a volume in a multi-volume work).\nMust be accompanied in the input data by a label indicating the locator type (see the Locators term list).\n\n\nmedium\nDescription of the item’s format or medium (e.g. “CD”, “DVD”, “Album”, etc.)\n\n\nnarrator\nNarrator (e.g. of an audio book).\n\n\nnote\nDescriptive text or notes about an item (e.g. in an annotated bibliography).\n\n\nnumber\nNumber identifying the item (e.g. a report number).\n\n\nnumber-of-pages\nTotal number of pages of the cited item.\n\n\nnumber-of-volumes\nTotal number of volumes, used when citing multi-volume books and such.\n\n\norganizer\nOrganizer of an event (e.g. organizer of a workshop or conference).\n\n\noriginal-author\nThe original creator of a work (e.g. the form of the author name listed on the original version of a book; the historical author of a work; the original songwriter or performer for a musical piece; the original developer or programmer for a piece of software; the original author of an adapted work such as a book adapted into a screenplay)\n\n\noriginal-date\nIssue date of the original version.\n\n\noriginal-publisher\nOriginal publisher, for items that have been republished by a different publisher.\n\n\noriginal-publisher-place\nGeographic location of the original publisher (e.g. “London, UK”).\n\n\noriginal-title\nTitle of the original version (e.g. “Война и мир”, the untranslated Russian title of “War and Peace”).\n\n\npage\nRange of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).\n\n\npage-first\nFirst page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).\n\n\npage-last\nLast page of the range of pages the item (e.g. a journal article) covers in a container (e.g. a journal issue).\n\n\npart-number\nNumber of the specific part of the item being cited (e.g. part 2 of a journal article).\nUse part-title for the title of the part, if any.\n\n\npart-title\nTitle of the specific part of an item being cited.\n\n\npdf-url\nA url to the pdf for this item.\n\n\nperformer\nPerformer of an item (e.g. an actor appearing in a film; a muscian performing a piece of music).\n\n\npmcid\nPubMed Central reference number.\n\n\npmid\nPubMed reference number.\n\n\nprinting-number\nPrinting number of the item or container holding the item.\n\n\nproducer\nProducer (e.g. of a television or radio broadcast).\n\n\npublic-url\nA public url for this item.\n\n\npublisher\nThe publisher of the item.\n\n\npublisher-place\nThe geographic location of the publisher.\n\n\nrecipient\nRecipient (e.g. of a letter).\n\n\nreviewed-author\nAuthor of the item reviewed by the current item.\n\n\nreviewed-genre\nType of the item being reviewed by the current item (e.g. book, film).\n\n\nreviewed-title\nTitle of the item reviewed by the current item.\n\n\nscale\nScale of e.g. a map or model.\n\n\nscript-writer\nWriter of a script or screenplay (e.g. of a film).\n\n\nsection\nSection of the item or container holding the item (e.g. “§2.0.1” for a law; “politics” for a newspaper article).\n\n\nseries-creator\nCreator of a series (e.g. of a television series).\n\n\nsource\nSource from whence the item originates (e.g. a library catalog or database).\n\n\nstatus\nPublication status of the item (e.g. “forthcoming”; “in press”; “advance online publication”; “retracted”)\n\n\nsubmitted\nDate the item (e.g. a manuscript) was submitted for publication.\n\n\nsupplement-number\nSupplement number of the item or container holding the item (e.g. for secondary legal items that are regularly updated between editions).\n\n\ntranslator\nTranslator\n\n\ntype\nThe type of the item.\n\n\nurl\nUniform Resource Locator (e.g. “https://aem.asm.org/cgi/content/full/74/9/2766”)\n\n\nversion\nVersion of the item (e.g. “2.0.9” for a software program).\n\n\nvolume\nVolume number of the item (e.g. “2” when citing volume 2 of a book) or the container holding the item (e.g. “2” when citing a chapter from volume 2 of a book).\nUse volume-title for the title of the volume, if any.\n\n\nvolume-title\nTitle of the volume of the item or container holding the item.\nAlso use for titles of periodical special issues, special sections, and the like.\n\n\nyear-suffix\nDisambiguating year suffix in author-date styles (e.g. “a” in “Doe, 1999a”).\n\n\ndescription\nWebsite description\n\n\nfavicon\nThe path to the favicon for this website\n\n\nsite-url\nBase URL for published website\n\n\nsite-path\nPath to site (defaults to /). Not required if you specify site-url.\n\n\nrepo-url\nBase URL for website source code repository\n\n\nrepo-subdir\nSubdirectory of repository containing website\n\n\nrepo-branch\nBranch of website source code (defaults to main)\n\n\nissue-url\nURL to use for the ‘report an issue’ repository action.\n\n\nrepo-actions\nLinks to source repository actions (none or one or more of edit, source, issue)\n\n\nreader-mode\nDisplays a ‘reader-mode’ tool which allows users to hide the sidebar and table of contents when viewing a page.\n\n\ngoogle-analytics\nThe Google tracking Id or measurement Id of this website.\n\n\ncookie-consent\nThe type of consent that should be requested, using one of these two values:\n\nimplied (default): This will notify the user that the site uses cookies and permit them to change preferences, but not block cookies unless the user changes their preferences.\nexpress: This will block cookies until the user expressly agrees to allow them (or continue blocking them if the user doesn’t agree).\n\n\n\nsearch\nSite search (true or false to enable/disable, or provide custom Search Options\n\n\nnavbar\nNavbar options (see Navbar)\n\n\nsidebar\nSidebar options (see Sidebar)\n\n\nbody-header\nMarkdown to insert at the beginning of each page’s body (below the title and author block).\n\n\nbody-footer\nMarkdown to insert below each page’s body.\n\n\nmargin-header\nMarkdown to place above margin content (text or file path)\n\n\nmargin-footer\nMarkdown to place below margin content (text or file path)\n\n\npage-navigation\nProvide next and previous article links in footer\n\n\nback-to-top-navigation\nProvide a ‘back to top’ navigation button\n\n\npage-footer\nPage footer. Text content or page footer definition.\n\n\nimage\nDefault site thumbnail image for twitter /open-graph\n\n\ncomments\n\n\n\nopen-graph\nGenerate Open Graph metadata (see Open Graph options)\n\n\ntwitter-card\nGenerate Twitter Card metadata (see Twitter Card options)\n\n\n\n\n\n\nNavbar\nOptions that define the top navigation bar for a book For example:\n---\nbook:\n navbar:\n search: true\n---\n\n\n\n\ntitle\nThe navbar title. Uses the project title if none is specified.\n\n\nlogo\nPath to a logo image that will be displayed to the left of the title.\n\n\nlogo-alt\nAlternate text for the logo image.\n\n\nlogo-href\nTarget href from navbar logo / title. By default, the logo and title link to the root page of the site (/index.html).\n\n\nbackground\nThe navbar’s background color (named or hex color).\n\n\nforeground\nThe navbar’s foreground color (named or hex color).\n\n\nsearch\nInclude a search box in the navbar.\n\n\npinned\nAlways show the navbar (keeping it pinned).\n\n\ncollapse\nCollapse the navbar into a menu when the display becomes narrow.\n\n\ncollapse-below\nThe responsive breakpoint below which the navbar will collapse into a menu (sm, md, lg (default), xl, xxl).\n\n\nleft\nList of items for the left side of the navbar (see Nav Items)\n\n\nright\nList of items for the left side of the navbar (see Nav Items)\n\n\n\n\n\n\nNav Items\nNav items appear in the left or right key of navbar definitions. For example:\n---\nbook:\n navbar:\n right:\n - icon: github\n href: https://github.com/\n aria-label: GitHub\n---\n\n\n\n\naria-label\nAccessible label for the item.\n\n\nhref\nLink to file contained with the project or external URL\n\n\nicon\nName of bootstrap icon (e.g. github, twitter, share) See https://icons.getbootstrap.com/ for a list of available icons\n\n\nmenu\nSubmenu of navigation items\n\n\ntext\nText to display for item (defaults to the document title if not provided)\n\n\nrel\nValue for rel attribute. Multiple space-separated values are permitted. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel for a details.\n\n\ntarget\nValue for target attribute. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target for details.\n\n\n\n\nNote that the icon option is available for items in the Navbar, however items in the Sidebar do not support the icon option.\n\n\nSidebar\nOptions that define the side navigation area for a book. For example:\n---\nbook:\n sidebar:\n search: true\n---\n\n\n\n\nid\nThe identifier for this sidebar.\n\n\ntitle\nThe sidebar title. Uses the project title if none is specified.\n\n\nlogo\nPath to a logo image that will be displayed in the sidebar.\n\n\nsearch\nInclude a search control in the sidebar.\n\n\ntools\nList of sidebar tools (see Sidebar Tools)\n\n\ncontents\nList of navigation items to appear in the sidebar. Can also include section entries which in turn contain sub-lists of navigation items.\n\n\nstyle\nThe style of sidebar (docked or floating).\n\n\nbackground\nThe sidebar’s background color (named or hex color).\n\n\nforeground\nThe sidebar’s foreground color (named or hex color).\n\n\nborder\nWhether to show a border on the sidebar (defaults to true for ‘docked’ sidebars)\n\n\nalignment\nAlignment of the items within the sidebar (left, right, or center)\n\n\ncollapse-level\nThe depth at which the sidebar contents should be collapsed by default.\n\n\npinned\nWhen collapsed, pin the collapsed sidebar to the top of the page.\n\n\nheader\nMarkdown to place above sidebar content (text or file path)\n\n\nfooter\nMarkdown to place below sidebar content (text or file path)\n\n\n\n\n\nSidebar Tools\nAction buttons that appear on the sidebar. For example:\n---\nbook:\n sidebar:\n tools:\n - icon: github\n href: https://github.com/\n---\n\n\n\n\nicon\nName of bootstrap icon (e.g. github, twitter, share) See https://icons.getbootstrap.com/ for a list of available icons\n\n\nhref\nLink to file contained with the project or external URL\n\n\nmenu\nSubmenu of navigation items\n\n\n\n\n\n\n\nFooter\nBook page footer definition. For example:\n---\nbook:\n page-footer:\n center: \n - text: \"About\"\n href: about.qmd\n - text: \"License\"\n href: license.qmd\n - text: \"Trademark\"\n href: trademark.qmd\n---\n\n\n\n\n\n\n\n\nleft\nFooter left content\n\n\nright\nFooter right content\n\n\ncenter\nFooter center content\n\n\nborder\nFooter border (true, false, or a border color)\n\n\nbackground\nFooter background color\n\n\nforeground\nFooter foreground color\n\n\n\n\n\n\nSearch\nSearch options are specified under the search key of book. For example:\nbook:\n search:\n location: navbar\n type: overlay\n---\n\n\n\n\nlocation\nLocation for search widget (navbar or sidebar)\n\n\ntype\nType of search UI (overlay or textbox)\n\n\nlimit\nNumber of matches to display (defaults to 20)\n\n\ncollapse-after\nMatches after which to collapse additional results\n\n\ncopy-button\nProvide button for copying search link\n\n\nalgolia\nUse an Algolia index for site search (see Algolia Options)\n\n\n\n\n\nAlgolia Options\nYou can use an Algolia index as the back end of book search. Specify Algolia options using the algolia sub-key of search, for example:\n---\nbook:\n search:\n algolia:\n index-name: \n application-id: \n search-only-api-key: \n---\n\n\n\n\n\n\n\n\nindex-name\nThe name of the index to use when performing a search\n\n\napplication-id\nThe unique ID used by Algolia to identify your application\n\n\nsearch-only-api-key\nThe Search-Only API key to use to connect to Algolia\n\n\nanalytics-events\nEnable tracking of Algolia analytics events\n\n\nshow-logo\nEnable the display of the Algolia logo in the search results footer.\n\n\nindex-fields\nFields to target for searches (see below for details)\n\n\nparams\nAdditional parameters to pass when executing a search\n\n\n\n\nThe index-fields option provides sub-fields within the Algolia index to target for searches:\n\n\n\n\n\n\n\n\nhref\nField that contains the URL of index entries\n\n\ntitle\nField that contains the title of index entries\n\n\ntext\nField that contains the text of index entries\n\n\nsection\nField that contains the section of index entries\n\n\n\n\n\n\n\nSocial\nSocial metadata is provided as a subkey of book options. You can specify true to generate social metadata using a set of default option, or specify one or more Twitter or Open Graph specific options as enumerated below. For example:\n---\nbook:\n open-graph: true\n twitter-card: \n site: \"@sitehandle\"\n---\n\nTwitter Card\n\n\n\n\ntitle\nThe title of the page. Note that by default Quarto will automatically use the title metadata from the page. Specify this field if you’d like to override the title for this provider.\n\n\ndescription\nA short description of the content. Note that by default Quarto will automatically use the description metadata from the page. Specify this field if you’d like to override the description for this provider.\n\n\nimage\nThe path to a preview image for the content. By default, Quarto will use the image value from the format metadata. If you provide an image, you may also optionally provide an image-width and image-height.\n\n\nimage-alt\nThe alt text for the preview image. By default, Quarto will use the image-alt value from the format metadata. If you provide an image, you may also optionally provide an image-width and image-height.\n\n\nimage-width\nImage width (pixels)\n\n\nimage-height\nImage height (pixels)\n\n\ncard-style\nCard style (summary or summary_large_image).\nIf this is not provided, the best style will automatically selected based upon other metadata. You can learn more about Twitter Card styles here.\n\n\ncreator\n@username of the content creator (must be a quoted string)\n\n\nsite\n@username of the website (must be a quoted string)\n\n\n\n\n\n\nOpen Graph\n\n\n\n\n\n\n\n\ntitle\nThe title of the page. Note that by default Quarto will automatically use the title metadata from the page. Specify this field if you’d like to override the title for this provider.\n\n\ndescription\nA short description of the content. Note that by default Quarto will automatically use the description metadata from the page. Specify this field if you’d like to override the description for this provider.\n\n\nimage\nThe path to a preview image for the content. By default, Quarto will use the image value from the format metadata. If you provide an image, you may also optionally provide an image-width and image-height.\n\n\nimage-alt\nThe alt text for the preview image. By default, Quarto will use the image-alt value from the format metadata. If you provide an image, you may also optionally provide an image-width and image-height.\n\n\nimage-width\nImage width (pixels)\n\n\nimage-height\nImage height (pixels)\n\n\nlocale\nLocale of open graph metadata\n\n\nsite-name\nName that should be displayed for the overall site. If not explicitly provided in the open-graph metadata, Quarto will use the website or book title by default.\n\n\n\n\n\n\n\nComments\nYou can add commenting to your book using either Hypothesis, Utterances, or Giscus.\n\nHypothesis\nEnable and configure Hypothesis commenting via comments key. For example:\n---\nwebsite:\n comments: \n hypothesis:\n theme: clean\n openSidebar: false\n---\n\n\n\n\n\n\n\n\nopenSidebar\nControls whether the sidebar opens automatically on startup.\n\n\nshowHighlights\nControls whether the in-document highlights are shown by default (always, whenSidebarOpen or never)\n\n\ntheme\nControls the overall look of the sidebar (classic or clean)\n\n\nenableExperimentalNewNoteButton\nControls whether the experimental New Note button should be shown in the notes tab in the sidebar.\n\n\nusernameUrl\nSpecify a URL to direct a user to, in a new tab. when they click on the annotation author link in the header of an annotation.\n\n\nservices\nArray of service definitions\n\n\nbranding\nCustom branding/colors to apply to UI\n\n\nexternalContainerSelector\nA CSS selector specifying the containing element into which the sidebar iframe will be placed.\n\n\nfocus\nUser focused filter set for the available annotations on a page\n\n\nrequestConfigFromFrame\nSpecify a host iframe to request configuration from\n\n\nassetRoot\nThe root URL from which assets are loaded.\n\n\nsidebarAppUrl\nThe URL for the sidebar application which displays annotations.\n\n\n\n\nFor additional documentation on the Hypothesis options enumerated above, see the Hypothesis Publisher Config documentation.\n\n\nUtterances\nEnable and configure Utterances commenting via the comments key. For example:\n---\nwebsite:\n comments: \n utterances:\n repo: quarto-dev/quarto-web\n---\n\n\n\n\n\n\n\n\nrepo\nThe Github repo that will be used to store comments.\n\n\nlabel\nThe label that will be assigned to issues created by Utterances.\n\n\ntheme\nThe Github theme that should be used for Utterances (github-light, github-dark, github-dark-orange, icy-dark, dark-blue, photon-dark, body-light, or gruvbox-dark)\n\n\nissue-term\nHow posts should be mapped to Github issues (pathname, url, title or og:title)\n\n\n\n\n\n\nGiscus\nEnable and configure usage of the Giscus app via the comments key. For example:\n---\nwebsite:\n comments:\n giscus:\n repo: quarto-dev/quarto-web\n---\n\n\n\n\nrepo\nThe Github repo that will be used to store comments.\nIn order to work correctly, the repo must be public, with the giscus app installed, and the discussions feature must be enabled.\n\n\nrepo-id\nThe Github repository identifier.\nYou can quickly find this by using the configuration tool at https://giscus.app. If this is not provided, Quarto will attempt to discover it at render time.\n\n\ncategory\nThe discussion category where new discussions will be created. It is recommended to use a category with the Announcements type so that new discussions can only be created by maintainers and giscus.\n\n\ncategory-id\nThe Github category identifier.\nYou can quickly find this by using the configuration tool at https://giscus.app. If this is not provided, Quarto will attempt to discover it at render time.\n\n\nmapping\nThe mapping between the page and the embedded discussion.\n\npathname: The discussion title contains the page path\nurl: The discussion title contains the page url\ntitle: The discussion title contains the page title\nog:title: The discussion title contains the og:title metadata value\nany other string or number: Any other strings will be passed through verbatim and a discussion title containing that value will be used. Numbers will be treated as a discussion number and automatic discussion creation is not supported.\n\n\n\nreactions-enabled\nDisplay reactions for the discussion’s main post before the comments.\n\n\nloading\nSpecify loading: lazy to defer loading comments until the user scrolls near the comments container.\n\n\ninput-position\nPlace the comment input box above or below the comments.\n\n\ntheme\nThe giscus theme to use when displaying comments.\n\n\nlanguage\nThe language that should be used when displaying the commenting interface.\n\n\n\n\n\n\n\nListings\nListings enable you to automatically generate the contents of a page (or region of a page) from a list of Quarto documents or other custom data. You can enable listings on a page using the listing option in the document front matter, for example:\n---\ntitle: \"Listing Example\"\nlisting: default\n---\n\n\n\n\nid\nThe id of this listing. When the listing is rendered, it will place the contents into a div with this id. If no such div is defined on the page, a div with this id will be created and appended to the end of the page.\nIn no id is provided for a listing, Quarto will synthesize one when rendering the page.\n\n\ntype\nThe type of listing to create. Choose one of:\n\ndefault: A blog style list of items\ntable: A table of items\ngrid: A grid of item cards\ncustom: A custom template, provided by the template field\n\n\n\ncontents\nThe files or path globs of Quarto documents or YAML files that should be included in the listing.\n\n\nsort\nSort items in the listing by these fields. The sort key is made up of a field name followed by a direction asc or desc.\nFor example: date asc\nUse sort:false to use the unsorted original order of items.\n\n\nmax-items\nThe maximum number of items to include in this listing.\n\n\npage-size\nThe number of items to display on a page.\n\n\nsort-ui\nShows or hides the sorting control for the listing. To control the fields that will be displayed in the sorting control, provide a list of field names.\n\n\nfilter-ui\nShows or hides the filtering control for the listing. To control the fields that will be used to filter the listing, provide a list of field names. By default all fields of the listing will be used when filtering.\n\n\ncategories\nDisplay item categories from this listing in the margin of the page.\n\nnumbered: Category list with number of items\nunnumbered: Category list\ncloud: Word cloud style categories\n\n\n\nfeed\nCreate an RSS feed for this page using the items in this listing (see Feed).\n\n\ndate-format\nThe date format to use when displaying dates (e.g. d-M-yyy). Learn more about supported date formatting values here.\n\n\nmax-description-length\nThe maximum length (in characters) of the description displayed in the listing. Defaults to 175.\n\n\nimage-placeholder\nThe default image to use if an item in the listing doesn’t have an image.\n\n\nimage-align\nIn default type listings, whether to place the image on the right or left side of the post content (left or right).\n\n\nimage-height\nThe height of the image being displayed (a CSS height string).\nThe width is automatically determined and the image will fill the rectangle without scaling (cropped to fill).\n\n\ngrid-columns\nIn grid type listings, the number of columns in the grid display. Defaults to 3.\n\n\ngrid-item-border\nIn grid type listings, whether to display a border around the item card. Defaults to true.\n\n\ngrid-item-align\nIn grid type listings, the alignment of the content within the card (left (default), right, or center).\n\n\ntable-striped\nIn table type listings, display the table rows with alternating background colors. Defaults to false.\n\n\ntable-hover\nIn table type listings, highlight rows of the table when the user hovers the mouse over them. Defaults to false.\n\n\ntemplate\nThe path to a custom listing template.\n\n\ntemplate-params\nParameters that are passed to the custom template.\n\n\nfields\nThe list of fields to include in this listing.\n\n\nfield-display-names\nA mapping that provides display names for specific fields. For example, to display the title column as ‘Report’ in a table listing you would write:\nlisting:\n field-display-names:\n title: \"Report\"\n\n\nfield-types\nProvides the date type for the field of a listing item. Unknown fields are treated as strings unless a type is provided. Valid types are date, number.\n\n\nfield-links\nThe list of fields to display as hyperlinks to the source document when the listing type is a table. By default, only the title or filename is displayed as a link.\n\n\nfield-required\nFields that items in this listing must have populated. If a listing is rendered and one more items in this listing is missing a required field, an error will occur and the render will.\n\n\ninclude\nItems with matching field values will be included in the listing.\n\n\nexclude\nItems with matching field values will be excluded from the listing.\n\n\n\n\n\nFeed\nEnable an RSS feed for your listing by including the feed option.\n\n\n\n\nitems\nThe number of items to include in your feed. Defaults to 20.\n\n\ntype\nWhether to include full or partial content in the feed.\n\nfull (default): Include the complete content of the document in the feed.\npartial: Include only the first paragraph of the document in the feed.\n\n\n\ntitle\nThe title for this feed. Defaults to the site title provided the Quarto project.\n\n\nimage\nThe path to an image for this feed. If not specified, the image for the page the listing appears on will be used, otherwise an image will be used if specified for the site in the Quarto project.\n\n\ndescription\nThe description of this feed. If not specified, the description for the page the listing appears on will be used, otherwise the description of the site will be used if specified in the Quarto project.\n\n\nlanguage\nThe language of the feed. Omitted if not specified. See https://www.rssboard.org/rss-language-codes for a list of valid language codes.\n\n\ncategories\nA list of categories for which to create separate RSS feeds containing only posts with that category.\n\n\n\n\n\n\n\nAbout\nLayout a simple about page for an individual or organization. For more, see the About Pages documentation.\n\n\n\n\nid\nThe target id of this about page. When the about page is rendered, it will place read the contents of a div with this id into the about template that you have selected (and replace the contents with the rendered about content).\nIf no such div is defined on the page, a div with this id will be created and appended to the end of the page.\n\n\ntemplate\nThe template to use to layout this about page. Choose from:\n\njolla\ntrestles\nsolana\nmarquee\nbroadside\n\n\n\nimage\nThe path to the main image on the about page. If not specified, the image provided for the document itself will be used.\n\n\nimage-width\nA valid CSS width for the about page image.\n\n\nimage-shape\nThe shape of the image on the about page.\n\nrectangle\nround\nrounded\n\n\n\nlinks\nLinks (as navigation items) to display on the about page."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/projects/books.html\",\n \"source\": \"https://quarto.org/docs/reference/projects/books.html\"\n}"}}},{"rowIdx":181,"cells":{"page_content":{"kind":"string","value":"This article documents options that define the type, render targets, and output of a project.\nSee the Project Basics article for additional documentation on using projects.\nProject options are specified under the project key. For example:\n---\nproject:\n type: website\n output-dir: _site\n---\n\n\n\n\ntitle\n\n\n\ntype\nProject type (default, website, or book)\n\n\nrender\nFiles to render (defaults to all files)\n\n\nexecute-dir\nControl the working directory for computations.\n\nfile: Use the directory of the file that is currently executing.\nproject: Use the root directory of the project.\n\n\n\noutput-dir\nOutput directory\n\n\nlib-dir\nHTML library (JS/CSS/etc.) directory\n\n\nresources\nAdditional file resources to be copied to output directory\n\n\npreview\nOptions for quarto preview (see Preview)\n\n\npre-render\nScripts to run as a pre-render step\n\n\npost-render\nScripts to run as a post-render step\n\n\n\n\n\nPreview\nSpecify options that control the behavior of quarto preview within the preview key. For example:\n---\nproject:\n type: website\n output-dir: _site\n preview:\n port: 4200\n browser: false\n---\nAvailable preview options include:\n\n\n\n\nport\nPort to listen on (defaults to random value between 3000 and 8000)\n\n\nhost\nHostname to bind to (defaults to 127.0.0.1)\n\n\nserve\nOptions for external preview server (see Serve)\n\n\nbrowser\nOpen a web browser to view the preview (defaults to true)\n\n\nwatch-inputs\nRe-render input files when they change (defaults to true)\n\n\nnavigate\nNavigate the browser automatically when outputs are updated (defaults to true)\n\n\ntimeout\nTime (in seconds) after which to exit if there are no active clients"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.799Z\",\n \"loc\": \"https://quarto.org/docs/reference/projects/core.html\",\n \"source\": \"https://quarto.org/docs/reference/projects/core.html\"\n}"}}},{"rowIdx":182,"cells":{"page_content":{"kind":"string","value":"Knitr is an R package for dynamic document generation. Learn more about using Knitr in the article on Using R.\n\nOverview\nCell options affect the execution and output of executable code blocks. They are specified within comments at the top of a block. For example:\n```{r}\n#| label: fig-polar\n#| echo: false\n#| fig-cap: \"A line plot on a polar axis\"\n```\n\n\nAttributes\n\n\n\n\n\n\n\nlabel\nUnique label for code cell. Used when other code needs to refer to the cell (e.g. for cross references fig-samples or tbl-summary)\n\n\nclasses\nClasses to apply to cell container\n\n\n\n\n\nCode Output\n\n\n\n\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\ncode-fold\nCollapse code into an HTML

tag so the user can display it on-demand.\n\ntrue: collapse code\nfalse (default): do not collapse code\nshow: use the

tag, but show the expanded code initially.\n\n\n\ncode-summary\nSummary text to use for code blocks collapsed using code-fold\n\n\ncode-overflow\nChoose how to handle code overflow, when code lines are too wide for their container. One of:\n\nscroll\nwrap\n\n\n\ncode-line-numbers\nInclude line numbers in code block output (true or false).\nFor revealjs output only, you can also specify a string to highlight specific lines (and/or animate between sets of highlighted lines).\n\nSets of lines are denoted with commas:\n\n3,4,5\n1,10,12\n\nRanges can be denoted with dashes and combined with commas:\n\n1-3,5\n5-10,12,14\n\nFinally, animation steps are separated by |:\n\n1-3|1-3,5 first shows 1-3, then 1-3,5\n|5|5-10,12 first shows no numbering, then 5, then lines 5-10 and 12\n\n\n\n\nlst-label\nUnique label for code listing (used in cross references)\n\n\nlst-cap\nCaption for code listing\n\n\ntidy\nWhether to reformat R code.\n\n\ntidy-opts\nList of options to pass to tidy handler\n\n\ncollapse\nCollapse all the source and output blocks from one code chunk into a single block\n\n\nprompt\nWhether to add the prompt characters in R code. See prompt and continue on the help page ?base::options. Note that adding prompts can make it difficult for readers to copy R code from the output, so prompt: false may be a better choice. This option may not work well when the engine is not R (#1274).\n\n\nclass-source\nClass name(s) for source code blocks\n\n\nattr-source\nAttribute(s) for source code blocks\n\n\n\n\n\nCell Output\n\n\n\n\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\npanel\nPanel type for cell output (tabset, input, sidebar, fill, center)\n\n\noutput-location\nLocation of output relative to the code that generated it. The possible values are as follows:\n\ndefault: Normal flow of the slide after the code\nfragment: In a fragment (not visible until you advance)\nslide: On a new slide after the curent one\n‘column’: In an adjacent column\ncolumn-fragment: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the revealjs format.\n\n\nmessage\nInclude messages in rendered output.\n\n\nresults\nHow to display text results. Note that this option only applies to normal text output (not warnings, messages, or errors). The possible values are as follows:\n\nmarkup: Mark up text output with the appropriate environments depending on the output format. For example, if the text output is a character string \"[1] 1 2 3\", the actual output that knitr produces will be:\n```\n[1] 1 2 3\n```\nIn this case, results: markup means to put the text output in fenced code blocks (```).\nasis: Write text output as-is, i.e., write the raw text results directly into the output document without any markups.\n```{r}\n#| results: asis\ncat(\"I'm raw **Markdown** content.\\n\")\n```\nhold: Hold all pieces of text output in a chunk and flush them to the end of the chunk.\nhide (or false): Hide text output.\n\n\n\ncomment\nPrefix to be added before each line of text output. By default, the text output is commented out by ##, so if readers want to copy and run the source code from the output document, they can select and copy everything from the chunk, since the text output is masked in comments (and will be ignored when running the copied text). Set comment: '' to remove the default ##.\n\n\nclass-output\nClass name(s) for text/console output\n\n\nattr-output\nAttribute(s) for text/console output\n\n\nclass-warning\nClass name(s) for warning output\n\n\nattr-warning\nAttribute(s) for warning output\n\n\nclass-message\nClass name(s) for message output\n\n\nattr-message\nAttribute(s) for message output\n\n\nclass-error\nClass name(s) for error output\n\n\nattr-error\nAttribute(s) for error output\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-width\nDefault width for figures\n\n\nfig-height\nDefault height for figures\n\n\nfig-cap\nFigure caption\n\n\nfig-subcap\nFigure subcaptions\n\n\nfig-link\nHyperlink target for the figure\n\n\nfig-align\nFigure horizontal alignment (default, left, right, or center)\n\n\nfig-alt\nAlternative text to be used in the alt attribute of HTML images.\n\n\nfig-env\nLaTeX environment for figure output\n\n\nfig-pos\nLaTeX figure position arrangement to be used in \\begin{figure}[].\nComputational figure output that is accompanied by the code that produced it is given a default value of fig-pos=\"H\" (so that the code and figure are not inordinately separated).\nIf fig-pos is false, then we don’t use any figure position specifier, which is sometimes necessary with custom figure environments (such as sidewaysfigure).\n\n\nfig-scap\nA short caption (only used in LaTeX output). A short caption is inserted in \\caption[], and usually displayed in the “List of Figures” of a PDF document.\n\n\nfig-format\nDefault output format for figures (retina, png, jpeg, svg, or pdf)\n\n\nfig-dpi\nDefault DPI for figures\n\n\nfig-asp\nThe 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.\n\n\nout-width\nWidth of the plot in the output document, which can be different from its physical fig-width, i.e., plots can be scaled in the output document. When used without a unit, the unit is assumed to be pixels. However, any of the following unit identifiers can be used: px, cm, mm, in, inch and %, for example, 3in, 8cm, 300px or 50%.\n\n\nout-height\nHeight of the plot in the output document, which can be different from its physical fig-height, i.e., plots can be scaled in the output document. Depending on the output format, this option can take special values. For example, for LaTeX output, it can be 3in, or 8cm; for HTML, it can be 300px.\n\n\nfig-keep\nHow plots in chunks should be kept. Possible values are as follows:\n\nhigh: Only keep high-level plots (merge low-level changes into high-level plots).\nnone: Discard all plots.\nall: Keep all plots (low-level plot changes may produce new plots).\nfirst: Only keep the first plot.\nlast: Only keep the last plot.\nA numeric vector: In this case, the values are indices of (low-level) plots to keep.\n\n\n\nfig-show\nHow to show/arrange the plots. Possible values are as follows:\n\nasis: Show plots exactly in places where they were generated (as if the code were run in an R terminal).\nhold: Hold all plots and output them at the end of a code chunk.\nanimate: Concatenate all plots into an animation if there are multiple plots in a chunk.\nhide: Generate plot files but hide them in the output document.\n\n\n\nout-extra\nAdditional raw LaTeX or HTML options to be applied to figures\n\n\nexternal\nExternalize tikz graphics (pre-compile to PDF)\n\n\nsanitize\nsanitize tikz graphics (escape special LaTeX characters).\n\n\ninterval\nTime interval (number of seconds) between animation frames.\n\n\naniopts\nExtra options for animations; see the documentation of the LaTeX animate package.\n\n\nanimation-hook\nHook function to create animations in HTML output.\nThe default hook (ffmpeg) uses FFmpeg to convert images to a WebM video.\nAnother hook function is gifski based on the gifski package to create GIF animations.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-cap\nTable caption\n\n\ntbl-subcap\nTable subcaptions\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\n\n\n\nPanel Layout\n\n\n\n\n\n\n\nlayout\n2d-array of widths where the first dimension specifies columns and the second rows.\nFor example, to layout the first two output blocks side-by-side on the top with the third block spanning the full width below, use [[3,3], [1]].\nUse negative values to create margin. For example, to create space between the output blocks in the top row of the previous example, use [[3,-1, 3], [1]].\n\n\nlayout-ncol\nLayout output blocks into columns\n\n\nlayout-nrow\nLayout output blocks into rows\n\n\nlayout-align\nHorizontal alignment for layout content (default, left, right, or center)\n\n\nlayout-valign\nVertical alignment for layout content (default, top, center, or bottom)\n\n\n\n\n\nPage Columns\n\n\n\n\n\n\n\ncolumn\nPage column for output\n\n\nfig-column\nPage column for figure output\n\n\ntbl-column\nPage column for table output\n\n\ncap-location\nWhere to place figure and table captions (top, bottom, or margin)\n\n\nfig-cap-location\nWhere to place figure captions (top, bottom, or margin)\n\n\ntbl-cap-location\nWhere to place table captions (top, bottom, or margin)\n\n\n\n\n\nCache\n\n\n\n\n\n\n\ncache\nWhether to cache a code chunk. When evaluating code chunks for the second time, the cached chunks are skipped (unless they have been modified), but the objects created in these chunks are loaded from previously saved databases (.rdb and .rdx files), and these files are saved when a chunk is evaluated for the first time, or when cached files are not found (e.g., you may have removed them by hand). Note that the filename consists of the chunk label with an MD5 digest of the R code and chunk options of the code chunk, which means any changes in the chunk will produce a different MD5 digest, and hence invalidate the cache.\n\n\ncache-vars\nVariable names to be saved in the cache database. By default, all variables created in the current chunks are identified and saved, but you may want to manually specify the variables to be saved, because the automatic detection of variables may not be robust, or you may want to save only a subset of variables.\n\n\ncache-globals\nVariables names that are not created from the current chunk.\nThis option is mainly for autodep: true to work more precisely—a chunk B depends on chunk A when any of B’s global variables are A’s local variables. In case the automatic detection of global variables in a chunk fails, you may manually specify the names of global variables via this option. In addition, cache-globals: false means detecting all variables in a code chunk, no matter if they are global or local variables.\n\n\ncache-lazy\nWhether to lazyLoad() or directly load() objects. For very large objects, lazyloading may not work, so cache-lazy: false may be desirable (see #572).\n\n\ncache-rebuild\nForce rebuild of cache for chunk\n\n\ncache-comments\nPrevent comment changes from invalidating the cache for a chunk\n\n\ndependson\nExplicitly specify cache dependencies for this chunk (one or more chunk labels)\n\n\nautodep\nDetect cache dependencies automatically via usage of global variables\n\n\n\n\n\nInclude\n\n\n\n\n\n\n\nchild\nOne or more paths of child documents to be knitted and input into the main document.\n\n\nfile\nFile containing code to execute for this chunk\n\n\ncode\nString containing code to execute for this chunk\n\n\npurl\nInclude chunk when extracting code with knitr::purl()"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/cells/cells-knitr.html\",\n \"source\": \"https://quarto.org/docs/reference/cells/cells-knitr.html\"\n}"}}},{"rowIdx":183,"cells":{"page_content":{"kind":"string","value":"Jupyter is an open document format that supports computations in many languages including Python, R, and Julia. Learn more about using Jupyter with Quarto in the articles on Using Python and Using Julia.\n\nOverview\nCell options affect the execution and output of executable code blocks. They are specified within comments at the top of a block. For example:\n```{python}\n#| label: fig-polar\n#| echo: false\n#| fig-cap: \"A line plot on a polar axis\"\n```\n\n\nAttributes\n\n\n\n\n\n\n\nlabel\nUnique label for code cell. Used when other code needs to refer to the cell (e.g. for cross references fig-samples or tbl-summary)\n\n\nclasses\nClasses to apply to cell container\n\n\ntags\nArray of tags for notebook cell\n\n\nid\nNotebook cell identifier. Note that if there is no cell id then label will be used as the cell id if it is present. See https://jupyter.org/enhancement-proposals/62-cell-id/cell-id.html for additional details on cell ids.\n\n\n\n\n\nCode Output\n\n\n\n\n\n\n\neval\nEvaluate code cells (if false just echos the code into output).\n\ntrue (default): evaluate code cell\nfalse: don’t evaluate code cell\n[...]: 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)\n\n\n\necho\nInclude cell source code in rendered output.\n\ntrue (default): include source code in output\nfalse: do not include source code in output\nfenced: in addition to echoing, include the cell delimiter as part of the output.\n[...]: 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)\n\n\n\ncode-fold\nCollapse code into an HTML

tag so the user can display it on-demand.\n\ntrue: collapse code\nfalse (default): do not collapse code\nshow: use the

tag, but show the expanded code initially.\n\n\n\ncode-summary\nSummary text to use for code blocks collapsed using code-fold\n\n\ncode-overflow\nChoose how to handle code overflow, when code lines are too wide for their container. One of:\n\nscroll\nwrap\n\n\n\ncode-line-numbers\nInclude line numbers in code block output (true or false).\nFor revealjs output only, you can also specify a string to highlight specific lines (and/or animate between sets of highlighted lines).\n\nSets of lines are denoted with commas:\n\n3,4,5\n1,10,12\n\nRanges can be denoted with dashes and combined with commas:\n\n1-3,5\n5-10,12,14\n\nFinally, animation steps are separated by |:\n\n1-3|1-3,5 first shows 1-3, then 1-3,5\n|5|5-10,12 first shows no numbering, then 5, then lines 5-10 and 12\n\n\n\n\nlst-label\nUnique label for code listing (used in cross references)\n\n\nlst-cap\nCaption for code listing\n\n\n\n\n\nCell Output\n\n\n\n\n\n\n\noutput\nInclude the results of executing the code in the output. Possible values:\n\ntrue: Include results.\nfalse: Do not include results.\nasis: Treat output as raw markdown with no enclosing containers.\n\n\n\nwarning\nInclude warnings in rendered output.\n\n\nerror\nInclude errors in the output (note that this implies that errors executing code will not halt processing of the document).\n\n\ninclude\nCatch all for preventing any output (code or results) from being included in output.\n\n\npanel\nPanel type for cell output (tabset, input, sidebar, fill, center)\n\n\noutput-location\nLocation of output relative to the code that generated it. The possible values are as follows:\n\ndefault: Normal flow of the slide after the code\nfragment: In a fragment (not visible until you advance)\nslide: On a new slide after the curent one\n‘column’: In an adjacent column\ncolumn-fragment: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the revealjs format.\n\n\n\n\n\nFigures\n\n\n\n\n\n\n\nfig-cap\nFigure caption\n\n\nfig-subcap\nFigure subcaptions\n\n\nfig-link\nHyperlink target for the figure\n\n\nfig-align\nFigure horizontal alignment (default, left, right, or center)\n\n\nfig-alt\nAlternative text to be used in the alt attribute of HTML images.\n\n\nfig-env\nLaTeX environment for figure output\n\n\nfig-pos\nLaTeX figure position arrangement to be used in \\begin{figure}[].\nComputational figure output that is accompanied by the code that produced it is given a default value of fig-pos=\"H\" (so that the code and figure are not inordinately separated).\nIf fig-pos is false, then we don’t use any figure position specifier, which is sometimes necessary with custom figure environments (such as sidewaysfigure).\n\n\nfig-scap\nA short caption (only used in LaTeX output). A short caption is inserted in \\caption[], and usually displayed in the “List of Figures” of a PDF document.\n\n\n\n\n\nTables\n\n\n\n\n\n\n\ntbl-cap\nTable caption\n\n\ntbl-subcap\nTable subcaptions\n\n\ntbl-colwidths\nApply explicit table column widths for markdown grid tables and pipe tables that are more than columns characters wide (72 by default).\nSome formats (e.g. HTML) do an excellent job automatically sizing table columns and so don’t benefit much from column width specifications. Other formats (e.g. LaTeX) require table column sizes in order to correctly flow longer cell content (this is a major reason why tables > 72 columns wide are assigned explicit widths by Pandoc).\nThis can be specified as:\n\nauto: Apply markdown table column widths except when there is a hyperlink in the table (which tends to throw off automatic calculation of column widths based on the markdown text width of cells). (auto is the default for HTML output formats)\ntrue: Always apply markdown table widths (true is the default for all non-HTML formats)\nfalse: Never apply markdown table widths.\nAn array of numbers (e.g. [40, 30, 30]): Array of explicit width percentages.\n\n\n\n\n\n\nPanel Layout\n\n\n\n\n\n\n\nlayout\n2d-array of widths where the first dimension specifies columns and the second rows.\nFor example, to layout the first two output blocks side-by-side on the top with the third block spanning the full width below, use [[3,3], [1]].\nUse negative values to create margin. For example, to create space between the output blocks in the top row of the previous example, use [[3,-1, 3], [1]].\n\n\nlayout-ncol\nLayout output blocks into columns\n\n\nlayout-nrow\nLayout output blocks into rows\n\n\nlayout-align\nHorizontal alignment for layout content (default, left, right, or center)\n\n\nlayout-valign\nVertical alignment for layout content (default, top, center, or bottom)\n\n\n\n\n\nPage Columns\n\n\n\n\n\n\n\ncolumn\nPage column for output\n\n\nfig-column\nPage column for figure output\n\n\ntbl-column\nPage column for table output\n\n\ncap-location\nWhere to place figure and table captions (top, bottom, or margin)\n\n\nfig-cap-location\nWhere to place figure captions (top, bottom, or margin)\n\n\ntbl-cap-location\nWhere to place table captions (top, bottom, or margin)"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.795Z\",\n \"loc\": \"https://quarto.org/docs/reference/cells/cells-jupyter.html\",\n \"source\": \"https://quarto.org/docs/reference/cells/cells-jupyter.html\"\n}"}}},{"rowIdx":184,"cells":{"page_content":{"kind":"string","value":"Have you been hearing about Quarto but didn’t give it a try yet? Perused the Get Started pages but would like another intro? Or have about 20 minutes to spare and want to pick up a few Quarto tips? You’ve come to the right place!\n\nIn this video, I walk you through creating documents, presentations, and websites and publishing with Quarto. The video features authoring Quarto documents with executable R code chunks using the RStudio Visual Editor.\nSelect highlights include:\n\nInserting cross references to tables and figures\nAdding a citation from a DOI\nSeamlessly switching between output formats as well as creating multi-format documents\nCustomizing the output location of code in presentations\nCreating a website from scratch\nPublishing the website to QuartoPub\n\nIf you would like to follow along as you watch the video, you can find the source code for everything created in the video in this GitHub repository and the published website on QuartoPub.\n \n\n\n\nSubscribe\nEnjoy this blog? Get notified of new posts by email:"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.251Z\",\n \"loc\": \"https://quarto.org/docs/blog/posts/2023-05-15-get-started/index.html\",\n \"source\": \"https://quarto.org/docs/blog/posts/2023-05-15-get-started/index.html\"\n}"}}},{"rowIdx":185,"cells":{"page_content":{"kind":"string","value":"Other FormatsJupyterMS Word\n\n\n\n\n\n\n\n\nQuarto 1.3 Feature\n\n\n\nThis post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.\n\n\nStarting in Quarto 1.3, HTML pages (either standalone or in a website) can automatically include links to other formats specified in the document front matter. For example, the following document front matter:\ntitle: Sample Page\nauthor: Norah Jones\ndate: last-modified\ntoc: true\nformat: \n html: default\n ipynb: default\nResults in an HTML page that includes a link to the additional notebook format in the right margin below the table of contents:\n\nIf a table of contents is enabled for the page, the additional formats will be automatically placed within the table of contents as a new section. If no table of contents is displayed, the additional formats will be displayed in the right margin at the top of the document.\nLinks to additional formats are displayed by default, but you can control whether they are shown or even which specific formats are included with the format-links YAML option.\nRead more about this feature on the Multi-format page of the pre-release highlights.\n \n\n\n\nSubscribe\nEnjoy this blog? Get notified of new posts by email:"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.223Z\",\n \"loc\": \"https://quarto.org/docs/blog/posts/2023-03-15-multi-format/index.html\",\n \"source\": \"https://quarto.org/docs/blog/posts/2023-03-15-multi-format/index.html\"\n}"}}},{"rowIdx":186,"cells":{"page_content":{"kind":"string","value":"NotebooksPalmer Penguins\n\n\n\n\n\n\n\n\nQuarto 1.3 Feature\n\n\n\nThis post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.\n\n\nStarting in Quarto 1.3, you can include the output of an external Jupyter notebook in a Quarto document with the embed shortcode. To embed a notebook cell, provide the path to a Jupyter Notebook and a cell identifier. For example, this notebook called penguins.ipynb has a cell labelled fig-bill-scatter:\n\nYou can use the following shortcode to embed the output of this cell:\n\nThis will embed the plot as follows:\n\n\n\n\n\n\nFigure 1: A scatterplot of bill dimensions for penguins, made with Altair.\n\n\n\nSource: Palmer Penguins\nA link to the source notebook is automatically provided beneath the plot. Following the link takes users to a rendered version of the notebook, allowing them to explore the notebook without having to download and run it locally. For example, clicking on the link to penguins.ipynb gets you to a page that looks like the following:\n\nBeyond this basic usage, head to the Jupyter Cell Embedding highlight docs to learn how to:\n\nSpecify cells in multiple ways, see Specifying Cells.\nControl the output using code cell options in the source Notebook, including things like figure captions, figure layout, and code display, see Code Cell Options.\nInclude the cell code along with the output by adding an echo option to the shortcode, see Embedding Code.\nCustomize or exclude the link to the source notebook, see Links to Source Notebooks.\n\n \n\n\n\nSubscribe\nEnjoy this blog? Get notified of new posts by email:"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.227Z\",\n \"loc\": \"https://quarto.org/docs/blog/posts/2023-03-17-jupyter-cell-embedding/index.html\",\n \"source\": \"https://quarto.org/docs/blog/posts/2023-03-17-jupyter-cell-embedding/index.html\"\n}"}}},{"rowIdx":187,"cells":{"page_content":{"kind":"string","value":"Quarto 1.3 Feature\n\n\n\nThis post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.\n\n\nAtlassian Confluence is a publishing platform for supporting team collaboration. Confluence has a variety of hosting options which include both free and paid subscription plans.\nQuarto 1.3 adds support for publishing individual documents, as well as projects composed of multiple documents into Confluence Spaces.\n\n\n\n\n\n\nA Quarto Document\n\n\n\n\n\n\n\nPublished to Confluence\n\n\n\n\n\n\n\n\n\n\n\nA Quarto Project\n\n\n\n\n\n\n\nPublished to Confluence\n\n\n\n\n\nManaging Confluence content with Quarto allows you to author content in Markdown, manage that content with your usual version control tools like Git and GitHub, and leverage Quarto’s tools for including computational output.\n\nIf you’re curious about using Confluence Publishing for your own project, head to the Confluence Publishing page of the pre-release highlights to learn more.\n \n\n\n\nSubscribe\nEnjoy this blog? Get notified of new posts by email:"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.247Z\",\n \"loc\": \"https://quarto.org/docs/blog/posts/2023-03-20-confluence/index.html\",\n \"source\": \"https://quarto.org/docs/blog/posts/2023-03-20-confluence/index.html\"\n}"}}},{"rowIdx":188,"cells":{"page_content":{"kind":"string","value":"The new Shinylive Quarto extension makes it easy to embed Shiny for Python applications in your Quarto documents. This makes it possible to add interactivity to your documents with just Python code. For example, you can include an interactive Shiny application like this, directly inside your Quarto document.\n\n\n\n\n\nIn case you’re not already familiar with Shiny, here’s some background: Shiny is a framework for creating web applications. Shiny was originally just for R, but we’ve recently released an alpha version of Shiny for Python.\nOne of the exciting new features of Shiny for Python is a deployment method called Shinylive: the application can be run entirely within the browser, without needing a remote server running Python. Instead, Python runs in the web browser, thanks to the magic of WebAssembly. In essence, but the server and client sides of the Shiny application run in the browser.\nThe Shiny for Python website contains many interactive, editable Shiny applications, and is built using this extension.\nBear in mind that not all Shiny applications can be deployed with Shinylive, in part because not all Python packages can run in WebAssembly – but for those that can, this extension makes it possible to deploy the Quarto document with the embedded application on any web hosting service. To learn more about Shinylive, see this page.\nThe new Shinylive Quarto extension makes it easy to embed Shiny for Python applications in Quarto documents. This is a great way of adding interactive components to your Quarto document. And, once again, you don’t need a server running Python to share these Quarto documents – just deploy the generated files as you would for any other Quarto website.\n \n\n\n\nSubscribe\nEnjoy this blog? Get notified of new posts by email:"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.223Z\",\n \"loc\": \"https://quarto.org/docs/blog/posts/2022-10-25-shinylive-extension/index.html\",\n \"source\": \"https://quarto.org/docs/blog/posts/2022-10-25-shinylive-extension/index.html\"\n}"}}},{"rowIdx":189,"cells":{"page_content":{"kind":"string","value":"We are happy to announce that Quarto 1.3 has been released. You can grab the current release from https://quarto.org/docs/download/.\nIf you are ever wondering which version of Quarto you are using, a quick way to check on the command line is:\n\n\nTerminal\n\nquarto --version\n\nWe’ve previously blogged about some of the features of this release that we were most excited about, but let’s highlight them again.\n\nCode Annotation\nYou can now add line-based annotations to your code blocks using special code comments along with an ordered list. Code annotations work across many formats, and are interactive in HTML-based formats.\n\n\n\nCode Annotation in an HTML document\n\n\nTo learn more, check out the Code Annotation documentation.\n\n\nMulti-format Publishing\nHTML pages (either standalone or in a website) now automatically include links to other formats specified in the document front matter. For example, the following document front matter:\ntitle: Sample Page\nauthor: Norah Jones\ndate: last-modified\ntoc: true\nformat: \n html: default\n ipynb: default\nResults in an HTML page that includes a link to the additional notebook format in the right margin below the table of contents:\n\n\n\nAn HTML document with a link to another format\n\n\nFind out more in the documentation on Including Other Formats.\n\n\nJupyter Cell Embedding\nEasily include the output of an external Jupyter notebook in a Quarto document with the embed shortcode. Provide the path to a Jupyter Notebook and a cell identifier and the output will be included in your document along with a link back to the source Notebook.\n\n\n\nA plot embedded in a document from a Jupyter Notebook\n\n\nLearn more about the embed shortcode in Embedding Jupyter Notebook Cells in the docs.\n\n\nConfluence Publishing\nAtlassian Confluence is a publishing platform for supporting team collaboration. Quarto now provides support for publishing individual documents, as well as projects composed of multiple documents, into Confluence Spaces.\n\n\n\n\n\n\nA Quarto Project\n\n\n\n\n\n\n\nPublished to Confluence\n\n\n\n\n\nTo learn more, head to the documentation on Confluence Publishing.\n\n\nOther Highlights\nSome other notable highlights include:\n\nArticle Grid Customization—Customize the widths of layout components in HTML documents\nQuarto Book AsciiDoc Support—Output Quarto books to AsciiDoc files\nWebsite Navigation Improvements—Include tools in your navbar, and provide better navigation for Quarto websites on mobile devices\nMermaid Diagram Theming—Use your document theme, or built-in Mermaid themes, for your Mermaid diagrams\nPDF: SVG and Remote Images—Include SVG images and remote images in PDF documents\nkbd Shortcode—Show well-formatted keyboard shortcuts in Quarto documents.\n\nYou can find all the other changes in 1.3, in the Release Notes.\n\n\nAcknowledgements\nWe’d like to say a huge thank you to everyone who contributed to this release by opening issues and pull requests:\nABohynDOE, aborruso, agerlach, aimundo, alperyilmaz, ameliaritger, anaveenan, andrewheiss, apreshill, apsteinmetz, arnaudgallou, aronatkins, arronlacey, ArturKlauser, astrowonk, ats, awehrfritz, b-rodrigues, baptiste, batpigandme, bayeslearner, benabel, BertTijhuis, boshek, brunomioto, busemorose, bvancil, bwelman, cboettig, cgoo4, ChoCho66, cicarrascog, coatless, code86, condwanaland, daniel-smit-haw, daranzolin, davidbudzynski, DavidD003, ddobrinskiy, dgkf, DhruvaSambrani, directknowledge, dkubek, dmalan, dmenne, drcaprosser, drscotthawley, edoson, eeholmes, eitsupi, elgabbas, EllaKaye, emmansh, ericvmai, espinielli, etiennebacher, EvoArt, fire, fortunewalla, freestatman, fuhrmanator, fulem, g-simmons, gadenbuie, GegznaV, ghost, giabaio, githubpsyche, GraceEMc, gregswinehart, GShotwell, guoruizhong, harrelfe, hemonika, henningsway, iandol, ijlyttle, iusgit, ivanek, jake-wittman, jakobarendt, jakub-jedrusiak, javajon, jcmkk3, jcolomb, jdutant, JeffreyRacine, jensschroer, jeremiahpslewis, jfbarthelemy, jhelvy, Jiayou-Chao, jimjam-slam, jkylearmstrong, jmbarbone, jmbuhr, jmcastagnetto, joelvonrotz, JoFrhwld, johannes4998, jrcuesta, jthomasmock, juba, justanothergithubber, KaiWaldrant, kalenkovich, kdheepak, kelly-sovacool, KittJonathan, kmasiello, knuesel, koehlerson, koushikkhan, lcnbr, leovan, linogaliana, m-legrand, m4jing, machow, maelle, malcolmbarrett, marierivers, MattF-NSIDC, mattsams89, mattwarkentin, maxdrohde, mccarthy-m-g, MHellmund, mikheyev, mine-cetinkaya-rundel, mksinicus, mrajeev08, nanxstats, NeubertJonas, nikcleju, njbart, patrickvdb, petrbouchal, philip-khor, philwunderlich, Pierre9344, pitmonticone, pmagwene, poldrack, pommevilla, psychelzh, ratnanil, ravimakhija, RaymondBalise, reuning, rexdouglass, rgaiacs, richardsprague, rjake, rleyvasal, rmcd1024, RobTour, rsenft1, runlevel0, sagikazarmark, salim-b, SamEdwardes, samperman, schochastics, ScientiaFelis, scottamain, scottfranz, sebastian-c, seeM, shafayetShafee, singuyenmai, sje30, snhansen, streepvaren, thedabs91, thomashallam, timothee-bacri, tomshafer, tomsutch, tomvaneyck, topepo, tverbeiren, TylerHillery, ucpresearch, verbalins, vfacta, vlyubchich, VMTdeJong, vpratz, white-c, wklimowicz, XiangyunHuang, Xitian9, xl0, xtimbeau, y9c, yevgenryeznik, zachcp, zkwabm\n\n \n\n\n\nSubscribe\nEnjoy this blog? Get notified of new posts by email:"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.247Z\",\n \"loc\": \"https://quarto.org/docs/blog/posts/2023-04-26-1.3-release/index.html\",\n \"source\": \"https://quarto.org/docs/blog/posts/2023-04-26-1.3-release/index.html\"\n}"}}},{"rowIdx":190,"cells":{"page_content":{"kind":"string","value":"Quarto 1.3 Feature\n\n\n\nThis post is part of a series highlighting new features in the 1.3 release of Quarto. Get the latest release at https://quarto.org/docs/download.\n\n\nCode blocks and executable code cells in Quarto may now include line-based annotations. Line-based annotations provide a way to attach explanation to lines of code much like footnotes.\nFor example, this code uses annotation to describe the steps in an R dplyr pipeline in plain language:\nlibrary(tidyverse)\nlibrary(palmerpenguins)\n1penguins |>\n2 mutate(\n bill_ratio = bill_depth_mm / bill_length_mm,\n bill_area = bill_depth_mm * bill_length_mm\n )\n\n1\n\nTake penguins, and then,\n\n2\n\nadd new columns for the bill ratio and bill area.\n\n\nThe default HTML annotation style displays annotations in a list below the code block. Clicking on the annotation number in the list highlights the relevant lines in the code. Other HTML styles hide the annotations, revealing them in a tooltip when a user hovers or selects a marker.\nThe PDF format also allows for annotations, numbering, and displaying the annotation text below the code. In other formats, like Word and GitHub Markdown, annotations are instead labeled with the line of code (or lines of code) to which the annotation text applies.\n\nPDFGitHub Flavored Markdown\n\n\n\n\n\n``` r\nlibrary(tidyverse)\nlibrary(palmerpenguins)\npenguins |>\n mutate(\n bill_ratio = bill_depth_mm / bill_length_mm,\n bill_area = bill_depth_mm * bill_length_mm\n )\n```\n\nLine 3 \nTake `penguins`, and then,\n\nLines 4-7 \nadd new columns for the bill ratio and bill area.\n\n\n\nTo add code annotation to a code block, you need to add two things: specially formatted code comments in your code cell, and an ordered list below the code cell with the annotation text:\n\nCode Comments: Each annotated line in the code cell should be terminated with a comment (using the code cell’s language comment character) followed by a space and then an annotation number enclosed in angle brackets (e.g. # <2>). You may repeat an annotation number if the annotation spans multiple lines.\nOrdered List: An ordered list should appear immediately after the code cell, and include the contents of each annotation. Each numbered item in the ordered list will correspond to the line(s) of code with the same annotation number.\n\nFor example, the annotations above were produced by including the following in the Quarto document:\n```r\nlibrary(tidyverse)\nlibrary(palmerpenguins)\npenguins |> # <1>\n mutate( # <2>\n bill_ratio = bill_depth_mm / bill_length_mm, # <2>\n bill_area = bill_depth_mm * bill_length_mm # <2>\n ) # <2>\n```\n1. Take `penguins`, and then,\n2. add new columns for the bill ratio and bill area.\nYou can read more about how to control the annotation style, and whether annotations appear at all on the Code Annotation page of the pre-release highlights.\n \n\n\n\nSubscribe\nEnjoy this blog? Get notified of new posts by email:"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.223Z\",\n \"loc\": \"https://quarto.org/docs/blog/posts/2023-03-13-code-annotation/index.html\",\n \"source\": \"https://quarto.org/docs/blog/posts/2023-03-13-code-annotation/index.html\"\n}"}}},{"rowIdx":191,"cells":{"page_content":{"kind":"string","value":"Overview\nShortcodes are special markdown directives that generate various types of content. Quarto shortcodes are similar in form and function to Hugo shortcodes and WordPress shortcodes.\nFor example, the following shortcode prints the title from document metadata:\n{{< meta title >}}\nQuarto supports several shortcodes natively:\n\n\n\nShortcode\nDescription\n\n\n\n\nvar\nPrint value from _variables.yml file\n\n\nmeta\nPrint value from document metadata\n\n\nenv\nPrint system environment variable\n\n\npagebreak\nInsert a native page-break\n\n\nkbd\nDescribe keyboard shortcuts\n\n\nvideo\nEmbed a video in a document\n\n\ninclude\nInclude contents of another qmd\n\n\nembed\nEmbed cells from a Jupyter Notebook\n\n\n\nThis article describes how to create your own shortcodes.\n\n\nQuick Start\nHere we’ll describe how to create a simple shortcode extension. We’ll use the quarto create command to do this. If you are using VS Code or RStudio, you should execute quarto create within their respective integrated terminal panes.\nTo get started, execute quarto create extension shortcode within the parent directory where you’d like the shortcode extension to be created:\n\n\nTerminal\n\n$ quarto create extension shortcode\n ? Extension Name › shorty\n\nAs shown above, you’ll be prompted for an extension name. Type shorty and press Enter—the shortcode extension is then created:\nCreating extension at /Users/jjallaire/extensions/shorty/shorty:\n - Created README.md\n - Created _extensions/shorty/shorty.lua\n - Created _extensions/shorty/_extension.yml\n - Created .gitignore\n - Created example.qmd\nIf you are running within VS Code or RStudio, a new window will open with the extension project.\nHere’s what the contents of the files in _extensions/shorty/ look like:\n\n\n_extensions/shorty/_extension.yml\n\ntitle: Shorty\nauthor: J.J. Allaire\nversion: 1.0.0\nquarto-required: \">=1.2.222\"\ncontributes:\n shortcodes:\n - shorty.lua\n\n\n\n_extensions/shorty/shorty.lua\n\nreturn {\n ['shorty'] = function(args, kwargs, meta) \n return pandoc.Str(\"Hello from Shorty!\")\n end\n}\n\nFinally, the example.qmd file includes code that exercises the extension. For example:\n\n\nexample.qmd\n\n---\ntitle: \"Shorty Example\"\n---\n\n\nTo develop your shortcode, render/preview example.qmd, and then make changes to shorty.lua (the preview will automatically refresh when you change shorty.lua).\n\n\nDevelopment\nShortcodes are created using Lua. If you aren’t familar with Lua (or with Pandoc filters), here are some resources to help you along:\n\nLua Development (Lua is the language used to create shortcodes).\nLua API Reference, which describes the Lua extension API for Quarto.\n\nShortcodes are implemented as Lua functions that take one or more arguments and return a Pandoc AST node (or list of nodes).\nHere’s the implementation of the env shortcode that is built in to Quarto:\n\n\nenv.lua\n\nfunction env(args)\n local var = pandoc.utils.stringify(args[1])\n local value = os.getenv(var)\n if value ~= nil then\n return pandoc.Str(value)\n else\n return pandoc.Null()\n end\nend\n\nNote that arguments to shortcodes are provided in args (a 1-dimensional array), and that each argument is a list of Pandoc inlines (i.e. markdown AST parsed from the text).\nWe use the pandoc.utils.stringify() function to convert the inlines to an ordinary string, and then the os.getenv() function to get its value.\nYou would use this shortcode as follows:\n{{< env HOME >}}\n\n\nDistribution\nIf your extension source code is located within a GitHub repository, then it can be installed by referencing the GitHub organization and repository name. For example:\n\n\nTerminal\n\n# install the current HEAD of the extension\nquarto add cooltools/shorty\n\n# install a branch or tagged release of the extension\nquarto add cooltools/shorty@v1.2\nquarto add cooltools/shorty@bugfix-22\n\nNote that it is possible to bundle and distribute extensions as simple gzip archives (as opposed to using a GitHub repository as described above). See the article on Distributing Extensions for additional details.\n\n\nExamples\nYou might find it instructive to examine the source code of these shortcode extensions authored by the Quarto team:\n\n\n\n\n\n\n\nExtension\nDescription\n\n\n\n\nfancy-text\nOutput nicely formatted versions of fancy strings such as LaTeX and BibTeX in multiple formats.\n\n\nfontawesome\nUse Font Awesome icons in HTML and PDF documents.\n\n\nvideo\nEmbed videos in HTML documents and Revealjs presentations.\n\n\n\nSome additional annotated examples are provided below.\n\nRaw Output\nShortcodes can tailor their output to the format being rendered to. This is often useful when you want to conditionally generate rich HTML output but still have the same document render properly to PDF or MS Word.\nThe pagebreak shortcode generates “native” pagebreaks in a variety of formats. Here’s the implementation of pagebreak:\n\n\npagebreak.lua\n\nfunction pagebreak()\n \n local raw = {\n epub = '

',\n html = '

',\n latex = '\\\\newpage{}',\n ooxml = '',\n odt = '',\n context = '\\\\page'\n }\n\n if quarto.doc.isFormat('docx') then\n return pandoc.RawBlock('openxml', raw.ooxml)\n elseif quarto.doc.isFormat('pdf') then\n return pandoc.RawBlock('tex', raw.latex)\n elseif quarto.doc.isFormat('odt') then\n return pandoc.RawBlock('opendocument', raw.odt)\n elseif quarto.doc.isFormat('epub') then\n return pandoc.RawBlock('html', raw.epub)\n elseif quarto.doc.isFormat('html') then\n return pandoc.RawBlock('html', raw.html)\n elseif quarto.doc.isFormat('context') then\n return pandoc.RawBlock('context', raw.context)\n else\n -- fall back to insert a form feed character\n return pandoc.Para{pandoc.Str '\\f'}\n end\n\nend\n\nWe use the pandoc.RawBlock() function to output the appropriate raw content for the target format. Note that raw blocks are passed straight through to the output file and are not processed as markdown.\nYou’d use this shortcode as follows:\n{{< pagebreak >}}\n\n\nNamed Arguments\nThe examples above use either a single argument (env) or no arguments at all (pagebreak). Here we demonstrate named argument handling by implementing a git-rev shortcode that prints the current git revision, providing a short option to determine whether a short or long SHA1 value is displayed:\n\n\ngit.lua\n\n-- run git and read its output\nfunction git(command)\n local p = io.popen(\"git \" .. command)\n local output = p:read('*all')\n p:close()\n return output\nend\n\n-- return a table containing shortcode definitions\n-- defining shortcodes this way allows us to create helper \n-- functions that are not themselves considered shortcodes \nreturn {\n [\"git-rev\"] = function(args, kwargs)\n -- command line args\n local cmdArgs = \"\"\n local short = pandoc.utils.stringify(kwargs[\"short\"])\n if short == \"true\" then\n cmdArgs = cmdArgs .. \"--short \"\n end\n \n -- run the command\n local cmd = \"rev-parse \" .. cmdArgs .. \"HEAD\"\n local rev = git(cmd)\n \n -- return as string\n return pandoc.Str(rev)\n end\n}\n\nThere are some new things demonstrated here:\n\nRather than defining our shortcode functions globally, we return a table with the shortcode definitions. This allows us to define helper functions that are not themselves registered as shortcodes. It also enables us to define a shortcode with a dash (-) in its name.\nThere is a new argument to our shortcode handler: kwargs. This holds any named arguments to the shortcode. As with args, values in kwargs will always be a list of Pandoc inlines (allowing you to accept markdown as an argument). Since short is a simple boolean value we need to call pandoc.utils.stringify() to treat it as a string and then compare it to \"true\".\n\nWe’d use this shortcode as follows:\n---\ntitle: \"My Document\"\n---\n\n{{< git-rev >}}\n{{< git-rev short=true >}}\n\n\nMetadata Options\nIn some cases you may want to provide options that affect how your shortcode behaves. There is a third argument to shortcode handlers (meta) that provides access to document and/or project level metadata.\nLet’s implement a different version of the git-rev shortcode that emits the revision as a link to GitHub rather than plain text. To do this, we make use of github.owner and github.repo metadata values:\n\n\ngit.lua\n\nfunction git(command)\n local p = io.popen(\"git \" .. command)\n local output = p:read('*all')\n p:close()\n return output\nend\n\nreturn {\n \n [\"git-rev\"] = function(args, kwargs, meta)\n -- run the command\n local rev = git(\"rev-parse HEAD\")\n \n -- target repo\n local owner = pandoc.utils.stringify(meta[\"github.owner\"])\n local repo = pandoc.utils.stringify(meta[\"github.repo\"])\n local url = \"https://github.com/\" \n .. owner .. \"/\" .. repo .. \"/\" .. rev \n \n -- return as link\n return pandoc.Link(pandoc.Str(rev), url)\n end\n}\n\nAs with args and kwargs, meta values are always provided as a list of Pandoc inlines, so often need to be converted to string using pandoc.utils.stringify().\nTo use this shortcode in a document, we provide the GitHub info as document options, then include the shortcode where we want the link to be:\n---\ntitle: \"My Document\"\ngithub:\n owner: quarto-dev\n repo: quarto-cli\n---\n\n{{< git-rev >}}\nThe shortcode registration and GitHub metadata could just as well been provided in a project-level _quarto.yml file or a directory-level _metadata.yml file.\n\n\n\nRaw Arguments\nIn Quarto >= 1.3 you can also access the raw stream of inlines passed to a shortcode by adding a raw_args parameter. For example:\nfunction shorty(args, kwargs, meta, raw_args)\n\nend\n\n\nEscaping\nIf you are writing documentation about using variable shortcodes (for example, this article!) you might need to prevent them from being processed. You can do this in two ways:\n\nEscape the shortcode reference with extra braces like this:\n{{{< var version >}}}\nAdd a shortcodes=false attribute to any code block you want to prevent processing of shortcodes within:\n```{shortcodes=false}\n{{< var version >}}\n```"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/extensions/shortcodes.html\",\n \"source\": \"https://quarto.org/docs/extensions/shortcodes.html\"\n}"}}},{"rowIdx":192,"cells":{"page_content":{"kind":"string","value":"Overview\nRevealjs plugins enable you to extend the capabilities of HTML presentations created with Revealjs. The Reveal Plugin API is very rich, and many of the built-in capabilities of Quarto Revealjs presentations are implemented as plugins, including Menu, Chalkboard, and PDF Export.\nHere are some examples of Revealjs plugins packaged as Quarto extensions:\n\n\n\n\n\n\n\nExtension\nDescription\n\n\n\n\nPointer\nAdds support for switching the cursor to a ‘pointer’ style element while presenting.\n\n\nAttribution\nDisplay attribution text along the right edge of slides.\n\n\n\n\n\nQuick Start\nHere we’ll describe how to create a simple Revealjs plugin extension. We’ll use the quarto create command to do this. If you are using VS Code or RStudio you should execute quarto create within their repsective integrated Terminal panes.\nTo get started, execute quarto create extension revealjs-plugin within the parent directory where you’d like the plugin extension to be created:\n\n\nTerminal\n\n$ quarto create extension revealjs-plugin\n ? Extension Name › shuffler\n\nAs shown above, you’ll be prompted for an extension name. Type shuffler and press Enter—the Revealjs plugin extension is then created:\nCreating extension at /Users/jjallaire/quarto/dev/shuffler:\n - Created README.md\n - Created _extensions/shuffler/_extension.yml\n - Created _extensions/shuffler/shuffler.css\n - Created _extensions/shuffler/shuffler.js\n - Created .gitignore\n - Created example.qmd\nIf you are running within VS Code or RStudio a new window will open with the extension project.\nHere’s what the contents of the files in _extensions/shuffler/ look like:\n\n\n_extensions/shuffler/_extension.yml\n\ntitle: Shuffler\nauthor: J.J. Allaire\nversion: 1.0.0\nquarto-required: \">=1.2.222\"\ncontributes:\n revealjs-plugins:\n - name: RevealShuffler\n script:\n - shuffler.js\n stylesheet:\n - shuffler.css\n\n\n\n_extensions/shuffler/shuffler.js\n\nwindow.RevealShuffler = function () {\n return {\n id: \"RevealShuffler\",\n init: function (deck) {\n // TODO: Implement your plugin functionality\n // Learn more at https://revealjs.com/creating-plugins/\n \n // This example shuffles the deck when the 'T' key is pressed\n deck.addKeyBinding({ keyCode: 84, key: \"T\" }, () => {\n deck.shuffle();\n });\n },\n };\n};\n\nThere is also a shuffler.css file for providing any styles required by your plugin.\nFinally, the example.qmd file includes code that exercises the extension. For example:\n\n\nexample.qmd\n\n---\ntitle: \"Shuffler Example\"\nformat:\n revealjs: default\nrevealjs-plugins:\n - shuffler\n---\n\n## Breakfast\n\n- Eat eggs\n- Drink coffee\n\n## Dinner\n\n- Eat spaghetti\n- Drink wine\n\nTo develop your plugin, render/preview example.qmd, and then make changes to shuffler.js and shuffler.css (the preview will automatically refresh when you change these files).\n\n\nInstallation and Use\nIf your extension source code it located within a GitHub repository, then it can be added by referencing the GitHub organization and repository name. For example, you can install the attribution extension with the following:\n\n\nTerminal\n\nquarto add quarto-ext/attribution\n\nNote that it is possible to bundle and distribute extensions as simple gzip archives (as opposed to using a GitHub repository as described above). See the article on Distributing Extensions for additional details.\nOnce an extension has been added, you can use the Reveal plugin by adding it to the reveal-plugins key. For example:\n---\ntitle: \"My Presentation\"\nformat: revealjs\nrevealjs-plugins:\n - attribution\n---\n\n\nPlugin Packaging\nNote that the plugins listed above were not initially developed for use with Quarto. Rather, they were developed intially as native Revealjs plugins and then packaged as Quarto extensions.\nFor example, you can find the original implementation of the attribution plugin here: https://github.com/rschmehl/reveal-plugins/tree/main/attribution. The plugin is implemented with a JavaScript file and a CSS file. To make the plugin available as a Quarto extension, we package these files along with an _extension.yml config file that registers the plugin. Here are the files in the Quarto extension:\nLICENSE\nREADME.md\nexample.qmd\n_extensions/\n attribution/\n _extension.yml\n attribution.js\n attribution.css\nNote that the LICENSE and README.md are standard documentation files and the example.qmd is used for development and documentation of the extension. None of those files are actually installed by end users (rather only the contents of the _extensions directory is installed).\nYou can see the full source code of the Quarto version here: https://github.com/quarto-ext/attribution (we’ll also walk through the code in detail below).\n\n\nPlugin Development\nYou can develop either entirely new Revealjs plugins from scratch or you can package existing Revealjs extensions as described above.\nHere is a list of existing 3rd party plugins for Revealjs that you might consider packaging as Quarto extensions: https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware.\nIf you want to develop new plugins, check out the Quarto Reveal extensions listed above as well as the code of other 3rd party Reveal Plugins. The following documentation on the Revealjs website provides additional important technical details:\n\nAPI Methods\nReveal Events\n\n\n\nPlugin Configuration\nSome Revealjs plugins make available various user options. If you are developing a plugin from scratch, you should use a distinct key for your plugin’s configuration. Users can use this key alongside other revealjs options. For example the pointer extension can be configured as follows:\n---\ntitle: \"Example Presentation\"\nformat:\n revealjs: \n pointer:\n pointerSize: 18\n color: '#32cd32'\nrevealjs-plugins:\n - pointer\n---\nThe extension accesses options using the deck.getConfig() function:\nreturn {\n id: \"pointer\",\n init: (deck) => {\n const config = deck.getConfig();\n const options = config.pointer || {};\n // etc\n }\n}\nNote that when packaging an existing Revealjs plugin, you can override its default configuration using the config key within your _extension.yml file. For example, these are the overrides provided by the pointer extension:\ntitle: Pointer\nauthor: Charles Teague\ncontributes:\n revealjs-plugins:\n - name: RevealPointer\n script:\n - pointer.js\n stylesheet:\n - pointer.css\n config:\n pointer:\n key: \"q\"\n color: \"red\"\n pointerSize: 16\n alwaysVisible: false\n\n\nExample: Attribution\nHere we’ll walk through the complete source code for the attribution extension. This extension enables you to display attribution text sideways along the right edge of Revealjs slides.\nHere are source files used to develop the extension:\nLICENSE\nREADME.md\nexample.qmd\n_extensions/\n attribution/\n _extension.yml\n attribution.js\n attribution.css\nThe example.qmd and documentation files are used for development of the the extension only (it is not installed by end users). The other files provide extension registration (_extension.yml) and the actual implementation of the Revealjs plugin (attribution.js and attribution.css).\nThe example.qmd is a simple one-slide presentation that includes an image along with a a div with class .attribution:\n\n\nexample.qmd\n\n---\ntitle: \"Attribution Extension\"\nformat: revealjs\nrevealjs-plugins:\n - attribution\n---\n\n## Forest Image\n\n\n\n::: {.attribution)\nPhoto courtesy of [@ingtotheforest](https://unsplash.com/@ingtotheforest)\n:::\n\nNote that the revealjs-plugins key references the attribution extension, which will implemented in the _extensions/attribution directory.\nThe _extension.yml file indicates that the extension is making available a Revealjs plugin along with the plugin name, script, and style-sheets (note that the plugin name is not arbitrary, it will be whatever name is used within the script that implements the plugin, in this case RevealAttribution):\n\n\n_extensions/attribution/_extension.yml\n\ntitle: Attribution\nauthor: Roland Schmehl\nversion: 0.1.0\nquarto-required: \">=1.2.0\"\ncontributes:\n revealjs-plugins:\n - name: RevealAttribution\n script:\n - attribution.js\n stylesheet:\n - attribution.css\n\nThe attribution.js file contains the implementation of the Plugin using the Revealjs Plugin API:\n\n\n_extensions/attribution/attribution.js\n\nwindow.RevealAttribution = window.RevealAttribution || {\n id: 'RevealAttribution',\n init: function(deck) {\n initAttribution(deck);\n }\n};\n\nconst initAttribution = function(Reveal){\n\nvar ready = false;\nvar resize = false;\nvar scale = 1;\n\nwindow.addEventListener( 'ready', function( event ) {\n\n var content;\n\n // Remove configured margin of the presentation\n var attribution = document.getElementsByClassName(\"attribution\");\n var width = window.innerWidth;\n var configuredWidth = Reveal.getConfig().width;\n var configuredHeight = Reveal.getConfig().height;\n\n scale = 1/(1-Reveal.getConfig().margin);\n\n for (var i = 0; i < attribution.length; i++) {\n content = attribution[i].innerHTML;\n attribution[i].style.width = configuredWidth + \"px\";\n attribution[i].style.height = configuredHeight + \"px\";\n attribution[i].innerHTML = \"\" + content + \"\";\n attribution[i].style.transform = 'translate( -50%, -50% ) scale( ' + scale*100 + '% ) rotate(-180deg)';\n }\n\n // Scale with cover class to mimic backgroundSize cover\n resizeCover();\n\n});\n\nwindow.addEventListener( 'resize', resizeCover );\n\nfunction resizeCover() {\n\n // Scale to mimic backgroundSize cover\n var attribution = document.getElementsByClassName(\"attribution\");\n var xScale = window.innerWidth / Reveal.getConfig().width;\n var yScale = window.innerHeight / Reveal.getConfig().height;\n var s = 1;\n\n if (xScale > yScale) {\n // The div fits perfectly in x axis, stretched in y\n s = xScale/yScale;\n }\n for (var i = 0; i < attribution.length; i++) {\n attribution[i].style.transform = 'translate( -50%, -50% ) scale( ' + s*scale*100 + '% ) rotate(-180deg)';\n }\n}\n\n};\n\nFinally, attribution.css includes the CSS that repositions and rotates the element with class .attribution on the far right side of the slide:\n\n\n_extensions/attribution/attribution.css\n\n/* Attribution plugin: text along the right edge of the viewport */\n.attribution{\n position: absolute;\n top: 50%;\n bottom: auto;\n left: 50%;\n right: auto;\n font-size: 0.4em;\n pointer-events: none;\n text-align: center;\n writing-mode: vertical-lr;\n transform: translate( -50%, -50% ) scale( 100% ) rotate(-180deg);\n}\n\n/* Attribution plugin: activate pointer events for attribution text only */\n.attribution .content{\n pointer-events: auto;\n}"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/extensions/revealjs.html\",\n \"source\": \"https://quarto.org/docs/extensions/revealjs.html\"\n}"}}},{"rowIdx":193,"cells":{"page_content":{"kind":"string","value":"Extensions are a powerful way to modify and extend the behavior of Quarto. Below is a listing of available extensions (please let us know if you have an extension you’d like to see added to the list).\nSee the articles on Creating Extensions to learn how to develop your own extensions.\n\n\n\n\n\n\nShortcode/Filter\n \n\n\n\nJournal Articles\n \n\n\n\nCustom Formats\n \n\n\n\nRevealjs\n \n\n\n\n\n\nJournal Articles\n\n\n\n\n\n\n\n\n\n\n\nName\n\n\nDescription\n\n\nAuthor\n\n\n\n\n\n\nacm\n\n\nAssociation of Computing Machinery (ACM) \n\n\nquarto-journals\n\n\n\n\nacs\n\n\nAmerican Chemical Society (ACS) \n\n\nquarto-journals\n\n\n\n\nagu\n\n\nAmerican Geophysical Union (AGU) \n\n\nquarto-journals\n\n\n\n\nbiophysical\n\n\nBiophysical Journal (BJ) \n\n\nquarto-journals\n\n\n\n\nelsevier\n\n\nFormat for journals published by Elsevier \n\n\nquarto-journals\n\n\n\n\njasa\n\n\nAmerican Statistical Association (ASA) \n\n\nquarto-journals\n\n\n\n\njss\n\n\nJournal of Statistical Software (JSS) \n\n\nquarto-journals\n\n\n\n\nplos\n\n\nPublic Library of Science (PLOS) \n\n\nquarto-journals\n\n\n\n\narxiv\n\n\nStyle and template for paper preprints (based on NIPS style) \n\n\nmikemahoney218\n\n\n\n\ntandf\n\n\nTaylor and Francis style. \n\n\nmikemahoney218\n\n\n\n\nsportrxiv\n\n\nManuscripts for the SportRxiv preprint server.\n\n\nsmnnlt\n\n\n\n\ncomputo\n\n\nTemplate for contribution to the Computo journal.\n\n\ncomputorg\n\n\n\n\nasm\n\n\nQuarto template for ASM mSystems.\n\n\nkelly-sovacool\n\n\n\n\n\nNo matching items"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/extensions/listing-journals.html\",\n \"source\": \"https://quarto.org/docs/extensions/listing-journals.html\"\n}"}}},{"rowIdx":194,"cells":{"page_content":{"kind":"string","value":"Overview\nStarter templates provide a straightforward way for users to get started with new Quarto projects by providing example content and options. You might use starter templates to:\n\nCreate a working initial document for Journal Articles or Custom Formats.\nProvide the initial content for a custom Project Type.\nScaffold a standard form of data analysis project used by your organization.\n\nStarter templates are essentially just GitHub repositories that are copied to a new directory on the user’s system. As we’ll describe below in Extensions & Templates, often times the repository for a custom format is also used as a starter template.\n\n\nCreating a Template\nTo create a starter template, just create a GitHub repository that includes the files you want copied into projects created with the template. All of the files in the repository are copied save for:\n\nHidden files (any file or directory name that starts with . (e.g. .gitignore).\nCommon GitHub repository files like README.md and LICENSE.\n\nIf you’d like, you can also include a .quartoignore file in the root of your repository listing other files or directories you’d like to exclude. Each line of the file should be a glob describing file(s) to ignore (using syntax like a .gitignore file).\n\ntemplate.qmd\nThere is one special file you’ll typically want to include in templates that target creation of documents (as opposed to projects): template.qmd. There are two reasons to include a template.qmd:\n\nIt provides an easy way to test that your template is working as expected.\nWhen the template is copied into the target directory, the template.qmd will automatically be renamed to match the name that the user provided for the directory.\n\nIf you are creating a template that targets creation of a website or book, a template.qmd is generally not necessary (as the index.qmd file already serves this purpose).\n\n\n\nUsing a Template\nOnce you’ve created the template repository and pushed it to GitHub, it can be instantiated with the following command:\n\n\nTerminal\n\nquarto use template cooltools/cool-project\n\nThis command copies the contents of the GitHub repository at https://github.com/cooltools/cool-project to the local system (excluding selected files as discussed above).\nIf the command is run in an empty directory, the user will be prompted whether they’d like to use the existing directory or create a new directory. If the command is run in a directory which contains other files or directories, they’ll be prompted for the name of a directory to create.\n\n\nExtensions & Templates\nWhen creating Journal Articles, Custom Formats, or Project Type extensions, we recommend that you additionally provide a starter template to make it easy for users to get started.\nThis is generally as easy as adding a template.qmd file to your extension that demonstrates its use. With this configuration, users can either begin using your extension via the template or by a conventional quarto install of the extension.\nFor example, consider the ACM Journal Article extension. The extension repository supports either getting started with a template:\n\n\nTerminal\n\nquarto use template quarto-journals/acm\n\nAlternatively, you can add the format (without the template) into an existing project or directory:\n\n\nTerminal\n\nquarto add quarto-journals/acm"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/extensions/starter-templates.html\",\n \"source\": \"https://quarto.org/docs/extensions/starter-templates.html\"\n}"}}},{"rowIdx":195,"cells":{"page_content":{"kind":"string","value":"Extensions are a powerful way to modify and extend the behavior of Quarto. Below is a listing of available extensions (please let us know if you have an extension you’d like to see added to the list).\nSee the articles on Creating Extensions to learn how to develop your own extensions.\n\n\n\n\n\n\nShortcode/Filter\n \n\n\n\nJournal Articles\n \n\n\n\nCustom Formats\n \n\n\n\nRevealjs\n \n\n\n\n\n\nRevealjs Extensions\n\n\n\n\n\n\n\n\n\n\n\nName\n\n\nDescription\n\n\nAuthor\n\n\n\n\n\n\npointer\n\n\nSwitch the cursor to a ‘pointer’ style element. \n\n\nquarto-ext\n\n\n\n\nattribution\n\n\nDisplay attribution text along the right edge of slides. \n\n\nquarto-ext\n\n\n\n\nauto-agenda\n\n\nAutomatically creates agenda slides from H1 heading titles. \n\n\nandrie\n\n\n\n\nroughnotation\n\n\nUses the Rough Notation library to add animated annotations to presentations.\n\n\nEmilHvitfeldt\n\n\n\n\nappearance\n\n\nAn animation extension that animates elements sequentially like in Powerpoint. Perfect for online portfolios or other presentations with images.\n\n\nmartino\n\n\n\n\nsimplemenu\n\n\nA simple extension for a menubar or a header or footer with an auto-generated menu.\n\n\nmartino\n\n\n\n\nverticator\n\n\nA plugin that adds indicators to show the amount of slides in a vertical stack.\n\n\nmartino\n\n\n\n\nconfetti\n\n\nAdd some fun and send confetti into your presentation.\n\n\nArthurData\n\n\n\n\ncodefocus\n\n\nA plugin that lets you step through fragments and code higlights at the same time.\n\n\nReuning\n\n\n\n\nreveal-header\n\n\nFilter that provides options to add a header text and header logo in top-left corner of the RevealJs slides. \n\n\nShafayet Khan Shafee\n\n\n\n\nstyle-speaker-note\n\n\nFilter that allows to style the Speaker Notes of the RevealJs slides from a CSS file. \n\n\nShafayet Khan Shafee\n\n\n\n\nspotlight\n\n\nA Quarto extension for Reveal.js allowing to highlight the current mouse position with a spotlight. \n\n\nMickaël CANOUIL\n\n\n\n\ncode-fullscreen\n\n\nFilter that adds a fullscreen button in the code blocks in Revealjs slides and html documents. \n\n\nShafayet Khan Shafee\n\n\n\n\nanimate\n\n\nCreate animations from svg files, and integrate them to fragments \n\n\nFrançois-David Collin\n\n\n\n\nstorybook-revealjs\n\n\nMedieval inspired format for Revealjs \n\n\nMickaël CANOUIL\n\n\n\n\nceeos-revealjs\n\n\nDark grey / white based format for Revealjs \n\n\nMickaël CANOUIL\n\n\n\n\nrladies-revealjs\n\n\nR-Ladies format for Revealjs \n\n\nbeatrizmilz\n\n\n\n\nonyxia-revealjs\n\n\nOnyxia format for Revealjs \n\n\nInseeFrLab\n\n\n\n\nblackboard-revealjs\n\n\nBlackboard like format for Revealjs \n\n\nschochastics\n\n\n\n\nnes-revealjs\n\n\nNES.css format for Revealjs \n\n\nEmilHvitfeldt\n\n\n\n\nrlille-revealjs\n\n\nR Lille (R User Group) format for Revealjs \n\n\nMickaël CANOUIL\n\n\n\n\nmetropolis-revealjs\n\n\nBeamer Metropolis like format for Revealjs. \n\n\nShafayet Khan Shafee\n\n\n\n\nillinois-revealjs\n\n\nUniversity of Illinois Urbana-Champaign inspired theme for the reveal.js format based on Metropolis. \n\n\nJames Joseph Balamuta\n\n\n\n\nclean-revealjs\n\n\nA minimal and elegant theme for reveal.js, inspired by modern Beamer templates. \n\n\nGrant McDermott\n\n\n\n\n\nNo matching items"},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/extensions/listing-revealjs.html\",\n \"source\": \"https://quarto.org/docs/extensions/listing-revealjs.html\"\n}"}}},{"rowIdx":196,"cells":{"page_content":{"kind":"string","value":"Overview\nIf you are rendering existing Jupyter notebooks that were not created with Quarto in mind, you may wish to do some pre-processing on the notebook prior to its conversion to markdown. This can be accomplished by specifying one or more ipynb-filters. These filters are passed the JSON representation of the notebook on stdin and should write a transformed JSON representation to stdout.\n\n\n\n\n\n\nNote\n\n\n\nThe purpose of notebook filters is to adapt existing .ipynb files for use with Quarto. Consequently, notebook filters are only run when the original input is an .ipynb file (they are not run for .qmd files).\n\n\n\n\nExample\nFor example, this notebook filter uses the nbformat package to read a notebook, prepend a comment to the source of each code cell, and then write it back to stdout:\nimport sys\nimport nbformat\n\n# read notebook from stdin\nnb = nbformat.reads(sys.stdin.read(), as_version = 4)\n\n# prepend a comment to the source of each cell\nfor index, cell in enumerate(nb.cells):\n if cell.cell_type == 'code':\n cell.source = \"# comment\\n\" + cell.source\n \n# write notebook to stdout \nnbformat.write(nb, sys.stdout)\nYou can arrange for this filter to be run using the ipynb-filters option (specified at either the document or project level):\n---\nipynb-filters:\n - filter.py\n---\nNote that the current working directory for the filter will be set to the location of the input notebook."},"metadata":{"kind":"string","value":"{\n \"lastmod\": \"2023-07-05T19:35:15.275Z\",\n \"loc\": \"https://quarto.org/docs/extensions/nbfilter.html\",\n \"source\": \"https://quarto.org/docs/extensions/nbfilter.html\"\n}"}}},{"rowIdx":197,"cells":{"page_content":{"kind":"string","value":"Overview\nThis article provides documentation on the standard APIs available when implementing Lua filters and shortcodes. There are three major sets of APIs available:\n\nLua Base API—Base functions provided for string handling, pattern matching, table manipulation, and file input and output.\nPandoc Lua API—Core API provided by Pandoc for filter development, and includes both core AST types (e.g. pandoc.Div, pandoc.CodeBlock, etc.) as well as a wide variety of helper functions for common tasks.\nQuarto Lua API—Additional functions used for debugging, format detection, encoding (e.g. JSON), and adding dependencies to documents (e.g. JavaScript libraries or LaTeX packages).\n\nTo get started with programming in Lua and learn about some recommended tools and workflow, see the article on Lua Development.\n\n\nLua Base API\nThe Lua standard library provides core functions for low-level string, math, table, and file operations. Here we provide links to a few of the more useful standard libaries (complete documentation can be found in the Lua Reference Manual).\n\n\n\n\n\n\n\nLibrary\nDescription\n\n\n\n\nstring\nThis library provides generic functions for string manipulation, such as finding and extracting substrings, and pattern matching.\n\n\nutf8\nThis library provides basic support for UTF-8 encoding.\n\n\ntable\nThis library provides generic functions for table manipulation.\n\n\nmath\nThis library provides basic mathematical functions.\n\n\nio, file\nThe I/O library provides two different styles for file manipulation: one uses implicit file handles and the other explicit handles.\n\n\nos\nDate/time, locales, environment variables, etc.\n\n\n\n\n\nPandoc Lua API\nComplete documentation for the Pandoc Lua API can be found in the Lua Filters article available on the Pandoc website. Here are the various components of the API along with links to their reference documentation:\n\n\n\n\n\n\n\nLua Module\nDescription\n\n\n\n\npandoc (ast)\nConstructors for document tree elements (e.g. pandoc.Div(), pandoc.Strong(), etc.) as well as core components (e.g. pandoc.Attr())\n\n\npandoc (functions)\nFunctions to parse text in a given format, filter and modify a sub-tree, and run child processes.\n\n\npandoc.text\nUTF-8 aware text manipulation functions (e.g. upper(), lower(), etc.)\n\n\npandoc.List\nThis module defines pandoc’s list type. It comes with useful methods and convenience function (e.g find_if(), includes(), filter(), map(), etc.)\n\n\npandoc.utils\nInternal pandoc functions and utility functions (e.g. blocks_to_inlines(), stringify(), citeproc(), etc.)\n\n\npandoc.path\nModule for file path manipulations (e.g. is_absolute(), is_relative(), join(), etc.\n\n\npandoc.system\nAccess to system information and functionality (e.g. get_working_directory(), list_directory(), etc.\n\n\npandoc.mediabag\nAccess to pandoc’s media storage. The “media bag” is used when pandoc is called with the --extract-media or (for HTML only) --embed-resources option.\n\n\npandoc.template\nCompile and access defualt pandoc templates (e.g. compile())\n\n\npandoc.types\nConstructors for types which are not part of the pandoc AST (e.g. Version())\n\n\n\n\n\nQuarto Lua API\n\nUtility Functions\nVarious utility functions are provided:\n\n\n\n\n\n\n\nFunction\nDescription\n\n\n\n\nquarto.version()\nReturn the current Quarto version as a pandoc.Version object.\n\n\nquarto.utils.dump(obj)\nDump a text representation of the passed object to stdout.\n\n\nquarto.utils.resolve_path(path)\nCompute the full path to a file that is installed alongside your extension’s Lua script. This is useful for internal resources that your filter needs but should not be visible to the user.\n\n\n\nQuarto includes the pandoc-lua-logging library, which should be used in preference to the dump function. For example, you can examine an element passed to a filter function as follows:\nfunction Div(el)\n quarto.log.output(el)\nend\n\n\nFormat Detection\nExtensions will often need to detect the current format to create custom content depending on the target output medium. The quarto.doc.is_format() function\n\n\n\nFunction\nDescription\n\n\n\n\nquarto.doc.is_format(name)\nDetect if the current format matches name.\n\n\nquarto.doc.has_bootstrap()\nQuery whether Bootstrap CSS is available within the current document (it is by default for standard html documents but this may have been overridden by e.g. theme: none).\n\n\n\nThe name parameter can match an exact Pandoc format name (e.g. docx, latex, etc. or can match based on an alias that groups commonly targeted formats together. The following values format aliases are handled specially by quarto.doc.is_format():\n\n\n\nAlias\nFormats\n\n\n\n\nlatex\nlatex, pdf\n\n\npdf\nlatex, pdf\n\n\nepub\nepub*\n\n\nhtml\nhtml*, epub*, revealjs\n\n\nhtml:js\nhtml*, revealjs\n\n\nmarkdown\nmarkdown*, commonmark*, gfm, markua\n\n\n\nNote that the html:js alias indicates that the target format is capable of executing JavaScript (this maps to all HTML formats save for ePub).\nFor example, here we check for PDF and HTML output:\nif quarto.doc.is_format(\"pdf\") then\n -- pdf specific output\nelseif quarto.doc.is_format(\"html\") then\n -- html specific output\nelse\n -- output for other formats\nend\nFor LaTeX output, you may need to additionally detect which citation utility and pdf engine are being used for the current render. You can use these functions to do that detection:\n\n\n\n\n\n\n\nFunction\nDescription\n\n\n\n\nquarto.doc.cite_method()\nReturns a string (citeproc, natbib, or biblatex) indicating the cite method in use.\n\n\nquarto.doc.pdf_engine()\nReturns a string (pdflatex, xelatex, lualatex, or tectonic) indicating the PDF engine being used to render the document.\n\n\n\n\n\nIncludes\nSometimes extensions need to inject content into the target document. There are three locations that content can be included (pass one of these locations as the first argument of the include functions):\n\n\n\n\n\n\n\nLocation\nDescription\n\n\n\n\nin-header\nIn the header of the document (HTML tag or LaTeX preamble)\n\n\nbefore-body\nBefore the document body\n\n\nafter-body\nAfter the document body\n\n\n\nNote that the included content should use the raw target format (e.g. HTML or LaTeX) rather than markdown. You can use these functions to include text or the contents of a file:\n\n\n\n\n\n\n\nFunction\nDescription\n\n\n\n\nquarto.doc.include_text(location, text)\nInclude text at the specified location (in-header, before-body, or after-body)\n\n\nquarto.doc.include_file(location, file)\nInclude file at the specified location (in-header, before-body, or after-body). The path to the file should relative to the Lua script calling this function.\n\n\n\nFor example the following code includes an HTML file after the body in the rendered document:\nquarto.doc.include_file(\"after-body\", \"comments.html\")\n\n\nDependencies\nExtensions will sometimes want to add external dependencies (for example, a JavaScript library and related CSS, or the usage of a LaTeX package). This can be accomplished with the following functions:\n\n\n\nFunction\nDescription\n\n\n\n\nquarto.doc.add_html_dependency(dep)\nAdd an HTML dependency (additional resources and content) to a document. See docs on the HTML Dependencies below for additional details.\n\n\nquarto.doc.attach_to_dependency(name, attach)\nAttach a file to an existing dependency. attach is a file path relative to the Lua filter or table with `path` and `name` for renaming the file as its copied.\n\n\nquarto.doc.use_latex_package(pkg, opt)\nAdds a \\usepackage statement to the LaTeX output (along an options string specified in opt)\n\n\nquarto.doc.add_format_resource(path)\nAdd a format resource to the document. Format resources will be copied into the directory next to the rendered output. This is useful, for example, if your format references a bst or cls file which must be copied into the LaTeX output directory.\n\n\n\nFor example, here we add a LaTeX package dependency:\nquarto.doc.use_latex_package(\"gamebook\")\n\nHTML Dependencies\nHTML Dependencies can bundle together JavaScript, CSS, and even arbitrary content to inject into the of the document. These dependencies have a name and a version, which is used to ensure that the same dependency isn’t bundled into the document more than once.\nThe dep object passed to quarto.doc.add_html_dependency() has the following fields:\n\n\n\nField\nDescription\n\n\n\n\nname\nUnique name. Required.\n\n\nversion\nVersion number (as a string). Required.\n\n\nscripts\nList of scripts to include (paths can be absolute or relative to the Lua file calling the function). Scripts can be either a simple path or a script object.\n\n\nstylesheets\nList of CSS style-sheets to include (paths can be absolute or relative to the Lua file calling the function). Stylesheets can either be a simple path or a stylesheet object\n\n\nlinks\nList of link tags to add to the document. Each tag should be a table with rel and ref (required) and optionally type\n\n\nresources\nAdditional files to copy to the input directory (each resource is an object with name (target file name in input directory) and path (source file name relative to Lua script).\n\n\nserviceworkers\nJavaScript serviceworker files that should be copied to the root output directory (can be a simple string file name or table with `path` and `name` for renaming the file as its copied).\n\n\nmeta\nTable of optional key = value meta tags to insert into the document \n\n\nhead\nArbitrary string to include in document \n\n\n\nFor example, here we add a dependency to a JavaScript library:\nquarto.doc.add_html_dependency({\n name = \"glightbox\",\n version = \"3.2.0\",\n scripts = {\"glightbox.min.js\"},\n stylesheets = {\"glightbox.min.css\"}\n})\n\n\nScript Object\nThe easiest way to specify scripts is with simple paths. However, in some cases you may need to add attributes to the