Integrate 1.3 and 1.4 LUA/AST changes #1166
Conversation
| | `quarto.doc.use_latex_package(pkg, opt)` | Adds a `\usepackage` statement to the LaTeX output (along an options string specified in `opt`) | | ||
| | `quarto.doc.add_format_resource(path)` | Add a format resource to the document. Format resources will be copied into the directory next to the rendered output. This is useful, for example, if your format references a `bst` or `cls` file which must be copied into the LaTeX output directory. | | ||
| | `quarto.doc.add_resource(path)` | Add a resource file to the current render, copying that file to the same relative location in the output directory. | | ||
| | `quarto.doc.add_supporting(path)` | Add a supporting file to the current render, moving that file file to the same relative location in the output directory. | |
There was a problem hiding this comment.
@cscheid The descriptions here look identical. Is that right?
There was a problem hiding this comment.
add_ressource is for resource file as the resources YAML field
add_supporting is for supporting file usually created directly by rendering (like images save on disk by R or python from plots). Supporting files are usually cleaned up.
See edit suggestion
| | `quarto.Callout(tbl)` | Callout: `tbl` is a table with entries `type`, `title`, and `content`. | | ||
| | `quarto.Tabset(tbl)` | Tabset: `tbl` is a table with entries `tabs`, `level` and `attr`. | | ||
| | `quarto.ConditionalBlock(tbl)` | Conditional block: `tbl` is a table with entries `node`, `behavior`, and `condition`. | | ||
| | `quarto.FloatRefTarget(tbl)` | Cross-referencable element: `tbl` is a table with entries `content`, `caption_long`, and `caption_short`. | |
There was a problem hiding this comment.
@cscheid I deduced the parameter here from the codebase. Did I get it right?
There was a problem hiding this comment.
I think it can take more and we do document more in quarto-ast.qmd
Example at: https://github.com/quarto-dev/quarto-cli/blob/7f84537a8dd84859ac7ff0578411e3e26eee249a/src/resources/filters/layout/html.lua#L74-L82
Maybe we can ask claude code to extract info from codebase ?
|
🚀 Deployed on https://deploy-preview-1166.quarto.org |
|
Now also closes quarto-dev/quarto-cli#4499 |
|
🚀 Deployed on https://deploy-preview-1166.quarto.org |
|
@cwickham As I was looking at adding some 1.3 highlight still hidden (https://quarto.org/docs/prerelease/1.3/pdf.html) I found this one still open. We should probably rework on this one. Those documentation are important to be in main website. |
|
@cderv Yes, happy to get this merged. Would you review it? |
cderv
left a comment
cderv
left a comment
There was a problem hiding this comment.
Looks good.
I am thinking we could ask claude code to give us its thought on the coverage of custom node argument. It does not see straightforward to day to know all the possibly entry. This require some code scanning for Lua file.
| | `quarto.doc.use_latex_package(pkg, opt)` | Adds a `\usepackage` statement to the LaTeX output (along an options string specified in `opt`) | | ||
| | `quarto.doc.add_format_resource(path)` | Add a format resource to the document. Format resources will be copied into the directory next to the rendered output. This is useful, for example, if your format references a `bst` or `cls` file which must be copied into the LaTeX output directory. | | ||
| | `quarto.doc.add_resource(path)` | Add a resource file to the current render, copying that file to the same relative location in the output directory. | | ||
| | `quarto.doc.add_supporting(path)` | Add a supporting file to the current render, moving that file file to the same relative location in the output directory. | |
There was a problem hiding this comment.
add_ressource is for resource file as the resources YAML field
add_supporting is for supporting file usually created directly by rendering (like images save on disk by R or python from plots). Supporting files are usually cleaned up.
See edit suggestion
| | `quarto.doc.use_latex_package(pkg, opt)` | Adds a `\usepackage` statement to the LaTeX output (along an options string specified in `opt`) | | ||
| | `quarto.doc.add_format_resource(path)` | Add a format resource to the document. Format resources will be copied into the directory next to the rendered output. This is useful, for example, if your format references a `bst` or `cls` file which must be copied into the LaTeX output directory. | | ||
| | `quarto.doc.add_resource(path)` | Add a resource file to the current render, copying that file to the same relative location in the output directory. | | ||
| | `quarto.doc.add_supporting(path)` | Add a supporting file to the current render, moving that file file to the same relative location in the output directory. | |
There was a problem hiding this comment.
| | `quarto.doc.add_supporting(path)` | Add a supporting file to the current render, moving that file file to the same relative location in the output directory. | | |
| | `quarto.doc.add_supporting(path)` | Add a supporting file to the current render, moving that file to the same relative location in the output directory. Supporting files can be cleanup after rendering. | |
| | `quarto.doc.attach_to_dependency(name, attach)` | Attach a file to an existing dependency. `attach` is a file path relative to the Lua filter or table with \`path\` and \`name\` for renaming the file as its copied. | | ||
| | `quarto.doc.use_latex_package(pkg, opt)` | Adds a `\usepackage` statement to the LaTeX output (along an options string specified in `opt`) | | ||
| | `quarto.doc.add_format_resource(path)` | Add a format resource to the document. Format resources will be copied into the directory next to the rendered output. This is useful, for example, if your format references a `bst` or `cls` file which must be copied into the LaTeX output directory. | | ||
| | `quarto.doc.add_resource(path)` | Add a resource file to the current render, copying that file to the same relative location in the output directory. | |
There was a problem hiding this comment.
Something like this ?
| | `quarto.doc.add_resource(path)` | Add a resource file to the current render, copying that file to the same relative location in the output directory. | | |
| | `quarto.doc.add_resource(path)` | Add a resource file to the current render, copying that file to the same relative location in the output directory. See more [about `resources` handling](docs/websites/website-tools.qmd#site-resources). | |
| | `quarto.Callout(tbl)` | Callout: `tbl` is a table with entries `type`, `title`, and `content`. | | ||
| | `quarto.Tabset(tbl)` | Tabset: `tbl` is a table with entries `tabs`, `level` and `attr`. | | ||
| | `quarto.ConditionalBlock(tbl)` | Conditional block: `tbl` is a table with entries `node`, `behavior`, and `condition`. | | ||
| | `quarto.FloatRefTarget(tbl)` | Cross-referencable element: `tbl` is a table with entries `content`, `caption_long`, and `caption_short`. | |
There was a problem hiding this comment.
I think it can take more and we do document more in quarto-ast.qmd
Example at: https://github.com/quarto-dev/quarto-cli/blob/7f84537a8dd84859ac7ff0578411e3e26eee249a/src/resources/filters/layout/html.lua#L74-L82
Maybe we can ask claude code to extract info from codebase ?
📝 Preview Deployment🔍 Full site preview: https://deploy-preview-1166.quarto.org 🔄 Modified Documents |
Mostly a moving of existing content in pre-release highlights into more permanent homes.
Closes quarto-dev/quarto-cli#7900
Closes quarto-dev/quarto-cli#8301