git.iko.soy/typeable/pandoc

on 47537d2 help sign in

fromb8e0b46

swap

to0 ahead, 2515 behind

compare

.circleci/config.yml+116−64

@@ -1,72 +1,124 @@

11version: "2.1"

2−jobs:

3− build:

4− macos:

5− xcode: 11.1.0

2+

3+env: &env

64 environment:

7− HOMEBREW_NO_AUTO_UPDATE: 1

5+ LC_ALL: "C.UTF-8"

6+ GHC_OPTS: "-O0 -Wall -fno-warn-unused-do-bind -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -Wincomplete-uni-patterns -Werror=missing-home-modules -Widentities -Wcpp-undef -fhide-source-paths"

7+ docker:

8+ - image: fpco/stack-build:lts

9+

10+#-----------------------------------------------------------------------------

11+# Common utility stuff, not to be modified usually

12+#-----------------------------------------------------------------------------

13+

14+preinstall: &preinstall

15+ run: |

16+ echo 'export PATH=/opt/cabal/bin:$PATH' >> $BASH_ENV

17+ source $BASH_ENV

18+ apt-get update

19+

20+restore: &restore

21+ # Needs to happen after installing ca-certificates

22+ restore_cache:

23+ key: v1-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}

24+

25+save: &save

26+ save_cache:

27+ key: v1-{{ .Environment.CIRCLE_JOB }}-{{ .Branch }}

28+ paths:

29+ - ~/.cabal

30+ - ~/.ghc

31+ - ~/.local

32+ - ~/.stack

33+

34+commands:

35+ cabal_build:

36+ parameters:

37+ ghcversion:

38+ type: string

839 steps:

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}

40+ - checkout

41+ - *preinstall

42+ - *restore

43+ - run:

44+ name: install ghc

45+ command: apt-get install -y ghc-<< paramaters.ghcversion >>

46+ - run: |

47+ set -e

48+ apt-get install -y cabal-install-2.4

49+ cabal v2-update

50+ TMPDIR=`mktemp -d -t circleci.XXXXXXX`

51+ cabal v2-sdist --output-dir=${TMPDIR}

52+ cd ${TMPDIR}

53+ tar xvzf *.tar.gz

54+ cd *

55+ cabal v2-build -j2 --dependencies-only --enable-tests --ghc-options="${GHC_OPTS}" all

56+ cabal v2-build -j2 --enable-tests --ghc-options="${GHC_OPTS}" all 2>build.log

57+ # fail if we had warnings in local build

58+ # this is to work around the fact that cabal v2 doesn't allow

59+ # us to use -Werror for just local build:

60+ # https://github.com/haskell/cabal/issues/4247

61+ ! grep -q "warning:" build.log

62+ cabal v2-test --ghc-options="${GHC_OPTS}" 2>build.log

63+ cabal v2-haddock --ghc-options="${GHC_OPTS}"

64+ cabal check

65+ - *save

5066

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"

67+#-----------------------------------------------------------------------------

68+# Build matrix

69+#-----------------------------------------------------------------------------

5870

59− - store_artifacts:

60− # https://circleci.com/docs/2.0/artifacts/

61− path: macos-release-candidate.zip

62− destination: macos-release-candidate.zip

71+jobs:

72+ cabal-ghc-8_6_3:

73+ <<: *env

74+ steps:

75+ - cabal_build:

76+ ghcversion: 8.6.3

77+

78+ cabal-ghc-8_4_4:

79+ <<: *env

80+ steps:

81+ - cabal_build:

82+ ghcversion: 8.4.4

83+

84+ cabal-ghc-8_2_2:

85+ <<: *env

86+ steps:

87+ - cabal_build:

88+ ghcversion: 8.2.2

89+

90+ cabal-ghc-8_0_2:

91+ <<: *env

92+ steps:

93+ - cabal_build:

94+ ghcversion: 8.0.2

95+

96+ cabal-ghc-7_10_3:

97+ <<: *env

98+ steps:

99+ - cabal_build:

100+ ghcversion: 7.10.3

101+

102+ stack-ghc-8_6:

103+ <<: *env

104+ steps:

105+ - checkout

106+ - *preinstall

107+ - *restore

108+ - run: |

109+ set -e

110+ apt-get install -y ghc-8.6.3

111+ stack update

112+ stack test --system-ghc --ghc-options="${GHC_OPTS} -Werror" .

113+ - *save

63114

64115workflows:

65− version: 2

66− release:

116+ version: "2.1"

117+ build:

67118 jobs:

68− - build:

69− filters:

70− branches:

71− only:

72− - /rc\/.*/

119+ - cabal-ghc-8_6_3

120+ - cabal-ghc-8_4_4

121+ - cabal-ghc-8_2_2

122+ - cabal-ghc-8_0_2

123+ - cabal-ghc-7_10_3

124+ - stack-ghc-8_6

.editorconfig−8

@@ -8,14 +8,6 @@ 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−

1911[*.{markdown,md}]

2012trim_trailing_whitespace = false

2113

.gitattributesdeleted−1

@@ -1 +0,0 @@

1−test/fb2/reader/* -text

.github/FUNDING.ymldeleted−1

@@ -1 +0,0 @@

1−github: [jgm,tarleb]

.github/ISSUE_TEMPLATEnew file+11

@@ -0,0 +1,11 @@

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.mddeleted−25

@@ -1,25 +0,0 @@

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.ymldeleted−9

@@ -1,9 +0,0 @@

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.mddeleted−21

@@ -1,21 +0,0 @@

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.ymldeleted−275

@@ -1,275 +0,0 @@

1−name: CI tests

2−

3−on:

4− push:

5− branches:

6− - '*'

7− - '!rc/*'

8− paths-ignore:

9− - 'doc/**'

10− - 'MANUAL.txt'

11− - '*.md'

12− - 'RELEASE_CHECKLIST'

13− - 'BUGS'

14− - 'changelog'

15− - 'README.template'

16− - 'appveyor.yml'

17− - 'tools/**'

18− - 'linux/**'

19− - 'macos/**'

20− - 'windows/**'

21− - 'man/**'

22− pull_request:

23− paths-ignore:

24− - 'doc/**'

25− - 'MANUAL.txt'

26− - '*.md'

27− - 'RELEASE_CHECKLIST'

28− - 'BUGS'

29− - 'changelog'

30− - 'README.template'

31− - 'appveyor.yml'

32− - 'tools/**'

33− - 'linux/**'

34− - 'macos/**'

35− - 'windows/**'

36− - 'man/**'

37−

38−jobs:

39− linux:

40−

41− runs-on: ubuntu-18.04

42− strategy:

43− fail-fast: true

44− matrix:

45− versions:

46− - ghc: '8.0.2'

47− cabal: '2.4'

48− prefix: 'v2-'

49− cabalopts: ''

50− testopts: ''

51− - ghc: '8.2.2'

52− cabal: '2.4'

53− prefix: 'v2-'

54− cabalopts: ''

55− testopts: ''

56− - ghc: '8.4.4'

57− cabal: '2.4'

58− prefix: 'v2-'

59− cabalopts: '-f-embed_data_files'

60− testopts: ''

61− - ghc: '8.6.5'

62− cabal: '3.2'

63− prefix: ''

64− cabalopts: ''

65− testopts: '--test-option=--hide-successes'

66− - ghc: '8.8.4'

67− cabal: '3.2'

68− prefix: ''

69− cabalopts: ''

70− testopts: '--test-option=--hide-successes'

71− - ghc: '8.10.4'

72− 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'

81− steps:

82− - uses: actions/checkout@v2

83−

84− # needed by memory

85− - name: Install numa

86− run: sudo apt-get install libnuma-dev

87−

88− # need to install older cabal/ghc versions from ppa repository

89−

90− - name: Install recent cabal/ghc

91− uses: haskell/actions/setup@v1

92− with:

93− ghc-version: ${{ matrix.versions.ghc }}

94− cabal-version: ${{ matrix.versions.cabal }}

95−

96− # declare/restore cached things

97− # caching doesn't work for scheduled runs yet

98− # https://github.com/actions/cache/issues/63

99−

100− - name: Cache cabal global package db

101− id: cabal-global

102− uses: actions/cache@v2

103− with:

104− path: |

105− ~/.cabal

106− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}

107−

108− - name: Cache cabal work

109− id: cabal-local

110− uses: actions/cache@v2

111− with:

112− path: |

113− dist-newstyle

114− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local

115−

116− - name: Install dependencies

117− run: |

118− cabal ${{ matrix.versions.prefix }}update

119− cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --dependencies-only --enable-tests --disable-optimization

120−

121− - name: Build and test

122− run: |

123− cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --enable-tests --disable-optimization 2>&1 | tee build.log

124− # fail if warnings in local build

125− ! grep -q ": *[Ww]arning:" build.log || exit 1

126− cabal ${{ matrix.versions.prefix }}test ${{ matrix.versions.cabalopts }} --disable-optimization ${{ matrix.versions.testopts }}

127−

128− windows:

129−

130− runs-on: windows-2019

131−

132− steps:

133− - uses: actions/checkout@v2

134−

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'

140−

141− # declare/restore cached things

142− # caching doesn't work for scheduled runs yet

143− # https://github.com/actions/cache/issues/63

144−

145− - name: Cache stack global package db

146− id: stack-global-package-db

147− uses: actions/cache@v2

148− with:

149− path: |

150− C:\Users\runneradmin\AppData\Roaming\stack\

151− key: ${{ runner.os }}-appdata-roaming-stack-${{ hashFiles('stack.yaml') }}

152−

153− # stack's local package dbs for the project and each package

154− # - name: Cache .stack-work

155− # uses: actions/cache@v1

156− # with:

157− # path: .stack-work

158− # key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}

159− # restore-keys: ${{ runner.os }}-stack-work

160−

161− - name: Install dependencies

162− run: |

163− stack update

164− stack install happy

165− stack test --dependencies-only --fast

166− - name: Build and test

167− shell: cmd

168− run: |

169− stack test --fast --test-arguments=--hide-successes

170−

171− macos:

172−

173− runs-on: macOS-10.15

174− strategy:

175− fail-fast: true

176− matrix:

177− versions:

178− - ghc: '8.8.4'

179− cabal: '3.2'

180−

181− steps:

182− - uses: actions/checkout@v2

183−

184− - name: Install recent cabal/ghc

185− uses: haskell/actions/setup@v1

186− with:

187− ghc-version: ${{ matrix.versions.ghc }}

188− cabal-version: ${{ matrix.versions.cabal }}

189−

190− # declare/restore cached things

191− # caching doesn't work for scheduled runs yet

192− # https://github.com/actions/cache/issues/63

193−

194− - name: Cache cabal global package db

195− id: cabal-global

196− uses: actions/cache@v2

197− with:

198− path: |

199− ~/.cabal

200− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}

201−

202− - name: Cache cabal work

203− id: cabal-local

204− uses: actions/cache@v2

205− with:

206− path: |

207− dist-newstyle

208− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local

209−

210− - name: Install dependencies

211− run: |

212− cabal v2-update

213− cabal v2-build --dependencies-only --enable-tests --disable-optimization

214− - name: Build and test

215− run: |

216− cabal v2-build --enable-tests --disable-optimization 2>&1 | tee build.log

217− # fail if warnings in local build

218− ! grep -q ": *[Ww]arning:" build.log || exit 1

219− 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/commit-validation.ymldeleted−38

@@ -1,38 +0,0 @@

1−name: commit-validation

2−on: [ push, pull_request ]

3−

4−jobs:

5− check-commit-msg-length:

6− runs-on: ubuntu-latest

7− steps:

8− - uses: actions/checkout@v1

9− - name: Check commit message length

10− run: |

11− # Get last commit messages

12− if [ "${{github.event_name}}" = "push" ]; then

13− if [ "${{github.event.before}}" = "0000000000000000000000000000000000000000" ]; then

14− # We are on a new branch

15− current="$(echo '${{github.ref}}' | sed 's!^refs/heads!origin!')"

16− readarray -t other < <(git show-ref | awk -F' ' '{ sub(/^refs\/remotes\//,"",$NF); }($NF != "'"$current"'"){print "^" $NF;}')

17− LOG_RANGE=( "$current" "${other[@]}" )

18− unset current other

19− else

20− # We are on existing branch

21− LOG_RANGE=( "${{github.event.before}}.." )

22− fi

23− elif [ "${{github.event_name}}" = "pull_request" ]; then

24− LOG_RANGE=( "origin/${{github.base_ref}}.." )

25− fi

26− if [[ -v LOG_RANGE ]]; then

27− if git log --no-merges --pretty=format:"%s" "${LOG_RANGE[@]}" -- | grep -qE "^[^#].{78}"; then

28− echo -e "Last commit log contains a line with more than 78 characters:\n"

29− git log --no-merges --pretty=format:"%h: %s" "${LOG_RANGE[@]}" -- | grep -E "^[^:]+: [^#].{78}"

30− echo

31− exit 1

32− else

33− echo "Commit log looks good."

34− fi

35− unset LOG_RANGE

36− else

37− echo "Not checking commits on ${{github.event_name}}"

38− fi

.github/workflows/format-validation.ymldeleted−88

@@ -1,88 +0,0 @@

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.ymldeleted−33

@@ -1,33 +0,0 @@

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.ymldeleted−91

@@ -1,91 +0,0 @@

1−name: Nightly

2−

3−on:

4− schedule:

5− - cron: '53 7 * * *'

6−

7−jobs:

8− linux:

9−

10− runs-on: ubuntu-18.04

11− steps:

12− - 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−

20− - name: Install dependencies

21− run: |

22− ghc --version

23− cabal --version

24− cabal v2-update

25− cabal v2-build --dependencies-only

26− - name: Build

27− run: |

28− cabal v2-install

29− strip $HOME/.cabal/bin/pandoc

30− - name: Install artifact

31− run: |

32− export ARTIFACTS=nightly-linux/pandoc-nightly-linux-$(date +%Y-%m-%d)

33− mkdir -p ${ARTIFACTS}

34− cp $HOME/.cabal/bin/pandoc ${ARTIFACTS}/

35− cp COPYRIGHT ${ARTIFACTS}/

36− echo "Built from ${GITHUB_SHA}" > ${ARTIFACTS}/README.nightly.txt

37− - uses: actions/upload-artifact@master

38− with:

39− name: nightly-linux

40− path: nightly-linux

41−

42− windows:

43−

44− runs-on: windows-2019

45−

46− steps:

47− - uses: actions/checkout@v2

48− - name: Install dependencies

49− run: |

50− stack update

51− stack build --dependencies-only pandoc

52− - name: Build artifacts

53− shell: cmd

54− run: |

55− for /f %%a in ('powershell -Command "Get-Date -format yyyy-MM-dd"') do set THEDATE=%%a

56− set ARTIFACTS=%CD%\nightly-windows\pandoc-nightly-windows-%THEDATE%

57− mkdir %ARTIFACTS%

58− stack build pandoc

59− forfiles /P .\.stack-work\install /M pandoc*.exe /S /C "cmd /C copy @path %%ARTIFACTS%%"

60− copy COPYRIGHT %ARTIFACTS%

61− ren %ARTIFACTS%\COPYRIGHT COPYRIGHT.txt

62− echo Built from %GITHUB_SHA% > %ARTIFACTS%\README.nightly.txt

63− - uses: actions/upload-artifact@master

64− with:

65− name: nightly-windows

66− path: nightly-windows

67−

68− macos:

69−

70− runs-on: macOS-10.15

71−

72− steps:

73− - uses: actions/checkout@v2

74− - name: Install dependencies

75− run: |

76− stack update

77− stack build --dependencies-only pandoc

78− - name: Build artifacts

79− run: |

80− export ARTIFACTS=nightly-macos/pandoc-nightly-macos-$(date +%Y-%m-%d)

81− mkdir -p ${ARTIFACTS}

82− stack build pandoc

83− for f in $(find .stack-work/install -name 'pandoc*' -perm +001 -type f); do cp $f ${ARTIFACTS}/; done

84− mv ${ARTIFACTS}/pandoc ${ARTIFACTS}/pandoc

85− cp COPYRIGHT ${ARTIFACTS}/

86− echo "Built from ${GITHUB_SHA}" > ${ARTIFACTS}/README.nightly.txt

87− - uses: actions/upload-artifact@master

88− with:

89− name: nightly-macos

90− path: nightly-macos

91−

.github/workflows/release-candidate.ymldeleted−83

@@ -1,83 +0,0 @@

1−name: Release candidate

2−

3−on:

4− push:

5− branches:

6− - 'rc/**'

7−

8−jobs:

9− linux:

10−

11− runs-on: ubuntu-18.04

12− steps:

13− - uses: actions/checkout@v1

14− - name: Create linux package

15− run: |

16− make debpkg

17− mkdir linux-release-candidate

18− cp linux/artifacts/*.deb linux-release-candidate/

19− cp linux/artifacts/*.tar.gz linux-release-candidate/

20− - uses: actions/upload-artifact@v2

21− with:

22− name: linux-release-candidate

23− path: linux-release-candidate

24−

25− windows:

26−

27− runs-on: windows-2019

28− strategy:

29− fail-fast: true

30− matrix:

31− versions:

32− - osarch: "windows-x86_64"

33− arch: "x64"

34− stack_opts: "-j1"

35− steps:

36− - uses: actions/checkout@v1

37− - name: Install dependencies

38− run: |

39− stack update

40− stack build ${{ matrix.versions.stack_opts }} --dependencies-only pandoc

41− - name: Create windows package

42− shell: cmd

43− run: |

44− for /f %%a in ('powershell -Command "Get-Date -format yyyy-MM-dd"') do set THEDATE=%%a

45− stack build ${{ matrix.versions.stack_opts }} pandoc

46− for /f "tokens=1-2 delims= " %%a in ('stack exec pandoc -- --version') do (

47− @set VERSION=%%b

48− goto :next

49− )

50− :next

51− if "%VERSION%" == "" (

52− echo Error: could not determine version number.

53− exit /b 1

54− )

55− echo Detected version %VERSION%

56− @set WINDOWS=%CD%\windows

57− @set RELEASE=%WINDOWS%\pandoc-%VERSION%

58− mkdir %RELEASE%

59− forfiles /P .\.stack-work\install /M pandoc.exe /S /C "cmd /C echo @path && echo %%WINDOWS%% && copy @path %%RELEASE%%"

60− stack exec pandoc -- -s --toc MANUAL.txt -o %RELEASE%\MANUAL.html

61− stack exec pandoc -- -s COPYING.md -t rtf -o %RELEASE%\COPYING.rtf

62− copy %RELEASE%\COPYING.rtf %WINDOWS%

63− copy COPYRIGHT %RELEASE%\COPYRIGHT.txt

64− cd windows

65− echo Creating msi...

66− dir

67− @set WIXBIN="c:\Program Files (x86)\WiX Toolset v3.11\bin"

68− @set WORKDIR=%CD%

69− echo Running candle...

70− %WIXBIN%\candle -arch ${{ matrix.versions.arch }} -dVERSION=%VERSION% -dBINPATH=%RELEASE% *.wxs -out wixobj\

71− if %errorlevel% neq 0 exit /b %errorlevel%

72− echo Running light...

73− %WIXBIN%\light -sw1076 -ext WixUIExtension -ext WixUtilExtension -cultures:en-us -loc Pandoc-en-us.wxl -out %WORKDIR%\pandoc-%VERSION%-${{ matrix.versions.osarch }}-UNSIGNED.msi wixobj\*.wixobj

74− 7z a "pandoc-%VERSION%-${{ matrix.versions.osarch }}.zip" pandoc-%VERSION%

75− cd ..

76− mkdir windows-release-candidate

77− copy windows\pandoc-%VERSION%-${{ matrix.versions.osarch }}-UNSIGNED.msi windows-release-candidate

78− copy windows\pandoc-%VERSION%-${{ matrix.versions.osarch }}.zip windows-release-candidate

79− copy windows\Makefile windows-release-candidate

80− - uses: actions/upload-artifact@v2

81− with:

82− name: windows-release-candidate

83− path: windows-release-candidate

.gitignore−10

@@ -1,6 +1,4 @@

11*~

2−.DS_Store

3−*.orig

42deb/.vagrant

53dist/*

64MANUAL.*

@@ -16,10 +14,6 @@ man/man?/*.html

1614*.o

1715*.hi

1816*.pyc

19−.hie/

20−.policeman-evidence/

21−.projectile/

22−.vscode/

2317/COPYING.rtf

2418/COPYRIGHT.txt

2519/cabal-dev/

@@ -29,7 +23,3 @@ windows/*.wixobj

2923data/reference.docx

3024data/reference.odt

3125.stack-work

32−/stack.yaml.lock

33−cabal.project.local

34−/dist-newstyle/

35−pandoc-2*/

.hlint.yaml+54−94

@@ -2,111 +2,71 @@

22# https://github.com/ndmitchell/hlint

33##########################

44

5−# Specify additional command line arguments

6−#

7−- arguments: [--color=auto, --cpp-ansi]

5+# This file contains a template configuration file, which is typically

6+# placed as .hlint.yaml in the root of your project

87

9−# Ignore some builtin hints

10−#

11−- ignore: {name: "Avoid lambda"}

12−- ignore: {name: "Use bimap"}

13−- ignore: {name: "Eta reduce"}

14−- ignore: {name: "Evaluate"}

15−- ignore: {name: "Reduce duplication"} # TODO: could be more fine-grained

16−- ignore: {name: "Use &&&"}

17−- ignore: {name: "Use String"}

18−- ignore: {name: "Use camelCase"}

19−- ignore: {name: "Use fmap"} # specific for GHC 7.8 compat

20−- ignore: {name: "Use isDigit"}

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

428

43−# With recent hlint this rule has given false positives on TH

44−- ignore:

45− name: "Redundant bracket"

9+# Specify additional command line arguments

10+#

11+- arguments: [--color, --cpp-ansi]

4612

4713

48−- ignore:

49− name: "Use <$>"

50− within:

51− - Text.Pandoc.Readers.LaTeX

52− - Text.Pandoc.Readers.Markdown

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

5330

54−- ignore:

55− name: "Use camelCase"

56− within:

57− - Tests.Writers.Docbook

58− - Tests.Writers.Native

59− - Text.Pandoc.Citeproc

60− - Text.Pandoc.Extensions

61− - Text.Pandoc.Lua.Marshaling.Version

62− - Text.Pandoc.Lua.Module.Pandoc

63− - Text.Pandoc.Lua.Module.Utils

64− - Text.Pandoc.Readers.Odt.ContentReader

65− - Text.Pandoc.Readers.Odt.Namespaces

6631

67−- ignore:

68− name: "Use forM_"

69− within:

70− - Text.Pandoc.Readers.DocBook

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}

7136

72−- ignore:

73− name: "Use Just"

74− within:

75− - Text.Pandoc.Citeproc.MetaValue

76− - Text.Pandoc.Readers.Odt.ContentReader

77− - Text.Pandoc.Writers.Roff

7837

79−- ignore:

80− name: "Use list comprehension"

81− within: Text.Pandoc.Citeproc.BibTeX

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}

8248

83−- ignore:

84− name: "Use list literal pattern"

85− within: Text.Pandoc.Citeproc.MetaValue

8649

87−# TODO: check

88−- ignore:

89− name: "Use second"

90− within:

91− - Text.Pandoc.Citeproc.BibTeX

92− - Text.Pandoc.Citeproc.Locator

50+# 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"}

57+- ignore: {name: "Avoid lambda"}

58+- ignore: {name: "Use String"}

59+- ignore: {name: "Use isDigit"}

60+- ignore: {name: "Eta reduce"}

61+- ignore: {name: "Use fmap"} # specific for GHC 7.8 compat

62+- ignore: {name: "Parse error"} # we trust the compiler over HLint

63+- ignore: {name: "Use =="} # Creates infinite loops in `EQ` using expressions

64+- ignore: {name: "Evaluate"}

65+- ignore: {name: "Use &&&"}

66+# - ignore: {name: "Redundant compare"}

9367

94−# TODO: check

95−- ignore:

96− name: "Use sortOn"

97− within: Text.Pandoc.Writers.OpenDocument

68+# Define some custom infix operators

69+# - fixity: infixr 3 ~^#^~

9870

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

10671

107−# fromRight is only in base >= 4.10

108−- ignore:

109− name: "Use fromRight"

11072

111−# Define some custom infix operators

112−# - fixity: infixr 3 ~^#^~

AUTHORS.md+3−111

@@ -1,100 +1,64 @@

11# Contributors

22

33- Anabra

4−- Aner Lucero

54- Arata Mizuki

6−- Arfon Smith

75- Aaron Wolen

86- Albert Krewinkel

97- Alex Ivkin

10−- Alex Toldaiev

118- Alex Vong

129- Alexander Kondratskiy

1310- Alexander Krotov

1411- Alexander Sulfrian

1512- Alexander V Vershilov

16−- Alexandre Franke

1713- Alfred Wechselberger

18−- Amogh Rathore

1914- Anders Waldenborg

2015- Andreas Lööw

2116- Andrew Dunning

22−- Andy Morris

23−- Anti-Distinctlyminty

2417- Antoine Latter

2518- Antonio Terceiro

2619- Arata Mizuki

27−- Arfon Smith

2820- Arlo O'Keeffe

2921- Artyom Kazak

3022- Agustín Martín Barbero

3123- B. Scott Michel

3224- Ben Firshman

3325- Ben Gamari

34−- Ben Steinberg

3526- Beni Cherniavsky-Paskin

3627- Benoit Schweblin

3728- Bjorn Buckwalter

38−- Blake Eryx

39−- Bodigrim

4029- Bradley Kuhn

4130- Brent Yorgey

4231- Brian Leung

4332- Bryan O'Sullivan

4433- Caleb McDaniel

45−- Caleb Mclennan

4634- Calvin Beck

4735- Carlos Sosa

48−- Cécile Chemin

49−- Cédric Couralet

50−- Charanjit Singh

5136- Chris Black

5237- Christian Conkle

53−- Christian Despres

5438- Christoffer Ackelman

5539- Christoffer Sawicki

5640- Clare Macrae

5741- Clint Adams

5842- Conal Elliott

59−- Cormac Relf

6043- Craig S. Bosma

6144- Damien Clochard

6245- Daniel Bergey

63−- Daniel Maslowski

6446- Daniel T. Staal

6547- Daniele D'Orazio

6648- David A Roberts

6749- David Lazar

68−- David Martschenko

6950- David Röthlisberger

7051- Denis Laxalde

71−- Denis Maier

72−- Derek Chen-Becker

73−- Diego Balseiro

74−- Dimitri Sabadie

75−- Dmitry Pogodin

76−- Dmitry Volodin

7752- Douglas Calvert

78−- Eigil Rischel

7953- Emanuel Evans

80−- Emerson Harkin

81−- Emily Bourke

8254- Emily Eisenberg

8355- Eric Kow

84−- Erik Rask

8556- Eric Seidel

86−- Eric Schrijver

87−- Ethan Riley

8857- Étienne Bersac

8958- Felix Yan

90−- Félix Baylac-Jacqué

91−- Florian Beeres

9259- Florian Eitel

93−- Florian Klink

94−- Florian Kohrt

9560- Francesco Occhipinti

9661- François Gannaz

97−- Frederik Elwert

9862- Freiric Barral

9963- Freirich Raabe

10064- Frerich Raabe

@@ -108,39 +72,29 @@

10872- Gwern Branwen

10973- Hamish Mackenzie

11074- Hans-Peter Deifel

111−- Heiko Schlittermann

11275- Henrik Tramberend

11376- Henry de Valence

11477- Hubert Plociniczak

115−- Ian Max Andolina

11678- Igor Khorlo

117−- Igor Pashev

11879- Ilya V. Portnov

11980- Ivan Trubach

12081- Ivo Clarysse

121−- Jared Lander

12282- J. B. Rainsberger

12383- J. Lewis Muir

12484- Jaime Marquínez Ferrándiz

125−- Jake Zimmerman

12685- Jakob Voß

12786- James Aspnes

12887- Jamie F. Olson

12988- Jan Larres

13089- Jan Schulz

131−- Jan Tojnar

132−- Jan-Otto Kröpke

13390- Jason Ronallo

13491- Jeff Arnold

13592- Jeff Runningen

13693- Jens Getreu

13794- Jens Petersen

138−- Jeroen de Haas

139−- Jerry Sky

14095- Jesse Rosenthal

14196- Joe Hermaszewski

14297- Joe Hillenbrand

143−- John KetzerX

14498- John MacFarlane

14599- John Muccigrosso

146100- John Luke Bentley

@@ -150,29 +104,17 @@

150104- Jose Luis Duran

151105- José de Mattos Neto

152106- Josef Svenningsson

153−- Joseph C. Sible

154107- Julien Cretel

155−- Julien Dutant

156−- Juliette Fourcot

157108- Juliusz Gonera

158109- Justin Bogner

159110- Jérémy Bobbio

160−- Karl Pettersson

161111- Keiichiro Shikano

162112- Kelsey Hightower

163113- Kolen Cheung

164114- Konstantin Zudov

165115- Kristof Bastiaensen

166−- Krystof Beuermann

167116- Herwig Stuetz

168117- Lars-Dominik Braun

169−- Laurent P. René de Cotret

170−- Leif Metcalf

171−- Leonard Rosenthol

172−- Lila

173−- Loïc Grobol

174−- Lorenzo

175−- Lucas Escot

176118- Luke Plant

177119- Marc Schreiber

178120- Mark Szepieniec

@@ -182,9 +124,7 @@

182124- Matej Kollar

183125- Mathias Schenner

184126- Mathias Walter

185−- Mathieu Boespflug

186127- Mathieu Duponchelle

187−- Matthew Doty

188128- Matthew Eddey

189129- Matthew Pickering

190130- Matthias C. M. Troffaes

@@ -194,38 +134,26 @@

194134- Merijn Verstraaten

195135- Michael Beaumont

196136- Michael Chladek

197−- Michael Hoffmann

198−- Michael Peyton Jones

199−- Michael Reed

200137- Michael Snoyman

201138- Michael Thompson

202−- Mike Tzou

203139- MinRK

204140- Morton Fox

205141- Nathan Gass

206142- Neil Mayhew

207143- Nick Bart

208−- Nick Berendsen

209144- Nick Fleisher

210145- Nicolas Kaiser

211146- Nikolay Yakimov

212147- Nils Carlson

213−- Nixon Enraght-Moony

214148- Nokome Bentley

215−- Ole Martin Ruud

216149- Oliver Matthews

217150- Ophir Lifshitz

218151- Or Neeman

219152- OvidiusCicero

220−- Owen McGrath

221153- Pablo Rodríguez

222−- Pascal Wagler

223−- Paul Tilley

224154- Paul Rivier

225155- Paulo Tanimoto

226−- Pete Ryland

227156- Peter Wang

228−- Philip Pesca

229157- Philippe Ombredanne

230158- Phillip Alday

231159- Prayag Verma

@@ -235,9 +163,7 @@

235163- Raymond Ehlers

236164- Recai Oktaş

237165- Roland Hieber

238−- Roman Beránek

239166- RyanGlScott

240−- Salim B

241167- Sascha Wilde

242168- Scott Morrison

243169- Sebastian Talmon

@@ -245,15 +171,11 @@

245171- Sergey Astanin

246172- Shahbaz Youssefi

247173- Shaun Attfield

248−- Shim Myeongseob

249−- Shin Sang-jae

250174- Sidarth Kapur

251175- Sidharth Kapur

252176- Simon Hengel

253177- Stefan Dresselhaus

254178- Sumit Sahrawat

255−- Tarik Graba

256−- Tatiana Porras

257179- Thenaesh Elango

258180- Thomas Hodgson

259181- Thomas Weißschuh

@@ -263,53 +185,30 @@

263185- Tiziano Müller

264186- Todd Sifleet

265187- Tom Leese

266−- Tristan de Cacqueray

267−- Tristan Stenner

268188- Uli Köhler

269−- Urs Liska

270189- Václav Zeman

271−- Václav Haisman

272−- Vaibhav Sagar

273−- Vanessa McHale

274−- Vasily Alferov

275190- Viktor Kronvall

276191- Vincent

277−- Vlad Hanciuta

192+- Václav Haisman

193+- Václav Zeman

278194- Wandmalfarbe

279195- Waldir Pimenta

280196- Wikiwide

281−- Winnie Hellmann

282197- Xavier Olive

283198- Yan Pashkovsky

284199- Yoan Blanc

285200- Yuchen Pei

286−- Zihang Chen

287−- a-vrma

288−- andrebauer

289−- argent0

290−- badumont

291−- blmage

292201- bucklereed

293202- bumper314

294−- chinapedia

295−- cholonam

296203- csforste

297−- dbecher-ito

298204- d-dorazio

299−- ebiim

300−- favonia

205+- iandol

301206- infinity0x

302−- jeongminkim-islab

303207- kaizshang91

304208- lux-lth

305209- lwolfsonkin

306−- mbrackeantidot

307210- nkalvi

308−- niszet

309−- nuew

310−- obcat

311211- oltolm

312−- oquechy

313212- quasicomputational

314213- qerub

315214- robabla

@@ -318,13 +217,6 @@

318217- rski

319218- shreevatsa.public

320219- takahashim

321−- taotieren

322−- tecosaur

323−- TEC

324220- tgkokk

325−- the-solipsist

326−- timo-a

327221- thsutton

328−- vijayphoenix

329222- wiefling

330−- wuffi

CONTRIBUTING.md+30−167

@@ -1,64 +1,6 @@

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−

624Have a question?

635----------------

646

@@ -68,21 +10,15 @@ Ask on [pandoc-discuss].

6810Found a bug?

6911------------

7012

71−Bug reports are welcome! Please report all bugs on pandoc's GitHub

13+Bug reports are welcome! Please report all bugs on pandoc's github

7214[issue tracker].

7315

7416Before you submit a bug report, search the [open issues] *and* [closed issues]

7517to make sure the issue hasn't come up before. Also, check the [User's Guide] and

7618[FAQs] for anything relevant.

7719

78−Make sure you can reproduce the bug with the [latest released

79−version] of pandoc---or, even better, the development version,

80−since the bug may have been fixed since the last release.

81−[Nightly builds] are available, so you don't need to compile

82−from source to test against the development version.

83−(To fetch a nightly, visit the link, click the topmost "Nightly"

84−in the table, then choose your platform under "Artifacts." Note

85−that you must be logged in with a GitHub account.)

20+Make sure you can reproduce the bug with the [latest released version] of pandoc

21+(or, even better, the [development version]).

8622

8723Your report should give detailed, *reproducible* instructions, including

8824

@@ -163,12 +99,7 @@ Explain the rationale for the feature you're requesting. Why would this

16399feature be useful? Consider also any possible drawbacks, including backwards

164100compatibility, new library dependencies, and performance issues.

165101

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]

102+It is best to discuss a potential new feature on [pandoc-discuss]

172103before opening an issue.

173104

174105Patches and pull requests

@@ -213,9 +144,10 @@ Please follow these guidelines:

2131449. It is better not to introduce new dependencies. Dependencies on

214145 external C libraries should especially be avoided.

215146

216−10. We aim for compatibility with ghc versions from 8.0 to the

147+10. We aim for compatibility with ghc versions from 7.10.3 to the

217148 latest release. All pull requests and commits are tested

218− automatically on GitHub Actions.

149+ automatically on <travis-ci.org>, using GHC versions in the

150+ `Tested-With` stanza of `pandoc.cabal`.

219151

220152Tests

221153-----

@@ -234,77 +166,6 @@ or, if you're using [stack],

234166

235167The test program is `test/test-pandoc.hs`.

236168

237−To run particular tests (pattern-matching on their names), use

238−the `-p` option:

239−

240− cabal install pandoc --enable-tests

241− cabal test --test-options='-p markdown'

242−

243−Or with stack:

244−

245− stack test --test-arguments='-p markdown'

246−

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

257−

258−If you add a new feature to pandoc, please add tests as well, following

259−the pattern of the existing tests. The test suite code is in

260−`test/test-pandoc.hs`. If you are adding a new reader or writer, it is

261−probably easiest to add some data files to the `test` directory, and

262−modify `test/Tests/Old.hs`. Otherwise, it is better to modify the module

263−under the `test/Tests` hierarchy corresponding to the pandoc module you

264−are changing. Alternatively, you may add a "command test" to

265−the `/test/command/` hierarchy, following the pattern of the tests there.

266−These test files should have a meaningful name, which can include the issue

267−number and/or the feature that's being tested. For example, `5474-tables.md`

268−refers to both issue and feature.

269−

270−You can rebuild the golden tests in `tests/` by passing

271−`--accept` to the test script. (If you're using stack, `stack

272−test --test-arguments "--accept"`; or `make TESTARGS=--accept`).

273−Then check the changed golden files for accuracy, and

274−commit the changes. For docx or pptx tests, open the files in Word

275−or Powerpoint to ensure that they weren't corrupted and that

276−they had the expected result, and mention the Word/Powerpoint

277−version and OS in your commit comment.

278−

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−

308169Benchmarks

309170----------

310171

@@ -318,6 +179,10 @@ With stack:

318179

319180 stack bench

320181

182+You can also build pandoc with the `weigh-pandoc` flag and

183+run `weigh-pandoc` to get some statistics on memory usage.

184+(Eventually this should be incorporated into the benchmark

185+suite.)

321186

322187Using the REPL

323188--------------

@@ -329,10 +194,10 @@ a ghci REPL for working with pandoc. With [stack], use

329194We recommend using the following `.ghci` file (which can be

330195placed in the source directory):

331196

332− :set -fobject-code

333− :set -XTypeSynonymInstances

334− :set -XScopedTypeVariables

335− :set -XOverloadedStrings

197+ :set -fobject-code

198+ :set -XTypeSynonymInstances

199+ :set -XScopedTypeVariables

200+ :set -XOverloadedStrings

336201

337202Profiling

338203---------

@@ -376,7 +241,7 @@ The code

376241--------

377242

378243Pandoc has a publicly accessible git repository on

379−GitHub: <https://github.com/jgm/pandoc>. To get a local copy of the source:

244+github: <http://github.com/jgm/pandoc>. To get a local copy of the source:

380245

381246 git clone https://github.com/jgm/pandoc.git

382247

@@ -386,7 +251,7 @@ the pandoc library is in `src/`, the source for the tests is in

386251

387252The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and

388253`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can

389−be found in <https://github.com/jgm/pandoc-types>.

254+be found in <http://github.com/jgm/pandoc-types>.

390255

391256To build pandoc, you will need a working installation of the

392257[Haskell platform].

@@ -406,11 +271,11 @@ The library is structured as follows:

406271 tree automatically.

407272 - `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*`

408273 are the writers.

409− - `Text.Pandoc.Citeproc.*` contain the code for citation handling,

410− including an interface to the [citeproc] library.

274+ - `Text.Pandoc.Biblio` is a utility module for formatting citations

275+ using citeproc-hs.

411276 - `Text.Pandoc.Data` is used to embed data files when the `embed_data_files`

412− cabal flag is used.

413− - `Text.Pandoc.Emoji` is a thin wrapper around [emojis].

277+ cabal flag is used. It is generated from `src/Text/Pandoc/Data.hsb` using

278+ the preprocessor [hsb2hs].

414279 - `Text.Pandoc.Highlighting` contains the interface to the

415280 skylighting library, which is used for code syntax highlighting.

416281 - `Text.Pandoc.ImageSize` is a utility module containing functions for

@@ -421,6 +286,7 @@ The library is structured as follows:

421286 - `Text.Pandoc.PDF` contains functions for producing a PDF from a

422287 LaTeX source.

423288 - `Text.Pandoc.Parsing` contains parsing functions used in multiple readers.

289+ - `Text.Pandoc.Pretty` is a pretty-printing library specialized to

424290 the needs of pandoc.

425291 - `Text.Pandoc.SelfContained` contains functions for making an HTML

426292 file "self-contained," by importing remotely linked images, CSS,

@@ -447,18 +313,14 @@ you may want to consider submitting a pull request to the

447313[open issues]: https://github.com/jgm/pandoc/issues

448314[closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed

449315[latest released version]: https://github.com/jgm/pandoc/releases/latest

450−[Nightly builds]: https://github.com/jgm/pandoc/actions?query=workflow%3ANightly

451−[pandoc-discuss]: https://groups.google.com/group/pandoc-discuss

316+[development version]: https://github.com/pandoc-extras/pandoc-nightly/releases/latest

317+[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss

452318[issue tracker]: https://github.com/jgm/pandoc/issues

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

319+[User's Guide]: http://pandoc.org/MANUAL.html

320+[FAQs]: http://pandoc.org/faqs.html

321+[EditorConfig]: http://editorconfig.org/

322+[Haskell platform]: http://www.haskell.org/platform/

323+[hsb2hs]: http://hackage.haskell.org/package/hsb2hs

462324[GitHub labels]: https://github.com/jgm/pandoc/labels

463325[good first issue]:https://github.com/jgm/pandoc/labels/good%20first%20issue

464326[enhancement]: https://github.com/jgm/pandoc/labels/enhancement

@@ -473,3 +335,4 @@ you may want to consider submitting a pull request to the

473335[status:more-discussion-needed]: https://github.com/jgm/pandoc/labels/status:more-discussion-needed

474336[status:more-info-needed]: https://github.com/jgm/pandoc/labels/status:more-info-needed

475337[stack]: https://github.com/commercialhaskell/stack

338+

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](https://www.gnu.org/licenses/lgpl.html) instead of this

360+License](http://www.gnu.org/licenses/lgpl.html) instead of this

361361License.

COPYRIGHT+27−34

@@ -1,5 +1,5 @@

11Pandoc

2−Copyright (C) 2006-2021 John MacFarlane <jgm at berkeley dot edu>

2+Copyright (C) 2006-2019 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]: https://www.gnu.org/copyleft/gpl.html

25+[GPL]: http://www.gnu.org/copyleft/gpl.html

2626

2727Pandoc's complete source code is available from the [Pandoc home page].

2828

29−[Pandoc home page]: https://pandoc.org

29+[Pandoc home page]: http://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-2021, John MacFarlane

40+Copyright (c) 2006-2019, John MacFarlane

4141

4242All rights reserved.

4343

@@ -73,29 +73,29 @@ 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--2021, John MacFarlane

76+Copyright (c) 2014--2019, John MacFarlane

7777

7878----------------------------------------------------------------------

7979src/Text/Pandoc/Writers/Muse.hs

80−Copyright (C) 2017-2020 Alexander Krotov

80+Copyright (C) 2017-2019 Alexander Krotov

8181

8282Released under the GNU General Public License version 2 or later.

8383

8484----------------------------------------------------------------------

8585src/Text/Pandoc/Writers/Texinfo.hs

86−Copyright (C) 2008-2021 John MacFarlane and Peter Wang

86+Copyright (C) 2008-2019 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-2021 Andrea Rossato and John MacFarlane

92+Copyright (C) 2008-2019 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-2021 Puneeth Chaganti, John MacFarlane, and

98+Copyright (C) 2010-2019 Puneeth Chaganti, John MacFarlane, and

9999 Albert Krewinkel

100100

101101Released under the GNU General Public License version 2 or later.

@@ -109,13 +109,13 @@ Released under the GNU General Public License version 2 or later.

109109----------------------------------------------------------------------

110110src/Text/Pandoc/Readers/Docx.hs

111111src/Text/Pandoc/Readers/Docx/*

112−Copyright (C) 2014-2020 Jesse Rosenthal

112+Copyright (C) 2014-2019 Jesse Rosenthal

113113

114114Released under the GNU General Public License version 2 or later.

115115

116116----------------------------------------------------------------------

117117src/Text/Pandoc/Readers/Textile.hs

118−Copyright (C) 2010-2021 Paul Rivier and John MacFarlane

118+Copyright (C) 2010-2019 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-2021 Matthew Pickering and John MacFarlane

136+Copyright (C) 2014-2018 Matthew Pickering

137137

138138Released under the GNU General Public License version 2 or later.

139139

@@ -141,49 +141,33 @@ 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-2021 Albert Krewinkel

145−

146−Released under the GNU General Public License version 2 or later.

147−

148−----------------------------------------------------------------------

149−src/Text/Pandoc/Lua.hs

150−src/Text/Pandoc/Lua/*

151−test/lua/*

152−Copyright (C) 2017--2021 Albert Krewinkel and John MacFarlane

153−

154−Released under the GNU General Public License version 2 or later.

155−

156−----------------------------------------------------------------------

157−src/Text/Pandoc/Readers/Jira.hs

158−src/Text/Pandoc/Writers/Jira.hs

159−test/Tests/Readers/Jira.hs

160−Copyright (C) 2019--2021 Albert Krewinkel

144+Copyright (C) 2014-2019 Albert Krewinkel

161145

162146Released under the GNU General Public License version 2 or later.

163147

164148----------------------------------------------------------------------

165149src/Text/Pandoc/Readers/FB2.hs

166−Copyright (C) 2018--2019 Alexander Krotov

150+Copyright (C) 2018 Alexander Krotov

167151

168152Released under the GNU General Public License version 2 or later.

169153

170154----------------------------------------------------------------------

171155data/pandoc.lua

172−Copyright (C) 2017-2021 Albert Krewinkel

156+Copyright (C) 2017-2019 Albert Krewinkel

173157

174158Released under the GNU General Public License version 2 or later.

175159

176160----------------------------------------------------------------------

177161The dzslides template contains JavaScript and CSS from Paul Rouget's

178162dzslides template.

179−https://github.com/paulrouget/dzslides

163+http://github.com/paulrouget/dzslides

180164

181165Released under the Do What the Fuck You Want To Public License.

182166

183167------------------------------------------------------------------------

184−Pandoc embeds a Lua interpreter (via hslua).

168+Pandoc embeds a lua interpreter (via hslua).

185169

186−Copyright © 1994–2020 Lua.org, PUC-Rio.

170+Copyright © 1994–2017 Lua.org, PUC-Rio.

187171

188172Permission is hereby granted, free of charge, to any person obtaining

189173a copy of this software and associated documentation files (the

@@ -203,3 +187,12 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

203187LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

204188OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

205189WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

190+

191+------------------------------------------------------------------------

192+The template pandoc.jats is Copyright 2013--15 Martin Fenner,

193+released under GPL version 2 or later.

194+

195+The file data/jats.csl is derived from a csl file by Martin Fenner,

196+revised by Martin Paul Eve and then John MacFarlane.

197+"This work is licensed under a Creative Commons Attribution-ShareAlike 3.0

198+License. Originally by Martin Fenner."

INSTALL.md+108−122

@@ -12,116 +12,118 @@ under the heading for your operating system.

1212

1313## Windows

1414

15−There is a package installer at pandoc's [download page].

16−This will install pandoc, replacing older versions, and

17−update your path to include the directory where pandoc's

18−binaries are installed.

15+ - There is a package installer at pandoc's [download page].

16+ This will install pandoc, replacing older versions, and

17+ update your path to include the directory where pandoc's

18+ binaries are installed.

1919

20−If you prefer not to use the msi installer, we also provide

21−a zip file that contains pandoc's binaries and

22−documentation. Simply unzip this file and move the binaries

23−to a directory of your choice.

20+ - If you prefer not to use the msi installer, we also provide

21+ a zip file that contains pandoc's binaries and

22+ documentation. Simply unzip this file and move the binaries

23+ to a directory of your choice.

2424

25−Alternatively, you can install pandoc using

26−[Chocolatey](https://chocolatey.org):

25+ - Alternatively, you can install pandoc using

26+ [Chocolatey](https://chocolatey.org):

2727

28− choco install pandoc

28+ choco install pandoc

2929

30−Chocolatey can also install other software that integrates with Pandoc.

31−For example, to install `rsvg-convert` (from [librsvg], covering formats

32−without SVG support), [Python] (to use Pandoc filters), and

33−[MiKTeX] (to typeset PDFs with [LaTeX]):

30+ Chocolatey can also install other software that integrates with Pandoc.

31+ For example, to install `rsvg-convert` (from [librsvg], covering formats

32+ without SVG support), [Python] (to use Pandoc filters), and

33+ [MiKTeX] (to typeset PDFs with [LaTeX]):

3434

35− choco install rsvg-convert python miktex

35+ 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−

41−By default, Pandoc creates PDFs using LaTeX.

42−We recommend installing it via [MiKTeX].

37+ - By default, Pandoc creates PDFs using LaTeX.

38+ We recommend installing it via [MiKTeX].

4339

4440## macOS

4541

46−There is a package installer at pandoc's [download page].

47−If you later want to uninstall the package, you can do so

48−by downloading [this script][uninstaller]

49−and running it with `perl uninstall-pandoc.pl`.

42+ - There is a package installer at pandoc's [download page].

43+ If you later want to uninstall the package, you can do so

44+ by downloading [this script][uninstaller]

45+ and running it with `perl uninstall-pandoc.pl`.

46+

47+ - Alternatively, you can install pandoc using

48+ [Homebrew](http://brew.sh):

5049

51−Alternatively, you can install pandoc using

52−[Homebrew](https://brew.sh):

50+ brew install pandoc

5351

54− brew install pandoc

52+ To include pandoc's citation parser:

5553

56−Homebrew can also install other software that integrates with Pandoc.

57−For example, to install [librsvg] (its `rsvg-convert` covers formats

58−without SVG support), [Python] (to use Pandoc filters), and

59−[BasicTeX] (to typeset PDFs with [LaTeX]):

54+ brew install pandoc-citeproc

6055

61− brew install librsvg python homebrew/cask/basictex

56+ Homebrew can also install other software that integrates with Pandoc.

57+ For example, to install [librsvg] (its `rsvg-convert` covers formats

58+ without SVG support), [Python] (to use Pandoc filters), and

59+ [BasicTeX] (to typeset PDFs with [LaTeX]):

6260

63−Note: On unsupported versions of macOS (more than three releases old),

64−Homebrew installs from source, which takes additional time and disk space

65−for the `ghc` compiler and dependent Haskell libraries.

61+ brew install librsvg python homebrew/cask/basictex

6662

67−We also provide a zip file containing the binaries and man

68−pages, for those who prefer not to use the installer. Simply

69−unzip the file and move the binaries and man pages to

70−whatever directory you like.

63+ Note: On unsupported versions of macOS (more than three releases old),

64+ Homebrew installs from source, which takes additional time and disk space

65+ for the `ghc` compiler and dependent Haskell libraries.

7166

72−By default, Pandoc creates PDFs using LaTeX. Because a full [MacTeX]

73−installation uses four gigabytes of disk space, we recommend

74−[BasicTeX] or [TinyTeX](https://yihui.org/tinytex/)

75−and using the `tlmgr` tool to install additional packages

76−as needed. If you receive errors warning of fonts not found:

67+ - We also provide a zip file containing the binaries and man

68+ pages, for those who prefer not to use the installer. Simply

69+ unzip the file and move the binaries and man pages to

70+ whatever directory you like.

7771

78− tlmgr install collection-fontsrecommended

72+ - By default, Pandoc creates PDFs using LaTeX. Because a full [MacTeX]

73+ installation uses four gigabytes of disk space, we recommend

74+ [BasicTeX] or [TinyTeX](https://yihui.name/tinytex/)

75+ and using the `tlmgr` tool to install additional packages

76+ as needed. If you receive errors warning of fonts not found:

77+

78+ tlmgr install collection-fontsrecommended

7979

8080## Linux

8181

82−Check whether the pandoc version in your package manager is

83−not outdated. Pandoc is in the [Debian], [Ubuntu], [Slackware],

84−[Arch], [Fedora], [NiXOS], [openSUSE], [gentoo] and [Void] repositories.

82+ - Check whether the pandoc version in your package manager is

83+ not outdated. Pandoc is in the [Debian], [Ubuntu], [Slackware],

84+ [Arch], [Fedora], [NiXOS], [openSUSE], and [gentoo] repositories.

8585

86−To get the latest release, we provide a binary package for amd64

87−architecture on the **[download page]**.

86+ - To get the latest release, we provide a binary package for amd64

87+ architecture on the **[download page]**.

8888

89−The executable is statically linked and

90−has no dynamic dependencies or dependencies on external

91−data files. Note: because of the static

92−linking, the pandoc binary from this package cannot use lua

93−filters that require external lua modules written in C.

89+ This provides both `pandoc` and `pandoc-citeproc`.

90+ The executables are statically linked and

91+ have no dynamic dependencies or dependencies on external

92+ data files. Note: because of the static

93+ linking, the pandoc binary from this package cannot use lua

94+ filters that require external lua modules written in C.

9495

95−Both a tarball and a deb installer are provided. To install the deb:

96+ Both a tarball and a deb installer are provided. To install the deb:

9697

97− sudo dpkg -i $DEB

98+ sudo dpkg -i $DEB

9899

99−where `$DEB` is the path to the downloaded deb. This will

100−install the `pandoc` executable and man page.

100+ where `$DEB` is the path to the downloaded deb. This will

101+ install the `pandoc` and `pandoc-citeproc` executables and

102+ man pages.

101103

102−If you use an RPM-based distro, you may be able to install

103−the deb from our download page using `alien`.

104+ If you use an RPM-based distro, you may be able to install

105+ the deb from our download page using `alien`.

104106

105−On any distro, you may install from the tarball into `$DEST`

106−(say, `/usr/local/` or `$HOME/.local`) by doing

107+ On any distro, you may install from the tarball into `$DEST`

108+ (say, `/usr/local/` or `$HOME/.local`) by doing

107109

108− tar xvzf $TGZ --strip-components 1 -C $DEST

110+ tar xvzf $TGZ --strip-components 1 -C $DEST

109111

110−where `$TGZ` is the path to the downloaded zipped tarball.

111−For Pandoc versions before 2.0, which don't provide

112−a tarball, try instead

112+ where `$TGZ` is the path to the downloaded zipped tarball.

113+ For Pandoc versions before 2.0, which don't provide

114+ a tarball, try instead

113115

114− ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST

116+ ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST

115117

116−You can also install from source, using the

117−instructions below under [Compiling from source].

118−Note that most distros have the Haskell platform in their

119−package repositories. For example, on Debian/Ubuntu,

120−you can install it with `apt-get install haskell-platform`.

118+ - You can also install from source, using the

119+ instructions below under [Compiling from source].

120+ Note that most distros have the Haskell platform in their

121+ package repositories. For example, on Debian/Ubuntu,

122+ you can install it with `apt-get install haskell-platform`.

121123

122−For PDF output, you'll need LaTeX. We recommend installing

123−[TeX Live](https://www.tug.org/texlive/) via your package

124−manager. (On Debian/Ubuntu, `apt-get install texlive`.)

124+ - For PDF output, you'll need LaTeX. We recommend installing

125+ [TeX Live](http://www.tug.org/texlive/) via your package

126+ manager. (On Debian/Ubuntu, `apt-get install texlive`.)

125127

126128## Chrome OS

127129

@@ -138,30 +140,7 @@ device you are using.

138140

139141## BSD

140142

141−Pandoc is in the [NetBSD] and [FreeBSD ports] repositories.

142−

143−## Docker

144−

145−The official Docker images for pandoc can be found at

146−<https://github.com/pandoc/dockerfiles> and at

147−[dockerhub](https://hub.docker.com/).

148−

149−The [pandoc/core](https://hub.docker.com/r/pandoc/core)

150−image contains `pandoc`.

151−

152−The [pandoc/latex](https://hub.docker.com/r/pandoc/latex)

153−image also contains the minimal LaTeX installation needed

154−to produce PDFs using pandoc.

155−

156−To run pandoc using Docker, converting `README.md` to `README.pdf`:

157−

158− docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` pandoc/latex README.md -o README.pdf

159−

160−## GitHub Actions

161−

162−Pandoc can be run through

163−[GitHub Actions](https://github.com/features/actions). For some

164−examples, see <https://github.com/pandoc/pandoc-action-example>.

143+ - Pandoc is in the [NetBSD] and [FreeBSD ports] repositories.

165144

166145## Compiling from source

167146

@@ -242,30 +221,37 @@ The easiest way to build pandoc from source is to use [stack][stack]:

242221

243222 pandoc --help

244223

245− [Not sure where `$CABALDIR` is?](https://wiki.haskell.org/Cabal-Install#The_cabal-install_configuration_file)

224+ [Not sure where `$CABALDIR` is?](http://www.haskell.org/haskellwiki/Cabal-Install#The_cabal-install_configuration_file)

246225

247−5. By default `pandoc` uses the "i;unicode-casemap" method

226+5. If you want to process citations with pandoc, you will also need to

227+ install a separate package, `pandoc-citeproc`. This can be installed

228+ using cabal:

229+

230+ cabal install pandoc-citeproc

231+

232+ By default `pandoc-citeproc` uses the "i;unicode-casemap" method

248233 to sort bibliography entries (RFC 5051). If you would like to

249234 use the locale-sensitive unicode collation algorithm instead,

250− specify the `icu` flag (which affects the dependency `citeproc`):

235+ specify the `unicode_collation` flag:

251236

252− cabal install pandoc -ficu

237+ cabal install pandoc-citeproc -funicode_collation

253238

254239 Note that this requires the `text-icu` library, which in turn

255240 depends on the C library `icu4c`. Installation directions

256241 vary by platform. Here is how it might work on macOS with Homebrew:

257242

258243 brew install icu4c

259− stack install pandoc \

260− --flag "citeproc:icu" \

261− --extra-lib-dirs=/usr/local/opt/icu4c/lib \

262− --extra-include-dirs=/usr/local/opt/icu4c/include

244+ cabal install --extra-lib-dirs=/usr/local/Cellar/icu4c/51.1/lib \

245+ --extra-include-dirs=/usr/local/Cellar/icu4c/51.1/include \

246+ -funicode_collation text-icu pandoc-citeproc

263247

2642486. The `pandoc.1` man page will be installed automatically. cabal shows

265249 you where it is installed: you may need to set your `MANPATH`

266250 accordingly. If `MANUAL.txt` has been modified, the man page can be

267251 rebuilt: `make man/pandoc.1`.

268252

253+ The `pandoc-citeproc.1` man page will also be installed automatically.

254+

269255

270256### Custom cabal method

271257

@@ -387,29 +373,29 @@ To run just the markdown benchmarks:

387373

388374

389375[Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/

390−[Cabal User's Guide]: https://cabal.readthedocs.io/

376+[Cabal User's Guide]: http://www.haskell.org/cabal/release/latest/doc/users-guide/builders.html#setup-configure-paths

391377[Debian]: https://packages.debian.org/pandoc

392378[Fedora]: https://apps.fedoraproject.org/packages/pandoc

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

379+[FreeBSD ports]: http://www.freshports.org/textproc/pandoc/

380+[GHC]: http://www.haskell.org/ghc/

381+[GPL]: http://www.gnu.org/copyleft/gpl.html

382+[Haskell platform]: http://hackage.haskell.org/platform/

383+[MacPorts]: http://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile

397384[MacTeX]: https://tug.org/mactex/

398−[BasicTeX]: https://www.tug.org/mactex/morepackages.html

385+[BasicTeX]: http://www.tug.org/mactex/morepackages.html

399386[LaTeX]: https://www.latex-project.org

400−[MiKTeX]: https://miktex.org/

387+[MiKTeX]: http://miktex.org/

401388[librsvg]: https://wiki.gnome.org/Projects/LibRsvg

402389[Python]: https://www.python.org

403−[NetBSD]: https://pkgsrc.se/wip/pandoc

390+[NetBSD]: http://pkgsrc.se/wip/pandoc

404391[NixOS]: https://nixos.org/nixos/packages.html

405392[Slackware]: https://www.slackbuilds.org/result/?search=pandoc&sv=

406393[Ubuntu]: https://packages.ubuntu.com/pandoc

407394[download page]: https://github.com/jgm/pandoc/releases/latest

408−[gentoo]: https://packages.gentoo.org/package/app-text/pandoc

395+[gentoo]: http://packages.gentoo.org/package/app-text/pandoc

409396[haskell repository]: https://wiki.archlinux.org/index.php/Haskell_Package_Guidelines#.5Bhaskell.5D

410397[openSUSE]: https://software.opensuse.org/package/pandoc

411−[source tarball]: https://hackage.haskell.org/package/pandoc

398+[source tarball]: http://hackage.haskell.org/package/pandoc

412399[stack]: https://docs.haskellstack.org/en/stable/install_and_upgrade.html

413−[cabal-install]: https://hackage.haskell.org/package/cabal-install

414−[Void]: https://voidlinux.org/

400+[cabal-install]: http://hackage.haskell.org/package/cabal-install

415401[uninstaller]: https://raw.githubusercontent.com/jgm/pandoc/master/macos/uninstall-pandoc.pl

MANUAL.txt+1105−2414

@@ -1,14 +1,14 @@

1−---

2−title: Pandoc User's Guide

3−author: John MacFarlane

4−date: June 20, 2021

5−---

1+% Pandoc User's Guide

2+% John MacFarlane

3+% January 30, 2019

64

7−# Synopsis

5+Synopsis

6+========

87

98`pandoc` [*options*] [*input-file*]...

109

11−# Description

10+Description

11+===========

1212

1313Pandoc is a [Haskell] library for converting from one markup format to

1414another, and a command-line tool that uses this library.

@@ -40,7 +40,8 @@ model. While conversions from pandoc's Markdown to all formats aspire

4040to be perfect, conversions from formats more expressive than pandoc's

4141Markdown can be expected to be lossy.

4242

43−## Using pandoc

43+Using pandoc

44+------------

4445

4546If no *input-files* are specified, input is read from *stdin*.

4647Output goes to *stdout* by default. For output to a file,

@@ -61,7 +62,8 @@ If multiple input files are given, `pandoc` will concatenate them all (with

6162blank lines between them) before parsing. (Use `--file-scope` to parse files

6263individually.)

6364

64−## Specifying formats

65+Specifying formats

66+------------------

6567

6668The format of the input and output can be specified explicitly using

6769command-line options. The input format can be specified using the

@@ -93,7 +95,8 @@ If no input file is specified (so that input comes from *stdin*), or

9395if the input files' extensions are unknown, the input format will

9496be assumed to be Markdown.

9597

96−## Character encoding

98+Character encoding

99+------------------

97100

98101Pandoc uses the UTF-8 character encoding for both input and output.

99102If your local character encoding is not UTF-8, you

@@ -106,9 +109,10 @@ RTF, OPML, DocBook, and Texinfo), information about

106109the character encoding is included in the document header, which

107110will only be included if you use the `-s/--standalone` option.

108111

109−[`iconv`]: https://www.gnu.org/software/libiconv/

112+[`iconv`]: http://www.gnu.org/software/libiconv/

110113

111−## Creating a PDF

114+Creating a PDF

115+--------------

112116

113117To produce a PDF, specify an output file with a `.pdf` extension:

114118

@@ -116,18 +120,17 @@ To produce a PDF, specify an output file with a `.pdf` extension:

116120

117121By default, pandoc will use LaTeX to create the PDF, which requires

118122that a LaTeX engine be installed (see `--pdf-engine` below).

119−Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an

120−intermediate format. To do this, specify an output file with a

121−`.pdf` extension, as before, but add the `--pdf-engine` option

122−or `-t context`, `-t html`, or `-t ms` to the command line.

123−The tool used to generate the PDF from the intermediate format

124−may be specified using `--pdf-engine`.

125−

126−You can control the PDF style using variables, depending on

127−the intermediate format used: see [variables for LaTeX],

128−[variables for ConTeXt], [variables for `wkhtmltopdf`],

129−[variables for ms]. When HTML is used as an intermediate

130−format, the output can be styled using `--css`.

123+

124+Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the

125+following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],

126+[`weasyprint`] or [`prince`].

127+To do this, specify an output file with a `.pdf` extension, as before,

128+but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`

129+to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).

130+

131+PDF output uses [variables for LaTeX] (with a LaTeX engine);

132+[variables for ConTeXt] (with ConTeXt); or [variables for `wkhtmltopdf`]

133+(an HTML/CSS-to-PDF engine; `--css` also affects the output).

131134

132135To debug the PDF creation, it can be useful to look at the intermediate

133136representation: instead of `-o test.pdf`, use for example `-s -o test.tex`

@@ -136,32 +139,33 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.

136139When using LaTeX, the following packages need to be available

137140(they are included with all recent versions of [TeX Live]):

138141[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],

139−[`iftex`], [`listings`] (if the

142+[`ifxetex`], [`ifluatex`], [`listings`] (if the

140143`--listings` option is used), [`fancyvrb`], [`longtable`],

141−[`booktabs`], [`graphicx`] (if the document

144+[`booktabs`], [`graphicx`] and [`grffile`] (if the document

142145contains images), [`hyperref`], [`xcolor`],

143146[`ulem`], [`geometry`] (with the `geometry` variable set),

144147[`setspace`] (with `linestretch`), and

145148[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as

146−the PDF engine requires [`fontspec`]. `lualatex` uses

147−[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),

148−[`xecjk`], and [`bidi`] (with the `dir` variable set). If the

149−`mathspec` variable is set, `xelatex` will use [`mathspec`]

150−instead of [`unicode-math`]. The [`upquote`] and [`microtype`]

151−packages are used if available, and [`csquotes`] will be used

152−for [typography] if the `csquotes` variable or metadata field is

153−set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],

154−and [`biber`] packages can optionally be used for [citation

155−rendering]. The following packages will be used to improve

156−output quality if present, but pandoc does not require them to

157−be present: [`upquote`] (for straight quotes in verbatim

158−environments), [`microtype`] (for better spacing adjustments),

159−[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for

160−better line breaks in URLs), [`bookmark`] (for better PDF

161−bookmarks), and [`footnotehyper`] or [`footnote`] (to allow

162−footnotes in tables).

163−

164−[TeX Live]: https://www.tug.org/texlive/

149+the PDF engine requires [`fontspec`]. `xelatex` uses

150+[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the

151+`dir` variable set). If the `mathspec` variable is set,

152+`xelatex` will use [`mathspec`] instead of [`unicode-math`].

153+The [`upquote`] and [`microtype`] packages are used if

154+available, and [`csquotes`] will be used for [typography]

155+if `\usepackage{csquotes}` is present in the template or

156+included via `/H/--include-in-header`. The [`natbib`],

157+[`biblatex`], [`bibtex`], and [`biber`] packages can optionally

158+be used for [citation rendering]. The following packages

159+will be used to improve output quality if present, but

160+pandoc does not require them to be present:

161+[`upquote`] (for straight quotes in verbatim environments),

162+[`microtype`] (for better spacing adjustments),

163+[`parskip`] (for better inter-paragraph spaces),

164+[`xurl`] (for better line breaks in URLs),

165+[`bookmark`] (for better PDF bookmarks),

166+and [`footnotehyper`] or [`footnote`] (to allow footnotes in tables).

167+

168+[TeX Live]: http://www.tug.org/texlive/

165169[`amsfonts`]: https://ctan.org/pkg/amsfonts

166170[`amsmath`]: https://ctan.org/pkg/amsmath

167171[`babel`]: https://ctan.org/pkg/babel

@@ -180,7 +184,8 @@ footnotes in tables).

180184[`graphicx`]: https://ctan.org/pkg/graphicx

181185[`grffile`]: https://ctan.org/pkg/grffile

182186[`hyperref`]: https://ctan.org/pkg/hyperref

183−[`iftex`]: https://ctan.org/pkg/iftex

187+[`ifluatex`]: https://ctan.org/pkg/ifluatex

188+[`ifxetex`]: https://ctan.org/pkg/ifxetex

184189[`listings`]: https://ctan.org/pkg/listings

185190[`lm`]: https://ctan.org/pkg/lm

186191[`longtable`]: https://ctan.org/pkg/longtable

@@ -194,44 +199,41 @@ footnotes in tables).

194199[`ulem`]: https://ctan.org/pkg/ulem

195200[`unicode-math`]: https://ctan.org/pkg/unicode-math

196201[`upquote`]: https://ctan.org/pkg/upquote

197−[`weasyprint`]: https://weasyprint.org

202+[`weasyprint`]: http://weasyprint.org

198203[`wkhtmltopdf`]: https://wkhtmltopdf.org

199204[`xcolor`]: https://ctan.org/pkg/xcolor

200205[`xecjk`]: https://ctan.org/pkg/xecjk

201206[`xurl`]: https://ctan.org/pkg/xurl

202−[`selnolig`]: https://ctan.org/pkg/selnolig

203207

204208

205209

206−## Reading from the Web

210+Reading from the Web

211+--------------------

207212

208−Instead of an input file, an absolute URI may be given. In this case

213+Instead of an input file, an absolute URI may be given. In this case

209214pandoc will fetch the content using HTTP:

210215

211− pandoc -f html -t markdown https://www.fsf.org

216+ pandoc -f html -t markdown http://www.fsf.org

212217

213218It is possible to supply a custom User-Agent string or other

214219header when requesting a document from a URL:

215220

216221 pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \

217− https://www.fsf.org

222+ http://www.fsf.org

218223

219−# Options

224+Options

225+=======

220226

221−## General options {.options}

227+General options {.options}

228+---------------

222229

223230`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*

224231

225232: Specify input format. *FORMAT* can be:

226233

227234 ::: {#input-formats}

228− - `bibtex` ([BibTeX] bibliography)

229− - `biblatex` ([BibLaTeX] bibliography)

230235 - `commonmark` ([CommonMark] Markdown)

231− - `commonmark_x` ([CommonMark] Markdown with extensions)

232236 - `creole` ([Creole 1.0])

233− - `csljson` ([CSL JSON] bibliography)

234− - `csv` ([CSV] table)

235237 - `docbook` ([DocBook])

236238 - `docx` ([Word docx])

237239 - `dokuwiki` ([DokuWiki markup])

@@ -245,7 +247,6 @@ header when requesting a document from a URL:

245247 - `html` ([HTML])

246248 - `ipynb` ([Jupyter notebook])

247249 - `jats` ([JATS] XML)

248− - `jira` ([Jira]/Confluence wiki markup)

249250 - `json` (JSON version of native AST)

250251 - `latex` ([LaTeX])

251252 - `markdown` ([Pandoc's Markdown])

@@ -278,14 +279,10 @@ header when requesting a document from a URL:

278279: Specify output format. *FORMAT* can be:

279280

280281 ::: {#output-formats}

281− - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])

282+ - `asciidoc` ([AsciiDoc])

282283 - `beamer` ([LaTeX beamer][`beamer`] slide show)

283− - `bibtex` ([BibTeX] bibliography)

284− - `biblatex` ([BibLaTeX] bibliography)

285284 - `commonmark` ([CommonMark] Markdown)

286− - `commonmark_x` ([CommonMark] Markdown with extensions)

287285 - `context` ([ConTeXt])

288− - `csljson` ([CSL JSON] bibliography)

289286 - `docbook` or `docbook4` ([DocBook] 4)

290287 - `docbook5` (DocBook 5)

291288 - `docx` ([Word docx])

@@ -302,11 +299,7 @@ header when requesting a document from a URL:

302299 - `html4` ([XHTML] 1.0 Transitional)

303300 - `icml` ([InDesign ICML])

304301 - `ipynb` ([Jupyter notebook])

305− - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)

306− - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)

307− - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)

308− - `jats` (alias for `jats_archiving`)

309− - `jira` ([Jira]/Confluence wiki markup)

302+ - `jats` ([JATS] XML)

310303 - `json` (JSON version of native AST)

311304 - `latex` ([LaTeX])

312305 - `man` ([roff man])

@@ -322,7 +315,6 @@ header when requesting a document from a URL:

322315 - `opml` ([OPML])

323316 - `opendocument` ([OpenDocument])

324317 - `org` ([Emacs Org mode])

325− - `pdf` ([PDF])

326318 - `plain` (plain text),

327319 - `pptx` ([PowerPoint] slide show)

328320 - `rst` ([reStructuredText])

@@ -335,12 +327,11 @@ header when requesting a document from a URL:

335327 - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)

336328 - `s5` ([S5] HTML and JavaScript slide show)

337329 - `tei` ([TEI Simple])

338− - `xwiki` ([XWiki markup])

339330 - `zimwiki` ([ZimWiki markup])

340− - the path of a custom Lua writer, see [Custom writers] below

331+ - the path of a custom lua writer, see [Custom writers] below

341332 :::

342333

343− Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed

334+ Note that `odt`, `docx`, and `epub` output will not be directed

344335 to *stdout* unless forced with `-o -`.

345336

346337 Extensions can be individually enabled or

@@ -358,32 +349,23 @@ header when requesting a document from a URL:

358349

359350: Specify the user data directory to search for pandoc data files.

360351 If this option is not specified, the default user data directory

361− will be used. On \*nix and macOS systems this will be the `pandoc`

362− subdirectory of the XDG data directory (by default,

363− `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`

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

367− `C:\Users\USERNAME\AppData\Roaming\pandoc`.

352+ will be used. This is, in UNIX:

353+

354+ $HOME/.pandoc

355+

356+ in Windows XP:

357+

358+ C:\Documents And Settings\USERNAME\Application Data\pandoc

359+

360+ and in Windows Vista or later:

361+

362+ C:\Users\USERNAME\AppData\Roaming\pandoc

363+

368364 You can find the default user data directory on your system by

369365 looking at the output of `pandoc --version`.

370− Data files placed in this directory (for example, `reference.odt`,

371− `reference.docx`, `epub.css`, `templates`) will override

372− pandoc's normal defaults.

373−

374−`-d` *FILE*, `--defaults=`*FILE*

375−

376−: Specify a set of default option settings. *FILE* is a YAML

377− file whose fields correspond to command-line option

378− settings. All options for document conversion, including input

379− and output files, can be set using a defaults file. The file will

380− be searched for first in the working directory, and then in

381− the `defaults` subdirectory of the user data directory

382− (see `--data-dir`). The `.yaml` extension may be omitted.

383− See the section [Default files] for more information on the

384− file format. Settings from the defaults file may be

385− overridden or extended by subsequent options on the command

386− line.

366+ A `reference.odt`, `reference.docx`, `epub.css`, `templates`,

367+ `slidy`, `slideous`, or `s5` directory

368+ placed in this directory will override pandoc's normal defaults.

387369

388370`--bash-completion`

389371

@@ -394,7 +376,8 @@ header when requesting a document from a URL:

394376

395377`--verbose`

396378

397−: Give verbose debugging output.

379+: Give verbose debugging output. Currently this only has an effect

380+ with PDF output.

398381

399382`--quiet`

400383

@@ -420,7 +403,7 @@ header when requesting a document from a URL:

420403

421404`--list-extensions`[`=`*FORMAT*]

422405

423−: List supported extensions for *FORMAT*, one per line, preceded

406+: List supported extensions, one per line, preceded

424407 by a `+` or `-` indicating whether it is enabled by default

425408 in *FORMAT*. If *FORMAT* is not specified, defaults for

426409 pandoc's Markdown are given.

@@ -443,88 +426,63 @@ header when requesting a document from a URL:

443426

444427: Show usage message.

445428

446−[Markdown]: https://daringfireball.net/projects/markdown/

447−[CommonMark]: https://commonmark.org

429+[Markdown]: http://daringfireball.net/projects/markdown/

430+[CommonMark]: http://commonmark.org

448431[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/

449432[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/

450−[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/

451−[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html

452−[S5]: https://meyerweb.com/eric/tools/s5/

453−[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/

454−[Slideous]: https://goessner.net/articles/slideous/

455−[HTML]: https://www.w3.org/html/

456−[HTML5]: https://html.spec.whatwg.org/

433+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

434+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html

435+[S5]: http://meyerweb.com/eric/tools/s5/

436+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/

437+[Slideous]: http://goessner.net/articles/slideous/

438+[HTML]: http://www.w3.org/html/

439+[HTML5]: http://www.w3.org/TR/html5/

457440[polyglot markup]: https://www.w3.org/TR/html-polyglot/

458−[XHTML]: https://www.w3.org/TR/xhtml1/

459−[LaTeX]: https://www.latex-project.org/

441+[XHTML]: http://www.w3.org/TR/xhtml1/

442+[LaTeX]: http://latex-project.org

460443[`beamer`]: https://ctan.org/pkg/beamer

461−[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf

462−[ConTeXt]: https://www.contextgarden.net/

463−[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format

464−[DocBook]: https://docbook.org

444+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf

445+[ConTeXt]: http://www.contextgarden.net/

446+[Rich Text Format]: http://en.wikipedia.org/wiki/Rich_Text_Format

447+[DocBook]: http://docbook.org

465448[JATS]: https://jats.nlm.nih.gov

466−[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all

467−[txt2tags]: https://txt2tags.org

449+[txt2tags]: http://txt2tags.org

468450[EPUB]: http://idpf.org/epub

469451[OPML]: http://dev.opml.org/spec2.html

470452[OpenDocument]: http://opendocument.xml.org

471−[ODT]: https://en.wikipedia.org/wiki/OpenDocument

472−[Textile]: https://www.promptworks.com/textile

453+[ODT]: http://en.wikipedia.org/wiki/OpenDocument

454+[Textile]: http://redcloth.org/textile

473455[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting

474456[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki

475−[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html

476−[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/

477−[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules

457+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html

458+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules

478459[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax

479460[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html

480461[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0

481−[CSV]: https://tools.ietf.org/html/rfc4180

482−[roff man]: https://man.cx/groff_man(7)

483−[roff ms]: https://man.cx/groff_ms(7)

462+[roff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html

463+[roff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html

484464[Haskell]: https://www.haskell.org

485−[GNU Texinfo]: https://www.gnu.org/software/texinfo/

486−[Emacs Org mode]: https://orgmode.org

487−[AsciiDoc]: https://www.methods.co.nz/asciidoc/

488−[AsciiDoctor]: https://asciidoctor.org/

489−[DZSlides]: https://paulrouget.com/dzslides/

465+[GNU Texinfo]: http://www.gnu.org/software/texinfo/

466+[Emacs Org mode]: http://orgmode.org

467+[AsciiDoc]: http://www.methods.co.nz/asciidoc/

468+[DZSlides]: http://paulrouget.com/dzslides/

490469[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML

491470[PDF]: https://www.adobe.com/pdf/

492−[reveal.js]: https://revealjs.com/

471+[reveal.js]: http://lab.hakim.se/reveal-js/

493472[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1

494473[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/

495−[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf

474+[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf

496475[TEI Simple]: https://github.com/TEIC/TEI-Simple

497476[Muse]: https://amusewiki.org/library/manual

498477[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint

499478[Vimwiki]: https://vimwiki.github.io

500−[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html

501−[BibTeX]: https://ctan.org/pkg/bibtex

502−[BibLaTeX]: https://ctan.org/pkg/biblatex

503−

504−## Reader options {.options}

505−

506−`--shift-heading-level-by=`*NUMBER*

507−

508−: Shift heading levels by a positive or negative integer.

509− For example, with `--shift-heading-level-by=-1`, level 2

510− headings become level 1 headings, and level 3 headings

511− become level 2 headings. Headings cannot have a level

512− less than 1, so a heading that would be shifted below level 1

513− becomes a regular paragraph. Exception: with a shift of -N,

514− a level-N heading at the beginning of the document

515− replaces the metadata title. `--shift-heading-level-by=-1`

516− is a good choice when converting HTML or Markdown documents that

517− use an initial level-1 heading for the document title and

518− level-2+ headings for sections. `--shift-heading-level-by=1`

519− may be a good choice for converting Markdown documents that

520− use level-1 headings for sections to HTML, since pandoc uses

521− a level-1 heading to render the document title.

479+

480+Reader options {.options}

481+--------------

522482

523483`--base-header-level=`*NUMBER*

524484

525−: *Deprecated. Use `--shift-heading-level-by`=X instead,

526− where X = NUMBER - 1.* Specify the base level for headings

527− (defaults to 1).

485+: Specify the base level for headers (defaults to 1).

528486

529487`--strip-empty-paragraphs`

530488

@@ -589,32 +547,41 @@ header when requesting a document from a URL:

589547

590548 3. `$PATH` (executable only)

591549

592− Filters, Lua-filters, and citeproc processing are applied in

593− the order specified on the command line.

550+ Filters and lua-filters are applied in the order specified

551+ on the command line.

594552

595−`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*

553+`--lua-filter=`*SCRIPT*

596554

597555: Transform the document in a similar fashion as JSON filters (see

598− `--filter`), but use pandoc's built-in Lua filtering system. The given

599− Lua script is expected to return a list of Lua filters which will be

600− applied in order. Each Lua filter must contain element-transforming

556+ `--filter`), but use pandoc's build-in lua filtering system. The given

557+ lua script is expected to return a list of lua filters which will be

558+ applied in order. Each lua filter must contain element-transforming

601559 functions indexed by the name of the AST element on which the filter

602560 function should be applied.

603561

604− The `pandoc` Lua module provides helper functions for element

605− creation. It is always loaded into the script's Lua environment.

562+ The `pandoc` lua module provides helper functions for element

563+ creation. It is always loaded into the script's lua environment.

606564

607− See the [Lua filters documentation] for further details.

565+ The following is an example lua script for macro-expansion:

608566

609− In order of preference, pandoc will look for Lua filters in

567+ function expand_hello_world(inline)

568+ if inline.c == '{{helloworld}}' then

569+ return pandoc.Emph{ pandoc.Str "Hello, World" }

570+ else

571+ return inline

572+ end

573+ end

610574

611− 1. a specified full or relative path

575+ return {{Str = expand_hello_world}}

612576

613− 2. `$DATADIR/filters` where `$DATADIR` is the user data

614− directory (see `--data-dir`, above).

577+ In order of preference, pandoc will look for lua filters in

578+

579+ 1. a specified full or relative path (executable or

580+ non-executable)

615581

616− Filters, Lua filters, and citeproc processing are applied in

617− the order specified on the command line.

582+ 2. `$DATADIR/filters` (executable or non-executable)

583+ where `$DATADIR` is the user data directory (see

584+ `--data-dir`, above).

618585

619586`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]

620587

@@ -631,23 +598,19 @@ header when requesting a document from a URL:

631598

632599`--metadata-file=`*FILE*

633600

634−: Read metadata from the supplied YAML (or JSON) file. This

635− option can be used with every input format, but string scalars

636− in the YAML file will always be parsed as Markdown. Generally,

637− the input will be handled the same as in [YAML metadata

638− blocks][Extension: `yaml_metadata_block`]. This option can be

639− used repeatedly to include multiple metadata files; values in

640− files specified later on the command line will be preferred

641− over those specified in earlier files. Metadata values

642− specified inside the document, or by using `-M`, overwrite

643− values specified with this option.

601+: Read metadata from the supplied YAML (or JSON) file.

602+ This option can be used with every input format, but string

603+ scalars in the YAML file will always be parsed as Markdown.

604+ Generally, the input will be handled the same as in

605+ [YAML metadata blocks][Extension: `yaml_metadata_block`].

606+ Metadata values specified inside the document, or by using `-M`,

607+ overwrite values specified with this option.

644608

645609`-p`, `--preserve-tabs`

646610

647−: Preserve tabs instead of converting them to spaces. (By default, pandoc

648− converts tabs to spaces before parsing its input.) Note that this will

649− only affect tabs in literal code spans and code blocks. Tabs in regular

650− text are always treated as spaces.

611+: Preserve tabs instead of converting them to spaces (the default).

612+ Note that this will only affect tabs in literal code spans and code

613+ blocks; tabs in regular text will be treated as spaces.

651614

652615`--tab-stop=`*NUMBER*

653616

@@ -657,30 +620,30 @@ header when requesting a document from a URL:

657620

658621: Specifies what to do with insertions, deletions, and comments

659622 produced by the MS Word "Track Changes" feature. `accept` (the

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.

623+ default), inserts all insertions, and ignores all

624+ deletions. `reject` inserts all deletions and ignores

625+ insertions. Both `accept` and `reject` ignore comments. `all` puts

626+ in insertions, deletions, and comments, wrapped in spans with

627+ `insertion`, `deletion`, `comment-start`, and `comment-end`

628+ classes, respectively. The author and time of change is

629+ included. `all` is useful for scripting: only accepting changes

630+ from a certain reviewer, say, or before a certain date. If a

631+ paragraph is inserted or deleted, `track-changes=all` produces a

632+ span with the class `paragraph-insertion`/`paragraph-deletion`

633+ before the affected paragraph break. This option only affects the

634+ docx reader.

672635

673636`--extract-media=`*DIR*

674637

675638: Extract images and other media contained in or linked from

676639 the source document to the path *DIR*, creating it if

677640 necessary, and adjust the images references in the document

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.

641+ so they point to the extracted files. If the source format is

642+ a binary container (docx, epub, or odt), the media is

643+ extracted from the container and the original

644+ filenames are used. Otherwise the media is read from the

645+ file system or downloaded, and new filenames are constructed

646+ based on SHA1 hashes of the contents.

684647

685648`--abbreviations=`*FILE*

686649

@@ -691,17 +654,17 @@ header when requesting a document from a URL:

691654 system default, use

692655 `pandoc --print-default-data-file=abbreviations`. The only

693656 use pandoc makes of this list is in the Markdown reader.

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.

657+ Strings ending in a period that are found in this list will

658+ be followed by a nonbreaking space, so that the period will

659+ not produce sentence-ending space in formats like LaTeX.

697660

698661[`pandocfilters`]: https://github.com/jgm/pandocfilters

699662[PHP]: https://github.com/vinai/pandocfilters-php

700663[perl]: https://metacpan.org/pod/Pandoc::Filter

701664[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node

702−[Lua filters documentation]: https://pandoc.org/lua-filters.html

703665

704−## General writer options {.options}

666+General writer options {.options}

667+----------------------

705668

706669`-s`, `--standalone`

707670

@@ -726,29 +689,22 @@ header when requesting a document from a URL:

726689`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]

727690

728691: Set the template variable *KEY* to the value *VAL* when rendering the

729− document in standalone mode. If no *VAL* is specified, the

730− key will be given the value `true`.

692+ document in standalone mode. This is generally only useful when the

693+ `--template` option is used to specify a custom template, since

694+ pandoc automatically sets the variables used in the default

695+ templates. If no *VAL* is specified, the key will be given the

696+ value `true`.

731697

732698`-D` *FORMAT*, `--print-default-template=`*FORMAT*

733699

734700: Print the system default template for an output *FORMAT*. (See `-t`

735701 for a list of possible *FORMAT*s.) Templates in the user data

736− directory are ignored. This option may be used with

737− `-o`/`--output` to redirect output to a file, but

738− `-o`/`--output` must come before `--print-default-template`

739− on the command line.

740−

741− Note that some of the default templates use partials, for

742− example `styles.html`. To print the partials, use

743− `--print-default-data-file`: for example,

744− `--print-default-data-file=templates/styles.html`.

702+ directory are ignored.

745703

746704`--print-default-data-file=`*FILE*

747705

748706: Print a system default data file. Files in the user data directory

749− are ignored. This option may be used with `-o`/`--output` to

750− redirect output to a file, but `-o`/`--output` must come before

751− `--print-default-data-file` on the command line.

707+ are ignored.

752708

753709`--eol=crlf`|`lf`|`native`

754710

@@ -759,12 +715,9 @@ header when requesting a document from a URL:

759715

760716`--dpi`=*NUMBER*

761717

762−: Specify the default dpi (dots per inch) value for conversion

763− from pixels to inch/centimeters and vice versa. (Technically,

764− the correct term would be ppi: pixels per inch.) The default

765− is 96dpi. When images contain information about dpi

766− internally, the encoded value is used instead of the default

767− specified by this option.

718+: Specify the dpi (dots per inch) value for conversion from pixels

719+ to inch/centimeters and vice versa. The default is 96dpi.

720+ Technically, the correct term would be ppi (pixels per inch).

768721

769722`--wrap=auto`|`none`|`preserve`

770723

@@ -795,17 +748,11 @@ header when requesting a document from a URL:

795748 unless `-s/--standalone` is used, and it has no effect

796749 on `man`, `docbook4`, `docbook5`, or `jats` output.

797750

798− Note that if you are producing a PDF via `ms`, the table

799− of contents will appear at the beginning of the

800− document, before the title. If you would prefer it to

801− be at the end of the document, use the option

802− `--pdf-engine-opt=--no-toc-relocation`.

803−

804751`--toc-depth=`*NUMBER*

805752

806753: Specify the number of section levels to include in the table

807− of contents. The default is 3 (which means that level-1, 2, and 3

808− headings will be listed in the contents).

754+ of contents. The default is 3 (which means that level 1, 2, and 3

755+ headers will be listed in the contents).

809756

810757`--strip-comments`

811758

@@ -841,10 +788,7 @@ header when requesting a document from a URL:

841788

842789: Prints a JSON version of a highlighting style, which can

843790 be modified, saved with a `.theme` extension, and used

844− with `--highlight-style`. This option may be used with

845− `-o`/`--output` to redirect output to a file, but

846− `-o`/`--output` must come before `--print-highlight-style`

847− on the command line.

791+ with `--highlight-style`.

848792

849793`--syntax-definition=`*FILE*

850794

@@ -852,8 +796,7 @@ header when requesting a document from a URL:

852796 which will be used for syntax highlighting of appropriately

853797 marked code blocks. This can be used to add support for

854798 new languages or to use altered syntax definitions for

855− existing languages. This option may be repeated to add

856− multiple syntax definitions.

799+ existing languages.

857800

858801`-H` *FILE*, `--include-in-header=`*FILE*|*URL*

859802

@@ -891,11 +834,11 @@ header when requesting a document from a URL:

891834 will not be searched. For example:

892835 `--resource-path=.:test` will search the working directory

893836 and the `test` subdirectory, in that order.

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`.

837+

838+ `--resource-path` only has an effect if (a) the output

839+ format embeds images (for example, `docx`, `pdf`, or `html`

840+ with `--self-contained`) or (b) it is used together with

841+ `--extract-media`.

899842

900843`--request-header=`*NAME*`:`*VAL*

901844

@@ -905,13 +848,8 @@ header when requesting a document from a URL:

905848 downloaded). If you're behind a proxy, you also need to set

906849 the environment variable `http_proxy` to `http://...`.

907850

908−`--no-check-certificate`

909−

910−: Disable the certificate verification to allow access to

911− unsecure HTTP resources (for example when the certificate

912− is no longer valid or self signed).

913−

914−## Options affecting specific writers {.options}

851+Options affecting specific writers {.options}

852+----------------------------------

915853

916854`--self-contained`

917855

@@ -936,9 +874,7 @@ header when requesting a document from a URL:

936874

937875`--html-q-tags`

938876

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.)

877+: Use `<q>` tags for quotes in HTML.

942878

943879`--ascii`

944880

@@ -956,45 +892,37 @@ header when requesting a document from a URL:

956892 placement of link references is affected by the

957893 `--reference-location` option.

958894

959−`--reference-location=block`|`section`|`document`

895+`--reference-location = block`|`section`|`document`

960896

961897: Specify whether footnotes (and references, if `reference-links` is

962898 set) are placed at the end of the current (top-level) block, the

963899 current section, or the document. The default is

964900 `document`. Currently only affects the markdown writer.

965901

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−

974902`--atx-headers`

975903

976−: *Deprecated synonym for `--markdown-headings=atx`.*

904+: Use ATX-style headers in Markdown output. The default is

905+ to use setext-style headers for levels 1-2, and then ATX headers.

906+ (Note: for `gfm` output, ATX headers are always used.)

907+ This option also affects markdown cells in `ipynb` output.

977908

978−`--top-level-division=default`|`section`|`chapter`|`part`

909+`--top-level-division=[default|section|chapter|part]`

979910

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.

911+: Treat top-level headers as the given division type in LaTeX, ConTeXt,

912+ DocBook, and TEI output. The hierarchy order is part, chapter, then section;

913+ all headers are shifted such that the top-level header becomes the specified

914+ type. The default behavior is to determine the best division type via

915+ heuristics: unless other conditions apply, `section` is chosen. When the

916+ LaTeX document class is set to `report`, `book`, or `memoir` (unless the

917+ `article` option is specified), `chapter` is implied as the setting for this

918+ option. If `beamer` is the output format, specifying either `chapter` or

919+ `part` will cause top-level headers to become `\part{..}`, while

920+ second-level headers remain as their default type.

993921

994922`-N`, `--number-sections`

995923

996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB

997− output. By default, sections are not numbered. Sections with class

924+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.

925+ By default, sections are not numbered. Sections with class

998926 `unnumbered` will never be numbered, even if `--number-sections`

999927 is specified.

1000928

@@ -1002,10 +930,10 @@ header when requesting a document from a URL:

1002930

1003931: Offset for section headings in HTML output (ignored in other

1004932 output formats). The first number is added to the section number for

1005− top-level headings, the second for second-level headings, and so on.

1006− So, for example, if you want the first top-level heading in your

933+ top-level headers, the second for second-level headers, and so on.

934+ So, for example, if you want the first top-level header in your

1007935 document to be numbered "6", specify `--number-offset=5`.

1008− If your document starts with a level-2 heading which you want to

936+ If your document starts with a level-2 header which you want to

1009937 be numbered "1.5", specify `--number-offset=1,4`.

1010938 Offsets are 0 by default. Implies `--number-sections`.

1011939

@@ -1013,7 +941,7 @@ header when requesting a document from a URL:

1013941

1014942: Use the [`listings`] package for LaTeX code blocks. The package

1015943 does not support multi-byte encoding for source code. To handle UTF-8

1016− you would need to use a custom template. This issue is fully

944+ you would need to use a custom template. This issue is fully

1017945 documented here: [Encoding issue with the listings package].

1018946

1019947`-i`, `--incremental`

@@ -1023,12 +951,12 @@ header when requesting a document from a URL:

1023951

1024952`--slide-level=`*NUMBER*

1025953

1026−: Specifies that headings with the specified level create

1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings

954+: Specifies that headers with the specified level create

955+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers

1028956 above this level in the hierarchy are used to divide the

1029− slide show into sections; headings below this level create

957+ slide show into sections; headers below this level create

1030958 subheads within a slide. Note that content that is

1031− not contained under slide-level headings will not appear in

959+ not contained under slide-level headers will not appear in

1032960 the slide show. The default is to set the slide level based

1033961 on the contents of the document; see [Structuring the slide

1034962 show].

@@ -1037,8 +965,8 @@ header when requesting a document from a URL:

1037965

1038966: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),

1039967 and attach identifiers to the enclosing `<section>` (or `<div>`)

1040− rather than the heading itself. See

1041− [Heading identifiers], below.

968+ rather than the header itself. See

969+ [Header identifiers], below.

1042970

1043971`--email-obfuscation=none`|`javascript`|`references`

1044972

@@ -1059,7 +987,8 @@ header when requesting a document from a URL:

1059987

1060988: Specify *STRING* as a prefix at the beginning of the title

1061989 that appears in the HTML header (but not in the title as it

1062− appears at the beginning of the HTML body). Implies `--standalone`.

990+ appears at the beginning of the HTML body). Implies

991+ `--standalone`.

1063992

1064993`-c` *URL*, `--css=`*URL*

1065994

@@ -1091,14 +1020,14 @@ header when requesting a document from a URL:

10911020

10921021 To produce a custom `reference.docx`, first get a copy of

10931022 the default `reference.docx`: `pandoc

1094− -o custom-reference.docx --print-default-data-file reference.docx`.

1095− Then open `custom-reference.docx` in Word, modify the

1096− styles as you wish, and save the file. For best

1097− results, do not make changes to this file other than

1098− modifying the styles used by pandoc:

1099−

1023+ --print-default-data-file reference.docx >

1024+ custom-reference.docx`. Then open `custom-reference.docx`

1025+ in Word, modify the styles as you wish, and save the file.

1026+ For best results, do not make changes to this file other

1027+ than modifying the styles used by pandoc:

1028+

11001029 Paragraph styles:

1101−

1030+

11021031 - Normal

11031032 - Body Text

11041033 - First Paragraph

@@ -1128,18 +1057,17 @@ header when requesting a document from a URL:

11281057 - Figure

11291058 - Captioned Figure

11301059 - TOC Heading

1131−

1060+

11321061 Character styles:

1133−

1062+

11341063 - Default Paragraph Font

11351064 - Body Text Char

11361065 - Verbatim Char

11371066 - Footnote Reference

11381067 - Hyperlink

1139− - Section Number

1140−

1068+

11411069 Table style:

1142−

1070+

11431071 - Table

11441072

11451073 ODT

@@ -1154,18 +1082,19 @@ header when requesting a document from a URL:

11541082

11551083 To produce a custom `reference.odt`, first get a copy of

11561084 the default `reference.odt`: `pandoc

1157− -o custom-reference.odt --print-default-data-file reference.odt`.

1158− Then open `custom-reference.odt` in LibreOffice, modify

1159− the styles as you wish, and save the file.

1085+ --print-default-data-file reference.odt >

1086+ custom-reference.odt`. Then open `custom-reference.odt` in

1087+ LibreOffice, modify the styles as you wish, and save the

1088+ file.

11601089

11611090 PowerPoint

11621091

1163− : Templates included with Microsoft PowerPoint 2013 (either with

1164− `.pptx` or `.potx` extension) are known to work, as are most

1165− templates derived from these.

1092+ : Any template included with a recent install of Microsoft

1093+ PowerPoint (either with `.pptx` or `.potx` extension) should

1094+ work, as will most templates derived from these.

11661095

1167− The specific requirement is that the template should begin with

1168− the following first four layouts:

1096+ The specific requirement is that the template should contain

1097+ the following four layouts as its first four layouts:

11691098

11701099 1. Title Slide

11711100 2. Title and Content

@@ -1177,10 +1106,10 @@ header when requesting a document from a URL:

11771106 `Home` menu to check.)

11781107

11791108 You can also modify the default `reference.pptx`: first run

1180− `pandoc -o custom-reference.pptx --print-default-data-file

1181− reference.pptx`, and then modify `custom-reference.pptx`

1182− in MS PowerPoint (pandoc will use the first four layout

1183− slides, as mentioned above).

1109+ `pandoc --print-default-data-file reference.pptx >

1110+ custom-reference.pptx`, and then modify

1111+ `custom-reference.pptx` in MS PowerPoint (pandoc will use the

1112+ first four layout slides, as mentioned above).

11841113

11851114`--epub-cover-image=`*FILE*

11861115

@@ -1248,12 +1177,12 @@ header when requesting a document from a URL:

12481177

12491178`--epub-chapter-level=`*NUMBER*

12501179

1251−: Specify the heading level at which to split the EPUB into separate

1252− "chapter" files. The default is to split into chapters at level-1

1253− headings. This option only affects the internal composition of the

1180+: Specify the header level at which to split the EPUB into separate

1181+ "chapter" files. The default is to split into chapters at level 1

1182+ headers. This option only affects the internal composition of the

12541183 EPUB, not the way chapters and sections are displayed to users. Some

12551184 readers may be slow if the chapter files are too large, so for large

1256− documents with few level-1 headings, one might want to use a chapter

1185+ documents with few level 1 headers, one might want to use a chapter

12571186 level of 2 or 3.

12581187

12591188`--epub-subdirectory=`*DIRNAME*

@@ -1262,118 +1191,71 @@ header when requesting a document from a URL:

12621191 the EPUB-specific contents. The default is `EPUB`. To put

12631192 the EPUB contents in the top level, use an empty string.

12641193

1265−`--ipynb-output=all|none|best`

1266−

1267−: Determines how ipynb output cells are treated. `all` means

1268− that all of the data formats included in the original are

1269− preserved. `none` means that the contents of data cells

1270− are omitted. `best` causes pandoc to try to pick the

1271− richest data block in each output cell that is compatible

1272− with the output format. The default is `best`.

1273−

1274−`--pdf-engine=`*PROGRAM*

1194+`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`

12751195

12761196: Use the specified engine when producing PDF output.

1277− Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,

1278− `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,

1279− and `pdfroff`. If the engine is not in your PATH, the full

1280− path of the engine may be specified here. If this option

1281− is not specified, pandoc uses the following defaults

1282− depending on the output format specified using `-t/--to`:

1283−

1284− - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,

1285− `tectonic`, `latexmk`)

1286− - `-t context`: `context`

1287− - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;

1288− see [print-css.rocks](https://print-css.rocks) for a good

1289− introduction to PDF generation from HTML/CSS.)

1290− - `-t ms`: `pdfroff`

1197+ The default is `pdflatex`. If the engine is not in your PATH,

1198+ the full path of the engine may be specified here.

12911199

12921200`--pdf-engine-opt=`*STRING*

12931201

12941202: Use the given string as a command-line argument to the `pdf-engine`.

1295− For example, to use a persistent directory `foo` for `latexmk`'s

1296− auxiliary files, use `--pdf-engine-opt=-outdir=foo`.

1297− Note that no check for duplicate options is done.

1203+ If used multiple times, the arguments are provided with spaces between

1204+ them. Note that no check for duplicate options is done.

12981205

1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/

1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime

1206+[Dublin Core elements]: http://dublincore.org/documents/dces/

1207+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime

13011208[Encoding issue with the listings package]:

13021209 https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue

13031210

1304−## Citation rendering {.options}

1305−

1306−`-C`, `--citeproc`

1307−

1308−: Process the citations in the file, replacing them with

1309− rendered citations and adding a bibliography.

1310− Citation processing will not take place unless bibliographic

1311− data is supplied, either through an external file specified

1312− using the `--bibliography` option or the `bibliography`

1313− field in metadata, or via a `references` section in metadata

1314− containing a list of citations in CSL YAML format with

1315− Markdown formatting. The style is controlled by a [CSL]

1316− stylesheet specified using the `--csl` option or the `csl`

1317− field in metadata. (If no stylesheet is specified,

1318− the `chicago-author-date` style will be used by default.)

1319− The citation processing transformation may be applied before

1320− or after filters or Lua filters (see `--filter`,

1321− `--lua-filter`): these transformations are applied in the

1322− order they appear on the command line. For more

1323− information, see the section on [Citations].

1211+Citation rendering {.options}

1212+------------------

13241213

13251214`--bibliography=`*FILE*

13261215

13271216: Set the `bibliography` field in the document's metadata to *FILE*,

1328− overriding any value set in the metadata. If you supply

1329− this argument multiple times, each *FILE* will be added to

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`).

1217+ overriding any value set in the metadata, and process citations

1218+ using `pandoc-citeproc`. (This is equivalent to

1219+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)

1220+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not

1221+ used, making this equivalent to `--metadata bibliography=FILE`.

1222+ If you supply this argument multiple times, each *FILE* will be added

1223+ to bibliography.

13341224

13351225`--csl=`*FILE*

13361226

13371227: Set the `csl` field in the document's metadata to *FILE*,

13381228 overriding any value set in the metadata. (This is equivalent to

1339− `--metadata csl=FILE`.) If *FILE* is a URL, it will be

1340− fetched via HTTP. If *FILE* is not found relative to the

1341− working directory, it will be sought in the resource path

1342− (see `--resource-path`) and finally in the `csl`

1343− subdirectory of the pandoc user data directory.

1229+ `--metadata csl=FILE`.)

1230+ This option is only relevant with `pandoc-citeproc`.

13441231

13451232`--citation-abbreviations=`*FILE*

13461233

13471234: Set the `citation-abbreviations` field in the document's metadata to

13481235 *FILE*, overriding any value set in the metadata. (This is equivalent to

13491236 `--metadata citation-abbreviations=FILE`.)

1350− If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not

1351− found relative to the working directory, it will be sought

1352− in the resource path (see `--resource-path`) and finally in

1353− the `csl` subdirectory of the pandoc user data directory.

1237+ This option is only relevant with `pandoc-citeproc`.

13541238

13551239`--natbib`

13561240

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`].

1241+: Use [`natbib`] for citations in LaTeX output. This option is not for use

1242+ with the `pandoc-citeproc` filter or with PDF output. It is intended for

1243+ use in producing a LaTeX file that can be processed with [`bibtex`].

13611244

13621245`--biblatex`

13631246

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`].

1247+: Use [`biblatex`] for citations in LaTeX output. This option is not for use

1248+ with the `pandoc-citeproc` filter or with PDF output. It is intended for

1249+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].

13681250

1369−## Math rendering in HTML {.options}

1251+Math rendering in HTML {.options}

1252+----------------------

13701253

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.

1254+The default is to render TeX math as far as possible using Unicode characters.

1255+Formulas are put inside a `span` with `class="math"`, so that they may be styled

1256+differently from the surrounding text if needed. However, this gives acceptable

1257+results only for basic math, usually you will want to use `--mathjax` or another

1258+of the following options.

13771259

13781260`--mathjax`[`=`*URL*]

13791261

@@ -1387,11 +1269,10 @@ results only for basic math, usually you will want to use

13871269

13881270`--mathml`

13891271

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.

1272+: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,

1273+ `html4` and `html5`). This is the default in `odt` output. Note that

1274+ currently only Firefox and Safari (and select e-book readers) natively

1275+ support MathML.

13951276

13961277`--webtex`[`=`*URL*]

13971278

@@ -1415,19 +1296,21 @@ results only for basic math, usually you will want to use

14151296`--gladtex`

14161297

14171298: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML

1418− can then be processed by [GladTeX] to produce SVG images of the typeset

1419− formulas and an HTML file with these images embedded.

1299+ can then be processed by [GladTeX] to produce images of the typeset

1300+ formulas and an HTML file with links to these images.

1301+ So, the procedure is:

14201302

14211303 pandoc -s --gladtex input.md -o myfile.htex

1422− gladtex -d image_dir myfile.htex

1423− # produces myfile.html and images in image_dir

1304+ gladtex -d myfile-images myfile.htex

1305+ # produces myfile.html and images in myfile-images

14241306

1425−[MathML]: https://www.w3.org/Math/

1307+[MathML]: http://www.w3.org/Math/

14261308[MathJax]: https://www.mathjax.org

14271309[KaTeX]: https://github.com/Khan/KaTeX

1428−[GladTeX]: https://humenda.github.io/GladTeX/

1310+[GladTeX]: http://humenda.github.io/GladTeX/

14291311

1430−## Options for wrapper scripts {.options}

1312+Options for wrapper scripts {.options}

1313+---------------------------

14311314

14321315`--dump-args`

14331316

@@ -1451,277 +1334,8 @@ results only for basic math, usually you will want to use

14511334

14521335 pandoc -o foo.html -s

14531336

1454−# Exit codes

1455−

1456−If pandoc completes successfully, it will return exit code 0.

1457−Nonzero exit codes have the following meanings:

1458−

1459− Code Error

1460−----- ------------------------------------

1461− 3 PandocFailOnWarningError

1462− 4 PandocAppError

1463− 5 PandocTemplateError

1464− 6 PandocOptionError

1465− 21 PandocUnknownReaderError

1466− 22 PandocUnknownWriterError

1467− 23 PandocUnsupportedExtensionError

1468− 24 PandocCiteprocError

1469− 31 PandocEpubSubdirectoryError

1470− 43 PandocPDFError

1471− 44 PandocXMLError

1472− 47 PandocPDFProgramNotFoundError

1473− 61 PandocHttpError

1474− 62 PandocShouldNeverHappenError

1475− 63 PandocSomeError

1476− 64 PandocParseError

1477− 65 PandocParsecError

1478− 66 PandocMakePDFError

1479− 67 PandocSyntaxMapError

1480− 83 PandocFilterError

1481− 91 PandocMacroLoop

1482− 92 PandocUTF8DecodingError

1483− 93 PandocIpynbDecodingError

1484− 94 PandocUnsupportedCharsetError

1485− 97 PandocCouldNotFindDataFileError

1486− 99 PandocResourceNotFound

1487−----- ------------------------------------

1488−

1489−# Default files

1490−

1491−The `--defaults` option may be used to specify a package

1492−of options. Here is a sample defaults file demonstrating all of

1493−the fields that may be used:

1494−

1495−``` yaml

1496−from: markdown+emoji

1497−# reader: may be used instead of from:

1498−to: html5

1499−# writer: may be used instead of to:

1500−

1501−# leave blank for output to stdout:

1502−output-file:

1503−# leave blank for input from stdin, use [] for no input:

1504−input-files:

1505−- preface.md

1506−- content.md

1507−# or you may use input-file: with a single value

1508−

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−

1519−template: letter

1520−standalone: true

1521−self-contained: false

1522−

1523−# note that structured variables may be specified:

1524−variables:

1525− documentclass: book

1526− classoption:

1527− - twosides

1528− - draft

1529−

1530−# metadata values specified here are parsed as literal

1531−# string text, not markdown:

1532−metadata:

1533− author:

1534− - Sam Smith

1535− - Julie Liu

1536−metadata-files:

1537−- boilerplate.yaml

1538−# or you may use metadata-file: with a single value

1539−

1540−# Note that these take files, not their contents:

1541−include-before-body: []

1542−include-after-body: []

1543−include-in-header: []

1544−resource-path: ["."]

1545−

1546−# turn on built-in citation processing. Note that if you need

1547−# control over when the citeproc processing is done relative

1548−# to other filters, you should instead use `citeproc` in the

1549−# list of `filters` (see below).

1550−citeproc: true

1551−csl: ieee

1552−bibliography:

1553−- foobar.bib

1554−- barbaz.json

1555−citation-abbreviations: abbrevs.json

1556−

1557−# Filters will be assumed to be Lua filters if they have

1558−# the .lua extension, and json filters otherwise. But

1559−# the filter type can also be specified explicitly, as shown.

1560−# Filters are run in the order specified.

1561−# To include the built-in citeproc filter, use either `citeproc`

1562−# or `{type: citeproc}`.

1563−filters:

1564−- wordcount.lua

1565−- type: json

1566− path: foo.lua

1567−

1568−file-scope: false

1569−

1570−data-dir:

1571−

1572−# ERROR, WARNING, or INFO

1573−verbosity: INFO

1574−log-file: log.json

1575−

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).

1579−cite-method: citeproc

1580−

1581−# part, chapter, section, or default:

1582−top-level-division: chapter

1583−abbreviations:

1584−

1585−pdf-engine: pdflatex

1586−pdf-engine-opts:

1587−- "-shell-escape"

1588−# you may also use pdf-engine-opt: with a single option

1589−# pdf-engine-opt: "-shell-escape"

1590−

1591−# auto, preserve, or none

1592−wrap: auto

1593−columns: 78

1594−dpi: 72

1595−

1596−extract-media: mediadir

1597−

1598−table-of-contents: true

1599−toc-depth: 2

1600−number-sections: false

1601−# a list of offsets at each heading level

1602−number-offset: [0,0,0,0,0,0]

1603−# toc: may also be used instead of table-of-contents:

1604−shift-heading-level-by: 1

1605−section-divs: true

1606−identifier-prefix: foo

1607−title-prefix: ""

1608−strip-empty-paragraphs: true

1609−# lf, crlf, or native

1610−eol: lf

1611−strip-comments: false

1612−indented-code-classes: []

1613−ascii: true

1614−default-image-extension: ".jpg"

1615−

1616−# either a style name of a style definition file:

1617−highlight-style: pygments

1618−syntax-definitions:

1619−- c.xml

1620−# or you may use syntax-definition: with a single value

1621−listings: false

1622−

1623−reference-doc: myref.docx

1624−

1625−# method is plain, webtex, gladtex, mathml, mathjax, katex

1626−# you may specify a url with webtex, mathjax, katex

1627−html-math-method:

1628− method: mathjax

1629− url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"

1630−# none, references, or javascript

1631−email-obfuscation: javascript

1632−

1633−tab-stop: 8

1634−preserve-tabs: true

1635−

1636−incremental: false

1637−slide-level: 2

1638−

1639−epub-subdirectory: EPUB

1640−epub-metadata: meta.xml

1641−epub-fonts:

1642−- foobar.otf

1643−epub-chapter-level: 1

1644−epub-cover-image: cover.jpg

1645−

1646−reference-links: true

1647−# block, section, or document

1648−reference-location: block

1649−markdown-headings: setext

1650−

1651−# accept, reject, or all

1652−track-changes: accept

1653−

1654−html-q-tags: false

1655−css:

1656−- site.css

1657−

1658−# none, all, or best

1659−ipynb-output: best

1660−

1661−# A list of two-element lists

1662−request-headers:

1663−- ["User-Agent", "Mozilla/5.0"]

1664−

1665−fail-if-warnings: false

1666−dump-args: false

1667−ignore-args: false

1668−trace: false

1669−```

1670−

1671−Fields that are omitted will just have their regular

1672−default values. So a defaults file can be as simple as

1673−one line:

1674−

1675−``` yaml

1676−verbosity: INFO

1677−```

1678−

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−

1707−Default files can be placed in the `defaults` subdirectory of

1708−the user data directory and used from any directory. For

1709−example, one could create a file specifying defaults for writing

1710−letters, save it as `letter.yaml` in the `defaults` subdirectory

1711−of the user data directory, and then invoke these defaults

1712−from any directory using `pandoc --defaults letter`

1713−or `pandoc -dletter`.

1714−

1715−When multiple defaults are used, their contents will be combined.

1716−

1717−Note that, where command-line arguments may be repeated

1718−(`--metadata-file`, `--css`, `--include-in-header`,

1719−`--include-before-body`, `--include-after-body`, `--variable`,

1720−`--metadata`, `--syntax-definition`), the values specified on

1721−the command line will combine with values specified in the

1722−defaults file, rather than replacing them.

1723−

1724−# Templates

1337+Templates

1338+=========

17251339

17261340When the `-s/--standalone` option is used, pandoc uses a template to

17271341add header and footer material that is needed for a self-standing

@@ -1747,398 +1361,18 @@ directory (see `--data-dir`, above). *Exceptions:*

17471361Templates contain *variables*, which allow for the inclusion of

17481362arbitrary information at any point in the file. They may be set at the

17491363command line using the `-V/--variable` option. If a variable is not set,

1750−pandoc will look for the key in the document's metadata, which can be set

1364+pandoc will look for the key in the document's metadata – which can be set

17511365using either [YAML metadata blocks][Extension: `yaml_metadata_block`]

1752−or with the `-M/--metadata` option. In addition, some variables

1753−are given default values by pandoc. See [Variables] below for

1754−a list of variables used in pandoc's default templates.

1755−

1756−If you use custom templates, you may need to revise them as pandoc

1757−changes. We recommend tracking the changes in the default templates,

1758−and modifying your custom templates accordingly. An easy way to do this

1759−is to fork the [pandoc-templates] repository and merge in

1760−changes after each pandoc release.

1761−

1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates

1763−

1764−## Template syntax

1765−

1766−### Comments

1767−

1768−Anything between the sequence `$--` and the end of the

1769−line will be treated as a comment and omitted from the output.

1770−

1771−### Delimiters

1772−

1773−To mark variables and control structures in the template,

1774−either `$`...`$` or `${`...`}` may be used as delimiters.

1775−The styles may also be mixed in the same template, but the

1776−opening and closing delimiter must match in each case. The

1777−opening delimiter may be followed by one or more spaces

1778−or tabs, which will be ignored. The closing delimiter may

1779−be followed by one or more spaces or tabs, which will be

1780−ignored.

1781−

1782−To include a literal `$` in the document, use `$$`.

1783−

1784−### Interpolated variables

1785−

1786−A slot for an interpolated variable is a variable name surrounded

1787−by matched delimiters. Variable names must begin with a letter

1788−and can contain letters, numbers, `_`, `-`, and `.`. The

1789−keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may

1790−not be used as variable names. Examples:

1791−

1792−```

1793−$foo$

1794−$foo.bar.baz$

1795−$foo_bar.baz-bim$

1796−$ foo $

1797−${foo}

1798−${foo.bar.baz}

1799−${foo_bar.baz-bim}

1800−${ foo }

1801−```

1802−

1803−Variable names with periods are used to get at structured

1804−variable values. So, for example, `employee.salary` will return the

1805−value of the `salary` field of the object that is the value of

1806−the `employee` field.

1807−

1808−- If the value of the variable is simple value, it will be

1809− rendered verbatim. (Note that no escaping is done;

1810− the assumption is that the calling program will escape

1811− the strings appropriately for the output format.)

1812−- If the value is a list, the values will be concatenated.

1813−- If the value is a map, the string `true` will be rendered.

1814−- Every other value will be rendered as the empty string.

1815−

1816−### Conditionals

1817−

1818−A conditional begins with `if(variable)` (enclosed in

1819−matched delimiters) and ends with `endif` (enclosed in matched

1820−delimiters). It may optionally contain an `else` (enclosed in

1821−matched delimiters). The `if` section is used if

1822−`variable` has a non-empty value, otherwise the `else`

1823−section is used (if present). Examples:

1824−

1825−```

1826−$if(foo)$bar$endif$

1827−

1828−$if(foo)$

1829− $foo$

1830−$endif$

1831−

1832−$if(foo)$

1833−part one

1834−$else$

1835−part two

1836−$endif$

1837−

1838−${if(foo)}bar${endif}

1839−

1840−${if(foo)}

1841− ${foo}

1842−${endif}

1843−

1844−${if(foo)}

1845−${ foo.bar }

1846−${else}

1847−no foo!

1848−${endif}

1849−```

1850−

1851−The keyword `elseif` may be used to simplify complex nested

1852−conditionals:

1853−

1854−```

1855−$if(foo)$

1856−XXX

1857−$elseif(bar)$

1858−YYY

1859−$else$

1860−ZZZ

1861−$endif$

1862−```

1863−

1864−### For loops

1865−

1866−A for loop begins with `for(variable)` (enclosed in

1867−matched delimiters) and ends with `endfor` (enclosed in matched

1868−delimiters.

1869−

1870−- If `variable` is an array, the material inside the loop will

1871− be evaluated repeatedly, with `variable` being set to each

1872− value of the array in turn, and concatenated.

1873−- If `variable` is a map, the material inside will be set to

1874− the map.

1875−- If the value of the associated variable is not an array or

1876− a map, a single iteration will be performed on its value.

1877−

1878−Examples:

1879−

1880−```

1881−$for(foo)$$foo$$sep$, $endfor$

1882−

1883−$for(foo)$

1884− - $foo.last$, $foo.first$

1885−$endfor$

1886−

1887−${ for(foo.bar) }

1888− - ${ foo.bar.last }, ${ foo.bar.first }

1889−${ endfor }

1890−

1891−$for(mymap)$

1892−$it.name$: $it.office$

1893−$endfor$

1894−```

1895−

1896−You may optionally specify a separator between consecutive

1897−values using `sep` (enclosed in matched delimiters). The

1898−material between `sep` and the `endfor` is the separator.

1899−

1900−```

1901−${ for(foo) }${ foo }${ sep }, ${ endfor }

1902−```

1903−

1904−Instead of using `variable` inside the loop, the special

1905−anaphoric keyword `it` may be used.

1906−

1907−```

1908−${ for(foo.bar) }

1909− - ${ it.last }, ${ it.first }

1910−${ endfor }

1911−```

1912−

1913−### Partials

1914−

1915−Partials (subtemplates stored in different files) may be

1916−included by using the name of the partial, followed

1917−by `()`, for example:

1918−

1919−```

1920−${ styles() }

1921−```

1922−

1923−Partials will be sought in the directory containing

1924−the main template. The file name will be assumed to

1925−have the same extension as the main template if it

1926−lacks an extension. When calling the partial, the

1927−full name including file extension can also be used:

1928−

1929−```

1930−${ styles.html() }

1931−```

1932−

1933−(If a partial is not found in the directory of the

1934−template and the template path is given as a relative

1935−path, it will also be sought in the `templates`

1936−subdirectory of the user data directory.)

1937−

1938−Partials may optionally be applied to variables using

1939−a colon:

1940−

1941−```

1942−${ date:fancy() }

1943−

1944−${ articles:bibentry() }

1945−```

1946−

1947−If `articles` is an array, this will iterate over its

1948−values, applying the partial `bibentry()` to each one. So the

1949−second example above is equivalent to

1950−

1951−```

1952−${ for(articles) }

1953−${ it:bibentry() }

1954−${ endfor }

1955−```

1956−

1957−Note that the anaphoric keyword `it` must be used when

1958−iterating over partials. In the above examples,

1959−the `bibentry` partial should contain `it.title`

1960−(and so on) instead of `articles.title`.

1961−

1962−Final newlines are omitted from included partials.

1963−

1964−Partials may include other partials.

1965−

1966−A separator between values of an array may be specified

1967−in square brackets, immediately after the variable name

1968−or partial:

1969−

1970−```

1971−${months[, ]}$

1972−

1973−${articles:bibentry()[; ]$

1974−```

1975−

1976−The separator in this case is literal and (unlike with `sep`

1977−in an explicit `for` loop) cannot contain interpolated

1978−variables or other template directives.

1979−

1980−### Nesting

1981−

1982−To ensure that content is "nested," that is, subsequent lines

1983−indented, use the `^` directive:

1984−

1985−```

1986−$item.number$ $^$$item.description$ ($item.price$)

1987−```

1988−

1989−In this example, if `item.description` has multiple lines,

1990−they will all be indented to line up with the first line:

1991−

1992−```

1993−00123 A fine bottle of 18-year old

1994− Oban whiskey. ($148)

1995−```

1996−

1997−To nest multiple lines to the same level, align them

1998−with the `^` directive in the template. For example:

1999−

2000−```

2001−$item.number$ $^$$item.description$ ($item.price$)

2002− (Available til $item.sellby$.)

2003−```

2004−

2005−will produce

2006−

2007−```

2008−00123 A fine bottle of 18-year old

2009− Oban whiskey. ($148)

2010− (Available til March 30, 2020.)

2011−```

2012−

2013−If a variable occurs by itself on a line, preceded by whitespace

2014−and not followed by further text or directives on the same line,

2015−and the variable's value contains multiple lines, it will be

2016−nested automatically.

2017−

2018−### Breakable spaces

2019−

2020−Normally, spaces in the template itself (as opposed to values of

2021−the interpolated variables) are not breakable, but they can be

2022−made breakable in part of the template by using the `~` keyword

2023−(ended with another `~`).

2024−

2025−```

2026−$~$This long line may break if the document is rendered

2027−with a short line length.$~$

2028−```

2029−

2030−### Pipes

2031−

2032−A pipe transforms the value of a variable or partial. Pipes are

2033−specified using a slash (`/`) between the variable name (or partial)

2034−and the pipe name. Example:

2035−

2036−```

2037−$for(name)$

2038−$name/uppercase$

2039−$endfor$

2040−

2041−$for(metadata/pairs)$

2042−- $it.key$: $it.value$

2043−$endfor$

2044−

2045−$employee:name()/uppercase$

2046−```

1366+or with the `-M/--metadata` option.

20471367

2048−Pipes may be chained:

2049−

2050−```

2051−$for(employees/pairs)$

2052−$it.key/alpha/uppercase$. $it.name$

2053−$endfor$

2054−```

2055−

2056−Some pipes take parameters:

2057−

2058−```

2059−|----------------------|------------|

2060−$for(employee)$

2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$

2062−$endfor$

2063−|----------------------|------------|

2064−```

2065−

2066−Currently the following pipes are predefined:

2067−

2068−- `pairs`: Converts a map or array to an array of maps,

2069− each with `key` and `value` fields. If the original

2070− value was an array, the `key` will be the array index,

2071− starting with 1.

2072−

2073−- `uppercase`: Converts text to uppercase.

2074−

2075−- `lowercase`: Converts text to lowercase.

2076−

2077−- `length`: Returns the length of the value: number

2078− of characters for a textual value, number of elements

2079− for a map or array.

2080−

2081−- `reverse`: Reverses a textual value or array,

2082− and has no effect on other values.

2083−

2084−- `first`: Returns the first value of an array, if

2085− applied to a non-empty array; otherwise returns

2086− the original value.

2087−

2088−- `last`: Returns the last value of an array, if

2089− applied to a non-empty array; otherwise returns

2090− the original value.

2091−

2092−- `rest`: Returns all but the first value of an array, if

2093− applied to a non-empty array; otherwise returns

2094− the original value.

2095−

2096−- `allbutlast`: Returns all but the last value of an array, if

2097− applied to a non-empty array; otherwise returns

2098− the original value.

2099−

2100−- `chomp`: Removes trailing newlines (and breakable space).

2101−

2102−- `nowrap`: Disables line wrapping on breakable spaces.

2103−

2104−- `alpha`: Converts textual values that can be

2105− read as an integer into lowercase alphabetic

2106− characters `a..z` (mod 26). This can be used to get lettered

2107− enumeration from array indices. To get uppercase

2108− letters, chain with `uppercase`.

2109−

2110−- `roman`: Converts textual values that can be

2111− read as an integer into lowercase roman numerials.

2112− This can be used to get lettered enumeration from array indices.

2113− To get uppercase roman, chain with `uppercase`.

2114−

2115−- `left n "leftborder" "rightborder"`: Renders a textual value

2116− in a block of width `n`, aligned to the left, with an optional

2117− left and right border. Has no effect on other values. This

2118− can be used to align material in tables. Widths are positive

2119− integers indicating the number of characters. Borders

2120− are strings inside double quotes; literal `"` and `\` characters

2121− must be backslash-escaped.

2122−

2123−- `right n "leftborder" "rightborder"`: Renders a textual value

2124− in a block of width `n`, aligned to the right, and has no

2125− effect on other values.

2126−

2127−- `center n "leftborder" "rightborder"`: Renders a textual

2128− value in a block of width `n`, aligned to the center, and has

2129− no effect on other values.

2130−

2131−

2132−## Variables

2133−

2134−### Metadata variables

1368+Metadata variables

1369+------------------

21351370

21361371`title`, `author`, `date`

21371372: allow identification of basic aspects of the document. Included

21381373 in PDF metadata through LaTeX and ConTeXt. These can be set

21391374 through a [pandoc title block][Extension: `pandoc_title_block`],

2140− which allows for multiple authors, or through a

2141− [YAML metadata block][Extension: `yaml_metadata_block`]:

1375+ which allows for multiple authors, or through a YAML metadata block:

21421376

21431377 ---

21441378 author:

@@ -2146,13 +1380,6 @@ Currently the following pipes are predefined:

21461380 - Peter Abelard

21471381 ...

21481382

2149− Note that if you just want to set PDF or HTML metadata, without

2150− including a title block in the document itself, you can

2151− set the `title-meta`, `author-meta`, and `date-meta`

2152− variables. (By default these are set automatically, based

2153− on `title`, `author`, and `date`.) The page title in HTML

2154− is set by `pagetitle`, which is equal to `title` by default.

2155−

21561383`subtitle`

21571384: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx

21581385 documents

@@ -2166,7 +1393,7 @@ Currently the following pipes are predefined:

21661393 and AsciiDoc metadata; repeat as for `author`, above

21671394

21681395`subject`

2169−: document subject, included in ODT, PDF, docx and pptx metadata

1396+: document subject, included in ODT, docx and pptx metadata

21701397

21711398`description`

21721399: document description, included in ODT, docx and pptx metadata. Some

@@ -2178,7 +1405,7 @@ Currently the following pipes are predefined:

21781405Additionally,

21791406any root-level string metadata, not included in ODT, docx

21801407or pptx metadata is added as a *custom property*.

2181−The following [YAML] metadata block for instance:

1408+The following YAML metadata block for instance:

21821409

21831410 ---

21841411 title: 'This is the title'

@@ -2197,7 +1424,8 @@ will include `title`, `author` and `description` as standard document

21971424properties and `subtitle` as a custom property when converting to docx,

21981425ODT or pptx.

21991426

2200−### Language variables

1427+Language variables

1428+------------------

22011429

22021430`lang`

22031431: identifies the main language of the document using IETF language

@@ -2205,10 +1433,10 @@ ODT or pptx.

22051433 The [Language subtag lookup] tool can look up or verify these tags.

22061434 This affects most formats, and controls hyphenation in PDF output

22071435 when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.

2208−

1436+

22091437 Use native pandoc [Divs and Spans] with the `lang` attribute to

22101438 switch the language:

2211−

1439+

22121440 ---

22131441 lang: en-GB

22141442 ...

@@ -2220,106 +1448,33 @@ ODT or pptx.

22201448 :::

22211449

22221450 More text in English. ['Zitat auf Deutsch.']{lang=de}

2223−

1451+

22241452`dir`

22251453: the base script direction, either `rtl` (right-to-left)

22261454 or `ltr` (left-to-right).

22271455

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].

1456+ For bidirectional documents, native pandoc `span`s and `div`s

1457+ with the `dir` attribute (value `rtl` or `ltr`) can be used to

1458+ override the base direction in some output formats.

1459+ This may not always be necessary if the final renderer

1460+ (e.g. the browser, when generating HTML) supports the

1461+ [Unicode Bidirectional Algorithm].

22341462

2235− When using LaTeX for bidirectional documents, only the

2236− `xelatex` engine is fully supported (use

2237− `--pdf-engine=xelatex`).

1463+ When using LaTeX for bidirectional documents, only the `xelatex` engine

1464+ is fully supported (use `--pdf-engine=xelatex`).

22381465

22391466[BCP 47]: https://tools.ietf.org/html/bcp47

2240−[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics

1467+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics

22411468[Language subtag lookup]: https://r12a.github.io/app-subtags/

22421469

2243−### Variables for HTML

2244−

2245−`document-css`

2246−: Enables inclusion of most of the [CSS] in the `styles.html`

2247− [partial](#partials) (have a look with

2248− `pandoc --print-default-data-file=templates/styles.html`).

2249− Unless you use [`--css`](#option--css), this variable

2250− is set to `true` by default. You can disable it with

2251− e.g. `pandoc -M document-css=false`.

2252−

2253−`mainfont`

2254−: sets the CSS `font-family` property on the `html` element.

2255−

2256−`fontsize`

2257−: sets the base CSS `font-size`, which you'd usually set

2258− to e.g. `20px`, but it also accepts `pt`

2259− (12pt = 16px in most browsers).

2260−

2261−`fontcolor`

2262−: sets the CSS `color` property on the `html` element.

2263−

2264−`linkcolor`

2265−: sets the CSS `color` property on all links.

2266−

2267−`monofont`

2268−: sets the CSS `font-family` property on `code` elements.

2269−

2270−`monobackgroundcolor`

2271−: sets the CSS `background-color` property on `code` elements

2272− and adds extra padding.

2273−

2274−`linestretch`

2275−: sets the CSS `line-height` property on the `html` element,

2276− which is preferred to be unitless.

2277−

2278−`backgroundcolor`

2279−: sets the CSS `background-color` property on the `html` element.

2280−

2281−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

2282−: sets the corresponding CSS `padding` properties on the `body` element.

2283−

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−

2306−### Variables for HTML math

2307−

2308−`classoption`

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`.

2312−

2313−### Variables for HTML slides

1470+Variables for HTML slides

1471+-------------------------

23141472

23151473These affect HTML output when [producing slide shows with pandoc].

2316−

2317−`institute`

2318−: author affiliations: can be a list when there are multiple authors

1474+All [reveal.js configuration options] are available as variables.

23191475

23201476`revealjs-url`

2321−: base URL for reveal.js documents (defaults to

2322− `https://unpkg.com/reveal.js@^4/`)

1477+: base URL for reveal.js documents (defaults to `reveal.js`)

23231478

23241479`s5-url`

23251480: base URL for S5 documents (defaults to `s5/default`)

@@ -2331,16 +1486,10 @@ These affect HTML output when [producing slide shows with pandoc].

23311486`slideous-url`

23321487: base URL for Slideous documents (defaults to `slideous`)

23331488

2334−`title-slide-attributes`

2335−: additional attributes for the title slide of reveal.js slide shows.

2336− See [background in reveal.js and beamer] for an example.

2337−

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−

2341−[reveal.js configuration options]: https://revealjs.com/config/

1489+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration

23421490

2343−### Variables for Beamer slides

1491+Variables for Beamer slides

1492+---------------------------

23441493

23451494These variables change the appearance of PDF slides using [`beamer`].

23461495

@@ -2369,7 +1518,7 @@ These variables change the appearance of PDF slides using [`beamer`].

23691518: enables "title pages" for new sections (default is true)

23701519

23711520`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`

2372−: beamer themes

1521+: beamer themes:

23731522

23741523`themeoptions`

23751524: options for LaTeX beamer themes (a list).

@@ -2377,83 +1526,28 @@ These variables change the appearance of PDF slides using [`beamer`].

23771526`titlegraphic`

23781527: image for title slide

23791528

2380−### Variables for PowerPoint

2381−

2382−These variables control the visual aspects of a slide show that

2383−are not easily controlled via templates.

2384−

2385−`monofont`

2386−: font to use for code.

2387−

2388−### Variables for LaTeX

1529+Variables for LaTeX

1530+-------------------

23891531

23901532Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

23911533

2392−#### Layout

2393−

2394−`block-headings`

2395−: make `\paragraph` and `\subparagraph` (fourth- and

2396− fifth-level headings, or fifth- and sixth-level with book

2397− classes) free-standing rather than run-in; requires further

2398− formatting to distinguish from `\subsubsection` (third- or

2399− fourth-level headings). Instead of using this option,

2400− [KOMA-Script] can adjust headings more extensively:

2401−

2402− ---

2403− documentclass: scrartcl

2404− header-includes: |

2405− \RedeclareSectionCommand[

2406− beforeskip=-10pt plus -2pt minus -1pt,

2407− afterskip=1sp plus -1sp minus 1sp,

2408− font=\normalfont\itshape]{paragraph}

2409− \RedeclareSectionCommand[

2410− beforeskip=-10pt plus -2pt minus -1pt,

2411− afterskip=1sp plus -1sp minus 1sp,

2412− font=\normalfont\scshape,

2413− indent=0pt]{subparagraph}

2414− ...

1534+### Layout

24151535

24161536`classoption`

2417−: option for document class, e.g. `oneside`; repeat for multiple options:

2418−

2419− ---

2420− classoption:

2421− - twocolumn

2422− - landscape

2423− ...

1537+: option for document class, e.g. `oneside`; repeat for multiple options

24241538

24251539`documentclass`

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`]

1540+: document class: usually one of the standard classes, [`article`], [`report`],

1541+ and [`book`]; the [KOMA-Script] equivalents, `scrartcl`, `scrreprt`,

1542+ and `scrbook`, which default to smaller margins; or [`memoir`]

24301543

24311544`geometry`

24321545: option for [`geometry`] package, e.g. `margin=1in`;

2433− repeat for multiple options:

2434−

2435− ---

2436− geometry:

2437− - top=30mm

2438− - left=20mm

2439− - heightrounded

2440− ...

2441−

2442−`hyperrefoptions`

2443−: option for [`hyperref`] package, e.g. `linktoc=all`;

2444− repeat for multiple options:

2445−

2446− ---

2447− hyperrefoptions:

2448− - linktoc=all

2449− - pdfwindowui

2450− - pdfpagemode=FullScreen

2451− ...

1546+ repeat for multiple options

24521547

24531548`indent`

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)

1549+: uses document class settings for indentation (the default LaTeX template

1550+ otherwise removes indentation and adds space between paragraphs)

24571551

24581552`linestretch`

24591553: adjusts line spacing using the [`setspace`]

@@ -2475,11 +1569,15 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

24751569: numbering depth for sections (with `--number-sections` option

24761570 or `numbersections` variable)

24771571

2478−#### Fonts

1572+`subparagraph`

1573+: disables default behavior of LaTeX template that redefines (sub)paragraphs

1574+ as sections, changing the appearance of nested headings in some classes

1575+

1576+### Fonts

24791577

24801578`fontenc`

2481−: allows font encoding to be specified through `fontenc` package (with

2482− `pdflatex`); default is `T1` (see [LaTeX font encodings guide])

1579+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);

1580+ default is `T1` (see [LaTeX font encodings guide])

24831581

24841582`fontfamily`

24851583: font package for use with `pdflatex`:

@@ -2490,7 +1588,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

24901588: options for package used as `fontfamily`; repeat for multiple options.

24911589 For example, to use the Libertine font with proportional lowercase

24921590 (old-style) figures through the [`libertinus`] package:

2493−

1591+

24941592 ---

24951593 fontfamily: libertinus

24961594 fontfamilyoptions:

@@ -2499,9 +1597,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

24991597 ...

25001598

25011599`fontsize`

2502−: font size for body text. The standard classes allow 10pt, 11pt, and

2503− 12pt. To use another size, set `documentclass` to one of

2504− the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.

1600+: font size for body text. The standard classes allow 10pt, 11pt, and 12pt.

1601+ To use another size, set `documentclass` to one of the [KOMA-Script] classes,

1602+ such as `scrartcl` or `scrbook`.

25051603

25061604`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`

25071605: font families for use with `xelatex` or

@@ -2510,10 +1608,9 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

25101608

25111609`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`

25121610: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,

2513− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any

2514− choices available through [`fontspec`]; repeat for multiple

2515− options. For example, to use the [TeX Gyre] version of

2516− Palatino with lowercase figures:

1611+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices

1612+ available through [`fontspec`]; repeat for multiple options. For example,

1613+ to use the [TeX Gyre] version of Palatino with lowercase figures:

25171614

25181615 ---

25191616 mainfont: TeX Gyre Pagella

@@ -2525,7 +1622,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

25251622`microtypeoptions`

25261623: options to pass to the microtype package

25271624

2528−#### Links

1625+### Links

25291626

25301627`colorlinks`

25311628: add color to link text; automatically enabled if any of

@@ -2540,7 +1637,7 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

25401637`links-as-notes`

25411638: causes links to be printed as footnotes

25421639

2543−#### Front matter

1640+### Front matter

25441641

25451642`lof`, `lot`

25461643: include list of figures, list of tables

@@ -2549,13 +1646,12 @@ Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

25491646: contents of acknowledgments footnote after document title

25501647

25511648`toc`

2552−: include table of contents (can also be set using

2553− `--toc/--table-of-contents`)

1649+: include table of contents (can also be set using `--toc/--table-of-contents`)

25541650

25551651`toc-depth`

25561652: level of section to include in table of contents

25571653

2558−#### BibLaTeX Bibliographies

1654+### BibLaTeX Bibliographies

25591655

25601656These variables function when using BibLaTeX for [citation rendering].

25611657

@@ -2575,7 +1671,7 @@ These variables function when using BibLaTeX for [citation rendering].

25751671: list of options for natbib

25761672

25771673[KOMA-Script]: https://ctan.org/pkg/koma-script

2578−[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/

1674+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/

25791675[LaTeX font encodings guide]: https://ctan.org/pkg/encguide

25801676[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre

25811677[`article`]: https://ctan.org/pkg/article

@@ -2584,7 +1680,8 @@ These variables function when using BibLaTeX for [citation rendering].

25841680[`memoir`]: https://ctan.org/pkg/memoir

25851681[`report`]: https://ctan.org/pkg/report

25861682

2587−### Variables for ConTeXt

1683+Variables for ConTeXt

1684+---------------------

25881685

25891686Pandoc uses these variables when [creating a PDF] with ConTeXt.

25901687

@@ -2592,12 +1689,12 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.

25921689: font size for body text (e.g. `10pt`, `12pt`)

25931690

25941691`headertext`, `footertext`

2595−: text to be placed in running header or footer (see [ConTeXt Headers and

2596− Footers]); repeat up to four times for different placement

1692+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);

1693+ repeat up to four times for different placement

25971694

25981695`indenting`

2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see

2600− [ConTeXt Indentation]); repeat for multiple options

1696+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);

1697+ repeat for multiple options

26011698

26021699`interlinespace`

26031700: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);

@@ -2608,19 +1705,16 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.

26081705 repeat for multiple options

26091706

26101707`linkcolor`, `contrastcolor`

2611−: color for links outside and inside a page, e.g. `red`, `blue` (see

2612− [ConTeXt Color])

1708+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])

26131709

26141710`linkstyle`

2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,

2616− `type`, `cap`, `small`

1711+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`

26171712

26181713`lof`, `lot`

26191714: include list of figures, list of tables

26201715

26211716`mainfont`, `sansfont`, `monofont`, `mathfont`

2622−: font families: take the name of any system font (see

2623− [ConTeXt Font Switching])

1717+: font families: take the name of any system font (see [ConTeXt Font Switching])

26241718

26251719`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

26261720: sets margins, if `layout` is not used (otherwise `layout`

@@ -2635,41 +1729,18 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.

26351729 repeat for multiple options

26361730

26371731`pdfa`

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.

2650−

2651−`pdfaiccprofile`

2652−: when used in conjunction with `pdfa`, specifies the ICC profile to use

2653− in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is

2654− used as default. May be repeated to include multiple profiles. Note that

2655− the profiles have to be available on the system. They can be obtained

2656− from [ConTeXt ICC Profiles].

2657−

2658−`pdfaintent`

2659−: when used in conjunction with `pdfa`, specifies the output intent for

2660− the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`

2661− If left unspecified, `sRGB IEC61966-2.1` is used as default.

1732+: adds to the preamble the setup necessary to generate PDF/A-1b:2005.

1733+ To successfully generate PDF/A the required ICC color profiles have to

1734+ be available and the content and all included files (such as images)

1735+ have to be standard conforming. The ICC profiles can be obtained

1736+ from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more

1737+ details.

26621738

26631739`toc`

2664−: include table of contents (can also be set using

2665− `--toc/--table-of-contents`)

1740+: include table of contents (can also be set using `--toc/--table-of-contents`)

26661741

26671742`whitespace`

2668−: spacing between paragraphs, e.g. `none`, `small` (using

2669− [`setupwhitespace`])

2670−

2671−`includesource`

2672−: include all source documents as file attachments in the PDF file

1743+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])

26731744

26741745[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup

26751746[ConTeXt Layout]: https://wiki.contextgarden.net/Layout

@@ -2683,7 +1754,8 @@ Pandoc uses these variables when [creating a PDF] with ConTeXt.

26831754[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace

26841755[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering

26851756

2686−### Variables for `wkhtmltopdf`

1757+Variables for `wkhtmltopdf`

1758+---------------------------

26871759

26881760Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].

26891761The `--css` option also affects the output.

@@ -2697,7 +1769,8 @@ The `--css` option also affects the output.

26971769`papersize`

26981770: sets the PDF paper size

26991771

2700−### Variables for man pages

1772+Variables for man pages

1773+-----------------------

27011774

27021775`adjusting`

27031776: adjusts text to left (`l`), right (`r`), center (`c`),

@@ -2715,7 +1788,8 @@ The `--css` option also affects the output.

27151788`section`

27161789: section number in man pages

27171790

2718−### Variables for ms

1791+Variables for ms

1792+----------------

27191793

27201794`fontfamily`

27211795: font family (e.g. `T` or `P`)

@@ -2729,7 +1803,8 @@ The `--css` option also affects the output.

27291803`pointsize`

27301804: point size (e.g. `10p`)

27311805

2732−### Variables set automatically

1806+Structural variables

1807+--------------------

27331808

27341809Pandoc sets these variables automatically in response to [options] or

27351810document contents; users can also modify them. These vary depending

@@ -2769,9 +1844,9 @@ on the output format, and include the following:

27691844

27701845`sourcefile`, `outputfile`

27711846: source and destination filenames, as given on the command line.

2772− `sourcefile` can also be a list if input comes from multiple files,

2773− or empty if input is from stdin. You can use the following snippet in

2774− your template to distinguish them:

1847+ `sourcefile` can also be a list if input comes from multiple files, or empty

1848+ if input is from stdin. You can use the following snippet in your template

1849+ to distinguish them:

27751850

27761851 $if(sourcefile)$

27771852 $for(sourcefile)$

@@ -2783,34 +1858,98 @@ on the output format, and include the following:

27831858

27841859 Similarly, `outputfile` can be `-` if output goes to the terminal.

27851860

2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.

2787−

2788−`curdir`

2789−: working directory from which pandoc is run.

2790−

27911861`toc`

27921862: non-null value if `--toc/--table-of-contents` was specified

27931863

27941864`toc-title`

27951865: title of table of contents (works only with EPUB,

2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)

1866+ opendocument, odt, docx, pptx, beamer, LaTeX)

27971867

2798−[pandoc-templates]: https://github.com/jgm/pandoc-templates

1868+Using variables in templates

1869+----------------------------

27991870

2800−# Extensions

1871+Variable names are sequences of alphanumerics, `-`, and `_`,

1872+starting with a letter. A variable name surrounded by `$` signs

1873+will be replaced by its value. For example, the string `$title$` in

28011874

2802−The behavior of some of the readers and writers can be adjusted by

2803−enabling or disabling various extensions.

1875+ <title>$title$</title>

28041876

2805−An extension can be enabled by adding `+EXTENSION`

2806−to the format name and disabled by adding `-EXTENSION`. For example,

2807−`--from markdown_strict+footnotes` is strict Markdown with footnotes

2808−enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's

2809−Markdown without footnotes or pipe tables.

1877+will be replaced by the document title.

28101878

2811−The markdown reader and writer make by far the most use of extensions.

2812−Extensions only used by them are therefore covered in the

2813−section [Pandoc's Markdown] below (See [Markdown variants] for

1879+To write a literal `$` in a template, use `$$`.

1880+

1881+Templates may contain conditionals. The syntax is as follows:

1882+

1883+ $if(variable)$

1884+ X

1885+ $else$

1886+ Y

1887+ $endif$

1888+

1889+This will include `X` in the template if `variable` has a truthy

1890+value; otherwise it will include `Y`. Here a truthy value is any

1891+of the following:

1892+

1893+- a string that is not entirely white space,

1894+- a non-empty array where the first value is truthy,

1895+- any number (including zero),

1896+- any object,

1897+- the boolean `true` (to specify the boolean `true`

1898+ value using YAML metadata or the `--metadata` flag,

1899+ use `true`, `True`, or `TRUE`; with the `--variable`

1900+ flag, simply omit a value for the variable, e.g.

1901+ `--variable draft`).

1902+

1903+`X` and `Y` are placeholders for any valid template text,

1904+and may include interpolated variables or other conditionals.

1905+The `$else$` section may be omitted.

1906+

1907+When variables can have multiple values (for example, `author` in

1908+a multi-author document), you can use the `$for$` keyword:

1909+

1910+ $for(author)$

1911+ <meta name="author" content="$author$" />

1912+ $endfor$

1913+

1914+You can optionally specify a separator to be used between

1915+consecutive items:

1916+

1917+ $for(author)$$author$$sep$, $endfor$

1918+

1919+Note that the separator needs to be specified immediately before the `$endfor`

1920+keyword.

1921+

1922+A dot can be used to select a field of a variable that takes

1923+an object as its value. So, for example:

1924+

1925+ $author.name$ ($author.affiliation$)

1926+

1927+If you use custom templates, you may need to revise them as pandoc

1928+changes. We recommend tracking the changes in the default templates,

1929+and modifying your custom templates accordingly. An easy way to do this

1930+is to fork the [pandoc-templates] repository and merge in changes after each

1931+pandoc release.

1932+

1933+Templates may contain comments: anything on a line after `$--`

1934+will be treated as a comment and ignored.

1935+

1936+[pandoc-templates]: https://github.com/jgm/pandoc-templates

1937+

1938+Extensions

1939+==========

1940+

1941+The behavior of some of the readers and writers can be adjusted by

1942+enabling or disabling various extensions.

1943+

1944+An extension can be enabled by adding `+EXTENSION`

1945+to the format name and disabled by adding `-EXTENSION`. For example,

1946+`--from markdown_strict+footnotes` is strict Markdown with footnotes

1947+enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's

1948+Markdown without footnotes or pipe tables.

1949+

1950+The markdown reader and writer make by far the most use of extensions.

1951+Extensions only used by them are therefore covered in the

1952+section [Pandoc's Markdown] below (See [Markdown variants] for

28141953`commonmark` and `gfm`.) In the following, extensions that also work

28151954for other formats are covered.

28161955

@@ -2818,7 +1957,8 @@ Note that markdown extensions added to the `ipynb` format

28181957affect Markdown cells in Jupyter notebooks (as do command-line

28191958options like `--atx-headers`).

28201959

2821−## Typography

1960+Typography

1961+----------

28221962

28231963#### Extension: `smart` ####

28241964

@@ -2850,12 +1990,13 @@ literally. In writing LaTeX, enabling `smart` tells pandoc

28501990to use the ligatures when possible; if `smart` is disabled

28511991pandoc will use unicode quotation mark and dash characters.

28521992

2853−## Headings and sections

1993+Headers and sections

1994+--------------------

28541995

28551996#### Extension: `auto_identifiers` ####

28561997

2857−A heading without an explicitly specified identifier will be

2858−automatically assigned a unique identifier based on the heading text.

1998+A header without an explicitly specified identifier will be

1999+automatically assigned a unique identifier based on the header text.

28592000

28602001This extension can be enabled/disabled for the following formats:

28612002

@@ -2869,7 +2010,7 @@ enabled by default in

28692010: `markdown`, `muse`

28702011

28712012The default algorithm used to derive the identifier from the

2872−heading text is:

2013+header text is:

28732014

28742015 - Remove all formatting, links, etc.

28752016 - Remove all footnotes.

@@ -2883,9 +2024,9 @@ heading text is:

28832024

28842025Thus, for example,

28852026

2886− Heading Identifier

2027+ Header Identifier

28872028 ------------------------------- ----------------------------

2888− `Heading identifiers in HTML` `heading-identifiers-in-html`

2029+ `Header identifiers in HTML` `header-identifiers-in-html`

28892030 `Maître d'hôtel` `maître-dhôtel`

28902031 `*Dogs*?--in *my* house?` `dogs--in-my-house`

28912032 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`

@@ -2893,7 +2034,7 @@ Thus, for example,

28932034 `33` `section`

28942035

28952036These rules should, in most cases, allow one to determine the identifier

2896−from the heading text. The exception is when several headings have the

2037+from the header text. The exception is when several headers have the

28972038same text; in this case, the first will get an identifier as described

28982039above; the second will get the same identifier with `-1` appended; the

28992040third with `-2`; and so on.

@@ -2907,7 +2048,7 @@ also make it easy to provide links from one section of a document to

29072048another. A link to this section, for example, might look like this:

29082049

29092050 See the section on

2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).

2051+ [header identifiers](#header-identifiers-in-html-latex-and-context).

29112052

29122053Note, however, that this method of providing links to sections works

29132054only in HTML, LaTeX, and ConTeXt formats.

@@ -2915,7 +2056,7 @@ only in HTML, LaTeX, and ConTeXt formats.

29152056If the `--section-divs` option is specified, then each section will

29162057be wrapped in a `section` (or a `div`, if `html4` was specified),

29172058and the identifier will be attached to the enclosing `<section>`

2918−(or `<div>`) tag rather than the heading itself. This allows entire

2059+(or `<div>`) tag rather than the header itself. This allows entire

29192060sections to be manipulated using JavaScript or treated differently in

29202061CSS.

29212062

@@ -2931,9 +2072,9 @@ Changes the algorithm used by `auto_identifiers` to conform to

29312072GitHub's method. Spaces are converted to dashes (`-`),

29322073uppercase characters to lowercase characters, and punctuation

29332074characters other than `-` and `_` are removed.

2934−Emojis are replaced by their names.

29352075

2936−## Math Input

2076+Math Input

2077+----------

29372078

29382079The extensions [`tex_math_dollars`](#extension-tex_math_dollars),

29392080[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and

@@ -2943,47 +2084,59 @@ are described in the section about Pandoc's Markdown.

29432084However, they can also be used with HTML input. This is handy for

29442085reading web pages formatted using MathJax, for example.

29452086

2946−## Raw HTML/TeX

2087+Raw HTML/TeX

2088+------------

2089+

2090+The following extensions (especially how they affect Markdown

2091+input/output) are also described in more detail in their respective

2092+sections of [Pandoc's Markdown].

2093+

2094+#### Extension: `raw_html` {#raw_html}

2095+

2096+When converting from HTML, parse elements to raw HTML which are not

2097+representable in pandoc's AST.

2098+By default, this is disabled for HTML input.

2099+

2100+#### Extension: `raw_tex` {#raw_tex}

2101+

2102+Allows raw LaTeX, TeX, and ConTeXt to be included in a document.

2103+

2104+This extension can be enabled/disabled for the following formats

2105+(in addition to `markdown`):

2106+

2107+input formats

2108+: `latex`, `org`, `textile`, `html` (environments, `\ref`, and

2109+ `\eqref` only), `ipynb`

2110+

2111+output formats

2112+: `textile`, `commonmark`

29472113

2948−The following extensions are described in more detail in

2949−their respective sections of [Pandoc's Markdown]:

2114+Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not

2115+only raw TeX in markdown cells, but data with mime type

2116+`text/html` in output cells. Since the `ipynb` reader attempts

2117+to preserve the richest possible outputs when several options

2118+are given, you will get best results if you disable `raw_html`

2119+and `raw_tex` when converting to formats like `docx` which don't

2120+allow raw `html` or `tex`.

29502121

2951−- [`raw_html`](#extension-raw_html) allows HTML elements which

2952− are not representable in pandoc's AST to be parsed as raw HTML.

2953− By default, this is disabled for HTML input.

2122+#### Extension: `native_divs` {#native_divs}

29542123

2955−- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt

2956− to be included in a document. This extension can be enabled/disabled

2957− for the following formats (in addition to `markdown`):

2124+This extension is enabled by default for HTML input. This means that

2125+`div`s are parsed to pandoc native elements. (Alternatively, you

2126+can parse them to raw HTML using `-f html-native_divs+raw_html`.)

29582127

2959− input formats

2960− : `latex`, `textile`, `html` (environments, `\ref`, and

2961− `\eqref` only), `ipynb`

2128+When converting HTML to Markdown, for example, you may want to drop all

2129+`div`s and `span`s:

29622130

2963− output formats

2964− : `textile`, `commonmark`

2131+ pandoc -f html-native_divs-native_spans -t markdown

29652132

2966− Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not

2967− only raw TeX in markdown cells, but data with mime type

2968− `text/html` in output cells. Since the `ipynb` reader attempts

2969− to preserve the richest possible outputs when several options

2970− are given, you will get best results if you disable `raw_html`

2971− and `raw_tex` when converting to formats like `docx` which don't

2972− allow raw `html` or `tex`.

2133+#### Extension: `native_spans` {#native_spans}

29732134

2974−- [`native_divs`](#extension-native_divs) causes HTML `div`

2975− elements to be parsed as native pandoc Div blocks.

2976− If you want them to be parsed as raw HTML, use

2977− `-f html-native_divs+raw_html`.

2135+Analogous to `native_divs` above.

29782136

2979−- [`native_spans`](#extension-native_spans) causes HTML `span`

2980− elements to be parsed as native pandoc Span inlines.

2981− If you want them to be parsed as raw HTML, use

2982− `-f html-native_spans+raw_html`. If you want to drop all

2983− `div`s and `span`s when converting HTML to Markdown, you

2984− can use `pandoc -f html-native_divs-native_spans -t markdown`.

29852137

2986−## Literate Haskell support

2138+Literate Haskell support

2139+------------------------

29872140

29882141#### Extension: `literate_haskell` ####

29892142

@@ -3004,12 +2157,12 @@ This means that

30042157 - In Markdown input, "bird track" sections will be parsed as Haskell

30052158 code rather than block quotations. Text between `\begin{code}`

30062159 and `\end{code}` will also be treated as Haskell code. For

3007− ATX-style headings the character '=' will be used instead of '#'.

2160+ ATX-style headers the character '=' will be used instead of '#'.

30082161

30092162 - In Markdown output, code blocks with classes `haskell` and `literate`

30102163 will be rendered using bird tracks, and block quotations will be

30112164 indented one space, so they will not be treated as Haskell code.

3012− In addition, headings will be rendered setext-style (with underlines)

2165+ In addition, headers will be rendered setext-style (with underlines)

30132166 rather than ATX-style (with '#' characters). (This is because ghc

30142167 treats '#' characters in column 1 as introducing line numbers.)

30152168

@@ -3044,7 +2197,8 @@ Note that GHC expects the bird tracks in the first column, so indented

30442197literate code blocks (e.g. inside an itemized environment) will not be

30452198picked up by the Haskell compiler.

30462199

3047−## Other extensions

2200+Other extensions

2201+----------------

30482202

30492203#### Extension: `empty_paragraphs` ####

30502204

@@ -3059,60 +2213,12 @@ input formats

30592213output formats

30602214: `docx`, `odt`, `opendocument`, `html`

30612215

3062−#### Extension: `native_numbering` ####

3063−

3064−Enables native numbering of figures and tables. Enumeration

3065−starts at 1.

3066−

3067−This extension can be enabled/disabled for the following formats:

3068−

3069−output formats

3070−: `odt`, `opendocument`

3071−

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−

31092216#### Extension: `styles` #### {#ext-styles}

31102217

3111−When converting from docx, read all docx styles as divs (for

3112−paragraph styles) and spans (for character styles) regardless

3113−of whether pandoc understands the meaning of these styles.

3114−This can be used with [docx custom styles](#custom-styles).

3115−Disabled by default.

2218+Read all docx styles as divs (for paragraph styles) and spans (for

2219+character styles) regardless of whether pandoc understands the meaning

2220+of these styles. This can be used with [docx custom

2221+styles](#custom-styles). Disabled by default.

31162222

31172223input formats

31182224: `docx`

@@ -3122,36 +2228,22 @@ input formats

31222228In the `muse` input format, this enables Text::Amuse

31232229extensions to Emacs Muse markup.

31242230

3125−#### Extension: `raw_markdown` ####

3126−

3127−In the `ipynb` input format, this causes Markdown cells

3128−to be included as raw Markdown blocks (allowing lossless

3129−round-tripping) rather than being parsed. Use this only

3130−when you are targeting `ipynb` or a markdown-based

3131−output format.

3132−

31332231#### Extension: `citations` {#org-citations}

31342232

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.

2233+Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted

2234+in `org` input.

31442235

31452236#### Extension: `ntb` ####

31462237

31472238In the `context` output format this enables the use of [Natural Tables

3148−(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default

3149−[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).

2239+(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default

2240+[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).

31502241Natural tables allow more fine-grained global customization but come

31512242at a performance penalty compared to extreme tables.

31522243

31532244

3154−# Pandoc's Markdown

2245+Pandoc's Markdown

2246+=================

31552247

31562248Pandoc understands an extended and slightly revised version of

31572249John Gruber's [Markdown] syntax. This document explains the syntax,

@@ -3161,7 +2253,8 @@ of `markdown`. Extensions can be enabled or disabled to specify the

31612253behavior more granularly. They are described in the following. See also

31622254[Extensions] above, for extensions that work also on other formats.

31632255

3164−## Philosophy

2256+Philosophy

2257+----------

31652258

31662259Markdown is designed to be easy to write, and, even more importantly,

31672260easy to read:

@@ -3169,7 +2262,7 @@ easy to read:

31692262> A Markdown-formatted document should be publishable as-is, as plain

31702263> text, without looking like it's been marked up with tags or formatting

31712264> instructions.

3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)

2265+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)

31732266

31742267This principle has guided pandoc's decisions in finding syntax for

31752268tables, footnotes, and other extensions.

@@ -3182,7 +2275,8 @@ it discourages it, and provides other, non-HTMLish ways of representing

31822275important document elements like definition lists, tables, mathematics, and

31832276footnotes.

31842277

3185−## Paragraphs

2278+Paragraphs

2279+----------

31862280

31872281A paragraph is one or more lines of text followed by one or more blank lines.

31882282Newlines are treated as spaces, so you can reflow your paragraphs as you like.

@@ -3195,42 +2289,43 @@ Note: in multiline and grid table cells, this is the only way

31952289to create a hard line break, since trailing spaces in the cells

31962290are ignored.

31972291

3198−## Headings

2292+Headers

2293+-------

31992294

3200−There are two kinds of headings: Setext and ATX.

2295+There are two kinds of headers: Setext and ATX.

32012296

3202−### Setext-style headings ###

2297+### Setext-style headers ###

32032298

3204−A setext-style heading is a line of text "underlined" with a row of `=` signs

3205−(for a level-one heading) or `-` signs (for a level-two heading):

2299+A setext-style header is a line of text "underlined" with a row of `=` signs

2300+(for a level one header) or `-` signs (for a level two header):

32062301

3207− A level-one heading

3208− ===================

2302+ A level-one header

2303+ ==================

32092304

3210− A level-two heading

3211− -------------------

2305+ A level-two header

2306+ ------------------

32122307

3213−The heading text can contain inline formatting, such as emphasis (see

2308+The header text can contain inline formatting, such as emphasis (see

32142309[Inline formatting], below).

32152310

32162311

3217−### ATX-style headings ###

2312+### ATX-style headers ###

32182313

3219−An ATX-style heading consists of one to six `#` signs and a line of

2314+An ATX-style header consists of one to six `#` signs and a line of

32202315text, optionally followed by any number of `#` signs. The number of

3221−`#` signs at the beginning of the line is the heading level:

2316+`#` signs at the beginning of the line is the header level:

32222317

3223− ## A level-two heading

2318+ ## A level-two header

32242319

3225− ### A level-three heading ###

2320+ ### A level-three header ###

32262321

3227−As with setext-style headings, the heading text can contain formatting:

2322+As with setext-style headers, the header text can contain formatting:

32282323

3229− # A level-one heading with a [link](/url) and *emphasis*

2324+ # A level-one header with a [link](/url) and *emphasis*

32302325

32312326#### Extension: `blank_before_header` ####

32322327

3233−Standard Markdown syntax does not require a blank line before a heading.

2328+Standard Markdown syntax does not require a blank line before a header.

32342329Pandoc does require this (except, of course, at the beginning of the

32352330document). The reason for the requirement is that it is all too easy for a

32362331`#` to end up at the beginning of a line by accident (perhaps through line

@@ -3242,30 +2337,29 @@ wrapping). Consider, for example:

32422337#### Extension: `space_in_atx_header` ####

32432338

32442339Many Markdown implementations do not require a space between the

3245−opening `#`s of an ATX heading and the heading text, so that

3246−`#5 bolt` and `#hashtag` count as headings. With this extension,

2340+opening `#`s of an ATX header and the header text, so that

2341+`#5 bolt` and `#hashtag` count as headers. With this extension,

32472342pandoc does require the space.

32482343

3249−### Heading identifiers ###

2344+### Header identifiers ###

32502345

3251−See also the [`auto_identifiers`

3252−extension](#extension-auto_identifiers) above.

2346+See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.

32532347

32542348#### Extension: `header_attributes` ####

32552349

3256−Headings can be assigned attributes using this syntax at the end

3257−of the line containing the heading text:

2350+Headers can be assigned attributes using this syntax at the end

2351+of the line containing the header text:

32582352

32592353 {#identifier .class .class key=value key=value}

32602354

3261−Thus, for example, the following headings will all be assigned the identifier

2355+Thus, for example, the following headers will all be assigned the identifier

32622356`foo`:

32632357

3264− # My heading {#foo}

2358+ # My header {#foo}

32652359

3266− ## My heading ## {#foo}

2360+ ## My header ## {#foo}

32672361

3268− My other heading {#foo}

2362+ My other header {#foo}

32692363 ---------------

32702364

32712365(This syntax is compatible with [PHP Markdown Extra].)

@@ -3274,56 +2368,51 @@ Note that although this syntax allows assignment of classes and key/value

32742368attributes, writers generally don't use all of this information. Identifiers,

32752369classes, and key/value attributes are used in HTML and HTML-based formats such

32762370as EPUB and slidy. Identifiers are used for labels and link anchors in the

3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.

2371+LaTeX, ConTeXt, Textile, and AsciiDoc writers.

32782372

3279−Headings with the class `unnumbered` will not be numbered, even if

2373+Headers with the class `unnumbered` will not be numbered, even if

32802374`--number-sections` is specified. A single hyphen (`-`) in an attribute

32812375context is equivalent to `.unnumbered`, and preferable in non-English

32822376documents. So,

32832377

3284− # My heading {-}

2378+ # My header {-}

32852379

32862380is just the same as

32872381

3288− # My heading {.unnumbered}

3289−

3290−If the `unlisted` class is present in addition to `unnumbered`,

3291−the heading will not be included in a table of contents.

3292−(Currently this feature is only implemented for certain

3293−formats: those based on LaTeX and HTML, PowerPoint, and RTF.)

2382+ # My header {.unnumbered}

32942383

32952384#### Extension: `implicit_header_references` ####

32962385

3297−Pandoc behaves as if reference links have been defined for each heading.

3298−So, to link to a heading

2386+Pandoc behaves as if reference links have been defined for each header.

2387+So, to link to a header

32992388

3300− # Heading identifiers in HTML

2389+ # Header identifiers in HTML

33012390

33022391you can simply write

33032392

3304− [Heading identifiers in HTML]

2393+ [Header identifiers in HTML]

33052394

33062395or

33072396

3308− [Heading identifiers in HTML][]

2397+ [Header identifiers in HTML][]

33092398

33102399or

33112400

3312− [the section on heading identifiers][heading identifiers in

2401+ [the section on header identifiers][header identifiers in

33132402 HTML]

33142403

33152404instead of giving the identifier explicitly:

33162405

3317− [Heading identifiers in HTML](#heading-identifiers-in-html)

2406+ [Header identifiers in HTML](#header-identifiers-in-html)

33182407

3319−If there are multiple headings with identical text, the corresponding

2408+If there are multiple headers with identical text, the corresponding

33202409reference will link to the first one only, and you will need to use explicit

33212410links to link to the others, as described above.

33222411

33232412Like regular reference links, these references are case-insensitive.

33242413

33252414Explicit link reference definitions always take priority over

3326−implicit heading references. So, in the following example, the

2415+implicit header references. So, in the following example, the

33272416link will point to `bar`, not to `#foo`:

33282417

33292418 # Foo

@@ -3332,11 +2421,12 @@ link will point to `bar`, not to `#foo`:

33322421

33332422 See [foo]

33342423

3335−## Block quotations

2424+Block quotations

2425+----------------

33362426

33372427Markdown uses email conventions for quoting blocks of text.

33382428A block quotation is one or more paragraphs or other block elements

3339−(such as lists or headings), with each line preceded by a `>` character

2429+(such as lists or headers), with each line preceded by a `>` character

33402430and an optional space. (The `>` need not start at the left margin, but

33412431it should not be indented more than three spaces.)

33422432

@@ -3371,19 +2461,19 @@ block in a block quote, you need five spaces after the `>`:

33712461

33722462#### Extension: `blank_before_blockquote` ####

33732463

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

2464+Standard Markdown syntax does not require a blank line before a block

2465+quote. Pandoc does require this (except, of course, at the beginning of the

2466+document). The reason for the requirement is that it is all too easy for a

2467+`>` to end up at the beginning of a line by accident (perhaps through line

2468+wrapping). So, unless the `markdown_strict` format is used, the following does

33802469not produce a nested block quote in pandoc:

33812470

33822471 > This is a block quote.

33832472 >> Nested.

33842473

33852474

3386−## Verbatim (code) blocks

2475+Verbatim (code) blocks

2476+----------------------

33872477

33882478### Indented code blocks ###

33892479

@@ -3445,16 +2535,14 @@ this syntax:

34452535 qsort (filter (>= x) xs)

34462536 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

34472537

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:

2538+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and

2539+`startFrom` is an attribute with value `100`. Some output formats can use this

2540+information to do syntax highlighting. Currently, the only output formats

2541+that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If

2542+highlighting is supported for your output format and language, then the code

2543+block above will appear highlighted, with numbered lines. (To see which

2544+languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,

2545+the code block above will appear as follows:

34582546

34592547 <pre id="mycode" class="haskell numberLines" startFrom="100">

34602548 <code>

@@ -3491,7 +2579,8 @@ To set the highlighting style, use `--highlight-style`.

34912579For more information on highlighting, see [Syntax highlighting],

34922580below.

34932581

3494−## Line blocks

2582+Line blocks

2583+-----------

34952584

34962585#### Extension: `line_blocks` ####

34972586

@@ -3517,12 +2606,10 @@ line must begin with a space.

35172606 | 200 Main St.

35182607 | Berkeley, CA 94718

35192608

3520−Inline formatting (such as emphasis) is allowed in the content,

3521−but not block-level formatting (such as block quotes or lists).

3522−

35232609This syntax is borrowed from [reStructuredText].

35242610

3525−## Lists

2611+Lists

2612+-----

35262613

35272614### Bullet lists ###

35282615

@@ -3723,12 +2810,11 @@ a blank line, and must be followed by one or more definitions.

37232810A definition begins with a colon or tilde, which may be indented one

37242811or two spaces.

37252812

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

2813+A term may have multiple definitions, and each definition may consist of one or

2814+more block elements (paragraph, code block, list, etc.), each indented four

2815+spaces or one tab stop. The body of the definition (including the first line,

2816+aside from the colon or tilde) should be indented four spaces. However,

2817+as with other Markdown lists, you can "lazily" omit indentation except

37322818at the beginning of a paragraph or other block element:

37332819

37342820 Term 1

@@ -3754,10 +2840,9 @@ definition:

37542840Note that space between items in a definition list is required.

37552841(A variant that loosens this requirement, but disallows "lazy"

37562842hard wrapping, can be activated with `compact_definition_lists`: see

3757−[Non-default extensions], below.)

2843+[Non-pandoc extensions], below.)

37582844

3759−[^3]: I have been influenced by the suggestions of [David

3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).

2845+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).

37612846

37622847### Numbered example lists ###

37632848

@@ -3793,6 +2878,30 @@ list marker. That is, example lists always behave as if the

37932878labels tend to be long, and indenting content to the

37942879first non-space character after the label would be awkward.

37952880

2881+### Compact and loose lists ###

2882+

2883+Pandoc behaves differently from `Markdown.pl` on some "edge

2884+cases" involving lists. Consider this source:

2885+

2886+ + First

2887+ + Second:

2888+ - Fee

2889+ - Fie

2890+ - Foe

2891+

2892+ + Third

2893+

2894+Pandoc transforms this into a "compact list" (with no `<p>` tags around

2895+"First", "Second", or "Third"), while Markdown puts `<p>` tags around

2896+"Second" and "Third" (but not "First"), because of the blank space

2897+around "Third". Pandoc follows a simple rule: if the text is followed by

2898+a blank line, it is treated as a paragraph. Since "Second" is followed

2899+by a list, and not a blank line, it isn't treated as a paragraph. The

2900+fact that the list is followed by a blank line is irrelevant. (Note:

2901+Pandoc works this way even when the `markdown_strict` format is specified. This

2902+behavior is consistent with the official Markdown syntax description,

2903+even though it is different from that of `Markdown.pl`.)

2904+

37962905

37972906### Ending a list ###

37982907

@@ -3831,7 +2940,8 @@ of one big list:

38312940 2. dos

38322941 3. tres

38332942

3834−## Horizontal rules

2943+Horizontal rules

2944+----------------

38352945

38362946A line containing a row of three or more `*`, `-`, or `_` characters

38372947(optionally separated by spaces) produces a horizontal rule:

@@ -3841,7 +2951,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters

38412951 ---------------

38422952

38432953

3844−## Tables

2954+Tables

2955+------

38452956

38462957Four kinds of tables may be used. The first three kinds presuppose the use of

38472958a fixed-width font, such as Courier. The fourth kind can be used with

@@ -3866,7 +2977,7 @@ Simple tables look like this:

38662977

38672978 Table: Demonstration of simple table syntax.

38682979

3869−The header and table rows must each fit on one line. Column

2980+The headers and table rows must each fit on one line. Column

38702981alignments are determined by the position of the header text relative

38712982to the dashed line below it:[^4]

38722983

@@ -3885,7 +2996,7 @@ to the dashed line below it:[^4]

38852996The table must end with a blank line, or a line of dashes followed by

38862997a blank line.

38872998

3888−The column header row may be omitted, provided a dashed line is used

2999+The column headers may be omitted, provided a dashed line is used

38893000to end the table. For example:

38903001

38913002 ------- ------ ---------- -------

@@ -3894,13 +3005,13 @@ to end the table. For example:

38943005 1 1 1 1

38953006 ------- ------ ---------- -------

38963007

3897−When the header row is omitted, column alignments are determined on the basis

3008+When headers are omitted, column alignments are determined on the basis

38983009of the first line of the table body. So, in the tables above, the columns

38993010would be right, left, center, and right aligned, respectively.

39003011

39013012#### Extension: `multiline_tables` ####

39023013

3903−Multiline tables allow header and table rows to span multiple lines

3014+Multiline tables allow headers and table rows to span multiple lines

39043015of text (but cells that span multiple columns or rows of the table are

39053016not supported). Here is an example:

39063017

@@ -3922,7 +3033,7 @@ not supported). Here is an example:

39223033These work like simple tables, but with the following differences:

39233034

39243035 - They must begin with a row of dashes, before the header text

3925− (unless the header row is omitted).

3036+ (unless the headers are omitted).

39263037 - They must end with a row of dashes, then a blank line.

39273038 - The rows must be separated by blank lines.

39283039

@@ -3931,7 +3042,7 @@ the columns, and the writers try to reproduce these relative widths in

39313042the output. So, if you find that one of the columns is too narrow in the

39323043output, try widening it in the Markdown source.

39333044

3934−The header may be omitted in multiline tables as well as simple tables:

3045+Headers may be omitted in multiline tables as well as simple tables:

39353046

39363047 ----------- ------- --------------- -------------------------

39373048 First row 12.0 Example of a row that

@@ -3942,7 +3053,7 @@ The header may be omitted in multiline tables as well as simple tables:

39423053 rows.

39433054 ----------- ------- --------------- -------------------------

39443055

3945− : Here's a multiline table without a header.

3056+ : Here's a multiline table without headers.

39463057

39473058It is possible for a multiline table to have just one row, but the row

39483059should be followed by a blank line (and then the row of dashes that ends

@@ -3968,8 +3079,9 @@ The row of `=`s separates the header from the table body, and can be

39683079omitted for a headerless table. The cells of grid tables may contain

39693080arbitrary block elements (multiple paragraphs, code blocks, lists,

39703081etc.). Cells that span multiple columns or rows are not

3971−supported. Grid tables can be created easily using Emacs' table-mode

3972−(`M-x table-insert`).

3082+supported. Grid tables can be created easily using [Emacs table mode].

3083+

3084+[Emacs table mode]: http://table.sourceforge.net/

39733085

39743086Alignments can be specified as with pipe tables, by putting

39753087colons at the boundaries of the separator line after the

@@ -3997,7 +3109,7 @@ and the same number of rows in each column. For example, the

39973109Docutils [sample grid tables] will not render as expected with

39983110Pandoc.

39993111

4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables

3112+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables

40013113

40023114

40033115#### Extension: `pipe_tables` ####

@@ -4030,7 +3142,7 @@ legal (though ugly) pipe table:

40303142

40313143The cells of pipe tables cannot contain block elements like paragraphs

40323144and lists, and cannot span multiple lines. If a pipe table contains a

4033−row whose Markdown content is wider than the column width (see

3145+row whose printable content is wider than the column width (see

40343146`--columns`), then the table will take up the full text width and

40353147the cell contents will wrap, with the relative cell widths determined

40363148by the number of dashes in the line separating the table header from

@@ -4054,7 +3166,8 @@ you'll need to add colons as above.

40543166

40553167[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table

40563168

4057−## Metadata blocks

3169+Metadata blocks

3170+---------------

40583171

40593172#### Extension: `pandoc_title_block` ####

40603173

@@ -4070,42 +3183,30 @@ output.) The block may contain just a title, a title and an author,

40703183or all three elements. If you want to include an author but no

40713184title, or a title and a date but no author, you need a blank line:

40723185

4073−```

4074−%

4075−% Author

4076−```

3186+ %

3187+ % Author

40773188

4078−```

4079−% My title

4080−%

4081−% June 15, 2006

4082−```

3189+ % My title

3190+ %

3191+ % June 15, 2006

40833192

40843193The title may occupy multiple lines, but continuation lines must

40853194begin with leading space, thus:

40863195

4087−```

4088−% My title

4089− on multiple lines

4090−```

3196+ % My title

3197+ on multiple lines

40913198

40923199If a document has multiple authors, the authors may be put on

40933200separate lines with leading space, or separated by semicolons, or

40943201both. So, all of the following are equivalent:

40953202

4096−```

4097−% Author One

4098− Author Two

4099−```

3203+ % Author One

3204+ Author Two

41003205

4101−```

4102−% Author One; Author Two

4103−```

3206+ % Author One; Author Two

41043207

4105−```

4106−% Author One;

4107− Author Two

4108−```

3208+ % Author One;

3209+ Author Two

41093210

41103211The date must fit on one line.

41113212

@@ -4146,7 +3247,7 @@ will also have "Version 4.0" in the header.

41463247

41473248#### Extension: `yaml_metadata_block` ####

41483249

4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three

3250+A YAML metadata block is a valid YAML object, delimited by a line of three

41503251hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots

41513252(`...`) at the bottom. A YAML metadata block may occur anywhere in the

41523253document, but if it is not at the beginning, it must be preceded by a blank

@@ -4169,22 +3270,20 @@ given a role by external processors.) Field names must not be

41693270interpretable as YAML numbers or boolean values (so, for

41703271example, `yes`, `True`, and `15` cannot be used as field names).

41713272

4172−A document may contain multiple metadata blocks. If two

4173−metadata blocks attempt to set the same field, the value from

4174−the second block will be taken.

3273+A document may contain multiple metadata blocks. The metadata fields will

3274+be combined through a *left-biased union*: if two metadata blocks attempt

3275+to set the same field, the value from the first block will be taken.

41753276

41763277When pandoc is used with `-t markdown` to create a Markdown document,

41773278a YAML metadata block will be produced only if the `-s/--standalone`

41783279option is used. All of the metadata will appear in a single block

41793280at the beginning of the document.

41803281

4181−Note that [YAML] escaping rules must be followed. Thus, for example,

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:

3282+Note that YAML escaping rules must be followed. Thus, for example,

3283+if a title contains a colon, it must be quoted. The pipe character

3284+(`|`) can be used to begin an indented block that will be interpreted

3285+literally, without need for escaping. This form is necessary

3286+when the field contains blank lines or block-level formatting:

41883287

41893288 ---

41903289 title: 'This is the title: it contains a colon'

@@ -4198,12 +3297,6 @@ or block-level formatting:

41983297 It consists of two paragraphs.

41993298 ...

42003299

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−

42073300Template variables will be set automatically from the metadata. Thus, for

42083301example, in writing HTML, the variable `abstract` will be set to the HTML

42093302equivalent of the Markdown in the `abstract` field:

@@ -4250,25 +3343,8 @@ will be interpreted as markdown. For example:

42503343 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}

42513344 ```

42523345

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−

4271−## Backslash escapes

3346+Backslash escapes

3347+-----------------

42723348

42733349#### Extension: `all_symbols_escapable` ####

42743350

@@ -4294,12 +3370,9 @@ which allows only the following characters to be backslash-escaped:

42943370(However, if the `markdown_strict` format is used, the standard Markdown rule

42953371will be used.)

42963372

4297−A backslash-escaped space is parsed as a nonbreaking space. In TeX output,

4298−it will appear as `~`. In HTML and XML output, it will appear as a

4299−literal unicode nonbreaking space character (note that it will thus

4300−actually look "invisible" in the generated HTML source; you can still

4301−use the `--ascii` command-line option to make it appear as an explicit

4302−entity).

3373+A backslash-escaped space is parsed as a nonbreaking space. It will

3374+appear in TeX output as `~` and in HTML and XML as `\&#160;` or

3375+`\&nbsp;`.

43033376

43043377A backslash-escaped newline (i.e. a backslash occurring at the end of

43053378a line) is parsed as a hard line break. It will appear in TeX output as

@@ -4309,7 +3382,8 @@ two trailing spaces on a line.

43093382

43103383Backslash escapes do not work in verbatim contexts.

43113384

4312−## Inline formatting

3385+Inline formatting

3386+-----------------

43133387

43143388### Emphasis ###

43153389

@@ -4357,13 +3431,12 @@ text by `~` characters. Thus, for example,

43573431

43583432 H~2~O is a liquid. 2^10^ is 1024.

43593433

4360−The text between `^...^` or `~...~` may not contain spaces or

4361−newlines. If the superscripted or subscripted text contains

4362−spaces, these spaces must be escaped with backslashes. (This is

4363−to prevent accidental superscripting and subscripting through

4364−the ordinary use of `~` and `^`, and also bad interactions with

4365−footnotes.) Thus, if you want the letter P with 'a cat' in

4366−subscripts, use `P~a\ cat~`, not `P~a cat~`.

3434+If the superscripted or subscripted text contains spaces, these spaces

3435+must be escaped with backslashes. (This is to prevent accidental

3436+superscripting and subscripting through the ordinary use of `~` and `^`.)

3437+Thus, if you want the letter P with 'a cat' in subscripts, use

3438+`P~a\ cat~`, not `P~a cat~`.

3439+

43673440

43683441### Verbatim ###

43693442

@@ -4412,7 +3485,8 @@ For compatibility with other Markdown flavors, CSS is also supported:

44123485This will work in all output formats that support small caps.

44133486

44143487

4415−## Math

3488+Math

3489+----

44163490

44173491#### Extension: `tex_math_dollars` ####

44183492

@@ -4424,10 +3498,6 @@ left, and must not be followed immediately by a digit. Thus,

44243498you need to enclose text in literal `$` characters, backslash-escape

44253499them and they won't be treated as math delimiters.

44263500

4427−For display math, use `$$` delimiters. (In this case, the delimiters

4428−may be separated from the formula by whitespace. However, there can be

4429−no blank lines betwen the opening and closing `$$` delimiters.)

4430−

44313501TeX math will be printed in all output formats. How it is rendered

44323502depends on the output format:

44333503

@@ -4439,23 +3509,16 @@ Markdown, Emacs Org mode, ConTeXt, ZimWiki

44393509 ~ It will appear verbatim surrounded by `$...$` (for inline

44403510 math) or `$$...$$` (for display math).

44413511

4442−XWiki

4443− ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.

4444−

44453512reStructuredText

44463513 ~ It will be rendered using an [interpreted text role `:math:`].

44473514

44483515AsciiDoc

4449− ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim

4450− surrounded by `latexmath:[$...$]` (for inline math) or

4451− `[latexmath]++++\[...\]+++` (for display math).

4452− For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters

4453− (`$..$` and `\[..\]`) are omitted.

3516+ ~ It will be rendered as `latexmath:[...]`.

44543517

44553518Texinfo

44563519 ~ It will be rendered inside a `@math` command.

44573520

4458−roff man, Jira markup

3521+roff man

44593522 ~ It will be rendered verbatim without `$`'s.

44603523

44613524MediaWiki, DokuWiki

@@ -4489,9 +3552,10 @@ HTML, Slidy, DZSlides, S5, EPUB

44893552 command-line options selected. Therefore see [Math rendering in HTML]

44903553 above.

44913554

4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math

3555+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math

44933556

4494−## Raw HTML

3557+Raw HTML

3558+--------

44953559

44963560#### Extension: `raw_html` ####

44973561

@@ -4529,7 +3593,7 @@ Thus, for example, pandoc will turn

45293593 <table>

45303594 <tr>

45313595 <td>*one*</td>

4532− <td>[a link](https://google.com)</td>

3596+ <td>[a link](http://google.com)</td>

45333597 </tr>

45343598 </table>

45353599

@@ -4538,14 +3602,14 @@ into

45383602 <table>

45393603 <tr>

45403604 <td><em>one</em></td>

4541− <td><a href="https://google.com">a link</a></td>

3605+ <td><a href="http://google.com">a link</a></td>

45423606 </tr>

45433607 </table>

45443608

45453609whereas `Markdown.pl` will preserve it as is.

45463610

4547−There is one exception to this rule: text between `<script>`,

4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.

3611+There is one exception to this rule: text between `<script>` and

3612+`<style>` tags is not interpreted as Markdown.

45493613

45503614This departure from standard Markdown should make it easier to mix

45513615Markdown with HTML block elements. For example, one can surround

@@ -4637,7 +3701,8 @@ example, to use a raw attribute with a backtick code block,

46373701

46383702The raw attribute cannot be combined with regular attributes.

46393703

4640−## LaTeX macros

3704+LaTeX macros

3705+------------

46413706

46423707#### Extension: `latex_macros` ####

46433708

@@ -4651,20 +3716,18 @@ all output formats, not just LaTeX:

46513716 $\tuple{a, b, c}$

46523717

46533718Note that LaTeX macros will not be applied if they occur

4654−inside a raw span or block marked with the

3719+inside inside a raw span or block marked with the

46553720[`raw_attribute` extension](#extension-raw_attribute).

46563721

46573722When `latex_macros` is disabled, the raw LaTeX and math will

46583723not have macros applied. This is usually a better approach when

46593724you are targeting LaTeX or PDF.

46603725

4661−Macro definitions in LaTeX will be passed through as raw LaTeX

4662−only if `latex_macros` is not enabled. Macro definitions in

4663−Markdown source (or other formats allowing `raw_tex`) will

4664−be passed through regardless of whether `latex_macros` is

4665−enabled.

3726+Whether or not `latex_macros` is enabled, the macro definitions

3727+will still be passed through as raw LaTeX.

46663728

4667−## Links

3729+Links

3730+-----

46683731

46693732Markdown allows links to be specified in several ways.

46703733

@@ -4673,7 +3736,7 @@ Markdown allows links to be specified in several ways.

46733736If you enclose a URL or email address in pointy brackets, it

46743737will become a link:

46753738

4676− <https://google.com>

3739+ <http://google.com>

46773740 <sam@green.eggs.ham>

46783741

46793742### Inline links ###

@@ -4683,7 +3746,7 @@ followed by the URL in parentheses. (Optionally, the URL can

46833746be followed by a link title, in quotes.)

46843747

46853748 This is an [inline link](/url), and here's [one with

4686− a title](https://fsf.org "click here for a good time!").

3749+ a title](http://fsf.org "click here for a good time!").

46873750

46883751There can be no space between the bracketed part and the parenthesized part.

46893752The link text can contain formatting (such as emphasis), but the title cannot.

@@ -4712,7 +3775,7 @@ Here are some examples:

47123775

47133776 [my label 1]: /foo/bar.html "My title, optional"

47143777 [my label 2]: /foo

4715− [my label 3]: https://fsf.org (The free software foundation)

3778+ [my label 3]: http://fsf.org (The free software foundation)

47163779 [my label 4]: /bar#special 'A title in single quotes'

47173780

47183781The URL may optionally be surrounded by angle brackets:

@@ -4721,7 +3784,7 @@ The URL may optionally be surrounded by angle brackets:

47213784

47223785The title may go on the next line:

47233786

4724− [my label 3]: https://fsf.org

3787+ [my label 3]: http://fsf.org

47253788 "The free software foundation"

47263789

47273790Note that link labels are not case sensitive. So, this will work:

@@ -4759,7 +3822,7 @@ be omitted entirely:

47593822### Internal links ###

47603823

47613824To link to another section of the same document, use the automatically

4762−generated identifier (see [Heading identifiers]). For example:

3825+generated identifier (see [Header identifiers]). For example:

47633826

47643827 See the [Introduction](#introduction).

47653828

@@ -4772,7 +3835,8 @@ or

47723835Internal links are currently supported for HTML formats (including

47733836HTML slide shows and EPUB), LaTeX, and ConTeXt.

47743837

4775−## Images

3838+Images

3839+------

47763840

47773841A link immediately preceded by a `!` will be treated as an image.

47783842The link text will be used as the image's alt text:

@@ -4818,11 +3882,10 @@ Attributes can be set on links and images:

48183882(This syntax is compatible with [PHP Markdown Extra] when only `#id`

48193883and `.class` are used.)

48203884

4821−For HTML and EPUB, all known HTML5 attributes except `width` and

4822−`height` (but including `srcset` and `sizes`) are passed through

4823−as is. Unknown attributes are passed through as custom

4824−attributes, with `data-` prepended. The other writers ignore

4825−attributes that are not specifically supported by their output format.

3885+For HTML and EPUB, all attributes except `width` and `height` (but

3886+including `srcset` and `sizes`) are passed through as is. The other

3887+writers ignore attributes that are not supported by their output

3888+format.

48263889

48273890The `width` and `height` attributes on images are treated specially. When

48283891used without a unit, the unit is assumed to be pixels. However, any of

@@ -4834,12 +3897,10 @@ For example:

48343897{ width=50% }

48353898```

48363899

4837−- Dimensions may be converted to a form that is compatible with

4838− the output format (for example, dimensions given in pixels will

4839− be converted to inches when converting HTML to LaTeX). Conversion

4840− between pixels and physical measurements is affected by the

4841− `--dpi` option (by default, 96 dpi is assumed, unless the image

4842− itself contains dpi information).

3900+- Dimensions are converted to inches for output in page-based formats like

3901+ LaTeX. Dimensions are converted to pixels for output in HTML-like

3902+ formats. Use the `--dpi` option to specify the number of pixels per

3903+ inch. The default is 96dpi.

48433904- The `%` unit is generally relative to some available space.

48443905 For example the above example will render to the following.

48453906 - HTML: `<img href="file.jpg" style="width: 50%;" />`

@@ -4848,13 +3909,14 @@ For example:

48483909 as in the default template.)

48493910 - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`

48503911- Some output formats have a notion of a class

4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))

3912+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))

48523913 or a unique identifier (LaTeX `\caption`), or both (HTML).

48533914- When no `width` or `height` attributes are specified, the fallback

48543915 is to look at the image resolution and the dpi metadata embedded in

48553916 the image file.

48563917

4857−## Divs and Spans

3918+Divs and Spans

3919+--------------

48583920

48593921Using the `native_divs` and `native_spans` extensions

48603922(see [above][Extension: `native_divs`]), HTML syntax can

@@ -4910,7 +3972,8 @@ followed immediately by attributes:

49103972

49113973 [This is *some text*]{.class key="val"}

49123974

4913−## Footnotes

3975+Footnotes

3976+---------

49143977

49153978#### Extension: `footnotes` ####

49163979

@@ -4956,72 +4019,143 @@ they cannot contain multiple paragraphs). The syntax is as follows:

49564019

49574020Inline and regular footnotes may be mixed freely.

49584021

4959−## Citation syntax

4022+Citations

4023+---------

49604024

49614025#### Extension: `citations` ####

49624026

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:

4027+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate

4028+citations and a bibliography in a number of styles. Basic usage is

49664029

4967− Blah blah [@doe99; @smith2000; @smith2004].

4030+ pandoc --filter pandoc-citeproc myinput.txt

49684031

4969−How this is rendered depends on the citation style. In an

4970−author-date style, it might render as

4032+In order to use this feature, you will need to specify a bibliography file

4033+using the `bibliography` metadata field in a YAML metadata section, or

4034+`--bibliography` command line argument. You can supply multiple `--bibliography`

4035+arguments or set `bibliography` metadata field to YAML array, if you want to

4036+use multiple bibliography files. The bibliography may have any of these

4037+formats:

49714038

4972− Blah blah (Doe 1999, Smith 2000, 2004).

4039+ Format File extension

4040+ ------------ --------------

4041+ BibLaTeX .bib

4042+ BibTeX .bibtex

4043+ Copac .copac

4044+ CSL JSON .json

4045+ CSL YAML .yaml

4046+ EndNote .enl

4047+ EndNote XML .xml

4048+ ISI .wos

4049+ MEDLINE .medline

4050+ MODS .mods

4051+ RIS .ris

49734052

4974−In a footnote style, it might render as

4053+Note that `.bib` can be used with both BibTeX and BibLaTeX files;

4054+use `.bibtex` to force BibTeX.

49754055

4976− Blah blah.[^1]

4056+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`

4057+can produce `.json` and `.yaml` files from any of the supported formats.

49774058

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).

4059+In-field markup: In BibTeX and BibLaTeX databases,

4060+pandoc-citeproc parses a subset of LaTeX markup; in CSL YAML

4061+databases, pandoc Markdown; and in CSL JSON databases, an

4062+[HTML-like markup][CSL markup specs]:

49814063

4982−See the [CSL user documentation] for more information about CSL

4983−styles and how they affect rendering.

4064+`<i>...</i>`

4065+: italics

49844066

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]`.

4067+`<b>...</b>`

4068+: bold

49944069

4995−Citation items may optionally include a prefix, a locator, and

4996−a suffix. In

4070+`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`

4071+: small capitals

49974072

4998− Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].

4073+`<sub>...</sub>`

4074+: subscript

49994075

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.

4076+`<sup>...</sup>`

4077+: superscript

50034078

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

4079+`<span class="nocase">...</span>`

4080+: prevent a phrase from being capitalized as title case

4081+

4082+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON

4083+and CSL YAML formats as far as possible.

4084+

4085+As an alternative to specifying a bibliography file using `--bibliography`

4086+or the YAML metadata field `bibliography`, you can include

4087+the citation data directly in the `references` field of the

4088+document's YAML metadata. The field should contain an array of

4089+YAML-encoded references, for example:

4090+

4091+ ---

4092+ references:

4093+ - type: article-journal

4094+ id: WatsonCrick1953

4095+ author:

4096+ - family: Watson

4097+ given: J. D.

4098+ - family: Crick

4099+ given: F. H. C.

4100+ issued:

4101+ date-parts:

4102+ - - 1953

4103+ - 4

4104+ - 25

4105+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose

4106+ nucleic acid'

4107+ title-short: Molecular structure of nucleic acids

4108+ container-title: Nature

4109+ volume: 171

4110+ issue: 4356

4111+ page: 737-738

4112+ DOI: 10.1038/171737a0

4113+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html

4114+ language: en-GB

4115+ ...

4116+

4117+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one

4118+of the supported formats.)

4119+

4120+Citations and references can be formatted using any style supported by the

4121+[Citation Style Language], listed in the [Zotero Style Repository].

4122+These files are specified using the `--csl` option or the `csl` metadata field.

4123+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date

4124+format. The CSL project provides further information on [finding and editing styles].

4125+

4126+To make your citations hyperlinks to the corresponding bibliography

4127+entries, add `link-citations: true` to your YAML metadata.

4128+

4129+Citations go inside square brackets and are separated by semicolons.

4130+Each citation must have a key, composed of '@' + the citation

4131+identifier from the database, and may optionally have a prefix,

4132+a locator, and a suffix. The citation key must begin with a letter, digit,

4133+or `_`, and may contain alphanumerics, `_`, and internal punctuation

4134+characters (`:.#$%&-+?<>~/`). Here are some examples:

4135+

4136+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].

4137+

4138+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

4139+

4140+ Blah blah [@smith04; @doe99].

4141+

4142+`pandoc-citeproc` detects locator terms in the [CSL locale files].

4143+Either abbreviated or unabbreviated forms are accepted. In the `en-US`

4144+locale, locator terms can be written in either singular or plural forms,

4145+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,

4146+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;

4147+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,

4148+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,

4149+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;

4150+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no

50164151locator term is used, "page" is assumed.

50174152

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:

4153+`pandoc-citeproc` will use heuristics to distinguish the locator

4154+from the suffix. In complex cases, the locator can be enclosed

4155+in curly braces (using `pandoc-citeproc` 0.15 and higher only):

50214156

50224157 [@smith{ii, A, D-Z}, with a suffix]

50234158 [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]

5024− [@smith{}, 99 years later]

50254159

50264160A minus sign (`-`) before the `@` will suppress mention of

50274161the author in the citation. This can be useful when the

@@ -5029,103 +4163,83 @@ author is already mentioned in the text:

50294163

50304164 Smith says blah [-@smith04].

50314165

5032−You can also write an author-in-text citation, by omitting the

5033−square brackets:

4166+You can also write an in-text citation, as follows:

50344167

50354168 @smith04 says blah.

50364169

50374170 @smith04 [p. 33] says blah.

50384171

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.

5050−

5051−[CSL user documentation]: https://citationstyles.org/authors/

5052−[CSL]: https://docs.citationstyles.org/en/stable/specification.html

5053−[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields

5054−[Chicago Manual of Style]: https://chicagomanualofstyle.org

5055−[Citation Style Language]: https://citationstyles.org

4172+If the style calls for a list of works cited, it will be placed

4173+in a div with id `refs`, if one exists:

4174+

4175+ ::: {#refs}

4176+ :::

4177+

4178+Otherwise, it will be placed at the end of the document.

4179+Generation of the bibliography can be suppressed by setting

4180+`suppress-bibliography: true` in the YAML metadata.

4181+

4182+If you wish the bibliography to have a section header, you can

4183+set `reference-section-title` in the metadata, or put the header

4184+at the beginning of the div with id `refs` (if you are using it)

4185+or at the end of your document:

4186+

4187+ last paragraph...

4188+

4189+ # References

4190+

4191+The bibliography will be inserted after this header. Note that

4192+the `unnumbered` class will be added to this header, so that the

4193+section will not be numbered.

4194+

4195+If you want to include items in the bibliography without actually

4196+citing them in the body text, you can define a dummy `nocite` metadata

4197+field and put the citations there:

4198+

4199+ ---

4200+ nocite: |

4201+ @item1, @item2

4202+ ...

4203+

4204+ @item3

4205+

4206+In this example, the document will contain a citation for `item3`

4207+only, but the bibliography will contain entries for `item1`, `item2`, and

4208+`item3`.

4209+

4210+It is possible to create a bibliography with all the citations,

4211+whether or not they appear in the document, by using a wildcard:

4212+

4213+ ---

4214+ nocite: |

4215+ @*

4216+ ...

4217+

4218+For LaTeX output, you can also use [`natbib`] or [`biblatex`] to

4219+render the bibliography. In order to do so, specify bibliography

4220+files as outlined above, and add `--natbib` or `--biblatex`

4221+argument to `pandoc` invocation. Bear in mind that bibliography

4222+files have to be in respective format (either BibTeX or

4223+BibLaTeX).

4224+

4225+For more information, see the [pandoc-citeproc man page].

4226+

4227+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields

4228+[Chicago Manual of Style]: http://chicagomanualofstyle.org

4229+[Citation Style Language]: http://citationstyles.org

50564230[Zotero Style Repository]: https://www.zotero.org/styles

50574231[finding and editing styles]: https://citationstyles.org/authors/

50584232[CSL locale files]: https://github.com/citation-style-language/locales

4233+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md

50594234

5060−## Non-default extensions

4235+Non-pandoc extensions

4236+---------------------

50614237

50624238The following Markdown syntax extensions are not enabled by default

50634239in pandoc, but may be enabled by adding `+EXTENSION` to the format

50644240name, where `EXTENSION` is the name of the extension. Thus, for

50654241example, `markdown+hard_line_breaks` is Markdown with hard line breaks.

50664242

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−`` in `chap1/text.md` refer to

5080−`chap1/spider.jpg` and `` 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−`` in `chap1/text.md` and

5087−`` 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−

5098−#### Extension: `attributes` ####

5099−

5100−Allows attributes to be attached to any inline or block-level

5101−element. The syntax for the attributes is the same as that

5102−used in [`header_attributes`][Extension: `header_attributes`].

5103−

5104−- Attributes that occur immediately after an inline

5105− element affect that element. If they follow a space, then they

5106− belong to the space. (Hence, this option subsumes

5107− `inline_code_attributes` and `link_attributes`.)

5108−- Attributes that occur immediately before a block

5109− element, on a line by themselves, affect that

5110− element.

5111−- Consecutive attribute specifiers may be used,

5112− either for blocks or for inlines. Their attributes

5113− will be combined.

5114−- Attributes that occur at the end of the text of

5115− a Setext or ATX heading (separated by whitespace

5116− from the text) affect the heading element. (Hence, this

5117− option subsumes `header_attributes`.)

5118−- Attributes that occur after the opening fence

5119− in a fenced code block affect the code block element. (Hence,

5120− this option subsumes `fenced_code_attributes`.)

5121−- Attributes that occur at the end of a reference

5122− link definition affect links that refer to that

5123− definition.

5124−

5125−Note that pandoc's AST does not currently allow attributes

5126−to be attached to arbitrary elements. Hence a Span or Div

5127−container will be added if needed.

5128−

51294243#### Extension: `old_dashes` ####

51304244

51314245Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:

@@ -5238,13 +4352,13 @@ and image references. This extension should not be confused with the

52384352

52394353 This is a reference ![image][ref] with multimarkdown attributes.

52404354

5241− [ref]: https://path.to/image "Image title" width=20px height=30px

4355+ [ref]: http://path.to/image "Image title" width=20px height=30px

52424356 id=myId class="myClass1 myClass2"

52434357

52444358#### Extension: `mmd_header_identifiers` ####

52454359

5246−Parses multimarkdown style heading identifiers (in square brackets,

5247−after the heading but before any trailing `#`s in an ATX heading).

4360+Parses multimarkdown style header identifiers (in square brackets,

4361+after the header but before any trailing `#`s in an ATX header).

52484362

52494363#### Extension: `compact_definition_lists` ####

52504364

@@ -5273,390 +4387,60 @@ in several respects:

52734387 we must either disallow lazy wrapping or require a blank line between

52744388 list items.

52754389

5276−#### Extension: `gutenberg` ####

5277−

5278−Use [Project Gutenberg] conventions for `plain` output:

5279−all-caps for strong emphasis, surround by underscores

5280−for regular emphasis, add extra blank space around headings.

5281−

5282− [Project Gutenberg]: https://www.gutenberg.org

5283−

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−

5291−## Markdown variants

4390+Markdown variants

4391+-----------------

52924392

52934393In addition to pandoc's extended Markdown, the following Markdown

52944394variants are supported:

52954395

5296−- `markdown_phpextra` (PHP Markdown Extra)

5297−- `markdown_github` (deprecated GitHub-Flavored Markdown)

5298−- `markdown_mmd` (MultiMarkdown)

5299−- `markdown_strict` (Markdown.pl)

5300−- `commonmark` (CommonMark)

5301−- `gfm` (Github-Flavored Markdown)

5302−- `commonmark_x` (CommonMark with many pandoc extensions)

5303−

5304−To see which extensions are supported for a given format,

5305−and which are enabled by default, you can use the command

5306−

5307− pandoc --list-extensions=FORMAT

5308−

5309−where `FORMAT` is replaced with the name of the format.

5310−

5311−Note that the list of extensions for `commonmark`,

5312−`gfm`, and `commonmark_x` are defined relative to default

5313−commonmark. So, for example, `backtick_code_blocks`

5314−does not appear as an extension, since it is enabled by

5315−default and cannot be disabled.

5316−

5317−# Citations

5318−

5319−When the `--citeproc` option is used, pandoc can automatically generate

5320−citations and a bibliography in a number of styles. Basic usage is

5321−

5322− pandoc --citeproc myinput.txt

5323−

5324−To use this feature, you will need to have

5325−

5326−- a document containing citations (see [Extension: `citations`]);

5327−- a source of bibliographic data: either an external bibliography

5328− file or a list of `references` in the document's YAML metadata

5329−- optionally, a [CSL] citation style.

5330−

5331−## Specifying bibliographic data

5332−

5333−You can specify an external bibliography using the

5334−`bibliography` metadata field in a YAML metadata section or the

5335−`--bibliography` command line argument. If you want to use

5336−multiple bibliography files, you can supply multiple

5337−`--bibliography` arguments or set `bibliography` metadata field

5338−to YAML array. A bibliography may have any of these formats:

5339−

5340− Format File extension

5341− ------------ --------------

5342− BibLaTeX .bib

5343− BibTeX .bibtex

5344− CSL JSON .json

5345− CSL YAML .yaml

5346−

5347−Note that `.bib` can be used with both BibTeX and BibLaTeX files;

5348−use the extension `.bibtex` to force interpretation as BibTeX.

5349−

5350−In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup

5351−inside fields such as `title`; in CSL YAML databases, pandoc

5352−Markdown; and in CSL JSON databases, an [HTML-like markup][CSL

5353−markup specs]:

5354−

5355−`<i>...</i>`

5356−: italics

5357−

5358−`<b>...</b>`

5359−: bold

5360−

5361−`<span style="font-variant:small-caps;">...</span>` or `<sc>...</sc>`

5362−: small capitals

5363−

5364−`<sub>...</sub>`

5365−: subscript

5366−

5367−`<sup>...</sup>`

5368−: superscript

5369−

5370−`<span class="nocase">...</span>`

5371−: prevent a phrase from being capitalized as title case

5372−

5373−As an alternative to specifying a bibliography file using

5374−`--bibliography` or the YAML metadata field `bibliography`, you

5375−can include the citation data directly in the `references` field

5376−of the document's YAML metadata. The field should contain an

5377−array of YAML-encoded references, for example:

5378−

5379− ---

5380− references:

5381− - type: article-journal

5382− id: WatsonCrick1953

5383− author:

5384− - family: Watson

5385− given: J. D.

5386− - family: Crick

5387− given: F. H. C.

5388− issued:

5389− date-parts:

5390− - - 1953

5391− - 4

5392− - 25

5393− title: 'Molecular structure of nucleic acids: a structure for

5394− deoxyribose nucleic acid'

5395− title-short: Molecular structure of nucleic acids

5396− container-title: Nature

5397− volume: 171

5398− issue: 4356

5399− page: 737-738

5400− DOI: 10.1038/171737a0

5401− URL: https://www.nature.com/articles/171737a0

5402− language: en-GB

5403− ...

5404−

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−

5409−Note that `pandoc` can be used to produce such a YAML metadata

5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:

5411−

5412− pandoc chem.bib -s -f biblatex -t markdown

5413− pandoc chem.json -s -f csljson -t markdown

5414−

5415−Indeed, `pandoc` can convert between any of these

5416−citation formats:

5417−

5418− pandoc chem.bib -s -f biblatex -t csljson

5419− pandoc chem.yaml -s -f markdown -t biblatex

5420−

5421−Running pandoc on a bibliography file with the `--citeproc`

5422−option will create a formatted bibliography in the format

5423−of your choice:

5424−

5425− pandoc chem.bib -s --citeproc -o chem.html

5426− pandoc chem.bib -s --citeproc -o chem.pdf

5427−

5428−### Capitalization in titles

5429−

5430−If you are using a bibtex or biblatex bibliography, then observe

5431−the following rules:

5432−

5433− - English titles should be in title case. Non-English titles should

5434− be in sentence case, and the `langid` field in biblatex should be

5435− set to the relevant language. (The following values are treated

5436− as English: `american`, `british`, `canadian`, `english`,

5437− `australian`, `newzealand`, `USenglish`, or `UKenglish`.)

5438−

5439− - As is standard with bibtex/biblatex, proper names should be

5440− protected with curly braces so that they won't be lowercased

5441− in styles that call for sentence case. For example:

5442−

5443− title = {My Dinner with {Andre}}

5444−

5445− - In addition, words that should remain lowercase (or camelCase)

5446− should be protected:

5447−

5448− title = {Spin Wave Dispersion on the {nm} Scale}

5449−

5450− Though this is not necessary in bibtex/biblatex, it is necessary

5451− with citeproc, which stores titles internally in sentence case,

5452− and converts to title case in styles that require it. Here we

5453− protect "nm" so that it doesn't get converted to "Nm" at this stage.

5454−

5455−If you are using a CSL bibliography (either JSON or YAML), then observe

5456−the following rules:

5457−

5458− - All titles should be in sentence case.

5459−

5460− - Use the `language` field for non-English titles to prevent their

5461− conversion to title case in styles that call for this. (Conversion

5462− happens only if `language` begins with `en` or is left empty.)

5463−

5464− - Protect words that should not be converted to title case using

5465− this syntax:

5466−

5467− Spin wave dispersion on the <span class="nocase">nm</span> scale

5468−

5469−### Conference Papers, Published vs. Unpublished

5470−

5471−For a formally published conference paper, use the biblatex entry type

5472−`inproceedings` (which will be mapped to CSL `paper-conference`).

5473−

5474−For an unpublished manuscript, use the biblatex entry type

5475−`unpublished` without an `eventtitle` field (this entry type

5476−will be mapped to CSL `manuscript`).

5477−

5478−For a talk, an unpublished conference paper, or a poster

5479−presentation, use the biblatex entry type `unpublished` with an

5480−`eventtitle` field (this entry type will be mapped to CSL

5481−`speech`). Use the biblatex `type` field to indicate the type,

5482−e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful

5483−too, though `eventdate` will not be rendered by most CSL styles.

5484−Note that `venue` is for the event's venue, unlike `location`

5485−which describes the publisher's location; do not use the latter

5486−for an unpublished conference paper.

5487−

5488−

5489−## Specifying a citation style

5490−

5491−Citations and references can be formatted using any style supported by the

5492−[Citation Style Language], listed in the [Zotero Style Repository].

5493−These files are specified using the `--csl` option or the `csl`

5494−(or `citation-style`) metadata field. By default, pandoc will

5495−use the [Chicago Manual of Style] author-date format. (You can

5496−override this default by copying a CSL style of your choice

5497−to `default.csl` in your user data directory.)

5498−The CSL project provides further information on [finding and

5499−editing styles].

5500−

5501−The `--citation-abbreviations` option (or the

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:

5507−

5508−

5509− { "default": {

5510− "container-title": {

5511− "Lloyd's Law Reports": "Lloyd's Rep",

5512− "Estates Gazette": "EG",

5513− "Scots Law Times": "SLT"

5514− }

5515− }

5516− }

5517−

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−

5546−## Raw content in a style

5547−

5548−To include raw content in a prefix, suffix, delimiter, or term,

5549−surround it with these tags indicating the format:

5550−

5551− {{jats}}&lt;ref&gt;{{/jats}}

5552−

5553−Without the tags, the string will be interpreted as a string

5554−and escaped in the output, rather than being passed through raw.

5555−

5556−This feature allows stylesheets to be customized to give

5557−different output for different output formats. However,

5558−stylesheets customized in this way will not be usable

5559−by other CSL implementations.

5560−

5561−

5562−

5563−## Placement of the bibliography

5564−

5565−If the style calls for a list of works cited, it will be placed

5566−in a div with id `refs`, if one exists:

5567−

5568− ::: {#refs}

5569− :::

5570−

5571−Otherwise, it will be placed at the end of the document.

5572−Generation of the bibliography can be suppressed by setting

5573−`suppress-bibliography: true` in the YAML metadata.

5574−

5575−If you wish the bibliography to have a section heading, you can

5576−set `reference-section-title` in the metadata, or put the heading

5577−at the beginning of the div with id `refs` (if you are using it)

5578−or at the end of your document:

5579−

5580− last paragraph...

5581−

5582− # References

5583−

5584−The bibliography will be inserted after this heading. Note that

5585−the `unnumbered` class will be added to this heading, so that the

5586−section will not be numbered.

5587−

5588−## Including uncited items in the bibliography

5589−

5590−If you want to include items in the bibliography without actually

5591−citing them in the body text, you can define a dummy `nocite` metadata

5592−field and put the citations there:

5593−

5594− ---

5595− nocite: |

5596− @item1, @item2

5597− ...

5598−

5599− @item3

5600−

5601−In this example, the document will contain a citation for `item3`

5602−only, but the bibliography will contain entries for `item1`, `item2`, and

5603−`item3`.

5604−

5605−It is possible to create a bibliography with all the citations,

5606−whether or not they appear in the document, by using a wildcard:

5607−

5608− ---

5609− nocite: |

5610− @*

5611− ...

5612−

5613−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to

5614−render the bibliography. In order to do so, specify bibliography

5615−files as outlined above, and add `--natbib` or `--biblatex`

5616−argument to `pandoc` invocation. Bear in mind that bibliography

5617−files have to be in either BibTeX (for `--natbib`)

5618−or BibLaTeX (for `--biblatex`) format.

5619−

5620−## Other relevant metadata fields

5621−

5622−A few other metadata fields affect bibliography formatting:

5623−

5624−`link-citations`

5625−: If true, citations will be

5626− hyperlinked to the corresponding bibliography entries

5627− (for author-date and numerical styles only).

5628−

5629−`lang`

5630−: The `lang` field will affect how the style is localized,

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).

5648−

5649−`notes-after-punctuation`

5650−: If true (the default), pandoc will put footnote citations

5651− after following punctuation. For example, if the source

5652− contains `blah blah [@jones99].`, the result will look like

5653− `blah blah.[^1]`, with the note moved after the period and

5654− the space collapsed. If false, the space will still be

5655− collapsed, but the footnote will not be moved after the

5656− punctuation.

5657−

5658−

5659−# Slide shows

4396+`markdown_phpextra` (PHP Markdown Extra)

4397+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,

4398+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,

4399+ `header_attributes`, `link_attributes`, `abbreviations`,

4400+ `shortcut_reference_links`, `spaced_reference_links`.

4401+

4402+`markdown_github` (deprecated GitHub-Flavored Markdown)

4403+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,

4404+ `gfm_auto_identifiers`, `backtick_code_blocks`,

4405+ `autolink_bare_uris`, `space_in_atx_header`,

4406+ `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,

4407+ `shortcut_reference_links`, `angle_brackets_escapable`,

4408+ `lists_without_preceding_blankline`.

4409+

4410+`markdown_mmd` (MultiMarkdown)

4411+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,

4412+ `tex_math_double_backslash`, `intraword_underscores`,

4413+ `mmd_title_block`, `footnotes`, `definition_lists`,

4414+ `all_symbols_escapable`, `implicit_header_references`,

4415+ `auto_identifiers`, `mmd_header_identifiers`,

4416+ `shortcut_reference_links`, `implicit_figures`,

4417+ `superscript`, `subscript`, `backtick_code_blocks`,

4418+ `spaced_reference_links`, `raw_attribute`.

4419+

4420+`markdown_strict` (Markdown.pl)

4421+: `raw_html`, `shortcut_reference_links`,

4422+ `spaced_reference_links`.

4423+

4424+We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,

4425+which is implemented as a set of extensions on `commonmark`).

4426+

4427+Note, however, that `commonmark` and `gfm` have limited support

4428+for extensions. Only those listed below (and `smart`,

4429+`raw_tex`, and `hard_line_breaks`) will work. The extensions

4430+can, however, all be individually disabled. Also, `raw_tex`

4431+only affects `gfm` output, not input.

4432+

4433+`gfm` (GitHub-Flavored Markdown)

4434+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,

4435+ `gfm_auto_identifiers`, `backtick_code_blocks`,

4436+ `autolink_bare_uris`, `space_in_atx_header`,

4437+ `intraword_underscores`, `strikeout`, `task_lists`, `emoji`,

4438+ `shortcut_reference_links`, `angle_brackets_escapable`,

4439+ `lists_without_preceding_blankline`.

4440+

4441+

4442+Producing slide shows with pandoc

4443+=================================

56604444

56614445You can use pandoc to produce an HTML + JavaScript slide presentation

56624446that can be viewed via a web browser. There are five ways to do this,

@@ -5704,21 +4488,18 @@ To produce an HTML/JavaScript slide show, simply type

57044488

57054489where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.

57064490

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.

4491+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the

4492+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are

4493+assumed to be available at the relative path `s5/default` (for S5), `slideous`

4494+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at

4495+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,

4496+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for HTML slides],

4497+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in

4498+the file by default.

4499+

4500+With all HTML slide formats, the `--self-contained` option can be used to

4501+produce a single file that contains all of the data necessary to display the

4502+slide show, including linked scripts, stylesheets, images, and videos.

57224503

57234504To produce a PDF slide show using beamer, type

57244505

@@ -5731,13 +4512,14 @@ To produce a Powerpoint slide show, type

57314512

57324513 pandoc habits.txt -o habits.pptx

57334514

5734−## Structuring the slide show

4515+Structuring the slide show

4516+--------------------------

57354517

5736−By default, the *slide level* is the highest heading level in

4518+By default, the *slide level* is the highest header level in

57374519the hierarchy that is followed immediately by content, and not another

5738−heading, somewhere in the document. In the example above, level-1 headings

5739−are always followed by level-2 headings, which are followed by content,

5740−so the slide level is 2. This default can be overridden using

4520+header, somewhere in the document. In the example above, level 1 headers

4521+are always followed by level 2 headers, which are followed by content,

4522+so 2 is the slide level. This default can be overridden using

57414523the `--slide-level` option.

57424524

57434525The document is carved up into slides according to the following

@@ -5745,21 +4527,17 @@ rules:

57454527

57464528 * A horizontal rule always starts a new slide.

57474529

5748− * A heading at the slide level always starts a new slide.

4530+ * A header at the slide level always starts a new slide.

57494531

5750− * Headings *below* the slide level in the hierarchy create

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.)

4532+ * Headers *below* the slide level in the hierarchy create

4533+ headers *within* a slide.

57564534

5757− * Headings *above* the slide level in the hierarchy create

4535+ * Headers *above* the slide level in the hierarchy create

57584536 "title slides," which just contain the section title

57594537 and help to break the slide show into sections.

5760− Non-slide content under these headings will be included

5761− on the title slide (for HTML slide shows) or in a

5762− subsequent slide with the same title (for beamer).

4538+

4539+ * Content *above* the slide level will not appear in the slide

4540+ show.

57634541

57644542 * A title page is constructed automatically from the document's title

57654543 block, if present. (In the case of beamer, this can be disabled

@@ -5767,16 +4545,17 @@ rules:

57674545

57684546These rules are designed to support many different styles of slide show. If

57694547you don't care about structuring your slides into sections and subsections,

5770−you can just use level-1 headings for all each slide. (In that case, level-1

4548+you can just use level 1 headers for all each slide. (In that case, level 1

57714549will be the slide level.) But you can also structure the slide show into

57724550sections, as in the example above.

57734551

57744552Note: in reveal.js slide shows, if slide level is 2, a two-dimensional

5775−layout will be produced, with level-1 headings building horizontally

5776−and level-2 headings building vertically. It is not recommended that

4553+layout will be produced, with level 1 headers building horizontally

4554+and level 2 headers building vertically. It is not recommended that

57774555you use deeper nesting of section levels with reveal.js.

57784556

5779−## Incremental lists

4557+Incremental lists

4558+-----------------

57804559

57814560By default, these writers produce lists that display "all at once."

57824561If you want your lists to display incrementally (one item at a time),

@@ -5814,10 +4593,8 @@ option):

58144593Both methods allow incremental and nonincremental lists to be mixed

58154594in a single document.

58164595

5817−Note: Neither the `-i/--incremental` option nor any of the

5818−methods described here currently works for PowerPoint output.

5819−

5820−## Inserting pauses

4596+Inserting pauses

4597+----------------

58214598

58224599You can add "pauses" within a slide by including a paragraph containing

58234600three dots, separated by spaces:

@@ -5830,9 +4607,8 @@ three dots, separated by spaces:

58304607

58314608 content after the pause

58324609

5833−Note: this feature is not yet implemented for PowerPoint output.

5834−

5835−## Styling the slides

4610+Styling the slides

4611+------------------

58364612

58374613You can change the style of HTML slides by putting customized CSS files

58384614in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),

@@ -5857,9 +4633,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,

58574633

58584634 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf

58594635

5860−Note that heading attributes will turn into slide attributes

4636+Note that header attributes will turn into slide attributes

58614637(on a `<div>` or `<section>`) in HTML slide formats, allowing you

5862−to style individual slides. In beamer, the only heading attribute

4638+to style individual slides. In beamer, the only header attribute

58634639that affects slides is the `allowframebreaks` class, which sets the

58644640`allowframebreaks` option, causing multiple slides to be created

58654641if the content overfills the frame. This is recommended especially for

@@ -5867,7 +4643,8 @@ bibliographies:

58674643

58684644 # References {.allowframebreaks}

58694645

5870−## Speaker notes

4646+Speaker notes

4647+-------------

58714648

58724649Speaker notes are supported in reveal.js and PowerPoint (pptx)

58734650output. You can add notes to your Markdown document thus:

@@ -5888,7 +4665,8 @@ in handouts and presenter view.

58884665Notes are not yet supported for other slide formats, but the notes

58894666will not appear on the slides themselves.

58904667

5891−## Columns

4668+Columns

4669+-------

58924670

58934671To put material in side by side columns, you can use a native

58944672div container with class `columns`, containing two or more div

@@ -5903,46 +4681,12 @@ containers with class `column` and a `width` attribute:

59034681 :::

59044682 ::::::::::::::

59054683

5906−### Additional columns attributes in beamer

5907−

5908−The div containers with classes `columns` and `column` can optionally have

5909−an `align` attribute.

5910−The class `columns` can optionally have a `totalwidth` attribute or an

5911−`onlytextwidth` class.

5912−

5913− :::::::::::::: {.columns align=center totalwidth=8em}

5914− ::: {.column width="40%"}

5915− contents...

5916− :::

5917− ::: {.column width="60%" align=bottom}

5918− contents...

5919− :::

5920− ::::::::::::::

5921−

5922−The `align` attributes on `columns` and `column` can be used with the

5923−values `top`, `top-baseline`, `center` and `bottom` to vertically align

5924−the columns. It defaults to `top` in `columns`.

5925−

5926−The `totalwidth` attribute limits the width of the columns to the given value.

5927−

5928− :::::::::::::: {.columns align=top .onlytextwidth}

5929− ::: {.column width="40%" align=center}

5930− contents...

5931− :::

5932− ::: {.column width="60%"}

5933− contents...

5934− :::

5935− ::::::::::::::

5936−

5937−The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.

5938−

5939−See Section 12.7 of the [Beamer User's Guide] for more details.

5940−

5941−## Frame attributes in beamer

4684+Frame attributes in beamer

4685+--------------------------

59424686

59434687Sometimes it is necessary to add the LaTeX `[fragile]` option to

59444688a frame in beamer (for example, when using the `minted` environment).

5945−This can be forced by adding the `fragile` class to the heading

4689+This can be forced by adding the `fragile` class to the header

59464690introducing the slide:

59474691

59484692 # Fragile slide {.fragile}

@@ -5952,9 +4696,10 @@ the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,

59524696`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,

59534697`shrink`, `standout`, `noframenumbering`.

59544698

5955−## Background in reveal.js and beamer

4699+Background in reveal.js and beamer

4700+----------------------------------

59564701

5957−Background images can be added to self-contained reveal.js slideshows and

4702+Background images can be added to self-contained reveal.js slideshows and

59584703to beamer slideshows.

59594704

59604705For the same image on every slide, use the configuration

@@ -5962,14 +4707,14 @@ option `background-image` either in the YAML metadata block

59624707or as a command-line variable. (There are no other options in

59634708beamer and the rest of this section concerns reveal.js slideshows.)

59644709

5965−For reveal.js, you can instead use the reveal.js-native option

5966−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`

5967−and `parallaxBackgroundVertical` the same way and must also set

4710+For reveal.js, you can instead use the reveal.js-native option

4711+`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`

4712+and `parallaxBackgroundVertical` the same way and must also set

59684713`parallaxBackgroundSize` to have your values take effect.

59694714

59704715To set an image for a particular reveal.js slide, add

59714716`{data-background-image="/path/to/image"}`

5972−to the first slide-level heading on the slide (which may even be empty).

4717+to the first slide-level header on the slide (which may even be empty).

59734718

59744719In reveal.js's overview mode, the parallaxBackgroundImage will show up

59754720only on the first slide.

@@ -5978,12 +4723,9 @@ Other reveal.js background settings also work on individual slides, including

59784723`data-background-size`, `data-background-repeat`, `data-background-color`,

59794724`data-transition`, and `data-transition-speed`.

59804725

5981−To add a background image to the automatically generated title slide, use the

5982−`title-slide-attributes` variable in the YAML metadata block. It must contain

5983−a map of attribute names and values.

5984−

5985−See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more

5986−details.

4726+See the [reveal.js

4727+documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)

4728+for more details.

59874729

59884730For example in reveal.js:

59894731

@@ -5991,9 +4733,6 @@ For example in reveal.js:

59914733---

59924734title: My Slideshow

59934735parallaxBackgroundImage: /path/to/my/background_image.png

5994−title-slide-attributes:

5995− data-background-image: /path/to/title_image.png

5996− data-background-size: contain

59974736---

59984737

59994738## Slide One

@@ -6002,12 +4741,14 @@ Slide 1 has background_image.png as its background.

60024741

60034742## {data-background-image="/path/to/special_image.jpg"}

60044743

6005−Slide 2 has a special image for its background, even though the heading has no content.

4744+Slide 2 has a special image for its background, even though the header has no content.

60064745```

60074746

6008−# EPUBs

4747+Creating EPUBs with pandoc

4748+==========================

60094749

6010−## EPUB Metadata

4750+EPUB Metadata

4751+-------------

60114752

60124753EPUB metadata may be specified using the `--epub-metadata` option, but

60134754if the source document is Markdown, it is better to use a [YAML metadata

@@ -6085,15 +4826,6 @@ The following fields are recognized:

60854826

60864827`rights`

60874828 ~ 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.

60974829

60984830`cover-image`

60994831 ~ A string value (path to cover image).

@@ -6115,12 +4847,13 @@ The following fields are recognized:

61154847 - `binding`: `true`|`false` (default `true`)

61164848 - `scroll-axis`: `vertical`|`horizontal`|`default`

61174849

6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html

4850+[MARC relators]: http://loc.gov/marc/relators/relaterm.html

61194851[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem

61204852

6121−## The `epub:type` attribute

4853+The `epub:type` attribute

4854+-------------------------

61224855

6123−For `epub3` output, you can mark up the heading that corresponds to an EPUB

4856+For `epub3` output, you can mark up the header that corresponds to an EPUB

61244857chapter using the [`epub:type` attribute][epub-type]. For example, to set

61254858the attribute to the value `prologue`, use this markdown:

61264859

@@ -6143,26 +4876,22 @@ abstract frontmatter

61434876acknowledgments frontmatter

61444877copyright-page frontmatter

61454878dedication frontmatter

6146−credits frontmatter

6147−keywords frontmatter

6148−imprint frontmatter

6149−contributors frontmatter

6150−other-credits frontmatter

6151−errata frontmatter

6152−revision-history frontmatter

6153−titlepage frontmatter

6154−halftitlepage frontmatter

6155−seriespage frontmatter

61564879foreword frontmatter

4880+halftitle, frontmatter

4881+introduction frontmatter

61574882preface frontmatter

4883+seriespage frontmatter

4884+titlepage frontmatter

4885+afterword backmatter

61584886appendix backmatter

61594887colophon backmatter

6160−bibliography backmatter

6161−index backmatter

4888+conclusion backmatter

4889+epigraph backmatter

61624890

61634891[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute

61644892

6165−## Linked media

4893+Linked media

4894+------------

61664895

61674896By default, pandoc will download media referenced from any `<img>`, `<audio>`,

61684897`<video>` or `<source>` element present in the generated EPUB,

@@ -6172,12 +4901,13 @@ instead, use raw HTML in your source and add `data-external="1"` to the tag

61724901with the `src` attribute. For example:

61734902

61744903 <audio controls="1">

6175− <source src="https://example.com/music/toccata.mp3"

4904+ <source src="http://example.com/music/toccata.mp3"

61764905 data-external="1" type="audio/mpeg">

61774906 </source>

61784907 </audio>

61794908

6180−# Jupyter notebooks

4909+Creating Jupyter notebooks with pandoc

4910+======================================

61814911

61824912When creating a [Jupyter notebook], pandoc will try to infer the

61834913notebook structure. Code blocks with the class `code` will be

@@ -6284,25 +5014,8 @@ hello

62845014::::::

62855015````

62865016

6287−If you include raw HTML or TeX in an output cell, use the

6288−[raw attribute][Extension: `fenced_attribute`], as shown

6289−in the last cell of the example above. Although pandoc can

6290−process "bare" raw HTML and TeX, the result is often

6291−interspersed raw elements and normal textual elements, and

6292−in an output cell pandoc expects a single, connected raw

6293−block. To avoid using raw HTML or TeX except when

6294−marked explicitly using raw attributes, we recommend

6295−specifying the extensions `-raw_html-raw_tex+raw_attribute` when

6296−translating between Markdown and ipynb notebooks.

6297−

6298−Note that options and extensions that affect reading and

6299−writing of Markdown will also affect Markdown cells in ipynb

6300−notebooks. For example, `--wrap=preserve` will preserve

6301−soft line breaks in Markdown cells; `--atx-headers` will

6302−cause ATX-style headings to be used; and `--preserve-tabs` will

6303−prevent tabs from being turned to spaces.

6304−

6305−# Syntax highlighting

5017+Syntax highlighting

5018+===================

63065019

63075020Pandoc will automatically highlight syntax in [fenced code blocks] that

63085021are marked with a language name. The Haskell library [skylighting] is

@@ -6330,7 +5043,7 @@ Then edit `my.theme` and use it like this:

63305043If you are not satisfied with the built-in highlighting, or you

63315044want highlight a language that isn't supported, you can use the

63325045`--syntax-definition` option to load a [KDE-style XML syntax definition

6333−file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).

5046+file](https://docs.kde.org/stable5/en/applications/katepart/highlight.html).

63345047Before writing your own, have a look at KDE's [repository of syntax

63355048definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).

63365049

@@ -6338,58 +5051,13 @@ To disable highlighting, use the `--no-highlight` option.

63385051

63395052[skylighting]: https://github.com/jgm/skylighting

63405053

6341−# Custom Styles

5054+Custom Styles

5055+=============

63425056

63435057Custom styles can be used in the docx and ICML formats.

63445058

6345−## Output

6346−

6347−By default, pandoc's docx and ICML output applies a predefined set of styles

6348−for blocks such as paragraphs and block quotes, and uses largely default

6349−formatting (italics, bold) for inlines. This will work for most

6350−purposes, especially alongside a `reference.docx` file. However, if you

6351−need to apply your own styles to blocks, or match a preexisting set of

6352−styles, pandoc allows you to define custom styles for blocks and text

6353−using `div`s and `span`s, respectively.

6354−

6355−If you define a `div` or `span` with the attribute `custom-style`,

6356−pandoc will apply your specified style to the contained elements (with

6357−the exception of elements whose function depends on a style, like

6358−headings, code blocks, block quotes, or links). So, for example, using

6359−the `bracketed_spans` syntax,

6360−

6361− [Get out]{custom-style="Emphatically"}, he said.

6362−

6363−would produce a docx file with "Get out" styled with character

6364−style `Emphatically`. Similarly, using the `fenced_divs` syntax,

6365−

6366− Dickinson starts the poem simply:

6367−

6368− ::: {custom-style="Poetry"}

6369− | A Bird came down the Walk---

6370− | He did not know I saw---

6371− :::

6372−

6373−would style the two contained lines with the `Poetry` paragraph style.

6374−

6375−For docx output, styles will be defined in the output file as inheriting

6376−from normal text, if the styles are not yet in your reference.docx.

6377−If they are already defined, pandoc will not alter the definition.

6378−

6379−This feature allows for greatest customization in conjunction with

6380−[pandoc filters]. If you want all paragraphs after block quotes to be

6381−indented, you can write a filter to apply the styles necessary. If you

6382−want all italics to be transformed to the `Emphasis` character style

6383−(perhaps to change their color), you can write a filter which will

6384−transform all italicized inlines to inlines within an `Emphasis`

6385−custom-style `span`.

6386−

6387−For docx output, you don't need to enable any extensions for

6388−custom styles to work.

6389−

6390−[pandoc filters]: https://pandoc.org/filters.html

6391−

6392−## Input

5059+Input

5060+-----

63935061

63945062The docx reader, by default, only reads those styles that it can

63955063convert into pandoc elements, either by direct conversion or

@@ -6418,17 +5086,17 @@ And with the extension:

64185086

64195087 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown

64205088

6421− ::: {custom-style="First Paragraph"}

5089+ ::: {custom-style="FirstParagraph"}

64225090 This is some text.

64235091 :::

64245092

6425− ::: {custom-style="Body Text"}

5093+ ::: {custom-style="BodyText"}

64265094 This is text with an [emphasized]{custom-style="Emphatic"} text style.

64275095 And this is text with a [strengthened]{custom-style="Strengthened"}

64285096 text style.

64295097 :::

64305098

6431− ::: {custom-style="My Block Style"}

5099+ ::: {custom-style="MyBlockStyle"}

64325100 > Here is a styled paragraph that inherits from Block Text.

64335101 :::

64345102

@@ -6436,47 +5104,70 @@ With these custom styles, you can use your input document as a

64365104reference-doc while creating docx output (see below), and maintain the

64375105same styles in your input and output files.

64385106

6439−# Custom writers

5107+Output

5108+------

5109+

5110+By default, pandoc's docx and ICML output applies a predefined set of styles

5111+for blocks such as paragraphs and block quotes, and uses largely default

5112+formatting (italics, bold) for inlines. This will work for most

5113+purposes, especially alongside a `reference.docx` file. However, if you

5114+need to apply your own styles to blocks, or match a preexisting set of

5115+styles, pandoc allows you to define custom styles for blocks and text

5116+using `div`s and `span`s, respectively.

5117+

5118+If you define a `div` or `span` with the attribute `custom-style`,

5119+pandoc will apply your specified style to the contained elements. So,

5120+for example using the `bracketed_spans` syntax,

5121+

5122+ [Get out]{custom-style="Emphatically"}, he said.

5123+

5124+would produce a docx file with "Get out" styled with character

5125+style `Emphatically`. Similarly, using the `fenced_divs` syntax,

5126+

5127+ Dickinson starts the poem simply:

5128+

5129+ ::: {custom-style="Poetry"}

5130+ | A Bird came down the Walk---

5131+ | He did not know I saw---

5132+ :::

5133+

5134+would style the two contained lines with the `Poetry` paragraph style.

5135+

5136+For docx output, styles will be defined in the output file as inheriting

5137+from normal text, if the styles are not yet in your reference.docx.

5138+If they are already defined, pandoc will not alter the definition.

5139+

5140+This feature allows for greatest customization in conjunction with

5141+[pandoc filters]. If you want all paragraphs after block quotes to be

5142+indented, you can write a filter to apply the styles necessary. If you

5143+want all italics to be transformed to the `Emphasis` character style

5144+(perhaps to change their color), you can write a filter which will

5145+transform all italicized inlines to inlines within an `Emphasis`

5146+custom-style `span`.

5147+

5148+[pandoc filters]: http://pandoc.org/filters.html

64405149

6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc

6442−includes a Lua interpreter, so Lua need not be installed separately.)

5150+Custom writers

5151+==============

64435152

6444−To use a custom writer, simply specify the path to the Lua script

5153+Pandoc can be extended with custom writers written in [lua]. (Pandoc

5154+includes a lua interpreter, so lua need not be installed separately.)

5155+

5156+To use a custom writer, simply specify the path to the lua script

64455157in place of the output format. For example:

64465158

64475159 pandoc -t data/sample.lua

64485160

6449−Creating a custom writer requires writing a Lua function for each

5161+Creating a custom writer requires writing a lua function for each

64505162possible element in a pandoc document. To get a documented example

64515163which you can modify according to your needs, do

64525164

64535165 pandoc --print-default-data-file sample.lua

64545166

6455−Note that custom writers have no default template. If you want

6456−to use `--standalone` with a custom writer, you will need to

6457−specify a template manually using `--template` or add a new

6458−default template with the name

6459−`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`

6460−subdirectory of your user data directory (see [Templates]).

6461−

6462−[Lua]: https://www.lua.org

6463−

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).

5167+[lua]: http://www.lua.org

64785168

6479−# A note on security

5169+A note on security

5170+==================

64805171

64815172If you use pandoc to convert user-contributed content in a web

64825173application, here are some things to keep in mind:

@@ -6491,7 +5182,7 @@ application, here are some things to keep in mind:

64915182 shelling out to the executable), it is possible to use it in a mode

64925183 that fully isolates pandoc from your file system, by running the

64935184 pandoc operations in the `PandocPure` monad. See the document

6494− [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)

5185+ [Using the pandoc API](http://pandoc.org/using-the-pandoc-api.html)

64955186 for more details.

64965187

649751883. Pandoc's parsers can exhibit pathological performance on some

@@ -6504,17 +5195,17 @@ application, here are some things to keep in mind:

650451954. The HTML generated by pandoc is not guaranteed to be safe.

65055196 If `raw_html` is enabled for the Markdown input, users can

65065197 inject arbitrary HTML. Even if `raw_html` is disabled,

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.

5198+ users can include dangerous content in attributes for

5199+ headers, spans, and code blocks. To be safe, you should

5200+ run all the generated HTML through an HTML sanitizer.

65105201

6511−# Authors

5202+Authors

5203+=======

65125204

6513−Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released

5205+Copyright 2006--2019 John MacFarlane (jgm@berkeley.edu). Released

65145206under the [GPL], version 2 or greater. This software carries no

65155207warranty of any kind. (See COPYRIGHT for full copyright and

65165208warranty notices.) For a full list of contributors, see the file

65175209AUTHORS.md in the pandoc source code.

65185210

6519−[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"

6520−[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"

5211+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

Makefile+75−81

@@ -1,79 +1,55 @@

11version?=$(shell grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')

22pandoc=$(shell find dist -name pandoc -type f -exec ls -t {} \; | head -1)

3−SOURCEFILES?=$(shell git ls-tree -r master --name-only | grep "\.hs$$")

3+SOURCEFILES?=$(shell find pandoc.hs src test -name '*.hs')

44BRANCH?=master

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

5+RESOLVER?=lts-13

6+GHCOPTS=-fdiagnostics-color=always -Wall -fno-warn-unused-do-bind -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -Wincomplete-uni-patterns -Werror=missing-home-modules -Widentities -Wcpp-undef -fhide-source-paths -j +RTS -A32M -RTS

7+# Later:

8+# -Wpartial-fields (currently used in Powerpoint writer)

9+# -Wmissing-export-lists (currently some Odt modules violate this)

10+# -Wredundant-constraints (problematic if we want to support older base)

1711WEBSITE=../../web/pandoc.org

18−REVISION?=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)",)

2312

2413quick:

25− stack install --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --ghc-options='$(GHCOPTS)' --test-arguments='-j4 --hide-successes $(TESTARGS)'

14+ stack install --resolver=$(RESOLVER) --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --test-arguments='-j4 --hide-successes $(TESTARGS)'

2615

2716quick-cabal:

28− cabal new-configure . --ghc-options '$(GHCOPTS)' --disable-optimization --enable-tests

29− cabal new-build -j4 . --disable-optimization

17+ cabal new-configure . --ghc-options '$(GHCOPTS)' --flags '+embed_data_files' --enable-tests

18+ cabal new-build . --disable-optimization

19+ cabal new-install --symlink-bindir=$$HOME/.local/bin

3020 cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)

3121

3222full-cabal:

33− cabal new-configure . --ghc-options '$(GHCOPTS)' --flags '+embed_data_files +trypandoc' --enable-tests --enable-benchmarks

23+ cabal new-configure . --ghc-options '$(GHCOPTS)' --flags '+embed_data_files +weigh-pandoc +trypandoc' --enable-tests --enable-benchmarks

3424 cabal new-build . --disable-optimization

25+ cabal new-install --symlink-bindir=$$HOME/.local/bin

3526 cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)

3627

3728full:

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)'

39−

40−ghci:

41− stack ghci --flag 'pandoc:embed_data_files'

29+ stack install --resolver=$(RESOLVER) --flag 'pandoc:embed_data_files' --flag 'pandoc:weigh-pandoc' --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)'

4230

4331haddock:

44− stack haddock

32+ stack haddock --resolver=$(RESOLVER)

4533

4634# Note: to accept current results of golden tests,

4735# make test TESTARGS='--accept'

4836test:

49− stack test --flag 'pandoc:embed_data_files' --fast --test-arguments='-j4 --hide-successes $(TESTARGS)' --ghc-options '$(GHCOPTS)'

50−

51−ghcid:

52− ghcid -c "stack repl --flag 'pandoc:embed_data_files'"

53−

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"

37+ stack test --resolver=$(RESOLVER) --flag 'pandoc:embed_data_files' --fast --test-arguments='-j4 --hide-successes $(TESTARGS)' --ghc-options '$(GHCOPTS)'

5638

5739bench:

58− stack bench \

59− --ghc-options '$(GHCOPTS)' \

60− --benchmark-arguments='$(BENCHARGS)' 2>&1 | \

61− tee "bench_latest.txt"

40+ stack bench --benchmark-arguments='$(BENCHARGS)' --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)'

41+

42+weigh:

43+ stack build --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)' --flag 'pandoc:weigh-pandoc' && stack exec weigh-pandoc

6244

6345reformat:

6446 for f in $(SOURCEFILES); do echo $$f; stylish-haskell -i $$f ; done

6547

66−lint: hlint fix_spacing

67−

68−hlint:

69− for f in $(SOURCEFILES); do echo $$f; hlint --verbose --refactor --refactor-options='-s -o -' $$f; done

70−

71−fix_spacing:

72− # Fix trailing newlines and spaces at ends of lines

73− for f in $(SOURCEFILES); do printf '%s\n' "`cat $$f`" | sed -e 's/ *$$//' > $$f.tmp; mv $$f.tmp $$f; done

48+lint:

49+ for f in $(SOURCEFILES); do echo $$f; hlint --verbose --refactor --refactor-options='-i -s' $$f; done

7450

7551changes_github:

76− pandoc --filter tools/extract-changes.hs changelog.md -t gfm --wrap=none --template tools/changes_template.html | sed -e 's/\\#/#/g' | pbcopy

52+ pandoc --filter tools/extract-changes.hs changelog -t gfm --wrap=none | sed -e 's/\\#/#/g' | pbcopy

7753

7854dist: man/pandoc.1

7955 cabal sdist

@@ -82,34 +58,62 @@ dist: man/pandoc.1

8258 cd pandoc-${version}

8359 stack setup && stack test && cd .. && rm -rf "pandoc-${version}"

8460

85−check: checkdocs check-cabal

61+packages: checkdocs winpkg debpkg macospkg

8662

87−checkdocs:

88− ! grep -q -n -e "\t" MANUAL.txt changelog.md

63+checkdocs: README.md

64+ ! grep -n -e "\t" MANUAL.txt changelog

8965

9066debpkg: man/pandoc.1

91− docker run -v `pwd`:/mnt \

92− -v `pwd`/linux/artifacts:/artifacts \

93− --user $(id -u):$(id -g) \

94− -e REVISION=$(REVISION) \

95− -w /mnt \

96− --memory=0 \

97− --rm \

98− $(DOCKERIMAGE) \

99− bash \

100− /mnt/linux/make_artifacts.sh 2>&1 > docker.log

101−

102−man/pandoc.1: MANUAL.txt man/pandoc.1.before man/pandoc.1.after

103− pandoc $< -f markdown -t man -s \

67+ make -C linux && \

68+ cp linux/artifacts/pandoc-$(version)-*.* .

69+

70+macospkg: man/pandoc.1

71+ ./macos/make_macos_package.sh

72+

73+winpkg: pandoc-$(version)-windows-i386.msi pandoc-$(version)-windows-i386.zip pandoc-$(version)-windows-x86_64.msi pandoc-$(version)-windows-x86_64.zip

74+

75+pandoc-$(version)-windows-%.zip: pandoc-$(version)-windows-%.msi

76+ ORIGDIR=`pwd` && \

77+ CONTAINER=$(basename $<) && \

78+ TEMPDIR=`mktemp -d` && \

79+ msiextract -C $$TEMPDIR/msi $< && \

80+ pushd $$TEMPDIR && \

81+ mkdir $$CONTAINER && \

82+ find msi -type f -exec cp {} $$CONTAINER/ \; && \

83+ zip -r $$ORIGDIR/$@ $$CONTAINER && \

84+ popd & \

85+ rm -rf $$TEMPDIR

86+

87+pandoc-$(version)-windows-%.msi: pandoc-windows-%.msi

88+ osslsigncode sign -pkcs12 ~/Private/ComodoCodeSigning.exp2019.p12 -in $< -i http://johnmacfarlane.net/ -t http://timestamp.comodoca.com/ -out $@ -askpass

89+ rm $<

90+

91+.INTERMEDIATE: pandoc-windows-i386.msi pandoc-windows-x86_64.msi

92+

93+pandoc-windows-i386.msi:

94+ JOBID=$(shell curl https://ci.appveyor.com/api/projects/jgm/pandoc | jq '.build.jobs[]| select(.name|test("i386")) | .jobId') && \

95+ wget "https://ci.appveyor.com/api/buildjobs/$$JOBID/artifacts/windows%2F$@" -O $@

96+

97+pandoc-windows-x86_64.msi:

98+ JOBID=$(shell curl https://ci.appveyor.com/api/projects/jgm/pandoc | jq '.build.jobs[]| select(.name|test("x86_64")) | .jobId') && \

99+ wget "https://ci.appveyor.com/api/buildjobs/$$JOBID/artifacts/windows%2F$@" -O $@

100+

101+man/pandoc.1: MANUAL.txt man/pandoc.1.template

102+ pandoc $< -f markdown-smart -t man -s --template man/pandoc.1.template \

104103 --lua-filter man/manfilter.lua \

105− --include-before-body man/pandoc.1.before \

106− --include-after-body man/pandoc.1.after \

107− --metadata author="" \

108− --variable footer="pandoc $(version)" \

104+ --variable version="pandoc $(version)" \

109105 -o $@

110106

107+doc/lua-filters.md: tools/ldoc.ltp data/pandoc.lua tools/update-lua-docs.lua

108+ cp $@ $@.tmp

109+ pandoc -t markdown --columns=64 --atx-headers \

110+ -f markdown -t markdown --standalone\

111+ --lua-filter tools/update-lua-docs.lua \

112+ -o $@ $@.tmp

113+ rm $@.tmp

114+

111115README.md: README.template MANUAL.txt tools/update-readme.lua

112− pandoc --lua-filter tools/update-readme.lua \

116+ pandoc --lua-filter tools/update-readme.lua --reference-links \

113117 --reference-location=section -t gfm $< -o $@

114118

115119download_stats:

@@ -118,9 +122,9 @@ download_stats:

118122

119123pandoc-templates:

120124 rm ../pandoc-templates/default.* ; \

121− cp data/templates/* ../pandoc-templates/ ; \

125+ cp data/templates/default.* ../pandoc-templates/ ; \

122126 pushd ../pandoc-templates/ && \

123− git add * && \

127+ git add default.* && \

124128 git commit -m "Updated templates for pandoc $(version)" && \

125129 popd

126130

@@ -135,14 +139,4 @@ update-website:

135139clean:

136140 stack clean

137141

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

142+.PHONY: deps quick full haddock install clean test bench changes_github macospkg dist prof download_stats reformat lint weigh doc/lua-filters.md packages pandoc-templates trypandoc update-website debpkg macospkg winpkg checkdocs

README.md+109−140

@@ -8,83 +8,72 @@ pandoc --lua-filter tools/update-readme.lua README.template -o README.md

88[![github

99release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)

1010[![hackage

11−release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)

12−[](https://formulae.brew.sh/formula/pandoc)

11+release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)

12+[](http://brewformulas.org/Pandoc)

1313[![stackage LTS

14−package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)

15−[![CI

16−tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)

14+package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)

15+[](https://circleci.com/gh/jgm/pandoc)

16+[![appveyor build

17+status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)

1718[](https://www.gnu.org/licenses/gpl.html)

1819[![pandoc-discuss on google

1920groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)

2021

2122## The universal markup converter

2223

23−Pandoc is a [Haskell](https://haskell.org) library for converting from

24+Pandoc is a [Haskell](http://haskell.org) library for converting from

2425one markup format to another, and a command-line tool that uses this

2526library. It can convert *from*

2627

2728<div id="input-formats">

2829

29−- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)

30−- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)

31−- `commonmark` ([CommonMark](https://commonmark.org) Markdown)

32−- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with

33− extensions)

34−- `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))

35−- `csljson` ([CSL

36− JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)

37− bibliography)

38−- `csv` ([CSV](https://tools.ietf.org/html/rfc4180) table)

39−- `docbook` ([DocBook](https://docbook.org))

40−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

41−- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

42−- `epub` ([EPUB](http://idpf.org/epub))

43−- `fb2`

30+ - `commonmark` ([CommonMark](http://commonmark.org) Markdown)

31+ - `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))

32+ - `docbook` ([DocBook](http://docbook.org))

33+ - `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

34+ - `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

35+ - `epub` ([EPUB](http://idpf.org/epub))

36+ - `fb2`

4437 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)

4538 e-book)

46−- `gfm` ([GitHub-Flavored

39+ - `gfm` ([GitHub-Flavored

4740 Markdown](https://help.github.com/articles/github-flavored-markdown/)),

4841 or the deprecated and less accurate `markdown_github`; use

49− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)

50− only if you need extensions not supported in

51− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).

52−- `haddock` ([Haddock

42+ [`markdown_github`](#markdown-variants) only if you need extensions

43+ not supported in [`gfm`](#markdown-variants).

44+ - `haddock` ([Haddock

5345 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

54−- `html` ([HTML](https://www.w3.org/html/))

55−- `ipynb` ([Jupyter

46+ - `html` ([HTML](http://www.w3.org/html/))

47+ - `ipynb` ([Jupyter

5648 notebook](https://nbformat.readthedocs.io/en/latest/))

57−- `jats` ([JATS](https://jats.nlm.nih.gov) XML)

58−- `jira`

59− ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence

60− wiki markup)

61−- `json` (JSON version of native AST)

62−- `latex` ([LaTeX](https://www.latex-project.org/))

63−- `markdown` ([Pandoc’s

64− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))

65−- `markdown_mmd`

66− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))

67−- `markdown_phpextra` ([PHP Markdown

49+ - `jats` ([JATS](https://jats.nlm.nih.gov) XML)

50+ - `json` (JSON version of native AST)

51+ - `latex` ([LaTeX](http://latex-project.org))

52+ - `markdown` ([Pandoc’s Markdown](#pandocs-markdown))

53+ - `markdown_mmd`

54+ ([MultiMarkdown](http://fletcherpenney.net/multimarkdown/))

55+ - `markdown_phpextra` ([PHP Markdown

6856 Extra](https://michelf.ca/projects/php-markdown/extra/))

69−- `markdown_strict` (original unextended

70− [Markdown](https://daringfireball.net/projects/markdown/))

71−- `mediawiki` ([MediaWiki

57+ - `markdown_strict` (original unextended

58+ [Markdown](http://daringfireball.net/projects/markdown/))

59+ - `mediawiki` ([MediaWiki

7260 markup](https://www.mediawiki.org/wiki/Help:Formatting))

73−- `man` ([roff man](https://man.cx/groff_man(7)))

74−- `muse` ([Muse](https://amusewiki.org/library/manual))

75−- `native` (native Haskell)

76−- `odt` ([ODT](https://en.wikipedia.org/wiki/OpenDocument))

77−- `opml` ([OPML](http://dev.opml.org/spec2.html))

78−- `org` ([Emacs Org mode](https://orgmode.org))

79−- `rst`

80− ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))

81−- `t2t` ([txt2tags](https://txt2tags.org))

82−- `textile` ([Textile](https://www.promptworks.com/textile))

83−- `tikiwiki` ([TikiWiki

61+ - `man` ([roff

62+ man](http://man7.org/linux/man-pages/man7/groff_man.7.html))

63+ - `muse` ([Muse](https://amusewiki.org/library/manual))

64+ - `native` (native Haskell)

65+ - `odt` ([ODT](http://en.wikipedia.org/wiki/OpenDocument))

66+ - `opml` ([OPML](http://dev.opml.org/spec2.html))

67+ - `org` ([Emacs Org mode](http://orgmode.org))

68+ - `rst`

69+ ([reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html))

70+ - `t2t` ([txt2tags](http://txt2tags.org))

71+ - `textile` ([Textile](http://redcloth.org/textile))

72+ - `tikiwiki` ([TikiWiki

8473 markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))

85−- `twiki` ([TWiki

86− markup](https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))

87−- `vimwiki` ([Vimwiki](https://vimwiki.github.io))

74+ - `twiki` ([TWiki

75+ markup](http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))

76+ - `vimwiki` ([Vimwiki](https://vimwiki.github.io))

8877

8978</div>

9079

@@ -92,102 +81,82 @@ It can convert *to*

9281

9382<div id="output-formats">

9483

95−- `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or

96− `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))

97−- `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)

100−- `commonmark` ([CommonMark](https://commonmark.org) Markdown)

101−- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with

102− extensions)

103−- `context` ([ConTeXt](https://www.contextgarden.net/))

104−- `csljson` ([CSL

105− JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)

106− bibliography)

107−- `docbook` or `docbook4` ([DocBook](https://docbook.org) 4)

108−- `docbook5` (DocBook 5)

109−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

110−- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

111−- `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)

112−- `epub2` (EPUB v2)

113−- `fb2`

84+ - `asciidoc` ([AsciiDoc](http://www.methods.co.nz/asciidoc/))

85+ - `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)

86+ - `commonmark` ([CommonMark](http://commonmark.org) Markdown)

87+ - `context` ([ConTeXt](http://www.contextgarden.net/))

88+ - `docbook` or `docbook4` ([DocBook](http://docbook.org) 4)

89+ - `docbook5` (DocBook 5)

90+ - `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

91+ - `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

92+ - `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)

93+ - `epub2` (EPUB v2)

94+ - `fb2`

11495 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)

11596 e-book)

116−- `gfm` ([GitHub-Flavored

97+ - `gfm` ([GitHub-Flavored

11798 Markdown](https://help.github.com/articles/github-flavored-markdown/)),

11899 or the deprecated and less accurate `markdown_github`; use

119− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)

120− only if you need extensions not supported in

121− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).

122−- `haddock` ([Haddock

100+ [`markdown_github`](#markdown-variants) only if you need extensions

101+ not supported in [`gfm`](#markdown-variants).

102+ - `haddock` ([Haddock

123103 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

124−- `html` or `html5` ([HTML](https://www.w3.org/html/),

125− i.e. [HTML5](https://html.spec.whatwg.org/)/XHTML [polyglot

104+ - `html` or `html5` ([HTML](http://www.w3.org/html/),

105+ i.e. [HTML5](http://www.w3.org/TR/html5/)/XHTML [polyglot

126106 markup](https://www.w3.org/TR/html-polyglot/))

127−- `html4` ([XHTML](https://www.w3.org/TR/xhtml1/) 1.0 Transitional)

128−- `icml` ([InDesign

129− ICML](https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))

130−- `ipynb` ([Jupyter

107+ - `html4` ([XHTML](http://www.w3.org/TR/xhtml1/) 1.0 Transitional)

108+ - `icml` ([InDesign

109+ ICML](http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))

110+ - `ipynb` ([Jupyter

131111 notebook](https://nbformat.readthedocs.io/en/latest/))

132−- `jats_archiving` ([JATS](https://jats.nlm.nih.gov) XML, Archiving

133− and Interchange Tag Set)

134−- `jats_articleauthoring` ([JATS](https://jats.nlm.nih.gov) XML,

135− Article Authoring Tag Set)

136−- `jats_publishing` ([JATS](https://jats.nlm.nih.gov) XML, Journal

137− Publishing Tag Set)

138−- `jats` (alias for `jats_archiving`)

139−- `jira`

140− ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence

141− wiki markup)

142−- `json` (JSON version of native AST)

143−- `latex` ([LaTeX](https://www.latex-project.org/))

144−- `man` ([roff man](https://man.cx/groff_man(7)))

145−- `markdown` ([Pandoc’s

146− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))

147−- `markdown_mmd`

148− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))

149−- `markdown_phpextra` ([PHP Markdown

112+ - `jats` ([JATS](https://jats.nlm.nih.gov) XML)

113+ - `json` (JSON version of native AST)

114+ - `latex` ([LaTeX](http://latex-project.org))

115+ - `man` ([roff

116+ man](http://man7.org/linux/man-pages/man7/groff_man.7.html))

117+ - `markdown` ([Pandoc’s Markdown](#pandocs-markdown))

118+ - `markdown_mmd`

119+ ([MultiMarkdown](http://fletcherpenney.net/multimarkdown/))

120+ - `markdown_phpextra` ([PHP Markdown

150121 Extra](https://michelf.ca/projects/php-markdown/extra/))

151−- `markdown_strict` (original unextended

152− [Markdown](https://daringfireball.net/projects/markdown/))

153−- `mediawiki` ([MediaWiki

122+ - `markdown_strict` (original unextended

123+ [Markdown](http://daringfireball.net/projects/markdown/))

124+ - `mediawiki` ([MediaWiki

154125 markup](https://www.mediawiki.org/wiki/Help:Formatting))

155−- `ms` ([roff ms](https://man.cx/groff_ms(7)))

156−- `muse` ([Muse](https://amusewiki.org/library/manual)),

157−- `native` (native Haskell),

158−- `odt` ([OpenOffice text

159− document](https://en.wikipedia.org/wiki/OpenDocument))

160−- `opml` ([OPML](http://dev.opml.org/spec2.html))

161−- `opendocument` ([OpenDocument](http://opendocument.xml.org))

162−- `org` ([Emacs Org mode](https://orgmode.org))

163−- `pdf` ([PDF](https://www.adobe.com/pdf/))

164−- `plain` (plain text),

165−- `pptx`

126+ - `ms` ([roff

127+ ms](http://man7.org/linux/man-pages/man7/groff_ms.7.html))

128+ - `muse` ([Muse](https://amusewiki.org/library/manual)),

129+ - `native` (native Haskell),

130+ - `odt` ([OpenOffice text

131+ document](http://en.wikipedia.org/wiki/OpenDocument))

132+ - `opml` ([OPML](http://dev.opml.org/spec2.html))

133+ - `opendocument` ([OpenDocument](http://opendocument.xml.org))

134+ - `org` ([Emacs Org mode](http://orgmode.org))

135+ - `plain` (plain text),

136+ - `pptx`

166137 ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)

167138 slide show)

168−- `rst`

169− ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))

170−- `rtf` ([Rich Text

171− Format](https://en.wikipedia.org/wiki/Rich_Text_Format))

172−- `texinfo` ([GNU Texinfo](https://www.gnu.org/software/texinfo/))

173−- `textile` ([Textile](https://www.promptworks.com/textile))

174−- `slideous` ([Slideous](https://goessner.net/articles/slideous/) HTML

139+ - `rst`

140+ ([reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html))

141+ - `rtf` ([Rich Text

142+ Format](http://en.wikipedia.org/wiki/Rich_Text_Format))

143+ - `texinfo` ([GNU Texinfo](http://www.gnu.org/software/texinfo/))

144+ - `textile` ([Textile](http://redcloth.org/textile))

145+ - `slideous` ([Slideous](http://goessner.net/articles/slideous/) HTML

175146 and JavaScript slide show)

176−- `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and

147+ - `slidy` ([Slidy](http://www.w3.org/Talks/Tools/Slidy/) HTML and

177148 JavaScript slide show)

178−- `dzslides` ([DZSlides](https://paulrouget.com/dzslides/) HTML5 +

149+ - `dzslides` ([DZSlides](http://paulrouget.com/dzslides/) HTML5 +

179150 JavaScript slide show),

180−- `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript

181− slide show)

182−- `s5` ([S5](https://meyerweb.com/eric/tools/s5/) HTML and JavaScript

151+ - `revealjs` ([reveal.js](http://lab.hakim.se/reveal-js/) HTML5 +

152+ JavaScript slide show)

153+ - `s5` ([S5](http://meyerweb.com/eric/tools/s5/) HTML and JavaScript

183154 slide show)

184−- `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))

185−- `xwiki` ([XWiki

186− markup](https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/))

187−- `zimwiki` ([ZimWiki

188− markup](https://zim-wiki.org/manual/Help/Wiki_Syntax.html))

189−- the path of a custom Lua writer, see [Custom

190− writers](https://pandoc.org/MANUAL.html#custom-writers) below

155+ - `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))

156+ - `zimwiki` ([ZimWiki

157+ markup](http://zim-wiki.org/manual/Help/Wiki_Syntax.html))

158+ - the path of a custom lua writer, see [Custom

159+ writers](#custom-writers) below

191160

192161</div>

193162

@@ -205,7 +174,7 @@ convert this native representation into a target format. Thus, adding an

205174input or output format requires only adding a reader or writer. Users

206175can also run custom pandoc filters to modify the intermediate AST (see

207176the documentation for [filters](https://pandoc.org/filters.html) and

208−[Lua filters](https://pandoc.org/lua-filters.html)).

177+[lua filters](https://pandoc.org/lua-filters.html)).

209178

210179Because pandoc’s intermediate representation of a document is less

211180expressive than many of the formats it converts between, one should not

@@ -238,7 +207,7 @@ opening a new issue.

238207

239208## License

240209

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"),

210+© 2006-2018 John MacFarlane (jgm@berkeley.edu). Released under the

211+[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),

243212version 2 or greater. This software carries no warranty of any kind.

244213(See COPYRIGHT for full copyright and warranty notices.)

README.template+9−8

@@ -7,10 +7,11 @@ Pandoc

77======

88

99[](https://github.com/jgm/pandoc/releases)

10−[](https://hackage.haskell.org/package/pandoc)

11−[](https://formulae.brew.sh/formula/pandoc)

12−[](https://www.stackage.org/lts/package/pandoc-types)

13−[](https://github.com/jgm/pandoc/actions)

10+[](http://hackage.haskell.org/package/pandoc)

11+[](http://brewformulas.org/Pandoc)

12+[](http://stackage.org/lts/package/pandoc)

13+[](https://circleci.com/gh/jgm/pandoc)

14+[](https://ci.appveyor.com/project/jgm/pandoc)

1415[](https://www.gnu.org/licenses/gpl.html)

1516[](https://groups.google.com/forum/#!forum/pandoc-discuss)

1617

@@ -43,7 +44,7 @@ this native representation into a target format. Thus, adding an input

4344or output format requires only adding a reader or writer. Users can also

4445run custom pandoc filters to modify the intermediate AST (see

4546the documentation for [filters](https://pandoc.org/filters.html)

46−and [Lua filters](https://pandoc.org/lua-filters.html)).

47+and [lua filters](https://pandoc.org/lua-filters.html)).

4748

4849Because pandoc's intermediate representation of a document is less

4950expressive than many of the formats it converts between, one should

@@ -81,9 +82,9 @@ new issue.

8182License

8283-------

8384

84−© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the

85+© 2006-2018 John MacFarlane (jgm@berkeley.edu). Released under the

8586[GPL], version 2 or greater. This software carries no warranty of

8687any kind. (See COPYRIGHT for full copyright and warranty notices.)

8788

88−[GPL]: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"

89−[Haskell]: https://haskell.org

89+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

90+[Haskell]: http://haskell.org

RELEASE-CHECKLIST+2−6

@@ -1,12 +1,8 @@

1−[ ] use 'policeman' to check API changes and version update

21[ ] make README.md and commit if needed

32[ ] make man/pandoc.1 and commit if needed

43[ ] Finalize changelog

5−[ ] push release candidate branch rc/VERSION and (if it builds

6− successfully) download artifacts

7−[ ] run tools/build-arm.sh to create and download arm64 linux package

8−[ ] download macos artifacts from CircleCI

9−[ ] Use 'make' in macos and windows artifacts to sign code

4+ tools/changelog-helper.sh

5+[ ] make packages

106[ ] make update-website

117[ ] make trypandoc

128[ ] Tag release in git

SECURITY.mddeleted−12

@@ -1,12 +0,0 @@

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.

app/pandoc.hsdeleted−20

@@ -1,20 +0,0 @@

1−{- |

2− Module : Main

3− Copyright : Copyright (C) 2006-2021 John MacFarlane

4− License : GNU GPL, version 2 or above

5−

6− Maintainer : John MacFarlane <jgm@berkeley@edu>

7− Stability : alpha

8− Portability : portable

9−

10−Parses command-line options and calls the appropriate readers and

11−writers.

12−-}

13−module Main where

14−import qualified Control.Exception as E

15−import Text.Pandoc.App (convertWithOpts, defaultOpts, options, parseOptions)

16−import Text.Pandoc.Error (handleError)

17−

18−main :: IO ()

19−main = E.catch (parseOptions options defaultOpts >>= convertWithOpts)

20− (handleError . Left)

appveyor.ymlnew file+95

@@ -0,0 +1,95 @@

1+image: Visual Studio 2013

2+clone_folder: "c:\\pandoc"

3+environment:

4+ global:

5+ WIXBIN: "c:\\Program Files (x86)\\WiX Toolset v3.11\\bin"

6+ CABAL_STORE: "C:\\cs"

7+ CABAL_PACKAGE_DB: "%CABAL_STORE%\\ghc-%GHC_MINOR_VERSION%\\package.db"

8+ # Override the temp directory to avoid sed escaping issues

9+ # See https://github.com/haskell/cabal/issues/5386

10+ TMP: "c:\\tmp"

11+ # see #4201, https://github.com/haskell-tools/haskell-tools/issues/277

12+ matrix:

13+ - OSARCH: "windows-x86_64"

14+ GHC_VERSION: "8.6.2"

15+ GHC_MINOR_VERSION: "8.6.2"

16+ GHC: "C:\\ProgramData\\chocolatey\\lib\\ghc\\tools\\ghc-%GHC_MINOR_VERSION%\\bin\\ghc.exe"

17+ CABAL_VERSION: "2.4.1.0"

18+ CABAL_OPTS: "-fembed_data_files -fbibutils --verbose=2"

19+ GHC_OPTS: "-fhide-source-paths"

20+ ARCH: "x64"

21+ CHOCO_OPTS: ""

22+ - OSARCH: "windows-i386"

23+ GHC_VERSION: "8.6.2"

24+ GHC_MINOR_VERSION: "8.6.2"

25+ GHC: "C:\\ProgramData\\chocolatey\\lib\\ghc\\tools\\ghc-%GHC_MINOR_VERSION%\\bin\\ghc.exe"

26+ CABAL_VERSION: "2.4.1.0"

27+ CABAL_OPTS: "-flua_32bits -fembed_data_files -fbibutils --verbose=2"

28+ GHC_OPTS: "-fhide-source-paths"

29+ ARCH: "x86"

30+ CHOCO_OPTS: "--x86"

31+

32+skip_commits:

33+ files:

34+ - '*.md'

35+ - '*.txt'

36+ - '.travis.yml'

37+ - 'Makefile'

38+ - 'man/pandoc.1'

39+ - 'linux/*'

40+ - 'macos/*'

41+

42+matrix:

43+ fast_finish: true

44+

45+cache:

46+ - '%CABAL_STORE%'

47+

48+# Note: to reset build cache, do the following in JavaScript

49+# console on appveyor:

50+# $.ajax({ url: 'https://ci.appveyor.com/api/projects/jgm/pandoc/buildcache', type: 'DELETE'})

51+

52+# We don't do a normal C build, but build in test_script

53+build: off

54+

55+install:

56+ - choco install wixtoolset --version 3.11.1 %CHOCO_OPTS%

57+ - choco install ghc --version %GHC_VERSION% --ignore-dependencies %CHOCO_OPTS%

58+ - choco install cabal --version %CABAL_VERSION% --ignore-dependencies %CHOCO_OPTS%

59+

60+# before_test:

61+

62+test_script:

63+ # Note: we manually create cabal store, because of a cabal bug:

64+ # see https://github.com/haskell/cabal/issues/5516

65+ - if not exist "%CABAL_PACKAGE_DB%" ( mkdir "%CABAL_PACKAGE_DB%" )

66+ - cabal --store-dir="%CABAL_STORE%" --version

67+ - cabal --store-dir="%CABAL_STORE%" new-update

68+ - cabal --store-dir="%CABAL_STORE%" new-configure -w %GHC% --enable-tests %CABAL_OPTS% --ghc-options="%GHC_OPTS%" . pandoc-citeproc

69+ - cabal --store-dir="%CABAL_STORE%" new-build . pandoc-citeproc

70+ - cabal --store-dir="%CABAL_STORE%" new-test . pandoc-citeproc

71+ - forfiles /P .\dist-newstyle /M pandoc*.exe /S /C "cmd /C copy @path C:\pandoc\windows"

72+

73+after_test:

74+ # create msi and zip artifacts

75+ - cd windows

76+ - .\pandoc.exe -s --toc ..\MANUAL.txt -o MANUAL.html

77+ - .\pandoc.exe -s ..\COPYING.md -o COPYING.rtf

78+ - copy ..\COPYRIGHT COPYRIGHT.txt

79+ - 7z a "pandoc-%OSARCH%.zip" pandoc.exe pandoc-citeproc.exe MANUAL.html COPYING.rtf

80+ - |

81+ set VERSION=

82+ for /f "tokens=1-2 delims= " %%a in ('.\pandoc.exe --version') do ( if not defined VERSION set "VERSION=%%b" )

83+ echo %VERSION%

84+ "%WIXBIN%"\candle -arch %ARCH% -dVERSION=%VERSION% -dBINPATH=. *.wxs -out wixobj\

85+ "%WIXBIN%"\light -sw1076 -ext WixUIExtension -ext WixUtilExtension -cultures:en-us -loc Pandoc-en-us.wxl -out "pandoc-%OSARCH%.msi" wixobj\*.wixobj

86+

87+# for debugging

88+# on_finish:

89+# - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))

90+

91+artifacts:

92+ - path: 'windows\pandoc-%OSARCH%.zip'

93+ name: exe

94+ - path: 'windows\pandoc-%OSARCH%.msi'

95+ name: msi

benchmark/benchmark-pandoc.hs+61−71

@@ -1,6 +1,7 @@

1−{-# LANGUAGE OverloadedStrings #-}

1+{-# LANGUAGE NoImplicitPrelude #-}

2+{-# LANGUAGE TupleSections #-}

23{-

3−Copyright (C) 2012-2021 John MacFarlane <jgm@berkeley.edu>

4+Copyright (C) 2012-2019 John MacFarlane <jgm@berkeley.edu>

45

56This program is free software; you can redistribute it and/or modify

67it under the terms of the GNU General Public License as published by

@@ -16,88 +17,77 @@ You should have received a copy of the GNU General Public License

1617along with this program; if not, write to the Free Software

1718Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

1819-}

20+import Prelude

1921import Text.Pandoc

20−import Text.Pandoc.MIME

21−import Control.DeepSeq (force)

22+import Text.Pandoc.Error (PandocError(..))

2223import Control.Monad.Except (throwError)

2324import qualified Text.Pandoc.UTF8 as UTF8

2425import qualified Data.ByteString as B

25−import qualified Data.Text as T

26−import Test.Tasty.Bench

27−-- import Gauge

28−import qualified Data.ByteString.Lazy as BL

26+import Criterion.Main

27+import Criterion.Types (Config(..))

28+import Data.List (intersect)

2929import Data.Maybe (mapMaybe)

30−import Data.List (sortOn)

30+import System.Environment (getArgs)

3131

3232readerBench :: Pandoc

33− -> T.Text

33+ -> String

3434 -> 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

35+readerBench doc name =

36+ case res of

37+ Right (readerFun, inp) ->

38+ Just $ bench (name ++ " reader")

39+ $ nf (\i -> either (error . show) id $ runPure (readerFun i))

40+ inp

41+ Left _ -> Nothing

42+ where res = runPure $

43+ case (getReader name, getWriter name) of

44+ (Right (TextReader r, rexts),

45+ Right (TextWriter w, wexts)) -> do

46+ inp <- w def{ writerWrapText = WrapAuto

47+ , writerExtensions = wexts } doc

48+ return $ (r def{ readerExtensions = rexts }, inp)

49+ _ -> throwError $ PandocSomeError

50+ $ "could not get text reader and writer for " ++ name

5751

58−getImages :: IO [(FilePath, MimeType, BL.ByteString)]

59−getImages = do

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)]

64−

65−writerBench :: [(FilePath, MimeType, BL.ByteString)]

66− -> Pandoc

67− -> T.Text

52+writerBench :: Pandoc

53+ -> String

6854 -> Maybe Benchmark

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)

55+writerBench doc name =

56+ case res of

57+ Right writerFun ->

58+ Just $ bench (name ++ " writer")

8459 $ nf (\d -> either (error . show) id $

85− runPure $ do

86− mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs

87− writerFun def{ writerExtensions = wexts} d)

88− doc

60+ runPure (writerFun d)) doc

61+ Left _ -> Nothing

62+ where res = runPure $ do

63+ case (getWriter name) of

64+ Right (TextWriter w, wexts) ->

65+ return $ w def{ writerExtensions = wexts }

66+ _ -> throwError $ PandocSomeError

67+ $ "could not get text reader and writer for " ++ name

8968

9069main :: IO ()

9170main = do

71+ args <- filter (\x -> take 1 x /= "-") <$> getArgs

72+ print args

73+ let matchReader (n, TextReader _) =

74+ null args || ("reader" `elem` args && n `elem` args)

75+ matchReader _ = False

76+ let matchWriter (n, TextWriter _) =

77+ null args || ("writer" `elem` args && n `elem` args)

78+ matchWriter _ = False

79+ let matchedReaders = map fst $ (filter matchReader readers

80+ :: [(String, Reader PandocPure)])

81+ let matchedWriters = map fst $ (filter matchWriter writers

82+ :: [(String, Writer PandocPure)])

9283 inp <- UTF8.toText <$> B.readFile "test/testsuite.txt"

9384 let opts = def

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− ]

85+ let doc = either (error . show) id $ runPure $ readMarkdown opts inp

86+ let readerBs = mapMaybe (readerBench doc)

87+ $ filter (/="haddock")

88+ (matchedReaders `intersect` matchedWriters)

89+ -- we need the corresponding writer to generate

90+ -- input for the reader

91+ let writerBs = mapMaybe (writerBench doc) matchedWriters

92+ defaultMainWith defaultConfig{ timeLimit = 6.0 }

93+ (writerBs ++ readerBs)

benchmark/weigh-pandoc.hsnew file+51

@@ -0,0 +1,51 @@

1+{-# LANGUAGE NoImplicitPrelude #-}

2+{- |

3+ Module : Main

4+ Copyright : © 2016-2019 John MacFarlane <jgm@berkeley.edu>

5+ License : GNU GPL, version 2 or above

6+

7+ Maintainer : John MacFarlane <jgm@berkeley.edu>

8+ Stability : alpha

9+ Portability : portable

10+

11+Benchmarks to determine resource use of readers and writers.

12+-}

13+import Prelude

14+import Weigh

15+import Text.Pandoc

16+import Data.Text (Text)

17+

18+main :: IO ()

19+main = do

20+ doc <- read <$> readFile "test/testsuite.native"

21+ mainWith $ do

22+ func "Pandoc document" id doc

23+ mapM_

24+ (\(n,r) -> weighReader doc n (either (error . show) id . runPure . r def{readerExtensions = pandocExtensions}))

25+ [("markdown", readMarkdown)

26+ ,("html", readHtml)

27+ ,("docbook", readDocBook)

28+ ,("latex", readLaTeX)

29+ ,("commonmark", readCommonMark)

30+ ]

31+ mapM_

32+ (\(n,w) -> weighWriter doc n (either (error . show) id . runPure . w def))

33+ [("markdown", writeMarkdown)

34+ ,("html", writeHtml5String)

35+ ,("docbook", writeDocbook5)

36+ ,("latex", writeLaTeX)

37+ ,("commonmark", writeCommonMark)

38+ ]

39+

40+weighWriter :: Pandoc -> String -> (Pandoc -> Text) -> Weigh ()

41+weighWriter doc name writer = func (name ++ " writer") writer doc

42+

43+weighReader :: Pandoc -> String -> (Text -> Pandoc) -> Weigh ()

44+weighReader doc name reader = do

45+ case lookup name writers of

46+ Just (TextWriter writer) ->

47+ let inp = either (error . show) id $ runPure $ writer def{ writerWrapText = WrapAuto} doc

48+ in func (name ++ " reader") reader inp

49+ _ -> return () -- no writer for reader

50+

51+

cabal.project+8−9

@@ -1,13 +1,12 @@

11packages: pandoc.cabal

2−tests: True

3−flags: +embed_data_files

42

5−source-repository-package

6− type: git

7− location: https://github.com/jgm/doctemplates

8− tag: 428c26d5303cf7a2b1051fe1ffd9aafe9ba71c81

3+package pandoc

4+ flags: +embed_data_files -trypandoc

5+

6+package pandoc-citeproc

7+ flags: +embed_data_files +bibutils -unicode_collation -test_citeproc -debug

98

109source-repository-package

11− type: git

12− location: https://github.com/jgm/citeproc

13− tag: 4ce0501cd6f9c86eee087afcf878c256e49b9615

10+ type: git

11+ location: https://github.com/jgm/pandoc-citeproc

12+ tag: 0.16.0.2

changelog.md → changelogrenamed+12050−16006

This diff is too big to show here.

citeproc/biblatex-localization/.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/UKenglish.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/USenglish.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/american.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/australian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/austrian.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/brazil.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/brazilian.lbx.stringsdeleted−233

This diff is too big to show here.

citeproc/biblatex-localization/british.lbx.stringsdeleted−3

This diff is too big to show here.

citeproc/biblatex-localization/bulgarian.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/canadian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/catalan.lbx.stringsdeleted−158

This diff is too big to show here.

citeproc/biblatex-localization/croatian.lbx.stringsdeleted−214

This diff is too big to show here.

citeproc/biblatex-localization/czech.lbx.stringsdeleted−91

This diff is too big to show here.

citeproc/biblatex-localization/danish.lbx.stringsdeleted−106

This diff is too big to show here.

citeproc/biblatex-localization/dutch.lbx.stringsdeleted−23

This diff is too big to show here.

citeproc/biblatex-localization/english.lbx.stringsdeleted−254

This diff is too big to show here.

citeproc/biblatex-localization/estonian.lbx.stringsdeleted−178

This diff is too big to show here.

citeproc/biblatex-localization/finnish.lbx.stringsdeleted−254

This diff is too big to show here.

citeproc/biblatex-localization/french.lbx.stringsdeleted−245

This diff is too big to show here.

citeproc/biblatex-localization/galician.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/german.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/greek.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/hungarian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/icelandic.lbx.stringsdeleted−7

This diff is too big to show here.

citeproc/biblatex-localization/italian.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/latvian.lbx.stringsdeleted−75

This diff is too big to show here.

citeproc/biblatex-localization/lithuanian.lbx.stringsdeleted−31

This diff is too big to show here.

citeproc/biblatex-localization/magyar.lbx.stringsdeleted−29

This diff is too big to show here.

citeproc/biblatex-localization/naustrian.lbx.stringsdeleted−2

This diff is too big to show here.

citeproc/biblatex-localization/newzealand.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/ngerman.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/norsk.lbx.stringsdeleted−98

This diff is too big to show here.

citeproc/biblatex-localization/nswissgerman.lbx.stringsdeleted−2

This diff is too big to show here.

citeproc/biblatex-localization/nynorsk.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/polish.lbx.stringsdeleted−100

This diff is too big to show here.

citeproc/biblatex-localization/portuges.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/portuguese.lbx.stringsdeleted−95

This diff is too big to show here.

citeproc/biblatex-localization/russian.lbx.stringsdeleted−102

This diff is too big to show here.

citeproc/biblatex-localization/serbian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/serbianc.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/slovak.lbx.stringsdeleted−82

This diff is too big to show here.

citeproc/biblatex-localization/slovene.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/slovenian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/spanish.lbx.stringsdeleted−190

This diff is too big to show here.

citeproc/biblatex-localization/swedish.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/swissgerman.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/turkish.lbx.stringsdeleted−157

This diff is too big to show here.

citeproc/biblatex-localization/ukrainian.lbx.stringsdeleted−102

This diff is too big to show here.

data/bash_completion.tpl+1−5

This diff is too big to show here.

data/default.csldeleted−658

This diff is too big to show here.

data/docx/word/settings.xml+16−6

This diff is too big to show here.

data/docx/word/styles.xml+14−26

This diff is too big to show here.

data/epub.css+2−15

This diff is too big to show here.

data/init.lua+4

This diff is too big to show here.

test/command/jats.csl → data/jats.cslrenamed+1−4

This diff is too big to show here.

data/make-reference-files.hsnew file+27

This diff is too big to show here.

data/odt/styles.xml+12−16

This diff is too big to show here.

data/pandoc.List.lua+46−68

This diff is too big to show here.

data/pandoc.lua+38−149

This diff is too big to show here.

data/pptx/[Content_Types].xml+1−1

This diff is too big to show here.

data/pptx/docProps/app.xml+1−1

This diff is too big to show here.

data/pptx/docProps/core.xml+1−1

This diff is too big to show here.

data/pptx/ppt/_rels/presentation.xml.rels+1−1

This diff is too big to show here.

data/pptx/ppt/notesMasters/notesMaster1.xml+1−1

This diff is too big to show here.

data/pptx/ppt/presentation.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout1.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout10.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout11.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout2.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout3.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout4.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout5.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout6.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout7.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout8.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout9.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideMasters/slideMaster1.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide3.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide4.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide1.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slides/slide3.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide4.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/viewProps.xml+1−1

This diff is too big to show here.

data/sample.lua+11−9

This diff is too big to show here.

data/templates/.github/ISSUE_TEMPLATE.mdnew file+3

This diff is too big to show here.

data/templates/.github/PULL_REQUEST_TEMPLATE.mdnew file+4

This diff is too big to show here.

data/templates/README.markdownnew file+49

This diff is too big to show here.

data/templates/affiliations.jatsdeleted−38

This diff is too big to show here.

data/templates/default.asciidoctordeleted−41

This diff is too big to show here.

data/templates/default.biblatexdeleted−10

This diff is too big to show here.

data/templates/default.bibtexdeleted−10

This diff is too big to show here.

data/templates/default.context+16−40

This diff is too big to show here.

data/templates/default.docbook4+3−3

This diff is too big to show here.

data/templates/default.docbook5+3−3

This diff is too big to show here.

data/templates/default.dzslides+13−2

This diff is too big to show here.

data/templates/default.epub2+9−8

This diff is too big to show here.

data/templates/default.epub3+11−10

This diff is too big to show here.

data/templates/default.html4+12−7

This diff is too big to show here.

data/templates/default.html5+12−7

This diff is too big to show here.

data/templates/default.icml+2−2

This diff is too big to show here.

data/templates/article.jats_publishing → data/templates/default.jatsrenamed+28−36

This diff is too big to show here.

data/templates/default.jats_archivingdeleted−7

This diff is too big to show here.

data/templates/default.jats_articleauthoringdeleted−93

This diff is too big to show here.

data/templates/default.jats_publishingdeleted−7

This diff is too big to show here.

data/templates/default.jiradeleted−9

This diff is too big to show here.

data/templates/default.latex+56−141

This diff is too big to show here.

data/templates/default.man+3−3

This diff is too big to show here.

data/templates/default.ms+4−7

This diff is too big to show here.

data/templates/default.muse+1−1

This diff is too big to show here.

data/templates/default.opendocument+1−7

This diff is too big to show here.

data/templates/default.org+3−3

This diff is too big to show here.

data/templates/default.revealjs+103−137

This diff is too big to show here.

data/templates/default.s5+12−4

This diff is too big to show here.

data/templates/default.slideous+12−8

This diff is too big to show here.

data/templates/default.slidy+12−6

This diff is too big to show here.

data/templates/default.xwikideleted−13

This diff is too big to show here.

data/templates/styles.htmldeleted−180

This diff is too big to show here.

data/translations/de.yaml−1

This diff is too big to show here.

data/translations/en.yaml+1−1

This diff is too big to show here.

data/translations/ru.yaml+1

This diff is too big to show here.

data/translations/uk.yaml+1

This diff is too big to show here.

data/translations/zh-Hans.yamldeleted−22

This diff is too big to show here.

data/translations/zh-Hant.yamldeleted−22

This diff is too big to show here.

data/vimwiki.cssnew file+82

This diff is too big to show here.

default.nix+95−12

This diff is too big to show here.

doc/customizing-pandoc.md+14−14

This diff is too big to show here.

doc/epub.md+11−18

This diff is too big to show here.

doc/faqs.mddeleted−128

This diff is too big to show here.

doc/filters.md+160−201

This diff is too big to show here.

doc/getting-started.md+11−11

This diff is too big to show here.

doc/jats.mddeleted−414

This diff is too big to show here.

doc/libraries.mddeleted−63

This diff is too big to show here.

doc/lua-filters.md+907−1991

This diff is too big to show here.

doc/org.md+10−195

This diff is too big to show here.

doc/using-the-pandoc-api.md+17−31

This diff is too big to show here.

linux/Dockerfilenew file+24

This diff is too big to show here.

linux/Makefilenew file+18

This diff is too big to show here.

linux/control.in+1−1

This diff is too big to show here.

linux/make_artifacts.shdeleted−84

This diff is too big to show here.

linux/make_deb.shnew file+51

This diff is too big to show here.

linux/make_tarball.shnew file+19

This diff is too big to show here.

macos/Makefiledeleted−35

This diff is too big to show here.

macos/make_macos_package.shnew file+86

This diff is too big to show here.

man/pandoc.1+1302−2868

This diff is too big to show here.

man/pandoc.1.afterdeleted−3

This diff is too big to show here.

man/pandoc.1.beforedeleted−2

This diff is too big to show here.

man/pandoc.1.templatenew file+10

This diff is too big to show here.

pandoc.cabal+212−304

This diff is too big to show here.

pandoc.hsnew file+40

This diff is too big to show here.

prelude/Prelude.hs+2

This diff is too big to show here.

release.nixdeleted−4

This diff is too big to show here.

shell.nixdeleted−106

This diff is too big to show here.

src/Text/Pandoc.hs+20−1

This diff is too big to show here.

src/Text/Pandoc/App.hs+203−212

This diff is too big to show here.

src/Text/Pandoc/App/CommandLineOptions.hs+400−532

This diff is too big to show here.

src/Text/Pandoc/App/FormatHeuristics.hs+30−25

This diff is too big to show here.

src/Text/Pandoc/App/Opt.hs+72−598

This diff is too big to show here.

src/Text/Pandoc/App/OutputSettings.hs+127−107

This diff is too big to show here.

src/Text/Pandoc/Asciify.hs+410−14

This diff is too big to show here.

src/Text/Pandoc/BCP47.hsnew file+127

This diff is too big to show here.

src/Text/Pandoc/CSS.hs+27−25

This diff is too big to show here.

src/Text/Pandoc/CSV.hs+34−11

This diff is too big to show here.

src/Text/Pandoc/Citeproc.hsdeleted−661

This diff is too big to show here.

src/Text/Pandoc/Citeproc/BibTeX.hsdeleted−1476

This diff is too big to show here.

src/Text/Pandoc/Citeproc/CslJson.hsdeleted−37

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Data.hsdeleted−32

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Locator.hsdeleted−295

This diff is too big to show here.

src/Text/Pandoc/Citeproc/MetaValue.hsdeleted−255

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Util.hsdeleted−70

This diff is too big to show here.

src/Text/Pandoc/Class.hs+1078−14

This diff is too big to show here.

src/Text/Pandoc/Class/CommonState.hsdeleted−83

This diff is too big to show here.

src/Text/Pandoc/Class/IO.hsdeleted−231

This diff is too big to show here.

src/Text/Pandoc/Class/PandocIO.hsdeleted−74

This diff is too big to show here.

src/Text/Pandoc/Class/PandocMonad.hsdeleted−711

This diff is too big to show here.

src/Text/Pandoc/Class/PandocPure.hsdeleted−218

This diff is too big to show here.

src/Text/Pandoc/Data.hs+3−1

This diff is too big to show here.

src/Text/Pandoc/Emoji.hs+896−8

This diff is too big to show here.

src/Text/Pandoc/Error.hs+92−164

This diff is too big to show here.

src/Text/Pandoc/Extensions.hs+66−258

This diff is too big to show here.

src/Text/Pandoc/Filter.hs+38−53

This diff is too big to show here.

src/Text/Pandoc/Filter/JSON.hs+32−16

This diff is too big to show here.

src/Text/Pandoc/Filter/Lua.hs+29−11

This diff is too big to show here.

src/Text/Pandoc/Filter/Path.hs+22−2

This diff is too big to show here.

src/Text/Pandoc/Highlighting.hs+46−31

This diff is too big to show here.

src/Text/Pandoc/Image.hsdeleted−37

This diff is too big to show here.

src/Text/Pandoc/ImageSize.hs+410−117

This diff is too big to show here.

src/Text/Pandoc/Logging.hs+190−248

This diff is too big to show here.

src/Text/Pandoc/Lua.hs+23−3

This diff is too big to show here.

src/Text/Pandoc/Lua/ErrorConversion.hsdeleted−61

This diff is too big to show here.

src/Text/Pandoc/Lua/Filter.hs+69−112

This diff is too big to show here.

src/Text/Pandoc/Lua/Global.hs+26−7

This diff is too big to show here.

src/Text/Pandoc/Lua/Init.hs+80−57

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling.hsdeleted−19

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/AST.hsdeleted−378

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/AnyValue.hsdeleted−24

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/CommonState.hsdeleted−102

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/Context.hsdeleted−28

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/List.hsdeleted−43

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/MediaBag.hsdeleted−73

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/PandocError.hsdeleted−65

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/ReaderOptions.hsdeleted−79

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/SimpleTable.hsdeleted−59

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/Version.hsdeleted−154

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/MediaBag.hs+74−67

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Pandoc.hs+63−59

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/System.hsdeleted−33

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Types.hsdeleted−68

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Utils.hs+70−88

This diff is too big to show here.

src/Text/Pandoc/Lua/Packages.hs+79−30

This diff is too big to show here.

src/Text/Pandoc/Lua/PandocLua.hsdeleted−141

This diff is too big to show here.

src/Text/Pandoc/Lua/StackInstances.hsnew file+474

This diff is too big to show here.

src/Text/Pandoc/Lua/Util.hs+40−12

This diff is too big to show here.

src/Text/Pandoc/Lua/Walk.hsdeleted−158

This diff is too big to show here.

src/Text/Pandoc/MIME.hs+37−53

This diff is too big to show here.

src/Text/Pandoc/MediaBag.hs+33−59

This diff is too big to show here.

src/Text/Pandoc/Options.hs+91−151

This diff is too big to show here.

src/Text/Pandoc/PDF.hs+260−329

This diff is too big to show here.

src/Text/Pandoc/Parsing.hs+404−623

This diff is too big to show here.

src/Text/Pandoc/Pretty.hsnew file+561

This diff is too big to show here.

src/Text/Pandoc/Process.hs+21−1

This diff is too big to show here.

src/Text/Pandoc/Readers.hs+70−86

This diff is too big to show here.

src/Text/Pandoc/Readers/BibTeX.hsdeleted−77

This diff is too big to show here.

src/Text/Pandoc/Readers/CSV.hsdeleted−48

This diff is too big to show here.

src/Text/Pandoc/Readers/CommonMark.hs+210−98

This diff is too big to show here.

src/Text/Pandoc/Readers/Creole.hs+47−21

This diff is too big to show here.

src/Text/Pandoc/Readers/CslJson.hsdeleted−54

This diff is too big to show here.

src/Text/Pandoc/Readers/DocBook.hs+239−397

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx.hs+300−292

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Combine.hs+71−87

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Fields.hs+36−19

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Lists.hs+35−21

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Parse.hs+391−304

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Parse/Styles.hsdeleted−322

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/StyleMap.hsnew file+123

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Util.hs+23−32

This diff is too big to show here.

src/Text/Pandoc/Readers/DokuWiki.hs+126−113

This diff is too big to show here.

src/Text/Pandoc/Readers/EPUB.hs+74−71

This diff is too big to show here.

src/Text/Pandoc/Readers/FB2.hs+80−138

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML.hs+672−424

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Parsing.hsdeleted−225

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Table.hsdeleted−283

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/TagCategories.hsdeleted−78

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Types.hsdeleted−97

This diff is too big to show here.

src/Text/Pandoc/Readers/Haddock.hs+35−49

This diff is too big to show here.

src/Text/Pandoc/Readers/Ipynb.hs+121−94

This diff is too big to show here.

src/Text/Pandoc/Readers/JATS.hs+139−144

This diff is too big to show here.

src/Text/Pandoc/Readers/Jira.hsdeleted−203

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX.hs+1562−496

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Citation.hsdeleted−210

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Inline.hsdeleted−397

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Lang.hs+149−210

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Macro.hsdeleted−184

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Math.hsdeleted−221

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Parsing.hs+110−422

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/SIunitx.hsdeleted−434

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Table.hsdeleted−378

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Man.hs+81−84

This diff is too big to show here.

src/Text/Pandoc/Readers/Markdown.hs+597−676

This diff is too big to show here.

src/Text/Pandoc/Readers/MediaWiki.hs+143−138

This diff is too big to show here.

src/Text/Pandoc/Readers/Metadata.hsdeleted−200

This diff is too big to show here.

src/Text/Pandoc/Readers/Muse.hs+118−144

This diff is too big to show here.

src/Text/Pandoc/Readers/Native.hs+32−15

This diff is too big to show here.

src/Text/Pandoc/Readers/OPML.hs+56−27

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt.hs+51−33

This diff is too big to show here.

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

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Base.hs+18

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/ContentReader.hs+102−115

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Fallible.hs+22

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/SetMap.hs+20

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/XMLConverter.hs+56−94

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/StyleReader.hs+49−32

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/BlockStarts.hs+33−18

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Blocks.hs+203−287

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ExportSettings.hs+50−66

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Inlines.hs+132−127

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Meta.hs+158−165

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ParserState.hs+35−34

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Parsing.hs+35−23

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Shared.hs+49−28

This diff is too big to show here.

src/Text/Pandoc/Readers/RST.hs+382−388

This diff is too big to show here.

src/Text/Pandoc/Readers/Roff.hs+151−123

This diff is too big to show here.

src/Text/Pandoc/Readers/TWiki.hs+115−85

This diff is too big to show here.

src/Text/Pandoc/Readers/Textile.hs+183−169

This diff is too big to show here.

src/Text/Pandoc/Readers/TikiWiki.hs+56−54

This diff is too big to show here.

src/Text/Pandoc/Readers/Txt2Tags.hs+113−122

This diff is too big to show here.

src/Text/Pandoc/Readers/Vimwiki.hs+97−98

This diff is too big to show here.

src/Text/Pandoc/RoffChar.hs+24−5

This diff is too big to show here.

src/Text/Pandoc/SelfContained.hs+92−80

This diff is too big to show here.

src/Text/Pandoc/Shared.hs+302−398

This diff is too big to show here.

src/Text/Pandoc/Slides.hs+22−6

This diff is too big to show here.

src/Text/Pandoc/Sources.hsdeleted−195

This diff is too big to show here.

src/Text/Pandoc/Templates.hs+44−82

This diff is too big to show here.

src/Text/Pandoc/Translations.hs+54−37

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/UUID.hs+25−6

This diff is too big to show here.

src/Text/Pandoc/Writers.hs+35−56

This diff is too big to show here.

src/Text/Pandoc/Writers/AnnotatedTable.hsdeleted−323

This diff is too big to show here.

src/Text/Pandoc/Writers/AsciiDoc.hs+162−283

This diff is too big to show here.

src/Text/Pandoc/Writers/BibTeX.hsdeleted−61

This diff is too big to show here.

src/Text/Pandoc/Writers/CommonMark.hs+379−2

This diff is too big to show here.

src/Text/Pandoc/Writers/ConTeXt.hs+182−194

This diff is too big to show here.

src/Text/Pandoc/Writers/CslJson.hsdeleted−91

This diff is too big to show here.

src/Text/Pandoc/Writers/Custom.hs+53−28

This diff is too big to show here.

src/Text/Pandoc/Writers/Docbook.hs+159−207

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx.hs+541−451

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/StyleMap.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Table.hsdeleted−227

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Types.hsdeleted−185

This diff is too big to show here.

src/Text/Pandoc/Writers/DokuWiki.hs+172−161

This diff is too big to show here.

src/Text/Pandoc/Writers/EPUB.hs+344−431

This diff is too big to show here.

src/Text/Pandoc/Writers/FB2.hs+209−163

This diff is too big to show here.

src/Text/Pandoc/Writers/GridTable.hsdeleted−157

This diff is too big to show here.

src/Text/Pandoc/Writers/HTML.hs+833−832

This diff is too big to show here.

src/Text/Pandoc/Writers/Haddock.hs+85−82

This diff is too big to show here.

src/Text/Pandoc/Writers/ICML.hs+201−243

This diff is too big to show here.

src/Text/Pandoc/Writers/Ipynb.hs+69−71

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS.hs+207−329

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/References.hsdeleted−164

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Table.hsdeleted−268

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Types.hsdeleted−57

This diff is too big to show here.

src/Text/Pandoc/Writers/Jira.hsdeleted−339

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX.hs+1078−476

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Caption.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Citation.hsdeleted−181

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Lang.hsdeleted−192

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Notes.hsdeleted−34

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Table.hsdeleted−307

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Types.hsdeleted−83

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Util.hsdeleted−275

This diff is too big to show here.

src/Text/Pandoc/Writers/Man.hs+104−95

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown.hs+829−384

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Inline.hsdeleted−616

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Types.hsdeleted−81

This diff is too big to show here.

src/Text/Pandoc/Writers/Math.hs+13−8

This diff is too big to show here.

src/Text/Pandoc/Writers/MediaWiki.hs+140−148

This diff is too big to show here.

src/Text/Pandoc/Writers/Ms.hs+193−251

This diff is too big to show here.

src/Text/Pandoc/Writers/Muse.hs+193−194

This diff is too big to show here.

src/Text/Pandoc/Writers/Native.hs+32−42

This diff is too big to show here.

src/Text/Pandoc/Writers/ODT.hs+73−58

This diff is too big to show here.

src/Text/Pandoc/Writers/OOXML.hs+42−32

This diff is too big to show here.

src/Text/Pandoc/Writers/OPML.hs+60−35

This diff is too big to show here.

src/Text/Pandoc/Writers/OpenDocument.hs+239−409

This diff is too big to show here.

src/Text/Pandoc/Writers/Org.hs+174−220

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint.hs+25−3

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Output.hs+419−484

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Presentation.hs+138−146

This diff is too big to show here.

src/Text/Pandoc/Writers/RST.hs+195−246

This diff is too big to show here.

src/Text/Pandoc/Writers/RTF.hs+134−127

This diff is too big to show here.

src/Text/Pandoc/Writers/Roff.hs+50−37

This diff is too big to show here.

src/Text/Pandoc/Writers/Shared.hs+208−293

This diff is too big to show here.

src/Text/Pandoc/Writers/TEI.hs+105−76

This diff is too big to show here.

src/Text/Pandoc/Writers/Texinfo.hs+115−105

This diff is too big to show here.

src/Text/Pandoc/Writers/Textile.hs+174−164

This diff is too big to show here.

src/Text/Pandoc/Writers/XWiki.hsdeleted−267

This diff is too big to show here.

src/Text/Pandoc/Writers/ZimWiki.hs+133−126

This diff is too big to show here.

src/Text/Pandoc/XML.hs+60−431

This diff is too big to show here.

src/Text/Pandoc/XML/Light.hsdeleted−89

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Output.hsdeleted−234

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Proc.hsdeleted−139

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Types.hsdeleted−193

This diff is too big to show here.

stack.yaml+19−14

This diff is too big to show here.

test/Tests/Command.hs+46−75

This diff is too big to show here.

test/Tests/Helpers.hs+39−27

This diff is too big to show here.

test/Tests/Lua.hs+46−61

This diff is too big to show here.

test/Tests/Lua/Module.hsdeleted−37

This diff is too big to show here.

test/Tests/Old.hs+31−61

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Readers/Docx.hs+14−57

This diff is too big to show here.

test/Tests/Readers/DokuWiki.hs+18−13

This diff is too big to show here.

test/Tests/Readers/EPUB.hs+5−38

This diff is too big to show here.

test/Tests/Readers/FB2.hs+9−9

This diff is too big to show here.

test/Tests/Readers/HTML.hs+5−35

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Readers/Jira.hsdeleted−204

This diff is too big to show here.

test/Tests/Readers/LaTeX.hs+26−101

This diff is too big to show here.

test/Tests/Readers/Man.hs+23−34

This diff is too big to show here.

test/Tests/Readers/Markdown.hs+11−57

This diff is too big to show here.

test/Tests/Readers/Muse.hs+81−146

This diff is too big to show here.

test/Tests/Readers/Odt.hs+4−5

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+26−34

This diff is too big to show here.

test/Tests/Readers/Org/Block/CodeBlock.hs+46−44

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Readers/Org/Block/Header.hs+5−44

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Readers/Org/Block/Table.hs+22−45

This diff is too big to show here.

test/Tests/Readers/Org/Directive.hs+4−123

This diff is too big to show here.

test/Tests/Readers/Org/Inline.hs+12−17

This diff is too big to show here.

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

This diff is too big to show here.

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

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Readers/Org/Meta.hs+112−200

This diff is too big to show here.

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

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Readers/Txt2Tags.hs+21−35

This diff is too big to show here.

test/Tests/Shared.hs+21−81

This diff is too big to show here.

test/Tests/Writers/AnnotatedTable.hsdeleted−253

This diff is too big to show here.

test/Tests/Writers/AsciiDoc.hs+9−14

This diff is too big to show here.

test/Tests/Writers/ConTeXt.hs+111−123

This diff is too big to show here.

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

This diff is too big to show here.

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

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+20−62

This diff is too big to show here.

test/Tests/Writers/JATS.hs+83−137

This diff is too big to show here.

test/Tests/Writers/Jira.hsdeleted−124

This diff is too big to show here.

test/Tests/Writers/LaTeX.hs+4−2

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Writers/Ms.hsdeleted−35

This diff is too big to show here.

test/Tests/Writers/Muse.hs+15−31

This diff is too big to show here.

test/Tests/Writers/Native.hs+3−1

This diff is too big to show here.

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

This diff is too big to show here.

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

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Writers/Powerpoint.hs+2−24

This diff is too big to show here.

test/Tests/Writers/RST.hs+7−18

This diff is too big to show here.

test/Tests/Writers/TEI.hs+2

This diff is too big to show here.

test/command/01.csvdeleted−4

This diff is too big to show here.

test/command/1279.md+1−1

This diff is too big to show here.

test/command/1592.md−21

This diff is too big to show here.

test/command/1608.mddeleted−41

This diff is too big to show here.

test/command/1710.md+2

This diff is too big to show here.

test/command/1762.mddeleted−18

This diff is too big to show here.

test/command/1881.md+18−50

This diff is too big to show here.

test/command/2103.mddeleted−8

This diff is too big to show here.

test/command/2118.md+1−1

This diff is too big to show here.

test/command/2378.md+3−3

This diff is too big to show here.

test/command/2662.md+1−1

This diff is too big to show here.

test/command/2874.md+2−2

This diff is too big to show here.

test/command/3324.mddeleted−18

This diff is too big to show here.

test/command/3348.md+7−20

This diff is too big to show here.

test/command/3450.md+1−1

This diff is too big to show here.

test/command/3516.md+14−44

This diff is too big to show here.

test/command/3523.mddeleted−31

This diff is too big to show here.

test/command/3530.md+5−2

This diff is too big to show here.

test/command/3531.md+1

This diff is too big to show here.

test/command/3533-rst-csv-tables.md+25−77

This diff is too big to show here.

test/command/3577.md+3−3

This diff is too big to show here.

test/command/3587.md+8−98

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+17−38

This diff is too big to show here.

test/command/3708.md+7−20

This diff is too big to show here.

test/command/3734.md+22−4

This diff is too big to show here.

test/command/3736.md+6−3

This diff is too big to show here.

test/command/3752.mddeleted−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−1

This diff is too big to show here.

test/command/4012.md+1−1

This diff is too big to show here.

test/command/4016.md+6−2

This diff is too big to show here.

test/command/4056.md+7−18

This diff is too big to show here.

test/command/4063.mddeleted−29

This diff is too big to show here.

test/command/4119.md+5−19

This diff is too big to show here.

test/command/4164.md+10−6

This diff is too big to show here.

test/command/4186.mddeleted−60

This diff is too big to show here.

test/command/4235.md+1−1

This diff is too big to show here.

test/command/4320.md+11−25

This diff is too big to show here.

test/command/4420.mddeleted−11

This diff is too big to show here.

test/command/4442.mddeleted−9

This diff is too big to show here.

test/command/4465.mddeleted−15

This diff is too big to show here.

test/command/4499.mddeleted−87

This diff is too big to show here.

test/command/4513.md+4−15

This diff is too big to show here.

test/command/4528.md+1−1

This diff is too big to show here.

test/command/4529.md+1−1

This diff is too big to show here.

test/command/4579.md+5−19

This diff is too big to show here.

test/command/4669.md+1−1

This diff is too big to show here.

test/command/4677.md+1−1

This diff is too big to show here.

test/command/4690.md+2

This diff is too big to show here.

test/command/4742.md+2−2

This diff is too big to show here.

test/command/4794.md+1

This diff is too big to show here.

test/command/4805-beamer-columns-alignment.mddeleted−40

This diff is too big to show here.

test/command/4833.md+1−1

This diff is too big to show here.

test/command/4933.mddeleted−6

This diff is too big to show here.

test/command/5014.md+3−14

This diff is too big to show here.

test/command/5079.md+3−12

This diff is too big to show here.

test/command/5099.md+1−1

This diff is too big to show here.

test/command/5107.mddeleted−23

This diff is too big to show here.

test/command/5121.md+3−2

This diff is too big to show here.

test/command/5128.md+9−17

This diff is too big to show here.

test/command/5178.md+16−16

This diff is too big to show here.

test/command/5285.md−17

This diff is too big to show here.

test/command/5304.mddeleted−24

This diff is too big to show here.

test/command/5321.mddeleted−24

This diff is too big to show here.

test/command/5340.mddeleted−14

This diff is too big to show here.

test/command/5360.mddeleted−19

This diff is too big to show here.

test/command/5367.mddeleted−43

This diff is too big to show here.

test/command/5368.mddeleted−23

This diff is too big to show here.

test/command/5369.mddeleted−7

This diff is too big to show here.

test/command/5407.mddeleted−14

This diff is too big to show here.

test/command/5410.mddeleted−7

This diff is too big to show here.

test/command/5416.mddeleted−13

This diff is too big to show here.

test/command/5420.mddeleted−6

This diff is too big to show here.

test/command/5439.mddeleted−6

This diff is too big to show here.

test/command/5446.mddeleted−6

This diff is too big to show here.

test/command/5474-figures.mddeleted−15

This diff is too big to show here.

test/command/5474-tables.mddeleted−63

This diff is too big to show here.

test/command/5476.mddeleted−12

This diff is too big to show here.

test/command/5495.mddeleted−18

This diff is too big to show here.

test/command/5519.mddeleted−14

This diff is too big to show here.

test/command/5529.mddeleted−10

This diff is too big to show here.

test/command/5540.mddeleted−8

This diff is too big to show here.

test/command/5541-localLink.mddeleted−149

This diff is too big to show here.

test/command/5541-nesting.mddeleted−98

This diff is too big to show here.

test/command/5541-urlLink.mddeleted−112

This diff is too big to show here.

test/command/5543.mddeleted−8

This diff is too big to show here.

test/command/5549.mddeleted−9

This diff is too big to show here.

test/command/5565.mddeleted−6

This diff is too big to show here.

test/command/5566.mddeleted−6

This diff is too big to show here.

test/command/5574.mddeleted−8

This diff is too big to show here.

test/command/5619.mddeleted−10

This diff is too big to show here.

test/command/5620.mddeleted−9

This diff is too big to show here.

test/command/5627.mddeleted−83

This diff is too big to show here.

test/command/5635.mddeleted−23

This diff is too big to show here.

test/command/5642.mddeleted−8

This diff is too big to show here.

test/command/5650.mddeleted−22

This diff is too big to show here.

test/command/5654.mddeleted−6

This diff is too big to show here.

test/command/5655.mddeleted−14

This diff is too big to show here.

test/command/5682.mddeleted−8

This diff is too big to show here.

test/command/5684.mddeleted−6

This diff is too big to show here.

test/command/5686.mddeleted−9

This diff is too big to show here.

test/command/5690.mddeleted−16

This diff is too big to show here.

test/command/5700-metadata-file-1.ymldeleted−1

This diff is too big to show here.

test/command/5700-metadata-file-2.ymldeleted−2

This diff is too big to show here.

test/command/5700.mddeleted−6

This diff is too big to show here.

test/command/5705.mddeleted−11

This diff is too big to show here.

test/command/5708.mddeleted−22

This diff is too big to show here.

test/command/5711.mddeleted−22

This diff is too big to show here.

test/command/5714.mddeleted−13

This diff is too big to show here.

test/command/5740.mddeleted−9

This diff is too big to show here.

test/command/5753.mddeleted−15

This diff is too big to show here.

test/command/5795.mddeleted−20

This diff is too big to show here.

test/command/5797.mddeleted−20

This diff is too big to show here.

test/command/5805.mddeleted−20

This diff is too big to show here.

test/command/5813.mddeleted−6

This diff is too big to show here.

test/command/5819.mddeleted−18

This diff is too big to show here.

test/command/5836.mddeleted−27

This diff is too big to show here.

test/command/5845.mddeleted−16

This diff is too big to show here.

test/command/5846.mddeleted−170

This diff is too big to show here.

test/command/5849-prefix.mddeleted−31

This diff is too big to show here.

test/command/5857.mddeleted−11

This diff is too big to show here.

test/command/5878.mddeleted−7

This diff is too big to show here.

test/command/5881.mddeleted−14

This diff is too big to show here.

test/command/5885.mddeleted−20

This diff is too big to show here.

test/command/5898.mddeleted−36

This diff is too big to show here.

test/command/5899.mddeleted−51

This diff is too big to show here.

test/command/5904.mddeleted−10

This diff is too big to show here.

test/command/5918.mddeleted−6

This diff is too big to show here.

test/command/5936.mddeleted−40

This diff is too big to show here.

test/command/5967.mddeleted−15

This diff is too big to show here.

test/command/5986.mddeleted−17

This diff is too big to show here.

test/command/6009.mddeleted−18

This diff is too big to show here.

test/command/6026.mddeleted−19

This diff is too big to show here.

test/command/6030.mddeleted−96

This diff is too big to show here.

test/command/6033.mddeleted−91

This diff is too big to show here.

test/command/6034.mddeleted−11

This diff is too big to show here.

test/command/6043.mddeleted−8

This diff is too big to show here.

test/command/6062.mddeleted−6

This diff is too big to show here.

test/command/6107.mddeleted−27

This diff is too big to show here.

test/command/6114.mddeleted−7

This diff is too big to show here.

test/command/6119.mddeleted−10

This diff is too big to show here.

test/command/6133.mddeleted−12

This diff is too big to show here.

test/command/6137.mddeleted−47

This diff is too big to show here.

test/command/6194.mddeleted−14

This diff is too big to show here.

test/command/6265.mddeleted−6

This diff is too big to show here.

test/command/6288.mddeleted−8

This diff is too big to show here.

test/command/6296.mddeleted−14

This diff is too big to show here.

test/command/6308.mddeleted−18

This diff is too big to show here.

test/command/6324.mddeleted−17

This diff is too big to show here.

test/command/6360.mddeleted−6

This diff is too big to show here.

test/command/6385.mddeleted−18

This diff is too big to show here.

test/command/6388.mddeleted−16

This diff is too big to show here.

test/command/6481.mddeleted−38

This diff is too big to show here.

test/command/6541.mddeleted−27

This diff is too big to show here.

test/command/6549.mddeleted−26

This diff is too big to show here.

test/command/6620.mddeleted−18

This diff is too big to show here.

test/command/6658.mddeleted−75

This diff is too big to show here.

test/command/6675.mddeleted−134

This diff is too big to show here.

test/command/6699.mddeleted−13

This diff is too big to show here.

test/command/6709.mddeleted−11

This diff is too big to show here.

test/command/6719.mddeleted−18

This diff is too big to show here.

test/command/6723.mddeleted−32

This diff is too big to show here.

test/command/6739.mddeleted−21

This diff is too big to show here.

test/command/6740.mddeleted−7

This diff is too big to show here.

test/command/6741.mddeleted−145

This diff is too big to show here.

test/command/6752.mddeleted−36

This diff is too big to show here.

test/command/6755.mddeleted−11

This diff is too big to show here.

test/command/6765.mddeleted−31

This diff is too big to show here.

test/command/6768.mddeleted−21

This diff is too big to show here.

test/command/6774.mddeleted−63

This diff is too big to show here.

test/command/6783.mddeleted−26

This diff is too big to show here.

test/command/6791.mddeleted−32

This diff is too big to show here.

test/command/6792.mddeleted−66

This diff is too big to show here.

test/command/6796.mddeleted−16

This diff is too big to show here.

test/command/6802.mddeleted−9

This diff is too big to show here.

test/command/6836.mddeleted−17

This diff is too big to show here.

test/command/6837.mddeleted−29

This diff is too big to show here.

test/command/6844.mddeleted−27

This diff is too big to show here.

test/command/6855.mddeleted−12

This diff is too big to show here.

test/command/6858.mddeleted−52

This diff is too big to show here.

test/command/6869.mddeleted−6

This diff is too big to show here.

test/command/6873.mddeleted−7

This diff is too big to show here.

test/command/6890.mddeleted−36

This diff is too big to show here.

test/command/6925.mddeleted−34

This diff is too big to show here.

test/command/6948.mddeleted−31

This diff is too big to show here.

test/command/6951.mddeleted−18

This diff is too big to show here.

test/command/6958.mddeleted−10

This diff is too big to show here.

test/command/6993.mddeleted−21

This diff is too big to show here.

test/command/7003.mddeleted−37

This diff is too big to show here.

test/command/7006.mddeleted−20

This diff is too big to show here.

test/command/7009.mddeleted−8

This diff is too big to show here.

test/command/7016.mddeleted−48

This diff is too big to show here.

test/command/7041.mddeleted−23

This diff is too big to show here.

test/command/7042.mddeleted−146

This diff is too big to show here.

test/command/7058.mddeleted−6

This diff is too big to show here.

test/command/7064.mddeleted−32

This diff is too big to show here.

test/command/7067.mddeleted−90

This diff is too big to show here.

test/command/7080.mddeleted−8

This diff is too big to show here.

test/command/7092.mddeleted−8

This diff is too big to show here.

test/command/7099.mddeleted−18

This diff is too big to show here.

test/command/7112.mddeleted−15

This diff is too big to show here.

test/command/7129.mddeleted−27

This diff is too big to show here.

test/command/7132.mddeleted−10

This diff is too big to show here.

test/command/7134.mddeleted−16

This diff is too big to show here.

test/command/7145.mddeleted−12

This diff is too big to show here.

test/command/7155.mddeleted−15

This diff is too big to show here.

test/command/7173.mddeleted−137

This diff is too big to show here.

test/command/7208.mddeleted−6

This diff is too big to show here.

test/command/7214.mddeleted−28

This diff is too big to show here.

test/command/7216.mddeleted−19

This diff is too big to show here.

test/command/7266.mddeleted−10

This diff is too big to show here.

test/command/7272.mddeleted−27

This diff is too big to show here.

test/command/7278.mddeleted−38

This diff is too big to show here.

test/command/7282.mddeleted−7

This diff is too big to show here.

test/command/7288.mddeleted−40

This diff is too big to show here.

test/command/7299.mddeleted−23

This diff is too big to show here.

test/command/7321.mddeleted−24

This diff is too big to show here.

test/command/7323.mddeleted−29

This diff is too big to show here.

test/command/7324.mddeleted−25

This diff is too big to show here.

test/command/7339.mddeleted−11

This diff is too big to show here.

test/command/7340.mddeleted−6

This diff is too big to show here.

test/command/7376.mddeleted−16

This diff is too big to show here.

test/command/7394.mddeleted−85

This diff is too big to show here.

test/command/7397.mddeleted−14

This diff is too big to show here.

test/command/7400.mddeleted−9

This diff is too big to show here.

test/command/7416.mddeleted−19

This diff is too big to show here.

test/command/A.txtdeleted−1

This diff is too big to show here.

test/command/B.txtdeleted−1

This diff is too big to show here.

test/command/C.txtdeleted−1

This diff is too big to show here.

test/command/D.txtdeleted−1

This diff is too big to show here.

test/command/advanced-optical-materials.csldeleted−155

This diff is too big to show here.

test/command/annales.csldeleted−334

This diff is too big to show here.

test/command/apa.csldeleted−474

This diff is too big to show here.

test/command/archeologie-medievale.csldeleted−291

This diff is too big to show here.

test/command/ascii.md+3−3

This diff is too big to show here.

test/command/averroes.bibdeleted−95

This diff is too big to show here.

test/command/biblatex-266.mddeleted−34

This diff is too big to show here.

test/command/biblatex-aksin.mddeleted−78

This diff is too big to show here.

test/command/biblatex-almendro.mddeleted−71

This diff is too big to show here.

test/command/biblatex-angenendt.mddeleted−66

This diff is too big to show here.

test/command/biblatex-aristotle-anima.mddeleted−62

This diff is too big to show here.

test/command/biblatex-aristotle-physics.mddeleted−63

This diff is too big to show here.

test/command/biblatex-aristotle-poetics.mddeleted−65

This diff is too big to show here.

test/command/biblatex-aristotle-rhetoric.mddeleted−80

This diff is too big to show here.

test/command/biblatex-article.mddeleted−128

This diff is too big to show here.

test/command/biblatex-augustine.mddeleted−56

This diff is too big to show here.

test/command/biblatex-averroes-bland.mddeleted−85

This diff is too big to show here.

test/command/biblatex-averroes-hannes.mddeleted−84

This diff is too big to show here.

test/command/biblatex-averroes-hercz.mddeleted−85

This diff is too big to show here.

test/command/biblatex-baez-article.mddeleted−76

This diff is too big to show here.

test/command/biblatex-baez-online.mddeleted−69

This diff is too big to show here.

test/command/biblatex-basic.mddeleted−71

This diff is too big to show here.

test/command/biblatex-bertram.mddeleted−66

This diff is too big to show here.

test/command/biblatex-bibstring-resolution.mddeleted−20

This diff is too big to show here.

test/command/biblatex-book-averroes.mddeleted−129

This diff is too big to show here.

test/command/biblatex-book-coleridge.mddeleted−59

This diff is too big to show here.

test/command/biblatex-book-title-maintitle-series.mddeleted−39

This diff is too big to show here.

test/command/biblatex-book-vazques-de-parga.mddeleted−48

This diff is too big to show here.

test/command/biblatex-brandt.mddeleted−88

This diff is too big to show here.

test/command/biblatex-britannica.mddeleted−85

This diff is too big to show here.

test/command/biblatex-chiu.mddeleted−77

This diff is too big to show here.

test/command/biblatex-cicero.mddeleted−82

This diff is too big to show here.

test/command/biblatex-cms.mddeleted−81

This diff is too big to show here.

test/command/biblatex-coleridge.mddeleted−86

This diff is too big to show here.

test/command/biblatex-companion.mddeleted−70

This diff is too big to show here.

test/command/biblatex-cotton.mddeleted−69

This diff is too big to show here.

test/command/biblatex-crossref-inbook-mvbook.mddeleted−58

This diff is too big to show here.

test/command/biblatex-crossref-nested.mddeleted−100

This diff is too big to show here.

test/command/biblatex-ctan.mddeleted−73

This diff is too big to show here.

test/command/biblatex-dates.mddeleted−162

This diff is too big to show here.

test/command/biblatex-doody.mddeleted−101

This diff is too big to show here.

test/command/biblatex-edtf-date.mddeleted−72

This diff is too big to show here.

test/command/biblatex-escapedquotes.mddeleted−51

This diff is too big to show here.

test/command/biblatex-formatting.mddeleted−23

This diff is too big to show here.

test/command/biblatex-gaonkar-in.mddeleted−62

This diff is too big to show here.

test/command/biblatex-gaonkar.mddeleted−59

This diff is too big to show here.

test/command/biblatex-geer.mddeleted−70

This diff is too big to show here.

test/command/biblatex-gerhardt.mddeleted−64

This diff is too big to show here.

test/command/biblatex-gillies.mddeleted−69

This diff is too big to show here.

test/command/biblatex-glashow.mddeleted−51

This diff is too big to show here.

test/command/biblatex-gonzalez.mddeleted−62

This diff is too big to show here.

test/command/biblatex-hammond.mddeleted−63

This diff is too big to show here.

test/command/biblatex-herrmann.mddeleted−70

This diff is too big to show here.

test/command/biblatex-hyman.mddeleted−79

This diff is too big to show here.

test/command/biblatex-iliad.mddeleted−68

This diff is too big to show here.

test/command/biblatex-inbook-title-booktitle-maintitle-series-2.mddeleted−48

This diff is too big to show here.

test/command/biblatex-inbook-title-booktitle-maintitle-series.mddeleted−44

This diff is too big to show here.

test/command/biblatex-inbook.mddeleted−147

This diff is too big to show here.

test/command/biblatex-incollection-2.mddeleted−98

This diff is too big to show here.

test/command/biblatex-incollection.mddeleted−130

This diff is too big to show here.

test/command/biblatex-inproceedings.mddeleted−88

This diff is too big to show here.

test/command/biblatex-issue288.mddeleted−35

This diff is too big to show here.

test/command/biblatex-itzhaki.mddeleted−82

This diff is too big to show here.

test/command/biblatex-jaffe.mddeleted−82

This diff is too big to show here.

test/command/biblatex-jcg.mddeleted−54

This diff is too big to show here.

test/command/biblatex-kant-kpv.mddeleted−90

This diff is too big to show here.

test/command/biblatex-kant-ku.mddeleted−82

This diff is too big to show here.

test/command/biblatex-kastenholz.mddeleted−126

This diff is too big to show here.

test/command/biblatex-knuth-ct-a.mddeleted−78

This diff is too big to show here.

test/command/biblatex-knuth-ct-b.mddeleted−70

This diff is too big to show here.

test/command/biblatex-knuth-ct-c.mddeleted−69

This diff is too big to show here.

test/command/biblatex-knuth-ct-d.mddeleted−71

This diff is too big to show here.

test/command/biblatex-knuth-ct-e.mddeleted−66

This diff is too big to show here.

test/command/biblatex-knuth-ct-related.mddeleted−72

This diff is too big to show here.

test/command/biblatex-knuth-ct.mddeleted−66

This diff is too big to show here.

test/command/biblatex-kowalik.mddeleted−68

This diff is too big to show here.

test/command/biblatex-kullback-related.mddeleted−62

This diff is too big to show here.

test/command/biblatex-kullback-reprint.mddeleted−71

This diff is too big to show here.

test/command/biblatex-kullback.mddeleted−52

This diff is too big to show here.

test/command/biblatex-laufenberg.mddeleted−109

This diff is too big to show here.

test/command/biblatex-loh.mddeleted−65

This diff is too big to show here.

test/command/biblatex-malinowski.mddeleted−67

This diff is too big to show here.

test/command/biblatex-manual.mddeleted−51

This diff is too big to show here.

test/command/biblatex-markey.mddeleted−65

This diff is too big to show here.

test/command/biblatex-maron.mddeleted−70

This diff is too big to show here.

test/command/biblatex-massa.mddeleted−56

This diff is too big to show here.

test/command/biblatex-moore-related.mddeleted−66

This diff is too big to show here.

test/command/biblatex-moore.mddeleted−56

This diff is too big to show here.

test/command/biblatex-moraux.mddeleted−94

This diff is too big to show here.

test/command/biblatex-murray.mddeleted−105

This diff is too big to show here.

test/command/biblatex-nietzsche-historie.mddeleted−100

This diff is too big to show here.

test/command/biblatex-nietzsche-ksa.mddeleted−89

This diff is too big to show here.

test/command/biblatex-nietzsche-ksa1.mddeleted−95

This diff is too big to show here.

test/command/biblatex-online.mddeleted−64

This diff is too big to show here.

test/command/biblatex-options-url-false-doi-false.mddeleted−57

This diff is too big to show here.

test/command/biblatex-padhye.mddeleted−117

This diff is too big to show here.

test/command/biblatex-patent.mddeleted−158

This diff is too big to show here.

test/command/biblatex-periodical.mddeleted−31

This diff is too big to show here.

test/command/biblatex-piccato.mddeleted−59

This diff is too big to show here.

test/command/biblatex-pines.mddeleted−77

This diff is too big to show here.

test/command/biblatex-quotes.mddeleted−44

This diff is too big to show here.

test/command/biblatex-reese.mddeleted−71

This diff is too big to show here.

test/command/biblatex-report.mddeleted−119

This diff is too big to show here.

test/command/biblatex-salam.mddeleted−69

This diff is too big to show here.

test/command/biblatex-sarfraz.mddeleted−65

This diff is too big to show here.

test/command/biblatex-shore.mddeleted−66

This diff is too big to show here.

test/command/biblatex-sigfridsson.mddeleted−106

This diff is too big to show here.

test/command/biblatex-sorace.mddeleted−65

This diff is too big to show here.

test/command/biblatex-spiegelberg.mddeleted−74

This diff is too big to show here.

test/command/biblatex-springer.mddeleted−58

This diff is too big to show here.

test/command/biblatex-strings.mddeleted−46

This diff is too big to show here.

test/command/biblatex-test-case-conversion.mddeleted−73

This diff is too big to show here.

test/command/biblatex-textnormal.mddeleted−17

This diff is too big to show here.

test/command/biblatex-thesis.mddeleted−68

This diff is too big to show here.

test/command/biblatex-title-and-shorttitle.mddeleted−76

This diff is too big to show here.

test/command/biblatex-vangennep-related.mddeleted−69

This diff is too big to show here.

test/command/biblatex-vangennep-trans.mddeleted−69

This diff is too big to show here.

test/command/biblatex-vangennep.mddeleted−61

This diff is too big to show here.

test/command/biblatex-vazques-de-parga-mvbook.mddeleted−75

This diff is too big to show here.

test/command/biblatex-vazques-de-parga.mddeleted−74

This diff is too big to show here.

test/command/biblatex-video.mddeleted−19

This diff is too big to show here.

test/command/biblatex-vizedom-related.mddeleted−68

This diff is too big to show here.

test/command/biblatex-wassenberg.mddeleted−83

This diff is too big to show here.

test/command/biblatex-weinberg.mddeleted−52

This diff is too big to show here.

test/command/biblatex-westfahl-frontier.mddeleted−60

This diff is too big to show here.

test/command/biblatex-westfahl-space.mddeleted−106

This diff is too big to show here.

test/command/biblatex-wilde.mddeleted−65

This diff is too big to show here.

test/command/biblatex-worman.mddeleted−60

This diff is too big to show here.

test/command/biblatex-yoon.mddeleted−67

This diff is too big to show here.

test/command/biblio.bibdeleted−26

This diff is too big to show here.

test/command/bibtex-basic.mddeleted−71

This diff is too big to show here.

test/command/bioethics.csldeleted−226

This diff is too big to show here.

test/command/chap1/spider.pngdeleted

Binary file not shown.

test/command/chap1/text.mddeleted−17

This diff is too big to show here.

test/command/chap2/spider.pngdeleted

Binary file not shown.

test/command/chap2/text.mddeleted−5

This diff is too big to show here.

test/command/chicago-annotated-bibliography.csldeleted−1207

This diff is too big to show here.

test/command/chicago-author-date-with-original-date-and-status.csldeleted−575

This diff is too big to show here.

test/command/chicago-fullnote-bibliography.csldeleted−1430

This diff is too big to show here.

test/command/chicago-note-bibliography.csldeleted−1005

This diff is too big to show here.

test/command/chinese-gb7714-2005-numeric.csldeleted−213

This diff is too big to show here.

test/command/cite-in-inline-note.md+1−1

This diff is too big to show here.

test/command/citeproc-17.mddeleted−17

This diff is too big to show here.

test/command/citeproc-20.mddeleted−25

This diff is too big to show here.

test/command/citeproc-7a.mddeleted−42

This diff is too big to show here.

test/command/citeproc-7b.mddeleted−36

This diff is too big to show here.

test/command/citeproc-author-in-text-suffix.mddeleted−6

This diff is too big to show here.

test/command/csv.mddeleted−46

This diff is too big to show here.

test/command/custom-attributes.htmlnew file+16

This diff is too big to show here.

test/command/defaults-inheritance-1.mddeleted−6

This diff is too big to show here.

test/command/defaults-inheritance-2.mddeleted−5

This diff is too big to show here.

test/command/defaults-inheritance-3.mddeleted−6

This diff is too big to show here.

test/command/defaults1.yamldeleted−1

This diff is too big to show here.

test/command/defaults2.yamldeleted−4

This diff is too big to show here.

test/command/defaults3.yamldeleted−4

This diff is too big to show here.

test/command/defaults4.yamldeleted−3

This diff is too big to show here.

test/command/defaults5.yamldeleted−2

This diff is too big to show here.

test/command/defaults6.yamldeleted−2

This diff is too big to show here.

test/command/defaults7.yamldeleted−2

This diff is too big to show here.

test/command/defaults8.yamldeleted−2

This diff is too big to show here.

test/command/defaults9.yamldeleted−1

This diff is too big to show here.

test/command/din-1505-2.csldeleted−406

This diff is too big to show here.

test/command/docbook-bibliography.mddeleted−20

This diff is too big to show here.

test/command/duplicate_attributes.mddeleted−7

This diff is too big to show here.

test/command/empty-inline-code.txtnew file+6

This diff is too big to show here.

test/command/empty_paragraphs.md+2

This diff is too big to show here.

test/command/gfm.md+18−52

This diff is too big to show here.

test/command/harvard-university-of-kent.csldeleted−253

This diff is too big to show here.

test/command/html-trim-definition-list-terms.mddeleted−17

This diff is too big to show here.

test/command/ieee.csldeleted−339

This diff is too big to show here.

test/command/issue160.csldeleted−28

This diff is too big to show here.

test/command/issue437.csldeleted−26

This diff is too big to show here.

test/command/issue58.csldeleted−553

This diff is too big to show here.

test/command/latex-center.mddeleted−13

This diff is too big to show here.

test/command/latex-tabular-column-specs.md+10−31

This diff is too big to show here.

test/command/le-tapuscrit-note.csldeleted−496

This diff is too big to show here.

test/command/lettrine.md+2−2

This diff is too big to show here.

test/command/lists-inside-definition.mddeleted−67

This diff is too big to show here.

test/command/locators.csldeleted−68

This diff is too big to show here.

test/command/lua-pandoc-state.md+2−2

This diff is too big to show here.

test/command/macro-defs-in-preamble.mddeleted−16

This diff is too big to show here.

test/command/macros.md+5−5

This diff is too big to show here.

test/command/make-section-column-divs.mddeleted−28

This diff is too big to show here.

test/command/mmd-metadata.mddeleted−20

This diff is too big to show here.

test/command/modern-humanities-research-association.csldeleted−445

This diff is too big to show here.

test/command/multiple-metadata-blocks.md+1−1

This diff is too big to show here.

test/command/nested-table-to-asciidoc-6942.mddeleted−82

This diff is too big to show here.

test/command/newif.mddeleted−55

This diff is too big to show here.

test/command/oscola.csldeleted−680

This diff is too big to show here.

test/command/pandoc-citeproc-118.mddeleted−28

This diff is too big to show here.

test/command/pandoc-citeproc-119.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-13.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-136.mddeleted−23

This diff is too big to show here.

test/command/pandoc-citeproc-14.mddeleted−77

This diff is too big to show here.

test/command/pandoc-citeproc-152.mddeleted−63

This diff is too big to show here.

test/command/pandoc-citeproc-160.mddeleted−44

This diff is too big to show here.

test/command/pandoc-citeproc-175.mddeleted−43

This diff is too big to show here.

test/command/pandoc-citeproc-197.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-213.mddeleted−33

This diff is too big to show here.

test/command/pandoc-citeproc-25.mddeleted−30

This diff is too big to show here.

test/command/pandoc-citeproc-250.mddeleted−21

This diff is too big to show here.

test/command/pandoc-citeproc-27.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-292.mddeleted−43

This diff is too big to show here.

test/command/pandoc-citeproc-301.mddeleted−25

This diff is too big to show here.

test/command/pandoc-citeproc-307.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-31.mddeleted−48

This diff is too big to show here.

test/command/pandoc-citeproc-312.mddeleted−171

This diff is too big to show here.

test/command/pandoc-citeproc-320.mddeleted−254

This diff is too big to show here.

test/command/pandoc-citeproc-320a.mddeleted−87

This diff is too big to show here.

test/command/pandoc-citeproc-322.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-325.mddeleted−30

This diff is too big to show here.

test/command/pandoc-citeproc-327.mddeleted−51

This diff is too big to show here.

test/command/pandoc-citeproc-338.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-351.mddeleted−27

This diff is too big to show here.

test/command/pandoc-citeproc-356.mddeleted−20

This diff is too big to show here.

test/command/pandoc-citeproc-360.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-361.mddeleted−80

This diff is too big to show here.

test/command/pandoc-citeproc-365.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-371.mddeleted−40

This diff is too big to show here.

test/command/pandoc-citeproc-38.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-386.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-392.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-399.mddeleted−45

This diff is too big to show here.

test/command/pandoc-citeproc-401.mddeleted−59

This diff is too big to show here.

test/command/pandoc-citeproc-408.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-416.mddeleted−60

This diff is too big to show here.

test/command/pandoc-citeproc-437.mddeleted−23

This diff is too big to show here.

test/command/pandoc-citeproc-47.mddeleted−112

This diff is too big to show here.

test/command/pandoc-citeproc-51.mddeleted−45

This diff is too big to show here.

test/command/pandoc-citeproc-53.mddeleted−56

This diff is too big to show here.

test/command/pandoc-citeproc-57.mddeleted−37

This diff is too big to show here.

test/command/pandoc-citeproc-58.mddeleted−32

This diff is too big to show here.

test/command/pandoc-citeproc-61.mddeleted−77

This diff is too big to show here.

test/command/pandoc-citeproc-64.mddeleted−24

This diff is too big to show here.

test/command/pandoc-citeproc-65.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-68.mddeleted−56

This diff is too big to show here.

test/command/pandoc-citeproc-7.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-70.mddeleted−73

This diff is too big to show here.

test/command/pandoc-citeproc-75.mddeleted−67

This diff is too big to show here.

test/command/pandoc-citeproc-76.mddeleted−64

This diff is too big to show here.

test/command/pandoc-citeproc-77.mddeleted−67

This diff is too big to show here.

test/command/pandoc-citeproc-82.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-87.mddeleted−156

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-author-date.mddeleted−109

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-fullnote-bibliography.mddeleted−134

This diff is too big to show here.

test/command/pandoc-citeproc-ieee.mddeleted−113

This diff is too big to show here.

test/command/pandoc-citeproc-locators-delimited.mddeleted−127

This diff is too big to show here.

test/command/pandoc-citeproc-locators-integrated.mddeleted−159

This diff is too big to show here.

test/command/pandoc-citeproc-move-period-inside-quote.mddeleted−52

This diff is too big to show here.

test/command/pandoc-citeproc-no-author.mddeleted−73

This diff is too big to show here.

test/command/pandoc-citeproc-number-of-volumes.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-page-range.mddeleted−32

This diff is too big to show here.

test/command/parse-raw.md+2−2

This diff is too big to show here.

test/command/refs.md+4−4

This diff is too big to show here.

test/command/sage-harvard.csldeleted−202

This diff is too big to show here.

test/command/science.csldeleted−245

This diff is too big to show here.

test/command/section-divs.mddeleted−25

This diff is too big to show here.

test/command/setext-fenced-div.mddeleted−9

This diff is too big to show here.

test/command/shift-heading-level-by.mddeleted−32

This diff is too big to show here.

test/command/style399.csldeleted−12

This diff is too big to show here.

test/command/svg.md+15−17

This diff is too big to show here.

test/command/table-with-cell-align.mddeleted−82

This diff is too big to show here.

test/command/table-with-column-span.mddeleted−276

This diff is too big to show here.

test/command/tabularx.md+48−123

This diff is too big to show here.

test/command/tasklist.md+4−4

This diff is too big to show here.

test/command/toc.mddeleted−47

This diff is too big to show here.

test/command/unicode-collation.mddeleted−130

This diff is too big to show here.

test/command/vancouver.csldeleted−351

This diff is too big to show here.

test/command/video-audio.mddeleted−19

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/command/zeitschrift-fur-kunstgeschichte.csldeleted−346

This diff is too big to show here.

test/creole-reader.native+16−53

This diff is too big to show here.

test/docbook-chapter.docbookdeleted−30

This diff is too big to show here.

test/docbook-chapter.nativedeleted−17

This diff is too big to show here.

test/docbook-reader.docbook+2−39

This diff is too big to show here.

test/docbook-reader.native+107−293

This diff is too big to show here.

test/docx/0_level_headers.native+14−41

This diff is too big to show here.

test/docx/adjacent_codeblocks.docx

Binary file not shown.

test/docx/alternate_document_path.native+1−2

This diff is too big to show here.

test/docx/compact-style-removal.docxdeleted

Binary file not shown.

test/docx/compact-style-removal.nativedeleted−5

This diff is too big to show here.

test/docx/custom-style-preserve.nativedeleted−15

This diff is too big to show here.

test/docx/custom-style-with-styles.native+3−3

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.docxdeleted

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.docxdeleted

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.docxdeleted

Binary file not shown.

test/docx/golden/raw-bookmarks.docxdeleted

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.docxdeleted

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.docxdeleted

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.docxdeleted

Binary file not shown.

test/docx/image_vml_as_object.nativedeleted−2

This diff is too big to show here.

test/docx/inline_formatting.native+1−2

This diff is too big to show here.

test/docx/lists-compact.docxdeleted

Binary file not shown.

test/docx/lists-compact.nativedeleted−5

This diff is too big to show here.

test/docx/lists.docx

Binary file not shown.

test/docx/lists.native+1−1

This diff is too big to show here.

test/docx/lists_level_override.native+1−1

This diff is too big to show here.

test/docx/lists_multiple_initial.nativedeleted−8

This diff is too big to show here.

test/docx/lists_sublist_reset.docxdeleted

Binary file not shown.

test/docx/lists_sublist_reset.nativedeleted−8

This diff is too big to show here.

test/docx/nested_anchors_in_header.native+1−1

This diff is too big to show here.

test/docx/raw-blocks.nativedeleted−6

This diff is too big to show here.

test/docx/raw-bookmarks.nativedeleted−3

This diff is too big to show here.

test/docx/sdt_elements.native+10−24

This diff is too big to show here.

test/docx/sdt_in_footnote.docxdeleted

Binary file not shown.

test/docx/sdt_in_footnote.nativedeleted−1

This diff is too big to show here.

test/docx/table_captions_no_field.docxdeleted

Binary file not shown.

test/docx/table_captions_no_field.nativedeleted−34

This diff is too big to show here.

test/docx/table_captions_with_field.docxdeleted

Binary file not shown.

test/docx/table_captions_with_field.nativedeleted−54

This diff is too big to show here.

test/docx/table_header_rowspan.docxdeleted

Binary file not shown.

test/docx/table_header_rowspan.nativedeleted−189

This diff is too big to show here.

test/docx/table_one_header_row.docxdeleted

Binary file not shown.

test/docx/table_one_header_row.nativedeleted−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+7−18

This diff is too big to show here.

test/docx/table_variable_width.native+16−40

This diff is too big to show here.

test/docx/table_with_list_cell.native+11−25

This diff is too big to show here.

test/docx/tables-default-widths.nativedeleted−92

This diff is too big to show here.

test/docx/tables.native+35−91

This diff is too big to show here.

test/docx/track_changes_scrubbed_metadata.docxdeleted

Binary file not shown.

test/docx/track_changes_scrubbed_metadata.nativedeleted−9

This diff is too big to show here.

test/docx/trim_last_inline.docxdeleted

Binary file not shown.

test/docx/trim_last_inline.nativedeleted−2

This diff is too big to show here.

test/dokuwiki_multiblock_table.native+18−41

This diff is too big to show here.

test/epub/epub2_cover.epubdeleted

Binary file not shown.

test/epub/epub2_no_cover.epubdeleted

Binary file not shown.

test/epub/epub2_picture.epubdeleted

Binary file not shown.

test/epub/features.epub

Binary file not shown.

test/epub/features.native+3−3

This diff is too big to show here.

test/epub/img_no_cover.epubdeleted

Binary file not shown.

test/epub/wasteland.epub

Binary file not shown.

test/epub/wasteland.native+892−889

This diff is too big to show here.

test/fb2/basic.fb2+6−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/reader/notes.fb2deleted−19

This diff is too big to show here.

test/fb2/reader/notes.nativedeleted−4

This diff is too big to show here.

test/fb2/test.jpg

Binary file not shown.

test/fb2/titles.fb2+1−1

This diff is too big to show here.

test/grofftest.shnew file+26

This diff is too big to show here.

test/html-reader.html−80

This diff is too big to show here.

test/html-reader.native+132−496

This diff is too big to show here.

test/ipynb/simple.in.nativedeleted−15

This diff is too big to show here.

test/ipynb/simple.ipynbdeleted−86

This diff is too big to show here.

test/ipynb/simple.out.nativedeleted−15

This diff is too big to show here.

test/jats-reader.native+131−380

This diff is too big to show here.

test/jats-reader.xml+3−4

This diff is too big to show here.

test/jira-reader.jiradeleted−284

This diff is too big to show here.

test/jira-reader.nativedeleted−185

This diff is too big to show here.

test/latex-reader.latex+9−4

This diff is too big to show here.

test/latex-reader.native+24−65

This diff is too big to show here.

test/lhs-test.html+70−204

This diff is too big to show here.

test/lhs-test.html+lhs+70−204

This diff is too big to show here.

test/lhs-test.latex+29−19

This diff is too big to show here.

test/lhs-test.latex+lhs+26−16

This diff is too big to show here.

test/lua/blocks-filter.luadeleted−8

This diff is too big to show here.

test/lua/inlines-filter.luadeleted−19

This diff is too big to show here.

test/lua/meta.luadeleted−6

This diff is too big to show here.

test/lua/module/pandoc-list.luadeleted−160

This diff is too big to show here.

test/lua/module/pandoc-mediabag.luadeleted−72

This diff is too big to show here.

test/lua/module/pandoc-path.luadeleted−44

This diff is too big to show here.

test/lua/module/pandoc-types.luadeleted−111

This diff is too big to show here.

test/lua/module/pandoc-utils.luadeleted−159

This diff is too big to show here.

test/lua/module/pandoc.luadeleted−253

This diff is too big to show here.

test/lua/require-file.luadeleted−2

This diff is too big to show here.

test/lua/test-pandoc-utils.luanew file+138

This diff is too big to show here.

test/man-reader.native+72−192

This diff is too big to show here.

test/markdown-citations.native+14−14

This diff is too big to show here.

test/markdown-reader-more.native+73−185

This diff is too big to show here.

test/mediawiki-reader.native+69−225

This diff is too big to show here.

test/odt/markdown/formula.mddeleted−1

This diff is too big to show here.

test/odt/native/simpleTable.native+1−1

This diff is too big to show here.

test/odt/native/simpleTableWithCaption.native+1−1

This diff is too big to show here.

test/odt/native/tab.nativedeleted−1

This diff is too big to show here.

test/odt/native/tableWithContents.native+1−1

This diff is too big to show here.

test/odt/odt/tab.odtdeleted

Binary file not shown.

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

This diff is too big to show here.

test/pipe-tables.native+104−315

This diff is too big to show here.

test/pptx/code-custom.pptxdeleted

Binary file not shown.

test/pptx/code-custom_templated.pptxdeleted

Binary file not shown.

test/pptx/code.nativedeleted−21

This diff is too big to show here.

test/pptx/code.pptxdeleted

Binary file not shown.

test/pptx/code_templated.pptxdeleted

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.native+1−1

This diff is too big to show here.

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.nativedeleted−5

This diff is too big to show here.

test/pptx/speaker_notes_after_metadata.pptxdeleted

Binary file not shown.

test/pptx/speaker_notes_after_metadata_templated.pptxdeleted

Binary file not shown.

test/pptx/speaker_notes_afterheader.nativedeleted−3

This diff is too big to show here.

test/pptx/speaker_notes_afterheader.pptxdeleted

Binary file not shown.

test/pptx/speaker_notes_afterheader_templated.pptxdeleted

Binary file not shown.

test/pptx/speaker_notes_afterseps.native+18−48

This diff is too big to show here.

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.nativedeleted−9

This diff is too big to show here.

test/pptx/start_numbering_at.pptxdeleted

Binary file not shown.

test/pptx/start_numbering_at_templated.pptxdeleted

Binary file not shown.

test/pptx/tables.native+34−94

This diff is too big to show here.

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+66−174

This diff is too big to show here.

test/rst-reader.rst+1−25

This diff is too big to show here.

test/s5-basic.html+4−7

This diff is too big to show here.

test/s5-fancy.html+5−7

This diff is too big to show here.

test/s5-inserts.html+4−7

This diff is too big to show here.

test/tables-rstsubset.native+107−294

This diff is too big to show here.

test/tables.asciidoctordeleted−67

This diff is too big to show here.

test/tables.custom+1

This diff is too big to show here.

test/tables.dokuwiki+1

This diff is too big to show here.

test/tables.fb2+2−1

This diff is too big to show here.

test/tables.haddock+70−70

This diff is too big to show here.

test/tables.jatsnew file+226

This diff is too big to show here.

test/tables.jats_archivingdeleted−226

This diff is too big to show here.

test/tables.jats_articleauthoringdeleted−226

This diff is too big to show here.

test/tables.jats_publishingdeleted−226

This diff is too big to show here.

test/tables.jiradeleted−43

This diff is too big to show here.

test/tables.latex+101−65

This diff is too big to show here.

test/tables.mediawiki+1

This diff is too big to show here.

test/tables.ms−44

This diff is too big to show here.

test/tables.native+107−286

This diff is too big to show here.

test/tables.opendocument+6−6

This diff is too big to show here.

test/tables.org+31−31

This diff is too big to show here.

test/tables.rtf+1

This diff is too big to show here.

test/tables.tei+12

This diff is too big to show here.

test/tables.textile+1

This diff is too big to show here.

test/tables.txt+1

This diff is too big to show here.

test/tables.xwiki−45

This diff is too big to show here.

test/tables.zimwiki+1

This diff is too big to show here.

test/tables/nordics.html4−59

This diff is too big to show here.

test/tables/nordics.html5−59

This diff is too big to show here.

test/tables/nordics.jats_archiving−58

This diff is too big to show here.

test/tables/nordics.latex−42

This diff is too big to show here.

test/tables/nordics.native−73

This diff is too big to show here.

test/tables/planets.html4−133

This diff is too big to show here.

test/tables/planets.html5−133

This diff is too big to show here.

test/tables/planets.jats_archiving−128

This diff is too big to show here.

test/tables/planets.latex−30

This diff is too big to show here.

test/tables/planets.native−241

This diff is too big to show here.

test/tables/students.html4−55

This diff is too big to show here.

test/tables/students.html5−55

This diff is too big to show here.

test/tables/students.jats_archiving−56

This diff is too big to show here.

test/tables/students.latex−31

This diff is too big to show here.

test/tables/students.native−54

This diff is too big to show here.

test/test-pandoc.hs+9−31

This diff is too big to show here.

test/testsuite.native+1−1

This diff is too big to show here.

test/textile-reader.native+41−104

This diff is too big to show here.

test/textile-reader.textile+1−1

This diff is too big to show here.

test/tikiwiki-reader.native+38−120

This diff is too big to show here.

test/twiki-reader.native+34−110

This diff is too big to show here.

test/txt2tags.native+304−661

This diff is too big to show here.

test/txt2tags.t2t+1−1

This diff is too big to show here.

test/vimwiki-reader.native+76−214

This diff is too big to show here.

test/vimwiki-reader.wiki−6

This diff is too big to show here.

test/writer.asciidoc+2−6

This diff is too big to show here.

test/writer.asciidoctor−649

This diff is too big to show here.

test/writer.context+47−51

This diff is too big to show here.

test/writer.custom+4−3

This diff is too big to show here.

test/writer.docbook4+1266−1272

This diff is too big to show here.

test/writer.docbook5+1230−1237

This diff is too big to show here.

test/writer.dokuwiki+1−12

This diff is too big to show here.

test/writer.fb2+45−36

This diff is too big to show here.

test/writer.haddock−1

This diff is too big to show here.

test/writer.html4+13−146

This diff is too big to show here.

test/writer.html5+13−146

This diff is too big to show here.

test/writer.icml+33−69

This diff is too big to show here.

test/writer.jats+47−68

This diff is too big to show here.

test/writer.jats_archiving−902

This diff is too big to show here.

test/writer.jats_articleauthoring−874

This diff is too big to show here.

test/writer.jira−537

This diff is too big to show here.

test/writer.latex+42−35

This diff is too big to show here.

test/writer.man+39−39

This diff is too big to show here.

test/writer.markdown+61−77

This diff is too big to show here.

test/writer.mediawiki+1−1

This diff is too big to show here.

test/writer.ms+57−60

This diff is too big to show here.

test/writer.muse+1−1

This diff is too big to show here.

test/writer.native+1−1

This diff is too big to show here.

test/writer.opendocument+4−4

This diff is too big to show here.

test/writer.opml+2−2

This diff is too big to show here.

test/writer.org+138−112

This diff is too big to show here.

test/writer.plain+89−36

This diff is too big to show here.

test/writer.rst+1−1

This diff is too big to show here.

test/writer.rtf+1−1

This diff is too big to show here.

test/writer.texinfo−1

This diff is too big to show here.

test/writer.textile+8−8

This diff is too big to show here.

test/writer.xwiki−650

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+13−16

This diff is too big to show here.

test/writers-lang-and-dir.latex+41−35

This diff is too big to show here.

tools/build-arm.sh−110

This diff is too big to show here.

tools/changelog-helper.sh+4−11

This diff is too big to show here.

tools/changes_template.html−6

This diff is too big to show here.

tools/diff-zip.sh−33

This diff is too big to show here.

tools/extract-changes.hs+3−9

This diff is too big to show here.

tools/ldoc.ltp+38

This diff is too big to show here.

tools/parseTimings.pl−33

This diff is too big to show here.

tools/update-lua-docs.lua+49

This diff is too big to show here.

tools/update-readme.lua+9−15

This diff is too big to show here.

trypandoc/index.html+11−31

This diff is too big to show here.

trypandoc/trypandoc.hs+13−10

This diff is too big to show here.

windows/Makefile−10

This diff is too big to show here.

windows/Pandoc-en-us.wxl+1−1

This diff is too big to show here.

windows/make-windows-installer.bat+29

This diff is too big to show here.

windows/pandoc.wxs+7−5

This diff is too big to show here.