aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2021-11-11 09:13:27 +0100
committerJohn MacFarlane <jgm@berkeley.edu>2021-11-11 10:32:37 -0800
commitebf7f782d3151956d6e886c9615580c0b67f6656 (patch)
tree308e97843914fdbad704e25d56374aaada56bdd4 /doc
parentfe113dd5fac4b05d74391bc47122f3d24b88b1dd (diff)
downloadpandoc-ebf7f782d3151956d6e886c9615580c0b67f6656.tar.gz
Lua: load `re` module available into global of the same name
Diffstat (limited to 'doc')
-rw-r--r--doc/lua-filters.md27
1 files changed, 20 insertions, 7 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index ba5f58120..38790ca5d 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -245,15 +245,28 @@ variables.
variable is of type [CommonState] and
is read-only.
-## Global modules
-
-There are two modules which are preloaded and accessible through
-global variables. The first is `pandoc`, which is described in the
-next section. The other is `lpeg`, a package based on Parsing
-Expression Grammars (PEG). See the official [LPeg homepage] for
-details.
+`pandoc`
+: The *pandoc* module, described in the next section, is
+ available through the global `pandoc`. The other modules
+ described herein are loaded as subfields under their
+ respective name.
+
+`lpeg`
+: This variable holds the `lpeg` module, a package based on
+ Parsing Expression Grammars (PEG). It provides excellent
+ parsing utilities and is documented on the official [LPeg
+ homepage]. Pandoc will try to load the module through the
+ normal package mechanism, and fall back to a built-in version
+ if necessary.
+
+`re`
+: Contains the LPeg.re module, which is built on top of LPeg and
+ offers an implementation of a [regex engine]. Pandoc will try
+ to load the module through the normal package mechanism, and
+ fall back to a built-in version if necessary.
[LPeg homepage]: http://www.inf.puc-rio.br/~roberto/lpeg/
+[regex engine]: http://www.inf.puc-rio.br/~roberto/lpeg/re.html
# Pandoc Module