diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ * Write or improve documentation. If you ran into a problem which took more time to figure out than expected, please consider to save other users from the same experience. People writing the - documentation tend to lack an outside few, so please help + documentation tend to lack an outside view, so please help provide one. Good documentation is both difficult and extremely important. @@ -288,7 +288,8 @@ before creating a commit: #!/bin/sh - git diff --cached --name-only | grep '\.hs$' | xargs hlint + git diff --diff-filter=MA --cached --name-only | grep '\.hs$' | \ + xargs hlint --hint .hlint.yaml Saving this to `.git/hooks/pre-commit`, and making the script executable, will prevent accidental introduction of potentially diff --git a/changelog.md b/changelog.md --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,18 @@ # Revision history for pandoc +## pandoc 2.11.3.1 (2020-12-18) + + * Added some missing files to extra-source-files and data + files, so they are included in the sdist tarball. Closes #6961. + Cleaned up some extraneous data and test files, and added + a CI check to ensure that the test and data files included + in the sdist match what is in the git repository. + + * Use citeproc 0.3.0.1, which avoids removing nonbreaking + space at the end of the `initialize-with` attribute. (Some + journals require nonbreaking space after initials, and this + makes that possible.) + ## pandoc 2.11.3 (2020-12-17) * With `--bibliography` (or `bibliography` in metadata), a diff --git a/data/templates/affiliations.jats b/data/templates/affiliations.jats new file mode 100644 --- /dev/null +++ b/data/templates/affiliations.jats @@ -0,0 +1,38 @@ +$-- +$-- Affiliations +$-- +$for(affiliation)$ + +$-- wrap affiliation if it has a known institution identifier +$if(affiliation.group)$ +$affiliation.group$ +$endif$ +$if(affiliation.department)$ +$affiliation.department$ +$endif$ + +$if(affiliation.organization)$ +$affiliation.organization$ +$else$ +$affiliation.name$ +$endif$ +$if(affiliation.isni)$ +$affiliation.isni$ +$endif$ +$if(affiliation.ringgold)$ +$affiliation.ringgold$ +$endif$ +$if(affiliation.ror)$ +$affiliation.ror$ +$endif$ +$for(affiliation.pid)$ +$affiliation.pid.id$ +$endfor$ +$if(affiliation.street-address)$, +$for(affiliation.street-address)$ +$affiliation.street-address$$sep$, +$endfor$ +$else$$if(affiliation.city)$, $affiliation.city$$endif$$endif$$if(affiliation.country)$, +$affiliation.country$$endif$ + +$endfor$ diff --git a/man/pandoc.1 b/man/pandoc.1 --- a/man/pandoc.1 +++ b/man/pandoc.1 @@ -1,7 +1,7 @@ '\" t .\" Automatically generated by Pandoc 2.11.3 .\" -.TH "Pandoc User\[cq]s Guide" "" "December 17, 2020" "pandoc 2.11.3" "" +.TH "Pandoc User\[cq]s Guide" "" "December 17, 2020" "pandoc 2.11.3.1" "" .hy .SH NAME pandoc - general markup converter diff --git a/pandoc.cabal b/pandoc.cabal --- a/pandoc.cabal +++ b/pandoc.cabal @@ -1,6 +1,6 @@ cabal-version: 2.2 name: pandoc -version: 2.11.3 +version: 2.11.3.1 build-type: Simple license: GPL-2.0-or-later license-file: COPYING.md @@ -84,6 +84,7 @@ data/templates/default.epub2 data/templates/default.epub3 data/templates/article.jats_publishing + data/templates/affiliations.jats -- translations data/translations/*.yaml -- source files for reference.docx @@ -286,6 +287,7 @@ test/tables.opendocument test/tables.org test/tables.asciidoc + test/tables.asciidoctor test/tables.haddock test/tables.texinfo test/tables.rst @@ -298,6 +300,7 @@ test/tables/*.html4 test/tables/*.html5 test/tables/*.native + test/tables/*.jats_archiving test/testsuite.txt test/writer.latex test/writer.context @@ -318,6 +321,7 @@ test/writer.opendocument test/writer.org test/writer.asciidoc + test/writer.asciidoctor test/writer.haddock test/writer.rst test/writer.icml @@ -400,7 +404,7 @@ blaze-markup >= 0.8 && < 0.9, bytestring >= 0.9 && < 0.12, case-insensitive >= 1.2 && < 1.3, - citeproc >= 0.3 && < 0.4, + citeproc >= 0.3.0.1 && < 0.4, commonmark >= 0.1.1.2 && < 0.2, commonmark-extensions >= 0.2.0.4 && < 0.3, commonmark-pandoc >= 0.2 && < 0.3, diff --git a/stack.yaml b/stack.yaml --- a/stack.yaml +++ b/stack.yaml @@ -17,7 +17,7 @@ - commonmark-extensions-0.2.0.4 - commonmark-pandoc-0.2.0.1 - doctemplates-0.9 -- citeproc-0.3 +- citeproc-0.3.0.1 # - citeproc: # git: https://github.com/jgm/citeproc.git # commit: a8193fe375fa2354049bf9a967ba3bad4b1ba053 diff --git a/test/tables.asciidoctor b/test/tables.asciidoctor new file mode 100644 --- /dev/null +++ b/test/tables.asciidoctor @@ -0,0 +1,67 @@ +Simple table with caption: + +.Demonstration of simple table syntax. +[cols=">,<,^,",options="header",] +|=== +|Right |Left |Center |Default +|12 |12 |12 |12 +|123 |123 |123 |123 +|1 |1 |1 |1 +|=== + +Simple table without caption: + +[cols=">,<,^,",options="header",] +|=== +|Right |Left |Center |Default +|12 |12 |12 |12 +|123 |123 |123 |123 +|1 |1 |1 |1 +|=== + +Simple table indented two spaces: + +.Demonstration of simple table syntax. +[cols=">,<,^,",options="header",] +|=== +|Right |Left |Center |Default +|12 |12 |12 |12 +|123 |123 |123 |123 +|1 |1 |1 |1 +|=== + +Multiline table with caption: + +.Here’s the caption. It may span multiple lines. +[width="80%",cols="^20%,<17%,>20%,<43%",options="header",] +|=== +|Centered Header |Left Aligned |Right Aligned |Default aligned +|First |row |12.0 |Example of a row that spans multiple lines. +|Second |row |5.0 |Here’s another one. Note the blank line between rows. +|=== + +Multiline table without caption: + +[width="80%",cols="^20%,<17%,>20%,<43%",options="header",] +|=== +|Centered Header |Left Aligned |Right Aligned |Default aligned +|First |row |12.0 |Example of a row that spans multiple lines. +|Second |row |5.0 |Here’s another one. Note the blank line between rows. +|=== + +Table without column headers: + +[cols=">,<,^,>",] +|=== +|12 |12 |12 |12 +|123 |123 |123 |123 +|1 |1 |1 |1 +|=== + +Multiline table without column headers: + +[width="80%",cols="^20%,<17%,>20%,43%",] +|=== +|First |row |12.0 |Example of a row that spans multiple lines. +|Second |row |5.0 |Here’s another one. Note the blank line between rows. +|=== diff --git a/test/tables/nordics.jats_archiving b/test/tables/nordics.jats_archiving new file mode 100644 --- /dev/null +++ b/test/tables/nordics.jats_archiving @@ -0,0 +1,58 @@ + + +

States belonging to the Nordics.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameCapitalPopulation + (in 2018)Area + (in km2)
Total27,376,0221,258,336
DenmarkCopenhagen5,809,50243,094
FinlandHelsinki5,537,364338,145
IcelandReykjavik343,518103,000
NorwayOslo5,372,191323,802
SwedenStockholm10,313,447450,295
+ diff --git a/test/tables/planets.jats_archiving b/test/tables/planets.jats_archiving new file mode 100644 --- /dev/null +++ b/test/tables/planets.jats_archiving @@ -0,0 +1,128 @@ + + +

Data about the planets of our solar system.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameMass (10^24kg)Diameter (km)Density (kg/m^3)Gravity (m/s^2)Length of day (hours)Distance from Sun (10^6km)Mean temperature (C)Number of moonsNotes
Terrestrial planetsMercury0.3304,87954273.74222.657.91670Closest to the Sun
Venus4.8712,10452438.92802.0108.24640
Earth5.9712,75655149.824.0149.6151Our world
Mars0.6426,79239333.724.7227.9-652The red planet
Jovian planetsGas giantsJupiter1898142,984132623.19.9778.6-11067The largest planet
Saturn568120,5366879.010.71433.5-14062
Ice giantsUranus86.851,11812718.717.22872.5-19527
Neptune10249,528163811.016.14495.1-20014
Dwarf planetsPluto0.01462,37020950.7153.35906.4-2255Declassified as a planet in 2006.
+ diff --git a/test/tables/students.jats_archiving b/test/tables/students.jats_archiving new file mode 100644 --- /dev/null +++ b/test/tables/students.jats_archiving @@ -0,0 +1,56 @@ + + +

List of Students

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Student IDName
Computer Science
3741255Jones, Martha
4077830Pierce, Benjamin
5151701Kirk, James
Russian Literature
3971244Nim, Victor
Astrophysics
4100332Petrov, Alexandra
4100332Toyota, Hiroko
+ diff --git a/test/writer.asciidoctor b/test/writer.asciidoctor new file mode 100644 --- /dev/null +++ b/test/writer.asciidoctor @@ -0,0 +1,649 @@ += Pandoc Test Suite +John MacFarlane; Anonymous +July 17, 2006 +:stem: latexmath + +This is a set of tests for pandoc. Most of them are adapted from John Gruber’s +markdown test suite. + +''''' + +== Headers + +=== Level 2 with an link:/url[embedded link] + +==== Level 3 with _emphasis_ + +===== Level 4 + +====== Level 5 + +== Level 1 + +=== Level 2 with _emphasis_ + +==== Level 3 + +with no blank line + +=== Level 2 + +with no blank line + +''''' + +== Paragraphs + +Here’s a regular paragraph. + +In Markdown 1.0.0 and earlier. Version 8. This line turns into a list item. +Because a hard-wrapped line in the middle of a paragraph looked like a list +item. + +Here’s one with a bullet. * criminey. + +There should be a hard line break + +here. + +''''' + +== Block Quotes + +E-mail style: + +____ +This is a block quote. It is pretty short. +____ + +____ +-- +Code in a block quote: + +.... +sub status { + print "working"; +} +.... + +A list: + +[arabic] +. item one +. item two + +Nested block quotes: + +____ +nested +____ + +____ +nested +____ + +-- +____ + +This should not be a block quote: 2 > 1. + +And a following paragraph. + +''''' + +== Code Blocks + +Code: + +.... +---- (should be four hyphens) + +sub status { + print "working"; +} + +this code block is indented by one tab +.... + +And: + +.... + this code block is indented by two tabs + +These should not be escaped: \$ \\ \> \[ \{ +.... + +''''' + +== Lists + +=== Unordered + +Asterisks tight: + +* asterisk 1 +* asterisk 2 +* asterisk 3 + +Asterisks loose: + +* asterisk 1 +* asterisk 2 +* asterisk 3 + +Pluses tight: + +* Plus 1 +* Plus 2 +* Plus 3 + +Pluses loose: + +* Plus 1 +* Plus 2 +* Plus 3 + +Minuses tight: + +* Minus 1 +* Minus 2 +* Minus 3 + +Minuses loose: + +* Minus 1 +* Minus 2 +* Minus 3 + +=== Ordered + +Tight: + +[arabic] +. First +. Second +. Third + +and: + +[arabic] +. One +. Two +. Three + +Loose using tabs: + +[arabic] +. First +. Second +. Third + +and using spaces: + +[arabic] +. One +. Two +. Three + +Multiple paragraphs: + +[arabic] +. Item 1, graf one. ++ +Item 1. graf two. The quick brown fox jumped over the lazy dog’s back. +. Item 2. +. Item 3. + +=== Nested + +* Tab +** Tab +*** Tab + +Here’s another: + +[arabic] +. First +. Second: +* Fee +* Fie +* Foe +. Third + +Same thing but with paragraphs: + +[arabic] +. First +. Second: +* Fee +* Fie +* Foe +. Third + +=== Tabs and spaces + +* this is a list item indented with tabs +* this is a list item indented with spaces +** this is an example list item indented with tabs +** this is an example list item indented with spaces + +=== Fancy list markers + +[arabic, start=2] +. begins with 2 +. and now 3 ++ +with a continuation +[lowerroman, start=4] +.. sublist with roman numerals, starting with 4 +.. more items +[upperalpha] +... a subsublist +... a subsublist + +Nesting: + +[upperalpha] +. Upper Alpha +[upperroman] +.. Upper Roman. +[arabic, start=6] +... Decimal start with 6 +[loweralpha, start=3] +.... Lower alpha with paren + +Autonumbering: + +. Autonumber. +. More. +.. Nested. + +Should not be a list item: + +M.A. 2007 + +B. Williams + +''''' + +== Definition Lists + +Tight using spaces: + +apple:: + red fruit +orange:: + orange fruit +banana:: + yellow fruit + +Tight using tabs: + +apple:: + red fruit +orange:: + orange fruit +banana:: + yellow fruit + +Loose: + +apple:: + red fruit +orange:: + orange fruit +banana:: + yellow fruit + +Multiple blocks with italics: + +_apple_:: + red fruit + + + contains seeds, crisp, pleasant to taste +_orange_:: + orange fruit + + +.... +{ orange code block } +.... + + + ____ + orange block quote + ____ + +Multiple definitions, tight: + +apple:: + red fruit + + + computer +orange:: + orange fruit + + + bank + +Multiple definitions, loose: + +apple:: + red fruit + + + computer +orange:: + orange fruit + + + bank + +Blank line after term, indented marker, alternate markers: + +apple:: + red fruit + + + computer +orange:: + orange fruit + + + [arabic] + . sublist + . sublist + +== HTML Blocks + +Simple block on one line: + +foo + +And nested without indentation: + +foo + +bar + +Interpreted markdown in a table: + +This is _emphasized_ + +And this is *strong* + +Here’s a simple block: + +foo + +This should be a code block, though: + +.... +
+ foo +
+.... + +As should this: + +.... +
foo
+.... + +Now, nested: + +foo + +This should just be an HTML comment: + +Multiline: + +Code block: + +.... + +.... + +Just plain comment, with trailing spaces on the line: + +Code: + +.... +
+.... + +Hr’s: + +''''' + +== Inline Markup + +This is _emphasized_, and so _is this_. + +This is *strong*, and so *is this*. + +An _link:/url[emphasized link]_. + +*_This is strong and em._* + +So is *_this_* word. + +*_This is strong and em._* + +So is *_this_* word. + +This is code: `+>+`, `+$+`, `+\+`, `+\$+`, `++`. + +[line-through]*This is _strikeout_.* + +Superscripts: a^bc^d a^_hello_^ a^hello there^. + +Subscripts: H~2~O, H~23~O, H~many of them~O. + +These should not be superscripts or subscripts, because of the unescaped +spaces: a^b c^d, a~b c~d. + +''''' + +== Smart quotes, ellipses, dashes + +"`Hello,`" said the spider. "`'`Shelob`' is my name.`" + +'`A`', '`B`', and '`C`' are letters. + +'`Oak,`' '`elm,`' and '`beech`' are names of trees. So is '`pine.`' + +'`He said, "`I want to go.`"`' Were you alive in the 70’s? + +Here is some quoted '``+code+``' and a +"`http://example.com/?foo=1&bar=2[quoted link]`". + +Some dashes: one—two — three—four — five. + +Dashes between numbers: 5–7, 255–66, 1987–1999. + +Ellipses…and…and…. + +''''' + +== LaTeX + +* +* latexmath:[2+2=4] +* latexmath:[x \in y] +* latexmath:[\alpha \wedge \omega] +* latexmath:[223] +* latexmath:[p]-Tree +* Here’s some display math: ++ +[latexmath] +++++ +\frac{d}{dx}f(x)=\lim_{h\to 0}\frac{f(x+h)-f(x)}{h} +++++ +* Here’s one that has a line break in it: +latexmath:[\alpha + \omega \times x^2]. + +These shouldn’t be math: + +* To get the famous equation, write `+$e = mc^2$+`. +* $22,000 is a _lot_ of money. So is $34,000. (It worked if "`lot`" is +emphasized.) +* Shoes ($20) and socks ($5). +* Escaped `+$+`: $73 _this should be emphasized_ 23$. + +Here’s a LaTeX table: + +''''' + +== Special Characters + +Here is some unicode: + +* I hat: Î +* o umlaut: ö +* section: § +* set membership: ∈ +* copyright: © + +AT&T has an ampersand in their name. + +AT&T is another way to write it. + +This & that. + +4 < 5. + +6 > 5. + +Backslash: \ + +Backtick: ` + +Asterisk: * + +Underscore: _ + +Left brace: \{ + +Right brace: } + +Left bracket: [ + +Right bracket: ] + +Left paren: ( + +Right paren: ) + +Greater-than: > + +Hash: # + +Period: . + +Bang: ! + +Plus: + + +Minus: - + +''''' + +== Links + +=== Explicit + +Just a link:/url/[URL]. + +link:/url/[URL and title]. + +link:/url/[URL and title]. + +link:/url/[URL and title]. + +link:/url/[URL and title] + +link:/url/[URL and title] + +link:/url/with_underscore[with_underscore] + +mailto:nobody@nowhere.net[Email link] + +link:[Empty]. + +=== Reference + +Foo link:/url/[bar]. + +With link:/url/[embedded [brackets]]. + +link:/url/[b] by itself should be a link. + +Indented link:/url[once]. + +Indented link:/url[twice]. + +Indented link:/url[thrice]. + +This should [not][] be a link. + +.... +[not]: /url +.... + +Foo link:/url/[bar]. + +Foo link:/url/[biz]. + +=== With ampersands + +Here’s a http://example.com/?foo=1&bar=2[link with an ampersand in the URL]. + +Here’s a link with an amersand in the link text: http://att.com/[AT&T]. + +Here’s an link:/script?foo=1&bar=2[inline link]. + +Here’s an link:/script?foo=1&bar=2[inline link in pointy braces]. + +=== Autolinks + +With an ampersand: http://example.com/?foo=1&bar=2 + +* In a list? +* http://example.com/ +* It should. + +An e-mail address: nobody@nowhere.net + +____ +Blockquoted: http://example.com/ +____ + +Auto-links should not occur here: `++` + +.... +or here: +.... + +''''' + +== Images + +From "`Voyage dans la Lune`" by Georges Melies (1902): + +image::lalune.jpg[lalune,title="Voyage dans la Lune"] + +Here is a movie image:movie.jpg[movie] icon. + +''''' + +== Footnotes + +Here is a footnote reference,footnote:[Here is the footnote. It can go +anywhere after the footnote reference. It need not be placed at the end of the +document.] and another.[multiblock footnote omitted] This should _not_ be a +footnote reference, because it contains a space.[^my note] Here is an inline +note.footnote:[This is _easier_ to type. Inline notes may contain +http://google.com[links] and `+]+` verbatim characters, as well as [bracketed +text].] + +____ +Notes can go in quotes.footnote:[In quote.] +____ + +[arabic] +. And in list items.footnote:[In list.] + +This paragraph should not be part of the note, as it is not indented.