summaryrefslogtreecommitdiff
path: root/doc/lua-filters.md
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2022-10-12 18:11:25 +0200
committerAlbert Krewinkel <albert@zeitkraut.de>2022-12-03 16:22:19 +0100
commitb34ec00607c0218b3f9e8718d0fc68b3cf228f6c (patch)
treee68214ff153efa5e9f3dd3116a930edf00043c6a /doc/lua-filters.md
parentc5beb1db45706e10ddd7747788da4f4adfad73e6 (diff)
doc/lua-filters.md: add documentation for pandoc.format
Diffstat (limited to 'doc/lua-filters.md')
-rw-r--r--doc/lua-filters.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index 6435280e6..8636b3254 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -4271,6 +4271,47 @@ Parameters:
`comp`
: Comparison function as described above.
+# Module pandoc.format
+
+Information about the formats supported by pandoc.
+
+## Functions {#pandoc.format-functions}
+
+### all_extensions {#pandoc.format.default_extensions}
+
+`all_extensions (format)`
+
+Returns the list of all valid extensions for a format. No
+distinction is made between input and output; an extension can
+have an effect when reading a format but not when writing it, or
+*vice versa*.
+
+Parameters:
+
+`format`
+: format name (string)
+
+Returns:
+
+- all extensions supported for `format` (FormatExtensions)
+
+### default_extensions {#pandoc.format.default_extensions}
+
+`default_extensions (format)`
+
+Returns the list of default extensions of the given format; this
+function does not check if the format is supported, it will return
+a fallback list of extensions even for unknown formats.
+
+Parameters:
+
+`format`
+: format name (string)
+
+Returns:
+
+- default extensions enabled for `format` (FormatExtensions)
+
# Module pandoc.path
Module for file path manipulations.