aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorIan Max Andolina <[email protected]>2022-10-09 09:27:50 +0800
committerGitHub <[email protected]>2022-10-08 18:27:50 -0700
commit2d27a06312dcfb4fda9b2ac60d6af305a9c77ef2 (patch)
tree52772a3b5c667cd335dd094aeb197d9738a46341 /doc
parent5589b1f8f994dd4f741e6861fc2a374f609bb2db (diff)
Update Lua filter doc: modify Zerobrane instructions to use Lua 5.4 (#8353)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua-filters.md32
1 files changed, 18 insertions, 14 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index 52bbcba3d..1d7498918 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -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: