quarto-dev / quarto-cli

Open-source scientific and technical publishing system built on Pandoc.
https://quarto.org
Other
3.93k stars 325 forks source link

Find homes for changes in 1.4 to LUA and AST #7900

Open cwickham opened 11 months ago

cwickham commented 11 months ago

The changes in LUA and AST processing don't belong in the Guide, but probably belong somewhere in Extensions > Creating Extensions. (We might also consider moving the changes to AST in 1.3)

[Edit: Expanding these three items out by section to make discussion easier]

AST processing changes in v1.4:

Lua filter changes:

AST in 1.3:

mcanouil commented 11 months ago

I've seen many users using Lua filters without using Quarto extensions mechanism. I think some users don't know they don't have to write extensions to use a Lua filter (especially all the Lua filters developed initially for Pandoc).

Here the "Extensions" pages should be read as "Extend Quarto with Lua filters, shortcodes formats and possibly distribue as Quarto extensions" but I feel users are reading this as "Use Quarto Extension mechanism", especially since this part starts with a listings of extension followed by how to create extensions.

(my two cents)

FYI, in discussions, there are several simple examples of Lua filters (a lot written by @cscheid):

https://github.com/quarto-dev/quarto-cli/discussions?discussions_q=label%3Alua

cwickham commented 11 months ago

Ah, that's a really good point. And there are other things that fall into the "customizing output without actually writing an extension" bucket, like using template partials, that we only talk about in the context of creating extensions.

This might need to part of a larger discussion/redesign of the Extensions section.

cwickham commented 9 months ago

Related issue https://github.com/quarto-dev/quarto-cli/issues/4926