summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2021-02-02Lua: add module "pandoc.path"Albert Krewinkel
The module allows to work with file paths in a convenient and platform-independent manner. Closes: #6001 Closes: #6565
2021-01-29JATS templates: tag author.name as string-nameAlbert Krewinkel
The partitioning the components of a name into surname, given names, etc. is not always possible or not available. Using `author.name` allows to give the full name as a fallback to be used when `author.surname` is not available.
2020-12-20Fixed table with file extensions and interpreterswuffi
Assigned .pl file extension to perl interpreter and .rb to ruby
2020-12-14typoIan Sullivan
2020-12-02filters.md: document a new Pandoc filtering framework (#6908)Randolf J
2020-11-23JATS template: allow array of persistent institute ids in `pid`Albert Krewinkel
2020-11-22Org reader: parse `#+LANGUAGE` into `lang` metadata fieldAlbert Krewinkel
Fixes: #6845
2020-11-20JATS writer: support author affiliations (#6867)Albert Krewinkel
Closes: #6687
2020-11-06doc/filters.md: describe technical details of filter invocations (#6815)Albert Krewinkel
2020-11-03Document pandoc's handling of metadata in JATS output (#6794)Albert Krewinkel
2020-11-01Fix code example in lua-filters.md.John MacFarlane
Closes #6795, thanks to Odin Kroeger.
2020-10-15Fix some small typos in the API documentation (#6751)Michael Hoffmann
While reading the docs I found a couple of small typos.
2020-10-12doc/org.md: fix typosAlbert Krewinkel
2020-10-12doc/lua-filters.md: fix typosAlbert Krewinkel
Use American spelling.
2020-10-11doc/lua-filters.md: describe parameters to `pandoc.pipe`Albert Krewinkel
2020-10-08Add info on how to debug Lua filters (#6732)Ian Max Andolina
Add info on debugging Lua filters.
2020-10-04doc/lua-filters.md: document Underline type and constructorAlbert Krewinkel
2020-09-25doc/org.md: add section on tablesAlbert Krewinkel
2020-09-21doc/org.md: add section on handling of unknown directivesAlbert Krewinkel
2020-09-20Lua filters: add SimpleTable for backwards compatibility (#6575)Albert Krewinkel
A new type `SimpleTable` is made available to Lua filters. It is similar to the `Table` type in pandoc versions before 2.10; conversion functions from and to the new Table type are provided. Old filters using tables now require minimal changes and can use, e.g., if PANDOC_VERSION > {2,10,1} then pandoc.Table = pandoc.SimpleTable end and function Table (tbl) tbl = pandoc.utils.to_simple_table(tbl) … return pandoc.utils.from_simple_table(tbl) end to work with the current pandoc version.
2020-08-26Make the setting-the-date example conditionalthe-solipsist
This makes the example a bit more realistic/valuable by checking if the metadata value "date" is already present, before changing the value.
2020-08-07doc/lua-filters.md: add missing Link.title fieldAlbert Krewinkel
2020-07-29doc/lua-filters.md: add missing header attributeAlbert Krewinkel
2020-07-28Lua filter docs: remove link table exampleAlbert Krewinkel
The example is outdated and requires a complete overhaul.
2020-07-25doc/lua-filters.md: document `body` fieldAlbert Krewinkel
2020-07-25Lua filters: make attr argument optional in Table constructorAlbert Krewinkel
This changes the Lua API. It is highly unlikely for this change to affect existing filters, since the documentation for the new Table constructor (and type) was incomplete and partly wrong before. The Lua API is now more consistent, as all constructors for elements with attributes now take attributes as the last parameter.
2020-07-25doc/lua-filters.md: fix documentation for tablesAlbert Krewinkel
2020-07-21Update using-the-pandoc-api.mdfavonia
2020-07-09Fix Typos in Lua Filters Doctajmone
2020-06-29Org reader: unify keyword handlingAlbert Krewinkel
Handling of export settings and other keywords (like `#+LINK`) has been combined and unified.
2020-06-29Org reader: support LATEX_HEADER_EXTRA and HTML_HEAD_EXTRA settingsAlbert Krewinkel
These export settings are treated like their non-extra counterparts, i.e., the values are added to the `header-includes` metadata list.
2020-06-29Org reader: allow multiple #+SUBTITLE export settingsAlbert Krewinkel
The values of all lines are read as inlines and collected in the `subtitle` metadata field.
2020-06-28doc/org.md: document behavior of `smart` extensionAlbert Krewinkel
See discussion in #4788. Closes: #4387
2020-06-28Org reader: read `#+INSTITUTE` values as text with markupAlbert Krewinkel
The value is stored in the `institute` metadata field and used in the default beamer presentation template.
2020-06-27doc/org.md: describe all supported export options in detailAlbert Krewinkel
2020-05-25lua-filters.md: use pandoc.system module in TikZ exampleAlbert Krewinkel
Showcase temporary directory handling with `with_temporary_directory` and `with_working_directory`.
2020-04-01Fix description of BulletList Lua typeLevi Gruspe
Change description of BulletList parameter from 'List of Blocks' to 'List of List of Blocks'.
2020-03-15Update filter code in doc/filters.md...John MacFarlane
so it works with latest pandoc. Closes #6185.
2020-01-18doc/lua-filters.md: fix copy-paste mistakeAlbert Krewinkel
Closes: #6040
2020-01-15Lua filters: allow filtering of element lists (#6040)Albert Krewinkel
Lists of Inline and Block elements can now be filtered via `Inlines` and `Blocks` functions, respectively. This is helpful if a filter conversion depends on the order of elements rather than a single element. For example, the following filter can be used to remove all spaces before a citation: function isSpaceBeforeCite (spc, cite) return spc and spc.t == 'Space' and cite and cite.t == 'Cite' end function Inlines (inlines) for i = #inlines-1,1,-1 do if isSpaceBeforeCite(inlines[i], inlines[i+1]) then inlines:remove(i) end end return inlines end Closes: #6038
2020-01-14Update filters doc with better cabal v2 instructions.John MacFarlane
2020-01-14Update filter documentation.John MacFarlane
Remove example using pandoc API directly (we have other docs for that and it was outdated). Closes #6065.
2020-01-12docs: capitalize Lua where it refers to the programming language nameAlbert Krewinkel
This follows the advise on the Lua website (https://www.lua.org/about.html#name): > […] "Lua" is a name, the name of the Earth's moon and the name of the > language. Like most names, it should be written in lower case with an > initial capital, that is, "Lua".
2020-01-11Lua filter docs: cross-link constructors and typesAlbert Krewinkel
Thanks to @bpj for the idea.
2020-01-11Lua: add methods `insert`, `remove`, and `sort` to pandoc.ListAlbert Krewinkel
The functions `table.insert`, `table.remove`, and `table.sort` are added to pandoc.List elements. They can be used as methods, e.g. local numbers = pandoc.List {2, 3, 1} numbers:sort() -- numbers is now {1, 2, 3}
2020-01-11doc/lua-filters.md: sort pandoc.List methods alphabeticallyAlbert Krewinkel
2020-01-11doc/lua-filters.md: unify, fix anchors and internal links (#6061)Albert Krewinkel
Links and anchors now follow consistent conventions, like lowercase-only anchor names. This breaks some links to specific sections in the document, but will make it much easier to link documentation in the future.
2020-01-11pandoc.List.lua: make `pandoc.List` a callable constructorAlbert Krewinkel
It is now possible to construct a new List via `pandoc.List()` instead of `pandoc.List:new()`.
2020-01-10docs/lua-filters.md: clarify filter function execution order (#6059)Albert Krewinkel
2019-12-22doc/lua-filters.md: replace metadata example with image centering (#6004)Albert Krewinkel
Metadata defaults can be given via the command line `--metadata-file`. Adding raw format snippets is a common use case for Lua filters, so it seems sensible to provide an example. Thanks to @efx for proposing this filter. Closes: pandoc/lua-filters#70