summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2017-12-01 17:14:28 +0100
committerAlbert Krewinkel <albert@zeitkraut.de>2017-12-01 17:14:28 +0100
commit5026dfaedf4a8043fd1d76c1b7da8880770f9255 (patch)
treeb05627dbe49312c41961b2b350248b7e9981784e /doc
parent8473a151c5685f8ceb515abf6000ab4fb7a3911c (diff)
lua-filters.md: add documentation for pandoc.List
Diffstat (limited to 'doc')
-rw-r--r--doc/lua-filters.md103
1 files changed, 103 insertions, 0 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index 112a9bab2..8cdb96194 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -1479,3 +1479,106 @@ storage. The "media bag" is used when pandoc is called with the
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
+
+## Metamethods
+
+[`pandoc.List:__concat (list)`]{#pandoc.List:__concat}
+
+: Concatenates two lists.
+
+ Parameters:
+
+ `list`:
+ : second list concatenated to the first
+
+ Returns: a new list containing all elements from list1 and
+ list2
+
+## Methods
+
+[`pandoc.List:clone ()`]{#pandoc.List:clone}
+
+: Returns a (shallow) copy of the list.
+
+[`pandoc.List:includes (needle, init)`]{#pandoc.List:includes}
+
+: Checks if the list has an item equal to the given needle.
+
+ Parameters:
+
+ `needle`:
+ : item to search for
+
+ `init`:
+ : index at which the search is started
+
+ Returns: true if a list item is equal to the needle, false
+ otherwise
+
+[`pandoc.List:find (needle, init)`]{#pandoc.List:find}
+
+: Returns the value and index of the first occurrence of the
+ given item.
+
+ Parameters:
+
+ `needle`:
+ : item to search for
+
+ `init`:
+ : index at which the search is started
+
+ Returns: first item equal to the needle, or nil if no such
+ item exists.
+
+[`pandoc.List:find_if (pred, init)`]{#pandoc.List:find_if}
+
+: Returns the value and index of the first element for which
+ the predicate holds true.
+
+ Parameters:
+
+ `pred`:
+ : the predicate function
+
+ `init`:
+ : index at which the search is started
+
+ Returns: first item for which \`test\` succeeds, or nil if
+ no such item exists.
+
+[`pandoc.List:extend (list)`]{#pandoc.List:extend}
+
+: Adds the given list to the end of this list.
+
+ Parameters:
+
+ `list`:
+ : list to appended
+
+[`pandoc.List:map (fn)`]{#pandoc.List:map}
+
+: Returns a copy of the current list by applying the given
+ function to all elements.
+
+ Parameters:
+
+ `fn`:
+ : function which is applied to all list items.
+
+[`pandoc.List:filter (pred)`]{#pandoc.List:filter}
+
+: Returns a new list containing all items satisfying a given
+ condition.
+
+ Parameters:
+
+ `pred`:
+ : condition items must satisfy.
+
+ Returns: a new list containing all items for which \`test\`
+ was true.