tstenner / luarefnos Goto Github PK

Since pandoc-xnos seems to be dead for now and it doesn't really support pandoc 3.x (e.g. pandoc-fignos is broken due to the new AST format), migrating to this native LUA implementation sounds like a good idea. But it would be beneficial if we could keep the documents written for pandoc-xnos...

So one of the differences is the "clever references" feature available in pandoc-xnos. The difference is the following:

• pandoc-xnos:

  • @fig:myfigure is simply replaced with the number of the figure (e.g. 1).
  • +@fig:myfigure is replaced with the caption + number (e.g. Figure 1)

• luarefnos:

  • @fig:myfigure is replaced with the caption + number (e.g. Figure 1)

Ideally, my suggestion is to implement exactly the same syntax as pandoc-xnos.
But if that is too complex, maybe it is possible to implement deletion of the + sign right before the reference.

Explanation:

• Today @fig:myfigure in luarefnos does the same as +@fig:myfigure in pandoc-xnos. Namely, it emits caption + number (e.g. Figure 1)
• If someone has a document written for pandoc-xnos, they are likely to have something like:

  Please see +@fig:myfigure for more details.
  

• If they migrate to luarefnos, this line will be rendered as:

  Please see +Figure 1 for more details.
  

• So it is almost like the clever reference, but there is this + that should not be there...

Since pandoc-xnos seems to be dead for now and it doesn't really support pandoc 3.x (e.g. pandoc-fignos is broken due to the new AST format), migrating to this native LUA implementation sounds like a good idea. But it would be beneficial if we could keep the documents written for pandoc-xnos...

So one of the differences is the fact that tables in pandoc-xnos are abbreviates with tbl:, while luarefnos uses tab: by default. I fixed it for myself, by adding a duplicate line for tbl here:

E.g.:

en = {
   tab = {ref = 'Table', plural = 'Tables', abbrev = 'Tab.'},
   tbl = {ref = 'Table', plural = 'Tables', abbrev = 'Tab.'},

With this change, I can render the documents that have links like @tbl:silly
Apparently, I couldn't just replace "tab" with "tbl", because is some other places it is used...

I suggest adding "official" support for this.

On pandoc 3.1.11.1:

% pandoc --version
pandoc 3.1.11.1
Features: +server +lua
Scripting engine: Lua 5.4

Trying to render a simple table without ID (the filter is not expected to do anything here):

% cat table.md 
 Revision        Date       Change Description
----------   ------------   --------------------
0.5           2022-07-05    Initial Draft

This results in failure:

% pandoc table.md --lua-filter refnos.lua -o table.html 
Error running filter refnos.lua:
refnos.lua:71: attempt to index a nil value (field 'integer index')
stack traceback:
	refnos.lua:247: in function <refnos.lua:244>

The problem seems to be here:

I fixed it by replacing this line with:

if tbl.attr.identifier ~= "" then

Equations, such as @eq:pythagoras , have to be put into a span with an id:

[$$a^2 + b^2 = c^2$$]{#eq:pythagoras}

If you change the field code to match the bookmark, another error occurs:

pandoc.exe 3.1.6
Scripting engine: Lua 5.4

| a   | b   |
|:--- |:--- |
| e   | f   |
| c   | d   |

: table caption {#tab:tabid}

see [@tab:tabid]

[img caption](https://obsidian-weber.oss-cn-hangzhou.aliyuncs.com/picgo/202310202150932.png){#fig:img}

see [@fig:img]

If I delete the picture, it works fine