John MacFarlane
0a298cb1be
Lua filters documentation: remove reference to phrenology.
...
Closes #9024 .
2023-08-25 16:23:52 -07:00
Diogo Almiro
aa21f79e89
Documentation - FAQs - Links ( #8978 )
...
Fix some links and add link text.
2023-08-04 09:51:54 -07:00
Vladimir Alexiev
52297a2bd3
add to "Academic publishing workflows" ( #8742 )
...
resolves #8696
2023-06-22 10:45:49 -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
Christian Christiansen
8db71cecb5
Update documentation for org-mode
...
Add zero width space to the default values of pandoc-emphasis-pre and
pandoc-emphasis-post. Zero width space was added to solve issue #8716 .
2023-03-28 09:32:34 -07: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
a23d14079c
pandoc-cli: add a Lua REPL
2023-03-17 09:18:41 -07:00
John MacFarlane
1c70458f3e
Add some notes on using NiX to develop pandoc.
2023-03-15 09:14:41 -07:00
John MacFarlane
7ce7c74711
Add doc/extras.md.
...
This was in the website repo; now we'll keep it here and copy it over.
2023-03-14 16:02:46 -07:00
John MacFarlane
32e351ba8b
doc/org.md: suggest use of -s to get metadata fields.
...
See #8688 . Obsoletes #8690 .
2023-03-13 19:28:15 -07:00
Albert Krewinkel
a496a3409f
doc/lua-filters.md: improve docs for pandoc.zip.
2023-03-10 18:40:26 +01:00
John MacFarlane
da66390f83
Add note on converting from .doc format to FAQs.
...
See #8654 .
2023-02-23 23:35:55 -08:00
Albert Krewinkel
f5b3a88017
doc/press.md: Add article on CiTO in J Cheminform by @egonw.
2023-02-19 09:12:48 +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
20d957a325
docs/custom-readers.md: Update JSON parsing example
...
The example now uses the built-in `pandoc.json` library to parse the API
output.
2023-02-12 11:21:14 +01: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
James Scott-Brown
456bd09877
fix formatting of link in pandoc-server.md
2023-01-20 00:10:25 +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
Ilona Silverwood
671cfcd869
doc/custom-reader.md: rewrite BytestringReader paragraph
2023-01-18 17:24:00 +01:00
John MacFarlane
70e6f51b96
Add FAQ on producing pdf/a.
...
See #3215 .
2023-01-17 19:29:30 -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
John MacFarlane
d7960212c0
Replace --epub-chapter-level with --split-level.
...
Rationale: we need this splitting level now not just in
EPUB but in chunked HTML.
`--epub-chapter-level` will still function as a deprecated
synonynm. `epub-chapter-level` will also continue to work in
defaults files, ande `epub_chapter_level` will still work for
Lua marshalling.
[API changes]
Text.Pandoc.App.Opt: remove `optEpubChapterLevel`, add
`optSplitLevel`.
Text.Pandoc.Options: remove `writerEpubChapterLevel`, add
`writerSplitLevel`.
2023-01-12 09:04:29 -08:00
John MacFarlane
61518584b4
Updated some references to master -> main.
2023-01-11 09:18:15 -08:00
R. N. West
660392bd95
Add missing backtick in filters.md
2023-01-10 22:35:33 +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