aboutsummaryrefslogtreecommitdiff
path: root/doc/lua-filters.md
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2019-02-07 09:50:06 +0100
committerAlbert Krewinkel <albert@zeitkraut.de>2019-02-07 10:10:55 +0100
commit713ed7c0c5a6f64348f30d02d7baee0e46ef371c (patch)
tree9c1b8b652e07336f692f0cf708a06adb451c50b7 /doc/lua-filters.md
parent1847bdbb833cfdd7abb34e7f906ab9a1f74dfa17 (diff)
downloadpandoc-713ed7c0c5a6f64348f30d02d7baee0e46ef371c.tar.gz
data/pandoc.lua: re-export List and utils module
Diffstat (limited to 'doc/lua-filters.md')
-rw-r--r--doc/lua-filters.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index 3817ea7d8..dc3c75217 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -2192,11 +2192,20 @@ Usage:
-- The inline element in that block is an `Emph`
assert(block.content[1].t == "Emph")
+
# Module pandoc.utils
This module exposes internal pandoc functions and utility
functions.
+The module is loaded as part of the `pandoc` module and available
+as `pandoc.utils`. In versions up-to and including pandoc 2.6,
+this module had to be loaded explicitly. Example:
+
+ local utils = require 'pandoc.utils'
+
+Use this for backwards compatibility.
+
### blocks\_to\_inlines {#utils-blocks_to_inlines}
`blocks_to_inlines (blocks[, sep])`
@@ -2468,9 +2477,20 @@ Usage:
local diagram_url = "https://pandoc.org/diagram.jpg"
local contents = pandoc.mediabag.fetch(diagram_url, ".")
+
# Module pandoc.List
-Pandoc\'s List type and helper methods
+Pandoc's List type and helper methods.
+
+This module is loaded and available as `pandoc.List`. Older
+versions up-to and including pandoc 2.6 require the module to be
+loaded explicitly. Example:
+
+ local List = require 'pandoc.List'
+
+The above remains the recommended method to use this module; it
+provides the List type under an idiomatic name and is fully
+backwards compatible.
## Metamethods