git.iko.soy/typeable/pandoc
on master help sign in
swap
b8e0b46925 ahead, 0 behind
677 files changed+25180−14482
since splitsnapshots
unifiedsplit
.circleci/config.yml+64−122 .editorconfig+8 .github/ISSUE_TEMPLATE−11 .github/ISSUE_TEMPLATE/bug_report.md+25 .github/ISSUE_TEMPLATE/config.yml+9 .github/ISSUE_TEMPLATE/feature_request.md+21 .github/workflows/ci.yml+96−11 .github/workflows/format-validation.yml+88 .github/workflows/lint.yml+33 .github/workflows/nightly.yml+9−2 .github/workflows/release-candidate.yml−1 .gitignore+7 .hlint.yaml+78−52 .travis.yml−54 AUTHORS.md+32 CONTRIBUTING.md+123−24 COPYING.md+1−1 COPYRIGHT+17−26 INSTALL.md+27−38 MANUAL.txt+574−246 Makefile+47−19 README.md+15−19 README.template+6−6 RELEASE-CHECKLIST+3−1 SECURITY.md+12 pandoc.hs → app/pandoc.hs+1−3 benchmark/benchmark-pandoc.hs+65−84 benchmark/weigh-pandoc.hs−50 cabal.project+11−3 changelog.md+2126−26 data/default.csl+12−2 data/docx/word/settings.xml+6−16 data/docx/word/styles.xml+15 data/jats.csl−203 data/make-reference-files.hs−27 data/odt/styles.xml+1−1 data/templates/.github/ISSUE_TEMPLATE.md−3 data/templates/.github/PULL_REQUEST_TEMPLATE.md−4 data/templates/README.markdown−49 data/templates/affiliations.jats+38 data/templates/article.jats_publishing+23−7 data/templates/default.biblatex+10 data/templates/default.bibtex+10 data/templates/default.context+10−8 data/templates/default.dzslides+1−1 data/templates/default.epub2+1−1 data/templates/default.epub3+1−1 data/templates/default.html4+3 data/templates/default.html5+3 data/templates/default.jats_articleauthoring+7−4 data/templates/default.latex+78−44 data/templates/default.man+1−1 data/templates/default.org+3−3 data/templates/default.revealjs+84−122 data/templates/default.s5+3 data/templates/default.slideous+7 data/templates/default.slidy+5 data/templates/styles.html+51−18 data/translations/zh-Hans.yaml+22 data/translations/zh-Hant.yaml+22 data/vimwiki.css−82 default.nix+13 doc/epub.md+9−2 doc/faqs.md+128 doc/filters.md+91−6 doc/jats.md+414 doc/libraries.md+63 doc/lua-filters.md+219−28 doc/org.md+22−5 doc/using-the-pandoc-api.md+28−15 linux/make_artifacts.sh+19−7 man/pandoc.1+484−132 man/pandoc.1.after+1−1 pandoc.cabal+131−179 release.nix+4 shell.nix+106 src/Text/Pandoc.hs+1−1 src/Text/Pandoc/App.hs+82−56 src/Text/Pandoc/App/CommandLineOptions.hs+88−57 src/Text/Pandoc/App/FormatHeuristics.hs+19−8 src/Text/Pandoc/App/Opt.hs+269−48 src/Text/Pandoc/App/OutputSettings.hs+3−3 src/Text/Pandoc/Asciify.hs+14−391 src/Text/Pandoc/BCP47.hs−112 src/Text/Pandoc/CSS.hs+24−25 src/Text/Pandoc/CSV.hs+2−3 src/Text/Pandoc/Citeproc.hs+258−134 src/Text/Pandoc/Citeproc/BibTeX.hs+306−66 src/Text/Pandoc/Citeproc/Data.hs+7−6 src/Text/Pandoc/Citeproc/Locator.hs+20−4 src/Text/Pandoc/Citeproc/MetaValue.hs+6−5 src/Text/Pandoc/Class/CommonState.hs+1−1 src/Text/Pandoc/Class/IO.hs+24−24 src/Text/Pandoc/Class/PandocMonad.hs+45−38 src/Text/Pandoc/Data.hs+1−1 src/Text/Pandoc/Error.hs+107−51 src/Text/Pandoc/Extensions.hs+36−7 src/Text/Pandoc/Filter.hs+6−4 src/Text/Pandoc/Filter/JSON.hs+1−1 src/Text/Pandoc/Filter/Lua.hs+1−1 src/Text/Pandoc/Filter/Path.hs+1−1 src/Text/Pandoc/Highlighting.hs+6−6 src/Text/Pandoc/Image.hs+1−1 src/Text/Pandoc/ImageSize.hs+61−341 src/Text/Pandoc/Logging.hs+82−46 src/Text/Pandoc/Lua.hs+1−1 src/Text/Pandoc/Lua/ErrorConversion.hs+1−1 src/Text/Pandoc/Lua/Filter.hs+7−4 src/Text/Pandoc/Lua/Global.hs+1−1 src/Text/Pandoc/Lua/Init.hs+15−5 src/Text/Pandoc/Lua/Marshaling.hs+2−2 src/Text/Pandoc/Lua/Marshaling/AST.hs+79−81 src/Text/Pandoc/Lua/Marshaling/AnyValue.hs+1−1 src/Text/Pandoc/Lua/Marshaling/CommonState.hs+2−2 src/Text/Pandoc/Lua/Marshaling/Context.hs+3−2 src/Text/Pandoc/Lua/Marshaling/List.hs+2−2 src/Text/Pandoc/Lua/Marshaling/MediaBag.hs+3−3 src/Text/Pandoc/Lua/Marshaling/PandocError.hs+1−1 src/Text/Pandoc/Lua/Marshaling/ReaderOptions.hs+2−2 src/Text/Pandoc/Lua/Marshaling/SimpleTable.hs+1−1 src/Text/Pandoc/Lua/Marshaling/Version.hs+1−1 src/Text/Pandoc/Lua/Module/MediaBag.hs+18−17 src/Text/Pandoc/Lua/Module/Pandoc.hs+29−23 src/Text/Pandoc/Lua/Module/System.hs+1−1 src/Text/Pandoc/Lua/Module/Types.hs+1−1 src/Text/Pandoc/Lua/Module/Utils.hs+2−2 src/Text/Pandoc/Lua/Packages.hs+10−27 src/Text/Pandoc/Lua/PandocLua.hs+20−13 src/Text/Pandoc/Lua/Util.hs+2−2 src/Text/Pandoc/Lua/Walk.hs+2−2 src/Text/Pandoc/MIME.hs+26−3 src/Text/Pandoc/MediaBag.hs+46−15 src/Text/Pandoc/Options.hs+21−18 src/Text/Pandoc/PDF.hs+38−17 src/Text/Pandoc/Parsing.hs+410−265 src/Text/Pandoc/Process.hs+1−1 src/Text/Pandoc/Readers.hs+56−49 src/Text/Pandoc/Readers/BibTeX.hs+18−11 src/Text/Pandoc/Readers/CSV.hs+9−9 src/Text/Pandoc/Readers/CommonMark.hs+81−28 src/Text/Pandoc/Readers/Creole.hs+6−7 src/Text/Pandoc/Readers/CslJson.hs+6−5 src/Text/Pandoc/Readers/DocBook.hs+119−89 src/Text/Pandoc/Readers/Docx.hs+62−47 src/Text/Pandoc/Readers/Docx/Combine.hs+7−7 src/Text/Pandoc/Readers/Docx/Parse.hs+214−120 src/Text/Pandoc/Readers/Docx/Parse/Styles.hs+32−25 src/Text/Pandoc/Readers/Docx/Util.hs+28−26 src/Text/Pandoc/Readers/DokuWiki.hs+10−9 src/Text/Pandoc/Readers/EPUB.hs+46−39 src/Text/Pandoc/Readers/FB2.hs+57−51 src/Text/Pandoc/Readers/HTML.hs+264−561 src/Text/Pandoc/Readers/HTML/Parsing.hs+225 src/Text/Pandoc/Readers/HTML/Table.hs+283 src/Text/Pandoc/Readers/HTML/TagCategories.hs+78 src/Text/Pandoc/Readers/HTML/Types.hs+97 src/Text/Pandoc/Readers/Haddock.hs+11−7 src/Text/Pandoc/Readers/Ipynb.hs+6−4 src/Text/Pandoc/Readers/JATS.hs+37−51 src/Text/Pandoc/Readers/Jira.hs+14−10 src/Text/Pandoc/Readers/LaTeX.hs+271−1429 src/Text/Pandoc/Readers/LaTeX/Citation.hs+210 src/Text/Pandoc/Readers/LaTeX/Inline.hs+397 src/Text/Pandoc/Readers/LaTeX/Lang.hs+200−121 src/Text/Pandoc/Readers/LaTeX/Macro.hs+184 src/Text/Pandoc/Readers/LaTeX/Math.hs+221 src/Text/Pandoc/Readers/LaTeX/Parsing.hs+213−55 src/Text/Pandoc/Readers/LaTeX/SIunitx.hs+153−70 src/Text/Pandoc/Readers/LaTeX/Table.hs+378 src/Text/Pandoc/Readers/LaTeX/Types.hs+15−2 src/Text/Pandoc/Readers/Man.hs+37−16 src/Text/Pandoc/Readers/Markdown.hs+328−261 src/Text/Pandoc/Readers/MediaWiki.hs+21−14 src/Text/Pandoc/Readers/Metadata.hs+50−20 src/Text/Pandoc/Readers/Muse.hs+10−9 src/Text/Pandoc/Readers/Native.hs+8−6 src/Text/Pandoc/Readers/OPML.hs+22−36 src/Text/Pandoc/Readers/Odt.hs+28−25 src/Text/Pandoc/Readers/Odt/Arrows/State.hs+2−2 src/Text/Pandoc/Readers/Odt/ContentReader.hs+22−15 src/Text/Pandoc/Readers/Odt/Generic/Namespaces.hs+2−1 src/Text/Pandoc/Readers/Odt/Generic/Utils.hs+10−26 src/Text/Pandoc/Readers/Odt/Generic/XMLConverter.hs+13−14 src/Text/Pandoc/Readers/Odt/Namespaces.hs+6−5 src/Text/Pandoc/Readers/Odt/StyleReader.hs+21−17 src/Text/Pandoc/Readers/Org.hs+5−8 src/Text/Pandoc/Readers/Org/BlockStarts.hs+1−1 src/Text/Pandoc/Readers/Org/Blocks.hs+71−33 src/Text/Pandoc/Readers/Org/DocumentTree.hs+1−1 src/Text/Pandoc/Readers/Org/ExportSettings.hs+1−1 src/Text/Pandoc/Readers/Org/Inlines.hs+13−13 src/Text/Pandoc/Readers/Org/Meta.hs+13−5 src/Text/Pandoc/Readers/Org/ParserState.hs+1−1 src/Text/Pandoc/Readers/Org/Parsing.hs+6−6 src/Text/Pandoc/Readers/Org/Shared.hs+1−1 src/Text/Pandoc/Readers/RST.hs+85−116 src/Text/Pandoc/Readers/Roff.hs+16−18 src/Text/Pandoc/Readers/TWiki.hs+7−27 src/Text/Pandoc/Readers/Textile.hs+96−90 src/Text/Pandoc/Readers/TikiWiki.hs+6−6 src/Text/Pandoc/Readers/Txt2Tags.hs+49−23 src/Text/Pandoc/Readers/Vimwiki.hs+12−7 src/Text/Pandoc/RoffChar.hs+1−1 src/Text/Pandoc/SelfContained.hs+16−12 src/Text/Pandoc/Shared.hs+52−101 src/Text/Pandoc/Slides.hs+1−1 src/Text/Pandoc/Sources.hs+195 src/Text/Pandoc/Templates.hs+5−1 src/Text/Pandoc/Translations.hs+1−1 src/Text/Pandoc/UTF8.hs+21−24 src/Text/Pandoc/UUID.hs+1−1 src/Text/Pandoc/Writers.hs+9−4 src/Text/Pandoc/Writers/AnnotatedTable.hs+23 src/Text/Pandoc/Writers/AsciiDoc.hs+43−12 src/Text/Pandoc/Writers/BibTeX.hs+61 src/Text/Pandoc/Writers/CommonMark.hs+1−1 src/Text/Pandoc/Writers/ConTeXt.hs+45−39 src/Text/Pandoc/Writers/CslJson.hs+11−9 src/Text/Pandoc/Writers/Custom.hs+1−1 src/Text/Pandoc/Writers/Docbook.hs+114−33 src/Text/Pandoc/Writers/Docx.hs+238−395 src/Text/Pandoc/Writers/Docx/StyleMap.hs+1−1 src/Text/Pandoc/Writers/Docx/Table.hs+227 src/Text/Pandoc/Writers/Docx/Types.hs+185 src/Text/Pandoc/Writers/DokuWiki.hs+29−16 src/Text/Pandoc/Writers/EPUB.hs+269−212 src/Text/Pandoc/Writers/FB2.hs+62−78 src/Text/Pandoc/Writers/GridTable.hs+157 src/Text/Pandoc/Writers/HTML.hs+144−64 src/Text/Pandoc/Writers/Haddock.hs+13−2 src/Text/Pandoc/Writers/ICML.hs+6−1 src/Text/Pandoc/Writers/Ipynb.hs+1−1 src/Text/Pandoc/Writers/JATS.hs+113−120 src/Text/Pandoc/Writers/JATS/References.hs+164 src/Text/Pandoc/Writers/JATS/Table.hs+268 src/Text/Pandoc/Writers/JATS/Types.hs+57 src/Text/Pandoc/Writers/Jira.hs+43−18 src/Text/Pandoc/Writers/LaTeX.hs+100−815 src/Text/Pandoc/Writers/LaTeX/Caption.hs+47 src/Text/Pandoc/Writers/LaTeX/Citation.hs+181 src/Text/Pandoc/Writers/LaTeX/Lang.hs+192 src/Text/Pandoc/Writers/LaTeX/Notes.hs+34 src/Text/Pandoc/Writers/LaTeX/Table.hs+307 src/Text/Pandoc/Writers/LaTeX/Types.hs+83 src/Text/Pandoc/Writers/LaTeX/Util.hs+275 src/Text/Pandoc/Writers/Man.hs+3−3 src/Text/Pandoc/Writers/Markdown.hs+94−660 src/Text/Pandoc/Writers/Markdown/Inline.hs+616 src/Text/Pandoc/Writers/Markdown/Types.hs+81 src/Text/Pandoc/Writers/MediaWiki.hs+10−3 src/Text/Pandoc/Writers/Ms.hs+30−12 src/Text/Pandoc/Writers/Muse.hs+6−3 src/Text/Pandoc/Writers/Native.hs+1−1 src/Text/Pandoc/Writers/ODT.hs+28−22 src/Text/Pandoc/Writers/OOXML.hs+22−22 src/Text/Pandoc/Writers/OPML.hs+1−1 src/Text/Pandoc/Writers/OpenDocument.hs+166−86 src/Text/Pandoc/Writers/Org.hs+66−42 src/Text/Pandoc/Writers/Powerpoint.hs+1−1 src/Text/Pandoc/Writers/Powerpoint/Output.hs+172−148 src/Text/Pandoc/Writers/Powerpoint/Presentation.hs+2−3 src/Text/Pandoc/Writers/RST.hs+38−22 src/Text/Pandoc/Writers/RTF.hs+17−11 src/Text/Pandoc/Writers/Roff.hs+2−2 src/Text/Pandoc/Writers/Shared.hs+20−6 src/Text/Pandoc/Writers/TEI.hs+5−4 src/Text/Pandoc/Writers/Texinfo.hs+23−16 src/Text/Pandoc/Writers/Textile.hs+1−1 src/Text/Pandoc/Writers/ZimWiki.hs+5−3 src/Text/Pandoc/XML.hs+42−20 src/Text/Pandoc/XML/Light.hs+89 src/Text/Pandoc/XML/Light/Output.hs+234 src/Text/Pandoc/XML/Light/Proc.hs+139 src/Text/Pandoc/XML/Light/Types.hs+193 stack.yaml+11−21 test/Tests/Command.hs+34−39 test/Tests/Helpers.hs+25−36 test/Tests/Lua.hs+2−4 test/Tests/Lua/Module.hs+3−1 test/Tests/Old.hs+18−30 test/Tests/Readers/Creole.hs+1−3 test/Tests/Readers/Docx.hs+25−7 test/Tests/Readers/DokuWiki.hs−2 test/Tests/Readers/EPUB.hs+2−4 test/Tests/Readers/FB2.hs−2 test/Tests/Readers/HTML.hs+24−19 test/Tests/Readers/JATS.hs+1−2 test/Tests/Readers/Jira.hs+22−2 test/Tests/Readers/LaTeX.hs+2−21 test/Tests/Readers/Man.hs+1−2 test/Tests/Readers/Markdown.hs+4−6 test/Tests/Readers/Muse.hs−2 test/Tests/Readers/Odt.hs+2−3 test/Tests/Readers/Org.hs+1−1 test/Tests/Readers/Org/Block.hs+22−24 test/Tests/Readers/Org/Block/CodeBlock.hs+36−38 test/Tests/Readers/Org/Block/Figure.hs+9−11 test/Tests/Readers/Org/Block/Header.hs+4−6 test/Tests/Readers/Org/Block/List.hs+14−3 test/Tests/Readers/Org/Block/Table.hs+3−5 test/Tests/Readers/Org/Directive.hs+1−3 test/Tests/Readers/Org/Inline.hs+5−7 test/Tests/Readers/Org/Inline/Citation.hs+41−3 test/Tests/Readers/Org/Inline/Note.hs+1−3 test/Tests/Readers/Org/Inline/Smart.hs+1−3 test/Tests/Readers/Org/Meta.hs+44−30 test/Tests/Readers/Org/Shared.hs+1−3 test/Tests/Readers/RST.hs+1−3 test/Tests/Readers/Txt2Tags.hs+1−3 test/Tests/Shared.hs+1−3 test/Tests/Writers/AnnotatedTable.hs−1 test/Tests/Writers/AsciiDoc.hs−2 test/Tests/Writers/ConTeXt.hs+122−115 test/Tests/Writers/Docbook.hs+103−2 test/Tests/Writers/Docx.hs+15−2 test/Tests/Writers/FB2.hs−2 test/Tests/Writers/HTML.hs+57−54 test/Tests/Writers/JATS.hs+135−93 test/Tests/Writers/Jira.hs+60−1 test/Tests/Writers/LaTeX.hs−2 test/Tests/Writers/Markdown.hs+3−3 test/Tests/Writers/Ms.hs−2 test/Tests/Writers/Muse.hs−1 test/Tests/Writers/Native.hs−2 test/Tests/Writers/OOXML.hs+5−4 test/Tests/Writers/Org.hs+46−13 test/Tests/Writers/Plain.hs−2 test/Tests/Writers/Powerpoint.hs−2 test/Tests/Writers/RST.hs−2 test/Tests/Writers/TEI.hs−2 test/command/1279.md+1−1 test/command/1881.md+13−13 test/command/2103.md+8 test/command/2378.md+3−3 test/command/2874.md+2−2 test/command/3516.md+1−5 test/command/3674.md+1−1 test/command/3706.md+8−8 test/command/3736.md+3−6 test/command/3752.md+60 test/command/3792.md+1−1 test/command/3824.md+1 test/command/4038.md+1−1 test/command/4063.md+29 test/command/4164.md+5−9 test/command/4186.md+8−8 test/command/4420.md−11 test/command/4442.md+1−1 test/command/4465.md+15 test/command/4742.md+2−2 test/command/5121.md+1−2 test/command/5178.md+10−10 test/command/5304.md+1−1 test/command/5321.md+2−2 test/command/5367.md+9−10 test/command/5519.md+1−1 test/command/5541-nesting.md+1 test/command/5686.md+1−1 test/command/5708.md+1−5 test/command/5986.md+3−2 test/command/6026.md+19 test/command/6388.md+16 test/command/6541.md+27 test/command/6620.md+3 test/command/6658.md+75 test/command/6709.md+11 test/command/6723.md+1−2 test/command/6739.md+21 test/command/6740.md+7 test/command/6741.md+145 test/command/6752.md+36 test/command/6755.md+11 test/command/6765.md+31 test/command/6768.md+21 test/command/6774.md+63 test/command/6783.md+26 test/command/6791.md+32 test/command/6792.md+66 test/command/6796.md+16 test/command/6802.md+9 test/command/6836.md+17 test/command/6837.md+29 test/command/6844.md+27 test/command/6855.md+12 test/command/6858.md+52 test/command/6869.md+6 test/command/6873.md+7 test/command/6890.md+36 test/command/6925.md+34 test/command/6948.md+31 test/command/6951.md+18 test/command/6958.md+10 test/command/6993.md+21 test/command/7003.md+37 test/command/7006.md+20 test/command/7009.md+8 test/command/7016.md+48 test/command/7041.md+23 test/command/7042.md+146 test/command/7058.md+6 test/command/7064.md+32 test/command/7067.md+90 test/command/7080.md+8 test/command/7092.md+8 test/command/7099.md+18 test/command/7112.md+15 test/command/7129.md+27 test/command/7132.md+10 test/command/7134.md+16 test/command/7145.md+12 test/command/7155.md+15 test/command/7173.md+137 test/command/7208.md+6 test/command/7214.md+28 test/command/7216.md+19 test/command/7266.md+10 test/command/7272.md+27 test/command/7278.md+38 test/command/7282.md+7 test/command/7288.md+40 test/command/7299.md+23 test/command/7321.md+24 test/command/7323.md+29 test/command/7324.md+25 test/command/7339.md+11 test/command/7340.md+6 test/command/7376.md+16 test/command/7394.md+85 test/command/7397.md+14 test/command/7400.md+9 test/command/7416.md+19 test/command/averroes.bib+95 test/command/biblatex-baez-article.md+1−1 test/command/biblatex-baez-online.md+1−1 test/command/biblatex-basic.md+5−3 test/command/biblatex-cotton.md+3−3 test/command/biblatex-examples.bib−1674 test/command/biblatex-inproceedings.md+1−1 test/command/biblatex-itzhaki.md+1−1 test/command/biblatex-jaffe.md+2−2 test/command/biblatex-moraux.md+1−1 test/command/biblatex-murray.md+3−2 test/command/biblatex-nussbaum.md−63 test/command/biblatex-quotes.md+1−1 test/command/biblatex-sigfridsson.md+1−1 test/command/biblatex-spiegelberg.md+2−2 test/command/biblatex-test-case-conversion.md+2−2 test/command/biblatex-textnormal.md+1−1 test/command/biblatex-thesis.md+1−1 test/command/biblatex-wassenberg.md+1−1 test/command/biblatex-wilde.md+1−1 test/command/chap1/spider.png test/command/chap1/text.md+17 test/command/chap2/spider.png test/command/chap2/text.md+5 test/command/citeproc-20.md+25 test/command/citeproc-author-in-text-suffix.md+6 test/command/custom-attributes.html−16 test/command/defaults-inheritance-1.md+6 test/command/defaults-inheritance-2.md+5 test/command/defaults-inheritance-3.md+6 test/command/defaults3.yaml+4 test/command/defaults4.yaml+3 test/command/defaults5.yaml+2 test/command/defaults6.yaml+2 test/command/defaults7.yaml+2 test/command/defaults8.yaml+2 test/command/defaults9.yaml+1 test/command/docbook-bibliography.md+20 test/command/duplicate_attributes.md+7 test/command/empty-inline-code.txt−6 test/command/latex-center.md+13 test/command/mmd-metadata.md+20 test/command/nested-table-to-asciidoc-6942.md+82 test/command/newif.md+55 test/command/pandoc-citeproc-119.md+2−3 test/command/pandoc-citeproc-14.md+1−2 test/command/pandoc-citeproc-152.md+2−4 test/command/pandoc-citeproc-160.md+2−4 test/command/pandoc-citeproc-175.md+2−4 test/command/pandoc-citeproc-213.md+1−2 test/command/pandoc-citeproc-25.md+1−2 test/command/pandoc-citeproc-27.md+1−2 test/command/pandoc-citeproc-320a.md+3−3 test/command/pandoc-citeproc-322.md+1−1 test/command/pandoc-citeproc-356.md+2−7 test/command/pandoc-citeproc-371.md+1−2 test/command/pandoc-citeproc-416.md+1−2 test/command/pandoc-citeproc-47.md+1−2 test/command/pandoc-citeproc-53.md+4−2 test/command/pandoc-citeproc-57.md+1−2 test/command/pandoc-citeproc-58.md+1−2 test/command/pandoc-citeproc-61.md+2−4 test/command/pandoc-citeproc-65.md+1−1 test/command/pandoc-citeproc-70.md+2−2 test/command/pandoc-citeproc-82.md+3−4 test/command/pandoc-citeproc-87.md+1−2 test/command/pandoc-citeproc-chicago-author-date.md+11−13 test/command/pandoc-citeproc-chicago-fullnote-bibliography.md+18−23 test/command/pandoc-citeproc-ieee.md+2−4 test/command/pandoc-citeproc-locators-integrated.md+2−2 test/command/svg.md+17−15 test/command/toc.md+11−20 test/command/unicode-collation.md+130 test/command/yaml-metadata-blocks.md+3−3 test/docbook-reader.docbook+9−2 test/docx/0_level_headers.native+2−2 test/docx/golden/block_quotes.docx test/docx/golden/codeblock.docx test/docx/golden/comments.docx test/docx/golden/custom_style_no_reference.docx test/docx/golden/custom_style_preserve.docx test/docx/golden/custom_style_reference.docx test/docx/golden/definition_list.docx test/docx/golden/document-properties-short-desc.docx test/docx/golden/document-properties.docx test/docx/golden/headers.docx test/docx/golden/image.docx test/docx/golden/inline_code.docx test/docx/golden/inline_formatting.docx test/docx/golden/inline_images.docx test/docx/golden/link_in_notes.docx test/docx/golden/links.docx test/docx/golden/lists.docx test/docx/golden/lists_continuing.docx test/docx/golden/lists_multiple_initial.docx test/docx/golden/lists_restarting.docx test/docx/golden/nested_anchors_in_header.docx test/docx/golden/notes.docx test/docx/golden/raw-blocks.docx test/docx/golden/raw-bookmarks.docx test/docx/golden/table_one_row.docx test/docx/golden/table_with_list_cell.docx test/docx/golden/tables-default-widths.docx test/docx/golden/tables.docx test/docx/golden/track_changes_deletion.docx test/docx/golden/track_changes_insertion.docx test/docx/golden/track_changes_move.docx test/docx/golden/track_changes_scrubbed_metadata.docx test/docx/golden/unicode.docx test/docx/golden/verbatim_subsuper.docx test/docx/image_vml_as_object.docx test/docx/image_vml_as_object.native+2 test/docx/raw-blocks.native+6 test/docx/raw-bookmarks.native+3 test/docx/sdt_elements.native+9−10 test/docx/table_captions_no_field.docx test/docx/table_captions_no_field.native+34 test/docx/table_captions_with_field.docx test/docx/table_captions_with_field.native+54 test/docx/table_header_rowspan.docx test/docx/table_header_rowspan.native+189 test/docx/table_one_header_row.docx test/docx/table_one_header_row.native+18 test/docx/table_one_row.docx test/docx/table_one_row.native+4−4 test/docx/table_variable_width.native+12−17 test/docx/table_with_list_cell.native+3−3 test/docx/tables-default-widths.native+92 test/docx/tables.native+9−9 test/epub/features.epub test/epub/features.native+3−3 test/epub/wasteland.epub test/epub/wasteland.native+4−4 test/fb2/images.fb2+1−1 test/fb2/test.jpg test/grofftest.sh−26 test/html-reader.html+76 test/html-reader.native+148−37 test/jats-reader.native+1−1 test/jats-reader.xml+1 test/jira-reader.native+1−1 test/latex-reader.native+26−13 test/lhs-test.html+45−19 test/lhs-test.html+lhs+45−19 test/lhs-test.latex+4−4 test/lhs-test.latex+lhs+4−4 test/lua/module/pandoc-path.lua+44 test/markdown-reader-more.native+6−34 test/odt/native/tab.native+1 test/odt/odt/tab.odt test/org-select-tags.org+2−2 test/pipe-tables.native+2−10 test/pptx/code-custom.pptx test/pptx/code-custom_templated.pptx test/pptx/code.pptx test/pptx/code_templated.pptx test/pptx/document-properties-short-desc.pptx test/pptx/document-properties-short-desc_templated.pptx test/pptx/document-properties.pptx test/pptx/document-properties_templated.pptx test/pptx/endnotes.pptx test/pptx/endnotes_templated.pptx test/pptx/endnotes_toc.pptx test/pptx/endnotes_toc_templated.pptx test/pptx/images.pptx test/pptx/images_templated.pptx test/pptx/inline_formatting.pptx test/pptx/inline_formatting_templated.pptx test/pptx/lists.pptx test/pptx/lists_templated.pptx test/pptx/raw_ooxml.native+1−1 test/pptx/raw_ooxml.pptx test/pptx/raw_ooxml_templated.pptx test/pptx/reference_depth.pptx test/pptx/remove_empty_slides.pptx test/pptx/remove_empty_slides_templated.pptx test/pptx/slide_breaks.pptx test/pptx/slide_breaks_slide_level_1.pptx test/pptx/slide_breaks_slide_level_1_templated.pptx test/pptx/slide_breaks_templated.pptx test/pptx/slide_breaks_toc.pptx test/pptx/slide_breaks_toc_templated.pptx test/pptx/speaker_notes.pptx test/pptx/speaker_notes_after_metadata.pptx test/pptx/speaker_notes_after_metadata_templated.pptx test/pptx/speaker_notes_afterheader.pptx test/pptx/speaker_notes_afterheader_templated.pptx test/pptx/speaker_notes_afterseps.pptx test/pptx/speaker_notes_afterseps_templated.pptx test/pptx/speaker_notes_templated.pptx test/pptx/start_numbering_at.pptx test/pptx/start_numbering_at_templated.pptx test/pptx/tables.pptx test/pptx/tables_templated.pptx test/pptx/two_column.pptx test/pptx/two_column_templated.pptx test/rst-reader.native+3−21 test/tables-rstsubset.native+1−9 test/tables.jats_archiving+156−156 test/tables.jats_articleauthoring+156−156 test/tables.jats_publishing+156−156 test/tables.latex+65−101 test/tables.ms+44 test/tables.org+3−3 test/tables/nordics.html4+6−6 test/tables/nordics.html5+6−6 test/tables/nordics.jats_archiving+58 test/tables/nordics.latex+42 test/tables/nordics.native+60−33 test/tables/planets.html4+1−1 test/tables/planets.html5+1−1 test/tables/planets.jats_archiving+128 test/tables/planets.latex+30 test/tables/planets.native+215−112 test/tables/students.jats_archiving+56 test/tables/students.latex+31 test/tables/students.native+49−32 test/test-pandoc.hs+18−8 test/textile-reader.native+1−1 test/textile-reader.textile+1−1 test/txt2tags.native+1−1 test/txt2tags.t2t+1−1 test/writer.context+45−43 test/writer.dokuwiki+11 test/writer.html4+44−19 test/writer.html5+44−19 test/writer.icml+2 test/writer.jats_archiving+12−8 test/writer.jats_articleauthoring+1−1 test/writer.jats_publishing+12−8 test/writer.jira+23−35 test/writer.latex+4−4 test/writer.markdown+27−54 test/writer.ms+1−1 test/writer.opml+1−1 test/writer.org+91−91 test/writer.zimwiki+3−3 test/writers-lang-and-dir.context+7−5 test/writers-lang-and-dir.latex+11−8 tools/build-arm.sh+110 tools/changelog-helper.sh+11−4 tools/parseTimings.pl+33 trypandoc/index.html+1−1 trypandoc/trypandoc.hs+3−8 windows/Makefile+1−1 windows/pandoc.wxs+2−2
.circleci/config.yml+64−122
@@ -1,130 +1,72 @@
11version: "2.1"
2−
3−env: &env
2+jobs:
3+ build:
4+ macos:
5+ xcode: 11.1.0
46 environment:
5− LC_ALL: "C.UTF-8"
6− docker:
7− - image: fpco/stack-build:lts-13
8−
9−#-----------------------------------------------------------------------------
10−# Common utility stuff, not to be modified usually
11−#-----------------------------------------------------------------------------
12−
13−preinstall: &preinstall
14− run: |
15− echo 'export PATH=/opt/cabal/bin:/opt/ghc/bin:$PATH' >> $BASH_ENV
16− source $BASH_ENV
17− apt-get update
18−
19−restore: &restore
20− # Needs to happen after installing ca-certificates
21− restore_cache:
22− key: v1-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}
23−
24−save: &save
25− save_cache:
26− key: v1-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}
27− paths:
28− - ~/.cabal
29− - ~/.ghc
30− - ~/.local
31− - ~/.stack
32−
33−commands:
34− cabal_build:
35− parameters:
36− ghcversion:
37− type: string
7+ HOMEBREW_NO_AUTO_UPDATE: 1
388 steps:
39− - checkout
40− - *preinstall
41− - *restore
42− - run:
43− name: install cabal
44− command: apt-get install -y cabal-install-2.4
45− - run:
46− name: install ghc
47− command: |
48− apt-get install -y ghc-<< parameters.ghcversion >>
49− - run:
50− name: build and test project
51− command: |
52− set -e
53− cabal v2-update
54− TMPDIR=`mktemp -d -t circleci.XXXXXXX`
55− cabal v2-sdist --output-dir=${TMPDIR}
56− cd ${TMPDIR}
57− tar xvzf *.tar.gz
58− cd *
59− cabal v2-build -w ghc-<< parameters.ghcversion >> -j2 --disable-optimization --dependencies-only --enable-tests --enable-benchmarks
60− cabal v2-build -w ghc-<< parameters.ghcversion >> -j2 --disable-optimization --enable-tests --enable-benchmarks 2>build.log
61− cat build.log
62− # fail if we had warnings in local build
63− # this is to work around the fact that cabal v2 doesn't allow
64− # us to use -Werror for just local build:
65− # https://github.com/haskell/cabal/issues/4247
66− ! grep -q "[Ww]arning:" build.log
67− cabal v2-test -w ghc-<< parameters.ghcversion >> -j2 --disable-optimization --enable-tests
68− cabal v2-haddock -w ghc-<< parameters.ghcversion >>
69− cabal check
70− - *save
9+ - checkout
10+ - restore_cache:
11+ # See https://circleci.com/docs/2.0/caching/
12+ name: Restore Cached Dependencies
13+ keys:
14+ - stack-dependencies-{{ checksum "stack.yaml" }}
15+ - run:
16+ name: Install stack
17+ command: stack --version || (curl -sSL https://get.haskellstack.org/ | sh -s - -f)
18+ - run:
19+ name: Resolve/Update Dependencies
20+ command: stack --no-terminal setup
21+ - run:
22+ name: Run tests
23+ command: stack --no-terminal test
24+ - run:
25+ name: Install executable
26+ command: stack --no-terminal install
27+ - run:
28+ name: Create artifacts
29+ command: |
30+ export VERSION=$(grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')
31+ export ARTIFACTS=macos-release-candidate
32+ export RESOURCES=${ARTIFACTS}/Resources
33+ export ROOT=${ARTIFACTS}/pandoc
34+ export DEST=${ROOT}/usr/local
35+ export ME=$(whoami)
36+ export BASE=pandoc-$VERSION
37+ mkdir -p ${ARTIFACTS}
38+ mkdir -p ${RESOURCES}
39+ mkdir -p ${DEST}/bin
40+ mkdir -p ${DEST}/share/man/man1
41+ cp ~/.local/bin/pandoc ${DEST}/bin/
42+ strip ${DEST}/bin/pandoc
43+ cp man/pandoc.1 ${DEST}/share/man/man1/pandoc.1
44+ ~/.local/bin/pandoc -s COPYING.md -Vpagetitle=License -o ${RESOURCES}/license.html
45+ chown -R $ME:staff ${ROOT}
46+ sed -e "s/PANDOCVERSION/${VERSION}/" macos/distribution.xml.in > ${ARTIFACTS}/distribution.xml
47+ cp macos/Makefile ${ARTIFACTS}/
48+ echo ${VERSION} > ${ARTIFACTS}/version.txt
49+ zip -r macos-release-candidate.zip ${ARTIFACTS}
7150
72−#-----------------------------------------------------------------------------
73−# Build matrix
74−#-----------------------------------------------------------------------------
51+ - save_cache:
52+ name: Cache Dependencies
53+ key: stack-dependencies-{{ checksum "stack.yaml" }}
54+ paths:
55+ - "/root/.stack"
56+ - ".stack-work"
57+ - "/usr/local/bin/stack"
7558
76−jobs:
77− cabal-ghc-8_8_1:
78− <<: *env
79− steps:
80− - cabal_build:
81− ghcversion: 8.8.1
82−
83− cabal-ghc-8_6_5:
84− <<: *env
85− steps:
86− - cabal_build:
87− ghcversion: 8.6.5
88−
89− cabal-ghc-8_4_4:
90− <<: *env
91− steps:
92− - cabal_build:
93− ghcversion: 8.4.4
94−
95− cabal-ghc-8_2_2:
96− <<: *env
97− steps:
98− - cabal_build:
99− ghcversion: 8.2.2
100−
101− cabal-ghc-8_0_2:
102− <<: *env
103− steps:
104− - cabal_build:
105− ghcversion: 8.0.2
106−
107− stack-ghc-8_6:
108− <<: *env
109− steps:
110− - checkout
111− - *preinstall
112− - *restore
113− - run: |
114− set -e
115− apt-get install -y ghc-8.6.5
116− stack update
117− stack test --system-ghc --fast --ghc-options="-Werror" .
118− - *save
59+ - store_artifacts:
60+ # https://circleci.com/docs/2.0/artifacts/
61+ path: macos-release-candidate.zip
62+ destination: macos-release-candidate.zip
11963
12064workflows:
121− version: "2.1"
122− build:
65+ version: 2
66+ release:
12367 jobs:
124− - cabal-ghc-8_6_5
125− - cabal-ghc-8_4_4
126− - cabal-ghc-8_2_2
127− - cabal-ghc-8_0_2
128− - stack-ghc-8_6
129− # - cabal-ghc-8_8_1
130−
68+ - build:
69+ filters:
70+ branches:
71+ only:
72+ - /rc\/.*/
.editorconfig+8
@@ -8,6 +8,14 @@ indent_size = 2
88insert_final_newline = true
99trim_trailing_whitespace = true
1010
11+[*.{zip,docx}]
12+charset =
13+end_of_line =
14+indent_style =
15+indent_size =
16+insert_final_newline =
17+trim_trailing_whitespace =
18+
1119[*.{markdown,md}]
1220trim_trailing_whitespace = false
1321
.github/ISSUE_TEMPLATEdeleted−11
@@ -1,11 +0,0 @@
1−Asking a question?
2−Please use the pandoc-discuss mailing list instead:
3−https://groups.google.com/forum/#!forum/pandoc-discuss
4−This tracker is for bug reports and enhancement requests.
5−
6−Reporting a bug?
7−Please include your pandoc version and an example that allows us
8−to reproduce the problem (complete input, exact command line
9−used, expected and actual output). The smaller the example, the
10−better.
11−
.github/ISSUE_TEMPLATE/bug_report.mdnew file+25
@@ -0,0 +1,25 @@
1+---
2+name: Bug report
3+about: Create a report to help us improve
4+title: ''
5+labels: 'bug'
6+assignees: ''
7+
8+---
9+
10+<!--
11+Thank you for reporting an issue! Before you continue, please make sure that you have
12+
13+- searched the issue tracker for similar issues (including closed issues): https://github.com/jgm/pandoc/issues
14+- searched the pandoc-discuss mailing list for solutions: https://groups.google.com/forum/#!forum/pandoc-discuss
15+- reproduced your issue on the latest release of pandoc, or on https://pandoc.org/try
16+
17+Note that this bug tracker is for reporting bugs, not asking questions. For questions, use the pandoc-discuss mailing list.
18+-->
19+
20+**Explain the problem.**
21+Include the exact command line you used and all inputs necessary to reproduce the issue. Please create as minimal an example as possible, to help the maintainers isolate the problem. Explain the output you received and how it differs from what you expected.
22+
23+**Pandoc version?**
24+What version of pandoc are you using, on what OS?
25+
.github/ISSUE_TEMPLATE/config.ymlnew file+9
@@ -0,0 +1,9 @@
1+blank_issues_enabled: false
2+contact_links:
3+ - name: Ask a question
4+ url: https://groups.google.com/forum/#!forum/pandoc-discuss
5+ about: "Discussion forum for pandoc (may be used as an email list)"
6+ - name: Contributing Guidelines
7+ url: https://pandoc.org/CONTRIBUTING.html
8+ about: "Guidelines for submitting bug reports and code improvements"
9+
.github/ISSUE_TEMPLATE/feature_request.mdnew file+21
@@ -0,0 +1,21 @@
1+---
2+name: Feature request
3+about: Suggest an idea for this project
4+title: ''
5+labels: 'enhancement'
6+assignees: ''
7+
8+---
9+
10+<!--
11+Thank you for suggesting a feature! Before you continue, please make sure that you have
12+
13+- read the contributing guidelines: https://pandoc.org/CONTRIBUTING.html
14+- searched the issue tracker for similar issues (including closed issues): https://github.com/jgm/pandoc/issues
15+- searched the pandoc-discuss mailing list for relevant discussions: https://groups.google.com/forum/#!forum/pandoc-discuss
16+-->
17+
18+**Describe your proposed improvement and the problem it solves.**
19+
20+**Describe alternatives you've considered.**
21+
.github/workflows/ci.yml+96−11
@@ -45,23 +45,50 @@ jobs:
4545 versions:
4646 - ghc: '8.0.2'
4747 cabal: '2.4'
48+ prefix: 'v2-'
49+ cabalopts: ''
50+ testopts: ''
4851 - ghc: '8.2.2'
4952 cabal: '2.4'
53+ prefix: 'v2-'
54+ cabalopts: ''
55+ testopts: ''
5056 - ghc: '8.4.4'
5157 cabal: '2.4'
58+ prefix: 'v2-'
59+ cabalopts: '-f-embed_data_files'
60+ testopts: ''
5261 - ghc: '8.6.5'
5362 cabal: '3.2'
63+ prefix: ''
64+ cabalopts: ''
65+ testopts: '--test-option=--hide-successes'
5466 - ghc: '8.8.4'
5567 cabal: '3.2'
56− - ghc: '8.10.2'
68+ prefix: ''
69+ cabalopts: ''
70+ testopts: '--test-option=--hide-successes'
71+ - ghc: '8.10.4'
5772 cabal: '3.2'
73+ prefix: ''
74+ cabalopts: '-ftrypandoc'
75+ testopts: '--test-option=--hide-successes'
76+ - ghc: '9.0.1'
77+ cabal: '3.4'
78+ prefix: ''
79+ cabalopts: ''
80+ testopts: '--test-option=--hide-successes'
5881 steps:
5982 - uses: actions/checkout@v2
6083
84+ # needed by memory
85+ - name: Install numa
86+ run: sudo apt-get install libnuma-dev
87+
6188 # need to install older cabal/ghc versions from ppa repository
6289
6390 - name: Install recent cabal/ghc
64− uses: actions/setup-haskell@v1.1
91+ uses: haskell/actions/setup@v1
6592 with:
6693 ghc-version: ${{ matrix.versions.ghc }}
6794 cabal-version: ${{ matrix.versions.cabal }}
@@ -88,14 +115,15 @@ jobs:
88115
89116 - name: Install dependencies
90117 run: |
91− cabal v2-update
92− cabal v2-build --dependencies-only --enable-tests --disable-optimization
118+ cabal ${{ matrix.versions.prefix }}update
119+ cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --dependencies-only --enable-tests --disable-optimization
120+
93121 - name: Build and test
94122 run: |
95− cabal v2-build --enable-tests --disable-optimization 2>&1 | tee build.log
123+ cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --enable-tests --disable-optimization 2>&1 | tee build.log
96124 # fail if warnings in local build
97125 ! grep -q ": *[Ww]arning:" build.log || exit 1
98− cabal v2-test --disable-optimization
126+ cabal ${{ matrix.versions.prefix }}test ${{ matrix.versions.cabalopts }} --disable-optimization ${{ matrix.versions.testopts }}
99127
100128 windows:
101129
@@ -104,10 +132,11 @@ jobs:
104132 steps:
105133 - uses: actions/checkout@v2
106134
107− - uses: actions/setup-haskell@v1.1
108− with:
109− enable-stack: true
110− stack-version: 'latest'
135+ # We should have ghc 8.10, cabal, stack pre-installed
136+ # - uses: haskell/actions/setup@v1
137+ # with:
138+ # enable-stack: true
139+ # stack-version: 'latest'
111140
112141 # declare/restore cached things
113142 # caching doesn't work for scheduled runs yet
@@ -153,7 +182,7 @@ jobs:
153182 - uses: actions/checkout@v2
154183
155184 - name: Install recent cabal/ghc
156− uses: actions/setup-haskell@v1.1
185+ uses: haskell/actions/setup@v1
157186 with:
158187 ghc-version: ${{ matrix.versions.ghc }}
159188 cabal-version: ${{ matrix.versions.cabal }}
@@ -188,3 +217,59 @@ jobs:
188217 # fail if warnings in local build
189218 ! grep -q ": *[Ww]arning:" build.log || exit 1
190219 cabal v2-test --disable-optimization
220+
221+ benchmark:
222+
223+ runs-on: ubuntu-18.04
224+ strategy:
225+ fail-fast: true
226+ matrix:
227+ versions:
228+ - ghc: '8.8.4'
229+ cabal: '3.2'
230+ - ghc: '8.10.2'
231+ cabal: '3.2'
232+ steps:
233+ - uses: actions/checkout@v2
234+
235+ # need to install older cabal/ghc versions from ppa repository
236+
237+ - name: Install recent cabal/ghc
238+ uses: haskell/actions/setup@v1
239+ with:
240+ ghc-version: ${{ matrix.versions.ghc }}
241+ cabal-version: ${{ matrix.versions.cabal }}
242+
243+ # declare/restore cached things
244+ # caching doesn't work for scheduled runs yet
245+ # https://github.com/actions/cache/issues/63
246+
247+ - name: Cache cabal global package db
248+ id: cabal-global
249+ uses: actions/cache@v2
250+ with:
251+ path: |
252+ ~/.cabal
253+ key: benchmark-${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}
254+
255+ - name: Cache cabal work
256+ id: cabal-local
257+ uses: actions/cache@v2
258+ with:
259+ path: |
260+ dist-newstyle
261+ key: benchmark-${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local
262+
263+ - name: Install dependencies
264+ run: |
265+ v2=$([ "${{ matrix.versions.cabal }}" = "2.2" ] && printf 'new' || printf 'v2')
266+ cabal $v2-update
267+ cabal $v2-build --dependencies-only --enable-optimization=1 --enable-benchmarks --disable-tests
268+
269+ - name: Build and test
270+ run: |
271+ v2=$([ "${{ matrix.versions.cabal }}" = "2.2" ] && printf 'new' || printf 'v2')
272+ cabal $v2-build --enable-optimization=1 --enable-benchmarks --disable-tests 2>&1 | tee build.log
273+ # fail if warnings in local build
274+ ! grep -q ": *[Ww]arning:" build.log || exit 1
275+ cabal $v2-bench --enable-optimization=1 --benchmark-options='--timeout=6 +RTS -T -RTS'
.github/workflows/format-validation.ymlnew file+88
@@ -0,0 +1,88 @@
1+name: Format validation
2+
3+on:
4+ push:
5+ branches:
6+ - '*'
7+ - '!rc/*'
8+ paths:
9+ - 'test/writer.jats_articleauthoring'
10+ - 'test/writer.jats_publishing'
11+ - 'test/writer.jats_archiving'
12+ - 'test/tables.jats_archiving'
13+ - 'test/tables/nordics.jats_archiving'
14+ - 'test/tables/planets.jats_archiving'
15+ - 'test/tables/students.jats_archiving'
16+ pull_request:
17+ branches:
18+ - '*'
19+ - '!rc/*'
20+ paths:
21+ - 'test/writer.jats_articleauthoring'
22+ - 'test/writer.jats_publishing'
23+ - 'test/writer.jats_archiving'
24+ - 'test/tables.jats_archiving'
25+ - 'test/tables/nordics.jats_archiving'
26+ - 'test/tables/planets.jats_archiving'
27+ - 'test/tables/students.jats_archiving'
28+
29+jobs:
30+ jats:
31+ name: JATS
32+ runs-on: ubuntu-latest
33+ env:
34+ VALIDATOR_URL: "https://jats-validator.hubmed.org/dtd/"
35+ strategy:
36+ fail-fast: false
37+ matrix:
38+ tagset:
39+ - articleauthoring
40+ - publishing
41+ - archiving
42+ steps:
43+ - name: Checkout
44+ uses: actions/checkout@v2
45+
46+ - name: Validate writer output
47+ run: |
48+ filename=test/writer.jats_${{ matrix.tagset }}
49+ printf "Validating file %s\n" "$filename"
50+ json="$(curl --form "xml=@${filename}" --silent "$VALIDATOR_URL")"
51+ err_count="$(printf '%s' "$json" | jq '.errors | length')"
52+ if [ "$err_count" -eq 0 ]; then
53+ printf "File was validated successfully.\n"
54+ exit 0
55+ else
56+ printf "Validator report:\n%s" "$json"
57+ exit 1
58+ fi
59+
60+ - name: Validate tables
61+ # Archiving has the simplest template, so we only check with that.
62+ if: matrix.tagset == 'archiving'
63+ run: |
64+ tmpl="$(cat <<EOF
65+ <?xml version="1.0" encoding="utf-8" ?>
66+ <!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Archiving and Interchange DTD v1.2 20190208//EN"
67+ "JATS-archivearticle1.dtd">
68+ <article xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink" dtd-version="1.2" article-type="other">
69+ <front><article-meta></article-meta></front>
70+ <body>%s</body></article>
71+ EOF
72+ )"
73+ jats_file="$(mktemp jats-tables.XXXXX)"
74+ exit_code=0
75+ for f in tables tables/nordics tables/planets tables/students; do
76+ filename=test/$f.jats_archiving
77+ printf "Validating %s...\n" "$filename"
78+ printf "$tmpl" "$(cat $filename)" > "$jats_file"
79+ json="$(curl --form "xml=@${jats_file}" --silent "$VALIDATOR_URL")"
80+ err_count="$(printf "%s" "$json" | jq '.errors | length')"
81+ if [ "$err_count" -eq 0 ]; then
82+ printf "Table output is valid when used as body content.\n"
83+ else
84+ printf "Validator report:\n%s" "$json"
85+ exit_code=1
86+ fi
87+ done
88+ exit "$exit_code"
.github/workflows/lint.ymlnew file+33
@@ -0,0 +1,33 @@
1+name: Lint
2+
3+# Trigger the workflow on push or pull request, but only for the
4+# master branch
5+on:
6+ pull_request:
7+ branch: [master]
8+ push:
9+ branch: [master]
10+ paths-ignore:
11+ - LICENSE
12+ - README.md
13+ - CHANGELOG.md
14+ - stack.yaml
15+ - .travis.yml
16+
17+jobs:
18+ lint:
19+ name: Lint
20+ runs-on: ubuntu-latest
21+ env:
22+ hlint_script: https://raw.github.com/ndmitchell/hlint/master/misc/run.sh
23+
24+ steps:
25+ - name: Checkout
26+ uses: actions/checkout@v2
27+
28+ - name: Check cabal file for missing test files
29+ run: make check-cabal
30+
31+ - name: Download and run hlint
32+ run: |
33+ curl -sSL "${hlint_script}" | sh -s .
.github/workflows/nightly.yml+9−2
@@ -10,15 +10,22 @@ jobs:
1010 runs-on: ubuntu-18.04
1111 steps:
1212 - uses: actions/checkout@v2
13+
14+ - name: Install recent cabal/ghc
15+ uses: haskell/actions/setup@v1
16+ with:
17+ ghc-version: '8.10.3'
18+ cabal-version: '3.2'
19+
1320 - name: Install dependencies
1421 run: |
1522 ghc --version
1623 cabal --version
1724 cabal v2-update
18− cabal v2-build --dependencies-only all
25+ cabal v2-build --dependencies-only
1926 - name: Build
2027 run: |
21− cabal v2-install all
28+ cabal v2-install
2229 strip $HOME/.cabal/bin/pandoc
2330 - name: Install artifact
2431 run: |
.github/workflows/release-candidate.yml−1
@@ -32,7 +32,6 @@ jobs:
3232 - osarch: "windows-x86_64"
3333 arch: "x64"
3434 stack_opts: "-j1"
35−
3635 steps:
3736 - uses: actions/checkout@v1
3837 - name: Install dependencies
.gitignore+7
@@ -1,4 +1,6 @@
11*~
2+.DS_Store
3+*.orig
24deb/.vagrant
35dist/*
46MANUAL.*
@@ -14,6 +16,10 @@ man/man?/*.html
1416*.o
1517*.hi
1618*.pyc
19+.hie/
20+.policeman-evidence/
21+.projectile/
22+.vscode/
1723/COPYING.rtf
1824/COPYRIGHT.txt
1925/cabal-dev/
@@ -26,3 +32,4 @@ data/reference.odt
2632/stack.yaml.lock
2733cabal.project.local
2834/dist-newstyle/
35+pandoc-2*/
.hlint.yaml+78−52
@@ -2,85 +2,111 @@
22# https://github.com/ndmitchell/hlint
33##########################
44
5−# This file contains a template configuration file, which is typically
6−# placed as .hlint.yaml in the root of your project
7−
8−
95# Specify additional command line arguments
106#
117- arguments: [--color=auto, --cpp-ansi]
128
13−
14−# Control which extensions/flags/modules/functions can be used
15−#
16−# - extensions:
17−# - default: false # all extension are banned by default
18−# - name: [PatternGuards, ViewPatterns] # only these listed extensions can be used
19−# - {name: CPP, within: CrossPlatform} # CPP can only be used in a given module
20−#
21−# - flags:
22−# - {name: -w, within: []} # -w is allowed nowhere
23−#
24−# - modules:
25−# - {name: [Data.Set, Data.HashSet], as: Set} # if you import Data.Set qualified, it must be as 'Set'
26−# - {name: Control.Arrow, within: []} # Certain modules are banned entirely
27−#
28−# - functions:
29−# - {name: unsafePerformIO, within: []} # unsafePerformIO can only appear in no modules
30−
31−
32−# Add custom hints for this project
33−#
34−# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
35−# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}
36−
37−
38−# Turn on hints that are off by default
39−#
40−# Ban "module X(module X) where", to require a real export list
41−# - warn: {name: Use explicit module export list}
42−#
43−# Replace a $ b $ c with a . b $ c
44−# - group: {name: dollar, enabled: true}
45−#
46−# Generalise map to fmap, ++ to <>
47−# - group: {name: generalise, enabled: true}
48−
49−
509# Ignore some builtin hints
51−# - ignore: {name: Use let}
52−# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules
53−# - ignore: {name: "Use section"}
54−# - ignore: {name: "Use camelCase"}
55−# - ignore: {name: "Use list comprehension"}
56−# - ignore: {name: "Redundant if"}
10+#
5711- ignore: {name: "Avoid lambda"}
12+- ignore: {name: "Use bimap"}
5813- ignore: {name: "Eta reduce"}
5914- ignore: {name: "Evaluate"}
60−- ignore: {name: "Monad law, left identity", module: "Text.Pandoc.App.OutputSettings"}
61−- ignore: {name: "Reduce duplication", module: "Text.Pandoc.Readers.Markdown"}
15+- ignore: {name: "Reduce duplication"} # TODO: could be more fine-grained
6216- ignore: {name: "Use &&&"}
6317- ignore: {name: "Use String"}
18+- ignore: {name: "Use camelCase"}
6419- ignore: {name: "Use fmap"} # specific for GHC 7.8 compat
65−- ignore: {name: "Use forM_", module: "Text.Pandoc.Readers.DocBook"}
6620- ignore: {name: "Use isDigit"}
67−- ignore: {name: "Use tuple-section", module: "Text.Pandoc.Readers.EPUB"}
68−- ignore: {name: "Use uncurry", module: "Text.Pandoc.Readers.Docx.Combine"}
21+
22+- ignore:
23+ name: "Monad law, left identity"
24+ within: Text.Pandoc.App.OutputSettings
25+
26+- ignore:
27+ name: "Move brackets to avoid $"
28+ within: Text.Pandoc.Writers.CslJson
29+
30+- ignore:
31+ name: "Redundant <$>"
32+ within:
33+ - Text.Pandoc.Readers.Docx.Parse
34+ - Text.Pandoc.Writers.MediaWiki
35+ - Text.Pandoc.Writers.OpenDocument
36+ - Text.Pandoc.Writers.Powerpoint.Output
37+ - Text.Pandoc.Writers.Powerpoint.Presentation
38+
39+- ignore:
40+ name: "Redundant return"
41+ within: Text.Pandoc.Citeproc.BibTeX
42+
43+# With recent hlint this rule has given false positives on TH
44+- ignore:
45+ name: "Redundant bracket"
46+
47+
6948- ignore:
7049 name: "Use <$>"
7150 within:
7251 - Text.Pandoc.Readers.LaTeX
7352 - Text.Pandoc.Readers.Markdown
53+
7454- ignore:
7555 name: "Use camelCase"
7656 within:
7757 - Tests.Writers.Docbook
7858 - Tests.Writers.Native
59+ - Text.Pandoc.Citeproc
7960 - Text.Pandoc.Extensions
8061 - Text.Pandoc.Lua.Marshaling.Version
62+ - Text.Pandoc.Lua.Module.Pandoc
8163 - Text.Pandoc.Lua.Module.Utils
8264 - Text.Pandoc.Readers.Odt.ContentReader
8365 - Text.Pandoc.Readers.Odt.Namespaces
8466
67+- ignore:
68+ name: "Use forM_"
69+ within:
70+ - Text.Pandoc.Readers.DocBook
71+
72+- ignore:
73+ name: "Use Just"
74+ within:
75+ - Text.Pandoc.Citeproc.MetaValue
76+ - Text.Pandoc.Readers.Odt.ContentReader
77+ - Text.Pandoc.Writers.Roff
78+
79+- ignore:
80+ name: "Use list comprehension"
81+ within: Text.Pandoc.Citeproc.BibTeX
82+
83+- ignore:
84+ name: "Use list literal pattern"
85+ within: Text.Pandoc.Citeproc.MetaValue
86+
87+# TODO: check
88+- ignore:
89+ name: "Use second"
90+ within:
91+ - Text.Pandoc.Citeproc.BibTeX
92+ - Text.Pandoc.Citeproc.Locator
93+
94+# TODO: check
95+- ignore:
96+ name: "Use sortOn"
97+ within: Text.Pandoc.Writers.OpenDocument
98+
99+- ignore:
100+ name: "Use tuple-section"
101+ within:
102+ - Text.Pandoc.Readers.EPUB
103+ - Text.Pandoc.ImageSize
104+ - Text.Pandoc.Readers.Markdown
105+ - Text.Pandoc.Readers.RST
106+
107+# fromRight is only in base >= 4.10
108+- ignore:
109+ name: "Use fromRight"
110+
85111# Define some custom infix operators
86112# - fixity: infixr 3 ~^#^~
.travis.ymldeleted−54
@@ -1,54 +0,0 @@
1−os: osx
2−language: generic
3−cache:
4− timeout: 1000
5− directories:
6− - "$HOME/.stack/"
7− - ".stack-work/"
8−branches:
9− only:
10− - /rc\/.*/
11−install:
12−- set -e
13−- ulimit -n 4096
14−- brew install haskell-stack
15−- which stack
16−- stack --version
17−- stack setup
18−- stack exec -- ghc --version
19−- |
20− export VERSION=$(grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')
21− export BASEDIR=$(pwd)
22− export ARTIFACTS=${BASEDIR}/macos-release-candidate
23− export RESOURCES=${ARTIFACTS}/Resources
24− export ROOT=${ARTIFACTS}/pandoc
25− export DEST=${ROOT}/usr/local
26− export ME=$(whoami)
27− export BASE=pandoc-$VERSION
28− mkdir -p ${ARTIFACTS}
29− mkdir -p ${RESOURCES}
30− mkdir -p ${DEST}/bin
31− mkdir -p ${DEST}/share/man/man1
32− stack build --dependencies-only pandoc
33− stack build pandoc
34− for f in $(find .stack-work/install -name 'pandoc' -perm +001 -type f); do cp $f ${DEST}/bin/; done
35− strip ${DEST}/bin/pandoc
36− cp man/pandoc.1 ${DEST}/share/man/man1/pandoc.1
37− ${DEST}/bin/pandoc -t html5 -s COPYING.md -Vpagetitle=License \
38− -o ${RESOURCES}/license.html
39− chown -R $ME:staff ${ROOT}
40− sed -e "s/PANDOCVERSION/${VERSION}/" macos/distribution.xml.in > ${ARTIFACTS}/distribution.xml
41− cp macos/Makefile ${ARTIFACTS}/
42− echo ${VERSION} > ${ARTIFACTS}/version.txt
43−deploy:
44− on:
45− all_branches: true
46− provider: s3
47− bucket: travis-jgm-pandoc
48− region: us-west-1
49− edge: true
50− local_dir: macos-release-candidate
51− access_key_id:
52− secure: ohEst8EP8Z3r/bPMlYgPATo3B/ye48Z0aGp4W1pEhDZjqufLUVTFBIoicvPApCkTrbKMNTdG+KmasrO/leHpju0uFKYQHDtJmHZe3avIOIdbGnOqn97+mmLZBN5skiJWNtrxnN/TuAM+wlePz1dQpohPt6J3S70ct8DsOdZOaGI=
53− secret_access_key:
54− secure: qZ2RN4Bx4WRcVz9H8ae4S6a3AA85kcca0RdMimIREdGSx4ewMYa8lSdcKDvRbPwXRy8H3SeviqL2tTZw3+ej1jccAHowMj8Zvde5EJwX0+qO4Sr0zdWjnsvMeUmx9pO1oL3L/09KTWiMTT+d4XNpE8eqiY08qN8oMj0EPeR/AS4=
AUTHORS.md+32
@@ -1,11 +1,13 @@
11# Contributors
22
33- Anabra
4+- Aner Lucero
45- Arata Mizuki
56- Arfon Smith
67- Aaron Wolen
78- Albert Krewinkel
89- Alex Ivkin
10+- Alex Toldaiev
911- Alex Vong
1012- Alexander Kondratskiy
1113- Alexander Krotov
@@ -17,6 +19,8 @@
1719- Anders Waldenborg
1820- Andreas Lööw
1921- Andrew Dunning
22+- Andy Morris
23+- Anti-Distinctlyminty
2024- Antoine Latter
2125- Antonio Terceiro
2226- Arata Mizuki
@@ -32,6 +36,7 @@
3236- Benoit Schweblin
3337- Bjorn Buckwalter
3438- Blake Eryx
39+- Bodigrim
3540- Bradley Kuhn
3641- Brent Yorgey
3742- Brian Leung
@@ -42,6 +47,7 @@
4247- Carlos Sosa
4348- Cécile Chemin
4449- Cédric Couralet
50+- Charanjit Singh
4551- Chris Black
4652- Christian Conkle
4753- Christian Despres
@@ -59,19 +65,23 @@
5965- Daniele D'Orazio
6066- David A Roberts
6167- David Lazar
68+- David Martschenko
6269- David Röthlisberger
6370- Denis Laxalde
6471- Denis Maier
6572- Derek Chen-Becker
6673- Diego Balseiro
74+- Dimitri Sabadie
6775- Dmitry Pogodin
6876- Dmitry Volodin
6977- Douglas Calvert
7078- Eigil Rischel
7179- Emanuel Evans
7280- Emerson Harkin
81+- Emily Bourke
7382- Emily Eisenberg
7483- Eric Kow
84+- Erik Rask
7585- Eric Seidel
7686- Eric Schrijver
7787- Ethan Riley
@@ -81,6 +91,7 @@
8191- Florian Beeres
8292- Florian Eitel
8393- Florian Klink
94+- Florian Kohrt
8495- Francesco Occhipinti
8596- François Gannaz
8697- Frederik Elwert
@@ -103,6 +114,7 @@
103114- Hubert Plociniczak
104115- Ian Max Andolina
105116- Igor Khorlo
117+- Igor Pashev
106118- Ilya V. Portnov
107119- Ivan Trubach
108120- Ivo Clarysse
@@ -116,6 +128,7 @@
116128- Jamie F. Olson
117129- Jan Larres
118130- Jan Schulz
131+- Jan Tojnar
119132- Jan-Otto Kröpke
120133- Jason Ronallo
121134- Jeff Arnold
@@ -123,6 +136,7 @@
123136- Jens Getreu
124137- Jens Petersen
125138- Jeroen de Haas
139+- Jerry Sky
126140- Jesse Rosenthal
127141- Joe Hermaszewski
128142- Joe Hillenbrand
@@ -138,6 +152,7 @@
138152- Josef Svenningsson
139153- Joseph C. Sible
140154- Julien Cretel
155+- Julien Dutant
141156- Juliette Fourcot
142157- Juliusz Gonera
143158- Justin Bogner
@@ -155,6 +170,8 @@
155170- Leif Metcalf
156171- Leonard Rosenthol
157172- Lila
173+- Loïc Grobol
174+- Lorenzo
158175- Lucas Escot
159176- Luke Plant
160177- Marc Schreiber
@@ -188,10 +205,12 @@
188205- Nathan Gass
189206- Neil Mayhew
190207- Nick Bart
208+- Nick Berendsen
191209- Nick Fleisher
192210- Nicolas Kaiser
193211- Nikolay Yakimov
194212- Nils Carlson
213+- Nixon Enraght-Moony
195214- Nokome Bentley
196215- Ole Martin Ruud
197216- Oliver Matthews
@@ -216,6 +235,7 @@
216235- Raymond Ehlers
217236- Recai Oktaş
218237- Roland Hieber
238+- Roman Beránek
219239- RyanGlScott
220240- Salim B
221241- Sascha Wilde
@@ -226,12 +246,14 @@
226246- Shahbaz Youssefi
227247- Shaun Attfield
228248- Shim Myeongseob
249+- Shin Sang-jae
229250- Sidarth Kapur
230251- Sidharth Kapur
231252- Simon Hengel
232253- Stefan Dresselhaus
233254- Sumit Sahrawat
234255- Tarik Graba
256+- Tatiana Porras
235257- Thenaesh Elango
236258- Thomas Hodgson
237259- Thomas Weißschuh
@@ -265,10 +287,12 @@
265287- a-vrma
266288- andrebauer
267289- argent0
290+- badumont
268291- blmage
269292- bucklereed
270293- bumper314
271294- chinapedia
295+- cholonam
272296- csforste
273297- dbecher-ito
274298- d-dorazio
@@ -279,8 +303,11 @@
279303- kaizshang91
280304- lux-lth
281305- lwolfsonkin
306+- mbrackeantidot
282307- nkalvi
283308- niszet
309+- nuew
310+- obcat
284311- oltolm
285312- oquechy
286313- quasicomputational
@@ -291,8 +318,13 @@
291318- rski
292319- shreevatsa.public
293320- takahashim
321+- taotieren
322+- tecosaur
323+- TEC
294324- tgkokk
295325- the-solipsist
326+- timo-a
296327- thsutton
297328- vijayphoenix
298329- wiefling
330+- wuffi
CONTRIBUTING.md+123−24
@@ -1,6 +1,64 @@
11Contributing to pandoc
22======================
33
4+Welcome to pandoc! Very soon after its beginnings in 2006, pandoc
5+has been influenced, improved, and modified, by users, devs, and
6+newcomers alike. The project thrives on its active community. It is
7+great to have you here.
8+
9+How can I help?
10+---------------
11+
12+There are many ways in which you can support pandoc. Here are a few
13+ideas:
14+
15+ * Participate in online discussions. The [pandoc-discuss] mailing
16+ list is a good place for this. This gives valuable input and
17+ makes it easier to improve the program.
18+
19+ * Help with questions. Every request that is answered by the wider
20+ community frees time for programming contributors. This will
21+ speed up development of new features and issue fixes. Don't
22+ underestimate your knowledge, please share it!
23+
24+ Good places to help are the [pandoc-discuss] mailing list, Q/A
25+ sites like StackOverflow, community forums (e.g.
26+ [RStudio][RStudio Community], [Zettlr][Zettlr Forum]), and, for
27+ technical questions, the GitHub [issue tracker].
28+
29+ * Write or improve documentation. If you ran into a problem which
30+ took more time to figure out than expected, please consider to
31+ save other users from the same experience. People writing the
32+ documentation tend to lack an outside view, so please help
33+ provide one. Good documentation is both difficult and extremely
34+ important.
35+
36+ The official docs are not the only place for documentation.
37+ Pandoc also has a [Wiki][pandoc wiki]. Private blogs can serve
38+ as documentation just as the official manual can.
39+
40+ * Contribute code. No matter whether it's a small fix in a format
41+ template or a huge lump of Haskell code: help is welcome. It's
42+ usually a good idea to talk about the plans early, as this can
43+ prevent unnecessary work. See below for more information.
44+
45+ * Last but not least: consider funding the development and
46+ maintenance of pandoc financially. You can find sponsor buttons
47+ on the [pandoc website] and the [GitHub repository][GitHub
48+ repo].
49+
50+A rich ecosystem of libraries, editors, filters, and templates has
51+developed around pandoc; conversely, pandoc builds and depends on a
52+large number of libraries. Contributing to any of these projects is
53+another way that can help to ensure stability, and to keep pushing
54+the boundaries of what is possible with pandoc.
55+
56+[RStudio Community]: https://community.rstudio.com/
57+[Zettlr Forum]: https://forum.zettlr.com/
58+[pandoc wiki]: https://github.com/jgm/pandoc/wiki
59+[pandoc website]: https://pandoc.org
60+[GitHub repo]: https://github.com/jgm/pandoc
61+
462Have a question?
563----------------
664
@@ -105,7 +163,12 @@ Explain the rationale for the feature you're requesting. Why would this
105163feature be useful? Consider also any possible drawbacks, including backwards
106164compatibility, new library dependencies, and performance issues.
107165
108−It is best to discuss a potential new feature on [pandoc-discuss]
166+Features are very rarely "implement and forget", as all code must be
167+maintained. This is especially relevant for large or complex
168+contributions. It is helpful to be sympathetic to that fact, and to
169+communicate future plans and availability clearly.
170+
171+Any potential new feature is best discussed on [pandoc-discuss]
109172before opening an issue.
110173
111174Patches and pull requests
@@ -181,9 +244,16 @@ Or with stack:
181244
182245 stack test --test-arguments='-p markdown'
183246
184−It is often helpful to add `-j4` (run tests in parallel)
185−and `--hide-successes` (don't clutter output with successes)
186−to the test arguments as well.
247+It is often helpful to add `-j4` (run tests in parallel) and
248+`--hide-successes` (don't clutter output with successes) to the test
249+arguments as well. Collecting all options in a `cabal.project.local`
250+file in the project's root directory can help to keep `cabal`
251+commands short. E.g.:
252+
253+ flags: +embed_data_files
254+ tests: True
255+ test-show-details: direct
256+ test-options: -j4 --hide-successes
187257
188258If you add a new feature to pandoc, please add tests as well, following
189259the pattern of the existing tests. The test suite code is in
@@ -206,6 +276,35 @@ or Powerpoint to ensure that they weren't corrupted and that
206276they had the expected result, and mention the Word/Powerpoint
207277version and OS in your commit comment.
208278
279+Code style
280+----------
281+
282+Pandoc uses [hlint] to identify opportunities for code improvements
283+like redundant brackets or unnecessary `Language` extensions.
284+However, sometimes there are cases where there are good reasons to
285+use code different from what hlint proposes. In these cases, the
286+respective warning should be disabled in the file `.hlint.yaml`.
287+
288+There should be no errors when running `hlint .`; this is checked by
289+the continuous integration (CI) setup. It is recommended that
290+contributors check their code with a local hlint installation, but
291+relying on the CI is fine, too.
292+
293+A good way to ensure no new warnings are introduced is to use a Git
294+[pre-commit hook] which runs hlint on all updated Haskell files
295+before creating a commit:
296+
297+ #!/bin/sh
298+ git diff --diff-filter=MA --cached --name-only | grep '\.hs$' | \
299+ xargs hlint --hint .hlint.yaml
300+
301+(If you are using GNU `xargs`, add the `-r` option immediately
302+after `xargs`.)
303+
304+Saving this to `.git/hooks/pre-commit`, and making the script
305+executable, will prevent accidental introduction of potentially
306+problematic code.
307+
209308Benchmarks
210309----------
211310
@@ -219,9 +318,6 @@ With stack:
219318
220319 stack bench
221320
222−You can also build `weigh-pandoc` (`stack build pandoc:weigh-pandoc`)
223−to get some statistics on memory usage. (Eventually this should
224−be incorporated into the benchmark suite.)
225321
226322Using the REPL
227323--------------
@@ -233,10 +329,10 @@ a ghci REPL for working with pandoc. With [stack], use
233329We recommend using the following `.ghci` file (which can be
234330placed in the source directory):
235331
236− :set -fobject-code
237− :set -XTypeSynonymInstances
238− :set -XScopedTypeVariables
239− :set -XOverloadedStrings
332+ :set -fobject-code
333+ :set -XTypeSynonymInstances
334+ :set -XScopedTypeVariables
335+ :set -XOverloadedStrings
240336
241337Profiling
242338---------
@@ -280,7 +376,7 @@ The code
280376--------
281377
282378Pandoc has a publicly accessible git repository on
283−GitHub: <http://github.com/jgm/pandoc>. To get a local copy of the source:
379+GitHub: <https://github.com/jgm/pandoc>. To get a local copy of the source:
284380
285381 git clone https://github.com/jgm/pandoc.git
286382
@@ -290,7 +386,7 @@ the pandoc library is in `src/`, the source for the tests is in
290386
291387The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
292388`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can
293−be found in <http://github.com/jgm/pandoc-types>.
389+be found in <https://github.com/jgm/pandoc-types>.
294390
295391To build pandoc, you will need a working installation of the
296392[Haskell platform].
@@ -310,11 +406,11 @@ The library is structured as follows:
310406 tree automatically.
311407 - `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*`
312408 are the writers.
313− - `Text.Pandoc.Biblio` is a utility module for formatting citations
314− using citeproc-hs.
409+ - `Text.Pandoc.Citeproc.*` contain the code for citation handling,
410+ including an interface to the [citeproc] library.
315411 - `Text.Pandoc.Data` is used to embed data files when the `embed_data_files`
316− cabal flag is used. It is generated from `src/Text/Pandoc/Data.hsb` using
317− the preprocessor [hsb2hs].
412+ cabal flag is used.
413+ - `Text.Pandoc.Emoji` is a thin wrapper around [emojis].
318414 - `Text.Pandoc.Highlighting` contains the interface to the
319415 skylighting library, which is used for code syntax highlighting.
320416 - `Text.Pandoc.ImageSize` is a utility module containing functions for
@@ -325,7 +421,6 @@ The library is structured as follows:
325421 - `Text.Pandoc.PDF` contains functions for producing a PDF from a
326422 LaTeX source.
327423 - `Text.Pandoc.Parsing` contains parsing functions used in multiple readers.
328− - `Text.Pandoc.Pretty` is a pretty-printing library specialized to
329424 the needs of pandoc.
330425 - `Text.Pandoc.SelfContained` contains functions for making an HTML
331426 file "self-contained," by importing remotely linked images, CSS,
@@ -353,13 +448,17 @@ you may want to consider submitting a pull request to the
353448[closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed
354449[latest released version]: https://github.com/jgm/pandoc/releases/latest
355450[Nightly builds]: https://github.com/jgm/pandoc/actions?query=workflow%3ANightly
356−[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
451+[pandoc-discuss]: https://groups.google.com/group/pandoc-discuss
357452[issue tracker]: https://github.com/jgm/pandoc/issues
358−[User's Guide]: http://pandoc.org/MANUAL.html
359−[FAQs]: http://pandoc.org/faqs.html
360−[EditorConfig]: http://editorconfig.org/
361−[Haskell platform]: http://www.haskell.org/platform/
362−[hsb2hs]: http://hackage.haskell.org/package/hsb2hs
453+[User's Guide]: https://pandoc.org/MANUAL.html
454+[FAQs]: https://pandoc.org/faqs.html
455+[EditorConfig]: https://editorconfig.org/
456+[Haskell platform]: https://www.haskell.org/platform/
457+[hlint]: https://hackage.haskell.org/package/hlint
458+[citeproc]: https://hackage.haskell.org/package/citeproc
459+[emojis]: https://hackage.haskell.org/package/emojis
460+[hsb2hs]: https://hackage.haskell.org/package/hsb2hs
461+[pre-commit hook]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
363462[GitHub labels]: https://github.com/jgm/pandoc/labels
364463[good first issue]:https://github.com/jgm/pandoc/labels/good%20first%20issue
365464[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
COPYING.md+1−1
@@ -357,5 +357,5 @@ into proprietary programs. If your program is a subroutine library,
357357you may consider it more useful to permit linking proprietary
358358applications with the library. If this is what you want to do, use the
359359[GNU Lesser General Public
360−License](http://www.gnu.org/licenses/lgpl.html) instead of this
360+License](https://www.gnu.org/licenses/lgpl.html) instead of this
361361License.
COPYRIGHT+17−26
@@ -1,5 +1,5 @@
11Pandoc
2−Copyright (C) 2006-2020 John MacFarlane <jgm at berkeley dot edu>
2+Copyright (C) 2006-2021 John MacFarlane <jgm at berkeley dot edu>
33
44With the exceptions noted below, this code is released under the [GPL],
55version 2 or later:
@@ -22,11 +22,11 @@ The GNU General Public License is available in the file COPYING.md in
2222the source distribution. On Debian systems, the complete text of the
2323GPL can be found in `/usr/share/common-licenses/GPL`.
2424
25−[GPL]: http://www.gnu.org/copyleft/gpl.html
25+[GPL]: https://www.gnu.org/copyleft/gpl.html
2626
2727Pandoc's complete source code is available from the [Pandoc home page].
2828
29−[Pandoc home page]: http://pandoc.org
29+[Pandoc home page]: https://pandoc.org
3030
3131Pandoc includes some code with different copyrights, or subject to different
3232licenses. The copyright and license statements for these sources are included
@@ -37,7 +37,7 @@ The modules in the `pandoc-types` repository (Text.Pandoc.Definition,
3737Text.Pandoc.Builder, Text.Pandoc.Generics, Text.Pandoc.JSON,
3838Text.Pandoc.Walk) are licensed under the BSD 3-clause license:
3939
40−Copyright (c) 2006-2020, John MacFarlane
40+Copyright (c) 2006-2021, John MacFarlane
4141
4242All rights reserved.
4343
@@ -73,7 +73,7 @@ Pandoc's templates (in `data/templates`) are dual-licensed as either
7373GPL (v2 or higher, same as pandoc) or (at your option) the BSD
74743-clause license.
7575
76−Copyright (c) 2014--2020, John MacFarlane
76+Copyright (c) 2014--2021, John MacFarlane
7777
7878----------------------------------------------------------------------
7979src/Text/Pandoc/Writers/Muse.hs
@@ -83,19 +83,19 @@ Released under the GNU General Public License version 2 or later.
8383
8484----------------------------------------------------------------------
8585src/Text/Pandoc/Writers/Texinfo.hs
86−Copyright (C) 2008-2020 John MacFarlane and Peter Wang
86+Copyright (C) 2008-2021 John MacFarlane and Peter Wang
8787
8888Released under the GNU General Public License version 2 or later.
8989
9090----------------------------------------------------------------------
9191src/Text/Pandoc/Writers/OpenDocument.hs
92−Copyright (C) 2008-2020 Andrea Rossato and John MacFarlane
92+Copyright (C) 2008-2021 Andrea Rossato and John MacFarlane
9393
9494Released under the GNU General Public License version 2 or later.
9595
9696----------------------------------------------------------------------
9797src/Text/Pandoc/Writers/Org.hs
98−Copyright (C) 2010-2020 Puneeth Chaganti, John MacFarlane, and
98+Copyright (C) 2010-2021 Puneeth Chaganti, John MacFarlane, and
9999 Albert Krewinkel
100100
101101Released under the GNU General Public License version 2 or later.
@@ -115,7 +115,7 @@ Released under the GNU General Public License version 2 or later.
115115
116116----------------------------------------------------------------------
117117src/Text/Pandoc/Readers/Textile.hs
118−Copyright (C) 2010-2020 Paul Rivier and John MacFarlane
118+Copyright (C) 2010-2021 Paul Rivier and John MacFarlane
119119
120120Released under the GNU General Public License version 2 or later.
121121
@@ -133,7 +133,7 @@ Released under the GNU General Public License version 2 or later.
133133
134134----------------------------------------------------------------------
135135src/Text/Pandoc/Readers/EPUB.hs
136−Copyright (C) 2014-2020 Matthew Pickering and John MacFarlane
136+Copyright (C) 2014-2021 Matthew Pickering and John MacFarlane
137137
138138Released under the GNU General Public License version 2 or later.
139139
@@ -141,7 +141,7 @@ Released under the GNU General Public License version 2 or later.
141141src/Text/Pandoc/Readers/Org.hs
142142src/Text/Pandoc/Readers/Org/*
143143test/Tests/Readers/Org/*
144−Copyright (C) 2014-2020 Albert Krewinkel
144+Copyright (C) 2014-2021 Albert Krewinkel
145145
146146Released under the GNU General Public License version 2 or later.
147147
@@ -149,7 +149,7 @@ Released under the GNU General Public License version 2 or later.
149149src/Text/Pandoc/Lua.hs
150150src/Text/Pandoc/Lua/*
151151test/lua/*
152−Copyright (C) 2017--2020 Albert Krewinkel and John MacFarlane
152+Copyright (C) 2017--2021 Albert Krewinkel and John MacFarlane
153153
154154Released under the GNU General Public License version 2 or later.
155155
@@ -157,7 +157,7 @@ Released under the GNU General Public License version 2 or later.
157157src/Text/Pandoc/Readers/Jira.hs
158158src/Text/Pandoc/Writers/Jira.hs
159159test/Tests/Readers/Jira.hs
160−Copyright (C) 2019--2020 Albert Krewinkel
160+Copyright (C) 2019--2021 Albert Krewinkel
161161
162162Released under the GNU General Public License version 2 or later.
163163
@@ -169,21 +169,21 @@ Released under the GNU General Public License version 2 or later.
169169
170170----------------------------------------------------------------------
171171data/pandoc.lua
172−Copyright (C) 2017-2020 Albert Krewinkel
172+Copyright (C) 2017-2021 Albert Krewinkel
173173
174174Released under the GNU General Public License version 2 or later.
175175
176176----------------------------------------------------------------------
177177The dzslides template contains JavaScript and CSS from Paul Rouget's
178178dzslides template.
179−http://github.com/paulrouget/dzslides
179+https://github.com/paulrouget/dzslides
180180
181181Released under the Do What the Fuck You Want To Public License.
182182
183183------------------------------------------------------------------------
184−Pandoc embeds a lua interpreter (via hslua).
184+Pandoc embeds a Lua interpreter (via hslua).
185185
186−Copyright © 1994–2019 Lua.org, PUC-Rio.
186+Copyright © 1994–2020 Lua.org, PUC-Rio.
187187
188188Permission is hereby granted, free of charge, to any person obtaining
189189a copy of this software and associated documentation files (the
@@ -203,12 +203,3 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
203203LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
204204OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
205205WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
206−
207−------------------------------------------------------------------------
208−The template pandoc.jats is Copyright 2013--2015 Martin Fenner,
209−released under GPL version 2 or later.
210−
211−The file data/jats.csl is derived from a csl file by Martin Fenner,
212−revised by Martin Paul Eve and then John MacFarlane.
213−"This work is licensed under a Creative Commons Attribution-ShareAlike 3.0
214−License. Originally by Martin Fenner."
INSTALL.md+27−38
@@ -34,6 +34,10 @@ without SVG support), [Python] (to use Pandoc filters), and
3434
3535 choco install rsvg-convert python miktex
3636
37+Using multiple installation methods can result in two separate
38+installations of pandoc; it is recommended to properly uninstall
39+pandoc before switching to an alternative installation method.
40+
3741By default, Pandoc creates PDFs using LaTeX.
3842We recommend installing it via [MiKTeX].
3943
@@ -45,14 +49,10 @@ by downloading [this script][uninstaller]
4549and running it with `perl uninstall-pandoc.pl`.
4650
4751Alternatively, you can install pandoc using
48−[Homebrew](http://brew.sh):
52+[Homebrew](https://brew.sh):
4953
5054 brew install pandoc
5155
52−To include pandoc's citation parser:
53−
54− brew install pandoc-citeproc
55−
5656Homebrew can also install other software that integrates with Pandoc.
5757For example, to install [librsvg] (its `rsvg-convert` covers formats
5858without SVG support), [Python] (to use Pandoc filters), and
@@ -86,9 +86,8 @@ not outdated. Pandoc is in the [Debian], [Ubuntu], [Slackware],
8686To get the latest release, we provide a binary package for amd64
8787architecture on the **[download page]**.
8888
89−This provides both `pandoc` and `pandoc-citeproc`.
90−The executables are statically linked and
91−have no dynamic dependencies or dependencies on external
89+The executable is statically linked and
90+has no dynamic dependencies or dependencies on external
9291data files. Note: because of the static
9392linking, the pandoc binary from this package cannot use lua
9493filters that require external lua modules written in C.
@@ -98,8 +97,7 @@ Both a tarball and a deb installer are provided. To install the deb:
9897 sudo dpkg -i $DEB
9998
10099where `$DEB` is the path to the downloaded deb. This will
101−install the `pandoc` and `pandoc-citeproc` executables and
102−man pages.
100+install the `pandoc` executable and man page.
103101
104102If you use an RPM-based distro, you may be able to install
105103the deb from our download page using `alien`.
@@ -122,7 +120,7 @@ package repositories. For example, on Debian/Ubuntu,
122120you can install it with `apt-get install haskell-platform`.
123121
124122For PDF output, you'll need LaTeX. We recommend installing
125−[TeX Live](http://www.tug.org/texlive/) via your package
123+[TeX Live](https://www.tug.org/texlive/) via your package
126124manager. (On Debian/Ubuntu, `apt-get install texlive`.)
127125
128126## Chrome OS
@@ -149,7 +147,7 @@ The official Docker images for pandoc can be found at
149147[dockerhub](https://hub.docker.com/).
150148
151149The [pandoc/core](https://hub.docker.com/r/pandoc/core)
152−image contains `pandoc` and `pandoc-citeproc`.
150+image contains `pandoc`.
153151
154152The [pandoc/latex](https://hub.docker.com/r/pandoc/latex)
155153image also contains the minimal LaTeX installation needed
@@ -244,28 +242,22 @@ The easiest way to build pandoc from source is to use [stack][stack]:
244242
245243 pandoc --help
246244
247− [Not sure where `$CABALDIR` is?](http://www.haskell.org/haskellwiki/Cabal-Install#The_cabal-install_configuration_file)
245+ [Not sure where `$CABALDIR` is?](https://wiki.haskell.org/Cabal-Install#The_cabal-install_configuration_file)
248246
249−5. If you want to process citations with pandoc, you will also need to
250− install a separate package, `pandoc-citeproc`. This can be installed
251− using cabal:
252−
253− cabal install pandoc-citeproc
254−
255− By default `pandoc-citeproc` uses the "i;unicode-casemap" method
247+5. By default `pandoc` uses the "i;unicode-casemap" method
256248 to sort bibliography entries (RFC 5051). If you would like to
257249 use the locale-sensitive unicode collation algorithm instead,
258− specify the `unicode_collation` flag:
250+ specify the `icu` flag (which affects the dependency `citeproc`):
259251
260− cabal install pandoc-citeproc -funicode_collation
252+ cabal install pandoc -ficu
261253
262254 Note that this requires the `text-icu` library, which in turn
263255 depends on the C library `icu4c`. Installation directions
264256 vary by platform. Here is how it might work on macOS with Homebrew:
265257
266258 brew install icu4c
267− stack install pandoc-citeproc \
268− --flag "pandoc-citeproc:unicode_collation" \
259+ stack install pandoc \
260+ --flag "citeproc:icu" \
269261 --extra-lib-dirs=/usr/local/opt/icu4c/lib \
270262 --extra-include-dirs=/usr/local/opt/icu4c/include
271263
@@ -274,8 +266,6 @@ The easiest way to build pandoc from source is to use [stack][stack]:
274266 accordingly. If `MANUAL.txt` has been modified, the man page can be
275267 rebuilt: `make man/pandoc.1`.
276268
277− The `pandoc-citeproc.1` man page will also be installed automatically.
278−
279269
280270### Custom cabal method
281271
@@ -397,30 +387,29 @@ To run just the markdown benchmarks:
397387
398388
399389[Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/
400−[Cabal User's Guide]: http://www.haskell.org/cabal/release/latest/doc/users-guide/builders.html#setup-configure-paths
390+[Cabal User's Guide]: https://cabal.readthedocs.io/
401391[Debian]: https://packages.debian.org/pandoc
402392[Fedora]: https://apps.fedoraproject.org/packages/pandoc
403−[FreeBSD ports]: http://www.freshports.org/textproc/hs-pandoc/
404−[GHC]: http://www.haskell.org/ghc/
405−[GPL]: http://www.gnu.org/copyleft/gpl.html
406−[Haskell platform]: http://hackage.haskell.org/platform/
407−[MacPorts]: http://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile
393+[FreeBSD ports]: https://www.freshports.org/textproc/hs-pandoc/
394+[GHC]: https://www.haskell.org/ghc/
395+[Haskell platform]: https://hackage.haskell.org/platform/
396+[MacPorts]: https://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile
408397[MacTeX]: https://tug.org/mactex/
409−[BasicTeX]: http://www.tug.org/mactex/morepackages.html
398+[BasicTeX]: https://www.tug.org/mactex/morepackages.html
410399[LaTeX]: https://www.latex-project.org
411−[MiKTeX]: http://miktex.org/
400+[MiKTeX]: https://miktex.org/
412401[librsvg]: https://wiki.gnome.org/Projects/LibRsvg
413402[Python]: https://www.python.org
414−[NetBSD]: http://pkgsrc.se/wip/pandoc
403+[NetBSD]: https://pkgsrc.se/wip/pandoc
415404[NixOS]: https://nixos.org/nixos/packages.html
416405[Slackware]: https://www.slackbuilds.org/result/?search=pandoc&sv=
417406[Ubuntu]: https://packages.ubuntu.com/pandoc
418407[download page]: https://github.com/jgm/pandoc/releases/latest
419−[gentoo]: http://packages.gentoo.org/package/app-text/pandoc
408+[gentoo]: https://packages.gentoo.org/package/app-text/pandoc
420409[haskell repository]: https://wiki.archlinux.org/index.php/Haskell_Package_Guidelines#.5Bhaskell.5D
421410[openSUSE]: https://software.opensuse.org/package/pandoc
422−[source tarball]: http://hackage.haskell.org/package/pandoc
411+[source tarball]: https://hackage.haskell.org/package/pandoc
423412[stack]: https://docs.haskellstack.org/en/stable/install_and_upgrade.html
424−[cabal-install]: http://hackage.haskell.org/package/cabal-install
413+[cabal-install]: https://hackage.haskell.org/package/cabal-install
425414[Void]: https://voidlinux.org/
426415[uninstaller]: https://raw.githubusercontent.com/jgm/pandoc/master/macos/uninstall-pandoc.pl
MANUAL.txt+574−246
@@ -1,7 +1,7 @@
11---
22title: Pandoc User's Guide
33author: John MacFarlane
4−date: July 23, 2020
4+date: June 20, 2021
55---
66
77# Synopsis
@@ -136,7 +136,7 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
136136When using LaTeX, the following packages need to be available
137137(they are included with all recent versions of [TeX Live]):
138138[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139−[`ifxetex`], [`ifluatex`], [`listings`] (if the
139+[`iftex`], [`listings`] (if the
140140`--listings` option is used), [`fancyvrb`], [`longtable`],
141141[`booktabs`], [`graphicx`] (if the document
142142contains images), [`hyperref`], [`xcolor`],
@@ -180,8 +180,7 @@ footnotes in tables).
180180[`graphicx`]: https://ctan.org/pkg/graphicx
181181[`grffile`]: https://ctan.org/pkg/grffile
182182[`hyperref`]: https://ctan.org/pkg/hyperref
183−[`ifluatex`]: https://ctan.org/pkg/ifluatex
184−[`ifxetex`]: https://ctan.org/pkg/ifxetex
183+[`iftex`]: https://ctan.org/pkg/iftex
185184[`listings`]: https://ctan.org/pkg/listings
186185[`lm`]: https://ctan.org/pkg/lm
187186[`longtable`]: https://ctan.org/pkg/longtable
@@ -281,6 +280,8 @@ header when requesting a document from a URL:
281280 ::: {#output-formats}
282281 - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
283282 - `beamer` ([LaTeX beamer][`beamer`] slide show)
283+ - `bibtex` ([BibTeX] bibliography)
284+ - `biblatex` ([BibLaTeX] bibliography)
284285 - `commonmark` ([CommonMark] Markdown)
285286 - `commonmark_x` ([CommonMark] Markdown with extensions)
286287 - `context` ([ConTeXt])
@@ -360,15 +361,15 @@ header when requesting a document from a URL:
360361 will be used. On \*nix and macOS systems this will be the `pandoc`
361362 subdirectory of the XDG data directory (by default,
362363 `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
363− environment variable). If that directory does not exist,
364− `$HOME/.pandoc` will be used (for backwards compatibility).
365− In Windows the default user data directory is
364+ environment variable). If that directory does not exist and
365+ `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
366+ On Windows the default user data directory is
366367 `C:\Users\USERNAME\AppData\Roaming\pandoc`.
367368 You can find the default user data directory on your system by
368369 looking at the output of `pandoc --version`.
369− A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
370− `slidy`, `slideous`, or `s5` directory
371− placed in this directory will override pandoc's normal defaults.
370+ Data files placed in this directory (for example, `reference.odt`,
371+ `reference.docx`, `epub.css`, `templates`) will override
372+ pandoc's normal defaults.
372373
373374`-d` *FILE*, `--defaults=`*FILE*
374375
@@ -485,7 +486,7 @@ header when requesting a document from a URL:
485486[Emacs Org mode]: https://orgmode.org
486487[AsciiDoc]: https://www.methods.co.nz/asciidoc/
487488[AsciiDoctor]: https://asciidoctor.org/
488−[DZSlides]: http://paulrouget.com/dzslides/
489+[DZSlides]: https://paulrouget.com/dzslides/
489490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
490491[PDF]: https://www.adobe.com/pdf/
491492[reveal.js]: https://revealjs.com/
@@ -588,13 +589,13 @@ header when requesting a document from a URL:
588589
589590 3. `$PATH` (executable only)
590591
591− Filters and Lua-filters are applied in the order specified
592− on the command line.
592+ Filters, Lua-filters, and citeproc processing are applied in
593+ the order specified on the command line.
593594
594595`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
595596
596597: Transform the document in a similar fashion as JSON filters (see
597− `--filter`), but use pandoc's build-in Lua filtering system. The given
598+ `--filter`), but use pandoc's built-in Lua filtering system. The given
598599 Lua script is expected to return a list of Lua filters which will be
599600 applied in order. Each Lua filter must contain element-transforming
600601 functions indexed by the name of the AST element on which the filter
@@ -603,26 +604,17 @@ header when requesting a document from a URL:
603604 The `pandoc` Lua module provides helper functions for element
604605 creation. It is always loaded into the script's Lua environment.
605606
606− The following is an example Lua script for macro-expansion:
607−
608− function expand_hello_world(inline)
609− if inline.c == '{{helloworld}}' then
610− return pandoc.Emph{ pandoc.Str "Hello, World" }
611− else
612− return inline
613− end
614− end
615−
616− return {{Str = expand_hello_world}}
607+ See the [Lua filters documentation] for further details.
617608
618609 In order of preference, pandoc will look for Lua filters in
619610
620− 1. a specified full or relative path (executable or
621− non-executable)
611+ 1. a specified full or relative path
622612
623− 2. `$DATADIR/filters` (executable or non-executable)
624− where `$DATADIR` is the user data directory (see
625− `--data-dir`, above).
613+ 2. `$DATADIR/filters` where `$DATADIR` is the user data
614+ directory (see `--data-dir`, above).
615+
616+ Filters, Lua filters, and citeproc processing are applied in
617+ the order specified on the command line.
626618
627619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
628620
@@ -665,30 +657,30 @@ header when requesting a document from a URL:
665657
666658: Specifies what to do with insertions, deletions, and comments
667659 produced by the MS Word "Track Changes" feature. `accept` (the
668− default), inserts all insertions, and ignores all
669− deletions. `reject` inserts all deletions and ignores
670− insertions. Both `accept` and `reject` ignore comments. `all` puts
671− in insertions, deletions, and comments, wrapped in spans with
672− `insertion`, `deletion`, `comment-start`, and `comment-end`
673− classes, respectively. The author and time of change is
674− included. `all` is useful for scripting: only accepting changes
675− from a certain reviewer, say, or before a certain date. If a
676− paragraph is inserted or deleted, `track-changes=all` produces a
677− span with the class `paragraph-insertion`/`paragraph-deletion`
678− before the affected paragraph break. This option only affects the
679− docx reader.
660+ default) processes all the insertions and deletions.
661+ `reject` ignores them. Both `accept` and `reject` ignore comments.
662+ `all` includes all insertions, deletions, and comments, wrapped
663+ in spans with `insertion`, `deletion`, `comment-start`, and
664+ `comment-end` classes, respectively. The author and time of
665+ change is included. `all` is useful for scripting: only
666+ accepting changes from a certain reviewer, say, or before a
667+ certain date. If a paragraph is inserted or deleted,
668+ `track-changes=all` produces a span with the class
669+ `paragraph-insertion`/`paragraph-deletion` before the
670+ affected paragraph break. This option only affects the docx
671+ reader.
680672
681673`--extract-media=`*DIR*
682674
683675: Extract images and other media contained in or linked from
684676 the source document to the path *DIR*, creating it if
685677 necessary, and adjust the images references in the document
686− so they point to the extracted files. If the source format is
687− a binary container (docx, epub, or odt), the media is
688− extracted from the container and the original
689− filenames are used. Otherwise the media is read from the
690− file system or downloaded, and new filenames are constructed
691− based on SHA1 hashes of the contents.
678+ so they point to the extracted files. Media are downloaded,
679+ read from the file system, or extracted from a binary
680+ container (e.g. docx), as needed. The original file paths
681+ are used if they are relative paths not containing `..`.
682+ Otherwise filenames are constructed from the SHA1 hash of
683+ the contents.
692684
693685`--abbreviations=`*FILE*
694686
@@ -699,14 +691,15 @@ header when requesting a document from a URL:
699691 system default, use
700692 `pandoc --print-default-data-file=abbreviations`. The only
701693 use pandoc makes of this list is in the Markdown reader.
702− Strings ending in a period that are found in this list will
703− be followed by a nonbreaking space, so that the period will
704− not produce sentence-ending space in formats like LaTeX.
694+ Strings found in this list will be followed by a nonbreaking
695+ space, and the period will not produce sentence-ending space
696+ in formats like LaTeX. The strings may not contain spaces.
705697
706698[`pandocfilters`]: https://github.com/jgm/pandocfilters
707699[PHP]: https://github.com/vinai/pandocfilters-php
708700[perl]: https://metacpan.org/pod/Pandoc::Filter
709701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702+[Lua filters documentation]: https://pandoc.org/lua-filters.html
710703
711704## General writer options {.options}
712705
@@ -898,11 +891,11 @@ header when requesting a document from a URL:
898891 will not be searched. For example:
899892 `--resource-path=.:test` will search the working directory
900893 and the `test` subdirectory, in that order.
901−
902− `--resource-path` only has an effect if (a) the output
903− format embeds images (for example, `docx`, `pdf`, or `html`
904− with `--self-contained`) or (b) it is used together with
905− `--extract-media`.
894+ This option can be used repeatedly. Search path components
895+ that come later on the command line will be searched before
896+ those that come earlier, so
897+ `--resource-path foo:bar --resource-path baz:bim` is
898+ equivalent to `--resource-path baz:bim:foo:bar`.
906899
907900`--request-header=`*NAME*`:`*VAL*
908901
@@ -914,7 +907,7 @@ header when requesting a document from a URL:
914907
915908`--no-check-certificate`
916909
917−: Disable the certificate verification to allow access to
910+: Disable the certificate verification to allow access to
918911 unsecure HTTP resources (for example when the certificate
919912 is no longer valid or self signed).
920913
@@ -943,7 +936,9 @@ header when requesting a document from a URL:
943936
944937`--html-q-tags`
945938
946−: Use `<q>` tags for quotes in HTML.
939+: Use `<q>` tags for quotes in HTML. (This option only has an
940+ effect if the `smart` extension is enabled for the input
941+ format used.)
947942
948943`--ascii`
949944
@@ -961,37 +956,45 @@ header when requesting a document from a URL:
961956 placement of link references is affected by the
962957 `--reference-location` option.
963958
964−`--reference-location = block`|`section`|`document`
959+`--reference-location=block`|`section`|`document`
965960
966961: Specify whether footnotes (and references, if `reference-links` is
967962 set) are placed at the end of the current (top-level) block, the
968963 current section, or the document. The default is
969964 `document`. Currently only affects the markdown writer.
970965
966+`--markdown-headings=setext`|`atx`
967+
968+: Specify whether to use ATX-style (`#`-prefixed) or
969+ Setext-style (underlined) headings for level 1 and 2
970+ headings in Markdown output. (The default is `atx`.)
971+ ATX-style headings are always used for levels 3+.
972+ This option also affects Markdown cells in `ipynb` output.
973+
971974`--atx-headers`
972975
973−: Use ATX-style headings in Markdown output. The default is
974− to use setext-style headings for levels 1 to 2, and then ATX headings.
975− (Note: for `gfm` output, ATX headings are always used.)
976− This option also affects markdown cells in `ipynb` output.
976+: *Deprecated synonym for `--markdown-headings=atx`.*
977977
978−`--top-level-division=[default|section|chapter|part]`
978+`--top-level-division=default`|`section`|`chapter`|`part`
979979
980−: Treat top-level headings as the given division type in LaTeX, ConTeXt,
981− DocBook, and TEI output. The hierarchy order is part, chapter, then section;
982− all headings are shifted such that the top-level heading becomes the specified
983− type. The default behavior is to determine the best division type via
984− heuristics: unless other conditions apply, `section` is chosen. When the
985− `documentclass` variable is set to `report`, `book`, or `memoir` (unless the
986− `article` option is specified), `chapter` is implied as the setting for this
987− option. If `beamer` is the output format, specifying either `chapter` or
988− `part` will cause top-level headings to become `\part{..}`, while
989− second-level headings remain as their default type.
980+: Treat top-level headings as the given division type in
981+ LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
982+ order is part, chapter, then section; all headings are
983+ shifted such that the top-level heading becomes the
984+ specified type. The default behavior is to determine the
985+ best division type via heuristics: unless other conditions
986+ apply, `section` is chosen. When the `documentclass`
987+ variable is set to `report`, `book`, or `memoir` (unless the
988+ `article` option is specified), `chapter` is implied as the
989+ setting for this option. If `beamer` is the output format,
990+ specifying either `chapter` or `part` will cause top-level
991+ headings to become `\part{..}`, while second-level headings
992+ remain as their default type.
990993
991994`-N`, `--number-sections`
992995
993−: Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
994− By default, sections are not numbered. Sections with class
996+: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
997+ output. By default, sections are not numbered. Sections with class
995998 `unnumbered` will never be numbered, even if `--number-sections`
996999 is specified.
9971000
@@ -1324,7 +1327,10 @@ header when requesting a document from a URL:
13241327: Set the `bibliography` field in the document's metadata to *FILE*,
13251328 overriding any value set in the metadata. If you supply
13261329 this argument multiple times, each *FILE* will be added to
1327− bibliography.
1330+ bibliography. If *FILE* is a URL, it will be fetched
1331+ via HTTP. If *FILE* is not found relative to the
1332+ working directory, it will be sought in the resource path
1333+ (see `--resource-path`).
13281334
13291335`--csl=`*FILE*
13301336
@@ -1333,8 +1339,8 @@ header when requesting a document from a URL:
13331339 `--metadata csl=FILE`.) If *FILE* is a URL, it will be
13341340 fetched via HTTP. If *FILE* is not found relative to the
13351341 working directory, it will be sought in the resource path
1336− and finally in the `csl` subdirectory of the
1337− pandoc user data directory.
1342+ (see `--resource-path`) and finally in the `csl`
1343+ subdirectory of the pandoc user data directory.
13381344
13391345`--citation-abbreviations=`*FILE*
13401346
@@ -1343,28 +1349,31 @@ header when requesting a document from a URL:
13431349 `--metadata citation-abbreviations=FILE`.)
13441350 If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
13451351 found relative to the working directory, it will be sought
1346− in the resource path and finally in the `csl` subdirectory
1347− of the pandoc user data directory.
1352+ in the resource path (see `--resource-path`) and finally in
1353+ the `csl` subdirectory of the pandoc user data directory.
13481354
13491355`--natbib`
13501356
1351−: Use [`natbib`] for citations in LaTeX output. This option is not for use
1352− with the `--citeproc` option or with PDF output. It is intended for
1353− use in producing a LaTeX file that can be processed with [`bibtex`].
1357+: Use [`natbib`] for citations in LaTeX output. This option
1358+ is not for use with the `--citeproc` option or with PDF
1359+ output. It is intended for use in producing a LaTeX file
1360+ that can be processed with [`bibtex`].
13541361
13551362`--biblatex`
13561363
1357−: Use [`biblatex`] for citations in LaTeX output. This option is not for use
1358− with the `--citeproc` option or with PDF output. It is intended for
1359− use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1364+: Use [`biblatex`] for citations in LaTeX output. This option
1365+ is not for use with the `--citeproc` option or with PDF
1366+ output. It is intended for use in producing a LaTeX file
1367+ that can be processed with [`bibtex`] or [`biber`].
13601368
13611369## Math rendering in HTML {.options}
13621370
1363−The default is to render TeX math as far as possible using Unicode characters.
1364−Formulas are put inside a `span` with `class="math"`, so that they may be styled
1365−differently from the surrounding text if needed. However, this gives acceptable
1366−results only for basic math, usually you will want to use `--mathjax` or another
1367−of the following options.
1371+The default is to render TeX math as far as possible using
1372+Unicode characters. Formulas are put inside a `span` with
1373+`class="math"`, so that they may be styled differently from the
1374+surrounding text if needed. However, this gives acceptable
1375+results only for basic math, usually you will want to use
1376+`--mathjax` or another of the following options.
13681377
13691378`--mathjax`[`=`*URL*]
13701379
@@ -1378,10 +1387,11 @@ of the following options.
13781387
13791388`--mathml`
13801389
1381−: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,
1382− `html4` and `html5`). This is the default in `odt` output. Note that
1383− currently only Firefox and Safari (and select e-book readers) natively
1384− support MathML.
1390+: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1391+ `docbook5`, `jats`, `html4` and `html5`). This is the
1392+ default in `odt` output. Note that currently only Firefox
1393+ and Safari (and select e-book readers) natively support
1394+ MathML.
13851395
13861396`--webtex`[`=`*URL*]
13871397
@@ -1405,13 +1415,12 @@ of the following options.
14051415`--gladtex`
14061416
14071417: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1408− can then be processed by [GladTeX] to produce images of the typeset
1409− formulas and an HTML file with links to these images.
1410− So, the procedure is:
1418+ can then be processed by [GladTeX] to produce SVG images of the typeset
1419+ formulas and an HTML file with these images embedded.
14111420
14121421 pandoc -s --gladtex input.md -o myfile.htex
1413− gladtex -d myfile-images myfile.htex
1414− # produces myfile.html and images in myfile-images
1422+ gladtex -d image_dir myfile.htex
1423+ # produces myfile.html and images in image_dir
14151424
14161425[MathML]: https://www.w3.org/Math/
14171426[MathJax]: https://www.mathjax.org
@@ -1459,6 +1468,7 @@ Nonzero exit codes have the following meanings:
14591468 24 PandocCiteprocError
14601469 31 PandocEpubSubdirectoryError
14611470 43 PandocPDFError
1471+ 44 PandocXMLError
14621472 47 PandocPDFProgramNotFoundError
14631473 61 PandocHttpError
14641474 62 PandocShouldNeverHappenError
@@ -1471,6 +1481,7 @@ Nonzero exit codes have the following meanings:
14711481 91 PandocMacroLoop
14721482 92 PandocUTF8DecodingError
14731483 93 PandocIpynbDecodingError
1484+ 94 PandocUnsupportedCharsetError
14741485 97 PandocCouldNotFindDataFileError
14751486 99 PandocResourceNotFound
14761487----- ------------------------------------
@@ -1495,6 +1506,16 @@ input-files:
14951506- content.md
14961507# or you may use input-file: with a single value
14971508
1509+# Include options from the specified defaults files.
1510+# The files will be searched for first in the working directory
1511+# and then in the defaults subdirectory of the user data directory.
1512+# The files are included in the same order in which they appear in
1513+# the list. Options specified in this defaults file always have
1514+# priority over the included ones.
1515+defaults:
1516+- defsA
1517+- defsB
1518+
14981519template: letter
14991520standalone: true
15001521self-contained: false
@@ -1531,6 +1552,7 @@ csl: ieee
15311552bibliography:
15321553- foobar.bib
15331554- barbaz.json
1555+citation-abbreviations: abbrevs.json
15341556
15351557# Filters will be assumed to be Lua filters if they have
15361558# the .lua extension, and json filters otherwise. But
@@ -1551,8 +1573,11 @@ data-dir:
15511573verbosity: INFO
15521574log-file: log.json
15531575
1554−# citeproc, natbib, or biblatex
1576+# citeproc, natbib, or biblatex. This only affects LaTeX
1577+# output. If you want to use citeproc to format citations,
1578+# you should also set 'citeproc: true' (see above).
15551579cite-method: citeproc
1580+
15561581# part, chapter, section, or default:
15571582top-level-division: chapter
15581583abbreviations:
@@ -1621,7 +1646,7 @@ epub-cover-image: cover.jpg
16211646reference-links: true
16221647# block, section, or document
16231648reference-location: block
1624−atx-headers: false
1649+markdown-headings: setext
16251650
16261651# accept, reject, or all
16271652track-changes: accept
@@ -1651,6 +1676,34 @@ one line:
16511676verbosity: INFO
16521677```
16531678
1679+In fields that expect a file path (or list of file paths), the
1680+following syntax may be used to interpolate environment variables:
1681+
1682+``` yaml
1683+csl: ${HOME}/mycsldir/special.csl
1684+```
1685+
1686+`${USERDATA}` may also be used; this will always resolve to the
1687+user data directory that is current when the defaults file is
1688+parsed, regardless of the setting of the environment
1689+variable `USERDATA`.
1690+
1691+`${.}` will resolve to the directory containing the default
1692+file itself. This allows you to refer to resources contained
1693+in that directory:
1694+
1695+``` yaml
1696+epub-cover-image: ${.}/cover.jpg
1697+epub-metadata: ${.}/meta.xml
1698+resource-path:
1699+- . # the working directory from which pandoc is run
1700+- ${.}/images # the images subdirectory of the directory
1701+ # containing this defaults file
1702+```
1703+
1704+This environment variable interpolation syntax *only* works in
1705+fields that expect file paths.
1706+
16541707Default files can be placed in the `defaults` subdirectory of
16551708the user data directory and used from any directory. For
16561709example, one could create a file specifying defaults for writing
@@ -1878,7 +1931,8 @@ ${ styles.html() }
18781931```
18791932
18801933(If a partial is not found in the directory of the
1881−template, it will also be sought in the `templates`
1934+template and the template path is given as a relative
1935+path, it will also be sought in the `templates`
18821936subdirectory of the user data directory.)
18831937
18841938Partials may optionally be applied to variables using
@@ -2096,7 +2150,8 @@ Currently the following pipes are predefined:
20962150 including a title block in the document itself, you can
20972151 set the `title-meta`, `author-meta`, and `date-meta`
20982152 variables. (By default these are set automatically, based
2099− on `title`, `author`, and `date`.)
2153+ on `title`, `author`, and `date`.) The page title in HTML
2154+ is set by `pagetitle`, which is equal to `title` by default.
21002155
21012156`subtitle`
21022157: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
@@ -2170,15 +2225,16 @@ ODT or pptx.
21702225: the base script direction, either `rtl` (right-to-left)
21712226 or `ltr` (left-to-right).
21722227
2173− For bidirectional documents, native pandoc `span`s and `div`s
2174− with the `dir` attribute (value `rtl` or `ltr`) can be used to
2175− override the base direction in some output formats.
2176− This may not always be necessary if the final renderer
2177− (e.g. the browser, when generating HTML) supports the
2178− [Unicode Bidirectional Algorithm].
2228+ For bidirectional documents, native pandoc `span`s and
2229+ `div`s with the `dir` attribute (value `rtl` or `ltr`) can
2230+ be used to override the base direction in some output
2231+ formats. This may not always be necessary if the final
2232+ renderer (e.g. the browser, when generating HTML) supports
2233+ the [Unicode Bidirectional Algorithm].
21792234
2180− When using LaTeX for bidirectional documents, only the `xelatex` engine
2181− is fully supported (use `--pdf-engine=xelatex`).
2235+ When using LaTeX for bidirectional documents, only the
2236+ `xelatex` engine is fully supported (use
2237+ `--pdf-engine=xelatex`).
21822238
21832239[BCP 47]: https://tools.ietf.org/html/bcp47
21842240[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
@@ -2187,7 +2243,7 @@ ODT or pptx.
21872243### Variables for HTML
21882244
21892245`document-css`
2190−: Enables inclusion of most of the CSS in the `styles.html`
2246+: Enables inclusion of most of the [CSS] in the `styles.html`
21912247 [partial](#partials) (have a look with
21922248 `pandoc --print-default-data-file=templates/styles.html`).
21932249 Unless you use [`--css`](#option--css), this variable
@@ -2211,6 +2267,10 @@ ODT or pptx.
22112267`monofont`
22122268: sets the CSS `font-family` property on `code` elements.
22132269
2270+`monobackgroundcolor`
2271+: sets the CSS `background-color` property on `code` elements
2272+ and adds extra padding.
2273+
22142274`linestretch`
22152275: sets the CSS `line-height` property on the `html` element,
22162276 which is preferred to be unitless.
@@ -2221,18 +2281,41 @@ ODT or pptx.
22212281`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
22222282: sets the corresponding CSS `padding` properties on the `body` element.
22232283
2284+To override or extend some [CSS] for just one document, include for example:
2285+
2286+ ---
2287+ header-includes: |
2288+ <style>
2289+ blockquote {
2290+ font-style: italic;
2291+ }
2292+ tr.even {
2293+ background-color: #f0f0f0;
2294+ }
2295+ td, th {
2296+ padding: 0.5em 2em 0.5em 0.5em;
2297+ }
2298+ tbody {
2299+ border-bottom: none;
2300+ }
2301+ </style>
2302+ ---
2303+
2304+[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
2305+
22242306### Variables for HTML math
22252307
22262308`classoption`
2227−: when using [KaTeX](#option--katex), you can render display math equations
2228− flush left using [YAML metadata](#layout) or with `-M classoption=fleqn`.
2309+: when using [KaTeX](#option--katex), you can render display
2310+math equations flush left using [YAML metadata](#layout) or with
2311+`-M classoption=fleqn`.
22292312
22302313### Variables for HTML slides
22312314
22322315These affect HTML output when [producing slide shows with pandoc].
22332316
2234−All [reveal.js configuration options] are available as variables.
2235−To turn off boolean flags that default to true in reveal.js, use `0`.
2317+`institute`
2318+: author affiliations: can be a list when there are multiple authors
22362319
22372320`revealjs-url`
22382321: base URL for reveal.js documents (defaults to
@@ -2252,6 +2335,9 @@ To turn off boolean flags that default to true in reveal.js, use `0`.
22522335: additional attributes for the title slide of reveal.js slide shows.
22532336 See [background in reveal.js and beamer] for an example.
22542337
2338+All [reveal.js configuration options] are available as variables.
2339+To turn off boolean flags that default to true in reveal.js, use `0`.
2340+
22552341[reveal.js configuration options]: https://revealjs.com/config/
22562342
22572343### Variables for Beamer slides
@@ -2337,9 +2423,10 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
23372423 ...
23382424
23392425`documentclass`
2340−: document class: usually one of the standard classes, [`article`], [`book`],
2341− and [`report`]; the [KOMA-Script] equivalents, `scrartcl`, `scrbook`,
2342− and `scrreprt`, which default to smaller margins; or [`memoir`]
2426+: document class: usually one of the standard classes,
2427+ [`article`], [`book`], and [`report`]; the [KOMA-Script]
2428+ equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
2429+ default to smaller margins; or [`memoir`]
23432430
23442431`geometry`
23452432: option for [`geometry`] package, e.g. `margin=1in`;
@@ -2364,8 +2451,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
23642451 ...
23652452
23662453`indent`
2367−: uses document class settings for indentation (the default LaTeX template
2368− otherwise removes indentation and adds space between paragraphs)
2454+: if true, pandoc will use document class settings for
2455+ indentation (the default LaTeX template otherwise removes
2456+ indentation and adds space between paragraphs)
23692457
23702458`linestretch`
23712459: adjusts line spacing using the [`setspace`]
@@ -2390,8 +2478,8 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
23902478#### Fonts
23912479
23922480`fontenc`
2393−: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
2394− default is `T1` (see [LaTeX font encodings guide])
2481+: allows font encoding to be specified through `fontenc` package (with
2482+ `pdflatex`); default is `T1` (see [LaTeX font encodings guide])
23952483
23962484`fontfamily`
23972485: font package for use with `pdflatex`:
@@ -2461,7 +2549,8 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
24612549: contents of acknowledgments footnote after document title
24622550
24632551`toc`
2464−: include table of contents (can also be set using `--toc/--table-of-contents`)
2552+: include table of contents (can also be set using
2553+ `--toc/--table-of-contents`)
24652554
24662555`toc-depth`
24672556: level of section to include in table of contents
@@ -2503,12 +2592,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25032592: font size for body text (e.g. `10pt`, `12pt`)
25042593
25052594`headertext`, `footertext`
2506−: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2507− repeat up to four times for different placement
2595+: text to be placed in running header or footer (see [ConTeXt Headers and
2596+ Footers]); repeat up to four times for different placement
25082597
25092598`indenting`
2510−: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2511− repeat for multiple options
2599+: controls indentation of paragraphs, e.g. `yes,small,next` (see
2600+ [ConTeXt Indentation]); repeat for multiple options
25122601
25132602`interlinespace`
25142603: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
@@ -2519,16 +2608,19 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25192608 repeat for multiple options
25202609
25212610`linkcolor`, `contrastcolor`
2522−: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2611+: color for links outside and inside a page, e.g. `red`, `blue` (see
2612+ [ConTeXt Color])
25232613
25242614`linkstyle`
2525−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2615+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616+ `type`, `cap`, `small`
25262617
25272618`lof`, `lot`
25282619: include list of figures, list of tables
25292620
25302621`mainfont`, `sansfont`, `monofont`, `mathfont`
2531−: font families: take the name of any system font (see [ConTeXt Font Switching])
2622+: font families: take the name of any system font (see
2623+ [ConTeXt Font Switching])
25322624
25332625`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
25342626: sets margins, if `layout` is not used (otherwise `layout`
@@ -2543,16 +2635,18 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25432635 repeat for multiple options
25442636
25452637`pdfa`
2546−: adds to the preamble the setup necessary to generate PDF/A of the type
2547− specified, e.g. `1a:2005`, `2a`. If no type is specified (i.e. the value
2548− is set to True, by e.g. `--metadata=pdfa` or `pdfa: true` in a YAML metadata
2549− block), `1b:2005` will be used as default, for reasons of backwards
2550− compatibility. Using `--variable=pdfa` without specified value is not supported.
2551− To successfully generate PDF/A the required ICC color profiles have to
2552− be available and the content and all included files (such as images)
2553− have to be standard conforming. The ICC profiles and output intent
2554− may be specified using the variables `pdfaiccprofile` and `pdfaintent`.
2555− See also [ConTeXt PDFA] for more details.
2638+: adds to the preamble the setup necessary to generate PDF/A
2639+ of the type specified, e.g. `1a:2005`, `2a`. If no type is
2640+ specified (i.e. the value is set to True, by e.g.
2641+ `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),
2642+ `1b:2005` will be used as default, for reasons of backwards
2643+ compatibility. Using `--variable=pdfa` without specified value
2644+ is not supported. To successfully generate PDF/A the required
2645+ ICC color profiles have to be available and the content and all
2646+ included files (such as images) have to be standard conforming.
2647+ The ICC profiles and output intent may be specified using the
2648+ variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt
2649+ PDFA] for more details.
25562650
25572651`pdfaiccprofile`
25582652: when used in conjunction with `pdfa`, specifies the ICC profile to use
@@ -2567,10 +2661,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.
25672661 If left unspecified, `sRGB IEC61966-2.1` is used as default.
25682662
25692663`toc`
2570−: include table of contents (can also be set using `--toc/--table-of-contents`)
2664+: include table of contents (can also be set using
2665+ `--toc/--table-of-contents`)
25712666
25722667`whitespace`
2573−: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2668+: spacing between paragraphs, e.g. `none`, `small` (using
2669+ [`setupwhitespace`])
25742670
25752671`includesource`
25762672: include all source documents as file attachments in the PDF file
@@ -2861,7 +2957,7 @@ their respective sections of [Pandoc's Markdown]:
28612957 for the following formats (in addition to `markdown`):
28622958
28632959 input formats
2864− : `latex`, `org`, `textile`, `html` (environments, `\ref`, and
2960+ : `latex`, `textile`, `html` (environments, `\ref`, and
28652961 `\eqref` only), `ipynb`
28662962
28672963 output formats
@@ -2973,6 +3069,43 @@ This extension can be enabled/disabled for the following formats:
29733069output formats
29743070: `odt`, `opendocument`
29753071
3072+#### Extension: `xrefs_name` ####
3073+
3074+Links to headings, figures and tables inside the document are
3075+substituted with cross-references that will use the name or caption
3076+of the referenced item. The original link text is replaced once
3077+the generated document is refreshed. This extension can be combined
3078+with `xrefs_number` in which case numbers will appear before the
3079+name.
3080+
3081+Text in cross-references is only made consistent with the referenced
3082+item once the document has been refreshed.
3083+
3084+This extension can be enabled/disabled for the following formats:
3085+
3086+output formats
3087+: `odt`, `opendocument`
3088+
3089+#### Extension: `xrefs_number` ####
3090+
3091+Links to headings, figures and tables inside the document are
3092+substituted with cross-references that will use the number
3093+of the referenced item. The original link text is discarded.
3094+This extension can be combined with `xrefs_name` in which case
3095+the name or caption numbers will appear after the number.
3096+
3097+For the `xrefs_number` to be useful heading numbers must be enabled
3098+in the generated document, also table and figure captions must be enabled
3099+using for example the `native_numbering` extension.
3100+
3101+Numbers in cross-references are only visible in the final document once
3102+it has been refreshed.
3103+
3104+This extension can be enabled/disabled for the following formats:
3105+
3106+output formats
3107+: `odt`, `opendocument`
3108+
29763109#### Extension: `styles` #### {#ext-styles}
29773110
29783111When converting from docx, read all docx styles as divs (for
@@ -2994,13 +3127,20 @@ extensions to Emacs Muse markup.
29943127In the `ipynb` input format, this causes Markdown cells
29953128to be included as raw Markdown blocks (allowing lossless
29963129round-tripping) rather than being parsed. Use this only
2997−when you are targetting `ipynb` or a markdown-based
3130+when you are targeting `ipynb` or a markdown-based
29983131output format.
29993132
30003133#### Extension: `citations` {#org-citations}
30013134
3002−Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted
3003−in `org` input.
3135+Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136+are also accepted in `org` input.
3137+
3138+#### Extension: `element_citations` ####
3139+
3140+In the `jats` output formats, this causes reference items to
3141+be replaced with `<element-citation>` elements. These
3142+elements are not influenced by CSL styles, but all information
3143+on the item is included in tags.
30043144
30053145#### Extension: `ntb` ####
30063146
@@ -3108,7 +3248,8 @@ pandoc does require the space.
31083248
31093249### Heading identifiers ###
31103250
3111−See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.
3251+See also the [`auto_identifiers`
3252+extension](#extension-auto_identifiers) above.
31123253
31133254#### Extension: `header_attributes` ####
31143255
@@ -3230,11 +3371,12 @@ block in a block quote, you need five spaces after the `>`:
32303371
32313372#### Extension: `blank_before_blockquote` ####
32323373
3233−Standard Markdown syntax does not require a blank line before a block
3234−quote. Pandoc does require this (except, of course, at the beginning of the
3235−document). The reason for the requirement is that it is all too easy for a
3236−`>` to end up at the beginning of a line by accident (perhaps through line
3237−wrapping). So, unless the `markdown_strict` format is used, the following does
3374+Standard Markdown syntax does not require a blank line before a
3375+block quote. Pandoc does require this (except, of course, at
3376+the beginning of the document). The reason for the requirement
3377+is that it is all too easy for a `>` to end up at the beginning
3378+of a line by accident (perhaps through line wrapping). So,
3379+unless the `markdown_strict` format is used, the following does
32383380not produce a nested block quote in pandoc:
32393381
32403382 > This is a block quote.
@@ -3303,14 +3445,16 @@ this syntax:
33033445 qsort (filter (>= x) xs)
33043446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33053447
3306−Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3307−`startFrom` is an attribute with value `100`. Some output formats can use this
3308−information to do syntax highlighting. Currently, the only output formats
3309−that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3310−highlighting is supported for your output format and language, then the code
3311−block above will appear highlighted, with numbered lines. (To see which
3312−languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,
3313−the code block above will appear as follows:
3448+Here `mycode` is an identifier, `haskell` and `numberLines` are
3449+classes, and `startFrom` is an attribute with value `100`. Some
3450+output formats can use this information to do syntax
3451+highlighting. Currently, the only output formats that uses this
3452+information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
3453+highlighting is supported for your output format and language,
3454+then the code block above will appear highlighted, with numbered
3455+lines. (To see which languages are supported, type `pandoc
3456+--list-highlight-languages`.) Otherwise, the code block above
3457+will appear as follows:
33143458
33153459 <pre id="mycode" class="haskell numberLines" startFrom="100">
33163460 <code>
@@ -3373,6 +3517,9 @@ line must begin with a space.
33733517 | 200 Main St.
33743518 | Berkeley, CA 94718
33753519
3520+Inline formatting (such as emphasis) is allowed in the content,
3521+but not block-level formatting (such as block quotes or lists).
3522+
33763523This syntax is borrowed from [reStructuredText].
33773524
33783525## Lists
@@ -3576,11 +3723,12 @@ a blank line, and must be followed by one or more definitions.
35763723A definition begins with a colon or tilde, which may be indented one
35773724or two spaces.
35783725
3579−A term may have multiple definitions, and each definition may consist of one or
3580−more block elements (paragraph, code block, list, etc.), each indented four
3581−spaces or one tab stop. The body of the definition (including the first line,
3582−aside from the colon or tilde) should be indented four spaces. However,
3583−as with other Markdown lists, you can "lazily" omit indentation except
3726+A term may have multiple definitions, and each definition may
3727+consist of one or more block elements (paragraph, code block,
3728+list, etc.), each indented four spaces or one tab stop. The
3729+body of the definition (including the first line, aside from the
3730+colon or tilde) should be indented four spaces. However, as with
3731+other Markdown lists, you can "lazily" omit indentation except
35843732at the beginning of a paragraph or other block element:
35853733
35863734 Term 1
@@ -3606,9 +3754,10 @@ definition:
36063754Note that space between items in a definition list is required.
36073755(A variant that loosens this requirement, but disallows "lazy"
36083756hard wrapping, can be activated with `compact_definition_lists`: see
3609−[Non-pandoc extensions], below.)
3757+[Non-default extensions], below.)
36103758
3611−[^3]: I have been influenced by the suggestions of [David Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
3759+[^3]: I have been influenced by the suggestions of [David
3760+ Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).
36123761
36133762### Numbered example lists ###
36143763
@@ -4030,10 +4179,12 @@ option is used. All of the metadata will appear in a single block
40304179at the beginning of the document.
40314180
40324181Note that [YAML] escaping rules must be followed. Thus, for example,
4033−if a title contains a colon, it must be quoted. The pipe character
4034−(`|`) can be used to begin an indented block that will be interpreted
4035−literally, without need for escaping. This form is necessary
4036−when the field contains blank lines or block-level formatting:
4182+if a title contains a colon, it must be quoted, and if it contains a
4183+backslash escape, then it must be ensured that it is not treated as a
4184+[YAML escape sequence]. The pipe character (`|`) can be used to begin
4185+an indented block that will be interpreted literally, without need for
4186+escaping. This form is necessary when the field contains blank lines
4187+or block-level formatting:
40374188
40384189 ---
40394190 title: 'This is the title: it contains a colon'
@@ -4047,6 +4198,12 @@ when the field contains blank lines or block-level formatting:
40474198 It consists of two paragraphs.
40484199 ...
40494200
4201+The literal block after the `|` must be indented relative to the
4202+line containing the `|`. If it is not, the YAML will be invalid
4203+and pandoc will not interpret it as metadata. For an overview
4204+of the complex rules governing YAML, see the [Wikipedia entry on
4205+YAML syntax].
4206+
40504207Template variables will be set automatically from the metadata. Thus, for
40514208example, in writing HTML, the variable `abstract` will be set to the HTML
40524209equivalent of the Markdown in the `abstract` field:
@@ -4093,6 +4250,24 @@ will be interpreted as markdown. For example:
40934250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
40944251 ```
40954252
4253+Note: the `yaml_metadata_block` extension works with
4254+`commonmark` as well as `markdown` (and it is enabled by default
4255+in `gfm` and `commonmark_x`). However, in these formats the
4256+following restrictions apply:
4257+
4258+- The YAML metadata block must occur at the beginning of the
4259+ document (and there can be only one). If multiple files are
4260+ given as arguments to pandoc, only the first can be a YAML
4261+ metadata block.
4262+
4263+- The leaf nodes of the YAML structure are parsed in isolation from
4264+ each other and from the rest of the document. So, for
4265+ example, you can't use a reference link in these contexts
4266+ if the link definition is somewhere else in the document.
4267+
4268+[YAML escape sequence]: https://yaml.org/spec/1.2/spec.html#id2776092
4269+[Wikipedia entry on YAML syntax]: https://en.m.wikipedia.org/wiki/YAML#Syntax
4270+
40964271## Backslash escapes
40974272
40984273#### Extension: `all_symbols_escapable` ####
@@ -4250,7 +4425,8 @@ you need to enclose text in literal `$` characters, backslash-escape
42504425them and they won't be treated as math delimiters.
42514426
42524427For display math, use `$$` delimiters. (In this case, the delimiters
4253−may be separated from the formula by whitespace.)
4428+may be separated from the formula by whitespace. However, there can be
4429+no blank lines betwen the opening and closing `$$` delimiters.)
42544430
42554431TeX math will be printed in all output formats. How it is rendered
42564432depends on the output format:
@@ -4368,8 +4544,8 @@ into
43684544
43694545whereas `Markdown.pl` will preserve it as is.
43704546
4371−There is one exception to this rule: text between `<script>` and
4372−`<style>` tags is not interpreted as Markdown.
4547+There is one exception to this rule: text between `<script>`,
4548+`<style>`, and `<textarea>` tags is not interpreted as Markdown.
43734549
43744550This departure from standard Markdown should make it easier to mix
43754551Markdown with HTML block elements. For example, one can surround
@@ -4784,37 +4960,68 @@ Inline and regular footnotes may be mixed freely.
47844960
47854961#### Extension: `citations` ####
47864962
4787−Markdown citations go inside square brackets and are separated
4788−by semicolons. Each citation must have a key, composed of '@' +
4789−the citation identifier from the database, and may optionally
4790−have a prefix, a locator, and a suffix. The citation key must
4791−begin with a letter, digit, or `_`, and may contain
4792−alphanumerics, `_`, and internal punctuation characters
4793−(`:.#$%&-+?<>~/`). Here are some examples:
4794−
4795− Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
4796−
4797− Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
4798−
4799− Blah blah [@smith04; @doe99].
4800−
4801−`pandoc` detects locator terms in the [CSL locale files].
4802−Either abbreviated or unabbreviated forms are accepted. In the `en-US`
4803−locale, locator terms can be written in either singular or plural forms,
4804−as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
4805−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
4806−`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
4807−`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
4808−`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
4809−`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
4963+To cite a bibliographic item with an identifier foo, use the
4964+syntax `@foo`. Normal citations should be included in square
4965+brackets, with semicolons separating distinct items:
4966+
4967+ Blah blah [@doe99; @smith2000; @smith2004].
4968+
4969+How this is rendered depends on the citation style. In an
4970+author-date style, it might render as
4971+
4972+ Blah blah (Doe 1999, Smith 2000, 2004).
4973+
4974+In a footnote style, it might render as
4975+
4976+ Blah blah.[^1]
4977+
4978+ [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
4979+ Susan Smith, "Flies," *Journal of Insects* (2000);
4980+ Susan Smith, "Bees," *Journal of Insects* (2004).
4981+
4982+See the [CSL user documentation] for more information about CSL
4983+styles and how they affect rendering.
4984+
4985+Unless a citation key start with a letter, digit, or `_`,
4986+and contains only alphanumerics and internal punctuation
4987+characters (`:.#$%&-+?<>~/`), it must be surrounded
4988+by curly braces, which are not considered part of the key.
4989+In `@Foo_bar.baz.`, the key is `Foo_bar.baz`. The final
4990+period is not *internal* punctuation, so it is not included in
4991+the key. In `@{Foo_bar.baz.}`, the key is `Foo_bar.baz.`, including
4992+the final period. The curly braces are recommended if you use URLs as
4993+keys: `[@{https://example.com/bib?name=foobar&date=2000}, p. 33]`.
4994+
4995+Citation items may optionally include a prefix, a locator, and
4996+a suffix. In
4997+
4998+ Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
4999+
5000+The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,
5001+and suffix `and *passim*`. The second item (`smith04`) has
5002+locator `chap. 1` and no prefix or suffix.
5003+
5004+Pandoc uses some heuristics to separate the locator from the
5005+rest of the subject. It is sensitive to the locator terms
5006+defined in the [CSL locale files]. Either abbreviated or
5007+unabbreviated forms are accepted. In the `en-US` locale, locator
5008+terms can be written in either singular or plural forms, as
5009+`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
5010+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,
5011+`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;
5012+`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;
5013+`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,
5014+`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,
5015+`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
48105016locator term is used, "page" is assumed.
48115017
4812−`pandoc` will use heuristics to distinguish the locator
4813−from the suffix. In complex cases, the locator can be enclosed
4814−in curly braces:
5018+In complex cases, you can force something to be treated as
5019+a locator by enclosing it in curly braces or prevent parsing
5020+the suffix as locator by prepending curly braces:
48155021
48165022 [@smith{ii, A, D-Z}, with a suffix]
48175023 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5024+ [@smith{}, 99 years later]
48185025
48195026A minus sign (`-`) before the `@` will suppress mention of
48205027the author in the citation. This can be useful when the
@@ -4822,13 +5029,26 @@ author is already mentioned in the text:
48225029
48235030 Smith says blah [-@smith04].
48245031
4825−You can also write an in-text citation, as follows:
5032+You can also write an author-in-text citation, by omitting the
5033+square brackets:
48265034
48275035 @smith04 says blah.
48285036
48295037 @smith04 [p. 33] says blah.
48305038
5039+This will cause the author's name to be rendered, followed by
5040+the bibliographical details. Use this form when you want to
5041+make the citation the subject of a sentence.
5042+
5043+When you are using a note style, it is usually better to let
5044+citeproc create the footnotes from citations rather than writing
5045+an explicit note. If you do write an explicit note that
5046+contains a citation, note that normal citations will be put in
5047+parentheses, while author-in-text citations will not. For
5048+this reason, it is sometimes preferable to use the
5049+author-in-text style inside notes when using a note style.
48315050
5051+[CSL user documentation]: https://citationstyles.org/authors/
48325052[CSL]: https://docs.citationstyles.org/en/stable/specification.html
48335053[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
48345054[Chicago Manual of Style]: https://chicagomanualofstyle.org
@@ -4837,13 +5057,44 @@ You can also write an in-text citation, as follows:
48375057[finding and editing styles]: https://citationstyles.org/authors/
48385058[CSL locale files]: https://github.com/citation-style-language/locales
48395059
4840−## Non-pandoc extensions
5060+## Non-default extensions
48415061
48425062The following Markdown syntax extensions are not enabled by default
48435063in pandoc, but may be enabled by adding `+EXTENSION` to the format
48445064name, where `EXTENSION` is the name of the extension. Thus, for
48455065example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
48465066
5067+#### Extension: `rebase_relative_paths` ####
5068+
5069+Rewrite relative paths for Markdown links and images, depending
5070+on the path of the file containing the link or image link. For
5071+each link or image, pandoc will compute the directory of the
5072+containing file, relative to the working directory, and prepend
5073+the resulting path to the link or image path.
5074+
5075+The use of this extension is best understood by example.
5076+Suppose you have a a subdirectory for each chapter of a book,
5077+`chap1`, `chap2`, `chap3`. Each contains a file `text.md` and a
5078+number of images used in the chapter. You would like to have
5079+`![image](spider.jpg)` in `chap1/text.md` refer to
5080+`chap1/spider.jpg` and `![image](spider.jpg)` in `chap2/text.md`
5081+refer to `chap2/spider.jpg`. To do this, use
5082+
5083+ pandoc chap*/*.md -f markdown+rebase_relative_paths
5084+
5085+Without this extension, you would have to use
5086+`![image](chap1/spider.jpg)` in `chap1/text.md` and
5087+`![image](chap2/spider.jpg)` in `chap2/text.md`. Links with
5088+relative paths will be rewritten in the same way as images.
5089+
5090+Absolute paths and URLs are not changed. Neither are empty
5091+paths or paths consisting entirely of a fragment, e.g., `#foo`.
5092+
5093+Note that relative paths in reference links and images will
5094+be rewritten relative to the file containing the link
5095+reference definition, not the file containing the reference link
5096+or image itself, if these differ.
5097+
48475098#### Extension: `attributes` ####
48485099
48495100Allows attributes to be attached to any inline or block-level
@@ -5030,6 +5281,13 @@ for regular emphasis, add extra blank space around headings.
50305281
50315282 [Project Gutenberg]: https://www.gutenberg.org
50325283
5284+#### Extension: `sourcepos` ####
5285+
5286+Include source position attributes when parsing `commonmark`.
5287+For elements that accept attributes, a `data-pos` attribute
5288+is added; other elements are placed in a surrounding
5289+Div or Span elemnet with a `data-pos` attribute.
5290+
50335291## Markdown variants
50345292
50355293In addition to pandoc's extended Markdown, the following Markdown
@@ -5144,17 +5402,21 @@ array of YAML-encoded references, for example:
51445402 language: en-GB
51455403 ...
51465404
5405+If both an external bibliography and inline (YAML metadata)
5406+references are provided, both will be used. In case of
5407+conflicting `id`s, the inline references will take precedence.
5408+
51475409Note that `pandoc` can be used to produce such a YAML metadata
51485410section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
51495411
5150− pandoc chem.bib -s -t markdown
5151− pandoc chem.json -s -t markdown
5412+ pandoc chem.bib -s -f biblatex -t markdown
5413+ pandoc chem.json -s -f csljson -t markdown
51525414
5153−`pandoc` can also be used to produce CSL JSON bibliography
5154−from BibTeX, BibLaTeX, or markdown YAML:
5415+Indeed, `pandoc` can convert between any of these
5416+citation formats:
51555417
5156− pandoc chem.bib -s -t csljson
5157− pandoc chem.yaml -s -t csljson
5418+ pandoc chem.bib -s -f biblatex -t csljson
5419+ pandoc chem.yaml -s -f markdown -t biblatex
51585420
51595421Running pandoc on a bibliography file with the `--citeproc`
51605422option will create a formatted bibliography in the format
@@ -5237,11 +5499,11 @@ The CSL project provides further information on [finding and
52375499editing styles].
52385500
52395501The `--citation-abbreviations` option (or the
5240−`citation-abbreviations` metadata field) may be used to
5241−specify a JSON file containing abbreviations of journals
5242−that should be used in formatted bibliographies when
5243−`form="short"` is specified. The format of the file
5244−can be illustrated with an example:
5502+`citation-abbreviations` metadata field) may be used to specify
5503+a JSON file containing abbreviations of journals that should be
5504+used in formatted bibliographies when `form="short"` is
5505+specified. The format of the file can be illustrated with an
5506+example:
52455507
52465508
52475509 { "default": {
@@ -5253,6 +5515,34 @@ can be illustrated with an example:
52535515 }
52545516 }
52555517
5518+
5519+## Citations in note styles
5520+
5521+Pandoc's citation processing is designed to allow you to
5522+move between author-date, numerical, and note styles without
5523+modifying the markdown source. When you're using a note
5524+style, avoid inserting footnotes manually. Instead, insert
5525+citations just as you would in an author-date style---for
5526+example,
5527+
5528+ Blah blah [@foo, p. 33].
5529+
5530+The footnote will be created automatically. Pandoc will take
5531+care of removing the space and moving the note before or
5532+after the period, depending on the setting of
5533+`notes-after-punctuation`, as described below in [Other relevant
5534+metadata fields].
5535+
5536+In some cases you may need to put a citation inside a regular
5537+footnote. Normal citations in footnotes (such as `[@foo, p.
5538+33]`) will be rendered in parentheses. In-text citations (such
5539+as `@foo [p. 33]`) will be rendered without parentheses. (A
5540+comma will be added if appropriate.) Thus:
5541+
5542+ [^1]: Some studies [@foo; @bar, p. 33] show that
5543+ frubulicious zoosnaps are quantical. For a survey
5544+ of the literature, see @baz [chap. 1].
5545+
52565546## Raw content in a style
52575547
52585548To include raw content in a prefix, suffix, delimiter, or term,
@@ -5265,7 +5555,7 @@ and escaped in the output, rather than being passed through raw.
52655555
52665556This feature allows stylesheets to be customized to give
52675557different output for different output formats. However,
5268−stylesheets customized in this way will not be useable
5558+stylesheets customized in this way will not be usable
52695559by other CSL implementations.
52705560
52715561
@@ -5331,17 +5621,30 @@ or BibLaTeX (for `--biblatex`) format.
53315621
53325622A few other metadata fields affect bibliography formatting:
53335623
5334−`link-citation`
5624+`link-citations`
53355625: If true, citations will be
53365626 hyperlinked to the corresponding bibliography entries
53375627 (for author-date and numerical styles only).
53385628
53395629`lang`
53405630: The `lang` field will affect how the style is localized,
5341− for example in the translation of labels and the use
5342− of quotation marks. (For backwards compatibility,
5343− `locale` may be used instead of `lang`, but this use
5344− is deprecated.)
5631+ for example in the translation of labels, the use
5632+ of quotation marks, and the way items are sorted.
5633+ (For backwards compatibility, `locale` may be used instead
5634+ of `lang`, but this use is deprecated.)
5635+
5636+ A BCP 47 language tag is expected: for example, `en`,
5637+ `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
5638+ syntax (after `-u-`) may be used to specify options for
5639+ collation (sorting) more precisely. Here are some examples:
5640+
5641+ - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
5642+ - `es-u-co-trad` -- Spanish with the traditional collation
5643+ (with `Ch` sorting after `C`).
5644+ - `fr-u-kb` -- French with "backwards" accent sorting
5645+ (with `coté` sorting after `côte`).
5646+ - `en-US-u-kf-upper` -- English with uppercase letters sorting
5647+ before lower (default is lower before upper).
53455648
53465649`notes-after-punctuation`
53475650: If true (the default), pandoc will put footnote citations
@@ -5353,12 +5656,6 @@ A few other metadata fields affect bibliography formatting:
53535656 punctuation.
53545657
53555658
5356−
5357−
5358−
5359−
5360−
5361−
53625659# Slide shows
53635660
53645661You can use pandoc to produce an HTML + JavaScript slide presentation
@@ -5407,18 +5704,21 @@ To produce an HTML/JavaScript slide show, simply type
54075704
54085705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
54095706
5410−For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the
5411−`-s/--standalone` option embeds a link to JavaScript and CSS files, which are
5412−assumed to be available at the relative path `s5/default` (for S5), `slideous`
5413−(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at
5414−`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,
5415−`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],
5416−above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5417−the file by default.
5418−
5419−With all HTML slide formats, the `--self-contained` option can be used to
5420−produce a single file that contains all of the data necessary to display the
5421−slide show, including linked scripts, stylesheets, images, and videos.
5707+For Slidy, Slideous, reveal.js, and S5, the file produced by
5708+pandoc with the `-s/--standalone` option embeds a link to
5709+JavaScript and CSS files, which are assumed to be available at
5710+the relative path `s5/default` (for S5), `slideous` (for
5711+Slideous), `reveal.js` (for reveal.js), or at the Slidy website
5712+at `w3.org` (for Slidy). (These paths can be changed by setting
5713+the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`
5714+variables; see [Variables for HTML slides], above.) For
5715+DZSlides, the (relatively short) JavaScript and CSS are included
5716+in the file by default.
5717+
5718+With all HTML slide formats, the `--self-contained` option can
5719+be used to produce a single file that contains all of the data
5720+necessary to display the slide show, including linked scripts,
5721+stylesheets, images, and videos.
54225722
54235723To produce a PDF slide show using beamer, type
54245724
@@ -5448,7 +5748,11 @@ rules:
54485748 * A heading at the slide level always starts a new slide.
54495749
54505750 * Headings *below* the slide level in the hierarchy create
5451− headings *within* a slide.
5751+ headings *within* a slide. (In beamer, a "block" will be
5752+ created. If the heading has the class `example`, an
5753+ `exampleblock` environment will be used; if it has the class
5754+ `alert`, an `alertblock` will be used; otherwise a regular
5755+ `block` will be used.)
54525756
54535757 * Headings *above* the slide level in the hierarchy create
54545758 "title slides," which just contain the section title
@@ -5781,6 +6085,15 @@ The following fields are recognized:
57816085
57826086`rights`
57836087 ~ A string value.
6088+
6089+`belongs-to-collection`
6090+ ~ A string value. identifies the name of a collection to which
6091+ the EPUB Publication belongs.
6092+
6093+`group-position`
6094+ ~ The `group-position` field indicates the numeric position in which
6095+ the EPUB Publication belongs relative to other works belonging to
6096+ the same `belongs-to-collection` field.
57846097
57856098`cover-image`
57866099 ~ A string value (path to cover image).
@@ -6017,7 +6330,7 @@ Then edit `my.theme` and use it like this:
60176330If you are not satisfied with the built-in highlighting, or you
60186331want highlight a language that isn't supported, you can use the
60196332`--syntax-definition` option to load a [KDE-style XML syntax definition
6020−file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).
6333+file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).
60216334Before writing your own, have a look at KDE's [repository of syntax
60226335definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).
60236336
@@ -6148,6 +6461,21 @@ subdirectory of your user data directory (see [Templates]).
61486461
61496462[Lua]: https://www.lua.org
61506463
6464+# Reproducible builds
6465+
6466+Some of the document formats pandoc targets (such as EPUB,
6467+docx, and ODT) include build timestamps in the generated document.
6468+That means that the files generated on successive builds will
6469+differ, even if the source does not. To avoid this, set the
6470+`SOURCE_DATE_EPOCH` environment variable, and the timestamp will
6471+be taken from it instead of the current time.
6472+`SOURCE_DATE_EPOCH` should contain an integer unix timestamp
6473+(specifying the number of second since midnight UTC January 1, 1970).
6474+
6475+Some document formats also include a unique identifier. For
6476+EPUB, this can be set explicitly by setting the `identifier`
6477+metadata field (see [EPUB Metadata], above).
6478+
61516479# A note on security
61526480
61536481If you use pandoc to convert user-contributed content in a web
@@ -6176,13 +6504,13 @@ application, here are some things to keep in mind:
617665044. The HTML generated by pandoc is not guaranteed to be safe.
61776505 If `raw_html` is enabled for the Markdown input, users can
61786506 inject arbitrary HTML. Even if `raw_html` is disabled,
6179− users can include dangerous content in attributes for
6180− headings, spans, and code blocks. To be safe, you should
6181− run all the generated HTML through an HTML sanitizer.
6507+ users can include dangerous content in URLs and attributes.
6508+ To be safe, you should run all the generated HTML through
6509+ an HTML sanitizer.
61826510
61836511# Authors
61846512
6185−Copyright 2006--2020 John MacFarlane (jgm@berkeley.edu). Released
6513+Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
61866514under the [GPL], version 2 or greater. This software carries no
61876515warranty of any kind. (See COPYRIGHT for full copyright and
61886516warranty notices.) For a full list of contributors, see the file
Makefile+47−19
@@ -2,17 +2,31 @@ version?=$(shell grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')
22pandoc=$(shell find dist -name pandoc -type f -exec ls -t {} \; | head -1)
33SOURCEFILES?=$(shell git ls-tree -r master --name-only | grep "\.hs$$")
44BRANCH?=master
5−RESOLVER?=lts-13
6−GHCOPTS=-fdiagnostics-color=always
5+ARCH=$(shell uname -m)
6+DOCKERIMAGE=registry.gitlab.b-data.ch/ghc/ghc4pandoc:8.10.4
7+COMMIT=$(shell git rev-parse --short HEAD)
8+TIMESTAMP=$(shell date "+%Y%m%d_%H%M")
9+LATESTBENCH=$(word 1,$(shell ls -t bench_*.csv 2>/dev/null))
10+BASELINE?=$(LATESTBENCH)
11+ifeq ($(BASELINE),)
12+BASELINECMD=
13+else
14+BASELINECMD=--baseline $(BASELINE)
15+endif
16+GHCOPTS=-fdiagnostics-color=always -j4 +RTS -A8m -RTS
717WEBSITE=../../web/pandoc.org
818REVISION?=1
19+# For gauge:
20+# BENCHARGS?=--small --ci=0.90 --match=pattern $(PATTERN)
21+# For tasty-bench:
22+BENCHARGS?=--csv bench_$(TIMESTAMP).csv $(BASELINECMD) --timeout=6 +RTS -T -RTS $(if $(PATTERN),--pattern "$(PATTERN)",)
923
1024quick:
11− stack install --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --ghc-options='-j +RTS -A64m -RTS' --test-arguments='-j4 --hide-successes $(TESTARGS)'
25+ stack install --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --ghc-options='$(GHCOPTS)' --test-arguments='-j4 --hide-successes $(TESTARGS)'
1226
1327quick-cabal:
1428 cabal new-configure . --ghc-options '$(GHCOPTS)' --disable-optimization --enable-tests
15− cabal new-build . --disable-optimization
29+ cabal new-build -j4 . --disable-optimization
1630 cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)
1731
1832full-cabal:
@@ -21,7 +35,7 @@ full-cabal:
2135 cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)
2236
2337full:
24− stack install --flag 'pandoc:embed_data_files' --flag 'pandoc:trypandoc' --bench --no-run-benchmarks --test --test-arguments='-j4 --hide-successes' --ghc-options '-Wall -Werror -fno-warn-unused-do-bind -O0 -j4 $(GHCOPTS)'
38+ stack install --flag 'pandoc:embed_data_files' --flag 'pandoc:trypandoc' --bench --no-run-benchmarks --test --test-arguments='-j4 --hide-successes' --ghc-options '-Wall -Werror -fno-warn-unused-do-bind -O0 $(GHCOPTS)'
2539
2640ghci:
2741 stack ghci --flag 'pandoc:embed_data_files'
@@ -37,11 +51,14 @@ test:
3751ghcid:
3852 ghcid -c "stack repl --flag 'pandoc:embed_data_files'"
3953
40−bench:
41− stack bench --benchmark-arguments='$(BENCHARGS)' --ghc-options '$(GHCOPTS)'
54+ghcid-test:
55+ ghcid -c "stack repl --ghc-options=-XNoImplicitPrelude --flag 'pandoc:embed_data_files' --ghci-options=-fobject-code pandoc:lib pandoc:test-pandoc"
4256
43−weigh:
44− stack build --ghc-options '$(GHCOPTS)' pandoc:weigh-pandoc && stack exec weigh-pandoc
57+bench:
58+ stack bench \
59+ --ghc-options '$(GHCOPTS)' \
60+ --benchmark-arguments='$(BENCHARGS)' 2>&1 | \
61+ tee "bench_latest.txt"
4562
4663reformat:
4764 for f in $(SOURCEFILES); do echo $$f; stylish-haskell -i $$f ; done
@@ -65,21 +82,22 @@ dist: man/pandoc.1
6582 cd pandoc-${version}
6683 stack setup && stack test && cd .. && rm -rf "pandoc-${version}"
6784
68−checkdocs: README.md
69− ! grep -n -e "\t" MANUAL.txt changelog
85+check: checkdocs check-cabal
86+
87+checkdocs:
88+ ! grep -q -n -e "\t" MANUAL.txt changelog.md
7089
7190debpkg: man/pandoc.1
7291 docker run -v `pwd`:/mnt \
7392 -v `pwd`/linux/artifacts:/artifacts \
93+ --user $(id -u):$(id -g) \
7494 -e REVISION=$(REVISION) \
7595 -w /mnt \
76− utdemir/ghc-musl:v12-libgmp-ghc8101 bash \
77− /mnt/linux/make_artifacts.sh
78−
79−macospkg:
80− rm -rf macos-release-candidate
81− aws s3 sync s3://travis-jgm-pandoc macos-release-candidate
82− make -C macos-release-candidate
96+ --memory=0 \
97+ --rm \
98+ $(DOCKERIMAGE) \
99+ bash \
100+ /mnt/linux/make_artifacts.sh 2>&1 > docker.log
83101
84102man/pandoc.1: MANUAL.txt man/pandoc.1.before man/pandoc.1.after
85103 pandoc $< -f markdown -t man -s \
@@ -117,4 +135,14 @@ update-website:
117135clean:
118136 stack clean
119137
120−.PHONY: deps quick full haddock install clean test bench changes_github macospkg dist prof download_stats reformat lint weigh doc/lua-filters.md pandoc-templates trypandoc update-website debpkg macospkg checkdocs ghcid ghci fix_spacing hlint
138+check-cabal: git-files.txt sdist-files.txt
139+ echo "Checking to see if all committed test/data files are in sdist."
140+ diff -u $^
141+
142+sdist-files.txt: .FORCE
143+ cabal sdist --list-only | sed 's/\.\///' | grep '^\(test\|data\)\/' | sort > $@
144+
145+git-files.txt: .FORCE
146+ git ls-tree -r --name-only HEAD | grep '^\(test\|data\)\/' | sort > $@
147+
148+.PHONY: .FORCE deps quick full haddock install clean test bench changes_github dist prof download_stats reformat lint weigh doc/lua-filters.md pandoc-templates trypandoc update-website debpkg checkdocs ghcid ghci fix_spacing hlint check check-cabal
README.md+15−19
@@ -3,26 +3,24 @@ README.template and MANUAL.txt via the command:
33pandoc --lua-filter tools/update-readme.lua README.template -o README.md
44-->
55
6−Pandoc
7−======
6+# Pandoc
87
98[![github
109release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
1110[![hackage
12−release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)
13−[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc)
11+release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)
12+[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](https://formulae.brew.sh/formula/pandoc)
1413[![stackage LTS
15−package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
14+package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)
1615[![CI
1716tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)
1817[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
1918[![pandoc-discuss on google
2019groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
2120
22−The universal markup converter
23−------------------------------
21+## The universal markup converter
2422
25−Pandoc is a [Haskell](http://haskell.org) library for converting from
23+Pandoc is a [Haskell](https://haskell.org) library for converting from
2624one markup format to another, and a command-line tool that uses this
2725library. It can convert *from*
2826
@@ -97,6 +95,8 @@ It can convert *to*
9795- `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or
9896 `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))
9997- `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)
98+- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)
99+- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)
100100- `commonmark` ([CommonMark](https://commonmark.org) Markdown)
101101- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with
102102 extensions)
@@ -175,7 +175,7 @@ It can convert *to*
175175 and JavaScript slide show)
176176- `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and
177177 JavaScript slide show)
178−- `dzslides` ([DZSlides](http://paulrouget.com/dzslides/) HTML5 +
178+- `dzslides` ([DZSlides](https://paulrouget.com/dzslides/) HTML5 +
179179 JavaScript slide show),
180180- `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript
181181 slide show)
@@ -217,13 +217,11 @@ While conversions from pandoc’s Markdown to all formats aspire to be
217217perfect, conversions from formats more expressive than pandoc’s Markdown
218218can be expected to be lossy.
219219
220−Installing
221−----------
220+## Installing
222221
223222Here’s [how to install pandoc](INSTALL.md).
224223
225−Documentation
226−-------------
224+## Documentation
227225
228226Pandoc’s website contains a full [User’s
229227Guide](https://pandoc.org/MANUAL.html). It is also available
@@ -232,17 +230,15 @@ contains some [examples of the use of
232230pandoc](https://pandoc.org/demos.html) and a limited [online
233231demo](https://pandoc.org/try).
234232
235−Contributing
236−------------
233+## Contributing
237234
238235Pull requests, bug reports, and feature requests are welcome. Please
239236make sure to read [the contributor guidelines](CONTRIBUTING.md) before
240237opening a new issue.
241238
242−License
243−-------
239+## License
244240
245−© 2006-2020 John MacFarlane (jgm@berkeley.edu). Released under the
246−[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),
241+© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the
242+[GPL](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"),
247243version 2 or greater. This software carries no warranty of any kind.
248244(See COPYRIGHT for full copyright and warranty notices.)
README.template+6−6
@@ -7,9 +7,9 @@ Pandoc
77======
88
99[![github release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
10−[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)
11−[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc)
12−[![stackage LTS package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
10+[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)
11+[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](https://formulae.brew.sh/formula/pandoc)
12+[![stackage LTS package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)
1313[![CI tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)
1414[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
1515[![pandoc-discuss on google groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
@@ -81,9 +81,9 @@ new issue.
8181License
8282-------
8383
84−© 2006-2020 John MacFarlane (jgm@berkeley.edu). Released under the
84+© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the
8585[GPL], version 2 or greater. This software carries no warranty of
8686any kind. (See COPYRIGHT for full copyright and warranty notices.)
8787
88−[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
89−[Haskell]: http://haskell.org
88+[GPL]: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"
89+[Haskell]: https://haskell.org
RELEASE-CHECKLIST+3−1
@@ -1,9 +1,11 @@
1+[ ] use 'policeman' to check API changes and version update
12[ ] make README.md and commit if needed
23[ ] make man/pandoc.1 and commit if needed
34[ ] Finalize changelog
4− tools/changelog-helper.sh
55[ ] push release candidate branch rc/VERSION and (if it builds
66 successfully) download artifacts
7+[ ] run tools/build-arm.sh to create and download arm64 linux package
8+[ ] download macos artifacts from CircleCI
79[ ] Use 'make' in macos and windows artifacts to sign code
810[ ] make update-website
911[ ] make trypandoc
SECURITY.mdnew file+12
@@ -0,0 +1,12 @@
1+# Security Policy
2+
3+## Supported Versions
4+
5+Only the most recent version of pandoc is supported with security updates.
6+
7+## Reporting a Vulnerability
8+
9+To report a vulnerability, email the maintainer, jgm@berkeley.edu.
10+But first please read the section of the manual entitled
11+[A note on security](https://pandoc.org/MANUAL.html#a-note-on-security),
12+which describes some security guarantees pandoc does NOT make.
pandoc.hs → app/pandoc.hsrenamed+1−3
@@ -1,7 +1,6 @@
1−{-# LANGUAGE NoImplicitPrelude #-}
21{- |
32 Module : Main
4− Copyright : Copyright (C) 2006-2020 John MacFarlane
3+ Copyright : Copyright (C) 2006-2021 John MacFarlane
54 License : GNU GPL, version 2 or above
65
76 Maintainer : John MacFarlane <jgm@berkeley@edu>
@@ -12,7 +11,6 @@ Parses command-line options and calls the appropriate readers and
1211writers.
1312-}
1413module Main where
15−import Prelude
1614import qualified Control.Exception as E
1715import Text.Pandoc.App (convertWithOpts, defaultOpts, options, parseOptions)
1816import Text.Pandoc.Error (handleError)
benchmark/benchmark-pandoc.hs+65−84
@@ -1,7 +1,6 @@
1−{-# LANGUAGE NoImplicitPrelude #-}
21{-# LANGUAGE OverloadedStrings #-}
32{-
4−Copyright (C) 2012-2019 John MacFarlane <jgm@berkeley.edu>
3+Copyright (C) 2012-2021 John MacFarlane <jgm@berkeley.edu>
54
65This program is free software; you can redistribute it and/or modify
76it under the terms of the GNU General Public License as published by
@@ -17,106 +16,88 @@ You should have received a copy of the GNU General Public License
1716along with this program; if not, write to the Free Software
1817Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1918-}
20−import Prelude
2119import Text.Pandoc
2220import Text.Pandoc.MIME
23−import Control.Monad.Except (throwError, liftIO)
21+import Control.DeepSeq (force)
22+import Control.Monad.Except (throwError)
2423import qualified Text.Pandoc.UTF8 as UTF8
2524import qualified Data.ByteString as B
2625import qualified Data.Text as T
27−import Criterion.Main
28−import Criterion.Types (Config(..))
29−import Data.List (intersect)
30−import Data.Maybe (mapMaybe, catMaybes)
31−import System.Environment (getArgs)
26+import Test.Tasty.Bench
27+-- import Gauge
3228import qualified Data.ByteString.Lazy as BL
33−
34−data Input = InputText {unInputText :: T.Text}
35− | InputBS {unInputBS :: BL.ByteString}
29+import Data.Maybe (mapMaybe)
30+import Data.List (sortOn)
3631
3732readerBench :: Pandoc
3833 -> T.Text
39− -> IO (Maybe Benchmark)
40−readerBench doc name = do
41− let (rdr, rexts) = either (error . show) id . runPure $ getReader name
42− res <- runIO $ do
43− (wtr, wexts) <- getWriter name
44− case (rdr, wtr) of
45− (TextReader r, TextWriter w) -> do
46− setResourcePath ["./test"]
47− inp <- w def{ writerWrapText = WrapAuto
48− , writerExtensions = wexts } doc
49− return (r def{ readerExtensions = rexts } . unInputText, InputText inp)
50− (ByteStringReader r, ByteStringWriter w) -> do
51− setResourcePath ["./test"]
52− tmpl <- Just <$> compileDefaultTemplate name
53− inp <- w def{ writerWrapText = WrapAuto
54− , writerExtensions = wexts
55− , writerTemplate = tmpl } doc
56− liftIO $ BL.writeFile "/tmp/test.odt" inp
57− return (r def{ readerExtensions = rexts } . unInputBS, InputBS inp)
58− _ -> throwError $ PandocSomeError $ "text/bytestring format mismatch: "
59− <> name
60− return $ case res of
61− Right (readerFun, inp) ->
62− Just $ bench (T.unpack $ name <> " reader")
63− $ nf (\i -> either (error . show) id $ runPure (readerFun i))
64− inp
65− Left _ -> Nothing
34+ -> Maybe Benchmark
35+readerBench _ name
36+ | name `elem` ["bibtex", "biblatex", "csljson"] = Nothing
37+readerBench doc name = either (const Nothing) Just $
38+ runPure $ do
39+ (rdr, rexts) <- getReader name
40+ (wtr, wexts) <- getWriter name
41+ case (rdr, wtr) of
42+ (TextReader r, TextWriter w) -> do
43+ inp <- w def{ writerWrapText = WrapAuto
44+ , writerExtensions = wexts } doc
45+ return $ bench (T.unpack name) $
46+ nf (either (error . show) id . runPure . r def) inp
47+ (ByteStringReader r, ByteStringWriter w) -> do
48+ tmpl <- Just <$> compileDefaultTemplate name
49+ inp <- w def{ writerWrapText = WrapAuto
50+ , writerExtensions = wexts
51+ , writerTemplate = tmpl } doc
52+ return $ bench (T.unpack name) $
53+ nf (either (error . show) id .
54+ runPure . r def{readerExtensions = rexts}) inp
55+ _ -> throwError $ PandocSomeError $ "text/bytestring format mismatch: "
56+ <> name
6657
6758getImages :: IO [(FilePath, MimeType, BL.ByteString)]
6859getImages = do
69− ll <- BL.readFile "test/lalune.jpg"
70− mv <- BL.readFile "test/movie.jpg"
71− return [("lalune.jpg", "image/jpg", ll)
72− ,("movie.jpg", "image/jpg", mv)]
60+ ll <- B.readFile "test/lalune.jpg"
61+ mv <- B.readFile "test/movie.jpg"
62+ return [("lalune.jpg", "image/jpg", BL.fromStrict ll)
63+ ,("movie.jpg", "image/jpg", BL.fromStrict mv)]
7364
74−writerBench :: Pandoc
65+writerBench :: [(FilePath, MimeType, BL.ByteString)]
66+ -> Pandoc
7567 -> T.Text
7668 -> Maybe Benchmark
77−writerBench doc name =
78− case res of
79− Right writerFun ->
80− Just $ env getImages $ \imgs ->
81− bench (T.unpack $ name <> " writer")
69+writerBench _ _ name
70+ | name `elem` ["bibtex", "biblatex", "csljson"] = Nothing
71+writerBench imgs doc name = either (const Nothing) Just $
72+ runPure $ do
73+ (wtr, wexts) <- getWriter name
74+ case wtr of
75+ TextWriter writerFun ->
76+ return $ bench (T.unpack name)
77+ $ nf (\d -> either (error . show) id $
78+ runPure $ do
79+ mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs
80+ writerFun def{ writerExtensions = wexts} d)
81+ doc
82+ ByteStringWriter writerFun ->
83+ return $ bench (T.unpack name)
8284 $ nf (\d -> either (error . show) id $
83− runPure (do mapM_
84− (\(fp, mt, bs) ->
85− insertMedia fp (Just mt) bs)
86− imgs
87− writerFun d)) doc
88− Left _ -> Nothing
89− where res = runPure $ do
90− (wtr, wexts) <- getWriter name
91− case wtr of
92− TextWriter w ->
93− return $ w def{ writerExtensions = wexts }
94− _ -> throwError $ PandocSomeError
95− $ "could not get text writer for " <> name
85+ runPure $ do
86+ mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs
87+ writerFun def{ writerExtensions = wexts} d)
88+ doc
9689
9790main :: IO ()
9891main = do
99− args <- filter (\x -> T.take 1 x /= "-") . fmap T.pack <$> getArgs
100− print args
101− let matchReader (n, _) =
102− null args || ("reader" `elem` args && n `elem` args)
103− matchWriter (n, TextWriter _) =
104− null args || ("writer" `elem` args && n `elem` args)
105− matchWriter _ = False
106− allWriters = map fst (writers :: [(T.Text, Writer PandocPure)])
107− matchedReaders = map fst (filter matchReader readers
108− :: [(T.Text, Reader PandocPure)])
109− matchedWriters = map fst (filter matchWriter writers
110− :: [(T.Text, Writer PandocPure)])
11192 inp <- UTF8.toText <$> B.readFile "test/testsuite.txt"
11293 let opts = def
113− let doc = either (error . show) id $ runPure $ readMarkdown opts inp
114− readerBs <- fmap catMaybes
115− $ mapM (readerBench doc)
116− $ filter (/="haddock")
117− (matchedReaders `intersect` allWriters)
118− -- we need the corresponding writer to generate
119− -- input for the reader
120− let writerBs = mapMaybe (writerBench doc) matchedWriters
121− defaultMainWith defaultConfig{ timeLimit = 6.0 }
122− (writerBs ++ readerBs)
94+ let doc = either (error . show) force $ runPure $ readMarkdown opts inp
95+ defaultMain
96+ [ env getImages $ \imgs ->
97+ bgroup "writers" $ mapMaybe (writerBench imgs doc . fst)
98+ (sortOn fst
99+ writers :: [(T.Text, Writer PandocPure)])
100+ , bgroup "readers" $ mapMaybe (readerBench doc . fst)
101+ (sortOn fst
102+ readers :: [(T.Text, Reader PandocPure)])
103+ ]
benchmark/weigh-pandoc.hsdeleted−50
@@ -1,50 +0,0 @@
1−{-# LANGUAGE NoImplicitPrelude #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{- |
4− Module : Main
5− Copyright : © 2016-2019 John MacFarlane <jgm@berkeley.edu>
6− License : GNU GPL, version 2 or above
7−
8− Maintainer : John MacFarlane <jgm@berkeley.edu>
9− Stability : alpha
10− Portability : portable
11−
12−Benchmarks to determine resource use of readers and writers.
13−-}
14−import Prelude
15−import Weigh
16−import Text.Pandoc
17−import Data.Text (Text, unpack)
18−
19−main :: IO ()
20−main = do
21− doc <- read <$> readFile "test/testsuite.native"
22− mainWith $ do
23− func "Pandoc document" id doc
24− mapM_
25− (\(n,r) -> weighReader doc n (either (error . show) id . runPure . r def{readerExtensions = pandocExtensions}))
26− [("markdown", readMarkdown)
27− ,("html", readHtml)
28− ,("docbook", readDocBook)
29− ,("latex", readLaTeX)
30− ,("commonmark", readCommonMark)
31− ]
32− mapM_
33− (\(n,w) -> weighWriter doc n (either (error . show) id . runPure . w def))
34− [("markdown", writeMarkdown)
35− ,("html", writeHtml5String)
36− ,("docbook", writeDocbook5)
37− ,("latex", writeLaTeX)
38− ,("commonmark", writeCommonMark)
39− ]
40−
41−weighWriter :: Pandoc -> String -> (Pandoc -> Text) -> Weigh ()
42−weighWriter doc name writer = func (name ++ " writer") writer doc
43−
44−weighReader :: Pandoc -> Text -> (Text -> Pandoc) -> Weigh ()
45−weighReader doc name reader =
46− case lookup name writers of
47− Just (TextWriter writer) ->
48− let inp = either (error . show) id $ runPure $ writer def{ writerWrapText = WrapAuto} doc
49− in func (unpack $ name <> " reader") reader inp
50− _ -> return () -- no writer for reader
cabal.project+11−3
@@ -1,5 +1,13 @@
11packages: pandoc.cabal
2+tests: True
3+flags: +embed_data_files
24
3−package pandoc
4− flags: +embed_data_files -trypandoc
5− ghc-options: -j +RTS -A64m -RTS
5+source-repository-package
6+ type: git
7+ location: https://github.com/jgm/doctemplates
8+ tag: 428c26d5303cf7a2b1051fe1ffd9aafe9ba71c81
9+
10+source-repository-package
11+ type: git
12+ location: https://github.com/jgm/citeproc
13+ tag: 4ce0501cd6f9c86eee087afcf878c256e49b9615
changelog.md+2126−26
@@ -1,5 +1,2105 @@
11# Revision history for pandoc
22
3+## pandoc 2.14.0.3 (2021-06-22)
4+
5+ * Text.Pandoc.MediaBag `insertMediaBag`: ensure we get a sane mediaPath
6+ for URLs (#7391). In earlier 2.14.x versions, we'd get
7+ incorrect paths for resources downloaded from URLs when the
8+ media are extracted (including in PDF production).
9+ * Text.Pandoc.Parsing: improve `emailAddress` (#7398).
10+ Previously the parser would accept characters in domains
11+ that are illegal in domains, and this sometimes caused it
12+ to gobble bits of the following text.
13+ * txt2tags reader: modify the email address parser so
14+ it still includes form parameters, even after the change to
15+ `emailAddress` in Text.Pandoc.Parsing.
16+ * Text.Pandoc.Readers.Metadata: Fix regression with comment-only YAML
17+ metadata blocks (#7400).
18+ * reveal.js writer and template: better handling of options. Previously
19+ it was impossible to specify false values for options that default to
20+ true (e.g. `center`); setting the option to false just caused the portion
21+ of the template setting the option to be omitted. Now we prepopulate
22+ all the variables with their default values, including them all
23+ unconditionally and allowing them to be overridden.
24+ * Markdown writer: Fix regression in code blocks with attributes (#7397).
25+ Code blocks with a single class but nonempty attributes
26+ were having attributes drop as a result of #7242.
27+ * LaTeX writer:
28+ + Add strut at end of minipage if it contains line breaks.
29+ Without them, the last line is not as tall as it should be in
30+ some cases.
31+ + Always use a minipage for cells with line breaks, when
32+ width information is available (#7393). Otherwise the way we treat them
33+ can lead to content that overflows a cell.
34+ + Use `\strut` instead of `~` before `\\` in empty line.
35+ * Use lts-18.0 stack resolver.
36+ * Require skylighting 0.10.5.2 (adding support for Swift).
37+ * Require commonmark 0.2.1.
38+ * Rephrase section on unsafe HTML in manual.
39+ * Create SECURITY.md
40+
41+## pandoc 2.14.0.2 (2021-06-13)
42+
43+ * Fix MediaBag regressions (#7345). iIn the 2.14 release `--extract-media`
44+ stopped working as before; there could be mismatches between the
45+ paths in the rendered document and the extracted media.
46+ This patch makes several changes that restore the earlier behavior
47+ (while keeping the same API). The `mediaPath` in 2.14 was always
48+ constructed from the SHA1 hash of the media contents. Now, we
49+ preserve the original path unless it's an absolute path or contains
50+ `..` segments (in that case we use a path based on the SHA1 hash of
51+ the contents).
52+
53+ In Text.Pandoc.MediaBag, `mediaDirectory` and `mediaItems` now use the
54+ `mediaPath`, rather than the mediabag key, for the first component of the
55+ tuple. This makes more sense, I think, and fits with the documentation of
56+ these functions; eventually, though, we should rework the API so that
57+ `mediaItems` returns both the keys and the MediaItems.
58+
59+ In Text.Pandoc.Class.IO, rewriting of source paths in `extractMedia` has
60+ been fixed.
61+
62+ In Text.Pandoc.Class.PandocMonad, `fillMediaBag` has been modified so that
63+ it doesn't modify image paths (that was part of the problem in #7345).
64+
65+ We now do path normalization (e.g. `\` separators on Windows) in
66+ writing the media.
67+
68+ * Text.Pandoc.PDF:
69+
70+ + Text.Pandoc.PDF: Fix regression in 2.14 for generation of PDFs with
71+ SVGs (#7344).
72+ + Only print relevant part of environment on `--verbose`. Since
73+ `--verbose` output might be put in an issue, we want to avoid
74+ spilling out secrets in environment variables.
75+
76+ * Markdown reader: fix pipe table regression in 2.11.4 (#7343).
77+ Previously pipe tables with empty headers (that is, a header
78+ line with all empty cells) would be rendered as headerless
79+ tables. This broke in 2.11.4. The fix here is to produce an
80+ AST with an empty table head when a pipe table has all empty
81+ header cells.
82+
83+ * LaTeX reader: don't allow optional `*` on symbol control sequences
84+ (#7340). Generally we allow optional starred variants of LaTeX commands
85+ (since many allow them, and if we don't accept these explicitly,
86+ ignoring the star usually gives acceptable results). But we
87+ don't want to do this for `\(*\)` and similar cases.
88+
89+ * Docx reader: handle absolute URIs in Relationship Target (#7374).
90+
91+ * Docx writer: fix handling of empty table headers (Albert Krewinkel,
92+ #7369). A table header which does not contain any cells is now treated as
93+ an empty header.
94+
95+ * LaTeX writer: Fix regression in table header position (#7347).
96+ In recent versions the table headers were no longer bottom-aligned
97+ (if more than one line). This patch fixes that by using minipages
98+ for table headers in non-simple tables.
99+
100+ * CommonMark writer:
101+
102+ + Do not use simple class for fenced-divs (Jan Tojnar, amends #7242.)
103+ + Do not throw away attributes when `Ext_attributes` is enabled.
104+ `Ext_attributes` covers at least the following:
105+ `Ext_fenced_code_attributes`, `Ext_header_attributes`,
106+ `Ext_inline_code_attributes`, `Ext_link_attributes`.
107+
108+ * Markdown writer:
109+
110+ + Allow `pipe_tables` to be disabled for commonmark formats
111+ (`commonmark_x`, `gfm`) (#7375).
112+ + Re-use functions from Text.Pandoc.Markdown.Inline (Jan Tojnar).
113+
114+ * DocBook writer: Remove non-existent admonitions (Jan Tojnar).
115+ `attention`, `error` and `hint` are reStructuredText specific.
116+
117+ * HTML writer: Don't omit width attribute on div (#7342).
118+
119+ * Text.Pandoc.MIME, `extensionFromMimeType`: add a few special cases.
120+ When we do a reverse lookup in the MIME table, we just get the
121+ last match, so when the same mime type is associated with several
122+ different extensions, we sometimes got weird results, e.g. `.vs`
123+ for `text/plain`. These special cases help us get the most standard
124+ extensions for mime types like `text/plain`.
125+
126+ * Lua utils: fix handling of table headers in `from_simple_table` (Albert
127+ Krewinkel, #7369). Passing an empty list of header cells now results
128+ in an empty table header.
129+
130+ * Text.Pandoc.Citeproc:
131+
132+ + Avoid duplicate classes and attributes on references div.
133+ + Fix regression in citeproc processing (#7376). If inline
134+ references are used (in the metadata `references` field), we
135+ should still only include in the bibliography items that are
136+ actually cited (unless `nocite` is used).
137+
138+ * Require citeproc 0.4.0.1. This fixes a bug which led to doubled
139+ "et al." in some (rare) circumstances.
140+
141+ * MANUAL.txt:
142+
143+ + Mention GladTeX for EPUB export (Sebastian Humenda).
144+ This updates the manual and the web site about the GladTeX usage.
145+ + More details and a useful link for YAML syntax.
146+
147+ * CONTRIBUTING.md: update modules overview (Albert Krewinkel).
148+
149+ * using-the-pandoc-api.md: switch from String to Text (Albert Krewinkel).
150+
151+
152+## pandoc 2.14.0.1 (2021-06-01)
153+
154+ * Commonmark reader: Fix regression in 2.14 with YAML metdata block parsing,
155+ which could cause the document body to be omitted after metadata (#7339).
156+
157+ * HTML reader: fix column width regression in 2.14 (#7334).
158+ Column widths specified with a style attribute were off by a factor of 100.
159+
160+ * Markdown reader: in `rebasePaths`, check for both Windows and Posix
161+ absolute paths. Previously Windows pandoc was treating
162+ `/foo/bar.jpg` as non-absolute.
163+
164+ * Text.Pandoc.Logging: In rendering `LoadedResource`, use relative paths.
165+
166+ * Docx writer: fix regression on captions (#7328). The "Table Caption"
167+ style was no longer getting applied. (It was overwritten by "Compact.")
168+
169+ * Use commonmark-extensions 0.2.1.2
170+
171+## pandoc 2.14 (2021-05-28)
172+
173+ * Change reader types, allowing better tracking of source positions
174+ [API change]. Previously, when multiple file arguments were provided,
175+ pandoc simply concatenated them and passed the contents to the readers,
176+ which took a Text argument. As a result, the readers had no way of knowing
177+ which file was the source of any particular bit of text. This meant that
178+ we couldn't report accurate source positions on errors or include accurate
179+ source positions as attributes in the AST. More seriously, it meant that
180+ we couldn't resolve resource paths relative to the files containing them
181+ (see e.g. #5501, #6632, #6384, #3752).
182+
183+ * Add `rebase_relative_paths` extension (#3752). When enabled, this
184+ extension rewrites relative image and link paths by prepending
185+ the (relative) directory of the containing file. This
186+ behavior is useful when your input sources are split
187+ into multiple files, across several directories, with files
188+ referring to images stored in the same directory. The
189+ extension can be enabled for all markdown and commonmark-based formats.
190+
191+ * Add Text.Pandoc.Sources (exported module), with a `Sources` type and a
192+ `ToSources` class. A `Sources` wraps a list of `(SourcePos, Text)` pairs
193+ [API change]. A parsec `Stream` instance is provided for `Sources`. The
194+ module also exports versions of parsec's `satisfy` and other Char parsers
195+ that track source positions accurately from a `Sources` stream (or any
196+ instance of the new `UpdateSourcePos` class).
197+
198+ * Text.Pandoc.Parsing
199+
200+ + Export the modified Char parsers defined in Text.Pandoc.Sources
201+ instead of the ones parsec provides. Modified parsers to use a
202+ `Sources` as stream [API change].
203+ + Improve include file functions [API change]. Remove old
204+ `insertIncludedFileF`. Give `insertIncludedFile` a more general type,
205+ allowing it to be used where `insertIncludedFileF` was.
206+ + Add parameter to the `citeKey` parser from
207+ Text.Pandoc.Parsing, which controls whether the `@{..}`
208+ syntax is allowed [API change].
209+
210+ * Text.Pandoc.Error: Modified the constructor `PandocParsecError` to take a
211+ `Sources` rather than a `Text` as first argument, so parse error locations
212+ can be accurately reported.
213+
214+ * Fix source position reporting for YAML bibliographies (#7273).
215+
216+ * Issue error message when reader or writer format is malformed
217+ (#7231). Previously we exited with an error status but (due to a bug)
218+ no message.
219+
220+ * Smarter smart quotes (#7216, #2103). Treat a leading `"` with no
221+ closing `"` as a left curly quote. This supports the practice, in
222+ fiction, of continuing paragraphs quoting the same speaker without an
223+ end quote. It also helps with quotes that break over lines in line blocks.
224+
225+ * Markdown reader:
226+
227+ + Use MetaInlines not MetaBlocks for multimarkdown metadata fields.
228+ This gives better results in converting to e.g. pandoc markdown.
229+ + Implement curly-brace syntax for Markdown citation keys (#6026).
230+ The change provides a way to use citation keys that contain
231+ special characters not usable with the standard citation key syntax.
232+ Example: `@{foo_bar{x}'}` for the key `foo_bar{x}`. It also allows
233+ separating citation keys from immediately following text, e.g. `@{foo}A`.
234+
235+ * RST reader:
236+
237+ + Seek include files in the directory of the file
238+ containing the include directive, as RST requires (#6632).
239+ + Use `insertIncludedFile` from Text.Pandoc.Parsing
240+ instead of reproducing much of its code.
241+
242+ * Org reader: Resolve org includes relative to the directory containing the
243+ file containing the INCLUDE directive (#5501).
244+
245+ * ODT reader: Treat tabs as spaces (#7185, niszet).
246+
247+ * Docx reader:
248+
249+ + Add handling of vml image objects (#7257, mbrackeantidot).
250+ + Support new table features (Emily Bourke, #6316): column
251+ spans, row spans, multiple header rows, table description
252+ (parsed as a simple caption), captions, column widths.
253+
254+ * LaTeX reader:
255+
256+ + Improved siunitx support (#6658, #6620).
257+ + Better support for `\xspace` (#7299).
258+ + Improve parsing of `\def` macros. We previously set "verbatim mode"
259+ even for parsing the initial `\def`; this caused problems
260+ for `\def` nested inside another `\def`.
261+ + Implement `\newif`.
262+
263+ * ConTeXt writer: improve ordered lists (#5016, Denis Maier).
264+ Change ordered list from itemize to enumerate. Add new
265+ itemgroup for ordered lists. Remove manual insertion of
266+ width attributes. Use tabular figures in ordered list
267+ enumerators.
268+
269+ * HTML reader:
270+
271+ + Don't fail on unmatched closing "script" tag (Albert Krenkel, #7282).
272+ + Keep h1 tags as normal headers (#2293, Albert Krewinkel).
273+ The tags `<title>` and `<h1 class="title">` often contain the same
274+ information, so the latter was dropped from the document. However, as
275+ this can lead to loss of information, the heading is now always
276+ retained. Use `--shift-heading-level-by=-1` to turn the `<h1>`
277+ into the document title, or a filter to restore the previous behavior.
278+ + Handle relative lengths (e.g. `2*`) in HTML column widths (#4063).
279+ See <https://www.w3.org/TR/html4/types.html#h-6.6>.
280+
281+ * DocBook/JATS readers:
282+
283+ + Fix mathml regression caused by the switch in XML libraries (#7173).
284+ + Fix "phrase" in DocBook: take classes from "role" not "class" (#7195).
285+
286+ * DocBook reader: ensure that first and last names are separated (#6541).
287+
288+ * Jira reader (Albert Krewinkel, #7218):
289+
290+ + Support "smart" links: `[alias|https://example.com|smart-card]` syntax.
291+ + Allow spaces and most unicode characters in attachment links.
292+ + No longer require a newline character after `{noformat}`.
293+ + Only allow URI path segment characters in bare links.
294+ + The `file:` schema is no longer allowed in bare links; these
295+ rarely make sense.
296+
297+ * Plain writer: handle superscript unicode minus (#7276).
298+
299+ * LaTeX writer:
300+
301+ + Better handling of line breaks in simple tables (#7272).
302+ Now we also handle the case where they're embedded in other elements,
303+ e.g. spans.
304+ + For beamer output, support `exampleblock` and `alertblock` (#7278).
305+ A block will be rendered as an `exampleblock` if the heading
306+ has class `example` and an `alertblock` if it has class `alert`.
307+ + Separate successive quote chars with thin space (#6958,
308+ Albert Krewinkel). Successive quote characters are separated with
309+ a thin space to improve readability and to prevent unwanted ligatures.
310+ Detection of these quotes sometimes had failed if the second quote
311+ was nested in a span element.
312+ + Separate successive quote chars with thin space (#6958, Albert
313+ Krewinkel).
314+
315+ * EPUB Writer: Fix belongs-to-collection XML id choice (#7267, nuew).
316+ The epub writer previously used the same XML id for both the book
317+ identifier and the epub collection. This causes an error on epubcheck.
318+
319+ * BibTeX/BibLaTeX writer: Handle `annote` field (#7266).
320+
321+ * ZimWiki writer: allow links and emphasis in headers (#6605,
322+ Albert Krewinkel).
323+
324+ * ConTeXt writer:
325+
326+ + Support blank lines in line blocks (#6564, Albert Krewinkel,
327+ thanks to @denismaier).
328+ + Use span identifiers as reference anchors (#7246, Albert Krewinkel).
329+
330+ * HTML writer:
331+
332+ + Keep attributes from code nested below `pre` tag (#7221,
333+ Albert Krewinkel). If a code block is defined with `<pre><code
334+ class="language-x">…</code></pre>`, where the `<pre>` element has no
335+ attributes, then the attributes from the `<code>` element are used
336+ instead. Any leading `language-` prefix is dropped in the code's
337+ `class` attribute are dropped to improve syntax highlighting.
338+ + Ensure headings only have valid attribs in HTML4 (#5944, Albert
339+ Krewinkel).
340+ + Parse `<header>` as a Div (Albert Krewinkel).
341+
342+ * Org writer:
343+
344+ + Inline latex envs need newlines (#7252, tecosaur).
345+ As specified in https://orgmode.org/manual/LaTeX-fragments.html, an
346+ inline \begin{}...\end{} LaTeX block must start on a new line.
347+ + Use LaTeX style maths deliminators (#7196, tecosaur).
348+
349+ * JATS writer (Albert Krewinkel):
350+
351+ + Use either styled-content or named-content for spans (#7211).
352+ If the element has a content-type attribute, or at least one class,
353+ then that value is used as `content-type` and the span is put inside
354+ a `<named-content>` element. Otherwise a `<styled-content>` element
355+ is used instead.
356+ + Reduce unnecessary use of `<p>` elements for wrapping (#7227).
357+ The `<p>` element is used for wrapping in cases were the contents
358+ would otherwise not be allowed in a certain context. Unnecessary
359+ wrapping is avoided, especially around quotes (`<disp-quote>` elements).
360+ + Convert spans to `<named-content>` elements (#7211). Spans with
361+ attributes are converted to `<named-content>` elements instead of
362+ being wrapped with `<milestone-start/>` and `<milestone-end>`
363+ elements. Milestone elements are not allowed in documents using the
364+ articleauthoring tag set, so this change ensures the creation of valid
365+ documents.
366+ + Add footnote number as label in backmatter (#7210). Footnotes in the
367+ backmatter are given the footnote's number as a label. The
368+ articleauthoring output is unaffected from this change, as footnotes
369+ are placed inline there.
370+ + Escape disallows chars in identifiers. XML identifiers must start
371+ with an underscore or letter, and can contain only a limited set
372+ of punctuation characters. Any IDs not adhering to these rules are
373+ rewritten by writing the offending characters as `Uxxxx`,
374+ where `xxxx` is the character's hex code.
375+
376+ * Jira writer: use `{color}` when span has a color attribute
377+ (Albert Krewinkel, tarleb/jira-wiki-markup#10).
378+
379+ * Docx writer:
380+
381+ + Autoset table width if no column has an explicit width (Albert
382+ Krewinkel).
383+ + Extract Table handling into separate module (Albert Krewinkel).
384+ + Support colspans and rowspans in tables (Albert Krewinkel, #6315).
385+ + Support multirow table headers (Albert Krewinkel).
386+ + Improve integration of settings from reference.docx (#1209).
387+ This change allows users to create a reference.docx that
388+ sets `w:proofState` for spelling or grammar to `dirty`,
389+ so that spell/grammar checking will be triggered on the
390+ generated docx.
391+ + Copy over more settings from reference.docx (#7240). From settings.xml
392+ in the reference-doc, we now include: `zoom`, `embedSystemFonts`,
393+ `doNotTrackMoves`, `defaultTabStop`, `drawingGridHorizontalSpacing`,
394+ `drawingGridVerticalSpacing`, `displayHorizontalDrawingGridEvery`,
395+ `displayVerticalDrawingGridEvery`, `characterSpacingControl`,
396+ `savePreviewPicture`, `mathPr`, `themeFontLang`, `decimalSymbol`,
397+ `listSeparator`, `autoHyphenation`, `compat`.
398+ + Set zoom to 100% by default in settings.xml.
399+ + Align math options more with current Word defaults (e.g. Cambria Math
400+ font).
401+ + Remove `rsid`s from default settings.xml. Word will add these
402+ when revisions are made.
403+
404+ * Ms writer: Handle tables with multiple paragraphs (#7288).
405+ Previously they overflowed the table cell width. We now set line lengths
406+ per-cell and restore them after the table has been written.
407+
408+ * Markdown writer:
409+
410+ + Use cleaner braceless syntax for code blocks with a
411+ single class (#7242, Jan Tojnar).
412+ + Add quotes properly in markdown YAML metadata fields (#7245).
413+ This fixes a bug, which caused the writer to look at the *last*
414+ rather than the *first* character in determining whether quotes
415+ were needed. So we got spurious quotes in some cases and
416+ didn't get necessary quotes in others.
417+ + Use `@{..}` syntax for citations when needed.
418+ + Use fewer unneeded escapes for `#` (see #6259).
419+ + Improve escaping of `@`. We need to escape literal `@` before
420+ `{` because of the new citation syntax.
421+
422+ * Commonmark writer: Use backslash escapes for `<` and `|`...
423+ instead of entities (#7208).
424+
425+ * Powerpoint writer: allow `monofont` to be specified in metadata
426+ (#7187).
427+
428+ * LaTeX template:
429+
430+ + Use non-starred names for xcolor color names (#6109).
431+ This should make svgnames and x11names work properly.
432+ + Fix bad vertical spacing after bibliography (#7234, badumont).
433+ + List of figures before list of tables (#7235, Julien Dutant).
434+ + Move CSL macro definitions before header-includes so they can be
435+ overridden (#7286).
436+ + Improve treatment of CSL `entry-spacing` (#7296).
437+ Previously with the default template settings (`indent` variable
438+ not set), we would get interparagraph spaces separating bib
439+ entries even with `entry-spacing="0"`. On the other hand,
440+ setting `entry-spacing="2"` gave ridiculously large spacing.
441+ This change makes the spacing caused by `entry-spacing` a multiple
442+ of `\parskip` by default, which gives aesthetically reasonable
443+ output. Those who want a larger or smaller unit (e.g. because
444+ they use `indent` which sets `\parskip` to 0) may
445+ `\setlength{\cslentryspacingunit}{10pt}` in header-includes
446+ to override the defaults.
447+ + Move title, author, date up to top of preamble (#7295).
448+ This allows header-includes to use them, and puts them
449+ in a position where you can see them immediately.
450+ + Define commands for zero width non-joiner character
451+ (#6639, Albert Krewinkel). The zero-width non-joiner character
452+ is used to avoid ligatures (e.g. in German).
453+
454+ * ConTeXt template:
455+
456+ + Define `enumerate` itemgroup (#5016, Denis Maier).
457+ + List of figures before list of tables (#7235, Julien Dutant).
458+
459+ * reveal.js template:
460+
461+ + Support `toc-title` (#7171, Florian Kohrt).
462+ + Use `hash: true` by default rather than `history: true` (#6968).
463+
464+ * HTML-based slide shows: add support for `institute` (#7289, Thomas
465+ Hodgson).
466+
467+ * Text.Pandoc.Extensions: Add constructor `Ext_rebase_relative_paths` to
468+ `Extensions` [API change].
469+
470+ * Text.Pandoc.XML.Light: add Eq, Ord instances for Content,
471+ Element, Attr, CDataKind [API change].
472+
473+ * Text.Pandoc.MediaBag:
474+
475+ + Change type to use a `Text` key instead of `[FilePath]`.
476+ We normalize the path and use `/` separators for consistency.
477+ + Export `MediaItem` type [API change].
478+ + Change `MediaBag` type to a map from Text to MediaItem [API change].
479+ + `lookupMedia` now returns a `MediaItem` [API change].
480+ + Change `insertMedia` so it sets the `mediaPath` to a filename based on
481+ the SHA1 hash of the contents. This will be used when contents
482+ are extracted.
483+
484+ * Text.Pandoc.Class.PandocMonad:
485+
486+ + Remove `fetchMediaResource` [API change]. Use `fetchItem` to get
487+ resources in `fillMediaBag`.
488+ + Add informational message in `downloadOrRead` indicating what path
489+ local resources have been loaded from.
490+
491+ * Text.Pandoc.Logging:
492+
493+ + Remove single quotes around paths in messages.
494+ + Add LoadedResource constructor to LogMessage [API change].
495+ This is for INFO-level messages telling where image data has been
496+ loaded from. (This can vary because of the resource path.)
497+
498+ * Text.Pandoc.Asciify: simplify code and export `toAsciiText` [API change].
499+ Instead of encoding a giant (and incomplete) map, we now
500+ just use unicode-transforms to normalize the text to
501+ a canonical decomposition, and manipulate the result.
502+
503+ * App: allow tabs expansion even if file-scope is used (Albert Krewinkel,
504+ #6709). Tabs in plain-text inputs are now handled correctly, even if
505+ the `--file-scope` flag is used.
506+
507+ * Add new internal module Text.Pandoc.Writers.GridTable (Albert Krewinkel).
508+
509+ * Text.Pandoc.Highlighting: Change type of `languagesByExtension`, adding
510+ a parameter for a `SyntaxMap` [API change] (Jan Tojnar, #7241).
511+ Languages defined using `--syntax-definition` were not recognized by
512+ `languagesByExtension`. This patch corrects that, allowing the writers
513+ to see all custom definitions. The LaTeX writer still uses the default
514+ syntax map, but that's okay in that context, since
515+ `--syntax-definition` won't create new listings styles.
516+
517+ * Text.Pandoc.Citeproc:
518+
519+ + Ensure that CSL-related attributes are passed on to a Div with id
520+ 'refs'. Otherwise things like `entry-spacing` won't work when
521+ such Divs are used.
522+ + Use metadata's `lang` for the lang parameter of citeproc, overriding
523+ `localeLanguage`.
524+ + Recognize locators spelled with a capital letter (#7323).
525+ + Add a comma and a space in front of the suffix if it doesn't start
526+ with space or punctuation (#7324).
527+ + Don't detect math elements as locators (#7321).
528+
529+ * Remove Text.Pandoc.BCP47 module [API change]. Use types and functions
530+ from UnicodeCollation.Lang instead. This is a richer implementation
531+ of BCP 47.
532+
533+ * Text.Pandoc.Shared:
534+
535+ + Fix regression in grid tables for wide characters (#7214).
536+ In the translation from String to Text, a char-width-sensitive
537+ `splitAt'` was dropped. This commit reinstates it and uses it to make
538+ `splitTextByInstances` char-width sensitive.
539+ + Add `getLang` (formerly in the now-removed BCP47) [API change].
540+
541+ * Text.Pandoc.SelfContained: use `application/octet-stream`
542+ for unknown mime types instead of halting with an error (#7202).
543+
544+ * Lua filters: respect Inlines/Blocks filter functions in `pandoc.walk_*`
545+ (Albert Krewinkel).
546+
547+ * Add text as build-depend for trypandoc (#7193, Roman Beránek).
548+
549+ * Bump upper-bounds for network-uri, time, attoparsec.
550+
551+ * Use citeproc 0.4.
552+
553+ * Use texmath 0.12.3.
554+
555+ * Use jira-wiki-markup 1.3.5 (Albert Krewinkel).
556+
557+ * Require latest skylighting (fixes a bug in XML syntax highlighting).
558+
559+ * Use latest xml-conduit.
560+
561+ * Use latest commonmark, commonmark-extensions, commonmark-pandoc.
562+
563+ * Use haddock-library-1.10.0 (Albert Krewinkel).
564+
565+ * Allow compilation with base 4.15 (Albert Krewinkel).
566+
567+ * MANUAL:
568+
569+ + Add information about `lang` and bibliography sorting.
570+ + Add info about YAML escape sequences, link to spec (#7152,
571+ Albert Krewinkel).
572+ + Note that `institute` variable works for HTML-based slides.
573+ + Update documentation on citation syntax.
574+ + Add citation example for locators and suffixes (Tristan Stenner)
575+
576+ * Updated and fixed typos in documentation (Charanjit Singh,
577+ Anti-Distinctlyminty, Tatiana Porras, obcat).
578+
579+ * Add instructions for installing pandoc-types before compiling filter.
580+
581+ * INSTALL: add note that parallel installations should be avoided
582+ (#6865).
583+
584+ * Remove `biblatex-nussbaum.md` test. It is basically the same
585+ as `biblaetx-quotes.md`.
586+
587+ * Command tests: fail if a file contains no tests---and fix a
588+ test that failed in that way!
589+
590+ * Use smaller images in tests, reducing the size of the source tarball by 8 MB.
591+
592+
593+## pandoc 2.13 (2021-03-21)
594+
595+ * Support `yaml_metadata_block` extension for `commonmark`, `gfm` (#6537).
596+ This supported is a bit more limited than with pandoc's
597+ `markdown`. The YAML block must be the first thing in the input,
598+ and the leaf notes are parsed in isolation from the rest of
599+ the document. So, for example, you can't use reference
600+ links if the references are defined later in the document.
601+
602+ * Fix fallback to default partials when custom templates are used.
603+ If the directory containing a template does not contain the partial,
604+ it should be sought in the default templates, but this was not
605+ working properly (#7164).
606+
607+ * Handle `nocite` better with `--biblatex` and `--natbib` (#4585).
608+ Previously the nocite metadata field was ignored with these formats.
609+ Now it populates a `nocite-ids` template variable and causes a
610+ `\nocite` command to be issued.
611+
612+ * Text.Pandoc.Citeproc: apply `fixLinks` correctly (#7130). This is code
613+ that incorporates a prefix like `https://doi.org/` into a following link
614+ when appropriate.
615+
616+ * Text.Pandoc.Shared:
617+
618+ + Remove `backslashEscapes`, `escapeStringUsing` [API change]. Replace
619+ these inefficient association list lookups with more efficient escaping
620+ functions in the writers that used them (for a 10-25% performance boost
621+ in org, haddock, rtf, texinfo writers).
622+ + Remove `ToString`, `ToText` typeclasses [API change]. These were needed
623+ for the transition from String to Text, but they are no longer used and
624+ may clash with other things.
625+ + Simplify `compactDL`.
626+
627+ * Text.Pandoc.Parsing:
628+
629+ + Change type of `readWithM` so that it is no longer polymorphic
630+ [API change]. The `ToText` class has been removed, and now that we've
631+ completed the transition to Text we no longer need this to operate
632+ on Strings.
633+ + Remove `F` type synonym [API change]. Muse and Org were defining their
634+ own `F` anyway.
635+
636+ * Text.Pandoc.Readers.Metadata:
637+
638+ + Export `yamlMetaBlock` [API change].
639+ + Make `yamlBsToMeta`, `yamlBsToRefs` polymorphic on the parser state
640+ [API change].
641+
642+ * Markdown reader: Fix regression with `tex_math_backslash` (#7155).
643+
644+ * MediaWiki reader: Allow block-level content in notes (ref) (#7145).
645+
646+ * Jira reader (Albert Krewinkel):
647+
648+ + Fixed parsing of autolinks (i.e., of bare URLs in the text).
649+ Previously an autolink would take up the rest of a line, as spaces
650+ were allowed characters in these items.
651+ + Emoji character sequences no longer cause parsing failures. This was
652+ due to missing backtracking when emoji parsing fails.
653+ + Mark divs created from panels with class "panel".
654+
655+ * RST reader: fix logic for ending comments (#7134). Previously comments
656+ sometimes got extended too far.
657+
658+ * DocBook writer: include Header attributes as XML attributes on
659+ section (Erik Rask). Attributes with key names that are not allowed
660+ as XML attributes are dropped, as are attributes with invalid values
661+ and `xml:id` (DocBook 5) and `id` (DocBook 4).
662+
663+ * Docx writer:
664+
665+ + Make `nsid` in `abstractNum` deterministic. Previously we assigned
666+ a random number, but we don't need random values, so now we just
667+ assign a value based on the list marker.
668+ + Use integral values for `w:tblW` (#7141).
669+
670+ * Jira writer (Albert Krewinkel):
671+
672+ + Block quotes are only rendered as `bq.` if they do not contain a
673+ linebreak.
674+ + Jira writer: improve div/panel handling. Include div attributes in
675+ panels, always render divs with class `panel` as panels, and
676+ avoid nesting of panels.
677+
678+ * HTML writer: Add warnings on duplicate attribute values.
679+ This prevents emitting invalid HTML. Ultimately it would be good to
680+ prevent this in the types themselves, but this is better for now.
681+
682+ * Org writer: Prevent unintended creation of ordered list items (#7132,
683+ Albert Krewinkel). Adjust line wrapping if default wrapping would cause
684+ a line to be read as an ordered list item.
685+
686+ * JATS templates: support 'equal-contrib' attrib for authors (Albert
687+ Krewinkel). Authors who contributed equally to a paper may be marked
688+ with `equal-contrib`.
689+
690+ * reveal.js template: replace JS comment with HTML (#7154, Florian Kohrt).
691+
692+ * Text.Pandoc.Logging: Add `DuplicateAttribute` constructor to `LogMessage`.
693+ [API change]
694+
695+ * Use `-j4` for linux release build. This speeds up the build dramatically
696+ on arm.
697+
698+ * cabal.project: remove ghcoptions. Move flags to top level, so they can
699+ be set differently on the command line.
700+
701+ * Require latest texmath, skylighting, citeproc, jira-wiki-markup.
702+ (The latest skylighting fixes a bad bug with Haskell syntax highlighting.)
703+ Narrow version bounds for texmath, skylighting, and citeproc, since
704+ the test output depend on them.
705+
706+ * Use doclayout 0.3.0.2. This significantly reduces the time and memory
707+ needed to compile pandoc.
708+
709+ * Use `foldl'` instead of `foldl` everywhere.
710+
711+ * Update bounds for random (#7156, Alexey Kuleshevich).
712+
713+ * Remove uses of some partial functions.
714+
715+ * Don't bake in a larger stack size for the executable.
716+
717+ * Test improvements:
718+
719+ + Use `getExecutablePath` from base, avoiding the dependency on
720+ `executable-path`.
721+ + Factor out `setupEnvironment` in Helpers, to avoid code duplication.
722+ + Fix finding of data files by setting teh `pandoc_datadir` environment
723+ variable when we shell out to pandoc. This avoids the need to use
724+ `--data-dir` for the tests, which caused problems finding `pandoc.lua`
725+ when compiling without the `embed_data_files` flag (#7163).
726+
727+ * Benchmark improvements:
728+
729+ + Build `+RTS -A8m -RTS` into default ghc-options for benchmark.
730+ This is necessary to get accurate benchmark results; otherwise we
731+ are largely measuring garbage collecting, some not related to the
732+ current benchmark.
733+ + Allow specifying BASELINE file in 'make bench' for comparison
734+ (otherwise the latest benchmark is chosen by default).
735+ + Force `readFile` in benchmarks early (Bodigrim).
736+
737+ * CONTRIBUTING: suggest using a `cabal.project.local` file (#7153,
738+ Albert Krewinkel).
739+
740+ * Add ghcid-test to Makefile. This loads the test suite in ghcid.
741+
742+
743+## pandoc 2.12 (2021-03-08)
744+
745+ * `--resource-path` now accumulates if specified multiple
746+ times (#6152). Resource paths specified later on the command line are
747+ prepended to those specified earlier. Thus,
748+ `--resource-path foo --resource-path bar:baz` is equivalent to
749+ `--resource-path bar:bas:foo`. (The previous behavior was
750+ for the last `--resource-path` to replace all the rest.)
751+ `resource-path` in defaults files behaves the same way: it
752+ will be prepended to the resource path set by earlier
753+ command line options or defaults files. This change
754+ facilitates the use of multiple defaults files: each can
755+ specify a directory containing resources it refers to
756+ without clobbering the resource paths set by the others.
757+
758+ * Allow defaults files to refer to the home directory, the
759+ user data directory, and the directory containing the defaults file
760+ itself (#5871, #5982, #5977). In fields that expect file paths
761+ (and only in these fields),
762+
763+ + `${VARIABLE}` will expand to the value of the environment variable
764+ `VARIABLE` (and in particular `${HOME}` will expand to the path
765+ of the home directory). A warning will be raised for undefined
766+ variables.
767+ + `${USERDATA}` will expand to the path of the user data
768+ directory in force when the defaults file is being processed.
769+ + `${.}` will expand to the directory containing the defaults file.
770+ (This allows default files to be placed in a directory containing
771+ resources they make use of.)
772+
773+ * When downloading content from URL arguments, be sensitive to
774+ the character encoding (#5600). We can properly handle UTF-8 and latin1
775+ (ISO-8859-1); for others we raise an error. Fall back to latin1 if
776+ no charset is given in the mime type and UTF-8 decoding fails.
777+
778+ * Allow abbreviations that don't end in a period to be
779+ specified using `--abbreviations` (#7124).
780+
781+ * Add new unexported module Text.Pandoc.XML.Light, as well
782+ as Text.Pandoc.XML.Light.Types, Text.Pantoc.XML.Light.Proc,
783+ Text.Pandoc.XML.Light.Output. (Closes #6001, #6565, #7091).
784+
785+ This module exports definitions of `Element` and `Content`
786+ that are isomorphic to xml-light's, but with Text
787+ instead of String. This allows us to keep most of the code in existing
788+ readers that use xml-light, but avoid lots of unnecessary allocation.
789+
790+ We also add versions of the functions from xml-light's
791+ Text.XML.Light.Output and Text.XML.Light.Proc that operate on our
792+ modified XML types, and functions that convert xml-light types to our
793+ types (since some of our dependencies, like texmath, use xml-light).
794+
795+ We export functions that use xml-conduit's parser to produce an
796+ `Element` or `[Content]`. This allows existing pandoc code to use
797+ a better parser without much modification.
798+
799+ The new parser is used in all places where xml-light's parser was
800+ previously used. Benchmarks show a significant performance improvement
801+ in parsing XML-based formats (with docbook, opml, jats, and docx
802+ almost twice as fast, odt and fb2 more than twice as fast).
803+
804+ In addition, the new parser gives us better error reporting than
805+ xml-light. We report XML errors, when possible, using the new
806+ `PandocXMLError` constructor in `PandocError`.
807+
808+ These changes revealed the need for some changes in the tests. The
809+ docbook-reader.docbook test lacked definitions for the entities it used;
810+ these have been added. And the docx golden tests have been updated,
811+ because the new parser does not preserve the order of attributes.
812+
813+ * DocBook reader:
814+
815+ + Avoid expensive tree normalization step, as it is not necessary
816+ with the new XML parser.
817+ + Support `informalfigure` (#7079) (Nils Carlson).
818+
819+ * Docx reader:
820+
821+ + Use Map instead of list for Namespaces. This gives a speedup of
822+ about 5-10%. With this and the XML parsing changes, the docx reader
823+ is now about twice as fast as in the previous release.
824+
825+ * HTML reader:
826+
827+ + Small performance tweaks.
828+ + Also, remove exported class `NamedTag(..)` [API change]. This was just
829+ intended to smooth over the transition from String to Text and is no
830+ longer needed.
831+ + As a result, the functions `isInlineTag` and `isBlockTag`
832+ are no longer polymorphic; they apply to a `Tag Text` [API change].
833+ + Do a lookahead to find the right parser to use. This takes
834+ benchmarks from 34ms to 23ms, with less allocation.
835+ + Fix bad handling of empty `src` attribute in `iframe` (#7099).
836+ If `src` is empty, we simply skip the `iframe`.
837+ If `src` is invalid or cannot be fetched, we issue a warning
838+ nd skip instead of failing with an error.
839+
840+ * JATS reader:
841+
842+ + Avoid tree normalization, which is no longer necessary given the
843+ new XML parser.
844+
845+ * LaTeX reader:
846+
847+ + Don't export `tokenize`, `untokenize` [API change]. These are internal
848+ implementation details, which were only exported for testing.
849+ They don't belong in the public API.
850+ + Improved efficiency of the parser. With these changes the reader
851+ is almost twice as fast as in the last release in our benchmarks.
852+ + Code cleanup, removing some unnecessary things.
853+ + Rewrite `withRaw` so it doesn't rely on fragile assumptions
854+ about token positions (which break when macros are expanded)
855+ (#7092). This requires the addition of `sEnableWithRaw` and
856+ `sRawTokens` in `LaTeXState`, and a new combinator `disablingWithRaw`
857+ to disable collecting of raw tokens in certain contexts.
858+ Add `parseFromToks` to Text.Pandoc.Readers.LaTeX.Parsing.
859+ Fix parsing of single character tokens so it doesn't mess
860+ up the new raw token collecting. These changes slightly increase
861+ allocations and have a small performance impact.
862+ + Handle some bibtex/biblatex-specific commands that used to be
863+ dealt with in pandoc-citeproc (#7049).
864+ + Optimize `satisfyTok`, avoiding unnecessary macro expansion steps.
865+ Benchmarks after this change show 2/3 of the run time and 2/3 of the
866+ allocation of the Feb. 10 benchmarks.
867+ + Removed `sExpanded` in state. This isn't actually needed and checking
868+ it doesn't change anything.
869+ + Improve `braced'`. Remove the parameter, have it parse the
870+ opening brace, and make it more efficient.
871+ + Factor out pieces of the LaTeX reader to make the module smaller.
872+ This reduces memory demands when compiling. Created
873+ Text.Pandoc.Readers.{LaTeX,Math,Citation,Table,Macro,Inline}.
874+ Changed Text.Pandoc.Readers.LaTeX.SIunitx to export a command map
875+ instead of individual commands.
876+ + Handle table cells containing `&` in `\verb` (#7129).
877+
878+ * Make Text.Pandoc.Readers.LaTeX.Types an unexported module [API change].
879+
880+ * Markdown reader:
881+
882+ + Improved handling of mmd link attributes in references (#7080).
883+ Previously they only worked for links that had titles.
884+ + Improved efficiency of the parser (benchmarks show a 15% speedup).
885+
886+ * OPML reader:
887+
888+ + Avoid tree normalization, which is no longer necessary with the
889+ new XML parser.
890+
891+ * ODT reader:
892+
893+ + Finer-grained errors on parse failure (#7091).
894+ + Give more information if the zip container can't be unpacked.
895+
896+ * Org reader:
897+
898+ + Support `task_lists` extension (Albert Krewinkel, #6336).
899+ + Fix bug in org-ref citation parsing (Albert Krewinkel, #7101).
900+ The org-ref syntax allows to list multiple citations separated by
901+ comma. Previously commas were accepted as part of the citation id,
902+ so all citation lists were parsed as one single citation.
903+
904+ * RST reader:
905+
906+ + Use `getTimestamp` instead of `getCurrentTime` to fetch timestamp.
907+ Setting `SOURCE_DATE_EPOCH` will allow reproducible builds.
908+ + RST reader: fix handling of header in CSV tables (#7064).
909+ The interpretation of this line is not affected by the delim option.
910+
911+ * Jira reader:
912+
913+ + Modified the Doc parser to skip leading blank lines. This fixes
914+ parsing of documents which start with multiple blank lines (Albert
915+ Krewinkel, #7095).
916+ + Prevent URLs within link aliases to be treated as autolinks (Albert
917+ Krewinkel, #6944).
918+
919+ * Text.Pandoc.Shared
920+
921+ + Remove formerly exported functions that are no longer used in the
922+ code base: `splitByIndices`, `splitStringByIndicies`, `substitute`,
923+ and `underlineSpan` (which had been deprecated in April 2020)
924+ [API change].
925+ + Export `handleTaskListItem` (Albert Krewinkel) [API change].
926+ + Change `defaultUserDataDirs` to `defaultUserDataDir` [API
927+ change]. We determine what is the default user data directory
928+ by seeing whether the XDG directory and/or legacy
929+ directory exist.
930+
931+ * BibTeX writer:
932+
933+ + BibTeX writer: use doclayout and doctemplate. This change allows
934+ bibtex/biblatex output to wrap as other formats do,
935+ depending on the settings of `--wrap` and `--columns` (#7068).
936+
937+ * CSL JSON writer:
938+
939+ + Output `[]` if no references in input, instead of raising a
940+ PandocAppError as before.
941+
942+ * Docx writer:
943+
944+ + Use `getTimestamp` instead of `getCurrentTime` for timestamp.
945+ Setting `SOURCE_DATE_EPOCH` will allow reproducible builds.
946+
947+ * EPUB writer:
948+
949+ + Use `getTimestamp` instead of `getCurrentTime` for timestamp.
950+ Setting `SOURCE_DATE_EPOCH` will allow reproducible builds (#7093).
951+ This does not suffice to fully enable reproducible in EPUB, since
952+ a unique id is still being generated for each build.
953+ + Support `belongs-to-collection` metadata (#7063) (Nick Berendsen).
954+
955+ * JATS writer:
956+
957+ + Escape special chars in reference elements (Albert Krewinkel).
958+ Prevents the generation of invalid markup if a citation element
959+ contains an ampersand or another character with a special meaning
960+ in XML.
961+
962+ * Jira writer:
963+
964+ + Use Span identifiers as anchors (Albert Krewinkel).
965+ + Use `{noformat}` instead of `{code}` for unknown languages (Albert
966+ Krewinkel). Code blocks which are not marked as a language supported
967+ by Jira are rendered as preformatted text via `{noformat}` blocks.
968+
969+ * LaTeX writer:
970+
971+ + Adjust hypertargets to beginnings of paragraphs (#7078).
972+ Use `\vadjust pre` so that the hypertarget takes you to the beginning
973+ of the paragraph rather than one line down.
974+ This makes a particular difference for links to citations using
975+ `--citeproc` and `link-citations: true`.
976+ + Change BCP47 lang tag from `jp` to `ja` (Mauro Bieg, #7047).
977+ + Use function instead of map for accent lookup (should be
978+ more efficient).
979+ + Split the module to make it easier to compile on low-memory
980+ systems: added Text.Pandoc.Writers.LaTeX.{Util,Citation,Lang}.
981+
982+ * Markdown writer:
983+
984+ + Handle math right before digit. We insert an HTML comment to
985+ avoid a `$` right before a digit, which pandoc will not recognize
986+ as a math delimiter.
987+ + Split the module to make it easier to compile on low-memory
988+ systems: added Text.Pandoc.Writers.Markdown.{Types,Inline}.
989+
990+ * ODT writer:
991+
992+ + Use `getTimestamp` instead of `getCurrentTime` for timestamp.
993+ Setting `SOURCE_DATE_EPOCH` will allow reproducible builds.
994+ + Update default ODT style (Lorenzo). Previously, the "First paragraph"
995+ style inherited from "Standard" but not from "Text body." Now
996+ it is adjusted to inherit from "Text body", to avoid some ugly
997+ spacing issues. It may be necessary to update a custom `reference.odt`
998+ in light of this change.
999+
1000+ * Org writer:
1001+
1002+ + Support `task_lists` extension (Albert Krewinkel, #6336).
1003+
1004+ * Pptx writer:
1005+
1006+ + Use `getTimestamp` instead of `getCurrentTime` for timestamp.
1007+ Setting `SOURCE_DATE_EPOCH` will allow reproducible builds.
1008+
1009+ * JATS templates: tag `author.name` as `string-name` (Albert Krewinkel).
1010+ The partitioning the components of a name into surname, given names,
1011+ etc. is not always possible or not available. Using `author.name`
1012+ allows to give the full name as a fallback to be used when
1013+ `author.surname` is not available.
1014+
1015+ * Add default templates for bibtex and biblatex, so that
1016+ the variables `header-include`, `include-before`, `include-after`
1017+ (or alternatively the command line options
1018+ `--include-in-header`, `--include-before-body`, `--include-after-body`)
1019+ may be used.
1020+
1021+ * LaTeX template:
1022+
1023+ + Update to iftex package (#7073) (Andrew Dunning)
1024+ + Wrap url colours in braces (#7121) (Loïc Grobol).
1025+
1026+ * revealjs template: Add 'center' option for vertical slide centering.
1027+ (maurerle, #7104).
1028+
1029+ * Text.Pandoc.XML: Improve efficiency of `fromEntities`.
1030+
1031+ * Text.Pandoc.MIME
1032+
1033+ + Add exported function `getCharset` [API change].
1034+
1035+ * Text.Pandoc.UTF8: change IO functions to return Text, not String
1036+ [API change]. This affects `readFile`, `getContents`, `writeFileWith`,
1037+ `writeFile`, `putStrWith`, `putStr`, `putStrLnWith`, `putStrLn`.
1038+ `hPutStrWith`, `hPutStr`, `hPutStrLnWith`, `hPutStrLn`, `hGetContents`.
1039+ This avoids the need to uselessly create a linked list of characters
1040+ when emiting output.
1041+
1042+ * Text.Pandoc.App
1043+
1044+ + Add `parseOptionsFromArgs` [API change, new exported function].
1045+ + Add fields for CSL options to `Opt` [API change]:
1046+ `optCSL`, `optbibliography`, `optCitationAbbreviations`.
1047+
1048+ * Text.Pandoc.Citeproc.BibTeX
1049+
1050+ + `Text.Pandoc.Citeproc.writeBibTeXString` now returns
1051+ `Doc Text` instead of `Text` (#7068).
1052+ + Correctly handle `pages` (= `page` in CSL) (#7067).
1053+ + Correctly handle BibLaTeX `langid` (= `language` in CSL, #7067).
1054+ + In BibTeX output, protect foreign titles since there's no language
1055+ field (#7067).
1056+ + Clean up BibTeX parsing (#7049). Previously there was a messy code
1057+ path that gave strange results in some cases, not passing through raw
1058+ tex but trying to extract a string content. This was an artefact of
1059+ trying to handle some special bibtex-specific commands in the BibTeX
1060+ reader. Now we just handle these in the LaTeX reader and simplify
1061+ parsing in the BibTeX reader. This does mean that more raw tex will
1062+ be passed through (and currently this is not sensitive to the
1063+ `raw_tex` extension; this should be fixed).
1064+
1065+ * Text.Pandoc.Citeproc.MetaValue
1066+
1067+ + Correctly parse "raw" date value in markdown references metadata.
1068+ (See jgm/citeproc#53.)
1069+
1070+ * Text.Pandoc.Citeproc
1071+
1072+ + Use https URLs for links (Salim B, #7122).
1073+
1074+ * Text.Pandoc.Class
1075+
1076+ + Add `getTimestamp` [API change]. This attempts to read the
1077+ `SOURCE_DATE_EPOCH` environment variable and parse a UTC time
1078+ from it (treating it as a unix date stamp, see
1079+ https://reproducible-builds.org/specs/source-date-epoch/). If the
1080+ variable is not set or can't be parsed as a unix date stamp, then the
1081+ function returns the current date.
1082+
1083+ * Text.Pandoc.Error
1084+
1085+ + Add `PandocUnsupportedCharsetError` constructor for
1086+ `PandocError` [API change].
1087+ + Export `renderError` [API change].
1088+ + Refactor `handleError` to use `renderError`. This allows us render
1089+ error messages without exiting.
1090+
1091+ * Text.Pandoc.Extensions
1092+
1093+ + `Ext_task_lists` is now supported by org (and turned
1094+ on by default) (Albert Krewinkel, #6336).
1095+ + Remove `Ext_fenced_code_attributes` from allowed commonmark attributes
1096+ (#7097). This attribute was listed as allowed, but it didn't actually
1097+ do anything. Use `attributes` for code attributes and more.
1098+
1099+ * Lua subsystem:
1100+
1101+ + Always load built-in Lua scripts from default data-dir (Albert
1102+ Krewinkel). The Lua modules `pandoc` and `pandoc.List` are now always
1103+ loaded from the system's default data directory. Loading from a
1104+ different directory by overriding the default path, e.g. via
1105+ `--data-dir`, is no longer supported to avoid unexpected behavior
1106+ and to address security concerns.
1107+ + Add module "pandoc.path" (Albert Krewinkel, #6001, #6565).
1108+ The module allows to work with file paths in a convenient and
1109+ platform-independent manner.
1110+ + Use strict evaluation when retrieving AST value from the stack
1111+ (Albert Krewinkel, #6674).
1112+
1113+ * Text.Pandoc.PDF
1114+
1115+ + Disable `smart` extension when building PDF via LaTeX.
1116+ This is to prevent accidental creation of ligatures like
1117+ `` ?` `` and `` !` `` (especially in languages with quotations like
1118+ German), and similar ligature issues. (See jgm/citeproc#54.)
1119+
1120+ * Text.Pandoc.CSV:
1121+
1122+ + Fix parsing of unquoted values (#7112). Previously we didn't allow
1123+ unescaped quotes in unquoted values, but they are allowed
1124+ in CSV.
1125+
1126+ * Test suite:
1127+
1128+ + Use a more robust method for testing the executable. Many
1129+ of our tests require running the pandoc executable. This
1130+ is problematic for a few different reasons. First,
1131+ cabal-install will sometimes run the test suite after
1132+ building the library but before building the executable,
1133+ which means the executable isn't in place for the tests.
1134+ One can work around that by first building, then building
1135+ and running the tests, but that's fragile. Second, we
1136+ have to find the executable. So far, we've done that using
1137+ a function `findPandoc` that attempts to locate it
1138+ relative to the test executable (which can be located
1139+ using findExecutablePath). But the logic here is delicate
1140+ and work with every combination of options. To solve both
1141+ problems, we add an `--emulate` option to the
1142+ `test-pandoc` executable. When `--emulate` occurs as the
1143+ first argument passed to `test-pandoc`, the program simply
1144+ emulates the regular pandoc executable, using the rest of
1145+ the arguments (after `--emulate`). Thus, `test-pandoc
1146+ --emulate -f markdown -t latex` is just like `pandoc -f
1147+ markdown -t latex`. Since all the work is done by library
1148+ functions, implementing this emulation just takes a couple
1149+ lines of code and should be entirely reliable. With this
1150+ change, we can test the pandoc executable by running the
1151+ test program itself (locatable using `findExecutablePath`)
1152+ with the `--emulate` option. This removes the need for the
1153+ fragile `findPandoc` step, and it means we can run our
1154+ integration tests even when we're just building the
1155+ library, not the executable. [Note: part of this change
1156+ involved simplifying some complex handling to set
1157+ environment variables for dynamic library paths. I have
1158+ tested a build with `--enable-dynamic-executable`, and it
1159+ works, but further testing may be needed.]
1160+ + Print accurate location if a test fails (Albert
1161+ Krewinkel). Ensures that tasty-hunit reports the location
1162+ of the failing test instead of the location of the helper
1163+ `test` function.
1164+
1165+ * Documentation: Update URLs and use `https` where possible (#7122,
1166+ Salim B).
1167+
1168+ * Add `doc/libraries.md`, a description of libraries that support pandoc.
1169+
1170+ * MANUAL.txt
1171+
1172+ + MANUAL: block-level formatting is not allowed in line blocks (#7107).
1173+ + Clarify `tex_math_dollars` extension. Note that no blank lines
1174+ are allowed between the delimiters in display math.
1175+ + Add MANUAL section on reproducible builds.
1176+ + Document no template fallback for absolute path (#7077, Nixon
1177+ Enraght-Moony.)
1178+ + Improve docs for cite-method.
1179+ + Update README and man page.
1180+
1181+ * Makefile: in `make bench`, create CSV files for comparison and compare
1182+ against previous benchmark run. Add timestamp to CSV filenames.
1183+
1184+ * cabal.project: don't explicitly set -trypandoc.
1185+ If we do, this can't be overridden on the cabal command line.
1186+
1187+ * doc/lua-filters.md: improve documentation for
1188+ `pandoc.mediabag.insert`, `pandoc.mediabag.fetch`,
1189+ `directory`, `normalize` (Albert Krewinkel).
1190+
1191+ * Allow base64-bytestring-1.2.* (Dmitrii Kovanikov)
1192+
1193+ * Require jira-wiki-markup 1.3.3 (Albert Krewinkel)
1194+
1195+ * Require citeproc 0.3.0.8, which correctly titlecases when titles
1196+ contain non-ASCII characters.
1197+
1198+ * Use skylighting 0.10.4. This version of skylighting uses xml-conduit
1199+ rather than hxt. This speeds up parsing of XML syntax definitions
1200+ fourfold, and removes four packages from pandoc's dependency graph:
1201+ hxt-charproperties, hxt-unicode, hxt-regex-xmlschema, hxt.
1202+
1203+ * Add script `tools/parseTimings.pl` to help pin down which
1204+ modules take the most time and memory to compile.
1205+
1206+ * Avoid unnecessary use of NoImplicitPrelude pragma (#7089) (Albert
1207+ Krewinkel)
1208+
1209+ * Benchmarks
1210+
1211+ + Use the lighter-weight tasty-bench instead of criterion.
1212+ + Run writer benchmarks for binary formats too.
1213+ + Alphabetize benchmarks.
1214+ + Don't run benchmarks for bibliography formats
1215+ (yet; we need a special input for them).
1216+ + Show allocation data
1217+ + Clean up benchmark code.
1218+ + Allow specifying patterns using `-p blah'.
1219+
1220+ * trypandoc: add 2 second timeout.
1221+
1222+ * Use `-split-sections` in creating linux release binary.
1223+ This reduces executable size significantly (by about 30%).
1224+
1225+ * Remove `weigh-pandoc`. It's not really useful any more, now that our
1226+ regular benchmarks include data on allocation.
1227+
1228+ * Improve linux package build process and add script to
1229+ automate building an arm64 binary package.
1230+
1231+
1232+## pandoc 2.11.4 (2021-01-22)
1233+
1234+ * Add `biblatex`, `bibtex` as output formats (closes #7040).
1235+
1236+ * Recognize more extensions as markdown by default (#7034):
1237+ `mkdn`, `mkd`, `mdwn`, `mdown`, `Rmd`.
1238+
1239+ * Implement defaults file inheritance (#6924, David Martschenko).
1240+ Allow defaults files to inherit options from other defaults files by
1241+ specifying them with the following syntax:
1242+ `defaults: [list of defaults files or single defaults file]`.
1243+
1244+ * Fix infinite HTTP requests when writing epubs from URL source (#7013).
1245+ Due to a bug in code added to avoid overwriting the cover image
1246+ if it had the form `fileX.YYY`, pandoc made an endless sequence
1247+ of HTTP requests when writing epub with input from a URL.
1248+
1249+ * Org reader:
1250+
1251+ + Allow multiple pipe chars in todo sequences (Albert Krewinkel, #7014).
1252+ Additional pipe chars, used to separate "action" state from "no further
1253+ action" states, are ignored. E.g., for the following sequence, both
1254+ `DONE` and `FINISHED` are states with no further action required:
1255+ `#+TODO: UNFINISHED | DONE | FINISHED`.
1256+ + Restructure output of captioned code blocks (Albert Krewinkel, #6977).
1257+ The Div wrapper of code blocks with captions now has the class
1258+ "captioned-content". The caption itself is added as a Plain block
1259+ inside a Div of class "caption". This makes it easier to write filters
1260+ which match on captioned code blocks. Existing filters will need to be
1261+ updated.
1262+ + Mark verbatim code with class `verbatim` (Dimitri Sabadie, #6998).
1263+
1264+ * LaTeX reader:
1265+
1266+ + Handle `filecontents` environment (#7003).
1267+ + Put contents of unknown environments in a Div when `raw_tex` is not
1268+ enabled (#6997). (When `raw_tex` is enabled, the whole environment is
1269+ parsed as a raw block.) The class name is the name of the environment.
1270+ Previously, we just included the contents without the surrounding Div,
1271+ but having a record of the environment's boundaries and name can be
1272+ useful.
1273+
1274+ * Mediawiki reader:
1275+
1276+ + Allow space around storng/emph delimiters (#6993).
1277+
1278+ * New module Text.Pandoc.Writers.BibTeX, exporting
1279+ writeBibTeX and writeBibLaTeX. [API change]
1280+
1281+ * LaTeX writer:
1282+
1283+ + Revert table line height increase in 2.11.3 (#6996).
1284+ In 2.11.3 we started adding `\addlinespace`, which produced less dense
1285+ tables. This wasn't an intentional change; I misunderstood a comment in
1286+ the discussion leading up to the change. This commit restores the earlier
1287+ default table appearance. Note that if you want a less dense table, you
1288+ can use something like `\def\arraystretch{1.5}` in your header.
1289+
1290+ * EPUB writer:
1291+
1292+ + Adjust internal links to identifiers defined in raw HTML sections
1293+ after splitting into chapters (#7000).
1294+ + Recognize `Format "html4"`, `Format "html5"` as raw HTML.
1295+ + Adjust internal links to images, links, and tables after splitting into
1296+ chapters. Previously we only did this for Div and Span and Header
1297+ elements (see #7000).
1298+
1299+ * Ms writer:
1300+
1301+ + Don't justify text inside table cells.
1302+
1303+ * JATS writer:
1304+
1305+ + Use `<element-citation>` if `element_citations`
1306+ extension is enabled (Albert Krewinkel).
1307+ + Fix citations (Albert Krewinkel, #7018). By default
1308+ we use formatted citations.
1309+ + Ensure that `<disp-quote>` is always wrapped in `<p>` (#7041).
1310+
1311+ * Markdown writer:
1312+
1313+ + Cleaned up raw formats. We now react appropriately
1314+ to `gfm`, `commonmark`, and `commonmark_x` as raw formats.
1315+
1316+ * RST writer:
1317+
1318+ + Fix bug with dropped content from inside spans with a class in
1319+ some cases (#7039).
1320+
1321+ * Docx writer:
1322+
1323+ + Handle table header using styles (#7008). Instead of hard-coding
1324+ the border and header cell vertical alignment, we now let this
1325+ be determined by the Table style, making use of Word's
1326+ "conditional formatting" for the table's first row. For
1327+ headerless tables, we use the tblLook element to tell Word
1328+ not to apply conditional first-row formatting.
1329+
1330+ * Commonmark writer:
1331+
1332+ + Implement start number on ordered lists (#7009). Previously they always
1333+ started at 1, but according to the spec the start number is respected.
1334+
1335+ * HTML writer:
1336+
1337+ + Fix implicit_figure at end of footnotes (#7006).
1338+
1339+ * ConTeXt template: Remove `\setupthinrules` from default template.
1340+ The width parameter this used is not actually supported,
1341+ and the command didn't do anything.
1342+
1343+ * Text.Pandoc.Extensions:
1344+
1345+ + Add `Ext_element_citations` constructor (Albert Krewinkel).
1346+
1347+ * Text.Pandoc.Citeproc.BibTeX: New unexported function
1348+ `writeBibtexString`.
1349+
1350+ * Text.Pandoc.Citeproc:
1351+
1352+ + Use finer grained imports (Albert Krewinkel).
1353+ + Factor out and export `getStyle` [API change].
1354+ + Export `getReferences` [API change, #7106].
1355+ + Factor out getLang.
1356+
1357+ * Text.Pandoc.Parsing: modify `gridTableWith'` for headerless tables.
1358+ If the table lacks a header, the header row should be an empty
1359+ list. Previously we got a list of empty cells, which caused
1360+ an empty header to be emitted instead of no header. In LaTeX/PDF
1361+ output that meant we got a double top line with space between.
1362+
1363+ * ImageSize: use `viewBox` for SVG if no length, width attributes (#7045).
1364+ This change allows pandoc to extract size information from more SVGs.
1365+
1366+ * Add simple default.nix.
1367+
1368+ * Use commonmark 0.1.1.3.
1369+
1370+ * Use citeproc 0.3.0.5.
1371+
1372+ * Update default CSL to use latest chicago-author-date.csl.
1373+
1374+ * CONTRIBUTING.md: add note on GNU xargs.
1375+
1376+ * MANUAL.txt:
1377+
1378+ + Update description of `-L`/`--lua-filter`.
1379+ + Document use of citations in note styles (#6828).
1380+
1381+## pandoc 2.11.3.2 (2020-12-29)
1382+
1383+ * HTML reader: use renderTags' from Text.Pandoc.Shared (Albert Krewinkel).
1384+ A side effect of this change is that empty `<col>` elements are written
1385+ as self-closing tags in raw HTML blocks.
1386+
1387+ * Asciidoc writer: Add support for writing nested tables (#6972, timo-a).
1388+ Asciidoc supports one level of nesting. If deeper tables are to be
1389+ written, they are omitted and a warning is issued.
1390+
1391+ * Docx writer: fix nested tables with captions (#6983).
1392+ Previously we got unreadable content, because docx seems
1393+ to want a `<w:p>` element (even an empty one) at the end of
1394+ every table cell.
1395+
1396+ * Powerpoint writer: allow arbitrary OOXML in raw inline elements
1397+ (Albert Krewinkel). The raw text is now included verbatim in the
1398+ output. Previously is was parsed into XML elements, which prevented
1399+ the inclusion of partial XML snippets.
1400+
1401+ * LaTeX writer: support colspans and rowspans in tables (#6950,
1402+ Albert Krewinkel). Note that the multirow package is needed for
1403+ rowspans. It is included in the latex template under a variable,
1404+ so that it won't be used unless needed for a table.
1405+
1406+ * HTML writer: don't include p tags in CSL bibliography entries
1407+ (#6966). Fixes a regression in 2.11.3.
1408+
1409+ * Add `meta-description` variable to HTML templates (#6982). This
1410+ is populated by the writer by stringifying the `description`
1411+ field of metadata (Jerry Sky). The `description` meta tag will
1412+ make the generated HTML documents more complete and SEO-friendly.
1413+
1414+ * Citeproc: fix handling of empty URL variables (`DOI`, etc.).
1415+ The `linkifyVariables` function was changing these to links
1416+ which then got treated as non-empty by citeproc, leading
1417+ to wrong results (e.g. ignoring nonempty URL when empty DOI is present).
1418+ See jgm/citeproc#41.
1419+
1420+ * Use citeproc 0.3.0.3. Fixes an issue in author-only citations when
1421+ both an author and translator are present, and an issue with
1422+ citation group delimiters.
1423+
1424+ * Require texmath 0.12.1. This improves siunitx support in math,
1425+ fixes bugs with `\*mod` family operators and arrays, and avoids
1426+ italicizing symbols and operator names in docx output.
1427+
1428+ * Ensure that the perl interpreter used for filters with `.pl`
1429+ extension (wuffi).
1430+
1431+ * MANUAL: note that textarea content is never parsed as Markdown
1432+ (Albert Krewinkel).
1433+
1434+
1435+## pandoc 2.11.3.1 (2020-12-18)
1436+
1437+ * Added some missing files to extra-source-files and data
1438+ files, so they are included in the sdist tarball. Closes #6961.
1439+ Cleaned up some extraneous data and test files, and added
1440+ a CI check to ensure that the test and data files included
1441+ in the sdist match what is in the git repository.
1442+
1443+ * Use citeproc 0.3.0.1, which avoids removing nonbreaking
1444+ space at the end of the `initialize-with` attribute. (Some
1445+ journals require nonbreaking space after initials, and this
1446+ makes that possible.)
1447+
1448+## pandoc 2.11.3 (2020-12-17)
1449+
1450+ * With `--bibliography` (or `bibliography` in metadata), a
1451+ URL may now be provided, and pandoc will fetch the resource.
1452+ In addition, if a file path is provided and it is not
1453+ found relative to the working directory, the resource
1454+ path will be searched (#6940).
1455+
1456+ * Add `sourcepos` extension for `commonmark`, `gfm`, `commonmark_x`
1457+ (#4565). With the `sourcepos` extension set set, `data-pos`
1458+ attributes are added to the AST by the commonmark reader. No other
1459+ readers are affected. The `data-pos` attributes are put on elements
1460+ that accept attributes; for other elements, an enlosing Div or Span
1461+ is added to hold the attributes.
1462+
1463+ * Change extensions for `commonmark_x`: replace `auto_identifiers`
1464+ with `gfm_auto_identifiers` (#6863). `commonmark_x` never actually
1465+ supported `auto_identifiers` (it didn't do anything), because the
1466+ underlying library implements gfm-style identifiers only. Attempts
1467+ to add the `auto_identifiers` extension to `commonmark` will now
1468+ fail with an error.
1469+
1470+ * HTML reader:
1471+
1472+ + Split module into several submodules (Albert Krewinkel). Reducing
1473+ module size should reduce memory use during compilation.
1474+ + Support advanced table features (Albert Krewinkel):
1475+ block level content in captions, row and colspans,
1476+ body headers, row head columns, footers, attributes.
1477+ + Disable round-trip testing for tables. Information for cell
1478+ alignment in a column is not preserved during round-trips (Albert
1479+ Krewinkel).
1480+ + Allow finer grained options for tag omission (Albert Krewinkel).
1481+ + Simplify list attribute handling (Albert Krewinkel).
1482+ + Pay attention to `lang` attributes on body element (#6938).
1483+ These (as well as `lang` attributes on the html element) should update
1484+ lang in metadata.
1485+ + Retain attribute prefixes and avoid duplicates (#6938).
1486+ Previously we stripped attribute prefixes, reading `xml:lang` as
1487+ `lang` for example. This resulted in two duplicate `lang`
1488+ attributes when `xml:lang` and `lang` were both used. This commit
1489+ causes the prefixes to be retained, and also avoids invald
1490+ duplicate attributes.
1491+
1492+ * Commonmark reader:
1493+
1494+ + Refactor `specFor`.
1495+ + Set input name to `""` to avoid clutter in sourcepos output.
1496+
1497+ * Org reader:
1498+
1499+ + Parse `#+LANGUAGE` into `lang` metadata field (#6845, Albert
1500+ Krewinkel).
1501+ + Preserve targets of spurious links (#6916, Albert
1502+ Krewinkel). Links with (internal) targets that the reader doesn't
1503+ know about are converted into emphasized text. Information on the
1504+ link target is now preserved by wrapping the text in a Span of class
1505+ `spurious-link`, with an attribute `target` set to the link's
1506+ original target. This allows to recover and fix broken or unknown
1507+ links with filters.
1508+
1509+ * DocBook reader:
1510+
1511+ + Table text width support (#6791, Nils Carlson).
1512+ Table width in relation to text width is not natively supported
1513+ by docbook but is by the docbook `fo` stylesheets through an XML
1514+ processing instruction, `<?dbfo table-width="50%"?>`.
1515+
1516+ * LaTeX reader:
1517+
1518+ + Improve parsing of command options (#6869, #6873).
1519+ In cases where we run into trouble parsing inlines til the
1520+ closing `]`, e.g. quotes, we return a plain string with the
1521+ option contents. Previously we mistakenly included the brackets
1522+ in this string.
1523+ + Preserve center environment (#6852, Igor Pashev).
1524+ The contents of the `center` environment are put in a `Div`
1525+ with class `center`.
1526+ + Don't parse `\rule` with width 0 as horizontal rule. These are
1527+ sometimes used as spacers in LaTeX.
1528+ + Don't apply theorem default styling to a figure inside (#6925).
1529+ If we put an image in italics, then when rendering to Markdown
1530+ we no longer get an implicit figure.
1531+
1532+ * Dokuwiki reader:
1533+
1534+ + Handle unknown interwiki links better (#6932).
1535+ DokuWiki lets the user define his own Interwiki links. Previously
1536+ pandoc reacted to these by emitting a google search link, which is
1537+ not helpful. Instead, we now just emit the full URL including the
1538+ wikilink prefix, e.g. `faquk>FAQ-mathml`. This at least gives users
1539+ the ability to modify the links using filters.
1540+
1541+ * Markdown writer:
1542+
1543+ + Properly handle boolean values in writing YAML metadata (#6388).
1544+ + Ensure that a new csl-block begins on a new line (#6921).
1545+ This just looks better and doesn't affect the semantics.
1546+
1547+ * RST writer:
1548+
1549+ + Better image handling (#6948). An image alone in its paragraph
1550+ (but not a figure) is now rendered as an independent image, with an
1551+ `alt` attribute if a description is supplied. An inline image that
1552+ is not alone in its paragraph will be rendered, as before, using a
1553+ substitution. Such an image cannot have a "center", "left", or
1554+ "right" alignment, so the classes `align-center`, `align-left`, or
1555+ `align-right` are ignored. However, `align-top`, `align-middle`,
1556+ `align-bottom` will generate a corresponding `align` attribute.
1557+
1558+ * Docx writer:
1559+
1560+ + Keep raw openxml strings verbatim (#6933, Albert Krewinkel).
1561+ + Use Content instead of Element. This allows us to inject
1562+ raw OpenXML into the document without reparsing it into an
1563+ Element, which is necessary if you want to inject an open
1564+ tag or close tag.
1565+ + Fix bullets/lists indentation, so that the first level is slightly
1566+ indented to the right instead of right on the margin (cholonam).
1567+ + Support bold and italic in "complex script" (#6911).
1568+ Previously bold and italics didn't work properly in LTR
1569+ text. This commit causes the w:bCs and w:iCs attributes
1570+ to be used, in addition to w:b and w:i, for bold and
1571+ italics respectively.
1572+
1573+ * ICML writer:
1574+
1575+ + Fix image bounding box for custom widths/heighta (Mauro Bieg, #6936).
1576+
1577+ * LaTeX writer:
1578+
1579+ + Improve table spacing (#6842, #6860).
1580+ Remove the `\strut` that was added at the end of minipage
1581+ environments in cells. Replace `\tabularnewline` with
1582+ `\\ \addlinespace`.
1583+ + Improve calculation of column spacing (#6883).
1584+ + Extract table handling into separate module (Albert Krewinkel).
1585+ + Fix bug with nested `csl-` display Spans (#6921).
1586+ + Improve longtable output (#6883). Don't create minipages for
1587+ regular paragraphs. Put width and alignment information in the
1588+ longtable column descriptors.
1589+
1590+ * OpenDocument writer:
1591+
1592+ + Support for table width as a percentage of text width
1593+ (#6792, Nils Carson).
1594+ + Implement Div and Span ident support (#6755, Nils Carson).
1595+ Spans and Divs containing an ident in the Attr will become bookmarks
1596+ or sections with idents in OpenDocument format.
1597+ + Add two extensions, `xrefs_name` and `xrefs_number` (#6774, Nils
1598+ Carlson). Links to headings, figures and tables inside the
1599+ document are substituted with cross-references that will use the
1600+ name or caption of the referenced item for `xrefs_name` or the
1601+ number for `xrefs_number`. For the `xrefs_number` to be useful
1602+ heading numbers must be enabled in the generated document and
1603+ table and figure captions must be enabled using for example the
1604+ `native_numbering` extension. In order for numbers and reference
1605+ text to be updated the generated document must be refreshed.
1606+
1607+ * JATS writer:
1608+
1609+ + Support advanced table features (Albert Krewinkel).
1610+ + Support author affiliations (#6687, Albert Krewinkel).
1611+
1612+ * Docbook writer:
1613+
1614+ + Use correct id attribute consistently (Jan Tojnar).
1615+ DocBook5 should always use `xml:id` instead of `id`.
1616+ + Handle admonition titles better (Jan Tojnar).
1617+ Docbook reader produces a `Div` with `title` class for `<title>`
1618+ element within an “admonition” element. Markdown writer then turns
1619+ this into a fenced div with `title` class attribute. Since fenced
1620+ divs are block elements, their content is recognized as a
1621+ paragraph by the Markdown reader. This is an issue for Docbook
1622+ writer because it would produce an invalid DocBook document from
1623+ such AST – the `<title>` element can only contain “inline”
1624+ elements. Handle this special case separately by unwrapping
1625+ the paragraph before creating the `<title>` element.
1626+ + Add XML namespaces to top-level elements (#6923, Jan Tojnar).
1627+ Previously, we only added `xmlns` attributes to chapter
1628+ elements, even when running with `--top-level-division=section`.
1629+ These namespaces are now added to part and section elements too,
1630+ when they are the selected top-level divisions.
1631+ We do not need to add namespaces to documents produced with
1632+ `--standalone` flag, since those will already have xmlns attribute on
1633+ the root element in the template.
1634+
1635+ * HTML writer:
1636+
1637+ + Fix handling of nested `csl-` display spans (#6921).
1638+ Previously inner Spans used to represent CSL display attributes were
1639+ not rendered as div tags as intended.
1640+
1641+ * EPUB writer:
1642+
1643+ + Include title page in landmarks (#6919).
1644+ Note that the toc is also included if `--toc` is specified.
1645+ + Add frontmatter type on body element for nav.xhtml (#6918).
1646+
1647+ * EPUB templates: use preserveAspectRatio="xMidYMid" for cover image (#6895,
1648+ Shin Sang-jae). This change affects both the epub2 and the epub3
1649+ templates. It avoids distortion of the cover image by requiring that the
1650+ aspect ratio be preserved.
1651+
1652+ * LaTeX template:
1653+
1654+ + Include `csquotes` package if `csquotes` variable set.
1655+ + Put back `amssymb`. We need it for checkboxes in todo lists,
1656+ and maybe for other things. In this location it seems compatible
1657+ with the cases that prompted #6469 and PR #6762.
1658+ + Disable language-specific shorthands in babel (#6817, #6887).
1659+ Babel defines "shorthands" for some languages, and these can
1660+ produce unexpected results. For example, in Spanish, `1.22`
1661+ gets rendered as `122`, and `et~al.` as `etal`.
1662+ One would think that babel's `shorthands=off` option (which
1663+ we were using) would disable these, but it doesn't. So we
1664+ remove `shorthands=off` and add some code that redefines
1665+ the shorthands macro. Eventually this will be fixed in babel,
1666+ I hope, and we can revert to something simpler.
1667+
1668+ * JATS template: allow array of persistent institute ids in `pid`
1669+ (Albert Krewinkel).
1670+
1671+ * Text.Pandoc.Parsing: minor code and efficiency improvements.
1672+
1673+ * Text.Pandoc.Extension:
1674+
1675+ + Add `Ext_sourcepos` constructor for `Extension` [API change].
1676+ + Add `Ext_xrefs_name` and `Ext_xrefs_number` constructors for
1677+ `Extension` (Nils Carson) [API change].
1678+
1679+ * Text.Pandoc.Citeproc:
1680+
1681+ + Fix truncation of `[Citation]` list in `Cite` inside footnotes (#6890).
1682+ This affected author-in-text citations in footnotes. It didn't cause
1683+ problems for the printed output, but for filters that expected the
1684+ citation id and other information.
1685+ + Allow the use of both inline and external references (#6951),
1686+ as with pandoc-citeproc. References defined in the document's
1687+ metadata take priority over references with the same id defined in
1688+ an external bibliography.
1689+ + Use `fetchItem` to get external bibliography (#6940).
1690+ + Ensure that BCP47 lang codes can be used. We ignore the variants
1691+ and just use the base lang code and country code when passing off
1692+ to citeproc.
1693+ + Citeproc BibTeX parser: revert change in `getRawField`
1694+ which was made (for reasons forgotten) when transferring
1695+ this code from pandoc-citeproc. The change led to `--` in
1696+ URLs being interpreted as en-dashes, which is unwanted (#6874).
1697+
1698+ * Text.Pandoc.ImageSize:
1699+
1700+ + Default to DPI 72 if the format specifies DPI of 0 (#6880).
1701+ This shouldn't happen, in general, but it can happen with
1702+ JPEGs that don't conform to the spec. Having a DPI of 0
1703+ will blow up size calculations (division by 0).
1704+ + ImageSize: use JuicyPixels to determine size for png, jpeg, and
1705+ gif, instead of doing our own binary parsing (#6936). This
1706+ gives more reliable results.
1707+
1708+ * Text.Pandoc.CSS:
1709+
1710+ + Remove `foldOrElse` (internal module) (Albert Krewinkel).
1711+
1712+ * Use skylighting 0.10.2 (#6625).
1713+
1714+ * Use citeproc 0.3. This fixes issues with references with
1715+ duplicate ids (jgm/citeproc#36).
1716+
1717+ * Use doctemplates 0.9. This fixes issues with boolean
1718+ metadata values in the Markdown writer (#6388)
1719+ and in `meta-json` (#6650). It also fixes
1720+ issues with nested for loops in templates.
1721+
1722+ * Add translations zh-Hans.yaml and zh-Hant.yaml (#6904, #6909,
1723+ Kolen Cheung, taotieren).
1724+
1725+ * Add tests: True to cabal.project.
1726+ This fixes some CI failures for cabal.
1727+
1728+ * Normalize test/tables/*.native (#6888, Kolen Cheung).
1729+
1730+ * Move executable to `app` directory to avoid problems with cabal repl.
1731+
1732+ * CONTRIBUTING: add section "How can I help?" (#6892, Albert Krewinkel).
1733+ Also adds a paragraph aimed at highlighting the importance of feature
1734+ maintenance.
1735+
1736+ * MANUAL: Document that --number-sections works in `ms` (#6935).
1737+
1738+
1739+## pandoc 2.11.2 (2020-11-19)
1740+
1741+ * Default to using ATX (`##`-style) headings for Markdown output
1742+ (#6662, Aner Lucero). Previously we used Setext (underlined) headings
1743+ by default for levels 1--2.
1744+
1745+ * Add option `--markdown-headings=atx|setext`, and deprecate
1746+ `--atx-headers` (#6662, Aner Lucero).
1747+
1748+ * Support `markdown-headings` in defaults files.
1749+
1750+ * Fix corner case in YAML metadata parsing (#6823). Previously YAML
1751+ metadata would sometimes not get recognized if a field ended with a
1752+ newline followed by spaces.
1753+
1754+ * `--self-contained`: increase coverage (#6854).
1755+ Previously we only self-contained attributes for certain tag names
1756+ (`img`, `embed`, `video`, `input`, `audio`, `source`, `track`,
1757+ `section`). Now we self-contain any occurrence of `src`,
1758+ `data-src`, `poster`, or `data-background-image`, on any tag; and
1759+ also `href` on `link` tags.
1760+
1761+ * Markdown reader:
1762+
1763+ + Fix detection of locators following in-text citations.
1764+ Prevously, if we had `@foo [p. 33; @bar]`, the `p. 33` would be
1765+ incorrectly parsed as a prefix of `@bar` rather than a suffix of
1766+ `@foo`.
1767+ + Improve period suppression algorithm for citations in notes
1768+ in note citation styles (#6835).
1769+ + Don't increment `stateNoteNumber` for example list references.
1770+ This helps with #6836 (a bug in which example list references
1771+ disturb calculation of citation note number and affect when
1772+ `ibid` is triggered).
1773+
1774+ * LaTeX reader:
1775+
1776+ + Move `getNextNumber` from Readers.LaTeX to Readers.LaTeX.Parsing.
1777+ + Fix negative numbers in siunitx commands. A change in pandoc 2.11
1778+ broke negative numbers, e.g. `\SI{-33}{\celcius}` or `\num{-3}`.
1779+ This fixes the regression.
1780+
1781+ * DocBook reader: drop period in formalpara title
1782+ and put it in a div with class `formalpara-title`, so that
1783+ people can reformat with filters (#6562).
1784+
1785+ * Man reader: improve handling of `.IP` (#6858). We now better handle
1786+ `.IP` when it is used with non-bullet, non-numbered lists, creating a
1787+ definition list. We also skip blank lines like groff itself.
1788+
1789+ * Bibtex reader: fall back on `en-US` if locale for LANG not found.
1790+ This reproduces earlier pandoc-citeproc behavior (jgm/citeproc#26).
1791+
1792+ * JATS writer:
1793+
1794+ + Wrap all tables (Albert Krewinkel).
1795+ All `<table>` elements are put inside `<table-wrap>` elements, as the
1796+ former are not valid as immediate child elements of `<body>`.
1797+ + Move Table handling to separate module (Albert Krewinkel).
1798+ Adds two new unexported modules:
1799+ Text.Pandoc.Writers.JATS.Types, Text.Pandoc.Writers.JATS.Table.
1800+
1801+ * Org writer:
1802+
1803+ + Replace org #+KEYWORDS with #+keywords (TEC).
1804+ As of ~2 years ago, lower case keywords became the standard (though
1805+ they are handled case insensitive, as always).
1806+ + Update org supported languages and identifiers according to the
1807+ current list contained in
1808+ <https://orgmode.org/worg/org-contrib/babel/languages/index.html>
1809+ (TEC).
1810+
1811+ * Only use `filterIpynbOutput` if input format is ipynb (#6841).
1812+ Before this change content could go missing from divs with class
1813+ `output`, even when non-ipynb was being converted.
1814+
1815+ * When checking reader/writer name, check base name now that we permit
1816+ extensions on formats other than markdown.
1817+
1818+ * Text.Pandoc.PDF: Fix `changePathSeparators` for Windows (#6173).
1819+ Previously a path beginning with a drive, like `C:\foo\bar`, was
1820+ translated to `C:\/foo/bar`, which caused problems.
1821+ With this fix, the backslashes are removed.
1822+
1823+ * Text.Pandoc.Logging:
1824+
1825+ + Add constructor `ATXHeadingInLHS` to `LogMessage` [API change].
1826+ + Add constructor `EnvironmentVariableUndefined` to
1827+ `LogMessage` [API change].
1828+
1829+ * Fix error that is given when people specify `doc` output (#6834,
1830+ gison93).
1831+
1832+ * LaTeX template: add a `\break` after parbox in `CSLRightInline`.
1833+ This should fix spacing problems between entries with numeric styles.
1834+ Also fix number of params on `CSLReferences`.
1835+
1836+ * reveal.js template: Put quotes around `controlsLayout`,
1837+ `controlsBackArrows`, and `display`, since these require strings.
1838+ Add `showSlideNumber`, `hashOneBasedIndex`, `pause`.
1839+
1840+ * Use citeproc 0.2. This fixes a bug with title case around parentheses.
1841+
1842+ * pandoc.cabal: remove 'static' flag.
1843+ This isn't really necessary and can be misleading (e.g. on macOS,
1844+ where a fully static build isn't possible). cabal's new option
1845+ `--enable-executable-static` does the same. On stack you can add
1846+ something like this to the options for your executable in package.yaml:
1847+
1848+ ld-options: -static -pthread
1849+
1850+ * Remove obsolete bibutils flag setting in `linux/make_artifacts.sh`.
1851+
1852+ * Manual:
1853+
1854+ + Correct `link-citation` -> `link-citations`.
1855+ + Add a sentence about `pagetitle` for HTML (#6843, Alex Toldaiev).
1856+
1857+ * INSTALL.md: Remove references to `pandoc-citeproc` (#6857).
1858+
1859+ * CONTRIBUTING: describe hlint and how it's used (#6840, Albert
1860+ Krewinkel).
1861+
1862+## pandoc 2.11.1.1 (2020-11-07)
1863+
1864+ * Citeproc: improve punctuation in in-text note citations (#6813).
1865+ Previously in-text note citations inside a footnote would sometimes have
1866+ the final period stripped, even if it was needed (e.g. on the end of
1867+ 'ibid').
1868+
1869+ * Use citeproc 0.1.1.1. This improves the decision about when
1870+ to use `ibid` in cases where citations are used inside
1871+ a footnote (#6813).
1872+
1873+ * Support `nocase` spans for `csljson` output.
1874+
1875+ * Require latest commonmark, commonmark-extensions.
1876+ This fixes a bug with `autolink_bare_uris` and commonmark.
1877+
1878+ * LaTeX reader: better handling of `\\` inside math in table cells (#6811).
1879+
1880+ * DokuWiki writer: translate language names for code elements
1881+ and improve whitespace (#6807).
1882+
1883+ * MediaWiki writer: use `syntaxhighlight` tag instead of deprecated
1884+ `source` for highlighted code (#6810). Also support `startFrom`
1885+ attribute and `numberLines`.
1886+
1887+ * Lint code in PRs and when committing to master (#6790,
1888+ Albert Krewinkel).
1889+
1890+ * doc/filters.md: describe technical details of filter invocations (#6815,
1891+ Albert Krewinkel).
1892+
1893+
1894+## pandoc 2.11.1 (2020-11-03)
1895+
1896+ * DocBook Reader: fix duplicate bibliography bug (#6773, Nils Carlson).
1897+
1898+ * HTML reader:
1899+
1900+ + Parse contents of iframes (#6770).
1901+ + Parse inline svg as image unless `raw_html` is set in the reader (in
1902+ which case the svg is passed through as raw HTML) (#6770).
1903+
1904+ * LaTeX reader:
1905+
1906+ + Fix bug parsing macro arguments (#6796). If `\cL` is
1907+ defined as `\mathcal{L}`, and `\til` as `\tilde{#1}`, then
1908+ `\til\cL` should expand to `\tilde{\mathcal{L}}`, but
1909+ pandoc was expanding it to `\tilde\mathcal{L}`. This is
1910+ fixed by parsing the arguments in "verbatim mode" when the
1911+ macro expands arguments at the point of use.
1912+ + Properly support optional (cite) argument for
1913+ `\blockquote` from `csquotes` (#6802).
1914+
1915+ * LaTeX writer: Improved calculation of table column widths.
1916+ We now have LaTeX do the calculation, using `\tabcolsep`.
1917+ So we should now have accurate relative column widths no
1918+ matter what the text width. The default template has been modified to load
1919+ the calc package if tables are used.
1920+
1921+ * HTML writer: Fix duplicate "class" attribute for table
1922+ rows (Andy Morris).
1923+
1924+ * Text.Pandoc.Filter: allow shorter YAML representation of Citeproc
1925+ (Albert Krewinkel). The map-based YAML representation of filters expects
1926+ `type` and `path` fields. The path field had to be present for all filter
1927+ types, but is not used for citeproc filters. The field can now be omitted
1928+ when type is "citeproc", as described in the MANUAL.
1929+
1930+ * Text.Pandoc.Error: Add `PandocBibliographyError` constructor
1931+ for `PandocError` [API change]. This ensures that bibliography parsing
1932+ errors generate messages that include the bibliography file name --
1933+ otherwise it can be quite mysterious where it is coming from.
1934+
1935+ * Citeproc: properly handle `csl` field with `data:` URI (#6783).
1936+ This is used with the JATS writer, so this fixes a regression
1937+ in pandoc 2.11 with JATS output and citeproc.
1938+
1939+ * Allow `citation-abbreviations` in defaults file.
1940+
1941+ * JATS templates: ensure `jats_publishing` output is valid
1942+ (Albert Krewinkel).
1943+
1944+ * LaTeX template: Fix `CSLRightInline`, so that it does not
1945+ run over the right margin.
1946+
1947+ * HTML template: default CSS tweaks (Mauro Bieg and John
1948+ MacFarlane).
1949+
1950+ - Fix margin before codeblock
1951+ - Add `monobackgroundcolor` variable, making the background color
1952+ and padding of code optional.
1953+ - Ensure that backgrounds from highlighting styles take precedence over
1954+ monobackgroundcolor
1955+ - Remove list markers from TOC
1956+ - Add margin-bottom where needed
1957+ - Remove italics from blockquote styling
1958+ - Change borders and spacing in tables to be more consistent with other
1959+ output formats
1960+ - Style h5, h6
1961+ - Set font-size for print media to 12pt.
1962+ - Reduce interline space.
1963+ - Reduce interparagraph space.
1964+ - Reduce line width.
1965+ - Remove the special `line-height: 1` for table cells.
1966+ - Remove the special line-height for pre.
1967+ - Ensure that there is a bit more space before a heading
1968+ than after.
1969+ - Slightly reduced space after title header.
1970+ - Add CSS example to MANUAL
1971+
1972+ * man template: Change comment that triggers `tbl` from
1973+ `.\"t` to `'\" t`, as specified in groff_man(7) (#6803).
1974+
1975+ * Use latest commonmark, commonmark-extensions.
1976+ This fixes a bug with nested blocks in footnotes with the
1977+ `footnote` extension to `commonmark`. See jgm/commonmark-hs#63.
1978+
1979+ * Citeproc: use comma for in-text citations inside footnotes.
1980+ When an author-in-text citation like `@foo` occurs in a footnote,
1981+ we now render it with: `AUTHOR NAME + COMMA + SPACE + REST`.
1982+ Previously we rendered: `AUTHOR NAME + SPACE + "(" + REST + ")"`.
1983+ This gives better results. Note that normal citations are still
1984+ rendered in parentheses.
1985+
1986+ * Use latest citeproc:
1987+
1988+ + citeproc no longer capitalizes notes, so we do it
1989+ in pandoc when appropriate.
1990+ + Closes #6783.
1991+
1992+ * Clarify manual on `--track-changes` (#6801).
1993+
1994+ * Add `doc/jats.md` to document pandoc's handling of JATS
1995+ (#6794, Albert Krewinkel).
1996+
1997+ * Fix code example in lua-filters.md (#6795).
1998+
1999+## pandoc 2.11.0.4 (2020-10-21)
2000+
2001+ * Commonmark writer: fix regression with fenced divs (#6768).
2002+ Starting with 2.10.1, fenced divs no longer render with
2003+ HTML div tags in commonmark output. This is a regression
2004+ due to our transition from cmark-gfm. This commit fixes it.
2005+
2006+ * Use released version of citeproc. (This fixes a mis-step
2007+ in the 2.11.0.3 release, which is now deprecated.)
2008+
2009+ * Use latest sylighting, with support for `groovy`.
2010+
2011+ * Document that --html-q-tags requires the smart extension on the reader
2012+ (#6766).
2013+
2014+## pandoc 2.11.0.3 (2020-10-20)
2015+
2016+ * Use latest citeproc (closes #6765). This fixes a problem with
2017+ author-in-text citations for references including both an author
2018+ and an editor. Previously, both were included in the text, but only
2019+ the author should be.
2020+
2021+ * With `--citeproc`, ensure that the final period is removed when
2022+ citations that occur in notes in note-based styles get put in
2023+ parentheses. See jgm/citeproc#20.
2024+
2025+ * Normalize rewritten image paths with `--extract-media` (#6761).
2026+ This change will avoid mixed paths like this one when
2027+ `--extract-media` is used with a Word file:
2028+ `![](C:\Git\TIJ4\Markdown/media/image30.wmf)`. Instead we'll get
2029+ `![](C:\Git\TIJ4\Markdown`media`image30.wmf)`.
2030+
2031+ * Modify `--version` output. Use space more efficiently and report the
2032+ citeproc and ipynb versions, along with skylighting, texmath, and
2033+ pandoc-types. Drop the word "default" before "user data directory."
2034+
2035+ * DocBook reader: bibliomisc and anchor support (#6754, Nils Carlson).
2036+ Also ensure that bibliodiv without a title no longer results in
2037+ an empty Header.
2038+
2039+ * ConTeXt template: adds `\setupinterlinespace` to fonts larger
2040+ than normal (#6763, Denis Maier).
2041+
2042+ * LaTeX template: Do not load amssymb if not needed (#6469, Angelo Peronio).
2043+ See <https://tex.stackexchange.com/a/549938>.
2044+
2045+ * Relax upper bound on hslua, allow hslua-1.3.* (Albert Krewinkel).
2046+
2047+ * MANUAL:
2048+
2049+ + Improve explanation of "indent" variable (#6767, Cyrus Yip).
2050+ + Remove org from list of input formats supporting raw_tex (#6753,
2051+ Nick Fleisher).
2052+
2053+
2054+## pandoc 2.11.0.2 (2020-10-15)
2055+
2056+ * Fix handling of `xdata` in bibtex/biblatex bibliographies (#6752).
2057+
2058+ * Fix some small typos in the API documentation (#6751, Michael Hoffmann).
2059+
2060+ * Require citeproc 0.1.0.2. This fixes a regression from pandoc-citeproc
2061+ involving spacing between components of a reference in certain styles
2062+ (e.g. `cell.csl`).
2063+
2064+ * Fix typos in comments, doc strings, error messages, and tests
2065+ (Albert Krewinkel, #6738).
2066+
2067+## pandoc 2.11.0.1 (2020-10-13)
2068+
2069+ * LaTeX reader: support more acronym commands (#6746):
2070+ `\acl`, `\aclp`, and capitalized versions of already
2071+ supported commands.
2072+
2073+ * Commonmark reader: add `pipe_table` extension *after* defaults (#6739).
2074+ Otherwise we get bad results for non-table, non-paragraph
2075+ lines containing pipe characters.
2076+
2077+ * Markdown writer: Fix autolinks rendering for gfm (#6740).
2078+ Previously, autolinks rendered as raw HTML, due to the
2079+ `class="uri"` added by pandoc's markdown reader.
2080+
2081+ * LaTeX writer:
2082+
2083+ + Escape option values in lstlistings environment (#6742).
2084+ + Fix handling of `lang` `pt-BR` (#2953). For polyglossia we now
2085+ use `\setmainlanguage[variant=brazilian]{portuguese}` and for babel
2086+ `\usepackage[shorthands=off,main=brazilian]{babel}`.
2087+
2088+ * Depend on latest citeproc (0.1.0.1).
2089+
2090+ + This fixes the citation number issue with ieee.csl and other
2091+ styles that do not explicitly sort bibliographies (#6741). (Pandoc
2092+ was numbering them by their order in the bibliography file,
2093+ rather than the order cited, as required by the CSL spec.)
2094+ + Fixes groupin/collapsing with citation items with prefixes.
2095+
2096+ * default.latex: fix `CSLReference` macro definition.
2097+
2098+ * Fix MANUAL.txt CSL JSON conversion examples.
2099+
2100+ * Fix spelling errors in changelog, MANUAL.txt, `doc/org.md` (#6738).
2101+
2102+
32103## pandoc 2.11 (2020-10-11)
42104
52105 * Add `--citeproc` (`-C`) option to trigger built-in citation processing.
@@ -30,8 +2130,8 @@
302130 - Some of the bibliography formats supported by pandoc-citeproc (via
312131 hs-bibutils) are no longer supported: Copac, EndNote,
322132 ISI, MEDLINE, MODS, and RIS. If you use one of these formats,
33− you may use the `bibutils` utility to convert to CSL JSON
34− or BibTeX. We now support only BibTeX, BibLaTeX, CSL JSON,
2133+ you may use the `bibutils` utility to convert to BibLaTeX.
2134+ We now support only BibTeX, BibLaTeX, CSL JSON,
352135 and pandoc's YAML/Markdown analogue of CSL JSON.
362136
372137 - pandoc-citeproc would always retrieve the independent parent
@@ -267,8 +2367,8 @@
2672367 * Add data files needed for Text.Pandoc.Citeproc: these include
2682368 `default.csl` in the data directory and a `citeproc` directory that
2692369 is only used at compile-time for biblatex localizations. Note that we've
270− added `file-embed` as a mandatory rather than a conditional depedency,
271− because of the biblatex localization files.
2370+ added `file-embed` as a mandatory rather than a conditional
2371+ dependency, because of the biblatex localization files.
2722372
2732373 * Lua filters:
2742374
@@ -505,7 +2605,7 @@
5052605 * Ms writer:
5062606
5072607 + Fix code highlighting with blank lines. Previously blank lines
508− were simply omitted from highligted code.
2608+ were simply omitted from highlighted code.
5092609 + Escape starting periods in ms writer code blocks (#6505, Michael
5102610 Hoffmann). If a line of ms code block output starts with a period (.),
5112611 it should be prepended by `\&` so that it is not interpreted as a roff
@@ -968,7 +3068,7 @@
9683068 * Make it possible to compile using Stack on NixOS (#6439, Mathieu
9693069 Boespflug).
9703070
971− * CI action to check for commit messsage length (Nikolay Yakimov, #6398).
3071+ * CI action to check for commit message length (Nikolay Yakimov, #6398).
9723072
9733073
9743074## pandoc 2.9.2.1 (2020-03-23)
@@ -1535,7 +3635,7 @@
15353635 The main impact of this change is better reflowing of
15363636 content interpolated into templates. Previously,
15373637 interpolated variables were rendered independently and
1538− intepolated as strings, which could lead to overly long
3638+ interpolated as strings, which could lead to overly long
15393639 lines. Now the templates interpolated as Doc values which
15403640 may include breaking spaces, and reflowing occurs after
15413641 template interpolation rather than before.
@@ -2014,7 +4114,7 @@
20144114 a margin and font size according to their level.
20154115 Furthermore this commit allows changing the font with which code is
20164116 formatted via the `monofont` option.
2017− + Start numbering at appopriate numbers (Jesse Rosenthal, #5709).
4117+ + Start numbering at appropriate numbers (Jesse Rosenthal, #5709).
20184118 Starting numbers for ordered lists were previously ignored. Now
20194119 we specify the number if it is something other than 1.
20204120
@@ -3333,7 +5433,7 @@
33335433 * Man/Ms writers: Don't escape `-` as `\-`. The `\-` gets rendered
33345434 in HTML and PDF as a unicode minus sign.
33355435
3336− * Ms writer: Ensure we have a newline after .EN in disply math (#5251).
5436+ * Ms writer: Ensure we have a newline after .EN in display math (#5251).
33375437
33385438 * RST writer: Don't wrap simple table header lines (#5128).
33395439
@@ -3465,7 +5565,7 @@
34655565 + Set default listings language for lua, assembler (#5227, John
34665566 MacFarlane). Otherwise we get an error when trying to compile code
34675567 with lua or assembler code. To change the default dialect
3468− (currenty 5.3 for lua and x86masm for assembler), you can use
5568+ (currently 5.3 for lua and x86masm for assembler), you can use
34695569 `--include-in-header` to inject something like
34705570 `\lstset{defaultdialect=[5.2]Lua}`.
34715571
@@ -7162,7 +9262,7 @@
71629262
71639263 * Removed `hard_line_breaks` extension from `markdown_github` (#3594).
71649264 GitHub has two Markdown modes, one for long-form documents like READMEs
7165− and one for short things like issue coments. In issue comments, a line
9265+ and one for short things like issue comments. In issue comments, a line
71669266 break is treated as a hard line break. In README, wikis, etc., it is
71679267 treated as a space as in regular Markdown. Since pandoc is more likely to
71689268 be used to convert long-form documents from GitHub Markdown,
@@ -7515,7 +9615,7 @@
75159615 top-level `Text.Pandoc` module.
75169616
75179617 + Changed `StringWriter` -> `TextWriter`.
7518− + `getWriter` now retuns a pair of a reader and
9618+ + `getWriter` now returns a pair of a reader and
75199619 `Extensions`, instead of building the extensions into the
75209620 reader (#3659). The calling code must explicitly set
75219621 `readerExtensions` using the `Extensions` returned. The
@@ -8467,7 +10567,7 @@
846710567 + Use `unicode-math` (Vaclav Haisman). Use `mathspec` with only
846810568 XeLaTeX on request.
846910569 + Don't load `fontspec` before `unicode-math` (over there).
8470− The `unicode-math` package loads `fontspec` so explict loading of
10570+ The `unicode-math` package loads `fontspec` so explicit loading of
847110571 `fontspec` before `unicode-math` is not necessary.
847210572 + Use `unicode-math` by default in default.latex template. mathspec will
847310573 be used in xelatex if the `mathspec` variable is set; otherwise
@@ -9148,7 +11248,7 @@
914811248 is now used in parsing RST and Markdown line blocks, DocBook
914911249 `linegroup`/`line` combinations, and Org-mode `VERSE` blocks.
915011250 Previously `Para` blocks with hard linebreaks were used. `LineBlock`s
9151− are handled specially in the following ouput formats: AsciiDoc
11251+ are handled specially in the following output formats: AsciiDoc
915211252 (as `[verse]` blocks), ConTeXt (`\startlines`/`\endlines`),
915311253 HTML (`div` with a style), Markdown (line blocks if `line_blocks`
915411254 is enabled), Org-mode (`VERSE` blocks), RST (line blocks). In
@@ -9295,7 +11395,7 @@
929511395 comma-separated list.
929611396 + Give precedence to later meta lines. The last meta-line of any given
929711397 type is the significant line. Previously the value of the first line
9298− was kept, even if more lines of the same type were encounterd.
11398+ was kept, even if more lines of the same type were encountered.
929911399 + Read LaTeX_header as header-includes. LaTeX-specific header commands
930011400 can be defined in `#+LaTeX_header` lines. They are parsed as
930111401 format-specific inlines to ensure that they will only show up in LaTeX
@@ -9343,7 +11443,7 @@
934311443 be able to figure out internal links to a header in a docx if the
934411444 anchor span was empty. We change that to read the inlines out of the
934511445 first anchor span in a header.
9346− + Let headers use exisiting id. Previously we always generated an id for
11446+ + Let headers use existing id. Previously we always generated an id for
934711447 headers (since they wouldn't bring one from Docx). Now we let it use an
934811448 existing one if possible. This should allow us to recurs through anchor
934911449 spans.
@@ -9922,7 +12022,7 @@
992212022 character. Empty rows where parsed as alignment rows and dropped from
992312023 the output.
992412024 + Fix spacing after LaTeX-style symbols.
9925− The org-reader was droping space after unescaped LaTeX-style symbol
12025+ The org-reader was dropping space after unescaped LaTeX-style symbol
992612026 commands: `\ForAll \Auml` resulted in `∀Ä` but should give `∀ Ä`
992712027 instead. This seems to be because the LaTeX-reader treats the
992812028 command-terminating space as part of the command. Dropping the trailing
@@ -10257,7 +12357,7 @@
1025712357
1025812358 * Entity handling fixes: improved handling of entities like
1025912359 `&lang;` that require a trailing semicolon. Allow uppercase
10260− `x` in numerical hexidecimal character references, working
12360+ `x` in numerical hexadecimal character references, working
1026112361 around a tagsoup bug.
1026212362
1026312363 * `stack.yaml` - use lts-4.0, but with older aeson to avoid excessive
@@ -11742,7 +13842,7 @@
1174213842 * `Text.Pandoc.Shared`:
1174313843
1174413844 + Make safeRead safe (#1801, Matthew Pickering).
11745− + Addded `mapLeft`, `hush` (Matthew Pickering).
13845+ + Added `mapLeft`, `hush` (Matthew Pickering).
1174613846
1174713847 * `Text.Pandoc.Pretty`:
1174813848
@@ -11810,7 +13910,7 @@
1181013910
1181113911 + Use `text:p` instead of `text:h` for title.
1181213912 Using `text:h` causes problems with numbering. Closes #2059.
11813− Thansk to @nkalvi for diagnosing this.
13913+ Thanks to @nkalvi for diagnosing this.
1181413914
1181513915 * reveal.js template:
1181613916
@@ -12076,7 +14176,7 @@
1207614176 * RST writer:
1207714177
1207814178 + Ensure blank line after figure.
12079− + Avoid exces whitespace after last list item (#1777).
14179+ + Avoid excess whitespace after last list item (#1777).
1208014180 + Wrap line blocks with spaces before continuations (#1656).
1208114181 + Fixed double-rendering of footnotes in RST tables (#1769).
1208214182
@@ -12138,7 +14238,7 @@
1213814238 + Renumber header and footer relationships to avoid collisions (Jesse
1213914239 Rosenthal). We previously took the old relationship names of the
1214014240 headers and footer in secptr. That led to collisions. We now make
12141− a map of availabl names in the relationships file, and then rename
14241+ a map of available names in the relationships file, and then rename
1214214242 in secptr.
1214314243
1214414244 * ConTeXt writer:
@@ -12861,7 +14961,7 @@
1286114961 different versions of the `directory` library.
1286214962
1286314963 + Added `Text.Pandoc.Compat.Except` to allow building against
12864− different verions of `mtl`.
14964+ different versions of `mtl`.
1286514965
1286614966 * Code cleanup in some writers, using Reader monad to avoid
1286714967 passing options parameter around (Matej Kollar).
@@ -14500,7 +16600,7 @@
1450016600 + Include HTML TOC, even in epub2. The TOC is included in `<spine>`,
1450116601 but `linear` is set to `no` unless the `--toc` option is specified.
1450216602 Include `<guide>` element in OPF. This should allow the TOC to
14503− be useable in Kindles when converted with kindlegen. Closes #773.
16603+ be usable in Kindles when converted with kindlegen. Closes #773.
1450416604
1450516605 * `Text.Pandoc.Parsing`: Optimized `oneOfStringsCI`.
1450616606 This dramatically reduces the speed penalty that comes from enabling the
@@ -15096,7 +17196,7 @@
1509617196 be a parenthesized emphasized "hello".
1509717197 The new list is taken from the PHP source of textile 2.4.
1509817198 + Fixed autolinks. Previously the textile reader and writer
15099− incorrectly implented RST-style autolinks for URLs and email
17199+ incorrectly implemented RST-style autolinks for URLs and email
1510017200 addresses. This has been fixed. Now an autolink is done this way:
1510117201 `"$":http://myurl.com`.
1510217202 + Fixed footnotes bug in textile. This affected notes occurring
@@ -16159,7 +18259,7 @@
1615918259 Items are no longer installed as root.
1616018260 Man pages are zipped and given proper permissions.
1616118261
16162− * Modified windows installer generater to use cabal-dev.
18262+ * Modified windows installer generator to use cabal-dev.
1616318263
1616418264 * Setup: Making man pages now works with cabal-dev (at least on OSX). In
1616518265 Setup.hs we now invoke 'runghc' in a way that points it to the correct
data/default.csl+12−2
@@ -27,6 +27,9 @@
2727 <email>matthew.g.roth@yale.edu</email>
2828 <uri> https://orcid.org/0000-0001-7902-6331</uri>
2929 </contributor>
30+ <contributor>
31+ <name>Brenton M. Wiernik</name>
32+ </contributor>
3033 <category citation-format="author-date"/>
3134 <category field="generic-base"/>
3235 <summary>The author-date variant of the Chicago style</summary>
@@ -509,8 +512,15 @@
509512 </choose>
510513 </macro>
511514 <macro name="event">
512− <group>
513− <text term="presented at" suffix=" "/>
515+ <group delimiter=" ">
516+ <choose>
517+ <if variable="genre">
518+ <text term="presented at"/>
519+ </if>
520+ <else>
521+ <text term="presented at" text-case="capitalize-first"/>
522+ </else>
523+ </choose>
514524 <text variable="event"/>
515525 </group>
516526 </macro>
data/docx/word/settings.xml+6−16
@@ -1,6 +1,6 @@
11<?xml version="1.0" encoding="UTF-8"?>
22<w:settings xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:sl="http://schemas.openxmlformats.org/schemaLibrary/2006/main">
3− <w:zoom w:percent="90" />
3+ <w:zoom w:percent="100" />
44 <w:embedSystemFonts />
55 <w:proofState w:spelling="clean" w:grammar="clean" />
66 <w:stylePaneFormatFilter w:val="0004" />
@@ -17,31 +17,21 @@
1717 <w:characterSpacingControl w:val="doNotCompress" />
1818 <w:savePreviewPicture />
1919 <w:rsids>
20− <w:rsidRoot w:val="00590D07" />
21− <w:rsid w:val="00011C8B" />
22− <w:rsid w:val="004E29B3" />
23− <w:rsid w:val="00590D07" />
24− <w:rsid w:val="00784D58" />
25− <w:rsid w:val="008D6863" />
26− <w:rsid w:val="00B86B75" />
27− <w:rsid w:val="00BC48D5" />
28− <w:rsid w:val="00C36279" />
29− <w:rsid w:val="00E315A3" />
3020 </w:rsids>
3121 <m:mathPr>
32− <m:mathFont m:val="Lucida Grande" />
22+ <m:mathFont m:val="Cambria Math" />
3323 <m:brkBin m:val="before" />
3424 <m:brkBinSub m:val="--" />
35− <m:smallFrac m:val="false" />
36− <m:dispDef m:val="false" />
25+ <m:smallFrac m:val="0" />
26+ <m:dispDef />
3727 <m:lMargin m:val="0" />
3828 <m:rMargin m:val="0" />
3929 <m:wrapRight />
4030 <m:intLim m:val="subSup" />
41− <m:naryLim m:val="subSup" />
31+ <m:naryLim m:val="undOvr" />
4232 </m:mathPr>
4333 <w:themeFontLang w:val="en-US" />
4434 <w:clrSchemeMapping w:bg1="light1" w:t1="dark1" w:bg2="light2" w:t2="dark2" w:accent1="accent1" w:accent2="accent2" w:accent3="accent3" w:accent4="accent4" w:accent5="accent5" w:accent6="accent6" w:hyperlink="hyperlink" w:followedHyperlink="followedHyperlink" />
4535 <w:decimalSymbol w:val="." />
4636 <w:listSeparator w:val="," />
47−</w:settings>
37+</w:settings>
data/docx/word/styles.xml+15
@@ -350,6 +350,21 @@
350350 <w:right w:w="108" w:type="dxa" />
351351 </w:tblCellMar>
352352 </w:tblPr>
353+ <w:tblStylePr w:type="firstRow">
354+ <w:tblPr>
355+ <w:jc w:val="left"/>
356+ <w:tblInd w:w="0" w:type="dxa"/>
357+ </w:tblPr>
358+ <w:trPr>
359+ <w:jc w:val="left"/>
360+ </w:trPr>
361+ <w:tcPr>
362+ <w:vAlign w:val="bottom"/>
363+ <w:tcBorders>
364+ <w:bottom w:val="single"/>
365+ </w:tcBorders>
366+ </w:tcPr>
367+ </w:tblStylePr>
353368 </w:style>
354369 <w:style w:type="paragraph" w:customStyle="1" w:styleId="DefinitionTerm">
355370 <w:name w:val="Definition Term" />
data/jats.csldeleted−203
@@ -1,203 +0,0 @@
1−<?xml version="1.0" encoding="utf-8"?>
2−<style xmlns="http://purl.org/net/xbiblio/csl" class="in-text" version="1.0" default-locale="en-US">
3− <info>
4− <title>Journal Article Tag Suite</title>
5− <title-short>JATS</title-short>
6− <id>http://www.zotero.org/styles/journal-article-tag-suite</id>
7− <link href="https://github.com/MartinPaulEve/JATS-CSL/blob/master/jats.csl" rel="self"/>
8− <link rel="documentation" href="http://jats.nlm.nih.gov/archiving/tag-library/1.0/index.html"/>
9− <author>
10− <name>Martin Paul Eve</name>
11− <email>martin@martineve.com</email>
12− </author>
13− <category citation-format="numeric"/>
14− <category field="medicine"/>
15− <category field="biology"/>
16− <summary>Use this style to generate bibliographic data in Journal Article Tagging Suite (JATS) 1.0 XML format</summary>
17− <updated>2014-06-21T17:41:26+00:00</updated>
18− <rights license="http://creativecommons.org/licenses/by-sa/3.0/">This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License. Originally by Martin Fenner.</rights>
19− </info>
20− <locale xml:lang="en">
21− <terms>
22− <term name="et-al">{{jats}}&lt;etal/&gt;{{/jats}}</term>
23− </terms>
24− </locale>
25− <macro name="citation-number">
26− <text variable="citation-number" prefix="{{jats}}id=&quot;ref-{{/jats}}" suffix="{{jats}}&quot;&gt;{{/jats}}"/>
27− </macro>
28− <macro name="author">
29− <names variable="author" delimiter=" ">
30− <name prefix="{{jats}}&lt;name&gt;{{/jats}}" suffix="{{jats}}&lt;/name&gt;{{/jats}}" name-as-sort-order="all" sort-separator=" ">
31− <name-part name="family" text-case="capitalize-first" prefix="{{jats}}&lt;surname&gt;{{/jats}}" suffix="{{jats}}&lt;/surname&gt;{{/jats}}"/>
32− <name-part name="given" text-case="capitalize-first" prefix="{{jats}}&lt;given-names&gt;{{/jats}}" suffix="{{jats}}&lt;/given-names&gt;{{/jats}}"/>
33− </name>
34− <substitute>
35− <names variable="editor"/>
36− </substitute>
37− </names>
38− </macro>
39−
40− <macro name="editor" delimiter=" ">
41− <names variable="editor" prefix="{{jats}}&lt;person-group person-group-type=&quot;editor&quot;&gt;{{/jats}}" suffix="{{jats}}&lt;/person-group&gt;{{/jats}}">
42− <name prefix="{{jats}}&lt;name&gt;{{/jats}}" suffix="{{jats}}&lt;/name&gt;{{/jats}}" name-as-sort-order="all" sort-separator=" ">
43− <name-part name="family" text-case="capitalize-first" prefix="{{jats}}&lt;surname&gt;{{/jats}}" suffix="{{jats}}&lt;/surname&gt;{{/jats}}"/>
44− <name-part name="given" text-case="capitalize-first" prefix="{{jats}}&lt;given-names&gt;{{/jats}}" suffix="{{jats}}&lt;/given-names&gt;{{/jats}}"/>
45− </name>
46− <substitute>
47− <names variable="editor"/>
48− </substitute>
49− </names>
50− </macro>
51−
52− <macro name="editor">
53− <group delimiter=": ">
54− <names variable="editor">
55− <name prefix="{{jats}}&lt;name&gt;{{/jats}}" suffix="{{jats}}&lt;/name&gt;{{/jats}}" name-as-sort-order="all" sort-separator="">
56− <name-part name="family" text-case="capitalize-first" prefix="{{jats}}&lt;surname&gt;{{/jats}}" suffix="{{jats}}&lt;/surname&gt;{{/jats}}"/>
57− <name-part name="given" text-case="capitalize-first" prefix="{{jats}}&lt;given-names&gt;{{/jats}}" suffix="{{jats}}&lt;given-names&gt;{{/jats}}"/>
58− </name>
59− </names>
60− </group>
61− </macro>
62− <macro name="title">
63− <choose>
64− <if type="book" match="any">
65− <group prefix="{{jats}}&lt;source&gt;{{/jats}}" suffix="{{jats}}&lt;/source&gt;{{/jats}}">
66− <text variable="title"/>
67− </group>
68− </if>
69− <else>
70− <group prefix="{{jats}}&lt;article-title&gt;{{/jats}}" suffix="{{jats}}&lt;/article-title&gt;{{/jats}}">
71− <text variable="title"/>
72− </group>
73− </else>
74− </choose>
75− </macro>
76− <macro name="container-title">
77− <text variable="container-title" form="short" prefix="{{jats}}&lt;source&gt;{{/jats}}" suffix="{{jats}}&lt;/source&gt;{{/jats}}"/>
78− </macro>
79− <macro name="publisher">
80− <text variable="publisher" prefix="{{jats}}&lt;publisher-name&gt;{{/jats}}" suffix="{{jats}}&lt;/publisher-name&gt;{{/jats}}"/>
81− <text variable="publisher-place" prefix="{{jats}}&lt;publisher-loc&gt;{{/jats}}" suffix="{{jats}}&lt;/publisher-loc&gt;{{/jats}}"/>
82− </macro>
83− <macro name="link">
84− <choose>
85− <if match="any" variable="DOI">
86− <group prefix="{{jats}}&lt;pub-id pub-id-type=&quot;doi&quot;&gt;{{/jats}}" suffix="{{jats}}&lt;/pub-id&gt;{{/jats}}">
87− <text variable="DOI"/>
88− </group>
89− </if>
90− </choose>
91− <choose>
92− <if match="any" variable="PMID">
93− <group prefix="{{jats}}&lt;pub-id pub-id-type=&quot;pmid&quot;&gt;{{/jats}}" suffix="{{jats}}&lt;/pub-id&gt;{{/jats}}">
94− <text variable="PMID"/>
95− </group>
96− </if>
97− </choose>
98− <choose>
99− <if variable="URL" match="any">
100− <text variable="URL" />
101− </if>
102− </choose>
103− </macro>
104− <macro name="date">
105− <choose>
106− <if type="article-journal article-magazine article-newspaper report patent book" match="any">
107− <group prefix="{{jats}}&lt;date&gt;{{/jats}}" suffix="{{jats}}&lt;/date&gt;{{/jats}}">
108− <date variable="issued">
109− <date-part name="day" form="numeric-leading-zeros" prefix="{{jats}}&lt;day&gt;{{/jats}}" suffix="{{jats}}&lt;/day&gt;{{/jats}}"/>
110− <date-part name="month" form="numeric-leading-zeros" prefix="{{jats}}&lt;month&gt;{{/jats}}" suffix="{{jats}}&lt;/month&gt;{{/jats}}"/>
111− <date-part name="year" prefix="{{jats}}&lt;year&gt;{{/jats}}" suffix="{{jats}}&lt;/year&gt;{{/jats}}"/>
112− </date>
113− </group>
114− </if>
115− <else>
116− <group prefix="{{jats}}&lt;date-in-citation content-type=&quot;access-date&quot;{{/jats}}" suffix="{{jats}}&lt;/date-in-citation&gt;{{/jats}}">
117− <date variable="accessed" prefix="{{jats}} iso-8601-date=&quot;{{/jats}}" suffix="{{jats}}&quot;&gt;{{/jats}}">
118− <date-part name="year"/>
119− <date-part name="month" form="numeric-leading-zeros" prefix="{{jats}}-{{/jats}}"/>
120− <date-part name="day" form="numeric-leading-zeros" prefix="{{jats}}-{{/jats}}"/>
121− </date>
122− <date variable="accessed">
123− <date-part name="day" prefix="{{jats}}&lt;day&gt;{{/jats}}" suffix="{{jats}}&lt;/day&gt;{{/jats}}"/>
124− <date-part name="month" form="numeric-leading-zeros" prefix="{{jats}}&lt;month&gt;{{/jats}}" suffix="{{jats}}&lt;/month&gt;{{/jats}}"/>
125− <date-part name="year" prefix="{{jats}}&lt;year&gt;{{/jats}}" suffix="{{jats}}&lt;/year&gt;{{/jats}}"/>
126− </date>
127− </group>
128− </else>
129− </choose>
130− </macro>
131− <macro name="location">
132− <choose>
133− <if type="article-journal article-magazine" match="any">
134− <text variable="volume" prefix="{{jats}}&lt;volume&gt;{{/jats}}" suffix="{{jats}}&lt;/volume&gt;{{/jats}}"/>
135− <text variable="issue" prefix="{{jats}}&lt;issue&gt;{{/jats}}" suffix="{{jats}}&lt;/issue&gt;{{/jats}}"/>
136− </if>
137− </choose>
138− <choose>
139− <if type="article-journal article-magazine article-newspaper chapter" match="any">
140− <text variable="page-first" prefix="{{jats}}&lt;fpage&gt;{{/jats}}" suffix="{{jats}}&lt;/fpage&gt;{{/jats}}"/>
141− </if>
142− </choose>
143− </macro>
144− <macro name="publication-type">
145− <group prefix="{{jats}} publication-type=&quot;{{/jats}}" suffix="{{jats}}&quot;&gt;{{/jats}}">
146− <choose>
147− <if type="article-journal article-magazine article-newspaper" match="any">
148− <text value="journal"/>
149− </if>
150− <else-if type="book" match="any">
151− <text value="book"/>
152− </else-if>
153− <else-if type="chapter" match="any">
154− <text value="bookchapter"/>
155− </else-if>
156− <else-if type="dataset" match="any">
157− <text value="dataset"/>
158− </else-if>
159− <else-if type="patent" match="any">
160− <text value="patent"/>
161− </else-if>
162− <else-if type="report" match="any">
163− <text value="report"/>
164− </else-if>
165− <else-if type="review" match="any">
166− <text value="review"/>
167− </else-if>
168− <else>
169− <text value="standard"/>
170− </else>
171− </choose>
172− </group>
173− </macro>
174− <citation collapse="citation-number">
175− <sort>
176− <key variable="citation-number"/>
177− </sort>
178− <layout delimiter=",">
179− <group prefix="{{jats}}&lt;xref ref-type=&quot;bibr&quot; rid=&quot;{{/jats}}" suffix="{{jats}}&lt;/xref&gt;{{/jats}}">
180− <text variable="citation-number" prefix="{{jats}}ref-{{/jats}}" suffix="{{jats}}&quot;&gt;{{/jats}}"/>
181− <text variable="citation-number"/>
182− </group>
183− </layout>
184− </citation>
185− <bibliography sort-separator="">
186− <layout>
187− <group prefix="{{jats}}&lt;ref {{/jats}}" suffix="{{jats}}&lt;/ref&gt;{{/jats}}">
188− <text macro="citation-number"/>
189− <group prefix="{{jats}}&lt;element-citation{{/jats}}" suffix="{{jats}}&lt;/element-citation&gt;{{/jats}}">
190− <text macro="publication-type"/>
191− <text macro="author" prefix="{{jats}}&lt;person-group person-group-type=&quot;author&quot;&gt;{{/jats}}" suffix="{{jats}}&lt;/person-group&gt;{{/jats}}"/>
192− <text macro="title" />
193− <text macro="container-title"/>
194− <text macro="editor"/>
195− <text macro="publisher"/>
196− <text macro="date"/>
197− <text macro="location"/>
198− <text macro="link"/>
199− </group>
200− </group>
201− </layout>
202− </bibliography>
203−</style>
data/make-reference-files.hsdeleted−27
@@ -1,27 +0,0 @@
1−import System.Environment
2−import System.Directory
3−import Codec.Archive.Zip
4−import qualified Data.ByteString.Lazy as BS
5−import qualified Control.Exception as E
6−import System.IO.Error (isDoesNotExistError)
7−import System.FilePath
8−
9−mkzip :: String -> IO ()
10−mkzip fmt = do
11− let dir = "data" </> fmt
12− output = "data" </> "reference" <.> fmt
13− cd <- getCurrentDirectory
14− setCurrentDirectory dir
15− archive <- addFilesToArchive [OptRecursive] emptyArchive ["."]
16− setCurrentDirectory cd
17− removeIfExists output
18− BS.writeFile output $ fromArchive archive
19−
20−removeIfExists :: FilePath -> IO ()
21−removeIfExists fileName = removeFile fileName `E.catch` handleExists
22− where handleExists e
23− | isDoesNotExistError e = return ()
24− | otherwise = E.throwIO e
25−
26−main :: IO ()
27−main = getArgs >>= mkzip . (!!0)
data/odt/styles.xml+1−1
@@ -350,7 +350,7 @@ xmlns:css3t="http://www.w3.org/TR/css3-text/" office:version="1.2">
350350 </style:style>
351351 <style:style style:name="First_20_paragraph"
352352 style:display-name="First paragraph" style:family="paragraph"
353− style:parent-style-name="Standard"
353+ style:parent-style-name="Text_20_body"
354354 style:next-style-name="Text_20_body" style:class="text" />
355355 <style:style style:name="Numbering_20_Symbols"
356356 style:display-name="Numbering Symbols" style:family="text" />
data/templates/.github/ISSUE_TEMPLATE.mddeleted−3
@@ -1,3 +0,0 @@
1−This repository is now maintained as a subtree of
2−[jgm/pandoc](https://github.com/jgm/pandoc). Please open
3−your issue there, not here.
data/templates/.github/PULL_REQUEST_TEMPLATE.mddeleted−4
@@ -1,4 +0,0 @@
1−This repository is now maintained as a subtree of
2−[jgm/pandoc](https://github.com/jgm/pandoc). Please open
3−your pull request there, not here.
4−
data/templates/README.markdowndeleted−49
@@ -1,49 +0,0 @@
1−The [pandoc-templates] repository contains default templates for [pandoc].
2−
3−If you use custom templates, we recommend forking this
4−repository, so that you can integrate changes to the default
5−templates in future pandoc releases.
6−
7−This repository is a subtree of [pandoc]; it will be updated
8−each time there is a new pandoc release. However, changes to
9−templates are made first in [pandoc]; thus, issues and pull
10−requests should be made [pandoc]'s issue tracker rather than
11−here.
12−
13−[pandoc]: https://github.com/jgm/pandoc
14−[pandoc-templates]: https://github.com/jgm/pandoc-templates
15−
16−All of the templates in this repository are dual licensed, under both
17−the GPL (v2 or higher, same as pandoc) and the BSD 3-clause license
18−(included below).
19−
20−Copyright (c) 2014--2019, John MacFarlane
21−
22−All rights reserved.
23−
24−Redistribution and use in source and binary forms, with or without
25−modification, are permitted provided that the following conditions are met:
26−
27−* Redistributions of source code must retain the above copyright
28− notice, this list of conditions and the following disclaimer.
29−
30−* Redistributions in binary form must reproduce the above
31− copyright notice, this list of conditions and the following
32− disclaimer in the documentation and/or other materials provided
33− with the distribution.
34−
35−* Neither the name of John MacFarlane nor the names of other
36− contributors may be used to endorse or promote products derived
37− from this software without specific prior written permission.
38−
39−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40−"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41−LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
42−A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
43−OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44−SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45−LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
46−DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
47−THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
48−(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
49−OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
data/templates/affiliations.jatsnew file+38
@@ -0,0 +1,38 @@
1+$--
2+$-- Affiliations
3+$--
4+$for(affiliation)$
5+<aff id="aff-$affiliation.id$">
6+$-- wrap affiliation if it has a known institution identifier
7+$if(affiliation.group)$
8+<institution content-type="group">$affiliation.group$</institution>
9+$endif$
10+$if(affiliation.department)$
11+<institution content-type="dept">$affiliation.department$</institution>
12+$endif$
13+<institution-wrap>
14+$if(affiliation.organization)$
15+<institution>$affiliation.organization$</institution>
16+$else$
17+<institution>$affiliation.name$</institution>
18+$endif$
19+$if(affiliation.isni)$
20+<institution-id institution-id-type="ISNI">$affiliation.isni$</institution-id>
21+$endif$
22+$if(affiliation.ringgold)$
23+<institution-id institution-id-type="Ringgold">$affiliation.ringgold$</institution-id>
24+$endif$
25+$if(affiliation.ror)$
26+<institution-id institution-id-type="ROR">$affiliation.ror$</institution-id>
27+$endif$
28+$for(affiliation.pid)$
29+<institution-id institution-id-type="$affiliation.pid.type$">$affiliation.pid.id$</institution-id>
30+$endfor$
31+</institution-wrap>$if(affiliation.street-address)$,
32+$for(affiliation.street-address)$
33+<addr-line>$affiliation.street-address$</addr-line>$sep$,
34+$endfor$
35+$else$$if(affiliation.city)$, <city>$affiliation.city$</city>$endif$$endif$$if(affiliation.country)$,
36+<country$if(affiliation.country-code)$ country="$affiliation.country-code$"$endif$>$affiliation.country$</country>$endif$
37+</aff>
38+$endfor$
data/templates/article.jats_publishing+23−7
@@ -14,6 +14,13 @@ $endif$
1414$if(journal.pmc)$
1515<journal-id journal-id-type="pmc">$journal.pmc$</journal-id>
1616$endif$
17+$-- Fallback: an empty journal-id in case none is available.
18+$if(journal.publisher-id)$
19+$elseif(journal.nlm-ta)$
20+$elseif(journal.pmc)$
21+$else$
22+<journal-id></journal-id>
23+$endif$
1724<journal-title-group>
1825$if(journal.title)$
1926<journal-title>$journal.title$</journal-title>
@@ -23,10 +30,16 @@ $if(journal.abbrev-title)$
2330$endif$
2431</journal-title-group>
2532$if(journal.pissn)$
26−<issn pub-type="ppub">$journal.pissn$</issn>
33+<issn publication-format="print">$journal.pissn$</issn>
2734$endif$
2835$if(journal.eissn)$
29−<issn pub-type="epub">$journal.eissn$</issn>
36+<issn publication-format="electronic">$journal.eissn$</issn>
37+$endif$
38+$-- At least one issn element is required; use empty issn as fallback
39+$if(journal.pissn)$
40+$elseif(journal.eissn)$
41+$else$
42+<issn></issn>
3043$endif$
3144<publisher>
3245<publisher-name>$journal.publisher-name$</publisher-name>
@@ -73,7 +86,7 @@ $endif$
7386$if(author)$
7487<contrib-group>
7588$for(author)$
76−<contrib contrib-type="author">
89+<contrib contrib-type="author"$if(author.equal-contrib)$ equal-contrib="true"$endif$>
7790$if(author.orcid)$
7891<contrib-id contrib-id-type="orcid">$author.orcid$</contrib-id>
7992$endif$
@@ -82,20 +95,23 @@ $if(author.surname)$
8295<surname>$author.surname$</surname>
8396<given-names>$author.given-names$</given-names>
8497</name>
98+$elseif(author.name)$
99+<string-name>$author.name$</string-name>
85100$else$
86101<string-name>$author$</string-name>
87102$endif$
88103$if(author.email)$
89104<email>$author.email$</email>
90105$endif$
91−$if(author.aff-id)$
92−<xref ref-type="aff" rid="aff-$contrib.aff-id$"/>
93−$endif$
106+$for(author.affiliation)$
107+<xref ref-type="aff" rid="aff-$author.affiliation$"/>
108+$endfor$
94109$if(author.cor-id)$
95110<xref ref-type="corresp" rid="cor-$author.cor-id$"><sup>*</sup></xref>
96111$endif$
97112</contrib>
98113$endfor$
114+${ affiliations.jats() }
99115</contrib-group>
100116$endif$
101117$if(article.author-notes)$
@@ -114,7 +130,7 @@ $endif$
114130</author-notes>
115131$endif$
116132$if(date)$
117−<pub-date pub-type="epub"$if(date.iso-8601)$ iso-8601-date="$date.iso-8601$"$endif$>
133+<pub-date date-type="$if(date.type)$$date.type$$else$pub$endif$" publication-format="electronic"$if(date.iso-8601)$ iso-8601-date="$date.iso-8601$"$endif$>
118134$if(date.day)$
119135<day>$date.day$</day>
120136$endif$
data/templates/default.biblatexnew file+10
@@ -0,0 +1,10 @@
1+$for(header-includes)$
2+$header-includes$
3+$endfor$
4+$for(include-before)$
5+$include-before$
6+$endfor$
7+$body$
8+$for(include-after)$
9+$include-after$
10+$endfor$
data/templates/default.bibtexnew file+10
@@ -0,0 +1,10 @@
1+$for(header-includes)$
2+$header-includes$
3+$endfor$
4+$for(include-before)$
5+$include-before$
6+$endfor$
7+$body$
8+$for(include-after)$
9+$include-after$
10+$endfor$
data/templates/default.context+10−8
@@ -51,6 +51,7 @@ $endif$
5151
5252% use microtypography
5353\definefontfeature[default][default][script=latn, protrusion=quality, expansion=quality, itlc=yes, textitalics=yes, onum=yes, pnum=yes]
54+\definefontfeature[default:tnum][default][tnum=yes, pnum=no]
5455\definefontfeature[smallcaps][script=latn, protrusion=quality, expansion=quality, smcp=yes, onum=yes, pnum=yes]
5556\setupalign[hz,hanging]
5657\setupitaliccorrection[global, always]
@@ -72,9 +73,9 @@ $if(interlinespace)$
7273\setupinterlinespace[$for(interlinespace)$$interlinespace$$sep$,$endfor$]
7374$endif$
7475
75−\setuphead[chapter] [style=\tfd,header=empty]
76−\setuphead[section] [style=\tfc]
77−\setuphead[subsection] [style=\tfb]
76+\setuphead[chapter] [style=\tfd\setupinterlinespace,header=empty]
77+\setuphead[section] [style=\tfc\setupinterlinespace]
78+\setuphead[subsection] [style=\tfb\setupinterlinespace]
7879\setuphead[subsubsection] [style=\bf]
7980\setuphead[subsubsubsection] [style=\sc]
8081\setuphead[subsubsubsubsection][style=\it]
@@ -97,11 +98,12 @@ $endif$
9798\setupitemize[autointro] % prevent orphan list intro
9899\setupitemize[indentnext=no]
99100
101+\defineitemgroup[enumerate]
102+\setupenumerate[each][fit][itemalign=left,distance=.5em,style={\feature[+][default:tnum]}]
103+
100104\setupfloat[figure][default={here,nonumber}]
101105\setupfloat[table][default={here,nonumber}]
102106
103−\setupthinrules[width=15em] % width of horizontal rules
104−
105107\setupxtable[frame=off]
106108\setupxtable[head][topframe=on,bottomframe=on]
107109\setupxtable[body][]
@@ -162,12 +164,12 @@ $endfor$
162164$if(toc)$
163165\completecontent
164166$endif$
165−$if(lot)$
166−\completelistoftables
167−$endif$
168167$if(lof)$
169168\completelistoffigures
170169$endif$
170+$if(lot)$
171+\completelistoftables
172+$endif$
171173
172174$body$
173175
data/templates/default.dzslides+1−1
@@ -171,7 +171,7 @@ $if(subtitle)$
171171 <h1 class="subtitle">$subtitle$</h1>
172172$endif$
173173 <footer>
174− $if(author)$<span class="author">$for(author)$$author$$sep$, $endfor$</span>$endif$ · $if(date)$<span class="date">$date$</span>$endif$
174+ $if(author)$<span class="author">$for(author)$$author$$sep$, $endfor$</span> · $endif$$if(institute)$<span class="institute">$for(institute)$$institute$$sep$, $endfor$</span> · $endif$$if(date)$<span class="date">$date$</span>$endif$
175175 </footer>
176176</section>
177177$endif$
data/templates/default.epub2+1−1
@@ -48,7 +48,7 @@ $endif$
4848$else$
4949$if(coverpage)$
5050<div id="cover-image">
51−<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="100%" height="100%" viewBox="0 0 $cover-image-width$ $cover-image-height$" preserveAspectRatio="none">
51+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="100%" height="100%" viewBox="0 0 $cover-image-width$ $cover-image-height$" preserveAspectRatio="xMidYMid">
5252<image width="$cover-image-width$" height="$cover-image-height$" xlink:href="../media/$cover-image$" />
5353</svg>
5454</div>
data/templates/default.epub3+1−1
@@ -49,7 +49,7 @@ $endif$
4949$else$
5050$if(coverpage)$
5151<div id="cover-image">
52−<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="100%" height="100%" viewBox="0 0 $cover-image-width$ $cover-image-height$" preserveAspectRatio="none">
52+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="100%" height="100%" viewBox="0 0 $cover-image-width$ $cover-image-height$" preserveAspectRatio="xMidYMid">
5353<image width="$cover-image-width$" height="$cover-image-height$" xlink:href="../media/$cover-image$" />
5454</svg>
5555</div>
data/templates/default.html4+3
@@ -12,6 +12,9 @@ $if(date-meta)$
1212$endif$
1313$if(keywords)$
1414 <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" />
15+$endif$
16+$if(description-meta)$
17+ <meta name="description" content="$description-meta$" />
1518$endif$
1619 <title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$</title>
1720 <style type="text/css">
data/templates/default.html5+3
@@ -12,6 +12,9 @@ $if(date-meta)$
1212$endif$
1313$if(keywords)$
1414 <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$" />
15+$endif$
16+$if(description-meta)$
17+ <meta name="description" content="$description-meta$" />
1518$endif$
1619 <title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$</title>
1720 <style>
data/templates/default.jats_articleauthoring+7−4
@@ -19,7 +19,7 @@ $endif$
1919$if(author)$
2020<contrib-group>
2121$for(author)$
22−<contrib contrib-type="author">
22+<contrib contrib-type="author"$if(author.equal-contrib)$ equal-contrib="true"$endif$>
2323$if(author.orcid)$
2424<contrib-id contrib-id-type="orcid">$author.orcid$</contrib-id>
2525$endif$
@@ -28,20 +28,23 @@ $if(author.surname)$
2828<surname>$author.surname$</surname>
2929<given-names>$author.given-names$</given-names>
3030</name>
31+$elseif(author.name)$
32+<string-name>$author.name$</string-name>
3133$else$
3234<string-name>$author$</string-name>
3335$endif$
3436$if(author.email)$
3537<email>$author.email$</email>
3638$endif$
37−$if(author.aff-id)$
38−<xref ref-type="aff" rid="aff-$contrib.aff-id$"/>
39−$endif$
39+$for(author.affiliation)$
40+<xref ref-type="aff" rid="aff-$author.affiliation$"/>
41+$endfor$
4042$if(author.cor-id)$
4143<xref ref-type="corresp" rid="cor-$author.cor-id$"><sup>*</sup></xref>
4244$endif$
4345</contrib>
4446$endfor$
47+${ affiliations.jats() }
4548</contrib-group>
4649$endif$
4750$if(copyright)$
data/templates/default.latex+78−44
@@ -2,7 +2,7 @@
22\PassOptionsToPackage{unicode$for(hyperrefoptions)$,$hyperrefoptions$$endfor$}{hyperref}
33\PassOptionsToPackage{hyphens}{url}
44$if(colorlinks)$
5−\PassOptionsToPackage{dvipsnames,svgnames*,x11names*}{xcolor}
5+\PassOptionsToPackage{dvipsnames,svgnames,x11names}{xcolor}
66$endif$
77$if(dir)$
88$if(latex-dir-rtl)$
@@ -89,6 +89,7 @@ $endif$
8989$if(beamerarticle)$
9090\usepackage{beamerarticle} % needs to be loaded first
9191$endif$
92+\usepackage{amsmath,amssymb}
9293$if(fontfamily)$
9394\usepackage[$for(fontfamilyoptions)$$fontfamilyoptions$$sep$,$endfor$]{$fontfamily$}
9495$else$
@@ -97,15 +98,14 @@ $endif$
9798$if(linestretch)$
9899\usepackage{setspace}
99100$endif$
100−\usepackage{amssymb,amsmath}
101−\usepackage{ifxetex,ifluatex}
102−\ifnum 0\ifxetex 1\fi\ifluatex 1\fi=0 % if pdftex
101+\usepackage{iftex}
102+\ifPDFTeX
103103 \usepackage[$if(fontenc)$$fontenc$$else$T1$endif$]{fontenc}
104104 \usepackage[utf8]{inputenc}
105105 \usepackage{textcomp} % provide euro and other symbols
106106\else % if luatex or xetex
107107$if(mathspec)$
108− \ifxetex
108+ \ifXeTeX
109109 \usepackage{mathspec}
110110 \else
111111 \usepackage{unicode-math}
@@ -129,7 +129,7 @@ $for(fontfamilies)$
129129$endfor$
130130$if(mathfont)$
131131$if(mathspec)$
132− \ifxetex
132+ \ifXeTeX
133133 \setmathfont(Digits,Latin,Greek)[$for(mathfontoptions)$$mathfontoptions$$sep$,$endfor$]{$mathfont$}
134134 \else
135135 \setmathfont[$for(mathfontoptions)$$mathfontoptions$$sep$,$endfor$]{$mathfont$}
@@ -139,23 +139,42 @@ $else$
139139$endif$
140140$endif$
141141$if(CJKmainfont)$
142− \ifxetex
142+ \ifXeTeX
143143 \usepackage{xeCJK}
144144 \setCJKmainfont[$for(CJKoptions)$$CJKoptions$$sep$,$endfor$]{$CJKmainfont$}
145145 \fi
146146$endif$
147147$if(luatexjapresetoptions)$
148− \ifluatex
148+ \ifLuaTeX
149149 \usepackage[$for(luatexjapresetoptions)$$luatexjapresetoptions$$sep$,$endfor$]{luatexja-preset}
150150 \fi
151151$endif$
152152$if(CJKmainfont)$
153− \ifluatex
153+ \ifLuaTeX
154154 \usepackage[$for(luatexjafontspecoptions)$$luatexjafontspecoptions$$sep$,$endfor$]{luatexja-fontspec}
155155 \setmainjfont[$for(CJKoptions)$$CJKoptions$$sep$,$endfor$]{$CJKmainfont$}
156156 \fi
157157$endif$
158158\fi
159+$if(zero-width-non-joiner)$
160+%% Support for zero-width non-joiner characters.
161+\makeatletter
162+\def\zerowidthnonjoiner{%
163+ % Prevent ligatures and adjust kerning, but still support hyphenating.
164+ \texorpdfstring{%
165+ \textormath{\nobreak\discretionary{-}{}{\kern.03em}%
166+ \ifvmode\else\nobreak\hskip\z@skip\fi}{}%
167+ }{}%
168+}
169+\makeatother
170+\ifPDFTeX
171+ \DeclareUnicodeCharacter{200C}{\zerowidthnonjoiner}
172+\else
173+ \catcode`^^^^200c=\active
174+ \protected\def ^^^^200c{\zerowidthnonjoiner}
175+\fi
176+%% End of ZWNJ support
177+$endif$
159178$if(beamer)$
160179$if(theme)$
161180\usetheme[$for(themeoptions)$$themeoptions$$sep$,$endfor$]{$theme$}
@@ -219,10 +238,10 @@ $if(keywords)$
219238$endif$
220239$if(colorlinks)$
221240 colorlinks=true,
222− linkcolor=$if(linkcolor)$$linkcolor$$else$Maroon$endif$,
223− filecolor=$if(filecolor)$$filecolor$$else$Maroon$endif$,
224− citecolor=$if(citecolor)$$citecolor$$else$Blue$endif$,
225− urlcolor=$if(urlcolor)$$urlcolor$$else$Blue$endif$,
241+ linkcolor={$if(linkcolor)$$linkcolor$$else$Maroon$endif$},
242+ filecolor={$if(filecolor)$$filecolor$$else$Maroon$endif$},
243+ citecolor={$if(citecolor)$$citecolor$$else$Blue$endif$},
244+ urlcolor={$if(urlcolor)$$urlcolor$$else$Blue$endif$},
226245$else$
227246 hidelinks,
228247$endif$
@@ -254,7 +273,11 @@ $if(highlighting-macros)$
254273$highlighting-macros$
255274$endif$
256275$if(tables)$
257−\usepackage{longtable,booktabs}
276+\usepackage{longtable,booktabs,array}
277+$if(multirow)$
278+\usepackage{multirow}
279+$endif$
280+\usepackage{calc} % for calculating minipage widths
258281$if(beamer)$
259282\usepackage{caption}
260283% Make caption package work with longtable
@@ -321,11 +344,36 @@ $endif$
321344$if(pagestyle)$
322345\pagestyle{$pagestyle$}
323346$endif$
347+$if(csl-refs)$
348+\newlength{\cslhangindent}
349+\setlength{\cslhangindent}{1.5em}
350+\newlength{\csllabelwidth}
351+\setlength{\csllabelwidth}{3em}
352+\newlength{\cslentryspacingunit} % times entry-spacing
353+\setlength{\cslentryspacingunit}{\parskip}
354+\newenvironment{CSLReferences}[2] % #1 hanging-ident, #2 entry spacing
355+ {% don't indent paragraphs
356+ \setlength{\parindent}{0pt}
357+ % turn on hanging indent if param 1 is 1
358+ \ifodd #1
359+ \let\oldpar\par
360+ \def\par{\hangindent=\cslhangindent\oldpar}
361+ \fi
362+ % set entry spacing
363+ \setlength{\parskip}{#2\cslentryspacingunit}
364+ }%
365+ {}
366+\usepackage{calc}
367+\newcommand{\CSLBlock}[1]{#1\hfill\break}
368+\newcommand{\CSLLeftMargin}[1]{\parbox[t]{\csllabelwidth}{#1}}
369+\newcommand{\CSLRightInline}[1]{\parbox[t]{\linewidth - \csllabelwidth}{#1}\break}
370+\newcommand{\CSLIndent}[1]{\hspace{\cslhangindent}#1}
371+$endif$
324372$for(header-includes)$
325373$header-includes$
326374$endfor$
327375$if(lang)$
328−\ifxetex
376+\ifXeTeX
329377 % Load polyglossia as late as possible: uses bidi with RTL langages (e.g. Hebrew, Arabic)
330378 \usepackage{polyglossia}
331379 \setmainlanguage[$for(polyglossia-lang.options)$$polyglossia-lang.options$$sep$,$endfor$]{$polyglossia-lang.name$}
@@ -333,21 +381,24 @@ $for(polyglossia-otherlangs)$
333381 \setotherlanguage[$for(polyglossia-otherlangs.options)$$polyglossia-otherlangs.options$$sep$,$endfor$]{$polyglossia-otherlangs.name$}
334382$endfor$
335383\else
336− \usepackage[shorthands=off,$for(babel-otherlangs)$$babel-otherlangs$,$endfor$main=$babel-lang$]{babel}
384+ \usepackage[$for(babel-otherlangs)$$babel-otherlangs$,$endfor$main=$babel-lang$]{babel}
385+% get rid of language-specific shorthands (see #6817):
386+\let\LanguageShortHands\languageshorthands
387+\def\languageshorthands#1{}
337388$if(babel-newcommands)$
338389 $babel-newcommands$
339390$endif$
340391\fi
341392$endif$
342−\ifluatex
393+\ifLuaTeX
343394 \usepackage{selnolig} % disable illegal ligatures
344395\fi
345396$if(dir)$
346−\ifxetex
397+\ifXeTeX
347398 % Load bidi as late as possible as it modifies e.g. graphicx
348399 \usepackage{bidi}
349400\fi
350−\ifnum 0\ifxetex 1\fi\ifluatex 1\fi=0 % if pdftex
401+\ifPDFTeX
351402 \TeXXeTstate=1
352403 \newcommand{\RL}[1]{\beginR #1\endR}
353404 \newcommand{\LR}[1]{\beginL #1\endL}
@@ -365,28 +416,11 @@ $for(bibliography)$
365416\addbibresource{$bibliography$}
366417$endfor$
367418$endif$
368−$if(csl-refs)$
369−\newlength{\cslhangindent}
370−\setlength{\cslhangindent}{1.5em}
371−\newlength{\csllabelwidth}
372−\setlength{\csllabelwidth}{3em}
373−\newenvironment{CSLReferences}[3] % #1 hanging-ident, #2 entry sp
374− {% don't indent paragraphs
375− \setlength{\parindent}{0pt}
376− % turn on hanging indent if param 1 is 1
377− \ifodd #1 \everypar{\setlength{\hangindent}{\cslhangindent}}\ignorespaces\fi
378− % set line spacing
379− % set entry spacing
380− \ifnum #2 > 0
381− \setlength{\parskip}{#3\baselineskip}
382− \fi
383− }%
384− {}
385−\usepackage{calc} % for \widthof, \maxof
386−\newcommand{\CSLBlock}[1]{#1\hfill\break}
387−\newcommand{\CSLLeftMargin}[1]{\parbox[t]{\maxof{\widthof{#1}}{\csllabelwidth}}{#1}}
388−\newcommand{\CSLRightInline}[1]{\parbox[t]{\linewidth}{#1}}
389−\newcommand{\CSLIndent}[1]{\hspace{\cslhangindent}#1}
419+$if(nocite-ids)$
420+\nocite{$for(nocite-ids)$$it$$sep$, $endfor$}
421+$endif$
422+$if(csquotes)$
423+\usepackage{csquotes}
390424$endif$
391425
392426$if(title)$
@@ -460,12 +494,12 @@ $endif$
460494}
461495$endif$
462496$endif$
463−$if(lot)$
464−\listoftables
465−$endif$
466497$if(lof)$
467498\listoffigures
468499$endif$
500+$if(lot)$
501+\listoftables
502+$endif$
469503$if(linestretch)$
470504\setstretch{$linestretch$}
471505$endif$
data/templates/default.man+1−1
@@ -1,5 +1,5 @@
11$if(has-tables)$
2−.\"t
2+'\" t
33$endif$
44$if(pandoc-version)$
55.\" Automatically generated by Pandoc $pandoc-version$
data/templates/default.org+3−3
@@ -1,12 +1,12 @@
11$if(title)$
2−#+TITLE: $title$
2+#+title: $title$
33
44$endif$
55$if(author)$
6−#+AUTHOR: $for(author)$$author$$sep$; $endfor$
6+#+author: $for(author)$$author$$sep$; $endfor$
77$endif$
88$if(date)$
9−#+DATE: $date$
9+#+date: $date$
1010
1111$endif$
1212$for(header-includes)$
data/templates/default.revealjs+84−122
@@ -52,6 +52,9 @@ $endif$
5252$for(author)$
5353 <p class="author">$author$</p>
5454$endfor$
55+$for(institute)$
56+ <p class="institute">$institute$</p>
57+$endfor$
5558$if(date)$
5659 <p class="date">$date$</p>
5760$endif$
@@ -59,7 +62,12 @@ $endif$
5962$endif$
6063$if(toc)$
6164<section id="$idprefix$TOC">
65+<nav role="doc-toc">
66+$if(toc-title)$
67+<h2 id="$idprefix$toc-title">$toc-title$</h2>
68+$endif$
6269$table-of-contents$
70+</nav>
6371</section>
6472$endif$
6573
@@ -69,7 +77,7 @@ $body$
6977
7078 <script src="$revealjs-url$/dist/reveal.js"></script>
7179
72− // reveal.js plugins
80+ <!-- reveal.js plugins -->
7381 <script src="$revealjs-url$/plugin/notes/notes.js"></script>
7482 <script src="$revealjs-url$/plugin/search/search.js"></script>
7583 <script src="$revealjs-url$/plugin/zoom/zoom.js"></script>
@@ -82,244 +90,198 @@ $endif$
8290 // Full list of configuration options available at:
8391 // https://revealjs.com/config/
8492 Reveal.initialize({
85−$if(controls)$
8693 // Display controls in the bottom right corner
8794 controls: $controls$,
88−$endif$
89−$if(controlsTutorial)$
95+
9096 // Help the user learn the controls by providing hints, for example by
9197 // bouncing the down arrow when they first encounter a vertical slide
9298 controlsTutorial: $controlsTutorial$,
93−$endif$
94−$if(controlsLayout)$
99+
95100 // Determines where controls appear, "edges" or "bottom-right"
96− controlsLayout: $controlsLayout$,
97−$endif$
98−$if(controlsBackArrows)$
101+ controlsLayout: '$controlsLayout$',
102+
99103 // Visibility rule for backwards navigation arrows; "faded", "hidden"
100104 // or "visible"
101− controlsBackArrows: $controlsBackArrows$,
102−$endif$
103−$if(progress)$
105+ controlsBackArrows: '$controlsBackArrows$',
106+
104107 // Display a presentation progress bar
105108 progress: $progress$,
106−$endif$
107−$if(slideNumber)$
109+
108110 // Display the page number of the current slide
109111 slideNumber: $slideNumber$,
110−$endif$
111−$if(hash)$
112+
113+ // 'all', 'print', or 'speaker'
114+ showSlideNumber: '$showSlideNumber$',
115+
112116 // Add the current slide number to the URL hash so that reloading the
113117 // page/copying the URL will return you to the same slide
114118 hash: $hash$,
115−$endif$
119+
120+ // Start with 1 for the hash rather than 0
121+ hashOneBasedIndex: $hashOneBasedIndex$,
122+
123+ // Flags if we should monitor the hash and change slides accordingly
124+ respondToHashChanges: $respondToHashChanges$,
125+
116126 // Push each slide change to the browser history
117−$if(history)$
118127 history: $history$,
119−$else$
120− history: true,
121−$endif$
122−$if(keyboard)$
128+
123129 // Enable keyboard shortcuts for navigation
124130 keyboard: $keyboard$,
125−$endif$
126−$if(overview)$
131+
127132 // Enable the slide overview mode
128133 overview: $overview$,
129−$endif$
130−$if(center)$
134+
135+ // Disables the default reveal.js slide layout (scaling and centering)
136+ // so that you can use custom CSS layout
137+ disableLayout: false,
138+
131139 // Vertical centering of slides
132140 center: $center$,
133−$endif$
134−$if(touch)$
141+
135142 // Enables touch navigation on devices with touch input
136143 touch: $touch$,
137−$endif$
138−$if(loop)$
144+
139145 // Loop the presentation
140146 loop: $loop$,
141−$endif$
142−$if(rtl)$
147+
143148 // Change the presentation direction to be RTL
144149 rtl: $rtl$,
145−$endif$
146−$if(navigationMode)$
150+
147151 // see https://revealjs.com/vertical-slides/#navigation-mode
148152 navigationMode: '$navigationMode$',
149−$endif$
150−$if(shuffle)$
153+
151154 // Randomizes the order of slides each time the presentation loads
152155 shuffle: $shuffle$,
153−$endif$
154−$if(fragments)$
156+
155157 // Turns fragments on and off globally
156158 fragments: $fragments$,
157−$endif$
158−$if(fragmentInURL)$
159+
159160 // Flags whether to include the current fragment in the URL,
160161 // so that reloading brings you to the same fragment position
161162 fragmentInURL: $fragmentInURL$,
162−$endif$
163−$if(embedded)$
163+
164164 // Flags if the presentation is running in an embedded mode,
165165 // i.e. contained within a limited portion of the screen
166166 embedded: $embedded$,
167−$endif$
168−$if(help)$
167+
169168 // Flags if we should show a help overlay when the questionmark
170169 // key is pressed
171170 help: $help$,
172−$endif$
173−$if(showNotes)$
171+
172+ // Flags if it should be possible to pause the presentation (blackout)
173+ pause: $pause$,
174+
174175 // Flags if speaker notes should be visible to all viewers
175176 showNotes: $showNotes$,
176−$endif$
177−$if(autoPlayMedia)$
178− // Global override for autoplaying embedded media (video/audio/iframe)
179− // - null: Media will only autoplay if data-autoplay is present
180− // - true: All media will autoplay, regardless of individual setting
181− // - false: No media will autoplay, regardless of individual setting
177+
178+ // Global override for autoplaying embedded media (null/true/false)
182179 autoPlayMedia: $autoPlayMedia$,
183−$endif$
184−$if(preloadIframes)$
185− // Global override for preloading lazy-loaded iframes
186− // - null: Iframes with data-src AND data-preload will be loaded when within
187− // the viewDistance, iframes with only data-src will be loaded when visible
188− // - true: All iframes with data-src will be loaded when within the viewDistance
189− // - false: All iframes with data-src will be loaded only when visible
180+
181+ // Global override for preloading lazy-loaded iframes (null/true/false)
190182 preloadIframes: $preloadIframes$,
191−$endif$
192−$if(autoSlide)$
183+
193184 // Number of milliseconds between automatically proceeding to the
194185 // next slide, disabled when set to 0, this value can be overwritten
195186 // by using a data-autoslide attribute on your slides
196187 autoSlide: $autoSlide$,
197−$endif$
198−$if(autoSlideStoppable)$
188+
199189 // Stop auto-sliding after user input
200190 autoSlideStoppable: $autoSlideStoppable$,
201−$endif$
202−$if(autoSlideMethod)$
191+
203192 // Use this method for navigation when auto-sliding
204193 autoSlideMethod: $autoSlideMethod$,
205−$endif$
206−$if(defaultTiming)$
194+
207195 // Specify the average time in seconds that you think you will spend
208196 // presenting each slide. This is used to show a pacing timer in the
209197 // speaker view
210198 defaultTiming: $defaultTiming$,
211−$endif$
212−$if(totalTime)$
213− // Specify the total time in seconds that is available to
214− // present. If this is set to a nonzero value, the pacing
215− // timer will work out the time available for each slide,
216− // instead of using the defaultTiming value
217− totalTime: $totalTime$,
218−$endif$
219−$if(minimumTimePerSlide)$
220− // Specify the minimum amount of time you want to allot to
221− // each slide, if using the totalTime calculation method. If
222− // the automated time allocation causes slide pacing to fall
223− // below this threshold, then you will see an alert in the
224− // speaker notes window
225− minimumTimePerSlide: $minimumTimePerSlide$,
226−$endif$
227−$if(mouseWheel)$
199+
228200 // Enable slide navigation via mouse wheel
229201 mouseWheel: $mouseWheel$,
230−$endif$
231−$if(rollingLinks)$
232− // Apply a 3D roll to links on hover
233− rollingLinks: $rollingLinks$,
234−$endif$
235−$if(hideInactiveCursor)$
202+
203+ // The display mode that will be used to show slides
204+ display: '$display$',
205+
236206 // Hide cursor if inactive
237207 hideInactiveCursor: $hideInactiveCursor$,
238−$endif$
239−$if(hideCursorTime)$
208+
240209 // Time before the cursor is hidden (in ms)
241210 hideCursorTime: $hideCursorTime$,
242−$endif$
243−$if(hideAddressBar)$
244− // Hides the address bar on mobile devices
245− hideAddressBar: $hideAddressBar$,
246−$endif$
247−$if(previewLinks)$
211+
248212 // Opens links in an iframe preview overlay
249213 previewLinks: $previewLinks$,
250−$endif$
251−$if(transition)$
252− // Transition style
253− transition: '$transition$', // none/fade/slide/convex/concave/zoom
254−$endif$
255−$if(transitionSpeed)$
256− // Transition speed
257− transitionSpeed: '$transitionSpeed$', // default/fast/slow
258−$endif$
259−$if(backgroundTransition)$
214+
215+ // Transition style (none/fade/slide/convex/concave/zoom)
216+ transition: '$transition$',
217+
218+ // Transition speed (default/fast/slow)
219+ transitionSpeed: '$transitionSpeed$',
220+
260221 // Transition style for full page slide backgrounds
261− backgroundTransition: '$backgroundTransition$', // none/fade/slide/convex/concave/zoom
262−$endif$
263−$if(viewDistance)$
222+ // (none/fade/slide/convex/concave/zoom)
223+ backgroundTransition: '$backgroundTransition$',
224+
264225 // Number of slides away from the current that are visible
265226 viewDistance: $viewDistance$,
266−$endif$
267−$if(mobileViewDistance)$
227+
268228 // Number of slides away from the current that are visible on mobile
269229 // devices. It is advisable to set this to a lower number than
270230 // viewDistance in order to save resources.
271231 mobileViewDistance: $mobileViewDistance$,
272−$endif$
273232$if(parallaxBackgroundImage)$
233+
274234 // Parallax background image
275235 parallaxBackgroundImage: '$parallaxBackgroundImage$', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
276236$else$
277237$if(background-image)$
238+
278239 // Parallax background image
279240 parallaxBackgroundImage: '$background-image$', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
280241$endif$
281242$endif$
282243$if(parallaxBackgroundSize)$
244+
283245 // Parallax background size
284246 parallaxBackgroundSize: '$parallaxBackgroundSize$', // CSS syntax, e.g. "2100px 900px"
285247$endif$
286248$if(parallaxBackgroundHorizontal)$
249+
287250 // Amount to move parallax background (horizontal and vertical) on slide change
288251 // Number, e.g. 100
289252 parallaxBackgroundHorizontal: $parallaxBackgroundHorizontal$,
290253$endif$
291254$if(parallaxBackgroundVertical)$
255+
292256 parallaxBackgroundVertical: $parallaxBackgroundVertical$,
293257$endif$
294258$if(width)$
259+
295260 // The "normal" size of the presentation, aspect ratio will be preserved
296261 // when the presentation is scaled to fit different resolutions. Can be
297262 // specified using percentage units.
298263 width: $width$,
299264$endif$
300265$if(height)$
266+
301267 height: $height$,
302268$endif$
303269$if(margin)$
270+
304271 // Factor of the display size that should remain empty around the content
305272 margin: $margin$,
306273$endif$
307274$if(minScale)$
275+
308276 // Bounds for smallest/largest possible scale to apply to content
309277 minScale: $minScale$,
310278$endif$
311279$if(maxScale)$
280+
312281 maxScale: $maxScale$,
313282$endif$
314−$if(zoomKey)$
315− // Modifier key used to click-zoom to part of the slide
316− zoomKey: '$zoomKey$',
317−$endif$
318−$if(display)$
319− // The display mode that will be used to show slides
320− display: $display$,
321−$endif$
322283$if(mathjax)$
284+
323285 math: {
324286 mathjax: '$mathjaxurl$',
325287 config: 'TeX-AMS_HTML-full',
data/templates/default.s5+3
@@ -61,6 +61,9 @@ $endif$
6161$if(author)$
6262 <h3 class="author">$for(author)$$author$$sep$<br/>$endfor$</h3>
6363$endif$
64+$if(institute)$
65+ <h3 class="institute">$for(institute)$$institute$$sep$<br/>$endfor$</h3>
66+$endif$
6467$if(date)$
6568 <h4 class="date">$date$</h4>
6669$endif$
data/templates/default.slideous+7
@@ -63,9 +63,16 @@ $if(title)$
6363$if(subtitle)$
6464 <h1 class="subtitle">$subtitle$</h1>
6565$endif$
66+$if(author)$
6667 <p class="author">
6768$for(author)$$author$$sep$<br/>$endfor$
6869 </p>
70+$endif$
71+$if(institute)$
72+ <p class="institute">
73+$for(institute)$$institute$$sep$<br/>$endfor$
74+ </p>
75+$endif$
6976$if(date)$
7077 <p class="date">$date$</p>
7178$endif$
data/templates/default.slidy+5
@@ -52,6 +52,11 @@ $if(author)$
5252$for(author)$$author$$sep$<br/>$endfor$
5353 </p>
5454$endif$
55+$if(institute)$
56+ <p class="institute">
57+$for(institute)$$institute$$sep$<br/>$endfor$
58+ </p>
59+$endif$
5560$if(date)$
5661 <p class="date">$date$</p>
5762$endif$
data/templates/styles.html+51−18
@@ -1,6 +1,6 @@
11$if(document-css)$
22html {
3− line-height: $if(linestretch)$$linestretch$$else$1.7$endif$;
3+ line-height: $if(linestretch)$$linestretch$$else$1.5$endif$;
44 font-family: $if(mainfont)$$mainfont$$else$Georgia, serif$endif$;
55 font-size: $if(fontsize)$$fontsize$$else$20px$endif$;
66 color: $if(fontcolor)$$fontcolor$$else$#1a1a1a$endif$;
@@ -8,13 +8,13 @@ html {
88}
99body {
1010 margin: 0 auto;
11− max-width: 40em;
11+ max-width: 36em;
1212 padding-left: $if(margin-left)$$margin-left$$else$50px$endif$;
1313 padding-right: $if(margin-right)$$margin-right$$else$50px$endif$;
1414 padding-top: $if(margin-top)$$margin-top$$else$50px$endif$;
1515 padding-bottom: $if(margin-bottom)$$margin-bottom$$else$50px$endif$;
1616 hyphens: auto;
17− word-wrap: break-word;
17+ overflow-wrap: break-word;
1818 text-rendering: optimizeLegibility;
1919 font-kerning: normal;
2020}
@@ -28,6 +28,7 @@ body {
2828 body {
2929 background-color: transparent;
3030 color: black;
31+ font-size: 12pt;
3132 }
3233 p, h2, h3 {
3334 orphans: 3;
@@ -38,7 +39,7 @@ body {
3839 }
3940}
4041p {
41− margin-top: 1.7em;
42+ margin: 1em 0;
4243}
4344a {
4445 color: $if(linkcolor)$$linkcolor$$else$#1a1a1a$endif$;
@@ -50,59 +51,91 @@ img {
5051 max-width: 100%;
5152}
5253h1, h2, h3, h4, h5, h6 {
53− margin-top: 1.7em;
54+ margin-top: 1.4em;
55+}
56+h5, h6 {
57+ font-size: 1em;
58+ font-style: italic;
59+}
60+h6 {
61+ font-weight: normal;
5462}
5563ol, ul {
5664 padding-left: 1.7em;
57− margin-top: 1.7em;
65+ margin-top: 1em;
5866}
5967li > ol, li > ul {
6068 margin-top: 0;
6169}
6270blockquote {
63− margin: 1.7em 0 1.7em 1.7em;
71+ margin: 1em 0 1em 1.7em;
6472 padding-left: 1em;
6573 border-left: 2px solid #e6e6e6;
66− font-style: italic;
74+ color: #606060;
6775}
6876code {
6977 font-family: $if(monofont)$$monofont$$else$Menlo, Monaco, 'Lucida Console', Consolas, monospace$endif$;
70− background-color: #f0f0f0;
78+$if(monobackgroundcolor)$
79+ background-color: $monobackgroundcolor$;
80+ padding: .2em .4em;
81+$endif$
7182 font-size: 85%;
7283 margin: 0;
73− padding: .2em .4em;
7484}
7585pre {
76− line-height: 1.5em;
86+ margin: 1em 0;
87+$if(monobackgroundcolor)$
88+ background-color: $monobackgroundcolor$;
7789 padding: 1em;
78− background-color: #f0f0f0;
90+$endif$
7991 overflow: auto;
8092}
8193pre code {
8294 padding: 0;
8395 overflow: visible;
96+ overflow-wrap: normal;
97+}
98+.sourceCode {
99+ background-color: transparent;
100+ overflow: visible;
84101}
85102hr {
86103 background-color: #1a1a1a;
87104 border: none;
88105 height: 1px;
89− margin-top: 1.7em;
106+ margin: 1em 0;
90107}
91108table {
109+ margin: 1em 0;
92110 border-collapse: collapse;
93111 width: 100%;
94112 overflow-x: auto;
95113 display: block;
114+ font-variant-numeric: lining-nums tabular-nums;
115+}
116+table caption {
117+ margin-bottom: 0.75em;
96118}
97−th, td {
98− border-bottom: 1px solid lightgray;
99− padding: 1em 3em 1em 0;
119+tbody {
120+ margin-top: 0.5em;
121+ border-top: 1px solid $if(fontcolor)$$fontcolor$$else$#1a1a1a$endif$;
122+ border-bottom: 1px solid $if(fontcolor)$$fontcolor$$else$#1a1a1a$endif$;
123+}
124+th {
125+ border-top: 1px solid $if(fontcolor)$$fontcolor$$else$#1a1a1a$endif$;
126+ padding: 0.25em 0.5em 0.25em 0.5em;
127+}
128+td {
129+ padding: 0.125em 0.5em 0.25em 0.5em;
100130}
101131header {
102− margin-bottom: 6em;
132+ margin-bottom: 4em;
103133 text-align: center;
104134}
105−nav a:not(:hover) {
135+#TOC li {
136+ list-style: none;
137+}
138+#TOC a:not(:hover) {
106139 text-decoration: none;
107140}
108141$endif$
data/translations/zh-Hans.yamlnew file+22
@@ -0,0 +1,22 @@
1+Abstract: 摘要
2+Appendix: 附录
3+Bibliography: 文献目录
4+Cc: 副本
5+Chapter: 章
6+Contents: 目录
7+Encl: 附件
8+Figure: 图
9+Glossary: 术语
10+Index: 索引
11+Listing: 列表
12+ListOfFigures: 附图目录
13+ListOfTables: 表格索引
14+Page: 页
15+Part: 段
16+Preface: 序
17+Proof: 校对
18+References: 参考文献
19+See: 见
20+SeeAlso: 参见
21+Table: 表
22+To: 到
data/translations/zh-Hant.yamlnew file+22
@@ -0,0 +1,22 @@
1+Abstract: 摘要
2+Appendix: 附錄
3+Bibliography: 文獻目錄
4+Cc: 副本
5+Chapter: 章
6+Contents: 目錄
7+Encl: 附件
8+Figure: 圖
9+Glossary: 術語
10+Index: 索引
11+Listing: 列表
12+ListOfFigures: 附圖目錄
13+ListOfTables: 表格索引
14+Page: 頁
15+Part: 段
16+Preface: 序
17+Proof: 校對
18+References: 參考文獻
19+See: 見
20+SeeAlso: 參見
21+Table: 表
22+To: 到
data/vimwiki.cssdeleted−82
@@ -1,82 +0,0 @@
1−pre{
2− font-size: 1.5em
3−}
4−
5−img {vertical-align: middle}
6−
7−body {font-family: Tahoma, Geneva, sans-serif; margin: 1em 2em 1em 2em; font-size: 120%; line-height: 130%;}
8−h1, h2, h3, h4, h5, h6 {font-family: Trebuchet MS, Helvetica, sans-serif; font-weight: bold; line-height:100%; margin-top: 1.5em; margin-bottom: 0.5em;}
9−h1 {font-size: 2.6em; color: #000000;}
10−h2 {font-size: 2.2em; color: #404040;}
11−h3 {font-size: 1.8em; color: #707070;}
12−h4 {font-size: 1.4em; color: #909090;}
13−h5 {font-size: 1.3em; color: #989898;}
14−h6 {font-size: 1.2em; color: #9c9c9c;}
15−p, pre, blockquote, table, ul, ol, dl {margin-top: 1em; margin-bottom: 1em;}
16−ul ul, ul ol, ol ol, ol ul {margin-top: 0.5em; margin-bottom: 0.5em;}
17−li {margin: 0.3em auto;}
18−ul {margin-left: 2em; padding-left: 0.5em;}
19−dt {font-weight: bold;}
20−img {border: none;}
21−pre {border-left: 1px solid #ccc; margin-left: 2em; padding-left: 0.5em;}
22−blockquote {padding: 0.4em; background-color: #f6f5eb;}
23−th, td {border: 1px solid #ccc; padding: 0.3em;}
24−th {background-color: #f0f0f0;}
25−hr {border: none; border-top: 1px solid #ccc; width: 100%;}
26−del {text-decoration: line-through; color: #777777;}
27−.toc li {list-style-type: none;}
28−.todo {font-weight: bold; background-color: #f0ece8; color: #a03020;}
29−.justleft {text-align: left;}
30−.justright {text-align: right;}
31−.justcenter {text-align: center;}
32−.center {margin-left: auto; margin-right: auto;}
33−div.center > table {margin-left: auto; margin-right: auto;}
34−.tag {background-color: #eeeeee; font-family: monospace; padding: 2px;}
35−
36−/* classes for items of todo lists */
37−.done0 {
38− /* list-style: none; */
39− background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAA7SURBVCiR7dMxEgAgCANBI3yVRzF5KxNbW6wsuH7LQ2YKQK1mkswBVERYF5Os3UV3gwd/jF2SkXy66gAZkxS6BniubAAAAABJRU5ErkJggg==);
40− background-repeat: no-repeat;
41− background-position: 0 .2em;
42− padding-left: 1.5em;
43−}
44−.done1 {
45− background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAABtSURBVCiR1ZO7DYAwDER9BDmTeZQMFXmUbGYpOjrEryA0wOvO8itOslFrJYAug5BMM4BeSkmjsrv3aVTa8p48Xw1JSkSsWVUFwD05IqS1tmYzk5zzae9jnVVVzGyXb8sALjse+euRkEzu/uirFomVIdDGOLjuAAAAAElFTkSuQmCC);
46− background-repeat: no-repeat;
47− background-position: 0 .15em;
48− padding-left: 1.5em;
49−}
50−.done2 {
51− background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAB1SURBVCiRzdO5DcAgDAVQGxjAYgTvxlDIu1FTIRYAp8qlFISkSH7l5kk+ZIwxKiI2mIyqWoeILYRgZ7GINDOLjnmF3VqklKCUMgTee2DmM661Qs55iI3Zm/1u5h9sm4ig9z4ERHTFzLyd4G4+nFlVrYg8+qoF/c0kdpeMsmcAAAAASUVORK5CYII=);
52− background-repeat: no-repeat;
53− background-position: 0 .15em;
54− padding-left: 1.5em;
55−}
56−.done3 {
57− background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAABoSURBVCiR7dOxDcAgDATA/0DtUdiKoZC3YhLkHjkVKF3idJHiztKfvrHZWnOSE8Fx95RJzlprimJVnXktvXeY2S0SEZRSAAAbmxnGGKH2I5T+8VfxPhIReQSuuY3XyYWa3T2p6quvOgGrvSFGlewuUAAAAABJRU5ErkJggg==);
58− background-repeat: no-repeat;
59− background-position: 0 .15em;
60− padding-left: 1.5em;
61−}
62−.done4 {
63− background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAAQCAYAAAAbBi9cAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAzgAAAM4BlP6ToAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAIISURBVDiNnZQ9SFtRFMd/773kpTaGJoQk1im4VDpWQcTNODhkFBcVTCNCF0NWyeDiIIiCm82QoIMIUkHUxcFBg1SEQoZszSat6cdTn1qNue92CMbEr9Sey+XC/Z/zu+f8h6ukUil3sVg0+M+4cFxk42/jH2wAqqqKSCSiPQdwcHHAnDHH9s/tN1h8V28ETdP+eU8fT9Nt62ancYdIPvJNtsu87bmjrJlrTDVM4RROJs1JrHPrD4Bar7A6cpc54iKOaTdJXCUI2UMVrQZ0Js7YPN18ECKkYNQcJe/OE/4dZsw7VqNXQMvHy3QZXQypQ6ycrtwDjf8aJ+PNEDSCzLpn7+m2pD8ZKHlKarYhy6XjEoCYGcN95qansQeA3fNdki+SaJZGTMQIOoL3W/Z89rxv+tokubNajlvk/vm+LFpF2XnUKZHI0I+QrI7Dw0OZTqdzUkpsM7mZTyfy5OPGyw1tK7AFSvmB/Ks8w8YwbUYbe6/3QEKv0vugfxWPnMLJun+d/kI/WLdizpNjMbAIKrhMF4OuwadBALqqs+RfInwUvuNi+fBd+wjogfogAFVRmffO02q01mZZ0HHdgXIzdz0QQLPezIQygX6llxNKKgOFARYCC49CqhoHIUTlss/Vx2phlYwjw8j1CAlfAiwQiJpiy7o1VHnsG5FISkoJu7Q/2YmmaV+i0ei7v38L2CBguSi5AAAAAElFTkSuQmCC);
64− background-repeat: no-repeat;
65− background-position: 0 .15em;
66− padding-left: 1.5em;
67−}
68−
69−*:not(pre) > code {
70− font-family: Monaco,"Courier New","DejaVu Sans Mono","Bitstream Vera Sans Mono",monospace;
71− -webkit-border-radius: 1px;
72− -moz-border-radius: 1px;
73− border-radius: 1px;
74− -moz-background-clip: padding;
75− -webkit-background-clip: padding-box;
76− background-clip: padding-box;
77− padding: 0px 3px;
78− display: inline-block;
79− color: #52595d;
80− border: 1px solid #ccc;
81− background-color: #f9f9f9;
82−}
default.nixnew file+13
@@ -0,0 +1,13 @@
1+# default.nix
2+let
3+ pkgs = import <nixpkgs> { };
4+in
5+ pkgs.haskellPackages.developPackage {
6+ root = ./.;
7+ modifier = drv:
8+ pkgs.haskell.lib.addBuildTools drv (with pkgs.haskellPackages;
9+ [ cabal-install
10+ ghcid
11+ ]);
12+ }
13+
doc/epub.md+9−2
@@ -141,8 +141,15 @@ Pandoc has an EPUB3 writer. It renders LaTeX math into MathML, which
141141EPUB3 readers are supposed to support (but unfortunately few do).
142142
143143Of course, this isn't much help if you want EPUB2 output (`pandoc -t epub2`)
144−or target readers that don't support MathML. Then you should try using the
145−`--webtex` option, which will use a web service to convert the TeX to an image.
144+or target readers that don't support MathML. Then you have two options:
145+
146+1. Use the [`--webtex`](https://pandoc.org/MANUAL.html#option--webtex) option,
147+ which will use a web service to convert the TeX to an image.
148+2. Use the [`--gladtex`](https://pandoc.org/MANUAL.html#option--gladtex) option
149+ to convert maths into SVG images on your local machine.
150+
151+Both GladTeX and WebTeX add the LaTeX source of the formula as alternative text
152+of the image, increasing accessibility for blind users.
146153
147154[KindleGen]: https://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211
148155[EPUB]: https://en.wikipedia.org/wiki/EPUB
doc/faqs.mdnew file+128
@@ -0,0 +1,128 @@
1+% FAQs
2+
3+::: faqs
4+
5+## How can I convert a whole directory of files from Markdown to RTF?
6+
7+On linux or OSX:
8+
9+ for f in *.txt; do pandoc "$f" -s -o "${f%.txt}.rtf"; done
10+
11+
12+In Windows Powershell:
13+
14+ gci -r -i *.txt |foreach{$rtf=$_.directoryname+"\"+$_.basename+".rtf";pandoc -f markdown -s $_.name -o $rtf}
15+
16+## I used pandoc to convert a document to ICML (or OPML or RTF), and when I try to open it I'm told it's invalid. What have I done wrong?
17+
18+Be sure to use the `-s` or `--standalone` flag, or you just get a
19+fragment, not a full document with the required header:
20+
21+ pandoc -s -f markdown -t icml -o my.icml my.md
22+
23+## I get a blank document when I try to convert a markdown document in Chinese to PDF.
24+
25+By default, pandoc uses pdflatex to generate the PDF, and pdflatex
26+doesn't handle Chinese characters. But you can change the default to
27+use xelatex instead. You should also make sure you're using a font
28+with Chinese glyphs. For example:
29+
30+ pandoc -o c.pdf --pdf-engine=xelatex -V mainfont='Adobe Ming Std'
31+
32+## The Windows installer does a single user install, rather than installing pandoc for all users. How can I install pandoc for all users?
33+
34+Run the following command as admin:
35+
36+ msiexec /i pandoc-VERSION.msi ALLUSERS=1
37+
38+This will put pandoc in `C:\Program Files\Pandoc`.
39+You can install Pandoc to a different directory by setting APPLICATIONFOLDER parameter,
40+for example:
41+
42+ msiexec /i pandoc-1.11.1.msi ALLUSERS=1 APPLICATIONFOLDER="C:\Pandoc"
43+
44+## How do I change the margins in PDF output?
45+
46+The option
47+
48+ -V geometry:margin=1in
49+
50+will set the margins to one inch on each side. If you don't want uniform
51+margins, you can do something like
52+
53+ -V geometry:"top=2cm, bottom=1.5cm, left=1cm, right=1cm"
54+
55+Or
56+
57+ -V geometry:"left=3cm, width=10cm"
58+
59+For more options, see the documentation for the LaTeX [geometry
60+package](https://www.ctan.org/pkg/geometry).
61+
62+## How does pandoc compare to multimarkdown?
63+
64+Here is a [wiki
65+page](https://github.com/jgm/pandoc/wiki/Pandoc-vs-Multimarkdown)
66+comparing the two.
67+
68+## When I specify an image width of 50% and convert to LaTeX, pandoc sets the height to textheight and the aspect ratio isn't preserved. How can I prevent this?
69+
70+For example, if you convert an image with `{width="50%"}`, the LaTeX produced
71+will be `\includegraphics[width=0.5\textwidth,height=\textheight]`.
72+
73+This output presupposes the following code in pandoc's default latex
74+template:
75+
76+```
77+% Scale images if necessary, so that they will not overflow the page
78+% margins by default, and it is still possible to overwrite the defaults
79+% using explicit options in \includegraphics[width, height, ...]{}
80+\setkeys{Gin}{width=\maxwidth,height=\maxheight,keepaspectratio}
81+```
82+
83+If you don't have this in your custom template, you should
84+add it. If we didn't set the `height` explicitly in this way,
85+the image would not be resized correctly unless it was
86+being resized to smaller than its original size.
87+
88+## Pandoc sometimes uses too much memory. How can I limit the memory used by pandoc?
89+
90+`pandoc +RTS -M30m -RTS` will limit heap memory to 30MB.
91+When converting a document requires more than this, an out of
92+memory error will be issued.
93+
94+## When using `--include-in-header` with PDF or LaTeX output, how do I reference tex declarations coming after `$header-includes$` in the default template?
95+
96+For various reasons, the `$header-includes$` are not at the very
97+end of the LaTeX preamble. This poses a problem when the code
98+you are inserting depends on declarations in the preamble coming
99+after the `$header-includes$` location. For example, you might
100+want to reference the `\author` and `\title` metadata values
101+(set at the very bottom of the preamble) and present them in
102+margins. In that case you can wrap your code in `etoolbox`'s
103+`\AtEndPreamble`. The technique is demonstrated in [this
104+gist](https://gist.github.com/JohnLukeBentley/9dda6166b9ee5c4127afd2b8cd16b70a).
105+When using `\AtEndPreamble`, keep any `makeatletter` or
106+`makeatother` outside of the `\AtEndPreamble`, as shown in the
107+example.
108+
109+## How can I convert PDFs to other formats using pandoc?
110+
111+You can't. You can try opening the PDF in Word or Google Docs
112+and saving in a format from which pandoc can convert directly.
113+
114+## Do I really need to install a 1 GB TeX installation to produce a PDF using pandoc?
115+
116+No. You can get by with a relatively small TeX installation,
117+for example, by starting with MacTeX's Basic TeX distribution
118+and using the `tlmgr` tool to install a few packages required by pandoc
119+(see https://pandoc.org/MANUAL.html#creating-a-pdf).
120+
121+Or, you can produce PDFs via HTML and `wkhtmltopdf`,
122+or via groff ms and `pdfroff`. (These don't produce as nice
123+topography as TeX, particularly when it comes to math, but they
124+may be fine for many purposes.)
125+
126+
127+:::
128+
doc/filters.md+91−6
@@ -253,12 +253,15 @@ repository](https://github.com/jgm/pandocfilters).
253253
254254For a more Pythonic alternative to pandocfilters, see
255255the [panflute](https://pypi.org/project/panflute) library.
256−Don't like Python? There are also ports of pandocfilters in
257−[PHP](https://github.com/vinai/pandocfilters-php),
258−[perl](https://metacpan.org/pod/Pandoc::Filter),
259−[javascript/node.js](https://github.com/mvhenderson/pandoc-filter-node),
260−[Groovy](https://github.com/dfrommi/groovy-pandoc), and
261−[Ruby](https://heerdebeer.org/Software/markdown/paru/).
256+Don't like Python? There are also ports of pandocfilters in
257+
258+- [PHP](https://github.com/vinai/pandocfilters-php),
259+- [perl](https://metacpan.org/pod/Pandoc::Filter),
260+- TypeScript/JavaScript via Node.js
261+ - [pandoc-filter](https://github.com/mvhenderson/pandoc-filter-node),
262+ - [node-pandoc-filter](https://github.com/mu-io/node-pandoc-filter),
263+- [Groovy](https://github.com/dfrommi/groovy-pandoc), and
264+- [Ruby](https://heerdebeer.org/Software/markdown/paru/).
262265
263266Starting with pandoc 2.0, pandoc includes built-in support for
264267writing filters in lua. The lua interpreter is built in to
@@ -391,6 +394,8 @@ automatically assign it `Just` the target format or `Nothing`.
391394
392395We compile our script:
393396
397+ # first, make sure pandoc-types is installed:
398+ cabal install --lib pandoc-types --package-env .
394399 ghc --make handleRuby
395400
396401Then run it:
@@ -425,3 +430,83 @@ the Japanese characters (e.g. "Noto Sans CJK TC"), and add
4254305. Find all code blocks with class `python` and run them
426431 using the python interpreter, printing the results to the console.
427432
433+# Technical details of JSON filters
434+
435+A JSON filter is any program which can consume and produce a
436+valid pandoc JSON document representation. This section describes
437+the technical details surrounding the invocation of filters.
438+
439+## Arguments
440+
441+The program will always be called with the target format as the
442+only argument. A pandoc invocation like
443+
444+ pandoc --filter demo --to=html
445+
446+will cause pandoc to call the program `demo` with argument `html`.
447+
448+## Environment variables
449+
450+Pandoc sets additional environment variables before calling a
451+filter.
452+
453+`PANDOC_VERSION`
454+: The version of the pandoc binary used to process the document.
455+ Example: `2.11.1`.
456+
457+`PANDOC_READER_OPTIONS`
458+: JSON object representation of the options passed to the input
459+ parser.
460+
461+ Object fields:
462+
463+ `readerAbbreviations`
464+ : set of known abbreviations (array of strings).
465+
466+ `readerColumns`
467+ : number of columns in terminal; an integer.
468+
469+ `readerDefaultImageExtension`
470+ : default extension for images; a string.
471+
472+ `readerExtensions`
473+ : integer representation of the syntax extensions bit
474+ field.
475+
476+ `readerIndentedCodeClasses`
477+ : default classes for indented code blocks; array of
478+ strings.
479+
480+ `readerStandalone`
481+ : whether the input was a standalone document with header;
482+ either `true` or `false`.
483+
484+ `readerStripComments`
485+ : HTML comments are stripped instead of parsed as raw HTML;
486+ either `true` or `false`.
487+
488+ `readerTabStop`
489+ : width (i.e. equivalent number of spaces) of tab stops;
490+ integer.
491+
492+ `readerTrackChanges`
493+ : track changes setting for docx; one of
494+ `"accept-changes"`, `"reject-changes"`, and
495+ `"all-changes"`.
496+
497+## Supported interpreters
498+
499+Files passed to the `--filter`/`-F` parameter are expected to be
500+executable. However, if the executable bit is not set, then
501+pandoc tries to guess a suitable interpreter from the file
502+extension.
503+
504+ file extension interpreter
505+ ---------------- --------------
506+ .py `python`
507+ .hs `runhaskell`
508+ .pl `perl`
509+ .rb `ruby`
510+ .php `php`
511+ .js `node`
512+ .r `Rscript`
doc/jats.mdnew file+414
@@ -0,0 +1,414 @@
1+---
2+title: JATS
3+author: Albert Krewinkel
4+---
5+
6+This document describes pandoc's handling of JATS.
7+
8+Metadata Values
9+===============
10+
11+`abstract`
12+: Article summary. Added via the document's front matter via the
13+ [`<abstract>`][elem:abstract] element.
14+
15+`author`
16+: list of article contributors. Each author should have a surname
17+ and a given name listed in the entry; if the author has no
18+ `surname` value, then the item will be used as the contributors
19+ [`string-name`][elem:string-name].
20+
21+ `orcid`
22+ : the contributor's ORCID identifier.
23+
24+ `surname`
25+ : surname of the contributor. Usually the family name in
26+ western names.
27+
28+ See [`<surname>`][elem:surname].
29+
30+ `given-names`
31+ : personal names of the contributor; this includes middle
32+ names (if any) in western-style names.
33+
34+ See [`<given-names>`][elem:given-names].
35+
36+ `name`
37+ : full name of the author; included only as a fallback if
38+ `author.surname` is not available. Tagged with
39+ [`<string-name>`][elem:string-name].
40+
41+ `email`
42+ : the contributor's email address.
43+
44+ Used as the contents of the [`<email>`][elem:given-names]
45+ element.
46+
47+ `affiliation`
48+ : list of affiliation identifiers; marks the organizations
49+ with which an author is affiliated. Each identifier in this
50+ list must also occur as the `id` of an affiliation listed in
51+ the top-level `affiliation` list.
52+
53+ `equal-contrib`
54+ : boolean attribute used to mark authors who contributed
55+ equally to the work. The
56+ [`equal-contrib`][attr:equal-contrib] attribute is added
57+ to the author's [`<contrib>`] element if this is set to a
58+ truthy value.
59+
60+ `cor-id`
61+ : identifier linking to the contributor's correspondence
62+ information. The info itself must be stored in as an item in
63+ `article.author-notes.corresp`. If the `cor-id` value is
64+ then, an [`<xref>`][elem:xref] link of
65+ [`ref-type`][attr:ref-type] `corresp` is added. The
66+ [`rid`][attr:rid] attribute is set to `cor-<ID>`, where
67+ `<ID>` is the stringified value of this attribute.
68+
69+`affiliation`
70+: the list of organizations with which contributors are
71+ affiliated. Each institution is added as an [`<aff>`] element to
72+ the author's contrib-group.
73+
74+ The fields are given in the order in which they are included in
75+ the output.
76+
77+ `id`
78+ : internal identifier; used as the [`<aff>`] element's `id`
79+ value, prefixed with `aff-`.
80+
81+ `group`
82+ : name of the research group or other low-level organizational
83+ structure; used as value of an [`<institution>`] element with
84+ [`content-type`][attr:content-type] set to `group`.
85+
86+ `department`
87+ : name of the department or other mid-level organizational
88+ structure; used as value of an [`<institution>`] element with
89+ [`content-type`][attr:content-type] set to `dept`.
90+
91+ `organization`
92+ : name of the company, university, or other top-level
93+ organizational structure; used as value of an
94+ [`<institution>`] element. The institution element is wrapped
95+ in an [`<institution-wrap>`] element; any identifiers, like
96+ `ringgold` or `ror`, are added to the wrapper and must hence
97+ belong to this organization (not the department or group).
98+
99+ `isni`
100+ : International Standard Name Identifier of the organization.
101+ Added via an [`<institution-id>`] element with
102+ [`institution-id-type`](attr:institution-id-type) set to
103+ `ISNI`.
104+
105+ `ringgold`
106+ : [Ringgold] identifier of the organization. Added via an
107+ [`<institution-id>`] element with
108+ [`institution-id-type`](attr:institution-id-type) set to
109+ `Ringgold`.
110+
111+ `ror`
112+ : Research Organization Registry identifier of the
113+ organization. Added via an [`<institution-id>`] element with
114+ [`institution-id-type`](attr:institution-id-type) set to
115+ `ROR`.
116+
117+ `pid`
118+ : Array of persistent identifiers which are added as
119+ [`<institution-id>`] elements. Each item must contain a map
120+ with keys `type`, used as
121+ [`institution-id-type`](attr:institution-id-type), and `id`,
122+ used as element content.
123+
124+ `street-address`
125+ : The organization's street address; each list item is wrapped
126+ in an [`<addr-line>`] element, separated by a comma and
127+ space (`, `).
128+
129+ `city`
130+ : City in which the organization is located; used only if
131+ `street-address` is not given, in which case the value is
132+ wrapped in a [`<city>`] element.
133+
134+ `country`
135+ : Country in which the organization is located; used as the
136+ value of a [`<country>`] element.
137+
138+ `country-code`
139+ : Two letter ISO-3166-1 country identifier; used as the
140+ [`country`][attr:country] attribute in element [`<country>`]
141+ (if the latter is present).
142+
143+`copyright`
144+: Licensing and copyright information. This information is
145+ rendered via the [`<permissions>`][elem:permissions] element.
146+
147+ The variables `type`, `link`, and `text` should always be used
148+ together.
149+
150+ `statement`
151+ : the year of copyright; used as content of the
152+ [`<copyright-statement>`][elem:copyright-statement]
153+
154+ `year`
155+ : the year of copyright; used as content of the
156+ [`<copyright-year>`][elem:copyright-year]
157+
158+ `holder`
159+ : the copyright holder; included via the
160+ [`<copyright-holder>`][elem:copyright-holder] element.
161+
162+ `text`
163+ : inline text setting the license under which the text is
164+ published; included via the
165+ [`<license-p>`][elem:copyright-holder] element.
166+
167+ `type`
168+ : type of the license; used as value of the
169+ [`license-type`][attr:license-type] attribute.
170+
171+ `link`
172+ : external link describing the license; used as value of a
173+ `xlink:href` attribute in the `<license>` element.
174+
175+`date`
176+: publication date. This value should usually be a string
177+ representation of a date. Pandoc will parse and deconstruct the
178+ date into the components given below. It is also possible to
179+ pass these components directly.
180+
181+ The publication date is recorded in the document via the
182+ [`<pub-date>`] element and its sub-elements. The
183+ [`publication-format`][attr:publication-format] attribute is
184+ always set to `electronic`.
185+
186+ `iso-8601`
187+ : ISO-8601 representation of the publication date. Used as the
188+ value of the [`<pub-date>`] element's
189+ [`iso-8601-date`][attr:iso-8601-date] attribute.
190+
191+ This value is set automatically if pandoc can parse the
192+ `date` value as a date.
193+
194+ `day`, `month`, `year`
195+ : Day, month, and year of the publication date. Only the
196+ publication year is required. The values are used as the
197+ contents of the elements with the respective names.
198+
199+ The values are set automatically if pandoc can parse the
200+ `date` value as a date.
201+
202+ `type`
203+ : The type of event marked by this date. The value is set as
204+ the [`date-type`][attr:date-type] attribute on the
205+ [`<pub-date>`] element and defaults to "pub" if not
206+ specified.
207+
208+`article`
209+: information concerning the article that identifies or describes
210+ it. The key-value pairs within this map are typically used
211+ within the [`<article-meta>`][elem:article-meta] element.
212+
213+ `publisher-id`
214+ : external article identifier assigned by the publisher. Used
215+ as the content of the [`<article-id>`][elem:article-id]
216+ element with attribute [`pub-id-type`][attr:pub-id-type] set
217+ to `publisher-id`.
218+
219+ `doi`
220+ : Digital Object Identifier (DOI) assigned to the article.
221+ Used as the content of the [`<article-id>`][elem:article-id]
222+ element with attribute [`pub-id-type`][attr:pub-id-type] set
223+ to `doi`.
224+
225+ `pmid`
226+ : PubMed Identifier (PubMed ID) assigned to the article. Used
227+ as the content of the [`<article-id>`][elem:article-id]
228+ element with attribute [`pub-id-type`][attr:pub-id-type] set
229+ to `pmid`.
230+
231+ `pmcid`
232+ : PubMed Central Identifier assigned to the article. Used as
233+ the content of the [`<article-id>`][elem:article-id] element
234+ with attribute [`pub-id-type`][attr:pub-id-type] set to
235+ `pmcid`.
236+
237+ `art-access-id`
238+ : generic article accession identifier. Used as the content of
239+ the [`<article-id>`][elem:article-id] element with attribute
240+ [`pub-id-type`][attr:pub-id-type] set to `art-access-id`.
241+
242+ `heading`
243+ : name of a subject or topic describing the article. Used as
244+ the content of the [`<subject>`][elem:subject] element,
245+ nested in a [`<subj-group>`][elem:subj-group] element which
246+ has `heading` as its
247+ [`subj-group-type`][attr:subj-group-type] attribute.
248+
249+ `categories`
250+ : list a subject or topic describing the article. Items are
251+ each used as the content a the [`<subject>`][elem:subject]
252+ element, grouped in a single
253+ [`<subj-group>`][elem:subj-group] element with its
254+ [`subj-group-type`][attr:subj-group-type] attribute set to
255+ `categories`.
256+
257+ `author-notes`
258+ : Additional information about authors, like conflict of
259+ interest statements and corresponding author contact info.
260+ Wrapped in an [`<author-notes>`][elem:author-notes] element.
261+
262+ `conflict`
263+ : Conflict of interest statement. Rendered as a footnote
264+ ([`<fn>`][elem:fn]) of [`fn-type`](attr:fn-type)
265+ `conflict`.
266+
267+ `con`
268+ : Contributed-by information. Rendered as a footnote
269+ ([`<fn>`][elem:fn]) of [`fn-type`](attr:fn-type) `con`.
270+
271+ `corresp`
272+ : Correspondence information. This must be a list of
273+ contributor correspondence items, where each item must
274+ have the properties `id` and `email`. The info is then
275+ rendered via a [`<corresp>`][elem:corresp] element.
276+
277+ `funding-statement`
278+ : Prose describing the funding. Added to the article's
279+ frontmatter via the
280+ [`funding-statement`][elem:funding-statement] element.
281+
282+`journal`
283+: information on the journal in which the article is published.
284+ This must be a map; the following key/value pairs are
285+ recognized.
286+
287+ `publisher-id`
288+ : journal identifier assigned by the publisher. Used as
289+ content of element [`<journal-id>`][elem:journal-id] with
290+ attribute [`journal-id-type`][attr:journal-id-type] set to
291+ `publisher-id`.
292+
293+ `nlm-ta`
294+ : journal identifier assigned by PubMed. Used as content of
295+ element [`<journal-id>`][elem:journal-id] with attribute
296+ [`journal-id-type`][attr:journal-id-type] set to `nlm-ta`.
297+
298+ `pmc`
299+ : journal identifier assigned by PubMed Central. Used as
300+ content of element [`<journal-id>`][elem:journal-id] with
301+ attribute [`journal-id-type`][attr:journal-id-type] set to
302+ `pmc`.
303+
304+ `title`
305+ : full title of the journal in which the article is published.
306+ Used as content of the
307+ [`<journal-title>`][elem:journal-title] element.
308+
309+ `abbrev-title`
310+ : short form of the journal title. Used as content of the
311+ [`<abbrev-journal-title>`][elem:abbrev-journal-title]
312+ element.
313+
314+ `pissn`
315+ : ISSN identifier of the publication's print version. Used as
316+ content of the [`<issn>`][elem:issn] element with the
317+ [`publication-format`][attr:publication-format] attribute
318+ set to `print`.
319+
320+ `eissn`
321+ : ISSN identifier of the publication's electronic version.
322+ Used as content of the [`<issn>`][elem:issn] element with
323+ the [`publication-format`][attr:publication-format]
324+ attribute set to `electronic`.
325+
326+ `publisher-name`
327+ : name of the publishing entity (person, company, or other).
328+ Used as the content of the
329+ [`<publisher-name>`][elem:publisher-name] element.
330+
331+ `publisher-loc`
332+ : place of publication. Used as the content of the
333+ [`<publisher-loc>`][elem:publisher-loc] element.
334+
335+`notes`
336+: Additional notes concerning the whole article. Added to the
337+ article's frontmatter via the [`<notes>`][elem:notes] element.
338+
339+`tags`
340+: list of keywords. Items are used as contents of the
341+ [`<kwd>`][elem:kwd] element; the elements are grouped in a
342+ [`<kwd-group>`][elem:kwd-group] with the
343+ [`kwd-group-type`][attr:kwd-group-type] value `author`.
344+
345+Required Metadata
346+-----------------
347+
348+Pandoc will try to generate a valid JATS document even when
349+information is missing, filling in placeholders or using empty
350+values. This circumvents the intend to ensure a minimum set of
351+information being present in documents of a certain tag set. It is
352+hence recommended to always provide the information listed below.
353+
354+### Publishing Tag Set
355+
356+Required metadata values:
357+
358+- One or more of `journal.publisher-id`, `journal.nlm-ta`,
359+ `journal.pmc`.
360+- One or more of `journal.pissn`, `journal.eissn`.
361+
362+[Ringgold]: https://ringgold.com/
363+[attr:content-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/content-type.html
364+[attr:date-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/date-type.html
365+[attr:equal-contrib]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/equal-contrib.html
366+[attr:fn-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/fn-type.html
367+[attr:institution-id-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/institution-id-type.html
368+[attr:iso-8601-date]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/iso-8601-date.html
369+[attr:journal-id-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/journal-id-type.html
370+[attr:kwd-group-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/kwd-group-type.html
371+[attr:license-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/license-type.html
372+[attr:pub-id-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/pub-id-type.html
373+[attr:publication-format]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/publication-format.html
374+[attr:ref-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/ref-type.html
375+[attr:rid]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/rid.html
376+[attr:subj-group-type]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/attribute/subj-group-type.html
377+[elem:abbrev-journal-title]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/abbrev-journal-title.html
378+[elem:abstract]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/abstract.html
379+[elem:article-id]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/article-id.html
380+[elem:article-meta]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/article-meta.html
381+[elem:copyright-holder]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/copyright-holder.html
382+[elem:copyright-statement]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/copyright-statement.html
383+[elem:copyright-year]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/copyright-year.html
384+[elem:corresp]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/corresp.html
385+[elem:email]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/email.html
386+[elem:fn]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/fn.html
387+[elem:funding-statement]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/funding-statement.html
388+[elem:given-names]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/given-names.html
389+[elem:issn]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/issn.html
390+[elem:journal-id]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/journal-id.html
391+[elem:journal-title]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/journal-title.html
392+[elem:kwd-group]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/kwd-group.html
393+[elem:kwd]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/kwd.html
394+[elem:license-p]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/license-p.html
395+[elem:license]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/license.html
396+[elem:notes]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/notes.html
397+[elem:permissions]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/permissions.html
398+[elem:publisher-loc]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/publisher-loc.html
399+[elem:publisher-name]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/publisher-name.html
400+[elem:string-name]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/string-name.html
401+[elem:subj-group]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/subj-group.html
402+[elem:subject]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/subject.html
403+[elem:surname]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/surname.html
404+[elem:xref]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/xref.html
405+
406+[`<addr-line>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/addr-line.html
407+[`<aff>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/aff.html
408+[`<city>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/city.html
409+[`<contrib>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/contrib.html
410+[`<country>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/country.html
411+[`<institution-id>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/institution-id.html
412+[`<institution-wrap>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/institution-wrap.html
413+[`<institution>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/institution.html
414+[`<pub-date>`]: https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/pub-date.html
doc/libraries.mdnew file+63
@@ -0,0 +1,63 @@
1+---
2+title: The pandoc family of libraries
3+author: John MacFarlane
4+---
5+
6+The following Haskell libraries have been developed to support
7+pandoc:
8+
9+[skylighting-core] and [skylighting]
10+: Syntax highlighting engine supporting over 140 languages.
11+
12+[citeproc]
13+: Citation processing using CSL stylesheets.
14+
15+[texmath]
16+: Conversion of math between tex, Word equation, MathML, and GNU eqn.
17+
18+[unicode-collation]
19+: Proper Unicode collation (sorting).
20+
21+[doclayout]
22+: Combinators for laying out a textual document, with support
23+ for line wrapping, tabular layout, and more.
24+
25+[doctemplates]
26+: Supports pandoc's templates.
27+
28+[commonmark], [commonmark-extensions], and [commonmark-pandoc]
29+: Efficient, standards-compliant parser for commonmark and extensions.
30+
31+[ipynb]
32+: Representation of Jupyter notebooks and conversion to and
33+ from JSON.
34+
35+[zip-archive]
36+: A pure zip file creator and extractor, used by pandoc for
37+ docx, ODT, and EPUB.
38+
39+[rfc5051]
40+: Simple unicode collation (used for citation sorting).
41+
42+[emojis]
43+: Conversion between emoji characters and aliases.
44+
45+[jira-wiki-markup]
46+: Support for parsing Jira wiki syntax.
47+
48+[skylighting]: https://hackage.haskell.org/package/skylighting
49+[skylighting-core]: https://hackage.haskell.org/package/skylighting-core
50+[citeproc]: https://hackage.haskell.org/package/citeproc
51+[texmath]: https://hackage.haskell.org/package/texmath
52+[doclayout]: https://hackage.haskell.org/package/doclayout
53+[doctemplates]: https://hackage.haskell.org/package/doctemplates
54+[commonmark]: https://hackage.haskell.org/package/commonmark
55+[commonmark-extensions]: https://hackage.haskell.org/package/commonmark-extensions
56+[commonmark-pandoc]: https://hackage.haskell.org/package/commonmark-pandoc
57+[ipynb]: https://hackage.haskell.org/package/ipynb
58+[zip-archive]: https://hackage.haskell.org/package/zip-archive
59+[rfc5051]: https://hackage.haskell.org/package/rfc5051
60+[emojis]: https://hackage.haskell.org/package/emojis
61+[jira-wiki-markup]: https://hackage.haskell.org/package/jira-wiki-markup
62+[unicode-collation]: https://hackage.haskell.org/package/unicode-collation
63+
doc/lua-filters.md+219−28
@@ -32,7 +32,7 @@ Starting with version 2.0, pandoc makes it possible to write
3232filters in Lua without any external dependencies at all. A Lua
3333interpreter (version 5.3) and a Lua library for creating pandoc
3434filters is built into the pandoc executable. Pandoc data types
35−are marshalled to Lua directly, avoiding the overhead of writing
35+are marshaled to Lua directly, avoiding the overhead of writing
3636JSON to stdout and reading it from stdin.
3737
3838Here is an example of a Lua filter that converts strong emphasis
@@ -75,7 +75,7 @@ Python (`smallcaps.py`):
7575 `pandoc --lua-filter ./smallcaps.lua` 1.03s
7676
7777As you can see, the Lua filter avoids the substantial overhead
78−associated with marshalling to and from JSON over a pipe.
78+associated with marshaling to and from JSON over a pipe.
7979
8080# Lua filter structure
8181
@@ -109,7 +109,7 @@ element filtering function. In other words, filter entries will
109109be called for each corresponding element in the document,
110110getting the respective element as input.
111111
112−The return of a filter function must one of the following:
112+The return of a filter function must be one of the following:
113113
114114- nil: this means that the object should remain unchanged.
115115- a pandoc object: this must be of the same type as the input
@@ -292,7 +292,7 @@ use-case would be to load additional modules, or even to alter
292292default modules.
293293
294294The following snippet is an example of code that might be useful
295−when added to `init.lua`. The snippet adds all unicode-aware
295+when added to `init.lua`. The snippet adds all Unicode-aware
296296functions defined in the [`text` module](#module-text) to the
297297default `string` module, prefixed with the string `uc_`.
298298
@@ -307,21 +307,25 @@ colon syntax (`mystring:uc_upper()`).
307307
308308# Debugging Lua filters
309309
310−It is possible to use a debugging interface to halt execution and step through a
311−Lua filter line by line as it is run inside Pandoc. This is accomplished using
312−the remote-debugging interface of the package
313−[`mobdebug`](https://github.com/pkulchenko/MobDebug). Although mobdebug can be
314−run from the terminal, it is more useful run within the donation-ware Lua editor
315−and IDE, [Zerobrane](https://studio.zerobrane.com/). Zerobrane offers a REPL
316−console and UI to step-through and view all variables and state.
310+It is possible to use a debugging interface to halt execution and
311+step through a Lua filter line by line as it is run inside Pandoc.
312+This is accomplished using the remote-debugging interface of the
313+package [`mobdebug`](https://github.com/pkulchenko/MobDebug).
314+Although mobdebug can be run from the terminal, it is more useful
315+run within the donation-ware Lua editor and IDE,
316+[ZeroBrane](https://studio.zerobrane.com/). ZeroBrane offers a
317+REPL console and UI to step-through and view all variables and
318+state.
317319
318320If you already have Lua 5.3 installed, you can add
319−[`mobdebug`](https://luarocks.org/modules/paulclinger/mobdebug) and its
320−dependency [`luasocket`](https://luarocks.org/modules/luasocket/luasocket) using
321−[`luarocks`](https://luarocks.org), which should then be available on the path.
322−Zerobrane also includes both of these in its package, so if you don't want to
323−install Lua seperately, you should add/modify your `LUA_PATH` and `LUA_CPATH` to
324−include the correct locations; [see detailed instructions
321+[`mobdebug`](https://luarocks.org/modules/paulclinger/mobdebug)
322+and its dependency
323+[`luasocket`](https://luarocks.org/modules/luasocket/luasocket)
324+using [`luarocks`](https://luarocks.org), which should then be
325+available on the path. ZeroBrane also includes both of these in
326+its package, so if you don't want to install Lua separately, you
327+should add/modify your `LUA_PATH` and `LUA_CPATH` to include the
328+correct locations; [see detailed instructions
325329here](https://studio.zerobrane.com/doc-remote-debugging).
326330
327331# Examples
@@ -1509,7 +1513,7 @@ with the [`pandoc.Attr`](#pandoc.attr) constructor. For
15091513convenience, it is usually not necessary to construct the value
15101514directly if it is part of an element, and it is sufficient to
15111515pass an HTML-like table. E.g., to create a span with identifier
1512−"text" and classes "a" and "b", on can write:
1516+"text" and classes "a" and "b", one can write:
15131517
15141518 local span = pandoc.Span('text', {id = 'text', class = 'a b'})
15151519
@@ -1765,7 +1769,7 @@ A list is any Lua table with integer indices. Indices start at
17651769one, so if `alist = {'value'}` then `alist[1] == 'value'`.
17661770
17671771Lists, when part of an element, or when generated during
1768−marshalling, are made instances of the `pandoc.List` type for
1772+marshaling, are made instances of the `pandoc.List` type for
17691773convenience. The `pandoc.List` type is defined in the
17701774[*pandoc.List*](#module-pandoc.list) module. See there for
17711775available methods.
@@ -2250,7 +2254,7 @@ format, and functions to filter and modify a subtree.
22502254
22512255[`Emph (content)`]{#pandoc.emph}
22522256
2253−: Creates an inline element representing emphasised text.
2257+: Creates an inline element representing emphasized text.
22542258
22552259 Parameters:
22562260
@@ -2453,7 +2457,7 @@ format, and functions to filter and modify a subtree.
24532457
24542458[`Strikeout (content)`]{#pandoc.strikeout}
24552459
2456−: Creates text which is striked out.
2460+: Creates text which is struck out.
24572461
24582462 Parameters:
24592463
@@ -2601,7 +2605,8 @@ format, and functions to filter and modify a subtree.
26012605 local caption = "Overview"
26022606 local aligns = {pandoc.AlignDefault, pandoc.AlignDefault}
26032607 local widths = {0, 0} -- let pandoc determine col widths
2604− local headers = {"Language", "Typing"}
2608+ local headers = {{pandoc.Plain({pandoc.Str "Language"})},
2609+ {pandoc.Plain({pandoc.Str "Typing"})}}
26052610 local rows = {
26062611 {{pandoc.Plain "Haskell"}, {pandoc.Plain "static"}},
26072612 {{pandoc.Plain "Lua"}, {pandoc.Plain "Dynamic"}},
@@ -2912,7 +2917,7 @@ Usage:
29122917
29132918`make_sections (number_sections, base_level, blocks)`
29142919
2915−Converst list of [Blocks](#type-block) into sections.
2920+Converts list of [Blocks](#type-block) into sections.
29162921`Div`s will be created beginning at each `Header`
29172922and containing following content until the next `Header`
29182923of comparable level. If `number_sections` is true,
@@ -3079,7 +3084,8 @@ Clear-out the media bag, deleting all items.
30793084
30803085`insert (filepath, mime_type, contents)`
30813086
3082−Adds a new entry to pandoc's media bag.
3087+Adds a new entry to pandoc's media bag. Replaces any existing
3088+mediabag entry with the same `filepath`.
30833089
30843090Parameters:
30853091
@@ -3087,7 +3093,7 @@ Parameters:
30873093: filename and path relative to the output folder.
30883094
30893095`mime_type`:
3090−: the file's MIME type
3096+: the file's MIME type; use `nil` if unknown or unavailable.
30913097
30923098`contents`:
30933099: the binary contents of the file.
@@ -3171,12 +3177,22 @@ Usage:
31713177
31723178### fetch {#pandoc.mediabag.fetch}
31733179
3174−`fetch (source, base_url)`
3180+`fetch (source)`
31753181
31763182Fetches the given source from a URL or local file. Returns two
31773183values: the contents of the file and the MIME type (or an empty
31783184string).
31793185
3186+The function will first try to retrieve `source` from the
3187+mediabag; if that fails, it will try to download it or read it
3188+from the local file system while respecting pandoc's "resource
3189+path" setting.
3190+
3191+Parameters:
3192+
3193+`source`:
3194+: path to a resource; either a local file path or URI
3195+
31803196Returns:
31813197
31823198- the entries MIME type, or nil if the file was not found.
@@ -3185,11 +3201,11 @@ Returns:
31853201Usage:
31863202
31873203 local diagram_url = "https://pandoc.org/diagram.jpg"
3188− local mt, contents = pandoc.mediabag.fetch(diagram_url, ".")
3204+ local mt, contents = pandoc.mediabag.fetch(diagram_url)
31893205
31903206# Module pandoc.List
31913207
3192−The this module defines pandoc's list type. It comes with useful
3208+This module defines pandoc's list type. It comes with useful
31933209methods and convenience functions.
31943210
31953211## Constructor
@@ -3371,6 +3387,181 @@ methods and convenience functions.
33713387 `comp`:
33723388 : Comparison function as described above.
33733389
3390+# Module pandoc.path
3391+
3392+Module for file path manipulations.
3393+
3394+## Static Fields {#pandoc.path-fields}
3395+
3396+### separator {#pandoc.path.separator}
3397+
3398+The character that separates directories.
3399+
3400+### search_path_separator {#pandoc.path.search_path_separator}
3401+
3402+The character that is used to separate the entries in the `PATH`
3403+environment variable.
3404+
3405+## Functions {#pandoc.path-functions}
3406+
3407+### directory (filepath) {#pandoc.path.directory}
3408+
3409+Gets the directory name, i.e., removes the last directory
3410+separator and everything after from the given path.
3411+
3412+Parameters:
3413+
3414+filepath
3415+: path (string)
3416+
3417+Returns:
3418+
3419+- The filepath up to the last directory separator. (string)
3420+
3421+### filename (filepath) {#pandoc.path.filename}
3422+
3423+Get the file name.
3424+
3425+Parameters:
3426+
3427+filepath
3428+: path (string)
3429+
3430+Returns:
3431+
3432+- File name part of the input path. (string)
3433+
3434+### is_absolute (filepath) {#pandoc.path.is_absolute}
3435+
3436+Checks whether a path is absolute, i.e. not fixed to a root.
3437+
3438+Parameters:
3439+
3440+filepath
3441+: path (string)
3442+
3443+Returns:
3444+
3445+- `true` iff `filepath` is an absolute path, `false` otherwise.
3446+ (boolean)
3447+
3448+### is_relative (filepath) {#pandoc.path.is_relative}
3449+
3450+Checks whether a path is relative or fixed to a root.
3451+
3452+Parameters:
3453+
3454+filepath
3455+: path (string)
3456+
3457+Returns:
3458+
3459+- `true` iff `filepath` is a relative path, `false` otherwise.
3460+ (boolean)
3461+
3462+### join (filepaths) {#pandoc.path.join}
3463+
3464+Join path elements back together by the directory separator.
3465+
3466+Parameters:
3467+
3468+filepaths
3469+: path components (list of strings)
3470+
3471+Returns:
3472+
3473+- The joined path. (string)
3474+
3475+### make_relative (path, root[, unsafe]) {#pandoc.path.make_relative}
3476+
3477+Contract a filename, based on a relative path. Note that the
3478+resulting path will usually not introduce `..` paths, as the
3479+presence of symlinks means `../b` may not reach `a/b` if it starts
3480+from `a/c`. For a worked example see [this blog
3481+post](https://neilmitchell.blogspot.co.uk/2015/10/filepaths-are-subtle-symlinks-are-hard.html).
3482+
3483+Set `unsafe` to a truthy value to a allow `..` in paths.
3484+
3485+Parameters:
3486+
3487+path
3488+: path to be made relative (string)
3489+
3490+root
3491+: root path (string)
3492+
3493+unsafe
3494+: whether to allow `..` in the result. (boolean)
3495+
3496+Returns:
3497+
3498+- contracted filename (string)
3499+
3500+### normalize (filepath) {#pandoc.path.normalize}
3501+
3502+Normalizes a path.
3503+
3504+- `//` makes sense only as part of a (Windows) network drive;
3505+ elsewhere, multiple slashes are reduced to a single
3506+ `path.separator` (platform dependent).
3507+- `/` becomes `path.separator` (platform dependent)
3508+- `./` -\> ''
3509+- an empty path becomes `.`
3510+
3511+Parameters:
3512+
3513+filepath
3514+: path (string)
3515+
3516+Returns:
3517+
3518+- The normalized path. (string)
3519+
3520+### split (filepath) {#pandoc.path.split}
3521+
3522+Splits a path by the directory separator.
3523+
3524+Parameters:
3525+
3526+filepath
3527+: path (string)
3528+
3529+Returns:
3530+
3531+- List of all path components. (list of strings)
3532+
3533+### split_extension (filepath) {#pandoc.path.split_extension}
3534+
3535+Splits the last extension from a file path and returns the parts. The
3536+extension, if present, includes the leading separator; if the path has
3537+no extension, then the empty string is returned as the extension.
3538+
3539+Parameters:
3540+
3541+filepath
3542+: path (string)
3543+
3544+Returns:
3545+
3546+- filepath without extension (string)
3547+
3548+- extension or empty string (string)
3549+
3550+### split_search_path (search_path) {#pandoc.path.split_search_path}
3551+
3552+Takes a string and splits it on the `search_path_separator` character.
3553+Blank items are ignored on Windows, and converted to `.` on Posix. On
3554+Windows path elements are stripped of quotes.
3555+
3556+Parameters:
3557+
3558+search_path
3559+: platform-specific search path (string)
3560+
3561+Returns:
3562+
3563+- list of directories in search path (list of strings)
3564+
33743565# Module pandoc.system
33753566
33763567Access to system information and functionality.
doc/org.md+22−5
@@ -22,10 +22,10 @@ The following export keywords are supported:
2222- EMAIL: author email address; passed as plain-text metadata
2323 field `email`, but not used by any default templates.
2424
25−- LANGUAGE: currently unsupported; use `#+LANG:` instead.
25+- LANGUAGE: document language; included as plain-text metadata
26+ field `lang`. The value should be a [BCP47 language tag].
2627
27−- SELECT_TAGS: tags which select a tree for export. Currently
28− *unsupported*.
28+- SELECT_TAGS: tags which select a tree for export.
2929
3030- EXCLUDE\_TAGS: tags which prevent a subtree from being
3131 exported. Fully supported.
@@ -36,6 +36,23 @@ The following export keywords are supported:
3636 defaults to stdout unless a target has to be given as a command
3737 line option.
3838
39+::: {.alert .alert-info}
40+Pandoc tries to be compatible with org-mode when exporting an org document. If
41+you find some behavior confusing, please do refer to org-mode
42+[Export-Settings](https://orgmode.org/manual/Export-Settings.html)
43+documentation. For example, a common confusion
44+([#3214](https://github.com/jgm/pandoc/issues/3214 "Problem with headers lower
45+then 3 in org-mode reader"), [#5169](https://github.com/jgm/pandoc/issues/5169
46+"org mode headings past level three converted to numbered outline list"),
47+[#6145](https://github.com/jgm/pandoc/issues/6145 "Headers 4 levels deep render
48+differently"), [#7236](https://github.com/jgm/pandoc/issues/7236 "In Org mode,
49+Header with level > 3 are not recognized as headers")) is treatment of headers
50+with level > 3 differently because org-mode sets `org-export-headline-levels`
51+(configurable with `#+OPTIONS: H:3`) to 3 by default.
52+:::
53+
54+[BCP47 language tag]: https://tools.ietf.org/html/bcp47
55+
3956Format-specific options
4057-----------------------
4158
@@ -206,7 +223,7 @@ Example:
206223
207224### Parenthetical citation
208225
209−Citations surrounded by parantheses. The syntax is identical to
226+Citations surrounded by parentheses. The syntax is identical to
210227in-text citations, except for the additional parentheses enclosing
211228the initial `cite` tag.
212229
@@ -267,7 +284,7 @@ Use normal latex citation commands like `\cite{x}` or
267284Tables
268285======
269286
270−Pandoc supports normal org tables (sometimes calles "pipe tables")
287+Pandoc supports normal org tables (sometimes called "pipe tables")
271288and grid tables (tables created by [table.el]).
272289
273290Column widths
doc/using-the-pandoc-api.md+28−15
@@ -14,7 +14,7 @@ and types is available at
1414Pandoc is structured as a set of *readers*, which translate
1515various input formats into an abstract syntax tree (the
1616Pandoc AST) representing a structured document, and a set of
17−*writers*, which render this AST into various input formats.
17+*writers*, which render this AST into various output formats.
1818Pictorially:
1919
2020```
@@ -90,8 +90,14 @@ Some notes:
9090Let's look at the types of `readMarkdown` and `writeRST`:
9191
9292```haskell
93−readMarkdown :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
94−writeRST :: PandocMonad m => WriterOptions -> Pandoc -> m Text
93+readMarkdown :: (PandocMonad m, ToSources a)
94+ => ReaderOptions
95+ -> a
96+ -> m Pandoc
97+writeRST :: PandocMonad m
98+ => WriterOptions
99+ -> Pandoc
100+ -> m Text
95101```
96102
97103The `PandocMonad m =>` part is a typeclass constraint.
@@ -120,7 +126,7 @@ getVerbosity :: PandocMonad m => m Verbosity
120126-- | Set the verbosity level.
121127setVerbosity :: PandocMonad m => Verbosity -> m ()
122128
123−-- Get the accomulated log messages (in temporal order).
129+-- Get the accumulated log messages (in temporal order).
124130getLog :: PandocMonad m => m [LogMessage]
125131getLog = reverse <$> getsCommonState stLog
126132
@@ -133,7 +139,7 @@ report :: PandocMonad m => LogMessage -> m ()
133139-- | Fetch an image or other item from the local filesystem or the net.
134140-- Returns raw content and maybe mime type.
135141fetchItem :: PandocMonad m
136− => String
142+ => Text
137143 -> m (B.ByteString, Maybe MimeType)
138144
139145-- Set the resource path searched by 'fetchItem'.
@@ -155,6 +161,13 @@ Note that `PandocIO` is an instance of `MonadIO`, so you can
155161use `liftIO` to perform arbitrary IO operations inside a pandoc
156162conversion chain.
157163
164+`readMarkdown` is polymorphic in its second argument, which
165+can be any type that is an instance of the `ToSources`
166+typeclass. You can use `Text`, as in the example above.
167+But you can also use `[(FilePath, Text)]`, if the input comes
168+from multiple files and you want to track source positions
169+accurately.
170+
158171# Options
159172
160173The first argument of each reader or writer is for
@@ -200,8 +213,8 @@ of the Monoid typeclass and can easily be concatenated:
200213import Text.Pandoc.Builder
201214
202215mydoc :: Pandoc
203−mydoc = doc $ header 1 (text "Hello!")
204− <> para (emph (text "hello world") <> text ".")
216+mydoc = doc $ header 1 (text (T.pack "Hello!"))
217+ <> para (emph (text (T.pack "hello world")) <> text (T.pack "."))
205218
206219main :: IO ()
207220main = print mydoc
@@ -248,16 +261,16 @@ import qualified Data.Text as T
248261import Data.List (intersperse)
249262
250263data Station = Station{
251− address :: String
252− , name :: String
253− , cardsAccepted :: [String]
264+ address :: T.Text
265+ , name :: T.Text
266+ , cardsAccepted :: [T.Text]
254267 } deriving Show
255268
256269instance FromJSON Station where
257270 parseJSON (Object v) = Station <$>
258271 v .: "street_address" <*>
259272 v .: "station_name" <*>
260− (words <$> (v .:? "cards_accepted" .!= ""))
273+ (T.words <$> (v .:? "cards_accepted" .!= ""))
261274 parseJSON _ = mzero
262275
263276createLetter :: [Station] -> Pandoc
@@ -315,7 +328,7 @@ users to override the system defaults. If you want to disable
315328this behavior, use `setUserDataDir Nothing`.
316329
317330To render a template, use `renderTemplate'`, which takes two
318−arguments, a template (String) and a context (any instance
331+arguments, a template (Text) and a context (any instance
319332of ToJSON). If you want to create a context from the metadata
320333part of a Pandoc document, use `metaToJSON'` from
321334[Text.Pandoc.Writers.Shared]. If you also want to incorporate
@@ -337,7 +350,7 @@ use `throwError`.
337350In addition to errors, which stop execution of the conversion
338351pipeline, one can generate informational messages.
339352Use `report` from [Text.Pandoc.Class] to issue a `LogMessage`.
340−For a list of cosntructors for `LogMessage`, see
353+For a list of constructors for `LogMessage`, see
341354[Text.Pandoc.Logging]. Note that each type of log message
342355is associated with a verbosity level. The verbosity level
343356(`setVerbosity`/`getVerbosity`) determines whether the report
@@ -413,7 +426,7 @@ concatenated together. Here's an example that returns a
413426list of the URLs linked to in a document:
414427
415428```haskell
416−listURLs :: Pandoc -> [String]
429+listURLs :: Pandoc -> [Text]
417430listURLs = query urls
418431 where urls (Link _ _ (src, _)) = [src]
419432 urls _ = []
@@ -432,7 +445,7 @@ structure and calling this function.
4324451. Pandoc's parsers can exhibit pathological behavior on some
433446 inputs. So it is always a good idea to wrap uses of pandoc
434447 in a timeout function (e.g. `System.Timeout.timeout` from `base`)
435− to prevent DOS attacks.
448+ to prevent DoS attacks.
436449
4374502. If pandoc generates HTML from untrusted user input, it is
438451 always a good idea to filter the generated HTML through
linux/make_artifacts.sh+19−7
@@ -2,13 +2,23 @@ set -e
22
33MACHINE=$(uname -m)
44case "$MACHINE" in
5− x86_64) ARCHITECTURE=amd64;;
6− i686) ARCHITECTURE=i386;;
7− i386) ARCHITECTURE=i386;;
5+ x86_64) ARCHITECTURE=amd64;;
6+ i686) ARCHITECTURE=i386;;
7+ i386) ARCHITECTURE=i386;;
8+ aarch64) ARCHITECTURE=arm64;;
9+ *) ARCHITECTURE=unknown;;
810esac
911
1012ARTIFACTS="${ARTIFACTS:-/artifacts}"
1113
14+# This is our sentinel that tells us when we're done.
15+rm -f $ARTIFACTS/DONE
16+
17+clean_up() {
18+ echo "All done!" > "$ARTIFACTS/DONE"
19+}
20+trap clean_up EXIT
21+
1222# build binaries
1323
1424cabal --version
@@ -16,9 +26,9 @@ ghc --version
1626
1727cabal v2-update
1828cabal v2-clean
19−cabal v2-configure --enable-tests -f-export-dynamic -fstatic -fembed_data_files -fbibutils --enable-executable-static --ghc-options '-optc-Os -optl=-pthread -split-sections' pandoc
20−cabal v2-build
21−cabal v2-test -j1
29+cabal v2-configure --enable-tests -f-export-dynamic -fembed_data_files --enable-executable-static --ghc-options '-j4 +RTS -A256m -RTS -split-sections -optc-Os -optl=-pthread' pandoc
30+cabal v2-build -j4
31+cabal v2-test -j4
2232for f in $(find dist-newstyle -name 'pandoc' -type f -perm /400); do cp $f /artifacts/; done
2333
2434# make deb
@@ -68,5 +78,7 @@ mv pandoc $TARGET/bin
6878strip $TARGET/bin/pandoc
6979gzip -9 $TARGET/share/man/man1/pandoc.1
7080
71−tar cvzf $TARGET-linux-amd64.tar.gz $TARGET
81+tar cvzf $TARGET-linux-$ARCHITECTURE.tar.gz $TARGET
7282rm -r $TARGET
83+
84+exit 0
man/pandoc.1+484−132
@@ -1,7 +1,7 @@
1−.\"t
2−.\" Automatically generated by Pandoc 2.11
1+'\" t
2+.\" Automatically generated by Pandoc 2.14.0.1
33.\"
4−.TH "Pandoc User\[cq]s Guide" "" "July 23, 2020" "pandoc 2.11" ""
4+.TH "Pandoc User\[cq]s Guide" "" "June 20, 2021" "pandoc 2.14.0.3" ""
55.hy
66.SH NAME
77pandoc - general markup converter
@@ -172,13 +172,12 @@ You can then test it with \f[C]pdflatex test.tex\f[R].
172172When using LaTeX, the following packages need to be available (they are
173173included with all recent versions of TeX Live): \f[C]amsfonts\f[R],
174174\f[C]amsmath\f[R], \f[C]lm\f[R], \f[C]unicode-math\f[R],
175−\f[C]ifxetex\f[R], \f[C]ifluatex\f[R], \f[C]listings\f[R] (if the
176−\f[C]--listings\f[R] option is used), \f[C]fancyvrb\f[R],
177−\f[C]longtable\f[R], \f[C]booktabs\f[R], \f[C]graphicx\f[R] (if the
178−document contains images), \f[C]hyperref\f[R], \f[C]xcolor\f[R],
179−\f[C]ulem\f[R], \f[C]geometry\f[R] (with the \f[C]geometry\f[R] variable
180−set), \f[C]setspace\f[R] (with \f[C]linestretch\f[R]), and
181−\f[C]babel\f[R] (with \f[C]lang\f[R]).
175+\f[C]iftex\f[R], \f[C]listings\f[R] (if the \f[C]--listings\f[R] option
176+is used), \f[C]fancyvrb\f[R], \f[C]longtable\f[R], \f[C]booktabs\f[R],
177+\f[C]graphicx\f[R] (if the document contains images),
178+\f[C]hyperref\f[R], \f[C]xcolor\f[R], \f[C]ulem\f[R], \f[C]geometry\f[R]
179+(with the \f[C]geometry\f[R] variable set), \f[C]setspace\f[R] (with
180+\f[C]linestretch\f[R]), and \f[C]babel\f[R] (with \f[C]lang\f[R]).
182181The use of \f[C]xelatex\f[R] or \f[C]lualatex\f[R] as the PDF engine
183182requires \f[C]fontspec\f[R].
184183\f[C]lualatex\f[R] uses \f[C]selnolig\f[R].
@@ -320,6 +319,10 @@ Specify output format.
320319.IP \[bu] 2
321320\f[C]beamer\f[R] (LaTeX beamer slide show)
322321.IP \[bu] 2
322+\f[C]bibtex\f[R] (BibTeX bibliography)
323+.IP \[bu] 2
324+\f[C]biblatex\f[R] (BibLaTeX bibliography)
325+.IP \[bu] 2
323326\f[C]commonmark\f[R] (CommonMark Markdown)
324327.IP \[bu] 2
325328\f[C]commonmark_x\f[R] (CommonMark Markdown with extensions)
@@ -454,16 +457,15 @@ On *nix and macOS systems this will be the \f[C]pandoc\f[R] subdirectory
454457of the XDG data directory (by default, \f[C]$HOME/.local/share\f[R],
455458overridable by setting the \f[C]XDG_DATA_HOME\f[R] environment
456459variable).
457−If that directory does not exist, \f[C]$HOME/.pandoc\f[R] will be used
458−(for backwards compatibility).
459−In Windows the default user data directory is
460+If that directory does not exist and \f[C]$HOME/.pandoc\f[R] exists, it
461+will be used (for backwards compatibility).
462+On Windows the default user data directory is
460463\f[C]C:\[rs]Users\[rs]USERNAME\[rs]AppData\[rs]Roaming\[rs]pandoc\f[R].
461464You can find the default user data directory on your system by looking
462465at the output of \f[C]pandoc --version\f[R].
463−A \f[C]reference.odt\f[R], \f[C]reference.docx\f[R], \f[C]epub.css\f[R],
464−\f[C]templates\f[R], \f[C]slidy\f[R], \f[C]slideous\f[R], or
465−\f[C]s5\f[R] directory placed in this directory will override
466−pandoc\[cq]s normal defaults.
466+Data files placed in this directory (for example,
467+\f[C]reference.odt\f[R], \f[C]reference.docx\f[R], \f[C]epub.css\f[R],
468+\f[C]templates\f[R]) will override pandoc\[cq]s normal defaults.
467469.TP
468470\f[B]\f[CB]-d\f[B]\f[R] \f[I]FILE\f[R], \f[B]\f[CB]--defaults=\f[B]\f[R]\f[I]FILE\f[R]
469471Specify a set of default option settings.
@@ -623,13 +625,13 @@ above).
623625.IP "3." 3
624626\f[C]$PATH\f[R] (executable only)
625627.PP
626−Filters and Lua-filters are applied in the order specified on the
627−command line.
628+Filters, Lua-filters, and citeproc processing are applied in the order
629+specified on the command line.
628630.RE
629631.TP
630632\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]
631633Transform the document in a similar fashion as JSON filters (see
632−\f[C]--filter\f[R]), but use pandoc\[cq]s build-in Lua filtering system.
634+\f[C]--filter\f[R]), but use pandoc\[cq]s built-in Lua filtering system.
633635The given Lua script is expected to return a list of Lua filters which
634636will be applied in order.
635637Each Lua filter must contain element-transforming functions indexed by
@@ -641,29 +643,17 @@ The \f[C]pandoc\f[R] Lua module provides helper functions for element
641643creation.
642644It is always loaded into the script\[cq]s Lua environment.
643645.PP
644−The following is an example Lua script for macro-expansion:
645−.IP
646−.nf
647−\f[C]
648−function expand_hello_world(inline)
649− if inline.c == \[aq]{{helloworld}}\[aq] then
650− return pandoc.Emph{ pandoc.Str \[dq]Hello, World\[dq] }
651− else
652− return inline
653− end
654−end
655−
656−return {{Str = expand_hello_world}}
657−\f[R]
658−.fi
646+See the Lua filters documentation for further details.
659647.PP
660648In order of preference, pandoc will look for Lua filters in
661649.IP "1." 3
662−a specified full or relative path (executable or non-executable)
650+a specified full or relative path
663651.IP "2." 3
664−\f[C]$DATADIR/filters\f[R] (executable or non-executable) where
665−\f[C]$DATADIR\f[R] is the user data directory (see \f[C]--data-dir\f[R],
666−above).
652+\f[C]$DATADIR/filters\f[R] where \f[C]$DATADIR\f[R] is the user data
653+directory (see \f[C]--data-dir\f[R], above).
654+.PP
655+Filters, Lua filters, and citeproc processing are applied in the order
656+specified on the command line.
667657.RE
668658.TP
669659\f[B]\f[CB]-M\f[B]\f[R] \f[I]KEY\f[R][\f[B]\f[CB]=\f[B]\f[R]\f[I]VAL\f[R]], \f[B]\f[CB]--metadata=\f[B]\f[R]\f[I]KEY\f[R][\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]]
@@ -704,12 +694,12 @@ Specify the number of spaces per tab (default is 4).
704694\f[B]\f[CB]--track-changes=accept\f[B]\f[R]|\f[B]\f[CB]reject\f[B]\f[R]|\f[B]\f[CB]all\f[B]\f[R]
705695Specifies what to do with insertions, deletions, and comments produced
706696by the MS Word \[lq]Track Changes\[rq] feature.
707−\f[C]accept\f[R] (the default), inserts all insertions, and ignores all
697+\f[C]accept\f[R] (the default) processes all the insertions and
708698deletions.
709−\f[C]reject\f[R] inserts all deletions and ignores insertions.
699+\f[C]reject\f[R] ignores them.
710700Both \f[C]accept\f[R] and \f[C]reject\f[R] ignore comments.
711−\f[C]all\f[R] puts in insertions, deletions, and comments, wrapped in
712−spans with \f[C]insertion\f[R], \f[C]deletion\f[R],
701+\f[C]all\f[R] includes all insertions, deletions, and comments, wrapped
702+in spans with \f[C]insertion\f[R], \f[C]deletion\f[R],
713703\f[C]comment-start\f[R], and \f[C]comment-end\f[R] classes,
714704respectively.
715705The author and time of change is included.
@@ -726,11 +716,11 @@ Extract images and other media contained in or linked from the source
726716document to the path \f[I]DIR\f[R], creating it if necessary, and adjust
727717the images references in the document so they point to the extracted
728718files.
729−If the source format is a binary container (docx, epub, or odt), the
730−media is extracted from the container and the original filenames are
731−used.
732−Otherwise the media is read from the file system or downloaded, and new
733−filenames are constructed based on SHA1 hashes of the contents.
719+Media are downloaded, read from the file system, or extracted from a
720+binary container (e.g.\ docx), as needed.
721+The original file paths are used if they are relative paths not
722+containing \f[C]..\f[R].
723+Otherwise filenames are constructed from the SHA1 hash of the contents.
734724.TP
735725\f[B]\f[CB]--abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
736726Specifies a custom abbreviations file, with abbreviations one to a line.
@@ -740,9 +730,9 @@ system default.
740730To see the system default, use
741731\f[C]pandoc --print-default-data-file=abbreviations\f[R].
742732The only use pandoc makes of this list is in the Markdown reader.
743−Strings ending in a period that are found in this list will be followed
744−by a nonbreaking space, so that the period will not produce
745−sentence-ending space in formats like LaTeX.
733+Strings found in this list will be followed by a nonbreaking space, and
734+the period will not produce sentence-ending space in formats like LaTeX.
735+The strings may not contain spaces.
746736.SS General writer options
747737.TP
748738\f[B]\f[CB]-s\f[B]\f[R], \f[B]\f[CB]--standalone\f[B]\f[R]
@@ -933,13 +923,11 @@ Note that, if \f[C]--resource-path\f[R] is specified, the working
933923directory must be explicitly listed or it will not be searched.
934924For example: \f[C]--resource-path=.:test\f[R] will search the working
935925directory and the \f[C]test\f[R] subdirectory, in that order.
936−.RS
937−.PP
938−\f[C]--resource-path\f[R] only has an effect if (a) the output format
939−embeds images (for example, \f[C]docx\f[R], \f[C]pdf\f[R], or
940−\f[C]html\f[R] with \f[C]--self-contained\f[R]) or (b) it is used
941−together with \f[C]--extract-media\f[R].
942−.RE
926+This option can be used repeatedly.
927+Search path components that come later on the command line will be
928+searched before those that come earlier, so
929+\f[C]--resource-path foo:bar --resource-path baz:bim\f[R] is equivalent
930+to \f[C]--resource-path baz:bim:foo:bar\f[R].
943931.TP
944932\f[B]\f[CB]--request-header=\f[B]\f[R]\f[I]NAME\f[R]\f[B]\f[CB]:\f[B]\f[R]\f[I]VAL\f[R]
945933Set the request header \f[I]NAME\f[R] to the value \f[I]VAL\f[R] when
@@ -981,6 +969,8 @@ speaker notes) may not work in an offline \[lq]self-contained\[rq]
981969.TP
982970\f[B]\f[CB]--html-q-tags\f[B]\f[R]
983971Use \f[C]<q>\f[R] tags for quotes in HTML.
972+(This option only has an effect if the \f[C]smart\f[R] extension is
973+enabled for the input format used.)
984974.TP
985975\f[B]\f[CB]--ascii\f[B]\f[R]
986976Use only ASCII characters in output.
@@ -998,21 +988,24 @@ By default inline links are used.
998988The placement of link references is affected by the
999989\f[C]--reference-location\f[R] option.
1000990.TP
1001−\f[B]\f[CB]--reference-location = block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R]
991+\f[B]\f[CB]--reference-location=block\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]document\f[B]\f[R]
1002992Specify whether footnotes (and references, if \f[C]reference-links\f[R]
1003993is set) are placed at the end of the current (top-level) block, the
1004994current section, or the document.
1005995The default is \f[C]document\f[R].
1006996Currently only affects the markdown writer.
1007997.TP
998+\f[B]\f[CB]--markdown-headings=setext\f[B]\f[R]|\f[B]\f[CB]atx\f[B]\f[R]
999+Specify whether to use ATX-style (\f[C]#\f[R]-prefixed) or Setext-style
1000+(underlined) headings for level 1 and 2 headings in Markdown output.
1001+(The default is \f[C]atx\f[R].) ATX-style headings are always used for
1002+levels 3+.
1003+This option also affects Markdown cells in \f[C]ipynb\f[R] output.
1004+.TP
10081005\f[B]\f[CB]--atx-headers\f[B]\f[R]
1009−Use ATX-style headings in Markdown output.
1010−The default is to use setext-style headings for levels 1 to 2, and then
1011−ATX headings.
1012−(Note: for \f[C]gfm\f[R] output, ATX headings are always used.) This
1013−option also affects markdown cells in \f[C]ipynb\f[R] output.
1006+\f[I]Deprecated synonym for \f[CI]--markdown-headings=atx\f[I].\f[R]
10141007.TP
1015−\f[B]\f[CB]--top-level-division=[default|section|chapter|part]\f[B]\f[R]
1008+\f[B]\f[CB]--top-level-division=default\f[B]\f[R]|\f[B]\f[CB]section\f[B]\f[R]|\f[B]\f[CB]chapter\f[B]\f[R]|\f[B]\f[CB]part\f[B]\f[R]
10161009Treat top-level headings as the given division type in LaTeX, ConTeXt,
10171010DocBook, and TEI output.
10181011The hierarchy order is part, chapter, then section; all headings are
@@ -1029,7 +1022,8 @@ become \f[C]\[rs]part{..}\f[R], while second-level headings remain as
10291022their default type.
10301023.TP
10311024\f[B]\f[CB]-N\f[B]\f[R], \f[B]\f[CB]--number-sections\f[B]\f[R]
1032−Number section headings in LaTeX, ConTeXt, HTML, Docx, or EPUB output.
1025+Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
1026+output.
10331027By default, sections are not numbered.
10341028Sections with class \f[C]unnumbered\f[R] will never be numbered, even if
10351029\f[C]--number-sections\f[R] is specified.
@@ -1421,6 +1415,9 @@ Set the \f[C]bibliography\f[R] field in the document\[cq]s metadata to
14211415\f[I]FILE\f[R], overriding any value set in the metadata.
14221416If you supply this argument multiple times, each \f[I]FILE\f[R] will be
14231417added to bibliography.
1418+If \f[I]FILE\f[R] is a URL, it will be fetched via HTTP.
1419+If \f[I]FILE\f[R] is not found relative to the working directory, it
1420+will be sought in the resource path (see \f[C]--resource-path\f[R]).
14241421.TP
14251422\f[B]\f[CB]--csl=\f[B]\f[R]\f[I]FILE\f[R]
14261423Set the \f[C]csl\f[R] field in the document\[cq]s metadata to
@@ -1428,8 +1425,9 @@ Set the \f[C]csl\f[R] field in the document\[cq]s metadata to
14281425(This is equivalent to \f[C]--metadata csl=FILE\f[R].) If \f[I]FILE\f[R]
14291426is a URL, it will be fetched via HTTP.
14301427If \f[I]FILE\f[R] is not found relative to the working directory, it
1431−will be sought in the resource path and finally in the \f[C]csl\f[R]
1432−subdirectory of the pandoc user data directory.
1428+will be sought in the resource path (see \f[C]--resource-path\f[R]) and
1429+finally in the \f[C]csl\f[R] subdirectory of the pandoc user data
1430+directory.
14331431.TP
14341432\f[B]\f[CB]--citation-abbreviations=\f[B]\f[R]\f[I]FILE\f[R]
14351433Set the \f[C]citation-abbreviations\f[R] field in the document\[cq]s
@@ -1438,8 +1436,9 @@ metadata to \f[I]FILE\f[R], overriding any value set in the metadata.
14381436\f[C]--metadata citation-abbreviations=FILE\f[R].) If \f[I]FILE\f[R] is
14391437a URL, it will be fetched via HTTP.
14401438If \f[I]FILE\f[R] is not found relative to the working directory, it
1441−will be sought in the resource path and finally in the \f[C]csl\f[R]
1442−subdirectory of the pandoc user data directory.
1439+will be sought in the resource path (see \f[C]--resource-path\f[R]) and
1440+finally in the \f[C]csl\f[R] subdirectory of the pandoc user data
1441+directory.
14431442.TP
14441443\f[B]\f[CB]--natbib\f[B]\f[R]
14451444Use \f[C]natbib\f[R] for citations in LaTeX output.
@@ -1505,16 +1504,16 @@ inserted.
15051504.TP
15061505\f[B]\f[CB]--gladtex\f[B]\f[R]
15071506Enclose TeX math in \f[C]<eq>\f[R] tags in HTML output.
1508−The resulting HTML can then be processed by GladTeX to produce images of
1509−the typeset formulas and an HTML file with links to these images.
1510−So, the procedure is:
1507+The resulting HTML can then be processed by GladTeX to produce SVG
1508+images of the typeset formulas and an HTML file with these images
1509+embedded.
15111510.RS
15121511.IP
15131512.nf
15141513\f[C]
15151514pandoc -s --gladtex input.md -o myfile.htex
1516−gladtex -d myfile-images myfile.htex
1517−# produces myfile.html and images in myfile-images
1515+gladtex -d image_dir myfile.htex
1516+# produces myfile.html and images in image_dir
15181517\f[R]
15191518.fi
15201519.RE
@@ -1618,6 +1617,11 @@ T}@T{
16181617PandocPDFError
16191618T}
16201619T{
1620+44
1621+T}@T{
1622+PandocXMLError
1623+T}
1624+T{
1621162547
16221626T}@T{
16231627PandocPDFProgramNotFoundError
@@ -1678,6 +1682,11 @@ T}@T{
16781682PandocIpynbDecodingError
16791683T}
16801684T{
1685+94
1686+T}@T{
1687+PandocUnsupportedCharsetError
1688+T}
1689+T{
1681169097
16821691T}@T{
16831692PandocCouldNotFindDataFileError
@@ -1710,6 +1719,16 @@ input-files:
17101719- content.md
17111720# or you may use input-file: with a single value
17121721
1722+# Include options from the specified defaults files.
1723+# The files will be searched for first in the working directory
1724+# and then in the defaults subdirectory of the user data directory.
1725+# The files are included in the same order in which they appear in
1726+# the list. Options specified in this defaults file always have
1727+# priority over the included ones.
1728+defaults:
1729+- defsA
1730+- defsB
1731+
17131732template: letter
17141733standalone: true
17151734self-contained: false
@@ -1746,6 +1765,7 @@ csl: ieee
17461765bibliography:
17471766- foobar.bib
17481767- barbaz.json
1768+citation-abbreviations: abbrevs.json
17491769
17501770# Filters will be assumed to be Lua filters if they have
17511771# the .lua extension, and json filters otherwise. But
@@ -1766,8 +1786,11 @@ data-dir:
17661786verbosity: INFO
17671787log-file: log.json
17681788
1769−# citeproc, natbib, or biblatex
1789+# citeproc, natbib, or biblatex. This only affects LaTeX
1790+# output. If you want to use citeproc to format citations,
1791+# you should also set \[aq]citeproc: true\[aq] (see above).
17701792cite-method: citeproc
1793+
17711794# part, chapter, section, or default:
17721795top-level-division: chapter
17731796abbreviations:
@@ -1836,7 +1859,7 @@ epub-cover-image: cover.jpg
18361859reference-links: true
18371860# block, section, or document
18381861reference-location: block
1839−atx-headers: false
1862+markdown-headings: setext
18401863
18411864# accept, reject, or all
18421865track-changes: accept
@@ -1868,6 +1891,38 @@ verbosity: INFO
18681891\f[R]
18691892.fi
18701893.PP
1894+In fields that expect a file path (or list of file paths), the following
1895+syntax may be used to interpolate environment variables:
1896+.IP
1897+.nf
1898+\f[C]
1899+csl: ${HOME}/mycsldir/special.csl
1900+\f[R]
1901+.fi
1902+.PP
1903+\f[C]${USERDATA}\f[R] may also be used; this will always resolve to the
1904+user data directory that is current when the defaults file is parsed,
1905+regardless of the setting of the environment variable
1906+\f[C]USERDATA\f[R].
1907+.PP
1908+\f[C]${.}\f[R] will resolve to the directory containing the default file
1909+itself.
1910+This allows you to refer to resources contained in that directory:
1911+.IP
1912+.nf
1913+\f[C]
1914+epub-cover-image: ${.}/cover.jpg
1915+epub-metadata: ${.}/meta.xml
1916+resource-path:
1917+- . # the working directory from which pandoc is run
1918+- ${.}/images # the images subdirectory of the directory
1919+ # containing this defaults file
1920+\f[R]
1921+.fi
1922+.PP
1923+This environment variable interpolation syntax \f[I]only\f[R] works in
1924+fields that expect file paths.
1925+.PP
18711926Default files can be placed in the \f[C]defaults\f[R] subdirectory of
18721927the user data directory and used from any directory.
18731928For example, one could create a file specifying defaults for writing
@@ -2127,9 +2182,9 @@ ${ styles.html() }
21272182\f[R]
21282183.fi
21292184.PP
2130−(If a partial is not found in the directory of the template, it will
2131−also be sought in the \f[C]templates\f[R] subdirectory of the user data
2132−directory.)
2185+(If a partial is not found in the directory of the template and the
2186+template path is given as a relative path, it will also be sought in the
2187+\f[C]templates\f[R] subdirectory of the user data directory.)
21332188.PP
21342189Partials may optionally be applied to variables using a colon:
21352190.IP
@@ -2362,7 +2417,8 @@ including a title block in the document itself, you can set the
23622417\f[C]title-meta\f[R], \f[C]author-meta\f[R], and \f[C]date-meta\f[R]
23632418variables.
23642419(By default these are set automatically, based on \f[C]title\f[R],
2365−\f[C]author\f[R], and \f[C]date\f[R].)
2420+\f[C]author\f[R], and \f[C]date\f[R].) The page title in HTML is set by
2421+\f[C]pagetitle\f[R], which is equal to \f[C]title\f[R] by default.
23662422.RE
23672423.TP
23682424\f[B]\f[CB]subtitle\f[B]\f[R]
@@ -2487,6 +2543,10 @@ sets the CSS \f[C]color\f[R] property on all links.
24872543\f[B]\f[CB]monofont\f[B]\f[R]
24882544sets the CSS \f[C]font-family\f[R] property on \f[C]code\f[R] elements.
24892545.TP
2546+\f[B]\f[CB]monobackgroundcolor\f[B]\f[R]
2547+sets the CSS \f[C]background-color\f[R] property on \f[C]code\f[R]
2548+elements and adds extra padding.
2549+.TP
24902550\f[B]\f[CB]linestretch\f[B]\f[R]
24912551sets the CSS \f[C]line-height\f[R] property on the \f[C]html\f[R]
24922552element, which is preferred to be unitless.
@@ -2498,6 +2558,31 @@ element.
24982558\f[B]\f[CB]margin-left\f[B]\f[R], \f[B]\f[CB]margin-right\f[B]\f[R], \f[B]\f[CB]margin-top\f[B]\f[R], \f[B]\f[CB]margin-bottom\f[B]\f[R]
24992559sets the corresponding CSS \f[C]padding\f[R] properties on the
25002560\f[C]body\f[R] element.
2561+.PP
2562+To override or extend some CSS for just one document, include for
2563+example:
2564+.IP
2565+.nf
2566+\f[C]
2567+---
2568+header-includes: |
2569+ <style>
2570+ blockquote {
2571+ font-style: italic;
2572+ }
2573+ tr.even {
2574+ background-color: #f0f0f0;
2575+ }
2576+ td, th {
2577+ padding: 0.5em 2em 0.5em 0.5em;
2578+ }
2579+ tbody {
2580+ border-bottom: none;
2581+ }
2582+ </style>
2583+---
2584+\f[R]
2585+.fi
25012586.SS Variables for HTML math
25022587.TP
25032588\f[B]\f[CB]classoption\f[B]\f[R]
@@ -2506,10 +2591,9 @@ YAML metadata or with \f[C]-M classoption=fleqn\f[R].
25062591.SS Variables for HTML slides
25072592.PP
25082593These affect HTML output when [producing slide shows with pandoc].
2509−.PP
2510−All reveal.js configuration options are available as variables.
2511−To turn off boolean flags that default to true in reveal.js, use
2512−\f[C]0\f[R].
2594+.TP
2595+\f[B]\f[CB]institute\f[B]\f[R]
2596+author affiliations: can be a list when there are multiple authors
25132597.TP
25142598\f[B]\f[CB]revealjs-url\f[B]\f[R]
25152599base URL for reveal.js documents (defaults to
@@ -2528,6 +2612,10 @@ base URL for Slideous documents (defaults to \f[C]slideous\f[R])
25282612\f[B]\f[CB]title-slide-attributes\f[B]\f[R]
25292613additional attributes for the title slide of reveal.js slide shows.
25302614See background in reveal.js and beamer for an example.
2615+.PP
2616+All reveal.js configuration options are available as variables.
2617+To turn off boolean flags that default to true in reveal.js, use
2618+\f[C]0\f[R].
25312619.SS Variables for Beamer slides
25322620.PP
25332621These variables change the appearance of PDF slides using
@@ -2664,8 +2752,9 @@ hyperrefoptions:
26642752.RE
26652753.TP
26662754\f[B]\f[CB]indent\f[B]\f[R]
2667−uses document class settings for indentation (the default LaTeX template
2668−otherwise removes indentation and adds space between paragraphs)
2755+if true, pandoc will use document class settings for indentation (the
2756+default LaTeX template otherwise removes indentation and adds space
2757+between paragraphs)
26692758.TP
26702759\f[B]\f[CB]linestretch\f[B]\f[R]
26712760adjusts line spacing using the \f[C]setspace\f[R] package,
@@ -2855,10 +2944,10 @@ paper size, e.g.\ \f[C]letter\f[R], \f[C]A4\f[R], \f[C]landscape\f[R]
28552944\f[B]\f[CB]pdfa\f[B]\f[R]
28562945adds to the preamble the setup necessary to generate PDF/A of the type
28572946specified, e.g.\ \f[C]1a:2005\f[R], \f[C]2a\f[R].
2858−If no type is specified (i.e.\ the value is set to True, by
2859−e.g.\ \f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML
2860−metadata block), \f[C]1b:2005\f[R] will be used as default, for reasons
2861−of backwards compatibility.
2947+If no type is specified (i.e.\ the value is set to True, by e.g.
2948+\f[C]--metadata=pdfa\f[R] or \f[C]pdfa: true\f[R] in a YAML metadata
2949+block), \f[C]1b:2005\f[R] will be used as default, for reasons of
2950+backwards compatibility.
28622951Using \f[C]--variable=pdfa\f[R] without specified value is not
28632952supported.
28642953To successfully generate PDF/A the required ICC color profiles have to
@@ -3218,9 +3307,8 @@ addition to \f[C]markdown\f[R]):
32183307.RS 2
32193308.TP
32203309input formats
3221−\f[C]latex\f[R], \f[C]org\f[R], \f[C]textile\f[R], \f[C]html\f[R]
3222−(environments, \f[C]\[rs]ref\f[R], and \f[C]\[rs]eqref\f[R] only),
3223−\f[C]ipynb\f[R]
3310+\f[C]latex\f[R], \f[C]textile\f[R], \f[C]html\f[R] (environments,
3311+\f[C]\[rs]ref\f[R], and \f[C]\[rs]eqref\f[R] only), \f[C]ipynb\f[R]
32243312.TP
32253313output formats
32263314\f[C]textile\f[R], \f[C]commonmark\f[R]
@@ -3340,6 +3428,43 @@ This extension can be enabled/disabled for the following formats:
33403428.TP
33413429output formats
33423430\f[C]odt\f[R], \f[C]opendocument\f[R]
3431+.SS Extension: \f[C]xrefs_name\f[R]
3432+.PP
3433+Links to headings, figures and tables inside the document are
3434+substituted with cross-references that will use the name or caption of
3435+the referenced item.
3436+The original link text is replaced once the generated document is
3437+refreshed.
3438+This extension can be combined with \f[C]xrefs_number\f[R] in which case
3439+numbers will appear before the name.
3440+.PP
3441+Text in cross-references is only made consistent with the referenced
3442+item once the document has been refreshed.
3443+.PP
3444+This extension can be enabled/disabled for the following formats:
3445+.TP
3446+output formats
3447+\f[C]odt\f[R], \f[C]opendocument\f[R]
3448+.SS Extension: \f[C]xrefs_number\f[R]
3449+.PP
3450+Links to headings, figures and tables inside the document are
3451+substituted with cross-references that will use the number of the
3452+referenced item.
3453+The original link text is discarded.
3454+This extension can be combined with \f[C]xrefs_name\f[R] in which case
3455+the name or caption numbers will appear after the number.
3456+.PP
3457+For the \f[C]xrefs_number\f[R] to be useful heading numbers must be
3458+enabled in the generated document, also table and figure captions must
3459+be enabled using for example the \f[C]native_numbering\f[R] extension.
3460+.PP
3461+Numbers in cross-references are only visible in the final document once
3462+it has been refreshed.
3463+.PP
3464+This extension can be enabled/disabled for the following formats:
3465+.TP
3466+output formats
3467+\f[C]odt\f[R], \f[C]opendocument\f[R]
33433468.SS Extension: \f[C]styles\f[R]
33443469.PP
33453470When converting from docx, read all docx styles as divs (for paragraph
@@ -3359,12 +3484,18 @@ to Emacs Muse markup.
33593484In the \f[C]ipynb\f[R] input format, this causes Markdown cells to be
33603485included as raw Markdown blocks (allowing lossless round-tripping)
33613486rather than being parsed.
3362−Use this only when you are targetting \f[C]ipynb\f[R] or a
3363−markdown-based output format.
3487+Use this only when you are targeting \f[C]ipynb\f[R] or a markdown-based
3488+output format.
33643489.SS Extension: \f[C]citations\f[R]
33653490.PP
33663491Some aspects of Pandoc\[cq]s Markdown citation syntax are also accepted
33673492in \f[C]org\f[R] input.
3493+.SS Extension: \f[C]element_citations\f[R]
3494+.PP
3495+In the \f[C]jats\f[R] output formats, this causes reference items to be
3496+replaced with \f[C]<element-citation>\f[R] elements.
3497+These elements are not influenced by CSL styles, but all information on
3498+the item is included in tags.
33683499.SS Extension: \f[C]ntb\f[R]
33693500.PP
33703501In the \f[C]context\f[R] output format this enables the use of Natural
@@ -3848,6 +3979,9 @@ begin with a space.
38483979\f[R]
38493980.fi
38503981.PP
3982+Inline formatting (such as emphasis) is allowed in the content, but not
3983+block-level formatting (such as block quotes or lists).
3984+.PP
38513985This syntax is borrowed from reStructuredText.
38523986.SS Lists
38533987.SS Bullet lists
@@ -4141,7 +4275,7 @@ Term 2
41414275Note that space between items in a definition list is required.
41424276(A variant that loosens this requirement, but disallows \[lq]lazy\[rq]
41434277hard wrapping, can be activated with \f[C]compact_definition_lists\f[R]:
4144−see Non-pandoc extensions, below.)
4278+see Non-default extensions, below.)
41454279.SS Numbered example lists
41464280.SS Extension: \f[C]example_lists\f[R]
41474281.PP
@@ -4662,7 +4796,9 @@ All of the metadata will appear in a single block at the beginning of
46624796the document.
46634797.PP
46644798Note that YAML escaping rules must be followed.
4665−Thus, for example, if a title contains a colon, it must be quoted.
4799+Thus, for example, if a title contains a colon, it must be quoted, and
4800+if it contains a backslash escape, then it must be ensured that it is
4801+not treated as a YAML escape sequence.
46664802The pipe character (\f[C]|\f[R]) can be used to begin an indented block
46674803that will be interpreted literally, without need for escaping.
46684804This form is necessary when the field contains blank lines or
@@ -4684,6 +4820,13 @@ abstract: |
46844820\f[R]
46854821.fi
46864822.PP
4823+The literal block after the \f[C]|\f[R] must be indented relative to the
4824+line containing the \f[C]|\f[R].
4825+If it is not, the YAML will be invalid and pandoc will not interpret it
4826+as metadata.
4827+For an overview of the complex rules governing YAML, see the Wikipedia
4828+entry on YAML syntax.
4829+.PP
46874830Template variables will be set automatically from the metadata.
46884831Thus, for example, in writing HTML, the variable \f[C]abstract\f[R] will
46894832be set to the HTML equivalent of the Markdown in the \f[C]abstract\f[R]
@@ -4749,6 +4892,21 @@ header-includes:
47494892 \[ga]\[ga]\[ga]
47504893\f[R]
47514894.fi
4895+.PP
4896+Note: the \f[C]yaml_metadata_block\f[R] extension works with
4897+\f[C]commonmark\f[R] as well as \f[C]markdown\f[R] (and it is enabled by
4898+default in \f[C]gfm\f[R] and \f[C]commonmark_x\f[R]).
4899+However, in these formats the following restrictions apply:
4900+.IP \[bu] 2
4901+The YAML metadata block must occur at the beginning of the document (and
4902+there can be only one).
4903+If multiple files are given as arguments to pandoc, only the first can
4904+be a YAML metadata block.
4905+.IP \[bu] 2
4906+The leaf nodes of the YAML structure are parsed in isolation from each
4907+other and from the rest of the document.
4908+So, for example, you can\[cq]t use a reference link in these contexts if
4909+the link definition is somewhere else in the document.
47524910.SS Backslash escapes
47534911.SS Extension: \f[C]all_symbols_escapable\f[R]
47544912.PP
@@ -4968,7 +5126,9 @@ delimiters.
49685126.PP
49695127For display math, use \f[C]$$\f[R] delimiters.
49705128(In this case, the delimiters may be separated from the formula by
4971−whitespace.)
5129+whitespace.
5130+However, there can be no blank lines betwen the opening and closing
5131+\f[C]$$\f[R] delimiters.)
49725132.PP
49735133TeX math will be printed in all output formats.
49745134How it is rendered depends on the output format:
@@ -5094,8 +5254,9 @@ into
50945254.PP
50955255whereas \f[C]Markdown.pl\f[R] will preserve it as is.
50965256.PP
5097−There is one exception to this rule: text between \f[C]<script>\f[R] and
5098−\f[C]<style>\f[R] tags is not interpreted as Markdown.
5257+There is one exception to this rule: text between \f[C]<script>\f[R],
5258+\f[C]<style>\f[R], and \f[C]<textarea>\f[R] tags is not interpreted as
5259+Markdown.
50995260.PP
51005261This departure from standard Markdown should make it easier to mix
51015262Markdown with HTML block elements.
@@ -5626,27 +5787,70 @@ Inline and regular footnotes may be mixed freely.
56265787.SS Citation syntax
56275788.SS Extension: \f[C]citations\f[R]
56285789.PP
5629−Markdown citations go inside square brackets and are separated by
5630−semicolons.
5631−Each citation must have a key, composed of `\[at]' + the citation
5632−identifier from the database, and may optionally have a prefix, a
5633−locator, and a suffix.
5634−The citation key must begin with a letter, digit, or \f[C]_\f[R], and
5635−may contain alphanumerics, \f[C]_\f[R], and internal punctuation
5636−characters (\f[C]:.#$%&-+?<>\[ti]/\f[R]).
5637−Here are some examples:
5790+To cite a bibliographic item with an identifier foo, use the syntax
5791+\f[C]\[at]foo\f[R].
5792+Normal citations should be included in square brackets, with semicolons
5793+separating distinct items:
56385794.IP
56395795.nf
56405796\f[C]
5641−Blah blah [see \[at]doe99, pp. 33-35; also \[at]smith04, chap. 1].
5642−
5643−Blah blah [\[at]doe99, pp. 33-35, 38-39 and *passim*].
5797+Blah blah [\[at]doe99; \[at]smith2000; \[at]smith2004].
5798+\f[R]
5799+.fi
5800+.PP
5801+How this is rendered depends on the citation style.
5802+In an author-date style, it might render as
5803+.IP
5804+.nf
5805+\f[C]
5806+Blah blah (Doe 1999, Smith 2000, 2004).
5807+\f[R]
5808+.fi
5809+.PP
5810+In a footnote style, it might render as
5811+.IP
5812+.nf
5813+\f[C]
5814+Blah blah.[\[ha]1]
56445815
5645−Blah blah [\[at]smith04; \[at]doe99].
5816+[\[ha]1]: John Doe, \[dq]Frogs,\[dq] *Journal of Amphibians* 44 (1999);
5817+Susan Smith, \[dq]Flies,\[dq] *Journal of Insects* (2000);
5818+Susan Smith, \[dq]Bees,\[dq] *Journal of Insects* (2004).
5819+\f[R]
5820+.fi
5821+.PP
5822+See the CSL user documentation for more information about CSL styles and
5823+how they affect rendering.
5824+.PP
5825+Unless a citation key start with a letter, digit, or \f[C]_\f[R], and
5826+contains only alphanumerics and internal punctuation characters
5827+(\f[C]:.#$%&-+?<>\[ti]/\f[R]), it must be surrounded by curly braces,
5828+which are not considered part of the key.
5829+In \f[C]\[at]Foo_bar.baz.\f[R], the key is \f[C]Foo_bar.baz\f[R].
5830+The final period is not \f[I]internal\f[R] punctuation, so it is not
5831+included in the key.
5832+In \f[C]\[at]{Foo_bar.baz.}\f[R], the key is \f[C]Foo_bar.baz.\f[R],
5833+including the final period.
5834+The curly braces are recommended if you use URLs as keys:
5835+\f[C][\[at]{https://example.com/bib?name=foobar&date=2000}, p. 33]\f[R].
5836+.PP
5837+Citation items may optionally include a prefix, a locator, and a suffix.
5838+In
5839+.IP
5840+.nf
5841+\f[C]
5842+Blah blah [see \[at]doe99, pp. 33-35 and *passim*; \[at]smith04, chap. 1].
56465843\f[R]
56475844.fi
56485845.PP
5649−\f[C]pandoc\f[R] detects locator terms in the CSL locale files.
5846+The first item (\f[C]doe99\f[R]) has prefix \f[C]see\f[R], locator
5847+\f[C]pp. 33-35\f[R], and suffix \f[C]and *passim*\f[R].
5848+The second item (\f[C]smith04\f[R]) has locator \f[C]chap. 1\f[R] and no
5849+prefix or suffix.
5850+.PP
5851+Pandoc uses some heuristics to separate the locator from the rest of the
5852+subject.
5853+It is sensitive to the locator terms defined in the CSL locale files.
56505854Either abbreviated or unabbreviated forms are accepted.
56515855In the \f[C]en-US\f[R] locale, locator terms can be written in either
56525856singular or plural forms, as \f[C]book\f[R],
@@ -5668,14 +5872,15 @@ singular or plural forms, as \f[C]book\f[R],
56685872\f[C]\[sc]\f[R]/\f[C]\[sc]\[sc]\f[R].
56695873If no locator term is used, \[lq]page\[rq] is assumed.
56705874.PP
5671−\f[C]pandoc\f[R] will use heuristics to distinguish the locator from the
5672−suffix.
5673−In complex cases, the locator can be enclosed in curly braces:
5875+In complex cases, you can force something to be treated as a locator by
5876+enclosing it in curly braces or prevent parsing the suffix as locator by
5877+prepending curly braces:
56745878.IP
56755879.nf
56765880\f[C]
56775881[\[at]smith{ii, A, D-Z}, with a suffix]
56785882[\[at]smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]
5883+[\[at]smith{}, 99 years later]
56795884\f[R]
56805885.fi
56815886.PP
@@ -5689,7 +5894,8 @@ Smith says blah [-\[at]smith04].
56895894\f[R]
56905895.fi
56915896.PP
5692−You can also write an in-text citation, as follows:
5897+You can also write an author-in-text citation, by omitting the square
5898+brackets:
56935899.IP
56945900.nf
56955901\f[C]
@@ -5698,13 +5904,64 @@ You can also write an in-text citation, as follows:
56985904\[at]smith04 [p. 33] says blah.
56995905\f[R]
57005906.fi
5701−.SS Non-pandoc extensions
5907+.PP
5908+This will cause the author\[cq]s name to be rendered, followed by the
5909+bibliographical details.
5910+Use this form when you want to make the citation the subject of a
5911+sentence.
5912+.PP
5913+When you are using a note style, it is usually better to let citeproc
5914+create the footnotes from citations rather than writing an explicit
5915+note.
5916+If you do write an explicit note that contains a citation, note that
5917+normal citations will be put in parentheses, while author-in-text
5918+citations will not.
5919+For this reason, it is sometimes preferable to use the author-in-text
5920+style inside notes when using a note style.
5921+.SS Non-default extensions
57025922.PP
57035923The following Markdown syntax extensions are not enabled by default in
57045924pandoc, but may be enabled by adding \f[C]+EXTENSION\f[R] to the format
57055925name, where \f[C]EXTENSION\f[R] is the name of the extension.
57065926Thus, for example, \f[C]markdown+hard_line_breaks\f[R] is Markdown with
57075927hard line breaks.
5928+.SS Extension: \f[C]rebase_relative_paths\f[R]
5929+.PP
5930+Rewrite relative paths for Markdown links and images, depending on the
5931+path of the file containing the link or image link.
5932+For each link or image, pandoc will compute the directory of the
5933+containing file, relative to the working directory, and prepend the
5934+resulting path to the link or image path.
5935+.PP
5936+The use of this extension is best understood by example.
5937+Suppose you have a a subdirectory for each chapter of a book,
5938+\f[C]chap1\f[R], \f[C]chap2\f[R], \f[C]chap3\f[R].
5939+Each contains a file \f[C]text.md\f[R] and a number of images used in
5940+the chapter.
5941+You would like to have \f[C]![image](spider.jpg)\f[R] in
5942+\f[C]chap1/text.md\f[R] refer to \f[C]chap1/spider.jpg\f[R] and
5943+\f[C]![image](spider.jpg)\f[R] in \f[C]chap2/text.md\f[R] refer to
5944+\f[C]chap2/spider.jpg\f[R].
5945+To do this, use
5946+.IP
5947+.nf
5948+\f[C]
5949+pandoc chap*/*.md -f markdown+rebase_relative_paths
5950+\f[R]
5951+.fi
5952+.PP
5953+Without this extension, you would have to use
5954+\f[C]![image](chap1/spider.jpg)\f[R] in \f[C]chap1/text.md\f[R] and
5955+\f[C]![image](chap2/spider.jpg)\f[R] in \f[C]chap2/text.md\f[R].
5956+Links with relative paths will be rewritten in the same way as images.
5957+.PP
5958+Absolute paths and URLs are not changed.
5959+Neither are empty paths or paths consisting entirely of a fragment,
5960+e.g., \f[C]#foo\f[R].
5961+.PP
5962+Note that relative paths in reference links and images will be rewritten
5963+relative to the file containing the link reference definition, not the
5964+file containing the reference link or image itself, if these differ.
57085965.SS Extension: \f[C]attributes\f[R]
57095966.PP
57105967Allows attributes to be attached to any inline or block-level element.
@@ -5884,6 +6141,12 @@ be indented four spaces.
58846141Use Project Gutenberg conventions for \f[C]plain\f[R] output: all-caps
58856142for strong emphasis, surround by underscores for regular emphasis, add
58866143extra blank space around headings.
6144+.SS Extension: \f[C]sourcepos\f[R]
6145+.PP
6146+Include source position attributes when parsing \f[C]commonmark\f[R].
6147+For elements that accept attributes, a \f[C]data-pos\f[R] attribute is
6148+added; other elements are placed in a surrounding Div or Span elemnet
6149+with a \f[C]data-pos\f[R] attribute.
58876150.SS Markdown variants
58886151.PP
58896152In addition to pandoc\[cq]s extended Markdown, the following Markdown
@@ -6043,23 +6306,28 @@ references:
60436306\f[R]
60446307.fi
60456308.PP
6309+If both an external bibliography and inline (YAML metadata) references
6310+are provided, both will be used.
6311+In case of conflicting \f[C]id\f[R]s, the inline references will take
6312+precedence.
6313+.PP
60466314Note that \f[C]pandoc\f[R] can be used to produce such a YAML metadata
60476315section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
60486316.IP
60496317.nf
60506318\f[C]
6051−pandoc chem.bib -s -t markdown
6052−pandoc chem.json -s -t markdown
6319+pandoc chem.bib -s -f biblatex -t markdown
6320+pandoc chem.json -s -f csljson -t markdown
60536321\f[R]
60546322.fi
60556323.PP
6056−\f[C]pandoc\f[R] can also be used to produce CSL JSON bibliography from
6057−BibTeX, BibLaTeX, or markdown YAML:
6324+Indeed, \f[C]pandoc\f[R] can convert between any of these citation
6325+formats:
60586326.IP
60596327.nf
60606328\f[C]
6061−pandoc chem.bib -s -t csljson
6062−pandoc chem.yaml -s -t csljson
6329+pandoc chem.bib -s -f biblatex -t csljson
6330+pandoc chem.yaml -s -f markdown -t biblatex
60636331\f[R]
60646332.fi
60656333.PP
@@ -6188,6 +6456,41 @@ The format of the file can be illustrated with an example:
61886456}
61896457\f[R]
61906458.fi
6459+.SS Citations in note styles
6460+.PP
6461+Pandoc\[cq]s citation processing is designed to allow you to move
6462+between author-date, numerical, and note styles without modifying the
6463+markdown source.
6464+When you\[cq]re using a note style, avoid inserting footnotes manually.
6465+Instead, insert citations just as you would in an author-date
6466+style\[em]for example,
6467+.IP
6468+.nf
6469+\f[C]
6470+Blah blah [\[at]foo, p. 33].
6471+\f[R]
6472+.fi
6473+.PP
6474+The footnote will be created automatically.
6475+Pandoc will take care of removing the space and moving the note before
6476+or after the period, depending on the setting of
6477+\f[C]notes-after-punctuation\f[R], as described below in Other relevant
6478+metadata fields.
6479+.PP
6480+In some cases you may need to put a citation inside a regular footnote.
6481+Normal citations in footnotes (such as \f[C][\[at]foo, p. 33]\f[R]) will
6482+be rendered in parentheses.
6483+In-text citations (such as \f[C]\[at]foo [p. 33]\f[R]) will be rendered
6484+without parentheses.
6485+(A comma will be added if appropriate.) Thus:
6486+.IP
6487+.nf
6488+\f[C]
6489+[\[ha]1]: Some studies [\[at]foo; \[at]bar, p. 33] show that
6490+frubulicious zoosnaps are quantical. For a survey
6491+of the literature, see \[at]baz [chap. 1].
6492+\f[R]
6493+.fi
61916494.SS Raw content in a style
61926495.PP
61936496To include raw content in a prefix, suffix, delimiter, or term, surround
@@ -6204,7 +6507,7 @@ in the output, rather than being passed through raw.
62046507.PP
62056508This feature allows stylesheets to be customized to give different
62066509output for different output formats.
6207−However, stylesheets customized in this way will not be useable by other
6510+However, stylesheets customized in this way will not be usable by other
62086511CSL implementations.
62096512.SS Placement of the bibliography
62106513.PP
@@ -6282,15 +6585,35 @@ Bear in mind that bibliography files have to be in either BibTeX (for
62826585.PP
62836586A few other metadata fields affect bibliography formatting:
62846587.TP
6285−\f[B]\f[CB]link-citation\f[B]\f[R]
6588+\f[B]\f[CB]link-citations\f[B]\f[R]
62866589If true, citations will be hyperlinked to the corresponding bibliography
62876590entries (for author-date and numerical styles only).
62886591.TP
62896592\f[B]\f[CB]lang\f[B]\f[R]
62906593The \f[C]lang\f[R] field will affect how the style is localized, for
6291−example in the translation of labels and the use of quotation marks.
6594+example in the translation of labels, the use of quotation marks, and
6595+the way items are sorted.
62926596(For backwards compatibility, \f[C]locale\f[R] may be used instead of
62936597\f[C]lang\f[R], but this use is deprecated.)
6598+.RS
6599+.PP
6600+A BCP 47 language tag is expected: for example, \f[C]en\f[R],
6601+\f[C]de\f[R], \f[C]en-US\f[R], \f[C]fr-CA\f[R], \f[C]ug-Cyrl\f[R].
6602+The unicode extension syntax (after \f[C]-u-\f[R]) may be used to
6603+specify options for collation (sorting) more precisely.
6604+Here are some examples:
6605+.IP \[bu] 2
6606+\f[C]zh-u-co-pinyin\f[R] \[en] Chinese with the Pinyin collation.
6607+.IP \[bu] 2
6608+\f[C]es-u-co-trad\f[R] \[en] Spanish with the traditional collation
6609+(with \f[C]Ch\f[R] sorting after \f[C]C\f[R]).
6610+.IP \[bu] 2
6611+\f[C]fr-u-kb\f[R] \[en] French with \[lq]backwards\[rq] accent sorting
6612+(with \f[C]cot\['e]\f[R] sorting after \f[C]c\[^o]te\f[R]).
6613+.IP \[bu] 2
6614+\f[C]en-US-u-kf-upper\f[R] \[en] English with uppercase letters sorting
6615+before lower (default is lower before upper).
6616+.RE
62946617.TP
62956618\f[B]\f[CB]notes-after-punctuation\f[B]\f[R]
62966619If true (the default), pandoc will put footnote citations after
@@ -6411,6 +6734,11 @@ A heading at the slide level always starts a new slide.
64116734.IP \[bu] 2
64126735Headings \f[I]below\f[R] the slide level in the hierarchy create
64136736headings \f[I]within\f[R] a slide.
6737+(In beamer, a \[lq]block\[rq] will be created.
6738+If the heading has the class \f[C]example\f[R], an
6739+\f[C]exampleblock\f[R] environment will be used; if it has the class
6740+\f[C]alert\f[R], an \f[C]alertblock\f[R] will be used; otherwise a
6741+regular \f[C]block\f[R] will be used.)
64146742.IP \[bu] 2
64156743Headings \f[I]above\f[R] the slide level in the hierarchy create
64166744\[lq]title slides,\[rq] which just contain the section title and help to
@@ -6811,6 +7139,16 @@ A string value.
68117139\f[B]\f[CB]rights\f[B]\f[R]
68127140A string value.
68137141.TP
7142+\f[B]\f[CB]belongs-to-collection\f[B]\f[R]
7143+A string value.
7144+identifies the name of a collection to which the EPUB Publication
7145+belongs.
7146+.TP
7147+\f[B]\f[CB]group-position\f[B]\f[R]
7148+The \f[C]group-position\f[R] field indicates the numeric position in
7149+which the EPUB Publication belongs relative to other works belonging to
7150+the same \f[C]belongs-to-collection\f[R] field.
7151+.TP
68147152\f[B]\f[CB]cover-image\f[B]\f[R]
68157153A string value (path to cover image).
68167154.TP
@@ -7326,6 +7664,20 @@ need to specify a template manually using \f[C]--template\f[R] or add a
73267664new default template with the name
73277665\f[C]default.NAME_OF_CUSTOM_WRITER.lua\f[R] to the \f[C]templates\f[R]
73287666subdirectory of your user data directory (see Templates).
7667+.SH REPRODUCIBLE BUILDS
7668+.PP
7669+Some of the document formats pandoc targets (such as EPUB, docx, and
7670+ODT) include build timestamps in the generated document.
7671+That means that the files generated on successive builds will differ,
7672+even if the source does not.
7673+To avoid this, set the \f[C]SOURCE_DATE_EPOCH\f[R] environment variable,
7674+and the timestamp will be taken from it instead of the current time.
7675+\f[C]SOURCE_DATE_EPOCH\f[R] should contain an integer unix timestamp
7676+(specifying the number of second since midnight UTC January 1, 1970).
7677+.PP
7678+Some document formats also include a unique identifier.
7679+For EPUB, this can be set explicitly by setting the \f[C]identifier\f[R]
7680+metadata field (see EPUB Metadata, above).
73297681.SH A NOTE ON SECURITY
73307682.PP
73317683If you use pandoc to convert user-contributed content in a web
@@ -7356,16 +7708,16 @@ The HTML generated by pandoc is not guaranteed to be safe.
73567708If \f[C]raw_html\f[R] is enabled for the Markdown input, users can
73577709inject arbitrary HTML.
73587710Even if \f[C]raw_html\f[R] is disabled, users can include dangerous
7359−content in attributes for headings, spans, and code blocks.
7711+content in URLs and attributes.
73607712To be safe, you should run all the generated HTML through an HTML
73617713sanitizer.
73627714.SH AUTHORS
73637715.PP
7364−Copyright 2006\[en]2020 John MacFarlane (jgm\[at]berkeley.edu).
7716+Copyright 2006\[en]2021 John MacFarlane (jgm\[at]berkeley.edu).
73657717Released under the GPL, version 2 or greater.
73667718This software carries no warranty of any kind.
73677719(See COPYRIGHT for full copyright and warranty notices.) For a full list
73687720of contributors, see the file AUTHORS.md in the pandoc source code.
73697721.PP
73707722The Pandoc source code and all documentation may be downloaded
7371−from <http://pandoc.org>.
7723+from <https://pandoc.org>.
man/pandoc.1.after+1−1
@@ -1,3 +1,3 @@
11.PP
22The Pandoc source code and all documentation may be downloaded
3−from <http://pandoc.org>.
3+from <https://pandoc.org>.
pandoc.cabal+131−179
@@ -1,10 +1,10 @@
11cabal-version: 2.2
22name: pandoc
3−version: 2.11
3+version: 2.14.0.3
44build-type: Simple
55license: GPL-2.0-or-later
66license-file: COPYING.md
7−copyright: (c) 2006-2020 John MacFarlane
7+copyright: (c) 2006-2021 John MacFarlane
88author: John MacFarlane <jgm@berkeley.edu>
99maintainer: John MacFarlane <jgm@berkeley.edu>
1010bug-reports: https://github.com/jgm/pandoc/issues
@@ -12,7 +12,7 @@ stability: alpha
1212homepage: https://pandoc.org
1313category: Text
1414tested-with: GHC == 8.2.2, GHC == 8.4.4, GHC == 8.6.5,
15− GHC == 8.8.4, GHC == 8.10.2
15+ GHC == 8.8.4, GHC == 8.10.2, GHC == 9.0.1
1616synopsis: Conversion between markup formats
1717description: Pandoc is a Haskell library for converting from one markup
1818 format to another, and a command-line tool that uses
@@ -56,6 +56,8 @@ data-files:
5656 data/templates/default.icml
5757 data/templates/default.opml
5858 data/templates/default.latex
59+ data/templates/default.bibtex
60+ data/templates/default.biblatex
5961 data/templates/default.context
6062 data/templates/default.texinfo
6163 data/templates/default.jira
@@ -84,6 +86,7 @@ data-files:
8486 data/templates/default.epub2
8587 data/templates/default.epub3
8688 data/templates/article.jats_publishing
89+ data/templates/affiliations.jats
8790 -- translations
8891 data/translations/*.yaml
8992 -- source files for reference.docx
@@ -179,8 +182,6 @@ data-files:
179182 data/pandoc.List.lua
180183 -- bash completion template
181184 data/bash_completion.tpl
182− -- jats csl
183− data/jats.csl
184185 -- citeproc
185186 data/default.csl
186187 citeproc/biblatex-localization/*.lbx.strings
@@ -207,14 +208,25 @@ extra-source-files:
207208 test/command/*.md
208209 test/command/*.csl
209210 test/command/biblio.bib
210− test/command/biblatex-examples.bib
211+ test/command/averroes.bib
211212 test/command/A.txt
212213 test/command/B.txt
213214 test/command/C.txt
214215 test/command/D.txt
215216 test/command/01.csv
217+ test/command/chap1/spider.png
218+ test/command/chap2/spider.png
219+ test/command/chap1/text.md
220+ test/command/chap2/text.md
216221 test/command/defaults1.yaml
217222 test/command/defaults2.yaml
223+ test/command/defaults3.yaml
224+ test/command/defaults4.yaml
225+ test/command/defaults5.yaml
226+ test/command/defaults6.yaml
227+ test/command/defaults7.yaml
228+ test/command/defaults8.yaml
229+ test/command/defaults9.yaml
218230 test/command/3533-rst-csv-tables.csv
219231 test/command/3880.txt
220232 test/command/5182.txt
@@ -286,6 +298,7 @@ extra-source-files:
286298 test/tables.opendocument
287299 test/tables.org
288300 test/tables.asciidoc
301+ test/tables.asciidoctor
289302 test/tables.haddock
290303 test/tables.texinfo
291304 test/tables.rst
@@ -297,7 +310,9 @@ extra-source-files:
297310 test/tables.xwiki
298311 test/tables/*.html4
299312 test/tables/*.html5
313+ test/tables/*.latex
300314 test/tables/*.native
315+ test/tables/*.jats_archiving
301316 test/testsuite.txt
302317 test/writer.latex
303318 test/writer.context
@@ -318,6 +333,7 @@ extra-source-files:
318333 test/writer.opendocument
319334 test/writer.org
320335 test/writer.asciidoc
336+ test/writer.asciidoctor
321337 test/writer.haddock
322338 test/writer.rst
323339 test/writer.icml
@@ -376,10 +392,6 @@ source-repository head
376392 type: git
377393 location: git://github.com/jgm/pandoc.git
378394
379−flag static
380− Description: Use static linking for pandoc executable.
381− Default: False
382−
383395flag embed_data_files
384396 Description: Embed data files in binary for relocatable executable.
385397 Default: False
@@ -388,104 +400,116 @@ flag trypandoc
388400 Description: Build trypandoc cgi executable.
389401 Default: False
390402
403+common common-options
404+ default-language: Haskell2010
405+ build-depends: base >= 4.9 && < 5
406+ ghc-options: -Wall -fno-warn-unused-do-bind
407+ -Wincomplete-record-updates
408+ -Wnoncanonical-monad-instances
409+
410+ if impl(ghc < 8.4)
411+ hs-source-dirs: prelude
412+ other-modules: Prelude
413+ build-depends: base-compat >= 0.9
414+ other-extensions: NoImplicitPrelude
415+
416+ if os(windows)
417+ cpp-options: -D_WINDOWS
418+
419+ -- Later:
420+ -- -Wpartial-fields (currently used in Powerpoint writer)
421+ -- -Wmissing-export-lists (currently some Odt modules violate this)
422+ -- -Wredundant-constraints (problematic if we want to support older base)
423+ if impl(ghc >= 8.2)
424+ ghc-options: -Wcpp-undef
425+ if impl(ghc >= 8.4)
426+ ghc-options: -Wincomplete-uni-patterns
427+ -Widentities
428+ -fhide-source-paths
429+
430+common common-executable
431+ import: common-options
432+ build-depends: pandoc
433+ ghc-options: -rtsopts -with-rtsopts=-A8m -threaded
434+
435+
391436library
392− build-depends: base >= 4.9 && < 5,
393− Glob >= 0.7 && < 0.11,
437+ import: common-options
438+ build-depends: Glob >= 0.7 && < 0.11,
394439 HTTP >= 4000.0.5 && < 4000.4,
395440 HsYAML >= 0.2 && < 0.3,
396441 JuicyPixels >= 3.1.6.1 && < 3.4,
397442 SHA >= 1.6 && < 1.7,
398443 aeson >= 0.7 && < 1.6,
399444 aeson-pretty >= 0.8.5 && < 0.9,
400− attoparsec >= 0.12 && < 0.14,
401− base64-bytestring >= 0.1 && < 1.2,
402− binary >= 0.5 && < 0.11,
445+ array >= 0.5 && < 0.6,
446+ attoparsec >= 0.12 && < 0.15,
447+ base64-bytestring >= 0.1 && < 1.3,
448+ binary >= 0.7 && < 0.11,
403449 blaze-html >= 0.9 && < 0.10,
404450 blaze-markup >= 0.8 && < 0.9,
405451 bytestring >= 0.9 && < 0.12,
406452 case-insensitive >= 1.2 && < 1.3,
407− citeproc >= 0.1 && < 0.2,
408− commonmark >= 0.1.0.2 && < 0.2,
409− commonmark-extensions >= 0.2 && < 0.3,
410− commonmark-pandoc >= 0.2 && < 0.3,
453+ citeproc >= 0.4.0.1 && < 0.4.1,
454+ commonmark >= 0.2.1 && < 0.3,
455+ commonmark-extensions >= 0.2.1.2 && < 0.3,
456+ commonmark-pandoc >= 0.2.1.1 && < 0.3,
411457 connection >= 0.3.1,
412458 containers >= 0.4.2.1 && < 0.7,
413459 data-default >= 0.4 && < 0.8,
414460 deepseq >= 1.3 && < 1.5,
415461 directory >= 1.2.3 && < 1.4,
416− doclayout >= 0.3 && < 0.4,
417− doctemplates >= 0.8.2 && < 0.9,
462+ doclayout >= 0.3.0.1 && < 0.4,
463+ doctemplates >= 0.9 && < 0.10,
418464 emojis >= 0.1 && < 0.2,
419465 exceptions >= 0.8 && < 0.11,
420466 file-embed >= 0.0 && < 0.1,
421467 filepath >= 1.1 && < 1.5,
422− haddock-library >= 1.8 && < 1.10,
423− hslua >= 1.1 && < 1.3,
468+ haddock-library >= 1.10 && < 1.11,
469+ hslua >= 1.1 && < 1.4,
470+ hslua-module-path >= 0.1.0 && < 0.2.0,
424471 hslua-module-system >= 0.2 && < 0.3,
425472 hslua-module-text >= 0.2.1 && < 0.4,
426473 http-client >= 0.4.30 && < 0.8,
427474 http-client-tls >= 0.2.4 && < 0.4,
428475 http-types >= 0.8 && < 0.13,
429476 ipynb >= 0.1 && < 0.2,
430− jira-wiki-markup >= 1.3.2 && < 1.4,
477+ jira-wiki-markup >= 1.4 && < 1.5,
431478 mtl >= 2.2 && < 2.3,
432479 network >= 2.6,
433− network-uri >= 2.6 && < 2.7,
480+ network-uri >= 2.6 && < 2.8,
434481 pandoc-types >= 1.22 && < 1.23,
435482 parsec >= 3.1 && < 3.2,
436483 process >= 1.2.3 && < 1.7,
437− random >= 1 && < 1.2,
438− safe >= 0.3 && < 0.4,
484+ random >= 1 && < 1.3,
485+ safe >= 0.3.18 && < 0.4,
439486 scientific >= 0.3 && < 0.4,
440− skylighting >= 0.10 && < 0.11,
441− skylighting-core >= 0.10 && < 0.11,
487+ skylighting >= 0.10.5.2 && < 0.10.6,
488+ skylighting-core >= 0.10.5.2 && < 0.10.6,
442489 split >= 0.2 && < 0.3,
443490 syb >= 0.1 && < 0.8,
444491 tagsoup >= 0.14.6 && < 0.15,
445492 temporary >= 1.1 && < 1.4,
446− texmath >= 0.12.0.2 && < 0.13,
493+ texmath >= 0.12.3 && < 0.12.4,
447494 text >= 1.1.1.0 && < 1.3,
448495 text-conversions >= 0.3 && < 0.4,
449− time >= 1.5 && < 1.10,
496+ time >= 1.5 && < 1.12,
450497 unicode-transforms >= 0.3 && < 0.4,
451498 unordered-containers >= 0.2 && < 0.3,
452499 xml >= 1.3.12 && < 1.4,
500+ xml-conduit >= 1.9.1.1 && < 1.10,
501+ unicode-collation >= 0.1.1 && < 0.2,
453502 zip-archive >= 0.2.3.4 && < 0.5,
454503 zlib >= 0.5 && < 0.7
455504 if os(windows) && arch(i386)
456505 build-depends: basement >= 0.0.10,
457506 foundation >= 0.0.23
458507 -- basement 0.0.9 won't build on 32-bit windows.
459− if impl(ghc < 8.4)
460− hs-source-dirs: prelude
461− other-modules: Prelude
462− build-depends: base-compat >= 0.9
463− if os(windows)
464− cpp-options: -D_WINDOWS
465− else
508+ if !os(windows)
466509 build-depends: unix >= 2.4 && < 2.8
467510 if flag(embed_data_files)
468511 cpp-options: -DEMBED_DATA_FILES
469512 other-modules: Text.Pandoc.Data
470− if os(windows)
471− cpp-options: -D_WINDOWS
472− ghc-options: -Wall -fno-warn-unused-do-bind
473− -Wincomplete-record-updates
474− -Wnoncanonical-monad-instances
475− -- Later:
476− -- -Wpartial-fields (currently used in Powerpoint writer)
477− -- -Wmissing-export-lists (currently some Odt modules violate this)
478− -- -Wredundant-constraints (problematic if we want to support older base)
479− if impl(ghc >= 8.2)
480− ghc-options: -Wcpp-undef
481− if impl(ghc >= 8.4)
482− ghc-options: -Wincomplete-uni-patterns
483− -Widentities
484− -Werror=missing-home-modules
485− -fhide-source-paths
486−
487− default-language: Haskell2010
488− other-extensions: NoImplicitPrelude
489513 hs-source-dirs: src
490514
491515 exposed-modules: Text.Pandoc,
@@ -493,13 +517,13 @@ library
493517 Text.Pandoc.Options,
494518 Text.Pandoc.Extensions,
495519 Text.Pandoc.Shared,
520+ Text.Pandoc.Sources,
496521 Text.Pandoc.MediaBag,
497522 Text.Pandoc.Error,
498523 Text.Pandoc.Filter,
499524 Text.Pandoc.Readers,
500525 Text.Pandoc.Readers.HTML,
501526 Text.Pandoc.Readers.LaTeX,
502− Text.Pandoc.Readers.LaTeX.Types,
503527 Text.Pandoc.Readers.Markdown,
504528 Text.Pandoc.Readers.CommonMark,
505529 Text.Pandoc.Readers.Creole,
@@ -568,6 +592,7 @@ library
568592 Text.Pandoc.Writers.Shared,
569593 Text.Pandoc.Writers.OOXML,
570594 Text.Pandoc.Writers.AnnotatedTable,
595+ Text.Pandoc.Writers.BibTeX,
571596 Text.Pandoc.Lua,
572597 Text.Pandoc.PDF,
573598 Text.Pandoc.UTF8,
@@ -582,7 +607,6 @@ library
582607 Text.Pandoc.Asciify,
583608 Text.Pandoc.Emoji,
584609 Text.Pandoc.ImageSize,
585− Text.Pandoc.BCP47,
586610 Text.Pandoc.Class,
587611 Text.Pandoc.Citeproc
588612 other-modules: Text.Pandoc.App.CommandLineOptions,
@@ -603,9 +627,19 @@ library
603627 Text.Pandoc.Readers.Docx.Parse.Styles,
604628 Text.Pandoc.Readers.Docx.Util,
605629 Text.Pandoc.Readers.Docx.Fields,
606− Text.Pandoc.Readers.LaTeX.Parsing,
630+ Text.Pandoc.Readers.HTML.Parsing,
631+ Text.Pandoc.Readers.HTML.Table,
632+ Text.Pandoc.Readers.HTML.TagCategories,
633+ Text.Pandoc.Readers.HTML.Types,
634+ Text.Pandoc.Readers.LaTeX.Inline,
635+ Text.Pandoc.Readers.LaTeX.Citation,
607636 Text.Pandoc.Readers.LaTeX.Lang,
637+ Text.Pandoc.Readers.LaTeX.Macro,
638+ Text.Pandoc.Readers.LaTeX.Math,
639+ Text.Pandoc.Readers.LaTeX.Parsing,
608640 Text.Pandoc.Readers.LaTeX.SIunitx,
641+ Text.Pandoc.Readers.LaTeX.Table,
642+ Text.Pandoc.Readers.LaTeX.Types,
609643 Text.Pandoc.Readers.Odt.Base,
610644 Text.Pandoc.Readers.Odt.Namespaces,
611645 Text.Pandoc.Readers.Odt.StyleReader,
@@ -629,6 +663,21 @@ library
629663 Text.Pandoc.Readers.Metadata,
630664 Text.Pandoc.Readers.Roff,
631665 Text.Pandoc.Writers.Docx.StyleMap,
666+ Text.Pandoc.Writers.Docx.Table,
667+ Text.Pandoc.Writers.Docx.Types,
668+ Text.Pandoc.Writers.GridTable
669+ Text.Pandoc.Writers.JATS.References,
670+ Text.Pandoc.Writers.JATS.Table,
671+ Text.Pandoc.Writers.JATS.Types,
672+ Text.Pandoc.Writers.LaTeX.Caption,
673+ Text.Pandoc.Writers.LaTeX.Notes,
674+ Text.Pandoc.Writers.LaTeX.Table,
675+ Text.Pandoc.Writers.LaTeX.Lang,
676+ Text.Pandoc.Writers.LaTeX.Types,
677+ Text.Pandoc.Writers.LaTeX.Citation,
678+ Text.Pandoc.Writers.LaTeX.Util,
679+ Text.Pandoc.Writers.Markdown.Types,
680+ Text.Pandoc.Writers.Markdown.Inline,
632681 Text.Pandoc.Writers.Roff,
633682 Text.Pandoc.Writers.Powerpoint.Presentation,
634683 Text.Pandoc.Writers.Powerpoint.Output,
@@ -656,6 +705,10 @@ library
656705 Text.Pandoc.Lua.PandocLua,
657706 Text.Pandoc.Lua.Util,
658707 Text.Pandoc.Lua.Walk,
708+ Text.Pandoc.XML.Light,
709+ Text.Pandoc.XML.Light.Types,
710+ Text.Pandoc.XML.Light.Proc,
711+ Text.Pandoc.XML.Light.Output,
659712 Text.Pandoc.CSS,
660713 Text.Pandoc.CSV,
661714 Text.Pandoc.RoffChar,
@@ -674,121 +727,50 @@ library
674727 buildable: True
675728
676729executable pandoc
677− build-depends: pandoc, base >= 4.8 && < 5
678− if impl(ghc < 8.4)
679− hs-source-dirs: prelude
680− other-modules: Prelude
681− build-depends: base-compat >= 0.9
682− if flag(static)
683− ld-options: -static
684− default-language: Haskell2010
685− other-extensions: NoImplicitPrelude
686− hs-source-dirs: .
730+ import: common-executable
731+ hs-source-dirs: app
687732 main-is: pandoc.hs
688733 buildable: True
689734 other-modules: Paths_pandoc
690− ghc-options: -rtsopts -with-rtsopts=-K16m -threaded
691− -Wall -fno-warn-unused-do-bind
692− -Wincomplete-record-updates
693− -Wnoncanonical-monad-instances
694− if impl(ghc >= 8.2)
695− ghc-options: -Wcpp-undef
696− if impl(ghc >= 8.4)
697− ghc-options: -Wincomplete-uni-patterns
698− -Widentities
699− -Werror=missing-home-modules
700− -fhide-source-paths
701735
702736executable trypandoc
737+ import: common-executable
703738 main-is: trypandoc.hs
704739 hs-source-dirs: trypandoc
705− default-language: Haskell2010
706− other-extensions: NoImplicitPrelude
707740 if flag(trypandoc)
708− build-depends: base, aeson, pandoc,
709− text, wai-extra, wai >= 0.3, http-types
741+ build-depends: aeson, http-types, text, wai >= 0.3, wai-extra >= 3.0.24
710742 buildable: True
711743 else
712744 buildable: False
713− if impl(ghc < 8.4)
714− hs-source-dirs: prelude
715− other-modules: Prelude
716− build-depends: base-compat >= 0.9
717− ghc-options: -rtsopts -with-rtsopts=-K16m -threaded
718− -Wall -fno-warn-unused-do-bind
719− -Wincomplete-record-updates
720− -Wnoncanonical-monad-instances
721− if impl(ghc >= 8.2)
722− ghc-options: -Wcpp-undef
723− if impl(ghc >= 8.4)
724− ghc-options: -Wincomplete-uni-patterns
725− -Widentities
726− -Werror=missing-home-modules
727− -fhide-source-paths
728−
729−benchmark weigh-pandoc
730− type: exitcode-stdio-1.0
731− main-is: weigh-pandoc.hs
732− hs-source-dirs: benchmark
733− build-depends: pandoc,
734− base >= 4.8 && < 5,
735− mtl >= 2.2 && < 2.3,
736− text,
737− weigh >= 0.0 && < 0.1,
738− if impl(ghc < 8.4)
739− hs-source-dirs: prelude
740− other-modules: Prelude
741− build-depends: base-compat >= 0.9
742− default-language: Haskell2010
743− other-extensions: NoImplicitPrelude
744− ghc-options: -rtsopts -with-rtsopts=-K16m -threaded
745− -Wall -fno-warn-unused-do-bind
746− -Wincomplete-record-updates
747− -Wnoncanonical-monad-instances
748− if impl(ghc >= 8.2)
749− ghc-options: -Wcpp-undef
750− if impl(ghc >= 8.4)
751− ghc-options: -Wincomplete-uni-patterns
752− -Widentities
753− -Werror=missing-home-modules
754− -fhide-source-paths
755−
756745
757746test-suite test-pandoc
747+ import: common-executable
758748 type: exitcode-stdio-1.0
759749 main-is: test-pandoc.hs
760750 hs-source-dirs: test
761751 build-depends: pandoc,
762− base >= 4.8 && < 5,
763752 Diff >= 0.2 && < 0.5,
764753 Glob >= 0.7 && < 0.11,
765754 QuickCheck >= 2.4 && < 2.15,
766− base64-bytestring >= 0.1 && < 1.2,
767755 bytestring >= 0.9 && < 0.12,
768756 containers >= 0.4.2.1 && < 0.7,
769757 directory >= 1.2.3 && < 1.4,
770− doctemplates >= 0.8.2 && < 0.9,
758+ doctemplates >= 0.9 && < 0.10,
771759 exceptions >= 0.8 && < 0.11,
772− executable-path >= 0.0 && < 0.1,
773760 filepath >= 1.1 && < 1.5,
774− hslua >= 1.1 && < 1.3,
761+ hslua >= 1.1 && < 1.4,
775762 mtl >= 2.2 && < 2.3,
776763 pandoc-types >= 1.22 && < 1.23,
777764 process >= 1.2.3 && < 1.7,
778− tasty >= 0.11 && < 1.4,
765+ tasty >= 0.11 && < 1.5,
779766 tasty-golden >= 2.3 && < 2.4,
780767 tasty-hunit >= 0.9 && < 0.11,
781768 tasty-lua >= 0.2 && < 0.3,
782769 tasty-quickcheck >= 0.8 && < 0.11,
783− temporary >= 1.1 && < 1.4,
784− text >= 1.1.1.0 && < 1.3,
785− time >= 1.5 && < 1.10,
770+ text >= 1.1.1.0 && < 1.3,
771+ time >= 1.5 && < 1.12,
786772 xml >= 1.3.12 && < 1.4,
787773 zip-archive >= 0.2.3.4 && < 0.5
788− if impl(ghc < 8.4)
789− hs-source-dirs: prelude
790− other-modules: Prelude
791− build-depends: base-compat >= 0.9
792774 other-modules: Tests.Old
793775 Tests.Command
794776 Tests.Helpers
@@ -844,49 +826,19 @@ test-suite test-pandoc
844826 Tests.Writers.OOXML
845827 Tests.Writers.Ms
846828 Tests.Writers.AnnotatedTable
847− if os(windows)
848− cpp-options: -D_WINDOWS
849− default-language: Haskell2010
850− other-extensions: NoImplicitPrelude
851− ghc-options: -rtsopts -with-rtsopts=-K16m -threaded
852− -Wall -fno-warn-unused-do-bind
853− -Wincomplete-record-updates
854− -Wnoncanonical-monad-instances
855− if impl(ghc >= 8.2)
856− ghc-options: -Wcpp-undef
857− if impl(ghc >= 8.4)
858− ghc-options: -Wincomplete-uni-patterns
859− -Widentities
860− -Werror=missing-home-modules
861− -fhide-source-paths
862−
863829
864830benchmark benchmark-pandoc
831+ import: common-executable
865832 type: exitcode-stdio-1.0
866833 main-is: benchmark-pandoc.hs
867834 hs-source-dirs: benchmark
868− build-depends: pandoc,
869− base >= 4.8 && < 5,
870− bytestring,
835+ build-depends: bytestring,
871836 containers,
872− criterion >= 1.0 && < 1.6,
837+ -- gauge >= 0.2 && < 0.3,
838+ tasty-bench >= 0.2 && <= 0.3,
873839 mtl >= 2.2 && < 2.3,
874840 text >= 1.1.1.0 && < 1.3,
875− time
876− if impl(ghc < 8.4)
877− hs-source-dirs: prelude
878− other-modules: Prelude
879− build-depends: base-compat >= 0.9
880− default-language: Haskell2010
881− other-extensions: NoImplicitPrelude
882− ghc-options: -rtsopts -with-rtsopts=-K16m -threaded
883− -Wall -fno-warn-unused-do-bind
884− -Wincomplete-record-updates
885− -Wnoncanonical-monad-instances
886− if impl(ghc >= 8.2)
887− ghc-options: -Wcpp-undef
888− if impl(ghc >= 8.4)
889− ghc-options: -Wincomplete-uni-patterns
890− -Widentities
891− -Werror=missing-home-modules
892− -fhide-source-paths
841+ time,
842+ deepseq
843+ -- we increase heap size to avoid benchmarking garbage collection:
844+ ghc-options: -rtsopts -with-rtsopts=-A8m -threaded
release.nixnew file+4
@@ -0,0 +1,4 @@
1+let
2+ pkgs = import <nixpkgs> { };
3+in
4+ pkgs.haskellPackages.callPackage ./project.nix { }
shell.nixnew file+106
@@ -0,0 +1,106 @@
1+{nixpkgs ? import <nixpkgs> {} }:
2+let
3+ inherit (nixpkgs) pkgs;
4+ inherit (pkgs) haskellPackages;
5+
6+ haskellDeps = ps: with ps; [
7+ Diff
8+ Glob
9+ HTTP
10+ HTTP
11+ HsYAML
12+ JuicyPixels
13+ QuickCheck
14+ SHA
15+ aeson
16+ aeson-pretty
17+ attoparsec
18+ base
19+ base-compat
20+ base64-bytestring
21+ binary
22+ blaze-html
23+ blaze-markup
24+ bytestring
25+ case-insensitive
26+ citeproc
27+ commonmark
28+ commonmark-extensions
29+ commonmark-pandoc
30+ conduit-extra
31+ connection
32+ connection
33+ containers
34+ data-default
35+ deepseq
36+ directory
37+ doclayout
38+ doctemplates
39+ emojis
40+ exceptions
41+ file-embed
42+ filepath
43+ haddock-library
44+ hsc2hs
45+ hslua
46+ hslua-module-system
47+ hslua-module-text
48+ http-client
49+ http-client
50+ http-client-tls
51+ http-client-tls
52+ http-types
53+ ipynb
54+ jira-wiki-markup
55+ mtl
56+ network
57+ network
58+ network-uri
59+ pandoc-types
60+ parsec
61+ process
62+ random
63+ safe
64+ scientific
65+ skylighting
66+ skylighting-core
67+ socks
68+ split
69+ streaming-commons
70+ syb
71+ tagsoup
72+ tasty
73+ tasty-golden
74+ tasty-hunit
75+ tasty-lua
76+ tasty-quickcheck
77+ temporary
78+ texmath
79+ text
80+ text-conversions
81+ time
82+ tls
83+ unicode-transforms
84+ unordered-containers
85+ weigh
86+ xml
87+ xml-conduit
88+ zip-archive
89+ zlib
90+ ];
91+
92+ ghc = haskellPackages.ghcWithPackages haskellDeps;
93+
94+ nixPackages = [
95+ pkgs.zlib
96+ ghc
97+ pkgs.gdb
98+ haskellPackages.ghcid
99+ haskellPackages.cabal2nix
100+ haskellPackages.cabal-install
101+ ];
102+in
103+pkgs.stdenv.mkDerivation {
104+ name = "env";
105+ buildInputs = nixPackages;
106+}
src/Text/Pandoc.hs+1−1
@@ -3,7 +3,7 @@
33{-# LANGUAGE ScopedTypeVariables #-}
44{- |
55 Module : Text.Pandoc
6− Copyright : Copyright (C) 2006-2020 John MacFarlane
6+ Copyright : Copyright (C) 2006-2021 John MacFarlane
77 License : GNU GPL, version 2 or above
88
99 Maintainer : John MacFarlane <jgm@berkeley.edu>
src/Text/Pandoc/App.hs+82−56
@@ -1,9 +1,10 @@
1+{-# LANGUAGE LambdaCase #-}
12{-# LANGUAGE OverloadedStrings #-}
23{-# LANGUAGE CPP #-}
34{-# LANGUAGE ScopedTypeVariables #-}
45{- |
56 Module : Text.Pandoc.App
6− Copyright : Copyright (C) 2006-2020 John MacFarlane
7+ Copyright : Copyright (C) 2006-2021 John MacFarlane
78 License : GNU GPL, version 2 or above
89
910 Maintainer : John MacFarlane <jgm@berkeley@edu>
@@ -19,14 +20,16 @@ module Text.Pandoc.App (
1920 , Filter(..)
2021 , defaultOpts
2122 , parseOptions
23+ , parseOptionsFromArgs
2224 , options
2325 , applyFilters
2426 ) where
2527import qualified Control.Exception as E
26−import Control.Monad
27−import Control.Monad.Trans
28+import Control.Monad ( (>=>), when )
29+import Control.Monad.Trans ( MonadIO(..) )
2830import Control.Monad.Except (throwError)
2931import qualified Data.ByteString as BS
32+import qualified Data.ByteString.Char8 as B8
3033import qualified Data.ByteString.Lazy as BL
3134import Data.Char (toLower)
3235import Data.Maybe (fromMaybe, isJust, isNothing)
@@ -40,23 +43,25 @@ import qualified Data.Text.Encoding.Error as TSE
4043import Network.URI (URI (..), parseURI)
4144import System.Directory (doesDirectoryExist)
4245import System.Exit (exitSuccess)
43−import System.FilePath
46+import System.FilePath ( takeBaseName, takeExtension )
4447import System.IO (nativeNewline, stdout)
4548import qualified System.IO as IO (Newline (..))
4649import Text.Pandoc
50+import Text.Pandoc.Builder (setMeta)
51+import Text.Pandoc.MIME (getCharset)
4752import Text.Pandoc.App.FormatHeuristics (formatFromFilePaths)
4853import Text.Pandoc.App.Opt (Opt (..), LineEnding (..), defaultOpts,
49− IpynbOutput (..) )
50−import Text.Pandoc.App.CommandLineOptions (parseOptions, options)
54+ IpynbOutput (..))
55+import Text.Pandoc.App.CommandLineOptions (parseOptions, parseOptionsFromArgs,
56+ options)
5157import Text.Pandoc.App.OutputSettings (OutputSettings (..), optToOutputSettings)
52−import Text.Pandoc.BCP47 (Lang (..), parseBCP47)
53−import Text.Pandoc.Builder (setMeta)
58+import Text.Collate.Lang (Lang (..), parseLang)
5459import Text.Pandoc.Filter (Filter (JSONFilter, LuaFilter), applyFilters)
5560import Text.Pandoc.PDF (makePDF)
56−import Text.Pandoc.SelfContained (makeDataURI, makeSelfContained)
61+import Text.Pandoc.SelfContained (makeSelfContained)
5762import Text.Pandoc.Shared (eastAsianLineBreakFilter, stripEmptyParagraphs,
5863 headerShift, isURI, tabFilter, uriPathToPath, filterIpynbOutput,
59− defaultUserDataDirs, tshow, findM)
64+ defaultUserDataDir, tshow)
6065import Text.Pandoc.Writers.Shared (lookupMetaString)
6166import Text.Pandoc.Readers.Markdown (yamlToMeta)
6267import qualified Text.Pandoc.UTF8 as UTF8
@@ -67,25 +72,29 @@ import System.Posix.Terminal (queryTerminal)
6772
6873convertWithOpts :: Opt -> IO ()
6974convertWithOpts opts = do
75+ datadir <- case optDataDir opts of
76+ Nothing -> do
77+ d <- defaultUserDataDir
78+ exists <- doesDirectoryExist d
79+ return $ if exists
80+ then Just d
81+ else Nothing
82+ Just _ -> return $ optDataDir opts
83+
7084 let outputFile = fromMaybe "-" (optOutputFile opts)
7185 let filters = optFilters opts
7286 let verbosity = optVerbosity opts
7387
7488 when (optDumpArgs opts) $
75− do UTF8.hPutStrLn stdout outputFile
76− mapM_ (UTF8.hPutStrLn stdout) (fromMaybe ["-"] $ optInputFiles opts)
89+ do UTF8.hPutStrLn stdout (T.pack outputFile)
90+ mapM_ (UTF8.hPutStrLn stdout . T.pack)
91+ (fromMaybe ["-"] $ optInputFiles opts)
7792 exitSuccess
7893
7994 let sources = case optInputFiles opts of
8095 Just xs | not (optIgnoreArgs opts) -> xs
8196 _ -> ["-"]
8297
83− datadir <- case optDataDir opts of
84− Nothing -> do
85− ds <- defaultUserDataDirs
86− findM doesDirectoryExist ds
87− Just _ -> return $ optDataDir opts
88−
8998 let runIO' :: PandocIO a -> IO a
9099 runIO' f = do
91100 (res, reports) <- runIOorExplode $ do
@@ -131,9 +140,10 @@ convertWithOpts opts = do
131140 (map (T.pack . takeExtension) sources) "markdown"
132141 return "markdown"
133142
143+ let readerNameBase = T.takeWhile (\c -> c /= '+' && c /= '-') readerName
134144 let pdfOutput = map toLower (takeExtension outputFile) == ".pdf"
135145
136− when (pdfOutput && readerName == "latex") $
146+ when (pdfOutput && readerNameBase == "latex") $
137147 case optInputFiles opts of
138148 Just (inputFile:_) -> report $ UnusualConversion $ T.pack $
139149 "to convert a .tex file to PDF, you get better results by using pdflatex "
@@ -144,26 +154,29 @@ convertWithOpts opts = do
144154 (reader :: Reader PandocIO, readerExts) <- getReader readerName
145155
146156 let convertTabs = tabFilter (if optPreserveTabs opts ||
147− readerName == "t2t" ||
148− readerName == "man"
157+ readerNameBase == "t2t" ||
158+ readerNameBase == "man"
149159 then 0
150160 else optTabStop opts)
151161
152162
153− let readSources :: [FilePath] -> PandocIO Text
154− readSources srcs = convertTabs . T.intercalate (T.pack "\n") <$>
155− mapM readSource srcs
163+ let readSources :: [FilePath] -> PandocIO [(FilePath, Text)]
164+ readSources srcs =
165+ mapM (\fp -> do
166+ t <- readSource fp
167+ return (if fp == "-" then "" else fp, convertTabs t)) srcs
156168
157169
158170 outputSettings <- optToOutputSettings opts
159171 let format = outputFormat outputSettings
160172 let writer = outputWriter outputSettings
161173 let writerName = outputWriterName outputSettings
174+ let writerNameBase = T.takeWhile (\c -> c /= '+' && c /= '-') writerName
162175 let writerOptions = outputWriterOptions outputSettings
163176
164− let bibOutput = writerName == "bibtex" ||
165− writerName == "biblatex" ||
166− writerName == "csljson"
177+ let bibOutput = writerNameBase == "bibtex" ||
178+ writerNameBase == "biblatex" ||
179+ writerNameBase == "csljson"
167180
168181 let standalone = optStandalone opts ||
169182 not (isTextFormat format) ||
@@ -188,20 +201,9 @@ convertWithOpts opts = do
188201 Nothing -> readDataFile "abbreviations"
189202 Just f -> readFileStrict f
190203
191− metadata <- if format == "jats" &&
192− isNothing (lookupMeta "csl" (optMetadata opts)) &&
193− isNothing (lookupMeta "citation-style"
194− (optMetadata opts))
195− then do
196− jatsCSL <- readDataFile "jats.csl"
197− let jatsEncoded = makeDataURI
198− ("application/xml", jatsCSL)
199− return $ setMeta "csl" jatsEncoded $ optMetadata opts
200− else return $ optMetadata opts
201−
202204 case lookupMetaString "lang" (optMetadata opts) of
203− "" -> setTranslations $ Lang "en" "" "US" []
204− l -> case parseBCP47 l of
205+ "" -> setTranslations $ Lang "en" Nothing (Just "US") [] [] []
206+ l -> case parseLang l of
205207 Left _ -> report $ InvalidLang l
206208 Right l' -> setTranslations l'
207209
@@ -239,6 +241,7 @@ convertWithOpts opts = do
239241 then (eastAsianLineBreakFilter :)
240242 else id) .
241243 (case optIpynbOutput opts of
244+ _ | readerNameBase /= "ipynb" -> id
242245 IpynbOutputAll -> id
243246 IpynbOutputNone -> (filterIpynbOutput Nothing :)
244247 IpynbOutputBest -> (filterIpynbOutput (Just $
@@ -254,17 +257,21 @@ convertWithOpts opts = do
254257 let sourceToDoc :: [FilePath] -> PandocIO Pandoc
255258 sourceToDoc sources' =
256259 case reader of
257− TextReader r
258− | optFileScope opts || readerName == "json" ->
259− mconcat <$> mapM (readSource >=> r readerOpts) sources'
260− | otherwise ->
261− readSources sources' >>= r readerOpts
262− ByteStringReader r ->
263− mconcat <$> mapM (readFile' >=> r readerOpts) sources'
264−
265−
266− when (readerName == "markdown_github" ||
267− writerName == "markdown_github") $
260+ TextReader r
261+ | readerNameBase == "json" ->
262+ mconcat <$> mapM (readSource >=> r readerOpts) sources'
263+ | optFileScope opts ->
264+ -- Read source and convert tabs (see #6709)
265+ let readSource' = fmap convertTabs . readSource
266+ in mconcat <$> mapM (readSource' >=> r readerOpts) sources'
267+ | otherwise ->
268+ readSources sources' >>= r readerOpts
269+ ByteStringReader r ->
270+ mconcat <$> mapM (readFile' >=> r readerOpts) sources'
271+
272+
273+ when (readerNameBase == "markdown_github" ||
274+ writerNameBase == "markdown_github") $
268275 report $ Deprecated "markdown_github" "Use gfm instead."
269276
270277 mapM_ (uncurry setRequestHeader) (optRequestHeaders opts)
@@ -278,12 +285,21 @@ convertWithOpts opts = do
278285 report $ Deprecated "pandoc-citeproc filter"
279286 "Use --citeproc instead."
280287
288+ let cslMetadata =
289+ maybe id (setMeta "csl") (optCSL opts) .
290+ (case optBibliography opts of
291+ [] -> id
292+ xs -> setMeta "bibliography" xs) .
293+ maybe id (setMeta "citation-abbreviations")
294+ (optCitationAbbreviations opts) $ mempty
295+
281296 doc <- sourceToDoc sources >>=
282297 ( (if isJust (optExtractMedia opts)
283298 then fillMediaBag
284299 else return)
285300 >=> return . adjustMetadata (metadataFromFile <>)
286− >=> return . adjustMetadata (<> metadata)
301+ >=> return . adjustMetadata (<> optMetadata opts)
302+ >=> return . adjustMetadata (<> cslMetadata)
287303 >=> applyTransforms transforms
288304 >=> applyFilters readerOpts filters [T.unpack format]
289305 >=> maybe return extractMedia (optExtractMedia opts)
@@ -350,7 +366,18 @@ readSource src = case parseURI src of
350366 _ -> PandocAppError (tshow e))
351367
352368readURI :: FilePath -> PandocIO Text
353−readURI src = UTF8.toText . fst <$> openURL (T.pack src)
369+readURI src = do
370+ (bs, mt) <- openURL (T.pack src)
371+ case mt >>= getCharset of
372+ Just "UTF-8" -> return $ UTF8.toText bs
373+ Just "ISO-8859-1" -> return $ T.pack $ B8.unpack bs
374+ Just charset -> throwError $ PandocUnsupportedCharsetError charset
375+ Nothing -> liftIO $ -- try first as UTF-8, then as latin1
376+ E.catch (return $! UTF8.toText bs)
377+ (\case
378+ TSE.DecodeError{} ->
379+ return $ T.pack $ B8.unpack bs
380+ e -> E.throwIO e)
354381
355382readFile' :: MonadIO m => FilePath -> m BL.ByteString
356383readFile' "-" = liftIO BL.getContents
@@ -361,6 +388,5 @@ writeFnBinary "-" = liftIO . BL.putStr
361388writeFnBinary f = liftIO . BL.writeFile (UTF8.encodePath f)
362389
363390writerFn :: MonadIO m => IO.Newline -> FilePath -> Text -> m ()
364−-- TODO this implementation isn't maximally efficient:
365−writerFn eol "-" = liftIO . UTF8.putStrWith eol . T.unpack
366−writerFn eol f = liftIO . UTF8.writeFileWith eol f . T.unpack
391+writerFn eol "-" = liftIO . UTF8.putStrWith eol
392+writerFn eol f = liftIO . UTF8.writeFileWith eol f
src/Text/Pandoc/App/CommandLineOptions.hs+88−57
@@ -6,7 +6,7 @@
66{-# LANGUAGE FlexibleContexts #-}
77{- |
88 Module : Text.Pandoc.App.CommandLineOptions
9− Copyright : Copyright (C) 2006-2020 John MacFarlane
9+ Copyright : Copyright (C) 2006-2021 John MacFarlane
1010 License : GNU GPL, version 2 or above
1111
1212 Maintainer : John MacFarlane <jgm@berkeley@edu>
@@ -17,6 +17,7 @@ Does a pandoc conversion based on command-line options.
1717-}
1818module Text.Pandoc.App.CommandLineOptions (
1919 parseOptions
20+ , parseOptionsFromArgs
2021 , options
2122 , engines
2223 , lookupHighlightStyle
@@ -25,11 +26,12 @@ module Text.Pandoc.App.CommandLineOptions (
2526import Control.Monad
2627import Control.Monad.Trans
2728import Control.Monad.Except (throwError)
29+import Control.Monad.State.Strict
2830import Data.Aeson.Encode.Pretty (encodePretty', Config(..), keyOrder,
2931 defConfig, Indent(..), NumberFormat(..))
3032import Data.Bifunctor (second)
3133import Data.Char (toLower)
32−import Data.List (intercalate, sort)
34+import Data.List (intercalate, sort, foldl')
3335#ifdef _WINDOWS
3436#if MIN_VERSION_base(4,12,0)
3537import Data.List (isPrefixOf)
@@ -46,10 +48,13 @@ import System.FilePath
4648import System.IO (stdout)
4749import Text.DocTemplates (Context (..), ToContext (toVal), Val (..))
4850import Text.Pandoc
49−import Text.Pandoc.App.Opt (Opt (..), LineEnding (..), IpynbOutput (..), addMeta)
51+import Text.Pandoc.Builder (setMeta)
52+import Text.Pandoc.App.Opt (Opt (..), LineEnding (..), IpynbOutput (..),
53+ DefaultsState (..), applyDefaults,
54+ fullDefaultsPath)
5055import Text.Pandoc.Filter (Filter (..))
5156import Text.Pandoc.Highlighting (highlightingStyles)
52−import Text.Pandoc.Shared (ordNub, elemText, safeStrRead, defaultUserDataDirs, findM)
57+import Text.Pandoc.Shared (ordNub, elemText, safeStrRead, defaultUserDataDir)
5358import Text.Printf
5459
5560#ifdef EMBED_DATA_FILES
@@ -64,16 +69,19 @@ import qualified Data.ByteString as BS
6469import qualified Data.ByteString.Lazy as B
6570import qualified Data.Map as M
6671import qualified Data.Text as T
67−import qualified Data.YAML as Y
6872import qualified Text.Pandoc.UTF8 as UTF8
6973
7074parseOptions :: [OptDescr (Opt -> IO Opt)] -> Opt -> IO Opt
7175parseOptions options' defaults = do
7276 rawArgs <- map UTF8.decodeArg <$> getArgs
7377 prg <- getProgName
78+ parseOptionsFromArgs options' defaults prg rawArgs
7479
80+parseOptionsFromArgs
81+ :: [OptDescr (Opt -> IO Opt)] -> Opt -> String -> [String] -> IO Opt
82+parseOptionsFromArgs options' defaults prg rawArgs = do
7583 let (actions, args, unrecognizedOpts, errors) =
76− getOpt' Permute options' rawArgs
84+ getOpt' Permute options' (map UTF8.decodeArg rawArgs)
7785
7886 let unknownOptionErrors =
7987 foldr (handleUnrecognizedOption . takeWhile (/= '=')) []
@@ -85,7 +93,7 @@ parseOptions options' defaults = do
8593 ("Try " ++ prg ++ " --help for more information.")
8694
8795 -- thread option data structure through all supplied option actions
88− opts <- foldl (>>=) (return defaults) actions
96+ opts <- foldl' (>>=) (return defaults) actions
8997 let mbArgs = case args of
9098 [] -> Nothing
9199 xs -> Just xs
@@ -166,7 +174,11 @@ options =
166174
167175 , Option "d" ["defaults"]
168176 (ReqArg
169− (\arg opt -> applyDefaults opt arg
177+ (\arg opt -> runIOorExplode $ do
178+ let defsState = DefaultsState { curDefaults = Nothing,
179+ inheritanceGraph = [] }
180+ fp <- fullDefaultsPath (optDataDir opt) arg
181+ evalStateT (applyDefaults opt fp) defsState
170182 )
171183 "FILE")
172184 ""
@@ -276,7 +288,8 @@ options =
276288 , Option "" ["resource-path"]
277289 (ReqArg
278290 (\arg opt -> return opt { optResourcePath =
279− splitSearchPath arg })
291+ splitSearchPath arg ++
292+ optResourcePath opt })
280293 "SEARCHPATH")
281294 "" -- "Paths to search for images and other resources"
282295
@@ -529,9 +542,26 @@ options =
529542
530543 , Option "" ["atx-headers"]
531544 (NoArg
532− (\opt -> return opt { optSetextHeaders = False } ))
545+ (\opt -> do
546+ deprecatedOption "--atx-headers"
547+ "Use --markdown-headings=atx instead."
548+ return opt { optSetextHeaders = False } ))
533549 "" -- "Use atx-style headers for markdown"
534550
551+ , Option "" ["markdown-headings"]
552+ (ReqArg
553+ (\arg opt -> do
554+ headingFormat <- case arg of
555+ "setext" -> pure True
556+ "atx" -> pure False
557+ _ -> E.throwIO $ PandocOptionError $ T.pack
558+ ("Unknown markdown heading format: " ++ arg ++
559+ ". Expecting atx or setext")
560+ pure opt { optSetextHeaders = headingFormat }
561+ )
562+ "setext|atx")
563+ ""
564+
535565 , Option "" ["listings"]
536566 (NoArg
537567 (\opt -> return opt { optListings = True }))
@@ -784,10 +814,10 @@ options =
784814 map (\c -> ['-',c]) shorts ++
785815 map ("--" ++) longs
786816 let allopts = unwords (concatMap optnames options)
787− UTF8.hPutStrLn stdout $ printf tpl allopts
788− (unwords readersNames)
789− (unwords writersNames)
790− (unwords $ map (T.unpack . fst) highlightingStyles)
817+ UTF8.hPutStrLn stdout $ T.pack $ printf tpl allopts
818+ (T.unpack $ T.unwords readersNames)
819+ (T.unpack $ T.unwords writersNames)
820+ (T.unpack $ T.unwords $ map fst highlightingStyles)
791821 (unwords datafiles)
792822 exitSuccess ))
793823 "" -- "Print bash completion script"
@@ -826,7 +856,7 @@ options =
826856 else if extensionEnabled x allExts
827857 then '-'
828858 else ' ') : drop 4 (show x)
829− mapM_ (UTF8.hPutStrLn stdout . showExt)
859+ mapM_ (UTF8.hPutStrLn stdout . T.pack . showExt)
830860 [ex | ex <- extList, extensionEnabled ex allExts]
831861 exitSuccess )
832862 "FORMAT")
@@ -840,14 +870,14 @@ options =
840870 , sShortname s `notElem`
841871 [T.pack "Alert", T.pack "Alert_indent"]
842872 ]
843− mapM_ (UTF8.hPutStrLn stdout) (sort langs)
873+ mapM_ (UTF8.hPutStrLn stdout . T.pack) (sort langs)
844874 exitSuccess ))
845875 ""
846876
847877 , Option "" ["list-highlight-styles"]
848878 (NoArg
849879 (\_ -> do
850− mapM_ (UTF8.hPutStrLn stdout . T.unpack . fst) highlightingStyles
880+ mapM_ (UTF8.hPutStrLn stdout . fst) highlightingStyles
851881 exitSuccess ))
852882 ""
853883
@@ -865,7 +895,7 @@ options =
865895 | T.null t -> -- e.g. for docx, odt, json:
866896 E.throwIO $ PandocCouldNotFindDataFileError $ T.pack
867897 ("templates/default." ++ arg)
868− | otherwise -> write . T.unpack $ t
898+ | otherwise -> write t
869899 Left e -> E.throwIO e
870900 exitSuccess)
871901 "FORMAT")
@@ -911,11 +941,13 @@ options =
911941 (NoArg
912942 (\_ -> do
913943 prg <- getProgName
914− defaultDatadirs <- defaultUserDataDirs
915− UTF8.hPutStrLn stdout (prg ++ " " ++ T.unpack pandocVersion ++
916− compileInfo ++ "\nDefault user data directory: " ++
917− intercalate " or " defaultDatadirs ++
918− ('\n':copyrightMessage))
944+ defaultDatadir <- defaultUserDataDir
945+ UTF8.hPutStrLn stdout
946+ $ T.pack
947+ $ prg ++ " " ++ T.unpack pandocVersion ++
948+ compileInfo ++
949+ "\nUser data directory: " ++ defaultDatadir ++
950+ ('\n':copyrightMessage)
919951 exitSuccess ))
920952 "" -- "Print version"
921953
@@ -923,7 +955,7 @@ options =
923955 (NoArg
924956 (\_ -> do
925957 prg <- getProgName
926− UTF8.hPutStr stdout (usageMessage prg options)
958+ UTF8.hPutStr stdout (T.pack $ usageMessage prg options)
927959 exitSuccess ))
928960 "" -- "Show help"
929961 ]
@@ -944,16 +976,16 @@ usageMessage programName = usageInfo (programName ++ " [OPTIONS] [FILES]")
944976
945977copyrightMessage :: String
946978copyrightMessage = intercalate "\n" [
947− "Copyright (C) 2006-2020 John MacFarlane",
948− "Web: https://pandoc.org",
949− "This is free software; see the source for copying conditions.",
950− "There is no warranty, not even for merchantability or fitness",
951− "for a particular purpose." ]
979+ "Copyright (C) 2006-2021 John MacFarlane. Web: https://pandoc.org",
980+ "This is free software; see the source for copying conditions. There is no",
981+ "warranty, not even for merchantability or fitness for a particular purpose." ]
952982
953983compileInfo :: String
954984compileInfo =
955− "\nCompiled with pandoc-types " ++ VERSION_pandoc_types ++ ", texmath " ++
956− VERSION_texmath ++ ", skylighting " ++ VERSION_skylighting
985+ "\nCompiled with pandoc-types " ++ VERSION_pandoc_types ++
986+ ", texmath " ++ VERSION_texmath ++ ", skylighting " ++
987+ VERSION_skylighting ++ ",\nciteproc " ++ VERSION_citeproc ++
988+ ", ipynb " ++ VERSION_ipynb
957989
958990handleUnrecognizedOption :: String -> [String] -> [String]
959991handleUnrecognizedOption "--smart" =
@@ -984,38 +1016,16 @@ handleUnrecognizedOption "-R" = handleUnrecognizedOption "--parse-raw"
9841016handleUnrecognizedOption x =
9851017 (("Unknown option " ++ x ++ ".") :)
9861018
987−readersNames :: [String]
988−readersNames = sort (map (T.unpack . fst) (readers :: [(Text, Reader PandocIO)]))
1019+readersNames :: [Text]
1020+readersNames = sort (map fst (readers :: [(Text, Reader PandocIO)]))
9891021
990−writersNames :: [String]
1022+writersNames :: [Text]
9911023writersNames = sort
992− ("pdf" : map (T.unpack . fst) (writers :: [(Text, Writer PandocIO)]))
1024+ ("pdf" : map fst (writers :: [(Text, Writer PandocIO)]))
9931025
9941026splitField :: String -> (String, String)
9951027splitField = second (tailDef "true") . break (`elemText` ":=")
9961028
997−-- | Apply defaults from --defaults file.
998−applyDefaults :: Opt -> FilePath -> IO Opt
999−applyDefaults opt file = runIOorExplode $ do
1000− let fp = if null (takeExtension file)
1001− then addExtension file "yaml"
1002− else file
1003− setVerbosity $ optVerbosity opt
1004− dataDirs <- liftIO defaultUserDataDirs
1005− let fps = fp : case optDataDir opt of
1006− Nothing -> map (</> ("defaults" </> fp))
1007− dataDirs
1008− Just dd -> [dd </> "defaults" </> fp]
1009− fp' <- fromMaybe fp <$> findM fileExists fps
1010− inp <- readFileLazy fp'
1011− case Y.decode1 inp of
1012− Right (f :: Opt -> Opt) -> return $ f opt
1013− Left (errpos, errmsg) -> throwError $
1014− PandocParseError $ T.pack $
1015− "Error parsing " ++ fp' ++ " line " ++
1016− show (Y.posLine errpos) ++ " column " ++
1017− show (Y.posColumn errpos) ++ ":\n" ++ errmsg
1018−
10191029lookupHighlightStyle :: PandocMonad m => String -> m Style
10201030lookupHighlightStyle s
10211031 | takeExtension s == ".theme" = -- attempt to load KDE theme
@@ -1044,6 +1054,27 @@ setVariable key val (Context ctx) = Context $ M.alter go key ctx
10441054 go (Just (ListVal xs)) = Just $ ListVal $ xs ++ [toVal val]
10451055 go (Just x) = Just $ ListVal [x, toVal val]
10461056
1057+addMeta :: String -> String -> Meta -> Meta
1058+addMeta k v meta =
1059+ case lookupMeta k' meta of
1060+ Nothing -> setMeta k' v' meta
1061+ Just (MetaList xs) ->
1062+ setMeta k' (MetaList (xs ++ [v'])) meta
1063+ Just x -> setMeta k' (MetaList [x, v']) meta
1064+ where
1065+ v' = readMetaValue v
1066+ k' = T.pack k
1067+
1068+readMetaValue :: String -> MetaValue
1069+readMetaValue s
1070+ | s == "true" = MetaBool True
1071+ | s == "True" = MetaBool True
1072+ | s == "TRUE" = MetaBool True
1073+ | s == "false" = MetaBool False
1074+ | s == "False" = MetaBool False
1075+ | s == "FALSE" = MetaBool False
1076+ | otherwise = MetaString $ T.pack s
1077+
10471078-- On Windows with ghc 8.6+, we need to rewrite paths
10481079-- beginning with \\ to \\?\UNC\. -- See #5127.
10491080normalizePath :: FilePath -> FilePath
src/Text/Pandoc/App/FormatHeuristics.hs+19−8
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.App.FormatHeuristics
4− Copyright : Copyright (C) 2006-2020 John MacFarlane
4+ Copyright : Copyright (C) 2006-2021 John MacFarlane
55 License : GNU GPL, version 2 or above
66
77 Maintainer : John MacFarlane <jgm@berkeley@edu>
@@ -15,18 +15,24 @@ module Text.Pandoc.App.FormatHeuristics
1515 ) where
1616
1717import Data.Char (toLower)
18+import Data.Foldable (asum)
1819import Data.Text (Text)
1920import System.FilePath (takeExtension)
2021
21−-- Determine default format based on file extensions.
22+-- | Determines default format based on file extensions; uses the format
23+-- of the first extension that's associated with a format.
24+--
25+-- Examples:
26+--
27+-- > formatFromFilePaths ["text.unknown", "no-extension"]
28+-- Nothing
29+--
30+-- > formatFromFilePaths ["my.md", "other.rst"]
31+-- Just "markdown"
2232formatFromFilePaths :: [FilePath] -> Maybe Text
23−formatFromFilePaths [] = Nothing
24−formatFromFilePaths (x:xs) =
25− case formatFromFilePath x of
26− Just f -> Just f
27− Nothing -> formatFromFilePaths xs
33+formatFromFilePaths = asum . map formatFromFilePath
2834
29−-- Determine format based on file extension
35+-- | Determines format based on file extension.
3036formatFromFilePath :: FilePath -> Maybe Text
3137formatFromFilePath x =
3238 case takeExtension (map toLower x) of
@@ -48,6 +54,11 @@ formatFromFilePath x =
4854 ".lhs" -> Just "markdown+lhs"
4955 ".ltx" -> Just "latex"
5056 ".markdown" -> Just "markdown"
57+ ".mkdn" -> Just "markdown"
58+ ".mkd" -> Just "markdown"
59+ ".mdwn" -> Just "markdown"
60+ ".mdown" -> Just "markdown"
61+ ".Rmd" -> Just "markdown"
5162 ".md" -> Just "markdown"
5263 ".ms" -> Just "ms"
5364 ".muse" -> Just "muse"
src/Text/Pandoc/App/Opt.hs+269−48
@@ -7,7 +7,7 @@
77{-# LANGUAGE FlexibleContexts #-}
88{- |
99 Module : Text.Pandoc.App.Opt
10− Copyright : Copyright (C) 2006-2020 John MacFarlane
10+ Copyright : Copyright (C) 2006-2021 John MacFarlane
1111 License : GNU GPL, version 2 or above
1212
1313 Maintainer : John MacFarlane <jgm@berkeley@edu>
@@ -20,21 +20,31 @@ module Text.Pandoc.App.Opt (
2020 Opt(..)
2121 , LineEnding (..)
2222 , IpynbOutput (..)
23+ , DefaultsState (..)
2324 , defaultOpts
24− , addMeta
25+ , applyDefaults
26+ , fullDefaultsPath
2527 ) where
28+import Control.Monad.Except (MonadIO, liftIO, throwError, (>=>), foldM)
29+import Control.Monad.State.Strict (StateT, modify, gets)
30+import System.FilePath ( addExtension, (</>), takeExtension, takeDirectory )
31+import System.Directory ( canonicalizePath )
2632import Data.Char (isLower, toLower)
33+import Data.Maybe (fromMaybe)
2734import GHC.Generics hiding (Meta)
28−import Text.Pandoc.Builder (setMeta)
2935import Text.Pandoc.Filter (Filter (..))
30−import Text.Pandoc.Logging (Verbosity (WARNING))
36+import Text.Pandoc.Logging (Verbosity (WARNING), LogMessage(..))
3137import Text.Pandoc.Options (TopLevelDivision (TopLevelDefault),
3238 TrackChanges (AcceptChanges),
3339 WrapOption (WrapAuto), HTMLMathMethod (PlainMath),
3440 ReferenceLocation (EndOfDocument),
3541 ObfuscationMethod (NoObfuscation),
3642 CiteMethod (Citeproc))
37−import Text.Pandoc.Shared (camelCaseStrToHyphenated)
43+import Text.Pandoc.Class (readFileLazy, fileExists, setVerbosity, report,
44+ PandocMonad(lookupEnv), getUserDataDir)
45+import Text.Pandoc.Error (PandocError (PandocParseError, PandocSomeError))
46+import Text.Pandoc.Shared (camelCaseStrToHyphenated, defaultUserDataDir,
47+ findM, ordNub)
3848import qualified Text.Pandoc.Parsing as P
3949import Text.Pandoc.Readers.Metadata (yamlMap)
4050import Text.Pandoc.Class.PandocPure
@@ -43,7 +53,7 @@ import Data.Text (Text, unpack)
4353import Data.Default (def)
4454import qualified Data.Text as T
4555import qualified Data.Map as M
46−import Text.Pandoc.Definition (Meta(..), MetaValue(..), lookupMeta)
56+import Text.Pandoc.Definition (Meta(..), MetaValue(..))
4757import Data.Aeson (defaultOptions, Options(..))
4858import Data.Aeson.TH (deriveJSON)
4959import Control.Applicative ((<|>))
@@ -147,19 +157,194 @@ data Opt = Opt
147157 , optNoCheckCertificate :: Bool -- ^ Disable certificate validation
148158 , optEol :: LineEnding -- ^ Style of line-endings to use
149159 , optStripComments :: Bool -- ^ Skip HTML comments
160+ , optCSL :: Maybe FilePath -- ^ CSL stylesheet
161+ , optBibliography :: [FilePath] -- ^ Bibliography files
162+ , optCitationAbbreviations :: Maybe FilePath -- ^ Citation abbreviations
150163 } deriving (Generic, Show)
151164
152165instance FromYAML (Opt -> Opt) where
153− parseYAML (Mapping _ _ m) =
154− foldr (.) id <$> mapM doOpt (M.toList m)
166+ parseYAML (Mapping _ _ m) = chain doOpt (M.toList m)
155167 parseYAML n = failAtNode n "Expected a mapping"
156168
169+data DefaultsState = DefaultsState
170+ {
171+ curDefaults :: Maybe FilePath -- currently parsed file
172+ , inheritanceGraph :: [[FilePath]] -- defaults file inheritance graph
173+ } deriving (Show)
174+
175+instance (PandocMonad m, MonadIO m)
176+ => FromYAML (Opt -> StateT DefaultsState m Opt) where
177+ parseYAML (Mapping _ _ m) = do
178+ let opts = M.mapKeys toText m
179+ dataDir <- case M.lookup "data-dir" opts of
180+ Nothing -> return Nothing
181+ Just v -> Just . unpack <$> parseYAML v
182+ f <- parseOptions (M.toList m)
183+ case M.lookup "defaults" opts of
184+ Just v -> do
185+ g <- parseDefaults v dataDir
186+ return $ g >=> f >=> resolveVarsInOpt
187+ Nothing -> return $ f >=> resolveVarsInOpt
188+ where
189+ toText (Scalar _ (SStr s)) = s
190+ toText _ = ""
191+ parseYAML n = failAtNode n "Expected a mapping"
192+
193+resolveVarsInOpt :: forall m. (PandocMonad m, MonadIO m)
194+ => Opt -> StateT DefaultsState m Opt
195+resolveVarsInOpt
196+ opt@Opt
197+ { optTemplate = oTemplate
198+ , optMetadataFiles = oMetadataFiles
199+ , optOutputFile = oOutputFile
200+ , optInputFiles = oInputFiles
201+ , optSyntaxDefinitions = oSyntaxDefinitions
202+ , optAbbreviations = oAbbreviations
203+ , optReferenceDoc = oReferenceDoc
204+ , optEpubMetadata = oEpubMetadata
205+ , optEpubFonts = oEpubFonts
206+ , optEpubCoverImage = oEpubCoverImage
207+ , optLogFile = oLogFile
208+ , optFilters = oFilters
209+ , optDataDir = oDataDir
210+ , optExtractMedia = oExtractMedia
211+ , optCss = oCss
212+ , optIncludeBeforeBody = oIncludeBeforeBody
213+ , optIncludeAfterBody = oIncludeAfterBody
214+ , optIncludeInHeader = oIncludeInHeader
215+ , optResourcePath = oResourcePath
216+ , optCSL = oCSL
217+ , optBibliography = oBibliography
218+ , optCitationAbbreviations = oCitationAbbreviations
219+ }
220+ = do
221+ oTemplate' <- mapM resolveVars oTemplate
222+ oMetadataFiles' <- mapM resolveVars oMetadataFiles
223+ oOutputFile' <- mapM resolveVars oOutputFile
224+ oInputFiles' <- mapM (mapM resolveVars) oInputFiles
225+ oSyntaxDefinitions' <- mapM resolveVars oSyntaxDefinitions
226+ oAbbreviations' <- mapM resolveVars oAbbreviations
227+ oReferenceDoc' <- mapM resolveVars oReferenceDoc
228+ oEpubMetadata' <- mapM resolveVars oEpubMetadata
229+ oEpubFonts' <- mapM resolveVars oEpubFonts
230+ oEpubCoverImage' <- mapM resolveVars oEpubCoverImage
231+ oLogFile' <- mapM resolveVars oLogFile
232+ oFilters' <- mapM resolveVarsInFilter oFilters
233+ oDataDir' <- mapM resolveVars oDataDir
234+ oExtractMedia' <- mapM resolveVars oExtractMedia
235+ oCss' <- mapM resolveVars oCss
236+ oIncludeBeforeBody' <- mapM resolveVars oIncludeBeforeBody
237+ oIncludeAfterBody' <- mapM resolveVars oIncludeAfterBody
238+ oIncludeInHeader' <- mapM resolveVars oIncludeInHeader
239+ oResourcePath' <- mapM resolveVars oResourcePath
240+ oCSL' <- mapM resolveVars oCSL
241+ oBibliography' <- mapM resolveVars oBibliography
242+ oCitationAbbreviations' <- mapM resolveVars oCitationAbbreviations
243+ return opt{ optTemplate = oTemplate'
244+ , optMetadataFiles = oMetadataFiles'
245+ , optOutputFile = oOutputFile'
246+ , optInputFiles = oInputFiles'
247+ , optSyntaxDefinitions = oSyntaxDefinitions'
248+ , optAbbreviations = oAbbreviations'
249+ , optReferenceDoc = oReferenceDoc'
250+ , optEpubMetadata = oEpubMetadata'
251+ , optEpubFonts = oEpubFonts'
252+ , optEpubCoverImage = oEpubCoverImage'
253+ , optLogFile = oLogFile'
254+ , optFilters = oFilters'
255+ , optDataDir = oDataDir'
256+ , optExtractMedia = oExtractMedia'
257+ , optCss = oCss'
258+ , optIncludeBeforeBody = oIncludeBeforeBody'
259+ , optIncludeAfterBody = oIncludeAfterBody'
260+ , optIncludeInHeader = oIncludeInHeader'
261+ , optResourcePath = oResourcePath'
262+ , optCSL = oCSL'
263+ , optBibliography = oBibliography'
264+ , optCitationAbbreviations = oCitationAbbreviations'
265+ }
266+
267+ where
268+ resolveVars :: FilePath -> StateT DefaultsState m FilePath
269+ resolveVars [] = return []
270+ resolveVars ('$':'{':xs) =
271+ let (ys, zs) = break (=='}') xs
272+ in if null zs
273+ then return $ '$':'{':xs
274+ else do
275+ val <- lookupEnv' ys
276+ (val ++) <$> resolveVars (drop 1 zs)
277+ resolveVars (c:cs) = (c:) <$> resolveVars cs
278+ lookupEnv' :: String -> StateT DefaultsState m String
279+ lookupEnv' "." = do
280+ mbCurDefaults <- gets curDefaults
281+ maybe (return "")
282+ (fmap takeDirectory . liftIO . canonicalizePath)
283+ mbCurDefaults
284+ lookupEnv' "USERDATA" = do
285+ mbodatadir <- mapM resolveVars oDataDir
286+ mbdatadir <- getUserDataDir
287+ defdatadir <- liftIO defaultUserDataDir
288+ return $ fromMaybe defdatadir (mbodatadir <|> mbdatadir)
289+ lookupEnv' v = do
290+ mbval <- fmap T.unpack <$> lookupEnv (T.pack v)
291+ case mbval of
292+ Nothing -> do
293+ report $ EnvironmentVariableUndefined (T.pack v)
294+ return mempty
295+ Just x -> return x
296+ resolveVarsInFilter (JSONFilter fp) =
297+ JSONFilter <$> resolveVars fp
298+ resolveVarsInFilter (LuaFilter fp) =
299+ LuaFilter <$> resolveVars fp
300+ resolveVarsInFilter CiteprocFilter = return CiteprocFilter
301+
302+
303+
304+parseDefaults :: (PandocMonad m, MonadIO m)
305+ => Node Pos
306+ -> Maybe FilePath
307+ -> Parser (Opt -> StateT DefaultsState m Opt)
308+parseDefaults n dataDir = parseDefsNames n >>= \ds -> return $ \o -> do
309+ -- get parent defaults:
310+ defsParent <- gets $ fromMaybe "" . curDefaults
311+ -- get child defaults:
312+ defsChildren <- mapM (fullDefaultsPath dataDir) ds
313+ -- expand parent in defaults inheritance graph by children:
314+ defsGraph <- gets inheritanceGraph
315+ let defsGraphExp = expand defsGraph defsChildren defsParent
316+ modify $ \defsState -> defsState{ inheritanceGraph = defsGraphExp }
317+ -- check for cyclic inheritance:
318+ if cyclic defsGraphExp
319+ then throwError $
320+ PandocSomeError $ T.pack $
321+ "Error: Circular defaults file reference in " ++
322+ "'" ++ defsParent ++ "'"
323+ else foldM applyDefaults o defsChildren
324+ where parseDefsNames x = (parseYAML x >>= \xs -> return $ map unpack xs)
325+ <|> (parseYAML x >>= \x' -> return [unpack x'])
326+
327+parseOptions :: Monad m
328+ => [(Node Pos, Node Pos)]
329+ -> Parser (Opt -> StateT DefaultsState m Opt)
330+parseOptions ns = do
331+ f <- chain doOpt' ns
332+ return $ return . f
333+
334+chain :: Monad m => (a -> m (b -> b)) -> [a] -> m (b -> b)
335+chain f = foldM g id
336+ where g o n = f n >>= \o' -> return $ o' . o
337+
338+doOpt' :: (Node Pos, Node Pos) -> Parser (Opt -> Opt)
339+doOpt' (k',v) = do
340+ k <- parseStringKey k'
341+ case k of
342+ "defaults" -> return id
343+ _ -> doOpt (k',v)
344+
157345doOpt :: (Node Pos, Node Pos) -> Parser (Opt -> Opt)
158346doOpt (k',v) = do
159− k <- case k' of
160− Scalar _ (SStr t) -> return t
161− Scalar _ _ -> failAtNode k' "Non-string key"
162− _ -> failAtNode k' "Non-scalar key"
347+ k <- parseStringKey k'
163348 case k of
164349 "tab-stop" ->
165350 parseYAML v >>= \x -> return (\o -> o{ optTabStop = x })
@@ -330,6 +515,12 @@ doOpt (k',v) = do
330515 parseYAML v >>= \x -> return (\o -> o{ optSlideLevel = x })
331516 "atx-headers" ->
332517 parseYAML v >>= \x -> return (\o -> o{ optSetextHeaders = not x })
518+ "markdown-headings" ->
519+ parseYAML v >>= \x -> return (\o ->
520+ case T.toLower x of
521+ "atx" -> o{ optSetextHeaders = False }
522+ "setext" -> o{ optSetextHeaders = True }
523+ _ -> o)
333524 "ascii" ->
334525 parseYAML v >>= \x -> return (\o -> o{ optAscii = x })
335526 "default-image-extension" ->
@@ -352,21 +543,18 @@ doOpt (k',v) = do
352543 (parseYAML v >>= \x -> return (\o -> o{ optCss = optCss o <>
353544 [unpack x] }))
354545 "bibliography" ->
355− do let addItem x o = o{ optMetadata =
356− addMeta "bibliography" (T.unpack x)
357− (optMetadata o) }
358− (parseYAML v >>= \(xs :: [Text]) -> return $ \o ->
359− foldr addItem o xs)
360− <|>
361− (parseYAML v >>= \(x :: Text) -> return $ \o -> addItem x o)
546+ (parseYAML v >>= \x -> return (\o ->
547+ o{ optBibliography = optBibliography o <>
548+ map unpack x }))
549+ <|>
550+ (parseYAML v >>= \x -> return (\o ->
551+ o{ optBibliography = optBibliography o <>
552+ [unpack x] }))
362553 "csl" ->
363− do let addItem x o = o{ optMetadata =
364− addMeta "csl" (T.unpack x)
365− (optMetadata o) }
366− (parseYAML v >>= \(xs :: [Text]) -> return $ \o ->
367− foldr addItem o xs)
368− <|>
369− (parseYAML v >>= \(x :: Text) -> return $ \o -> addItem x o)
554+ parseYAML v >>= \x -> return (\o -> o{ optCSL = unpack <$> x })
555+ "citation-abbreviations" ->
556+ parseYAML v >>= \x -> return (\o -> o{ optCitationAbbreviations =
557+ unpack <$> x })
370558 "ipynb-output" ->
371559 parseYAML v >>= \x -> return (\o -> o{ optIpynbOutput = x })
372560 "include-before-body" ->
@@ -395,7 +583,8 @@ doOpt (k',v) = do
395583 optIncludeInHeader o <> [unpack x] }))
396584 "resource-path" ->
397585 parseYAML v >>= \x ->
398− return (\o -> o{ optResourcePath = map unpack x })
586+ return (\o -> o{ optResourcePath = map unpack x <>
587+ optResourcePath o })
399588 "request-headers" ->
400589 parseYAML v >>= \x ->
401590 return (\o -> o{ optRequestHeaders = x })
@@ -464,7 +653,7 @@ defaultOpts = Opt
464653 , optPdfEngine = Nothing
465654 , optPdfEngineOpts = []
466655 , optSlideLevel = Nothing
467− , optSetextHeaders = True
656+ , optSetextHeaders = False
468657 , optAscii = False
469658 , optDefaultImageExtension = ""
470659 , optExtractMedia = Nothing
@@ -481,38 +670,70 @@ defaultOpts = Opt
481670 , optNoCheckCertificate = False
482671 , optEol = Native
483672 , optStripComments = False
673+ , optCSL = Nothing
674+ , optBibliography = []
675+ , optCitationAbbreviations = Nothing
484676 }
485677
678+parseStringKey :: Node Pos -> Parser Text
679+parseStringKey k = case k of
680+ Scalar _ (SStr t) -> return t
681+ Scalar _ _ -> failAtNode k "Non-string key"
682+ _ -> failAtNode k "Non-scalar key"
683+
486684yamlToMeta :: Node Pos -> Parser Meta
487685yamlToMeta (Mapping _ _ m) =
488686 either (fail . show) return $ runEverything (yamlMap pMetaString m)
489687 where
490688 pMetaString = pure . MetaString <$> P.manyChar P.anyChar
491− runEverything p = runPure (P.readWithM p def "")
689+ runEverything p =
690+ runPure (P.readWithM p (def :: P.ParserState) ("" :: Text))
492691 >>= fmap (Meta . flip P.runF def)
493692yamlToMeta _ = return mempty
494693
495−addMeta :: String -> String -> Meta -> Meta
496−addMeta k v meta =
497− case lookupMeta k' meta of
498− Nothing -> setMeta k' v' meta
499− Just (MetaList xs) ->
500− setMeta k' (MetaList (xs ++ [v'])) meta
501− Just x -> setMeta k' (MetaList [x, v']) meta
502− where
503− v' = readMetaValue v
504− k' = T.pack k
694+-- | Apply defaults from --defaults file.
695+applyDefaults :: (PandocMonad m, MonadIO m)
696+ => Opt
697+ -> FilePath
698+ -> StateT DefaultsState m Opt
699+applyDefaults opt file = do
700+ setVerbosity $ optVerbosity opt
701+ modify $ \defsState -> defsState{ curDefaults = Just file }
702+ inp <- readFileLazy file
703+ case decode1 inp of
704+ Right f -> f opt
705+ Left (errpos, errmsg) -> throwError $
706+ PandocParseError $ T.pack $
707+ "Error parsing " ++ file ++ " line " ++
708+ show (posLine errpos) ++ " column " ++
709+ show (posColumn errpos) ++ ":\n" ++ errmsg
505710
506−readMetaValue :: String -> MetaValue
507−readMetaValue s
508− | s == "true" = MetaBool True
509− | s == "True" = MetaBool True
510− | s == "TRUE" = MetaBool True
511− | s == "false" = MetaBool False
512− | s == "False" = MetaBool False
513− | s == "FALSE" = MetaBool False
514− | otherwise = MetaString $ T.pack s
711+fullDefaultsPath :: (PandocMonad m, MonadIO m)
712+ => Maybe FilePath
713+ -> FilePath
714+ -> m FilePath
715+fullDefaultsPath dataDir file = do
716+ let fp = if null (takeExtension file)
717+ then addExtension file "yaml"
718+ else file
719+ defaultDataDir <- liftIO defaultUserDataDir
720+ let defaultFp = fromMaybe defaultDataDir dataDir </> "defaults" </> fp
721+ fromMaybe fp <$> findM fileExists [fp, defaultFp]
515722
723+-- | In a list of lists, append another list in front of every list which
724+-- starts with specific element.
725+expand :: Ord a => [[a]] -> [a] -> a -> [[a]]
726+expand [] ns n = fmap (\x -> x : [n]) ns
727+expand ps ns n = concatMap (ext n ns) ps
728+ where
729+ ext x xs p = case p of
730+ (l : _) | x == l -> fmap (: p) xs
731+ _ -> [p]
732+
733+cyclic :: Ord a => [[a]] -> Bool
734+cyclic = any hasDuplicate
735+ where
736+ hasDuplicate xs = length (ordNub xs) /= length xs
516737
517738-- see https://github.com/jgm/pandoc/pull/4083
518739-- using generic deriving caused long compilation times
src/Text/Pandoc/App/OutputSettings.hs+3−3
@@ -5,7 +5,7 @@
55{-# LANGUAGE TupleSections #-}
66{- |
77 Module : Text.Pandoc.App
8− Copyright : Copyright (C) 2006-2020 John MacFarlane
8+ Copyright : Copyright (C) 2006-2021 John MacFarlane
99 License : GNU GPL, version 2 or above
1010
1111 Maintainer : John MacFarlane <jgm@berkeley@edu>
@@ -59,8 +59,8 @@ optToOutputSettings opts = do
5959 let outputFile = fromMaybe "-" (optOutputFile opts)
6060
6161 when (optDumpArgs opts) . liftIO $ do
62− UTF8.hPutStrLn stdout outputFile
63− mapM_ (UTF8.hPutStrLn stdout) (fromMaybe [] $ optInputFiles opts)
62+ UTF8.hPutStrLn stdout (T.pack outputFile)
63+ mapM_ (UTF8.hPutStrLn stdout . T.pack) (fromMaybe [] $ optInputFiles opts)
6464 exitSuccess
6565
6666 epubMetadata <- traverse readUtf8File $ optEpubMetadata opts
src/Text/Pandoc/Asciify.hs+14−391
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Asciify
3− Copyright : Copyright (C) 2013-2020 John MacFarlane
3+ Copyright : Copyright (C) 2013-2021 John MacFarlane
44 License : GNU GPL, version 2 or above
55
66 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -10,396 +10,19 @@
1010Function to convert accented latin letters to their unaccented
1111ascii equivalents (used in constructing HTML identifiers).
1212-}
13−module Text.Pandoc.Asciify (toAsciiChar)
13+module Text.Pandoc.Asciify (toAsciiChar, toAsciiText)
1414where
15−import Data.Char (isAscii)
16−import qualified Data.Map as M
15+import Data.Char (isAscii, isMark)
16+import qualified Data.Text.Normalize as TN
17+import Data.Text (Text)
18+import qualified Data.Text as T
1719
18−toAsciiChar :: Char -> Maybe Char
19−toAsciiChar c | isAscii c = Just c
20− | otherwise = M.lookup c asciiMap
20+toAsciiText :: Text -> Text
21+toAsciiText = T.filter isAscii . TN.normalize (TN.NFD)
2122
22−asciiMap :: M.Map Char Char
23−asciiMap = M.fromList
24− [('\192','A')
25− ,('\193','A')
26− ,('\194','A')
27− ,('\195','A')
28− ,('\196','A')
29− ,('\197','A')
30− ,('\199','C')
31− ,('\200','E')
32− ,('\201','E')
33− ,('\202','E')
34− ,('\203','E')
35− ,('\204','I')
36− ,('\205','I')
37− ,('\206','I')
38− ,('\207','I')
39− ,('\209','N')
40− ,('\210','O')
41− ,('\211','O')
42− ,('\212','O')
43− ,('\213','O')
44− ,('\214','O')
45− ,('\217','U')
46− ,('\218','U')
47− ,('\219','U')
48− ,('\220','U')
49− ,('\221','Y')
50− ,('\224','a')
51− ,('\225','a')
52− ,('\226','a')
53− ,('\227','a')
54− ,('\228','a')
55− ,('\229','a')
56− ,('\231','c')
57− ,('\232','e')
58− ,('\233','e')
59− ,('\234','e')
60− ,('\235','e')
61− ,('\236','i')
62− ,('\237','i')
63− ,('\238','i')
64− ,('\239','i')
65− ,('\241','n')
66− ,('\242','o')
67− ,('\243','o')
68− ,('\244','o')
69− ,('\245','o')
70− ,('\246','o')
71− ,('\249','u')
72− ,('\250','u')
73− ,('\251','u')
74− ,('\252','u')
75− ,('\253','y')
76− ,('\255','y')
77− ,('\256','A')
78− ,('\257','a')
79− ,('\258','A')
80− ,('\259','a')
81− ,('\260','A')
82− ,('\261','a')
83− ,('\262','C')
84− ,('\263','c')
85− ,('\264','C')
86− ,('\265','c')
87− ,('\266','C')
88− ,('\267','c')
89− ,('\268','C')
90− ,('\269','c')
91− ,('\270','D')
92− ,('\271','d')
93− ,('\274','E')
94− ,('\275','e')
95− ,('\276','E')
96− ,('\277','e')
97− ,('\278','E')
98− ,('\279','e')
99− ,('\280','E')
100− ,('\281','e')
101− ,('\282','E')
102− ,('\283','e')
103− ,('\284','G')
104− ,('\285','g')
105− ,('\286','G')
106− ,('\287','g')
107− ,('\288','G')
108− ,('\289','g')
109− ,('\290','G')
110− ,('\291','g')
111− ,('\292','H')
112− ,('\293','h')
113− ,('\296','I')
114− ,('\297','i')
115− ,('\298','I')
116− ,('\299','i')
117− ,('\300','I')
118− ,('\301','i')
119− ,('\302','I')
120− ,('\303','i')
121− ,('\304','I')
122− ,('\305','i')
123− ,('\308','J')
124− ,('\309','j')
125− ,('\310','K')
126− ,('\311','k')
127− ,('\313','L')
128− ,('\314','l')
129− ,('\315','L')
130− ,('\316','l')
131− ,('\317','L')
132− ,('\318','l')
133− ,('\323','N')
134− ,('\324','n')
135− ,('\325','N')
136− ,('\326','n')
137− ,('\327','N')
138− ,('\328','n')
139− ,('\332','O')
140− ,('\333','o')
141− ,('\334','O')
142− ,('\335','o')
143− ,('\336','O')
144− ,('\337','o')
145− ,('\340','R')
146− ,('\341','r')
147− ,('\342','R')
148− ,('\343','r')
149− ,('\344','R')
150− ,('\345','r')
151− ,('\346','S')
152− ,('\347','s')
153− ,('\348','S')
154− ,('\349','s')
155− ,('\350','S')
156− ,('\351','s')
157− ,('\352','S')
158− ,('\353','s')
159− ,('\354','T')
160− ,('\355','t')
161− ,('\356','T')
162− ,('\357','t')
163− ,('\360','U')
164− ,('\361','u')
165− ,('\362','U')
166− ,('\363','u')
167− ,('\364','U')
168− ,('\365','u')
169− ,('\366','U')
170− ,('\367','u')
171− ,('\368','U')
172− ,('\369','u')
173− ,('\370','U')
174− ,('\371','u')
175− ,('\372','W')
176− ,('\373','w')
177− ,('\374','Y')
178− ,('\375','y')
179− ,('\376','Y')
180− ,('\377','Z')
181− ,('\378','z')
182− ,('\379','Z')
183− ,('\380','z')
184− ,('\381','Z')
185− ,('\382','z')
186− ,('\416','O')
187− ,('\417','o')
188− ,('\431','U')
189− ,('\432','u')
190− ,('\461','A')
191− ,('\462','a')
192− ,('\463','I')
193− ,('\464','i')
194− ,('\465','O')
195− ,('\466','o')
196− ,('\467','U')
197− ,('\468','u')
198− ,('\486','G')
199− ,('\487','g')
200− ,('\488','K')
201− ,('\489','k')
202− ,('\490','O')
203− ,('\491','o')
204− ,('\496','j')
205− ,('\500','G')
206− ,('\501','g')
207− ,('\504','N')
208− ,('\505','n')
209− ,('\512','A')
210− ,('\513','a')
211− ,('\514','A')
212− ,('\515','a')
213− ,('\516','E')
214− ,('\517','e')
215− ,('\518','E')
216− ,('\519','e')
217− ,('\520','I')
218− ,('\521','i')
219− ,('\522','I')
220− ,('\523','i')
221− ,('\524','O')
222− ,('\525','o')
223− ,('\526','O')
224− ,('\527','o')
225− ,('\528','R')
226− ,('\529','r')
227− ,('\530','R')
228− ,('\531','r')
229− ,('\532','U')
230− ,('\533','u')
231− ,('\534','U')
232− ,('\535','u')
233− ,('\536','S')
234− ,('\537','s')
235− ,('\538','T')
236− ,('\539','t')
237− ,('\542','H')
238− ,('\543','h')
239− ,('\550','A')
240− ,('\551','a')
241− ,('\552','E')
242− ,('\553','e')
243− ,('\558','O')
244− ,('\559','o')
245− ,('\562','Y')
246− ,('\563','y')
247− ,('\894',';')
248− ,('\7680','A')
249− ,('\7681','a')
250− ,('\7682','B')
251− ,('\7683','b')
252− ,('\7684','B')
253− ,('\7685','b')
254− ,('\7686','B')
255− ,('\7687','b')
256− ,('\7690','D')
257− ,('\7691','d')
258− ,('\7692','D')
259− ,('\7693','d')
260− ,('\7694','D')
261− ,('\7695','d')
262− ,('\7696','D')
263− ,('\7697','d')
264− ,('\7698','D')
265− ,('\7699','d')
266− ,('\7704','E')
267− ,('\7705','e')
268− ,('\7706','E')
269− ,('\7707','e')
270− ,('\7710','F')
271− ,('\7711','f')
272− ,('\7712','G')
273− ,('\7713','g')
274− ,('\7714','H')
275− ,('\7715','h')
276− ,('\7716','H')
277− ,('\7717','h')
278− ,('\7718','H')
279− ,('\7719','h')
280− ,('\7720','H')
281− ,('\7721','h')
282− ,('\7722','H')
283− ,('\7723','h')
284− ,('\7724','I')
285− ,('\7725','i')
286− ,('\7728','K')
287− ,('\7729','k')
288− ,('\7730','K')
289− ,('\7731','k')
290− ,('\7732','K')
291− ,('\7733','k')
292− ,('\7734','L')
293− ,('\7735','l')
294− ,('\7738','L')
295− ,('\7739','l')
296− ,('\7740','L')
297− ,('\7741','l')
298− ,('\7742','M')
299− ,('\7743','m')
300− ,('\7744','M')
301− ,('\7745','m')
302− ,('\7746','M')
303− ,('\7747','m')
304− ,('\7748','N')
305− ,('\7749','n')
306− ,('\7750','N')
307− ,('\7751','n')
308− ,('\7752','N')
309− ,('\7753','n')
310− ,('\7754','N')
311− ,('\7755','n')
312− ,('\7764','P')
313− ,('\7765','p')
314− ,('\7766','P')
315− ,('\7767','p')
316− ,('\7768','R')
317− ,('\7769','r')
318− ,('\7770','R')
319− ,('\7771','r')
320− ,('\7774','R')
321− ,('\7775','r')
322− ,('\7776','S')
323− ,('\7777','s')
324− ,('\7778','S')
325− ,('\7779','s')
326− ,('\7786','T')
327− ,('\7787','t')
328− ,('\7788','T')
329− ,('\7789','t')
330− ,('\7790','T')
331− ,('\7791','t')
332− ,('\7792','T')
333− ,('\7793','t')
334− ,('\7794','U')
335− ,('\7795','u')
336− ,('\7796','U')
337− ,('\7797','u')
338− ,('\7798','U')
339− ,('\7799','u')
340− ,('\7804','V')
341− ,('\7805','v')
342− ,('\7806','V')
343− ,('\7807','v')
344− ,('\7808','W')
345− ,('\7809','w')
346− ,('\7810','W')
347− ,('\7811','w')
348− ,('\7812','W')
349− ,('\7813','w')
350− ,('\7814','W')
351− ,('\7815','w')
352− ,('\7816','W')
353− ,('\7817','w')
354− ,('\7818','X')
355− ,('\7819','x')
356− ,('\7820','X')
357− ,('\7821','x')
358− ,('\7822','Y')
359− ,('\7823','y')
360− ,('\7824','Z')
361− ,('\7825','z')
362− ,('\7826','Z')
363− ,('\7827','z')
364− ,('\7828','Z')
365− ,('\7829','z')
366− ,('\7830','h')
367− ,('\7831','t')
368− ,('\7832','w')
369− ,('\7833','y')
370− ,('\7840','A')
371− ,('\7841','a')
372− ,('\7842','A')
373− ,('\7843','a')
374− ,('\7864','E')
375− ,('\7865','e')
376− ,('\7866','E')
377− ,('\7867','e')
378− ,('\7868','E')
379− ,('\7869','e')
380− ,('\7880','I')
381− ,('\7881','i')
382− ,('\7882','I')
383− ,('\7883','i')
384− ,('\7884','O')
385− ,('\7885','o')
386− ,('\7886','O')
387− ,('\7887','o')
388− ,('\7908','U')
389− ,('\7909','u')
390− ,('\7910','U')
391− ,('\7911','u')
392− ,('\7922','Y')
393− ,('\7923','y')
394− ,('\7924','Y')
395− ,('\7925','y')
396− ,('\7926','Y')
397− ,('\7927','y')
398− ,('\7928','Y')
399− ,('\7929','y')
400− ,('\8175','`')
401− ,('\8490','K')
402− ,('\8800','=')
403− ,('\8814','<')
404− ,('\8815','>')
405− ]
23+toAsciiChar :: Char -> Maybe Char
24+toAsciiChar c = case T.unpack (TN.normalize TN.NFD (T.singleton c)) of
25+ (x:xs) | isAscii x
26+ , all isMark xs
27+ -> Just x
28+ _ -> Nothing
src/Text/Pandoc/BCP47.hsdeleted−112
@@ -1,112 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{- |
3− Module : Text.Pandoc.BCP47
4− Copyright : Copyright (C) 2017–2020 John MacFarlane
5− License : GNU GPL, version 2 or above
6−
7− Maintainer : John MacFarlane <jgm@berkeley.edu>
8− Stability : alpha
9− Portability : portable
10−
11−Functions for parsing and rendering BCP47 language identifiers.
12−-}
13−module Text.Pandoc.BCP47 (
14− getLang
15− , parseBCP47
16− , Lang(..)
17− , renderLang
18− )
19−where
20−import Control.Monad (guard)
21−import Data.Char (isAlphaNum, isAscii, isLetter, isLower, isUpper)
22−import Text.Pandoc.Definition
23−import Text.Pandoc.Options
24−import Text.DocTemplates (FromContext(..))
25−import qualified Data.Text as T
26−import qualified Text.Parsec as P
27−
28−-- | Represents BCP 47 language/country code.
29−data Lang = Lang{ langLanguage :: T.Text
30− , langScript :: T.Text
31− , langRegion :: T.Text
32− , langVariants :: [T.Text] }
33− deriving (Eq, Ord, Show)
34−
35−-- | Render a Lang as BCP 47.
36−renderLang :: Lang -> T.Text
37−renderLang lang = T.intercalate "-" (langLanguage lang : filter (not . T.null)
38− ([langScript lang, langRegion lang] ++ langVariants lang))
39−
40−-- | Get the contents of the `lang` metadata field or variable.
41−getLang :: WriterOptions -> Meta -> Maybe T.Text
42−getLang opts meta =
43− case lookupContext "lang" (writerVariables opts) of
44− Just s -> Just s
45− _ ->
46− case lookupMeta "lang" meta of
47− Just (MetaBlocks [Para [Str s]]) -> Just s
48− Just (MetaBlocks [Plain [Str s]]) -> Just s
49− Just (MetaInlines [Str s]) -> Just s
50− Just (MetaString s) -> Just s
51− _ -> Nothing
52−
53−-- | Parse a BCP 47 string as a Lang. Currently we parse
54−-- extensions and private-use fields as "variants," even
55−-- though officially they aren't.
56−parseBCP47 :: T.Text -> Either T.Text Lang
57−parseBCP47 lang =
58− case P.parse bcp47 "lang" lang of
59− Right r -> Right r
60− Left e -> Left $ T.pack $ show e
61− where bcp47 = do
62− language <- pLanguage
63− script <- P.option "" pScript
64− region <- P.option "" pRegion
65− variants <- P.many (pVariant P.<|> pExtension P.<|> pPrivateUse)
66− P.eof
67− return Lang{ langLanguage = language
68− , langScript = script
69− , langRegion = region
70− , langVariants = variants }
71− asciiLetter = P.satisfy (\c -> isAscii c && isLetter c)
72− pLanguage = do
73− cs <- P.many1 asciiLetter
74− let lcs = length cs
75− guard $ lcs == 2 || lcs == 3
76− return $ T.toLower $ T.pack cs
77− pScript = P.try $ do
78− P.char '-'
79− x <- P.satisfy (\c -> isAscii c && isLetter c && isUpper c)
80− xs <- P.count 3
81− (P.satisfy (\c -> isAscii c && isLetter c && isLower c))
82− return $ T.toLower $ T.pack (x:xs)
83− pRegion = P.try $ do
84− P.char '-'
85− cs <- P.many1 asciiLetter
86− let lcs = length cs
87− guard $ lcs == 2 || lcs == 3
88− return $ T.toUpper $ T.pack cs
89− pVariant = P.try $ do
90− P.char '-'
91− ds <- P.option "" (P.count 1 P.digit)
92− cs <- P.many1 asciiLetter
93− let var = ds ++ cs
94− lv = length var
95− guard $ if null ds
96− then lv >= 5 && lv <= 8
97− else lv == 4
98− return $ T.toLower $ T.pack var
99− pExtension = P.try $ do
100− P.char '-'
101− cs <- P.many1 $ P.satisfy (\c -> isAscii c && isAlphaNum c)
102− let lcs = length cs
103− guard $ lcs >= 2 && lcs <= 8
104− return $ T.toLower $ T.pack cs
105− pPrivateUse = P.try $ do
106− P.char '-'
107− P.char 'x'
108− P.char '-'
109− cs <- P.many1 $ P.satisfy (\c -> isAscii c && isAlphaNum c)
110− guard $ not (null cs) && length cs <= 8
111− let var = "x-" ++ cs
112− return $ T.toLower $ T.pack var
src/Text/Pandoc/CSS.hs+24−25
@@ -1,6 +1,6 @@
11{- |
22Module : Text.Pandoc.CSS
3−Copyright : © 2006-2020 John MacFarlane <jgm@berkeley.edu>,
3+Copyright : © 2006-2021 John MacFarlane <jgm@berkeley.edu>,
44 2015-2016 Mauro Bieg,
55 2015 Ophir Lifshitz <hangfromthefloor@gmail.com>
66License : GNU GPL, version 2 or above
@@ -11,47 +11,46 @@ Portability : portable
1111
1212Tools for working with CSS.
1313-}
14−module Text.Pandoc.CSS ( foldOrElse
15− , pickStyleAttrProps
16− , pickStylesToKVs
17− )
14+module Text.Pandoc.CSS
15+ ( cssAttributes
16+ , pickStyleAttrProps
17+ , pickStylesToKVs
18+ )
1819where
1920
20−import qualified Data.Text as T
21+import Data.Maybe (mapMaybe, listToMaybe)
22+import Data.Text (Text, pack)
2123import Text.Pandoc.Shared (trim)
2224import Text.Parsec
2325import Text.Parsec.Text
2426
25−ruleParser :: Parser (T.Text, T.Text)
27+ruleParser :: Parser (Text, Text)
2628ruleParser = do
2729 p <- many1 (noneOf ":") <* char ':'
2830 v <- many1 (noneOf ":;") <* optional (char ';') <* spaces
29− return (trim $ T.pack p, trim $ T.pack v)
31+ return (trim $ pack p, trim $ pack v)
3032
31−styleAttrParser :: Parser [(T.Text, T.Text)]
33+styleAttrParser :: Parser [(Text, Text)]
3234styleAttrParser = many1 ruleParser
3335
34−orElse :: Eq a => a -> a -> a -> a
35−orElse v x y = if v == x then y else x
36−
37−foldOrElse :: Eq a => a -> [a] -> a
38−foldOrElse v xs = foldr (orElse v) v xs
39−
40−eitherToMaybe :: Either a b -> Maybe b
41−eitherToMaybe (Right x) = Just x
42−eitherToMaybe _ = Nothing
36+-- | Parses a style string, returning the CSS attributes.
37+-- Returns an empty list on failure.
38+cssAttributes :: Text -> [(Text, Text)]
39+cssAttributes styleString =
40+ -- Use Data.Either.fromRight once GHC 8.0 is no longer supported
41+ case parse styleAttrParser "" styleString of
42+ Left _ -> []
43+ Right x -> x
4344
4445-- | takes a list of keys/properties and a CSS string and
4546-- returns the corresponding key-value-pairs.
46−pickStylesToKVs :: [T.Text] -> T.Text -> [(T.Text, T.Text)]
47+pickStylesToKVs :: [Text] -> Text -> [(Text, Text)]
4748pickStylesToKVs props styleAttr =
48− case parse styleAttrParser "" styleAttr of
49− Left _ -> []
50− Right styles -> filter (\s -> fst s `elem` props) styles
49+ filter (\s -> fst s `elem` props) $ cssAttributes styleAttr
5150
5251-- | takes a list of key/property synonyms and a CSS string and maybe
5352-- returns the value of the first match (in order of the supplied list)
54−pickStyleAttrProps :: [T.Text] -> T.Text -> Maybe T.Text
53+pickStyleAttrProps :: [Text] -> Text -> Maybe Text
5554pickStyleAttrProps lookupProps styleAttr = do
56− styles <- eitherToMaybe $ parse styleAttrParser "" styleAttr
57− foldOrElse Nothing $ map (`lookup` styles) lookupProps
55+ styles <- either (const Nothing) Just $ parse styleAttrParser "" styleAttr
56+ listToMaybe $ mapMaybe (`lookup` styles) lookupProps
src/Text/Pandoc/CSV.hs+2−3
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.CSV
3− Copyright : Copyright (C) 2017–2020 John MacFarlane <jgm@berkeley.edu>
3+ Copyright : Copyright (C) 2017-2021 John MacFarlane <jgm@berkeley.edu>
44 License : GNU GPL, version 2 or above
55 Maintainer : John MacFarlane <jgm@berkeley.edu>
66 Stability : alpha
@@ -68,8 +68,7 @@ escaped opts = try $
6868
6969pCSVUnquotedCell :: CSVOptions -> Parser Text
7070pCSVUnquotedCell opts = T.pack <$>
71− many (satisfy (\c -> c /= csvDelim opts && c /= '\r' && c /= '\n'
72− && c /= csvQuote opts))
71+ many (satisfy (\c -> c /= csvDelim opts && c /= '\r' && c /= '\n'))
7372
7473pCSVDelim :: CSVOptions -> Parser ()
7574pCSVDelim opts = do
src/Text/Pandoc/Citeproc.hs+258−134
@@ -1,56 +1,121 @@
11{-# LANGUAGE ScopedTypeVariables #-}
22{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE ViewPatterns #-}
43{-# LANGUAGE StrictData #-}
54{-# LANGUAGE MultiParamTypeClasses #-}
65{-# LANGUAGE FlexibleInstances #-}
76{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE DeriveFunctor #-}
9−{-# LANGUAGE DeriveFoldable #-}
10−{-# LANGUAGE DeriveTraversable #-}
117module Text.Pandoc.Citeproc
12− ( processCitations )
8+ ( processCitations,
9+ getReferences,
10+ getStyle
11+ )
1312where
1413
15−import Citeproc as Citeproc
14+import Citeproc
1615import Citeproc.Pandoc ()
1716import Text.Pandoc.Citeproc.Locator (parseLocator)
1817import Text.Pandoc.Citeproc.CslJson (cslJsonToReferences)
1918import Text.Pandoc.Citeproc.BibTeX (readBibtexString, Variant(..))
2019import Text.Pandoc.Citeproc.MetaValue (metaValueToReference, metaValueToText)
2120import Text.Pandoc.Readers.Markdown (yamlToRefs)
22−import Text.Pandoc.Class (setResourcePath, getResourcePath, getUserDataDir)
23−import Data.ByteString (ByteString)
24−import qualified Data.ByteString.Lazy as L
21+import Text.Pandoc.Builder (Inlines, Many(..), deleteMeta, setMeta)
22+import qualified Text.Pandoc.Builder as B
2523import Text.Pandoc.Definition as Pandoc
26−import Text.Pandoc.Walk
27−import Text.Pandoc.Builder as B
28−import Text.Pandoc (PandocMonad(..), PandocError(..),
29− readDataFile, ReaderOptions(..), pandocExtensions,
30− report, LogMessage(..), fetchItem)
31−import Text.Pandoc.Shared (stringify, ordNub, blocksToInlines)
24+import Text.Pandoc.Class (PandocMonad(..), getResourcePath, getUserDataDir,
25+ fetchItem, readDataFile, report, setResourcePath)
26+import Text.Pandoc.Error (PandocError(..))
27+import Text.Pandoc.Extensions (pandocExtensions)
28+import Text.Pandoc.Logging (LogMessage(..))
29+import Text.Pandoc.Options (ReaderOptions(..))
30+import Text.Pandoc.Shared (stringify, ordNub, tshow)
3231import qualified Text.Pandoc.UTF8 as UTF8
32+import Text.Pandoc.Walk (query, walk, walkM)
33+import Control.Applicative ((<|>))
34+import Control.Monad.Except (catchError, throwError)
35+import Control.Monad.State (State, evalState, get, put, runState)
3336import Data.Aeson (eitherDecode)
34−import Data.Default
35−import Data.Ord ()
37+import Data.ByteString (ByteString)
38+import qualified Data.ByteString.Lazy as L
39+import Data.Char (isPunctuation, isUpper)
40+import Data.Default (Default(def))
41+import qualified Data.Foldable as Foldable
3642import qualified Data.Map as M
43+import Data.Maybe (mapMaybe, fromMaybe)
44+import Data.Ord ()
45+import qualified Data.Sequence as Seq
3746import qualified Data.Set as Set
38−import Data.Char (isPunctuation)
3947import Data.Text (Text)
4048import qualified Data.Text as T
41−import Control.Monad.State
42−import qualified Data.Sequence as Seq
43−import qualified Data.Foldable as Foldable
44−import System.FilePath
45−import Control.Applicative
46−import Control.Monad.Except
47−import Data.Maybe (mapMaybe, fromMaybe)
49+import System.FilePath (takeExtension)
4850import Safe (lastMay, initSafe)
49−-- import Debug.Trace as Trace (trace, traceShowId)
5051
5152
52−processCitations :: PandocMonad m => Pandoc -> m Pandoc
53+processCitations :: PandocMonad m => Pandoc -> m Pandoc
5354processCitations (Pandoc meta bs) = do
55+ style <- getStyle (Pandoc meta bs)
56+
57+ mblang <- getLang meta
58+ let locale = Citeproc.mergeLocales mblang style
59+
60+ refs <- getReferences (Just locale) (Pandoc meta bs)
61+
62+ let otherIdsMap = foldr (\ref m ->
63+ case T.words . extractText <$>
64+ M.lookup "other-ids"
65+ (referenceVariables ref) of
66+ Nothing -> m
67+ Just ids -> foldr
68+ (\id' ->
69+ M.insert id' (referenceId ref)) m ids)
70+ M.empty refs
71+ let meta' = deleteMeta "nocite" meta
72+ let citations = getCitations locale otherIdsMap $ Pandoc meta' bs
73+
74+
75+ let linkCites = maybe False truish $ lookupMeta "link-citations" meta
76+ let opts = defaultCiteprocOptions{ linkCitations = linkCites }
77+ let result = Citeproc.citeproc opts style mblang refs citations
78+ mapM_ (report . CiteprocWarning) (resultWarnings result)
79+ let sopts = styleOptions style
80+ let classes = "references" : -- TODO remove this or keep for compatibility?
81+ "csl-bib-body" :
82+ ["hanging-indent" | styleHangingIndent sopts]
83+ let refkvs = (case styleEntrySpacing sopts of
84+ Just es | es > 0 -> (("entry-spacing",T.pack $ show es):)
85+ _ -> id) .
86+ (case styleLineSpacing sopts of
87+ Just ls | ls > 1 -> (("line-spacing",T.pack $ show ls):)
88+ _ -> id) $ []
89+ let bibs = mconcat $ map (\(ident, out) ->
90+ B.divWith ("ref-" <> ident,["csl-entry"],[]) . B.para .
91+ walk (convertQuotes locale) .
92+ insertSpace $ out)
93+ (resultBibliography result)
94+ let moveNotes = styleIsNoteStyle sopts &&
95+ maybe True truish (lookupMeta "notes-after-punctuation" meta)
96+ let cits = map (walk (convertQuotes locale)) $
97+ resultCitations result
98+
99+ let metanocites = lookupMeta "nocite" meta
100+ let Pandoc meta'' bs' =
101+ maybe id (setMeta "nocite") metanocites .
102+ walk (mvPunct moveNotes locale) .
103+ (if styleIsNoteStyle sopts
104+ then walk addNote . walk deNote
105+ else id) .
106+ evalState (walkM insertResolvedCitations $ Pandoc meta' bs)
107+ $ cits
108+ return $ Pandoc meta''
109+ $ insertRefs refkvs classes meta''
110+ (walk fixLinks $ B.toList bibs) bs'
111+
112+-- | Retrieve the CSL style specified by the csl or citation-style
113+-- metadata field in a pandoc document, or the default CSL style
114+-- if none is specified. Retrieve the parent style
115+-- if the style is a dependent style. Add abbreviations defined
116+-- in an abbreviation file if one has been specified.
117+getStyle :: PandocMonad m => Pandoc -> m (Style Inlines)
118+getStyle (Pandoc meta _) = do
54119 let cslfile = (lookupMeta "csl" meta <|> lookupMeta "citation-style" meta)
55120 >>= metaValueToText
56121
@@ -60,7 +125,7 @@ processCitations (Pandoc meta bs) = do
60125 setResourcePath $ oldRp ++ maybe []
61126 (\u -> [u <> "/csl",
62127 u <> "/csl/dependent"]) mbUdd
63− let fp' = if T.any (=='.') fp
128+ let fp' = if T.any (=='.') fp || "data:" `T.isPrefixOf` fp
64129 then fp
65130 else fp <> defaultExtension
66131 (result, _) <- fetchItem fp'
@@ -90,87 +155,61 @@ processCitations (Pandoc meta bs) = do
90155 UTF8.toText <$>
91156 catchError (getFile ".csl" basename) (\_ -> fst <$> fetchItem url)
92157
93− -- TODO check .csl directory if not found
94158 styleRes <- Citeproc.parseStyle getParentStyle cslContents
95− style <-
96− case styleRes of
97− Left err -> throwError $ PandocAppError $ prettyCiteprocError err
98− Right style -> return style{ styleAbbreviations = mbAbbrevs }
99− let mblang = parseLang <$>
100− ((lookupMeta "lang" meta <|> lookupMeta "locale" meta) >>= metaValueToText)
101− let locale = Citeproc.mergeLocales mblang style
159+ case styleRes of
160+ Left err -> throwError $ PandocAppError $ prettyCiteprocError err
161+ Right style -> return style{ styleAbbreviations = mbAbbrevs }
162+
163+
164+-- Retrieve citeproc lang based on metadata.
165+getLang :: PandocMonad m => Meta -> m (Maybe Lang)
166+getLang meta = maybe (return Nothing) bcp47LangToIETF
167+ ((lookupMeta "lang" meta <|> lookupMeta "locale" meta) >>=
168+ metaValueToText)
169+
170+-- | Get references defined inline in the metadata and via an external
171+-- bibliography. Only references that are actually cited in the document
172+-- (either with a genuine citation or with `nocite`) are returned.
173+-- URL variables are converted to links.
174+getReferences :: PandocMonad m
175+ => Maybe Locale -> Pandoc -> m [Reference Inlines]
176+getReferences mblocale (Pandoc meta bs) = do
177+ locale <- case mblocale of
178+ Just l -> return l
179+ Nothing -> do
180+ mblang <- getLang meta
181+ case mblang of
182+ Just lang -> return $ either mempty id $ getLocale lang
183+ Nothing -> return mempty
184+
102185 let getCiteId (Cite cs _) = Set.fromList $ map B.citationId cs
103186 getCiteId _ = mempty
104187 let metanocites = lookupMeta "nocite" meta
105− let meta' = deleteMeta "nocite" meta
106188 let nocites = maybe mempty (query getCiteId) metanocites
107189 let citeIds = query getCiteId (Pandoc meta bs)
108190 let idpred = if "*" `Set.member` nocites
109191 then const True
110− else (\c -> c `Set.member` citeIds ||
111− c `Set.member` nocites)
112− refs <- map (linkifyVariables . legacyDateRanges) <$>
113− case lookupMeta "references" meta of
114− Just (MetaList rs) -> return $ mapMaybe metaValueToReference rs
115− _ ->
116− case lookupMeta "bibliography" meta of
117− Just (MetaList xs) ->
118− mconcat <$>
119− mapM (getRefsFromBib locale idpred)
120− (mapMaybe metaValueToText xs)
121− Just x ->
122− case metaValueToText x of
123− Just fp -> getRefsFromBib locale idpred fp
124− Nothing -> return []
125− Nothing -> return []
126− let otherIdsMap = foldr (\ref m ->
127− case T.words . extractText <$>
128− M.lookup "other-ids"
129− (referenceVariables ref) of
130− Nothing -> m
131− Just ids -> foldr
132− (\id' ->
133− M.insert id' (referenceId ref)) m ids)
134− M.empty refs
135− -- TODO: issue warning if no refs defined
136− let citations = getCitations locale otherIdsMap $ Pandoc meta' bs
137− let linkCites = maybe False truish $ lookupMeta "link-citations" meta
138− let opts = defaultCiteprocOptions{ linkCitations = linkCites }
139− let result = Citeproc.citeproc opts style (localeLanguage locale)
140− refs citations
141− mapM_ (report . CiteprocWarning) (resultWarnings result)
142− let sopts = styleOptions style
143− let classes = "references" : -- TODO remove this or keep for compatibility?
144− "csl-bib-body" :
145− ["hanging-indent" | styleHangingIndent sopts]
146− let refkvs = (case styleEntrySpacing sopts of
147− Just es | es > 0 -> (("entry-spacing",T.pack $ show es):)
148− _ -> id) .
149− (case styleLineSpacing sopts of
150− Just ls | ls > 1 -> (("line-spacing",T.pack $ show ls):)
151− _ -> id) $ []
152− let bibs = mconcat $ map (\(ident, out) ->
153− B.divWith ("ref-" <> ident,["csl-entry"],[]) . B.para .
154− walk (convertQuotes locale) . insertSpace $ out)
155− (resultBibliography result)
156− let moveNotes = maybe True truish $
157− lookupMeta "notes-after-punctuation" meta
158− let cits = map (walk fixLinks . walk (convertQuotes locale)) $
159− resultCitations result
192+ else (`Set.member` citeIds)
193+ let inlineRefs = case lookupMeta "references" meta of
194+ Just (MetaList rs) ->
195+ filter (idpred . unItemId . referenceId)
196+ $ mapMaybe metaValueToReference rs
197+ _ -> []
198+ externalRefs <- case lookupMeta "bibliography" meta of
199+ Just (MetaList xs) ->
200+ mconcat <$>
201+ mapM (getRefsFromBib locale idpred)
202+ (mapMaybe metaValueToText xs)
203+ Just x ->
204+ case metaValueToText x of
205+ Just fp -> getRefsFromBib locale idpred fp
206+ Nothing -> return []
207+ Nothing -> return []
208+ return $ map (linkifyVariables . legacyDateRanges)
209+ (externalRefs ++ inlineRefs)
210+ -- note that inlineRefs can override externalRefs
160211
161− let fixQuotes = case localePunctuationInQuote locale of
162− Just True ->
163− B.toList . movePunctuationInsideQuotes . B.fromList
164− _ -> id
165212
166− let Pandoc meta'' bs' =
167− maybe id (setMeta "nocite") metanocites $
168− walk (fixQuotes . mvPunct moveNotes locale) $ walk deNote $
169− evalState (walkM insertResolvedCitations $ Pandoc meta' bs)
170− $ cits
171− return $ Pandoc meta''
172− $ insertRefs refkvs classes meta''
173− (walk fixLinks $ B.toList bibs) bs'
174213
175214-- If we have a span.csl-left-margin followed by span.csl-right-inline,
176215-- we insert a space. This ensures that they will be separated by a space,
@@ -191,37 +230,38 @@ insertSpace ils =
191230
192231getRefsFromBib :: PandocMonad m
193232 => Locale -> (Text -> Bool) -> Text -> m [Reference Inlines]
194−getRefsFromBib locale idpred t = do
195− let fp = T.unpack t
196− raw <- readFileStrict fp
197− case formatFromExtension fp of
233+getRefsFromBib locale idpred fp = do
234+ (raw, _) <- fetchItem fp
235+ case formatFromExtension (T.unpack fp) of
198236 Just f -> getRefs locale f idpred (Just fp) raw
199237 Nothing -> throwError $ PandocAppError $
200− "Could not deterine bibliography format for " <> t
238+ "Could not determine bibliography format for " <> fp
201239
202240getRefs :: PandocMonad m
203241 => Locale
204242 -> BibFormat
205243 -> (Text -> Bool)
206− -> Maybe FilePath
244+ -> Maybe Text
207245 -> ByteString
208246 -> m [Reference Inlines]
209−getRefs locale format idpred mbfp raw =
247+getRefs locale format idpred mbfp raw = do
248+ let err' = throwError .
249+ PandocBibliographyError (fromMaybe mempty mbfp)
210250 case format of
211251 Format_bibtex ->
212− either (throwError . PandocAppError . T.pack . show) return .
252+ either (err' . tshow) return .
213253 readBibtexString Bibtex locale idpred . UTF8.toText $ raw
214254 Format_biblatex ->
215− either (throwError . PandocAppError . T.pack . show) return .
255+ either (err' . tshow) return .
216256 readBibtexString Biblatex locale idpred . UTF8.toText $ raw
217257 Format_json ->
218− either (throwError . PandocAppError . T.pack)
258+ either (err' . T.pack)
219259 (return . filter (idpred . unItemId . referenceId)) .
220260 cslJsonToReferences $ raw
221261 Format_yaml -> do
222262 rs <- yamlToRefs idpred
223263 def{ readerExtensions = pandocExtensions }
224− mbfp
264+ (T.unpack <$> mbfp)
225265 (L.fromStrict raw)
226266 return $ mapMaybe metaValueToReference rs
227267
@@ -250,7 +290,7 @@ insertResolvedCitations (Cite cs ils) = do
250290 [] -> return (Cite cs ils)
251291 (x:xs) -> do
252292 put xs
253− return $ Cite cs (B.toList x)
293+ return $ Cite cs (walk fixLinks $ B.toList x)
254294insertResolvedCitations x = return x
255295
256296getCitations :: Locale
@@ -332,7 +372,6 @@ formatFromExtension fp = case dropWhile (== '.') $ takeExtension fp of
332372
333373
334374isNote :: Inline -> Bool
335−isNote (Note _) = True
336375isNote (Cite _ [Note _]) = True
337376 -- the following allows citation styles that are "in-text" but use superscript
338377 -- references to be treated as if they are "notes" for the purposes of moving
@@ -345,6 +384,12 @@ isSpacy Space = True
345384isSpacy SoftBreak = True
346385isSpacy _ = False
347386
387+movePunctInsideQuotes :: Locale -> [Inline] -> [Inline]
388+movePunctInsideQuotes locale
389+ | localePunctuationInQuote locale == Just True
390+ = B.toList . movePunctuationInsideQuotes . B.fromList
391+ | otherwise
392+ = id
348393
349394mvPunct :: Bool -> Locale -> [Inline] -> [Inline]
350395mvPunct moveNotes locale (x : xs)
@@ -357,7 +402,8 @@ mvPunct moveNotes locale (q : s : x : ys)
357402 in if moveNotes
358403 then if T.null spunct
359404 then q : x : mvPunct moveNotes locale ys
360− else q : Str spunct : x : mvPunct moveNotes locale
405+ else movePunctInsideQuotes locale
406+ [q , Str spunct , x] ++ mvPunct moveNotes locale
361407 (B.toList
362408 (dropTextWhile isPunctuation (B.fromList ys)))
363409 else q : x : mvPunct moveNotes locale ys
@@ -369,9 +415,10 @@ mvPunct moveNotes locale (Cite cs ils : ys)
369415 , moveNotes
370416 = let s = stringify ys
371417 spunct = T.takeWhile isPunctuation s
372− in Cite cs (init ils
373− ++ [Str spunct | not (endWithPunct False (init ils))]
374− ++ [last ils]) :
418+ in Cite cs (movePunctInsideQuotes locale $
419+ init ils
420+ ++ [Str spunct | not (endWithPunct False (init ils))]
421+ ++ [last ils]) :
375422 mvPunct moveNotes locale
376423 (B.toList (dropTextWhile isPunctuation (B.fromList ys)))
377424mvPunct moveNotes locale (s : x : ys) | isSpacy s, isNote x =
@@ -387,7 +434,7 @@ mvPunct _ _ [] = []
387434-- move https://doi.org etc. prefix inside link text (#6723):
388435fixLinks :: [Inline] -> [Inline]
389436fixLinks (Str t : Link attr [Str u1] (u2,tit) : xs)
390− | t <> u1 == u2
437+ | u2 == t <> u1
391438 = Link attr [Str (t <> u1)] (u2,tit) : fixLinks xs
392439fixLinks (x:xs) = x : fixLinks xs
393440fixLinks [] = []
@@ -457,7 +504,8 @@ insertRefs refkvs refclasses meta refs bs =
457504 put True
458505 -- refHeader isn't used if you have an explicit references div
459506 let cs' = ordNub $ cs ++ refclasses
460− return $ Div ("refs",cs',kvs) (xs ++ refs)
507+ let kvs' = ordNub $ kvs ++ refkvs
508+ return $ Div ("refs",cs',kvs') (xs ++ refs)
461509 go x = return x
462510
463511refTitle :: Meta -> Maybe [Inline]
@@ -500,13 +548,15 @@ linkifyVariables ref =
500548 fixShortDOI x = let x' = extractText x
501549 in if "10/" `T.isPrefixOf` x'
502550 then TextVal $ T.drop 3 x'
503− -- see http://shortdoi.org
551+ -- see https://shortdoi.org
504552 else TextVal x'
505553 tolink pref x = let x' = extractText x
506554 x'' = if "://" `T.isInfixOf` x'
507555 then x'
508556 else pref <> x'
509− in FancyVal (B.link x'' "" (B.str x'))
557+ in if T.null x'
558+ then x
559+ else FancyVal (B.link x'' "" (B.str x'))
510560
511561extractText :: Val Inlines -> Text
512562extractText (TextVal x) = x
@@ -514,24 +564,98 @@ extractText (FancyVal x) = toText x
514564extractText (NumVal n) = T.pack (show n)
515565extractText _ = mempty
516566
567+-- Here we take the Spans with class csl-note that are left
568+-- after deNote has removed nested ones, and convert them
569+-- into real notes.
570+addNote :: Inline -> Inline
571+addNote (Span ("",["csl-note"],[]) ils) =
572+ Note [Para $
573+ B.toList . addTextCase Nothing CapitalizeFirst . B.fromList $ ils]
574+addNote x = x
575+
576+-- Here we handle citation notes that occur inside footnotes
577+-- or other citation notes, in a note style. We don't want
578+-- notes inside notes, so we convert these to parenthesized
579+-- or comma-separated citations.
517580deNote :: Inline -> Inline
518−deNote (Note bs) = Note $ walk go bs
581+deNote (Note bs) =
582+ case bs of
583+ [Para (cit@(Cite (c:_) _) : ils)]
584+ | citationMode c /= AuthorInText ->
585+ -- if citation is first in note, no need to parenthesize.
586+ Note [Para (walk removeNotes $ cit : walk addParens ils)]
587+ _ -> Note (walk removeNotes . walk addParens $ bs)
588+
519589 where
520− go (Note bs')
521− = Span ("",[],[]) (Space : Str "(" :
522− (removeFinalPeriod
523− (blocksToInlines bs')) ++ [Str ")"])
524− go x = x
590+ addParens [] = []
591+ addParens (Cite (c:cs) ils : zs)
592+ | citationMode c == AuthorInText
593+ = Cite (c:cs) (concatMap (noteAfterComma (needsPeriod zs)) ils) :
594+ addParens zs
595+ | otherwise
596+ = Cite (c:cs) (concatMap noteInParens ils) : addParens zs
597+ addParens (x:xs) = x : addParens xs
598+
599+ removeNotes (Span ("",["csl-note"],[]) ils) = Span ("",[],[]) ils
600+ removeNotes x = x
601+
602+ needsPeriod [] = True
603+ needsPeriod (Str t:_) = case T.uncons t of
604+ Nothing -> False
605+ Just (c,_) -> isUpper c
606+ needsPeriod (Space:zs) = needsPeriod zs
607+ needsPeriod _ = False
608+
609+ noteInParens (Span ("",["csl-note"],[]) ils)
610+ = Space : Str "(" :
611+ removeFinalPeriod ils ++ [Str ")"]
612+ noteInParens x = [x]
613+
614+ noteAfterComma needsPer (Span ("",["csl-note"],[]) ils)
615+ | not (null ils)
616+ = Str "," : Space :
617+ if needsPer
618+ then ils
619+ else removeFinalPeriod ils
620+ noteAfterComma _ x = [x]
621+
525622deNote x = x
526623
527−-- Note: we can't use dropTextWhileEnd because this would
528−-- remove the final period on abbreviations like Ibid.
529−-- But removing a final Str "." is safe.
624+-- Note: we can't use dropTextWhileEnd indiscriminately,
625+-- because this would remove the final period on abbreviations like Ibid.
626+-- But it turns out that when the note citation ends with Ibid.
627+-- (or Ed. etc.), the last inline will be Str "" as a result of
628+-- the punctuation-fixing mechanism that removes the double '.'.
530629removeFinalPeriod :: [Inline] -> [Inline]
531630removeFinalPeriod ils =
532631 case lastMay ils of
533− Just (Str ".") -> initSafe ils
534− _ -> ils
535−
536−
537−
632+ Just (Span attr ils')
633+ -> initSafe ils ++ [Span attr (removeFinalPeriod ils')]
634+ Just (Emph ils')
635+ -> initSafe ils ++ [Emph (removeFinalPeriod ils')]
636+ Just (Strong ils')
637+ -> initSafe ils ++ [Strong (removeFinalPeriod ils')]
638+ Just (SmallCaps ils')
639+ -> initSafe ils ++ [SmallCaps (removeFinalPeriod ils')]
640+ Just (Str t)
641+ | T.takeEnd 1 t == "." -> initSafe ils ++ [Str (T.dropEnd 1 t)]
642+ | isRightQuote (T.takeEnd 1 t)
643+ -> removeFinalPeriod
644+ (initSafe ils ++ [Str tInit | not (T.null tInit)]) ++ [Str tEnd]
645+ where
646+ tEnd = T.takeEnd 1 t
647+ tInit = T.dropEnd 1 t
648+ _ -> ils
649+ where
650+ isRightQuote "\8221" = True
651+ isRightQuote "\8217" = True
652+ isRightQuote "\187" = True
653+ isRightQuote _ = False
654+
655+bcp47LangToIETF :: PandocMonad m => Text -> m (Maybe Lang)
656+bcp47LangToIETF bcplang =
657+ case parseLang bcplang of
658+ Left _ -> do
659+ report $ InvalidLang bcplang
660+ return Nothing
661+ Right lang -> return $ Just lang
src/Text/Pandoc/Citeproc/BibTeX.hs+306−66
@@ -1,4 +1,5 @@
11{-# LANGUAGE ViewPatterns #-}
2+{-# LANGUAGE LambdaCase #-}
23{-# LANGUAGE OverloadedStrings #-}
34{-# LANGUAGE ScopedTypeVariables #-}
45{-# LANGUAGE FlexibleContexts #-}
@@ -17,6 +18,7 @@
1718module Text.Pandoc.Citeproc.BibTeX
1819 ( Variant(..)
1920 , readBibtexString
21+ , writeBibtexString
2022 )
2123 where
2224
@@ -24,10 +26,11 @@ import Text.Pandoc.Definition
2426import Text.Pandoc.Builder as B
2527import Text.Pandoc.Readers.LaTeX (readLaTeX)
2628import Text.Pandoc.Extensions (Extension(..), extensionsFromList)
27−import Text.Pandoc.Options (ReaderOptions(..))
28−import Text.Pandoc.Class (runPure)
29+import Text.Pandoc.Options (ReaderOptions(..), WriterOptions)
2930import Text.Pandoc.Error (PandocError)
3031import Text.Pandoc.Shared (stringify)
32+import Text.Pandoc.Writers.LaTeX (writeLaTeX)
33+import Text.Pandoc.Class (runPure)
3134import qualified Text.Pandoc.Walk as Walk
3235import Citeproc.Types
3336import Citeproc.Pandoc ()
@@ -46,34 +49,302 @@ import qualified Data.Sequence as Seq
4649import Data.Char (isAlphaNum, isDigit, isLetter,
4750 isUpper, toLower, toUpper,
4851 isLower, isPunctuation)
49−import Data.List (foldl', intercalate)
52+import Data.List (foldl', intercalate, intersperse)
5053import Safe (readMay)
54+import Text.Printf (printf)
55+import Text.DocLayout (literal, hsep, nest, hang, Doc(..),
56+ braces, ($$), cr)
5157
5258data Variant = Bibtex | Biblatex
5359 deriving (Show, Eq, Ord)
5460
5561-- | Parse BibTeX or BibLaTeX into a list of 'Reference's.
56−readBibtexString :: Variant -- ^ bibtex or biblatex
62+readBibtexString :: ToSources a
63+ => Variant -- ^ bibtex or biblatex
5764 -> Locale -- ^ Locale
5865 -> (Text -> Bool) -- ^ Filter on citation ids
59− -> Text -- ^ bibtex/biblatex text
66+ -> a -- ^ bibtex/biblatex text
6067 -> Either ParseError [Reference Inlines]
6168readBibtexString variant locale idpred contents = do
6269 case runParser (((resolveCrossRefs variant <$> bibEntries) <* eof) >>=
6370 mapM (itemToReference locale variant) .
64− filter (idpred . identifier))
71+ filter (\item -> idpred (identifier item) &&
72+ entryType item /= "xdata"))
6573 (fromMaybe defaultLang $ localeLanguage locale, Map.empty)
66− "" contents of
74+ (initialSourceName sources) sources of
6775 Left err -> Left err
6876 Right xs -> return xs
77+ where
78+ sources = toSources contents
79+
80+-- | Write BibTeX or BibLaTeX given given a 'Reference'.
81+writeBibtexString :: WriterOptions -- ^ options (for writing LaTex)
82+ -> Variant -- ^ bibtex or biblatex
83+ -> Maybe Lang -- ^ Language
84+ -> Reference Inlines -- ^ Reference to write
85+ -> Doc Text
86+writeBibtexString opts variant mblang ref =
87+ "@" <> bibtexType <> "{" <> literal (unItemId (referenceId ref)) <> ","
88+ $$ nest 2 (renderFields fs)
89+ $$ "}" <> cr
90+
91+ where
92+ bibtexType =
93+ case referenceType ref of
94+ "article-magazine" -> "article"
95+ "article-newspaper" -> "article"
96+ "article-journal" -> "article"
97+ "book" -> "book"
98+ "pamphlet" -> "booklet"
99+ "dataset" | variant == Biblatex -> "dataset"
100+ "webpage" | variant == Biblatex -> "online"
101+ "chapter" -> case getVariable "editor" of
102+ Just _ -> "incollection"
103+ Nothing -> "inbook"
104+ "entry-encyclopedia" | variant == Biblatex -> "inreference"
105+ | otherwise -> "inbook"
106+ "paper-conference" -> "inproceedings"
107+ "thesis" -> case getVariableAsText "genre" of
108+ Just "mathesis" -> "mastersthesis"
109+ _ -> "phdthesis"
110+ "patent" | variant == Biblatex -> "patent"
111+ "report" | variant == Biblatex -> "report"
112+ | otherwise -> "techreport"
113+ "speech" -> "unpublished"
114+ "manuscript" -> "unpublished"
115+ "graphic" | variant == Biblatex -> "artwork"
116+ "song" | variant == Biblatex -> "music"
117+ "legal_case" | variant == Biblatex -> "jurisdictionN"
118+ "legislation" | variant == Biblatex -> "legislation"
119+ "treaty" | variant == Biblatex -> "legal"
120+ "personal_communication" | variant == Biblatex -> "letter"
121+ "motion_picture" | variant == Biblatex -> "movie"
122+ "review" | variant == Biblatex -> "review"
123+ _ -> "misc"
124+
125+ mbSubtype =
126+ case referenceType ref of
127+ "article-magazine" -> Just "magazine"
128+ "article-newspaper" -> Just "newspaper"
129+ _ -> Nothing
130+
131+ fs =
132+ case variant of
133+ Biblatex ->
134+ [ "author"
135+ , "editor"
136+ , "translator"
137+ , "publisher"
138+ , "title"
139+ , "booktitle"
140+ , "journal"
141+ , "series"
142+ , "edition"
143+ , "volume"
144+ , "volumes"
145+ , "number"
146+ , "pages"
147+ , "date"
148+ , "eventdate"
149+ , "urldate"
150+ , "address"
151+ , "url"
152+ , "doi"
153+ , "isbn"
154+ , "issn"
155+ , "type"
156+ , "entrysubtype"
157+ , "note"
158+ , "langid"
159+ , "abstract"
160+ , "keywords"
161+ , "annote"
162+ ]
163+ Bibtex ->
164+ [ "author"
165+ , "editor"
166+ , "translator"
167+ , "publisher"
168+ , "title"
169+ , "booktitle"
170+ , "journal"
171+ , "series"
172+ , "edition"
173+ , "volume"
174+ , "number"
175+ , "pages"
176+ , "year"
177+ , "month"
178+ , "address"
179+ , "type"
180+ , "note"
181+ , "annote"
182+ ]
183+
184+ valToInlines (TextVal t) = B.text t
185+ valToInlines (FancyVal ils) = ils
186+ valToInlines (NumVal n) = B.text (T.pack $ show n)
187+ valToInlines (NamesVal names) =
188+ mconcat $ intersperse (B.space <> B.text "and" <> B.space)
189+ $ map renderName names
190+ valToInlines (DateVal date) = B.text $
191+ case dateLiteral date of
192+ Just t -> t
193+ Nothing -> T.intercalate "/" (map renderDatePart (dateParts date)) <>
194+ (if dateCirca date then "~" else mempty)
195+
196+ renderDatePart (DateParts xs) = T.intercalate "-" $
197+ map (T.pack . printf "%02d") xs
198+
199+ renderName name =
200+ case nameLiteral name of
201+ Just t -> B.text t
202+ Nothing -> spacedMaybes
203+ [ nameNonDroppingParticle name
204+ , nameFamily name
205+ , if nameCommaSuffix name
206+ then (", " <>) <$> nameSuffix name
207+ else nameSuffix name ]
208+ <>
209+ spacedMaybes
210+ [ (", " <>) <$> nameGiven name,
211+ nameDroppingParticle name ]
212+
213+ mblang' = case getVariableAsText "language" of
214+ Just l -> either (const Nothing) Just $ parseLang l
215+ Nothing -> mblang
216+
217+ titlecase = case mblang' of
218+ Just lang | langLanguage lang == "en"
219+ -> titlecase'
220+ Nothing -> titlecase'
221+ _ ->
222+ case variant of
223+ Bibtex -> B.spanWith nullAttr
224+ -- BibTex lacks a language field, so we wrap non-English
225+ -- titles in {} to protect case.
226+ Biblatex -> id
227+
228+ titlecase' = addTextCase mblang' TitleCase .
229+ (\ils -> B.fromList
230+ (case B.toList ils of
231+ Str t : xs -> Str t : Walk.walk spanAroundCapitalizedWords xs
232+ xs -> Walk.walk spanAroundCapitalizedWords xs))
233+
234+ -- protect capitalized words when we titlecase
235+ spanAroundCapitalizedWords (Str t)
236+ | not (T.all (\c -> isLower c || not (isLetter c)) t) =
237+ Span ("",["nocase"],[]) [Str t]
238+ spanAroundCapitalizedWords x = x
239+
240+ spacedMaybes = mconcat . intersperse B.space . mapMaybe (fmap B.text)
241+
242+ toLaTeX x =
243+ case runPure (writeLaTeX opts $ doc (B.plain x)) of
244+ Left _ -> Nothing
245+ Right t -> Just $ hsep . map literal $ T.words t
246+
247+ renderField :: Text -> Maybe (Doc Text)
248+ renderField name =
249+ (((literal name) <>) . hang 2 " = " . braces)
250+ <$> getContentsFor name
251+
252+ getVariable v = lookupVariable (toVariable v) ref
253+
254+ getVariableAsText v = (stringify . valToInlines) <$> getVariable v
255+
256+ getYear val =
257+ case val of
258+ DateVal date ->
259+ case dateLiteral date of
260+ Just t -> toLaTeX (B.text t)
261+ Nothing ->
262+ case dateParts date of
263+ [DateParts (y1:_), DateParts (y2:_)] ->
264+ Just $ literal (T.pack (printf "%04d" y1) <> "--" <>
265+ T.pack (printf "%04d" y2))
266+ [DateParts (y1:_)] ->
267+ Just $ literal (T.pack (printf "%04d" y1))
268+ _ -> Nothing
269+ _ -> Nothing
270+
271+ toMonth 1 = "jan"
272+ toMonth 2 = "feb"
273+ toMonth 3 = "mar"
274+ toMonth 4 = "apr"
275+ toMonth 5 = "may"
276+ toMonth 6 = "jun"
277+ toMonth 7 = "jul"
278+ toMonth 8 = "aug"
279+ toMonth 9 = "sep"
280+ toMonth 10 = "oct"
281+ toMonth 11 = "nov"
282+ toMonth 12 = "dec"
283+ toMonth x = T.pack $ show x
284+
285+ getMonth val =
286+ case val of
287+ DateVal date ->
288+ case dateParts date of
289+ [DateParts (_:m1:_), DateParts (_:m2:_)] ->
290+ Just $ literal (toMonth m1 <> "--" <> toMonth m2)
291+ [DateParts (_:m1:_)] -> Just $ literal (toMonth m1)
292+ _ -> Nothing
293+ _ -> Nothing
294+
295+ getContentsFor :: Text -> Maybe (Doc Text)
296+ getContentsFor "type" =
297+ getVariableAsText "genre" >>=
298+ \case
299+ "mathesis" -> Just "mastersthesis"
300+ "phdthesis" -> Just "phdthesis"
301+ _ -> Nothing
302+ getContentsFor "entrysubtype" = literal <$> mbSubtype
303+ getContentsFor "journal"
304+ | bibtexType `elem` ["article", "periodical", "suppperiodical", "review"]
305+ = getVariable "container-title" >>= toLaTeX . valToInlines
306+ | otherwise = Nothing
307+ getContentsFor "booktitle"
308+ | bibtexType `elem`
309+ ["inbook","incollection","inproceedings","inreference","bookinbook"]
310+ = (getVariable "volume-title" <|> getVariable "container-title")
311+ >>= toLaTeX . valToInlines
312+ | otherwise = Nothing
313+ getContentsFor "series" = getVariable "collection-title"
314+ >>= toLaTeX . valToInlines
315+ getContentsFor "address" = getVariable "publisher-place"
316+ >>= toLaTeX . valToInlines
317+ getContentsFor "date" = getVariable "issued" >>= toLaTeX . valToInlines
318+ getContentsFor "eventdate" = getVariable "event-date" >>= toLaTeX . valToInlines
319+ getContentsFor "urldate" = getVariable "accessed" >>= toLaTeX . valToInlines
320+ getContentsFor "year" = getVariable "issued" >>= getYear
321+ getContentsFor "month" = getVariable "issued" >>= getMonth
322+ getContentsFor "pages" = getVariable "page" >>= toLaTeX . valToInlines
323+ getContentsFor "langid" = getVariable "language" >>= toLaTeX . valToInlines
324+ getContentsFor "number" = (getVariable "number"
325+ <|> getVariable "collection-number"
326+ <|> getVariable "issue") >>= toLaTeX . valToInlines
327+
328+ getContentsFor x = getVariable x >>=
329+ if isURL x
330+ then Just . literal . stringify . valToInlines
331+ else toLaTeX .
332+ (if x == "title"
333+ then titlecase
334+ else id) .
335+ valToInlines
336+
337+ isURL x = x `elem` ["url","doi","issn","isbn"]
338+
339+ renderFields = mconcat . intersperse ("," <> cr) . mapMaybe renderField
69340
70341defaultLang :: Lang
71−defaultLang = Lang "en" (Just "US")
342+defaultLang = Lang "en" Nothing (Just "US") [] [] []
72343
73344-- a map of bibtex "string" macros
74345type StringMap = Map.Map Text Text
75346
76−type BibParser = Parser Text (Lang, StringMap)
347+type BibParser = Parser Sources (Lang, StringMap)
77348
78349data Item = Item{ identifier :: Text
79350 , sourcePos :: SourcePos
@@ -88,9 +359,7 @@ itemToReference locale variant item = do
88359 bib item $ do
89360 let lang = fromMaybe defaultLang $ localeLanguage locale
90361 modify $ \st -> st{ localeLang = lang,
91− untitlecase = case lang of
92− (Lang "en" _) -> True
93− _ -> False }
362+ untitlecase = langLanguage lang == "en" }
94363
95364 id' <- asks identifier
96365 otherIds <- (Just <$> getRawField "ids")
@@ -314,10 +583,10 @@ itemToReference locale variant item = do
314583 eprint <- getRawField "eprint"
315584 let baseUrl =
316585 case T.toLower etype of
317− "arxiv" -> "http://arxiv.org/abs/"
318− "jstor" -> "http://www.jstor.org/stable/"
319− "pubmed" -> "http://www.ncbi.nlm.nih.gov/pubmed/"
320− "googlebooks" -> "http://books.google.com?id="
586+ "arxiv" -> "https://arxiv.org/abs/"
587+ "jstor" -> "https://www.jstor.org/stable/"
588+ "pubmed" -> "https://www.ncbi.nlm.nih.gov/pubmed/"
589+ "googlebooks" -> "https://books.google.com?id="
321590 _ -> ""
322591 if T.null baseUrl
323592 then mzero
@@ -448,7 +717,7 @@ itemToReference locale variant item = do
448717
449718
450719bib :: Item -> Bib a -> BibParser a
451−bib entry m = fst <$> evalRWST m entry (BibState True (Lang "en" (Just "US")))
720+bib entry m = fst <$> evalRWST m entry (BibState True defaultLang)
452721
453722resolveCrossRefs :: Variant -> [Item] -> [Item]
454723resolveCrossRefs variant entries =
@@ -501,41 +770,10 @@ blocksToInlines bs =
501770 _ -> B.fromList $ Walk.query (:[]) bs
502771
503772adjustSpans :: Lang -> Inline -> Inline
504−adjustSpans lang (RawInline (Format "latex") s)
505− | s == "\\hyphen" || s == "\\hyphen " = Str "-"
506− | otherwise = parseRawLaTeX lang s
773+adjustSpans lang (Span ("",[],[("bibstring",s)]) _) = Str $ resolveKey' lang s
507774adjustSpans _ SoftBreak = Space
508775adjustSpans _ x = x
509776
510−parseRawLaTeX :: Lang -> Text -> Inline
511−parseRawLaTeX lang t@(T.stripPrefix "\\" -> Just xs) =
512− case parseLaTeX lang contents of
513− Right [Para ys] -> f command ys
514− Right [Plain ys] -> f command ys
515− Right [] -> f command []
516− _ -> RawInline (Format "latex") t
517− where (command', contents') = T.break (\c -> c =='{' || c =='\\') xs
518− command = T.strip command'
519− contents = T.drop 1 $ T.dropEnd 1 contents'
520− f "mkbibquote" ils = Span nullAttr [Quoted DoubleQuote ils]
521− f "mkbibemph" ils = Span nullAttr [Emph ils]
522− f "mkbibitalic" ils = Span nullAttr [Emph ils]
523− f "mkbibbold" ils = Span nullAttr [Strong ils]
524− f "mkbibparens" ils = Span nullAttr $
525− [Str "("] ++ ils ++ [Str ")"]
526− f "mkbibbrackets" ils = Span nullAttr $
527− [Str "["] ++ ils ++ [Str "]"]
528− -- ... both should be nestable & should work in year fields
529− f "autocap" ils = Span nullAttr ils
530− -- TODO: should work in year fields
531− f "textnormal" ils = Span ("",["nodecor"],[]) ils
532− f "bibstring" [Str s] = Str $ resolveKey' lang s
533− f "adddot" [] = Str "."
534− f "adddotspace" [] = Span nullAttr [Str ".", Space]
535− f "addabbrvspace" [] = Space
536− f _ ils = Span nullAttr ils
537−parseRawLaTeX _ t = RawInline (Format "latex") t
538−
539777latex' :: Text -> Bib [Block]
540778latex' t = do
541779 lang <- gets localeLang
@@ -571,7 +809,7 @@ bibEntries = do
571809 (bibComment <|> bibPreamble <|> bibString))
572810
573811bibSkip :: BibParser ()
574−bibSkip = () <$ take1WhileP (/='@')
812+bibSkip = skipMany1 (satisfy (/='@'))
575813
576814bibComment :: BibParser ()
577815bibComment = do
@@ -596,11 +834,14 @@ bibString = do
596834 updateState (\(l,m) -> (l, Map.insert k v m))
597835 return ()
598836
837+take1WhileP :: Monad m => (Char -> Bool) -> ParserT Sources u m Text
838+take1WhileP f = T.pack <$> many1 (satisfy f)
839+
599840inBraces :: BibParser Text
600841inBraces = do
601842 char '{'
602843 res <- manyTill
603− ( (T.pack <$> many1 (noneOf "{}\\"))
844+ ( take1WhileP (\c -> c /= '{' && c /= '}' && c /= '\\')
604845 <|> (char '\\' >> ( (char '{' >> return "\\{")
605846 <|> (char '}' >> return "\\}")
606847 <|> return "\\"))
@@ -615,7 +856,7 @@ inQuotes :: BibParser Text
615856inQuotes = do
616857 char '"'
617858 T.concat <$> manyTill
618− ( (T.pack <$> many1 (noneOf "\"\\{"))
859+ ( take1WhileP (\c -> c /= '{' && c /= '"' && c /= '\\')
619860 <|> (char '\\' >> T.cons '\\' . T.singleton <$> anyChar)
620861 <|> braced <$> inBraces
621862 ) (char '"')
@@ -627,7 +868,7 @@ fieldName = resolveAlias . T.toLower
627868
628869isBibtexKeyChar :: Char -> Bool
629870isBibtexKeyChar c =
630− isAlphaNum c || c `elem` (".:;?!`'()/*@_+=-[]*&" :: [Char])
871+ isAlphaNum c || c `elem` (".:;?!`'()$/*@_+=-[]*&" :: [Char])
631872
632873bibItem :: BibParser Item
633874bibItem = do
@@ -811,22 +1052,21 @@ getOldDate prefix = do
8111052 let dateparts = filter (\x -> x /= DateParts [])
8121053 $ map toDateParts [(year',month',day'),
8131054 (endyear',endmonth',endday')]
814− literal <- if null dateparts
815− then Just <$> getRawField (prefix <> "year")
816− else return Nothing
1055+ literal' <- if null dateparts
1056+ then Just <$> getRawField (prefix <> "year")
1057+ else return Nothing
8171058 return $
8181059 Date { dateParts = dateparts
8191060 , dateCirca = False
8201061 , dateSeason = Nothing
821− , dateLiteral = literal }
1062+ , dateLiteral = literal' }
8221063
8231064getRawField :: Text -> Bib Text
824−getRawField f =
825− (stringify <$> getField f)
826− <|> do fs <- asks fields
827− case Map.lookup f fs of
828− Just x -> return x
829− Nothing -> notFound f
1065+getRawField f = do
1066+ fs <- asks fields
1067+ case Map.lookup f fs of
1068+ Just x -> return x
1069+ Nothing -> notFound f
8301070
8311071getLiteralList :: Text -> Bib [Inlines]
8321072getLiteralList f = do
@@ -1058,7 +1298,6 @@ getTypeAndGenre :: Bib (Text, Maybe Text)
10581298getTypeAndGenre = do
10591299 lang <- gets localeLang
10601300 et <- asks entryType
1061− guard $ et /= "xdata"
10621301 reftype' <- resolveKey' lang <$> getRawField "type"
10631302 <|> return mempty
10641303 st <- getRawField "entrysubtype" <|> return mempty
@@ -1226,8 +1465,9 @@ resolveKey lang ils = Walk.walk go ils
12261465 go x = x
12271466
12281467resolveKey' :: Lang -> Text -> Text
1229−resolveKey' lang@(Lang l _) k =
1230− case Map.lookup l biblatexStringMap >>= Map.lookup (T.toLower k) of
1468+resolveKey' lang k =
1469+ case Map.lookup (langLanguage lang) biblatexStringMap >>=
1470+ Map.lookup (T.toLower k) of
12311471 Nothing -> k
12321472 Just (x, _) -> either (const k) stringify $ parseLaTeX lang x
12331473
src/Text/Pandoc/Citeproc/Data.hs+7−6
@@ -10,7 +10,7 @@ import qualified Data.Text.Encoding as TE
1010import qualified Data.Text as T
1111import Data.Text (Text)
1212import Text.Pandoc.Citeproc.Util (toIETF)
13−import Citeproc (Lang(..), parseLang)
13+import Text.Collate.Lang (Lang(..), parseLang)
1414
1515biblatexLocalizations :: [(FilePath, ByteString)]
1616biblatexLocalizations = $(embedDir "citeproc/biblatex-localization")
@@ -21,11 +21,12 @@ biblatexStringMap :: M.Map Text (M.Map Text (Text, Text))
2121biblatexStringMap = foldr go mempty biblatexLocalizations
2222 where
2323 go (fp, bs) =
24− let Lang lang _ = parseLang (toIETF $ T.takeWhile (/= '.') $ T.pack fp)
25− ls = T.lines $ TE.decodeUtf8 bs
26− in if length ls > 4
27− then M.insert lang (toStringMap $ map (T.splitOn "|") ls)
28− else id
24+ let ls = T.lines $ TE.decodeUtf8 bs
25+ in case parseLang (toIETF $ T.takeWhile (/= '.') $ T.pack fp) of
26+ Right lang | length ls > 4
27+ -> M.insert (langLanguage lang)
28+ (toStringMap $ map (T.splitOn "|") ls)
29+ _ -> id
2930 toStringMap = foldr go' mempty
3031 go' [term, x, y] = M.insert term (x, y)
3132 go' _ = id
src/Text/Pandoc/Citeproc/Locator.hs+20−4
@@ -7,6 +7,7 @@ where
77import Citeproc.Types
88import Data.Text (Text)
99import qualified Data.Text as T
10+import Data.List (foldl')
1011import Text.Parsec
1112import Text.Pandoc.Definition
1213import Text.Pandoc.Parsing (romanNumeral)
@@ -19,7 +20,7 @@ parseLocator :: Locale -> [Inline] -> (Maybe (Text, Text), [Inline])
1920parseLocator locale inp =
2021 case parse (pLocatorWords (toLocatorMap locale)) "suffix" $ splitInp inp of
2122 Right r -> r
22− Left _ -> (Nothing, inp)
23+ Left _ -> (Nothing, maybeAddComma inp)
2324
2425splitInp :: [Inline] -> [Inline]
2526splitInp = splitStrWhen (\c -> isSpace c || (isPunctuation c && c /= ':'))
@@ -41,9 +42,17 @@ pLocatorWords locMap = do
4142 -- i.e. the first one will be " 9"
4243 return $
4344 if T.null la && T.null lo
44− then (Nothing, s)
45+ then (Nothing, maybeAddComma s)
4546 else (Just (la, T.strip lo), s)
4647
48+maybeAddComma :: [Inline] -> [Inline]
49+maybeAddComma [] = []
50+maybeAddComma ils@(Space : _) = ils
51+maybeAddComma ils@(Str t : _)
52+ | Just (c, _) <- T.uncons t
53+ , isPunctuation c = ils
54+maybeAddComma ils = Str "," : Space : ils
55+
4756pLocatorDelimited :: LocatorMap -> LocatorParser (Text, Text)
4857pLocatorDelimited locMap = try $ do
4958 _ <- pMatchChar "{" (== '{')
@@ -96,7 +105,7 @@ pLocatorLabel' locMap lim = go ""
96105 t <- anyToken
97106 ts <- manyTill anyToken (try $ lookAhead lim)
98107 let s = acc <> stringify (t:ts)
99− case M.lookup (T.strip s) locMap of
108+ case M.lookup (T.toCaseFold $ T.strip s) locMap of
100109 -- try to find a longer one, or return this one
101110 Just l -> go s <|> return (l, False)
102111 Nothing -> go s
@@ -139,7 +148,7 @@ pBalancedBraces braces p = try $ do
139148 where
140149 except = notFollowedBy pBraces >> p
141150 -- outer and inner
142− surround = foldl (\a (open, close) -> sur open close except <|> a)
151+ surround = foldl' (\a (open, close) -> sur open close except <|> a)
143152 except
144153 braces
145154
@@ -180,6 +189,7 @@ pPageUnit = roman <|> plainUnit
180189 plainUnit = do
181190 ts <- many1 (notFollowedBy pSpace >>
182191 notFollowedBy pLocatorPunct >>
192+ notFollowedBy pMath >>
183193 anyToken)
184194 let s = stringify ts
185195 -- otherwise look for actual digits or -s
@@ -210,6 +220,12 @@ pMatchChar msg f = satisfyTok f' <?> msg
210220pSpace :: LocatorParser Inline
211221pSpace = satisfyTok (\t -> isSpacey t || t == Str "\160") <?> "space"
212222
223+pMath :: LocatorParser Inline
224+pMath = satisfyTok isMath
225+ where
226+ isMath (Math{}) = True
227+ isMath _ = False
228+
213229satisfyTok :: (Inline -> Bool) -> LocatorParser Inline
214230satisfyTok f = tokenPrim show (\sp _ _ -> sp) (\tok -> if f tok
215231 then Just tok
src/Text/Pandoc/Citeproc/MetaValue.hs+6−5
@@ -135,23 +135,25 @@ metaValueToVal k v
135135 MetaMap _ -> TextVal mempty
136136
137137metaValueToDate :: MetaValue -> Date
138−metaValueToDate (MetaMap m) =
139− Date
138+metaValueToDate (MetaMap m) = fromMaybe
139+ (Date
140140 { dateParts = dateparts
141141 , dateCirca = circa
142142 , dateSeason = season
143− , dateLiteral = literal }
143+ , dateLiteral = literal })
144+ rawdate
144145 where
145146 dateparts = case M.lookup "date-parts" m of
146147 Just (MetaList xs) ->
147148 mapMaybe metaValueToDateParts xs
148149 Just _ -> []
149150 Nothing ->
150− maybe [] (:[]) $ metaValueToDateParts (MetaMap m)
151+ maybeToList $ metaValueToDateParts (MetaMap m)
151152 circa = fromMaybe False $
152153 M.lookup "circa" m >>= metaValueToBool
153154 season = M.lookup "season" m >>= metaValueToInt
154155 literal = M.lookup "literal" m >>= metaValueToText
156+ rawdate = M.lookup "raw" m >>= metaValueToText >>= rawDateEDTF
155157metaValueToDate (MetaList xs) =
156158 Date{ dateParts = mapMaybe metaValueToDateParts xs
157159 , dateCirca = False
@@ -251,4 +253,3 @@ normalizeKey k =
251253 "pmid" -> "PMID"
252254 "url" -> "URL"
253255 x -> x
254−
src/Text/Pandoc/Class/CommonState.hs+1−1
@@ -19,7 +19,7 @@ where
1919
2020import Data.Default (Default (def))
2121import Data.Text (Text)
22−import Text.Pandoc.BCP47 (Lang)
22+import Text.Collate.Lang (Lang)
2323import Text.Pandoc.MediaBag (MediaBag)
2424import Text.Pandoc.Logging (LogMessage, Verbosity (WARNING))
2525import Text.Pandoc.Translations (Translations)
src/Text/Pandoc/Class/IO.hs+24−24
@@ -62,7 +62,7 @@ import Text.Pandoc.Definition (Pandoc, Inline (Image))
6262import Text.Pandoc.Error (PandocError (..))
6363import Text.Pandoc.Logging (LogMessage (..), messageVerbosity, showLogMessage)
6464import Text.Pandoc.MIME (MimeType)
65−import Text.Pandoc.MediaBag (MediaBag, lookupMedia, mediaDirectory)
65+import Text.Pandoc.MediaBag (MediaBag, MediaItem(..), lookupMedia, mediaItems)
6666import Text.Pandoc.Walk (walk)
6767import qualified Control.Exception as E
6868import qualified Data.ByteString as B
@@ -183,7 +183,7 @@ getModificationTime = liftIOError System.Directory.getModificationTime
183183logOutput :: (PandocMonad m, MonadIO m) => LogMessage -> m ()
184184logOutput msg = liftIO $ do
185185 UTF8.hPutStr stderr $
186− "[" ++ show (messageVerbosity msg) ++ "] "
186+ "[" <> T.pack (show (messageVerbosity msg)) <> "] "
187187 alertIndent $ T.lines $ showLogMessage msg
188188
189189-- | Prints the list of lines to @stderr@, indenting every but the first
@@ -191,41 +191,41 @@ logOutput msg = liftIO $ do
191191alertIndent :: [Text] -> IO ()
192192alertIndent [] = return ()
193193alertIndent (l:ls) = do
194− UTF8.hPutStrLn stderr $ unpack l
194+ UTF8.hPutStrLn stderr l
195195 mapM_ go ls
196196 where go l' = do UTF8.hPutStr stderr " "
197− UTF8.hPutStrLn stderr $ unpack l'
197+ UTF8.hPutStrLn stderr l'
198198
199199-- | Extract media from the mediabag into a directory.
200200extractMedia :: (PandocMonad m, MonadIO m) => FilePath -> Pandoc -> m Pandoc
201201extractMedia dir d = do
202202 media <- getMediaBag
203− case [fp | (fp, _, _) <- mediaDirectory media] of
204− [] -> return d
205− fps -> do
206− mapM_ (writeMedia dir media) fps
207− return $ walk (adjustImagePath dir fps) d
203+ let items = mediaItems media
204+ if null items
205+ then return d
206+ else do
207+ mapM_ (writeMedia dir) items
208+ return $ walk (adjustImagePath dir media) d
208209
209210-- | Write the contents of a media bag to a path.
210211writeMedia :: (PandocMonad m, MonadIO m)
211− => FilePath -> MediaBag -> FilePath
212+ => FilePath
213+ -> (FilePath, MimeType, BL.ByteString)
212214 -> m ()
213−writeMedia dir mediabag subpath = do
214− -- we join and split to convert a/b/c to a\b\c on Windows;
215− -- in zip containers all paths use /
216− let fullpath = dir </> unEscapeString (normalise subpath)
217− let mbcontents = lookupMedia subpath mediabag
218− case mbcontents of
219− Nothing -> throwError $ PandocResourceNotFound $ pack subpath
220− Just (_, bs) -> do
221− report $ Extracting $ pack fullpath
222− liftIOError (createDirectoryIfMissing True) (takeDirectory fullpath)
223− logIOError $ BL.writeFile fullpath bs
215+writeMedia dir (fp, _mt, bs) = do
216+ -- we normalize to get proper path separators for the platform
217+ let fullpath = normalise $ dir </> fp
218+ liftIOError (createDirectoryIfMissing True) (takeDirectory fullpath)
219+ logIOError $ BL.writeFile fullpath bs
224220
225221-- | If the given Inline element is an image with a @src@ path equal to
226222-- one in the list of @paths@, then prepends @dir@ to the image source;
227223-- returns the element unchanged otherwise.
228−adjustImagePath :: FilePath -> [FilePath] -> Inline -> Inline
229−adjustImagePath dir paths (Image attr lab (src, tit))
230− | unpack src `elem` paths = Image attr lab (pack dir <> "/" <> src, tit)
224+adjustImagePath :: FilePath -> MediaBag -> Inline -> Inline
225+adjustImagePath dir mediabag (Image attr lab (src, tit)) =
226+ case lookupMedia (T.unpack src) mediabag of
227+ Nothing -> Image attr lab (src, tit)
228+ Just item ->
229+ let fullpath = dir </> mediaPath item
230+ in Image attr lab (T.pack fullpath, tit)
231231adjustImagePath _ _ x = x
src/Text/Pandoc/Class/PandocMonad.hs+45−38
@@ -1,4 +1,5 @@
11{-# LANGUAGE CPP #-}
2+{-# LANGUAGE TupleSections #-}
23{-# LANGUAGE FlexibleContexts #-}
34{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE MultiParamTypeClasses #-}
@@ -37,7 +38,6 @@ module Text.Pandoc.Class.PandocMonad
3738 , setUserDataDir
3839 , getUserDataDir
3940 , fetchItem
40− , fetchMediaResource
4141 , getInputFiles
4242 , setInputFiles
4343 , getOutputFile
@@ -51,30 +51,31 @@ module Text.Pandoc.Class.PandocMonad
5151 , setTranslations
5252 , translateTerm
5353 , makeCanonical
54+ , getTimestamp
5455 ) where
5556
5657import Codec.Archive.Zip
5758import Control.Monad.Except (MonadError (catchError, throwError),
5859 MonadTrans, lift, when)
59−import Data.Digest.Pure.SHA (sha1, showDigest)
60−import Data.Maybe (fromMaybe)
60+import Data.List (foldl')
6161import Data.Time (UTCTime)
62−import Data.Time.Clock.POSIX (POSIXTime, utcTimeToPOSIXSeconds)
62+import Data.Time.Clock.POSIX (POSIXTime, utcTimeToPOSIXSeconds,
63+ posixSecondsToUTCTime)
6364import Data.Time.LocalTime (TimeZone, ZonedTime, utcToZonedTime)
6465import Network.URI ( escapeURIString, nonStrictRelativeTo,
6566 unEscapeString, parseURIReference, isAllowedInURI,
6667 parseURI, URI(..) )
67−import System.FilePath ((</>), (<.>), takeExtension, dropExtension,
68− isRelative, splitDirectories)
68+import System.FilePath ((</>), takeExtension, dropExtension,
69+ isRelative, splitDirectories, makeRelative)
6970import System.Random (StdGen)
70−import Text.Pandoc.BCP47 (Lang(..), parseBCP47, renderLang)
71+import Text.Collate.Lang (Lang(..), parseLang, renderLang)
7172import Text.Pandoc.Class.CommonState (CommonState (..))
7273import Text.Pandoc.Definition
7374import Text.Pandoc.Error
7475import Text.Pandoc.Logging
75−import Text.Pandoc.MIME (MimeType, getMimeType, extensionFromMimeType)
76−import Text.Pandoc.MediaBag (MediaBag, lookupMedia)
77−import Text.Pandoc.Shared (uriPathToPath)
76+import Text.Pandoc.MIME (MimeType, getMimeType)
77+import Text.Pandoc.MediaBag (MediaBag, lookupMedia, MediaItem(..))
78+import Text.Pandoc.Shared (uriPathToPath, safeRead)
7879import Text.Pandoc.Translations (Term(..), Translations, lookupTerm,
7980 readTranslations)
8081import Text.Pandoc.Walk (walkM)
@@ -160,7 +161,7 @@ setVerbosity verbosity =
160161getVerbosity :: PandocMonad m => m Verbosity
161162getVerbosity = getsCommonState stVerbosity
162163
163−-- | Get the accomulated log messages (in temporal order).
164+-- | Get the accumulated log messages (in temporal order).
164165getLog :: PandocMonad m => m [LogMessage]
165166getLog = reverse <$> getsCommonState stLog
166167
@@ -175,6 +176,21 @@ report msg = do
175176 when (level <= verbosity) $ logOutput msg
176177 modifyCommonState $ \st -> st{ stLog = msg : stLog st }
177178
179+-- | Get the time from the @SOURCE_DATE_EPOCH@
180+-- environment variable. The variable should contain a
181+-- unix time stamp, the number of seconds since midnight Jan 01
182+-- 1970 UTC. If the variable is not set or cannot be
183+-- parsed as a unix time stamp, the current time is returned.
184+-- This function is designed to make possible reproducible
185+-- builds in formats that include a creation timestamp.
186+getTimestamp :: PandocMonad m => m UTCTime
187+getTimestamp = do
188+ mbSourceDateEpoch <- lookupEnv "SOURCE_DATE_EPOCH"
189+ case mbSourceDateEpoch >>= safeRead of
190+ Just (epoch :: Integer) ->
191+ return $ posixSecondsToUTCTime $ fromIntegral epoch
192+ Nothing -> getCurrentTime
193+
178194-- | Determine whether tracing is enabled. This affects
179195-- the behavior of 'trace'. If tracing is not enabled,
180196-- 'trace' does nothing.
@@ -267,7 +283,7 @@ readFileFromDirs (d:ds) f = catchError
267283toLang :: PandocMonad m => Maybe T.Text -> m (Maybe Lang)
268284toLang Nothing = return Nothing
269285toLang (Just s) =
270− case parseBCP47 s of
286+ case parseLang s of
271287 Left _ -> do
272288 report $ InvalidLang s
273289 return Nothing
@@ -358,7 +374,8 @@ fetchItem :: PandocMonad m
358374fetchItem s = do
359375 mediabag <- getMediaBag
360376 case lookupMedia (T.unpack s) mediabag of
361− Just (mime, bs) -> return (BL.toStrict bs, Just mime)
377+ Just item -> return (BL.toStrict (mediaContents item),
378+ Just (mediaMimeType item))
362379 Nothing -> downloadOrRead s
363380
364381-- | Returns the content and, if available, the MIME type of a resource.
@@ -393,9 +410,10 @@ downloadOrRead s = do
393410 _ -> readLocalFile fp -- get from local file system
394411 where readLocalFile f = do
395412 resourcePath <- getResourcePath
396− cont <- if isRelative f
397− then withPaths resourcePath readFileStrict f
398− else readFileStrict f
413+ (fp', cont) <- if isRelative f
414+ then withPaths resourcePath readFileStrict f
415+ else (f,) <$> readFileStrict f
416+ report $ LoadedResource f (makeRelative "." fp')
399417 return (cont, mime)
400418 httpcolon = URI{ uriScheme = "http:",
401419 uriAuthority = Nothing,
@@ -595,35 +613,23 @@ checkExistence fn = do
595613-- | Canonicalizes a file path by removing redundant @.@ and @..@.
596614makeCanonical :: FilePath -> FilePath
597615makeCanonical = Posix.joinPath . transformPathParts . splitDirectories
598− where transformPathParts = reverse . foldl go []
616+ where transformPathParts = reverse . foldl' go []
599617 go as "." = as
600618 go (_:as) ".." = as
601619 go as x = x : as
602620
603−-- | Trys to run an action on a file: for each directory given, a
621+-- | Tries to run an action on a file: for each directory given, a
604622-- filepath is created from the given filename, and the action is run on
605623-- that filepath. Returns the result of the first successful execution
606624-- of the action, or throws a @PandocResourceNotFound@ exception if the
607625-- action errors for all filepaths.
608−withPaths :: PandocMonad m => [FilePath] -> (FilePath -> m a) -> FilePath -> m a
626+withPaths :: PandocMonad m
627+ => [FilePath] -> (FilePath -> m a) -> FilePath -> m (FilePath, a)
609628withPaths [] _ fp = throwError $ PandocResourceNotFound $ T.pack fp
610629withPaths (p:ps) action fp =
611− catchError (action (p </> fp))
630+ catchError ((p </> fp,) <$> action (p </> fp))
612631 (\_ -> withPaths ps action fp)
613632
614−-- | Fetch local or remote resource (like an image) and provide data suitable
615−-- for adding it to the MediaBag.
616−fetchMediaResource :: PandocMonad m
617− => T.Text -> m (FilePath, Maybe MimeType, BL.ByteString)
618−fetchMediaResource src = do
619− (bs, mt) <- downloadOrRead src
620− let ext = fromMaybe (T.pack $ takeExtension $ T.unpack src)
621− (mt >>= extensionFromMimeType)
622− let bs' = BL.fromChunks [bs]
623− let basename = showDigest $ sha1 bs'
624− let fname = basename <.> T.unpack ext
625− return (fname, mt, bs')
626−
627633-- | Traverse tree, filling media bag for any images that
628634-- aren't already in the media bag.
629635fillMediaBag :: PandocMonad m => Pandoc -> m Pandoc
@@ -631,12 +637,13 @@ fillMediaBag d = walkM handleImage d
631637 where handleImage :: PandocMonad m => Inline -> m Inline
632638 handleImage (Image attr lab (src, tit)) = catchError
633639 (do mediabag <- getMediaBag
634− case lookupMedia (T.unpack src) mediabag of
635− Just (_, _) -> return $ Image attr lab (src, tit)
640+ let fp = T.unpack src
641+ case lookupMedia fp mediabag of
642+ Just _ -> return ()
636643 Nothing -> do
637− (fname, mt, bs) <- fetchMediaResource src
638− insertMedia fname mt bs
639− return $ Image attr lab (T.pack fname, tit))
644+ (bs, mt) <- fetchItem src
645+ insertMedia fp mt (BL.fromStrict bs)
646+ return $ Image attr lab (src, tit))
640647 (\e ->
641648 case e of
642649 PandocResourceNotFound _ -> do
src/Text/Pandoc/Data.hs+1−1
@@ -1,7 +1,7 @@
11{-# LANGUAGE TemplateHaskell #-}
22{- |
33Module : Text.Pandoc.Data
4−Copyright : Copyright (C) 2013-2020 John MacFarlane
4+Copyright : Copyright (C) 2013-2021 John MacFarlane
55License : GNU GPL, version 2 or above
66
77Maintainer : John MacFarlane <jgm@berkeley@edu>
src/Text/Pandoc/Error.hs+107−51
@@ -3,51 +3,54 @@
33{-# LANGUAGE OverloadedStrings #-}
44{- |
55 Module : Text.Pandoc.Error
6− Copyright : Copyright (C) 2006-2020 John MacFarlane
6+ Copyright : Copyright (C) 2006-2021 John MacFarlane
77 License : GNU GPL, version 2 or above
88
99 Maintainer : John MacFarlane <jgm@berkeley.edu>
1010 Stability : alpha
1111 Portability : portable
1212
13−This module provides a standard way to deal with possible errors encounted
14−during parsing.
13+This module provides a standard way to deal with possible errors
14+encountered during parsing.
1515
1616-}
1717module Text.Pandoc.Error (
1818 PandocError(..),
19+ renderError,
1920 handleError) where
2021
21−import Control.Exception (Exception)
22+import Control.Exception (Exception, displayException)
2223import Data.Typeable (Typeable)
2324import Data.Word (Word8)
2425import Data.Text (Text)
26+import Data.List (sortOn)
2527import qualified Data.Text as T
28+import Data.Ord (Down(..))
2629import GHC.Generics (Generic)
2730import Network.HTTP.Client (HttpException)
2831import System.Exit (ExitCode (..), exitWith)
2932import System.IO (stderr)
3033import qualified Text.Pandoc.UTF8 as UTF8
34+import Text.Pandoc.Sources (Sources(..))
3135import Text.Printf (printf)
3236import Text.Parsec.Error
3337import Text.Parsec.Pos hiding (Line)
3438import Text.Pandoc.Shared (tshow)
3539import Citeproc (CiteprocError, prettyCiteprocError)
3640
37−type Input = Text
38−
3941data PandocError = PandocIOError Text IOError
4042 | PandocHttpError Text HttpException
4143 | PandocShouldNeverHappenError Text
4244 | PandocSomeError Text
4345 | PandocParseError Text
44− | PandocParsecError Input ParseError
46+ | PandocParsecError Sources ParseError
4547 | PandocMakePDFError Text
4648 | PandocOptionError Text
4749 | PandocSyntaxMapError Text
4850 | PandocFailOnWarningError
4951 | PandocPDFProgramNotFoundError Text
5052 | PandocPDFError Text
53+ | PandocXMLError Text Text
5154 | PandocFilterError Text Text
5255 | PandocLuaError Text
5356 | PandocCouldNotFindDataFileError Text
@@ -58,70 +61,80 @@ data PandocError = PandocIOError Text IOError
5861 | PandocMacroLoop Text
5962 | PandocUTF8DecodingError Text Int Word8
6063 | PandocIpynbDecodingError Text
64+ | PandocUnsupportedCharsetError Text
6165 | PandocUnknownReaderError Text
6266 | PandocUnknownWriterError Text
6367 | PandocUnsupportedExtensionError Text Text
6468 | PandocCiteprocError CiteprocError
69+ | PandocBibliographyError Text Text
6570 deriving (Show, Typeable, Generic)
6671
6772instance Exception PandocError
6873
69−-- | Handle PandocError by exiting with an error message.
70−handleError :: Either PandocError a -> IO a
71−handleError (Right r) = return r
72−handleError (Left e) =
74+renderError :: PandocError -> Text
75+renderError e =
7376 case e of
74− PandocIOError _ err' -> ioError err'
75− PandocHttpError u err' -> err 61 $
77+ PandocIOError _ err' -> T.pack $ displayException err'
78+ PandocHttpError u err' ->
7679 "Could not fetch " <> u <> "\n" <> tshow err'
77− PandocShouldNeverHappenError s -> err 62 $
80+ PandocShouldNeverHappenError s ->
7881 "Something we thought was impossible happened!\n" <>
7982 "Please report this to pandoc's developers: " <> s
80− PandocSomeError s -> err 63 s
81− PandocParseError s -> err 64 s
82− PandocParsecError input err' ->
83+ PandocSomeError s -> s
84+ PandocParseError s -> s
85+ PandocParsecError (Sources inputs) err' ->
8386 let errPos = errorPos err'
8487 errLine = sourceLine errPos
8588 errColumn = sourceColumn errPos
86− ls = T.lines input <> [""]
87− errorInFile = if length ls > errLine - 1
88− then T.concat ["\n", ls !! (errLine - 1)
89− ,"\n", T.replicate (errColumn - 1) " "
90− ,"^"]
91− else ""
92− in err 65 $ "\nError at " <> tshow err' <>
93− -- if error comes from a chunk or included file,
94− -- then we won't get the right text this way:
95− if sourceName errPos == "source"
96− then errorInFile
97− else ""
98− PandocMakePDFError s -> err 66 s
99− PandocOptionError s -> err 6 s
100− PandocSyntaxMapError s -> err 67 s
101− PandocFailOnWarningError -> err 3 "Failing because there were warnings."
102− PandocPDFProgramNotFoundError pdfprog -> err 47 $
89+ errFile = sourceName errPos
90+ errorInFile =
91+ case sortOn (Down . sourceLine . fst)
92+ [ (pos,t)
93+ | (pos,t) <- inputs
94+ , sourceName pos == errFile
95+ , sourceLine pos <= errLine
96+ ] of
97+ [] -> ""
98+ ((pos,txt):_) ->
99+ let ls = T.lines txt <> [""]
100+ ln = (errLine - sourceLine pos) + 1
101+ in if length ls > ln && ln >= 1
102+ then T.concat ["\n", ls !! (ln - 1)
103+ ,"\n", T.replicate (errColumn - 1) " "
104+ ,"^"]
105+ else ""
106+ in "Error at " <> tshow err' <> errorInFile
107+ PandocMakePDFError s -> s
108+ PandocOptionError s -> s
109+ PandocSyntaxMapError s -> s
110+ PandocFailOnWarningError -> "Failing because there were warnings."
111+ PandocPDFProgramNotFoundError pdfprog ->
103112 pdfprog <> " not found. Please select a different --pdf-engine or install " <> pdfprog
104− PandocPDFError logmsg -> err 43 $ "Error producing PDF.\n" <> logmsg
105− PandocFilterError filtername msg -> err 83 $ "Error running filter " <>
113+ PandocPDFError logmsg -> "Error producing PDF.\n" <> logmsg
114+ PandocXMLError fp logmsg -> "Invalid XML" <>
115+ (if T.null fp then "" else " in " <> fp) <> ":\n" <> logmsg
116+ PandocFilterError filtername msg -> "Error running filter " <>
106117 filtername <> ":\n" <> msg
107− PandocLuaError msg -> err 84 $ "Error running Lua:\n" <> msg
108− PandocCouldNotFindDataFileError fn -> err 97 $
118+ PandocLuaError msg -> "Error running Lua:\n" <> msg
119+ PandocCouldNotFindDataFileError fn ->
109120 "Could not find data file " <> fn
110− PandocResourceNotFound fn -> err 99 $
121+ PandocResourceNotFound fn ->
111122 "File " <> fn <> " not found in resource path"
112− PandocTemplateError s -> err 5 $ "Error compiling template " <> s
113− PandocAppError s -> err 4 s
114− PandocEpubSubdirectoryError s -> err 31 $
123+ PandocTemplateError s -> "Error compiling template " <> s
124+ PandocAppError s -> s
125+ PandocEpubSubdirectoryError s ->
115126 "EPUB subdirectory name '" <> s <> "' contains illegal characters"
116− PandocMacroLoop s -> err 91 $
127+ PandocMacroLoop s ->
117128 "Loop encountered in expanding macro " <> s
118− PandocUTF8DecodingError f offset w -> err 92 $
129+ PandocUTF8DecodingError f offset w ->
119130 "UTF-8 decoding error in " <> f <> " at byte offset " <> tshow offset <>
120131 " (" <> T.pack (printf "%2x" w) <> ").\n" <>
121132 "The input must be a UTF-8 encoded text."
122− PandocIpynbDecodingError w -> err 93 $
133+ PandocIpynbDecodingError w ->
123134 "ipynb decoding error: " <> w
124− PandocUnknownReaderError r -> err 21 $
135+ PandocUnsupportedCharsetError charset ->
136+ "Unsupported charset " <> charset
137+ PandocUnknownReaderError r ->
125138 "Unknown input format " <> r <>
126139 case r of
127140 "doc" -> "\nPandoc can convert from DOCX, but not from DOC." <>
@@ -129,23 +142,66 @@ handleError (Left e) =
129142 " and convert that with pandoc."
130143 "pdf" -> "\nPandoc can convert to PDF, but not from PDF."
131144 _ -> ""
132− PandocUnknownWriterError w -> err 22 $
145+ PandocUnknownWriterError w ->
133146 "Unknown output format " <> w <>
134147 case w of
135148 "pdf" -> "To create a pdf using pandoc, use" <>
136149 " -t latex|beamer|context|ms|html5" <>
137150 "\nand specify an output file with " <>
138151 ".pdf extension (-o filename.pdf)."
139− "doc" -> "\nPandoc can convert to DOCX, but not from DOC."
152+ "doc" -> "\nPandoc can convert to DOCX, but not to DOC."
140153 _ -> ""
141− PandocUnsupportedExtensionError ext f -> err 23 $
154+ PandocUnsupportedExtensionError ext f ->
142155 "The extension " <> ext <> " is not supported " <>
143156 "for " <> f
144− PandocCiteprocError e' -> err 24 $
157+ PandocCiteprocError e' ->
145158 prettyCiteprocError e'
159+ PandocBibliographyError fp msg ->
160+ "Error reading bibliography file " <> fp <> ":\n" <> msg
161+
162+
163+-- | Handle PandocError by exiting with an error message.
164+handleError :: Either PandocError a -> IO a
165+handleError (Right r) = return r
166+handleError (Left e) =
167+ case e of
168+ PandocIOError _ err' -> ioError err'
169+ _ -> err exitCode (renderError e)
170+ where
171+ exitCode =
172+ case e of
173+ PandocIOError{} -> 1
174+ PandocHttpError{} -> 61
175+ PandocShouldNeverHappenError{} -> 62
176+ PandocSomeError{} -> 63
177+ PandocParseError{} -> 64
178+ PandocParsecError{} -> 65
179+ PandocMakePDFError{} -> 66
180+ PandocOptionError{} -> 6
181+ PandocSyntaxMapError{} -> 67
182+ PandocFailOnWarningError{} -> 3
183+ PandocPDFProgramNotFoundError{} -> 47
184+ PandocPDFError{} -> 43
185+ PandocXMLError{} -> 44
186+ PandocFilterError{} -> 83
187+ PandocLuaError{} -> 84
188+ PandocCouldNotFindDataFileError{} -> 97
189+ PandocResourceNotFound{} -> 99
190+ PandocTemplateError{} -> 5
191+ PandocAppError{} -> 4
192+ PandocEpubSubdirectoryError{} -> 31
193+ PandocMacroLoop{} -> 91
194+ PandocUTF8DecodingError{} -> 92
195+ PandocIpynbDecodingError{} -> 93
196+ PandocUnsupportedCharsetError{} -> 94
197+ PandocUnknownReaderError{} -> 21
198+ PandocUnknownWriterError{} -> 22
199+ PandocUnsupportedExtensionError{} -> 23
200+ PandocCiteprocError{} -> 24
201+ PandocBibliographyError{} -> 25
146202
147203err :: Int -> Text -> IO a
148204err exitCode msg = do
149− UTF8.hPutStrLn stderr (T.unpack msg)
205+ UTF8.hPutStrLn stderr msg
150206 exitWith $ ExitFailure exitCode
151207 return undefined
src/Text/Pandoc/Extensions.hs+36−7
@@ -6,7 +6,7 @@
66{-# LANGUAGE OverloadedStrings #-}
77{- |
88 Module : Text.Pandoc.Extensions
9− Copyright : Copyright (C) 2012-2020 John MacFarlane
9+ Copyright : Copyright (C) 2012-2021 John MacFarlane
1010 License : GNU GPL, version 2 or above
1111
1212 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -34,6 +34,7 @@ module Text.Pandoc.Extensions ( Extension(..)
3434where
3535import Data.Bits (clearBit, setBit, testBit, (.|.))
3636import Data.Data (Data)
37+import Data.List (foldl')
3738import qualified Data.Text as T
3839import Data.Typeable (Typeable)
3940import GHC.Generics (Generic)
@@ -88,6 +89,7 @@ data Extension =
8889 -- does not affect readers/writers directly; it causes
8990 -- the eastAsianLineBreakFilter to be applied after
9091 -- parsing, in Text.Pandoc.App.convertWithOpts.
92+ | Ext_element_citations -- ^ Use element-citation elements for JATS citations
9193 | Ext_emoji -- ^ Support emoji like :smile:
9294 | Ext_empty_paragraphs -- ^ Allow empty paragraphs
9395 | Ext_epub_html_exts -- ^ Recognise the EPUB extended version of HTML
@@ -134,6 +136,8 @@ data Extension =
134136 | Ext_raw_html -- ^ Allow raw HTML
135137 | Ext_raw_tex -- ^ Allow raw TeX (other than math)
136138 | Ext_raw_markdown -- ^ Parse markdown in ipynb as raw markdown
139+ | Ext_rebase_relative_paths -- ^ Rebase relative image and link paths,
140+ -- relative to directory of containing file
137141 | Ext_shortcut_reference_links -- ^ Shortcut reference links
138142 | Ext_simple_tables -- ^ Pandoc-style simple tables
139143 | Ext_smart -- ^ "Smart" quotes, apostrophes, ellipses, dashes
@@ -149,9 +153,12 @@ data Extension =
149153 | Ext_tex_math_dollars -- ^ TeX math between $..$ or $$..$$
150154 | Ext_tex_math_double_backslash -- ^ TeX math btw \\(..\\) \\[..\\]
151155 | Ext_tex_math_single_backslash -- ^ TeX math btw \(..\) \[..\]
156+ | Ext_xrefs_name -- ^ Use xrefs with names
157+ | Ext_xrefs_number -- ^ Use xrefs with numbers
152158 | Ext_yaml_metadata_block -- ^ YAML metadata block
153159 | Ext_gutenberg -- ^ Use Project Gutenberg conventions for plain
154160 | Ext_attributes -- ^ Generic attribute syntax
161+ | Ext_sourcepos -- ^ Include source position attributes
155162 deriving (Show, Read, Enum, Eq, Ord, Bounded, Data, Typeable, Generic)
156163
157164-- | Extensions to be used with pandoc-flavored markdown.
@@ -349,13 +356,14 @@ getDefaultExtensions "gfm" = extensionsFromList
349356 , Ext_strikeout
350357 , Ext_task_lists
351358 , Ext_emoji
359+ , Ext_yaml_metadata_block
352360 ]
353361getDefaultExtensions "commonmark" = extensionsFromList
354362 [Ext_raw_html]
355363getDefaultExtensions "commonmark_x" = extensionsFromList
356364 [ Ext_pipe_tables
357365 , Ext_raw_html
358− , Ext_auto_identifiers
366+ , Ext_gfm_auto_identifiers
359367 , Ext_strikeout
360368 , Ext_task_lists
361369 , Ext_emoji
@@ -374,10 +382,11 @@ getDefaultExtensions "commonmark_x" = extensionsFromList
374382 , Ext_raw_attribute
375383 , Ext_implicit_header_references
376384 , Ext_attributes
377− , Ext_fenced_code_attributes
385+ , Ext_yaml_metadata_block
378386 ]
379387getDefaultExtensions "org" = extensionsFromList
380388 [Ext_citations,
389+ Ext_task_lists,
381390 Ext_auto_identifiers]
382391getDefaultExtensions "html" = extensionsFromList
383392 [Ext_auto_identifiers,
@@ -409,6 +418,11 @@ getDefaultExtensions "textile" = extensionsFromList
409418 Ext_smart,
410419 Ext_raw_html,
411420 Ext_auto_identifiers]
421+getDefaultExtensions "jats" = extensionsFromList
422+ [Ext_auto_identifiers]
423+getDefaultExtensions "jats_archiving" = getDefaultExtensions "jats"
424+getDefaultExtensions "jats_publishing" = getDefaultExtensions "jats"
425+getDefaultExtensions "jats_articleauthoring" = getDefaultExtensions "jats"
412426getDefaultExtensions "opml" = pandocExtensions -- affects notes
413427getDefaultExtensions _ = extensionsFromList
414428 [Ext_auto_identifiers]
@@ -450,6 +464,7 @@ getAllExtensions f = universalExtensions <> getAll f
450464 , Ext_gutenberg
451465 , Ext_smart
452466 , Ext_literate_haskell
467+ , Ext_rebase_relative_paths
453468 ]
454469 getAll "markdown_strict" = allMarkdownExtensions
455470 getAll "markdown_phpextra" = allMarkdownExtensions
@@ -465,6 +480,8 @@ getAllExtensions f = universalExtensions <> getAll f
465480 getAll "opendocument" = extensionsFromList
466481 [ Ext_empty_paragraphs
467482 , Ext_native_numbering
483+ , Ext_xrefs_name
484+ , Ext_xrefs_number
468485 ]
469486 getAll "odt" = getAll "opendocument" <> autoIdExtensions
470487 getAll "muse" = autoIdExtensions <>
@@ -474,9 +491,10 @@ getAllExtensions f = universalExtensions <> getAll f
474491 getAll "plain" = allMarkdownExtensions
475492 getAll "gfm" = getAll "commonmark"
476493 getAll "commonmark" =
477− autoIdExtensions <>
478494 extensionsFromList
479− [ Ext_pipe_tables
495+ [ Ext_gfm_auto_identifiers
496+ , Ext_ascii_identifiers
497+ , Ext_pipe_tables
480498 , Ext_autolink_bare_uris
481499 , Ext_strikeout
482500 , Ext_task_lists
@@ -497,13 +515,16 @@ getAllExtensions f = universalExtensions <> getAll f
497515 , Ext_raw_attribute
498516 , Ext_implicit_header_references
499517 , Ext_attributes
500− , Ext_fenced_code_attributes
518+ , Ext_sourcepos
519+ , Ext_yaml_metadata_block
520+ , Ext_rebase_relative_paths
501521 ]
502522 getAll "commonmark_x" = getAll "commonmark"
503523 getAll "org" = autoIdExtensions <>
504524 extensionsFromList
505525 [ Ext_citations
506526 , Ext_smart
527+ , Ext_task_lists
507528 ]
508529 getAll "html" = autoIdExtensions <>
509530 extensionsFromList
@@ -547,6 +568,14 @@ getAllExtensions f = universalExtensions <> getAll f
547568 , Ext_smart
548569 , Ext_raw_tex
549570 ]
571+ getAll "jats" =
572+ extensionsFromList
573+ [ Ext_auto_identifiers
574+ , Ext_element_citations
575+ ]
576+ getAll "jats_archiving" = getAll "jats"
577+ getAll "jats_publishing" = getAll "jats"
578+ getAll "jats_articleauthoring" = getAll "jats"
550579 getAll "opml" = allMarkdownExtensions -- affects notes
551580 getAll "twiki" = autoIdExtensions <>
552581 extensionsFromList
@@ -572,7 +601,7 @@ parseFormatSpec :: T.Text
572601parseFormatSpec = parse formatSpec ""
573602 where formatSpec = do
574603 name <- formatName
575− (extsToEnable, extsToDisable) <- foldl (flip ($)) ([],[]) <$>
604+ (extsToEnable, extsToDisable) <- foldl' (flip ($)) ([],[]) <$>
576605 many extMod
577606 return (T.pack name, reverse extsToEnable, reverse extsToDisable)
578607 formatName = many1 $ noneOf "-+"
src/Text/Pandoc/Filter.hs+6−4
@@ -4,7 +4,7 @@
44{-# LANGUAGE OverloadedStrings #-}
55{- |
66 Module : Text.Pandoc.Filter
7− Copyright : Copyright (C) 2006-2020 John MacFarlane
7+ Copyright : Copyright (C) 2006-2021 John MacFarlane
88 License : GNU GPL, version 2 or above
99
1010 Maintainer : John MacFarlane <jgm@berkeley@edu>
@@ -47,11 +47,13 @@ instance FromYAML Filter where
4747 parseYAML node =
4848 (withMap "Filter" $ \m -> do
4949 ty <- m .: "type"
50− fp <- m .: "path"
50+ fp <- m .:? "path"
51+ let missingPath = fail $ "Expected 'path' for filter of type " ++ show ty
52+ let filterWithPath constr = maybe missingPath (return . constr . T.unpack)
5153 case ty of
5254 "citeproc" -> return CiteprocFilter
53− "lua" -> return $ LuaFilter $ T.unpack fp
54− "json" -> return $ JSONFilter $ T.unpack fp
55+ "lua" -> filterWithPath LuaFilter fp
56+ "json" -> filterWithPath JSONFilter fp
5557 _ -> fail $ "Unknown filter type " ++ show (ty :: T.Text)) node
5658 <|>
5759 (withStr "Filter" $ \t -> do
src/Text/Pandoc/Filter/JSON.hs+1−1
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.Filter
4− Copyright : Copyright (C) 2006-2020 John MacFarlane
4+ Copyright : Copyright (C) 2006-2021 John MacFarlane
55 License : GNU GPL, version 2 or above
66
77 Maintainer : John MacFarlane <jgm@berkeley@edu>
src/Text/Pandoc/Filter/Lua.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Filter.Lua
3− Copyright : Copyright (C) 2006-2020 John MacFarlane
3+ Copyright : Copyright (C) 2006-2021 John MacFarlane
44 License : GNU GPL, version 2 or above
55
66 Maintainer : John MacFarlane <jgm@berkeley@edu>
src/Text/Pandoc/Filter/Path.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Filter.Path
3− Copyright : Copyright (C) 2006-2020 John MacFarlane
3+ Copyright : Copyright (C) 2006-2021 John MacFarlane
44 License : GNU GPL, version 2 or above
55
66 Maintainer : John MacFarlane <jgm@berkeley@edu>
src/Text/Pandoc/Highlighting.hs+6−6
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.Highlighting
4− Copyright : Copyright (C) 2008-2020 John MacFarlane
4+ Copyright : Copyright (C) 2008-2021 John MacFarlane
55 License : GNU GPL, version 2 or above
66
77 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -52,12 +52,12 @@ highlightingStyles =
5252 ("breezedark", breezeDark),
5353 ("haddock", haddock)]
5454
55−languages :: [T.Text]
56−languages = [T.toLower (sName s) | s <- M.elems defaultSyntaxMap]
55+languages :: SyntaxMap -> [T.Text]
56+languages syntaxmap = [T.toLower (sName s) | s <- M.elems syntaxmap]
5757
58−languagesByExtension :: T.Text -> [T.Text]
59−languagesByExtension ext =
60− [T.toLower (sName s) | s <- syntaxesByExtension defaultSyntaxMap (T.unpack ext)]
58+languagesByExtension :: SyntaxMap -> T.Text -> [T.Text]
59+languagesByExtension syntaxmap ext =
60+ [T.toLower (sName s) | s <- syntaxesByExtension syntaxmap (T.unpack ext)]
6161
6262highlight :: SyntaxMap
6363 -> (FormatOptions -> [SourceLine] -> a) -- ^ Formatter
src/Text/Pandoc/Image.hs+1−1
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, CPP #-}
22{- |
33Module : Text.Pandoc.Image
4−Copyright : Copyright (C) 2020 John MacFarlane
4+Copyright : Copyright (C) 2020-2021 John MacFarlane
55License : GNU GPL, version 2 or above
66
77Maintainer : John MacFarlane <jgm@berkeley.edu>
src/Text/Pandoc/ImageSize.hs+61−341
@@ -1,9 +1,9 @@
1−{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, CPP #-}
1+{-# LANGUAGE OverloadedStrings, ScopedTypeVariables #-}
22{-# LANGUAGE ViewPatterns #-}
33{-# OPTIONS_GHC -fno-warn-type-defaults #-}
44{- |
55Module : Text.Pandoc.ImageSize
6−Copyright : Copyright (C) 2011-2020 John MacFarlane
6+Copyright : Copyright (C) 2011-2021 John MacFarlane
77License : GNU GPL, version 2 or above
88
99Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -32,33 +32,33 @@ module Text.Pandoc.ImageSize ( ImageType(..)
3232 , showInPixel
3333 , showFl
3434 ) where
35−import Data.ByteString (ByteString, unpack)
35+import Data.ByteString (ByteString)
3636import qualified Data.ByteString.Char8 as B
3737import qualified Data.ByteString.Lazy as BL
38+import Data.Binary.Get
3839import Data.Char (isDigit)
3940import Control.Monad
40−import Data.Bits
41−import Data.Binary
42−import Data.Binary.Get
4341import Text.Pandoc.Shared (safeRead)
4442import Data.Default (Default)
4543import Numeric (showFFloat)
4644import Text.Pandoc.Definition
4745import Text.Pandoc.Options
4846import qualified Text.Pandoc.UTF8 as UTF8
49−import qualified Text.XML.Light as Xml
50−import qualified Data.Map as M
47+import Text.Pandoc.XML.Light hiding (Attr)
5148import qualified Data.Text as T
49+import qualified Data.Text.Lazy as TL
5250import qualified Data.Text.Encoding as TE
53−import Control.Monad.Except
5451import Control.Applicative
55−import Data.Maybe (fromMaybe)
5652import qualified Data.Attoparsec.ByteString.Char8 as A
53+import qualified Codec.Picture.Metadata as Metadata
54+import qualified Codec.Picture.Metadata.Exif as Exif
55+import Codec.Picture (decodeImageWithMetadata)
5756
5857-- quick and dirty functions to get image sizes
5958-- algorithms borrowed from wwwis.pl
6059
61−data ImageType = Png | Gif | Jpeg | Svg | Pdf | Eps | Emf deriving Show
60+data ImageType = Png | Gif | Jpeg | Svg | Pdf | Eps | Emf | Tiff
61+ deriving Show
6262data Direction = Width | Height
6363instance Show Direction where
6464 show Width = "width"
@@ -101,6 +101,8 @@ imageType :: ByteString -> Maybe ImageType
101101imageType img = case B.take 4 img of
102102 "\x89\x50\x4e\x47" -> return Png
103103 "\x47\x49\x46\x38" -> return Gif
104+ "\x49\x49\x2a\x00" -> return Tiff
105+ "\x4D\x4D\x00\x2a" -> return Tiff
104106 "\xff\xd8\xff\xe0" -> return Jpeg -- JFIF
105107 "\xff\xd8\xff\xe1" -> return Jpeg -- Exif
106108 "%PDF" -> return Pdf
@@ -120,11 +122,12 @@ findSvgTag :: ByteString -> Bool
120122findSvgTag img = "<svg" `B.isInfixOf` img || "<SVG" `B.isInfixOf` img
121123
122124imageSize :: WriterOptions -> ByteString -> Either T.Text ImageSize
123−imageSize opts img =
125+imageSize opts img = checkDpi <$>
124126 case imageType img of
125− Just Png -> mbToEither "could not determine PNG size" $ pngSize img
126− Just Gif -> mbToEither "could not determine GIF size" $ gifSize img
127− Just Jpeg -> jpegSize img
127+ Just Png -> getSize img
128+ Just Gif -> getSize img
129+ Just Jpeg -> getSize img
130+ Just Tiff -> getSize img
128131 Just Svg -> mbToEither "could not determine SVG size" $ svgSize opts img
129132 Just Eps -> mbToEither "could not determine EPS size" $ epsSize img
130133 Just Pdf -> mbToEither "could not determine PDF size" $ pdfSize img
@@ -132,9 +135,12 @@ imageSize opts img =
132135 Nothing -> Left "could not determine image type"
133136 where mbToEither msg Nothing = Left msg
134137 mbToEither _ (Just x) = Right x
138+ -- see #6880, some defective JPEGs may encode dpi 0, so default to 72
139+ -- if that value is 0
140+ checkDpi size =
141+ size{ dpiX = if dpiX size == 0 then 72 else dpiX size
142+ , dpiY = if dpiY size == 0 then 72 else dpiY size }
135143
136−defaultSize :: (Integer, Integer)
137−defaultSize = (72, 72)
138144
139145sizeInPixels :: ImageSize -> (Integer, Integer)
140146sizeInPixels s = (pxX s, pxY s)
@@ -294,59 +300,50 @@ pPdfSize = do
294300 , dpiY = 72 }
295301 ) <|> pPdfSize
296302
297−pngSize :: ByteString -> Maybe ImageSize
298−pngSize img = do
299− let (h, rest) = B.splitAt 8 img
300− guard $ h == "\x8a\x4d\x4e\x47\x0d\x0a\x1a\x0a" ||
301− h == "\x89\x50\x4e\x47\x0d\x0a\x1a\x0a"
302− let (i, rest') = B.splitAt 4 $ B.drop 4 rest
303− guard $ i == "MHDR" || i == "IHDR"
304− let (sizes, rest'') = B.splitAt 8 rest'
305− (x,y) <- case map fromIntegral $unpack sizes of
306− ([w1,w2,w3,w4,h1,h2,h3,h4] :: [Integer]) -> return
307− (shift w1 24 + shift w2 16 + shift w3 8 + w4,
308− shift h1 24 + shift h2 16 + shift h3 8 + h4)
309− _ -> Nothing -- "PNG parse error"
310− (dpix, dpiy) <- findpHYs rest''
311− return ImageSize { pxX = x, pxY = y, dpiX = dpix, dpiY = dpiy }
312−
313−findpHYs :: ByteString -> Maybe (Integer, Integer)
314−findpHYs x
315− | B.null x || "IDAT" `B.isPrefixOf` x = return (72,72)
316− | "pHYs" `B.isPrefixOf` x =
317− case map fromIntegral $ unpack $ B.take 9 $ B.drop 4 x of
318− [x1,x2,x3,x4,y1,y2,y3,y4,u] -> do
319− let factor = if u == 1 -- dots per meter
320− then \z -> z * 254 `div` 10000
321− else const 72
322− return
323− ( factor $ shift x1 24 + shift x2 16 + shift x3 8 + x4,
324− factor $ shift y1 24 + shift y2 16 + shift y3 8 + y4 )
325− _ -> mzero
326− | otherwise = findpHYs $ B.drop 1 x -- read another byte
327−
328−gifSize :: ByteString -> Maybe ImageSize
329−gifSize img = do
330− let (h, rest) = B.splitAt 6 img
331− guard $ h == "GIF87a" || h == "GIF89a"
332− case map fromIntegral $ unpack $ B.take 4 rest of
333− [w2,w1,h2,h1] -> return ImageSize {
334− pxX = shift w1 8 + w2,
335− pxY = shift h1 8 + h2,
336− dpiX = 72,
337− dpiY = 72
338− }
339− _ -> Nothing -- "GIF parse error"
303+getSize :: ByteString -> Either T.Text ImageSize
304+getSize img =
305+ case decodeImageWithMetadata img of
306+ Left e -> Left (T.pack e)
307+ Right (_, meta) -> do
308+ pxx <- maybe (Left "Could not determine width") Right $
309+ -- first look for exif image width, then width
310+ (Metadata.lookup
311+ (Metadata.Exif (Exif.TagUnknown 0xA002)) meta >>=
312+ exifDataToWord) <|>
313+ Metadata.lookup Metadata.Width meta
314+ pxy <- maybe (Left "Could not determine height") Right $
315+ -- first look for exif image height, then height
316+ (Metadata.lookup
317+ (Metadata.Exif (Exif.TagUnknown 0xA003)) meta >>=
318+ exifDataToWord) <|>
319+ Metadata.lookup Metadata.Height meta
320+ dpix <- maybe (Right 72) Right $ Metadata.lookup Metadata.DpiX meta
321+ dpiy <- maybe (Right 72) Right $ Metadata.lookup Metadata.DpiY meta
322+ return $ ImageSize
323+ { pxX = fromIntegral pxx
324+ , pxY = fromIntegral pxy
325+ , dpiX = fromIntegral dpix
326+ , dpiY = fromIntegral dpiy }
327+ where
328+ exifDataToWord (Exif.ExifLong x) = Just $ fromIntegral x
329+ exifDataToWord (Exif.ExifShort x) = Just $ fromIntegral x
330+ exifDataToWord _ = Nothing
331+
340332
341333svgSize :: WriterOptions -> ByteString -> Maybe ImageSize
342334svgSize opts img = do
343− doc <- Xml.parseXMLDoc $ UTF8.toString img
335+ doc <- either (const mzero) return $ parseXMLElement
336+ $ TL.fromStrict $ UTF8.toText img
337+ let viewboxSize = do
338+ vb <- findAttrBy (== QName "viewBox" Nothing Nothing) doc
339+ [_,_,w,h] <- mapM safeRead (T.words vb)
340+ return (w,h)
344341 let dpi = fromIntegral $ writerDpi opts
345342 let dirToInt dir = do
346− dim <- Xml.findAttrBy (== Xml.QName dir Nothing Nothing) doc >>= lengthToDim . T.pack
343+ dim <- findAttrBy (== QName dir Nothing Nothing) doc >>= lengthToDim
347344 return $ inPixel opts dim
348− w <- dirToInt "width"
349− h <- dirToInt "height"
345+ w <- dirToInt "width" <|> (fst <$> viewboxSize)
346+ h <- dirToInt "height" <|> (snd <$> viewboxSize)
350347 return ImageSize {
351348 pxX = w
352349 , pxY = h
@@ -384,280 +381,3 @@ emfSize img =
384381 case parseheader . BL.fromStrict $ img of
385382 Left _ -> Nothing
386383 Right (_, _, size) -> Just size
387−
388−
389−jpegSize :: ByteString -> Either T.Text ImageSize
390−jpegSize img =
391− let (hdr, rest) = B.splitAt 4 img
392− in if B.length rest < 14
393− then Left "unable to determine JPEG size"
394− else case hdr of
395− "\xff\xd8\xff\xe0" -> jfifSize rest
396− "\xff\xd8\xff\xe1" -> exifSize rest
397− _ -> Left "unable to determine JPEG size"
398−
399−jfifSize :: ByteString -> Either T.Text ImageSize
400−jfifSize rest =
401− case map fromIntegral $ unpack $ B.take 5 $ B.drop 9 rest of
402− [dpiDensity,dpix1,dpix2,dpiy1,dpiy2] ->
403− let factor = case dpiDensity of
404− 1 -> id
405− 2 -> \x -> x * 254 `div` 10
406− _ -> const 72
407− dpix = factor (shift dpix1 8 + dpix2)
408− dpiy = factor (shift dpiy1 8 + dpiy2)
409− in case findJfifSize rest of
410− Left msg -> Left msg
411− Right (w,h) -> Right ImageSize { pxX = w
412− , pxY = h
413− , dpiX = dpix
414− , dpiY = dpiy }
415− _ -> Left "unable to determine JFIF size"
416−
417−findJfifSize :: ByteString -> Either T.Text (Integer,Integer)
418−findJfifSize bs =
419− let bs' = B.dropWhile (=='\xff') $ B.dropWhile (/='\xff') bs
420− in case B.uncons bs' of
421− Just (c,bs'') | c >= '\xc0' && c <= '\xc3' ->
422− case map fromIntegral $ unpack $ B.take 4 $ B.drop 3 bs'' of
423− [h1,h2,w1,w2] -> Right (shift w1 8 + w2, shift h1 8 + h2)
424− _ -> Left "JFIF parse error"
425− Just (_,bs'') ->
426− case map fromIntegral $ unpack $ B.take 2 bs'' of
427− [c1,c2] ->
428− let len = shift c1 8 + c2
429− -- skip variables
430− in findJfifSize $ B.drop len bs''
431− _ -> Left "JFIF parse error"
432− Nothing -> Left "Did not find JFIF length record"
433−
434−runGet' :: Get (Either T.Text a) -> BL.ByteString -> Either T.Text a
435−runGet' p bl =
436−#if MIN_VERSION_binary(0,7,0)
437− case runGetOrFail p bl of
438− Left (_,_,msg) -> Left $ T.pack msg
439− Right (_,_,x) -> x
440−#else
441− runGet p bl
442−#endif
443−
444−exifSize :: ByteString -> Either T.Text ImageSize
445−exifSize bs = runGet' header bl
446− where bl = BL.fromChunks [bs]
447− header = runExceptT $ exifHeader bl
448−-- NOTE: It would be nicer to do
449−-- runGet ((Just <$> exifHeader) <|> return Nothing)
450−-- which would prevent pandoc from raising an error when an exif header can't
451−-- be parsed. But we only get an Alternative instance for Get in binary 0.6,
452−-- and binary 0.5 ships with ghc 7.6.
453−
454−exifHeader :: BL.ByteString -> ExceptT T.Text Get ImageSize
455−exifHeader hdr = do
456− _app1DataSize <- lift getWord16be
457− exifHdr <- lift getWord32be
458− unless (exifHdr == 0x45786966) $ throwError "Did not find exif header"
459− zeros <- lift getWord16be
460− unless (zeros == 0) $ throwError "Expected zeros after exif header"
461− -- beginning of tiff header -- we read whole thing to use
462− -- in getting data from offsets:
463− let tiffHeader = BL.drop 8 hdr
464− byteAlign <- lift getWord16be
465− let bigEndian = byteAlign == 0x4d4d
466− let (getWord16, getWord32, getWord64) =
467− if bigEndian
468− then (getWord16be, getWord32be, getWord64be)
469− else (getWord16le, getWord32le, getWord64le)
470− let getRational = do
471− num <- getWord32
472− den <- getWord32
473− return $ fromIntegral num / fromIntegral den
474− tagmark <- lift getWord16
475− unless (tagmark == 0x002a) $ throwError "Failed alignment sanity check"
476− ifdOffset <- lift getWord32
477− lift $ skip (fromIntegral ifdOffset - 8) -- skip to IDF
478− numentries <- lift getWord16
479− let ifdEntry :: ExceptT T.Text Get (TagType, DataFormat)
480− ifdEntry = do
481− tag <- fromMaybe UnknownTagType . flip M.lookup tagTypeTable
482− <$> lift getWord16
483− dataFormat <- lift getWord16
484− numComponents <- lift getWord32
485− (fmt, bytesPerComponent) <-
486− case dataFormat of
487− 1 -> return (UnsignedByte <$> getWord8, 1)
488− 2 -> return (AsciiString <$>
489− getLazyByteString
490− (fromIntegral numComponents), 1)
491− 3 -> return (UnsignedShort <$> getWord16, 2)
492− 4 -> return (UnsignedLong <$> getWord32, 4)
493− 5 -> return (UnsignedRational <$> getRational, 8)
494− 6 -> return (SignedByte <$> getWord8, 1)
495− 7 -> return (Undefined <$> getLazyByteString
496− (fromIntegral numComponents), 1)
497− 8 -> return (SignedShort <$> getWord16, 2)
498− 9 -> return (SignedLong <$> getWord32, 4)
499− 10 -> return (SignedRational <$> getRational, 8)
500− 11 -> return (SingleFloat <$> getWord32 {- TODO -}, 4)
501− 12 -> return (DoubleFloat <$> getWord64 {- TODO -}, 8)
502− _ -> throwError $ "Unknown data format " <> T.pack (show dataFormat)
503− let totalBytes = fromIntegral $ numComponents * bytesPerComponent
504− payload <- if totalBytes <= 4 -- data is right here
505− then lift $ fmt <* skip (4 - totalBytes)
506− else do -- get data from offset
507− offs <- lift getWord32
508− let bytesAtOffset =
509− BL.take (fromIntegral totalBytes)
510− $ BL.drop (fromIntegral offs) tiffHeader
511− case runGet' (Right <$> fmt) bytesAtOffset of
512− Left msg -> throwError msg
513− Right x -> return x
514− return (tag, payload)
515− entries <- replicateM (fromIntegral numentries) ifdEntry
516− subentries <- case lookup ExifOffset entries of
517− Just (UnsignedLong offset') -> do
518− pos <- lift bytesRead
519− lift $ skip (fromIntegral offset' - (fromIntegral pos - 8))
520− numsubentries <- lift getWord16
521− replicateM (fromIntegral numsubentries) ifdEntry
522− _ -> return []
523− let allentries = entries ++ subentries
524− (wdth, hght) <- case (lookup ExifImageWidth allentries,
525− lookup ExifImageHeight allentries) of
526− (Just (UnsignedLong w), Just (UnsignedLong h)) ->
527− return (fromIntegral w, fromIntegral h)
528− _ -> return defaultSize
529− -- we return a default width and height when
530− -- the exif header doesn't contain these
531− let resfactor = case lookup ResolutionUnit allentries of
532− Just (UnsignedShort 1) -> 100 / 254
533− _ -> 1
534− let xres = case lookup XResolution allentries of
535− Just (UnsignedRational x) -> floor (x * resfactor)
536− _ -> 72
537− let yres = case lookup YResolution allentries of
538− Just (UnsignedRational y) -> floor (y * resfactor)
539− _ -> 72
540− return ImageSize{
541− pxX = wdth
542− , pxY = hght
543− , dpiX = xres
544− , dpiY = yres }
545−
546−data DataFormat = UnsignedByte Word8
547− | AsciiString BL.ByteString
548− | UnsignedShort Word16
549− | UnsignedLong Word32
550− | UnsignedRational Rational
551− | SignedByte Word8
552− | Undefined BL.ByteString
553− | SignedShort Word16
554− | SignedLong Word32
555− | SignedRational Rational
556− | SingleFloat Word32
557− | DoubleFloat Word64
558− deriving (Show)
559−
560−data TagType = ImageDescription
561− | Make
562− | Model
563− | Orientation
564− | XResolution
565− | YResolution
566− | ResolutionUnit
567− | Software
568− | DateTime
569− | WhitePoint
570− | PrimaryChromaticities
571− | YCbCrCoefficients
572− | YCbCrPositioning
573− | ReferenceBlackWhite
574− | Copyright
575− | ExifOffset
576− | ExposureTime
577− | FNumber
578− | ExposureProgram
579− | ISOSpeedRatings
580− | ExifVersion
581− | DateTimeOriginal
582− | DateTimeDigitized
583− | ComponentConfiguration
584− | CompressedBitsPerPixel
585− | ShutterSpeedValue
586− | ApertureValue
587− | BrightnessValue
588− | ExposureBiasValue
589− | MaxApertureValue
590− | SubjectDistance
591− | MeteringMode
592− | LightSource
593− | Flash
594− | FocalLength
595− | MakerNote
596− | UserComment
597− | FlashPixVersion
598− | ColorSpace
599− | ExifImageWidth
600− | ExifImageHeight
601− | RelatedSoundFile
602− | ExifInteroperabilityOffset
603− | FocalPlaneXResolution
604− | FocalPlaneYResolution
605− | FocalPlaneResolutionUnit
606− | SensingMethod
607− | FileSource
608− | SceneType
609− | UnknownTagType
610− deriving (Show, Eq, Ord)
611−
612−tagTypeTable :: M.Map Word16 TagType
613−tagTypeTable = M.fromList
614− [ (0x010e, ImageDescription)
615− , (0x010f, Make)
616− , (0x0110, Model)
617− , (0x0112, Orientation)
618− , (0x011a, XResolution)
619− , (0x011b, YResolution)
620− , (0x0128, ResolutionUnit)
621− , (0x0131, Software)
622− , (0x0132, DateTime)
623− , (0x013e, WhitePoint)
624− , (0x013f, PrimaryChromaticities)
625− , (0x0211, YCbCrCoefficients)
626− , (0x0213, YCbCrPositioning)
627− , (0x0214, ReferenceBlackWhite)
628− , (0x8298, Copyright)
629− , (0x8769, ExifOffset)
630− , (0x829a, ExposureTime)
631− , (0x829d, FNumber)
632− , (0x8822, ExposureProgram)
633− , (0x8827, ISOSpeedRatings)
634− , (0x9000, ExifVersion)
635− , (0x9003, DateTimeOriginal)
636− , (0x9004, DateTimeDigitized)
637− , (0x9101, ComponentConfiguration)
638− , (0x9102, CompressedBitsPerPixel)
639− , (0x9201, ShutterSpeedValue)
640− , (0x9202, ApertureValue)
641− , (0x9203, BrightnessValue)
642− , (0x9204, ExposureBiasValue)
643− , (0x9205, MaxApertureValue)
644− , (0x9206, SubjectDistance)
645− , (0x9207, MeteringMode)
646− , (0x9208, LightSource)
647− , (0x9209, Flash)
648− , (0x920a, FocalLength)
649− , (0x927c, MakerNote)
650− , (0x9286, UserComment)
651− , (0xa000, FlashPixVersion)
652− , (0xa001, ColorSpace)
653− , (0xa002, ExifImageWidth)
654− , (0xa003, ExifImageHeight)
655− , (0xa004, RelatedSoundFile)
656− , (0xa005, ExifInteroperabilityOffset)
657− , (0xa20e, FocalPlaneXResolution)
658− , (0xa20f, FocalPlaneYResolution)
659− , (0xa210, FocalPlaneResolutionUnit)
660− , (0xa217, SensingMethod)
661− , (0xa300, FileSource)
662− , (0xa301, SceneType)
663− ]
src/Text/Pandoc/Logging.hs+82−46
@@ -4,7 +4,7 @@
44{-# LANGUAGE OverloadedStrings #-}
55{- |
66 Module : Text.Pandoc.Logging
7− Copyright : Copyright (C) 2006-2020 John MacFarlane
7+ Copyright : Copyright (C) 2006-2021 John MacFarlane
88 License : GNU GPL, version 2 or above
99
1010 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -31,10 +31,12 @@ import Data.Aeson.Encode.Pretty (Config (..), defConfig, encodePretty',
3131import qualified Data.ByteString.Lazy as BL
3232import Data.Data (Data, toConstr)
3333import qualified Data.Text as Text
34+import Data.Text (Text)
3435import Data.Typeable (Typeable)
3536import GHC.Generics (Generic)
3637import Text.Pandoc.Definition
3738import Text.Parsec.Pos
39+import Text.Pandoc.Shared (tshow)
3840
3941-- | Verbosity level.
4042data Verbosity = ERROR | WARNING | INFO
@@ -59,45 +61,49 @@ instance FromYAML Verbosity where
5961 _ -> mzero
6062
6163data LogMessage =
62− SkippedContent Text.Text SourcePos
63− | IgnoredElement Text.Text
64− | DuplicateLinkReference Text.Text SourcePos
65− | DuplicateNoteReference Text.Text SourcePos
66− | NoteDefinedButNotUsed Text.Text SourcePos
67− | DuplicateIdentifier Text.Text SourcePos
68− | ReferenceNotFound Text.Text SourcePos
69− | CircularReference Text.Text SourcePos
70− | UndefinedToggle Text.Text SourcePos
71− | ParsingUnescaped Text.Text SourcePos
72− | CouldNotLoadIncludeFile Text.Text SourcePos
73− | MacroAlreadyDefined Text.Text SourcePos
64+ SkippedContent Text SourcePos
65+ | IgnoredElement Text
66+ | DuplicateLinkReference Text SourcePos
67+ | DuplicateNoteReference Text SourcePos
68+ | NoteDefinedButNotUsed Text SourcePos
69+ | DuplicateIdentifier Text SourcePos
70+ | ReferenceNotFound Text SourcePos
71+ | CircularReference Text SourcePos
72+ | UndefinedToggle Text SourcePos
73+ | ParsingUnescaped Text SourcePos
74+ | CouldNotLoadIncludeFile Text SourcePos
75+ | MacroAlreadyDefined Text SourcePos
7476 | InlineNotRendered Inline
7577 | BlockNotRendered Block
76− | DocxParserWarning Text.Text
77− | IgnoredIOError Text.Text
78− | CouldNotFetchResource Text.Text Text.Text
79− | CouldNotDetermineImageSize Text.Text Text.Text
80− | CouldNotConvertImage Text.Text Text.Text
81− | CouldNotDetermineMimeType Text.Text
82− | CouldNotConvertTeXMath Text.Text Text.Text
83− | CouldNotParseCSS Text.Text
84− | Fetching Text.Text
85− | Extracting Text.Text
86− | NoTitleElement Text.Text
78+ | DocxParserWarning Text
79+ | IgnoredIOError Text
80+ | CouldNotFetchResource Text Text
81+ | CouldNotDetermineImageSize Text Text
82+ | CouldNotConvertImage Text Text
83+ | CouldNotDetermineMimeType Text
84+ | CouldNotConvertTeXMath Text Text
85+ | CouldNotParseCSS Text
86+ | Fetching Text
87+ | Extracting Text
88+ | LoadedResource FilePath FilePath
89+ | NoTitleElement Text
8790 | NoLangSpecified
88− | InvalidLang Text.Text
89− | CouldNotHighlight Text.Text
90− | MissingCharacter Text.Text
91− | Deprecated Text.Text Text.Text
92− | NoTranslation Text.Text
93− | CouldNotLoadTranslations Text.Text Text.Text
94− | UnusualConversion Text.Text
95− | UnexpectedXmlElement Text.Text Text.Text
96− | UnknownOrgExportOption Text.Text
97− | CouldNotDeduceFormat [Text.Text] Text.Text
91+ | InvalidLang Text
92+ | CouldNotHighlight Text
93+ | MissingCharacter Text
94+ | Deprecated Text Text
95+ | NoTranslation Text
96+ | CouldNotLoadTranslations Text Text
97+ | UnusualConversion Text
98+ | UnexpectedXmlElement Text Text
99+ | UnknownOrgExportOption Text
100+ | CouldNotDeduceFormat [Text] Text
98101 | RunningFilter FilePath
99102 | FilterCompleted FilePath Integer
100− | CiteprocWarning Text.Text
103+ | CiteprocWarning Text
104+ | ATXHeadingInLHS Int Text
105+ | EnvironmentVariableUndefined Text
106+ | DuplicateAttribute Text Text
101107 deriving (Show, Eq, Data, Ord, Typeable, Generic)
102108
103109instance ToJSON LogMessage where
@@ -190,6 +196,9 @@ instance ToJSON LogMessage where
190196 ["path" .= fp]
191197 Extracting fp ->
192198 ["path" .= fp]
199+ LoadedResource orig found ->
200+ ["for" .= orig
201+ ,"from" .= found]
193202 NoTitleElement fallback ->
194203 ["fallback" .= fallback]
195204 NoLangSpecified -> []
@@ -224,13 +233,23 @@ instance ToJSON LogMessage where
224233 ,"milliseconds" .= Text.pack (show ms) ]
225234 CiteprocWarning msg ->
226235 ["message" .= msg]
236+ ATXHeadingInLHS lvl contents ->
237+ ["level" .= lvl
238+ ,"contents" .= contents]
239+ EnvironmentVariableUndefined var ->
240+ ["variable" .= var ]
241+ DuplicateAttribute attr val ->
242+ ["attribute" .= attr
243+ ,"value" .= val]
227244
228−showPos :: SourcePos -> Text.Text
245+showPos :: SourcePos -> Text
229246showPos pos = Text.pack $ sn ++ "line " ++
230247 show (sourceLine pos) ++ " column " ++ show (sourceColumn pos)
231− where sn = if sourceName pos == "source" || sourceName pos == ""
232− then ""
233− else sourceName pos ++ " "
248+ where
249+ sn' = sourceName pos
250+ sn = if sn' == "source" || sn' == "" || sn' == "-"
251+ then ""
252+ else sn' ++ " "
234253
235254encodeLogMessages :: [LogMessage] -> BL.ByteString
236255encodeLogMessages ms =
@@ -238,7 +257,7 @@ encodeLogMessages ms =
238257 keyOrder [ "type", "verbosity", "contents", "message", "path",
239258 "source", "line", "column" ] } ms
240259
241−showLogMessage :: LogMessage -> Text.Text
260+showLogMessage :: LogMessage -> Text
242261showLogMessage msg =
243262 case msg of
244263 SkippedContent s pos ->
@@ -263,7 +282,7 @@ showLogMessage msg =
263282 ParsingUnescaped s pos ->
264283 "Parsing unescaped '" <> s <> "' at " <> showPos pos
265284 CouldNotLoadIncludeFile fp pos ->
266− "Could not load include file '" <> fp <> "' at " <> showPos pos
285+ "Could not load include file " <> fp <> " at " <> showPos pos
267286 MacroAlreadyDefined name pos ->
268287 "Macro '" <> name <> "' already defined, ignoring at " <> showPos pos
269288 InlineNotRendered il ->
@@ -275,18 +294,18 @@ showLogMessage msg =
275294 IgnoredIOError s ->
276295 "IO Error (ignored): " <> s
277296 CouldNotFetchResource fp s ->
278− "Could not fetch resource '" <> fp <> "'" <>
297+ "Could not fetch resource " <> fp <>
279298 if Text.null s then "" else ": " <> s
280299 CouldNotDetermineImageSize fp s ->
281− "Could not determine image size for '" <> fp <> "'" <>
300+ "Could not determine image size for " <> fp <>
282301 if Text.null s then "" else ": " <> s
283302 CouldNotConvertImage fp s ->
284− "Could not convert image '" <> fp <> "'" <>
303+ "Could not convert image " <> fp <>
285304 if Text.null s then "" else ": " <> s
286305 CouldNotDetermineMimeType fp ->
287− "Could not determine mime type for '" <> fp <> "'"
306+ "Could not determine mime type for " <> fp
288307 CouldNotConvertTeXMath s m ->
289− "Could not convert TeX math '" <> s <> "', rendering as TeX" <>
308+ "Could not convert TeX math " <> s <> ", rendering as TeX" <>
290309 if Text.null m then "" else ":\n" <> m
291310 CouldNotParseCSS m ->
292311 "Could not parse CSS" <> if Text.null m then "" else ":\n" <> m
@@ -294,6 +313,8 @@ showLogMessage msg =
294313 "Fetching " <> fp <> "..."
295314 Extracting fp ->
296315 "Extracting " <> fp <> "..."
316+ LoadedResource orig found ->
317+ "Loaded " <> Text.pack orig <> " from " <> Text.pack found
297318 NoTitleElement fallback ->
298319 "This document format requires a nonempty <title> element.\n" <>
299320 "Defaulting to '" <> fallback <> "' as the title.\n" <>
@@ -333,6 +354,17 @@ showLogMessage msg =
333354 FilterCompleted fp ms -> "Completed filter " <> Text.pack fp <>
334355 " in " <> Text.pack (show ms) <> " ms"
335356 CiteprocWarning ms -> "Citeproc: " <> ms
357+ ATXHeadingInLHS lvl contents ->
358+ "Rendering heading '" <> contents <> "' as a paragraph.\n" <>
359+ "ATX headings cannot be used in literate Haskell, because " <>
360+ "'#' is not\nallowed in column 1." <>
361+ if lvl < 3
362+ then " Consider using --markdown-headings=setext."
363+ else ""
364+ EnvironmentVariableUndefined var ->
365+ "Undefined environment variable " <> var <> " in defaults file."
366+ DuplicateAttribute attr val ->
367+ "Ignoring duplicate attribute " <> attr <> "=" <> tshow val <> "."
336368
337369messageVerbosity :: LogMessage -> Verbosity
338370messageVerbosity msg =
@@ -363,6 +395,7 @@ messageVerbosity msg =
363395 CouldNotParseCSS{} -> WARNING
364396 Fetching{} -> INFO
365397 Extracting{} -> INFO
398+ LoadedResource{} -> INFO
366399 NoTitleElement{} -> WARNING
367400 NoLangSpecified -> INFO
368401 InvalidLang{} -> WARNING
@@ -378,3 +411,6 @@ messageVerbosity msg =
378411 RunningFilter{} -> INFO
379412 FilterCompleted{} -> INFO
380413 CiteprocWarning{} -> WARNING
414+ ATXHeadingInLHS{} -> WARNING
415+ EnvironmentVariableUndefined{}-> WARNING
416+ DuplicateAttribute{} -> WARNING
src/Text/Pandoc/Lua.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Lua
3− Copyright : Copyright © 2017–2020 Albert Krewinkel
3+ Copyright : Copyright © 2017-2021 Albert Krewinkel
44 License : GNU GPL, version 2 or above
55
66 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/ErrorConversion.hs+1−1
@@ -3,7 +3,7 @@
33{-# LANGUAGE ScopedTypeVariables #-}
44{- |
55 Module : Text.Pandoc.Lua.ErrorConversion
6− Copyright : © 2020 Albert Krewinkel
6+ Copyright : © 2020-2021 Albert Krewinkel
77 License : GNU GPL, version 2 or above
88
99 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Filter.hs+7−4
@@ -1,8 +1,8 @@
11{-# LANGUAGE FlexibleContexts #-}
22{- |
33Module : Text.Pandoc.Lua.Filter
4−Copyright : © 2012–2020 John MacFarlane,
5− © 2017-2020 Albert Krewinkel
4+Copyright : © 2012-2021 John MacFarlane,
5+ © 2017-2021 Albert Krewinkel
66License : GNU GPL, version 2 or above
77Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
88Stability : alpha
@@ -13,7 +13,9 @@ module Text.Pandoc.Lua.Filter ( LuaFilterFunction
1313 , LuaFilter
1414 , runFilterFile
1515 , walkInlines
16+ , walkInlineLists
1617 , walkBlocks
18+ , walkBlockLists
1719 , module Text.Pandoc.Lua.Walk
1820 ) where
1921import Control.Applicative ((<|>))
@@ -22,6 +24,7 @@ import Control.Monad.Catch (finally, try)
2224import Data.Data (Data, DataType, dataTypeConstrs, dataTypeName, dataTypeOf,
2325 showConstr, toConstr, tyconUQname)
2426import Data.Foldable (foldrM)
27+import Data.List (foldl')
2528import Data.Map (Map)
2629import Data.Maybe (fromMaybe)
2730import Foreign.Lua (Lua, Peekable, Pushable, StackIndex)
@@ -160,7 +163,7 @@ mconcatMapM :: (Monad m) => (a -> m [a]) -> [a] -> m [a]
160163mconcatMapM f = fmap mconcat . mapM f
161164
162165hasOneOf :: LuaFilter -> [String] -> Bool
163−hasOneOf (LuaFilter fnMap) = any (\k -> Map.member k fnMap)
166+hasOneOf (LuaFilter fnMap) = any (`Map.member` fnMap)
164167
165168contains :: LuaFilter -> String -> Bool
166169contains (LuaFilter fnMap) = (`Map.member` fnMap)
@@ -204,7 +207,7 @@ walkMeta lf (Pandoc m bs) = do
204207
205208walkPandoc :: LuaFilter -> Pandoc -> Lua Pandoc
206209walkPandoc (LuaFilter fnMap) =
207− case foldl mplus Nothing (map (`Map.lookup` fnMap) pandocFilterNames) of
210+ case foldl' mplus Nothing (map (`Map.lookup` fnMap) pandocFilterNames) of
208211 Just fn -> \x -> runFilterFunction fn x *> singleElement x
209212 Nothing -> return
210213
src/Text/Pandoc/Lua/Global.hs+1−1
@@ -1,7 +1,7 @@
11{-# LANGUAGE DeriveDataTypeable #-}
22{- |
33 Module : Text.Pandoc.Lua
4− Copyright : Copyright © 2017-2020 Albert Krewinkel
4+ Copyright : Copyright © 2017-2021 Albert Krewinkel
55 License : GNU GPL, version 2 or above
66
77 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Init.hs+15−5
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Lua
3− Copyright : Copyright © 2017-2020 Albert Krewinkel
3+ Copyright : Copyright © 2017-2021 Albert Krewinkel
44 License : GNU GPL, version 2 or above
55
66 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -12,17 +12,18 @@ module Text.Pandoc.Lua.Init
1212 ( runLua
1313 ) where
1414
15+import Control.Monad (when)
1516import Control.Monad.Catch (try)
1617import Control.Monad.Trans (MonadIO (..))
1718import Data.Data (Data, dataTypeConstrs, dataTypeOf, showConstr)
1819import Foreign.Lua (Lua)
1920import GHC.IO.Encoding (getForeignEncoding, setForeignEncoding, utf8)
21+import Text.Pandoc.Class.PandocMonad (readDataFile)
2022import Text.Pandoc.Class.PandocIO (PandocIO)
2123import Text.Pandoc.Error (PandocError)
2224import Text.Pandoc.Lua.Packages (installPandocPackageSearcher)
23−import Text.Pandoc.Lua.PandocLua (PandocLua, liftPandocLua,
24− loadScriptFromDataDir, runPandocLua)
25−
25+import Text.Pandoc.Lua.PandocLua (PandocLua, liftPandocLua, runPandocLua)
26+import Text.Pandoc.Lua.Util (throwTopMessageAsError')
2627import qualified Foreign.Lua as Lua
2728import qualified Text.Pandoc.Definition as Pandoc
2829import qualified Text.Pandoc.Lua.Module.Pandoc as ModulePandoc
@@ -44,7 +45,7 @@ initLuaState = do
4445 liftPandocLua Lua.openlibs
4546 installPandocPackageSearcher
4647 initPandocModule
47− loadScriptFromDataDir "init.lua"
48+ loadInitScript "init.lua"
4849 where
4950 initPandocModule :: PandocLua ()
5051 initPandocModule = do
@@ -61,6 +62,15 @@ initLuaState = do
6162 -- assign module to global variable
6263 liftPandocLua $ Lua.setglobal "pandoc"
6364
65+ loadInitScript :: FilePath -> PandocLua ()
66+ loadInitScript scriptFile = do
67+ script <- readDataFile scriptFile
68+ status <- liftPandocLua $ Lua.dostring script
69+ when (status /= Lua.OK) . liftPandocLua $
70+ throwTopMessageAsError'
71+ (("Couldn't load '" ++ scriptFile ++ "'.\n") ++)
72+
73+
6474-- | AST elements are marshaled via normal constructor functions in the
6575-- @pandoc@ module. However, accessing Lua globals from Haskell is
6676-- expensive (due to error handling). Accessing the Lua registry is much
src/Text/Pandoc/Lua/Marshaling.hs+2−2
@@ -1,7 +1,7 @@
11{- |
22 Module : Text.Pandoc.Lua.Marshaling
3− Copyright : © 2012-2020 John MacFarlane
4− © 2017-2020 Albert Krewinkel
3+ Copyright : © 2012-2021 John MacFarlane
4+ © 2017-2021 Albert Krewinkel
55 License : GNU GPL, version 2 or above
66
77 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Marshaling/AST.hs+79−81
@@ -1,9 +1,10 @@
11{-# OPTIONS_GHC -fno-warn-orphans #-}
2+{-# LANGUAGE BangPatterns #-}
23{-# LANGUAGE LambdaCase #-}
34{- |
45 Module : Text.Pandoc.Lua.Marshaling.AST
5− Copyright : © 2012-2020 John MacFarlane
6− © 2017-2020 Albert Krewinkel
6+ Copyright : © 2012-2021 John MacFarlane
7+ © 2017-2021 Albert Krewinkel
78 License : GNU GPL, version 2 or above
89
910 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -17,6 +18,7 @@ module Text.Pandoc.Lua.Marshaling.AST
1718 ) where
1819
1920import Control.Applicative ((<|>))
21+import Control.Monad ((<$!>))
2022import Foreign.Lua (Lua, Peekable, Pushable, StackIndex)
2123import Text.Pandoc.Definition
2224import Text.Pandoc.Error (PandocError)
@@ -32,17 +34,16 @@ instance Pushable Pandoc where
3234 pushViaConstructor "Pandoc" blocks meta
3335
3436instance Peekable Pandoc where
35− peek idx = defineHowTo "get Pandoc value" $ do
36− blocks <- LuaUtil.rawField idx "blocks"
37− meta <- LuaUtil.rawField idx "meta"
38− return $ Pandoc meta blocks
37+ peek idx = defineHowTo "get Pandoc value" $! Pandoc
38+ <$!> LuaUtil.rawField idx "meta"
39+ <*> LuaUtil.rawField idx "blocks"
3940
4041instance Pushable Meta where
4142 push (Meta mmap) =
4243 pushViaConstructor "Meta" mmap
4344instance Peekable Meta where
44− peek idx = defineHowTo "get Meta value" $
45− Meta <$> Lua.peek idx
45+ peek idx = defineHowTo "get Meta value" $!
46+ Meta <$!> Lua.peek idx
4647
4748instance Pushable MetaValue where
4849 push = pushMetaValue
@@ -68,14 +69,13 @@ instance Pushable Citation where
6869 pushViaConstructor "Citation" cid mode prefix suffix noteNum hash
6970
7071instance Peekable Citation where
71− peek idx = do
72− id' <- LuaUtil.rawField idx "id"
73− prefix <- LuaUtil.rawField idx "prefix"
74− suffix <- LuaUtil.rawField idx "suffix"
75− mode <- LuaUtil.rawField idx "mode"
76− num <- LuaUtil.rawField idx "note_num"
77− hash <- LuaUtil.rawField idx "hash"
78− return $ Citation id' prefix suffix mode num hash
72+ peek idx = Citation
73+ <$!> LuaUtil.rawField idx "id"
74+ <*> LuaUtil.rawField idx "prefix"
75+ <*> LuaUtil.rawField idx "suffix"
76+ <*> LuaUtil.rawField idx "mode"
77+ <*> LuaUtil.rawField idx "note_num"
78+ <*> LuaUtil.rawField idx "hash"
7979
8080instance Pushable Alignment where
8181 push = Lua.push . show
@@ -90,7 +90,7 @@ instance Peekable CitationMode where
9090instance Pushable Format where
9191 push (Format f) = Lua.push f
9292instance Peekable Format where
93− peek idx = Format <$> Lua.peek idx
93+ peek idx = Format <$!> Lua.peek idx
9494
9595instance Pushable ListNumberDelim where
9696 push = Lua.push . show
@@ -130,26 +130,26 @@ peekMetaValue idx = defineHowTo "get MetaValue" $ do
130130 elementContent = Lua.peek idx
131131 luatype <- Lua.ltype idx
132132 case luatype of
133− Lua.TypeBoolean -> MetaBool <$> Lua.peek idx
134− Lua.TypeString -> MetaString <$> Lua.peek idx
133+ Lua.TypeBoolean -> MetaBool <$!> Lua.peek idx
134+ Lua.TypeString -> MetaString <$!> Lua.peek idx
135135 Lua.TypeTable -> do
136136 tag <- try $ LuaUtil.getTag idx
137137 case tag of
138− Right "MetaBlocks" -> MetaBlocks <$> elementContent
139− Right "MetaBool" -> MetaBool <$> elementContent
140− Right "MetaMap" -> MetaMap <$> elementContent
141− Right "MetaInlines" -> MetaInlines <$> elementContent
142− Right "MetaList" -> MetaList <$> elementContent
143− Right "MetaString" -> MetaString <$> elementContent
138+ Right "MetaBlocks" -> MetaBlocks <$!> elementContent
139+ Right "MetaBool" -> MetaBool <$!> elementContent
140+ Right "MetaMap" -> MetaMap <$!> elementContent
141+ Right "MetaInlines" -> MetaInlines <$!> elementContent
142+ Right "MetaList" -> MetaList <$!> elementContent
143+ Right "MetaString" -> MetaString <$!> elementContent
144144 Right t -> Lua.throwMessage ("Unknown meta tag: " <> t)
145145 Left _ -> do
146146 -- no meta value tag given, try to guess.
147147 len <- Lua.rawlen idx
148148 if len <= 0
149− then MetaMap <$> Lua.peek idx
150− else (MetaInlines <$> Lua.peek idx)
151− <|> (MetaBlocks <$> Lua.peek idx)
152− <|> (MetaList <$> Lua.peek idx)
149+ then MetaMap <$!> Lua.peek idx
150+ else (MetaInlines <$!> Lua.peek idx)
151+ <|> (MetaBlocks <$!> Lua.peek idx)
152+ <|> (MetaList <$!> Lua.peek idx)
153153 _ -> Lua.throwMessage "could not get meta value"
154154
155155-- | Push a block element to the top of the Lua stack.
@@ -174,25 +174,25 @@ pushBlock = \case
174174
175175-- | Return the value at the given index as block if possible.
176176peekBlock :: StackIndex -> Lua Block
177−peekBlock idx = defineHowTo "get Block value" $ do
177+peekBlock idx = defineHowTo "get Block value" $! do
178178 tag <- LuaUtil.getTag idx
179179 case tag of
180− "BlockQuote" -> BlockQuote <$> elementContent
181− "BulletList" -> BulletList <$> elementContent
182− "CodeBlock" -> withAttr CodeBlock <$> elementContent
183− "DefinitionList" -> DefinitionList <$> elementContent
184− "Div" -> withAttr Div <$> elementContent
180+ "BlockQuote" -> BlockQuote <$!> elementContent
181+ "BulletList" -> BulletList <$!> elementContent
182+ "CodeBlock" -> withAttr CodeBlock <$!> elementContent
183+ "DefinitionList" -> DefinitionList <$!> elementContent
184+ "Div" -> withAttr Div <$!> elementContent
185185 "Header" -> (\(lvl, LuaAttr attr, lst) -> Header lvl attr lst)
186− <$> elementContent
186+ <$!> elementContent
187187 "HorizontalRule" -> return HorizontalRule
188− "LineBlock" -> LineBlock <$> elementContent
188+ "LineBlock" -> LineBlock <$!> elementContent
189189 "OrderedList" -> (\(LuaListAttributes lstAttr, lst) ->
190190 OrderedList lstAttr lst)
191− <$> elementContent
191+ <$!> elementContent
192192 "Null" -> return Null
193− "Para" -> Para <$> elementContent
194− "Plain" -> Plain <$> elementContent
195− "RawBlock" -> uncurry RawBlock <$> elementContent
193+ "Para" -> Para <$!> elementContent
194+ "Plain" -> Plain <$!> elementContent
195+ "RawBlock" -> uncurry RawBlock <$!> elementContent
196196 "Table" -> (\(attr, capt, colSpecs, thead, tbodies, tfoot) ->
197197 Table (fromLuaAttr attr)
198198 capt
@@ -200,7 +200,7 @@ peekBlock idx = defineHowTo "get Block value" $ do
200200 thead
201201 tbodies
202202 tfoot)
203− <$> elementContent
203+ <$!> elementContent
204204 _ -> Lua.throwMessage ("Unknown block type: " <> tag)
205205 where
206206 -- Get the contents of an AST element.
@@ -222,15 +222,14 @@ pushCaption (Caption shortCaption longCaption) = do
222222
223223-- | Peek Caption element
224224peekCaption :: StackIndex -> Lua Caption
225−peekCaption idx = do
226− short <- Lua.fromOptional <$> LuaUtil.rawField idx "short"
227− long <- LuaUtil.rawField idx "long"
228− return $ Caption short long
225+peekCaption idx = Caption
226+ <$!> (Lua.fromOptional <$!> LuaUtil.rawField idx "short")
227+ <*> LuaUtil.rawField idx "long"
229228
230229instance Peekable ColWidth where
231230 peek idx = do
232− width <- Lua.fromOptional <$> Lua.peek idx
233− return $ maybe ColWidthDefault ColWidth width
231+ width <- Lua.fromOptional <$!> Lua.peek idx
232+ return $! maybe ColWidthDefault ColWidth width
234233
235234instance Pushable ColWidth where
236235 push = \case
@@ -252,12 +251,11 @@ instance Pushable TableBody where
252251 LuaUtil.addField "body" body
253252
254253instance Peekable TableBody where
255− peek idx = do
256− attr <- LuaUtil.rawField idx "attr"
257− rowHeadColumns <- LuaUtil.rawField idx "row_head_columns"
258− head' <- LuaUtil.rawField idx "head"
259− body <- LuaUtil.rawField idx "body"
260− return $ TableBody attr (RowHeadColumns rowHeadColumns) head' body
254+ peek idx = TableBody
255+ <$!> LuaUtil.rawField idx "attr"
256+ <*> (RowHeadColumns <$!> LuaUtil.rawField idx "row_head_columns")
257+ <*> LuaUtil.rawField idx "head"
258+ <*> LuaUtil.rawField idx "body"
261259
262260instance Pushable TableHead where
263261 push (TableHead attr rows) = Lua.push (attr, rows)
@@ -287,13 +285,12 @@ pushCell (Cell attr align (RowSpan rowSpan) (ColSpan colSpan) contents) = do
287285 LuaUtil.addField "contents" contents
288286
289287peekCell :: StackIndex -> Lua Cell
290−peekCell idx = do
291− attr <- fromLuaAttr <$> LuaUtil.rawField idx "attr"
292− align <- LuaUtil.rawField idx "alignment"
293− rowSpan <- LuaUtil.rawField idx "row_span"
294− colSpan <- LuaUtil.rawField idx "col_span"
295− contents <- LuaUtil.rawField idx "contents"
296− return $ Cell attr align (RowSpan rowSpan) (ColSpan colSpan) contents
288+peekCell idx = Cell
289+ <$!> (fromLuaAttr <$!> LuaUtil.rawField idx "attr")
290+ <*> LuaUtil.rawField idx "alignment"
291+ <*> (RowSpan <$!> LuaUtil.rawField idx "row_span")
292+ <*> (ColSpan <$!> LuaUtil.rawField idx "col_span")
293+ <*> LuaUtil.rawField idx "contents"
297294
298295-- | Push an inline element to the top of the lua stack.
299296pushInline :: Inline -> Lua ()
@@ -324,28 +321,29 @@ peekInline :: StackIndex -> Lua Inline
324321peekInline idx = defineHowTo "get Inline value" $ do
325322 tag <- LuaUtil.getTag idx
326323 case tag of
327− "Cite" -> uncurry Cite <$> elementContent
328− "Code" -> withAttr Code <$> elementContent
329− "Emph" -> Emph <$> elementContent
330− "Underline" -> Underline <$> elementContent
331− "Image" -> (\(LuaAttr attr, lst, tgt) -> Image attr lst tgt)
332− <$> elementContent
333− "Link" -> (\(LuaAttr attr, lst, tgt) -> Link attr lst tgt)
334− <$> elementContent
324+ "Cite" -> uncurry Cite <$!> elementContent
325+ "Code" -> withAttr Code <$!> elementContent
326+ "Emph" -> Emph <$!> elementContent
327+ "Underline" -> Underline <$!> elementContent
328+ "Image" -> (\(LuaAttr !attr, !lst, !tgt) -> Image attr lst tgt)
329+ <$!> elementContent
330+ "Link" -> (\(LuaAttr !attr, !lst, !tgt) -> Link attr lst tgt)
331+ <$!> elementContent
335332 "LineBreak" -> return LineBreak
336− "Note" -> Note <$> elementContent
337− "Math" -> uncurry Math <$> elementContent
338− "Quoted" -> uncurry Quoted <$> elementContent
339− "RawInline" -> uncurry RawInline <$> elementContent
340− "SmallCaps" -> SmallCaps <$> elementContent
333+ "Note" -> Note <$!> elementContent
334+ "Math" -> uncurry Math <$!> elementContent
335+ "Quoted" -> uncurry Quoted <$!> elementContent
336+ "RawInline" -> uncurry RawInline <$!> elementContent
337+ "SmallCaps" -> SmallCaps <$!> elementContent
341338 "SoftBreak" -> return SoftBreak
342339 "Space" -> return Space
343− "Span" -> withAttr Span <$> elementContent
344− "Str" -> Str <$> elementContent
345− "Strikeout" -> Strikeout <$> elementContent
346− "Strong" -> Strong <$> elementContent
347− "Subscript" -> Subscript <$> elementContent
348− "Superscript"-> Superscript <$> elementContent
340+ "Span" -> withAttr Span <$!> elementContent
341+ -- strict to Lua string is copied before gc
342+ "Str" -> Str <$!> elementContent
343+ "Strikeout" -> Strikeout <$!> elementContent
344+ "Strong" -> Strong <$!> elementContent
345+ "Subscript" -> Subscript <$!> elementContent
346+ "Superscript"-> Superscript <$!> elementContent
349347 _ -> Lua.throwMessage ("Unknown inline type: " <> tag)
350348 where
351349 -- Get the contents of an AST element.
@@ -366,7 +364,7 @@ instance Pushable LuaAttr where
366364 pushViaConstructor "Attr" id' classes kv
367365
368366instance Peekable LuaAttr where
369− peek idx = defineHowTo "get Attr value" (LuaAttr <$> Lua.peek idx)
367+ peek idx = defineHowTo "get Attr value" $! (LuaAttr <$!> Lua.peek idx)
370368
371369-- | Wrapper for ListAttributes
372370newtype LuaListAttributes = LuaListAttributes ListAttributes
src/Text/Pandoc/Lua/Marshaling/AnyValue.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Lua.Marshaling.AnyValue
3− Copyright : © 2017-2020 Albert Krewinkel
3+ Copyright : © 2017-2021 Albert Krewinkel
44 License : GNU GPL, version 2 or above
55
66 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Marshaling/CommonState.hs+2−2
@@ -3,8 +3,8 @@
33{-# LANGUAGE OverloadedStrings #-}
44{- |
55 Module : Text.Pandoc.Lua.Marshaling.CommonState
6− Copyright : © 2012-2020 John MacFarlane
7− © 2017-2020 Albert Krewinkel
6+ Copyright : © 2012-2021 John MacFarlane
7+ © 2017-2021 Albert Krewinkel
88 License : GNU GPL, version 2 or above
99 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
1010 Stability : alpha
src/Text/Pandoc/Lua/Marshaling/Context.hs+3−2
@@ -1,8 +1,8 @@
11{-# OPTIONS_GHC -fno-warn-orphans #-}
22{- |
33 Module : Text.Pandoc.Lua.Marshaling.Context
4− Copyright : © 2012-2020 John MacFarlane
5− © 2017-2020 Albert Krewinkel
4+ Copyright : © 2012-2021 John MacFarlane
5+ © 2017-2021 Albert Krewinkel
66 License : GNU GPL, version 2 or above
77
88 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -22,6 +22,7 @@ instance (TemplateTarget a, Pushable a) => Pushable (Context a) where
2222
2323instance (TemplateTarget a, Pushable a) => Pushable (Val a) where
2424 push NullVal = Lua.push ()
25+ push (BoolVal b) = Lua.push b
2526 push (MapVal ctx) = Lua.push ctx
2627 push (ListVal xs) = Lua.push xs
2728 push (SimpleVal d) = Lua.push $ render Nothing d
src/Text/Pandoc/Lua/Marshaling/List.hs+2−2
@@ -4,8 +4,8 @@
44{-# LANGUAGE UndecidableInstances #-}
55{- |
66Module : Text.Pandoc.Lua.Marshaling.List
7−Copyright : © 2012-2020 John MacFarlane
8− © 2017-2020 Albert Krewinkel
7+Copyright : © 2012-2021 John MacFarlane
8+ © 2017-2021 Albert Krewinkel
99License : GNU GPL, version 2 or above
1010Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
1111Stability : alpha
src/Text/Pandoc/Lua/Marshaling/MediaBag.hs+3−3
@@ -1,7 +1,7 @@
11{- |
22 Module : Text.Pandoc.Lua.Marshaling.MediaBag
3− Copyright : © 2012-2020 John MacFarlane
4− © 2017-2020 Albert Krewinkel
3+ Copyright : © 2012-2021 John MacFarlane
4+ © 2017-2021 Albert Krewinkel
55 License : GNU GPL, version 2 or above
66 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
77 Stability : alpha
@@ -34,7 +34,7 @@ instance Peekable MediaItems where
3434 peek = peekMediaItems
3535
3636-- | Push an iterator triple to be used with Lua's @for@ loop construct.
37−-- Each iterator invokation returns a tripple consisting of an item's
37+-- Each iterator invocation returns a triple containing the item's
3838-- filename, MIME type, and content.
3939pushIterator :: MediaBag -> Lua NumResults
4040pushIterator mb = do
src/Text/Pandoc/Lua/Marshaling/PandocError.hs+1−1
@@ -4,7 +4,7 @@
44{-# LANGUAGE ScopedTypeVariables #-}
55{- |
66 Module : Text.Pandoc.Lua.Marshaling.PandocError
7− Copyright : © 2020 Albert Krewinkel
7+ Copyright : © 2020-2021 Albert Krewinkel
88 License : GNU GPL, version 2 or above
99
1010 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Marshaling/ReaderOptions.hs+2−2
@@ -4,8 +4,8 @@
44{-# OPTIONS_GHC -fno-warn-orphans #-}
55{- |
66 Module : Text.Pandoc.Lua.Marshaling.ReaderOptions
7− Copyright : © 2012-2020 John MacFarlane
8− © 2017-2020 Albert Krewinkel
7+ Copyright : © 2012-2021 John MacFarlane
8+ © 2017-2021 Albert Krewinkel
99 License : GNU GPL, version 2 or above
1010
1111 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Marshaling/SimpleTable.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Lua.Marshaling.SimpleTable
3− Copyright : © 2020 Albert Krewinkel
3+ Copyright : © 2020-2021 Albert Krewinkel
44 License : GNU GPL, version 2 or above
55
66 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Marshaling/Version.hs+1−1
@@ -4,7 +4,7 @@
44{-# LANGUAGE ScopedTypeVariables #-}
55{- |
66 Module : Text.Pandoc.Lua.Marshaling.Version
7− Copyright : © 2019-2020 Albert Krewinkel
7+ Copyright : © 2019-2021 Albert Krewinkel
88 License : GNU GPL, version 2 or above
99
1010 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Module/MediaBag.hs+18−17
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.Lua.Module.MediaBag
4− Copyright : Copyright © 2017-2020 Albert Krewinkel
4+ Copyright : Copyright © 2017-2021 Albert Krewinkel
55 License : GNU GPL, version 2 or above
66
77 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -13,6 +13,7 @@ module Text.Pandoc.Lua.Module.MediaBag
1313 ( pushModule
1414 ) where
1515
16+import Prelude hiding (lookup)
1617import Control.Monad (zipWithM_)
1718import Foreign.Lua (Lua, NumResults, Optional)
1819import Text.Pandoc.Class.CommonState (CommonState (..))
@@ -36,10 +37,10 @@ pushModule = do
3637 liftPandocLua Lua.newtable
3738 addFunction "delete" delete
3839 addFunction "empty" empty
39− addFunction "insert" insertMediaFn
40+ addFunction "insert" insert
4041 addFunction "items" items
41− addFunction "lookup" lookupMediaFn
42− addFunction "list" mediaDirectoryFn
42+ addFunction "lookup" lookup
43+ addFunction "list" list
4344 addFunction "fetch" fetch
4445 return 1
4546
@@ -53,11 +54,11 @@ empty :: PandocLua NumResults
5354empty = 0 <$ modifyCommonState (\st -> st { stMediaBag = mempty })
5455
5556-- | Insert a new item into the media bag.
56−insertMediaFn :: FilePath
57− -> Optional MimeType
58− -> BL.ByteString
59− -> PandocLua NumResults
60−insertMediaFn fp optionalMime contents = do
57+insert :: FilePath
58+ -> Optional MimeType
59+ -> BL.ByteString
60+ -> PandocLua NumResults
61+insert fp optionalMime contents = do
6162 mb <- getMediaBag
6263 setMediaBag $ MB.insertMedia fp (Lua.fromOptional optionalMime) contents mb
6364 return (Lua.NumResults 0)
@@ -66,19 +67,19 @@ insertMediaFn fp optionalMime contents = do
6667items :: PandocLua NumResults
6768items = getMediaBag >>= liftPandocLua . pushIterator
6869
69−lookupMediaFn :: FilePath
70− -> PandocLua NumResults
71−lookupMediaFn fp = do
70+lookup :: FilePath
71+ -> PandocLua NumResults
72+lookup fp = do
7273 res <- MB.lookupMedia fp <$> getMediaBag
7374 liftPandocLua $ case res of
7475 Nothing -> 1 <$ Lua.pushnil
75− Just (mimeType, contents) -> do
76− Lua.push mimeType
77− Lua.push contents
76+ Just item -> do
77+ Lua.push $ MB.mediaMimeType item
78+ Lua.push $ MB.mediaContents item
7879 return 2
7980
80−mediaDirectoryFn :: PandocLua NumResults
81−mediaDirectoryFn = do
81+list :: PandocLua NumResults
82+list = do
8283 dirContents <- MB.mediaDirectory <$> getMediaBag
8384 liftPandocLua $ do
8485 Lua.newtable
src/Text/Pandoc/Lua/Module/Pandoc.hs+29−23
@@ -2,7 +2,7 @@
22{-# LANGUAGE OverloadedStrings #-}
33{- |
44 Module : Text.Pandoc.Lua.Module.Pandoc
5− Copyright : Copyright © 2017-2020 Albert Krewinkel
5+ Copyright : Copyright © 2017-2021 Albert Krewinkel
66 License : GNU GPL, version 2 or above
77
88 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -14,6 +14,7 @@ module Text.Pandoc.Lua.Module.Pandoc
1414 ( pushModule
1515 ) where
1616
17+import Prelude hiding (read)
1718import Control.Monad (when)
1819import Control.Monad.Except (throwError)
1920import Data.Default (Default (..))
@@ -22,10 +23,12 @@ import Foreign.Lua (Lua, NumResults, Optional, Peekable, Pushable)
2223import System.Exit (ExitCode (..))
2324import Text.Pandoc.Class.PandocIO (runIO)
2425import Text.Pandoc.Definition (Block, Inline)
25−import Text.Pandoc.Lua.Filter (walkInlines, walkBlocks, LuaFilter, SingletonsList (..))
26+import Text.Pandoc.Lua.Filter (LuaFilter, SingletonsList (..), walkInlines,
27+ walkInlineLists, walkBlocks, walkBlockLists)
2628import Text.Pandoc.Lua.Marshaling ()
29+import Text.Pandoc.Lua.Marshaling.List (List (..))
2730import Text.Pandoc.Lua.PandocLua (PandocLua, addFunction, liftPandocLua,
28− loadScriptFromDataDir)
31+ loadDefaultModule)
2932import Text.Pandoc.Walk (Walkable)
3033import Text.Pandoc.Options (ReaderOptions (readerExtensions))
3134import Text.Pandoc.Process (pipeProcess)
@@ -38,30 +41,33 @@ import qualified Foreign.Lua as Lua
3841import qualified Text.Pandoc.Lua.Util as LuaUtil
3942import Text.Pandoc.Error
4043
41−-- | Push the "pandoc" on the lua stack. Requires the `list` module to be
42−-- loaded.
44+-- | Push the "pandoc" package to the Lua stack. Requires the `List`
45+-- module to be loadable.
4346pushModule :: PandocLua NumResults
4447pushModule = do
45− loadScriptFromDataDir "pandoc.lua"
46− addFunction "read" readDoc
47− addFunction "pipe" pipeFn
48− addFunction "walk_block" walkBlock
49− addFunction "walk_inline" walkInline
48+ loadDefaultModule "pandoc"
49+ addFunction "read" read
50+ addFunction "pipe" pipe
51+ addFunction "walk_block" walk_block
52+ addFunction "walk_inline" walk_inline
5053 return 1
5154
5255walkElement :: (Walkable (SingletonsList Inline) a,
53− Walkable (SingletonsList Block) a)
56+ Walkable (SingletonsList Block) a,
57+ Walkable (List Inline) a,
58+ Walkable (List Block) a)
5459 => a -> LuaFilter -> PandocLua a
55−walkElement x f = liftPandocLua $ walkInlines f x >>= walkBlocks f
60+walkElement x f = liftPandocLua $
61+ walkInlines f x >>= walkInlineLists f >>= walkBlocks f >>= walkBlockLists f
5662
57−walkInline :: Inline -> LuaFilter -> PandocLua Inline
58−walkInline = walkElement
63+walk_inline :: Inline -> LuaFilter -> PandocLua Inline
64+walk_inline = walkElement
5965
60−walkBlock :: Block -> LuaFilter -> PandocLua Block
61−walkBlock = walkElement
66+walk_block :: Block -> LuaFilter -> PandocLua Block
67+walk_block = walkElement
6268
63−readDoc :: T.Text -> Optional T.Text -> PandocLua NumResults
64−readDoc content formatSpecOrNil = liftPandocLua $ do
69+read :: T.Text -> Optional T.Text -> PandocLua NumResults
70+read content formatSpecOrNil = liftPandocLua $ do
6571 let formatSpec = fromMaybe "markdown" (Lua.fromOptional formatSpecOrNil)
6672 res <- Lua.liftIO . runIO $
6773 getReader formatSpec >>= \(rdr,es) ->
@@ -79,11 +85,11 @@ readDoc content formatSpecOrNil = liftPandocLua $ do
7985 Left e -> Lua.raiseError $ show e
8086
8187-- | Pipes input through a command.
82−pipeFn :: String
83− -> [String]
84− -> BL.ByteString
85− -> PandocLua NumResults
86−pipeFn command args input = liftPandocLua $ do
88+pipe :: String -- ^ path to executable
89+ -> [String] -- ^ list of arguments
90+ -> BL.ByteString -- ^ input passed to process via stdin
91+ -> PandocLua NumResults
92+pipe command args input = liftPandocLua $ do
8793 (ec, output) <- Lua.liftIO $ pipeProcess Nothing command args input
8894 case ec of
8995 ExitSuccess -> 1 <$ Lua.push output
src/Text/Pandoc/Lua/Module/System.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Lua.Module.System
3− Copyright : © 2019-2020 Albert Krewinkel
3+ Copyright : © 2019-2021 Albert Krewinkel
44 License : GNU GPL, version 2 or above
55
66 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Module/Types.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Lua.Module.Types
3− Copyright : © 2019-2020 Albert Krewinkel
3+ Copyright : © 2019-2021 Albert Krewinkel
44 License : GNU GPL, version 2 or above
55
66 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Module/Utils.hs+2−2
@@ -2,7 +2,7 @@
22{-# LANGUAGE ScopedTypeVariables #-}
33{- |
44 Module : Text.Pandoc.Lua.Module.Utils
5− Copyright : Copyright © 2017-2020 Albert Krewinkel
5+ Copyright : Copyright © 2017-2021 Albert Krewinkel
66 License : GNU GPL, version 2 or above
77
88 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -146,7 +146,7 @@ from_simple_table (SimpleTable capt aligns widths head' body) = do
146146 nullAttr
147147 (Caption Nothing [Plain capt])
148148 (zipWith (\a w -> (a, toColWidth w)) aligns widths)
149− (TableHead nullAttr [blockListToRow head'])
149+ (TableHead nullAttr [blockListToRow head' | not (null head') ])
150150 [TableBody nullAttr 0 [] $ map blockListToRow body]
151151 (TableFoot nullAttr [])
152152 return (NumResults 1)
src/Text/Pandoc/Lua/Packages.hs+10−27
@@ -1,9 +1,6 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE ScopedTypeVariables #-}
41{- |
52 Module : Text.Pandoc.Lua.Packages
6− Copyright : Copyright © 2017-2020 Albert Krewinkel
3+ Copyright : Copyright © 2017-2021 Albert Krewinkel
74 License : GNU GPL, version 2 or above
85
96 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -15,15 +12,12 @@ module Text.Pandoc.Lua.Packages
1512 ( installPandocPackageSearcher
1613 ) where
1714
18−import Control.Monad.Catch (try)
1915import Control.Monad (forM_)
20−import Data.ByteString (ByteString)
21−import Foreign.Lua (Lua, NumResults)
22−import Text.Pandoc.Error (PandocError)
23−import Text.Pandoc.Class.PandocMonad (readDataFile)
24−import Text.Pandoc.Lua.PandocLua (PandocLua, liftPandocLua)
16+import Foreign.Lua (NumResults)
17+import Text.Pandoc.Lua.PandocLua (PandocLua, liftPandocLua, loadDefaultModule)
2518
2619import qualified Foreign.Lua as Lua
20+import qualified Foreign.Lua.Module.Path as Path
2721import qualified Foreign.Lua.Module.Text as Text
2822import qualified Text.Pandoc.Lua.Module.Pandoc as Pandoc
2923import qualified Text.Pandoc.Lua.Module.MediaBag as MediaBag
@@ -50,28 +44,17 @@ pandocPackageSearcher pkgName =
5044 case pkgName of
5145 "pandoc" -> pushWrappedHsFun Pandoc.pushModule
5246 "pandoc.mediabag" -> pushWrappedHsFun MediaBag.pushModule
47+ "pandoc.path" -> pushWrappedHsFun Path.pushModule
5348 "pandoc.system" -> pushWrappedHsFun System.pushModule
5449 "pandoc.types" -> pushWrappedHsFun Types.pushModule
5550 "pandoc.utils" -> pushWrappedHsFun Utils.pushModule
5651 "text" -> pushWrappedHsFun Text.pushModule
57− _ -> searchPureLuaLoader
52+ "pandoc.List" -> pushWrappedHsFun (loadDefaultModule pkgName)
53+ _ -> reportPandocSearcherFailure
5854 where
5955 pushWrappedHsFun f = liftPandocLua $ do
6056 Lua.pushHaskellFunction f
6157 return 1
62− searchPureLuaLoader = do
63− let filename = pkgName ++ ".lua"
64− try (readDataFile filename) >>= \case
65− Right script -> pushWrappedHsFun (loadStringAsPackage pkgName script)
66− Left (_ :: PandocError) -> liftPandocLua $ do
67− Lua.push ("\n\tno file '" ++ filename ++ "' in pandoc's datadir")
68− return (1 :: NumResults)
69−
70−loadStringAsPackage :: String -> ByteString -> Lua NumResults
71−loadStringAsPackage pkgName script = do
72− status <- Lua.dostring script
73− if status == Lua.OK
74− then return (1 :: NumResults)
75− else do
76− msg <- Lua.popValue
77− Lua.raiseError ("Error while loading `" <> pkgName <> "`.\n" <> msg)
58+ reportPandocSearcherFailure = liftPandocLua $ do
59+ Lua.push ("\n\t" <> pkgName <> "is not one of pandoc's default packages")
60+ return (1 :: NumResults)
src/Text/Pandoc/Lua/PandocLua.hs+20−13
@@ -9,7 +9,7 @@
99{-# OPTIONS_GHC -fno-warn-orphans #-}
1010{- |
1111 Module : Text.Pandoc.Lua.PandocLua
12− Copyright : Copyright © 2020 Albert Krewinkel
12+ Copyright : Copyright © 2020-2021 Albert Krewinkel
1313 License : GNU GPL, version 2 or above
1414
1515 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
@@ -23,24 +23,23 @@ module Text.Pandoc.Lua.PandocLua
2323 , runPandocLua
2424 , liftPandocLua
2525 , addFunction
26− , loadScriptFromDataDir
26+ , loadDefaultModule
2727 ) where
2828
29−import Control.Monad (when)
3029import Control.Monad.Catch (MonadCatch, MonadMask, MonadThrow)
3130import Control.Monad.Except (MonadError (catchError, throwError))
3231import Control.Monad.IO.Class (MonadIO (liftIO))
3332import Foreign.Lua (Lua (..), NumResults, Pushable, ToHaskellFunction)
3433import Text.Pandoc.Class.PandocIO (PandocIO)
35−import Text.Pandoc.Class.PandocMonad (PandocMonad (..), readDataFile)
36−import Text.Pandoc.Error (PandocError)
34+import Text.Pandoc.Class.PandocMonad (PandocMonad (..), readDefaultDataFile)
35+import Text.Pandoc.Error (PandocError (PandocLuaError))
3736import Text.Pandoc.Lua.Global (Global (..), setGlobals)
3837import Text.Pandoc.Lua.ErrorConversion (errorConversion)
3938
4039import qualified Control.Monad.Catch as Catch
40+import qualified Data.Text as T
4141import qualified Foreign.Lua as Lua
4242import qualified Text.Pandoc.Class.IO as IO
43−import qualified Text.Pandoc.Lua.Util as LuaUtil
4443
4544-- | Type providing access to both, pandoc and Lua operations.
4645newtype PandocLua a = PandocLua { unPandocLua :: Lua a }
@@ -86,14 +85,22 @@ addFunction name fn = liftPandocLua $ do
8685 Lua.pushHaskellFunction fn
8786 Lua.rawset (-3)
8887
89−-- | Load a file from pandoc's data directory.
90−loadScriptFromDataDir :: FilePath -> PandocLua ()
91−loadScriptFromDataDir scriptFile = do
92− script <- readDataFile scriptFile
88+-- | Load a pure Lua module included with pandoc. Leaves the result on
89+-- the stack and returns @NumResults 1@.
90+--
91+-- The script is loaded from the default data directory. We do not load
92+-- from data directories supplied via command line, as this could cause
93+-- scripts to be executed even though they had not been passed explicitly.
94+loadDefaultModule :: String -> PandocLua NumResults
95+loadDefaultModule name = do
96+ script <- readDefaultDataFile (name <> ".lua")
9397 status <- liftPandocLua $ Lua.dostring script
94− when (status /= Lua.OK) . liftPandocLua $
95− LuaUtil.throwTopMessageAsError'
96− (("Couldn't load '" ++ scriptFile ++ "'.\n") ++)
98+ if status == Lua.OK
99+ then return (1 :: NumResults)
100+ else do
101+ msg <- liftPandocLua Lua.popValue
102+ let err = "Error while loading `" <> name <> "`.\n" <> msg
103+ throwError $ PandocLuaError (T.pack err)
97104
98105-- | Global variables which should always be set.
99106defaultGlobals :: PandocIO [Global]
src/Text/Pandoc/Lua/Util.hs+2−2
@@ -3,8 +3,8 @@
33{-# LANGUAGE OverloadedStrings #-}
44{- |
55 Module : Text.Pandoc.Lua.Util
6− Copyright : © 2012–2020 John MacFarlane,
7− © 2017-2020 Albert Krewinkel
6+ Copyright : © 2012-2021 John MacFarlane,
7+ © 2017-2021 Albert Krewinkel
88 License : GNU GPL, version 2 or above
99
1010 Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
src/Text/Pandoc/Lua/Walk.hs+2−2
@@ -4,8 +4,8 @@
44{-# LANGUAGE MultiParamTypeClasses #-}
55{- |
66Module : Text.Pandoc.Lua.Walk
7−Copyright : © 2012–2020 John MacFarlane,
8− © 2017-2020 Albert Krewinkel
7+Copyright : © 2012-2021 John MacFarlane,
8+ © 2017-2021 Albert Krewinkel
99License : GNU GPL, version 2 or above
1010Maintainer : Albert Krewinkel <tarleb+pandoc@moltkeplatz.de>
1111Stability : alpha
src/Text/Pandoc/MIME.hs+26−3
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.MIME
4− Copyright : Copyright (C) 2011-2020 John MacFarlane
4+ Copyright : Copyright (C) 2011-2021 John MacFarlane
55 License : GNU GPL, version 2 or above
66
77 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -10,8 +10,13 @@
1010
1111Mime type lookup.
1212-}
13−module Text.Pandoc.MIME ( MimeType, getMimeType, getMimeTypeDef,
14− extensionFromMimeType, mediaCategory ) where
13+module Text.Pandoc.MIME (
14+ MimeType,
15+ getMimeType,
16+ getMimeTypeDef,
17+ getCharset,
18+ extensionFromMimeType,
19+ mediaCategory ) where
1520import Data.List (isPrefixOf, isSuffixOf)
1621import qualified Data.Map as M
1722import qualified Data.Text as T
@@ -38,6 +43,16 @@ getMimeTypeDef :: FilePath -> MimeType
3843getMimeTypeDef = fromMaybe "application/octet-stream" . getMimeType
3944
4045extensionFromMimeType :: MimeType -> Maybe T.Text
46+-- few special cases, where there are multiple options:
47+extensionFromMimeType "text/plain" = Just "txt"
48+extensionFromMimeType "video/quicktime" = Just "mov"
49+extensionFromMimeType "video/mpeg" = Just "mpeg"
50+extensionFromMimeType "video/dv" = Just "dv"
51+extensionFromMimeType "image/vnd.djvu" = Just "djvu"
52+extensionFromMimeType "image/tiff" = Just "tiff"
53+extensionFromMimeType "image/jpeg" = Just "jpg"
54+extensionFromMimeType "application/xml" = Just "xml"
55+extensionFromMimeType "application/ogg" = Just "ogg"
4156extensionFromMimeType mimetype =
4257 M.lookup (T.takeWhile (/=';') mimetype) reverseMimeTypes
4358 -- note: we just look up the basic mime type, dropping the content-encoding etc.
@@ -54,6 +69,14 @@ reverseMimeTypes = M.fromList $ map swap mimeTypesList
5469mimeTypes :: M.Map T.Text MimeType
5570mimeTypes = M.fromList mimeTypesList
5671
72+-- | Get the charset from a mime type, if one is present.
73+getCharset :: MimeType -> Maybe T.Text
74+getCharset mt =
75+ let (_,y) = T.breakOn "charset=" mt
76+ in if T.null y
77+ then Nothing
78+ else Just $ T.toUpper $ T.takeWhile (/= ';') $ T.drop 8 y
79+
5780-- | Collection of common mime types.
5881-- Except for first entry, list borrowed from
5982-- <https://github.com/Happstack/happstack-server/blob/master/src/Happstack/Server/FileServe/BuildingBlocks.hs happstack-server>
src/Text/Pandoc/MediaBag.hs+46−15
@@ -1,9 +1,10 @@
11{-# LANGUAGE CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
23{-# LANGUAGE DeriveDataTypeable #-}
34{-# LANGUAGE GeneralizedNewtypeDeriving #-}
45{- |
56 Module : Text.Pandoc.MediaBag
6− Copyright : Copyright (C) 2014-2015, 2017–2020 John MacFarlane
7+ Copyright : Copyright (C) 2014-2015, 2017-2021 John MacFarlane
78 License : GNU GPL, version 2 or above
89
910 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -14,6 +15,7 @@ Definition of a MediaBag object to hold binary resources, and an
1415interface for interacting with it.
1516-}
1617module Text.Pandoc.MediaBag (
18+ MediaItem(..),
1719 MediaBag,
1820 deleteMedia,
1921 lookupMedia,
@@ -24,29 +26,43 @@ module Text.Pandoc.MediaBag (
2426import qualified Data.ByteString.Lazy as BL
2527import Data.Data (Data)
2628import qualified Data.Map as M
27−import Data.Maybe (fromMaybe)
29+import Data.Maybe (fromMaybe, isNothing)
2830import Data.Typeable (Typeable)
2931import System.FilePath
30−import qualified System.FilePath.Posix as Posix
31−import Text.Pandoc.MIME (MimeType, getMimeTypeDef)
32+import Text.Pandoc.MIME (MimeType, getMimeTypeDef, extensionFromMimeType)
33+import Data.Text (Text)
34+import qualified Data.Text as T
35+import Data.Digest.Pure.SHA (sha1, showDigest)
36+import Network.URI (URI (..), parseURI)
37+
38+data MediaItem =
39+ MediaItem
40+ { mediaMimeType :: MimeType
41+ , mediaPath :: FilePath
42+ , mediaContents :: BL.ByteString
43+ } deriving (Eq, Ord, Show, Data, Typeable)
3244
3345-- | A container for a collection of binary resources, with names and
3446-- mime types. Note that a 'MediaBag' is a Monoid, so 'mempty'
3547-- can be used for an empty 'MediaBag', and '<>' can be used to append
3648-- two 'MediaBag's.
37−newtype MediaBag = MediaBag (M.Map [FilePath] (MimeType, BL.ByteString))
49+newtype MediaBag = MediaBag (M.Map Text MediaItem)
3850 deriving (Semigroup, Monoid, Data, Typeable)
3951
4052instance Show MediaBag where
4153 show bag = "MediaBag " ++ show (mediaDirectory bag)
4254
55+-- | We represent paths with /, in normalized form.
56+canonicalize :: FilePath -> Text
57+canonicalize = T.replace "\\" "/" . T.pack . normalise
58+
4359-- | Delete a media item from a 'MediaBag', or do nothing if no item corresponds
4460-- to the given path.
4561deleteMedia :: FilePath -- ^ relative path and canonical name of resource
4662 -> MediaBag
4763 -> MediaBag
4864deleteMedia fp (MediaBag mediamap) =
49− MediaBag $ M.delete (splitDirectories fp) mediamap
65+ MediaBag $ M.delete (canonicalize fp) mediamap
5066
5167-- | Insert a media item into a 'MediaBag', replacing any existing
5268-- value with the same name.
@@ -56,26 +72,41 @@ insertMedia :: FilePath -- ^ relative path and canonical name of resource
5672 -> MediaBag
5773 -> MediaBag
5874insertMedia fp mbMime contents (MediaBag mediamap) =
59− MediaBag (M.insert (splitDirectories fp) (mime, contents) mediamap)
60− where mime = fromMaybe fallback mbMime
75+ MediaBag (M.insert fp' mediaItem mediamap)
76+ where mediaItem = MediaItem{ mediaPath = newpath
77+ , mediaContents = contents
78+ , mediaMimeType = mt }
79+ fp' = canonicalize fp
80+ uri = parseURI fp
81+ newpath = if isRelative fp
82+ && isNothing uri
83+ && ".." `notElem` splitPath fp
84+ then T.unpack fp'
85+ else showDigest (sha1 contents) <> "." <> ext
6186 fallback = case takeExtension fp of
6287 ".gz" -> getMimeTypeDef $ dropExtension fp
6388 _ -> getMimeTypeDef fp
89+ mt = fromMaybe fallback mbMime
90+ path = maybe fp uriPath uri
91+ ext = case takeExtension path of
92+ '.':e -> e
93+ _ -> maybe "" T.unpack $ extensionFromMimeType mt
94+
6495
6596-- | Lookup a media item in a 'MediaBag', returning mime type and contents.
6697lookupMedia :: FilePath
6798 -> MediaBag
68− -> Maybe (MimeType, BL.ByteString)
69−lookupMedia fp (MediaBag mediamap) = M.lookup (splitDirectories fp) mediamap
99+ -> Maybe MediaItem
100+lookupMedia fp (MediaBag mediamap) = M.lookup (canonicalize fp) mediamap
70101
71102-- | Get a list of the file paths stored in a 'MediaBag', with
72103-- their corresponding mime types and the lengths in bytes of the contents.
73104mediaDirectory :: MediaBag -> [(FilePath, MimeType, Int)]
74−mediaDirectory (MediaBag mediamap) =
75− M.foldrWithKey (\fp (mime,contents) ->
76− ((Posix.joinPath fp, mime, fromIntegral $ BL.length contents):)) [] mediamap
105+mediaDirectory mediabag =
106+ map (\(fp, mt, bs) -> (fp, mt, fromIntegral (BL.length bs)))
107+ (mediaItems mediabag)
77108
78109mediaItems :: MediaBag -> [(FilePath, MimeType, BL.ByteString)]
79110mediaItems (MediaBag mediamap) =
80− M.foldrWithKey (\fp (mime,contents) ->
81− ((Posix.joinPath fp, mime, contents):)) [] mediamap
111+ map (\item -> (mediaPath item, mediaMimeType item, mediaContents item))
112+ (M.elems mediamap)
src/Text/Pandoc/Options.hs+21−18
@@ -6,7 +6,7 @@
66{-# LANGUAGE TemplateHaskell #-}
77{- |
88 Module : Text.Pandoc.Options
9− Copyright : Copyright (C) 2012-2020 John MacFarlane
9+ Copyright : Copyright (C) 2012-2021 John MacFarlane
1010 License : GNU GPL, version 2 or above
1111
1212 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -65,6 +65,7 @@ data ReaderOptions = ReaderOptions{
6565 , readerDefaultImageExtension :: Text -- ^ Default extension for images
6666 , readerTrackChanges :: TrackChanges -- ^ Track changes setting for docx
6767 , readerStripComments :: Bool -- ^ Strip HTML comments instead of parsing as raw HTML
68+ -- (only implemented in commonmark)
6869} deriving (Show, Read, Data, Typeable, Generic)
6970
7071instance HasSyntaxExtensions ReaderOptions where
@@ -289,7 +290,7 @@ instance Default WriterOptions where
289290 , writerTopLevelDivision = TopLevelDefault
290291 , writerListings = False
291292 , writerHighlightStyle = Just pygments
292− , writerSetextHeaders = True
293+ , writerSetextHeaders = False
293294 , writerEpubSubdirectory = "EPUB"
294295 , writerEpubMetadata = Nothing
295296 , writerEpubFonts = []
@@ -314,6 +315,24 @@ defaultMathJaxURL = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.j
314315defaultKaTeXURL :: Text
315316defaultKaTeXURL = "https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/"
316317
318+-- Update documentation in doc/filters.md if this is changed.
319+$(deriveJSON defaultOptions{ constructorTagModifier =
320+ camelCaseStrToHyphenated
321+ } ''TrackChanges)
322+
323+$(deriveJSON defaultOptions{ constructorTagModifier =
324+ camelCaseStrToHyphenated
325+ } ''WrapOption)
326+
327+$(deriveJSON defaultOptions{ constructorTagModifier =
328+ camelCaseStrToHyphenated . drop 8
329+ } ''TopLevelDivision)
330+
331+$(deriveJSON defaultOptions{ constructorTagModifier =
332+ camelCaseStrToHyphenated
333+ } ''ReferenceLocation)
334+
335+-- Update documentation in doc/filters.md if this is changed.
317336$(deriveJSON defaultOptions ''ReaderOptions)
318337
319338$(deriveJSON defaultOptions{
@@ -336,19 +355,3 @@ $(deriveJSON defaultOptions{ constructorTagModifier =
336355 } ''ObfuscationMethod)
337356
338357$(deriveJSON defaultOptions ''HTMLSlideVariant)
339−
340−$(deriveJSON defaultOptions{ constructorTagModifier =
341− camelCaseStrToHyphenated
342− } ''TrackChanges)
343−
344−$(deriveJSON defaultOptions{ constructorTagModifier =
345− camelCaseStrToHyphenated
346− } ''WrapOption)
347−
348−$(deriveJSON defaultOptions{ constructorTagModifier =
349− camelCaseStrToHyphenated . drop 8
350− } ''TopLevelDivision)
351−
352−$(deriveJSON defaultOptions{ constructorTagModifier =
353− camelCaseStrToHyphenated
354− } ''ReferenceLocation)
src/Text/Pandoc/PDF.hs+38−17
@@ -4,7 +4,7 @@
44{-# LANGUAGE ScopedTypeVariables #-}
55{- |
66 Module : Text.Pandoc.PDF
7− Copyright : Copyright (C) 2012-2020 John MacFarlane
7+ Copyright : Copyright (C) 2012-2021 John MacFarlane
88 License : GNU GPL, version 2 or above
99
1010 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -43,6 +43,7 @@ import Text.Pandoc.Definition
4343import Text.Pandoc.Error (PandocError (PandocPDFProgramNotFoundError))
4444import Text.Pandoc.MIME (getMimeType)
4545import Text.Pandoc.Options (HTMLMathMethod (..), WriterOptions (..))
46+import Text.Pandoc.Extensions (disableExtension, Extension(Ext_smart))
4647import Text.Pandoc.Process (pipeProcess)
4748import System.Process (readProcessWithExitCode)
4849import Text.Pandoc.Shared (inDirectory, stringify, tshow)
@@ -60,7 +61,10 @@ import Text.Pandoc.Logging
6061
6162#ifdef _WINDOWS
6263changePathSeparators :: FilePath -> FilePath
63−changePathSeparators = intercalate "/" . splitDirectories
64+changePathSeparators =
65+ -- We filter out backslashes because an initial `C:\` gets
66+ -- retained by `splitDirectories`, see #6173:
67+ intercalate "/" . map (filter (/='\\')) . splitDirectories
6468#endif
6569
6670makePDF :: String -- ^ pdf creator (pdflatex, lualatex, xelatex,
@@ -111,7 +115,10 @@ makePDF program pdfargs writer opts doc =
111115 runIOorExplode $ do
112116 putCommonState commonState
113117 doc' <- handleImages opts tmpdir doc
114− source <- writer opts doc'
118+ source <- writer opts{ writerExtensions = -- disable use of quote
119+ -- ligatures to avoid bad ligatures like ?`
120+ disableExtension Ext_smart
121+ (writerExtensions opts) } doc'
115122 res <- case baseProg of
116123 "context" -> context2pdf verbosity program pdfargs tmpdir source
117124 "tectonic" -> tectonic2pdf verbosity program pdfargs tmpdir source
@@ -195,7 +202,7 @@ convertImage opts tmpdir fname = do
195202 Just "image/svg+xml" -> E.catch (do
196203 (exit, _) <- pipeProcess Nothing "rsvg-convert"
197204 ["-f","pdf","-a","--dpi-x",dpi,"--dpi-y",dpi,
198− "-o",pdfOut,fname] BL.empty
205+ "-o",pdfOut,svgIn] BL.empty
199206 if exit == ExitSuccess
200207 then return $ Right pdfOut
201208 else return $ Left "conversion from SVG failed")
@@ -210,6 +217,7 @@ convertImage opts tmpdir fname = do
210217 where
211218 pngOut = replaceDirectory (replaceExtension fname ".png") tmpdir
212219 pdfOut = replaceDirectory (replaceExtension fname ".pdf") tmpdir
220+ svgIn = tmpdir </> fname
213221 mime = getMimeType fname
214222 doNothing = return (Right fname)
215223
@@ -263,7 +271,7 @@ missingCharacterWarnings verbosity log' = do
263271 | isAscii c = T.singleton c
264272 | otherwise = T.pack $ c : " (U+" ++ printf "%04X" (ord c) ++ ")"
265273 let addCodePoint = T.concatMap toCodePoint
266− let warnings = [ addCodePoint (T.pack $ utf8ToString (BC.drop 19 l))
274+ let warnings = [ addCodePoint (utf8ToText (BC.drop 19 l))
267275 | l <- ls
268276 , isMissingCharacterWarning l
269277 ]
@@ -307,7 +315,7 @@ runTectonic verbosity program args' tmpDir' source = do
307315 env <- liftIO getEnvironment
308316 when (verbosity >= INFO) $ liftIO $
309317 showVerboseInfo (Just tmpDir) program programArgs env
310− (utf8ToString sourceBL)
318+ (utf8ToText sourceBL)
311319 (exit, out) <- liftIO $ E.catch
312320 (pipeProcess (Just env) program programArgs sourceBL)
313321 (handlePDFProgramNotFound program)
@@ -378,7 +386,7 @@ runTeXProgram verbosity program args numRuns tmpDir' source = do
378386 (pipeProcess (Just env'') program programArgs BL.empty)
379387 (handlePDFProgramNotFound program)
380388 when (verbosity >= INFO) $ liftIO $ do
381− UTF8.hPutStrLn stderr $ "[makePDF] Run #" ++ show runNumber
389+ UTF8.hPutStrLn stderr $ "[makePDF] Run #" <> tshow runNumber
382390 BL.hPutStr stderr out
383391 UTF8.hPutStr stderr "\n"
384392 if runNumber < numRuns
@@ -398,7 +406,7 @@ generic2pdf :: Verbosity
398406generic2pdf verbosity program args source = do
399407 env' <- getEnvironment
400408 when (verbosity >= INFO) $
401− showVerboseInfo Nothing program args env' (T.unpack source)
409+ showVerboseInfo Nothing program args env' source
402410 (exit, out) <- E.catch
403411 (pipeProcess (Just env') program args
404412 (BL.fromStrict $ UTF8.fromText source))
@@ -487,19 +495,32 @@ showVerboseInfo :: Maybe FilePath
487495 -> String
488496 -> [String]
489497 -> [(String, String)]
490− -> String
498+ -> Text
491499 -> IO ()
492500showVerboseInfo mbTmpDir program programArgs env source = do
493501 case mbTmpDir of
494502 Just tmpDir -> do
495503 UTF8.hPutStrLn stderr "[makePDF] temp dir:"
496− UTF8.hPutStrLn stderr tmpDir
504+ UTF8.hPutStrLn stderr (T.pack tmpDir)
497505 Nothing -> return ()
498506 UTF8.hPutStrLn stderr "[makePDF] Command line:"
499− UTF8.hPutStrLn stderr $ program ++ " " ++ unwords (map show programArgs)
507+ UTF8.hPutStrLn stderr $
508+ T.pack program <> " " <> T.pack (unwords (map show programArgs))
500509 UTF8.hPutStr stderr "\n"
501− UTF8.hPutStrLn stderr "[makePDF] Environment:"
502− mapM_ (UTF8.hPutStrLn stderr . show) env
510+ UTF8.hPutStrLn stderr "[makePDF] Relevant environment variables:"
511+ -- we filter out irrelevant stuff to avoid leaking passwords and keys!
512+ let isRelevant ("PATH",_) = True
513+ isRelevant ("TMPDIR",_) = True
514+ isRelevant ("PWD",_) = True
515+ isRelevant ("LANG",_) = True
516+ isRelevant ("HOME",_) = True
517+ isRelevant ("LUA_PATH",_) = True
518+ isRelevant ("LUA_CPATH",_) = True
519+ isRelevant ("SHELL",_) = True
520+ isRelevant ("TEXINPUTS",_) = True
521+ isRelevant ("TEXMFOUTPUT",_) = True
522+ isRelevant _ = False
523+ mapM_ (UTF8.hPutStrLn stderr . tshow) (filter isRelevant env)
503524 UTF8.hPutStr stderr "\n"
504525 UTF8.hPutStrLn stderr "[makePDF] Source:"
505526 UTF8.hPutStrLn stderr source
@@ -510,8 +531,8 @@ handlePDFProgramNotFound program e
510531 E.throwIO $ PandocPDFProgramNotFoundError $ T.pack program
511532 | otherwise = E.throwIO e
512533
513−utf8ToString :: ByteString -> String
514−utf8ToString lbs =
534+utf8ToText :: ByteString -> Text
535+utf8ToText lbs =
515536 case decodeUtf8' lbs of
516− Left _ -> BC.unpack lbs -- if decoding fails, treat as latin1
517− Right t -> TL.unpack t
537+ Left _ -> T.pack $ BC.unpack lbs -- if decoding fails, treat as latin1
538+ Right t -> TL.toStrict t
src/Text/Pandoc/Parsing.hs+410−265
@@ -5,11 +5,10 @@
55{-# LANGUAGE GeneralizedNewtypeDeriving #-}
66{-# LANGUAGE IncoherentInstances #-}
77{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE ViewPatterns #-}
98{-# LANGUAGE OverloadedStrings #-}
109{- |
1110 Module : Text.Pandoc.Parsing
12− Copyright : Copyright (C) 2006-2020 John MacFarlane
11+ Copyright : Copyright (C) 2006-2021 John MacFarlane
1312 License : GNU GPL, version 2 or above
1413
1514 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -19,8 +18,7 @@
1918A utility library with parsers used in pandoc readers.
2019-}
2120
22−module Text.Pandoc.Parsing ( take1WhileP,
23− takeP,
21+module Text.Pandoc.Parsing ( module Text.Pandoc.Sources,
2422 countChar,
2523 textStr,
2624 anyLine,
@@ -105,14 +103,14 @@ module Text.Pandoc.Parsing ( take1WhileP,
105103 singleQuoteEnd,
106104 doubleQuoteStart,
107105 doubleQuoteEnd,
108− ellipses,
109106 apostrophe,
107+ doubleCloseQuote,
108+ ellipses,
110109 dash,
111110 nested,
112111 citeKey,
113112 Parser,
114113 ParserT,
115− F,
116114 Future(..),
117115 runF,
118116 askF,
@@ -123,7 +121,6 @@ module Text.Pandoc.Parsing ( take1WhileP,
123121 (<+?>),
124122 extractIdClass,
125123 insertIncludedFile,
126− insertIncludedFileF,
127124 -- * Re-exports from Text.Parsec
128125 Stream,
129126 runParser,
@@ -134,22 +131,10 @@ module Text.Pandoc.Parsing ( take1WhileP,
134131 getInput,
135132 setInput,
136133 unexpected,
137− char,
138− letter,
139− digit,
140− alphaNum,
141134 skipMany,
142135 skipMany1,
143− spaces,
144− space,
145− anyChar,
146− satisfy,
147− newline,
148− string,
149136 count,
150137 eof,
151− noneOf,
152− oneOf,
153138 lookAhead,
154139 notFollowedBy,
155140 many,
@@ -174,6 +159,8 @@ module Text.Pandoc.Parsing ( take1WhileP,
174159 SourcePos,
175160 getPosition,
176161 setPosition,
162+ sourceName,
163+ setSourceName,
177164 sourceColumn,
178165 sourceLine,
179166 setSourceColumn,
@@ -189,48 +176,141 @@ module Text.Pandoc.Parsing ( take1WhileP,
189176where
190177
191178import Control.Monad.Identity
179+ ( guard,
180+ join,
181+ unless,
182+ when,
183+ void,
184+ liftM2,
185+ liftM,
186+ Identity(..),
187+ MonadPlus(mzero) )
192188import Control.Monad.Reader
193−import Data.Char (chr, isAlphaNum, isAscii, isAsciiUpper,
194− isPunctuation, isSpace, ord, toLower, toUpper)
195−import Data.Default
189+ ( asks, runReader, MonadReader(ask), Reader, ReaderT(ReaderT) )
190+import Data.Char (chr, isAlphaNum, isAscii, isAsciiUpper, isAsciiLower,
191+ isSpace, ord, toLower, toUpper)
192+import Data.Default ( Default(..) )
196193import Data.Functor (($>))
197194import Data.List (intercalate, transpose)
198195import qualified Data.Map as M
199−import Data.Maybe (mapMaybe, fromMaybe)
196+import Data.Maybe (fromMaybe)
200197import qualified Data.Set as Set
201−import Data.String
202198import Data.Text (Text)
203199import qualified Data.Text as T
204200import Text.HTML.TagSoup.Entity (lookupEntity)
205−import Text.Pandoc.Asciify (toAsciiChar)
201+import Text.Pandoc.Asciify (toAsciiText)
206202import Text.Pandoc.Builder (Blocks, HasMeta (..), Inlines, trimInlines)
207203import qualified Text.Pandoc.Builder as B
208204import Text.Pandoc.Class.PandocMonad (PandocMonad, readFileFromDirs, report)
209205import Text.Pandoc.Definition
206+ ( Target,
207+ nullMeta,
208+ nullAttr,
209+ Meta,
210+ ColWidth(ColWidthDefault, ColWidth),
211+ TableFoot(TableFoot),
212+ TableBody(TableBody),
213+ Attr,
214+ TableHead(TableHead),
215+ Row(..),
216+ Alignment(..),
217+ Inline(Str),
218+ ListNumberDelim(..),
219+ ListAttributes,
220+ ListNumberStyle(..) )
210221import Text.Pandoc.Logging
222+ ( LogMessage(CouldNotLoadIncludeFile, DuplicateIdentifier) )
211223import Text.Pandoc.Options
224+ ( extensionEnabled,
225+ Extension(Ext_old_dashes, Ext_tex_math_dollars,
226+ Ext_tex_math_single_backslash, Ext_tex_math_double_backslash,
227+ Ext_auto_identifiers, Ext_ascii_identifiers, Ext_smart),
228+ ReaderOptions(readerTabStop, readerColumns, readerExtensions) )
212229import Text.Pandoc.Readers.LaTeX.Types (Macro)
213230import Text.Pandoc.Shared
231+ ( uniqueIdent,
232+ tshow,
233+ mapLeft,
234+ compactify,
235+ trim,
236+ trimr,
237+ splitTextByIndices,
238+ safeRead,
239+ trimMath,
240+ schemes,
241+ escapeURI )
242+import Text.Pandoc.Sources
214243import qualified Text.Pandoc.UTF8 as UTF8 (putStrLn)
215244import Text.Pandoc.XML (fromEntities)
216−import Text.Parsec hiding (token)
217−import Text.Parsec.Pos (initialPos, newPos, updatePosString)
218−
219−import Control.Monad.Except
245+import Text.Parsec
246+ ( between,
247+ setSourceName,
248+ Parsec,
249+ Column,
250+ Line,
251+ incSourceLine,
252+ incSourceColumn,
253+ setSourceLine,
254+ setSourceColumn,
255+ sourceLine,
256+ sourceColumn,
257+ sourceName,
258+ setSourceName,
259+ setPosition,
260+ getPosition,
261+ updateState,
262+ setState,
263+ getState,
264+ optionMaybe,
265+ optional,
266+ option,
267+ endBy1,
268+ endBy,
269+ sepEndBy1,
270+ sepEndBy,
271+ sepBy1,
272+ sepBy,
273+ try,
274+ choice,
275+ (<?>),
276+ (<|>),
277+ manyTill,
278+ many1,
279+ many,
280+ notFollowedBy,
281+ lookAhead,
282+ eof,
283+ count,
284+ skipMany1,
285+ skipMany,
286+ unexpected,
287+ setInput,
288+ getInput,
289+ anyToken,
290+ tokenPrim,
291+ parse,
292+ runParserT,
293+ runParser,
294+ ParseError,
295+ ParsecT,
296+ SourcePos,
297+ Stream(..) )
298+import Text.Parsec.Pos (initialPos, newPos)
299+import Control.Monad.Except ( MonadError(throwError) )
220300import Text.Pandoc.Error
301+ ( PandocError(PandocParseError, PandocParsecError) )
221302
222303type Parser t s = Parsec t s
223304
224305type ParserT = ParsecT
225306
307+
226308-- | Reader monad wrapping the parser state. This is used to possibly delay
227309-- evaluation until all relevant information has been parsed and made available
228310-- in the parser state.
229311newtype Future s a = Future { runDelayed :: Reader s a }
230312 deriving (Monad, Applicative, Functor)
231313
232−type F = Future ParserState
233−
234314runF :: Future s a -> s -> a
235315runF = runReader . runDelayed
236316
@@ -253,70 +333,48 @@ instance (Semigroup a, Monoid a) => Monoid (Future s a) where
253333 mappend = (<>)
254334
255335-- | Like @count@, but packs its result
256−countChar :: (Stream s m Char, Monad m)
336+countChar :: (Stream s m Char, UpdateSourcePos s Char, Monad m)
257337 => Int
258338 -> ParsecT s st m Char
259339 -> ParsecT s st m Text
260340countChar n = fmap T.pack . count n
261341
262342-- | Like @string@, but uses @Text@.
263−textStr :: Stream s m Char => Text -> ParsecT s u m Text
343+textStr :: (Stream s m Char, UpdateSourcePos s Char)
344+ => Text -> ParsecT s u m Text
264345textStr t = string (T.unpack t) $> t
265346
266−-- | Parse characters while a predicate is true.
267−take1WhileP :: Monad m
268− => (Char -> Bool)
269− -> ParserT Text st m Text
270−take1WhileP f = do
271− -- needed to persuade parsec that this won't match an empty string:
272− c <- satisfy f
273− inp <- getInput
274− pos <- getPosition
275− let (t, rest) = T.span f inp
276− setInput rest
277− setPosition $
278− if f '\t' || f '\n'
279− then updatePosString pos $ T.unpack t
280− else incSourceColumn pos (T.length t)
281− return $ T.singleton c <> t
282−
283−-- Parse n characters of input (or the rest of the input if
284−-- there aren't n characters).
285−takeP :: Monad m => Int -> ParserT Text st m Text
286−takeP n = do
287− guard (n > 0)
288− -- faster than 'count n anyChar'
289− inp <- getInput
290− pos <- getPosition
291− let (xs, rest) = T.splitAt n inp
292− -- needed to persuade parsec that this won't match an empty string:
293− anyChar
294− setInput rest
295− setPosition $ updatePosString pos $ T.unpack xs
296− return xs
297−
298−-- | Parse any line of text
299−anyLine :: Monad m => ParserT Text st m Text
347+
348+-- | Parse any line of text, returning the contents without the
349+-- final newline.
350+anyLine :: Monad m => ParserT Sources st m Text
300351anyLine = do
301352 -- This is much faster than:
302353 -- manyTill anyChar newline
303354 inp <- getInput
304− pos <- getPosition
305− case T.break (=='\n') inp of
306− (this, T.uncons -> Just ('\n', rest)) -> do
307− -- needed to persuade parsec that this won't match an empty string:
308− anyChar
309− setInput rest
310− setPosition $ incSourceLine (setSourceColumn pos 1) 1
311− return this
312− _ -> mzero
355+ case inp of
356+ Sources [] -> mzero
357+ Sources ((fp,t):inps) ->
358+ -- we assume that lines don't span different input files
359+ case T.break (=='\n') t of
360+ (this, rest)
361+ | T.null rest
362+ , not (null inps) ->
363+ -- line may span different input files, so do it
364+ -- character by character
365+ T.pack <$> manyTill anyChar newline
366+ | otherwise -> do -- either end of inputs or newline in rest
367+ setInput $ Sources ((fp, rest):inps)
368+ char '\n' -- needed so parsec knows we won't match empty string
369+ -- and so source pos is updated
370+ return this
313371
314372-- | Parse any line, include the final newline in the output
315−anyLineNewline :: Monad m => ParserT Text st m Text
373+anyLineNewline :: Monad m => ParserT Sources st m Text
316374anyLineNewline = (<> "\n") <$> anyLine
317375
318376-- | Parse indent by specified number of spaces (or equiv. tabs)
319−indentWith :: Stream s m Char
377+indentWith :: (Stream s m Char, UpdateSourcePos s Char)
320378 => HasReaderOptions st
321379 => Int -> ParserT s st m Text
322380indentWith num = do
@@ -401,11 +459,13 @@ notFollowedBy' p = try $ join $ do a <- try p
401459 return (return ())
402460-- (This version due to Andrew Pimlott on the Haskell mailing list.)
403461
404−oneOfStrings' :: Stream s m Char => (Char -> Char -> Bool) -> [Text] -> ParserT s st m Text
462+oneOfStrings' :: (Stream s m Char, UpdateSourcePos s Char)
463+ => (Char -> Char -> Bool) -> [Text] -> ParserT s st m Text
405464oneOfStrings' f = fmap T.pack . oneOfStrings'' f . fmap T.unpack
406465
407466-- TODO: This should be re-implemented in a Text-aware way
408−oneOfStrings'' :: Stream s m Char => (Char -> Char -> Bool) -> [String] -> ParserT s st m String
467+oneOfStrings'' :: (Stream s m Char, UpdateSourcePos s Char)
468+ => (Char -> Char -> Bool) -> [String] -> ParserT s st m String
409469oneOfStrings'' _ [] = Prelude.fail "no strings"
410470oneOfStrings'' matches strs = try $ do
411471 c <- anyChar
@@ -420,14 +480,16 @@ oneOfStrings'' matches strs = try $ do
420480-- | Parses one of a list of strings. If the list contains
421481-- two strings one of which is a prefix of the other, the longer
422482-- string will be matched if possible.
423−oneOfStrings :: Stream s m Char => [Text] -> ParserT s st m Text
483+oneOfStrings :: (Stream s m Char, UpdateSourcePos s Char)
484+ => [Text] -> ParserT s st m Text
424485oneOfStrings = oneOfStrings' (==)
425486
426487-- | Parses one of a list of strings (tried in order), case insensitive.
427488
428489-- TODO: This will not be accurate with general Unicode (neither
429490-- Text.toLower nor Text.toCaseFold can be implemented with a map)
430−oneOfStringsCI :: Stream s m Char => [Text] -> ParserT s st m Text
491+oneOfStringsCI :: (Stream s m Char, UpdateSourcePos s Char)
492+ => [Text] -> ParserT s st m Text
431493oneOfStringsCI = oneOfStrings' ciMatch
432494 where ciMatch x y = toLower' x == toLower' y
433495 -- this optimizes toLower by checking common ASCII case
@@ -438,29 +500,41 @@ oneOfStringsCI = oneOfStrings' ciMatch
438500 | otherwise = toLower c
439501
440502-- | Parses a space or tab.
441−spaceChar :: Stream s m Char => ParserT s st m Char
503+spaceChar :: (Stream s m Char, UpdateSourcePos s Char)
504+ => ParserT s st m Char
442505spaceChar = satisfy $ \c -> c == ' ' || c == '\t'
443506
444507-- | Parses a nonspace, nonnewline character.
445−nonspaceChar :: Stream s m Char => ParserT s st m Char
446−nonspaceChar = noneOf ['\t', '\n', ' ', '\r']
508+nonspaceChar :: (Stream s m Char, UpdateSourcePos s Char)
509+ => ParserT s st m Char
510+nonspaceChar = satisfy (not . isSpaceChar)
511+
512+isSpaceChar :: Char -> Bool
513+isSpaceChar ' ' = True
514+isSpaceChar '\t' = True
515+isSpaceChar '\n' = True
516+isSpaceChar '\r' = True
517+isSpaceChar _ = False
447518
448519-- | Skips zero or more spaces or tabs.
449−skipSpaces :: Stream s m Char => ParserT s st m ()
520+skipSpaces :: (Stream s m Char, UpdateSourcePos s Char)
521+ => ParserT s st m ()
450522skipSpaces = skipMany spaceChar
451523
452524-- | Skips zero or more spaces or tabs, then reads a newline.
453−blankline :: Stream s m Char => ParserT s st m Char
525+blankline :: (Stream s m Char, UpdateSourcePos s Char)
526+ => ParserT s st m Char
454527blankline = try $ skipSpaces >> newline
455528
456529-- | Parses one or more blank lines and returns a string of newlines.
457−blanklines :: Stream s m Char => ParserT s st m Text
530+blanklines :: (Stream s m Char, UpdateSourcePos s Char)
531+ => ParserT s st m Text
458532blanklines = T.pack <$> many1 blankline
459533
460534-- | Gobble n spaces; if tabs are encountered, expand them
461535-- and gobble some or all of their spaces, leaving the rest.
462536gobbleSpaces :: (HasReaderOptions st, Monad m)
463− => Int -> ParserT Text st m ()
537+ => Int -> ParserT Sources st m ()
464538gobbleSpaces 0 = return ()
465539gobbleSpaces n
466540 | n < 0 = error "gobbleSpaces called with negative number"
@@ -468,18 +542,26 @@ gobbleSpaces n
468542 char ' ' <|> eatOneSpaceOfTab
469543 gobbleSpaces (n - 1)
470544
471−eatOneSpaceOfTab :: (HasReaderOptions st, Monad m) => ParserT Text st m Char
545+eatOneSpaceOfTab :: (HasReaderOptions st, Monad m) => ParserT Sources st m Char
472546eatOneSpaceOfTab = do
473− char '\t'
547+ lookAhead (char '\t')
548+ pos <- getPosition
474549 tabstop <- getOption readerTabStop
550+ -- replace the tab on the input stream with spaces
551+ let numSpaces = tabstop - ((sourceColumn pos - 1) `mod` tabstop)
475552 inp <- getInput
476− setInput $ T.replicate (tabstop - 1) " " <> inp
477− return ' '
553+ setInput $
554+ case inp of
555+ Sources [] -> error "eatOneSpaceOfTab - empty Sources list"
556+ Sources ((fp,t):rest) ->
557+ -- drop the tab and add spaces
558+ Sources ((fp, T.replicate numSpaces " " <> T.drop 1 t):rest)
559+ char ' '
478560
479561-- | Gobble up to n spaces; if tabs are encountered, expand them
480562-- and gobble some or all of their spaces, leaving the rest.
481563gobbleAtMostSpaces :: (HasReaderOptions st, Monad m)
482− => Int -> ParserT Text st m Int
564+ => Int -> ParserT Sources st m Int
483565gobbleAtMostSpaces 0 = return 0
484566gobbleAtMostSpaces n
485567 | n < 0 = error "gobbleAtMostSpaces called with negative number"
@@ -488,7 +570,8 @@ gobbleAtMostSpaces n
488570 (+ 1) <$> gobbleAtMostSpaces (n - 1)
489571
490572-- | Parses material enclosed between start and end parsers.
491−enclosed :: (Show end, Stream s m Char) => ParserT s st m t -- ^ start parser
573+enclosed :: (Show end, Stream s m Char, UpdateSourcePos s Char)
574+ => ParserT s st m t -- ^ start parser
492575 -> ParserT s st m end -- ^ end parser
493576 -> ParserT s st m a -- ^ content parser (to be used repeatedly)
494577 -> ParserT s st m [a]
@@ -496,39 +579,41 @@ enclosed start end parser = try $
496579 start >> notFollowedBy space >> many1Till parser end
497580
498581-- | Parse string, case insensitive.
499−stringAnyCase :: Stream s m Char => Text -> ParserT s st m Text
582+stringAnyCase :: (Stream s m Char, UpdateSourcePos s Char)
583+ => Text -> ParserT s st m Text
500584stringAnyCase = fmap T.pack . stringAnyCase' . T.unpack
501585
502−stringAnyCase' :: Stream s m Char => String -> ParserT s st m String
586+stringAnyCase' :: (Stream s m Char, UpdateSourcePos s Char)
587+ => String -> ParserT s st m String
503588stringAnyCase' [] = string ""
504589stringAnyCase' (x:xs) = do
505590 firstChar <- char (toUpper x) <|> char (toLower x)
506591 rest <- stringAnyCase' xs
507592 return (firstChar:rest)
508593
594+-- TODO rewrite by just adding to Sources stream?
509595-- | Parse contents of 'str' using 'parser' and return result.
510−parseFromString :: (Stream s m Char, IsString s)
511− => ParserT s st m r
596+parseFromString :: Monad m
597+ => ParserT Sources st m r
512598 -> Text
513− -> ParserT s st m r
599+ -> ParserT Sources st m r
514600parseFromString parser str = do
515601 oldPos <- getPosition
516602 setPosition $ initialPos "chunk"
517603 oldInput <- getInput
518− setInput $ fromString $ T.unpack str
604+ setInput $ toSources str
519605 result <- parser
520606 spaces
521− eof
522607 setInput oldInput
523608 setPosition oldPos
524609 return result
525610
526611-- | Like 'parseFromString' but specialized for 'ParserState'.
527612-- This resets 'stateLastStrPos', which is almost always what we want.
528−parseFromString' :: (Stream s m Char, IsString s, HasLastStrPosition u)
529− => ParserT s u m a
613+parseFromString' :: (Monad m, HasLastStrPosition u)
614+ => ParserT Sources u m a
530615 -> Text
531− -> ParserT s u m a
616+ -> ParserT Sources u m a
532617parseFromString' parser str = do
533618 oldLastStrPos <- getLastStrPos <$> getState
534619 updateState $ setLastStrPos Nothing
@@ -537,7 +622,7 @@ parseFromString' parser str = do
537622 return res
538623
539624-- | Parse raw line block up to and including blank lines.
540−lineClump :: Monad m => ParserT Text st m Text
625+lineClump :: Monad m => ParserT Sources st m Text
541626lineClump = blanklines
542627 <|> (T.unlines <$> many1 (notFollowedBy blankline >> anyLine))
543628
@@ -546,7 +631,7 @@ lineClump = blanklines
546631-- pairs of open and close, which must be different. For example,
547632-- @charsInBalanced '(' ')' anyChar@ will parse "(hello (there))"
548633-- and return "hello (there)".
549−charsInBalanced :: Stream s m Char => Char -> Char -> ParserT s st m Char
634+charsInBalanced :: (Stream s m Char, UpdateSourcePos s Char) => Char -> Char -> ParserT s st m Char
550635 -> ParserT s st m Text
551636charsInBalanced open close parser = try $ do
552637 char open
@@ -565,7 +650,7 @@ charsInBalanced open close parser = try $ do
565650-- Auxiliary functions for romanNumeral:
566651
567652-- | Parses a roman numeral (uppercase or lowercase), returns number.
568−romanNumeral :: Stream s m Char => Bool -- ^ Uppercase if true
653+romanNumeral :: (Stream s m Char, UpdateSourcePos s Char) => Bool -- ^ Uppercase if true
569654 -> ParserT s st m Int
570655romanNumeral upperCase = do
571656 let rchar uc = char $ if upperCase then uc else toLower uc
@@ -601,20 +686,19 @@ romanNumeral upperCase = do
601686
602687-- | Parses an email address; returns original and corresponding
603688-- escaped mailto: URI.
604−emailAddress :: Stream s m Char => ParserT s st m (Text, Text)
689+emailAddress :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (Text, Text)
605690emailAddress = try $ toResult <$> mailbox <*> (char '@' *> domain)
606691 where toResult mbox dom = let full = fromEntities $ T.pack $ mbox ++ '@':dom
607692 in (full, escapeURI $ "mailto:" <> full)
608693 mailbox = intercalate "." <$> (emailWord `sepBy1'` dot)
609694 domain = intercalate "." <$> (subdomain `sepBy1'` dot)
610695 dot = char '.'
611− subdomain = many1 $ alphaNum <|> innerPunct
696+ subdomain = many1 $ alphaNum <|> innerPunct (=='-')
612697 -- this excludes some valid email addresses, since an
613698 -- email could contain e.g. '__', but gives better results
614699 -- for our purposes, when combined with markdown parsing:
615− innerPunct = try (satisfy (\c -> isEmailPunct c || c == '@')
616− <* notFollowedBy space
617− <* notFollowedBy (satisfy isPunctuation))
700+ innerPunct f = try (satisfy f
701+ <* notFollowedBy (satisfy (not . isAlphaNum)))
618702 -- technically an email address could begin with a symbol,
619703 -- but allowing this creates too many problems.
620704 -- See e.g. https://github.com/jgm/pandoc/issues/2940
@@ -625,16 +709,16 @@ emailAddress = try $ toResult <$> mailbox <*> (char '@' *> domain)
625709 isEmailPunct c = T.any (== c) "!\"#$%&'*+-/=?^_{|}~;"
626710
627711
628−uriScheme :: Stream s m Char => ParserT s st m Text
712+uriScheme :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Text
629713uriScheme = oneOfStringsCI (Set.toList schemes)
630714
631715-- | Parses a URI. Returns pair of original and URI-escaped version.
632−uri :: Stream s m Char => ParserT s st m (Text, Text)
716+uri :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (Text, Text)
633717uri = try $ do
634718 scheme <- uriScheme
635719 char ':'
636720 -- Avoid parsing e.g. "**Notes:**" as a raw URI:
637− notFollowedBy (oneOf "*_]")
721+ notFollowedBy $ satisfy (\c -> c == '*' || c == '_' || c == ']')
638722 -- We allow sentence punctuation except at the end, since
639723 -- we don't want the trailing '.' in 'http://google.com.' We want to allow
640724 -- http://en.wikipedia.org/wiki/State_of_emergency_(disambiguation)
@@ -648,7 +732,20 @@ uri = try $ do
648732 let uri' = scheme <> ":" <> fromEntities str'
649733 return (uri', escapeURI uri')
650734 where
651− wordChar = alphaNum <|> oneOf "#$%+/@\\_-&="
735+ isWordChar '#' = True
736+ isWordChar '$' = True
737+ isWordChar '%' = True
738+ isWordChar '+' = True
739+ isWordChar '/' = True
740+ isWordChar '@' = True
741+ isWordChar '\\' = True
742+ isWordChar '_' = True
743+ isWordChar '-' = True
744+ isWordChar '&' = True
745+ isWordChar '=' = True
746+ isWordChar c = isAlphaNum c
747+
748+ wordChar = satisfy isWordChar
652749 percentEscaped = try $ (:) <$> char '%' <*> many1 hexDigit
653750 entity = try $ pure <$> characterReference
654751 punct = try $ many1 (char ',') <|> fmap pure (satisfy (\c -> not (isSpace c) && c /= '<' && c /= '>'))
@@ -659,11 +756,13 @@ uri = try $ do
659756 uriChunkBetween l r = try $ do chunk <- between (char l) (char r) uriChunk
660757 return (T.pack $ [l] ++ chunk ++ [r])
661758
662−mathInlineWith :: Stream s m Char => Text -> Text -> ParserT s st m Text
759+mathInlineWith :: (Stream s m Char, UpdateSourcePos s Char) => Text -> Text -> ParserT s st m Text
663760mathInlineWith op cl = try $ do
664761 textStr op
665762 when (op == "$") $ notFollowedBy space
666− words' <- many1Till (countChar 1 (noneOf " \t\n\\")
763+ words' <- many1Till (
764+ (T.singleton <$>
765+ satisfy (\c -> not (isSpaceChar c || c == '\\')))
667766 <|> (char '\\' >>
668767 -- This next clause is needed because \text{..} can
669768 -- contain $, \(\), etc.
@@ -671,17 +770,17 @@ mathInlineWith op cl = try $ do
671770 (("\\text" <>) <$> inBalancedBraces 0 ""))
672771 <|> (\c -> T.pack ['\\',c]) <$> anyChar))
673772 <|> do (blankline <* notFollowedBy' blankline) <|>
674− (oneOf " \t" <* skipMany (oneOf " \t"))
773+ (spaceChar <* skipMany spaceChar)
675774 notFollowedBy (char '$')
676775 return " "
677776 ) (try $ textStr cl)
678777 notFollowedBy digit -- to prevent capture of $5
679778 return $ trimMath $ T.concat words'
680779 where
681− inBalancedBraces :: Stream s m Char => Int -> Text -> ParserT s st m Text
780+ inBalancedBraces :: (Stream s m Char, UpdateSourcePos s Char) => Int -> Text -> ParserT s st m Text
682781 inBalancedBraces n = fmap T.pack . inBalancedBraces' n . T.unpack
683782
684− inBalancedBraces' :: Stream s m Char => Int -> String -> ParserT s st m String
783+ inBalancedBraces' :: (Stream s m Char, UpdateSourcePos s Char) => Int -> String -> ParserT s st m String
685784 inBalancedBraces' 0 "" = do
686785 c <- anyChar
687786 if c == '{'
@@ -698,12 +797,13 @@ mathInlineWith op cl = try $ do
698797 '{' -> inBalancedBraces' (numOpen + 1) (c:xs)
699798 _ -> inBalancedBraces' numOpen (c:xs)
700799
701−mathDisplayWith :: Stream s m Char => Text -> Text -> ParserT s st m Text
800+mathDisplayWith :: (Stream s m Char, UpdateSourcePos s Char) => Text -> Text -> ParserT s st m Text
702801mathDisplayWith op cl = try $ fmap T.pack $ do
703802 textStr op
704− many1Till (noneOf "\n" <|> (newline <* notFollowedBy' blankline)) (try $ textStr cl)
803+ many1Till (satisfy (/= '\n') <|> (newline <* notFollowedBy' blankline))
804+ (try $ textStr cl)
705805
706−mathDisplay :: (HasReaderOptions st, Stream s m Char)
806+mathDisplay :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char)
707807 => ParserT s st m Text
708808mathDisplay =
709809 (guardEnabled Ext_tex_math_dollars >> mathDisplayWith "$$" "$$")
@@ -712,7 +812,7 @@ mathDisplay =
712812 <|> (guardEnabled Ext_tex_math_double_backslash >>
713813 mathDisplayWith "\\\\[" "\\\\]")
714814
715−mathInline :: (HasReaderOptions st , Stream s m Char)
815+mathInline :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char)
716816 => ParserT s st m Text
717817mathInline =
718818 (guardEnabled Ext_tex_math_dollars >> mathInlineWith "$" "$")
@@ -725,7 +825,7 @@ mathInline =
725825-- displacement (the difference between the source column at the end
726826-- and the source column at the beginning). Vertical displacement
727827-- (source row) is ignored.
728−withHorizDisplacement :: Stream s m Char
828+withHorizDisplacement :: (Stream s m Char, UpdateSourcePos s Char)
729829 => ParserT s st m a -- ^ Parser to apply
730830 -> ParserT s st m (a, Int) -- ^ (result, displacement)
731831withHorizDisplacement parser = do
@@ -737,30 +837,37 @@ withHorizDisplacement parser = do
737837-- | Applies a parser and returns the raw string that was parsed,
738838-- along with the value produced by the parser.
739839withRaw :: Monad m
740− => ParsecT Text st m a
741− -> ParsecT Text st m (a, Text)
840+ => ParsecT Sources st m a
841+ -> ParsecT Sources st m (a, Text)
742842withRaw parser = do
743− pos1 <- getPosition
744− inp <- getInput
843+ inps1 <- getInput
745844 result <- parser
746− pos2 <- getPosition
747− let (l1,c1) = (sourceLine pos1, sourceColumn pos1)
748− let (l2,c2) = (sourceLine pos2, sourceColumn pos2)
749− let inplines = take ((l2 - l1) + 1) $ T.lines inp
750− let raw = case inplines of
751− [] -> ""
752− [l] -> T.take (c2 - c1) l
753− ls -> T.unlines (init ls) <> T.take (c2 - 1) (last ls)
754− return (result, raw)
845+ inps2 <- getInput
846+ -- 'raw' is the difference between inps1 and inps2
847+ return (result, sourcesDifference inps1 inps2)
848+
849+sourcesDifference :: Sources -> Sources -> Text
850+sourcesDifference (Sources is1) (Sources is2) = go is1 is2
851+ where
852+ go inps1 inps2 =
853+ case (inps1, inps2) of
854+ ([], _) -> mempty
855+ (_, []) -> mconcat $ map snd inps1
856+ ((p1,t1):rest1, (p2, t2):rest2)
857+ | p1 == p2
858+ , t1 == t2 -> go rest1 rest2
859+ | p1 == p2
860+ , t1 /= t2 -> fromMaybe mempty $ T.stripSuffix t2 t1
861+ | otherwise -> t1 <> go rest1 inps2
755862
756863-- | Parses backslash, then applies character parser.
757−escaped :: Stream s m Char
864+escaped :: (Stream s m Char, UpdateSourcePos s Char)
758865 => ParserT s st m Char -- ^ Parser for character to escape
759866 -> ParserT s st m Char
760867escaped parser = try $ char '\\' >> parser
761868
762869-- | Parse character entity.
763−characterReference :: Stream s m Char => ParserT s st m Char
870+characterReference :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char
764871characterReference = try $ do
765872 char '&'
766873 ent <- many1Till nonspaceChar (char ';')
@@ -773,19 +880,19 @@ characterReference = try $ do
773880 _ -> Prelude.fail "entity not found"
774881
775882-- | Parses an uppercase roman numeral and returns (UpperRoman, number).
776−upperRoman :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
883+upperRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
777884upperRoman = do
778885 num <- romanNumeral True
779886 return (UpperRoman, num)
780887
781888-- | Parses a lowercase roman numeral and returns (LowerRoman, number).
782−lowerRoman :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
889+lowerRoman :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
783890lowerRoman = do
784891 num <- romanNumeral False
785892 return (LowerRoman, num)
786893
787894-- | Parses a decimal numeral and returns (Decimal, number).
788−decimal :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
895+decimal :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
789896decimal = do
790897 num <- many1 digit
791898 return (Decimal, fromMaybe 1 $ safeRead $ T.pack num)
@@ -794,11 +901,15 @@ decimal = do
794901-- returns (DefaultStyle, [next example number]). The next
795902-- example number is incremented in parser state, and the label
796903-- (if present) is added to the label table.
797−exampleNum :: Stream s m Char
904+exampleNum :: (Stream s m Char, UpdateSourcePos s Char)
798905 => ParserT s ParserState m (ListNumberStyle, Int)
799906exampleNum = do
800907 char '@'
801− lab <- T.pack <$> many (alphaNum <|> satisfy (\c -> c == '_' || c == '-'))
908+ lab <- mconcat . map T.pack <$>
909+ many (many1 alphaNum <|>
910+ try (do c <- char '_' <|> char '-'
911+ cs <- many1 alphaNum
912+ return (c:cs)))
802913 st <- getState
803914 let num = stateNextExample st
804915 let newlabels = if T.null lab
@@ -809,37 +920,37 @@ exampleNum = do
809920 return (Example, num)
810921
811922-- | Parses a '#' returns (DefaultStyle, 1).
812−defaultNum :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
923+defaultNum :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
813924defaultNum = do
814925 char '#'
815926 return (DefaultStyle, 1)
816927
817928-- | Parses a lowercase letter and returns (LowerAlpha, number).
818−lowerAlpha :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
929+lowerAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
819930lowerAlpha = do
820− ch <- oneOf ['a'..'z']
931+ ch <- satisfy isAsciiLower
821932 return (LowerAlpha, ord ch - ord 'a' + 1)
822933
823934-- | Parses an uppercase letter and returns (UpperAlpha, number).
824−upperAlpha :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
935+upperAlpha :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
825936upperAlpha = do
826− ch <- oneOf ['A'..'Z']
937+ ch <- satisfy isAsciiUpper
827938 return (UpperAlpha, ord ch - ord 'A' + 1)
828939
829940-- | Parses a roman numeral i or I
830−romanOne :: Stream s m Char => ParserT s st m (ListNumberStyle, Int)
941+romanOne :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m (ListNumberStyle, Int)
831942romanOne = (char 'i' >> return (LowerRoman, 1)) <|>
832943 (char 'I' >> return (UpperRoman, 1))
833944
834945-- | Parses an ordered list marker and returns list attributes.
835−anyOrderedListMarker :: Stream s m Char => ParserT s ParserState m ListAttributes
946+anyOrderedListMarker :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s ParserState m ListAttributes
836947anyOrderedListMarker = choice
837948 [delimParser numParser | delimParser <- [inPeriod, inOneParen, inTwoParens],
838949 numParser <- [decimal, exampleNum, defaultNum, romanOne,
839950 lowerAlpha, lowerRoman, upperAlpha, upperRoman]]
840951
841952-- | Parses a list number (num) followed by a period, returns list attributes.
842−inPeriod :: Stream s m Char
953+inPeriod :: (Stream s m Char, UpdateSourcePos s Char)
843954 => ParserT s st m (ListNumberStyle, Int)
844955 -> ParserT s st m ListAttributes
845956inPeriod num = try $ do
@@ -851,7 +962,7 @@ inPeriod num = try $ do
851962 return (start, style, delim)
852963
853964-- | Parses a list number (num) followed by a paren, returns list attributes.
854−inOneParen :: Stream s m Char
965+inOneParen :: (Stream s m Char, UpdateSourcePos s Char)
855966 => ParserT s st m (ListNumberStyle, Int)
856967 -> ParserT s st m ListAttributes
857968inOneParen num = try $ do
@@ -860,7 +971,7 @@ inOneParen num = try $ do
860971 return (start, style, OneParen)
861972
862973-- | Parses a list number (num) enclosed in parens, returns list attributes.
863−inTwoParens :: Stream s m Char
974+inTwoParens :: (Stream s m Char, UpdateSourcePos s Char)
864975 => ParserT s st m (ListNumberStyle, Int)
865976 -> ParserT s st m ListAttributes
866977inTwoParens num = try $ do
@@ -871,7 +982,7 @@ inTwoParens num = try $ do
871982
872983-- | Parses an ordered list marker with a given style and delimiter,
873984-- returns number.
874−orderedListMarker :: Stream s m Char
985+orderedListMarker :: (Stream s m Char, UpdateSourcePos s Char)
875986 => ListNumberStyle
876987 -> ListNumberDelim
877988 -> ParserT s ParserState m Int
@@ -894,10 +1005,10 @@ orderedListMarker style delim = do
8941005 return start
8951006
8961007-- | Parses a character reference and returns a Str element.
897−charRef :: Stream s m Char => ParserT s st m Inline
1008+charRef :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inline
8981009charRef = Str . T.singleton <$> characterReference
8991010
900−lineBlockLine :: Monad m => ParserT Text st m Text
1011+lineBlockLine :: Monad m => ParserT Sources st m Text
9011012lineBlockLine = try $ do
9021013 char '|'
9031014 char ' '
@@ -907,11 +1018,11 @@ lineBlockLine = try $ do
9071018 continuations <- many (try $ char ' ' >> anyLine)
9081019 return $ white <> T.unwords (line : continuations)
9091020
910−blankLineBlockLine :: Stream s m Char => ParserT s st m Char
1021+blankLineBlockLine :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Char
9111022blankLineBlockLine = try (char '|' >> blankline)
9121023
9131024-- | Parses an RST-style line block and returns a list of strings.
914−lineBlockLines :: Monad m => ParserT Text st m [Text]
1025+lineBlockLines :: Monad m => ParserT Sources st m [Text]
9151026lineBlockLines = try $ do
9161027 lines' <- many1 (lineBlockLine <|> (T.singleton <$> blankLineBlockLine))
9171028 skipMany blankline
@@ -919,7 +1030,8 @@ lineBlockLines = try $ do
9191030
9201031-- | Parse a table using 'headerParser', 'rowParser',
9211032-- 'lineParser', and 'footerParser'.
922−tableWith :: (Stream s m Char, HasReaderOptions st, Monad mf)
1033+tableWith :: (Stream s m Char, UpdateSourcePos s Char,
1034+ HasReaderOptions st, Monad mf)
9231035 => ParserT s st m (mf [Blocks], [Alignment], [Int])
9241036 -> ([Int] -> ParserT s st m (mf [Blocks]))
9251037 -> ParserT s st m sep
@@ -939,7 +1051,8 @@ tableWith headerParser rowParser lineParser footerParser = try $ do
9391051
9401052type TableComponents mf = ([Alignment], [Double], mf [Row], mf [Row])
9411053
942−tableWith' :: (Stream s m Char, HasReaderOptions st, Monad mf)
1054+tableWith' :: (Stream s m Char, UpdateSourcePos s Char,
1055+ HasReaderOptions st, Monad mf)
9431056 => ParserT s st m (mf [Blocks], [Alignment], [Int])
9441057 -> ([Int] -> ParserT s st m (mf [Blocks]))
9451058 -> ParserT s st m sep
@@ -988,20 +1101,19 @@ widthsFromIndices numColumns' indices =
9881101-- (which may be grid), then the rows,
9891102-- which may be grid, separated by blank lines, and
9901103-- ending with a footer (dashed line followed by blank line).
991−gridTableWith :: (Stream s m Char, HasReaderOptions st, HasLastStrPosition st,
992− Monad mf, IsString s)
993− => ParserT s st m (mf Blocks) -- ^ Block list parser
1104+gridTableWith :: (Monad m, HasReaderOptions st, HasLastStrPosition st, Monad mf)
1105+ => ParserT Sources st m (mf Blocks) -- ^ Block list parser
9941106 -> Bool -- ^ Headerless table
995− -> ParserT s st m (mf Blocks)
1107+ -> ParserT Sources st m (mf Blocks)
9961108gridTableWith blocks headless =
9971109 tableWith (gridTableHeader headless blocks) (gridTableRow blocks)
9981110 (gridTableSep '-') gridTableFooter
9991111
1000−gridTableWith' :: (Stream s m Char, HasReaderOptions st, HasLastStrPosition st,
1001− Monad mf, IsString s)
1002− => ParserT s st m (mf Blocks) -- ^ Block list parser
1112+gridTableWith' :: (Monad m, HasReaderOptions st, HasLastStrPosition st,
1113+ Monad mf)
1114+ => ParserT Sources st m (mf Blocks) -- ^ Block list parser
10031115 -> Bool -- ^ Headerless table
1004− -> ParserT s st m (TableComponents mf)
1116+ -> ParserT Sources st m (TableComponents mf)
10051117gridTableWith' blocks headless =
10061118 tableWith' (gridTableHeader headless blocks) (gridTableRow blocks)
10071119 (gridTableSep '-') gridTableFooter
@@ -1010,7 +1122,7 @@ gridTableSplitLine :: [Int] -> Text -> [Text]
10101122gridTableSplitLine indices line = map removeFinalBar $ tail $
10111123 splitTextByIndices (init indices) $ trimr line
10121124
1013−gridPart :: Stream s m Char => Char -> ParserT s st m ((Int, Int), Alignment)
1125+gridPart :: Monad m => Char -> ParserT Sources st m ((Int, Int), Alignment)
10141126gridPart ch = do
10151127 leftColon <- option False (True <$ char ':')
10161128 dashes <- many1 (char ch)
@@ -1025,7 +1137,7 @@ gridPart ch = do
10251137 (False, False) -> AlignDefault
10261138 return ((lengthDashes, lengthDashes + 1), alignment)
10271139
1028−gridDashedLines :: Stream s m Char => Char -> ParserT s st m [((Int, Int), Alignment)]
1140+gridDashedLines :: Monad m => Char -> ParserT Sources st m [((Int, Int), Alignment)]
10291141gridDashedLines ch = try $ char '+' >> many1 (gridPart ch) <* blankline
10301142
10311143removeFinalBar :: Text -> Text
@@ -1034,47 +1146,47 @@ removeFinalBar = T.dropWhileEnd go . T.dropWhileEnd (=='|')
10341146 go c = T.any (== c) " \t"
10351147
10361148-- | Separator between rows of grid table.
1037−gridTableSep :: Stream s m Char => Char -> ParserT s st m Char
1149+gridTableSep :: Monad m => Char -> ParserT Sources st m Char
10381150gridTableSep ch = try $ gridDashedLines ch >> return '\n'
10391151
10401152-- | Parse header for a grid table.
1041−gridTableHeader :: (Stream s m Char, Monad mf, IsString s, HasLastStrPosition st)
1153+gridTableHeader :: (Monad m, Monad mf, HasLastStrPosition st)
10421154 => Bool -- ^ Headerless table
1043− -> ParserT s st m (mf Blocks)
1044− -> ParserT s st m (mf [Blocks], [Alignment], [Int])
1045−gridTableHeader headless blocks = try $ do
1155+ -> ParserT Sources st m (mf Blocks)
1156+ -> ParserT Sources st m (mf [Blocks], [Alignment], [Int])
1157+gridTableHeader True _ = do
1158+ optional blanklines
1159+ dashes <- gridDashedLines '-'
1160+ let aligns = map snd dashes
1161+ let lines' = map (snd . fst) dashes
1162+ let indices = scanl (+) 0 lines'
1163+ return (return [], aligns, indices)
1164+gridTableHeader False blocks = try $ do
10461165 optional blanklines
10471166 dashes <- gridDashedLines '-'
1048− rawContent <- if headless
1049− then return $ repeat ""
1050− else many1
1051− (notFollowedBy (gridTableSep '=') >> char '|' >>
1167+ rawContent <- many1 (notFollowedBy (gridTableSep '=') >> char '|' >>
10521168 T.pack <$> many1Till anyChar newline)
1053− underDashes <- if headless
1054− then return dashes
1055− else gridDashedLines '='
1169+ underDashes <- gridDashedLines '='
10561170 guard $ length dashes == length underDashes
10571171 let lines' = map (snd . fst) underDashes
10581172 let indices = scanl (+) 0 lines'
10591173 let aligns = map snd underDashes
1060− let rawHeads = if headless
1061− then replicate (length underDashes) ""
1062− else map (T.unlines . map trim) $ transpose
1174+ let rawHeads = map (T.unlines . map trim) $ transpose
10631175 $ map (gridTableSplitLine indices) rawContent
10641176 heads <- sequence <$> mapM (parseFromString' blocks . trim) rawHeads
10651177 return (heads, aligns, indices)
10661178
1067−gridTableRawLine :: Stream s m Char => [Int] -> ParserT s st m [Text]
1179+gridTableRawLine :: (Stream s m Char, UpdateSourcePos s Char) => [Int] -> ParserT s st m [Text]
10681180gridTableRawLine indices = do
10691181 char '|'
10701182 line <- many1Till anyChar newline
10711183 return (gridTableSplitLine indices $ T.pack line)
10721184
10731185-- | Parse row of grid table.
1074−gridTableRow :: (Stream s m Char, Monad mf, IsString s, HasLastStrPosition st)
1075− => ParserT s st m (mf Blocks)
1186+gridTableRow :: (Monad m, Monad mf, HasLastStrPosition st)
1187+ => ParserT Sources st m (mf Blocks)
10761188 -> [Int]
1077− -> ParserT s st m (mf [Blocks])
1189+ -> ParserT Sources st m (mf [Blocks])
10781190gridTableRow blocks indices = do
10791191 colLines <- many1 (gridTableRawLine indices)
10801192 let cols = map ((<> "\n") . T.unlines . removeOneLeadingSpace) $
@@ -1095,34 +1207,38 @@ removeOneLeadingSpace xs =
10951207 Just (c, _) -> c == ' '
10961208
10971209-- | Parse footer for a grid table.
1098−gridTableFooter :: Stream s m Char => ParserT s st m ()
1210+gridTableFooter :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m ()
10991211gridTableFooter = optional blanklines
11001212
11011213---
11021214
11031215-- | Removes the ParsecT layer from the monad transformer stack
1104−readWithM :: (Stream s m Char, ToText s)
1105− => ParserT s st m a -- ^ parser
1106− -> st -- ^ initial state
1107− -> s -- ^ input
1216+readWithM :: (Monad m, ToSources t)
1217+ => ParserT Sources st m a -- ^ parser
1218+ -> st -- ^ initial state
1219+ -> t -- ^ input
11081220 -> m (Either PandocError a)
11091221readWithM parser state input =
1110− mapLeft (PandocParsecError $ toText input) `liftM` runParserT parser state "source" input
1222+ mapLeft (PandocParsecError sources)
1223+ <$> runParserT parser state (initialSourceName sources) sources
1224+ where
1225+ sources = toSources input
11111226
11121227-- | Parse a string with a given parser and state
1113−readWith :: Parser Text st a
1228+readWith :: ToSources t
1229+ => Parser Sources st a
11141230 -> st
1115− -> Text
1231+ -> t
11161232 -> Either PandocError a
11171233readWith p t inp = runIdentity $ readWithM p t inp
11181234
11191235-- | Parse a string with @parser@ (for testing).
11201236testStringWith :: Show a
1121− => ParserT Text ParserState Identity a
1237+ => ParserT Sources ParserState Identity a
11221238 -> Text
11231239 -> IO ()
1124−testStringWith parser str = UTF8.putStrLn $ show $
1125− readWith parser defaultParserState str
1240+testStringWith parser str = UTF8.putStrLn $ tshow $
1241+ readWith parser defaultParserState (toSources str)
11261242
11271243-- | Parsing options.
11281244data ParserState = ParserState
@@ -1142,7 +1258,7 @@ data ParserState = ParserState
11421258 stateInNote :: Bool, -- ^ True if parsing note contents
11431259 stateNoteNumber :: Int, -- ^ Last note number for citations
11441260 stateMeta :: Meta, -- ^ Document metadata
1145− stateMeta' :: F Meta, -- ^ Document metadata
1261+ stateMeta' :: Future ParserState Meta, -- ^ Document metadata
11461262 stateCitations :: M.Map Text Text, -- ^ RST-style citations
11471263 stateHeaderTable :: [HeaderType], -- ^ Ordered list of header types used
11481264 stateIdentifiers :: Set.Set Text, -- ^ Header identifiers used
@@ -1321,7 +1437,7 @@ data QuoteContext
13211437
13221438type NoteTable = [(Text, Text)]
13231439
1324−type NoteTable' = M.Map Text (SourcePos, F Blocks)
1440+type NoteTable' = M.Map Text (SourcePos, Future ParserState Blocks)
13251441-- used in markdown reader
13261442
13271443newtype Key = Key Text deriving (Show, Read, Eq, Ord)
@@ -1356,7 +1472,7 @@ registerHeader (ident,classes,kvs) header' = do
13561472 then do
13571473 let id' = uniqueIdent exts (B.toList header') ids
13581474 let id'' = if Ext_ascii_identifiers `extensionEnabled` exts
1359− then T.pack $ mapMaybe toAsciiChar $ T.unpack id'
1475+ then toAsciiText id'
13601476 else id'
13611477 updateState $ updateIdentifierList $ Set.insert id'
13621478 updateState $ updateIdentifierList $ Set.insert id''
@@ -1369,34 +1485,42 @@ registerHeader (ident,classes,kvs) header' = do
13691485 updateState $ updateIdentifierList $ Set.insert ident
13701486 return (ident,classes,kvs)
13711487
1372−smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st, HasQuoteContext st m, Stream s m Char)
1488+smartPunctuation :: (HasReaderOptions st, HasLastStrPosition st,
1489+ HasQuoteContext st m,
1490+ Stream s m Char, UpdateSourcePos s Char)
13731491 => ParserT s st m Inlines
13741492 -> ParserT s st m Inlines
13751493smartPunctuation inlineParser = do
13761494 guardEnabled Ext_smart
1377− choice [ quoted inlineParser, apostrophe, dash, ellipses ]
1378−
1379−apostrophe :: Stream s m Char => ParserT s st m Inlines
1380−apostrophe = (char '\'' <|> char '\8217') >> return (B.str "\x2019")
1495+ choice [ quoted inlineParser, apostrophe, doubleCloseQuote, dash, ellipses ]
13811496
1382−quoted :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char)
1497+quoted :: (HasLastStrPosition st, HasQuoteContext st m,
1498+ Stream s m Char, UpdateSourcePos s Char)
13831499 => ParserT s st m Inlines
13841500 -> ParserT s st m Inlines
13851501quoted inlineParser = doubleQuoted inlineParser <|> singleQuoted inlineParser
13861502
1387−singleQuoted :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char)
1503+singleQuoted :: (HasLastStrPosition st, HasQuoteContext st m,
1504+ Stream s m Char, UpdateSourcePos s Char)
13881505 => ParserT s st m Inlines
13891506 -> ParserT s st m Inlines
1390−singleQuoted inlineParser = try $ B.singleQuoted . mconcat
1391− <$ singleQuoteStart
1392− <*> withQuoteContext InSingleQuote (many1Till inlineParser singleQuoteEnd)
1393−
1394−doubleQuoted :: (HasQuoteContext st m, Stream s m Char)
1507+singleQuoted inlineParser = do
1508+ singleQuoteStart
1509+ (B.singleQuoted . mconcat <$>
1510+ try
1511+ (withQuoteContext InSingleQuote (many1Till inlineParser singleQuoteEnd)))
1512+ <|> pure "\8217"
1513+
1514+doubleQuoted :: (HasQuoteContext st m, HasLastStrPosition st,
1515+ Stream s m Char, UpdateSourcePos s Char)
13951516 => ParserT s st m Inlines
13961517 -> ParserT s st m Inlines
1397−doubleQuoted inlineParser = try $ B.doubleQuoted . mconcat
1398− <$ doubleQuoteStart
1399− <*> withQuoteContext InDoubleQuote (manyTill inlineParser doubleQuoteEnd)
1518+doubleQuoted inlineParser = do
1519+ doubleQuoteStart
1520+ (B.doubleQuoted . mconcat <$>
1521+ try
1522+ (withQuoteContext InDoubleQuote (manyTill inlineParser doubleQuoteEnd)))
1523+ <|> pure (B.str "\8220")
14001524
14011525failIfInQuoteContext :: (HasQuoteContext st m, Stream s m t)
14021526 => QuoteContext
@@ -1405,13 +1529,14 @@ failIfInQuoteContext context = do
14051529 context' <- getQuoteContext
14061530 when (context' == context) $ Prelude.fail "already inside quotes"
14071531
1408−charOrRef :: Stream s m Char => [Char] -> ParserT s st m Char
1532+charOrRef :: (Stream s m Char, UpdateSourcePos s Char) => [Char] -> ParserT s st m Char
14091533charOrRef cs =
14101534 oneOf cs <|> try (do c <- characterReference
14111535 guard (c `elem` cs)
14121536 return c)
14131537
1414−singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m, Stream s m Char)
1538+singleQuoteStart :: (HasLastStrPosition st, HasQuoteContext st m,
1539+ Stream s m Char, UpdateSourcePos s Char)
14151540 => ParserT s st m ()
14161541singleQuoteStart = do
14171542 failIfInQuoteContext InSingleQuote
@@ -1419,30 +1544,39 @@ singleQuoteStart = do
14191544 guard =<< notAfterString
14201545 try $ do
14211546 charOrRef "'\8216\145"
1422− notFollowedBy (oneOf [' ', '\t', '\n'])
1547+ void $ lookAhead (satisfy (not . isSpaceChar))
14231548
1424−singleQuoteEnd :: Stream s m Char
1549+singleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char)
14251550 => ParserT s st m ()
14261551singleQuoteEnd = try $ do
14271552 charOrRef "'\8217\146"
14281553 notFollowedBy alphaNum
14291554
1430−doubleQuoteStart :: (HasQuoteContext st m, Stream s m Char)
1555+doubleQuoteStart :: (HasLastStrPosition st,
1556+ HasQuoteContext st m,
1557+ Stream s m Char, UpdateSourcePos s Char)
14311558 => ParserT s st m ()
14321559doubleQuoteStart = do
14331560 failIfInQuoteContext InDoubleQuote
1561+ guard =<< notAfterString
14341562 try $ do charOrRef "\"\8220\147"
1435− notFollowedBy (oneOf [' ', '\t', '\n'])
1563+ void $ lookAhead (satisfy (not . isSpaceChar))
14361564
1437−doubleQuoteEnd :: Stream s m Char
1565+doubleQuoteEnd :: (Stream s m Char, UpdateSourcePos s Char)
14381566 => ParserT s st m ()
14391567doubleQuoteEnd = void (charOrRef "\"\8221\148")
14401568
1441−ellipses :: Stream s m Char
1569+apostrophe :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines
1570+apostrophe = (char '\'' <|> char '\8217') >> return (B.str "\8217")
1571+
1572+doubleCloseQuote :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m Inlines
1573+doubleCloseQuote = B.str "\8221" <$ char '"'
1574+
1575+ellipses :: (Stream s m Char, UpdateSourcePos s Char)
14421576 => ParserT s st m Inlines
14431577ellipses = try (string "..." >> return (B.str "\8230"))
14441578
1445−dash :: (HasReaderOptions st, Stream s m Char)
1579+dash :: (HasReaderOptions st, Stream s m Char, UpdateSourcePos s Char)
14461580 => ParserT s st m Inlines
14471581dash = try $ do
14481582 oldDashes <- extensionEnabled Ext_old_dashes <$> getOption readerExtensions
@@ -1469,20 +1603,28 @@ nested p = do
14691603 updateState $ \st -> st{ stateMaxNestingLevel = nestlevel }
14701604 return res
14711605
1472−citeKey :: (Stream s m Char, HasLastStrPosition st)
1473− => ParserT s st m (Bool, Text)
1474−citeKey = try $ do
1606+citeKey :: (Stream s m Char, UpdateSourcePos s Char, HasLastStrPosition st)
1607+ => Bool -- ^ If True, allow expanded @{..} syntax.
1608+ -> ParserT s st m (Bool, Text)
1609+citeKey allowBraced = try $ do
14751610 guard =<< notAfterString
14761611 suppress_author <- option False (True <$ char '-')
14771612 char '@'
1613+ key <- simpleCiteIdentifier
1614+ <|> if allowBraced
1615+ then charsInBalanced '{' '}' (satisfy (not . isSpace))
1616+ else mzero
1617+ return (suppress_author, key)
1618+
1619+simpleCiteIdentifier :: (Stream s m Char, UpdateSourcePos s Char)
1620+ => ParserT s st m Text
1621+simpleCiteIdentifier = do
14781622 firstChar <- alphaNum <|> char '_' <|> char '*' -- @* for wildcard in nocite
14791623 let regchar = satisfy (\c -> isAlphaNum c || c == '_')
14801624 let internal p = try $ p <* lookAhead regchar
14811625 rest <- many $ regchar <|> internal (oneOf ":.#$%&-+?<>~/") <|>
14821626 try (oneOf ":/" <* lookAhead (char '/'))
1483− let key = firstChar:rest
1484− return (suppress_author, T.pack key)
1485−
1627+ return $ T.pack $ firstChar:rest
14861628
14871629token :: (Stream s m t)
14881630 => (t -> Text)
@@ -1502,12 +1644,15 @@ extractIdClass (ident, cls, kvs) = (ident', cls', kvs')
15021644 cls' = maybe cls T.words $ lookup "class" kvs
15031645 kvs' = filter (\(k,_) -> k /= "id" || k /= "class") kvs
15041646
1505−insertIncludedFile' :: (PandocMonad m, HasIncludeFiles st)
1506− => ParserT a st m (mf Blocks)
1507− -> (Text -> a)
1508− -> [FilePath] -> FilePath
1509− -> ParserT a st m (mf Blocks)
1510−insertIncludedFile' blocks totoks dirs f = do
1647+insertIncludedFile :: (PandocMonad m, HasIncludeFiles st)
1648+ => ParserT a st m b -- ^ parser to apply
1649+ -> (Text -> a) -- ^ convert Text to stream type
1650+ -> [FilePath] -- ^ search path (directories)
1651+ -> FilePath -- ^ path of file to include
1652+ -> Maybe Int -- ^ start line (negative counts from end)
1653+ -> Maybe Int -- ^ end line (negative counts from end)
1654+ -> ParserT a st m b
1655+insertIncludedFile parser toStream dirs f mbstartline mbendline = do
15111656 oldPos <- getPosition
15121657 oldInput <- getInput
15131658 containers <- getIncludeFiles <$> getState
@@ -1516,32 +1661,32 @@ insertIncludedFile' blocks totoks dirs f = do
15161661 updateState $ addIncludeFile $ T.pack f
15171662 mbcontents <- readFileFromDirs dirs f
15181663 contents <- case mbcontents of
1519− Just s -> return s
1664+ Just s -> return $ exciseLines mbstartline mbendline s
15201665 Nothing -> do
15211666 report $ CouldNotLoadIncludeFile (T.pack f) oldPos
15221667 return ""
1523− setPosition $ newPos f 1 1
1524− setInput $ totoks contents
1525− bs <- blocks
1668+ setInput $ toStream contents
1669+ setPosition $ newPos f (fromMaybe 1 mbstartline) 1
1670+ result <- parser
15261671 setInput oldInput
15271672 setPosition oldPos
15281673 updateState dropLatestIncludeFile
1529− return bs
1674+ return result
1675+
1676+exciseLines :: Maybe Int -> Maybe Int -> Text -> Text
1677+exciseLines Nothing Nothing t = t
1678+exciseLines mbstartline mbendline t =
1679+ T.unlines $ take (endline' - (startline' - 1))
1680+ $ drop (startline' - 1) contentLines
1681+ where
1682+ contentLines = T.lines t
1683+ numLines = length contentLines
1684+ startline' = case mbstartline of
1685+ Nothing -> 1
1686+ Just x | x >= 0 -> x
1687+ | otherwise -> numLines + x -- negative from end
1688+ endline' = case mbendline of
1689+ Nothing -> numLines
1690+ Just x | x >= 0 -> x
1691+ | otherwise -> numLines + x -- negative from end
15301692
1531−-- | Parse content of include file as blocks. Circular includes result in an
1532−-- @PandocParseError@.
1533−insertIncludedFile :: (PandocMonad m, HasIncludeFiles st)
1534− => ParserT [a] st m Blocks
1535− -> (Text -> [a])
1536− -> [FilePath] -> FilePath
1537− -> ParserT [a] st m Blocks
1538−insertIncludedFile blocks totoks dirs f =
1539− runIdentity <$> insertIncludedFile' (Identity <$> blocks) totoks dirs f
1540−
1541−-- | Parse content of include file as future blocks. Circular includes result in
1542−-- an @PandocParseError@.
1543−insertIncludedFileF :: (PandocMonad m, HasIncludeFiles st)
1544− => ParserT Text st m (Future st Blocks)
1545− -> [FilePath] -> FilePath
1546− -> ParserT Text st m (Future st Blocks)
1547−insertIncludedFileF p = insertIncludedFile' p id
src/Text/Pandoc/Process.hs+1−1
@@ -1,6 +1,6 @@
11{- |
22 Module : Text.Pandoc.Process
3− Copyright : Copyright (C) 2013-2020 John MacFarlane
3+ Copyright : Copyright (C) 2013-2021 John MacFarlane
44 License : GNU GPL, version 2 or above
55
66 Maintainer : John MacFarlane <jgm@berkeley.edu>
src/Text/Pandoc/Readers.hs+56−49
@@ -1,9 +1,10 @@
11{-# LANGUAGE MonoLocalBinds #-}
2+{-# LANGUAGE RankNTypes #-}
23{-# LANGUAGE ScopedTypeVariables #-}
34{-# LANGUAGE OverloadedStrings #-}
45{- |
56 Module : Text.Pandoc.Readers
6− Copyright : Copyright (C) 2006-2020 John MacFarlane
7+ Copyright : Copyright (C) 2006-2021 John MacFarlane
78 License : GNU GPL, version 2 or above
89
910 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -65,12 +66,14 @@ import Data.Aeson
6566import qualified Data.ByteString.Lazy as BL
6667import Data.Text (Text)
6768import qualified Data.Text as T
69+import Text.Pandoc.Shared (tshow)
6870import Text.Pandoc.Class
6971import Text.Pandoc.Definition
7072import Text.Pandoc.Error
7173import Text.Pandoc.Extensions
7274import Text.Pandoc.Options
7375import Text.Pandoc.Readers.CommonMark
76+import Text.Pandoc.Readers.Markdown
7477import Text.Pandoc.Readers.Creole
7578import Text.Pandoc.Readers.DocBook
7679import Text.Pandoc.Readers.Docx
@@ -83,7 +86,6 @@ import Text.Pandoc.Readers.HTML (readHtml)
8386import Text.Pandoc.Readers.JATS (readJATS)
8487import Text.Pandoc.Readers.Jira (readJira)
8588import Text.Pandoc.Readers.LaTeX
86−import Text.Pandoc.Readers.Markdown
8789import Text.Pandoc.Readers.MediaWiki
8890import Text.Pandoc.Readers.Muse
8991import Text.Pandoc.Readers.Native
@@ -101,59 +103,60 @@ import Text.Pandoc.Readers.CSV
101103import Text.Pandoc.Readers.CslJson
102104import Text.Pandoc.Readers.BibTeX
103105import qualified Text.Pandoc.UTF8 as UTF8
104−import Text.Parsec.Error
106+import Text.Pandoc.Sources (ToSources(..), sourcesToText)
105107
106−data Reader m = TextReader (ReaderOptions -> Text -> m Pandoc)
108+data Reader m = TextReader (forall a . ToSources a =>
109+ ReaderOptions -> a -> m Pandoc)
107110 | ByteStringReader (ReaderOptions -> BL.ByteString -> m Pandoc)
108111
109112-- | Association list of formats and readers.
110113readers :: PandocMonad m => [(Text, Reader m)]
111−readers = [ ("native" , TextReader readNative)
112− ,("json" , TextReader readJSON)
113− ,("markdown" , TextReader readMarkdown)
114− ,("markdown_strict" , TextReader readMarkdown)
115− ,("markdown_phpextra" , TextReader readMarkdown)
116− ,("markdown_github" , TextReader readMarkdown)
117− ,("markdown_mmd", TextReader readMarkdown)
118− ,("commonmark" , TextReader readCommonMark)
119− ,("commonmark_x" , TextReader readCommonMark)
120− ,("creole" , TextReader readCreole)
121− ,("dokuwiki" , TextReader readDokuWiki)
122− ,("gfm" , TextReader readCommonMark)
123− ,("rst" , TextReader readRST)
124− ,("mediawiki" , TextReader readMediaWiki)
125− ,("vimwiki" , TextReader readVimwiki)
126− ,("docbook" , TextReader readDocBook)
127− ,("opml" , TextReader readOPML)
128− ,("org" , TextReader readOrg)
129− ,("textile" , TextReader readTextile) -- TODO : textile+lhs
130− ,("html" , TextReader readHtml)
131− ,("jats" , TextReader readJATS)
132− ,("jira" , TextReader readJira)
133− ,("latex" , TextReader readLaTeX)
134− ,("haddock" , TextReader readHaddock)
135− ,("twiki" , TextReader readTWiki)
136− ,("tikiwiki" , TextReader readTikiWiki)
137− ,("docx" , ByteStringReader readDocx)
138− ,("odt" , ByteStringReader readOdt)
139− ,("t2t" , TextReader readTxt2Tags)
140− ,("epub" , ByteStringReader readEPUB)
141− ,("muse" , TextReader readMuse)
142− ,("man" , TextReader readMan)
143− ,("fb2" , TextReader readFB2)
144− ,("ipynb" , TextReader readIpynb)
145− ,("csv" , TextReader readCSV)
146− ,("csljson" , TextReader readCslJson)
147− ,("bibtex" , TextReader readBibTeX)
148− ,("biblatex" , TextReader readBibLaTeX)
114+readers = [("native" , TextReader readNative)
115+ ,("json" , TextReader readJSON)
116+ ,("markdown" , TextReader readMarkdown)
117+ ,("markdown_strict" , TextReader readMarkdown)
118+ ,("markdown_phpextra" , TextReader readMarkdown)
119+ ,("markdown_github" , TextReader readMarkdown)
120+ ,("markdown_mmd", TextReader readMarkdown)
121+ ,("commonmark" , TextReader readCommonMark)
122+ ,("commonmark_x" , TextReader readCommonMark)
123+ ,("creole" , TextReader readCreole)
124+ ,("dokuwiki" , TextReader readDokuWiki)
125+ ,("gfm" , TextReader readCommonMark)
126+ ,("rst" , TextReader readRST)
127+ ,("mediawiki" , TextReader readMediaWiki)
128+ ,("vimwiki" , TextReader readVimwiki)
129+ ,("docbook" , TextReader readDocBook)
130+ ,("opml" , TextReader readOPML)
131+ ,("org" , TextReader readOrg)
132+ ,("textile" , TextReader readTextile) -- TODO : textile+lhs
133+ ,("html" , TextReader readHtml)
134+ ,("jats" , TextReader readJATS)
135+ ,("jira" , TextReader readJira)
136+ ,("latex" , TextReader readLaTeX)
137+ ,("haddock" , TextReader readHaddock)
138+ ,("twiki" , TextReader readTWiki)
139+ ,("tikiwiki" , TextReader readTikiWiki)
140+ ,("docx" , ByteStringReader readDocx)
141+ ,("odt" , ByteStringReader readOdt)
142+ ,("t2t" , TextReader readTxt2Tags)
143+ ,("epub" , ByteStringReader readEPUB)
144+ ,("muse" , TextReader readMuse)
145+ ,("man" , TextReader readMan)
146+ ,("fb2" , TextReader readFB2)
147+ ,("ipynb" , TextReader readIpynb)
148+ ,("csv" , TextReader readCSV)
149+ ,("csljson" , TextReader readCslJson)
150+ ,("bibtex" , TextReader readBibTeX)
151+ ,("biblatex" , TextReader readBibLaTeX)
149152 ]
150153
151154-- | Retrieve reader, extensions based on formatSpec (format+extensions).
152155getReader :: PandocMonad m => Text -> m (Reader m, Extensions)
153156getReader s =
154157 case parseFormatSpec s of
155− Left e -> throwError $ PandocAppError
156− $ T.intercalate "\n" [T.pack m | Message m <- errorMessages e]
158+ Left e -> throwError $ PandocAppError $
159+ "Error parsing reader format " <> tshow s <> ": " <> tshow e
157160 Right (readerName, extsToEnable, extsToDisable) ->
158161 case lookup readerName readers of
159162 Nothing -> throwError $ PandocUnknownReaderError
@@ -173,9 +176,13 @@ getReader s =
173176 return (r, exts)
174177
175178-- | Read pandoc document from JSON format.
176−readJSON :: PandocMonad m
177− => ReaderOptions -> Text -> m Pandoc
178−readJSON _ t =
179− case eitherDecode' . BL.fromStrict . UTF8.fromText $ t of
179+readJSON :: (PandocMonad m, ToSources a)
180+ => ReaderOptions
181+ -> a
182+ -> m Pandoc
183+readJSON _ s =
184+ case eitherDecode' . BL.fromStrict . UTF8.fromText
185+ . sourcesToText . toSources $ s of
180186 Right doc -> return doc
181− Left e -> throwError $ PandocParseError ("JSON parse error: " <> T.pack e)
187+ Left e -> throwError $ PandocParseError ("JSON parse error: "
188+ <> T.pack e)
src/Text/Pandoc/Readers/BibTeX.hs+18−11
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.Readers.BibTeX
4− Copyright : Copyright (C) 2020 John MacFarlane
4+ Copyright : Copyright (C) 2020-2021 John MacFarlane
55 License : GNU GPL, version 2 or above
66
77 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -23,39 +23,47 @@ where
2323import Text.Pandoc.Options
2424import Text.Pandoc.Definition
2525import Text.Pandoc.Builder (setMeta, cite, str)
26−import Data.Text (Text)
2726import Citeproc (Lang(..), parseLang)
2827import Citeproc.Locale (getLocale)
29−import Data.Maybe (fromMaybe)
3028import Text.Pandoc.Error (PandocError(..))
3129import Text.Pandoc.Class (PandocMonad, lookupEnv)
3230import Text.Pandoc.Citeproc.BibTeX as BibTeX
3331import Text.Pandoc.Citeproc.MetaValue (referenceToMetaValue)
32+import Text.Pandoc.Sources (ToSources(..))
3433import Control.Monad.Except (throwError)
3534
3635-- | Read BibTeX from an input string and return a Pandoc document.
3736-- The document will have only metadata, with an empty body.
3837-- The metadata will contain a `references` field with the
3938-- bibliography entries, and a `nocite` field with the wildcard `[@*]`.
40−readBibTeX :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
39+readBibTeX :: (PandocMonad m, ToSources a)
40+ => ReaderOptions -> a -> m Pandoc
4141readBibTeX = readBibTeX' BibTeX.Bibtex
4242
4343-- | Read BibLaTeX from an input string and return a Pandoc document.
4444-- The document will have only metadata, with an empty body.
4545-- The metadata will contain a `references` field with the
4646-- bibliography entries, and a `nocite` field with the wildcard `[@*]`.
47−readBibLaTeX :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
47+readBibLaTeX :: (PandocMonad m, ToSources a)
48+ => ReaderOptions -> a -> m Pandoc
4849readBibLaTeX = readBibTeX' BibTeX.Biblatex
4950
50−readBibTeX' :: PandocMonad m => Variant -> ReaderOptions -> Text -> m Pandoc
51+readBibTeX' :: (PandocMonad m, ToSources a)
52+ => Variant -> ReaderOptions -> a -> m Pandoc
5153readBibTeX' variant _opts t = do
52− lang <- fromMaybe (Lang "en" (Just "US")) . fmap parseLang
53− <$> lookupEnv "LANG"
54+ mblangEnv <- lookupEnv "LANG"
55+ let defaultLang = Lang "en" Nothing (Just "US") [] [] []
56+ let lang = case mblangEnv of
57+ Nothing -> defaultLang
58+ Just l -> either (const defaultLang) id $ parseLang l
5459 locale <- case getLocale lang of
55− Left e -> throwError $ PandocCiteprocError e
60+ Left e ->
61+ case getLocale (Lang "en" Nothing (Just "US") [] [] []) of
62+ Right l -> return l
63+ Left _ -> throwError $ PandocCiteprocError e
5664 Right l -> return l
5765 case BibTeX.readBibtexString variant locale (const True) t of
58− Left e -> throwError $ PandocParsecError t e
66+ Left e -> throwError $ PandocParsecError (toSources t) e
5967 Right refs -> return $ setMeta "references"
6068 (map referenceToMetaValue refs)
6169 . setMeta "nocite"
@@ -67,4 +75,3 @@ readBibTeX' variant _opts t = do
6775 , citationHash = 0}]
6876 (str "[@*]"))
6977 $ Pandoc nullMeta []
70−
src/Text/Pandoc/Readers/CSV.hs+9−9
@@ -2,8 +2,8 @@
22
33{-# LANGUAGE ScopedTypeVariables #-}
44{- |
5− Module : Text.Pandoc.Readers.RST
6− Copyright : Copyright (C) 2006-2020 John MacFarlane
5+ Module : Text.Pandoc.Readers.CSV
6+ Copyright : Copyright (C) 2006-2021 John MacFarlane
77 License : GNU GPL, version 2 or above
88
99 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -13,23 +13,23 @@
1313Conversion from CSV to a 'Pandoc' table.
1414-}
1515module Text.Pandoc.Readers.CSV ( readCSV ) where
16−import Data.Text (Text)
1716import qualified Data.Text as T
1817import Text.Pandoc.CSV (parseCSV, defaultCSVOptions)
1918import Text.Pandoc.Definition
2019import qualified Text.Pandoc.Builder as B
2120import Text.Pandoc.Class (PandocMonad)
22−import Text.Pandoc.Shared (crFilter)
2321import Text.Pandoc.Error
22+import Text.Pandoc.Sources (ToSources(..), sourcesToText)
2423import Text.Pandoc.Options (ReaderOptions)
2524import Control.Monad.Except (throwError)
2625
27−readCSV :: PandocMonad m
26+readCSV :: (PandocMonad m, ToSources a)
2827 => ReaderOptions -- ^ Reader options
29− -> Text -- ^ Text to parse (assuming @'\n'@ line endings)
28+ -> a
3029 -> m Pandoc
31−readCSV _opts s =
32− case parseCSV defaultCSVOptions (crFilter s) of
30+readCSV _opts s = do
31+ let txt = sourcesToText $ toSources s
32+ case parseCSV defaultCSVOptions txt of
3333 Right (r:rs) -> return $ B.doc $ B.table capt
3434 (zip aligns widths)
3535 (TableHead nullAttr hdrs)
@@ -45,4 +45,4 @@ readCSV _opts s =
4545 aligns = replicate numcols AlignDefault
4646 widths = replicate numcols ColWidthDefault
4747 Right [] -> return $ B.doc mempty
48− Left e -> throwError $ PandocParsecError s e
48+ Left e -> throwError $ PandocParsecError (toSources [("",txt)]) e
src/Text/Pandoc/Readers/CommonMark.hs+81−28
@@ -1,8 +1,9 @@
11{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE FlexibleContexts #-}
23{-# LANGUAGE ScopedTypeVariables #-}
34{- |
45 Module : Text.Pandoc.Readers.CommonMark
5− Copyright : Copyright (C) 2015-2020 John MacFarlane
6+ Copyright : Copyright (C) 2015-2021 John MacFarlane
67 License : GNU GPL, version 2 or above
78
89 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -25,41 +26,93 @@ import Text.Pandoc.Definition
2526import Text.Pandoc.Builder as B
2627import Text.Pandoc.Options
2728import Text.Pandoc.Error
29+import Text.Pandoc.Readers.Metadata (yamlMetaBlock)
2830import Control.Monad.Except
2931import Data.Functor.Identity (runIdentity)
32+import Data.Typeable
33+import Text.Pandoc.Parsing (runParserT, getInput,
34+ runF, defaultParserState, option, many1, anyChar,
35+ Sources(..), ToSources(..), ParserT, Future,
36+ sourceName)
37+import qualified Data.Text as T
3038
3139-- | Parse a CommonMark formatted string into a 'Pandoc' structure.
32−readCommonMark :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
33−readCommonMark opts s = do
34− let res = runIdentity $
35− commonmarkWith (foldr (<>) defaultSyntaxSpec exts) "input" s
36− case res of
37− Left err -> throwError $ PandocParsecError s err
38− Right (Cm bls :: Cm () Blocks) -> return $ B.doc bls
40+readCommonMark :: (PandocMonad m, ToSources a)
41+ => ReaderOptions -> a -> m Pandoc
42+readCommonMark opts s
43+ | isEnabled Ext_yaml_metadata_block opts = do
44+ let sources = toSources s
45+ let toks = concatMap sourceToToks (unSources sources)
46+ res <- runParserT (do meta <- yamlMetaBlock (metaValueParser opts)
47+ rest <- getInput
48+ return (meta, rest))
49+ defaultParserState "YAML metadata" (toSources s)
50+ case res of
51+ Left _ -> readCommonMarkBody opts sources toks
52+ Right (meta, rest) -> do
53+ -- strip off metadata section and parse body
54+ let body = concatMap sourceToToks (unSources rest)
55+ Pandoc _ bs <- readCommonMarkBody opts sources body
56+ return $ Pandoc (runF meta defaultParserState) bs
57+ | otherwise = do
58+ let sources = toSources s
59+ let toks = concatMap sourceToToks (unSources sources)
60+ readCommonMarkBody opts sources toks
61+
62+sourceToToks :: (SourcePos, Text) -> [Tok]
63+sourceToToks (pos, s) = tokenize (sourceName pos) s
64+
65+metaValueParser :: Monad m
66+ => ReaderOptions -> ParserT Sources st m (Future st MetaValue)
67+metaValueParser opts = do
68+ inp <- option "" $ T.pack <$> many1 anyChar
69+ let toks = concatMap sourceToToks (unSources (toSources inp))
70+ case runIdentity (parseCommonmarkWith (specFor opts) toks) of
71+ Left _ -> mzero
72+ Right (Cm bls :: Cm () Blocks) -> return $ return $ B.toMetaValue bls
73+
74+readCommonMarkBody :: PandocMonad m => ReaderOptions -> Sources -> [Tok] -> m Pandoc
75+readCommonMarkBody opts s toks
76+ | isEnabled Ext_sourcepos opts =
77+ case runIdentity (parseCommonmarkWith (specFor opts) toks) of
78+ Left err -> throwError $ PandocParsecError s err
79+ Right (Cm bls :: Cm SourceRange Blocks) -> return $ B.doc bls
80+ | otherwise =
81+ case runIdentity (parseCommonmarkWith (specFor opts) toks) of
82+ Left err -> throwError $ PandocParsecError s err
83+ Right (Cm bls :: Cm () Blocks) -> return $ B.doc bls
84+
85+specFor :: (Monad m, Typeable m, Typeable a,
86+ Rangeable (Cm a Inlines), Rangeable (Cm a Blocks))
87+ => ReaderOptions -> SyntaxSpec m (Cm a Inlines) (Cm a Blocks)
88+specFor opts = foldr ($) defaultSyntaxSpec exts
3989 where
40− exts = [ hardLineBreaksSpec | isEnabled Ext_hard_line_breaks opts ] ++
41− [ smartPunctuationSpec | isEnabled Ext_smart opts ] ++
42− [ strikethroughSpec | isEnabled Ext_strikeout opts ] ++
43− [ superscriptSpec | isEnabled Ext_superscript opts ] ++
44− [ subscriptSpec | isEnabled Ext_subscript opts ] ++
45− [ mathSpec | isEnabled Ext_tex_math_dollars opts ] ++
46− [ fancyListSpec | isEnabled Ext_fancy_lists opts ] ++
47− [ fencedDivSpec | isEnabled Ext_fenced_divs opts ] ++
48− [ bracketedSpanSpec | isEnabled Ext_bracketed_spans opts ] ++
49− [ rawAttributeSpec | isEnabled Ext_raw_attribute opts ] ++
50− [ attributesSpec | isEnabled Ext_attributes opts ] ++
51− [ pipeTableSpec | isEnabled Ext_pipe_tables opts ] ++
52− [ autolinkSpec | isEnabled Ext_autolink_bare_uris opts ] ++
53− [ emojiSpec | isEnabled Ext_emoji opts ] ++
54− [ autoIdentifiersSpec
90+ exts = [ (hardLineBreaksSpec <>) | isEnabled Ext_hard_line_breaks opts ] ++
91+ [ (smartPunctuationSpec <>) | isEnabled Ext_smart opts ] ++
92+ [ (strikethroughSpec <>) | isEnabled Ext_strikeout opts ] ++
93+ [ (superscriptSpec <>) | isEnabled Ext_superscript opts ] ++
94+ [ (subscriptSpec <>) | isEnabled Ext_subscript opts ] ++
95+ [ (mathSpec <>) | isEnabled Ext_tex_math_dollars opts ] ++
96+ [ (fancyListSpec <>) | isEnabled Ext_fancy_lists opts ] ++
97+ [ (fencedDivSpec <>) | isEnabled Ext_fenced_divs opts ] ++
98+ [ (bracketedSpanSpec <>) | isEnabled Ext_bracketed_spans opts ] ++
99+ [ (rawAttributeSpec <>) | isEnabled Ext_raw_attribute opts ] ++
100+ [ (attributesSpec <>) | isEnabled Ext_attributes opts ] ++
101+ [ (<> pipeTableSpec) | isEnabled Ext_pipe_tables opts ] ++
102+ -- see #6739
103+ [ (autolinkSpec <>) | isEnabled Ext_autolink_bare_uris opts ] ++
104+ [ (emojiSpec <>) | isEnabled Ext_emoji opts ] ++
105+ [ (autoIdentifiersSpec <>)
55106 | isEnabled Ext_gfm_auto_identifiers opts
56107 , not (isEnabled Ext_ascii_identifiers opts) ] ++
57− [ autoIdentifiersAsciiSpec
108+ [ (autoIdentifiersAsciiSpec <>)
58109 | isEnabled Ext_gfm_auto_identifiers opts
59110 , isEnabled Ext_ascii_identifiers opts ] ++
60− [ implicitHeadingReferencesSpec
111+ [ (implicitHeadingReferencesSpec <>)
61112 | isEnabled Ext_implicit_header_references opts ] ++
62− [ footnoteSpec | isEnabled Ext_footnotes opts ] ++
63− [ definitionListSpec | isEnabled Ext_definition_lists opts ] ++
64− [ taskListSpec | isEnabled Ext_task_lists opts ]
113+ [ (footnoteSpec <>) | isEnabled Ext_footnotes opts ] ++
114+ [ (definitionListSpec <>) | isEnabled Ext_definition_lists opts ] ++
115+ [ (taskListSpec <>) | isEnabled Ext_task_lists opts ] ++
116+ [ (rebaseRelativePathsSpec <>)
117+ | isEnabled Ext_rebase_relative_paths opts ]
65118
src/Text/Pandoc/Readers/Creole.hs+6−7
@@ -23,21 +23,20 @@ import Text.Pandoc.Class.PandocMonad (PandocMonad (..))
2323import Text.Pandoc.Definition
2424import Text.Pandoc.Options
2525import Text.Pandoc.Parsing hiding (enclosed)
26−import Text.Pandoc.Shared (crFilter)
27−
2826
2927-- | Read creole from an input string and return a Pandoc document.
30−readCreole :: PandocMonad m
28+readCreole :: (PandocMonad m, ToSources a)
3129 => ReaderOptions
32− -> Text
30+ -> a
3331 -> m Pandoc
3432readCreole opts s = do
35− res <- readWithM parseCreole def{ stateOptions = opts } $ crFilter s <> "\n\n"
33+ let sources = ensureFinalNewlines 2 (toSources s)
34+ res <- readWithM parseCreole def{ stateOptions = opts } sources
3635 case res of
3736 Left e -> throwError e
3837 Right d -> return d
3938
40−type CRLParser = ParserT Text ParserState
39+type CRLParser = ParserT Sources ParserState
4140
4241--
4342-- Utility functions
@@ -252,7 +251,7 @@ inlineNowiki = B.code <$> (start >> manyTillChar (noneOf "\n\r") end)
252251 end = try $ string "}}}" >> lookAhead (noneOf "}")
253252
254253placeholder :: PandocMonad m => CRLParser m B.Inlines
255−-- The semantics of the placeholder is basicallly implementation
254+-- The semantics of the placeholder is basically implementation
256255-- dependent, so there is no way to DTRT for all cases.
257256-- So for now we just drop them.
258257placeholder = B.text <$> try (string "<<<" >> manyTill anyChar (string ">>>")
src/Text/Pandoc/Readers/CslJson.hs+6−5
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.Readers.CslJson
4− Copyright : Copyright (C) 2020 John MacFarlane
4+ Copyright : Copyright (C) 2020-2021 John MacFarlane
55 License : GNU GPL, version 2 or above
66
77 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -24,21 +24,22 @@ import Text.Pandoc.Options
2424import Text.Pandoc.Definition
2525import Text.Pandoc.Builder (setMeta, cite, str)
2626import qualified Text.Pandoc.UTF8 as UTF8
27−import Data.Text (Text)
2827import qualified Data.Text as T
2928import Text.Pandoc.Error (PandocError(..))
3029import Text.Pandoc.Class (PandocMonad)
3130import Text.Pandoc.Citeproc.CslJson (cslJsonToReferences)
3231import Text.Pandoc.Citeproc.MetaValue (referenceToMetaValue)
3332import Control.Monad.Except (throwError)
33+import Text.Pandoc.Sources (ToSources(..), sourcesToText)
3434
3535-- | Read CSL JSON from an input string and return a Pandoc document.
3636-- The document will have only metadata, with an empty body.
3737-- The metadata will contain a `references` field with the
3838-- bibliography entries, and a `nocite` field with the wildcard `[@*]`.
39−readCslJson :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
40−readCslJson _opts t =
41− case cslJsonToReferences (UTF8.fromText t) of
39+readCslJson :: (PandocMonad m, ToSources a)
40+ => ReaderOptions -> a -> m Pandoc
41+readCslJson _opts x =
42+ case cslJsonToReferences (UTF8.fromText $ sourcesToText $ toSources x) of
4243 Left e -> throwError $ PandocParseError $ T.pack e
4344 Right refs -> return $ setMeta "references"
4445 (map referenceToMetaValue refs)
src/Text/Pandoc/Readers/DocBook.hs+119−89
@@ -1,7 +1,7 @@
11{-# LANGUAGE OverloadedStrings #-}
22{- |
33 Module : Text.Pandoc.Readers.DocBook
4− Copyright : Copyright (C) 2006-2020 John MacFarlane
4+ Copyright : Copyright (C) 2006-2021 John MacFarlane
55 License : GNU GPL, version 2 or above
66
77 Maintainer : John MacFarlane <jgm@berkeley.edu>
@@ -12,23 +12,28 @@ Conversion of DocBook XML to 'Pandoc' document.
1212-}
1313module Text.Pandoc.Readers.DocBook ( readDocBook ) where
1414import Control.Monad.State.Strict
15−import Data.Char (isSpace, toUpper)
15+import Data.Char (isSpace, isLetter)
1616import Data.Default
1717import Data.Either (rights)
1818import Data.Foldable (asum)
1919import Data.Generics
2020import Data.List (intersperse,elemIndex)
21+import Data.List.NonEmpty (nonEmpty)
2122import Data.Maybe (fromMaybe,mapMaybe)
2223import Data.Text (Text)
2324import qualified Data.Text as T
25+import qualified Data.Text.Lazy as TL
26+import Control.Monad.Except (throwError)
2427import Text.HTML.TagSoup.Entity (lookupEntity)
28+import Text.Pandoc.Error (PandocError(..))
2529import Text.Pandoc.Builder
2630import Text.Pandoc.Class.PandocMonad (PandocMonad, report)
2731import Text.Pandoc.Options
2832import Text.Pandoc.Logging (LogMessage(..))
29−import Text.Pandoc.Shared (crFilter, safeRead, extractSpaces)
33+import Text.Pandoc.Shared (safeRead, extractSpaces)
34+import Text.Pandoc.Sources (ToSources(..), sourcesToText)
3035import Text.TeXMath (readMathML, writeTeX)
31−import Text.XML.Light
36+import Text.Pandoc.XML.Light
3237
3338{-
3439
@@ -44,7 +49,7 @@ List of all DocBook tags, with [x] indicating implemented,
4449[o] address - A real-world address, generally a postal address
4550[ ] affiliation - The institutional affiliation of an individual
4651[ ] alt - Text representation for a graphical element
47−[o] anchor - A spot in the document
52+[x] anchor - A spot in the document
4853[x] answer - An answer to a question posed in a QandASet
4954[x] appendix - An appendix in a Book or Article
5055[x] appendixinfo - Meta-information for an Appendix
@@ -72,7 +77,7 @@ List of all DocBook tags, with [x] indicating implemented,
7277[ ] bibliographyinfo - Meta-information for a Bibliography
7378[ ] biblioid - An identifier for a document
7479[o] bibliolist - A wrapper for a set of bibliography entries
75−[ ] bibliomisc - Untyped bibliographic information
80+[x] bibliomisc - Untyped bibliographic information
7681[x] bibliomixed - An entry in a Bibliography
7782[ ] bibliomset - A cooked container for related bibliographic information
7883[ ] biblioref - A cross reference to a bibliographic entry
@@ -129,6 +134,7 @@ List of all DocBook tags, with [x] indicating implemented,
129134[ ] corpcredit - A corporation or organization credited in a document
130135[ ] corpname - The name of a corporation
131136[ ] country - The name of a country
137+[x] danger - An admonition set off from the text indicating hazardous situation
132138[ ] database - The name of a database, or part of a database
133139[x] date - The date of publication or revision of a document
134140[ ] dedication - A wrapper for the dedication section of a book
@@ -206,7 +212,7 @@ List of all DocBook tags, with [x] indicating implemented,
206212[x] info - A wrapper for information about a component or other block. (DocBook v5)
207213[x] informalequation - A displayed mathematical equation without a title
208214[x] informalexample - A displayed example without a title
209−[ ] informalfigure - A untitled figure
215+[x] informalfigure - An untitled figure
210216[ ] informaltable - A table without a title
211217[ ] initializer - The initializer for a FieldSynopsis
212218[x] inlineequation - A mathematical equation or expression occurring inline
@@ -535,24 +541,32 @@ instance Default DBState where
535541 , dbContent = [] }
536542
537543
538−readDocBook :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
544+readDocBook :: (PandocMonad m, ToSources a)
545+ => ReaderOptions
546+ -> a
547+ -> m Pandoc
539548readDocBook _ inp = do
540− let tree = normalizeTree . parseXML . handleInstructions $ crFilter inp
549+ let sources = toSources inp
550+ tree <- either (throwError . PandocXMLError "") return $
551+ parseXMLContents
552+ (TL.fromStrict . handleInstructions . sourcesToText $ sources)
541553 (bs, st') <- flip runStateT (def{ dbContent = tree }) $ mapM parseBlock tree
542554 return $ Pandoc (dbMeta st') (toList . mconcat $ bs)
543555
544−-- We treat <?asciidoc-br?> specially (issue #1236), converting it
545−-- to <br/>, since xml-light doesn't parse the instruction correctly.
546−-- Other xml instructions are simply removed from the input stream.
556+-- We treat certain processing instructions by converting them to tags
557+-- beginning "pi-".
547558handleInstructions :: Text -> Text
548−handleInstructions = T.pack . handleInstructions' . T.unpack
549−
550−handleInstructions' :: String -> String
551−handleInstructions' ('<':'?':'a':'s':'c':'i':'i':'d':'o':'c':'-':'b':'r':'?':'>':xs) = '<':'b':'r':'/':'>': handleInstructions' xs
552−handleInstructions' xs = case break (=='<') xs of
553− (ys, []) -> ys
554− ([], '<':zs) -> '<' : handleInstructions' zs
555− (ys, zs) -> ys ++ handleInstructions' zs
559+handleInstructions t =
560+ let (x,y) = T.breakOn "<?" t
561+ in if T.null y
562+ then x
563+ else
564+ let (w,z) = T.breakOn "?>" y
565+ in (if T.takeWhile (\c -> isLetter c || c == '-')
566+ (T.drop 2 w) `elem` ["asciidoc-br", "dbfo"]
567+ then x <> "<pi-" <> T.drop 2 w <> "/>"
568+ else x <> w <> T.take 2 z) <>
569+ handleInstructions (T.drop 2 z)
556570
557571getFigure :: PandocMonad m => Element -> DB m Blocks
558572getFigure e = do
@@ -565,32 +579,14 @@ getFigure e = do
565579 modify $ \st -> st{ dbFigureTitle = mempty, dbFigureId = mempty }
566580 return res
567581
568−-- normalize input, consolidating adjacent Text and CRef elements
569−normalizeTree :: [Content] -> [Content]
570−normalizeTree = everywhere (mkT go)
571− where go :: [Content] -> [Content]
572− go (Text (CData CDataRaw _ _):xs) = xs
573− go (Text (CData CDataText s1 z):Text (CData CDataText s2 _):xs) =
574− Text (CData CDataText (s1 ++ s2) z):xs
575− go (Text (CData CDataText s1 z):CRef r:xs) =
576− Text (CData CDataText (s1 ++ convertEntity r) z):xs
577− go (CRef r:Text (CData CDataText s1 z):xs) =
578− Text (CData CDataText (convertEntity r ++ s1) z):xs
579− go (CRef r1:CRef r2:xs) =
580− Text (CData CDataText (convertEntity r1 ++ convertEntity r2) Nothing):xs
581− go xs = xs
582−
583−convertEntity :: String -> String
584−convertEntity e = Data.Maybe.fromMaybe (map toUpper e) (lookupEntity e)
585−
586582-- convenience function to get an attribute value, defaulting to ""
587−attrValue :: String -> Element -> Text
583+attrValue :: Text -> Element -> Text
588584attrValue attr elt =
589− maybe "" T.pack (lookupAttrBy (\x -> qName x == attr) (elAttribs elt))
585+ fromMaybe "" (lookupAttrBy (\x -> qName x == attr) (elAttribs elt))
590586
591587-- convenience function
592588named :: Text -> Element -> Bool
593−named s e = qName (elName e) == T.unpack s
589+named s e = qName (elName e) == s
594590
595591--
596592
@@ -605,16 +601,24 @@ addMetadataFromElement e = do
605601 Nothing -> return ()
606602 Just z -> addMetaField "author" z
607603 addMetaField "subtitle" e
608− addMetaField "author" e
604+ addAuthor e
609605 addMetaField "date" e
610606 addMetaField "release" e
611607 addMetaField "releaseinfo" e
612608 return mempty
613− where addMetaField fieldname elt =
614− case filterChildren (named fieldname) elt of
615− [] -> return ()
616− [z] -> getInlines z >>= addMeta fieldname
617− zs -> mapM getInlines zs >>= addMeta fieldname
609+ where
610+ addAuthor elt =
611+ case filterChildren (named "author") elt of
612+ [] -> return ()
613+ [z] -> fromAuthor z >>= addMeta "author"
614+ zs -> mapM fromAuthor zs >>= addMeta "author"
615+ fromAuthor elt =
616+ mconcat . intersperse space <$> mapM getInlines (elChildren elt)
617+ addMetaField fieldname elt =
618+ case filterChildren (named fieldname) elt of
619+ [] -> return ()
620+ [z] -> getInlines z >>= addMeta fieldname
621+ zs -> mapM getInlines zs >>= addMeta fieldname
618622
619623addMeta :: PandocMonad m => ToMetaValue a => Text -> a -> DB m ()
620624addMeta field val = modify (setMeta field val)
@@ -627,7 +631,7 @@ isBlockElement :: Content -> Bool
627631isBlockElement (Elem e) = qName (elName e) `elem` blockTags
628632isBlockElement _ = False
629633
630−blockTags :: [String]
634+blockTags :: [Text]
631635blockTags =
632636 [ "abstract"
633637 , "ackno"
@@ -644,6 +648,7 @@ blockTags =
644648 , "bibliodiv"
645649 , "biblioentry"
646650 , "bibliography"
651+ , "bibliomisc"
647652 , "bibliomixed"
648653 , "blockquote"
649654 , "book"
@@ -668,6 +673,7 @@ blockTags =
668673 , "index"
669674 , "info"
670675 , "informalexample"
676+ , "informalfigure"
671677 , "informaltable"
672678 , "itemizedlist"
673679 , "linegroup"
@@ -712,8 +718,8 @@ blockTags =
712718 , "variablelist"
713719 ] ++ admonitionTags
714720
715−admonitionTags :: [String]
716−admonitionTags = ["important","caution","note","tip","warning"]
721+admonitionTags :: [Text]
722+admonitionTags = ["caution","danger","important","note","tip","warning"]
717723
718724-- Trim leading and trailing newline characters
719725trimNl :: Text -> Text
@@ -770,10 +776,10 @@ getBlocks e = mconcat <$>
770776
771777parseBlock :: PandocMonad m => Content -> DB m Blocks
772778parseBlock (Text (CData CDataRaw _ _)) = return mempty -- DOCTYPE
773−parseBlock (Text (CData _ s _)) = if all isSpace s
779+parseBlock (Text (CData _ s _)) = if T.all isSpace s
774780 then return mempty
775− else return $ plain $ trimInlines $ text $ T.pack s
776−parseBlock (CRef x) = return $ plain $ str $ T.toUpper $ T.pack x
781+ else return $ plain $ trimInlines $ text s
782+parseBlock (CRef x) = return $ plain $ str $ T.toUpper x
777783parseBlock (Elem e) =
778784 case qName (elName e) of
779785 "toc" -> skip -- skip TOC, since in pandoc it's autogenerated
@@ -781,8 +787,8 @@ parseBlock (Elem e) =
781787 "para" -> parseMixed para (elContent e)
782788 "formalpara" -> do
783789 tit <- case filterChild (named "title") e of
784− Just t -> para . strong . (<> str ".") <$>
785− getInlines t
790+ Just t -> divWith ("",["formalpara-title"],[]) .
791+ para . strong <$> getInlines t
786792 Nothing -> return mempty
787793 (tit <>) <$> parseMixed para (elContent e)
788794 "simpara" -> parseMixed para (elContent e)
@@ -793,8 +799,12 @@ parseBlock (Elem e) =
793799 "titleabbrev" -> skip
794800 "authorinitials" -> skip
795801 "bibliography" -> sect 0
796− "bibliodiv" -> sect 1
802+ "bibliodiv" ->
803+ case filterChild (named "title") e of
804+ Just _ -> sect 1
805+ Nothing -> return mempty
797806 "biblioentry" -> parseMixed para (elContent e)
807+ "bibliomisc" -> parseMixed para (elContent e)
798808 "bibliomixed" -> parseMixed para (elContent e)
799809 "equation" -> para <$> equation e displayMath
800810 "informalequation" -> para <$> equation e displayMath
@@ -824,7 +834,7 @@ parseBlock (Elem e) =
824834 "refsect2" -> sect 2
825835 "refsect3" -> sect 3
826836 "refsection" -> gets dbSectionLevel >>= sect . (+1)
827− l | l `elem` admonitionTags -> parseAdmonition $ T.pack l
837+ l | l `elem` admonitionTags -> parseAdmonition l
828838 "area" -> skip
829839 "areaset" -> skip
830840 "areaspec" -> skip
@@ -850,6 +860,7 @@ parseBlock (Elem e) =
850860 "variablelist" -> definitionList <$> deflistitems
851861 "procedure" -> bulletList <$> steps
852862 "figure" -> getFigure e
863+ "informalfigure" -> getFigure e
853864 "mediaobject" -> para <$> getMediaobject e
854865 "caption" -> skip
855866 "info" -> addMetadataFromElement e
@@ -885,7 +896,11 @@ parseBlock (Elem e) =
885896 "subtitle" -> return mempty -- handled in parent element
886897 _ -> skip >> getBlocks e
887898 where skip = do
888− lift $ report $ IgnoredElement $ T.pack $ qName (elName e)
899+ let qn = qName $ elName e
900+ let name = if "pi-" `T.isPrefixOf` qn
901+ then "<?" <> qn <> "?>"
902+ else qn
903+ lift $ report $ IgnoredElement name
889904 return mempty
890905
891906 codeBlockWithLang = do
@@ -893,7 +908,7 @@ parseBlock (Elem e) =
893908 "" -> []
894909 x -> [x]
895910 return $ codeBlockWith (attrValue "id" e, classes', [])
896− $ trimNl $ T.pack $ strContentRecursive e
911+ $ trimNl $ strContentRecursive e
897912 parseBlockquote = do
898913 attrib <- case filterChild (named "attribution") e of
899914 Nothing -> return mempty
@@ -947,20 +962,29 @@ parseBlock (Elem e) =
947962 w <- findAttr (unqual "colwidth") c
948963 n <- safeRead $ "0" <> T.filter (\x ->
949964 (x >= '0' && x <= '9')
950− || x == '.') (T.pack w)
965+ || x == '.') w
951966 if n > 0 then Just n else Nothing
952− let numrows = case bodyrows of
953− [] -> 0
954− xs -> maximum $ map length xs
967+ let numrows = maybe 0 maximum $ nonEmpty
968+ $ map length bodyrows
955969 let aligns = case colspecs of
956970 [] -> replicate numrows AlignDefault
957971 cs -> map toAlignment cs
972+ let parseWidth s = safeRead (T.filter (\x -> (x >= '0' && x <= '9')
973+ || x == '.') s)
974+ let textWidth = case filterChild (named "pi-dbfo") e of
975+ Just d -> case attrValue "table-width" d of
976+ "" -> 1.0
977+ w -> fromMaybe 100.0 (parseWidth w) / 100.0
978+ Nothing -> 1.0
958979 let widths = case colspecs of
959980 [] -> replicate numrows ColWidthDefault
960981 cs -> let ws = map toWidth cs
961982 in case sequence ws of
962− Just ws' -> let tot = sum ws'
963− in ColWidth . (/ tot) <$> ws'
983+ Just ws' -> let colTot = sum ws'
984+ scale
985+ | textWidth == 1.0 = (/ colTot)
986+ | otherwise = (* (textWidth / colTot) )
987+ in ColWidth . scale <$> ws'
964988 Nothing -> replicate numrows ColWidthDefault
965989 let toRow = Row nullAttr
966990 toHeaderRow l = [toRow l | not (null l)]
@@ -1020,12 +1044,12 @@ parseMixed container conts = do
10201044 x <- parseMixed container rs
10211045 return $ p <> b <> x
10221046
1023−parseRow :: PandocMonad m => [String] -> Element -> DB m [Cell]
1047+parseRow :: PandocMonad m => [Text] -> Element -> DB m [Cell]
10241048parseRow cn = do
10251049 let isEntry x = named "entry" x || named "td" x || named "th" x
10261050 mapM (parseEntry cn) . filterChildren isEntry
10271051
1028−parseEntry :: PandocMonad m => [String] -> Element -> DB m Cell
1052+parseEntry :: PandocMonad m => [Text] -> Element -> DB m Cell
10291053parseEntry cn el = do
10301054 let colDistance sa ea = do
10311055 let iStrt = elemIndex sa cn
@@ -1041,13 +1065,13 @@ parseEntry cn el = do
10411065 _ -> 1
10421066 let colSpan = toColSpan el
10431067 let align = toAlignment el
1044− (fmap (cell align 1 colSpan) . (parseMixed plain) . elContent) el
1068+ (fmap (cell align 1 colSpan) . parseMixed plain . elContent) el
10451069
10461070getInlines :: PandocMonad m => Element -> DB m Inlines
10471071getInlines e' = trimInlines . mconcat <$>
10481072 mapM parseInline (elContent e')
10491073
1050−strContentRecursive :: Element -> String
1074+strContentRecursive :: Element -> Text
10511075strContentRecursive = strContent .
10521076 (\e' -> e'{ elContent = map elementToStr $ elContent e' })
10531077
@@ -1056,14 +1080,16 @@ elementToStr (Elem e') = Text $ CData CDataText (strContentRecursive e') Nothing
10561080elementToStr x = x
10571081
10581082parseInline :: PandocMonad m => Content -> DB m Inlines
1059−parseInline (Text (CData _ s _)) = return $ text $ T.pack s
1083+parseInline (Text (CData _ s _)) = return $ text s
10601084parseInline (CRef ref) =
1061− return $ text $ maybe (T.toUpper $ T.pack ref) T.pack $ lookupEntity ref
1085+ return $ text $ maybe (T.toUpper ref) T.pack $ lookupEntity (T.unpack ref)
10621086parseInline (Elem e) =
10631087 case qName (elName e) of
1088+ "anchor" -> do
1089+ return $ spanWith (attrValue "id" e, [], []) mempty
10641090 "phrase" -> do
10651091 let ident = attrValue "id" e
1066− let classes = T.words $ attrValue "class" e
1092+ let classes = T.words $ attrValue "role" e
10671093 if ident /= "" || classes /= []
10681094 then innerInlines (spanWith (ident,classes,[]))
10691095 else innerInlines id
@@ -1108,7 +1134,7 @@ parseInline (Elem e) =
11081134 "userinput" -> codeWithLang
11091135 "systemitem" -> codeWithLang
11101136 "varargs" -> return $ code "(...)"
1111− "keycap" -> return (str $ T.pack $ strContent e)
1137+ "keycap" -> return (str $ strContent e)
11121138 "keycombo" -> keycombo <$>
11131139 mapM parseInline (elContent e)
11141140 "menuchoice" -> menuchoice <$>
@@ -1120,17 +1146,17 @@ parseInline (Elem e) =
11201146 let title = case attrValue "endterm" e of
11211147 "" -> maybe "???" xrefTitleByElem
11221148 (findElementById linkend content)
1123− endterm -> maybe "???" (T.pack . strContent)
1149+ endterm -> maybe "???" strContent
11241150 (findElementById endterm content)
11251151 return $ link ("#" <> linkend) "" (text title)
1126− "email" -> return $ link ("mailto:" <> T.pack (strContent e)) ""
1127− $ str $ T.pack $ strContent e
1128− "uri" -> return $ link (T.pack $ strContent e) "" $ str $ T.pack $ strContent e
1152+ "email" -> return $ link ("mailto:" <> strContent e) ""
1153+ $ str $ strContent e
1154+ "uri" -> return $ link (strContent e) "" $ str $ strContent e
11291155 "ulink" -> innerInlines (link (attrValue "url" e) "")
11301156 "link" -> do
11311157 ils <- innerInlines id
11321158 let href = case findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) e of
1133− Just h -> T.pack h
1159+ Just h -> h
11341160 _ -> "#" <> attrValue "linkend" e
11351161 let ils' = if ils == mempty then str href else ils
11361162 let attr = (attrValue "id" e, T.words $ attrValue "role" e, [])
@@ -1146,12 +1172,15 @@ parseInline (Elem e) =
11461172 "title" -> return mempty
11471173 "affiliation" -> skip
11481174 -- Note: this isn't a real docbook tag; it's what we convert
1149− -- <?asciidor-br?> to in handleInstructions, above. A kludge to
1150− -- work around xml-light's inability to parse an instruction.
1151− "br" -> return linebreak
1175+ -- <?asciidor-br?> to in handleInstructions, above.
1176+ "pi-asciidoc-br" -> return linebreak
11521177 _ -> skip >> innerInlines id
11531178 where skip = do
1154− lift $ report $ IgnoredElement $ T.pack $ qName (elName e)
1179+ let qn = qName $ elName e
1180+ let name = if "pi-" `T.isPrefixOf` qn
1181+ then "<?" <> qn <> "?>"
1182+ else qn
1183+ lift $ report $ IgnoredElement name
11551184 return mempty
11561185
11571186 innerInlines f = extractSpaces f . mconcat <$>
@@ -1160,7 +1189,7 @@ parseInline (Elem e) =
11601189 let classes' = case attrValue "language" e of
11611190 "" -> []
11621191 l -> [l]
1163− return $ codeWith (attrValue "id" e,classes',[]) $ T.pack $ strContentRecursive e
1192+ return $ codeWith (attrValue "id" e,classes',[]) $ strContentRecursive e
11641193 simpleList = mconcat . intersperse (str "," <> space) <$> mapM getInlines
11651194 (filterChildren (named "member") e)
11661195 segmentedList = do
@@ -1201,10 +1230,10 @@ parseInline (Elem e) =
12011230 "sect5" -> descendantContent "title" el
12021231 "cmdsynopsis" -> descendantContent "command" el
12031232 "funcsynopsis" -> descendantContent "function" el
1204− _ -> T.pack $ qName (elName el) ++ "_title"
1233+ _ -> qName (elName el) <> "_title"
12051234 where
12061235 xrefLabel = attrValue "xreflabel" el
1207− descendantContent name = maybe "???" (T.pack . strContent)
1236+ descendantContent name = maybe "???" strContent
12081237 . filterElementName (\n -> qName n == name)
12091238
12101239-- | Extract a math equation from an element
@@ -1224,8 +1253,9 @@ equation e constructor =
12241253 where
12251254 mathMLEquations :: [Text]
12261255 mathMLEquations = map writeTeX $ rights $ readMath
1227− (\x -> qName (elName x) == "math" && qPrefix (elName x) == Just "mml")
1228− (readMathML . T.pack . showElement)
1256+ (\x -> qName (elName x) == "math" &&
1257+ qURI (elName x) == Just "http://www.w3.org/1998/Math/MathML")
1258+ (readMathML . showElement)
12291259
12301260 latexEquations :: [Text]
12311261 latexEquations = readMath (\x -> qName (elName x) == "mathphrase")
@@ -1239,8 +1269,8 @@ equation e constructor =
12391269-- | Get the actual text stored in a CData block. 'showContent'
12401270-- returns the text still surrounded by the [[CDATA]] tags.
12411271showVerbatimCData :: Content -> Text
1242−showVerbatimCData (Text (CData _ d _)) = T.pack d
1243−showVerbatimCData c = T.pack $ showContent c
1272+showVerbatimCData (Text (CData _ d _)) = d
1273+showVerbatimCData c = showContent c
12441274
12451275
12461276-- | Set the prefix of a name to 'Nothing'
src/Text/Pandoc/Readers/Docx.hs+62−47
@@ -1,7 +1,6 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE OverloadedStrings #-}
33{-# LANGUAGE PatternGuards #-}
4−{-# LANGUAGE MultiWayIf #-}
54{-# LANGUAGE FlexibleContexts #-}
65{-# LANGUAGE ViewPatterns #-}
76{- |
@@ -62,13 +61,14 @@ module Text.Pandoc.Readers.Docx
6261import Codec.Archive.Zip
6362import Control.Monad.Reader
6463import Control.Monad.State.Strict
64+import Data.Bifunctor (bimap, first)
6565import qualified Data.ByteString.Lazy as B
6666import Data.Default (Default)
67−import Data.List (delete, intersect)
67+import Data.List (delete, intersect, foldl')
6868import Data.Char (isSpace)
6969import qualified Data.Map as M
7070import qualified Data.Text as T
71−import Data.Maybe (isJust, fromMaybe)
71+import Data.Maybe (catMaybes, isJust, fromMaybe)
7272import Data.Sequence (ViewL (..), viewl)
7373import qualified Data.Sequence as Seq
7474import qualified Data.Set as Set
@@ -86,6 +86,7 @@ import Text.Pandoc.Class.PandocMonad (PandocMonad)
8686import qualified Text.Pandoc.Class.PandocMonad as P
8787import Text.Pandoc.Error
8888import Text.Pandoc.Logging
89+import Data.List.NonEmpty (nonEmpty)
8990
9091readDocx :: PandocMonad m
9192 => ReaderOptions
@@ -113,6 +114,7 @@ data DState = DState { docxAnchorMap :: M.Map T.Text T.Text
113114 -- restarting
114115 , docxListState :: M.Map (T.Text, T.Text) Integer
115116 , docxPrevPara :: Inlines
117+ , docxTableCaptions :: [Blocks]
116118 }
117119
118120instance Default DState where
@@ -123,6 +125,7 @@ instance Default DState where
123125 , docxDropCap = mempty
124126 , docxListState = M.empty
125127 , docxPrevPara = mempty
128+ , docxTableCaptions = []
126129 }
127130
128131data DEnv = DEnv { docxOptions :: ReaderOptions
@@ -417,7 +420,7 @@ parPartToInlines' (BookMark _ anchor) =
417420 (modify $ \s -> s { docxAnchorMap = M.insert anchor prevAnchor anchorMap})
418421 return mempty
419422 Nothing -> do
420− exts <- readerExtensions <$> asks docxOptions
423+ exts <- asks (readerExtensions . docxOptions)
421424 let newAnchor =
422425 if not inHdrBool && anchor `elem` M.elems anchorMap
423426 then uniqueIdent exts [Str anchor]
@@ -462,7 +465,7 @@ makeHeaderAnchor' (Header n (ident, classes, kvs) ils)
462465 | (c:_) <- filter isAnchorSpan ils
463466 , (Span (anchIdent, ["anchor"], _) cIls) <- c = do
464467 hdrIDMap <- gets docxAnchorMap
465− exts <- readerExtensions <$> asks docxOptions
468+ exts <- asks (readerExtensions . docxOptions)
466469 let newIdent = if T.null ident
467470 then uniqueIdent exts ils (Set.fromList $ M.elems hdrIDMap)
468471 else ident
@@ -475,7 +478,7 @@ makeHeaderAnchor' (Header n (ident, classes, kvs) ils)
475478makeHeaderAnchor' (Header n (ident, classes, kvs) ils) =
476479 do
477480 hdrIDMap <- gets docxAnchorMap
478− exts <- readerExtensions <$> asks docxOptions
481+ exts <- asks (readerExtensions . docxOptions)
479482 let newIdent = if T.null ident
480483 then uniqueIdent exts ils (Set.fromList $ M.elems hdrIDMap)
481484 else ident
@@ -491,15 +494,32 @@ singleParaToPlain blks
491494 singleton $ Plain ils
492495singleParaToPlain blks = blks
493496
494−cellToBlocks :: PandocMonad m => Docx.Cell -> DocxContext m Blocks
495−cellToBlocks (Docx.Cell bps) = do
497+cellToCell :: PandocMonad m => RowSpan -> Docx.Cell -> DocxContext m Pandoc.Cell
498+cellToCell rowSpan (Docx.Cell gridSpan _ bps) = do
496499 blks <- smushBlocks <$> mapM bodyPartToBlocks bps
497− return $ fromList $ blocksToDefinitions $ blocksToBullets $ toList blks
500+ let blks' = singleParaToPlain $ fromList $ blocksToDefinitions $ blocksToBullets $ toList blks
501+ return (cell AlignDefault rowSpan (ColSpan (fromIntegral gridSpan)) blks')
502+
503+rowsToRows :: PandocMonad m => [Docx.Row] -> DocxContext m [Pandoc.Row]
504+rowsToRows rows = do
505+ let rowspans = (fmap . fmap) (first RowSpan) (Docx.rowsToRowspans rows)
506+ cells <- traverse (traverse (uncurry cellToCell)) rowspans
507+ return (fmap (Pandoc.Row nullAttr) cells)
508+
509+splitHeaderRows :: Bool -> [Docx.Row] -> ([Docx.Row], [Docx.Row])
510+splitHeaderRows hasFirstRowFormatting rs = bimap reverse reverse $ fst
511+ $ if hasFirstRowFormatting
512+ then foldl' f ((take 1 rs, []), True) (drop 1 rs)
513+ else foldl' f (([], []), False) rs
514+ where
515+ f ((headerRows, bodyRows), previousRowWasHeader) r@(Docx.Row h cs)
516+ | h == HasTblHeader || (previousRowWasHeader && any isContinuationCell cs)
517+ = ((r : headerRows, bodyRows), True)
518+ | otherwise
519+ = ((headerRows, r : bodyRows), False)
520+
521+ isContinuationCell (Docx.Cell _ vm _) = vm == Docx.Continue
498522
499−rowToBlocksList :: PandocMonad m => Docx.Row -> DocxContext m [Blocks]
500−rowToBlocksList (Docx.Row cells) = do
501− blksList <- mapM cellToBlocks cells
502− return $ map singleParaToPlain blksList
503523
504524-- like trimInlines, but also take out linebreaks
505525trimSps :: Inlines -> Inlines
@@ -546,6 +566,11 @@ normalizeToClassName = T.map go . fromStyleName
546566 where go c | isSpace c = '-'
547567 | otherwise = c
548568
569+bodyPartToTableCaption :: PandocMonad m => BodyPart -> DocxContext m (Maybe Blocks)
570+bodyPartToTableCaption (TblCaption pPr parparts) =
571+ Just <$> bodyPartToBlocks (Paragraph pPr parparts)
572+bodyPartToTableCaption _ = pure Nothing
573+
549574bodyPartToBlocks :: PandocMonad m => BodyPart -> DocxContext m Blocks
550575bodyPartToBlocks (Paragraph pPr parparts)
551576 | Just True <- pBidi pPr = do
@@ -637,54 +662,43 @@ bodyPartToBlocks (ListItem pPr _ _ _ parparts) =
637662 let pPr' = pPr {pStyle = constructBogusParStyleData "list-paragraph": pStyle pPr}
638663 in
639664 bodyPartToBlocks $ Paragraph pPr' parparts
665+bodyPartToBlocks (TblCaption _ _) =
666+ return $ para mempty -- collected separately
640667bodyPartToBlocks (Tbl _ _ _ []) =
641668 return $ para mempty
642−bodyPartToBlocks (Tbl cap _ look parts@(r:rs)) = do
643− let cap' = simpleCaption $ plain $ text cap
644− (hdr, rows) = case firstRowFormatting look of
645− True | null rs -> (Nothing, [r])
646− | otherwise -> (Just r, rs)
647− False -> (Nothing, r:rs)
648−
649− cells <- mapM rowToBlocksList rows
669+bodyPartToBlocks (Tbl cap grid look parts) = do
670+ captions <- gets docxTableCaptions
671+ fullCaption <- case captions of
672+ c : cs -> do
673+ modify (\s -> s { docxTableCaptions = cs })
674+ return c
675+ [] -> return $ if T.null cap then mempty else plain (text cap)
676+ let shortCaption = if T.null cap then Nothing else Just (toList (text cap))
677+ cap' = caption shortCaption fullCaption
678+ (hdr, rows) = splitHeaderRows (firstRowFormatting look) parts
650679
651680 let width = maybe 0 maximum $ nonEmpty $ map rowLength parts
652− -- Data.List.NonEmpty is not available with ghc 7.10 so we roll out
653− -- our own, see
654− -- https://github.com/jgm/pandoc/pull/4361#issuecomment-365416155
655− nonEmpty [] = Nothing
656− nonEmpty l = Just l
657681 rowLength :: Docx.Row -> Int
658− rowLength (Docx.Row c) = length c
682+ rowLength (Docx.Row _ c) = sum (fmap (\(Docx.Cell gridSpan _ _) -> fromIntegral gridSpan) c)
659683
660− let toRow = Pandoc.Row nullAttr . map simpleCell
661− toHeaderRow l = [toRow l | not (null l)]
684+ headerCells <- rowsToRows hdr
685+ bodyCells <- rowsToRows rows
662686
663− -- pad cells. New Text.Pandoc.Builder will do that for us,
664− -- so this is for compatibility while we switch over.
665− let cells' = map (\row -> toRow $ take width (row ++ repeat mempty)) cells
666−
667− hdrCells <- case hdr of
668− Just r' -> toHeaderRow <$> rowToBlocksList r'
669− Nothing -> return []
670−
671− -- The two following variables (horizontal column alignment and
672− -- relative column widths) go to the default at the
673− -- moment. Width information is in the TblGrid field of the Tbl,
674− -- so should be possible. Alignment might be more difficult,
675− -- since there doesn't seem to be a column entity in docx.
687+ -- Horizontal column alignment goes to the default at the moment. Getting
688+ -- it might be difficult, since there doesn't seem to be a column entity
689+ -- in docx.
676690 let alignments = replicate width AlignDefault
677− widths = replicate width ColWidthDefault
691+ totalWidth = sum grid
692+ widths = (\w -> ColWidth (fromInteger w / fromInteger totalWidth)) <$> grid
678693
679694 return $ table cap'
680695 (zip alignments widths)
681− (TableHead nullAttr hdrCells)
682− [TableBody nullAttr 0 [] cells']
696+ (TableHead nullAttr headerCells)
697+ [TableBody nullAttr 0 [] bodyCells]
683698 (TableFoot nullAttr [])
684699bodyPartToBlocks (OMathPara e) =
685700 return $ para $ displayMath (writeTeX e)
686701
687−
688702-- replace targets with generated anchors.
689703rewriteLink' :: PandocMonad m => Inline -> DocxContext m Inline
690704rewriteLink' l@(Link attr ils (T.uncons -> Just ('#',target), title)) = do
@@ -720,6 +734,8 @@ bodyToOutput :: PandocMonad m => Body -> DocxContext m (Meta, [Block])
720734bodyToOutput (Body bps) = do
721735 let (metabps, blkbps) = sepBodyParts bps
722736 meta <- bodyPartsToMeta metabps
737+ captions <- catMaybes <$> mapM bodyPartToTableCaption blkbps
738+ modify (\s -> s { docxTableCaptions = captions })
723739 blks <- smushBlocks <$> mapM bodyPartToBlocks blkbps
724740 blks' <- rewriteLinks $ blocksToDefinitions $ blocksToBullets $ toList blks
725741 blks'' <- removeOrphanAnchors blks'
@@ -736,4 +752,3 @@ docxToOutput opts (Docx (Document _ body)) =
736752addAuthorAndDate :: T.Text -> Maybe T.Text -> [(T.Text, T.Text)]
737753addAuthorAndDate author mdate =
738754 ("author", author) : maybe [] (\date -> [("date", date)]) mdate
739−
src/Text/Pandoc/Readers/Docx/Combine.hs+7−7
@@ -2,7 +2,7 @@
22{- |
33 Module : Text.Pandoc.Readers.Docx.Combine
44 Copyright : © 2014-2020 Jesse Rosenthal <jrosenthal@jhu.edu>,
5− 2014-2020 John MacFarlane <jgm@berkeley.edu>,
5+ 2014-2021 John MacFarlane <jgm@berkeley.edu>,
66 2020 Nikolay Yakimov <root@livid.pp.ru>
77 License : GNU GPL, version 2 or above
88
@@ -61,7 +61,7 @@ import Data.List
6161import Data.Bifunctor
6262import Data.Sequence ( ViewL (..), ViewR (..), viewl, viewr, spanr, spanl
6363 , (><), (|>) )
64−import Text.Pandoc.Builder
64+import Text.Pandoc.Builder as B
6565
6666data Modifier a = Modifier (a -> a)
6767 | AttrModifier (Attr -> a -> a) Attr
@@ -109,19 +109,19 @@ ilModifierAndInnards ils = case viewl $ unMany ils of
109109 Underline lst -> Just (Modifier underline, lst)
110110 Superscript lst -> Just (Modifier superscript, lst)
111111 Subscript lst -> Just (Modifier subscript, lst)
112− Link attr lst tgt -> Just (Modifier $ linkWith attr (fst tgt) (snd tgt), lst)
112+ Link attr lst tgt -> Just (Modifier $ uncurry (linkWith attr) tgt, lst)
113113 Span attr lst -> Just (AttrModifier spanWith attr, lst)
114114 _ -> Nothing
115115 _ -> Nothing
116116
117117inlinesL :: Inlines -> (Inlines, Inlines)
118118inlinesL ils = case viewl $ unMany ils of
119− (s :< sq) -> (singleton s, Many sq)
119+ (s :< sq) -> (B.singleton s, Many sq)
120120 _ -> (mempty, ils)
121121
122122inlinesR :: Inlines -> (Inlines, Inlines)
123123inlinesR ils = case viewr $ unMany ils of
124− (sq :> s) -> (Many sq, singleton s)
124+ (sq :> s) -> (Many sq, B.singleton s)
125125 _ -> (ils, mempty)
126126
127127combineInlines :: Inlines -> Inlines -> Inlines
@@ -182,7 +182,7 @@ isAttrModifier _ = False
182182
183183smushInlines :: [Inlines] -> Inlines
184184smushInlines xs = combineInlines xs' mempty
185− where xs' = foldl combineInlines mempty xs
185+ where xs' = foldl' combineInlines mempty xs
186186
187187smushBlocks :: [Blocks] -> Blocks
188−smushBlocks xs = foldl combineBlocks mempty xs
188+smushBlocks xs = foldl' combineBlocks mempty xs
src/Text/Pandoc/Readers/Docx/Parse.hs+214−120
@@ -33,7 +33,9 @@ module Text.Pandoc.Readers.Docx.Parse ( Docx(..)
3333 , ParStyle
3434 , CharStyle(cStyleData)
3535 , Row(..)
36+ , TblHeader(..)
3637 , Cell(..)
38+ , VMerge(..)
3739 , TrackedChange(..)
3840 , ChangeType(..)
3941 , ChangeInfo(..)
@@ -50,6 +52,7 @@ module Text.Pandoc.Readers.Docx.Parse ( Docx(..)
5052 , pHeading
5153 , constructBogusParStyleData
5254 , leftBiasedMergeRunStyle
55+ , rowsToRowspans
5356 ) where
5457import Text.Pandoc.Readers.Docx.Parse.Styles
5558import Codec.Archive.Zip
@@ -63,6 +66,7 @@ import Data.Char (chr, ord, readLitChar)
6366import Data.List
6467import qualified Data.Map as M
6568import qualified Data.Text as T
69+import Data.Text (Text)
6670import Data.Maybe
6771import System.FilePath
6872import Text.Pandoc.Readers.Docx.Util
@@ -72,8 +76,7 @@ import qualified Text.Pandoc.UTF8 as UTF8
7276import Text.TeXMath (Exp)
7377import Text.TeXMath.Readers.OMML (readOMML)
7478import Text.TeXMath.Unicode.Fonts (Font (..), getUnicode, textToFont)
75−import Text.XML.Light
76−import qualified Text.XML.Light.Cursor as XMLC
79+import Text.Pandoc.XML.Light
7780
7881data ReaderEnv = ReaderEnv { envNotes :: Notes
7982 , envComments :: Comments
@@ -127,37 +130,23 @@ mapD f xs =
127130 in
128131 concatMapM handler xs
129132
130−unwrap :: NameSpaces -> Content -> [Content]
131−unwrap ns (Elem element)
133+unwrapElement :: NameSpaces -> Element -> [Element]
134+unwrapElement ns element
132135 | isElem ns "w" "sdt" element
133136 , Just sdtContent <- findChildByName ns "w" "sdtContent" element
134− = concatMap (unwrap ns . Elem) (elChildren sdtContent)
137+ = concatMap (unwrapElement ns) (elChildren sdtContent)
135138 | isElem ns "w" "smartTag" element
136− = concatMap (unwrap ns . Elem) (elChildren element)
137−unwrap _ content = [content]
139+ = concatMap (unwrapElement ns) (elChildren element)
140+ | otherwise
141+ = [element{ elContent = concatMap (unwrapContent ns) (elContent element) }]
138142
139−unwrapChild :: NameSpaces -> Content -> Content
140−unwrapChild ns (Elem element) =
141− Elem $ element { elContent = concatMap (unwrap ns) (elContent element) }
142−unwrapChild _ content = content
143+unwrapContent :: NameSpaces -> Content -> [Content]
144+unwrapContent ns (Elem element) = map Elem $ unwrapElement ns element
145+unwrapContent _ content = [content]
143146
144−walkDocument' :: NameSpaces -> XMLC.Cursor -> XMLC.Cursor
145−walkDocument' ns cur =
146− let modifiedCur = XMLC.modifyContent (unwrapChild ns) cur
147− in
148− case XMLC.nextDF modifiedCur of
149− Just cur' -> walkDocument' ns cur'
150− Nothing -> XMLC.root modifiedCur
151−
152−walkDocument :: NameSpaces -> Element -> Maybe Element
147+walkDocument :: NameSpaces -> Element -> Element
153148walkDocument ns element =
154− let cur = XMLC.fromContent (Elem element)
155− cur' = walkDocument' ns cur
156− in
157− case XMLC.toTree cur' of
158− Elem element' -> Just element'
159− _ -> Nothing
160−
149+ element{ elContent = concatMap (unwrapContent ns) (elContent element) }
161150
162151newtype Docx = Docx Document
163152 deriving Show
@@ -239,6 +228,7 @@ defaultParagraphStyle = ParagraphStyle { pStyle = []
239228data BodyPart = Paragraph ParagraphStyle [ParPart]
240229 | ListItem ParagraphStyle T.Text T.Text (Maybe Level) [ParPart]
241230 | Tbl T.Text TblGrid TblLook [Row]
231+ | TblCaption ParagraphStyle [ParPart]
242232 | OMathPara [Exp]
243233 deriving Show
244234
@@ -250,12 +240,61 @@ newtype TblLook = TblLook {firstRowFormatting::Bool}
250240defaultTblLook :: TblLook
251241defaultTblLook = TblLook{firstRowFormatting = False}
252242
253−newtype Row = Row [Cell]
254− deriving Show
243+data Row = Row TblHeader [Cell] deriving Show
255244
256−newtype Cell = Cell [BodyPart]
245+data TblHeader = HasTblHeader | NoTblHeader deriving (Show, Eq)
246+
247+data Cell = Cell GridSpan VMerge [BodyPart]
257248 deriving Show
258249
250+type GridSpan = Integer
251+
252+data VMerge = Continue
253+ -- ^ This cell should be merged with the one above it
254+ | Restart
255+ -- ^ This cell should not be merged with the one above it
256+ deriving (Show, Eq)
257+
258+rowsToRowspans :: [Row] -> [[(Int, Cell)]]
259+rowsToRowspans rows = let
260+ removeMergedCells = fmap (filter (\(_, Cell _ vmerge _) -> vmerge == Restart))
261+ in removeMergedCells (foldr f [] rows)
262+ where
263+ f :: Row -> [[(Int, Cell)]] -> [[(Int, Cell)]]
264+ f (Row _ cells) acc = let
265+ spans = g cells Nothing (listToMaybe acc)
266+ in spans : acc
267+
268+ g ::
269+ -- | The current row
270+ [Cell] ->
271+ -- | Number of columns left below
272+ Maybe Integer ->
273+ -- | (rowspan so far, cell) for the row below this one
274+ Maybe [(Int, Cell)] ->
275+ -- | (rowspan so far, cell) for this row
276+ [(Int, Cell)]
277+ g cells _ Nothing = zip (repeat 1) cells
278+ g cells columnsLeftBelow (Just rowBelow) =
279+ case cells of
280+ [] -> []
281+ thisCell@(Cell thisGridSpan _ _) : restOfRow -> case rowBelow of
282+ [] -> zip (repeat 1) cells
283+ (spanSoFarBelow, Cell gridSpanBelow vmerge _) : _ ->
284+ let spanSoFar = case vmerge of
285+ Restart -> 1
286+ Continue -> 1 + spanSoFarBelow
287+ columnsToDrop = thisGridSpan + (gridSpanBelow - fromMaybe gridSpanBelow columnsLeftBelow)
288+ (newColumnsLeftBelow, restOfRowBelow) = dropColumns columnsToDrop rowBelow
289+ in (spanSoFar, thisCell) : g restOfRow (Just newColumnsLeftBelow) (Just restOfRowBelow)
290+
291+ dropColumns :: Integer -> [(a, Cell)] -> (Integer, [(a, Cell)])
292+ dropColumns n [] = (n, [])
293+ dropColumns n cells@((_, Cell gridSpan _ _) : otherCells) =
294+ if n < gridSpan
295+ then (gridSpan - n, cells)
296+ else dropColumns (n - gridSpan) otherCells
297+
259298leftBiasedMergeRunStyle :: RunStyle -> RunStyle -> RunStyle
260299leftBiasedMergeRunStyle a b = RunStyle
261300 { isBold = isBold a <|> isBold b
@@ -343,10 +382,16 @@ archiveToDocxWithWarnings archive = do
343382 Right doc -> Right (Docx doc, stateWarnings st)
344383 Left e -> Left e
345384
385+parseXMLFromEntry :: Entry -> Maybe Element
386+parseXMLFromEntry entry =
387+ case parseXMLElement (UTF8.toTextLazy (fromEntry entry)) of
388+ Left _ -> Nothing
389+ Right el -> Just el
390+
346391getDocumentXmlPath :: Archive -> Maybe FilePath
347392getDocumentXmlPath zf = do
348393 entry <- findEntryByPath "_rels/.rels" zf
349− relsElem <- (parseXMLDoc . UTF8.toStringLazy . fromEntry) entry
394+ relsElem <- parseXMLFromEntry entry
350395 let rels = filterChildrenName (\n -> qName n == "Relationship") relsElem
351396 rel <- find (\e -> findAttr (QName "Type" Nothing Nothing) e ==
352397 Just "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument")
@@ -354,18 +399,18 @@ getDocumentXmlPath zf = do
354399 fp <- findAttr (QName "Target" Nothing Nothing) rel
355400 -- sometimes there will be a leading slash, which windows seems to
356401 -- have trouble with.
357− return $ case fp of
402+ return $ case T.unpack fp of
358403 '/' : fp' -> fp'
359− _ -> fp
404+ fp' -> fp'
360405
361406archiveToDocument :: Archive -> D Document
362407archiveToDocument zf = do
363408 docPath <- asks envDocXmlPath
364409 entry <- maybeToD $ findEntryByPath docPath zf
365− docElem <- maybeToD $ (parseXMLDoc . UTF8.toStringLazy . fromEntry) entry
410+ docElem <- maybeToD $ parseXMLFromEntry entry
366411 let namespaces = elemToNameSpaces docElem
367412 bodyElem <- maybeToD $ findChildByName namespaces "w" "body" docElem
368− let bodyElem' = fromMaybe bodyElem (walkDocument namespaces bodyElem)
413+ let bodyElem' = walkDocument namespaces bodyElem
369414 body <- elemToBody namespaces bodyElem'
370415 return $ Document namespaces body
371416
@@ -401,23 +446,24 @@ constructBogusParStyleData stName = ParStyle
401446archiveToNotes :: Archive -> Notes
402447archiveToNotes zf =
403448 let fnElem = findEntryByPath "word/footnotes.xml" zf
404− >>= (parseXMLDoc . UTF8.toStringLazy . fromEntry)
449+ >>= parseXMLFromEntry
405450 enElem = findEntryByPath "word/endnotes.xml" zf
406− >>= (parseXMLDoc . UTF8.toStringLazy . fromEntry)
407− fn_namespaces = maybe [] elemToNameSpaces fnElem
408− en_namespaces = maybe [] elemToNameSpaces enElem
409− ns = unionBy (\x y -> fst x == fst y) fn_namespaces en_namespaces
410− fn = fnElem >>= walkDocument ns >>= elemToNotes ns "footnote"
411− en = enElem >>= walkDocument ns >>= elemToNotes ns "endnote"
451+ >>= parseXMLFromEntry
452+ fn_namespaces = maybe mempty elemToNameSpaces fnElem
453+ en_namespaces = maybe mempty elemToNameSpaces enElem
454+ ns = M.union fn_namespaces en_namespaces
455+ fn = fnElem >>= elemToNotes ns "footnote" . walkDocument ns
456+ en = enElem >>= elemToNotes ns "endnote" . walkDocument ns
412457 in
413458 Notes ns fn en
414459
415460archiveToComments :: Archive -> Comments
416461archiveToComments zf =
417462 let cmtsElem = findEntryByPath "word/comments.xml" zf
418− >>= (parseXMLDoc . UTF8.toStringLazy . fromEntry)
419− cmts_namespaces = maybe [] elemToNameSpaces cmtsElem
420− cmts = elemToComments cmts_namespaces <$> (cmtsElem >>= walkDocument cmts_namespaces)
463+ >>= parseXMLFromEntry
464+ cmts_namespaces = maybe mempty elemToNameSpaces cmtsElem
465+ cmts = elemToComments cmts_namespaces . walkDocument cmts_namespaces <$>
466+ cmtsElem
421467 in
422468 case cmts of
423469 Just c -> Comments cmts_namespaces c
@@ -433,20 +479,26 @@ filePathToRelType path docXmlPath =
433479 then Just InDocument
434480 else Nothing
435481
436−relElemToRelationship :: DocumentLocation -> Element -> Maybe Relationship
437−relElemToRelationship relType element | qName (elName element) == "Relationship" =
482+relElemToRelationship :: FilePath -> DocumentLocation -> Element
483+ -> Maybe Relationship
484+relElemToRelationship fp relType element | qName (elName element) == "Relationship" =
438485 do
439− relId <- findAttrText (QName "Id" Nothing Nothing) element
440− target <- findAttrText (QName "Target" Nothing Nothing) element
441− return $ Relationship relType relId target
442−relElemToRelationship _ _ = Nothing
486+ relId <- findAttr (QName "Id" Nothing Nothing) element
487+ target <- findAttr (QName "Target" Nothing Nothing) element
488+ -- target may be relative (media/image1.jpeg) or absolute
489+ -- (/word/media/image1.jpeg); we need to relativize it (see #7374)
490+ let frontOfFp = T.pack $ takeWhile (/= '_') fp
491+ let target' = fromMaybe target $
492+ T.stripPrefix frontOfFp $ T.dropWhile (== '/') target
493+ return $ Relationship relType relId target'
494+relElemToRelationship _ _ _ = Nothing
443495
444496filePathToRelationships :: Archive -> FilePath -> FilePath -> [Relationship]
445497filePathToRelationships ar docXmlPath fp
446498 | Just relType <- filePathToRelType fp docXmlPath
447499 , Just entry <- findEntryByPath fp ar
448− , Just relElems <- (parseXMLDoc . UTF8.toStringLazy . fromEntry) entry =
449− mapMaybe (relElemToRelationship relType) $ elChildren relElems
500+ , Just relElems <- parseXMLFromEntry entry =
501+ mapMaybe (relElemToRelationship fp relType) $ elChildren relElems
450502filePathToRelationships _ _ _ = []
451503
452504archiveToRelationships :: Archive -> FilePath -> [Relationship]
@@ -478,10 +530,10 @@ lookupLevel numId ilvl (Numbering _ numbs absNumbs) = do
478530loElemToLevelOverride :: NameSpaces -> Element -> Maybe LevelOverride
479531loElemToLevelOverride ns element
480532 | isElem ns "w" "lvlOverride" element = do
481− ilvl <- findAttrTextByName ns "w" "ilvl" element
533+ ilvl <- findAttrByName ns "w" "ilvl" element
482534 let startOverride = findChildByName ns "w" "startOverride" element
483535 >>= findAttrByName ns "w" "val"
484− >>= (\s -> listToMaybe (map fst (reads s :: [(Integer, String)])))
536+ >>= stringToInteger
485537 lvl = findChildByName ns "w" "lvl" element
486538 >>= levelElemToLevel ns
487539 return $ LevelOverride ilvl startOverride lvl
@@ -490,9 +542,9 @@ loElemToLevelOverride _ _ = Nothing
490542numElemToNum :: NameSpaces -> Element -> Maybe Numb
491543numElemToNum ns element
492544 | isElem ns "w" "num" element = do
493− numId <- findAttrTextByName ns "w" "numId" element
545+ numId <- findAttrByName ns "w" "numId" element
494546 absNumId <- findChildByName ns "w" "abstractNumId" element
495− >>= findAttrTextByName ns "w" "val"
547+ >>= findAttrByName ns "w" "val"
496548 let lvlOverrides = mapMaybe
497549 (loElemToLevelOverride ns)
498550 (findChildrenByName ns "w" "lvlOverride" element)
@@ -502,7 +554,7 @@ numElemToNum _ _ = Nothing
502554absNumElemToAbsNum :: NameSpaces -> Element -> Maybe AbstractNumb
503555absNumElemToAbsNum ns element
504556 | isElem ns "w" "abstractNum" element = do
505− absNumId <- findAttrTextByName ns "w" "abstractNumId" element
557+ absNumId <- findAttrByName ns "w" "abstractNumId" element
506558 let levelElems = findChildrenByName ns "w" "lvl" element
507559 levels = mapMaybe (levelElemToLevel ns) levelElems
508560 return $ AbstractNumb absNumId levels
@@ -511,23 +563,23 @@ absNumElemToAbsNum _ _ = Nothing
511563levelElemToLevel :: NameSpaces -> Element -> Maybe Level
512564levelElemToLevel ns element
513565 | isElem ns "w" "lvl" element = do
514− ilvl <- findAttrTextByName ns "w" "ilvl" element
566+ ilvl <- findAttrByName ns "w" "ilvl" element
515567 fmt <- findChildByName ns "w" "numFmt" element
516− >>= findAttrTextByName ns "w" "val"
568+ >>= findAttrByName ns "w" "val"
517569 txt <- findChildByName ns "w" "lvlText" element
518− >>= findAttrTextByName ns "w" "val"
570+ >>= findAttrByName ns "w" "val"
519571 let start = findChildByName ns "w" "start" element
520572 >>= findAttrByName ns "w" "val"
521− >>= (\s -> listToMaybe (map fst (reads s :: [(Integer, String)])))
573+ >>= stringToInteger
522574 return (Level ilvl fmt txt start)
523575levelElemToLevel _ _ = Nothing
524576
525577archiveToNumbering' :: Archive -> Maybe Numbering
526578archiveToNumbering' zf =
527579 case findEntryByPath "word/numbering.xml" zf of
528− Nothing -> Just $ Numbering [] [] []
580+ Nothing -> Just $ Numbering mempty [] []
529581 Just entry -> do
530− numberingElem <- (parseXMLDoc . UTF8.toStringLazy . fromEntry) entry
582+ numberingElem <- parseXMLFromEntry entry
531583 let namespaces = elemToNameSpaces numberingElem
532584 numElems = findChildrenByName namespaces "w" "num" numberingElem
533585 absNumElems = findChildrenByName namespaces "w" "abstractNum" numberingElem
@@ -537,13 +589,13 @@ archiveToNumbering' zf =
537589
538590archiveToNumbering :: Archive -> Numbering
539591archiveToNumbering archive =
540− fromMaybe (Numbering [] [] []) (archiveToNumbering' archive)
592+ fromMaybe (Numbering mempty [] []) (archiveToNumbering' archive)
541593
542−elemToNotes :: NameSpaces -> String -> Element -> Maybe (M.Map T.Text Element)
594+elemToNotes :: NameSpaces -> Text -> Element -> Maybe (M.Map T.Text Element)
543595elemToNotes ns notetype element
544596 | isElem ns "w" (notetype <> "s") element =
545597 let pairs = mapMaybe
546− (\e -> findAttrTextByName ns "w" "id" e >>=
598+ (\e -> findAttrByName ns "w" "id" e >>=
547599 (\a -> Just (a, e)))
548600 (findChildrenByName ns "w" notetype element)
549601 in
@@ -555,7 +607,7 @@ elemToComments :: NameSpaces -> Element -> M.Map T.Text Element
555607elemToComments ns element
556608 | isElem ns "w" "comments" element =
557609 let pairs = mapMaybe
558− (\e -> findAttrTextByName ns "w" "id" e >>=
610+ (\e -> findAttrByName ns "w" "id" e >>=
559611 (\a -> Just (a, e)))
560612 (findChildrenByName ns "w" "comment" element)
561613 in
@@ -570,7 +622,7 @@ elemToTblGrid :: NameSpaces -> Element -> D TblGrid
570622elemToTblGrid ns element | isElem ns "w" "tblGrid" element =
571623 let cols = findChildrenByName ns "w" "gridCol" element
572624 in
573− mapD (\e -> maybeToD (findAttrByName ns "w" "val" e >>= stringToInteger))
625+ mapD (\e -> maybeToD (findAttrByName ns "w" "w" e >>= stringToInteger))
574626 cols
575627elemToTblGrid _ _ = throwError WrongElem
576628
@@ -594,14 +646,31 @@ elemToRow ns element | isElem ns "w" "tr" element =
594646 do
595647 let cellElems = findChildrenByName ns "w" "tc" element
596648 cells <- mapD (elemToCell ns) cellElems
597− return $ Row cells
649+ let hasTblHeader = maybe NoTblHeader (const HasTblHeader)
650+ (findChildByName ns "w" "trPr" element
651+ >>= findChildByName ns "w" "tblHeader")
652+ return $ Row hasTblHeader cells
598653elemToRow _ _ = throwError WrongElem
599654
600655elemToCell :: NameSpaces -> Element -> D Cell
601656elemToCell ns element | isElem ns "w" "tc" element =
602657 do
658+ let properties = findChildByName ns "w" "tcPr" element
659+ let gridSpan = properties
660+ >>= findChildByName ns "w" "gridSpan"
661+ >>= findAttrByName ns "w" "val"
662+ >>= stringToInteger
663+ let vMerge = case properties >>= findChildByName ns "w" "vMerge" of
664+ Nothing -> Restart
665+ Just e ->
666+ fromMaybe Continue $ do
667+ s <- findAttrByName ns "w" "val" e
668+ case s of
669+ "continue" -> Just Continue
670+ "restart" -> Just Restart
671+ _ -> Nothing
603672 cellContents <- mapD (elemToBodyPart ns) (elChildren element)
604− return $ Cell cellContents
673+ return $ Cell (fromMaybe 1 gridSpan) vMerge cellContents
605674elemToCell _ _ = throwError WrongElem
606675
607676elemToParIndentation :: NameSpaces -> Element -> Maybe ParIndentation
@@ -615,12 +684,12 @@ elemToParIndentation ns element | isElem ns "w" "ind" element =
615684 stringToInteger
616685 , hangingParIndent =
617686 findAttrByName ns "w" "hanging" element >>=
618− stringToInteger}
687+ stringToInteger }
619688elemToParIndentation _ _ = Nothing
620689
621−testBitMask :: String -> Int -> Bool
690+testBitMask :: Text -> Int -> Bool
622691testBitMask bitMaskS n =
623− case (reads ("0x" ++ bitMaskS) :: [(Int, String)]) of
692+ case (reads ("0x" ++ T.unpack bitMaskS) :: [(Int, String)]) of
624693 [] -> False
625694 ((n', _) : _) -> (n' .|. n) /= 0
626695
@@ -633,10 +702,9 @@ pNumInfo = getParStyleField numInfo . pStyle
633702elemToBodyPart :: NameSpaces -> Element -> D BodyPart
634703elemToBodyPart ns element
635704 | isElem ns "w" "p" element
636− , (c:_) <- findChildrenByName ns "m" "oMathPara" element =
637− do
638− expsLst <- eitherToD $ readOMML $ T.pack $ showElement c
639− return $ OMathPara expsLst
705+ , (c:_) <- findChildrenByName ns "m" "oMathPara" element = do
706+ expsLst <- eitherToD $ readOMML $ showElement c
707+ return $ OMathPara expsLst
640708elemToBodyPart ns element
641709 | isElem ns "w" "p" element
642710 , Just (numId, lvl) <- getNumInfo ns element = do
@@ -654,13 +722,31 @@ elemToBodyPart ns element
654722 Nothing | Just (numId, lvl) <- pNumInfo parstyle -> do
655723 levelInfo <- lookupLevel numId lvl <$> asks envNumbering
656724 return $ ListItem parstyle numId lvl levelInfo parparts
657− _ -> return $ Paragraph parstyle parparts
725+ _ -> let
726+ hasCaptionStyle = elem "Caption" (pStyleId <$> pStyle parstyle)
727+
728+ hasSimpleTableField = fromMaybe False $ do
729+ fldSimple <- findChildByName ns "w" "fldSimple" element
730+ instr <- findAttrByName ns "w" "instr" fldSimple
731+ pure ("Table" `elem` T.words instr)
732+
733+ hasComplexTableField = fromMaybe False $ do
734+ instrText <- findElementByName ns "w" "instrText" element
735+ pure ("Table" `elem` T.words (strContent instrText))
736+
737+ in if hasCaptionStyle && (hasSimpleTableField || hasComplexTableField)
738+ then return $ TblCaption parstyle parparts
739+ else return $ Paragraph parstyle parparts
740+
658741elemToBodyPart ns element
659742 | isElem ns "w" "tbl" element = do
660− let caption' = findChildByName ns "w" "tblPr" element
743+ let tblProperties = findChildByName ns "w" "tblPr" element
744+ caption = fromMaybe "" $ tblProperties
661745 >>= findChildByName ns "w" "tblCaption"
662− >>= findAttrTextByName ns "w" "val"
663− caption = fromMaybe "" caption'
746+ >>= findAttrByName ns "w" "val"
747+ description = fromMaybe "" $ tblProperties
748+ >>= findChildByName ns "w" "tblDescription"
749+ >>= findAttrByName ns "w" "val"
664750 grid' = case findChildByName ns "w" "tblGrid" element of
665751 Just g -> elemToTblGrid ns g
666752 Nothing -> return []
@@ -673,7 +759,7 @@ elemToBodyPart ns element
673759 grid <- grid'
674760 tblLook <- tblLook'
675761 rows <- mapD (elemToRow ns) (elChildren element)
676− return $ Tbl caption grid tblLook rows
762+ return $ Tbl (caption <> description) grid tblLook rows
677763elemToBodyPart _ _ = throwError WrongElem
678764
679765lookupRelationship :: DocumentLocation -> RelId -> [Relationship] -> Maybe Target
@@ -698,8 +784,8 @@ getTitleAndAlt :: NameSpaces -> Element -> (T.Text, T.Text)
698784getTitleAndAlt ns element =
699785 let mbDocPr = findChildByName ns "wp" "inline" element >>=
700786 findChildByName ns "wp" "docPr"
701− title = fromMaybe "" (mbDocPr >>= findAttrTextByName ns "" "title")
702− alt = fromMaybe "" (mbDocPr >>= findAttrTextByName ns "" "descr")
787+ title = fromMaybe "" (mbDocPr >>= findAttrByName ns "" "title")
788+ alt = fromMaybe "" (mbDocPr >>= findAttrByName ns "" "descr")
703789 in (title, alt)
704790
705791elemToParPart :: NameSpaces -> Element -> D ParPart
@@ -711,22 +797,29 @@ elemToParPart ns element
711797 = let (title, alt) = getTitleAndAlt ns drawingElem
712798 a_ns = "http://schemas.openxmlformats.org/drawingml/2006/main"
713799 drawing = findElement (QName "blip" (Just a_ns) (Just "a")) picElem
714− >>= findAttrTextByName ns "r" "embed"
800+ >>= findAttrByName ns "r" "embed"
715801 in
716802 case drawing of
717803 Just s -> expandDrawingId s >>= (\(fp, bs) -> return $ Drawing fp title alt bs $ elemToExtent drawingElem)
718804 Nothing -> throwError WrongElem
719−-- The below is an attempt to deal with images in deprecated vml format.
805+-- The two cases below are an attempt to deal with images in deprecated vml format.
806+-- Todo: check out title and attr for deprecated format.
720807elemToParPart ns element
721808 | isElem ns "w" "r" element
722809 , Just _ <- findChildByName ns "w" "pict" element =
723810 let drawing = findElement (elemName ns "v" "imagedata") element
724− >>= findAttrTextByName ns "r" "id"
811+ >>= findAttrByName ns "r" "id"
725812 in
726813 case drawing of
727− -- Todo: check out title and attr for deprecated format.
728814 Just s -> expandDrawingId s >>= (\(fp, bs) -> return $ Drawing fp "" "" bs Nothing)
729815 Nothing -> throwError WrongElem
816+elemToParPart ns element
817+ | isElem ns "w" "r" element
818+ , Just objectElem <- findChildByName ns "w" "object" element
819+ , Just shapeElem <- findChildByName ns "v" "shape" objectElem
820+ , Just imagedataElem <- findChildByName ns "v" "imagedata" shapeElem
821+ , Just drawingId <- findAttrByName ns "r" "id" imagedataElem
822+ = expandDrawingId drawingId >>= (\(fp, bs) -> return $ Drawing fp "" "" bs Nothing)
730823-- Chart
731824elemToParPart ns element
732825 | isElem ns "w" "r" element
@@ -790,7 +883,7 @@ elemToParPart ns element
790883 fldCharState <- gets stateFldCharState
791884 case fldCharState of
792885 FldCharOpen -> do
793− info <- eitherToD $ parseFieldInfo $ T.pack $ strContent instrText
886+ info <- eitherToD $ parseFieldInfo $ strContent instrText
794887 modify $ \st -> st{stateFldCharState = FldCharFieldInfo info}
795888 return NullParPart
796889 _ -> return NullParPart
@@ -811,48 +904,48 @@ elemToParPart ns element
811904 return $ ChangedRuns change runs
812905elemToParPart ns element
813906 | isElem ns "w" "bookmarkStart" element
814− , Just bmId <- findAttrTextByName ns "w" "id" element
815− , Just bmName <- findAttrTextByName ns "w" "name" element =
907+ , Just bmId <- findAttrByName ns "w" "id" element
908+ , Just bmName <- findAttrByName ns "w" "name" element =
816909 return $ BookMark bmId bmName
817910elemToParPart ns element
818911 | isElem ns "w" "hyperlink" element
819− , Just relId <- findAttrTextByName ns "r" "id" element = do
912+ , Just relId <- findAttrByName ns "r" "id" element = do
820913 location <- asks envLocation
821914 runs <- mapD (elemToRun ns) (elChildren element)
822915 rels <- asks envRelationships
823916 case lookupRelationship location relId rels of
824917 Just target ->
825− case findAttrTextByName ns "w" "anchor" element of
918+ case findAttrByName ns "w" "anchor" element of
826919 Just anchor -> return $ ExternalHyperLink (target <> "#" <> anchor) runs
827920 Nothing -> return $ ExternalHyperLink target runs
828921 Nothing -> return $ ExternalHyperLink "" runs
829922elemToParPart ns element
830923 | isElem ns "w" "hyperlink" element
831− , Just anchor <- findAttrTextByName ns "w" "anchor" element = do
924+ , Just anchor <- findAttrByName ns "w" "anchor" element = do
832925 runs <- mapD (elemToRun ns) (elChildren element)
833926 return $ InternalHyperLink anchor runs
834927elemToParPart ns element
835928 | isElem ns "w" "commentRangeStart" element
836− , Just cmtId <- findAttrTextByName ns "w" "id" element = do
929+ , Just cmtId <- findAttrByName ns "w" "id" element = do
837930 (Comments _ commentMap) <- asks envComments
838931 case M.lookup cmtId commentMap of
839932 Just cmtElem -> elemToCommentStart ns cmtElem
840933 Nothing -> throwError WrongElem
841934elemToParPart ns element
842935 | isElem ns "w" "commentRangeEnd" element
843− , Just cmtId <- findAttrTextByName ns "w" "id" element =
936+ , Just cmtId <- findAttrByName ns "w" "id" element =
844937 return $ CommentEnd cmtId
845938elemToParPart ns element
846939 | isElem ns "m" "oMath" element =
847− fmap PlainOMath (eitherToD $ readOMML $ T.pack $ showElement element)
940+ fmap PlainOMath (eitherToD $ readOMML $ showElement element)
848941elemToParPart _ _ = throwError WrongElem
849942
850943elemToCommentStart :: NameSpaces -> Element -> D ParPart
851944elemToCommentStart ns element
852945 | isElem ns "w" "comment" element
853− , Just cmtId <- findAttrTextByName ns "w" "id" element
854− , Just cmtAuthor <- findAttrTextByName ns "w" "author" element
855− , cmtDate <- findAttrTextByName ns "w" "date" element = do
946+ , Just cmtId <- findAttrByName ns "w" "id" element
947+ , Just cmtAuthor <- findAttrByName ns "w" "author" element
948+ , cmtDate <- findAttrByName ns "w" "date" element = do
856949 bps <- mapD (elemToBodyPart ns) (elChildren element)
857950 return $ CommentStart cmtId cmtAuthor cmtDate bps
858951elemToCommentStart _ _ = throwError WrongElem
@@ -871,7 +964,7 @@ elemToExtent drawingElem =
871964 where
872965 wp_ns = "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing"
873966 getDim at = findElement (QName "extent" (Just wp_ns) (Just "wp")) drawingElem
874− >>= findAttr (QName at Nothing Nothing) >>= safeRead . T.pack
967+ >>= findAttr (QName at Nothing Nothing) >>= safeRead
875968
876969
877970childElemToRun :: NameSpaces -> Element -> D Run
@@ -882,7 +975,7 @@ childElemToRun ns element
882975 = let (title, alt) = getTitleAndAlt ns element
883976 a_ns = "http://schemas.openxmlformats.org/drawingml/2006/main"
884977 drawing = findElement (QName "blip" (Just a_ns) (Just "a")) picElem
885− >>= findAttrText (QName "embed" (lookup "r" ns) (Just "r"))
978+ >>= findAttr (QName "embed" (M.lookup "r" ns) (Just "r"))
886979 in
887980 case drawing of
888981 Just s -> expandDrawingId s >>=
@@ -895,7 +988,7 @@ childElemToRun ns element
895988 = return InlineChart
896989childElemToRun ns element
897990 | isElem ns "w" "footnoteReference" element
898− , Just fnId <- findAttrTextByName ns "w" "id" element = do
991+ , Just fnId <- findAttrByName ns "w" "id" element = do
899992 notes <- asks envNotes
900993 case lookupFootnote fnId notes of
901994 Just e -> do bps <- local (\r -> r {envLocation=InFootnote}) $ mapD (elemToBodyPart ns) (elChildren e)
@@ -903,7 +996,7 @@ childElemToRun ns element
903996 Nothing -> return $ Footnote []
904997childElemToRun ns element
905998 | isElem ns "w" "endnoteReference" element
906− , Just enId <- findAttrTextByName ns "w" "id" element = do
999+ , Just enId <- findAttrByName ns "w" "id" element = do
9071000 notes <- asks envNotes
9081001 case lookupEndnote enId notes of
9091002 Just e -> do bps <- local (\r -> r {envLocation=InEndnote}) $ mapD (elemToBodyPart ns) (elChildren e)
@@ -956,15 +1049,15 @@ getParStyleField _ _ = Nothing
9561049getTrackedChange :: NameSpaces -> Element -> Maybe TrackedChange
9571050getTrackedChange ns element
9581051 | isElem ns "w" "ins" element || isElem ns "w" "moveTo" element
959− , Just cId <- findAttrTextByName ns "w" "id" element
960− , Just cAuthor <- findAttrTextByName ns "w" "author" element
961− , mcDate <- findAttrTextByName ns "w" "date" element =
1052+ , Just cId <- findAttrByName ns "w" "id" element
1053+ , Just cAuthor <- findAttrByName ns "w" "author" element
1054+ , mcDate <- findAttrByName ns "w" "date" element =
9621055 Just $ TrackedChange Insertion (ChangeInfo cId cAuthor mcDate)
9631056getTrackedChange ns element
9641057 | isElem ns "w" "del" element || isElem ns "w" "moveFrom" element
965− , Just cId <- findAttrTextByName ns "w" "id" element
966− , Just cAuthor <- findAttrTextByName ns "w" "author" element
967− , mcDate <- findAttrTextByName ns "w" "date" element =
1058+ , Just cId <- findAttrByName ns "w" "id" element
1059+ , Just cAuthor <- findAttrByName ns "w" "author" element
1060+ , mcDate <- findAttrByName ns "w" "date" element =
9681061 Just $ TrackedChange Deletion (ChangeInfo cId cAuthor mcDate)
9691062getTrackedChange _ _ = Nothing
9701063
@@ -973,7 +1066,7 @@ elemToParagraphStyle ns element sty
9731066 | Just pPr <- findChildByName ns "w" "pPr" element =
9741067 let style =
9751068 mapMaybe
976− (fmap ParaStyleId . findAttrTextByName ns "w" "val")
1069+ (fmap ParaStyleId . findAttrByName ns "w" "val")
9771070 (findChildrenByName ns "w" "pStyle" pPr)
9781071 in ParagraphStyle
9791072 {pStyle = mapMaybe (`M.lookup` sty) style
@@ -1005,7 +1098,7 @@ elemToRunStyleD ns element
10051098 charStyles <- asks envCharStyles
10061099 let parentSty =
10071100 findChildByName ns "w" "rStyle" rPr >>=
1008− findAttrTextByName ns "w" "val" >>=
1101+ findAttrByName ns "w" "val" >>=
10091102 flip M.lookup charStyles . CharStyleId
10101103 return $ elemToRunStyle ns element parentSty
10111104elemToRunStyleD _ _ = return defaultRunStyle
@@ -1015,7 +1108,7 @@ elemToRunElem ns element
10151108 | isElem ns "w" "t" element
10161109 || isElem ns "w" "delText" element
10171110 || isElem ns "m" "t" element = do
1018− let str = T.pack $ strContent element
1111+ let str = strContent element
10191112 font <- asks envFont
10201113 case font of
10211114 Nothing -> return $ TextRun str
@@ -1037,14 +1130,14 @@ getSymChar :: NameSpaces -> Element -> RunElem
10371130getSymChar ns element
10381131 | Just s <- lowerFromPrivate <$> getCodepoint
10391132 , Just font <- getFont =
1040− case readLitChar ("\\x" ++ s) of
1133+ case readLitChar ("\\x" ++ T.unpack s) of
10411134 [(char, _)] -> TextRun . maybe "" T.singleton $ getUnicode font char
10421135 _ -> TextRun ""
10431136 where
10441137 getCodepoint = findAttrByName ns "w" "char" element
1045− getFont = textToFont . T.pack =<< findAttrByName ns "w" "font" element
1046− lowerFromPrivate ('F':xs) = '0':xs
1047− lowerFromPrivate xs = xs
1138+ getFont = textToFont =<< findAttrByName ns "w" "font" element
1139+ lowerFromPrivate t | "F" `T.isPrefixOf` t = "0" <> T.drop 1 t
1140+ | otherwise = t
10481141getSymChar _ _ = TextRun ""
10491142
10501143elemToRunElems :: NameSpaces -> Element -> D [RunElem]
@@ -1054,8 +1147,9 @@ elemToRunElems ns element
10541147 let qualName = elemName ns "w"
10551148 let font = do
10561149 fontElem <- findElement (qualName "rFonts") element
1057− textToFont . T.pack =<<
1058− foldr ((<|>) . (flip findAttr fontElem . qualName)) Nothing ["ascii", "hAnsi"]
1150+ textToFont =<<
1151+ foldr ((<|>) . (flip findAttr fontElem . qualName))
1152+ Nothing ["ascii", "hAnsi"]
10591153 local (setFont font) (mapD (elemToRunElem ns) (elChildren element))
10601154elemToRunElems _ _ = throwError WrongElem
10611155
src/Text/Pandoc/Readers/Docx/Parse/Styles.hs+32−25
@@ -48,11 +48,13 @@ import Data.Function (on)
4848import Data.String (IsString(..))
4949import qualified Data.Map as M
5050import qualified Data.Text as T
51+import qualified Data.Text.Read
52+import Data.Text (Text)
5153import Data.Maybe
5254import Data.Coerce
5355import Text.Pandoc.Readers.Docx.Util
5456import qualified Text.Pandoc.UTF8 as UTF8
55−import Text.XML.Light
57+import Text.Pandoc.XML.Light
5658
5759newtype CharStyleId = CharStyleId T.Text
5860 deriving (Show, Eq, Ord, IsString, FromStyleId)
@@ -108,7 +110,7 @@ data RunStyle = RunStyle { isBold :: Maybe Bool
108110 , isRTL :: Maybe Bool
109111 , isForceCTL :: Maybe Bool
110112 , rVertAlign :: Maybe VertAlign
111− , rUnderline :: Maybe String
113+ , rUnderline :: Maybe Text
112114 , rParentStyle :: Maybe CharStyle
113115 }
114116 deriving Show
@@ -135,19 +137,22 @@ defaultRunStyle = RunStyle { isBold = Nothing
135137 , rParentStyle = Nothing
136138 }
137139
138−archiveToStyles' :: (Ord k1, Ord k2, ElemToStyle a1, ElemToStyle a2) =>
139− (a1 -> k1) -> (a2 -> k2) -> Archive -> (M.Map k1 a1, M.Map k2 a2)
140+archiveToStyles'
141+ :: (Ord k1, Ord k2, ElemToStyle a1, ElemToStyle a2)
142+ => (a1 -> k1) -> (a2 -> k2) -> Archive -> (M.Map k1 a1, M.Map k2 a2)
140143archiveToStyles' conv1 conv2 zf =
141− let stylesElem = findEntryByPath "word/styles.xml" zf >>=
142− (parseXMLDoc . UTF8.toStringLazy . fromEntry)
143− in
144− case stylesElem of
145− Nothing -> (M.empty, M.empty)
146− Just styElem ->
147− let namespaces = elemToNameSpaces styElem
148− in
149− ( M.fromList $ map (\r -> (conv1 r, r)) $ buildBasedOnList namespaces styElem Nothing,
150− M.fromList $ map (\p -> (conv2 p, p)) $ buildBasedOnList namespaces styElem Nothing)
144+ case findEntryByPath "word/styles.xml" zf of
145+ Nothing -> (M.empty, M.empty)
146+ Just entry ->
147+ case parseXMLElement . UTF8.toTextLazy . fromEntry $ entry of
148+ Left _ -> (M.empty, M.empty)
149+ Right styElem ->
150+ let namespaces = elemToNameSpaces styElem
151+ in
152+ ( M.fromList $ map (\r -> (conv1 r, r)) $
153+ buildBasedOnList namespaces styElem Nothing,
154+ M.fromList $ map (\p -> (conv2 p, p)) $
155+ buildBasedOnList namespaces styElem Nothing)
151156
152157isBasedOnStyle :: (ElemToStyle a, FromStyleId (StyleId a)) => NameSpaces -> Element -> Maybe a -> Bool
153158isBasedOnStyle ns element parentStyle
@@ -155,7 +160,7 @@ isBasedOnStyle ns element parentStyle
155160 , Just styleType <- findAttrByName ns "w" "type" element
156161 , styleType == cStyleType parentStyle
157162 , Just basedOnVal <- findChildByName ns "w" "basedOn" element >>=
158− findAttrTextByName ns "w" "val"
163+ findAttrByName ns "w" "val"
159164 , Just ps <- parentStyle = basedOnVal == fromStyleId (getStyleId ps)
160165 | isElem ns "w" "style" element
161166 , Just styleType <- findAttrByName ns "w" "type" element
@@ -165,7 +170,7 @@ isBasedOnStyle ns element parentStyle
165170 | otherwise = False
166171
167172class HasStyleId a => ElemToStyle a where
168− cStyleType :: Maybe a -> String
173+ cStyleType :: Maybe a -> Text
169174 elemToStyle :: NameSpaces -> Element -> Maybe a -> Maybe a
170175
171176class FromStyleId (StyleId a) => HasStyleId a where
@@ -222,8 +227,10 @@ buildBasedOnList ns element rootStyle =
222227 stys -> stys ++
223228 concatMap (buildBasedOnList ns element . Just) stys
224229
225−stringToInteger :: String -> Maybe Integer
226−stringToInteger s = listToMaybe $ map fst (reads s :: [(Integer, String)])
230+stringToInteger :: Text -> Maybe Integer
231+stringToInteger s = case Data.Text.Read.decimal s of
232+ Right (x,_) -> Just x
233+ Left _ -> Nothing
227234
228235checkOnOff :: NameSpaces -> Element -> QName -> Maybe Bool
229236checkOnOff ns rPr tag
@@ -243,7 +250,7 @@ checkOnOff _ _ _ = Nothing
243250elemToCharStyle :: NameSpaces
244251 -> Element -> Maybe CharStyle -> Maybe CharStyle
245252elemToCharStyle ns element parentStyle
246− = CharStyle <$> (CharStyleId <$> findAttrTextByName ns "w" "styleId" element)
253+ = CharStyle <$> (CharStyleId <$> findAttrByName ns "w" "styleId" element)
247254 <*> getElementStyleName ns element
248255 <*> Just (elemToRunStyle ns element parentStyle)
249256
@@ -277,7 +284,7 @@ elemToRunStyle _ _ _ = defaultRunStyle
277284getHeaderLevel :: NameSpaces -> Element -> Maybe (ParaStyleName, Int)
278285getHeaderLevel ns element
279286 | Just styleName <- getElementStyleName ns element
280− , Just n <- stringToInteger . T.unpack =<<
287+ , Just n <- stringToInteger =<<
281288 (T.stripPrefix "heading " . T.toLower $
282289 fromStyleName styleName)
283290 , n > 0 = Just (styleName, fromInteger n)
@@ -285,8 +292,8 @@ getHeaderLevel _ _ = Nothing
285292
286293getElementStyleName :: Coercible T.Text a => NameSpaces -> Element -> Maybe a
287294getElementStyleName ns el = coerce <$>
288− ((findChildByName ns "w" "name" el >>= findAttrTextByName ns "w" "val")
289− <|> findAttrTextByName ns "w" "styleId" el)
295+ ((findChildByName ns "w" "name" el >>= findAttrByName ns "w" "val")
296+ <|> findAttrByName ns "w" "styleId" el)
290297
291298getNumInfo :: NameSpaces -> Element -> Maybe (T.Text, T.Text)
292299getNumInfo ns element = do
@@ -294,15 +301,15 @@ getNumInfo ns element = do
294301 findChildByName ns "w" "numPr"
295302 lvl = fromMaybe "0" (numPr >>=
296303 findChildByName ns "w" "ilvl" >>=
297− findAttrTextByName ns "w" "val")
304+ findAttrByName ns "w" "val")
298305 numId <- numPr >>=
299306 findChildByName ns "w" "numId" >>=
300− findAttrTextByName ns "w" "val"
307+ findAttrByName ns "w" "val"
301308 return (numId, lvl)
302309
303310elemToParStyleData :: NameSpaces -> Element -> Maybe ParStyle -> Maybe ParStyle
304311elemToParStyleData ns element parentStyle
305− | Just styleId <- findAttrTextByName ns "w" "styleId" element
312+ | Just styleId <- findAttrByName ns "w" "styleId" element
306313 , Just styleName <- getElementStyleName ns element
307314 = Just $ ParStyle
308315 {
src/Text/Pandoc/Readers/Docx/Util.hs+28−26
@@ -1,7 +1,8 @@
1+{-# LANGUAGE OverloadedStrings #-}
12{- |
23 Module : Text.Pandoc.Readers.Docx.StyleMaps
34 Copyright : © 2014-2020 Jesse Rosenthal <jrosenthal@jhu.edu>,
4− 2014-2020 John MacFarlane <jgm@berkeley.edu>,
5+ 2014-2021 John MacFarlane <jgm@berkeley.edu>,
56 2015 Nikolay Yakimov <root@livid.pp.ru>
67 License : GNU GPL, version 2 or above
78
@@ -18,51 +19,52 @@ module Text.Pandoc.Readers.Docx.Util (
1819 , elemToNameSpaces
1920 , findChildByName
2021 , findChildrenByName
21− , findAttrText
22+ , findElementByName
2223 , findAttrByName
23− , findAttrTextByName
2424 ) where
2525
26−import Data.Maybe (mapMaybe)
2726import qualified Data.Text as T
28−import Text.XML.Light
27+import Data.Text (Text)
28+import Text.Pandoc.XML.Light
29+import qualified Data.Map as M
2930
30−type NameSpaces = [(String, String)]
31+type NameSpaces = M.Map Text Text
3132
3233elemToNameSpaces :: Element -> NameSpaces
33−elemToNameSpaces = mapMaybe attrToNSPair . elAttribs
34+elemToNameSpaces = foldr (\(Attr qn val) ->
35+ case qn of
36+ QName s _ (Just "xmlns") -> M.insert s val
37+ _ -> id) mempty . elAttribs
3438
35−attrToNSPair :: Attr -> Maybe (String, String)
36−attrToNSPair (Attr (QName s _ (Just "xmlns")) val) = Just (s, val)
37−attrToNSPair _ = Nothing
38−
39−elemName :: NameSpaces -> String -> String -> QName
39+elemName :: NameSpaces -> Text -> Text -> QName
4040elemName ns prefix name =
41− QName name (lookup prefix ns) (if null prefix then Nothing else Just prefix)
41+ QName name (M.lookup prefix ns)
42+ (if T.null prefix then Nothing else Just prefix)
4243
43−isElem :: NameSpaces -> String -> String -> Element -> Bool
44+isElem :: NameSpaces -> Text -> Text -> Element -> Bool
4445isElem ns prefix name element =
45− let ns' = ns ++ elemToNameSpaces element
46+ let ns' = ns <> elemToNameSpaces element
4647 in qName (elName element) == name &&
47− qURI (elName element) == lookup prefix ns'
48+ qURI (elName element) == M.lookup prefix ns'
4849
49−findChildByName :: NameSpaces -> String -> String -> Element -> Maybe Element
50+findChildByName :: NameSpaces -> Text -> Text -> Element -> Maybe Element
5051findChildByName ns pref name el =
51− let ns' = ns ++ elemToNameSpaces el
52+ let ns' = ns <> elemToNameSpaces el
5253 in findChild (elemName ns' pref name) el
5354
54−findChildrenByName :: NameSpaces -> String -> String -> Element -> [Element]
55+findChildrenByName :: NameSpaces -> Text -> Text -> Element -> [Element]
5556findChildrenByName ns pref name el =
56− let ns' = ns ++ elemToNameSpaces el
57+ let ns' = ns <> elemToNameSpaces el
5758 in findChildren (elemName ns' pref name) el
5859
59−findAttrText :: QName -> Element -> Maybe T.Text
60−findAttrText x = fmap T.pack . findAttr x
60+-- | Like 'findChildrenByName', but searches descendants.
61+findElementByName :: NameSpaces -> Text -> Text -> Element -> Maybe Element
62+findElementByName ns pref name el =
63+ let ns' = ns <> elemToNameSpaces el
64+ in findElement (elemName ns' pref name) el
6165
62−findAttrByName :: NameSpaces -> String -> String -> Element -> Maybe String
66+findAttrByName :: NameSpaces -> Text -> Text -> Element -> Maybe Text
6367findAttrByName ns pref name el =
64− let ns' = ns ++ elemToNameSpaces el
68+ let ns' = ns <> elemToNameSpaces el
6569 in findAttr (elemName ns' pref name) el
6670
67−findAttrTextByName :: NameSpaces -> String -> String -> Element -> Maybe T.Text
68−findAttrTextByName a b c = fmap T.pack . findAttrByName a b c
src/Text/Pandoc/Readers/DokuWiki.hs+10−9
@@ -29,26 +29,27 @@ import Text.Pandoc.Definition
2929import Text.Pandoc.Error (PandocError (PandocParsecError))
3030import Text.Pandoc.Options
3131import Text.Pandoc.Parsing hiding (enclosed, nested)
32−import Text.Pandoc.Shared (crFilter, trim, stringify, tshow)
32+import Text.Pandoc.Shared (trim, stringify, tshow)
3333
3434-- | Read DokuWiki from an input string and return a Pandoc document.
35−readDokuWiki :: PandocMonad m
35+readDokuWiki :: (PandocMonad m, ToSources a)
3636 => ReaderOptions
37− -> Text
37+ -> a
3838 -> m Pandoc
3939readDokuWiki opts s = do
40− let input = crFilter s
41− res <- runParserT parseDokuWiki def {stateOptions = opts } "source" input
40+ let sources = toSources s
41+ res <- runParserT parseDokuWiki def {stateOptions = opts }
42+ (initialSourceName sources) sources
4243 case res of
43− Left e -> throwError $ PandocParsecError input e
44+ Left e -> throwError $ PandocParsecError sources e
4445 Right d -> return d
4546
46−type DWParser = ParserT Text ParserState
47+type DWParser = ParserT Sources ParserState
4748
4849-- * Utility functions
4950
5051-- | Parse end-of-line, which can be either a newline or end-of-file.
51−eol :: Stream s m Char => ParserT s st m ()
52+eol :: (Stream s m Char, UpdateSourcePos s Char) => ParserT s st m ()
5253eol = void newline <|> eof
5354
5455nested :: PandocMonad m => DWParser m a -> DWParser m a
@@ -317,7 +318,7 @@ interwikiToUrl "wpes" page = "https://es.wikipedia.org/wiki/" <> page
317318interwikiToUrl "wpfr" page = "https://fr.wikipedia.org/wiki/" <> page
318319interwikiToUrl "wpjp" page = "https://jp.wikipedia.org/wiki/" <> page
319320interwikiToUrl "wppl" page = "https://pl.wikipedia.org/wiki/" <> page
320−interwikiToUrl _ page = "https://www.google.com/search?q=" <> page <> "&btnI=lucky"
321+interwikiToUrl unknown page = unknown <> ">" <> page
321322
322323linkText :: PandocMonad m => DWParser m B.Inlines
323324linkText = parseLink fromRaw "[[" "]]"
src/Text/Pandoc/Readers/EPUB.hs+46−39
@@ -17,16 +17,16 @@ module Text.Pandoc.Readers.EPUB
1717 (readEPUB)
1818 where
1919
20−import Codec.Archive.Zip (Archive (..), Entry, findEntryByPath, fromEntry,
20+import Codec.Archive.Zip (Archive (..), Entry(..), findEntryByPath, fromEntry,
2121 toArchiveOrFail)
2222import Control.DeepSeq (NFData, deepseq)
2323import Control.Monad (guard, liftM, liftM2, mplus)
2424import Control.Monad.Except (throwError)
2525import qualified Data.ByteString.Lazy as BL (ByteString)
26−import Data.List (isInfixOf)
2726import qualified Data.Text as T
27+import Data.Text (Text)
2828import qualified Data.Map as M (Map, elems, fromList, lookup)
29−import Data.Maybe (fromMaybe, mapMaybe)
29+import Data.Maybe (mapMaybe)
3030import qualified Data.Text.Lazy as TL
3131import qualified Data.Text.Lazy.Encoding as TL
3232import Network.URI (unEscapeString)
@@ -40,12 +40,12 @@ import Text.Pandoc.Extensions (Extension (Ext_raw_html), enableExtension)
4040import Text.Pandoc.MIME (MimeType)
4141import Text.Pandoc.Options (ReaderOptions (..))
4242import Text.Pandoc.Readers.HTML (readHtml)
43−import Text.Pandoc.Shared (addMetaField, collapseFilePath, escapeURI)
44−import qualified Text.Pandoc.UTF8 as UTF8 (toStringLazy)
43+import Text.Pandoc.Shared (addMetaField, collapseFilePath, escapeURI, tshow)
44+import qualified Text.Pandoc.UTF8 as UTF8 (toTextLazy)
4545import Text.Pandoc.Walk (query, walk)
46−import Text.XML.Light
46+import Text.Pandoc.XML.Light
4747
48−type Items = M.Map String (FilePath, MimeType)
48+type Items = M.Map Text (FilePath, MimeType)
4949
5050readEPUB :: PandocMonad m => ReaderOptions -> BL.ByteString -> m Pandoc
5151readEPUB opts bytes = case toArchiveOrFail bytes of
@@ -125,27 +125,27 @@ imageToPandoc s = B.doc . B.para $ B.image (T.pack s) "" mempty
125125imageMimes :: [MimeType]
126126imageMimes = ["image/gif", "image/jpeg", "image/png"]
127127
128−type CoverId = String
128+type CoverId = Text
129129
130130type CoverImage = FilePath
131131
132−parseManifest :: (PandocMonad m) => Element -> Maybe CoverId -> m (Maybe CoverImage, Items)
132+parseManifest :: (PandocMonad m)
133+ => Element -> Maybe CoverId -> m (Maybe CoverImage, Items)
133134parseManifest content coverId = do
134135 manifest <- findElementE (dfName "manifest") content
135136 let items = findChildren (dfName "item") manifest
136137 r <- mapM parseItem items
137138 let cover = findAttr (emptyName "href") =<< filterChild findCover manifest
138− return (cover `mplus` coverId, M.fromList r)
139+ return (T.unpack <$> (cover `mplus` coverId), M.fromList r)
139140 where
140− findCover e = maybe False (isInfixOf "cover-image")
141+ findCover e = maybe False (T.isInfixOf "cover-image")
141142 (findAttr (emptyName "properties") e)
142− || fromMaybe False
143− (liftM2 (==) coverId (findAttr (emptyName "id") e))
143+ || Just True == liftM2 (==) coverId (findAttr (emptyName "id") e)
144144 parseItem e = do
145145 uid <- findAttrE (emptyName "id") e
146146 href <- findAttrE (emptyName "href") e
147147 mime <- findAttrE (emptyName "media-type") e
148− return (uid, (href, T.pack mime))
148+ return (uid, (T.unpack href, mime))
149149
150150parseSpine :: PandocMonad m => Items -> Element -> m [(FilePath, MimeType)]
151151parseSpine is e = do
@@ -173,25 +173,25 @@ parseMeta content = do
173173-- http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-metadata-elem
174174parseMetaItem :: Element -> Meta -> Meta
175175parseMetaItem e@(stripNamespace . elName -> field) meta =
176− addMetaField (renameMeta field) (B.str $ T.pack $ strContent e) meta
176+ addMetaField (renameMeta field) (B.str $ strContent e) meta
177177
178−renameMeta :: String -> T.Text
178+renameMeta :: Text -> Text
179179renameMeta "creator" = "author"
180−renameMeta s = T.pack s
180+renameMeta s = s
181181
182182getManifest :: PandocMonad m => Archive -> m (String, Element)
183183getManifest archive = do
184184 metaEntry <- findEntryByPathE ("META-INF" </> "container.xml") archive
185− docElem <- (parseXMLDocE . UTF8.toStringLazy . fromEntry) metaEntry
185+ docElem <- parseXMLDocE metaEntry
186186 let namespaces = mapMaybe attrToNSPair (elAttribs docElem)
187187 ns <- mkE "xmlns not in namespaces" (lookup "xmlns" namespaces)
188188 as <- fmap (map attrToPair . elAttribs)
189189 (findElementE (QName "rootfile" (Just ns) Nothing) docElem)
190− manifestFile <- mkE "Root not found" (lookup "full-path" as)
190+ manifestFile <- T.unpack <$> mkE "Root not found" (lookup "full-path" as)
191191 let rootdir = dropFileName manifestFile
192192 --mime <- lookup "media-type" as
193193 manifest <- findEntryByPathE manifestFile archive
194− fmap ((,) rootdir) (parseXMLDocE . UTF8.toStringLazy . fromEntry $ manifest)
194+ (rootdir,) <$> parseXMLDocE manifest
195195
196196-- Fixup
197197
@@ -201,7 +201,8 @@ fixInternalReferences pathToFile =
201201 . walk (fixBlockIRs filename)
202202 . walk (fixInlineIRs filename)
203203 where
204− (root, T.unpack . escapeURI . T.pack -> filename) = splitFileName pathToFile
204+ (root, T.unpack . escapeURI . T.pack -> filename) =
205+ splitFileName pathToFile
205206
206207fixInlineIRs :: String -> Inline -> Inline
207208fixInlineIRs s (Span as v) =
@@ -214,7 +215,7 @@ fixInlineIRs s (Link as is t) =
214215 Link (fixAttrs s as) is t
215216fixInlineIRs _ v = v
216217
217−prependHash :: [T.Text] -> Inline -> Inline
218+prependHash :: [Text] -> Inline -> Inline
218219prependHash ps l@(Link attr is (url, tit))
219220 | or [s `T.isPrefixOf` url | s <- ps] =
220221 Link attr is ("#" <> url, tit)
@@ -231,16 +232,17 @@ fixBlockIRs s (CodeBlock as code) =
231232fixBlockIRs _ b = b
232233
233234fixAttrs :: FilePath -> B.Attr -> B.Attr
234−fixAttrs s (ident, cs, kvs) = (addHash s ident, filter (not . T.null) cs, removeEPUBAttrs kvs)
235+fixAttrs s (ident, cs, kvs) =
236+ (addHash s ident, filter (not . T.null) cs, removeEPUBAttrs kvs)
235237
236−addHash :: String -> T.Text -> T.Text
238+addHash :: FilePath -> Text -> Text
237239addHash _ "" = ""
238240addHash s ident = T.pack (takeFileName s) <> "#" <> ident
239241
240−removeEPUBAttrs :: [(T.Text, T.Text)] -> [(T.Text, T.Text)]
242+removeEPUBAttrs :: [(Text, Text)] -> [(Text, Text)]
241243removeEPUBAttrs kvs = filter (not . isEPUBAttr) kvs
242244
243−isEPUBAttr :: (T.Text, a) -> Bool
245+isEPUBAttr :: (Text, a) -> Bool
244246isEPUBAttr (k, _) = "epub:" `T.isPrefixOf` k
245247
246248-- Library
@@ -257,39 +259,44 @@ uncurry3 f (a, b, c) = f a b c
257259
258260-- Utility
259261
260−stripNamespace :: QName -> String
262+stripNamespace :: QName -> Text
261263stripNamespace (QName v _ _) = v
262264
263−attrToNSPair :: Attr -> Maybe (String, String)
265+attrToNSPair :: Attr -> Maybe (Text, Text)
264266attrToNSPair (Attr (QName "xmlns" _ _) val) = Just ("xmlns", val)
265267attrToNSPair _ = Nothing
266268
267−attrToPair :: Attr -> (String, String)
269+attrToPair :: Attr -> (Text, Text)
268270attrToPair (Attr (QName name _ _) val) = (name, val)
269271
270−defaultNameSpace :: Maybe String
272+defaultNameSpace :: Maybe Text
271273defaultNameSpace = Just "http://www.idpf.org/2007/opf"
272274
273−dfName :: String -> QName
275+dfName :: Text -> QName
274276dfName s = QName s defaultNameSpace Nothing
275277
276−emptyName :: String -> QName
278+emptyName :: Text -> QName
277279emptyName s = QName s Nothing Nothing
278280
279281-- Convert Maybe interface to Either
280282
281−findAttrE :: PandocMonad m => QName -> Element -> m String
283+findAttrE :: PandocMonad m => QName -> Element -> m Text
282284findAttrE q e = mkE "findAttr" $ findAttr q e
283285
284286findEntryByPathE :: PandocMonad m => FilePath -> Archive -> m Entry
285287findEntryByPathE (normalise . unEscapeString -> path) a =
286− mkE ("No entry on path: " ++ path) $ findEntryByPath path a
288+ mkE ("No entry on path: " <> T.pack path) $ findEntryByPath path a
287289
288−parseXMLDocE :: PandocMonad m => String -> m Element
289−parseXMLDocE doc = mkE "Unable to parse XML doc" $ parseXMLDoc doc
290+parseXMLDocE :: PandocMonad m => Entry -> m Element
291+parseXMLDocE entry =
292+ either (throwError . PandocXMLError fp) return $ parseXMLElement doc
293+ where
294+ doc = UTF8.toTextLazy . fromEntry $ entry
295+ fp = T.pack $ eRelativePath entry
290296
291297findElementE :: PandocMonad m => QName -> Element -> m Element
292−findElementE e x = mkE ("Unable to find element: " ++ show e) $ findElement e x
298+findElementE e x =
299+ mkE ("Unable to find element: " <> tshow e) $ findElement e x
293300
294−mkE :: PandocMonad m => String -> Maybe a -> m a
295−mkE s = maybe (throwError . PandocParseError $ T.pack s) return
301+mkE :: PandocMonad m => Text -> Maybe a -> m a
302+mkE s = maybe (throwError . PandocParseError $ s) return
src/Text/Pandoc/Readers/FB2.hs+57−51
@@ -25,13 +25,13 @@ TODO:
2525module Text.Pandoc.Readers.FB2 ( readFB2 ) where
2626import Control.Monad.Except (throwError)
2727import Control.Monad.State.Strict
28−import Data.ByteString.Lazy.Char8 ( pack )
2928import Data.ByteString.Base64.Lazy
3029import Data.Functor
3130import Data.List (intersperse)
3231import qualified Data.Map as M
3332import Data.Text (Text)
3433import qualified Data.Text as T
34+import qualified Data.Text.Lazy as TL
3535import Data.Default
3636import Data.Maybe
3737import Text.HTML.TagSoup.Entity (lookupEntity)
@@ -40,8 +40,9 @@ import Text.Pandoc.Class.PandocMonad (PandocMonad, insertMedia, report)
4040import Text.Pandoc.Error
4141import Text.Pandoc.Logging
4242import Text.Pandoc.Options
43−import Text.Pandoc.Shared (crFilter)
44−import Text.XML.Light
43+import Text.Pandoc.XML.Light
44+import qualified Text.Pandoc.UTF8 as UTF8
45+import Text.Pandoc.Sources (ToSources(..), sourcesToText)
4546
4647type FB2 m = StateT FB2State m
4748
@@ -62,12 +63,15 @@ instance HasMeta FB2State where
6263 setMeta field v s = s {fb2Meta = setMeta field v (fb2Meta s)}
6364 deleteMeta field s = s {fb2Meta = deleteMeta field (fb2Meta s)}
6465
65−readFB2 :: PandocMonad m => ReaderOptions -> Text -> m Pandoc
66+readFB2 :: (PandocMonad m, ToSources a)
67+ => ReaderOptions
68+ -> a
69+ -> m Pandoc
6670readFB2 _ inp =
67− case parseXMLDoc $ crFilter inp of
68− Nothing -> throwError $ PandocParseError "Not an XML document"
69− Just e -> do
70− (bs, st) <- runStateT (parseRootElement e) def
71+ case parseXMLElement $ TL.fromStrict $ sourcesToText $ toSources inp of
72+ Left msg -> throwError $ PandocXMLError "" msg
73+ Right el -> do
74+ (bs, st) <- runStateT (parseRootElement el) def
7175 let authors = if null $ fb2Authors st
7276 then id
7377 else setMeta "author" (map text $ reverse $ fb2Authors st)
@@ -83,12 +87,12 @@ removeHash t = case T.uncons t of
8387 Just ('#', xs) -> xs
8488 _ -> t
8589
86−convertEntity :: String -> Text
87−convertEntity e = maybe (T.toUpper $ T.pack e) T.pack $ lookupEntity e
90+convertEntity :: Text -> Text
91+convertEntity e = maybe (T.toUpper e) T.pack $ lookupEntity (T.unpack e)
8892
8993parseInline :: PandocMonad m => Content -> FB2 m Inlines
9094parseInline (Elem e) =
91− case T.pack $ qName $ elName e of
95+ case qName $ elName e of
9296 "strong" -> strong <$> parseStyleType e
9397 "emphasis" -> emph <$> parseStyleType e
9498 "style" -> parseNamedStyle e
@@ -96,12 +100,12 @@ parseInline (Elem e) =
96100 "strikethrough" -> strikeout <$> parseStyleType e
97101 "sub" -> subscript <$> parseStyleType e
98102 "sup" -> superscript <$> parseStyleType e
99− "code" -> pure $ code $ T.pack $ strContent e
103+ "code" -> pure $ code $ strContent e
100104 "image" -> parseInlineImageElement e
101105 name -> do
102106 report $ IgnoredElement name
103107 pure mempty
104−parseInline (Text x) = pure $ text $ T.pack $ cdData x
108+parseInline (Text x) = pure $ text $ cdData x
105109parseInline (CRef r) = pure $ str $ convertEntity r
106110
107111parseSubtitle :: PandocMonad m => Element -> FB2 m Blocks
@@ -111,7 +115,7 @@ parseSubtitle e = headerWith ("", ["unnumbered"], []) <$> gets fb2SectionLevel <
111115
112116parseRootElement :: PandocMonad m => Element -> FB2 m Blocks
113117parseRootElement e =
114− case T.pack $ qName $ elName e of
118+ case qName $ elName e of
115119 "FictionBook" -> do
116120 -- Parse notes before parsing the rest of the content.
117121 case filterChild isNotesBody e of
@@ -144,7 +148,7 @@ parseNote e =
144148 Just sectionId -> do
145149 content <- mconcat <$> mapM parseSectionChild (dropTitle $ elChildren e)
146150 oldNotes <- gets fb2Notes
147− modify $ \s -> s { fb2Notes = M.insert ("#" <> T.pack sectionId) content oldNotes }
151+ modify $ \s -> s { fb2Notes = M.insert ("#" <> sectionId) content oldNotes }
148152 pure ()
149153 where
150154 isTitle x = qName (elName x) == "title"
@@ -156,7 +160,7 @@ parseNote e =
156160-- | Parse a child of @\<FictionBook>@ element.
157161parseFictionBookChild :: PandocMonad m => Element -> FB2 m Blocks
158162parseFictionBookChild e =
159− case T.pack $ qName $ elName e of
163+ case qName $ elName e of
160164 "stylesheet" -> pure mempty -- stylesheet is ignored
161165 "description" -> mempty <$ mapM_ parseDescriptionChild (elChildren e)
162166 "body" -> if isNotesBody e
@@ -168,7 +172,7 @@ parseFictionBookChild e =
168172-- | Parse a child of @\<description>@ element.
169173parseDescriptionChild :: PandocMonad m => Element -> FB2 m ()
170174parseDescriptionChild e =
171− case T.pack $ qName $ elName e of
175+ case qName $ elName e of
172176 "title-info" -> mapM_ parseTitleInfoChild (elChildren e)
173177 "src-title-info" -> pure () -- ignore
174178 "document-info" -> pure ()
@@ -182,7 +186,7 @@ parseDescriptionChild e =
182186-- | Parse a child of @\<body>@ element.
183187parseBodyChild :: PandocMonad m => Element -> FB2 m Blocks
184188parseBodyChild e =
185− case T.pack $ qName $ elName e of
189+ case qName $ elName e of
186190 "image" -> parseImageElement e
187191 "title" -> header <$> gets fb2SectionLevel <*> parseTitleType (elContent e)
188192 "epigraph" -> parseEpigraph e
@@ -196,7 +200,10 @@ parseBinaryElement e =
196200 (Nothing, _) -> report $ IgnoredElement "binary without id attribute"
197201 (Just _, Nothing) ->
198202 report $ IgnoredElement "binary without content-type attribute"
199− (Just filename, contentType) -> insertMedia filename (T.pack <$> contentType) (decodeLenient (pack (strContent e)))
203+ (Just filename, contentType) ->
204+ insertMedia (T.unpack filename) contentType
205+ (decodeLenient
206+ (UTF8.fromTextLazy . TL.fromStrict . strContent $ e))
200207
201208-- * Type parsers
202209
@@ -206,13 +213,13 @@ parseAuthor e = T.unwords . catMaybes <$> mapM parseAuthorChild (elChildren e)
206213
207214parseAuthorChild :: PandocMonad m => Element -> FB2 m (Maybe Text)
208215parseAuthorChild e =
209− case T.pack $ qName $ elName e of
210− "first-name" -> pure $ Just $ T.pack $ strContent e
211− "middle-name" -> pure $ Just $ T.pack $ strContent e
212− "last-name" -> pure $ Just $ T.pack $ strContent e
213− "nickname" -> pure $ Just $ T.pack $ strContent e
214− "home-page" -> pure $ Just $ T.pack $ strContent e
215− "email" -> pure $ Just $ T.pack $ strContent e
216+ case qName $ elName e of
217+ "first-name" -> pure $ Just $ strContent e
218+ "middle-name" -> pure $ Just $ strContent e
219+ "last-name" -> pure $ Just $ strContent e
220+ "nickname" -> pure $ Just $ strContent e
221+ "home-page" -> pure $ Just $ strContent e
222+ "email" -> pure $ Just $ strContent e
216223 name -> do
217224 report $ IgnoredElement $ name <> " in author"
218225 pure Nothing
@@ -236,13 +243,13 @@ parseTitleContent _ = pure Nothing
236243parseImageElement :: PandocMonad m => Element -> FB2 m Blocks
237244parseImageElement e =
238245 case href of
239− Just src -> pure $ para $ imageWith (imgId, [], []) (removeHash $ T.pack src) title alt
246+ Just src -> pure $ para $ imageWith (imgId, [], []) (removeHash src) title alt
240247 Nothing -> do
241248 report $ IgnoredElement " image without href"
242249 pure mempty
243− where alt = maybe mempty (str . T.pack) $ findAttr (unqual "alt") e
244− title = maybe "" T.pack $ findAttr (unqual "title") e
245− imgId = maybe "" T.pack $ findAttr (unqual "id") e
250+ where alt = maybe mempty str $ findAttr (unqual "alt") e
251+ title = fromMaybe "" $ findAttr (unqual "title") e
252+ imgId = fromMaybe "" $ findAttr (unqual "id") e
246253 href = findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) e
247254
248255-- | Parse @pType@
@@ -256,7 +263,7 @@ parseCite e = blockQuote . mconcat <$> mapM parseCiteChild (elChildren e)
256263-- | Parse @citeType@ child
257264parseCiteChild :: PandocMonad m => Element -> FB2 m Blocks
258265parseCiteChild e =
259− case T.pack $ qName $ elName e of
266+ case qName $ elName e of
260267 "p" -> para <$> parsePType e
261268 "poem" -> parsePoem e
262269 "empty-line" -> pure horizontalRule
@@ -271,13 +278,13 @@ parsePoem e = mconcat <$> mapM parsePoemChild (elChildren e)
271278
272279parsePoemChild :: PandocMonad m => Element -> FB2 m Blocks
273280parsePoemChild e =
274− case T.pack $ qName $ elName e of
281+ case qName $ elName e of
275282 "title" -> parseTitle e
276283 "subtitle" -> parseSubtitle e
277284 "epigraph" -> parseEpigraph e
278285 "stanza" -> parseStanza e
279286 "text-author" -> para <$> parsePType e
280− "date" -> pure $ para $ text $ T.pack $ strContent e
287+ "date" -> pure $ para $ text $ strContent e
281288 name -> report (UnexpectedXmlElement name "poem") $> mempty
282289
283290parseStanza :: PandocMonad m => Element -> FB2 m Blocks
@@ -290,7 +297,7 @@ joinLineBlocks [] = []
290297
291298parseStanzaChild :: PandocMonad m => Element -> FB2 m Blocks
292299parseStanzaChild e =
293− case T.pack $ qName $ elName e of
300+ case qName $ elName e of
294301 "title" -> parseTitle e
295302 "subtitle" -> parseSubtitle e
296303 "v" -> lineBlock . (:[]) <$> parsePType e
@@ -300,11 +307,11 @@ parseStanzaChild e =
300307parseEpigraph :: PandocMonad m => Element -> FB2 m Blocks
301308parseEpigraph e =
302309 divWith (divId, ["epigraph"], []) . mconcat <$> mapM parseEpigraphChild (elChildren e)
303− where divId = maybe "" T.pack $ findAttr (unqual "id") e
310+ where divId = fromMaybe "" $ findAttr (unqual "id") e
304311
305312parseEpigraphChild :: PandocMonad m => Element -> FB2 m Blocks
306313parseEpigraphChild e =
307− case T.pack $ qName $ elName e of
314+ case qName $ elName e of
308315 "p" -> para <$> parsePType e
309316 "poem" -> parsePoem e
310317 "cite" -> parseCite e
@@ -318,7 +325,7 @@ parseAnnotation e = mconcat <$> mapM parseAnnotationChild (elChildren e)
318325
319326parseAnnotationChild :: PandocMonad m => Element -> FB2 m Blocks
320327parseAnnotationChild e =
321− case T.pack $ qName $ elName e of
328+ case qName $ elName e of
322329 "p" -> para <$> parsePType e
323330 "poem" -> parsePoem e
324331 "cite" -> parseCite e
@@ -332,14 +339,14 @@ parseSection :: PandocMonad m => Element -> FB2 m Blocks
332339parseSection e = do
333340 n <- gets fb2SectionLevel
334341 modify $ \st -> st{ fb2SectionLevel = n + 1 }
335− let sectionId = maybe "" T.pack $ findAttr (unqual "id") e
342+ let sectionId = fromMaybe "" $ findAttr (unqual "id") e
336343 bs <- divWith (sectionId, ["section"], []) . mconcat <$> mapM parseSectionChild (elChildren e)
337344 modify $ \st -> st{ fb2SectionLevel = n }
338345 pure bs
339346
340347parseSectionChild :: PandocMonad m => Element -> FB2 m Blocks
341348parseSectionChild e =
342− case T.pack $ qName $ elName e of
349+ case qName $ elName e of
343350 "title" -> parseBodyChild e
344351 "epigraph" -> parseEpigraph e
345352 "image" -> parseImageElement e
@@ -361,16 +368,16 @@ parseStyleType e = mconcat <$> mapM parseInline (elContent e)
361368parseNamedStyle :: PandocMonad m => Element -> FB2 m Inlines
362369parseNamedStyle e = do
363370 content <- mconcat <$> mapM parseNamedStyleChild (elContent e)
364− let lang = maybeToList $ ("lang",) . T.pack <$> findAttr (QName "lang" Nothing (Just "xml")) e
371+ let lang = maybeToList $ ("lang",) <$> findAttr (QName "lang" Nothing (Just "xml")) e
365372 case findAttr (unqual "name") e of
366− Just name -> pure $ spanWith ("", [T.pack name], lang) content
373+ Just name -> pure $ spanWith ("", [name], lang) content
367374 Nothing -> do
368375 report $ IgnoredElement "link without required name"
369376 pure mempty
370377
371378parseNamedStyleChild :: PandocMonad m => Content -> FB2 m Inlines
372379parseNamedStyleChild (Elem e) =
373− case T.pack $ qName (elName e) of
380+ case qName (elName e) of
374381 "strong" -> strong <$> parseStyleType e
375382 "emphasis" -> emph <$> parseStyleType e
376383 "style" -> parseNamedStyle e
@@ -378,7 +385,7 @@ parseNamedStyleChild (Elem e) =
378385 "strikethrough" -> strikeout <$> parseStyleType e
379386 "sub" -> subscript <$> parseStyleType e
380387 "sup" -> superscript <$> parseStyleType e
381− "code" -> pure $ code $ T.pack $ strContent e
388+ "code" -> pure $ code $ strContent e
382389 "image" -> parseInlineImageElement e
383390 name -> do
384391 report $ IgnoredElement $ name <> " in style"
@@ -390,7 +397,7 @@ parseLinkType :: PandocMonad m => Element -> FB2 m Inlines
390397parseLinkType e = do
391398 content <- mconcat <$> mapM parseStyleLinkType (elContent e)
392399 notes <- gets fb2Notes
393− case T.pack <$> findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) e of
400+ case findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) e of
394401 Just href -> case findAttr (QName "type" Nothing Nothing) e of
395402 Just "note" -> case M.lookup href notes of
396403 Nothing -> pure $ link href "" content
@@ -417,15 +424,14 @@ parseTable _ = pure mempty -- TODO: tables are not supported yet
417424-- | Parse @title-infoType@
418425parseTitleInfoChild :: PandocMonad m => Element -> FB2 m ()
419426parseTitleInfoChild e =
420− case T.pack $ qName (elName e) of
427+ case qName (elName e) of
421428 "genre" -> pure ()
422429 "author" -> parseAuthor e >>= \author -> modify (\st -> st {fb2Authors = author:fb2Authors st})
423− "book-title" -> modify (setMeta "title" (text $ T.pack $ strContent e))
430+ "book-title" -> modify (setMeta "title" (text $ strContent e))
424431 "annotation" -> parseAnnotation e >>= modify . setMeta "abstract"
425432 "keywords" -> modify (setMeta "keywords" (map (MetaString . trim) $ T.splitOn ","
426− $ T.pack
427433 $ strContent e))
428− "date" -> modify (setMeta "date" (text $ T.pack $ strContent e))
434+ "date" -> modify (setMeta "date" (text $ strContent e))
429435 "coverpage" -> parseCoverPage e
430436 "lang" -> pure ()
431437 "src-lang" -> pure ()
@@ -439,7 +445,7 @@ parseCoverPage e =
439445 Just img -> case href of
440446 Just src -> modify (setMeta "cover-image" (MetaString $ removeHash src))
441447 Nothing -> pure ()
442− where href = T.pack <$> findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) img
448+ where href = findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) img
443449 Nothing -> pure ()
444450
445451-- | Parse @inlineImageType@ element
@@ -452,5 +458,5 @@ parseInlineImageElement e =
452458 Nothing -> do
453459 report $ IgnoredElement "inline image without href"
454460 pure mempty
455− where alt = maybe mempty (str . T.pack) $ findAttr (unqual "alt") e
456− href = T.pack <$> findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) e
461+ where alt = maybe mempty str $ findAttr (unqual "alt") e
462+ href = findAttr (QName "href" (Just "http://www.w3.org/1999/xlink") Nothing) e
src/Text/Pandoc/Readers/HTML.hs+264−561

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Parsing.hsnew file+225

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Table.hsnew file+283

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/TagCategories.hsnew file+78

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Types.hsnew file+97

This diff is too big to show here.

src/Text/Pandoc/Readers/Haddock.hs+11−7

This diff is too big to show here.

src/Text/Pandoc/Readers/Ipynb.hs+6−4

This diff is too big to show here.

src/Text/Pandoc/Readers/JATS.hs+37−51

This diff is too big to show here.

src/Text/Pandoc/Readers/Jira.hs+14−10

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX.hs+271−1429

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Citation.hsnew file+210

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Inline.hsnew file+397

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Lang.hs+200−121

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Macro.hsnew file+184

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Math.hsnew file+221

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Parsing.hs+213−55

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/SIunitx.hs+153−70

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Table.hsnew file+378

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Types.hs+15−2

This diff is too big to show here.

src/Text/Pandoc/Readers/Man.hs+37−16

This diff is too big to show here.

src/Text/Pandoc/Readers/Markdown.hs+328−261

This diff is too big to show here.

src/Text/Pandoc/Readers/MediaWiki.hs+21−14

This diff is too big to show here.

src/Text/Pandoc/Readers/Metadata.hs+50−20

This diff is too big to show here.

src/Text/Pandoc/Readers/Muse.hs+10−9

This diff is too big to show here.

src/Text/Pandoc/Readers/Native.hs+8−6

This diff is too big to show here.

src/Text/Pandoc/Readers/OPML.hs+22−36

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt.hs+28−25

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Arrows/State.hs+2−2

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/ContentReader.hs+22−15

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Namespaces.hs+2−1

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Utils.hs+10−26

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/XMLConverter.hs+13−14

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Namespaces.hs+6−5

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/StyleReader.hs+21−17

This diff is too big to show here.

src/Text/Pandoc/Readers/Org.hs+5−8

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/BlockStarts.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Blocks.hs+71−33

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/DocumentTree.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ExportSettings.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Inlines.hs+13−13

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Meta.hs+13−5

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ParserState.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Parsing.hs+6−6

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Shared.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Readers/RST.hs+85−116

This diff is too big to show here.

src/Text/Pandoc/Readers/Roff.hs+16−18

This diff is too big to show here.

src/Text/Pandoc/Readers/TWiki.hs+7−27

This diff is too big to show here.

src/Text/Pandoc/Readers/Textile.hs+96−90

This diff is too big to show here.

src/Text/Pandoc/Readers/TikiWiki.hs+6−6

This diff is too big to show here.

src/Text/Pandoc/Readers/Txt2Tags.hs+49−23

This diff is too big to show here.

src/Text/Pandoc/Readers/Vimwiki.hs+12−7

This diff is too big to show here.

src/Text/Pandoc/RoffChar.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/SelfContained.hs+16−12

This diff is too big to show here.

src/Text/Pandoc/Shared.hs+52−101

This diff is too big to show here.

src/Text/Pandoc/Slides.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Sources.hsnew file+195

This diff is too big to show here.

src/Text/Pandoc/Templates.hs+5−1

This diff is too big to show here.

src/Text/Pandoc/Translations.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/UTF8.hs+21−24

This diff is too big to show here.

src/Text/Pandoc/UUID.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers.hs+9−4

This diff is too big to show here.

src/Text/Pandoc/Writers/AnnotatedTable.hs+23

This diff is too big to show here.

src/Text/Pandoc/Writers/AsciiDoc.hs+43−12

This diff is too big to show here.

src/Text/Pandoc/Writers/BibTeX.hsnew file+61

This diff is too big to show here.

src/Text/Pandoc/Writers/CommonMark.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/ConTeXt.hs+45−39

This diff is too big to show here.

src/Text/Pandoc/Writers/CslJson.hs+11−9

This diff is too big to show here.

src/Text/Pandoc/Writers/Custom.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/Docbook.hs+114−33

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx.hs+238−395

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/StyleMap.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Table.hsnew file+227

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Types.hsnew file+185

This diff is too big to show here.

src/Text/Pandoc/Writers/DokuWiki.hs+29−16

This diff is too big to show here.

src/Text/Pandoc/Writers/EPUB.hs+269−212

This diff is too big to show here.

src/Text/Pandoc/Writers/FB2.hs+62−78

This diff is too big to show here.

src/Text/Pandoc/Writers/GridTable.hsnew file+157

This diff is too big to show here.

src/Text/Pandoc/Writers/HTML.hs+144−64

This diff is too big to show here.

src/Text/Pandoc/Writers/Haddock.hs+13−2

This diff is too big to show here.

src/Text/Pandoc/Writers/ICML.hs+6−1

This diff is too big to show here.

src/Text/Pandoc/Writers/Ipynb.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS.hs+113−120

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/References.hsnew file+164

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Table.hsnew file+268

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Types.hsnew file+57

This diff is too big to show here.

src/Text/Pandoc/Writers/Jira.hs+43−18

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX.hs+100−815

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Caption.hsnew file+47

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Citation.hsnew file+181

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Lang.hsnew file+192

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Notes.hsnew file+34

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Table.hsnew file+307

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Types.hsnew file+83

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Util.hsnew file+275

This diff is too big to show here.

src/Text/Pandoc/Writers/Man.hs+3−3

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown.hs+94−660

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Inline.hsnew file+616

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Types.hsnew file+81

This diff is too big to show here.

src/Text/Pandoc/Writers/MediaWiki.hs+10−3

This diff is too big to show here.

src/Text/Pandoc/Writers/Ms.hs+30−12

This diff is too big to show here.

src/Text/Pandoc/Writers/Muse.hs+6−3

This diff is too big to show here.

src/Text/Pandoc/Writers/Native.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/ODT.hs+28−22

This diff is too big to show here.

src/Text/Pandoc/Writers/OOXML.hs+22−22

This diff is too big to show here.

src/Text/Pandoc/Writers/OPML.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/OpenDocument.hs+166−86

This diff is too big to show here.

src/Text/Pandoc/Writers/Org.hs+66−42

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Output.hs+172−148

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Presentation.hs+2−3

This diff is too big to show here.

src/Text/Pandoc/Writers/RST.hs+38−22

This diff is too big to show here.

src/Text/Pandoc/Writers/RTF.hs+17−11

This diff is too big to show here.

src/Text/Pandoc/Writers/Roff.hs+2−2

This diff is too big to show here.

src/Text/Pandoc/Writers/Shared.hs+20−6

This diff is too big to show here.

src/Text/Pandoc/Writers/TEI.hs+5−4

This diff is too big to show here.

src/Text/Pandoc/Writers/Texinfo.hs+23−16

This diff is too big to show here.

src/Text/Pandoc/Writers/Textile.hs+1−1

This diff is too big to show here.

src/Text/Pandoc/Writers/ZimWiki.hs+5−3

This diff is too big to show here.

src/Text/Pandoc/XML.hs+42−20

This diff is too big to show here.

src/Text/Pandoc/XML/Light.hsnew file+89

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Output.hsnew file+234

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Proc.hsnew file+139

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Types.hsnew file+193

This diff is too big to show here.

stack.yaml+11−21

This diff is too big to show here.

test/Tests/Command.hs+34−39

This diff is too big to show here.

test/Tests/Helpers.hs+25−36

This diff is too big to show here.

test/Tests/Lua.hs+2−4

This diff is too big to show here.

test/Tests/Lua/Module.hs+3−1

This diff is too big to show here.

test/Tests/Old.hs+18−30

This diff is too big to show here.

test/Tests/Readers/Creole.hs+1−3

This diff is too big to show here.

test/Tests/Readers/Docx.hs+25−7

This diff is too big to show here.

test/Tests/Readers/DokuWiki.hs−2

This diff is too big to show here.

test/Tests/Readers/EPUB.hs+2−4

This diff is too big to show here.

test/Tests/Readers/FB2.hs−2

This diff is too big to show here.

test/Tests/Readers/HTML.hs+24−19

This diff is too big to show here.

test/Tests/Readers/JATS.hs+1−2

This diff is too big to show here.

test/Tests/Readers/Jira.hs+22−2

This diff is too big to show here.

test/Tests/Readers/LaTeX.hs+2−21

This diff is too big to show here.

test/Tests/Readers/Man.hs+1−2

This diff is too big to show here.

test/Tests/Readers/Markdown.hs+4−6

This diff is too big to show here.

test/Tests/Readers/Muse.hs−2

This diff is too big to show here.

test/Tests/Readers/Odt.hs+2−3

This diff is too big to show here.

test/Tests/Readers/Org.hs+1−1

This diff is too big to show here.

test/Tests/Readers/Org/Block.hs+22−24

This diff is too big to show here.

test/Tests/Readers/Org/Block/CodeBlock.hs+36−38

This diff is too big to show here.

test/Tests/Readers/Org/Block/Figure.hs+9−11

This diff is too big to show here.

test/Tests/Readers/Org/Block/Header.hs+4−6

This diff is too big to show here.

test/Tests/Readers/Org/Block/List.hs+14−3

This diff is too big to show here.

test/Tests/Readers/Org/Block/Table.hs+3−5

This diff is too big to show here.

test/Tests/Readers/Org/Directive.hs+1−3

This diff is too big to show here.

test/Tests/Readers/Org/Inline.hs+5−7

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Citation.hs+41−3

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Note.hs+1−3

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Smart.hs+1−3

This diff is too big to show here.

test/Tests/Readers/Org/Meta.hs+44−30

This diff is too big to show here.

test/Tests/Readers/Org/Shared.hs+1−3

This diff is too big to show here.

test/Tests/Readers/RST.hs+1−3

This diff is too big to show here.

test/Tests/Readers/Txt2Tags.hs+1−3

This diff is too big to show here.

test/Tests/Shared.hs+1−3

This diff is too big to show here.

test/Tests/Writers/AnnotatedTable.hs−1

This diff is too big to show here.

test/Tests/Writers/AsciiDoc.hs−2

This diff is too big to show here.

test/Tests/Writers/ConTeXt.hs+122−115

This diff is too big to show here.

test/Tests/Writers/Docbook.hs+103−2

This diff is too big to show here.

test/Tests/Writers/Docx.hs+15−2

This diff is too big to show here.

test/Tests/Writers/FB2.hs−2

This diff is too big to show here.

test/Tests/Writers/HTML.hs+57−54

This diff is too big to show here.

test/Tests/Writers/JATS.hs+135−93

This diff is too big to show here.

test/Tests/Writers/Jira.hs+60−1

This diff is too big to show here.

test/Tests/Writers/LaTeX.hs−2

This diff is too big to show here.

test/Tests/Writers/Markdown.hs+3−3

This diff is too big to show here.

test/Tests/Writers/Ms.hs−2

This diff is too big to show here.

test/Tests/Writers/Muse.hs−1

This diff is too big to show here.

test/Tests/Writers/Native.hs−2

This diff is too big to show here.

test/Tests/Writers/OOXML.hs+5−4

This diff is too big to show here.

test/Tests/Writers/Org.hs+46−13

This diff is too big to show here.

test/Tests/Writers/Plain.hs−2

This diff is too big to show here.

test/Tests/Writers/Powerpoint.hs−2

This diff is too big to show here.

test/Tests/Writers/RST.hs−2

This diff is too big to show here.

test/Tests/Writers/TEI.hs−2

This diff is too big to show here.

test/command/1279.md+1−1

This diff is too big to show here.

test/command/1881.md+13−13

This diff is too big to show here.

test/command/2103.mdnew file+8

This diff is too big to show here.

test/command/2378.md+3−3

This diff is too big to show here.

test/command/2874.md+2−2

This diff is too big to show here.

test/command/3516.md+1−5

This diff is too big to show here.

test/command/3674.md+1−1

This diff is too big to show here.

test/command/3706.md+8−8

This diff is too big to show here.

test/command/3736.md+3−6

This diff is too big to show here.

test/command/3752.mdnew file+60

This diff is too big to show here.

test/command/3792.md+1−1

This diff is too big to show here.

test/command/3824.md+1

This diff is too big to show here.

test/command/4038.md+1−1

This diff is too big to show here.

test/command/4063.mdnew file+29

This diff is too big to show here.

test/command/4164.md+5−9

This diff is too big to show here.

test/command/4186.md+8−8

This diff is too big to show here.

test/command/4420.md−11

This diff is too big to show here.

test/command/4442.md+1−1

This diff is too big to show here.

test/command/4465.mdnew file+15

This diff is too big to show here.

test/command/4742.md+2−2

This diff is too big to show here.

test/command/5121.md+1−2

This diff is too big to show here.

test/command/5178.md+10−10

This diff is too big to show here.

test/command/5304.md+1−1

This diff is too big to show here.

test/command/5321.md+2−2

This diff is too big to show here.

test/command/5367.md+9−10

This diff is too big to show here.

test/command/5519.md+1−1

This diff is too big to show here.

test/command/5541-nesting.md+1

This diff is too big to show here.

test/command/5686.md+1−1

This diff is too big to show here.

test/command/5708.md+1−5

This diff is too big to show here.

test/command/5986.md+3−2

This diff is too big to show here.

test/command/6026.mdnew file+19

This diff is too big to show here.

test/command/6388.mdnew file+16

This diff is too big to show here.

test/command/6541.mdnew file+27

This diff is too big to show here.

test/command/6620.md+3

This diff is too big to show here.

test/command/6658.mdnew file+75

This diff is too big to show here.

test/command/6709.mdnew file+11

This diff is too big to show here.

test/command/6723.md+1−2

This diff is too big to show here.

test/command/6739.mdnew file+21

This diff is too big to show here.

test/command/6740.mdnew file+7

This diff is too big to show here.

test/command/6741.mdnew file+145

This diff is too big to show here.

test/command/6752.mdnew file+36

This diff is too big to show here.

test/command/6755.mdnew file+11

This diff is too big to show here.

test/command/6765.mdnew file+31

This diff is too big to show here.

test/command/6768.mdnew file+21

This diff is too big to show here.

test/command/6774.mdnew file+63

This diff is too big to show here.

test/command/6783.mdnew file+26

This diff is too big to show here.

test/command/6791.mdnew file+32

This diff is too big to show here.

test/command/6792.mdnew file+66

This diff is too big to show here.

test/command/6796.mdnew file+16

This diff is too big to show here.

test/command/6802.mdnew file+9

This diff is too big to show here.

test/command/6836.mdnew file+17

This diff is too big to show here.

test/command/6837.mdnew file+29

This diff is too big to show here.

test/command/6844.mdnew file+27

This diff is too big to show here.

test/command/6855.mdnew file+12

This diff is too big to show here.

test/command/6858.mdnew file+52

This diff is too big to show here.

test/command/6869.mdnew file+6

This diff is too big to show here.

test/command/6873.mdnew file+7

This diff is too big to show here.

test/command/6890.mdnew file+36

This diff is too big to show here.

test/command/6925.mdnew file+34

This diff is too big to show here.

test/command/6948.mdnew file+31

This diff is too big to show here.

test/command/6951.mdnew file+18

This diff is too big to show here.

test/command/6958.mdnew file+10

This diff is too big to show here.

test/command/6993.mdnew file+21

This diff is too big to show here.

test/command/7003.mdnew file+37

This diff is too big to show here.

test/command/7006.mdnew file+20

This diff is too big to show here.

test/command/7009.mdnew file+8

This diff is too big to show here.

test/command/7016.mdnew file+48

This diff is too big to show here.

test/command/7041.mdnew file+23

This diff is too big to show here.

test/command/7042.mdnew file+146

This diff is too big to show here.

test/command/7058.mdnew file+6

This diff is too big to show here.

test/command/7064.mdnew file+32

This diff is too big to show here.

test/command/7067.mdnew file+90

This diff is too big to show here.

test/command/7080.mdnew file+8

This diff is too big to show here.

test/command/7092.mdnew file+8

This diff is too big to show here.

test/command/7099.mdnew file+18

This diff is too big to show here.

test/command/7112.mdnew file+15

This diff is too big to show here.

test/command/7129.mdnew file+27

This diff is too big to show here.

test/command/7132.mdnew file+10

This diff is too big to show here.

test/command/7134.mdnew file+16

This diff is too big to show here.

test/command/7145.mdnew file+12

This diff is too big to show here.

test/command/7155.mdnew file+15

This diff is too big to show here.

test/command/7173.mdnew file+137

This diff is too big to show here.

test/command/7208.mdnew file+6

This diff is too big to show here.

test/command/7214.mdnew file+28

This diff is too big to show here.

test/command/7216.mdnew file+19

This diff is too big to show here.

test/command/7266.mdnew file+10

This diff is too big to show here.

test/command/7272.mdnew file+27

This diff is too big to show here.

test/command/7278.mdnew file+38

This diff is too big to show here.

test/command/7282.mdnew file+7

This diff is too big to show here.

test/command/7288.mdnew file+40

This diff is too big to show here.

test/command/7299.mdnew file+23

This diff is too big to show here.

test/command/7321.mdnew file+24

This diff is too big to show here.

test/command/7323.mdnew file+29

This diff is too big to show here.

test/command/7324.mdnew file+25

This diff is too big to show here.

test/command/7339.mdnew file+11

This diff is too big to show here.

test/command/7340.mdnew file+6

This diff is too big to show here.

test/command/7376.mdnew file+16

This diff is too big to show here.

test/command/7394.mdnew file+85

This diff is too big to show here.

test/command/7397.mdnew file+14

This diff is too big to show here.

test/command/7400.mdnew file+9

This diff is too big to show here.

test/command/7416.mdnew file+19

This diff is too big to show here.

test/command/averroes.bibnew file+95

This diff is too big to show here.

test/command/biblatex-baez-article.md+1−1

This diff is too big to show here.

test/command/biblatex-baez-online.md+1−1

This diff is too big to show here.

test/command/biblatex-basic.md+5−3

This diff is too big to show here.

test/command/biblatex-cotton.md+3−3

This diff is too big to show here.

test/command/biblatex-examples.bibdeleted−1674

This diff is too big to show here.

test/command/biblatex-inproceedings.md+1−1

This diff is too big to show here.

test/command/biblatex-itzhaki.md+1−1

This diff is too big to show here.

test/command/biblatex-jaffe.md+2−2

This diff is too big to show here.

test/command/biblatex-moraux.md+1−1

This diff is too big to show here.

test/command/biblatex-murray.md+3−2

This diff is too big to show here.

test/command/biblatex-nussbaum.mddeleted−63

This diff is too big to show here.

test/command/biblatex-quotes.md+1−1

This diff is too big to show here.

test/command/biblatex-sigfridsson.md+1−1

This diff is too big to show here.

test/command/biblatex-spiegelberg.md+2−2

This diff is too big to show here.

test/command/biblatex-test-case-conversion.md+2−2

This diff is too big to show here.

test/command/biblatex-textnormal.md+1−1

This diff is too big to show here.

test/command/biblatex-thesis.md+1−1

This diff is too big to show here.

test/command/biblatex-wassenberg.md+1−1

This diff is too big to show here.

test/command/biblatex-wilde.md+1−1

This diff is too big to show here.

test/command/chap1/spider.pngnew file

Binary file not shown.

test/command/chap1/text.mdnew file+17

This diff is too big to show here.

test/command/chap2/spider.pngnew file

Binary file not shown.

test/command/chap2/text.mdnew file+5

This diff is too big to show here.

test/command/citeproc-20.mdnew file+25

This diff is too big to show here.

test/command/citeproc-author-in-text-suffix.mdnew file+6

This diff is too big to show here.

test/command/custom-attributes.htmldeleted−16

This diff is too big to show here.

test/command/defaults-inheritance-1.mdnew file+6

This diff is too big to show here.

test/command/defaults-inheritance-2.mdnew file+5

This diff is too big to show here.

test/command/defaults-inheritance-3.mdnew file+6

This diff is too big to show here.

test/command/defaults3.yamlnew file+4

This diff is too big to show here.

test/command/defaults4.yamlnew file+3

This diff is too big to show here.

test/command/defaults5.yamlnew file+2

This diff is too big to show here.

test/command/defaults6.yamlnew file+2

This diff is too big to show here.

test/command/defaults7.yamlnew file+2

This diff is too big to show here.

test/command/defaults8.yamlnew file+2

This diff is too big to show here.

test/command/defaults9.yamlnew file+1

This diff is too big to show here.

test/command/docbook-bibliography.mdnew file+20

This diff is too big to show here.

test/command/duplicate_attributes.mdnew file+7

This diff is too big to show here.

test/command/empty-inline-code.txtdeleted−6

This diff is too big to show here.

test/command/latex-center.mdnew file+13

This diff is too big to show here.

test/command/mmd-metadata.mdnew file+20

This diff is too big to show here.

test/command/nested-table-to-asciidoc-6942.mdnew file+82

This diff is too big to show here.

test/command/newif.mdnew file+55

This diff is too big to show here.

test/command/pandoc-citeproc-119.md+2−3

This diff is too big to show here.

test/command/pandoc-citeproc-14.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-152.md+2−4

This diff is too big to show here.

test/command/pandoc-citeproc-160.md+2−4

This diff is too big to show here.

test/command/pandoc-citeproc-175.md+2−4

This diff is too big to show here.

test/command/pandoc-citeproc-213.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-25.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-27.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-320a.md+3−3

This diff is too big to show here.

test/command/pandoc-citeproc-322.md+1−1

This diff is too big to show here.

test/command/pandoc-citeproc-356.md+2−7

This diff is too big to show here.

test/command/pandoc-citeproc-371.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-416.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-47.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-53.md+4−2

This diff is too big to show here.

test/command/pandoc-citeproc-57.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-58.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-61.md+2−4

This diff is too big to show here.

test/command/pandoc-citeproc-65.md+1−1

This diff is too big to show here.

test/command/pandoc-citeproc-70.md+2−2

This diff is too big to show here.

test/command/pandoc-citeproc-82.md+3−4

This diff is too big to show here.

test/command/pandoc-citeproc-87.md+1−2

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-author-date.md+11−13

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-fullnote-bibliography.md+18−23

This diff is too big to show here.

test/command/pandoc-citeproc-ieee.md+2−4

This diff is too big to show here.

test/command/pandoc-citeproc-locators-integrated.md+2−2

This diff is too big to show here.

test/command/svg.md+17−15

This diff is too big to show here.

test/command/toc.md+11−20

This diff is too big to show here.

test/command/unicode-collation.mdnew file+130

This diff is too big to show here.

test/command/yaml-metadata-blocks.md+3−3

This diff is too big to show here.

test/docbook-reader.docbook+9−2

This diff is too big to show here.

test/docx/0_level_headers.native+2−2

This diff is too big to show here.

test/docx/golden/block_quotes.docx

Binary file not shown.

test/docx/golden/codeblock.docx

Binary file not shown.

test/docx/golden/comments.docx

Binary file not shown.

test/docx/golden/custom_style_no_reference.docx

Binary file not shown.

test/docx/golden/custom_style_preserve.docx

Binary file not shown.

test/docx/golden/custom_style_reference.docx

Binary file not shown.

test/docx/golden/definition_list.docx

Binary file not shown.

test/docx/golden/document-properties-short-desc.docx

Binary file not shown.

test/docx/golden/document-properties.docx

Binary file not shown.

test/docx/golden/headers.docx

Binary file not shown.

test/docx/golden/image.docx

Binary file not shown.

test/docx/golden/inline_code.docx

Binary file not shown.

test/docx/golden/inline_formatting.docx

Binary file not shown.

test/docx/golden/inline_images.docx

Binary file not shown.

test/docx/golden/link_in_notes.docx

Binary file not shown.

test/docx/golden/links.docx

Binary file not shown.

test/docx/golden/lists.docx

Binary file not shown.

test/docx/golden/lists_continuing.docx

Binary file not shown.

test/docx/golden/lists_multiple_initial.docx

Binary file not shown.

test/docx/golden/lists_restarting.docx

Binary file not shown.

test/docx/golden/nested_anchors_in_header.docx

Binary file not shown.

test/docx/golden/notes.docx

Binary file not shown.

test/docx/golden/raw-blocks.docxnew file

Binary file not shown.

test/docx/golden/raw-bookmarks.docxnew file

Binary file not shown.

test/docx/golden/table_one_row.docx

Binary file not shown.

test/docx/golden/table_with_list_cell.docx

Binary file not shown.

test/docx/golden/tables-default-widths.docxnew file

Binary file not shown.

test/docx/golden/tables.docx

Binary file not shown.

test/docx/golden/track_changes_deletion.docx

Binary file not shown.

test/docx/golden/track_changes_insertion.docx

Binary file not shown.

test/docx/golden/track_changes_move.docx

Binary file not shown.

test/docx/golden/track_changes_scrubbed_metadata.docx

Binary file not shown.

test/docx/golden/unicode.docx

Binary file not shown.

test/docx/golden/verbatim_subsuper.docx

Binary file not shown.

test/docx/image_vml_as_object.docxnew file

Binary file not shown.

test/docx/image_vml_as_object.nativenew file+2

This diff is too big to show here.

test/docx/raw-blocks.nativenew file+6

This diff is too big to show here.

test/docx/raw-bookmarks.nativenew file+3

This diff is too big to show here.

test/docx/sdt_elements.native+9−10

This diff is too big to show here.

test/docx/table_captions_no_field.docxnew file

Binary file not shown.

test/docx/table_captions_no_field.nativenew file+34

This diff is too big to show here.

test/docx/table_captions_with_field.docxnew file

Binary file not shown.

test/docx/table_captions_with_field.nativenew file+54

This diff is too big to show here.

test/docx/table_header_rowspan.docxnew file

Binary file not shown.

test/docx/table_header_rowspan.nativenew file+189

This diff is too big to show here.

test/docx/table_one_header_row.docxnew file

Binary file not shown.

test/docx/table_one_header_row.nativenew file+18

This diff is too big to show here.

test/docx/table_one_row.docx

Binary file not shown.

test/docx/table_one_row.native+4−4

This diff is too big to show here.

test/docx/table_variable_width.native+12−17

This diff is too big to show here.

test/docx/table_with_list_cell.native+3−3

This diff is too big to show here.

test/docx/tables-default-widths.nativenew file+92

This diff is too big to show here.

test/docx/tables.native+9−9

This diff is too big to show here.

test/epub/features.epub

Binary file not shown.

test/epub/features.native+3−3

This diff is too big to show here.

test/epub/wasteland.epub

Binary file not shown.

test/epub/wasteland.native+4−4

This diff is too big to show here.

test/fb2/images.fb2+1−1

This diff is too big to show here.

test/fb2/test.jpg

Binary file not shown.

test/grofftest.shdeleted−26

This diff is too big to show here.

test/html-reader.html+76

This diff is too big to show here.

test/html-reader.native+148−37

This diff is too big to show here.

test/jats-reader.native+1−1

This diff is too big to show here.

test/jats-reader.xml+1

This diff is too big to show here.

test/jira-reader.native+1−1

This diff is too big to show here.

test/latex-reader.native+26−13

This diff is too big to show here.

test/lhs-test.html+45−19

This diff is too big to show here.

test/lhs-test.html+lhs+45−19

This diff is too big to show here.

test/lhs-test.latex+4−4

This diff is too big to show here.

test/lhs-test.latex+lhs+4−4

This diff is too big to show here.

test/lua/module/pandoc-path.luanew file+44

This diff is too big to show here.

test/markdown-reader-more.native+6−34

This diff is too big to show here.

test/odt/native/tab.nativenew file+1

This diff is too big to show here.

test/odt/odt/tab.odtnew file

Binary file not shown.

test/org-select-tags.org+2−2

This diff is too big to show here.

test/pipe-tables.native+2−10

This diff is too big to show here.

test/pptx/code-custom.pptx

Binary file not shown.

test/pptx/code-custom_templated.pptx

Binary file not shown.

test/pptx/code.pptx

Binary file not shown.

test/pptx/code_templated.pptx

Binary file not shown.

test/pptx/document-properties-short-desc.pptx

Binary file not shown.

test/pptx/document-properties-short-desc_templated.pptx

Binary file not shown.

test/pptx/document-properties.pptx

Binary file not shown.

test/pptx/document-properties_templated.pptx

Binary file not shown.

test/pptx/endnotes.pptx

Binary file not shown.

test/pptx/endnotes_templated.pptx

Binary file not shown.

test/pptx/endnotes_toc.pptx

Binary file not shown.

test/pptx/endnotes_toc_templated.pptx

Binary file not shown.

test/pptx/images.pptx

Binary file not shown.

test/pptx/images_templated.pptx

Binary file not shown.

test/pptx/inline_formatting.pptx

Binary file not shown.

test/pptx/inline_formatting_templated.pptx

Binary file not shown.

test/pptx/lists.pptx

Binary file not shown.

test/pptx/lists_templated.pptx

Binary file not shown.

test/pptx/raw_ooxml.native+1−1

This diff is too big to show here.

test/pptx/raw_ooxml.pptx

Binary file not shown.

test/pptx/raw_ooxml_templated.pptx

Binary file not shown.

test/pptx/reference_depth.pptx

Binary file not shown.

test/pptx/remove_empty_slides.pptx

Binary file not shown.

test/pptx/remove_empty_slides_templated.pptx

Binary file not shown.

test/pptx/slide_breaks.pptx

Binary file not shown.

test/pptx/slide_breaks_slide_level_1.pptx

Binary file not shown.

test/pptx/slide_breaks_slide_level_1_templated.pptx

Binary file not shown.

test/pptx/slide_breaks_templated.pptx

Binary file not shown.

test/pptx/slide_breaks_toc.pptx

Binary file not shown.

test/pptx/slide_breaks_toc_templated.pptx

Binary file not shown.

test/pptx/speaker_notes.pptx

Binary file not shown.

test/pptx/speaker_notes_after_metadata.pptx

Binary file not shown.

test/pptx/speaker_notes_after_metadata_templated.pptx

Binary file not shown.

test/pptx/speaker_notes_afterheader.pptx

Binary file not shown.

test/pptx/speaker_notes_afterheader_templated.pptx

Binary file not shown.

test/pptx/speaker_notes_afterseps.pptx

Binary file not shown.

test/pptx/speaker_notes_afterseps_templated.pptx

Binary file not shown.

test/pptx/speaker_notes_templated.pptx

Binary file not shown.

test/pptx/start_numbering_at.pptx

Binary file not shown.

test/pptx/start_numbering_at_templated.pptx

Binary file not shown.

test/pptx/tables.pptx

Binary file not shown.

test/pptx/tables_templated.pptx

Binary file not shown.

test/pptx/two_column.pptx

Binary file not shown.

test/pptx/two_column_templated.pptx

Binary file not shown.

test/rst-reader.native+3−21

This diff is too big to show here.

test/tables-rstsubset.native+1−9

This diff is too big to show here.

test/tables.jats_archiving+156−156

This diff is too big to show here.

test/tables.jats_articleauthoring+156−156

This diff is too big to show here.

test/tables.jats_publishing+156−156

This diff is too big to show here.

test/tables.latex+65−101

This diff is too big to show here.

test/tables.ms+44

This diff is too big to show here.

test/tables.org+3−3

This diff is too big to show here.

test/tables/nordics.html4+6−6

This diff is too big to show here.

test/tables/nordics.html5+6−6

This diff is too big to show here.

test/tables/nordics.jats_archivingnew file+58

This diff is too big to show here.

test/tables/nordics.latexnew file+42

This diff is too big to show here.

test/tables/nordics.native+60−33

This diff is too big to show here.

test/tables/planets.html4+1−1

This diff is too big to show here.

test/tables/planets.html5+1−1

This diff is too big to show here.

test/tables/planets.jats_archivingnew file+128

This diff is too big to show here.

test/tables/planets.latexnew file+30

This diff is too big to show here.

test/tables/planets.native+215−112

This diff is too big to show here.

test/tables/students.jats_archivingnew file+56

This diff is too big to show here.

test/tables/students.latexnew file+31

This diff is too big to show here.

test/tables/students.native+49−32

This diff is too big to show here.

test/test-pandoc.hs+18−8

This diff is too big to show here.

test/textile-reader.native+1−1

This diff is too big to show here.

test/textile-reader.textile+1−1

This diff is too big to show here.

test/txt2tags.native+1−1

This diff is too big to show here.

test/txt2tags.t2t+1−1

This diff is too big to show here.

test/writer.context+45−43

This diff is too big to show here.

test/writer.dokuwiki+11

This diff is too big to show here.

test/writer.html4+44−19

This diff is too big to show here.

test/writer.html5+44−19

This diff is too big to show here.

test/writer.icml+2

This diff is too big to show here.

test/writer.jats_archiving+12−8

This diff is too big to show here.

test/writer.jats_articleauthoring+1−1

This diff is too big to show here.

test/writer.jats_publishing+12−8

This diff is too big to show here.

test/writer.jira+23−35

This diff is too big to show here.

test/writer.latex+4−4

This diff is too big to show here.

test/writer.markdown+27−54

This diff is too big to show here.

test/writer.ms+1−1

This diff is too big to show here.

test/writer.opml+1−1

This diff is too big to show here.

test/writer.org+91−91

This diff is too big to show here.

test/writer.zimwiki+3−3

This diff is too big to show here.

test/writers-lang-and-dir.context+7−5

This diff is too big to show here.

test/writers-lang-and-dir.latex+11−8

This diff is too big to show here.

tools/build-arm.shnew file+110

This diff is too big to show here.

tools/changelog-helper.sh+11−4

This diff is too big to show here.

tools/parseTimings.plnew file+33

This diff is too big to show here.

trypandoc/index.html+1−1

This diff is too big to show here.

trypandoc/trypandoc.hs+3−8

This diff is too big to show here.

windows/Makefile+1−1

This diff is too big to show here.

windows/pandoc.wxs+2−2

This diff is too big to show here.