John MacFarlane
0a298cb1be
Lua filters documentation: remove reference to phrenology.
...
Closes #9024 .
2023-08-25 16:23:52 -07:00
Matt Dodson
bb412768d8
doc/lua-filters: use full field name in example ( #8857 )
...
Remove old `.c` alias that mimics the JSON representation:
- Since 2.15ish, the lua structure no longer closely resembles that
JSON representation
- even if it did, introductory examples should be explicit. Using
an undocumented alias creates ambiguity.
2023-05-17 23:09:23 +02:00
thron7
7ec7512aa0
doc/lua-filters.md: fix copy-and-paste error ( #8798 )
2023-04-20 13:17:12 +02:00
Toni Dietze
2b420a1f89
doc/lua-filters.md: fix wrong anchor
2023-04-05 18:46:10 +02:00
perro tuerto
2007fdd575
doc/lua-filter.md: Fix typos. ( #8734 )
2023-03-30 07:18:41 +02:00
Albert Krewinkel
f1b55be65f
T.P.Format: add new function formatFromFilePaths [API Change] ( #8710 )
...
* T.P.Format: export `formatFromFilePaths` [API change]
* Lua: add function `pandoc.format.from_path`
* Update lua-filters.md
* The old T.P.App.FormatHeuristics module has been removed.
This is an alternative to #8693 .
2023-03-20 21:19:16 -07:00
Albert Krewinkel
8346cfad4c
lua-filters: auto-generate docs for pandoc.system module.
2023-03-20 16:06:19 +01:00
Albert Krewinkel
936f44d460
lua-filters: auto-generate docs for pandoc.text module.
2023-03-20 16:06:18 +01:00
Albert Krewinkel
ed5197f525
Lua: load text module as pandoc.text.
...
This only affects the name in the Lua-internal documentation. It is
still possible to load the modules via `require 'text'`, although this
is deprecated.
2023-03-20 16:06:18 +01:00
Albert Krewinkel
4e2949ceca
lua-filters: Move docs from module text to pandoc.text
...
The latter is easier to use and more consistent with the other modules.
2023-03-20 09:15:56 +01:00
Albert Krewinkel
a53a6edfa5
lua-filters.md: Generate docs for pandoc.utils
...
The documentation in the Haskell sources has been updated.
2023-03-20 08:30:04 +01:00
Albert Krewinkel
a37eda9713
lua-filters.md: auto-generate docs for more modules
2023-03-19 22:39:15 +01:00
Albert Krewinkel
7743c5287a
Lua: add info on when functions became available in pandoc
2023-03-19 15:09:23 +01:00
Albert Krewinkel
07c56322c2
lua-filters.md: generate docs from Haskell for pandoc.structure
2023-03-19 13:35:02 +01:00
Albert Krewinkel
ec1a06f5ef
lua-filters.md: autogenerate parts of the Lua API docs
2023-03-19 12:33:04 +01:00
Albert Krewinkel
203a652e43
Lua: add pandoc.cli.repl function
2023-03-18 15:00:45 -07:00
Albert Krewinkel
a496a3409f
doc/lua-filters.md: improve docs for pandoc.zip.
2023-03-10 18:40:26 +01:00
Morgan Willcock
33cf42b78f
Doc: fix typo in run_json_filter
2023-02-18 22:46:08 +01:00
Albert Krewinkel
45367cdd37
Lua: add new function pandoc.system.cputime.
...
The function returns the CPU time consumed by pandoc and can be used to
benchmark Lua computations.
2023-02-14 09:44:20 -08:00
Albert Krewinkel
75b5851d21
Lua: add module pandoc.json to handle JSON encoding
...
Closes : #8605
2023-02-11 14:53:53 -08:00
Albert Krewinkel
9eee4a2582
Lua: add field chunk_template to WriterOptions objects [API change]
...
The PathTemplate type exported from Text.Pandoc.Chunks is now an
instance of the ToJSON and FromJSON classes.
Closes : #8607
2023-02-09 08:15:13 +01:00
Martin Joerg
d9a7d473d9
Fix typos
2023-02-07 10:44:16 +01:00
Albert Krewinkel
5f31a01d77
doc/lua-filters.md: document 'Figure' type and constructor
2023-01-28 18:12:26 +01:00
Carlos Scheidegger
b1e4a9eecf
Fix typo
...
`#types-chunkeddoc` -> `#type-chunkeddoc`
2023-01-23 20:32:36 +01:00
Albert Krewinkel
3a0fc17880
Lua: add function pandoc.format.extensions.
...
This simplifies the creation of custom readers and writers that are
based on built-in formats.
2023-01-18 08:59:53 -08:00
Albert Krewinkel
5d58f060ac
Lua: Add function pandoc.mediabag.write.
...
Allows to write the complete mediabag or just a specific file to a given
directory.
2023-01-16 10:12:09 -08:00
Albert Krewinkel
cdf8c69fb9
Lua: add module pandoc.structure.
...
Adds support for table of contents and chunks handling. The function
`make_sections` has been given a friendlier interface and was moved to
the new module; the old `pandoc.utils.make_sections` has been
deprecated.
2023-01-15 10:47:54 -08:00
Albert Krewinkel
8f394a17f2
Remove Null constructor from docs
2023-01-14 10:10:26 +01:00
Albert Krewinkel
8862d5e0dd
Lua: add functions pandoc.text.toencoding, pandoc.text.fromencoding.
...
Closes : #8512
2023-01-03 10:35:22 +01:00
Albert Krewinkel
1328e57f08
Shared: use LineBreak as default block sep in blocksToInlines
...
This change also affects the `pandoc.utils.blocks_to_inlines` Lua
function.
Closes : #8499
2022-12-20 13:39:16 -08:00
Albert Krewinkel
a36f12119f
Lua: allow table structure as format spec.
...
This allows to pass structured values as format specifiers to
`pandoc.write` and `pandoc.read`.
2022-12-16 10:43:01 -08:00
Albert Krewinkel
928dde57b9
Lua: add pandoc.cli module
...
Allow processing of CLI options in Lua.
2022-12-12 09:35:21 -08:00
TomBen
18874be79d
Fix a tiny typo in lua-filters.md
2022-12-07 21:28:36 -08:00
Albert Krewinkel
e0e6087145
Shared: change defaultBlocksSeparator to PARAGRAPH SEPARATOR
...
This Unicode char (U+2029) is intended as a semantic separator between
paragraphs; it is cleaner and less intrusive than the pilcrow sign that
we used before. This also changes the default `sep` value used in the
`pandoc.utils.blocks_to_inlines` Lua function.
2022-12-08 00:24:07 +01:00
Albert Krewinkel
b34ec00607
doc/lua-filters.md: add documentation for pandoc.format
2022-12-03 16:22:19 +01:00
Albert Krewinkel
e243cd696f
Lua: add pandoc.scaffolding.Writer ( #8377 )
...
This can be used to reduce boilerplate in custom writers.
2022-10-21 10:11:45 -07:00
Albert Krewinkel
f711c7f2aa
Lua: add new module pandoc.zip
...
Allows to handle docx and epub files.
2022-10-20 09:11:57 -07:00
Albert Krewinkel
14c7b5db20
Lua: add function pandoc.template.meta_to_context.
...
The functions converts Meta values to template contexts; the intended
use is in combination with `pandoc.template.apply`.
2022-10-12 10:16:01 -07:00
Albert Krewinkel
78d7fc46fe
Lua: add function pandoc.template.apply
...
The new function applies a context, containing variable assignments, to
a template.
2022-10-11 14:03:08 -07:00
Albert Krewinkel
8f4308f2e5
doc/lua-filters.md: deprecate PANDOC_WRITER_OPTIONS in custom writers
2022-10-10 12:09:09 +02:00
Albert Krewinkel
654059efed
doc/lua-filters.md: fix typos
2022-10-09 11:48:03 +02:00
Ian Max Andolina
2d27a06312
Update Lua filter doc: modify Zerobrane instructions to use Lua 5.4 ( #8353 )
2022-10-08 18:27:50 -07:00
Albert Krewinkel
2d565eda9e
doc/lua-filters.md: fix documentation of PANDOC_WRITER_OPTIONS.
2022-10-03 20:01:55 +02:00
Albert Krewinkel
59e9df4262
doc/lua-filters.md: document pandoc.write_classic.
2022-10-03 19:57:02 +02:00
luz paz
aff726b460
Fix typos
...
Found via `codespell -q 3 -S changelog.md -L bu,fo,ist,mke,multline,noes,ot,pard,pres,tabl,te,tothe`
2022-08-21 20:23:00 -07:00
Albert Krewinkel
5a99747063
Lua: add function pandoc.utils.citeproc
...
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-13 12:30:13 -07:00
Albert Krewinkel
daef24f022
Lua: extend pandoc.system module. ( #8184 )
...
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-15 21:22:33 +02:00
John MacFarlane
7119fee963
lua-filters.md: Add link to @wlupton's logging.lua.
...
Closes #8146 .
2022-07-15 21:18:21 +02:00
Albert Krewinkel
12cc140272
Lua: add fields pandoc.readers and pandoc.writers. ( #8177 )
...
The set of supported input and output formats is made available to Lua
users.
2022-07-12 20:14:42 +02:00
Albert Krewinkel
37fc412daa
doc/lua-filters.html: add list of common pitfalls
...
A list with common filtering and Lua pitfalls is added to the
"debugging" section.
Closes : #6077
2022-06-16 17:40:33 +02:00