QUARTO_EXECUTE_INFO documentation #1797
Conversation
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-1797.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-1797.quarto.org 🔄 Modified Documents |
| | `QUARTO_EXECUTE_INFO` | `QUARTO_EXECUTE_INFO` holds the name of a file containing a JSON object with execution information for Quarto engines. This is accessible by code in executable code cells. | | ||
| +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ||
|
|
||
| For more information on the JSON object referenced by `QUARTO_EXECUTE_INFO`, see [Quarto engine execution information](./quarto-execute-info.qmd). |
There was a problem hiding this comment.
Any reason this link isn't inside the table?
There was a problem hiding this comment.
I wanted to highlight the new page on a para by itself, but yeah, we should have the link in both places.
| | `render` | object | Rendering options including `keep-tex`, `code-fold`, `fig-align`, output extensions, etc. | | ||
| | `pandoc` | object | Pandoc-specific settings like `standalone`, `to`, and `default-image-extension` | | ||
| | `language` | object | Localized text for UI elements, section titles, callouts, and other interface strings | | ||
| | `metadata` | object | Document metadata including title and format-specific options | |
There was a problem hiding this comment.
"...format-specific options" is a bit confusing here because I think about it meaning options I set under a format, but here I think it means options specific to a format that aren't otherwise in one of the previous categories.
There was a problem hiding this comment.
How about we just cut that to "document metadata"?
| | `to` | string | Pandoc output format | | ||
| | `standalone` | boolean | Whether to produce standalone output | | ||
| | `default-image-extension` | string | Default file extension for images | | ||
|
|
There was a problem hiding this comment.
No subsection for language or metadata? It think it's worth mentioning at least custom metadata end up in metadata. Maybe something about where project-level or _metadata.yml items end up?
There was a problem hiding this comment.
That information isn't in QUARTO_EXECUTE_INFO...
There was a problem hiding this comment.
I mean, you just said in the table format has elements metadata and language, and they don't get sections like identifier, execute, ... etc.
And if you set custom metadata like:
custom-value: "my-value"It is in QUARTO_EXECUTE_INFO:
info_file <- Sys.getenv("QUARTO_EXECUTE_INFO")
info <- fromJSON(info_file)
info$format$metadata$`custom-value`
Co-authored-by: Charlotte Wickham <[email protected]>
Co-authored-by: Charlotte Wickham <[email protected]>
Co-authored-by: Charlotte Wickham <[email protected]>
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-1797.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-1797.quarto.org 🔄 Modified Documents |
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-1797.quarto.org 🔄 Modified Documents |
* QUARTO_EXECUTE_INFO documentation * remove some lines * Update docs/advanced/quarto-execute-info.qmd Co-authored-by: Charlotte Wickham <[email protected]> * Update docs/advanced/environment-vars.qmd Co-authored-by: Charlotte Wickham <[email protected]> * Update docs/advanced/quarto-execute-info.qmd Co-authored-by: Charlotte Wickham <[email protected]> * change to base_format, use fallthrough * add link to table content --------- Co-authored-by: Charlotte Wickham <[email protected]>
* QUARTO_EXECUTE_INFO documentation * remove some lines * Update docs/advanced/quarto-execute-info.qmd Co-authored-by: Charlotte Wickham <[email protected]> * Update docs/advanced/environment-vars.qmd Co-authored-by: Charlotte Wickham <[email protected]> * Update docs/advanced/quarto-execute-info.qmd Co-authored-by: Charlotte Wickham <[email protected]> * change to base_format, use fallthrough * add link to table content --------- Co-authored-by: Charlotte Wickham <[email protected]>
(What the title says)