aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2020-11-23JATS template: allow array of persistent institute ids in `pid`Albert Krewinkel1-0/+7
2020-11-22Org reader: parse `#+LANGUAGE` into `lang` metadata fieldAlbert Krewinkel1-1/+4
Fixes: #6845
2020-11-20JATS writer: support author affiliations (#6867)Albert Krewinkel1-0/+84
Closes: #6687
2020-11-06doc/filters.md: describe technical details of filter invocations (#6815)Albert Krewinkel1-0/+79
2020-11-03Document pandoc's handling of metadata in JATS output (#6794)Albert Krewinkel1-0/+299
2020-11-01Fix code example in lua-filters.md.John MacFarlane1-1/+2
Closes #6795, thanks to Odin Kroeger.
2020-10-15Fix some small typos in the API documentation (#6751)Michael Hoffmann1-3/+3
While reading the docs I found a couple of small typos.
2020-10-12doc/org.md: fix typosAlbert Krewinkel1-2/+2
2020-10-12doc/lua-filters.md: fix typosAlbert Krewinkel1-20/+24
Use American spelling.
2020-10-11doc/lua-filters.md: describe parameters to `pandoc.pipe`Albert Krewinkel1-1/+13
2020-10-08Add info on how to debug Lua filters (#6732)Ian Max Andolina1-0/+19
Add info on debugging Lua filters.
2020-10-04doc/lua-filters.md: document Underline type and constructorAlbert Krewinkel1-0/+27
2020-09-25doc/org.md: add section on tablesAlbert Krewinkel1-0/+28
2020-09-21doc/org.md: add section on handling of unknown directivesAlbert Krewinkel1-0/+47
2020-09-20Lua filters: add SimpleTable for backwards compatibility (#6575)Albert Krewinkel1-0/+115
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-solipsist1-3/+5
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 Krewinkel1-0/+3
2020-07-29doc/lua-filters.md: add missing header attributeAlbert Krewinkel1-1/+1
2020-07-28Lua filter docs: remove link table exampleAlbert Krewinkel1-36/+0
The example is outdated and requires a complete overhaul.
2020-07-25doc/lua-filters.md: document `body` fieldAlbert Krewinkel1-3/+6
2020-07-25Lua filters: make attr argument optional in Table constructorAlbert Krewinkel1-6/+15
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 Krewinkel1-20/+123
2020-07-21Update using-the-pandoc-api.mdfavonia1-1/+2
2020-07-09Fix Typos in Lua Filters Doctajmone1-4/+4
2020-06-29Org reader: unify keyword handlingAlbert Krewinkel1-4/+4
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 Krewinkel1-6/+7
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 Krewinkel1-1/+4
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 Krewinkel1-0/+27
See discussion in #4788. Closes: #4387
2020-06-28Org reader: read `#+INSTITUTE` values as text with markupAlbert Krewinkel1-0/+5
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 Krewinkel1-0/+57
2020-05-25lua-filters.md: use pandoc.system module in TikZ exampleAlbert Krewinkel1-39/+48
Showcase temporary directory handling with `with_temporary_directory` and `with_working_directory`.
2020-04-01Fix description of BulletList Lua typeLevi Gruspe1-5/+5
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 MacFarlane1-7/+21
so it works with latest pandoc. Closes #6185.
2020-01-18doc/lua-filters.md: fix copy-paste mistakeAlbert Krewinkel1-1/+1
Closes: #6040
2020-01-15Lua filters: allow filtering of element lists (#6040)Albert Krewinkel1-1/+71
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 MacFarlane1-3/+3
2020-01-14Update filter documentation.John MacFarlane1-142/+84
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 Krewinkel1-15/+15
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 Krewinkel1-62/+281
Thanks to @bpj for the idea.
2020-01-11Lua: add methods `insert`, `remove`, and `sort` to pandoc.ListAlbert Krewinkel1-0/+59
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 Krewinkel1-34/+34
2020-01-11doc/lua-filters.md: unify, fix anchors and internal links (#6061)Albert Krewinkel1-362/+334
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 Krewinkel1-1/+23
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 Krewinkel1-2/+30
2019-12-22doc/lua-filters.md: replace metadata example with image centering (#6004)Albert Krewinkel1-22/+23
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
2019-12-17lua-filters.md remove spurious dot in title (#5996)Mauro Bieg1-1/+1
2019-11-20Fix typos (#5919)Brian Wignall1-2/+2
2019-11-13doc/lua-filters.md: mention which Lua version is shipped with pandocAlbert Krewinkel1-3/+3
See: #5892
2019-11-02Fix metadata replacement example in lua-filters doc.John MacFarlane1-20/+20
Closes #5851. We avoid the failure with a boolean value by simply checking to make sure we have a table before indexing.
2019-10-28Fix capitalization of "Linux" in docs (#5859)Marcus Stollsteimer2-3/+3
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-15 15:51:22 +0000