From c737a04d5187fb33f50a761e56589c7df2ffa8fb Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Mon, 11 Dec 2023 10:54:49 +1300 Subject: [PATCH 01/29] Remove 1.3 callout, add 1.4 callout --- docs/_require-1.3.qmd | 5 ----- docs/_require-1.4.qmd | 5 +++++ 2 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 docs/_require-1.4.qmd diff --git a/docs/_require-1.3.qmd b/docs/_require-1.3.qmd index 1b2bbd6be7..e69de29bb2 100644 --- a/docs/_require-1.3.qmd +++ b/docs/_require-1.3.qmd @@ -1,5 +0,0 @@ -::: {.callout-note} -## Quarto 1.3 Feature - -This feature is new in Quarto 1.3, which you can download at -::: \ No newline at end of file diff --git a/docs/_require-1.4.qmd b/docs/_require-1.4.qmd new file mode 100644 index 0000000000..70bcac5383 --- /dev/null +++ b/docs/_require-1.4.qmd @@ -0,0 +1,5 @@ +::: {.callout-note} +## Quarto 1.4 Feature + +This feature is new in Quarto 1.4. Download the latest version at +::: \ No newline at end of file From e669bb07182d5d242d04d8305791ce4bebb43576 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Mon, 11 Dec 2023 11:08:49 +1300 Subject: [PATCH 02/29] Improve 1.4 callout --- docs/_require-1.4.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_require-1.4.qmd b/docs/_require-1.4.qmd index 70bcac5383..daf547742b 100644 --- a/docs/_require-1.4.qmd +++ b/docs/_require-1.4.qmd @@ -1,5 +1,5 @@ ::: {.callout-note} ## Quarto 1.4 Feature -This feature is new in Quarto 1.4. Download the latest version at +This feature is new in Quarto 1.4. Download the latest version of Quarto at . ::: \ No newline at end of file From 1e0d7d8294380e26987cdfd2455c5900858c81fe Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Mon, 11 Dec 2023 11:48:05 +1300 Subject: [PATCH 03/29] Move Cloud Publishing docs to main docs --- _quarto.yml | 1 + docs/guide/guide.yml | 2 ++ docs/output-formats/html-publishing.qmd | 1 + docs/publishing/_providers.md | 1 + docs/publishing/posit-cloud.qmd | 2 +- 5 files changed, 6 insertions(+), 1 deletion(-) diff --git a/_quarto.yml b/_quarto.yml index 6a3ff8ddc0..a9fa8226ff 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -340,6 +340,7 @@ website: - docs/publishing/quarto-pub.qmd - docs/publishing/github-pages.qmd - docs/publishing/rstudio-connect.qmd + - docs/publishing/posit-cloud.qmd - docs/publishing/netlify.qmd - docs/publishing/confluence.qmd - docs/publishing/other.qmd diff --git a/docs/guide/guide.yml b/docs/guide/guide.yml index 0cc9b44ed6..6f9ece6189 100644 --- a/docs/guide/guide.yml +++ b/docs/guide/guide.yml @@ -140,6 +140,8 @@ href: ../publishing/github-pages.qmd - text: Posit Connect href: ../publishing/rstudio-connect.qmd + - text: Posit Cloud + href: ../publishing/posit-cloud.qmd - text: Netlify href: ../publishing/netlify.qmd - text: Confluence diff --git a/docs/output-formats/html-publishing.qmd b/docs/output-formats/html-publishing.qmd index 593c60c5d5..d29413f132 100644 --- a/docs/output-formats/html-publishing.qmd +++ b/docs/output-formats/html-publishing.qmd @@ -30,6 +30,7 @@ Here's a brief overview of the various supported services and when they might be | [Quarto Pub](../publishing/quarto-pub.html) | Publishing service for Quarto documents, websites, and books. Use Quarto Pub when you want a free, easy to use service for publicly available content. | | [GitHub Pages](../publishing/github-pages.html) | Publish 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. | | [Posit Connect](../publishing/rstudio-connect.html) | Publishing 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. | +| [Posit Cloud](../docs/publishing/posit-cloud.html) | Create data projects and publish results from your web browser. Use Posit Cloud when you want to organize all your static documents and interactive applications in one place. | | [Netlify](../publishing/netlify.html) | Professional web publishing platform. Use Netlify when you want support for custom domains, authentication, previewing branches, and other more advanced capabilities. | | [Other Services](../publishing/other.html) | Content 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. | diff --git a/docs/publishing/_providers.md b/docs/publishing/_providers.md index 8dc2a9a755..7cfeb6a6e8 100644 --- a/docs/publishing/_providers.md +++ b/docs/publishing/_providers.md @@ -5,6 +5,7 @@ | [Quarto Pub](/docs/publishing/quarto-pub.qmd) | Publishing service for Quarto documents, websites, and books. Use Quarto Pub when you want a free, easy to use service for publicly available content. | | [GitHub Pages](/docs/publishing/github-pages.qmd) | Publish 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. | | [Posit Connect](/docs/publishing/rstudio-connect.qmd) | Publishing 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. | +| [Posit Cloud](/docs/publishing/posit-cloud.qmd) | Create data projects and publish results from your web browser. Use Posit Cloud when you want to organize all your static documents and interactive applications in one place. | | [Netlify](/docs/publishing/netlify.qmd) | Professional web publishing platform. Use Netlify when you want support for custom domains, authentication, previewing branches, and other more advanced capabilities. | | [Confluence](/docs/publishing/confluence.qmd) | Publishing platform for supporting team collaboration. Use Confluence to share documents in team Spaces. | | [Other Services](/docs/publishing/other.qmd) | Content rendered with Quarto uses standard formats (HTML, PDFs, MS Word, etc.) that can be published anywhere. Use this if none of the methods above meets your requirements. | diff --git a/docs/publishing/posit-cloud.qmd b/docs/publishing/posit-cloud.qmd index 925ee06498..f74e4f5f89 100644 --- a/docs/publishing/posit-cloud.qmd +++ b/docs/publishing/posit-cloud.qmd @@ -4,7 +4,7 @@ editor: visual heading-pad: '#' --- -{{< include /docs/prerelease/1.4/_pre-release-feature.qmd >}} +{{< include /docs/_require-1.4.qmd >}} ## Overview From 2d0451619802e650c50a2b87f452bd11172d53e4 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Wed, 13 Dec 2023 09:48:30 +1300 Subject: [PATCH 04/29] Add Typst Reference Pages --- _quarto.yml | 2 + docs/reference/cells/cells-jupyter.json | 156 +++++-- docs/reference/cells/cells-knitr.json | 316 +++++++++++---- docs/reference/cells/cells-ojs.json | 181 +++++++-- docs/reference/formats/asciidoc.json | 16 +- docs/reference/formats/context.json | 16 +- docs/reference/formats/dashboards.json | 1 + docs/reference/formats/docbook.json | 14 +- docs/reference/formats/docx.json | 30 +- docs/reference/formats/epub.json | 10 +- docs/reference/formats/fb2.json | 16 +- docs/reference/formats/haddock.json | 16 +- docs/reference/formats/html.json | 42 +- docs/reference/formats/icml.json | 16 +- docs/reference/formats/ipynb.json | 16 +- docs/reference/formats/jats.json | 28 +- docs/reference/formats/man.json | 16 +- .../formats/markdown/commonmark.json | 16 +- docs/reference/formats/markdown/gfm.json | 16 +- docs/reference/formats/markdown/markua.json | 16 +- docs/reference/formats/ms.json | 16 +- docs/reference/formats/muse.json | 16 +- docs/reference/formats/odt.json | 32 +- docs/reference/formats/opml.json | 16 +- docs/reference/formats/org.json | 16 +- docs/reference/formats/pdf.json | 18 +- .../formats/presentations/beamer.json | 24 +- .../reference/formats/presentations/pptx.json | 18 +- .../formats/presentations/revealjs.json | 34 +- docs/reference/formats/rst.json | 16 +- docs/reference/formats/rtf.json | 16 +- docs/reference/formats/tei.json | 16 +- docs/reference/formats/texinfo.json | 16 +- docs/reference/formats/textile.json | 16 +- docs/reference/formats/typst.json | 381 ++++++++++++++++++ docs/reference/formats/typst.qmd | 8 + docs/reference/formats/wiki/dokuwiki.json | 16 +- docs/reference/formats/wiki/jira.json | 16 +- docs/reference/formats/wiki/mediawiki.json | 16 +- docs/reference/formats/wiki/xwiki.json | 16 +- docs/reference/formats/wiki/zimwiki.json | 16 +- docs/reference/projects/_websites.md | 1 + docs/reference/projects/book.json | 28 ++ docs/reference/projects/feed.json | 8 +- docs/reference/projects/giscus.json | 2 +- docs/reference/projects/hypothesis.json | 4 + docs/reference/projects/project.json | 2 +- docs/reference/projects/search.json | 8 + docs/reference/projects/website.json | 24 ++ docs/reference/reference.yml | 2 + 50 files changed, 1407 insertions(+), 351 deletions(-) create mode 100644 docs/reference/formats/dashboards.json create mode 100644 docs/reference/formats/typst.json create mode 100644 docs/reference/formats/typst.qmd diff --git a/_quarto.yml b/_quarto.yml index a9fa8226ff..512f4204c7 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -441,6 +441,8 @@ website: href: docs/reference/formats/pdf.qmd - text: "MS Word" href: docs/reference/formats/docx.qmd + - text: Typst + href: docs/reference/formats/typst.qmd - text: "OpenOffice" href: docs/reference/formats/odt.qmd - text: "ePub" diff --git a/docs/reference/cells/cells-jupyter.json b/docs/reference/cells/cells-jupyter.json index f1d8f6a454..0f3454d086 100644 --- a/docs/reference/cells/cells-jupyter.json +++ b/docs/reference/cells/cells-jupyter.json @@ -68,9 +68,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -138,9 +140,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -208,9 +212,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "jupyter" }, @@ -279,9 +285,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "jupyter" } @@ -356,9 +364,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -366,7 +376,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n", + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n", "formats": [ "asciidoc", "asciidoctor", @@ -429,9 +439,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -441,6 +453,7 @@ "name": "code-fold", "description": "Collapse code into an HTML `
` tag so the user can display it on-demand.\n\n- `true`: collapse code\n- `false` (default): do not collapse code\n- `show`: use the `
` tag, but show the expanded code initially.\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -461,6 +474,7 @@ "name": "code-summary", "description": "Summary text to use for code blocks collapsed using `code-fold`", "formats": [ + "dashboard", "html", "html4", "html5", @@ -481,6 +495,7 @@ "name": "code-overflow", "description": "Choose how to handle code overflow, when code lines are too wide for their container. One of:\n\n- `scroll`\n- `wrap`\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -502,6 +517,7 @@ "description": "Include line numbers in code block output (`true` or `false`).\n\nFor revealjs output only, you can also specify a string to highlight\nspecific lines (and/or animate between sets of highlighted lines).\n\n* Sets of lines are denoted with commas:\n * `3,4,5`\n * `1,10,12`\n* Ranges can be denoted with dashes and combined with commas:\n * `1-3,5` \n * `5-10,12,14`\n* Finally, animation steps are separated by `|`:\n * `1-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\n and 12\n", "formats": [ "ms", + "dashboard", "html", "html4", "html5", @@ -586,9 +602,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -656,9 +674,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] } ] @@ -732,9 +752,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -805,9 +827,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -878,9 +902,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -951,9 +977,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -1024,14 +1052,16 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "output-location", - "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- 'column': In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n", + "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- `column`: In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n", "formats": [ "revealjs" ] @@ -1107,9 +1137,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1177,9 +1209,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1247,9 +1281,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1263,6 +1299,7 @@ "latex", "pdf", "beamer", + "dashboard", "html", "html4", "html5", @@ -1283,6 +1320,7 @@ "name": "fig-alt", "description": "Alternative text to be used in the `alt` attribute of HTML images.\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -1400,9 +1438,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1470,14 +1510,44 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "tbl-colwidths", "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n", + "formats": [ + "latex", + "pdf", + "beamer", + "dashboard", + "html", + "html4", + "html5", + "slidy", + "slideous", + "s5", + "revealjs", + "dzslides", + "epub", + "epub2", + "epub3" + ], + "contexts": [ + "document-tables" + ], + "engine": [ + "knitr", + "jupyter" + ] + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process raw HTML table in cell output and leave it as-is", "formats": [ "asciidoc", "asciidoctor", @@ -1540,16 +1610,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" - ], - "contexts": [ - "document-tables" - ], - "engine": [ - "knitr", - "jupyter" + "md", + "dashboard" ] } ] @@ -1623,9 +1688,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1693,9 +1760,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1763,9 +1832,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1833,9 +1904,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1903,9 +1976,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] } ] @@ -1979,9 +2054,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -2049,9 +2126,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -2119,15 +2198,18 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "cap-location", "description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", @@ -2148,6 +2230,7 @@ "name": "fig-cap-location", "description": "Where to place figure captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", @@ -2169,6 +2252,7 @@ "name": "tbl-cap-location", "description": "Where to place table captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", diff --git a/docs/reference/cells/cells-knitr.json b/docs/reference/cells/cells-knitr.json index 1b526d1f0c..6609ab2b56 100644 --- a/docs/reference/cells/cells-knitr.json +++ b/docs/reference/cells/cells-knitr.json @@ -68,9 +68,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -138,9 +140,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] } ] @@ -214,9 +218,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -224,7 +230,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n", + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n", "formats": [ "asciidoc", "asciidoctor", @@ -287,9 +293,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -299,6 +307,7 @@ "name": "code-fold", "description": "Collapse code into an HTML `
` tag so the user can display it on-demand.\n\n- `true`: collapse code\n- `false` (default): do not collapse code\n- `show`: use the `
` tag, but show the expanded code initially.\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -319,6 +328,7 @@ "name": "code-summary", "description": "Summary text to use for code blocks collapsed using `code-fold`", "formats": [ + "dashboard", "html", "html4", "html5", @@ -339,6 +349,7 @@ "name": "code-overflow", "description": "Choose how to handle code overflow, when code lines are too wide for their container. One of:\n\n- `scroll`\n- `wrap`\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -360,6 +371,7 @@ "description": "Include line numbers in code block output (`true` or `false`).\n\nFor revealjs output only, you can also specify a string to highlight\nspecific lines (and/or animate between sets of highlighted lines).\n\n* Sets of lines are denoted with commas:\n * `3,4,5`\n * `1,10,12`\n* Ranges can be denoted with dashes and combined with commas:\n * `1-3,5` \n * `5-10,12,14`\n* Finally, animation steps are separated by `|`:\n * `1-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\n and 12\n", "formats": [ "ms", + "dashboard", "html", "html4", "html5", @@ -444,9 +456,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -514,9 +528,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -584,9 +600,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -655,9 +673,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -726,9 +746,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -797,9 +819,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -868,9 +892,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -939,9 +965,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" } @@ -1016,9 +1044,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -1089,9 +1119,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -1162,9 +1194,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -1235,9 +1269,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -1308,14 +1344,16 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "output-location", - "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- 'column': In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n", + "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- `column`: In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n", "formats": [ "revealjs" ] @@ -1385,9 +1423,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1456,9 +1496,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1527,9 +1569,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1598,9 +1642,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1669,9 +1715,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1740,9 +1788,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1811,9 +1861,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1882,9 +1934,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -1953,9 +2007,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2024,9 +2080,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2095,9 +2153,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" } @@ -2172,9 +2232,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2243,9 +2305,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2314,9 +2378,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -2384,9 +2450,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -2454,9 +2522,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -2470,6 +2540,7 @@ "latex", "pdf", "beamer", + "dashboard", "html", "html4", "html5", @@ -2490,6 +2561,7 @@ "name": "fig-alt", "description": "Alternative text to be used in the `alt` attribute of HTML images.\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -2601,9 +2673,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2672,9 +2746,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2743,9 +2819,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2814,9 +2892,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2885,9 +2965,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -2956,9 +3038,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -3027,9 +3111,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -3098,9 +3184,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -3189,9 +3277,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -3260,9 +3350,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -3331,9 +3423,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" } @@ -3408,9 +3502,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -3478,14 +3574,44 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "tbl-colwidths", "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n", + "formats": [ + "latex", + "pdf", + "beamer", + "dashboard", + "html", + "html4", + "html5", + "slidy", + "slideous", + "s5", + "revealjs", + "dzslides", + "epub", + "epub2", + "epub3" + ], + "contexts": [ + "document-tables" + ], + "engine": [ + "knitr", + "jupyter" + ] + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process raw HTML table in cell output and leave it as-is", "formats": [ "asciidoc", "asciidoctor", @@ -3548,16 +3674,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" - ], - "contexts": [ - "document-tables" - ], - "engine": [ - "knitr", - "jupyter" + "md", + "dashboard" ] } ] @@ -3631,9 +3752,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -3701,9 +3824,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -3771,9 +3896,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -3841,9 +3968,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -3911,9 +4040,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] } ] @@ -3987,9 +4118,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -4057,9 +4190,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -4127,15 +4262,18 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "cap-location", "description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", @@ -4156,6 +4294,7 @@ "name": "fig-cap-location", "description": "Where to place figure captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", @@ -4177,6 +4316,7 @@ "name": "tbl-cap-location", "description": "Where to place table captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", @@ -4265,9 +4405,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4336,9 +4478,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4407,9 +4551,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4478,9 +4624,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4549,9 +4697,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4620,9 +4770,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4691,9 +4843,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4762,9 +4916,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" } @@ -4839,9 +4995,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4910,9 +5068,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -4981,9 +5141,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" }, @@ -5052,9 +5214,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "engine": "knitr" } diff --git a/docs/reference/cells/cells-ojs.json b/docs/reference/cells/cells-ojs.json index 8261669148..4e83e14d16 100644 --- a/docs/reference/cells/cells-ojs.json +++ b/docs/reference/cells/cells-ojs.json @@ -68,9 +68,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -138,9 +140,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] } ] @@ -214,9 +218,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -224,7 +230,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n", + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n", "formats": [ "asciidoc", "asciidoctor", @@ -287,9 +293,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -299,6 +307,7 @@ "name": "code-fold", "description": "Collapse code into an HTML `
` tag so the user can display it on-demand.\n\n- `true`: collapse code\n- `false` (default): do not collapse code\n- `show`: use the `
` tag, but show the expanded code initially.\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -319,6 +328,7 @@ "name": "code-summary", "description": "Summary text to use for code blocks collapsed using `code-fold`", "formats": [ + "dashboard", "html", "html4", "html5", @@ -339,6 +349,7 @@ "name": "code-overflow", "description": "Choose how to handle code overflow, when code lines are too wide for their container. One of:\n\n- `scroll`\n- `wrap`\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -360,6 +371,7 @@ "description": "Include line numbers in code block output (`true` or `false`).\n\nFor revealjs output only, you can also specify a string to highlight\nspecific lines (and/or animate between sets of highlighted lines).\n\n* Sets of lines are denoted with commas:\n * `3,4,5`\n * `1,10,12`\n* Ranges can be denoted with dashes and combined with commas:\n * `1-3,5` \n * `5-10,12,14`\n* Finally, animation steps are separated by `|`:\n * `1-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\n and 12\n", "formats": [ "ms", + "dashboard", "html", "html4", "html5", @@ -444,9 +456,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -514,9 +528,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] } ] @@ -590,9 +606,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -663,9 +681,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -736,9 +756,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -809,9 +831,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ], "contexts": [ "document-execute" @@ -882,14 +906,16 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "output-location", - "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- 'column': In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n", + "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- `column`: In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n", "formats": [ "revealjs" ] @@ -965,9 +991,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1035,9 +1063,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1105,9 +1135,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1121,6 +1153,7 @@ "latex", "pdf", "beamer", + "dashboard", "html", "html4", "html5", @@ -1141,6 +1174,7 @@ "name": "fig-alt", "description": "Alternative text to be used in the `alt` attribute of HTML images.\n", "formats": [ + "dashboard", "html", "html4", "html5", @@ -1258,9 +1292,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1328,9 +1364,83 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" + ] + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process raw HTML table in cell output and leave it as-is", + "formats": [ + "asciidoc", + "asciidoctor", + "beamer", + "biblatex", + "bibtex", + "chunkedhtml", + "commonmark", + "commonmark_x", + "context", + "csljson", + "docbook", + "docbook4", + "docbook5", + "docx", + "dokuwiki", + "dzslides", + "epub", + "epub2", + "epub3", + "fb2", + "gfm", + "haddock", + "html", + "html4", + "html5", + "icml", + "ipynb", + "jats", + "jats_archiving", + "jats_articleauthoring", + "jats_publishing", + "jira", + "json", + "latex", + "man", + "markdown", + "markdown_github", + "markdown_mmd", + "markdown_phpextra", + "markdown_strict", + "markua", + "mediawiki", + "ms", + "muse", + "native", + "odt", + "opendocument", + "opml", + "org", + "pdf", + "plain", + "pptx", + "revealjs", + "rst", + "rtf", + "s5", + "slideous", + "slidy", + "tei", + "texinfo", + "textile", + "typst", + "xwiki", + "zimwiki", + "md", + "dashboard" ] } ] @@ -1404,9 +1514,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1474,9 +1586,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1544,9 +1658,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1614,9 +1730,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1684,9 +1802,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] } ] @@ -1760,9 +1880,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1830,9 +1952,11 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { @@ -1900,15 +2024,18 @@ "tei", "texinfo", "textile", + "typst", "xwiki", "zimwiki", - "md" + "md", + "dashboard" ] }, { "name": "cap-location", "description": "Where to place figure and table captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", @@ -1929,6 +2056,7 @@ "name": "fig-cap-location", "description": "Where to place figure captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", @@ -1950,6 +2078,7 @@ "name": "tbl-cap-location", "description": "Where to place table captions (`top`, `bottom`, or `margin`)", "formats": [ + "dashboard", "html", "html4", "html5", diff --git a/docs/reference/formats/asciidoc.json b/docs/reference/formats/asciidoc.json index fc4f733dee..7085ca516e 100644 --- a/docs/reference/formats/asciidoc.json +++ b/docs/reference/formats/asciidoc.json @@ -98,7 +98,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -156,10 +156,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -296,6 +292,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -315,6 +315,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -328,7 +332,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/context.json b/docs/reference/formats/context.json index 51183c988e..7b31f84d2f 100644 --- a/docs/reference/formats/context.json +++ b/docs/reference/formats/context.json @@ -196,7 +196,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -254,10 +254,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -406,6 +402,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -425,6 +425,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -456,7 +460,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/dashboards.json b/docs/reference/formats/dashboards.json new file mode 100644 index 0000000000..0637a088a0 --- /dev/null +++ b/docs/reference/formats/dashboards.json @@ -0,0 +1 @@ +[] \ No newline at end of file diff --git a/docs/reference/formats/docbook.json b/docs/reference/formats/docbook.json index f5539cb02c..b89a8fa2d8 100644 --- a/docs/reference/formats/docbook.json +++ b/docs/reference/formats/docbook.json @@ -88,7 +88,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -146,10 +146,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -276,6 +272,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -295,6 +295,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] } diff --git a/docs/reference/formats/docx.json b/docs/reference/formats/docx.json index e5365545f9..63bfb6cc6b 100644 --- a/docs/reference/formats/docx.json +++ b/docs/reference/formats/docx.json @@ -7,6 +7,10 @@ "name": "title", "description": "Document title" }, + { + "name": "subtitle", + "description": "Identifies the subtitle of the document." + }, { "name": "date", "description": "Document date" @@ -15,6 +19,14 @@ "name": "author", "description": "Author or authors of the document" }, + { + "name": "abstract", + "description": "Summary of document" + }, + { + "name": "abstract-title", + "description": "Title used to label document abstract" + }, { "name": "order", "description": "Order for document when included in a website automatic sidebar menu." @@ -122,7 +134,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -184,10 +196,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -270,6 +278,10 @@ "name": "metadata", "title": "Metadata", "options": [ + { + "name": "keywords", + "description": "List of keywords to be included in the document metadata." + }, { "name": "subject", "description": "The document subject" @@ -324,6 +336,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -343,6 +359,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] } diff --git a/docs/reference/formats/epub.json b/docs/reference/formats/epub.json index f34f282a43..6fa479be9a 100644 --- a/docs/reference/formats/epub.json +++ b/docs/reference/formats/epub.json @@ -250,7 +250,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -460,6 +460,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -479,6 +483,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, diff --git a/docs/reference/formats/fb2.json b/docs/reference/formats/fb2.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/fb2.json +++ b/docs/reference/formats/fb2.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/haddock.json b/docs/reference/formats/haddock.json index 8415534e50..f54bbb23e0 100644 --- a/docs/reference/formats/haddock.json +++ b/docs/reference/formats/haddock.json @@ -98,7 +98,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -156,10 +156,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -286,6 +282,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -305,6 +305,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -318,7 +322,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/html.json b/docs/reference/formats/html.json index e5755ae0f0..0b87e11f91 100644 --- a/docs/reference/formats/html.json +++ b/docs/reference/formats/html.json @@ -105,7 +105,7 @@ }, { "name": "toc-location", - "description": "Location for table of contents (`body`, `left`, or `right` (default)).\n" + "description": "Location for table of contents:\n\n- `body`: Show the Table of Contents in the center body of the document. \n- `left`: Show the Table of Contents in left margin of the document.\n- `right`(default): Show the Table of Contents in right margin of the document.\n- `left-body`: Show two Tables of Contents in both the center body and the left margin of the document.\n- `right-body`: Show two Tables of Contents in both the center body and the right margin of the document.\n" }, { "name": "toc-title", @@ -291,11 +291,11 @@ }, { "name": "code-tools", - "description": "Include a code tools menu (for hiding and showing code).\nUse `true` or `false` to enable or disable the standard code \ntools menu. Specify sub-properties `source`, `toggle`, and\n`caption` to customize the behavior and appearnce of code tools.\n" + "description": "Include a code tools menu (for hiding and showing code).\nUse `true` or `false` to enable or disable the standard code \ntools menu. Specify sub-properties `source`, `toggle`, and\n`caption` to customize the behavior and appearance of code tools.\n" }, { "name": "code-block-border-left", - "description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.=\n" + "description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.\n" }, { "name": "code-block-bg", @@ -326,7 +326,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -434,9 +434,25 @@ "name": "notebook-links", "description": "Controls the display of links to notebooks that provided embedded content or are created from documents.\n\nSpecify `false` to disable linking to source Notebooks. Specify `inline` to show links to source notebooks beneath the content they provide. \nSpecify `global` to show a set of global links to source notebooks.\n" }, + { + "name": "other-links", + "description": "A list of links that should be displayed below the table of contents in an `Other Links` section." + }, + { + "name": "code-links", + "description": "A list of links that should be displayed below the table of contents in an `Code Links` section." + }, { "name": "notebook-view", "description": "Configures the HTML viewer for notebooks that provide embedded content." + }, + { + "name": "notebook-preview-options", + "description": "Options for controlling the display and behavior of Notebook previews." + }, + { + "name": "canonical-url", + "description": "Include a canonical link tag in website pages. You may pass either `true` to \nautomatically generate a canonical link, or pass a canonical url that you'd like\nto have placed in the `href` attribute of the tag.\n\nCanonical links can only be generated for websites with a known `site-url`.\n" } ] }, @@ -552,7 +568,7 @@ }, { "name": "license", - "description": "The license for this document, if any. \n\nCreative Commons licenses `CC BY`, `CC BY-SA`, `CC BY-ND`, `CC BY-NC` will automatically generate a license link\nin the document appendix. Other license text will be placed in the appendix verbatim.\n" + "description": "The license for this document, if any. \n\nCreative Commons licenses `CC BY`, `CC BY-SA`, `CC BY-ND`, `CC BY-NC`, `CC BY-NC-SA`, and `CC BY-NC-ND` will automatically generate a license link\nin the document appendix. Other license text will be placed in the appendix verbatim.\n" }, { "name": "pagetitle", @@ -608,10 +624,6 @@ "name": "embed-resources", "description": "Produce a standalone HTML file with no external dependencies, using\n`data:` URIs to incorporate the contents of linked scripts, stylesheets,\nimages, and videos. The resulting file should be \"self-contained,\" in the\nsense that it needs no external files and no net access to be displayed\nproperly by a browser. This option works only with HTML output formats,\nincluding `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`, `slidy`,\n`slideous`, `dzslides`, and `revealjs`. Scripts, images, and stylesheets at\nabsolute URLs will be downloaded; those at relative URLs will be sought\nrelative to the working directory (if the first source\nfile is local) or relative to the base URL (if the first source\nfile is remote). Elements with the attribute\n`data-external=\"1\"` will be left alone; the documents they\nlink to will not be incorporated in the document.\nLimitation: resources that are loaded dynamically through\nJavaScript cannot be incorporated; as a result, some\nadvanced features (e.g. zoom or speaker notes) may not work\nin an offline \"self-contained\" `reveal.js` slide show.\n" }, - { - "name": "self-contained", - "description": "Produce a standalone HTML file with no external dependencies. Note that\nthis option has been deprecated in favor of `embed-resources`.\n" - }, { "name": "self-contained-math", "description": "Embed math libraries (e.g. MathJax) within `self-contained` output.\nNote that math libraries are not embedded by default because they are \n quite large and often time consuming to download.\n" @@ -636,6 +648,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -655,6 +671,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -666,6 +686,10 @@ "name": "search", "description": "Setting this to false prevents this document from being included in searches." }, + { + "name": "repo-actions", + "description": "Setting this to false prevents the `repo-actions` from appearing on this page." + }, { "name": "aliases", "description": "URLs that alias this document, when included in a website." diff --git a/docs/reference/formats/icml.json b/docs/reference/formats/icml.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/icml.json +++ b/docs/reference/formats/icml.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/ipynb.json b/docs/reference/formats/ipynb.json index 1920269254..88c22687a1 100644 --- a/docs/reference/formats/ipynb.json +++ b/docs/reference/formats/ipynb.json @@ -102,7 +102,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -160,10 +160,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -270,6 +266,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -289,6 +289,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -302,7 +306,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/jats.json b/docs/reference/formats/jats.json index 95913fd89a..58a7697890 100644 --- a/docs/reference/formats/jats.json +++ b/docs/reference/formats/jats.json @@ -112,7 +112,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -170,16 +170,22 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" } ] }, + { + "name": "links", + "title": "Links", + "options": [ + { + "name": "notebook-subarticles", + "description": "Controls the display of links to notebooks that provided embedded content or are created from documents.\n\nDefaults to `true` - specify `false` to disable embedding Notebook as subarticles with the JATS output.\n" + } + ] + }, { "name": "references", "title": "References", @@ -250,7 +256,7 @@ }, { "name": "license", - "description": "The license for this document, if any. \n\nCreative Commons licenses `CC BY`, `CC BY-SA`, `CC BY-ND`, `CC BY-NC` will automatically generate a license link\nin the document appendix. Other license text will be placed in the appendix verbatim.\n" + "description": "The license for this document, if any. \n\nCreative Commons licenses `CC BY`, `CC BY-SA`, `CC BY-ND`, `CC BY-NC`, `CC BY-NC-SA`, and `CC BY-NC-ND` will automatically generate a license link\nin the document appendix. Other license text will be placed in the appendix verbatim.\n" } ] }, @@ -302,6 +308,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -321,6 +331,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -334,7 +348,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/man.json b/docs/reference/formats/man.json index 28a1f700f1..2311adff26 100644 --- a/docs/reference/formats/man.json +++ b/docs/reference/formats/man.json @@ -98,7 +98,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -156,10 +156,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -294,6 +290,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -313,6 +313,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -326,7 +330,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/markdown/commonmark.json b/docs/reference/formats/markdown/commonmark.json index 0f33f79989..1f4d308f55 100644 --- a/docs/reference/formats/markdown/commonmark.json +++ b/docs/reference/formats/markdown/commonmark.json @@ -110,7 +110,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -168,10 +168,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -308,6 +304,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -327,6 +327,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -340,7 +344,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/markdown/gfm.json b/docs/reference/formats/markdown/gfm.json index 214f7a7c8f..bffcd2abbd 100644 --- a/docs/reference/formats/markdown/gfm.json +++ b/docs/reference/formats/markdown/gfm.json @@ -118,7 +118,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -176,10 +176,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -316,6 +312,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -335,6 +335,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -348,7 +352,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/markdown/markua.json b/docs/reference/formats/markdown/markua.json index 0f33f79989..1f4d308f55 100644 --- a/docs/reference/formats/markdown/markua.json +++ b/docs/reference/formats/markdown/markua.json @@ -110,7 +110,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -168,10 +168,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -308,6 +304,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -327,6 +327,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -340,7 +344,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/ms.json b/docs/reference/formats/ms.json index d054215d4a..a98f50c106 100644 --- a/docs/reference/formats/ms.json +++ b/docs/reference/formats/ms.json @@ -144,7 +144,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -202,10 +202,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -332,6 +328,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -351,6 +351,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -364,7 +368,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/muse.json b/docs/reference/formats/muse.json index 6ffba5c155..2598ba9ce9 100644 --- a/docs/reference/formats/muse.json +++ b/docs/reference/formats/muse.json @@ -98,7 +98,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -156,10 +156,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -296,6 +292,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -315,6 +315,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -328,7 +332,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/odt.json b/docs/reference/formats/odt.json index 81ecee887c..4969c9a8d5 100644 --- a/docs/reference/formats/odt.json +++ b/docs/reference/formats/odt.json @@ -114,7 +114,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -176,10 +176,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -258,6 +254,24 @@ } ] }, + { + "name": "metadata", + "title": "Metadata", + "options": [ + { + "name": "keywords", + "description": "List of keywords to be included in the document metadata." + }, + { + "name": "subject", + "description": "The document subject" + }, + { + "name": "description", + "description": "The document description. Some applications show this as `Comments` metadata." + } + ] + }, { "name": "render", "title": "Rendering", @@ -306,6 +320,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -325,6 +343,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] } diff --git a/docs/reference/formats/opml.json b/docs/reference/formats/opml.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/opml.json +++ b/docs/reference/formats/opml.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/org.json b/docs/reference/formats/org.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/org.json +++ b/docs/reference/formats/org.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/pdf.json b/docs/reference/formats/pdf.json index ff6a560fd2..5cd2996e03 100644 --- a/docs/reference/formats/pdf.json +++ b/docs/reference/formats/pdf.json @@ -45,6 +45,10 @@ "name": "pdf-engine-opt", "description": "Use the given string as a command-line argument to the pdf-engine.\nFor example, to use a persistent directory foo for latexmk’s auxiliary\nfiles, use `pdf-engine-opt: -outdir=foo`. Note that no check for \nduplicate options is done.\n" }, + { + "name": "beamerarticle", + "description": "Whether to produce a Beamer article from this presentation." + }, { "name": "quarto-required", "description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n" @@ -233,7 +237,7 @@ }, { "name": "papersize", - "description": "The paper size for the document." + "description": "The paper size for the document.\n" }, { "name": "grid", @@ -287,7 +291,7 @@ }, { "name": "code-block-border-left", - "description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.=\n" + "description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.\n" }, { "name": "code-block-bg", @@ -322,7 +326,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -606,6 +610,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "keep-tex", "description": "Keep the intermediate tex file used during render." @@ -629,6 +637,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, diff --git a/docs/reference/formats/presentations/beamer.json b/docs/reference/formats/presentations/beamer.json index 685f2f84f6..f539bae73f 100644 --- a/docs/reference/formats/presentations/beamer.json +++ b/docs/reference/formats/presentations/beamer.json @@ -53,10 +53,6 @@ "name": "pdf-engine-opt", "description": "Use the given string as a command-line argument to the pdf-engine.\nFor example, to use a persistent directory foo for latexmk’s auxiliary\nfiles, use `pdf-engine-opt: -outdir=foo`. Note that no check for \nduplicate options is done.\n" }, - { - "name": "beamerarticle", - "description": "Whether to produce a Beamer article from this presentation." - }, { "name": "beameroption", "description": "Add an extra Beamer option using `\\setbeameroption{}`." @@ -67,7 +63,7 @@ }, { "name": "logo", - "description": "The logo image for slides." + "description": "The logo image." }, { "name": "titlegraphic", @@ -115,10 +111,6 @@ "name": "toc", "description": "Include an automatically generated table of contents (or, in\nthe case of `latex`, `context`, `docx`, `odt`,\n`opendocument`, `rst`, or `ms`, an instruction to create\none) in the output document. This option has no effect\nif `standalone` is `false`.\n\nNote that if you are producing a PDF via `ms`, the table\nof contents will appear at the beginning of the\ndocument, before the title. If you would prefer it to\nbe at the end of the document, use the option\n`pdf-engine-opt: --no-toc-relocation`.\n" }, - { - "name": "toc-depth", - "description": "Specify the number of section levels to include in the table of contents.\nThe default is 3\n" - }, { "name": "toc-title", "description": "The title used for the table of contents." @@ -303,7 +295,7 @@ }, { "name": "papersize", - "description": "The paper size for the document." + "description": "The paper size for the document.\n" }, { "name": "grid", @@ -357,7 +349,7 @@ }, { "name": "code-block-border-left", - "description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.=\n" + "description": "Specifies to apply a left border on code blocks. Provide a hex color to specify that the border is\nenabled as well as the color of the border.\n" }, { "name": "code-block-bg", @@ -392,7 +384,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -672,6 +664,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "keep-tex", "description": "Keep the intermediate tex file used during render." @@ -695,6 +691,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, diff --git a/docs/reference/formats/presentations/pptx.json b/docs/reference/formats/presentations/pptx.json index 3a348a951d..ffa04adc59 100644 --- a/docs/reference/formats/presentations/pptx.json +++ b/docs/reference/formats/presentations/pptx.json @@ -116,7 +116,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -174,10 +174,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -248,6 +244,10 @@ "name": "metadata", "title": "Metadata", "options": [ + { + "name": "keywords", + "description": "List of keywords to be included in the document metadata." + }, { "name": "subject", "description": "The document subject" @@ -302,6 +302,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -321,6 +325,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] } diff --git a/docs/reference/formats/presentations/revealjs.json b/docs/reference/formats/presentations/revealjs.json index f09a0e276b..c36a81733f 100644 --- a/docs/reference/formats/presentations/revealjs.json +++ b/docs/reference/formats/presentations/revealjs.json @@ -41,10 +41,6 @@ "name": "css", "description": "One or more CSS style sheets." }, - { - "name": "section-divs", - "description": "Wrap sections in `
` tags and attach identifiers to the enclosing `
`\nrather than the heading itself.\n" - }, { "name": "identifier-prefix", "description": "Specify a prefix to be added to all identifiers and internal links in HTML and\nDocBook output, and to footnote numbers in Markdown and Haddock output. \nThis is useful for preventing duplicate identifiers when generating fragments\nto be included in other pages.\n" @@ -167,7 +163,7 @@ }, { "name": "output-location", - "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- 'column': In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n" + "description": "Location of output relative to the code that generated it. The possible values are as follows:\n\n- `default`: Normal flow of the slide after the code\n- `fragment`: In a fragment (not visible until you advance)\n- `slide`: On a new slide after the curent one\n- `column`: In an adjacent column \n- `column-fragment`: In an adjacent column (not visible until you advance)\n\nNote that this option is supported only for the `revealjs` format.\n" } ] }, @@ -349,6 +345,10 @@ "name": "reveal-print", "title": "Print to PDF", "options": [ + { + "name": "pdf-max-pages-per-slide", + "description": "Slides that are too tall to fit within a single page will expand onto multiple pages. You can limit how many pages a slide may expand to using this option.\n" + }, { "name": "pdf-separate-fragments", "description": "Prints each fragment on a separate slide" @@ -419,7 +419,7 @@ }, { "name": "margin", - "description": "Factor of the display size that should remain empty around the content" + "description": "For `revealjs`, the factor of the display size that should remain empty around the content (e.g. 0.1).\n\nFor `typst`, a dictionary with the fields defined in the Typst documentation:\n`x`, `y`, `top`, `bottom`, `left`, `right` (margins are specified in `cm` units,\ne.g. `5cm`).\n" }, { "name": "min-scale", @@ -436,6 +436,10 @@ { "name": "disable-layout", "description": "Disables the default reveal.js slide layout (scaling and centering)\n" + }, + { + "name": "code-block-height", + "description": "Sets the maximum height for source code blocks that appear in the presentation.\n" } ] }, @@ -511,7 +515,7 @@ }, { "name": "code-link", - "description": "Enables hyper-linking of functions within code blocks \nto their online documentation.\n\nCode linking is currently implemented only for the knitr engine \n(via the [downlit](https://downlit.r-lib.org/) package).\n" + "description": "Enables hyper-linking of functions within code blocks \nto their online documentation.\n\nCode linking is currently implemented only for the knitr engine \n(via the [downlit](https://downlit.r-lib.org/) package). \nA limitation of downlit currently prevents code linking \nif `code-line-numbers` is also `true`.\n" }, { "name": "code-annotations", @@ -542,7 +546,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -800,10 +804,6 @@ "name": "embed-resources", "description": "Produce a standalone HTML file with no external dependencies, using\n`data:` URIs to incorporate the contents of linked scripts, stylesheets,\nimages, and videos. The resulting file should be \"self-contained,\" in the\nsense that it needs no external files and no net access to be displayed\nproperly by a browser. This option works only with HTML output formats,\nincluding `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`, `slidy`,\n`slideous`, `dzslides`, and `revealjs`. Scripts, images, and stylesheets at\nabsolute URLs will be downloaded; those at relative URLs will be sought\nrelative to the working directory (if the first source\nfile is local) or relative to the base URL (if the first source\nfile is remote). Elements with the attribute\n`data-external=\"1\"` will be left alone; the documents they\nlink to will not be incorporated in the document.\nLimitation: resources that are loaded dynamically through\nJavaScript cannot be incorporated; as a result, some\nadvanced features (e.g. zoom or speaker notes) may not work\nin an offline \"self-contained\" `reveal.js` slide show.\n" }, - { - "name": "self-contained", - "description": "Produce a standalone HTML file with no external dependencies. Note that\nthis option has been deprecated in favor of `embed-resources`.\n" - }, { "name": "self-contained-math", "description": "Embed math libraries (e.g. MathJax) within `self-contained` output.\nNote that math libraries are not embedded by default because they are \n quite large and often time consuming to download.\n" @@ -828,6 +828,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -847,6 +851,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -869,7 +877,7 @@ "title": "Library", "options": [ { - "name": "reveal-js-url", + "name": "revealjs-url", "description": "Directory containing reveal.js files." } ] diff --git a/docs/reference/formats/rst.json b/docs/reference/formats/rst.json index 41eddcf5e8..513a3cf5a0 100644 --- a/docs/reference/formats/rst.json +++ b/docs/reference/formats/rst.json @@ -104,7 +104,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -162,10 +162,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -292,6 +288,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -311,6 +311,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -324,7 +328,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/rtf.json b/docs/reference/formats/rtf.json index 91eed52b33..703c704aa0 100644 --- a/docs/reference/formats/rtf.json +++ b/docs/reference/formats/rtf.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -156,10 +156,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -286,6 +282,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -305,6 +305,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -318,7 +322,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/tei.json b/docs/reference/formats/tei.json index dbff89926b..1902a25090 100644 --- a/docs/reference/formats/tei.json +++ b/docs/reference/formats/tei.json @@ -98,7 +98,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -156,10 +156,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -286,6 +282,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -305,6 +305,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -318,7 +322,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/texinfo.json b/docs/reference/formats/texinfo.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/texinfo.json +++ b/docs/reference/formats/texinfo.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/textile.json b/docs/reference/formats/textile.json index 36e2d51343..0046b3b00a 100644 --- a/docs/reference/formats/textile.json +++ b/docs/reference/formats/textile.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/typst.json b/docs/reference/formats/typst.json new file mode 100644 index 0000000000..22125d6a9f --- /dev/null +++ b/docs/reference/formats/typst.json @@ -0,0 +1,381 @@ +[ + { + "name": "attributes", + "title": "Title & Author", + "options": [ + { + "name": "title", + "description": "Document title" + }, + { + "name": "date", + "description": "Document date" + }, + { + "name": "author", + "description": "Author or authors of the document" + }, + { + "name": "order", + "description": "Order for document when included in a website automatic sidebar menu." + } + ] + }, + { + "name": "options", + "title": "Format Options", + "options": [ + { + "name": "quarto-required", + "description": "A semver version range describing the supported quarto versions for this document\nor project.\n\nExamples:\n\n- `>= 1.1.0`: Require at least quarto version 1.1\n- `1.*`: Require any quarto versions whose major version number is 1\n" + } + ] + }, + { + "name": "toc", + "title": "Table of Contents", + "options": [ + { + "name": "toc", + "description": "Include an automatically generated table of contents (or, in\nthe case of `latex`, `context`, `docx`, `odt`,\n`opendocument`, `rst`, or `ms`, an instruction to create\none) in the output document. This option has no effect\nif `standalone` is `false`.\n\nNote that if you are producing a PDF via `ms`, the table\nof contents will appear at the beginning of the\ndocument, before the title. If you would prefer it to\nbe at the end of the document, use the option\n`pdf-engine-opt: --no-toc-relocation`.\n" + }, + { + "name": "toc-depth", + "description": "Specify the number of section levels to include in the table of contents.\nThe default is 3\n" + } + ] + }, + { + "name": "numbering", + "title": "Numbering", + "options": [ + { + "name": "number-sections", + "description": "Number section headings rendered output. By default, sections are not numbered.\nSections with class `.unnumbered` will never be numbered, even if `number-sections`\nis specified.\n" + }, + { + "name": "number-offset", + "description": "Offset for section headings in output (offsets are 0 by default)\nThe first number is added to the section number for\ntop-level headings, the second for second-level headings, and so on.\nSo, for example, if you want the first top-level heading in your\ndocument to be numbered \"6\", specify `number-offset: 5`. If your\ndocument starts with a level-2 heading which you want to be numbered\n\"1.5\", specify `number-offset: [1,4]`. Implies `number-sections`\n" + }, + { + "name": "section-numbering", + "description": "Schema to use for numbering sections, e.g. `1.A.1`" + }, + { + "name": "shift-heading-level-by", + "description": "Shift heading levels by a positive or negative integer.\nFor example, with `shift-heading-level-by: -1`, level 2\nheadings become level 1 headings, and level 3 headings\nbecome level 2 headings. Headings cannot have a level\nless than 1, so a heading that would be shifted below level 1\nbecomes a regular paragraph. Exception: with a shift of -N,\na level-N heading at the beginning of the document\nreplaces the metadata title.\n" + } + ] + }, + { + "name": "reveal-layout", + "title": "Slide Layout", + "options": [ + { + "name": "margin", + "description": "For `revealjs`, the factor of the display size that should remain empty around the content (e.g. 0.1).\n\nFor `typst`, a dictionary with the fields defined in the Typst documentation:\n`x`, `y`, `top`, `bottom`, `left`, `right` (margins are specified in `cm` units,\ne.g. `5cm`).\n" + } + ] + }, + { + "name": "fonts", + "title": "Fonts", + "options": [ + { + "name": "mainfont", + "description": "For HTML output, sets the CSS `font-family` on the HTML element.\n\nFor LaTeX output, the main font family for use with `xelatex` or \n`lualatex`. Takes the name of any system font, using the\n[`fontspec`](https://ctan.org/pkg/fontspec) package. \n\nFor ConTeXt output, the main font family. Use the name of any \nsystem font. See [ConTeXt Fonts](https://wiki.contextgarden.net/Fonts) for more\ninformation.\n" + }, + { + "name": "fontsize", + "description": "For HTML output, sets the base CSS `font-size` property.\n\nFor LaTeX and ConTeXt output, sets the font size for the document body text.\n" + }, + { + "name": "font-paths", + "description": "Locally, Typst uses installed system fonts. In addition, some custom path \ncan be specified to add directories that should be scanned for fonts.\nSetting this configuration will take precedence over any path set in TYPST_FONT_PATHS environment variable.\n" + } + ] + }, + { + "name": "layout", + "title": "Layout", + "options": [ + { + "name": "papersize", + "description": "The paper size for the document.\n" + }, + { + "name": "grid", + "description": "Properties of the grid system used to layout Quarto HTML pages." + } + ] + }, + { + "name": "code", + "title": "Code", + "options": [ + { + "name": "code-annotations", + "description": "The style to use when displaying code annotations. Set this value\nto false to hide code annotations.\n" + } + ] + }, + { + "name": "execute", + "title": "Execution", + "description": "Execution options should be specified within the `execute` key. For example:\n\n```yaml\nexecute:\n echo: false\n warning: false\n```\n", + "options": [ + { + "name": "eval", + "description": "Evaluate code cells (if `false` just echos the code into output).\n\n- `true` (default): evaluate code cell\n- `false`: don't evaluate code cell\n- `[...]`: A list of positive or negative line numbers to selectively include or exclude lines \n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + }, + { + "name": "echo", + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + }, + { + "name": "output", + "description": "Include the results of executing the code in the output. Possible values:\n\n- `true`: Include results.\n- `false`: Do not include results.\n- `asis`: Treat output as raw markdown with no enclosing containers.\n" + }, + { + "name": "warning", + "description": "Include warnings in rendered output." + }, + { + "name": "error", + "description": "Include errors in the output (note that this implies that errors executing code\nwill not halt processing of the document).\n" + }, + { + "name": "include", + "description": "Catch all for preventing any output (code or results) from being included in output.\n" + }, + { + "name": "cache", + "description": "Cache results of computations (using the [knitr cache](https://yihui.org/knitr/demo/cache/) \nfor R documents, and [Jupyter Cache](https://jupyter-cache.readthedocs.io/en/latest/) \nfor Jupyter documents).\n\nNote that cache invalidation is triggered by changes in chunk source code \n(or other cache attributes you've defined). \n\n- `true`: Cache results\n- `false`: Do not cache results\n- `refresh`: Force a refresh of the cache even if has not been otherwise invalidated.\n" + }, + { + "name": "freeze", + "description": "Control the re-use of previous computational output when rendering.\n\n- `true`: Never recompute previously generated computational output during a global project render\n- `false` (default): Recompute previously generated computational output\n- `auto`: Re-compute previously generated computational output only in case their source file changes\n" + } + ] + }, + { + "name": "figures", + "title": "Figures", + "options": [ + { + "name": "fig-width", + "description": "Default width for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n" + }, + { + "name": "fig-height", + "description": "Default height for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n" + }, + { + "name": "fig-format", + "description": "Default format for figures generated by Matplotlib or R graphics (`retina`, `png`, `jpeg`, `svg`, or `pdf`)" + }, + { + "name": "fig-dpi", + "description": "Default DPI for figures generated by Matplotlib or R graphics.\n\nNote that with the Jupyter engine, this option has no effect when\nprovided at the cell level; it can only be provided with\ndocument or project metadata.\n" + }, + { + "name": "fig-asp", + "description": "The aspect ratio of the plot, i.e., the ratio of height/width. When `fig-asp` is specified,\nthe height of a plot (the option `fig-height`) is calculated from `fig-width * fig-asp`.\n\nThe `fig-asp` option is only available within the knitr engine.\n" + } + ] + }, + { + "name": "tables", + "title": "Tables", + "options": [ + { + "name": "df-print", + "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" + } + ] + }, + { + "name": "references", + "title": "References", + "options": [ + { + "name": "bibliography", + "description": "Document bibliography (BibTeX or CSL). May be a single file or a list of files\n" + }, + { + "name": "csl", + "description": "Citation Style Language file to use for formatting references." + }, + { + "name": "citeproc", + "description": "Turn on built-in citation processing. To use this feature, you will need\nto have a document containing citations and a source of bibliographic data: \neither an external bibliography file or a list of `references` in the \ndocument's YAML metadata. You can optionally also include a `csl` \ncitation style file.\n" + }, + { + "name": "bibliographystyle", + "description": "The bibliography style to use (e.g. `#set bibliography(style: \"apa\")`) when using typst built-in citation system (e.g when not `citeproc: true`)." + }, + { + "name": "citation-abbreviations", + "description": "JSON file containing abbreviations of journals that should be\nused in formatted bibliographies when `form=\"short\"` is\nspecified. The format of the file can be illustrated with an\nexample:\n\n```json\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" + } + ] + }, + { + "name": "citation", + "title": "Citation", + "options": [ + { + "name": "citation", + "description": "Citation information for the document itself specified as [CSL](https://docs.citationstyles.org/en/stable/specification.html) \nYAML in the document front matter.\n\nFor more on supported options, see [Citation Metadata](https://quarto.org/docs/reference/metadata/citation.html).\n" + } + ] + }, + { + "name": "language", + "title": "Language", + "options": [ + { + "name": "lang", + "description": "Identifies the main language of the document using IETF language tags \n(following the [BCP 47](https://www.rfc-editor.org/info/bcp47) standard), \nsuch as `en` or `en-GB`. The [Language subtag lookup](https://r12a.github.io/app-subtags/) \ntool can look up or verify these tags. \n\nThis affects most formats, and controls hyphenation \nin PDF output when using LaTeX (through [`babel`](https://ctan.org/pkg/babel) \nand [`polyglossia`](https://ctan.org/pkg/polyglossia)) or ConTeXt.\n" + }, + { + "name": "language", + "description": "YAML file containing custom language translations" + }, + { + "name": "dir", + "description": "The base script direction for the document (`rtl` or `ltr`).\n\nFor bidirectional documents, native pandoc `span`s and\n`div`s with the `dir` attribute can\nbe used to override the base direction in some output\nformats. This may not always be necessary if the final\nrenderer (e.g. the browser, when generating HTML) supports\nthe [Unicode Bidirectional Algorithm].\n\nWhen using LaTeX for bidirectional documents, only the\n`xelatex` engine is fully supported (use\n`--pdf-engine=xelatex`).\n" + } + ] + }, + { + "name": "includes", + "title": "Includes", + "options": [ + { + "name": "include-before-body", + "description": "Include contents at the beginning of the document body\n(e.g. after the `` tag in HTML, or the `\\begin{document}` command\nin LaTeX).\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n" + }, + { + "name": "include-after-body", + "description": "Include 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.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n" + }, + { + "name": "include-in-header", + "description": "Include contents at the end of the header. This can\nbe used, for example, to include special CSS or JavaScript in HTML\ndocuments.\n\nA string value or an object with key \"file\" indicates a filename whose contents are to be included\n\nAn object with key \"text\" indicates textual content to be included\n" + }, + { + "name": "metadata-files", + "description": "Read metadata from the supplied YAML (or JSON) files. This\noption can be used with every input format, but string scalars\nin the YAML file will always be parsed as Markdown. Generally,\nthe input will be handled the same as in YAML metadata blocks.\nValues in files specified later in the list will be preferred\nover those specified earlier. Metadata values specified inside\nthe document, or by using `-M`, overwrite values specified with\nthis option.\n" + } + ] + }, + { + "name": "render", + "title": "Rendering", + "options": [ + { + "name": "from", + "description": "Format to read from. Extensions can be individually enabled or disabled by appending +EXTENSION or -EXTENSION to the format name (e.g. markdown+emoji).\n" + }, + { + "name": "output-file", + "description": "Output file to write to" + }, + { + "name": "output-ext", + "description": "Extension to use for generated output file\n" + }, + { + "name": "template", + "description": "Use the specified file as a custom template for the generated document.\n" + }, + { + "name": "template-partials", + "description": "Include the specified files as partials accessible to the template for the generated content.\n" + }, + { + "name": "standalone", + "description": "Produce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment)\n" + }, + { + "name": "filters", + "description": "Specify executables or Lua scripts to be used as a filter transforming\nthe pandoc AST after the input is parsed and before the output is written.\n" + }, + { + "name": "shortcodes", + "description": "Specify Lua scripts that implement shortcode handlers\n" + }, + { + "name": "keep-md", + "description": "Keep the markdown file generated by executing code" + }, + { + "name": "keep-ipynb", + "description": "Keep the notebook file generated from executing code." + }, + { + "name": "ipynb-filters", + "description": "Filters to pre-process ipynb files before rendering to markdown" + }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, + { + "name": "keep-typ", + "description": "Keep the intermediate typst file used during render." + }, + { + "name": "extract-media", + "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" + }, + { + "name": "resource-path", + "description": "List of paths to search for images and other resources.\n" + }, + { + "name": "default-image-extension", + "description": "Specify a default extension to use when image paths/URLs have no\nextension. This allows you to use the same source for formats that\nrequire different kinds of images. Currently this option only affects\nthe Markdown and LaTeX readers.\n" + }, + { + "name": "abbreviations", + "description": "Specifies a custom abbreviations file, with abbreviations one to a line.\nThis list is used when reading Markdown input: strings found in this list\nwill be followed by a nonbreaking space, and the period will not produce sentence-ending space in formats like LaTeX. The strings may not contain\nspaces.\n" + }, + { + "name": "dpi", + "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." + } + ] + }, + { + "name": "text", + "title": "Text Output", + "options": [ + { + "name": "wrap", + "description": "Determine how text is wrapped in the output (the source code, not the rendered\nversion). \n\n- `auto` (default): Pandoc will attempt to wrap lines to the column width specified by `columns` (default 72). \n- `none`: Pandoc will not wrap lines at all. \n- `preserve`: Pandoc will attempt to preserve the wrapping from the source\n document. Where there are nonsemantic newlines in the source, there will be\n nonsemantic newlines in the output as well.\n" + }, + { + "name": "columns", + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" + }, + { + "name": "tab-stop", + "description": "Specify the number of spaces per tab (default is 4). Note that tabs\nwithin normal textual input are always converted to spaces. Tabs \nwithin code are also converted, however this can be disabled with\n`preserve-tabs: false`.\n" + }, + { + "name": "preserve-tabs", + "description": "Preserve tabs within code instead of converting them to spaces.\n(By default, pandoc converts tabs to spaces before parsing its input.) \nNote that this will only affect tabs in literal code spans and code blocks. \nTabs in regular text are always treated as spaces.\n" + }, + { + "name": "eol", + "description": "Manually specify line endings: \n\n- `crlf`: Use Windows line endings\n- `lf`: Use macOS/Linux/UNIX line endings\n- `native` (default): Use line endings appropriate to the OS on which pandoc is being run).\n" + } + ] + } +] \ No newline at end of file diff --git a/docs/reference/formats/typst.qmd b/docs/reference/formats/typst.qmd new file mode 100644 index 0000000000..21df4583f4 --- /dev/null +++ b/docs/reference/formats/typst.qmd @@ -0,0 +1,8 @@ +--- +title: "Typst Options" +spec: https://typst.app/docs/ +--- + +[Typst](https://github.com/typst/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. Typst creates beautiful PDF output with blazing fast render times. + +See the Typst format [user guide](../../output-formats/typst-basics.qmd) for more details on creating Typst output with Quarto. diff --git a/docs/reference/formats/wiki/dokuwiki.json b/docs/reference/formats/wiki/dokuwiki.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/wiki/dokuwiki.json +++ b/docs/reference/formats/wiki/dokuwiki.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/wiki/jira.json b/docs/reference/formats/wiki/jira.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/wiki/jira.json +++ b/docs/reference/formats/wiki/jira.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/wiki/mediawiki.json b/docs/reference/formats/wiki/mediawiki.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/wiki/mediawiki.json +++ b/docs/reference/formats/wiki/mediawiki.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/wiki/xwiki.json b/docs/reference/formats/wiki/xwiki.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/wiki/xwiki.json +++ b/docs/reference/formats/wiki/xwiki.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/formats/wiki/zimwiki.json b/docs/reference/formats/wiki/zimwiki.json index 1a1f8d484f..0bebe421c1 100644 --- a/docs/reference/formats/wiki/zimwiki.json +++ b/docs/reference/formats/wiki/zimwiki.json @@ -94,7 +94,7 @@ }, { "name": "echo", - "description": "Include cell source code in rendered output.\n\n- `true` (default): include source code in output\n- `false`: do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" + "description": "Include cell source code in rendered output.\n\n- `true` (default in most formats): include source code in output\n- `false` (default in presentation formats like `beamer`, `revealjs`, and `pptx`): do not include source code in output\n- `fenced`: 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\n (explicit inclusion/excusion of lines is available only when using the knitr engine)\n" }, { "name": "output", @@ -152,10 +152,6 @@ "name": "tables", "title": "Tables", "options": [ - { - "name": "tbl-colwidths", - "description": "Apply explicit table column widths for markdown grid tables and pipe\ntables that are more than `columns` characters wide (72 by default). \n\nSome formats (e.g. HTML) do an excellent job automatically sizing\ntable columns and so don't benefit much from column width specifications.\nOther formats (e.g. LaTeX) require table column sizes in order to \ncorrectly flow longer cell content (this is a major reason why tables \n> 72 columns wide are assigned explicit widths by Pandoc).\n\nThis can be specified as:\n\n- `auto`: Apply markdown table column widths except when there is a\n hyperlink in the table (which tends to throw off automatic\n calculation of column widths based on the markdown text width of cells).\n (`auto` is the default for HTML output formats)\n\n- `true`: Always apply markdown table widths (`true` is the default\n for all non-HTML formats)\n\n- `false`: Never apply markdown table widths.\n\n- An array of numbers (e.g. `[40, 30, 30]`): Array of explicit width percentages.\n" - }, { "name": "df-print", "description": "Method used to print tables in Knitr engine documents:\n\n- `default`: Use the default S3 method for the data frame.\n- `kable`: Markdown table using the `knitr::kable()` function.\n- `tibble`: Plain text table using the `tibble` package.\n- `paged`: HTML table with paging for row and column overflow.\n\nThe default printing method is `kable`.\n" @@ -282,6 +278,10 @@ "name": "ipynb-filters", "description": "Filters to pre-process ipynb files before rendering to markdown" }, + { + "name": "ipynb-shell-interactivity", + "description": "Specify which nodes should be run interactively (displaying output from expressions)\n" + }, { "name": "extract-media", "description": "Extract images and other media contained in or linked from the source document to the\npath DIR, creating it if necessary, and adjust the images references in the document\nso they point to the extracted files. Media are downloaded, read from the file\nsystem, or extracted from a binary container (e.g. docx), as needed. The original\nfile paths are used if they are relative paths not containing ... Otherwise filenames\nare constructed from the SHA1 hash of the contents.\n" @@ -301,6 +301,10 @@ { "name": "dpi", "description": "Specify the default dpi (dots per inch) value for conversion from pixels to inch/\ncentimeters and vice versa. (Technically, the correct term would be ppi: pixels per\ninch.) The default is `96`. When images contain information about dpi internally, the\nencoded value is used instead of the default specified by this option.\n" + }, + { + "name": "html-table-processing", + "description": "If `none`, do not process tables in HTML input." } ] }, @@ -314,7 +318,7 @@ }, { "name": "columns", - "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables.\n" + "description": "Specify length of lines in characters. This affects text wrapping in generated source\ncode (see `wrap`). It also affects calculation of column widths for plain text\ntables. \n\nFor `typst`, number of columns for body text.\n" }, { "name": "tab-stop", diff --git a/docs/reference/projects/_websites.md b/docs/reference/projects/_websites.md index 225d67160b..bcb0c4cf94 100644 --- a/docs/reference/projects/_websites.md +++ b/docs/reference/projects/_websites.md @@ -91,6 +91,7 @@ Action buttons that appear on the sidebar. For example: Search options are specified under the `search` key of `{{< meta project-type >}}`. For example: ``` yaml +--- {{< meta project-type >}}: search: location: navbar diff --git a/docs/reference/projects/book.json b/docs/reference/projects/book.json index 5b501d06fe..7920111c35 100644 --- a/docs/reference/projects/book.json +++ b/docs/reference/projects/book.json @@ -211,6 +211,10 @@ "name": "host", "description": "Host of the item (e.g. of a TV show or podcast)." }, + { + "name": "id", + "description": "A value which uniquely identifies this item." + }, { "name": "illustrator", "description": "Illustrator (e.g. of a children’s book or graphic novel)." @@ -455,6 +459,14 @@ "name": "repo-url", "description": "Base URL for website source code repository" }, + { + "name": "repo-link-target", + "description": "The value of the target attribute for repo links" + }, + { + "name": "repo-link-rel", + "description": "The value of the rel attribute for repo links" + }, { "name": "repo-subdir", "description": "Subdirectory of repository containing website" @@ -519,6 +531,10 @@ "name": "back-to-top-navigation", "description": "Provide a 'back to top' navigation button" }, + { + "name": "bread-crumbs", + "description": "Whether to show navigation breadcrumbs for pages more than 1 level deep" + }, { "name": "page-footer", "description": "Page footer. Text content or [page footer](#page-footer) definition." @@ -527,6 +543,10 @@ "name": "image", "description": "Default site thumbnail image for `twitter` /`open-graph`\n" }, + { + "name": "image-alt", + "description": "Default site thumbnail image alt text for `twitter` /`open-graph`\n" + }, { "name": "comments", "description": "" @@ -538,5 +558,13 @@ { "name": "twitter-card", "description": "Generate Twitter Card metadata (see [Twitter Card](#twitter-card) options)" + }, + { + "name": "other-links", + "description": "A list of other links to appear below the TOC." + }, + { + "name": "code-links", + "description": "A list of code links to appear with this document." } ] \ No newline at end of file diff --git a/docs/reference/projects/feed.json b/docs/reference/projects/feed.json index 9eb25e59fa..7238ad7724 100644 --- a/docs/reference/projects/feed.json +++ b/docs/reference/projects/feed.json @@ -5,7 +5,7 @@ }, { "name": "type", - "description": "Whether to include full or partial content in the feed.\n\n- `full` (default): Include the complete content of the document in the feed.\n- `partial`: Include only the first paragraph of the document in the feed.\n" + "description": "Whether to include full or partial content in the feed.\n\n- `full` (default): Include the complete content of the document in the feed.\n- `partial`: Include only the first paragraph of the document in the feed.\n- `metadata`: Use only the title, description, and other document metadata in the feed.\n" }, { "name": "title", @@ -25,6 +25,10 @@ }, { "name": "categories", - "description": "A list of categories for which to create separate RSS feeds containing only posts with that category." + "description": "A list of categories for which to create separate RSS feeds containing only posts with that category" + }, + { + "name": "xml-stylesheet", + "description": "The path to an XML stylesheet (XSL file) used to style the RSS feed." } ] \ No newline at end of file diff --git a/docs/reference/projects/giscus.json b/docs/reference/projects/giscus.json index 3fbedef98e..6236414eaf 100644 --- a/docs/reference/projects/giscus.json +++ b/docs/reference/projects/giscus.json @@ -33,7 +33,7 @@ }, { "name": "theme", - "description": "The giscus theme to use when displaying comments." + "description": "The light theme name." }, { "name": "language", diff --git a/docs/reference/projects/hypothesis.json b/docs/reference/projects/hypothesis.json index a6592a8437..0a590b3969 100644 --- a/docs/reference/projects/hypothesis.json +++ b/docs/reference/projects/hypothesis.json @@ -1,4 +1,8 @@ [ + { + "name": "client-url", + "description": "Override the default hypothesis client url with a custom client url." + }, { "name": "openSidebar", "description": "Controls whether the sidebar opens automatically on startup." diff --git a/docs/reference/projects/project.json b/docs/reference/projects/project.json index 5774cacb7a..72fba90f20 100644 --- a/docs/reference/projects/project.json +++ b/docs/reference/projects/project.json @@ -5,7 +5,7 @@ }, { "name": "type", - "description": "Project type (`default`, `website`, or `book`)" + "description": "Project type (`default`, `website`, `book`, or `manuscript`)" }, { "name": "render", diff --git a/docs/reference/projects/search.json b/docs/reference/projects/search.json index 89d5d9023c..35f5bb5d29 100644 --- a/docs/reference/projects/search.json +++ b/docs/reference/projects/search.json @@ -19,6 +19,14 @@ "name": "copy-button", "description": "Provide button for copying search link" }, + { + "name": "keyboard-shortcut", + "description": "One or more keys that will act as a shortcut to launch search (single characters)" + }, + { + "name": "show-item-context", + "description": "Whether to include search result parents when displaying items in search results (when possible)." + }, { "name": "algolia", "description": "Use an Algolia index for site search (see [Algolia Options](#algolia-options))" diff --git a/docs/reference/projects/website.json b/docs/reference/projects/website.json index a1a3d0f8c4..fc8b5cb46c 100644 --- a/docs/reference/projects/website.json +++ b/docs/reference/projects/website.json @@ -23,6 +23,14 @@ "name": "repo-url", "description": "Base URL for website source code repository" }, + { + "name": "repo-link-target", + "description": "The value of the target attribute for repo links" + }, + { + "name": "repo-link-rel", + "description": "The value of the rel attribute for repo links" + }, { "name": "repo-subdir", "description": "Subdirectory of repository containing website" @@ -87,6 +95,10 @@ "name": "back-to-top-navigation", "description": "Provide a 'back to top' navigation button" }, + { + "name": "bread-crumbs", + "description": "Whether to show navigation breadcrumbs for pages more than 1 level deep" + }, { "name": "page-footer", "description": "Page footer. Text content or [page footer](#page-footer) definition." @@ -95,6 +107,10 @@ "name": "image", "description": "Default site thumbnail image for `twitter` /`open-graph`\n" }, + { + "name": "image-alt", + "description": "Default site thumbnail image alt text for `twitter` /`open-graph`\n" + }, { "name": "comments", "description": "" @@ -106,5 +122,13 @@ { "name": "twitter-card", "description": "Generate Twitter Card metadata (see [Twitter Card](#twitter-card) options)" + }, + { + "name": "other-links", + "description": "A list of other links to appear below the TOC." + }, + { + "name": "code-links", + "description": "A list of code links to appear with this document." } ] \ No newline at end of file diff --git a/docs/reference/reference.yml b/docs/reference/reference.yml index 41965d6198..d26b6be1c8 100644 --- a/docs/reference/reference.yml +++ b/docs/reference/reference.yml @@ -6,6 +6,8 @@ href: formats/pdf.qmd - text: MS Word href: formats/docx.qmd + - text: Typst + href: formats/typst.qmd - text: Open Office href: formats/odt.qmd - text: ePub From a366719f7ce8a1564c9cb818d9a1aa2d23912db9 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Fri, 15 Dec 2023 10:56:48 +1300 Subject: [PATCH 05/29] Add crossref to reference pages (#947) --- _quarto.yml | 2 + docs/reference/formats/asciidoc.json | 10 + docs/reference/formats/context.json | 10 + docs/reference/formats/docbook.json | 10 + docs/reference/formats/docx.json | 10 + docs/reference/formats/epub.json | 10 + docs/reference/formats/fb2.json | 10 + docs/reference/formats/haddock.json | 10 + docs/reference/formats/html.json | 14 + docs/reference/formats/icml.json | 10 + docs/reference/formats/ipynb.json | 10 + docs/reference/formats/jats.json | 10 + docs/reference/formats/man.json | 10 + .../formats/markdown/commonmark.json | 10 + docs/reference/formats/markdown/gfm.json | 10 + docs/reference/formats/markdown/markua.json | 10 + docs/reference/formats/ms.json | 10 + docs/reference/formats/muse.json | 10 + docs/reference/formats/odt.json | 10 + docs/reference/formats/opml.json | 10 + docs/reference/formats/org.json | 10 + docs/reference/formats/pdf.json | 10 + .../formats/presentations/beamer.json | 10 + .../reference/formats/presentations/pptx.json | 10 + .../formats/presentations/revealjs.json | 14 + docs/reference/formats/rst.json | 10 + docs/reference/formats/rtf.json | 10 + docs/reference/formats/tei.json | 10 + docs/reference/formats/texinfo.json | 10 + docs/reference/formats/textile.json | 10 + docs/reference/formats/typst.json | 10 + docs/reference/formats/wiki/dokuwiki.json | 10 + docs/reference/formats/wiki/jira.json | 10 + docs/reference/formats/wiki/mediawiki.json | 10 + docs/reference/formats/wiki/xwiki.json | 10 + docs/reference/formats/wiki/zimwiki.json | 10 + docs/reference/metadata/crossref.json | 247 ++++++++++++++++++ docs/reference/metadata/crossref.qmd | 13 + docs/reference/projects/book.json | 12 - docs/reference/projects/website.json | 12 - docs/reference/reference.yml | 2 + tools/reference.ts | 29 +- 42 files changed, 646 insertions(+), 29 deletions(-) create mode 100644 docs/reference/metadata/crossref.json create mode 100644 docs/reference/metadata/crossref.qmd diff --git a/_quarto.yml b/_quarto.yml index 512f4204c7..9db5182789 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -540,6 +540,8 @@ website: href: docs/reference/globs.qmd - text: "Citations" href: docs/reference/metadata/citation.qmd + - text: "Cross-References" + href: docs/reference/metadata/crossref.qmd - id: prerelease title: "Quarto 1.3" contents: diff --git a/docs/reference/formats/asciidoc.json b/docs/reference/formats/asciidoc.json index 7085ca516e..8e86f50b4d 100644 --- a/docs/reference/formats/asciidoc.json +++ b/docs/reference/formats/asciidoc.json @@ -184,6 +184,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/context.json b/docs/reference/formats/context.json index 7b31f84d2f..58c6a48384 100644 --- a/docs/reference/formats/context.json +++ b/docs/reference/formats/context.json @@ -282,6 +282,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/docbook.json b/docs/reference/formats/docbook.json index b89a8fa2d8..3eba1773ca 100644 --- a/docs/reference/formats/docbook.json +++ b/docs/reference/formats/docbook.json @@ -174,6 +174,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/docx.json b/docs/reference/formats/docx.json index 63bfb6cc6b..31a50b6977 100644 --- a/docs/reference/formats/docx.json +++ b/docs/reference/formats/docx.json @@ -236,6 +236,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/epub.json b/docs/reference/formats/epub.json index 6fa479be9a..de6b14a15b 100644 --- a/docs/reference/formats/epub.json +++ b/docs/reference/formats/epub.json @@ -348,6 +348,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/fb2.json b/docs/reference/formats/fb2.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/fb2.json +++ b/docs/reference/formats/fb2.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/haddock.json b/docs/reference/formats/haddock.json index f54bbb23e0..5902d34acf 100644 --- a/docs/reference/formats/haddock.json +++ b/docs/reference/formats/haddock.json @@ -184,6 +184,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/html.json b/docs/reference/formats/html.json index 0b87e11f91..4188bd0efc 100644 --- a/docs/reference/formats/html.json +++ b/docs/reference/formats/html.json @@ -500,6 +500,20 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + }, + { + "name": "crossrefs-hover", + "description": "Enables a hover popup for cross references that shows the item being referenced." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/icml.json b/docs/reference/formats/icml.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/icml.json +++ b/docs/reference/formats/icml.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/ipynb.json b/docs/reference/formats/ipynb.json index 88c22687a1..11b0a7e6c3 100644 --- a/docs/reference/formats/ipynb.json +++ b/docs/reference/formats/ipynb.json @@ -188,6 +188,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/jats.json b/docs/reference/formats/jats.json index 58a7697890..c788803f27 100644 --- a/docs/reference/formats/jats.json +++ b/docs/reference/formats/jats.json @@ -208,6 +208,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/man.json b/docs/reference/formats/man.json index 2311adff26..48587065c0 100644 --- a/docs/reference/formats/man.json +++ b/docs/reference/formats/man.json @@ -184,6 +184,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/markdown/commonmark.json b/docs/reference/formats/markdown/commonmark.json index 1f4d308f55..c6fef7ca66 100644 --- a/docs/reference/formats/markdown/commonmark.json +++ b/docs/reference/formats/markdown/commonmark.json @@ -206,6 +206,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/markdown/gfm.json b/docs/reference/formats/markdown/gfm.json index bffcd2abbd..4fbc3c8c24 100644 --- a/docs/reference/formats/markdown/gfm.json +++ b/docs/reference/formats/markdown/gfm.json @@ -214,6 +214,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/markdown/markua.json b/docs/reference/formats/markdown/markua.json index 1f4d308f55..c6fef7ca66 100644 --- a/docs/reference/formats/markdown/markua.json +++ b/docs/reference/formats/markdown/markua.json @@ -206,6 +206,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/ms.json b/docs/reference/formats/ms.json index a98f50c106..90f276e8d6 100644 --- a/docs/reference/formats/ms.json +++ b/docs/reference/formats/ms.json @@ -230,6 +230,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/muse.json b/docs/reference/formats/muse.json index 2598ba9ce9..94d5bd86f5 100644 --- a/docs/reference/formats/muse.json +++ b/docs/reference/formats/muse.json @@ -194,6 +194,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/odt.json b/docs/reference/formats/odt.json index 4969c9a8d5..7b37db46a6 100644 --- a/docs/reference/formats/odt.json +++ b/docs/reference/formats/odt.json @@ -204,6 +204,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/opml.json b/docs/reference/formats/opml.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/opml.json +++ b/docs/reference/formats/opml.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/org.json b/docs/reference/formats/org.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/org.json +++ b/docs/reference/formats/org.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/pdf.json b/docs/reference/formats/pdf.json index 5cd2996e03..9649d2152e 100644 --- a/docs/reference/formats/pdf.json +++ b/docs/reference/formats/pdf.json @@ -486,6 +486,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/presentations/beamer.json b/docs/reference/formats/presentations/beamer.json index f539bae73f..660fc7b774 100644 --- a/docs/reference/formats/presentations/beamer.json +++ b/docs/reference/formats/presentations/beamer.json @@ -540,6 +540,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/presentations/pptx.json b/docs/reference/formats/presentations/pptx.json index ffa04adc59..acf508bdf1 100644 --- a/docs/reference/formats/presentations/pptx.json +++ b/docs/reference/formats/presentations/pptx.json @@ -202,6 +202,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/presentations/revealjs.json b/docs/reference/formats/presentations/revealjs.json index c36a81733f..b11e1a0236 100644 --- a/docs/reference/formats/presentations/revealjs.json +++ b/docs/reference/formats/presentations/revealjs.json @@ -688,6 +688,20 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + }, + { + "name": "crossrefs-hover", + "description": "Enables a hover popup for cross references that shows the item being referenced." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/rst.json b/docs/reference/formats/rst.json index 513a3cf5a0..896fe5dbb4 100644 --- a/docs/reference/formats/rst.json +++ b/docs/reference/formats/rst.json @@ -190,6 +190,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/rtf.json b/docs/reference/formats/rtf.json index 703c704aa0..4ca0b003ed 100644 --- a/docs/reference/formats/rtf.json +++ b/docs/reference/formats/rtf.json @@ -184,6 +184,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/tei.json b/docs/reference/formats/tei.json index 1902a25090..a5484a13d8 100644 --- a/docs/reference/formats/tei.json +++ b/docs/reference/formats/tei.json @@ -184,6 +184,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/texinfo.json b/docs/reference/formats/texinfo.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/texinfo.json +++ b/docs/reference/formats/texinfo.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/textile.json b/docs/reference/formats/textile.json index 0046b3b00a..fb07f84399 100644 --- a/docs/reference/formats/textile.json +++ b/docs/reference/formats/textile.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/typst.json b/docs/reference/formats/typst.json index 22125d6a9f..90e4f39515 100644 --- a/docs/reference/formats/typst.json +++ b/docs/reference/formats/typst.json @@ -220,6 +220,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/wiki/dokuwiki.json b/docs/reference/formats/wiki/dokuwiki.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/wiki/dokuwiki.json +++ b/docs/reference/formats/wiki/dokuwiki.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/wiki/jira.json b/docs/reference/formats/wiki/jira.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/wiki/jira.json +++ b/docs/reference/formats/wiki/jira.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/wiki/mediawiki.json b/docs/reference/formats/wiki/mediawiki.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/wiki/mediawiki.json +++ b/docs/reference/formats/wiki/mediawiki.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/wiki/xwiki.json b/docs/reference/formats/wiki/xwiki.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/wiki/xwiki.json +++ b/docs/reference/formats/wiki/xwiki.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/formats/wiki/zimwiki.json b/docs/reference/formats/wiki/zimwiki.json index 0bebe421c1..1db095840b 100644 --- a/docs/reference/formats/wiki/zimwiki.json +++ b/docs/reference/formats/wiki/zimwiki.json @@ -180,6 +180,16 @@ } ] }, + { + "name": "crossref", + "title": "Cross-References", + "options": [ + { + "name": "crossref", + "description": "Configuration for crossref labels and prefixes. See [Cross-Reference Options](https://quarto.org/docs/reference/metadata/crossref.html) for more details." + } + ] + }, { "name": "citation", "title": "Citation", diff --git a/docs/reference/metadata/crossref.json b/docs/reference/metadata/crossref.json new file mode 100644 index 0000000000..c45115773c --- /dev/null +++ b/docs/reference/metadata/crossref.json @@ -0,0 +1,247 @@ +[ + { + "name": "crossref", + "title": "Crossref", + "options": [ + { + "name": "custom", + "description": "A custom cross reference type. See [Custom](#custom) for more details." + }, + { + "name": "chapters", + "description": "Use top level sections (H1) in this document as chapters." + }, + { + "name": "title-delim", + "description": "The delimiter used between the prefix and the caption." + }, + { + "name": "fig-title", + "description": "The title prefix used for figure captions." + }, + { + "name": "tbl-title", + "description": "The title prefix used for table captions." + }, + { + "name": "eq-title", + "description": "The title prefix used for equation captions." + }, + { + "name": "lst-title", + "description": "The title prefix used for listing captions." + }, + { + "name": "thm-title", + "description": "The title prefix used for theorem captions." + }, + { + "name": "lem-title", + "description": "The title prefix used for lemma captions." + }, + { + "name": "cor-title", + "description": "The title prefix used for corollary captions." + }, + { + "name": "prp-title", + "description": "The title prefix used for proposition captions." + }, + { + "name": "cnj-title", + "description": "The title prefix used for conjecture captions." + }, + { + "name": "def-title", + "description": "The title prefix used for definition captions." + }, + { + "name": "exm-title", + "description": "The title prefix used for example captions." + }, + { + "name": "exr-title", + "description": "The title prefix used for exercise captions." + }, + { + "name": "fig-prefix", + "description": "The prefix used for an inline reference to a figure." + }, + { + "name": "tbl-prefix", + "description": "The prefix used for an inline reference to a table." + }, + { + "name": "eq-prefix", + "description": "The prefix used for an inline reference to an equation." + }, + { + "name": "sec-prefix", + "description": "The prefix used for an inline reference to a section." + }, + { + "name": "lst-prefix", + "description": "The prefix used for an inline reference to a listing." + }, + { + "name": "thm-prefix", + "description": "The prefix used for an inline reference to a theorem." + }, + { + "name": "lem-prefix", + "description": "The prefix used for an inline reference to a lemma." + }, + { + "name": "cor-prefix", + "description": "The prefix used for an inline reference to a corollary." + }, + { + "name": "prp-prefix", + "description": "The prefix used for an inline reference to a proposition." + }, + { + "name": "cnj-prefix", + "description": "The prefix used for an inline reference to a conjecture." + }, + { + "name": "def-prefix", + "description": "The prefix used for an inline reference to a definition." + }, + { + "name": "exm-prefix", + "description": "The prefix used for an inline reference to an example." + }, + { + "name": "exr-prefix", + "description": "The prefix used for an inline reference to an exercise." + }, + { + "name": "fig-labels", + "description": "The numbering scheme used for figures." + }, + { + "name": "tbl-labels", + "description": "The numbering scheme used for tables." + }, + { + "name": "eq-labels", + "description": "The numbering scheme used for equations." + }, + { + "name": "sec-labels", + "description": "The numbering scheme used for sections." + }, + { + "name": "lst-labels", + "description": "The numbering scheme used for listings." + }, + { + "name": "thm-labels", + "description": "The numbering scheme used for theorems." + }, + { + "name": "lem-labels", + "description": "The numbering scheme used for lemmas." + }, + { + "name": "cor-labels", + "description": "The numbering scheme used for corollaries." + }, + { + "name": "prp-labels", + "description": "The numbering scheme used for propositions." + }, + { + "name": "cnj-labels", + "description": "The numbering scheme used for conjectures." + }, + { + "name": "def-labels", + "description": "The numbering scheme used for definitions." + }, + { + "name": "exm-labels", + "description": "The numbering scheme used for examples." + }, + { + "name": "exr-labels", + "description": "The numbering scheme used for exercises." + }, + { + "name": "lof-title", + "description": "The title used for the list of figures." + }, + { + "name": "lot-title", + "description": "The title used for the list of tables." + }, + { + "name": "lol-title", + "description": "The title used for the list of listings." + }, + { + "name": "labels", + "description": "The number scheme used for references." + }, + { + "name": "subref-labels", + "description": "The number scheme used for sub references." + }, + { + "name": "ref-hyperlink", + "description": "Whether cross references should be hyper-linked." + }, + { + "name": "appendix-title", + "description": "The title used for appendix." + }, + { + "name": "appendix-delim", + "description": "The delimiter beween appendix number and title." + } + ] + }, + { + "name": "crossref-custom", + "title": "Custom", + "description": "Use the `custom` option to `crossref` to define new types of cross reference. For example: \n\n```yaml\n---\ncrossref:\n custom:\n - key: vid\n kind: float\n reference-prefix: Video\n---\n```\n", + "options": [ + { + "name": "kind", + "description": "The kind of cross reference (currently only \"float\" is supported)." + }, + { + "name": "reference-prefix", + "description": "The prefix used in rendered references when referencing this type." + }, + { + "name": "caption-prefix", + "description": "The prefix used in rendered captions when referencing this type. If omitted, the field `reference-prefix` is used." + }, + { + "name": "space-before-numbering", + "description": "If false, use no space between crossref prefixes and numbering." + }, + { + "name": "key", + "description": "The key used to prefix reference labels of this type, such as \"fig\", \"tbl\", \"lst\", etc." + }, + { + "name": "latex-env", + "description": "In LaTeX output, the name of the custom environment to be used." + }, + { + "name": "latex-list-of-file-extension", + "description": "In LaTeX output, the extension of the auxiliary file used by LaTeX to collect names to be used in the custom \"list of\" command. If omitted, a string with prefix `lo` and suffix with the value of `ref-type` is used." + }, + { + "name": "latex-list-of-description", + "description": "The description of the crossreferenceable object to be used in the title of the \"list of\" command. If omitted, the field `reference-prefix` is used." + }, + { + "name": "caption-location", + "description": "The location of the caption relative to the crossreferenceable content." + } + ] + } +] \ No newline at end of file diff --git a/docs/reference/metadata/crossref.qmd b/docs/reference/metadata/crossref.qmd new file mode 100644 index 0000000000..5f13bb0509 --- /dev/null +++ b/docs/reference/metadata/crossref.qmd @@ -0,0 +1,13 @@ +--- +title: Cross Reference Options +--- + +The `crossref` option is used to customize the appearance and behavior of cross-references. You can read more about using [Cross-References in the Guide](/docs/authoring/cross-references.qmd). + +```yaml +--- +crossref: + labels: roman + title-delim: "-" +--- +``` \ No newline at end of file diff --git a/docs/reference/projects/book.json b/docs/reference/projects/book.json index 7920111c35..b91448087a 100644 --- a/docs/reference/projects/book.json +++ b/docs/reference/projects/book.json @@ -459,14 +459,6 @@ "name": "repo-url", "description": "Base URL for website source code repository" }, - { - "name": "repo-link-target", - "description": "The value of the target attribute for repo links" - }, - { - "name": "repo-link-rel", - "description": "The value of the rel attribute for repo links" - }, { "name": "repo-subdir", "description": "Subdirectory of repository containing website" @@ -543,10 +535,6 @@ "name": "image", "description": "Default site thumbnail image for `twitter` /`open-graph`\n" }, - { - "name": "image-alt", - "description": "Default site thumbnail image alt text for `twitter` /`open-graph`\n" - }, { "name": "comments", "description": "" diff --git a/docs/reference/projects/website.json b/docs/reference/projects/website.json index fc8b5cb46c..9f7ecb56bf 100644 --- a/docs/reference/projects/website.json +++ b/docs/reference/projects/website.json @@ -23,14 +23,6 @@ "name": "repo-url", "description": "Base URL for website source code repository" }, - { - "name": "repo-link-target", - "description": "The value of the target attribute for repo links" - }, - { - "name": "repo-link-rel", - "description": "The value of the rel attribute for repo links" - }, { "name": "repo-subdir", "description": "Subdirectory of repository containing website" @@ -107,10 +99,6 @@ "name": "image", "description": "Default site thumbnail image for `twitter` /`open-graph`\n" }, - { - "name": "image-alt", - "description": "Default site thumbnail image alt text for `twitter` /`open-graph`\n" - }, { "name": "comments", "description": "" diff --git a/docs/reference/reference.yml b/docs/reference/reference.yml index d26b6be1c8..fe69ba5205 100644 --- a/docs/reference/reference.yml +++ b/docs/reference/reference.yml @@ -70,4 +70,6 @@ href: globs.qmd - text: "Citations" href: metadata/citation.qmd + - text: "Cross-References" + href: metadata/crossref.qmd diff --git a/tools/reference.ts b/tools/reference.ts index 37701494cb..8c5b1d124f 100644 --- a/tools/reference.ts +++ b/tools/reference.ts @@ -120,7 +120,7 @@ const cellOptions = Object.keys(cellGroups).map(group => { // document options const documentGroups = groups["document"]; const documentOptions = Object.keys(documentGroups) - .filter(group => !["comments", "crossref"].includes(group)) + .filter(group => !["comments"].includes(group)) .map(group => { const title = documentGroups[group]["title"]; @@ -311,18 +311,37 @@ function findVal(object: any, key: string) { } // Metadata pages -function writeMetadataTable(name: string, options: Array