aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--data/pandoc.lua4
-rw-r--r--doc/lua-filters.md22
2 files changed, 25 insertions, 1 deletions
diff --git a/data/pandoc.lua b/data/pandoc.lua
index 7c38f2191..2dd8e448e 100644
--- a/data/pandoc.lua
+++ b/data/pandoc.lua
@@ -24,9 +24,13 @@ THIS SOFTWARE.
-- @license MIT
local M = {}
+-- Other modules used here; those are also re-exported.
local List = require 'pandoc.List'
local utils = require 'pandoc.utils'
+M.List = List
+M.utils = utils
+
------------------------------------------------------------------------
-- Accessor objects
--
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