Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

lua-filters.md: update docs and mention implicit filters

Browse source
This commit is contained in:
Albert Krewinkel 2017-08-21 16:53:00 +02:00
parent b81cff4357
commit 29a6793811
No known key found for this signature in database
GPG key ID: 388DC0B21F631124
1 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/lua-filters.md
View file

@ -2,7 +2,21 @@ Lua Filters
===========
Pandoc expects lua files to return a list of filters. The filters in that list
are called sequentially, each on the result of the previous filter.
are called sequentially, each on the result of the previous filter. If there is
no value returned by the filter script, then pandoc will try to generate a
filter by collecting all top-level functions whose names correspond to those of
pandoc elements (e.g., `Str`, `Para`, `Meta`, or `Pandoc`).
Filters are expected to be put into separate files and are passed via the
`--lua-filter` command-line argument. E.g., if a filter is defined in a file
`current-date.lua`, then it would be applied like this:
pandoc --lua-filter=current-date.lua -f markdown MANUAL.txt
The `--lua-filter` can be supplied multiple times, causing the filters to be
applied sequentially in the order they were given. If other, non-Lua filters are
given as well (via `--filter`), then those are executed *after* all Lua filters
have been applied.
Lua Filter Structure
--------------------
@ -45,7 +59,7 @@ functions and access to some of pandoc's main functionalities.
Element creation
----------------
Element creator functions like `Str`, `Para`, and `Doc` are designed to
Element creator functions like `Str`, `Para`, and `Pandoc` are designed to
allow easy creation of new elements that are simple to use and can be
read back from the lua environment. Internally, pandoc uses these
functions to create the lua objects which are passed to element filter