aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-11-16Update epub.mdVladimir Alexiev
minor typo s/above/about/
2022-10-25Lua: rename `reader_extensions`/`writer_extensions` globals...John MacFarlane
...as `Extensions`. Update documnetation. Include a custom extension in the documentation example. See #8390.
2022-10-24Remove sample.lua from data files (#8397)Albert Krewinkel
The file is kept around in the pandoc-lua-engine test-suite. Closes: #8356
2022-10-21Lua: add pandoc.scaffolding.Writer (#8377)Albert Krewinkel
This can be used to reduce boilerplate in custom writers.
2022-10-20Lua: add new module `pandoc.zip`Albert Krewinkel
Allows to handle docx and epub files.
2022-10-14Lua: Support built-in default templates for custom writersAlbert Krewinkel
Custom writers can define a default template via a global `Template` function; the data directory is no longer searched for a default template. Writer authors can restore the old lookup behavior with ``` lua Template = function () local template return template.compile(template.default(PANDOC_SCRIPT_FILE)) end ```
2022-10-14doc/custom-writers.md: fix formattingAlbert Krewinkel
2022-10-14doc/custom-writers.md: Rephrase paragraph on format extensions (#8375)Ilona
2022-10-12Lua: add function `pandoc.template.meta_to_context`.Albert Krewinkel
The functions converts Meta values to template contexts; the intended use is in combination with `pandoc.template.apply`.
2022-10-12Lua: support extensions in custom readers.Albert Krewinkel
Like custom readers, like writers, can define the set of supported extensions by setting a global. E.g.: ``` lua reader_extensions = { smart = true, citations = false, } ```
2022-10-11Lua: add function `pandoc.template.apply`Albert Krewinkel
The new function applies a context, containing variable assignments, to a template.
2022-10-10Lua: support extensions in custom writersAlbert Krewinkel
Custom writers can define the extensions that they support via the global `writer_extensions`. The variable's value must be a table with all supported extensions as keys, and their default status as values. E.g., the below specifies that the writer support the extensions `smart` and `sourcepos`, but only the `smart` extension is enabled by default: writer_extensions = { smart = true, sourcepos = false, }
2022-10-10doc/libraries.md: add hslua-cli and the hslua-module-* packagesAlbert Krewinkel
2022-10-10doc/lua-filters.md: deprecate PANDOC_WRITER_OPTIONS in custom writersAlbert Krewinkel
2022-10-10Lua: support custom bytestring readers.Albert Krewinkel
2022-10-09doc/lua-filters.md: fix typosAlbert Krewinkel
2022-10-08Update Lua filter doc: modify Zerobrane instructions to use Lua 5.4 (#8353)Ian Max Andolina
2022-10-03doc/lua-filters.md: fix documentation of PANDOC_WRITER_OPTIONS.Albert Krewinkel
2022-10-03doc/lua-filters.md: document pandoc.write_classic.Albert Krewinkel
2022-10-03[API Change] Support bytestring custom writers.Albert Krewinkel
New-style custom Lua writers can now define an alternative entry function `BinaryWriter`. If a function with that name is defined, then pandoc will treat the returned string as binary output. This allows to generate formats like docx and odt with custom writers.
2022-10-03Lua: deprecate classic custom writers.Albert Krewinkel
2022-10-03[API Change] Base custom writers on Writer type.Albert Krewinkel
The `T.P.Lua.writeCustom` function changed to allow either a TextWriter or ByteStringWriter to be returned. The global variables `PANDOC_DOCUMENT` and `PANDOC_WRITER_OPTIONS` are no longer set when the writer script is loaded. Both variables are still set in classic writers before the conversion is started, so they can be used when they are wrapped in functions.
2022-09-26pandoc-lua: support more command line flagsAlbert Krewinkel
2022-09-25doc: use cabal's --package-env more (#8317)Artem Pelenitsyn
2022-09-22Make pandoc behave like a Lua interpreter when called as `pandoc-lua`. (#8311)Albert Krewinkel
2022-08-29PandocServer: return error in JSON object if response is JSON.John MacFarlane
2022-08-26pandoc-server.md: fix documentation for highlight-style.John MacFarlane
2022-08-23docs/faqs.md: fix typo in faq on pdf generationAlbert Krewinkel
2022-08-21Fix typosluz paz
Found via `codespell -q 3 -S changelog.md -L bu,fo,ist,mke,multline,noes,ot,pard,pres,tabl,te,tothe`
2022-08-18pandoc-server.cgi: allow setting timeoutJohn MacFarlane
via PANDOC_SERVER_TIMEOUT environment variable.
2022-08-17pandoc-server.md: fix typoJohn MacFarlane
2022-08-17Integrate server into main pandoc.John MacFarlane
- Remove server flag. - Remove pandoc-server executable. - Add Text.Pandoc.Server as exposed module. [API change] - Re-use Opt (and our existing FromJSON instance) for Params. - Document.
2022-08-13Lua: add function `pandoc.utils.citeproc`Albert Krewinkel
The function runs the *citeproc* processor on a Pandoc document. Exposing this functionality to Lua allows to make citation processing part of a filter or writer, simplifies the creation of multiple bibliographies, and enables the use of varying citation styles in different parts of a document.
2022-08-02doc/libraries.md: add hslua packages written specifically for pandocAlbert Krewinkel
2022-07-30Add gridtables to doc/libraries.md.John MacFarlane
2022-07-27Fix bug in filter example. Thanks to Jiří Wolker.John MacFarlane
2022-07-15Lua: extend pandoc.system module. (#8184)Albert Krewinkel
The module now has the additional functions `list_directory`, `make_directory`, and `remove_directory`. This makes it easier to write cross-platform scripts that need to inspect or modify the file system.
2022-07-15lua-filters.md: Add link to @wlupton's logging.lua.John MacFarlane
Closes #8146.
2022-07-12Lua: add fields `pandoc.readers` and `pandoc.writers`. (#8177)Albert Krewinkel
The set of supported input and output formats is made available to Lua users.
2022-07-04Add FAQ on preventing column widths in pipe tables.John MacFarlane
See #8139.
2022-06-30Update filter.md Noto Sans CJK TC -> JP (#8153)Masataka Ogawa
Noto Sans CJK TC, that is suggested as a character set that contains Japanese characters, may not be suitable to properly display Japanese characters. Rather, Noto Sans CJK JP is much more recommendable for that purpose. Although some characters originated from China are quite similar among countries/regions, most of them have evolved into different shapes in Mainland China, Hong Kong, Taiwan, Japan, Korea, and Vietnam. Therefore, it is best to use a character set that the language of the country/region uses for the readability/recongnizability sake. See also [an webpage that discusses the glyph appearance issue in Chinese, Japanese, Korean, and Vietnamese languages](https://heistak.github.io/your-code-displays-japanese-wrong/). [README of Noto CJK](https://github.com/googlefonts/noto-cjk/blob/main/README.md) may be also good resource to know which font should be used to display characters of each language.
2022-06-24JATS template: mark authors with cor-id as corresponding authorsAlbert Krewinkel
Corresponding authors are marked by setting the attribute `corresp="yes"` in their respective `<contrib>` element.
2022-06-16doc/lua-filters.html: add list of common pitfallsAlbert Krewinkel
A list with common filtering and Lua pitfalls is added to the "debugging" section. Closes: #6077
2022-06-14add `--embed-resources` flag (#8121)Elliot Bobrow
* Add `--embed-resources` flag for `--self-contained` without implying `--standalone` * Deprecate `--self-contained flag` Closes #7331
2022-06-14Make clear that walk performs a deep copy (#8124)Bastien Dumont
Relevant discussion here: https://groups.google.com/g/pandoc-discuss/c/-NoL3Ft9AC8 I felt that it could be useful to inform that walk is the only way to get a deep copy of a List. I wrote this where I think that users will likely loop up for this feature, but it may be out of place.
2022-06-06Add press.md (formerly press.txt in website).John MacFarlane
2022-06-06Lua: add function pandoc.mediabag.fill (#8104)Albert Krewinkel
The function allows to fill the mediabag with all images in a given document. Images that cannot be fetched are replaced with a Span containing the image description.
2022-04-04JATS template: allow multiple licenses to be given.Albert Krewinkel
The `license` metadata field can now be used to set the license of an article; a list can be used to add multiple license statements.
2022-04-02JATS template: allow multiple copyright statements, years, holdersAlbert Krewinkel
2022-03-30Lua: allow to pass Sources to pandoc.read (#8002)Albert Krewinkel
Sources, the data type passed to the `Reader` function in custom readers, are now accepted as input to `pandoc.read`.