opensource/pandoc
3
0
Fork 0
mirror of https://github.com/jgm/pandoc.git synced 2026-09-21 05:43:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Lua filter doc: modify Zerobrane instructions to use Lua 5.4 (#8353)

Browse Source
This commit is contained in:
Ian Max Andolina
2022-10-08 18:27:50 -07:00
committed by GitHub
parent 5589b1f8f9
commit 2d27a06312
1 changed files with 18 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/lua-filters.md
+18 -14
View File
@@ -30,7 +30,7 @@ executable.
Starting with version 2.0, pandoc makes it possible to write
filters in Lua without any external dependencies at all. A Lua
interpreter (version 5.3) and a Lua library for creating pandoc
interpreter (version 5.4) and a Lua library for creating pandoc
filters is built into the pandoc executable. Pandoc data types
are marshaled to Lua directly, avoiding the overhead of writing
JSON to stdout and reading it from stdin.
@@ -413,16 +413,20 @@ run within the donation-ware Lua editor and IDE,
REPL console and UI to step-through and view all variables and
state.
If you already have Lua 5.3 installed, you can add
[`mobdebug`](https://luarocks.org/modules/paulclinger/mobdebug)
and its dependency
[`luasocket`](https://luarocks.org/modules/luasocket/luasocket)
using [`luarocks`](https://luarocks.org), which should then be
available on the path. ZeroBrane also includes both of these in
its package, so if you don't want to install Lua separately, you
should add/modify your `LUA_PATH` and `LUA_CPATH` to include the
correct locations; [see detailed instructions
here](https://studio.zerobrane.com/doc-remote-debugging).
Zerobrane doesn't come with Lua 5.4 bundled, but it can debug it, so
you should install Lua 5.4, and then add
[`mobdebug`](https://luarocks.org/modules/paulclinger/mobdebug) and
its dependency
[`luasocket`](https://luarocks.org/modules/luasocket/luasocket) using
[`luarocks`](https://luarocks.org). ZeroBrane can use your Lua 5.4
install by adding `path.lua = "/path/to/your/lua"` in your Zerobrane
settings file. Next, open your Lua filter in Zerobrane, and add
`require('mobdebug').start()` at the line where you want your
breakpoint. Then make sure the Project > Lua Intepreter is set to the
"Lua" you added in settings and enable "Start Debugger Server" [see
detailed instructions
here](https://studio.zerobrane.com/doc-remote-debugging). Run Pandoc
as you normally would, and Zerobrane should break at the correct line.
## Common pitfalls
@@ -4189,7 +4193,7 @@ Inserts element `value` at position `pos` in list, shifting
elements to the next-greater index if necessary.
This function is identical to
[`table.insert`](https://www.lua.org/manual/5.3/manual.html#6.6).
[`table.insert`](https://www.lua.org/manual/5.4/manual.html#6.6).
Parameters:
@@ -4228,7 +4232,7 @@ Removes the element at position `pos`, returning the value
of the removed element.
This function is identical to
[`table.remove`](https://www.lua.org/manual/5.3/manual.html#6.6).
[`table.remove`](https://www.lua.org/manual/5.4/manual.html#6.6).
Parameters:
@@ -4258,7 +4262,7 @@ by the given order may have their relative positions changed
by the sort.
This function is identical to
[`table.sort`](https://www.lua.org/manual/5.3/manual.html#6.6).
[`table.sort`](https://www.lua.org/manual/5.4/manual.html#6.6).
Parameters: