git.iko.soy/typeable/pandoc
on master help sign in
Update changelog and man page.
commitcdbb14de5b1b688b664676f1cf623db2c666235b authorJohn MacFarlane <jgm@berkeley.edu> dateSat 15 Feb 2020, 21:26 (7 years ago) parent33fcac4
4 files changed+244−29
AUTHORS.md+3 MANUAL.txt+1−1 changelog.md+204 man/pandoc.1+36−28
AUTHORS.md+3
@@ -36,6 +36,7 @@
3636- Brian Leung
3737- Bryan O'Sullivan
3838- Caleb McDaniel
39+- Caleb Mclennan
3940- Calvin Beck
4041- Carlos Sosa
4142- Chris Black
@@ -67,6 +68,7 @@
6768- Eric Kow
6869- Eric Seidel
6970- Eric Schrijver
71+- Ethan Riley
7072- Étienne Bersac
7173- Felix Yan
7274- Félix Baylac-Jacqué
@@ -127,6 +129,7 @@
127129- Jose Luis Duran
128130- José de Mattos Neto
129131- Josef Svenningsson
132+- Joseph C. Sible
130133- Julien Cretel
131134- Juliusz Gonera
132135- Justin Bogner
MANUAL.txt+1−1
@@ -1,7 +1,7 @@
11---
22title: Pandoc User's Guide
33author: John MacFarlane
4−date: January 5, 2020
4+date: February 15, 2020
55---
66
77# Synopsis
changelog.md+204
@@ -1,5 +1,209 @@
11# Revision history for pandoc
22
3+## pandoc 2.9.2 (2020-02-15)
4+
5+ * Add `csv` as an input format (#6100). The CSV table is converted into a
6+ pandoc simple table. A new module Text.Pandoc.Readers.CSV
7+ exports `readCSV` [API change].
8+
9+ * Introduce new format variants for JATS writer (#6014, Albert Krewinkel):
10+
11+ - `jats_archiving` for the "Archiving and Interchange Tag Set",
12+ - `jats_publishing` for the "Journal Publishing Tag Set", and
13+ - `jats_articleauthoring` for the "Article Authoring Tag Set."
14+
15+ The `jats` output format is now an alias for `jats_archiving`.
16+ The module Text.Pandoc.Writers.JATS now exports
17+ `writeJatsArchiving`, `writeJatsPublishing`, and
18+ `writeJatsArticleAuthoring`, as well as the legacy
19+ `writeJATS` [API change].
20+
21+ * `--defaults`: Support `bibliography` and `csl` fields.
22+ Move `addMeta` from Text.Pandoc.App.CommandLineOptions to
23+ Text.Pandoc.App.Opt (internal change).
24+
25+ * Add timing info for filters in `--verbose` mode (#6112).
26+ When verbose mode is specified (verbosity == INFO), print a
27+ notice when running a filter and when a filter completes (including
28+ timing).
29+
30+ * LaTeX reader:
31+
32+ + Allow `&` in LaTeX citation keys (#6110).
33+ + Improve caption and label parsing.
34+ + Don't emit empty Span elements for labels.
35+ + Put tables with labels in a surrounding Div.
36+ + Resolve `\ref` to table numbers (#6137).
37+ + Skip comments in more places where this is needed (#6114).
38+ + Allow beamer overlays for all commands in all raw tex (#6043).
39+ This affects parsing of raw tex in LaTeX and in Markdown and
40+ other formats.
41+ + Improve parsing of raw environments (#6034). If parsing fails
42+ in a raw environment (e.g. due to special characters like unescaped
43+ `_`), try again as a verbatim environment, which is less sensitive to
44+ special characters. This allows us to capture special environments
45+ that change catcodes as raw tex when `-f latex+raw_tex` is used.
46+
47+ * RST reader:
48+
49+ + Add highlight directive (#6140, Lucas Escot).
50+
51+ * MediaWiki writer:
52+
53+ + Prevent triple `[[[` which confuses MediaWiki (#6119).
54+
55+ * HTML reader:
56+
57+ + Don't parse `data-id` as `id` attribute. And similarly don't
58+ parse any `data-X` as `X` when `X` is a valid HTML attribute.
59+
60+ * Org reader:
61+
62+ + Simplify parsing of sub- and superscripts (#6127, Albert Krewinkel).
63+ Speeds up parsing of single-word, markup-less sub- and superscripts.
64+
65+ * LaTeX writer:
66+
67+ + Group biblatex citations even with prefix and suffix (#5849, Ethan
68+ Riley). Previously biblatex citations were only grouped if there
69+ was no prefix. This patch allows them to be grouped in subgroups split
70+ by prefixes and suffixes, which allows better citation sorting.
71+ + Fix regression in handling of columns in beamer slides (#6033).
72+ Columns in title slides were causing problems with
73+ slide division.
74+ + Fix duplicate frame classes in LaTeX/Beamer output (#6107).
75+
76+ * HTML writer:
77+
78+ + Fix duplicate attributes on headings (#6062), regression from 2.7.x.
79+ + Fix `--number-offset` with HTML TOC. Eventually it would be worth
80+ adding a parameter to `makeSections` so this could be done at that
81+ level; then it would also affect other writers that construct
82+ TOC manually.
83+ + reveal.js: restore old behavior for 2D nesting (#6032).
84+ The fix to #6030 actually changed behavior, so that the
85+ 2D nesting occurred at slide level N-1 and N, instead of
86+ at the top-level section. This commit restores the v2.7.3 behavior.
87+ If there are more than 2 levels, the top level is horizontal
88+ and the rest are collapsed to vertical.
89+ + reveal.js: ensure that pauses work even in title slides (#5819).
90+
91+ * Markdown writer:
92+
93+ + Fix regression: spurious dots in markdown_mmd metadata output (#6133).
94+
95+ * Docx writer:
96+
97+ + Fix regression with Compact style on tight lists (#6072).
98+ Starting in 2.8, the docx writer no longer distinguishes between tight
99+ and loose lists, since the Compact style is omitted. This is a
100+ side-effect of the fix to #5670, as explained in the changelog. This
101+ patch fixes the problem by extending the exception currently offered to
102+ Plain blocks inside tables to Plain blocks inside list items.
103+
104+ * Jira writer:
105+
106+ + Fix output of table headers (Albert Krewinkel, #6035).
107+
108+ * Add Text.Pandoc.Image with unexported svgToPng.
109+
110+ * Moved html5Attributes, html4Attributes, rdfaAttributes
111+ from T.P.Writers.HTML (where they were unexported) to
112+ T.P.XML (where they are now exported).
113+ [API change: new exported functions]
114+ This allows these sets to be used elsewhere, e.g.
115+ in the HTML reader.
116+
117+ * Text.Pandoc.Shared: Export a new function `findM` (#6125,
118+ Joseph C. Sible).
119+
120+ * Text.Pandoc.Logging: Add `RunningFilter`, `FilterCompleted`
121+ constructors to LogMessage [API change].
122+
123+ * Text.Pandoc.CSV: fix bug in CSV parser; previously an extra blank record
124+ would sometimes be inserted at the end.
125+
126+ * LaTeX template: add space option to xeCJK with PassOptionsToPackage
127+ (#6002). Otherwise we can get a clash with documentclasses that
128+ already load the package.
129+
130+ * Lua filters:
131+
132+ + Allow filtering of element lists (#6038, Albert Krewinkel). Lists of
133+ Inline and Block elements can now be filtered via `Inlines` and
134+ `Blocks` functions, respectively. This is helpful if a filter
135+ conversion depends on the order of elements rather than a single
136+ element. For example, the following filter can be used to remove all
137+ spaces before a citation:
138+
139+ function isSpaceBeforeCite (spc, cite)
140+ return spc and spc.t == 'Space'
141+ and cite and cite.t == 'Cite'
142+ end
143+
144+ function Inlines (inlines)
145+ for i = #inlines-1,1,-1 do
146+ if isSpaceBeforeCite(inlines[i], inlines[i+1]) then
147+ inlines:remove(i)
148+ end
149+ end
150+ return inlines
151+ end
152+
153+ + Add methods `insert`, `remove`, and `sort` to pandoc.List
154+ (Albert Krewinkel). Example of use:
155+
156+ local numbers = pandoc.List {2, 3, 1}
157+ numbers:sort() -- numbers is now {1, 2, 3}
158+ + Make `pandoc.List` a callable constructor (Albert Krewinkel).
159+ It is now possible to construct a new List via
160+ `pandoc.List()` instead of `pandoc.List:new()`.
161+ + Add tests for pandoc.List module (Albert Krewinkel).
162+
163+ * Text.Pandoc.App.CommandLineOptions: Change `setVariable` to use `Text`
164+ instead of `String`. This avoids some unnecessary unpacking.
165+
166+ * Use versioned directory for windows release zipfile.
167+ Also remove old `make-windows-installer.bat`, superseded by GitHub
168+ actions workflow, and modify `pandoc.wxs` for new paths.
169+
170+ * Extensive code cleanup (#6141, #6128, #6129, #6130, #6123,
171+ #6105, 6102, #6117, #6124, #6115, #6116, #6111, Joseph C. Sible).
172+
173+ * Fix hlint warnings (Albert Krewinkel).
174+
175+ * Use latest doclayout, doctemplates (#6031). The new version of
176+ doclayout fixes a memory leak that affected `--include-in-header` with
177+ large files (and possibly other cases involving extremely long lines).
178+
179+ * Use latest texmath.
180+
181+ * Use latest skylighting and fix test suite (#6086).
182+
183+ * sample.lua: Fix typo in descriptive comments (#6136, Caleb Maclennan).
184+ Fix typo in error message (#6135).
185+
186+ * Add Docker and GH Actions instructions/links to INSTALL.md.
187+
188+ * Update filter documentation (#6065). Improve cabal v2 instructions.
189+ Remove example using pandoc API directly (we have other
190+ docs for that and it was outdated).
191+
192+ * Lua filter docs:
193+
194+ + Cross-link constructors and types (Albert Krewinkel).
195+ Thanks to @bpj for the idea.
196+ + Sort pandoc.List methods alphabetically (Albert Krewinkel).
197+ + Unify, fix anchors and internal links (#6061, Albert Krewinkel).
198+ Links and anchors now follow consistent conventions, like
199+ lowercase-only anchor names. This breaks some links to specific
200+ sections in the document, but will make it much easier to link
201+ documentation in the future.
202+ + Clarify filter function execution order (#6059, Albert Krewinkel).
203+
204+ * In docs, update URLs and use `https:` wherever possible (#6090,
205+ Salim B).
206+
3207## pandoc 2.9.1.1 (2020-01-05)
4208
5209 * Markdown reader:
man/pandoc.1+36−28
@@ -1,7 +1,7 @@
11.\"t
2−.\" Automatically generated by Pandoc 2.9.1
2+.\" Automatically generated by Pandoc 2.9.2
33.\"
4−.TH "Pandoc User\[aq]s Guide" "" "January 5, 2020" "pandoc 2.9.1.1" ""
4+.TH "Pandoc User\[aq]s Guide" "" "February 15, 2020" "pandoc 2.9.2" ""
55.hy
66.SH NAME
77pandoc - general markup converter
@@ -206,7 +206,7 @@ In this case pandoc will fetch the content using HTTP:
206206.IP
207207.nf
208208\f[C]
209−pandoc -f html -t markdown http://www.fsf.org
209+pandoc -f html -t markdown https://www.fsf.org
210210\f[R]
211211.fi
212212.PP
@@ -216,7 +216,7 @@ requesting a document from a URL:
216216.nf
217217\f[C]
218218pandoc -f html -t markdown --request-header User-Agent:\[dq]Mozilla/5.0\[dq] \[rs]
219− http://www.fsf.org
219+ https://www.fsf.org
220220\f[R]
221221.fi
222222.SH OPTIONS
@@ -231,6 +231,8 @@ Specify input format.
231231.IP \[bu] 2
232232\f[C]creole\f[R] (Creole 1.0)
233233.IP \[bu] 2
234+\f[C]csv\f[R] (CSV table)
235+.IP \[bu] 2
234236\f[C]docbook\f[R] (DocBook)
235237.IP \[bu] 2
236238\f[C]docx\f[R] (Word docx)
@@ -342,7 +344,13 @@ HTML5/XHTML polyglot markup)
342344.IP \[bu] 2
343345\f[C]ipynb\f[R] (Jupyter notebook)
344346.IP \[bu] 2
345−\f[C]jats\f[R] (JATS XML)
347+\f[C]jats_archiving\f[R] (JATS XML, Archiving and Interchange Tag Set)
348+.IP \[bu] 2
349+\f[C]jats_articleauthoring\f[R] (JATS XML, Article Authoring Tag Set)
350+.IP \[bu] 2
351+\f[C]jats_publishing\f[R] (JATS XML, Journal Publishing Tag Set)
352+.IP \[bu] 2
353+\f[C]jats\f[R] (alias for \f[C]jats_archiving\f[R])
346354.IP \[bu] 2
347355\f[C]jira\f[R] (Jira wiki markup)
348356.IP \[bu] 2
@@ -406,7 +414,7 @@ HTML5/XHTML polyglot markup)
406414.IP \[bu] 2
407415\f[C]zimwiki\f[R] (ZimWiki markup)
408416.IP \[bu] 2
409−the path of a custom lua writer, see Custom writers below
417+the path of a custom Lua writer, see Custom writers below
410418.PP
411419Note that \f[C]odt\f[R], \f[C]docx\f[R], \f[C]epub\f[R], and
412420\f[C]pdf\f[R] output will not be directed to \f[I]stdout\f[R] unless
@@ -603,25 +611,25 @@ above).
603611.IP "3." 3
604612\f[C]$PATH\f[R] (executable only)
605613.PP
606−Filters and lua-filters are applied in the order specified on the
614+Filters and Lua-filters are applied in the order specified on the
607615command line.
608616.RE
609617.TP
610618\f[B]\f[CB]-L\f[B]\f[R] \f[I]SCRIPT\f[R], \f[B]\f[CB]--lua-filter=\f[B]\f[R]\f[I]SCRIPT\f[R]
611619Transform the document in a similar fashion as JSON filters (see
612−\f[C]--filter\f[R]), but use pandoc\[aq]s build-in lua filtering system.
613−The given lua script is expected to return a list of lua filters which
620+\f[C]--filter\f[R]), but use pandoc\[aq]s build-in Lua filtering system.
621+The given Lua script is expected to return a list of Lua filters which
614622will be applied in order.
615−Each lua filter must contain element-transforming functions indexed by
623+Each Lua filter must contain element-transforming functions indexed by
616624the name of the AST element on which the filter function should be
617625applied.
618626.RS
619627.PP
620−The \f[C]pandoc\f[R] lua module provides helper functions for element
628+The \f[C]pandoc\f[R] Lua module provides helper functions for element
621629creation.
622−It is always loaded into the script\[aq]s lua environment.
630+It is always loaded into the script\[aq]s Lua environment.
623631.PP
624−The following is an example lua script for macro-expansion:
632+The following is an example Lua script for macro-expansion:
625633.IP
626634.nf
627635\f[C]
@@ -637,7 +645,7 @@ return {{Str = expand_hello_world}}
637645\f[R]
638646.fi
639647.PP
640−In order of preference, pandoc will look for lua filters in
648+In order of preference, pandoc will look for Lua filters in
641649.IP "1." 3
642650a specified full or relative path (executable or non-executable)
643651.IP "2." 3
@@ -1688,7 +1696,7 @@ include-after-body: []
16881696include-in-header: []
16891697resource-path: [\[dq].\[dq]]
16901698
1691−# filters will be assumed to be lua filters if they have
1699+# filters will be assumed to be Lua filters if they have
16921700# the .lua extension, and json filters otherwise. But
16931701# the filter type can also be specified explicitly, as shown:
16941702filters:
@@ -4983,7 +4991,7 @@ Thus, for example, pandoc will turn
49834991<table>
49844992<tr>
49854993<td>*one*</td>
4986−<td>[a link](http://google.com)</td>
4994+<td>[a link](https://google.com)</td>
49874995</tr>
49884996</table>
49894997\f[R]
@@ -4996,7 +5004,7 @@ into
49965004<table>
49975005<tr>
49985006<td><em>one</em></td>
4999−<td><a href=\[dq]http://google.com\[dq]>a link</a></td>
5007+<td><a href=\[dq]https://google.com\[dq]>a link</a></td>
50005008</tr>
50015009</table>
50025010\f[R]
@@ -5154,7 +5162,7 @@ a link:
51545162.IP
51555163.nf
51565164\f[C]
5157−<http://google.com>
5165+<https://google.com>
51585166<sam\[at]green.eggs.ham>
51595167\f[R]
51605168.fi
@@ -5167,7 +5175,7 @@ the URL in parentheses.
51675175.nf
51685176\f[C]
51695177This is an [inline link](/url), and here\[aq]s [one with
5170−a title](http://fsf.org \[dq]click here for a good time!\[dq]).
5178+a title](https://fsf.org \[dq]click here for a good time!\[dq]).
51715179\f[R]
51725180.fi
51735181.PP
@@ -5207,7 +5215,7 @@ Here are some examples:
52075215\f[C]
52085216[my label 1]: /foo/bar.html \[dq]My title, optional\[dq]
52095217[my label 2]: /foo
5210−[my label 3]: http://fsf.org (The free software foundation)
5218+[my label 3]: https://fsf.org (The free software foundation)
52115219[my label 4]: /bar#special \[aq]A title in single quotes\[aq]
52125220\f[R]
52135221.fi
@@ -5224,7 +5232,7 @@ The title may go on the next line:
52245232.IP
52255233.nf
52265234\f[C]
5227−[my label 3]: http://fsf.org
5235+[my label 3]: https://fsf.org
52285236 \[dq]The free software foundation\[dq]
52295237\f[R]
52305238.fi
@@ -5684,7 +5692,7 @@ references:
56845692 issue: 4356
56855693 page: 737-738
56865694 DOI: 10.1038/171737a0
5687− URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5695+ URL: https://www.nature.com/articles/171737a0
56885696 language: en-GB
56895697\&...
56905698\f[R]
@@ -5973,7 +5981,7 @@ extension.
59735981\f[C]
59745982This is a reference ![image][ref] with multimarkdown attributes.
59755983
5976−[ref]: http://path.to/image \[dq]Image title\[dq] width=20px height=30px
5984+[ref]: https://path.to/image \[dq]Image title\[dq] width=20px height=30px
59775985 id=myId class=\[dq]myClass1 myClass2\[dq]
59785986\f[R]
59795987.fi
@@ -6723,7 +6731,7 @@ For example:
67236731.nf
67246732\f[C]
67256733<audio controls=\[dq]1\[dq]>
6726− <source src=\[dq]http://example.com/music/toccata.mp3\[dq]
6734+ <source src=\[dq]https://example.com/music/toccata.mp3\[dq]
67276735 data-external=\[dq]1\[dq] type=\[dq]audio/mpeg\[dq]>
67286736 </source>
67296737</audio>
@@ -7019,11 +7027,11 @@ reference-doc while creating docx output (see below), and maintain the
70197027same styles in your input and output files.
70207028.SH CUSTOM WRITERS
70217029.PP
7022−Pandoc can be extended with custom writers written in lua.
7023−(Pandoc includes a lua interpreter, so lua need not be installed
7030+Pandoc can be extended with custom writers written in Lua.
7031+(Pandoc includes a Lua interpreter, so Lua need not be installed
70247032separately.)
70257033.PP
7026−To use a custom writer, simply specify the path to the lua script in
7034+To use a custom writer, simply specify the path to the Lua script in
70277035place of the output format.
70287036For example:
70297037.IP
@@ -7033,7 +7041,7 @@ pandoc -t data/sample.lua
70337041\f[R]
70347042.fi
70357043.PP
7036−Creating a custom writer requires writing a lua function for each
7044+Creating a custom writer requires writing a Lua function for each
70377045possible element in a pandoc document.
70387046To get a documented example which you can modify according to your
70397047needs, do