[FR] New Lua utility function to access qmd input filename

[cderv]

Just opening this to track idea from #2230

Maybe we could add a feature to add a quarto.utils.input_files() (or similar) to easily access the source .qmd from a Lua filter.

Could be useful in certain case, and PANDOC_STATE.input_files can probably help for that.

Let's see if some 👍 are added by users developing with Lua.

[Nenuial]

This would be great! As mentioned in my question, PANDOC_STATE.input_files didn't work for me, because it contains the path of a temporary .md file.

I was trying to write a shortcode that allows me to easily insert a link to the pdf version of a document.

I have a website with articles that have both an html and pdf output format. When rendering the html, I wanted a {{< pdf-download >}} shortcode to insert a link to the pdf version of the article automatically.

[justanothergithubber]

I am not a Lua developer, but I use this shortcode snippet to get the filename without the .qmd

function filename(args)
  return pandoc.path.split_extension(PANDOC_STATE.output_file)
end

So if I use {{< filename >}} I get the filename (abc.qmd -> abc). More Lua script can process this output. I add in capitalisation and changing of _ to spaces for my use.

Having an official shortcode for this would be useful

[cderv]

That is indeed a good solution when output-file has not been set. It is possible that when set, the file returned in PANDOC_STATE will not be the input file.

However a good solution for @Nenuial to know the output file name for a known format I believe. Thank you !

[Nenuial]

I implemented something along those lines after @mcanouil suggestions to try other variables in PANDOC_STATE. It works for my use case, but would indeed fail if the output file is changed. Thanks for sharing your solution!

[cderv]

For reference, related question in Posit Community: https://community.rstudio.com/t/find-the-name-of-the-current-file-being-rendered-in-quarto/157756

[dragonstyle]

Starting in Quarto 1.2 you should be about use:

quarto.doc.input_file
quarto.doc.output_file

to get the input and output files respectively...

[cderv]

Nice so we have it already through Lua filter ! Is this public API for now ? I don't see it in our doc https://quarto.org/docs/extensions/lua-api.html#quarto-lua-api

Also #2230 and Community Question are about accessing this value through variables shortcodes I believe.
With this Quarto Lua API it could be possible to make right ? 🤔

[dragonstyle]

Yep, it will available to any LUA code that is being executed (e.g. filter or shortcode)- it is public but you're right that it is omitted from the documentation (unintentionally)!

We also added some project related functions that are omitted:

quarto.project.directory
quarto.project.offset
quarto.project.profile
quarto.project.output_directory

Let's keep this issue open to track getting the documentation updated to reflect this.

[ratnanil]

I've been so looking forward to this! So this should be possible as of Quarto 1.2?

{{< quarto.doc.input_file >}}

[cscheid]

No, {{< ... >}} denotes a shortcode. quarto.doc.input_file is a Lua function.