aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2019-02-16 13:35:16 +0100
committerAlbert Krewinkel <albert@zeitkraut.de>2019-05-29 23:18:44 +0200
commit5a82ecaaa19176afc24576fd80b91c9a529c2dcb (patch)
tree8c7d4fcca448419987f6327de80cdc71bc3efe87 /doc
parent0a6a11cfabead239eab3baec065d8d6e95bb6447 (diff)
downloadpandoc-5a82ecaaa19176afc24576fd80b91c9a529c2dcb.tar.gz
pandoc.mediabag module: add function `delete`
Function `pandoc.mediabag.delete` allows to remove a single item of the given name from the media bag.
Diffstat (limited to 'doc')
-rw-r--r--doc/lua-filters.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index d60957a2e..2a9646dfd 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -2450,6 +2450,18 @@ e.g.:
local mb = require 'pandoc.mediabag'
+### delete {#mediabag-delete}
+
+`delete (filepath)`
+
+Removes a single entry from the media bag.
+
+Parameters:
+
+`filepath`:
+: filename of the item to be deleted. The media bag will be
+ left unchanged if no entry with the given filename exists.
+
### empty {#mediabag-empty}
`empty ()`