aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2021-12-19doc/lua-filters: numbers are now accepted as MetaValueAlbert Krewinkel1-1/+1
2021-12-19Lua: change representation of TableHead, TableFoot, and Row values.Albert Krewinkel1-15/+78
The objects now also follow the principle that element attributes are accessible through the `.attr` field. Rows in `TableHead` and `TableFoot` are available via the `.rows` field. Row objects have a `.cells` field, containing the list of table cells. Closes: #7718
2021-12-17Lua: add function `pandoc.utils.references`Albert Krewinkel1-0/+32
List with all cited references of a document. Closes: #7752
2021-12-14doc/lua-filters.md: add docs for `Cell` constructorAlbert Krewinkel1-4/+31
2021-12-13doc/lua-filters.md: update description of walk methods, fix typosAlbert Krewinkel1-18/+23
2021-12-13Lua: support topdown traversalsAlbert Krewinkel1-2/+47
The traversal order of filters can now be selected by setting the key `traverse` of the filter to either `'topdown'` or `'typewise'`; the default remains `'typewise'`. Topdown traversals can be cut short by returning `false` as a second value from the filter function. No child-element of the returned element is processed in that case.
2021-12-11Custom reader: ensure old Readers continue to workAlbert Krewinkel1-0/+7
Retry conversion by passing a string instead of sources when the `Reader` fails with a message that hints at an outdated function. A deprecation notice is reported in that case.
2021-12-11Custom reader: pass list of sources instead of concatenated textAlbert Krewinkel1-8/+47
The first argument passed to Lua `Reader` functions is no longer a plain string but a richer data structure. The structure can easily be converted to a string by applying `tostring`, but is also a list with elements that contain each the *text* and *name* of each input source as a property of the respective name. A small example is added to the custom reader documentation, showcasing its use in a reader that creates a syntax-highlighted code block for each source code file passed as input. Existing readers must be updated.
2021-12-10Switch to released pandoc-lua-marshal-0.1.2Albert Krewinkel1-0/+9
Cell values are now marshaled as userdata objects; a constructor function for table cells is provided as `pandoc.Cell`.
2021-12-09Lua: update to latest pandoc-lua-marshal (0.1.1)Albert Krewinkel1-5/+176
- `walk` methods are added to `Block` and `Inline` values; the methods are similar to `pandoc.utils.walk_block` and `pandoc.utils.walk_inline`, but apply to filter also to the element itself, and therefore return a list of element instead of a single element. - Functions of name `Doc` are no longer accepted as alternatives for `Pandoc` filter functions. This functionality was undocumented.
2021-12-06custom-writers.md: use filter to include source of example.John MacFarlane1-0/+4
2021-12-02Suggest VSCode as a possible editor in getting-started.md.John MacFarlane1-0/+1
2021-11-29Lua: remove `pandoc.utils.text` (#7720)Albert Krewinkel1-18/+0
The new `pandoc.Inlines` function behaves identical on string input, but allows other Inlines-like arguments as well. The `pandoc.utils.text` function could be written as function pandoc.utils.text (x) assert(type(x) == 'string') return pandoc.Inlines(x) end
2021-11-29fix typo in custom-readers.md (#7722)Mauro Bieg1-1/+1
2021-11-28doc/lua-filters.md: update docs on Blocks, Inlines, MetaValueAlbert Krewinkel1-75/+79
2021-11-28Lua: add constructors `pandoc.Blocks` and `pandoc.Inlines`Albert Krewinkel1-1/+36
The functions convert their argument into a list of Block and Inline values, respectively.
2021-11-23Simplify sample ris reader in doc/custom-readers.md.John MacFarlane1-22/+9
Made possible by #7712.
2021-11-23Lua: add function `pandoc.utils.text` (#7710)Albert Krewinkel1-0/+18
The function converts a string to `Inlines`, treating interword spaces as `Space`s or `SoftBreak`s. If you want a `Str` with literal spaces, use `pandoc.Str`. Closes: #7709
2021-11-22Add an example to custom-readers.md.John MacFarlane1-0/+52
2021-11-21Add custom-writers.md.John MacFarlane1-0/+48
2021-11-21Rename doc/custom-reader.lua to doc/custom-readers.mdAlbert Krewinkel1-0/+0
2021-11-18Add doc for custom-readers.John MacFarlane1-0/+599
2021-11-17Lua: set `lpeg`, `re` as globals; allow shared lib access via requireAlbert Krewinkel1-8/+17
The `lpeg` and `re` modules are loaded into globals of the respective name, but they are not necessarily registered as loaded packages. This ensures that - the built-in library versions are preferred when setting the globals, - a shared library is used if pandoc has been compiled without `lpeg`, and - the `require` mechanism can be used to load the shared library if available, falling back to the internal version if possible and necessary.
2021-11-11Lua: load `re` module available into global of the same nameAlbert Krewinkel1-7/+20
2021-11-11JATS template: fix incomplete previous commitAlbert Krewinkel1-3/+3
2021-11-06Lua: allow to pass custom reader options to `pandoc.read`Albert Krewinkel1-4/+38
Reader options can now be passed as an optional third argument to `pandoc.read`. The object can either be a table or a ReaderOptions value like `PANDOC_READER_OPTIONS`. Creating new ReaderOptions objects is possible through the new constructor `pandoc.ReaderOptions`. Closes: #7656
2021-11-05doc/lua-filters.md: add section on global modules, including lpegAlbert Krewinkel1-0/+10
2021-10-27short-guide: Transitions -> Transformations.John MacFarlane1-2/+2
2021-10-27Update description of T.P.PDFAlbert Krewinkel1-2/+1
Co-authored-by: Mauro Bieg <mb21@users.noreply.github.com>
2021-10-27Add a short guide to pandoc's sourcesAlbert Krewinkel1-0/+260
2021-10-27Change JSON encodings of some types.John MacFarlane1-9/+9
- For LineEnding use lowercase constructors, e.g. `crlf`, `native`. This was the original intent, but there was a bug in the implementation. - For HTMLSlideVariant use lowercase constructors. - For ReaderOptions use e.g. `default-image-extension` instead of `readerDefaultImageExtension` for field names. - For Extension, use e.g. `tex_math_dollars` instead of `Ext_tex_math_dollars` as constructor. - For Extensions, use an array of Extensions, instead of an object wrapping the tag `Extensions` and an integer. (The representation is not supposed to be part of the public API.) - For Opt, use field names like `tab-stop` instead of `optTabStop`.
2021-09-04Rephrase pandoc.path docs (#7548)Quinn1-2/+2
2021-09-04Improve order of Image fieldsQuinn1-3/+3
Ensure consistency throughout docs
2021-09-04Add missing type for Image titleQuinn1-1/+1
2021-08-30Do not leak working directory in TikZ filterJeroen de Haas1-3/+3
2021-08-01Add a faq about the "Cannot allocate memory" error on M1 macs.John MacFarlane1-0/+8
2021-07-03Add FAQ on converting from/to PDFJohn MacFarlane1-0/+18
2021-07-03Add doc/faqs.md.John MacFarlane1-0/+110
This is imported from the website; in the future the website version will be drawn from here. Added a FAQ on the use of `\AtEndPreamble` for cases when the contents of `header-includes` need to refer to definitions that come later in the preamble. See #7422.
2021-06-08using-the-pandoc-api.md: switch from String to TextAlbert Krewinkel1-9/+9
Fixed examples that would no longer compile with current library versions, as the API now uses Text instead of String in most places.
2021-06-07Mention GladTeX for EPUB exportSebastian Humenda1-2/+9
This updates the manual and the web site about the GladTeX usage.
2021-05-09Update doc/using-the-pandoc-api.md for new reader types.John MacFarlane1-2/+15
2021-04-30Add instructions for installing pandoc-types before compiling filter.John MacFarlane1-0/+2
2021-04-26Add unicode-collation to list of libraries developed to support pandoc.John MacFarlane1-0/+4
2021-04-26docs/org.md: Add note about default export behavior of org-mode in (#7238)Charanjit Singh1-0/+15
Since it seem to be a common source of confusion, this commit adds a note in org-mode documentation referring users to consult org-mode's export documentation when they find themselves in a pinch.
2021-04-03Fix typo (#7200)obcat1-1/+1
2021-03-30Update org.md (#7189)Anti-Distinctlyminty1-2/+1
SELECT_TAGS supported since ac83b9c37c39a49878e7d864fb276c0e4caed338
2021-03-28Fixed typo #7159TatianaPorras1-1/+1
This commit fixes the typo in the Lua filters documentation, see #7159
2021-03-28Fixed "The this" typo in lua-filters.mdTatianaPorras1-1/+1
The documentation for Lua filters said "The this module defines..." This has been fixed to say "This module defines..."
2021-03-11JATS templates: support 'equal-contrib' attrib for authorsAlbert Krewinkel1-0/+9
Authors who contributed equally to a paper may be marked with `equal-contrib`.
2021-03-02Add doc/libraries.md.John MacFarlane1-0/+59
A description of libraries that support pandoc.