master..50da884 · typeable/pandoc

git.iko.soy/typeable/pandoc

on 50da884 help sign in

.circleci/config.ymldeleted−72

since splitsnapshots

unifiedsplit

@@ -1,72 +0,0 @@

1−version: "2.1"

2−jobs:

3− build:

4− macos:

5− xcode: 11.1.0

6− environment:

7− HOMEBREW_NO_AUTO_UPDATE: 1

8− 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}

50−

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"

58−

59− - store_artifacts:

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

61− path: macos-release-candidate.zip

62− destination: macos-release-candidate.zip

63−

64−workflows:

65− version: 2

66− release:

67− jobs:

68− - build:

69− filters:

70− branches:

71− only:

72− - /rc\/.*/

.editorconfig−8

@@ -8,14 +8,6 @@ indent_size = 2

8insert_final_newline = true

9trim_trailing_whitespace = true

11−[*.{zip,docx}]

12−charset =

13−end_of_line =

14−indent_style =

15−indent_size =

16−insert_final_newline =

17−trim_trailing_whitespace =

18−

19[*.{markdown,md}]

11[*.{markdown,md}]

20trim_trailing_whitespace = false

12trim_trailing_whitespace = false

.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.

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 @@

1*~

2−.DS_Store

3−*.orig

4deb/.vagrant

2deb/.vagrant

5dist/*

3dist/*

6MANUAL.*

4MANUAL.*

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

16*.o

14*.o

17*.hi

15*.hi

18*.pyc

16*.pyc

19−.hie/

20−.policeman-evidence/

21−.projectile/

22−.vscode/

23/COPYING.rtf

17/COPYING.rtf

24/COPYRIGHT.txt

18/COPYRIGHT.txt

25/cabal-dev/

19/cabal-dev/

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

29data/reference.docx

23data/reference.docx

30data/reference.odt

24data/reference.odt

31.stack-work

25.stack-work

32−/stack.yaml.lock

33−cabal.project.local

34−/dist-newstyle/

35−pandoc-2*/

.hlint.yaml+54−94

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

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

3##########################

5−# Specify additional command line arguments

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

6−#

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

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

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

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

9+# Specify additional command line arguments

44−- ignore:

10+#

45− name: "Redundant bracket"

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

48−- ignore:

14+# Control which extensions/flags/modules/functions can be used

49− name: "Use <$>"

15+#

50− within:

16+# - extensions:

51− - Text.Pandoc.Readers.LaTeX

17+# - default: false # all extension are banned by default

52− - Text.Pandoc.Readers.Markdown

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

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

67−- ignore:

32+# Add custom hints for this project

68− name: "Use forM_"

33+#

69− within:

34+# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"

70− - Text.Pandoc.Readers.DocBook

35+# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}

72−- ignore:

73− name: "Use Just"

74− within:

75− - Text.Pandoc.Citeproc.MetaValue

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

77− - Text.Pandoc.Writers.Roff

79−- ignore:

38+# Turn on hints that are off by default

80− name: "Use list comprehension"

39+#

81− within: Text.Pandoc.Citeproc.BibTeX

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}

83−- ignore:

84− name: "Use list literal pattern"

85− within: Text.Pandoc.Citeproc.MetaValue

87−# TODO: check

50+# Ignore some builtin hints

88−- ignore:

51+# - ignore: {name: Use let}

89− name: "Use second"

52+# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules

90− within:

53+# - ignore: {name: "Use section"}

91− - Text.Pandoc.Citeproc.BibTeX

54+# - ignore: {name: "Use camelCase"}

92− - Text.Pandoc.Citeproc.Locator

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"}

94−# TODO: check

68+# Define some custom infix operators

95−- ignore:

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

96− name: "Use sortOn"

97− within: Text.Pandoc.Writers.OpenDocument

99−- ignore:

100− name: "Use tuple-section"

101− within:

102− - Text.Pandoc.Readers.EPUB

103− - Text.Pandoc.ImageSize

104− - Text.Pandoc.Readers.Markdown

105− - Text.Pandoc.Readers.RST

106

107−# fromRight is only in base >= 4.10

108−- ignore:

109− name: "Use fromRight"

110

111−# Define some custom infix operators

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

.mailmapdeleted−37

@@ -1,37 +0,0 @@

1−Adam Brandizzi <brandizzi@gmail.com>

2−Albert Krewinkel <albert@zeitkraut.de> <albert+github@zeitkraut.de>

3−Albert Krewinkel <albert@zeitkraut.de> <albert.krewinkel@tourstream.eu>

4−Albert Krewinkel <albert@zeitkraut.de> <tarleb@moltkeplatz.de>

5−Albert Krewinkel <albert@zeitkraut.de> <tarleb@zeitkraut.de>

6−Alexander Krotov <ilabdsf@gmail.com>

7−Alex Ivkin <alex@ivkin.net>

8−Alex Ivkin <alex@ivkin.net> <alexivkin@users.noreply.github.com>

9−Andrew Dunning <andunning@gmail.com>

10−Andrew Dunning <andunning@gmail.com> <adunning@users.noreply.github.com>

11−Andrew Newman <andrewfnewman@gmail.com>

12−Clare Macrae <clare.macrae@googlemail.com> <github@cfmacrae.fastmail.co.uk>

13−Hugo Roy <hugo@fsfe.org>

14−Hugo Roy <hugo@xps.ampoliros.net>

15−John MacFarlane <jgm@berkeley.edu> <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>

16−John MacFarlane <jgm@berkeley.edu> <fiddlosopher@gmail.com>

17−John MacFarlane <jgm@berkeley.edu> <jgm@Johns-MacBook-Pro.local>

18−Jose Luis Duran <jlduran@gmail.com> <jlduran@users.noreply.github.com>

19−Marc Schreiber <schrieveslaach@online.de>

20−Masayoshi Takahashi <maki@rubycolor.org>

21−Matthew Pickering <matthewtpickering@gmail.com>

22−Mauro Bieg <mauro.bieg@gmail.com>

23−Mauro Bieg <mauro.bieg@gmail.com> <maurobieg@Mauros-MacBook-Air.local>

24−Mauro Bieg <mauro.bieg@gmail.com> <mb21@server.fake>

25−Mauro Bieg <mauro.bieg@gmail.com> <mb21@users.noreply.github.com>

26−Mauro Bieg <mb21@users.noreply.github.com>

27−Nils Carlson <nils.carlson@ludd.ltu.se>

28−Nils Carlson <nils.carlson@ludd.ltu.se> <pyssling@ludd.ltu.se>

29−Robin Lambertz <robinlambertz+dev@gmail.com>

30−Roland Hieber <rohieb@rohieb.name> <rohieb@users.noreply.github.com>

31−Sebastian Talmon <35015406+stalmon@users.noreply.github.com>

32−Sergei Trofimovich <slyfox@gentoo.org> <siarheit@google.com>

33−Sergei Trofimovich <slyfox@gentoo.org> <slyfox@inbox.ru>

34−Stefan Björk <stefan.bjork@gmail.com> <stefan@airistotle.local>

35−Thomas Hodgson <hello@twshodgson.net> <twsh@users.noreply.github.com>

36−Timm Albers <timmm.albers@gmail.com> <timm.albers@open-xchange.com>

37−Yan Pashkovsky <yanpaso@gmail.com> <Yanpas@users.noreply.github.com>

.stylish-haskell.yaml+4−4

@@ -41,7 +41,7 @@ steps:

41 # Default: global.

42 align: none

44− # Following options affect only import list alignment.

44+ # Folowing options affect only import list alignment.

45 #

46 # List align has following options:

47 #

@@ -75,7 +75,7 @@ steps:

75 # short enough to fit to single line. Otherwise it'll be multiline.

76 #

77 # - multiline: One line per import list entry.

78− # Type with constructor list acts like single import.

78+ # Type with contructor list acts like single import.

79 #

80 # > import qualified Data.Map as M

81 # > ( empty

@@ -91,7 +91,7 @@ steps:

91 # This option affects 'list_align' and 'long_list_align'.

92 list_padding: 4

94− # Separate lists option affects formatting of import list for type

94+ # Separate lists option affects formating of import list for type

95 # or class. The only difference is single space between type and list

96 # of constructors, selectors and class functions.

97 #

@@ -124,7 +124,7 @@ steps:

124

125 # Align affects alignment of closing pragma brackets.

126 #

127− # - true: Brackets are aligned in same column.

127+ # - true: Brackets are aligned in same collumn.

128 #

129 # - false: Brackets are not aligned together. There is only one space

130 # between actual import and closing bracket.

.travis.ymlnew file+139

@@ -0,0 +1,139 @@

1+# This .travis.yml is modified from the sample at

2+# https://docs.haskellstack.org/en/stable/GUIDE/#travis-with-caching

4+# Use new container infrastructure to enable caching

5+sudo: false

7+# Do not choose a language; we provide our own build tools.

8+language: generic

10+# Caching so the next build will be fast too.

11+cache:

12+ directories:

13+ - $HOME/.ghc

14+ - $HOME/.cabal

15+ - $HOME/.stack

16+

17+# The different configurations we want to test. We have BUILD=cabal which uses

18+# cabal-install, and BUILD=stack which uses Stack. More documentation on each

19+# of those below.

20+#

21+# We set the compiler values here to tell Travis to use a different

22+# cache file per set of arguments.

23+#

24+# If you need to have different apt packages for each combination in the

25+# matrix, you can use a line such as:

26+# addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}

27+#

28+# fast_finish: build successful when every builds not in allow_failure are finished

29+# i.e. not waiting any of the allow_failure to finish

30+matrix:

31+ include:

32+ # We grab the appropriate GHC and cabal-install versions from hvr's PPA. See:

33+ # https://github.com/hvr/multi-ghc-travis

34+ # don't build benchmarks for ghc 7.10.3, because build takes too long...

35+ - env: BUILD=cabal GHCVER=7.10.3 CABALVER=1.22 OPTS="-O0 -Wall -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS=""

36+ compiler: ": #GHC 7.10.3"

37+ addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.3,happy-1.19.5], sources: [hvr-ghc]}}

38+

39+ # don't build benchmarks for ghc 8.0.2, because build takes too long...

40+ - env: BUILD=cabal GHCVER=8.0.2 CABALVER=1.24 OPTS="-O0 -Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror" FLAGS="fast" CABALARGS=""

41+ compiler: ": #GHC 8.0.2"

42+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.0.2,happy-1.19.5], sources: [hvr-ghc]}}

43+

44+ - env: BUILD=cabal GHCVER=8.2.2 CABALVER=1.24 OPTS="-O0 -Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS="--enable-benchmarks"

45+ compiler: ": #GHC 8.2.2"

46+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.2.2,happy-1.19.5], sources: [hvr-ghc]}}

47+

48+ - env: BUILD=cabal GHCVER=8.2.2 CABALVER=2.0 OPTS="-O0 -Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS="--enable-benchmarks"

49+ compiler: ": #GHC 8.2.2"

50+ addons: {apt: {packages: [cabal-install-2.0,ghc-8.2.2,happy-1.19.5], sources: [hvr-ghc]}}

51+

52+ - env: BUILD=cabal GHCVER=8.4.1 CABALVER=2.0 OPTS="-O0 -Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS="--enable-benchmarks"

53+ compiler: ": #GHC 8.4.1"

54+ addons: {apt: {packages: [cabal-install-2.0,ghc-8.4.1,happy-1.19.5], sources: [hvr-ghc]}}

55+

56+ # Build with the newest GHC and cabal-install. This is an accepted failure,

57+ # see below.

58+ # - env: BUILD=cabal GHCVER=head CABALVER=head CABALAGS="--allow-newer"

59+ # compiler: ": #GHC HEAD"

60+ # addons: {apt: {packages: [cabal-install-head,ghc-head], sources: [hvr-ghc]}}

61+

62+ # The Stack builds. We can pass in arbitrary Stack arguments via the ARGS

63+ # variable, such as using --stack-yaml to point to a different file.

64+ # - env: BUILD=stack ARGS="--stack-yaml stack.lts9.yaml" OPTS="-Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror"

65+ # compiler: ": #stack 8.0.2"

66+ # addons: {apt: {packages: [ghc-8.0.2], sources: [hvr-ghc]}}

67+

68+ - env: BUILD=stack ARGS="--resolver lts-10" OPTS="-Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror"

69+ compiler: ": #stack 8.2.2"

70+ addons: {apt: {packages: [ghc-8.2.2], sources: [hvr-ghc]}}

71+

72+ # Nightly builds are allowed to fail

73+ - env: BUILD=stack ARGS="--resolver nightly" OPTS="-Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror"

74+ compiler: ": #stack nightly"

75+ addons: {apt: {packages: [ghc-8.2.2], sources: [hvr-ghc]}}

76+

77+ # - env: BUILD=stack ARGS="--resolver lts-8"

78+ # compiler: ": #stack 8.0.2 osx"

79+ # os: osx

80+

81+ # - env: BUILD=stack ARGS="--resolver nightly"

82+ # compiler: ": #stack nightly osx"

83+ # os: osx

84+

85+ allow_failures:

86+ - env: BUILD=cabal GHCVER=head CABALVER=head

87+ - env: BUILD=stack ARGS="--resolver nightly" OPTS="-Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror"

88+

89+ fast_finish: true

90+

91+before_install:

92+# Using compiler above sets CC to an invalid value, so unset it

93+- unset CC

94+- export PATH=/opt/happy/1.19.5/bin/:/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.local/bin:$HOME/.cabal/bin:$PATH

95+# Download and unpack the stack executable

96+- |

97+ if [[ $BUILD == "stack" ]]; then

98+ mkdir -p ~/.local/bin

99+ if [ `uname` = "Darwin" ]

100+ then

101+ curl --insecure -L https://www.stackage.org/stack/osx-x86_64 | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin

102+ else

103+ curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'

104+ fi

105+ fi

106+

107+install:

108+- echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"

109+- if [ -f configure.ac ]; then autoreconf -i; fi

110+- |

111+ case "$BUILD" in

112+ stack)

113+ ulimit -n 4096

114+ stack config set system-ghc --global true

115+ stack --no-terminal --install-ghc $ARGS build --only-dependencies --fast --flag 'pandoc:embed_data_files' --flag 'aeson:fast' --jobs 2

116+ ;;

117+ cabal)

118+ cabal --version

119+ travis_retry cabal update

120+ cabal install --disable-optimization --only-dependencies --flags="$FLAGS" --enable-tests --force-reinstalls --reorder-goals --max-backjumps=-1 $CABALARGS

121+ ;;

122+ esac

123+

124+script:

125+- |

126+ case "$BUILD" in

127+ stack)

128+ ulimit -n 4096

129+ stack config set system-ghc --global true

130+ stack --no-terminal $ARGS test --fast --flag 'aeson:fast' --flag pandoc:embed_data_files --haddock --no-haddock-deps --ghc-options="$OPTS" --test-arguments='--hide-successes'

131+ ;;

132+ cabal)

133+ cabal sdist --output-directory=sourcedist && \

134+ cd sourcedist && \

135+ cabal configure --disable-optimization --enable-tests -v2 --flags="$FLAGS" --ghc-options="$OPTS" $CABALARGS && \

136+ cabal build -v2 -j2 && \

137+ cabal test

138+ ;;

139+ esac

AUTHORS.md+3−131

@@ -1,100 +1,60 @@

1# Contributors

3- Anabra

4−- Aner Lucero

5- Arata Mizuki

4- Arata Mizuki

6−- Arfon Smith

7- Aaron Wolen

5- Aaron Wolen

8- Albert Krewinkel

6- Albert Krewinkel

9- Alex Ivkin

7- Alex Ivkin

10−- Alex Toldaiev

11- Alex Vong

8- Alex Vong

12- Alexander Kondratskiy

9- Alexander Kondratskiy

13- Alexander Krotov

10- Alexander Krotov

14- Alexander Sulfrian

11- Alexander Sulfrian

15- Alexander V Vershilov

12- Alexander V Vershilov

16−- Alexandre Franke

17- Alfred Wechselberger

13- Alfred Wechselberger

18−- Amogh Rathore

19−- Anders Waldenborg

20- Andreas Lööw

14- Andreas Lööw

21- Andrew Dunning

15- Andrew Dunning

22−- Andy Morris

23−- Anti-Distinctlyminty

24- Antoine Latter

16- Antoine Latter

25−- Antonio Terceiro

26- Arata Mizuki

17- Arata Mizuki

27−- Arfon Smith

28- Arlo O'Keeffe

18- Arlo O'Keeffe

29- Artyom Kazak

19- Artyom Kazak

30- Agustín Martín Barbero

20- Agustín Martín Barbero

31- B. Scott Michel

21- B. Scott Michel

32- Ben Firshman

22- Ben Firshman

33- Ben Gamari

23- Ben Gamari

34−- Ben Steinberg

35- Beni Cherniavsky-Paskin

24- Beni Cherniavsky-Paskin

36- Benoit Schweblin

25- Benoit Schweblin

37- Bjorn Buckwalter

26- Bjorn Buckwalter

38−- Blake Eryx

39−- Bodigrim

40- Bradley Kuhn

27- Bradley Kuhn

41- Brent Yorgey

28- Brent Yorgey

42−- Brian Leung

43- Bryan O'Sullivan

29- Bryan O'Sullivan

44- Caleb McDaniel

30- Caleb McDaniel

45−- Caleb Mclennan

46- Calvin Beck

31- Calvin Beck

47- Carlos Sosa

32- Carlos Sosa

48−- Cécile Chemin

49−- Cédric Couralet

50−- Charanjit Singh

51- Chris Black

33- Chris Black

52- Christian Conkle

34- Christian Conkle

53−- Christian Despres

54- Christoffer Ackelman

35- Christoffer Ackelman

55- Christoffer Sawicki

36- Christoffer Sawicki

56- Clare Macrae

37- Clare Macrae

57- Clint Adams

38- Clint Adams

58- Conal Elliott

39- Conal Elliott

59−- Cormac Relf

60- Craig S. Bosma

40- Craig S. Bosma

61−- Damien Clochard

62- Daniel Bergey

41- Daniel Bergey

63−- Daniel Maslowski

64- Daniel T. Staal

42- Daniel T. Staal

65- Daniele D'Orazio

43- Daniele D'Orazio

66- David A Roberts

44- David A Roberts

67- David Lazar

45- David Lazar

68−- David Martschenko

69- David Röthlisberger

46- David Röthlisberger

70- Denis Laxalde

47- Denis Laxalde

71−- Denis Maier

72−- Derek Chen-Becker

73−- Diego Balseiro

74−- Dimitri Sabadie

75−- Dmitry Pogodin

76−- Dmitry Volodin

77- Douglas Calvert

48- Douglas Calvert

78−- Eigil Rischel

79- Emanuel Evans

49- Emanuel Evans

80−- Emerson Harkin

81−- Emily Bourke

82- Emily Eisenberg

50- Emily Eisenberg

83- Eric Kow

51- Eric Kow

84−- Erik Rask

85- Eric Seidel

52- Eric Seidel

86−- Eric Schrijver

87−- Ethan Riley

88- Étienne Bersac

53- Étienne Bersac

89- Felix Yan

54- Felix Yan

90−- Félix Baylac-Jacqué

91−- Florian Beeres

92- Florian Eitel

55- Florian Eitel

93−- Florian Klink

94−- Florian Kohrt

95- Francesco Occhipinti

56- Francesco Occhipinti

96- François Gannaz

57- François Gannaz

97−- Frederik Elwert

98- Freiric Barral

58- Freiric Barral

99- Freirich Raabe

59- Freirich Raabe

100- Frerich Raabe

60- Frerich Raabe

@@ -108,71 +68,43 @@

108- Gwern Branwen

68- Gwern Branwen

109- Hamish Mackenzie

69- Hamish Mackenzie

110- Hans-Peter Deifel

70- Hans-Peter Deifel

111−- Heiko Schlittermann

112- Henrik Tramberend

71- Henrik Tramberend

113- Henry de Valence

72- Henry de Valence

114- Hubert Plociniczak

73- Hubert Plociniczak

115−- Ian Max Andolina

116−- Igor Khorlo

117−- Igor Pashev

118- Ilya V. Portnov

74- Ilya V. Portnov

119−- Ivan Trubach

120- Ivo Clarysse

75- Ivo Clarysse

121−- Jared Lander

122−- J. B. Rainsberger

123- J. Lewis Muir

76- J. Lewis Muir

124- Jaime Marquínez Ferrándiz

77- Jaime Marquínez Ferrándiz

125−- Jake Zimmerman

126- Jakob Voß

78- Jakob Voß

127- James Aspnes

79- James Aspnes

128- Jamie F. Olson

80- Jamie F. Olson

129- Jan Larres

81- Jan Larres

130- Jan Schulz

82- Jan Schulz

131−- Jan Tojnar

132−- Jan-Otto Kröpke

133- Jason Ronallo

83- Jason Ronallo

134- Jeff Arnold

84- Jeff Arnold

135- Jeff Runningen

85- Jeff Runningen

136- Jens Getreu

86- Jens Getreu

137- Jens Petersen

87- Jens Petersen

138−- Jeroen de Haas

139−- Jerry Sky

140- Jesse Rosenthal

88- Jesse Rosenthal

141−- Joe Hermaszewski

142- Joe Hillenbrand

89- Joe Hillenbrand

143−- John KetzerX

144- John MacFarlane

90- John MacFarlane

145- John Muccigrosso

91- John Muccigrosso

146- John Luke Bentley

92- John Luke Bentley

147- Jonas Smedegaard

93- Jonas Smedegaard

148−- Jonas Scholl

149- Jonathan Daugherty

94- Jonathan Daugherty

150- Jose Luis Duran

95- Jose Luis Duran

151−- José de Mattos Neto

152- Josef Svenningsson

96- Josef Svenningsson

153−- Joseph C. Sible

154- Julien Cretel

97- Julien Cretel

155−- Julien Dutant

156−- Juliette Fourcot

157- Juliusz Gonera

98- Juliusz Gonera

158- Justin Bogner

99- Justin Bogner

159- Jérémy Bobbio

100- Jérémy Bobbio

160−- Karl Pettersson

161- Keiichiro Shikano

101- Keiichiro Shikano

162- Kelsey Hightower

102- Kelsey Hightower

163- Kolen Cheung

103- Kolen Cheung

164- Konstantin Zudov

104- Konstantin Zudov

165- Kristof Bastiaensen

105- Kristof Bastiaensen

166−- Krystof Beuermann

167- Herwig Stuetz

106- Herwig Stuetz

168- Lars-Dominik Braun

107- 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

176- Luke Plant

108- Luke Plant

177- Marc Schreiber

109- Marc Schreiber

178- Mark Szepieniec

110- Mark Szepieniec

@@ -181,10 +113,7 @@

181- Masayoshi Takahashi

113- Masayoshi Takahashi

182- Matej Kollar

114- Matej Kollar

183- Mathias Schenner

115- Mathias Schenner

184−- Mathias Walter

185−- Mathieu Boespflug

186- Mathieu Duponchelle

116- Mathieu Duponchelle

187−- Matthew Doty

188- Matthew Eddey

117- Matthew Eddey

189- Matthew Pickering

118- Matthew Pickering

190- Matthias C. M. Troffaes

119- Matthias C. M. Troffaes

@@ -194,50 +123,32 @@

194- Merijn Verstraaten

123- Merijn Verstraaten

195- Michael Beaumont

124- Michael Beaumont

196- Michael Chladek

125- Michael Chladek

197−- Michael Hoffmann

198−- Michael Peyton Jones

199−- Michael Reed

200- Michael Snoyman

126- Michael Snoyman

201- Michael Thompson

127- Michael Thompson

202−- Mike Tzou

203- MinRK

128- MinRK

204- Morton Fox

129- Morton Fox

205- Nathan Gass

130- Nathan Gass

206- Neil Mayhew

131- Neil Mayhew

207- Nick Bart

132- Nick Bart

208−- Nick Berendsen

209−- Nick Fleisher

210- Nicolas Kaiser

133- Nicolas Kaiser

211- Nikolay Yakimov

134- Nikolay Yakimov

212−- Nils Carlson

213−- Nixon Enraght-Moony

214- Nokome Bentley

135- Nokome Bentley

215−- Ole Martin Ruud

216- Oliver Matthews

136- Oliver Matthews

217- Ophir Lifshitz

137- Ophir Lifshitz

218- Or Neeman

138- Or Neeman

219−- OvidiusCicero

220−- Owen McGrath

221- Pablo Rodríguez

139- Pablo Rodríguez

222−- Pascal Wagler

223−- Paul Tilley

224- Paul Rivier

140- Paul Rivier

225- Paulo Tanimoto

141- Paulo Tanimoto

226−- Pete Ryland

227- Peter Wang

142- Peter Wang

228−- Philip Pesca

229- Philippe Ombredanne

143- Philippe Ombredanne

230- Phillip Alday

144- Phillip Alday

231- Prayag Verma

145- Prayag Verma

232- Puneeth Chaganti

146- Puneeth Chaganti

233- Ralf Stephan

147- Ralf Stephan

234- Raniere Silva

148- Raniere Silva

235−- Raymond Ehlers

236- Recai Oktaş

149- Recai Oktaş

237- Roland Hieber

150- Roland Hieber

238−- Roman Beránek

239- RyanGlScott

151- RyanGlScott

240−- Salim B

241- Sascha Wilde

152- Sascha Wilde

242- Scott Morrison

153- Scott Morrison

243- Sebastian Talmon

154- Sebastian Talmon

@@ -245,15 +156,11 @@

245- Sergey Astanin

156- Sergey Astanin

246- Shahbaz Youssefi

157- Shahbaz Youssefi

247- Shaun Attfield

158- Shaun Attfield

248−- Shim Myeongseob

249−- Shin Sang-jae

250- Sidarth Kapur

159- Sidarth Kapur

251- Sidharth Kapur

160- Sidharth Kapur

252- Simon Hengel

161- Simon Hengel

253- Stefan Dresselhaus

162- Stefan Dresselhaus

254- Sumit Sahrawat

163- Sumit Sahrawat

255−- Tarik Graba

256−- Tatiana Porras

257- Thenaesh Elango

164- Thenaesh Elango

258- Thomas Hodgson

165- Thomas Hodgson

259- Thomas Weißschuh

166- Thomas Weißschuh

@@ -263,53 +170,26 @@

263- Tiziano Müller

170- Tiziano Müller

264- Todd Sifleet

171- Todd Sifleet

265- Tom Leese

172- Tom Leese

266−- Tristan de Cacqueray

267−- Tristan Stenner

268- Uli Köhler

173- Uli Köhler

269−- Urs Liska

270- Václav Zeman

174- Václav Zeman

271−- Václav Haisman

272−- Vaibhav Sagar

273−- Vanessa McHale

274−- Vasily Alferov

275- Viktor Kronvall

175- Viktor Kronvall

276- Vincent

176- Vincent

277−- Vlad Hanciuta

177+- Václav Haisman

178+- Václav Zeman

278- Wandmalfarbe

179- Wandmalfarbe

279- Waldir Pimenta

180- Waldir Pimenta

280- Wikiwide

181- Wikiwide

281−- Winnie Hellmann

282- Xavier Olive

182- Xavier Olive

283−- Yan Pashkovsky

284−- Yoan Blanc

285- Yuchen Pei

183- Yuchen Pei

286−- Zihang Chen

287−- a-vrma

288−- andrebauer

289−- argent0

290−- badumont

291−- blmage

292- bucklereed

184- bucklereed

293- bumper314

185- bumper314

294−- chinapedia

295−- cholonam

296- csforste

186- csforste

297−- dbecher-ito

298- d-dorazio

187- d-dorazio

299−- ebiim

188+- iandol

300−- favonia

301- infinity0x

189- infinity0x

302−- jeongminkim-islab

303−- kaizshang91

304−- lux-lth

305- lwolfsonkin

190- lwolfsonkin

306−- mbrackeantidot

307- nkalvi

191- nkalvi

308−- niszet

309−- nuew

310−- obcat

311- oltolm

192- oltolm

312−- oquechy

313- quasicomputational

193- quasicomputational

314- qerub

194- qerub

315- robabla

195- robabla

@@ -318,13 +198,5 @@

318- rski

198- rski

319- shreevatsa.public

199- shreevatsa.public

320- takahashim

200- takahashim

321−- taotieren

322−- tecosaur

323−- TEC

324- tgkokk

201- tgkokk

325−- the-solipsist

326−- timo-a

327- thsutton

202- thsutton

328−- vijayphoenix

329−- wiefling

330−- wuffi

CONTRIBUTING.md+35−176

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

1Contributing to pandoc

2======================

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−

62Have a question?

4Have a question?

63----------------

5----------------

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

68Found a bug?

10Found a bug?

69------------

11------------

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

72[issue tracker].

14[issue tracker].

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

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

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

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

76[FAQs] for anything relevant.

18[FAQs] for anything relevant.

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

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

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.

21+(or, even better, 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.)

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

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

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

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

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

164compatibility, new library dependencies, and performance issues.

100compatibility, new library dependencies, and performance issues.

165

101

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]

172before opening an issue.

103before opening an issue.

173

104

174Patches and pull requests

105Patches and pull requests

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

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

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

214 external C libraries should especially be avoided.

145 external C libraries should especially be avoided.

215

146

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.8.3 to the

217 latest release. All pull requests and commits are tested

148 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`. We currently relax

151+ the "`-Wall` clean" requirement for GHC 7.10.x, because

152+ there are so many warnings relating to the addition of type

153+ classes to the Prelude.

219

154

220Tests

155Tests

221-----

156-----

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

234

169

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

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

236

171

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−

308Benchmarks

172Benchmarks

309----------

173----------

310

174

@@ -318,21 +182,25 @@ With stack:

318

182

319 stack bench

183 stack bench

320

184

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

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

187+(Eventually this should be incorporated into the benchmark

188+suite.)

321

189

322Using the REPL

190Using the REPL

323--------------

191--------------

324

192

325With a recent version of cabal, you can do `cabal repl` and get

193With a recent version of cabal, you can do `cabal repl` and get

326a ghci REPL for working with pandoc. With [stack], use

194a ghci REPL for working with pandoc. With [stack], use

327−`stack ghci`.

195+`cabal ghci`.

328

196

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

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

330placed in the source directory):

198placed in the source directory):

331

199

332− :set -fobject-code

200+ :set -fobject-code

333− :set -XTypeSynonymInstances

201+ :set -XTypeSynonymInstances

334− :set -XScopedTypeVariables

202+ :set -XScopedTypeVariables

335− :set -XOverloadedStrings

203+ :set -XOverloadedStrings

336

204

337Profiling

205Profiling

338---------

206---------

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

376--------

244--------

377

245

378Pandoc has a publicly accessible git repository on

246Pandoc has a publicly accessible git repository on

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

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

380

248

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

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

382

250

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

386

254

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

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

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

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

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

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

390

258

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

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

392[Haskell platform].

260[Haskell platform].

@@ -399,18 +267,18 @@ The library is structured as follows:

399 - `Text.Pandoc.Definition` (in `pandoc-types`) defines the types

267 - `Text.Pandoc.Definition` (in `pandoc-types`) defines the types

400 used for representing a pandoc document.

268 used for representing a pandoc document.

401 - `Text.Pandoc.Builder` (in `pandoc-types`) provides functions for

269 - `Text.Pandoc.Builder` (in `pandoc-types`) provides functions for

402− building pandoc documents programmatically.

270+ building pandoc documents programatically.

403 - `Text.Pandoc.Generics` (in `pandoc-types`) provides functions allowing

271 - `Text.Pandoc.Generics` (in `pandoc-types`) provides functions allowing

404 you to promote functions that operate on parts of pandoc documents

272 you to promote functions that operate on parts of pandoc documents

405 to functions that operate on whole pandoc documents, walking the

273 to functions that operate on whole pandoc documents, walking the

406 tree automatically.

274 tree automatically.

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

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

408 are the writers.

276 are the writers.

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

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

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

278+ using citeproc-hs.

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

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

412− cabal flag is used.

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

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

281+ the preprocessor [hsb2hs].

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

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

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

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

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

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

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

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

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

422 LaTeX source.

290 LaTeX source.

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

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

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

424 the needs of pandoc.

293 the needs of pandoc.

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

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

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

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

@@ -437,28 +306,17 @@ The library is structured as follows:

437 - `Text.Pandoc.UUID` contains functions for generating UUIDs.

306 - `Text.Pandoc.UUID` contains functions for generating UUIDs.

438 - `Text.Pandoc.XML` contains functions for formatting XML.

307 - `Text.Pandoc.XML` contains functions for formatting XML.

439

308

440−Lua filters

441−-----------

442−

443−If you've written a useful pandoc [lua filter](lua-filters.html),

444−you may want to consider submitting a pull request to the

445−[lua-filters repository](https://github.com/pandoc/lua-filters).

446−

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

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

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

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

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

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

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

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

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

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

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

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

453−[User's Guide]: https://pandoc.org/MANUAL.html

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

454−[FAQs]: https://pandoc.org/faqs.html

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

455−[EditorConfig]: https://editorconfig.org/

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

456−[Haskell platform]: https://www.haskell.org/platform/

318+[Haskell platform]: http://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

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

461−[pre-commit hook]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

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

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

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

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

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

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

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

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

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

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

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

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

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

334+

COPYING.md+1−1

@@ -357,5 +357,5 @@ into proprietary programs. If your program is a subroutine library,

357you may consider it more useful to permit linking proprietary

358applications with the library. If this is what you want to do, use the

359[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

361License.

COPYRIGHT+34−33

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

1Pandoc

4With the exceptions noted below, this code is released under the [GPL],

5version 2 or later:

@@ -22,11 +22,11 @@ The GNU General Public License is available in the file COPYING.md in

22the source distribution. On Debian systems, the complete text of the

23GPL can be found in `/usr/share/common-licenses/GPL`.

25−[GPL]: https://www.gnu.org/copyleft/gpl.html

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

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

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

29+[Pandoc home page]: http://pandoc.org

31Pandoc includes some code with different copyrights, or subject to different

32licenses. The copyright and license statements for these sources are included

@@ -37,7 +37,7 @@ The modules in the `pandoc-types` repository (Text.Pandoc.Definition,

37Text.Pandoc.Builder, Text.Pandoc.Generics, Text.Pandoc.JSON,

38Text.Pandoc.Walk) are licensed under the BSD 3-clause license:

42All rights reserved.

@@ -73,29 +73,29 @@ Pandoc's templates (in `data/templates`) are dual-licensed as either

73GPL (v2 or higher, same as pandoc) or (at your option) the BSD

743-clause license.

78----------------------------------------------------------------------

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

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

84----------------------------------------------------------------------

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

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

90----------------------------------------------------------------------

91src/Text/Pandoc/Writers/OpenDocument.hs

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

96----------------------------------------------------------------------

97src/Text/Pandoc/Writers/Org.hs

99 Albert Krewinkel

100

101Released 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.

109----------------------------------------------------------------------

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

111src/Text/Pandoc/Readers/Docx/*

113

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

115

116----------------------------------------------------------------------

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

119

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

121

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

123src/Text/Pandoc/Readers/TikiWiki.hs

125

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

126+Released under the GNU General Public License version 2.

127

128----------------------------------------------------------------------

129src/Text/Pandoc/Readers/JATS.hs

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

133

134----------------------------------------------------------------------

135src/Text/Pandoc/Readers/EPUB.hs

137

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

139

@@ -141,49 +141,41 @@ Released under the GNU General Public License version 2 or later.

141src/Text/Pandoc/Readers/Org.hs

142src/Text/Pandoc/Readers/Org/*

143test/Tests/Readers/Org/*

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/*

153

145

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

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

155

147

156----------------------------------------------------------------------

148----------------------------------------------------------------------

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

149+data/LaTeXMathML.js

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

150+Adapted by Jeff Knisely and Douglas Woodall from

159−test/Tests/Readers/Jira.hs

151+ASCIIMathML.js v. 1.4.7

161

153

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

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

163

155

164----------------------------------------------------------------------

156----------------------------------------------------------------------

165−src/Text/Pandoc/Readers/FB2.hs

157+data/MathMLinHTML.js

167

159

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

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

169

161

170−----------------------------------------------------------------------

162+------------------------------------------------------------------------

171data/pandoc.lua

163data/pandoc.lua

173

165

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

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

175

167

176----------------------------------------------------------------------

168----------------------------------------------------------------------

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

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

178dzslides template.

170dzslides template.

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

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

180

172

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

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

182

174

183------------------------------------------------------------------------

175------------------------------------------------------------------------

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

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

185

177

187

179

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

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

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

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

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

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

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

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

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

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

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

198+

199+------------------------------------------------------------------------

201+released under GPL version 2 or later.

202+

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

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

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

206+License. Originally by Martin Fenner."

INSTALL.md+93−173

@@ -1,167 +1,94 @@

1# Installing pandoc

3−The simplest way to get the latest pandoc release is to use the installer.

4−

5−<a href="https://github.com/jgm/pandoc/releases/latest"

6− class="btn btn-primary" id="downloadInstallerBtn">

7− Download the latest installer

8−</a>

9−

10−For alternative ways to install pandoc, see below

11−under the heading for your operating system.

12−

13## Windows

3## Windows

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

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

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

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

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

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

18−binaries are installed.

8+ binaries are installed.

19−

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.

24−

25−Alternatively, you can install pandoc using

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

27−

28− choco install pandoc

29−

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]):

34−

35− choco install rsvg-convert python miktex

37−Using multiple installation methods can result in two separate

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

38−installations of pandoc; it is recommended to properly uninstall

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

39−pandoc before switching to an alternative installation method.

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

13+ to a directory of your choice.

41−By default, Pandoc creates PDFs using LaTeX.

15+ - For PDF output, you'll also need to install LaTeX.

42−We recommend installing it via [MiKTeX].

16+ We recommend [MiKTeX](http://miktex.org/).

44## macOS

18## macOS

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

20+ - You can install pandoc using

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

21+ [homebrew](http://brew.sh): `brew install pandoc`.

48−by downloading [this script][uninstaller]

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

51−Alternatively, you can install pandoc using

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

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

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

25+ by downloading [this script][uninstaller]

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

54− brew install pandoc

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

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

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

31+ whatever directory you like.

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

33+ - For PDF output, you'll also need LaTeX. Because a full [MacTeX]

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

34+ installation takes more than a gigabyte of disk space, we recommend

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

35+ installing [BasicTeX](http://www.tug.org/mactex/morepackages.html)

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

36+ (64M) and using the `tlmgr` tool to install additional packages

37+ as needed. If you get errors warning of fonts not found, try

61− brew install librsvg python homebrew/cask/basictex

62−

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.

66−

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.

71−

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:

77−

78− tlmgr install collection-fontsrecommended

39+ tlmgr install collection-fontsrecommended

80## Linux

41## Linux

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

43+ - First, try your package manager.

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

44+ Pandoc is in the [Debian], [Ubuntu], [Slackware],

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

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

85−

46+ Note, however, that versions in the repositories are often

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

47+ old.

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

88−

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.

94−

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

96−

97− sudo dpkg -i $DEB

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

49+ - We provide a binary package for amd64 architecture on

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

50+ the [download page]. This provides both `pandoc` and

51+ `pandoc-citeproc`. The executables are statically linked and

52+ have no dynamic dependencies or dependencies on external

53+ data files. Note: because of the static

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

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

101

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

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

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

104

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

59+ sudo dpkg -i $DEB

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

107

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

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

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

63+ man pages.

109

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

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

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

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

112−a tarball, try instead

113

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

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

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

115

116−You can also install from source, using the

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

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`.

121

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

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

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

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

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

75+ a tarball, try instead

125

126−## Chrome OS

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

127

128−On Chrome OS, pandoc can be installed using the

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

129−[chromebrew](https://github.com/skycocker/chromebrew) package manager

80+ instructions below under [Compiling from source].

130−with the command:

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

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

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

131

132−```sh

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

133−crew install pandoc

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

134−```

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

135−

136−This will automatically build and configure pandoc for the specific

137−device you are using.

138

139## BSD

89## BSD

140

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

91+ - 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>.

165

166## Compiling from source

93## Compiling from source

167

@@ -191,9 +118,9 @@ the last released version.

191

118

192### Quick stack method

119### Quick stack method

193

120

194−The easiest way to build pandoc from source is to use [stack][stack]:

121+The easiest way to build pandoc from source is to use [stack]:

195

122

196−1. Install [stack][stack]. Note that Pandoc requires stack >= 1.7.0.

123+1. Install [stack]. Note that Pandoc requires stack >= 1.6.0.

197

124

1982. Change to the pandoc source directory and issue the following commands:

1252. Change to the pandoc source directory and issue the following commands:

199

126

@@ -210,21 +137,13 @@ The easiest way to build pandoc from source is to use [stack][stack]:

210

137

2111. Install the [Haskell platform]. This will give you [GHC] and

1381. Install the [Haskell platform]. This will give you [GHC] and

212 the [cabal-install] build tool. Note that pandoc requires

139 the [cabal-install] build tool. Note that pandoc requires

213− GHC >= 7.10 and cabal >= 2.0.

140+ GHC >= 7.10.

214

141

2152. Update your package database:

1422. Update your package database:

216

143

217 cabal update

144 cabal update

218

145

219−3. Check your cabal version with

220−

221− cabal --version

222−

223− If you have a version less than 2.0, install the latest with:

224−

225− cabal install cabal-install

226−

227−4. Use `cabal` to install pandoc and its dependencies:

146+3. Use `cabal` to install pandoc and its dependencies:

228

147

229 cabal install pandoc

148 cabal install pandoc

230

149

@@ -237,35 +156,42 @@ The easiest way to build pandoc from source is to use [stack][stack]:

237

156

238 cabal install

157 cabal install

239

158

240−5. Make sure the `$CABALDIR/bin` directory is in your path. You should

159+4. Make sure the `$CABALDIR/bin` directory is in your path. You should

241 now be able to run `pandoc`:

160 now be able to run `pandoc`:

242

161

243 pandoc --help

162 pandoc --help

244

163

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

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

165+

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

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

168+ using cabal:

246

169

170+ cabal install pandoc-citeproc

171+

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

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

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

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

249 use the locale-sensitive unicode collation algorithm instead,

174 use the locale-sensitive unicode collation algorithm instead,

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

175+ specify the `unicode_collation` flag:

251

176

252− cabal install pandoc -ficu

177+ cabal install pandoc-citeproc -funicode_collation

253

178

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

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

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

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

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

181+ vary by platform. Here is how it might work on macOS with homebrew:

257

182

258 brew install icu4c

183 brew install icu4c

259− stack install pandoc \

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

260− --flag "citeproc:icu" \

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

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

186+ -funicode_collation text-icu pandoc-citeproc

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

263

187

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

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

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

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

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

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

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

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

268

192

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

194+

269

195

270### Custom cabal method

196### Custom cabal method

271

197

@@ -274,7 +200,6 @@ over the build and installation. Most users should use the

274quick install, but this information may be of use to packagers.

200quick install, but this information may be of use to packagers.

275For more details, see the [Cabal User's Guide]. These instructions

201For more details, see the [Cabal User's Guide]. These instructions

276assume that the pandoc source directory is your working directory.

202assume that the pandoc source directory is your working directory.

277−You will need cabal version 2.0 or higher.

278

203

2791. Install dependencies: in addition to the [Haskell platform],

2041. Install dependencies: in addition to the [Haskell platform],

280 you will need a number of additional libraries. You can install

205 you will need a number of additional libraries. You can install

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

387

312

388

313

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

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

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

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

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

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

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

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

393−[FreeBSD ports]: https://www.freshports.org/textproc/hs-pandoc/

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

394−[GHC]: https://www.haskell.org/ghc/

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

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

395−[Haskell platform]: https://hackage.haskell.org/platform/

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

396−[MacPorts]: https://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile

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

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

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

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

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

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

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

402−[Python]: https://www.python.org

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

333+[stack]: http://docs.haskellstack.org/en/stable/install_and_upgrade.html

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

334+[cabal-install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall

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

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

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

MANUAL.txt+1348−3149

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

1−---

2−title: Pandoc User's Guide

1+% Pandoc User's Guide

3−author: John MacFarlane

2+% John MacFarlane

4−date: June 20, 2021

3+% March 17, 2018

5−---

7−# Synopsis

5+Synopsis

6+========

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

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

11−# Description

10+Description

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

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

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

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

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

41Markdown can be expected to be lossy.

43−## Using pandoc

43+Using `pandoc`

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

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

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

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

47Output 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

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

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

62individually.)

63individually.)

64−## Specifying formats

65+Specifying formats

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

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

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

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

69command-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

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

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

94be assumed to be Markdown.

96be assumed to be Markdown.

96−## Character encoding

98+Character encoding

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

100

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

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

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

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

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

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

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

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

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

108

111

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

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

110

113

111−## Creating a PDF

114+Creating a PDF

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

112

116

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

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

114

118

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

116

120

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

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

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

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

123+

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

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`].

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

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

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

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

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

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

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

130+

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

131+PDF output can be controlled using [variables for LaTeX] (if

125−

132+LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).

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

133+When using an HTML/CSS-to-PDF-engine, `--css` affects the output.

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

134+If `wkhtmltopdf` is used, then the variables `margin-left`,

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

135+`margin-right`, `margin-top`, `margin-bottom`, `footer-html`,

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

136+`header-html` and `papersize` will affect the output.

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

131

137

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

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

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

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

@@ -136,116 +142,94 @@ to output the generated LaTeX. You can then test it with `pdflatex test.tex`.

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

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

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

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

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

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

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

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

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

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

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

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

142−contains images), [`hyperref`], [`xcolor`],

148+contains images), [`hyperref`], [`xcolor`] (with `colorlinks`),

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

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

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

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

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

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

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

152+the LaTeX engine requires [`fontspec`]. `xelatex` uses

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

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

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

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

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

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

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

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

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

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

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

158+if added to the template or included in any header file. The

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

159+[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can

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

160+optionally be used for [citation rendering].

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

161+

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/

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

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

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

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

167−[`babel`]: https://ctan.org/pkg/babel

164+[`lm`]: https://ctan.org/pkg/lm

168−[`biber`]: https://ctan.org/pkg/biber

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

169−[`biblatex`]: https://ctan.org/pkg/biblatex

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

170−[`bibtex`]: https://ctan.org/pkg/bibtex

167+[`listings`]: https://ctan.org/pkg/listings

171−[`bidi`]: https://ctan.org/pkg/bidi

172−[`bookmark`]: https://ctan.org/pkg/bookmark

173−[`booktabs`]: https://ctan.org/pkg/booktabs

174−[`csquotes`]: https://ctan.org/pkg/csquotes

175[`fancyvrb`]: https://ctan.org/pkg/fancyvrb

168[`fancyvrb`]: https://ctan.org/pkg/fancyvrb

176−[`fontspec`]: https://ctan.org/pkg/fontspec

169+[`longtable`]: https://ctan.org/pkg/longtable

177−[`footnote`]: https://ctan.org/pkg/footnote

170+[`booktabs`]: https://ctan.org/pkg/booktabs

178−[`footnotehyper`]: https://ctan.org/pkg/footnotehyper

179−[`geometry`]: https://ctan.org/pkg/geometry

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

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

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

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

182−[`hyperref`]: https://ctan.org/pkg/hyperref

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

184−[`listings`]: https://ctan.org/pkg/listings

185−[`lm`]: https://ctan.org/pkg/lm

186−[`longtable`]: https://ctan.org/pkg/longtable

187−[`mathspec`]: https://ctan.org/pkg/mathspec

188−[`microtype`]: https://ctan.org/pkg/microtype

189−[`natbib`]: https://ctan.org/pkg/natbib

173+[`geometry`]: https://ctan.org/pkg/geometry

190−[`parskip`]: https://ctan.org/pkg/parskip

191−[`polyglossia`]: https://ctan.org/pkg/polyglossia

192−[`prince`]: https://www.princexml.com/

193[`setspace`]: https://ctan.org/pkg/setspace

174[`setspace`]: https://ctan.org/pkg/setspace

175+[`xecjk`]: https://ctan.org/pkg/xecjk

176+[`hyperref`]: https://ctan.org/pkg/hyperref

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

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

178+[`babel`]: https://ctan.org/pkg/babel

179+[`bidi`]: https://ctan.org/pkg/bidi

180+[`mathspec`]: https://ctan.org/pkg/mathspec

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

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

182+[`polyglossia`]: https://ctan.org/pkg/polyglossia

183+[`fontspec`]: https://ctan.org/pkg/fontspec

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

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

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

185+[`microtype`]: https://ctan.org/pkg/microtype

186+[`csquotes`]: https://ctan.org/pkg/csquotes

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

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

189+[`bibtex`]: https://ctan.org/pkg/bibtex

190+[`biber`]: https://ctan.org/pkg/biber

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

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

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

199−[`xcolor`]: https://ctan.org/pkg/xcolor

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

200−[`xecjk`]: https://ctan.org/pkg/xecjk

194+[`prince`]: https://www.princexml.com/

201−[`xurl`]: https://ctan.org/pkg/xurl

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

203−

204−

205

195

206−## Reading from the Web

196+Reading from the Web

197+--------------------

207

198

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

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

209pandoc will fetch the content using HTTP:

200pandoc will fetch the content using HTTP:

210

201

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

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

212

203

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

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

214header when requesting a document from a URL:

205header when requesting a document from a URL:

215

206

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

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

217− https://www.fsf.org

208+ http://www.fsf.org

218

209

219−# Options

210+Options

211+=======

220

212

221−## General options {.options}

213+General options

214+---------------

222

215

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

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

224

217

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

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

226

219

227 ::: {#input-formats}

220 ::: {#input-formats}

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

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

230 - `commonmark` ([CommonMark] Markdown)

221 - `commonmark` ([CommonMark] Markdown)

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

232 - `creole` ([Creole 1.0])

222 - `creole` ([Creole 1.0])

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

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

235 - `docbook` ([DocBook])

223 - `docbook` ([DocBook])

236 - `docx` ([Word docx])

224 - `docx` ([Word docx])

237− - `dokuwiki` ([DokuWiki markup])

238 - `epub` ([EPUB])

225 - `epub` ([EPUB])

239− - `fb2` ([FictionBook2] e-book)

240 - `gfm` ([GitHub-Flavored Markdown]),

226 - `gfm` ([GitHub-Flavored Markdown]),

241− or the deprecated and less accurate `markdown_github`;

227+ or `markdown_github`, which provides deprecated and less accurate

242− use [`markdown_github`](#markdown-variants) only

228+ support for Github-Flavored Markdown; please use `gfm` instead,

243− if you need extensions not supported in [`gfm`](#markdown-variants).

229+ unless you need to use extensions other than `smart`.

244 - `haddock` ([Haddock markup])

230 - `haddock` ([Haddock markup])

245 - `html` ([HTML])

231 - `html` ([HTML])

246− - `ipynb` ([Jupyter notebook])

247 - `jats` ([JATS] XML)

232 - `jats` ([JATS] XML)

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

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

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

250 - `latex` ([LaTeX])

234 - `latex` ([LaTeX])

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

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

@@ -253,7 +237,6 @@ header when requesting a document from a URL:

253 - `markdown_phpextra` ([PHP Markdown Extra])

237 - `markdown_phpextra` ([PHP Markdown Extra])

254 - `markdown_strict` (original unextended [Markdown])

238 - `markdown_strict` (original unextended [Markdown])

255 - `mediawiki` ([MediaWiki markup])

239 - `mediawiki` ([MediaWiki markup])

256− - `man` ([roff man])

257 - `muse` ([Muse])

240 - `muse` ([Muse])

258 - `native` (native Haskell)

241 - `native` (native Haskell)

259 - `odt` ([ODT])

242 - `odt` ([ODT])

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

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

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

279

262

280 ::: {#output-formats}

263 ::: {#output-formats}

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

264+ - `asciidoc` ([AsciiDoc])

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

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

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

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

285 - `commonmark` ([CommonMark] Markdown)

266 - `commonmark` ([CommonMark] Markdown)

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

287 - `context` ([ConTeXt])

267 - `context` ([ConTeXt])

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

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

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

290 - `docbook5` (DocBook 5)

269 - `docbook5` (DocBook 5)

291 - `docx` ([Word docx])

270 - `docx` ([Word docx])

@@ -294,35 +273,29 @@ header when requesting a document from a URL:

294 - `epub2` (EPUB v2)

273 - `epub2` (EPUB v2)

295 - `fb2` ([FictionBook2] e-book)

274 - `fb2` ([FictionBook2] e-book)

296 - `gfm` ([GitHub-Flavored Markdown]),

275 - `gfm` ([GitHub-Flavored Markdown]),

297− or the deprecated and less accurate `markdown_github`;

276+ or `markdown_github`, which provides deprecated and less accurate

298− use [`markdown_github`](#markdown-variants) only

277+ support for Github-Flavored Markdown; please use `gfm` instead,

299− if you need extensions not supported in [`gfm`](#markdown-variants).

278+ unless you use extensions that do not work with `gfm`.

300 - `haddock` ([Haddock markup])

279 - `haddock` ([Haddock markup])

301 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])

280 - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])

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

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

303 - `icml` ([InDesign ICML])

282 - `icml` ([InDesign ICML])

304− - `ipynb` ([Jupyter notebook])

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

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)

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

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

311 - `latex` ([LaTeX])

285 - `latex` ([LaTeX])

312− - `man` ([roff man])

286+ - `man` ([groff man])

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

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

314 - `markdown_mmd` ([MultiMarkdown])

288 - `markdown_mmd` ([MultiMarkdown])

315 - `markdown_phpextra` ([PHP Markdown Extra])

289 - `markdown_phpextra` ([PHP Markdown Extra])

316 - `markdown_strict` (original unextended [Markdown])

290 - `markdown_strict` (original unextended [Markdown])

317 - `mediawiki` ([MediaWiki markup])

291 - `mediawiki` ([MediaWiki markup])

318− - `ms` ([roff ms])

292+ - `ms` ([groff ms])

319 - `muse` ([Muse]),

293 - `muse` ([Muse]),

320 - `native` (native Haskell),

294 - `native` (native Haskell),

321 - `odt` ([OpenOffice text document][ODT])

295 - `odt` ([OpenOffice text document][ODT])

322 - `opml` ([OPML])

296 - `opml` ([OPML])

323 - `opendocument` ([OpenDocument])

297 - `opendocument` ([OpenDocument])

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

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

325− - `pdf` ([PDF])

326 - `plain` (plain text),

299 - `plain` (plain text),

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

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

328 - `rst` ([reStructuredText])

301 - `rst` ([reStructuredText])

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

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

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

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

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

337 - `tei` ([TEI Simple])

310 - `tei` ([TEI Simple])

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

339 - `zimwiki` ([ZimWiki markup])

311 - `zimwiki` ([ZimWiki markup])

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

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

341 :::

313 :::

342

314

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

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

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

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

345

317

346 Extensions can be individually enabled or

318 Extensions can be individually enabled or

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

358

330

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

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

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

332 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`

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

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

334+

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

335+ $HOME/.pandoc

364− environment variable). If that directory does not exist and

336+

365− `$HOME/.pandoc` exists, it will be used (for backwards compatibility).

337+ in Windows XP:

366− On Windows the default user data directory is

338+

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

340+

341+ and in Windows Vista or later:

342+

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

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

344+

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

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

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

346 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

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

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

372− pandoc's normal defaults.

349+ placed in this directory will override 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.

387

350

388`--bash-completion`

351`--bash-completion`

389

352

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

394

357

395`--verbose`

358`--verbose`

396

359

397−: Give verbose debugging output.

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

361+ with PDF output.

398

362

399`--quiet`

363`--quiet`

400

364

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

420

384

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

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

422

386

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

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

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

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

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

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

426 pandoc's Markdown are given.

390 pandoc's Markdown are given.

@@ -443,88 +407,62 @@ header when requesting a document from a URL:

443

407

444: Show usage message.

408: Show usage message.

445

409

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

438+[ZimWiki markup]: http://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

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

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

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

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

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

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

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

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

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

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

444+[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html

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

484[Haskell]: https://www.haskell.org

445[Haskell]: https://www.haskell.org

485−[GNU Texinfo]: https://www.gnu.org/software/texinfo/

446+[GNU Texinfo]: http://www.gnu.org/software/texinfo/

486−[Emacs Org mode]: https://orgmode.org

447+[Emacs Org mode]: http://orgmode.org

487−[AsciiDoc]: https://www.methods.co.nz/asciidoc/

448+[AsciiDoc]: http://www.methods.co.nz/asciidoc/

488−[AsciiDoctor]: https://asciidoctor.org/

489−[DZSlides]: https://paulrouget.com/dzslides/

449+[DZSlides]: http://paulrouget.com/dzslides/

490[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML

450[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML

491[PDF]: https://www.adobe.com/pdf/

451[PDF]: https://www.adobe.com/pdf/

492−[reveal.js]: https://revealjs.com/

452+[reveal.js]: http://lab.hakim.se/reveal-js/

493[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1

453[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1

494−[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

454+[InDesign ICML]: http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf

496[TEI Simple]: https://github.com/TEIC/TEI-Simple

455[TEI Simple]: https://github.com/TEIC/TEI-Simple

497[Muse]: https://amusewiki.org/library/manual

456[Muse]: https://amusewiki.org/library/manual

498[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint

457[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint

499[Vimwiki]: https://vimwiki.github.io

458[Vimwiki]: https://vimwiki.github.io

500−[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html

459+

501−[BibTeX]: https://ctan.org/pkg/bibtex

502−[BibLaTeX]: https://ctan.org/pkg/biblatex

503−

504−## Reader options {.options}

460+Reader options

505−

461+--------------

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.

522

462

523`--base-header-level=`*NUMBER*

463`--base-header-level=`*NUMBER*

524

464

525−: *Deprecated. Use `--shift-heading-level-by`=X instead,

526− where X = NUMBER - 1.* Specify the base level for headings

465+: Specify the base level for headers (defaults to 1).

527− (defaults to 1).

528

466

529`--strip-empty-paragraphs`

467`--strip-empty-paragraphs`

530

468

@@ -554,7 +492,7 @@ header when requesting a document from a URL:

554 footnotes and links will not work across files. Reading binary

492 footnotes and links will not work across files. Reading binary

555 files (docx, odt, epub) implies `--file-scope`.

493 files (docx, odt, epub) implies `--file-scope`.

556

494

557−`-F` *PROGRAM*, `--filter=`*PROGRAM*

495+`--filter=`*PROGRAM*

558

496

559: Specify an executable to be used as a filter transforming the

497: Specify an executable to be used as a filter transforming the

560 pandoc AST after the input is parsed and before the output is

498 pandoc AST after the input is parsed and before the output is

@@ -589,38 +527,47 @@ header when requesting a document from a URL:

589

527

590 3. `$PATH` (executable only)

528 3. `$PATH` (executable only)

591

529

592− Filters, Lua-filters, and citeproc processing are applied in

530+ Filters and lua-filters are applied in the order specified

593− the order specified on the command line.

531+ on the command line.

594

532

595−`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*

533+`--lua-filter=`*SCRIPT*

596

534

597: Transform the document in a similar fashion as JSON filters (see

535: Transform the document in a similar fashion as JSON filters (see

598− `--filter`), but use pandoc's built-in Lua filtering system. The given

536+ `--filter`), but use pandoc's build-in lua filtering system. The given

599− Lua script is expected to return a list of Lua filters which will be

537+ 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

538+ applied in order. Each lua filter must contain element-transforming

601 functions indexed by the name of the AST element on which the filter

539 functions indexed by the name of the AST element on which the filter

602 function should be applied.

540 function should be applied.

603

541

604− The `pandoc` Lua module provides helper functions for element

542+ The `pandoc` lua module provides helper functions for element

605− creation. It is always loaded into the script's Lua environment.

543+ creation. It is always loaded into the script's lua environment.

606

544

607− See the [Lua filters documentation] for further details.

545+ The following is an example lua script for macro-expansion:

608

546

609− In order of preference, pandoc will look for Lua filters in

547+ function expand_hello_world(inline)

548+ if inline.c == '{{helloworld}}' then

549+ return pandoc.Emph{ pandoc.Str "Hello, World" }

550+ else

551+ return inline

552+ end

553+ end

610

554

611− 1. a specified full or relative path

555+ return {{Str = expand_hello_world}}

612

556

613− 2. `$DATADIR/filters` where `$DATADIR` is the user data

557+ In order of preference, pandoc will look for lua filters in

614− directory (see `--data-dir`, above).

558+

559+ 1. a specified full or relative path (executable or

560+ non-executable)

615

561

616− Filters, Lua filters, and citeproc processing are applied in

562+ 2. `$DATADIR/filters` (executable or non-executable)

617− the order specified on the command line.

563+ where `$DATADIR` is the user data directory (see

564+ `--data-dir`, above).

618

565

619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]

566`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]

620

567

621: Set the metadata field *KEY* to the value *VAL*. A value specified

568: Set the metadata field *KEY* to the value *VAL*. A value specified

622 on the command line overrides a value specified in the document

569 on the command line overrides a value specified in the document

623− using [YAML metadata blocks][Extension: `yaml_metadata_block`].

570+ using [YAML metadata blocks][Extension:`yaml_metadata_block`].

624 Values will be parsed as YAML boolean or string values. If no value is

571 Values will be parsed as YAML boolean or string values. If no value is

625 specified, the value will be treated as Boolean true. Like

572 specified, the value will be treated as Boolean true. Like

626 `--variable`, `--metadata` causes template variables to be set.

573 `--variable`, `--metadata` causes template variables to be set.

@@ -629,25 +576,11 @@ header when requesting a document from a URL:

629 printed in some output formats) and metadata values will be escaped

576 printed in some output formats) and metadata values will be escaped

630 when inserted into the template.

577 when inserted into the template.

631

578

632−`--metadata-file=`*FILE*

633−

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.

644−

645`-p`, `--preserve-tabs`

579`-p`, `--preserve-tabs`

646

580

647−: Preserve tabs instead of converting them to spaces. (By default, pandoc

581+: Preserve tabs instead of converting them to spaces (the default).

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

582+ Note that this will only affect tabs in literal code spans and code

650− text are always treated as spaces.

583+ blocks; tabs in regular text will be treated as spaces.

651

584

652`--tab-stop=`*NUMBER*

585`--tab-stop=`*NUMBER*

653

586

@@ -657,30 +590,30 @@ header when requesting a document from a URL:

657

590

658: Specifies what to do with insertions, deletions, and comments

591: Specifies what to do with insertions, deletions, and comments

659 produced by the MS Word "Track Changes" feature. `accept` (the

592 produced by the MS Word "Track Changes" feature. `accept` (the

660− default) processes all the insertions and deletions.

593+ default), inserts all insertions, and ignores all

594+ deletions. `reject` inserts all deletions and ignores

661− `reject` ignores them. Both `accept` and `reject` ignore comments.

595+ insertions. Both `accept` and `reject` ignore comments. `all` puts

662− `all` includes all insertions, deletions, and comments, wrapped

596+ in insertions, deletions, and comments, wrapped in spans with

663− in spans with `insertion`, `deletion`, `comment-start`, and

597+ `insertion`, `deletion`, `comment-start`, and `comment-end`

664− `comment-end` classes, respectively. The author and time of

598+ classes, respectively. The author and time of change is

665− change is included. `all` is useful for scripting: only

599+ included. `all` is useful for scripting: only accepting changes

666− accepting changes from a certain reviewer, say, or before a

600+ from a certain reviewer, say, or before a certain date. If a

667− certain date. If a paragraph is inserted or deleted,

601+ paragraph is inserted or deleted, `track-changes=all` produces a

668− `track-changes=all` produces a span with the class

669− `paragraph-insertion`/`paragraph-deletion` before the

602+ span with the class `paragraph-insertion`/`paragraph-deletion`

670− affected paragraph break. This option only affects the docx

603+ before the affected paragraph break. This option only affects the

671− reader.

604+ docx reader.

672

605

673`--extract-media=`*DIR*

606`--extract-media=`*DIR*

674

607

675: Extract images and other media contained in or linked from

608: Extract images and other media contained in or linked from

676 the source document to the path *DIR*, creating it if

609 the source document to the path *DIR*, creating it if

677 necessary, and adjust the images references in the document

610 necessary, and adjust the images references in the document

678− so they point to the extracted files. Media are downloaded,

611+ so they point to the extracted files. If the source format is

679− read from the file system, or extracted from a binary

612+ a binary container (docx, epub, or odt), the media is

680− container (e.g. docx), as needed. The original file paths

613+ extracted from the container and the original

681− are used if they are relative paths not containing `..`.

614+ filenames are used. Otherwise the media is read from the

682− Otherwise filenames are constructed from the SHA1 hash of

615+ file system or downloaded, and new filenames are constructed

683− the contents.

616+ based on SHA1 hashes of the contents.

684

617

685`--abbreviations=`*FILE*

618`--abbreviations=`*FILE*

686

619

@@ -691,30 +624,29 @@ header when requesting a document from a URL:

691 system default, use

624 system default, use

692 `pandoc --print-default-data-file=abbreviations`. The only

625 `pandoc --print-default-data-file=abbreviations`. The only

693 use pandoc makes of this list is in the Markdown reader.

626 use pandoc makes of this list is in the Markdown reader.

694− Strings found in this list will be followed by a nonbreaking

627+ Strings ending in a period that are found in this list will

628+ be followed by a nonbreaking space, so that the period will

695− space, and the period will not produce sentence-ending space

629+ not produce sentence-ending space in formats like LaTeX.

696− in formats like LaTeX. The strings may not contain spaces.

697

630

698[`pandocfilters`]: https://github.com/jgm/pandocfilters

631[`pandocfilters`]: https://github.com/jgm/pandocfilters

699[PHP]: https://github.com/vinai/pandocfilters-php

632[PHP]: https://github.com/vinai/pandocfilters-php

700[perl]: https://metacpan.org/pod/Pandoc::Filter

633[perl]: https://metacpan.org/pod/Pandoc::Filter

701[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node

634[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node

702−[Lua filters documentation]: https://pandoc.org/lua-filters.html

703

635

704−## General writer options {.options}

636+General writer options

637+----------------------

705

638

706`-s`, `--standalone`

639`-s`, `--standalone`

707

640

708: Produce output with an appropriate header and footer (e.g. a

641: Produce output with an appropriate header and footer (e.g. a

709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option

642 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option

710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`

643 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`

711− output. For `native` output, this option causes metadata to

644+ output.

712− be included; otherwise, metadata is suppressed.

713

645

714−`--template=`*FILE*|*URL*

646+`--template=`*FILE*

715

647

716−: Use the specified file as a custom template for the generated document.

648+: Use *FILE* as a custom template for the generated document. Implies

717− Implies `--standalone`. See [Templates], below, for a description

649+ `--standalone`. See [Templates], below, for a description

718 of template syntax. If no extension is specified, an extension

650 of template syntax. If no extension is specified, an extension

719 corresponding to the writer will be added, so that `--template=special`

651 corresponding to the writer will be added, so that `--template=special`

720 looks for `special.html` for HTML output. If the template is not

652 looks for `special.html` for HTML output. If the template is not

@@ -726,29 +658,22 @@ header when requesting a document from a URL:

726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]

658`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]

727

659

728: Set the template variable *KEY* to the value *VAL* when rendering the

660: Set the template variable *KEY* to the value *VAL* when rendering the

729− document in standalone mode. If no *VAL* is specified, the

661+ document in standalone mode. This is generally only useful when the

662+ `--template` option is used to specify a custom template, since

663+ pandoc automatically sets the variables used in the default

664+ templates. If no *VAL* is specified, the key will be given the

730− key will be given the value `true`.

665+ value `true`.

731

666

732`-D` *FORMAT*, `--print-default-template=`*FORMAT*

667`-D` *FORMAT*, `--print-default-template=`*FORMAT*

733

668

734: Print the system default template for an output *FORMAT*. (See `-t`

669: Print the system default template for an output *FORMAT*. (See `-t`

735 for a list of possible *FORMAT*s.) Templates in the user data

670 for a list of possible *FORMAT*s.) Templates in the user data

736− directory are ignored. This option may be used with

671+ directory are ignored.

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`.

745

672

746`--print-default-data-file=`*FILE*

673`--print-default-data-file=`*FILE*

747

674

748: Print a system default data file. Files in the user data directory

675: Print a system default data file. Files in the user data directory

749− are ignored. This option may be used with `-o`/`--output` to

676+ are ignored.

750− redirect output to a file, but `-o`/`--output` must come before

751− `--print-default-data-file` on the command line.

752

677

753`--eol=crlf`|`lf`|`native`

678`--eol=crlf`|`lf`|`native`

754

679

@@ -759,12 +684,9 @@ header when requesting a document from a URL:

759

684

760`--dpi`=*NUMBER*

685`--dpi`=*NUMBER*

761

686

762−: Specify the default dpi (dots per inch) value for conversion

687+: Specify the dpi (dots per inch) value for conversion from pixels

763− from pixels to inch/centimeters and vice versa. (Technically,

688+ to inch/centimeters and vice versa. The default is 96dpi.

764− the correct term would be ppi: pixels per inch.) The default

689+ Technically, the correct term would be ppi (pixels per inch).

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.

768

690

769`--wrap=auto`|`none`|`preserve`

691`--wrap=auto`|`none`|`preserve`

770

692

@@ -777,8 +699,6 @@ header when requesting a document from a URL:

777 where there are nonsemantic newlines in the source, there

699 where there are nonsemantic newlines in the source, there

778 will be nonsemantic newlines in the output as well).

700 will be nonsemantic newlines in the output as well).

779 Automatic wrapping does not currently work in HTML output.

701 Automatic wrapping does not currently work in HTML output.

780− In `ipynb` output, this option affects wrapping of the

781− contents of markdown cells.

782

702

783`--columns=`*NUMBER*

703`--columns=`*NUMBER*

784

704

@@ -791,21 +711,14 @@ header when requesting a document from a URL:

791: Include an automatically generated table of contents (or, in

711: Include an automatically generated table of contents (or, in

792 the case of `latex`, `context`, `docx`, `odt`,

712 the case of `latex`, `context`, `docx`, `odt`,

793 `opendocument`, `rst`, or `ms`, an instruction to create

713 `opendocument`, `rst`, or `ms`, an instruction to create

794− one) in the output document. This option has no effect

714+ one) in the output document. This option has no effect on

795− unless `-s/--standalone` is used, and it has no effect

796− on `man`, `docbook4`, `docbook5`, or `jats` output.

715+ `man`, `docbook4`, `docbook5`, or `jats` output.

797−

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

716

804`--toc-depth=`*NUMBER*

717`--toc-depth=`*NUMBER*

805

718

806: Specify the number of section levels to include in the table

719: 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

720+ of contents. The default is 3 (which means that level 1, 2, and 3

808− headings will be listed in the contents).

721+ headers will be listed in the contents).

809

722

810`--strip-comments`

723`--strip-comments`

811

724

@@ -841,10 +754,7 @@ header when requesting a document from a URL:

841

754

842: Prints a JSON version of a highlighting style, which can

755: Prints a JSON version of a highlighting style, which can

843 be modified, saved with a `.theme` extension, and used

756 be modified, saved with a `.theme` extension, and used

844− with `--highlight-style`. This option may be used with

757+ with `--highlight-style`.

845− `-o`/`--output` to redirect output to a file, but

846− `-o`/`--output` must come before `--print-highlight-style`

847− on the command line.

848

758

849`--syntax-definition=`*FILE*

759`--syntax-definition=`*FILE*

850

760

@@ -852,10 +762,9 @@ header when requesting a document from a URL:

852 which will be used for syntax highlighting of appropriately

762 which will be used for syntax highlighting of appropriately

853 marked code blocks. This can be used to add support for

763 marked code blocks. This can be used to add support for

854 new languages or to use altered syntax definitions for

764 new languages or to use altered syntax definitions for

855− existing languages. This option may be repeated to add

765+ existing languages.

856− multiple syntax definitions.

857

766

858−`-H` *FILE*, `--include-in-header=`*FILE*|*URL*

767+`-H` *FILE*, `--include-in-header=`*FILE*

859

768

860: Include contents of *FILE*, verbatim, at the end of the header.

769: Include contents of *FILE*, verbatim, at the end of the header.

861 This can be used, for example, to include special

770 This can be used, for example, to include special

@@ -863,7 +772,7 @@ header when requesting a document from a URL:

863 repeatedly to include multiple files in the header. They will be

772 repeatedly to include multiple files in the header. They will be

864 included in the order specified. Implies `--standalone`.

773 included in the order specified. Implies `--standalone`.

865

774

866−`-B` *FILE*, `--include-before-body=`*FILE*|*URL*

775+`-B` *FILE*, `--include-before-body=`*FILE*

867

776

868: Include contents of *FILE*, verbatim, at the beginning of the

777: Include contents of *FILE*, verbatim, at the beginning of the

869 document body (e.g. after the `<body>` tag in HTML, or the

778 document body (e.g. after the `<body>` tag in HTML, or the

@@ -872,7 +781,7 @@ header when requesting a document from a URL:

872 used repeatedly to include multiple files. They will be included in

781 used repeatedly to include multiple files. They will be included in

873 the order specified. Implies `--standalone`.

782 the order specified. Implies `--standalone`.

874

783

875−`-A` *FILE*, `--include-after-body=`*FILE*|*URL*

784+`-A` *FILE*, `--include-after-body=`*FILE*

876

785

877: Include contents of *FILE*, verbatim, at the end of the document

786: Include contents of *FILE*, verbatim, at the end of the document

878 body (before the `</body>` tag in HTML, or the

787 body (before the `</body>` tag in HTML, or the

@@ -891,27 +800,16 @@ header when requesting a document from a URL:

891 will not be searched. For example:

800 will not be searched. For example:

892 `--resource-path=.:test` will search the working directory

801 `--resource-path=.:test` will search the working directory

893 and the `test` subdirectory, in that order.

802 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`.

899

803

900`--request-header=`*NAME*`:`*VAL*

804`--request-header=`*NAME*`:`*VAL*

901

805

902: Set the request header *NAME* to the value *VAL* when making

806: Set the request header *NAME* to the value *VAL* when making

903 HTTP requests (for example, when a URL is given on the

807 HTTP requests (for example, when a URL is given on the

904 command line, or when resources used in a document must be

808 command line, or when resources used in a document must be

905− downloaded). If you're behind a proxy, you also need to set

809+ downloaded).

906− the environment variable `http_proxy` to `http://...`.

907−

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

810

914−## Options affecting specific writers {.options}

811+Options affecting specific writers

812+----------------------------------

915

813

916`--self-contained`

814`--self-contained`

917

815

@@ -936,18 +834,14 @@ header when requesting a document from a URL:

936

834

937`--html-q-tags`

835`--html-q-tags`

938

836

939−: Use `<q>` tags for quotes in HTML. (This option only has an

837+: Use `<q>` tags for quotes in HTML.

940− effect if the `smart` extension is enabled for the input

941− format used.)

942

838

943`--ascii`

839`--ascii`

944

840

945−: Use only ASCII characters in output. Currently supported for XML

841+: Use only ASCII characters in output. Currently supported for

946− and HTML formats (which use entities instead of UTF-8 when this

842+ XML and HTML formats (which use numerical entities instead of

947− option is selected), CommonMark, gfm, and Markdown (which use

843+ UTF-8 when this option is selected) and for groff ms and man

948− entities), roff ms (which use hexadecimal escapes), and to a

844+ (which use hexadecimal escapes).

949− limited degree LaTeX (which uses standard commands for accented

950− characters when possible). roff man output uses ASCII by default.

951

845

952`--reference-links`

846`--reference-links`

953

847

@@ -956,45 +850,36 @@ header when requesting a document from a URL:

956 placement of link references is affected by the

850 placement of link references is affected by the

957 `--reference-location` option.

851 `--reference-location` option.

958

852

959−`--reference-location=block`|`section`|`document`

853+`--reference-location = block`|`section`|`document`

960

854

961: Specify whether footnotes (and references, if `reference-links` is

855: Specify whether footnotes (and references, if `reference-links` is

962 set) are placed at the end of the current (top-level) block, the

856 set) are placed at the end of the current (top-level) block, the

963 current section, or the document. The default is

857 current section, or the document. The default is

964 `document`. Currently only affects the markdown writer.

858 `document`. Currently only affects the markdown writer.

965

859

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−

974`--atx-headers`

860`--atx-headers`

975

861

976−: *Deprecated synonym for `--markdown-headings=atx`.*

862+: Use ATX-style headers in Markdown and AsciiDoc output. The default is

863+ to use setext-style headers for levels 1-2, and then ATX headers.

864+ (Note: for `gfm` output, ATX headers are always used.)

977

865

978−`--top-level-division=default`|`section`|`chapter`|`part`

866+`--top-level-division=[default|section|chapter|part]`

979

867

980−: Treat top-level headings as the given division type in

868+: Treat top-level headers as the given division type in LaTeX, ConTeXt,

981− LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy

869+ DocBook, and TEI output. The hierarchy order is part, chapter, then section;

982− order is part, chapter, then section; all headings are

983− shifted such that the top-level heading becomes the

870+ all headers are shifted such that the top-level header becomes the specified

984− specified type. The default behavior is to determine the

871+ type. The default behavior is to determine the best division type via

985− best division type via heuristics: unless other conditions

872+ heuristics: unless other conditions apply, `section` is chosen. When the

986− apply, `section` is chosen. When the `documentclass`

987− variable is set to `report`, `book`, or `memoir` (unless the

873+ LaTeX document class is set to `report`, `book`, or `memoir` (unless the

988− `article` option is specified), `chapter` is implied as the

874+ `article` option is specified), `chapter` is implied as the setting for this

989− setting for this option. If `beamer` is the output format,

875+ option. If `beamer` is the output format, specifying either `chapter` or

990− specifying either `chapter` or `part` will cause top-level

876+ `part` will cause top-level headers to become `\part{..}`, while

991− headings to become `\part{..}`, while second-level headings

992− remain as their default type.

877+ second-level headers remain as their default type.

993

878

994`-N`, `--number-sections`

879`-N`, `--number-sections`

995

880

996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB

881+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.

997− output. By default, sections are not numbered. Sections with class

882+ By default, sections are not numbered. Sections with class

998 `unnumbered` will never be numbered, even if `--number-sections`

883 `unnumbered` will never be numbered, even if `--number-sections`

999 is specified.

884 is specified.

1000

885

@@ -1002,19 +887,16 @@ header when requesting a document from a URL:

1002

887

1003: Offset for section headings in HTML output (ignored in other

888: Offset for section headings in HTML output (ignored in other

1004 output formats). The first number is added to the section number for

889 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.

890+ top-level headers, the second for second-level headers, and so on.

1006− So, for example, if you want the first top-level heading in your

891+ So, for example, if you want the first top-level header in your

1007 document to be numbered "6", specify `--number-offset=5`.

892 document to be numbered "6", specify `--number-offset=5`.

1008− If your document starts with a level-2 heading which you want to

893+ If your document starts with a level-2 header which you want to

1009 be numbered "1.5", specify `--number-offset=1,4`.

894 be numbered "1.5", specify `--number-offset=1,4`.

1010 Offsets are 0 by default. Implies `--number-sections`.

895 Offsets are 0 by default. Implies `--number-sections`.

1011

896

1012`--listings`

897`--listings`

1013

898

1014−: Use the [`listings`] package for LaTeX code blocks. The package

899+: Use the [`listings`] package for LaTeX code blocks

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

1017− documented here: [Encoding issue with the listings package].

1018

900

1019`-i`, `--incremental`

901`-i`, `--incremental`

1020

902

@@ -1023,12 +905,12 @@ header when requesting a document from a URL:

1023

905

1024`--slide-level=`*NUMBER*

906`--slide-level=`*NUMBER*

1025

907

1026−: Specifies that headings with the specified level create

908+: Specifies that headers with the specified level create

1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings

909+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers

1028 above this level in the hierarchy are used to divide the

910 above this level in the hierarchy are used to divide the

1029− slide show into sections; headings below this level create

911+ slide show into sections; headers below this level create

1030 subheads within a slide. Note that content that is

912 subheads within a slide. Note that content that is

1031− not contained under slide-level headings will not appear in

913+ not contained under slide-level headers will not appear in

1032 the slide show. The default is to set the slide level based

914 the slide show. The default is to set the slide level based

1033 on the contents of the document; see [Structuring the slide

915 on the contents of the document; see [Structuring the slide

1034 show].

916 show].

@@ -1037,8 +919,8 @@ header when requesting a document from a URL:

1037

919

1038: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),

920: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),

1039 and attach identifiers to the enclosing `<section>` (or `<div>`)

921 and attach identifiers to the enclosing `<section>` (or `<div>`)

1040− rather than the heading itself. See

922+ rather than the header itself. See

1041− [Heading identifiers], below.

923+ [Header identifiers], below.

1042

924

1043`--email-obfuscation=none`|`javascript`|`references`

925`--email-obfuscation=none`|`javascript`|`references`

1044

926

@@ -1059,7 +941,8 @@ header when requesting a document from a URL:

1059

941

1060: Specify *STRING* as a prefix at the beginning of the title

942: Specify *STRING* as a prefix at the beginning of the title

1061 that appears in the HTML header (but not in the title as it

943 that appears in the HTML header (but not in the title as it

1062− appears at the beginning of the HTML body). Implies `--standalone`.

944+ appears at the beginning of the HTML body). Implies

945+ `--standalone`.

1063

946

1064`-c` *URL*, `--css=`*URL*

947`-c` *URL*, `--css=`*URL*

1065

948

@@ -1067,8 +950,8 @@ header when requesting a document from a URL:

1067 include multiple files. They will be included in the order specified.

950 include multiple files. They will be included in the order specified.

1068

951

1069 A stylesheet is required for generating EPUB. If none is

952 A stylesheet is required for generating EPUB. If none is

1070− provided using this option (or the `css` or `stylesheet`

953+ provided using this option (or the `stylesheet` metadata

1071− metadata fields), pandoc will look for a file `epub.css` in the

954+ field), pandoc will look for a file `epub.css` in the

1072 user data directory (see `--data-dir`). If it is not

955 user data directory (see `--data-dir`). If it is not

1073 found there, sensible defaults will be used.

956 found there, sensible defaults will be used.

1074

957

@@ -1091,56 +974,20 @@ header when requesting a document from a URL:

1091

974

1092 To produce a custom `reference.docx`, first get a copy of

975 To produce a custom `reference.docx`, first get a copy of

1093 the default `reference.docx`: `pandoc

976 the default `reference.docx`: `pandoc

1094− -o custom-reference.docx --print-default-data-file reference.docx`.

977+ --print-default-data-file reference.docx >

1095− Then open `custom-reference.docx` in Word, modify the

978+ custom-reference.docx`. Then open `custom-reference.docx`

1096− styles as you wish, and save the file. For best

979+ in Word, modify the styles as you wish, and save the file.

1097− results, do not make changes to this file other than

980+ For best results, do not make changes to this file other

1098− modifying the styles used by pandoc:

981+ than modifying the styles used by pandoc: [paragraph]

1099−

1100− Paragraph styles:

1101−

1102− - Normal

1103− - Body Text

1104− - First Paragraph

982+ Normal, Body Text, First Paragraph, Compact, Title,

1105− - Compact

1106− - Title

1107− - Subtitle

1108− - Author

1109− - Date

1110− - Abstract

1111− - Bibliography

983+ Subtitle, Author, Date, Abstract, Bibliography, Heading 1,

1112− - Heading 1

984+ Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,

1113− - Heading 2

1114− - Heading 3

1115− - Heading 4

1116− - Heading 5

1117− - Heading 6

1118− - Heading 7

1119− - Heading 8

1120− - Heading 9

1121− - Block Text

1122− - Footnote Text

985+ Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,

1123− - Definition Term

986+ Definition Term, Definition, Caption, Table Caption,

1124− - Definition

1125− - Caption

1126− - Table Caption

1127− - Image Caption

1128− - Figure

1129− - Captioned Figure

987+ Image Caption, Figure, Captioned Figure, TOC Heading;

1130− - TOC Heading

1131−

1132− Character styles:

1133−

1134− - Default Paragraph Font

988+ [character] Default Paragraph Font, Body Text Char,

1135− - Body Text Char

1136− - Verbatim Char

1137− - Footnote Reference

989+ Verbatim Char, Footnote Reference, Hyperlink; [table]

1138− - Hyperlink

1139− - Section Number

1140−

1141− Table style:

1142−

1143− - Table

990+ Table.

1144

991

1145 ODT

992 ODT

1146

993

@@ -1154,18 +1001,19 @@ header when requesting a document from a URL:

1154

1001

1155 To produce a custom `reference.odt`, first get a copy of

1002 To produce a custom `reference.odt`, first get a copy of

1156 the default `reference.odt`: `pandoc

1003 the default `reference.odt`: `pandoc

1157− -o custom-reference.odt --print-default-data-file reference.odt`.

1004+ --print-default-data-file reference.odt >

1158− Then open `custom-reference.odt` in LibreOffice, modify

1005+ custom-reference.odt`. Then open `custom-reference.odt` in

1159− the styles as you wish, and save the file.

1006+ LibreOffice, modify the styles as you wish, and save the

1007+ file.

1160

1008

1161 PowerPoint

1009 PowerPoint

1162

1010

1163− : Templates included with Microsoft PowerPoint 2013 (either with

1011+ : Any template included with a recent install of Microsoft

1164− `.pptx` or `.potx` extension) are known to work, as are most

1012+ PowerPoint (either with `.pptx` or `.potx` extension) should

1165− templates derived from these.

1013+ work, as will most templates derived from these.

1166

1014

1167− The specific requirement is that the template should begin with

1015+ The specific requirement is that the template should contain

1168− the following first four layouts:

1016+ the following four layouts as its first four layouts:

1169

1017

1170 1. Title Slide

1018 1. Title Slide

1171 2. Title and Content

1019 2. Title and Content

@@ -1177,10 +1025,10 @@ header when requesting a document from a URL:

1177 `Home` menu to check.)

1025 `Home` menu to check.)

1178

1026

1179 You can also modify the default `reference.pptx`: first run

1027 You can also modify the default `reference.pptx`: first run

1180− `pandoc -o custom-reference.pptx --print-default-data-file

1028+ `pandoc --print-default-data-file reference.pptx >

1181− reference.pptx`, and then modify `custom-reference.pptx`

1029+ custom-reference.pptx`, and then modify

1182− in MS PowerPoint (pandoc will use the first four layout

1030+ `custom-reference.pptx` in MS PowerPoint (pandoc will use the

1183− slides, as mentioned above).

1031+ first four layout slides, as mentioned above).

1184

1032

1185`--epub-cover-image=`*FILE*

1033`--epub-cover-image=`*FILE*

1186

1034

@@ -1248,12 +1096,12 @@ header when requesting a document from a URL:

1248

1096

1249`--epub-chapter-level=`*NUMBER*

1097`--epub-chapter-level=`*NUMBER*

1250

1098

1251−: Specify the heading level at which to split the EPUB into separate

1099+: Specify the header level at which to split the EPUB into separate

1252− "chapter" files. The default is to split into chapters at level-1

1100+ "chapter" files. The default is to split into chapters at level 1

1253− headings. This option only affects the internal composition of the

1101+ headers. This option only affects the internal composition of the

1254 EPUB, not the way chapters and sections are displayed to users. Some

1102 EPUB, not the way chapters and sections are displayed to users. Some

1255 readers may be slow if the chapter files are too large, so for large

1103 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

1104+ documents with few level 1 headers, one might want to use a chapter

1257 level of 2 or 3.

1105 level of 2 or 3.

1258

1106

1259`--epub-subdirectory=`*DIRNAME*

1107`--epub-subdirectory=`*DIRNAME*

@@ -1262,118 +1110,69 @@ header when requesting a document from a URL:

1262 the EPUB-specific contents. The default is `EPUB`. To put

1110 the EPUB-specific contents. The default is `EPUB`. To put

1263 the EPUB contents in the top level, use an empty string.

1111 the EPUB contents in the top level, use an empty string.

1264

1112

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*

1275

1114

1276: Use the specified engine when producing PDF output.

1115: 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

1116+ The default is `pdflatex`. If the engine is not in your PATH,

1280− path of the engine may be specified here. If this option

1117+ the full path of the engine may be specified here.

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`

1291

1118

1292`--pdf-engine-opt=`*STRING*

1119`--pdf-engine-opt=`*STRING*

1293

1120

1294: Use the given string as a command-line argument to the `pdf-engine`.

1121: 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

1122+ If used multiple times, the arguments are provided with spaces between

1296− auxiliary files, use `--pdf-engine-opt=-outdir=foo`.

1297− Note that no check for duplicate options is done.

1123+ them. Note that no check for duplicate options is done.

1298−

1124+

1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/

1125+[Dublin Core elements]: http://dublincore.org/documents/dces/

1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime

1126+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime

1301−[Encoding issue with the listings package]:

1127+

1302− https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue

1303−

1304−## Citation rendering {.options}

1128+Citation rendering

1305−

1129+------------------

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].

1324

1130

1325`--bibliography=`*FILE*

1131`--bibliography=`*FILE*

1326

1132

1327: Set the `bibliography` field in the document's metadata to *FILE*,

1133: Set the `bibliography` field in the document's metadata to *FILE*,

1328− overriding any value set in the metadata. If you supply

1134+ overriding any value set in the metadata, and process citations

1135+ using `pandoc-citeproc`. (This is equivalent to

1136+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)

1137+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not

1138+ used, making this equivalent to `--metadata bibliography=FILE`.

1329− this argument multiple times, each *FILE* will be added to

1139+ If you supply this argument multiple times, each *FILE* will be added

1330− bibliography. If *FILE* is a URL, it will be fetched

1140+ to bibliography.

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`).

1334

1141

1335`--csl=`*FILE*

1142`--csl=`*FILE*

1336

1143

1337: Set the `csl` field in the document's metadata to *FILE*,

1144: Set the `csl` field in the document's metadata to *FILE*,

1338 overriding any value set in the metadata. (This is equivalent to

1145 overriding any value set in the metadata. (This is equivalent to

1339− `--metadata csl=FILE`.) If *FILE* is a URL, it will be

1146+ `--metadata csl=FILE`.)

1340− fetched via HTTP. If *FILE* is not found relative to the

1147+ This option is only relevant with `pandoc-citeproc`.

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.

1344

1148

1345`--citation-abbreviations=`*FILE*

1149`--citation-abbreviations=`*FILE*

1346

1150

1347: Set the `citation-abbreviations` field in the document's metadata to

1151: Set the `citation-abbreviations` field in the document's metadata to

1348 *FILE*, overriding any value set in the metadata. (This is equivalent to

1152 *FILE*, overriding any value set in the metadata. (This is equivalent to

1349 `--metadata citation-abbreviations=FILE`.)

1153 `--metadata citation-abbreviations=FILE`.)

1350− If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not

1154+ This option is only relevant with `pandoc-citeproc`.

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.

1354

1155

1355`--natbib`

1156`--natbib`

1356

1157

1357−: Use [`natbib`] for citations in LaTeX output. This option

1158+: Use [`natbib`] for citations in LaTeX output. This option is not for use

1358− is not for use with the `--citeproc` option or with PDF

1159+ with the `pandoc-citeproc` filter or with PDF output. It is intended for

1359− output. It is intended for use in producing a LaTeX file

1360− that can be processed with [`bibtex`].

1160+ use in producing a LaTeX file that can be processed with [`bibtex`].

1361

1161

1362`--biblatex`

1162`--biblatex`

1363

1163

1364−: Use [`biblatex`] for citations in LaTeX output. This option

1164+: Use [`biblatex`] for citations in LaTeX output. This option is not for use

1365− is not for use with the `--citeproc` option or with PDF

1165+ with the `pandoc-citeproc` filter or with PDF output. It is intended for

1366− output. It is intended for use in producing a LaTeX file

1367− that can be processed with [`bibtex`] or [`biber`].

1166+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].

1368

1167

1369−## Math rendering in HTML {.options}

1168+Math rendering in HTML

1169+----------------------

1370

1170

1371−The default is to render TeX math as far as possible using

1171+The default is to render TeX math as far as possible using Unicode characters.

1372−Unicode characters. Formulas are put inside a `span` with

1373−`class="math"`, so that they may be styled differently from the

1172+Formulas are put inside a `span` with `class="math"`, so that they may be styled

1374−surrounding text if needed. However, this gives acceptable

1173+differently from the surrounding text if needed. However, this gives acceptable

1375−results only for basic math, usually you will want to use

1174+results only for basic math, usually you will want to use `--mathjax` or another

1376−`--mathjax` or another of the following options.

1175+of the following options.

1377

1176

1378`--mathjax`[`=`*URL*]

1177`--mathjax`[`=`*URL*]

1379

1178

@@ -1387,11 +1186,10 @@ results only for basic math, usually you will want to use

1387

1186

1388`--mathml`

1187`--mathml`

1389

1188

1390−: Convert TeX math to [MathML] (in `epub3`, `docbook4`,

1189+: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,

1391− `docbook5`, `jats`, `html4` and `html5`). This is the

1392− default in `odt` output. Note that currently only Firefox

1190+ `html4` and `html5`). This is the default in `odt` output. Note that

1393− and Safari (and select e-book readers) natively support

1191+ currently only Firefox and Safari (and select e-book readers) natively

1394− MathML.

1192+ support MathML.

1395

1193

1396`--webtex`[`=`*URL*]

1194`--webtex`[`=`*URL*]

1397

1195

@@ -1408,26 +1206,21 @@ results only for basic math, usually you will want to use

1408`--katex`[`=`*URL*]

1206`--katex`[`=`*URL*]

1409

1207

1410: Use [KaTeX] to display embedded TeX math in HTML output.

1208: Use [KaTeX] to display embedded TeX math in HTML output.

1411− The *URL* is the base URL for the KaTeX library. That directory

1209+ The *URL* is the base URL for the KaTeX library. If a *URL* is

1412− should contain a `katex.min.js` and a `katex.min.css` file.

1413− If a *URL* is not provided, a link to the KaTeX CDN will be inserted.

1210+ not provided, a link to the KaTeX CDN will be inserted.

1414

1211

1415−`--gladtex`

1212+`--katex-stylesheet=`*URL*

1416

1213

1417−: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML

1214+: The *URL* should point to the `katex.css` stylesheet. If this option is

1418− can then be processed by [GladTeX] to produce SVG images of the typeset

1215+ not specified, a link to the KaTeX CDN will be inserted. Note that this

1419− formulas and an HTML file with these images embedded.

1216+ option does not imply `--katex`.

1420

1217

1421− pandoc -s --gladtex input.md -o myfile.htex

1422− gladtex -d image_dir myfile.htex

1423− # produces myfile.html and images in image_dir

1424−

1425−[MathML]: https://www.w3.org/Math/

1218+[MathML]: http://www.w3.org/Math/

1426[MathJax]: https://www.mathjax.org

1219[MathJax]: https://www.mathjax.org

1427[KaTeX]: https://github.com/Khan/KaTeX

1220[KaTeX]: https://github.com/Khan/KaTeX

1428−[GladTeX]: https://humenda.github.io/GladTeX/

1429

1221

1430−## Options for wrapper scripts {.options}

1222+Options for wrapper scripts

1223+---------------------------

1431

1224

1432`--dump-args`

1225`--dump-args`

1433

1226

@@ -1451,277 +1244,8 @@ results only for basic math, usually you will want to use

1451

1244

1452 pandoc -o foo.html -s

1245 pandoc -o foo.html -s

1453

1246

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

1247+Templates

1248+=========

1725

1249

1726When the `-s/--standalone` option is used, pandoc uses a template to

1250When the `-s/--standalone` option is used, pandoc uses a template to

1727add header and footer material that is needed for a self-standing

1251add header and footer material that is needed for a self-standing

@@ -1741,981 +1265,412 @@ directory (see `--data-dir`, above). *Exceptions:*

1741 (or the `default.context` template, if you use `-t context`,

1265 (or the `default.context` template, if you use `-t context`,

1742 or the `default.ms` template, if you use `-t ms`, or the

1266 or the `default.ms` template, if you use `-t ms`, or the

1743 `default.html` template, if you use `-t html`).

1267 `default.html` template, if you use `-t html`).

1744−- `docx` and `pptx` have no template (however, you can use

1268+- `docx` has no template (however, you can use

1745 `--reference-doc` to customize the output).

1269 `--reference-doc` to customize the output).

1746

1270

1747Templates contain *variables*, which allow for the inclusion of

1271Templates contain *variables*, which allow for the inclusion of

1748arbitrary information at any point in the file. They may be set at the

1272arbitrary information at any point in the file. They may be set at the

1749command line using the `-V/--variable` option. If a variable is not set,

1273command 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

1274+pandoc will look for the key in the document's metadata – which can be set

1751−using either [YAML metadata blocks][Extension: `yaml_metadata_block`]

1275+using either [YAML metadata blocks][Extension:`yaml_metadata_block`]

1752−or with the `-M/--metadata` option. In addition, some variables

1276+or with the `--metadata` option.

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

1277

1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates

1278+Variables set by pandoc

1279+-----------------------

1763

1280

1764−## Template syntax

1281+Some variables are set automatically by pandoc. These vary somewhat

1282+depending on the output format, but include the following:

1765

1283

1766−### Comments

1284+`sourcefile`, `outputfile`

1285+: source and destination filenames, as given on the command line.

1286+ `sourcefile` can also be a list if input comes from multiple files, or empty

1287+ if input is from stdin. You can use the following snippet in your template

1288+ to distinguish them:

1767

1289

1768−Anything between the sequence `$--` and the end of the

1290+ $if(sourcefile)$

1769−line will be treated as a comment and omitted from the output.

1291+ $for(sourcefile)$

1292+ $sourcefile$

1293+ $endfor$

1294+ $else$

1295+ (stdin)

1296+ $endif$

1770

1297

1771−### Delimiters

1298+ Similarly, `outputfile` can be `-` if output goes to the terminal.

1772

1299

1773−To mark variables and control structures in the template,

1300+`title`, `author`, `date`

1774−either `$`...`$` or `${`...`}` may be used as delimiters.

1301+: allow identification of basic aspects of the document. Included

1775−The styles may also be mixed in the same template, but the

1302+ in PDF metadata through LaTeX and ConTeXt. These can be set

1776−opening and closing delimiter must match in each case. The

1303+ through a [pandoc title block][Extension: `pandoc_title_block`],

1777−opening delimiter may be followed by one or more spaces

1304+ which allows for multiple authors, or through a YAML metadata block:

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

1305

1782−To include a literal `$` in the document, use `$$`.

1306+ ---

1307+ author:

1308+ - Aristotle

1309+ - Peter Abelard

1310+ ...

1783

1311

1784−### Interpolated variables

1312+`subtitle`

1313+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;

1314+ renders in LaTeX only when using a document class that supports

1315+ `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,

1316+ `scrreprt`, `scrbook`).[^subtitle]

1785

1317

1786−A slot for an interpolated variable is a variable name surrounded

1318+`institute`

1787−by matched delimiters. Variable names must begin with a letter

1319+: author affiliations (in LaTeX and Beamer only). Can be a

1788−and can contain letters, numbers, `_`, `-`, and `.`. The

1320+ list, when there are multiple authors.

1789−keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may

1790−not be used as variable names. Examples:

1791

1321

1792−```

1322+`abstract`

1793−$foo$

1323+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx

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

1324

1803−Variable names with periods are used to get at structured

1325+`keywords`

1804−variable values. So, for example, `employee.salary` will return the

1326+: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;

1805−value of the `salary` field of the object that is the value of

1327+ may be repeated as for `author`, above

1806−the `employee` field.

1807

1328

1808−- If the value of the variable is simple value, it will be

1329+`header-includes`

1809− rendered verbatim. (Note that no escaping is done;

1330+: contents specified by `-H/--include-in-header` (may have multiple

1810− the assumption is that the calling program will escape

1331+ values)

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

1332

1816−### Conditionals

1333+`toc`

1334+: non-null value if `--toc/--table-of-contents` was specified

1817

1335

1818−A conditional begins with `if(variable)` (enclosed in

1336+`toc-title`

1819−matched delimiters) and ends with `endif` (enclosed in matched

1337+: title of table of contents (works only with EPUB,

1820−delimiters). It may optionally contain an `else` (enclosed in

1338+ opendocument, odt, docx, pptx)

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

1339

1825−```

1340+`include-before`

1826−$if(foo)$bar$endif$

1341+: contents specified by `-B/--include-before-body` (may have

1342+ multiple values)

1827

1343

1828−$if(foo)$

1344+`include-after`

1829− $foo$

1345+: contents specified by `-A/--include-after-body` (may have

1830−$endif$

1346+ multiple values)

1831

1347

1832−$if(foo)$

1348+`body`

1833−part one

1349+: body of document

1834−$else$

1835−part two

1836−$endif$

1837

1350

1838−${if(foo)}bar${endif}

1351+`meta-json`

1352+: JSON representation of all of the document's metadata. Field

1353+ values are transformed to the selected output format.

1839

1354

1840−${if(foo)}

1355+[^subtitle]: To make `subtitle` work with other LaTeX

1841− ${foo}

1356+ document classes, you can add the following to `header-includes`:

1842−${endif}

1843

1357

1844−${if(foo)}

1358+ \providecommand{\subtitle}[1]{%

1845−${ foo.bar }

1359+ \usepackage{titling}

1846−${else}

1360+ \posttitle{%

1847−no foo!

1361+ \par\large#1\end{center}}

1848−${endif}

1362+ }

1849−```

1850

1363

1851−The keyword `elseif` may be used to simplify complex nested

1364+Language variables

1852−conditionals:

1365+------------------

1853

1366

1854−```

1367+`lang`

1855−$if(foo)$

1368+: identifies the main language of the document,

1856−XXX

1369+ using a code according to [BCP 47] (e.g. `en` or `en-GB`).

1857−$elseif(bar)$

1370+ For some output formats, pandoc will convert it to an appropriate

1858−YYY

1371+ format stored in the additional variables `babel-lang`,

1859−$else$

1372+ `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).

1860−ZZZ

1373+

1861−$endif$

1374+ Native pandoc Spans and Divs with the lang attribute

1862−```

1375+ (value in BCP 47) can be used to switch the language in

1376+ that range. In LaTeX output, `babel-otherlangs` and

1377+ `polyglossia-otherlangs` variables will be generated

1378+ automatically based on the `lang` attributes of Spans

1379+ and Divs in the document.

1863

1380

1864−### For loops

1381+`dir`

1382+: the base direction of the document, either `rtl` (right-to-left)

1383+ or `ltr` (left-to-right).

1865

1384

1866−A for loop begins with `for(variable)` (enclosed in

1385+ For bidirectional documents, native pandoc `span`s and `div`s

1867−matched delimiters) and ends with `endfor` (enclosed in matched

1386+ with the `dir` attribute (value `rtl` or `ltr`) can be used to

1868−delimiters.

1387+ override the base direction in some output formats.

1388+ This may not always be necessary if the final renderer

1389+ (e.g. the browser, when generating HTML) supports the

1390+ [Unicode Bidirectional Algorithm].

1869

1391

1870−- If `variable` is an array, the material inside the loop will

1392+ When using LaTeX for bidirectional documents, only the `xelatex` engine

1871− be evaluated repeatedly, with `variable` being set to each

1393+ is fully supported (use `--pdf-engine=xelatex`).

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

1394

1878−Examples:

1395+[BCP 47]: https://tools.ietf.org/html/bcp47

1396+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics

1879

1397

1880−```

1398+Variables for slides

1881−$for(foo)$$foo$$sep$, $endfor$

1399+--------------------

1882

1400

1883−$for(foo)$

1401+Variables are available for [producing slide shows with pandoc],

1884− - $foo.last$, $foo.first$

1402+including all [reveal.js configuration options].

1885−$endfor$

1886

1403

1887−${ for(foo.bar) }

1404+`titlegraphic`

1888− - ${ foo.bar.last }, ${ foo.bar.first }

1405+: title graphic for Beamer documents

1889−${ endfor }

1890

1406

1891−$for(mymap)$

1407+`logo`

1892−$it.name$: $it.office$

1408+: logo for Beamer documents

1893−$endfor$

1894−```

1895

1409

1896−You may optionally specify a separator between consecutive

1410+`slidy-url`

1897−values using `sep` (enclosed in matched delimiters). The

1411+: base URL for Slidy documents (defaults to

1898−material between `sep` and the `endfor` is the separator.

1412+ `https://www.w3.org/Talks/Tools/Slidy2`)

1899

1413

1900−```

1414+`slideous-url`

1901−${ for(foo) }${ foo }${ sep }, ${ endfor }

1415+: base URL for Slideous documents (defaults to `slideous`)

1902−```

1903

1416

1904−Instead of using `variable` inside the loop, the special

1417+`s5-url`

1905−anaphoric keyword `it` may be used.

1418+: base URL for S5 documents (defaults to `s5/default`)

1906

1419

1907−```

1420+`revealjs-url`

1908−${ for(foo.bar) }

1421+: base URL for reveal.js documents (defaults to `reveal.js`)

1909− - ${ it.last }, ${ it.first }

1910−${ endfor }

1911−```

1912

1422

1913−### Partials

1423+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`

1424+: themes for LaTeX [`beamer`] documents

1914

1425

1915−Partials (subtemplates stored in different files) may be

1426+`themeoptions`

1916−included by using the name of the partial, followed

1427+: options for LaTeX beamer themes (a list).

1917−by `()`, for example:

1918

1428

1919−```

1429+`navigation`

1920−${ styles() }

1430+: controls navigation symbols in `beamer` documents

1921−```

1431+ (default is `empty` for no navigation symbols; other valid values

1432+ are `frame`, `vertical`, and `horizontal`).

1922

1433

1923−Partials will be sought in the directory containing

1434+`section-titles`

1924−the main template. The file name will be assumed to

1435+: enables on "title pages" for new sections in `beamer`

1925−have the same extension as the main template if it

1436+ documents (default = true).

1926−lacks an extension. When calling the partial, the

1927−full name including file extension can also be used:

1928

1437

1929−```

1438+`beamerarticle`

1930−${ styles.html() }

1439+: when true, the `beamerarticle` package is loaded (for

1931−```

1440+ producing an article from beamer slides).

1932

1441

1933−(If a partial is not found in the directory of the

1442+`aspectratio`

1934−template and the template path is given as a relative

1443+: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,

1935−path, it will also be sought in the `templates`

1444+ `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the

1936−subdirectory of the user data directory.)

1445+ default, and `32` for 3:2).

1937

1446

1938−Partials may optionally be applied to variables using

1447+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration

1939−a colon:

1940

1448

1941−```

1449+Variables for LaTeX

1942−${ date:fancy() }

1450+-------------------

1943

1451

1944−${ articles:bibentry() }

1452+LaTeX variables are used when [creating a PDF].

1945−```

1946

1453

1947−If `articles` is an array, this will iterate over its

1454+`papersize`

1948−values, applying the partial `bibentry()` to each one. So the

1455+: paper size, e.g. `letter`, `a4`

1949−second example above is equivalent to

1950

1456

1951−```

1457+`fontsize`

1952−${ for(articles) }

1458+: font size for body text (e.g. `10pt`, `12pt`)

1953−${ it:bibentry() }

1954−${ endfor }

1955−```

1956

1459

1957−Note that the anaphoric keyword `it` must be used when

1460+`documentclass`

1958−iterating over partials. In the above examples,

1461+: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]

1959−the `bibentry` partial should contain `it.title`

1960−(and so on) instead of `articles.title`.

1961

1462

1962−Final newlines are omitted from included partials.

1463+`classoption`

1464+: option for document class, e.g. `oneside`; may be repeated

1465+ for multiple options

1963

1466

1964−Partials may include other partials.

1467+`beameroption`

1468+: In beamer, add extra beamer option with `\setbeameroption{}`

1965

1469

1966−A separator between values of an array may be specified

1470+`geometry`

1967−in square brackets, immediately after the variable name

1471+: option for [`geometry`] package, e.g. `margin=1in`;

1968−or partial:

1472+ may be repeated for multiple options

1969

1473

1970−```

1474+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

1971−${months[, ]}$

1475+: sets margins, if `geometry` is not used (otherwise `geometry`

1476+ overrides these)

1972

1477

1973−${articles:bibentry()[; ]$

1478+`linestretch`

1974−```

1479+: adjusts line spacing using the [`setspace`]

1480+ package, e.g. `1.25`, `1.5`

1975

1481

1976−The separator in this case is literal and (unlike with `sep`

1482+`fontfamily`

1977−in an explicit `for` loop) cannot contain interpolated

1483+: font package for use with `pdflatex`:

1978−variables or other template directives.

1484+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].

1485+ The default is [Latin Modern][`lm`].

1979

1486

1980−### Nesting

1487+`fontfamilyoptions`

1488+: options for package used as `fontfamily`: e.g. `osf,sc` with

1489+ `fontfamily` set to [`mathpazo`] provides Palatino with old-style

1490+ figures and true small caps; may be repeated for multiple options

1981

1491

1982−To ensure that content is "nested," that is, subsequent lines

1492+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`

1983−indented, use the `^` directive:

1493+: font families for use with `xelatex` or

1494+ `lualatex`: take the name of any system font, using the

1495+ [`fontspec`] package. Note that if `CJKmainfont` is used,

1496+ the [`xecjk`] package must be available.

1984

1497

1985−```

1498+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`

1986−$item.number$ $^$$item.description$ ($item.price$)

1499+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,

1987−```

1500+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices

1501+ available through [`fontspec`], such as the OpenType features

1502+ `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.

1988

1503

1989−In this example, if `item.description` has multiple lines,

1504+`fontenc`

1990−they will all be indented to line up with the first line:

1505+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);

1506+ default is `T1` (see guide to [LaTeX font encodings])

1991

1507

1992−```

1508+`microtypeoptions`

1993−00123 A fine bottle of 18-year old

1509+: options to pass to the microtype package

1994− Oban whiskey. ($148)

1995−```

1996

1510

1997−To nest multiple lines to the same level, align them

1511+`colorlinks`

1998−with the `^` directive in the template. For example:

1512+: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,

1513+ `urlcolor`, or `toccolor` are set

1999

1514

2000−```

1515+`linkcolor`, `citecolor`, `urlcolor`, `toccolor`

2001−$item.number$ $^$$item.description$ ($item.price$)

1516+: color for internal links, citation links, external links, and links in table of contents:

2002− (Available til $item.sellby$.)

1517+ uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists

2003−```

2004

1518

2005−will produce

1519+`links-as-notes`

1520+: causes links to be printed as footnotes

2006

1521

2007−```

1522+`indent`

2008−00123 A fine bottle of 18-year old

1523+: uses document class settings for indentation (the default LaTeX template

2009− Oban whiskey. ($148)

1524+ otherwise removes indentation and adds space between paragraphs)

2010− (Available til March 30, 2020.)

2011−```

2012

1525

2013−If a variable occurs by itself on a line, preceded by whitespace

1526+`subparagraph`

2014−and not followed by further text or directives on the same line,

1527+: disables default behavior of LaTeX template that redefines (sub)paragraphs

2015−and the variable's value contains multiple lines, it will be

1528+ as sections, changing the appearance of nested headings in some classes

2016−nested automatically.

2017

1529

2018−### Breakable spaces

1530+`thanks`

1531+: specifies contents of acknowledgments footnote after document title.

2019

1532

2020−Normally, spaces in the template itself (as opposed to values of

1533+`toc`

2021−the interpolated variables) are not breakable, but they can be

1534+: include table of contents (can also be set using `--toc/--table-of-contents`)

2022−made breakable in part of the template by using the `~` keyword

2023−(ended with another `~`).

2024

1535

2025−```

1536+`toc-depth`

2026−$~$This long line may break if the document is rendered

1537+: level of section to include in table of contents

2027−with a short line length.$~$

2028−```

2029

1538

2030−### Pipes

1539+`secnumdepth`

1540+: numbering depth for sections, if sections are numbered

2031

1541

2032−A pipe transforms the value of a variable or partial. Pipes are

1542+`lof`, `lot`

2033−specified using a slash (`/`) between the variable name (or partial)

1543+: include list of figures, list of tables

2034−and the pipe name. Example:

2035

1544

2036−```

1545+`bibliography`

2037−$for(name)$

1546+: bibliography to use for resolving references

2038−$name/uppercase$

2039−$endfor$

2040

1547

2041−$for(metadata/pairs)$

1548+`biblio-style`

2042−- $it.key$: $it.value$

1549+: bibliography style, when used with `--natbib` and `--biblatex`.

2043−$endfor$

2044

1550

2045−$employee:name()/uppercase$

1551+`biblio-title`

2046−```

1552+: bibliography title, when used with `--natbib` and `--biblatex`.

2047

1553

2048−Pipes may be chained:

1554+`biblatexoptions`

1555+: list of options for biblatex.

2049

1556

2050−```

1557+`natbiboptions`

2051−$for(employees/pairs)$

1558+: list of options for natbib.

2052−$it.key/alpha/uppercase$. $it.name$

2053−$endfor$

2054−```

2055

1559

2056−Some pipes take parameters:

1560+`pagestyle`

1561+: An option for LaTeX's `\pagestyle{}`. The default article class

1562+ supports 'plain' (default), 'empty', and 'headings'; headings puts

1563+ section titles in the header.

2057

1564

2058−```

1565+[`article`]: https://ctan.org/pkg/article

2059−|----------------------|------------|

1566+[`report`]: https://ctan.org/pkg/report

2060−$for(employee)$

1567+[`book`]: https://ctan.org/pkg/book

2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$

1568+[KOMA-Script]: https://ctan.org/pkg/koma-script

2062−$endfor$

1569+[`memoir`]: https://ctan.org/pkg/memoir

2063−|----------------------|------------|

1570+[`xcolor`]: https://ctan.org/pkg/xcolor

2064−```

1571+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/

1572+[`mathpazo`]: https://ctan.org/pkg/mathpazo

1573+[LaTeX font encodings]: https://ctan.org/pkg/encguide

2065

1574

2066−Currently the following pipes are predefined:

1575+Variables for ConTeXt

1576+---------------------

2067

1577

2068−- `pairs`: Converts a map or array to an array of maps,

1578+`papersize`

2069− each with `key` and `value` fields. If the original

1579+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);

2070− value was an array, the `key` will be the array index,

1580+ may be repeated for multiple options

2071− starting with 1.

2072

1581

2073−- `uppercase`: Converts text to uppercase.

1582+`layout`

2074−

1583+: options for page margins and text arrangement (see [ConTeXt Layout]);

2075−- `lowercase`: Converts text to lowercase.

1584+ may be repeated for multiple options

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

2135−

2136−`title`, `author`, `date`

2137−: allow identification of basic aspects of the document. Included

2138− in PDF metadata through LaTeX and ConTeXt. These can be set

2139− 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`]:

2142−

2143− ---

2144− author:

2145− - Aristotle

2146− - Peter Abelard

2147− ...

2148−

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−

2156−`subtitle`

2157−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx

2158− documents

2159−

2160−`abstract`

2161−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx

2162− documents

2163−

2164−`keywords`

2165−: list of keywords to be included in HTML, PDF, ODT, pptx, docx

2166− and AsciiDoc metadata; repeat as for `author`, above

2167−

2168−`subject`

2169−: document subject, included in ODT, PDF, docx and pptx metadata

2170−

2171−`description`

2172−: document description, included in ODT, docx and pptx metadata. Some

2173− applications show this as `Comments` metadata.

2174−

2175−`category`

2176−: document category, included in docx and pptx metadata

2177−

2178−Additionally,

2179−any root-level string metadata, not included in ODT, docx

2180−or pptx metadata is added as a *custom property*.

2181−The following [YAML] metadata block for instance:

2182−

2183− ---

2184− title: 'This is the title'

2185− subtitle: "This is the subtitle"

2186− author:

2187− - Author One

2188− - Author Two

2189− description: |

2190− This is a long

2191− description.

2192−

2193− It consists of two paragraphs

2194− ...

2195−

2196−will include `title`, `author` and `description` as standard document

2197−properties and `subtitle` as a custom property when converting to docx,

2198−ODT or pptx.

2199−

2200−### Language variables

2201−

2202−`lang`

2203−: identifies the main language of the document using IETF language

2204− tags (following the [BCP 47] standard), such as `en` or `en-GB`.

2205− The [Language subtag lookup] tool can look up or verify these tags.

2206− This affects most formats, and controls hyphenation in PDF output

2207− when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.

2208−

2209− Use native pandoc [Divs and Spans] with the `lang` attribute to

2210− switch the language:

2211−

2212− ---

2213− lang: en-GB

2214− ...

2215−

2216− Text in the main document language (British English).

2217−

2218− ::: {lang=fr-CA}

2219− > Cette citation est écrite en français canadien.

2220− :::

2221−

2222− More text in English. ['Zitat auf Deutsch.']{lang=de}

2223−

2224−`dir`

2225−: the base script direction, either `rtl` (right-to-left)

2226− or `ltr` (left-to-right).

2227−

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].

2234−

2235− When using LaTeX for bidirectional documents, only the

2236− `xelatex` engine is fully supported (use

2237− `--pdf-engine=xelatex`).

2238−

2239−[BCP 47]: https://tools.ietf.org/html/bcp47

2240−[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics

2241−[Language subtag lookup]: https://r12a.github.io/app-subtags/

2242−

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

1585

2281`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

1586`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

2314−

2315−These affect HTML output when [producing slide shows with pandoc].

2316−

2317−`institute`

2318−: author affiliations: can be a list when there are multiple authors

2319−

2320−`revealjs-url`

2321−: base URL for reveal.js documents (defaults to

2322− `https://unpkg.com/reveal.js@^4/`)

2323−

2324−`s5-url`

2325−: base URL for S5 documents (defaults to `s5/default`)

2326−

2327−`slidy-url`

2328−: base URL for Slidy documents (defaults to

2329− `https://www.w3.org/Talks/Tools/Slidy2`)

2330−

2331−`slideous-url`

2332−: base URL for Slideous documents (defaults to `slideous`)

2333−

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/

2342−

2343−### Variables for Beamer slides

2344−

2345−These variables change the appearance of PDF slides using [`beamer`].

2346−

2347−`aspectratio`

2348−: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,

2349− `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,

2350− `32` for 3:2)

2351−

2352−`beamerarticle`

2353−: produce an article from Beamer slides

2354−

2355−`beameroption`

2356−: add extra beamer option with `\setbeameroption{}`

2357−

2358−`institute`

2359−: author affiliations: can be a list when there are multiple authors

2360−

2361−`logo`

2362−: logo image for slides

2363−

2364−`navigation`

2365−: controls navigation symbols (default is `empty` for no navigation

2366− symbols; other valid values are `frame`, `vertical`, and `horizontal`)

2367−

2368−`section-titles`

2369−: enables "title pages" for new sections (default is true)

2370−

2371−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`

2372−: beamer themes

2373−

2374−`themeoptions`

2375−: options for LaTeX beamer themes (a list).

2376−

2377−`titlegraphic`

2378−: image for title slide

2379−

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

2389−

2390−Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

2391−

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

2415−

2416−`classoption`

2417−: option for document class, e.g. `oneside`; repeat for multiple options:

2418−

2419− ---

2420− classoption:

2421− - twocolumn

2422− - landscape

2423− ...

2424−

2425−`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`]

2430−

2431−`geometry`

2432−: 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− ...

2452−

2453−`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)

2457−

2458−`linestretch`

2459−: adjusts line spacing using the [`setspace`]

2460− package, e.g. `1.25`, `1.5`

2461−

2462−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

2463−: sets margins if `geometry` is not used (otherwise `geometry`

1587+: sets margins, if `layout` is not used (otherwise `layout`

2464 overrides these)

1588 overrides these)

2465

1589

2466−`pagestyle`

2467−: control `\pagestyle{}`: the default article class

2468− supports `plain` (default), `empty` (no running heads or page numbers),

2469− and `headings` (section titles in running heads)

2470−

2471−`papersize`

2472−: paper size, e.g. `letter`, `a4`

2473−

2474−`secnumdepth`

2475−: numbering depth for sections (with `--number-sections` option

2476− or `numbersections` variable)

2477−

2478−#### Fonts

2479−

2480−`fontenc`

2481−: allows font encoding to be specified through `fontenc` package (with

2482− `pdflatex`); default is `T1` (see [LaTeX font encodings guide])

2483−

2484−`fontfamily`

2485−: font package for use with `pdflatex`:

2486− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].

2487− The default is [Latin Modern][`lm`].

2488−

2489−`fontfamilyoptions`

2490−: options for package used as `fontfamily`; repeat for multiple options.

2491− For example, to use the Libertine font with proportional lowercase

2492− (old-style) figures through the [`libertinus`] package:

2493−

2494− ---

2495− fontfamily: libertinus

2496− fontfamilyoptions:

2497− - osf

2498− - p

2499− ...

2500−

2501−`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`.

2505−

2506−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`

2507−: font families for use with `xelatex` or

2508− `lualatex`: take the name of any system font, using the

2509− [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.

2510−

2511−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`

2512−: 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:

2517−

2518− ---

2519− mainfont: TeX Gyre Pagella

2520− mainfontoptions:

2521− - Numbers=Lowercase

2522− - Numbers=Proportional

2523− ...

2524−

2525−`microtypeoptions`

2526−: options to pass to the microtype package

2527−

2528−#### Links

2529−

2530−`colorlinks`

2531−: add color to link text; automatically enabled if any of

2532− `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set

2533−

2534−`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`

2535−: color for internal links, external links, citation links, linked

2536− URLs, and links in table of contents, respectively: uses options

2537− allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and

2538− `x11names` lists

2539−

2540−`links-as-notes`

2541−: causes links to be printed as footnotes

2542−

2543−#### Front matter

2544−

2545−`lof`, `lot`

2546−: include list of figures, list of tables

2547−

2548−`thanks`

2549−: contents of acknowledgments footnote after document title

2550−

2551−`toc`

2552−: include table of contents (can also be set using

2553− `--toc/--table-of-contents`)

2554−

2555−`toc-depth`

2556−: level of section to include in table of contents

2557−

2558−#### BibLaTeX Bibliographies

2559−

2560−These variables function when using BibLaTeX for [citation rendering].

2561−

2562−`biblatexoptions`

2563−: list of options for biblatex

2564−

2565−`biblio-style`

2566−: bibliography style, when used with `--natbib` and `--biblatex`.

2567−

2568−`biblio-title`

2569−: bibliography title, when used with `--natbib` and `--biblatex`.

2570−

2571−`bibliography`

2572−: bibliography to use for resolving references

2573−

2574−`natbiboptions`

2575−: list of options for natbib

2576−

2577−[KOMA-Script]: https://ctan.org/pkg/koma-script

2578−[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/

2579−[LaTeX font encodings guide]: https://ctan.org/pkg/encguide

2580−[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre

2581−[`article`]: https://ctan.org/pkg/article

2582−[`book`]: https://ctan.org/pkg/book

2583−[`libertinus`]: https://ctan.org/pkg/libertinus

2584−[`memoir`]: https://ctan.org/pkg/memoir

2585−[`report`]: https://ctan.org/pkg/report

2586−

2587−### Variables for ConTeXt

2588−

2589−Pandoc uses these variables when [creating a PDF] with ConTeXt.

2590−

2591`fontsize`

1590`fontsize`

2592: font size for body text (e.g. `10pt`, `12pt`)

1591: font size for body text (e.g. `10pt`, `12pt`)

2593

1592

2594−`headertext`, `footertext`

1593+`mainfont`, `sansfont`, `monofont`, `mathfont`

2595−: text to be placed in running header or footer (see [ConTeXt Headers and

1594+: font families: take the name of any system font (see [ConTeXt Font Switching])

2596− Footers]); repeat up to four times for different placement

2597−

2598−`indenting`

2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see

2600− [ConTeXt Indentation]); repeat for multiple options

2601−

2602−`interlinespace`

2603−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);

2604− repeat for multiple options

2605−

2606−`layout`

2607−: options for page margins and text arrangement (see [ConTeXt Layout]);

2608− repeat for multiple options

2609

1595

2610`linkcolor`, `contrastcolor`

1596`linkcolor`, `contrastcolor`

2611−: color for links outside and inside a page, e.g. `red`, `blue` (see

1597+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])

2612− [ConTeXt Color])

2613

1598

2614`linkstyle`

1599`linkstyle`

2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,

1600+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`

2616− `type`, `cap`, `small`

2617

1601

2618−`lof`, `lot`

1602+`indenting`

2619−: include list of figures, list of tables

1603+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);

1604+ may be repeated for multiple options

2620

1605

2621−`mainfont`, `sansfont`, `monofont`, `mathfont`

1606+`whitespace`

2622−: font families: take the name of any system font (see

1607+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])

2623− [ConTeXt Font Switching])

2624

1608

2625−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

1609+`interlinespace`

2626−: sets margins, if `layout` is not used (otherwise `layout`

1610+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);

2627− overrides these)

1611+ may be repeated for multiple options

1612+

1613+`headertext`, `footertext`

1614+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);

1615+ may be repeated up to four times for different placement

2628

1616

2629`pagenumbering`

1617`pagenumbering`

2630: page number style and location (using [`setuppagenumbering`]);

1618: page number style and location (using [`setuppagenumbering`]);

2631− repeat for multiple options

1619+ may be repeated for multiple options

2632−

2633−`papersize`

2634−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);

2635− repeat for multiple options

2636−

2637−`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.

2662

1620

2663`toc`

1621`toc`

2664−: include table of contents (can also be set using

1622+: include table of contents (can also be set using `--toc/--table-of-contents`)

2665− `--toc/--table-of-contents`)

2666−

2667−`whitespace`

2668−: spacing between paragraphs, e.g. `none`, `small` (using

2669− [`setupwhitespace`])

2670

1623

2671−`includesource`

1624+`lof`, `lot`

2672−: include all source documents as file attachments in the PDF file

1625+: include list of figures, list of tables

2673−

2674−[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup

2675−[ConTeXt Layout]: https://wiki.contextgarden.net/Layout

2676−[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching

2677−[ConTeXt Color]: https://wiki.contextgarden.net/Color

2678−[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers

2679−[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation

2680−[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles

2681−[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A

2682−[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace

2683−[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace

2684−[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering

2685−

2686−### Variables for `wkhtmltopdf`

2687−

2688−Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].

2689−The `--css` option also affects the output.

2690

1626

2691−`footer-html`, `header-html`

1627+`pdfa`

2692−: add information to the header and footer

1628+: adds to the preamble the setup necessary to generate PDF/A-1b:2005.

1629+ To successfully generate PDF/A the required ICC color profiles have to

1630+ be available and the content and all included files (such as images)

1631+ have to be standard conforming. The ICC profiles can be obtained

1632+ from [ConTeXt ICC Profiles]. See also [ConTeXt PDFA] for more

1633+ details.

1634+

1635+[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup

1636+[ConTeXt Layout]: http://wiki.contextgarden.net/Layout

1637+[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching

1638+[ConTeXt Color]: http://wiki.contextgarden.net/Color

1639+[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers

1640+[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation

1641+[ConTeXt ICC Profiles]: http://wiki.contextgarden.net/PDFX#ICC_profiles

1642+[ConTeXt PDFA]: http://wiki.contextgarden.net/PDF/A

1643+[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace

1644+[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace

1645+[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering

1646+

1647+Variables for man pages

1648+-----------------------

2693

1649

2694−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

1650+`section`

2695−: set the page margins

1651+: section number in man pages

2696

1652

2697−`papersize`

1653+`header`

2698−: sets the PDF paper size

1654+: header in man pages

2699

1655

1656+`footer`

2700−### Variables for man pages

1657+: footer in man pages

2701

1658

2702`adjusting`

1659`adjusting`

2703: adjusts text to left (`l`), right (`r`), center (`c`),

1660: adjusts text to left (`l`), right (`r`), center (`c`),

2704 or both (`b`) margins

1661 or both (`b`) margins

2705

1662

2706−`footer`

2707−: footer in man pages

2708−

2709−`header`

2710−: header in man pages

2711−

2712`hyphenate`

1663`hyphenate`

2713: if `true` (the default), hyphenation will be used

1664: if `true` (the default), hyphenation will be used

2714

1665

2715−`section`

1666+Variables for ms

2716−: section number in man pages

1667+----------------

1668+

1669+`pointsize`

1670+: point size (e.g. `10p`)

2717

1671

2718−### Variables for ms

1672+`lineheight`

1673+: line height (e.g. `12p`)

2719

1674

2720`fontfamily`

1675`fontfamily`

2721: font family (e.g. `T` or `P`)

1676: font family (e.g. `T` or `P`)

@@ -2723,81 +1678,62 @@ The `--css` option also affects the output.

2723`indent`

1678`indent`

2724: paragraph indent (e.g. `2m`)

1679: paragraph indent (e.g. `2m`)

2725

1680

2726−`lineheight`

1681+Using variables in templates

2727−: line height (e.g. `12p`)

1682+----------------------------

2728−

2729−`pointsize`

2730−: point size (e.g. `10p`)

2731−

2732−### Variables set automatically

2733

1683

2734−Pandoc sets these variables automatically in response to [options] or

1684+Variable names are sequences of alphanumerics, `-`, and `_`,

2735−document contents; users can also modify them. These vary depending

1685+starting with a letter. A variable name surrounded by `$` signs

2736−on the output format, and include the following:

1686+will be replaced by its value. For example, the string `$title$` in

2737

1687

2738−`body`

1688+ <title>$title$</title>

2739−: body of document

2740

1689

2741−`date-meta`

1690+will be replaced by the document title.

2742−: the `date` variable converted to ISO 8601 YYYY-MM-DD,

2743− included in all HTML based formats (dzslides, epub,

2744− html, html4, html5, revealjs, s5, slideous, slidy).

2745− The recognized formats for `date` are: `mm/dd/yyyy`,

2746− `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`

2747− (e.g. either `02 Apr 2018` or `02 April 2018`),

2748− `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),

2749− `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).

2750

1691

2751−`header-includes`

1692+To write a literal `$` in a template, use `$$`.

2752−: contents specified by `-H/--include-in-header` (may have multiple

2753− values)

2754

1693

2755−`include-before`

1694+Templates may contain conditionals. The syntax is as follows:

2756−: contents specified by `-B/--include-before-body` (may have

2757− multiple values)

2758

1695

2759−`include-after`

1696+ $if(variable)$

2760−: contents specified by `-A/--include-after-body` (may have

1697+ X

2761− multiple values)

1698+ $else$

1699+ Y

1700+ $endif$

2762

1701

2763−`meta-json`

1702+This will include `X` in the template if `variable` has a non-null

2764−: JSON representation of all of the document's metadata. Field

1703+value; otherwise it will include `Y`. `X` and `Y` are placeholders for

2765− values are transformed to the selected output format.

1704+any valid template text, and may include interpolated variables or other

1705+conditionals. The `$else$` section may be omitted.

2766

1706

2767−`numbersections`

1707+When variables can have multiple values (for example, `author` in

2768−: non-null value if `-N/--number-sections` was specified

1708+a multi-author document), you can use the `$for$` keyword:

2769

1709

2770−`sourcefile`, `outputfile`

1710+ $for(author)$

2771−: source and destination filenames, as given on the command line.

1711+ <meta name="author" content="$author$" />

2772− `sourcefile` can also be a list if input comes from multiple files,

1712+ $endfor$

2773− or empty if input is from stdin. You can use the following snippet in

2774− your template to distinguish them:

2775

1713

2776− $if(sourcefile)$

1714+You can optionally specify a separator to be used between

2777− $for(sourcefile)$

1715+consecutive items:

2778− $sourcefile$

2779− $endfor$

2780− $else$

2781− (stdin)

2782− $endif$

2783

1716

2784− Similarly, `outputfile` can be `-` if output goes to the terminal.

1717+ $for(author)$$author$$sep$, $endfor$

2785

1718

2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.

1719+A dot can be used to select a field of a variable that takes

1720+an object as its value. So, for example:

2787

1721

2788−`curdir`

1722+ $author.name$ ($author.affiliation$)

2789−: working directory from which pandoc is run.

2790

1723

2791−`toc`

1724+If you use custom templates, you may need to revise them as pandoc

2792−: non-null value if `--toc/--table-of-contents` was specified

1725+changes. We recommend tracking the changes in the default templates,

1726+and modifying your custom templates accordingly. An easy way to do this

1727+is to fork the [pandoc-templates] repository and merge in changes after each

1728+pandoc release.

2793

1729

2794−`toc-title`

1730+Templates may contain comments: anything on a line after `$--`

2795−: title of table of contents (works only with EPUB,

1731+will be treated as a comment and ignored.

2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)

2797

1732

2798[pandoc-templates]: https://github.com/jgm/pandoc-templates

1733[pandoc-templates]: https://github.com/jgm/pandoc-templates

2799

1734

2800−# Extensions

1735+Extensions

1736+==========

2801

1737

2802The behavior of some of the readers and writers can be adjusted by

1738The behavior of some of the readers and writers can be adjusted by

2803enabling or disabling various extensions.

1739enabling or disabling various extensions.

@@ -2814,11 +1750,8 @@ section [Pandoc's Markdown] below (See [Markdown variants] for

2814`commonmark` and `gfm`.) In the following, extensions that also work

1750`commonmark` and `gfm`.) In the following, extensions that also work

2815for other formats are covered.

1751for other formats are covered.

2816

1752

2817−Note that markdown extensions added to the `ipynb` format

2818−affect Markdown cells in Jupyter notebooks (as do command-line

2819−options like `--atx-headers`).

2820−

2821−## Typography

1753+Typography

1754+----------

2822

1755

2823#### Extension: `smart` ####

1756#### Extension: `smart` ####

2824

1757

@@ -2850,12 +1783,13 @@ literally. In writing LaTeX, enabling `smart` tells pandoc

2850to use the ligatures when possible; if `smart` is disabled

1783to use the ligatures when possible; if `smart` is disabled

2851pandoc will use unicode quotation mark and dash characters.

1784pandoc will use unicode quotation mark and dash characters.

2852

1785

2853−## Headings and sections

1786+Headers and sections

1787+--------------------

2854

1788

2855#### Extension: `auto_identifiers` ####

1789#### Extension: `auto_identifiers` ####

2856

1790

2857−A heading without an explicitly specified identifier will be

1791+A header without an explicitly specified identifier will be

2858−automatically assigned a unique identifier based on the heading text.

1792+automatically assigned a unique identifier based on the header text.

2859

1793

2860This extension can be enabled/disabled for the following formats:

1794This extension can be enabled/disabled for the following formats:

2861

1795

@@ -2868,13 +1802,11 @@ output formats

2868enabled by default in

1802enabled by default in

2869: `markdown`, `muse`

1803: `markdown`, `muse`

2870

1804

2871−The default algorithm used to derive the identifier from the

1805+The algorithm used to derive the identifier from the header text is:

2872−heading text is:

2873

1806

2874 - Remove all formatting, links, etc.

1807 - Remove all formatting, links, etc.

2875 - Remove all footnotes.

1808 - Remove all footnotes.

2876− - Remove all non-alphanumeric characters,

2877− except underscores, hyphens, and periods.

1809+ - Remove all punctuation, except underscores, hyphens, and periods.

2878 - Replace all spaces and newlines with hyphens.

1810 - Replace all spaces and newlines with hyphens.

2879 - Convert all alphabetic characters to lowercase.

1811 - Convert all alphabetic characters to lowercase.

2880 - Remove everything up to the first letter (identifiers may

1812 - Remove everything up to the first letter (identifiers may

@@ -2883,31 +1815,27 @@ heading text is:

2883

1815

2884Thus, for example,

1816Thus, for example,

2885

1817

2886− Heading Identifier

1818+ Header Identifier

2887 ------------------------------- ----------------------------

1819 ------------------------------- ----------------------------

2888− `Heading identifiers in HTML` `heading-identifiers-in-html`

1820+ `Header identifiers in HTML` `header-identifiers-in-html`

2889− `Maître d'hôtel` `maître-dhôtel`

2890 `*Dogs*?--in *my* house?` `dogs--in-my-house`

1821 `*Dogs*?--in *my* house?` `dogs--in-my-house`

2891 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`

1822 `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`

2892 `3. Applications` `applications`

1823 `3. Applications` `applications`

2893 `33` `section`

1824 `33` `section`

2894

1825

2895These rules should, in most cases, allow one to determine the identifier

1826These rules should, in most cases, allow one to determine the identifier

2896−from the heading text. The exception is when several headings have the

1827+from the header text. The exception is when several headers have the

2897same text; in this case, the first will get an identifier as described

1828same text; in this case, the first will get an identifier as described

2898above; the second will get the same identifier with `-1` appended; the

1829above; the second will get the same identifier with `-1` appended; the

2899third with `-2`; and so on.

1830third with `-2`; and so on.

2900

1831

2901−(However, a different algorithm is used if

2902−`gfm_auto_identifiers` is enabled; see below.)

2903−

2904These identifiers are used to provide link targets in the table of

1832These identifiers are used to provide link targets in the table of

2905contents generated by the `--toc|--table-of-contents` option. They

1833contents generated by the `--toc|--table-of-contents` option. They

2906also make it easy to provide links from one section of a document to

1834also make it easy to provide links from one section of a document to

2907another. A link to this section, for example, might look like this:

1835another. A link to this section, for example, might look like this:

2908

1836

2909 See the section on

1837 See the section on

2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).

1838+ [header identifiers](#header-identifiers-in-html-latex-and-context).

2911

1839

2912Note, however, that this method of providing links to sections works

1840Note, however, that this method of providing links to sections works

2913only in HTML, LaTeX, and ConTeXt formats.

1841only in HTML, LaTeX, and ConTeXt formats.

@@ -2915,7 +1843,7 @@ only in HTML, LaTeX, and ConTeXt formats.

2915If the `--section-divs` option is specified, then each section will

1843If the `--section-divs` option is specified, then each section will

2916be wrapped in a `section` (or a `div`, if `html4` was specified),

1844be wrapped in a `section` (or a `div`, if `html4` was specified),

2917and the identifier will be attached to the enclosing `<section>`

1845and the identifier will be attached to the enclosing `<section>`

2918−(or `<div>`) tag rather than the heading itself. This allows entire

1846+(or `<div>`) tag rather than the header itself. This allows entire

2919sections to be manipulated using JavaScript or treated differently in

1847sections to be manipulated using JavaScript or treated differently in

2920CSS.

1848CSS.

2921

1849

@@ -2925,15 +1853,8 @@ Causes the identifiers produced by `auto_identifiers` to be pure ASCII.

2925Accents are stripped off of accented Latin letters, and non-Latin

1853Accents are stripped off of accented Latin letters, and non-Latin

2926letters are omitted.

1854letters are omitted.

2927

1855

2928−#### Extension: `gfm_auto_identifiers` ####

2929−

2930−Changes the algorithm used by `auto_identifiers` to conform to

2931−GitHub's method. Spaces are converted to dashes (`-`),

2932−uppercase characters to lowercase characters, and punctuation

2933−characters other than `-` and `_` are removed.

2934−Emojis are replaced by their names.

2935−

2936−## Math Input

1856+Math Input

1857+----------

2937

1858

2938The extensions [`tex_math_dollars`](#extension-tex_math_dollars),

1859The extensions [`tex_math_dollars`](#extension-tex_math_dollars),

2939[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and

1860[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and

@@ -2943,47 +1864,50 @@ are described in the section about Pandoc's Markdown.

2943However, they can also be used with HTML input. This is handy for

1864However, they can also be used with HTML input. This is handy for

2944reading web pages formatted using MathJax, for example.

1865reading web pages formatted using MathJax, for example.

2945

1866

2946−## Raw HTML/TeX

1867+Raw HTML/TeX

1868+------------

1869+

1870+The following extensions (especially how they affect Markdown

1871+input/output) are also described in more detail in their respective

1872+sections of [Pandoc's Markdown].

1873+

1874+#### [Extension: `raw_html`] {#raw_html}

1875+

1876+When converting from HTML, parse elements to raw HTML which are not

1877+representable in pandoc's AST.

1878+By default, this is disabled for HTML input.

2947

1879

2948−The following extensions are described in more detail in

1880+#### [Extension: `raw_tex`] {#raw_tex}

2949−their respective sections of [Pandoc's Markdown]:

1881+

1882+Allows raw LaTeX, TeX, and ConTeXt to be included in a document.

1883+

1884+This extension can be enabled/disabled for the following formats

1885+(in addition to `markdown`):

1886+

1887+input formats

1888+: `latex`, `org`, `textile`

1889+

1890+output formats

1891+: `textile`

2950

1892

2951−- [`raw_html`](#extension-raw_html) allows HTML elements which

1893+#### [Extension: `native_divs`] {#native_divs}

2952− are not representable in pandoc's AST to be parsed as raw HTML.

2953− By default, this is disabled for HTML input.

2954

1894

2955−- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt

1895+This extension is enabled by default for HTML input. This means that

2956− to be included in a document. This extension can be enabled/disabled

1896+`div`s are parsed to pandoc native elements. (Alternatively, you

2957− for the following formats (in addition to `markdown`):

1897+can parse them to raw HTML using `-f html-native_divs+raw_html`.)

2958

1898

2959− input formats

1899+When converting HTML to Markdown, for example, you may want to drop all

2960− : `latex`, `textile`, `html` (environments, `\ref`, and

1900+`div`s and `span`s:

2961− `\eqref` only), `ipynb`

2962

1901

2963− output formats

1902+ pandoc -f html-native_divs-native_spans -t markdown

2964− : `textile`, `commonmark`

2965

1903

2966− Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not

1904+#### [Extension: `native_spans`] {#native_spans}

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`.

2973

1905

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`.

1906+Analogous to `native_divs` above.

2978

1907

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`.

2985

1908

2986−## Literate Haskell support

1909+Literate Haskell support

1910+------------------------

2987

1911

2988#### Extension: `literate_haskell` ####

1912#### Extension: `literate_haskell` ####

2989

1913

@@ -3004,12 +1928,12 @@ This means that

3004 - In Markdown input, "bird track" sections will be parsed as Haskell

1928 - In Markdown input, "bird track" sections will be parsed as Haskell

3005 code rather than block quotations. Text between `\begin{code}`

1929 code rather than block quotations. Text between `\begin{code}`

3006 and `\end{code}` will also be treated as Haskell code. For

1930 and `\end{code}` will also be treated as Haskell code. For

3007− ATX-style headings the character '=' will be used instead of '#'.

1931+ ATX-style headers the character '=' will be used instead of '#'.

3008

1932

3009 - In Markdown output, code blocks with classes `haskell` and `literate`

1933 - In Markdown output, code blocks with classes `haskell` and `literate`

3010 will be rendered using bird tracks, and block quotations will be

1934 will be rendered using bird tracks, and block quotations will be

3011 indented one space, so they will not be treated as Haskell code.

1935 indented one space, so they will not be treated as Haskell code.

3012− In addition, headings will be rendered setext-style (with underlines)

1936+ In addition, headers will be rendered setext-style (with underlines)

3013 rather than ATX-style (with '#' characters). (This is because ghc

1937 rather than ATX-style (with '#' characters). (This is because ghc

3014 treats '#' characters in column 1 as introducing line numbers.)

1938 treats '#' characters in column 1 as introducing line numbers.)

3015

1939

@@ -3044,7 +1968,8 @@ Note that GHC expects the bird tracks in the first column, so indented

3044literate code blocks (e.g. inside an itemized environment) will not be

1968literate code blocks (e.g. inside an itemized environment) will not be

3045picked up by the Haskell compiler.

1969picked up by the Haskell compiler.

3046

1970

3047−## Other extensions

1971+Other extensions

1972+----------------

3048

1973

3049#### Extension: `empty_paragraphs` ####

1974#### Extension: `empty_paragraphs` ####

3050

1975

@@ -3059,60 +1984,12 @@ input formats

3059output formats

1984output formats

3060: `docx`, `odt`, `opendocument`, `html`

1985: `docx`, `odt`, `opendocument`, `html`

3061

1986

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−

3109#### Extension: `styles` #### {#ext-styles}

1987#### Extension: `styles` #### {#ext-styles}

3110

1988

3111−When converting from docx, read all docx styles as divs (for

3112−paragraph styles) and spans (for character styles) regardless

1989+Read all docx styles as divs (for paragraph styles) and spans (for

3113−of whether pandoc understands the meaning of these styles.

1990+character styles) regardless of whether pandoc understands the meaning

3114−This can be used with [docx custom styles](#custom-styles).

1991+of these styles. This can be used with [docx custom

3115−Disabled by default.

1992+styles](#custom-styles-in-docx). Disabled by default.

3116

1993

3117input formats

1994input formats

3118: `docx`

1995: `docx`

@@ -3122,36 +1999,22 @@ input formats

3122In the `muse` input format, this enables Text::Amuse

1999In the `muse` input format, this enables Text::Amuse

3123extensions to Emacs Muse markup.

2000extensions to Emacs Muse markup.

3124

2001

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−

3133#### Extension: `citations` {#org-citations}

2002#### Extension: `citations` {#org-citations}

3134

2003

3135−Some aspects of [Pandoc's Markdown citation syntax](#citations)

2004+Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted

3136−are also accepted in `org` input.

2005+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.

3144

2006

3145#### Extension: `ntb` ####

2007#### Extension: `ntb` ####

3146

2008

3147In the `context` output format this enables the use of [Natural Tables

2009In the `context` output format this enables the use of [Natural Tables

3148−(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default

2010+(TABLE)](http://wiki.contextgarden.net/TABLE) instead of the default

3149−[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).

2011+[Extreme Tables (xtables)](http://wiki.contextgarden.net/xtables).

3150Natural tables allow more fine-grained global customization but come

2012Natural tables allow more fine-grained global customization but come

3151at a performance penalty compared to extreme tables.

2013at a performance penalty compared to extreme tables.

3152

2014

3153

2015

3154−# Pandoc's Markdown

2016+Pandoc's Markdown

2017+=================

3155

2018

3156Pandoc understands an extended and slightly revised version of

2019Pandoc understands an extended and slightly revised version of

3157John Gruber's [Markdown] syntax. This document explains the syntax,

2020John Gruber's [Markdown] syntax. This document explains the syntax,

@@ -3161,7 +2024,8 @@ of `markdown`. Extensions can be enabled or disabled to specify the

3161behavior more granularly. They are described in the following. See also

2024behavior more granularly. They are described in the following. See also

3162[Extensions] above, for extensions that work also on other formats.

2025[Extensions] above, for extensions that work also on other formats.

3163

2026

3164−## Philosophy

2027+Philosophy

2028+----------

3165

2029

3166Markdown is designed to be easy to write, and, even more importantly,

2030Markdown is designed to be easy to write, and, even more importantly,

3167easy to read:

2031easy to read:

@@ -3169,7 +2033,7 @@ easy to read:

3169> A Markdown-formatted document should be publishable as-is, as plain

2033> A Markdown-formatted document should be publishable as-is, as plain

3170> text, without looking like it's been marked up with tags or formatting

2034> text, without looking like it's been marked up with tags or formatting

3171> instructions.

2035> instructions.

3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)

2036+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)

3173

2037

3174This principle has guided pandoc's decisions in finding syntax for

2038This principle has guided pandoc's decisions in finding syntax for

3175tables, footnotes, and other extensions.

2039tables, footnotes, and other extensions.

@@ -3182,7 +2046,8 @@ it discourages it, and provides other, non-HTMLish ways of representing

3182important document elements like definition lists, tables, mathematics, and

2046important document elements like definition lists, tables, mathematics, and

3183footnotes.

2047footnotes.

3184

2048

3185−## Paragraphs

2049+Paragraphs

2050+----------

3186

2051

3187A paragraph is one or more lines of text followed by one or more blank lines.

2052A paragraph is one or more lines of text followed by one or more blank lines.

3188Newlines are treated as spaces, so you can reflow your paragraphs as you like.

2053Newlines are treated as spaces, so you can reflow your paragraphs as you like.

@@ -3195,42 +2060,43 @@ Note: in multiline and grid table cells, this is the only way

3195to create a hard line break, since trailing spaces in the cells

2060to create a hard line break, since trailing spaces in the cells

3196are ignored.

2061are ignored.

3197

2062

3198−## Headings

2063+Headers

2064+-------

3199

2065

3200−There are two kinds of headings: Setext and ATX.

2066+There are two kinds of headers: Setext and ATX.

3201

2067

3202−### Setext-style headings ###

2068+### Setext-style headers ###

3203

2069

3204−A setext-style heading is a line of text "underlined" with a row of `=` signs

2070+A setext-style header is a line of text "underlined" with a row of `=` signs

3205−(for a level-one heading) or `-` signs (for a level-two heading):

2071+(for a level one header) or `-` signs (for a level two header):

3206

2072

3207− A level-one heading

2073+ A level-one header

3208− ===================

2074+ ==================

3209

2075

3210− A level-two heading

2076+ A level-two header

3211− -------------------

2077+ ------------------

3212

2078

3213−The heading text can contain inline formatting, such as emphasis (see

2079+The header text can contain inline formatting, such as emphasis (see

3214[Inline formatting], below).

2080[Inline formatting], below).

3215

2081

3216

2082

3217−### ATX-style headings ###

2083+### ATX-style headers ###

3218

2084

3219−An ATX-style heading consists of one to six `#` signs and a line of

2085+An ATX-style header consists of one to six `#` signs and a line of

3220text, optionally followed by any number of `#` signs. The number of

2086text, optionally followed by any number of `#` signs. The number of

3221−`#` signs at the beginning of the line is the heading level:

2087+`#` signs at the beginning of the line is the header level:

3222

2088

3223− ## A level-two heading

2089+ ## A level-two header

3224

2090

3225− ### A level-three heading ###

2091+ ### A level-three header ###

3226

2092

3227−As with setext-style headings, the heading text can contain formatting:

2093+As with setext-style headers, the header text can contain formatting:

3228

2094

3229− # A level-one heading with a [link](/url) and *emphasis*

2095+ # A level-one header with a [link](/url) and *emphasis*

3230

2096

3231#### Extension: `blank_before_header` ####

2097#### Extension: `blank_before_header` ####

3232

2098

3233−Standard Markdown syntax does not require a blank line before a heading.

2099+Standard Markdown syntax does not require a blank line before a header.

3234Pandoc does require this (except, of course, at the beginning of the

2100Pandoc does require this (except, of course, at the beginning of the

3235document). The reason for the requirement is that it is all too easy for a

2101document). The reason for the requirement is that it is all too easy for a

3236`#` to end up at the beginning of a line by accident (perhaps through line

2102`#` to end up at the beginning of a line by accident (perhaps through line

@@ -3242,30 +2108,29 @@ wrapping). Consider, for example:

3242#### Extension: `space_in_atx_header` ####

2108#### Extension: `space_in_atx_header` ####

3243

2109

3244Many Markdown implementations do not require a space between the

2110Many Markdown implementations do not require a space between the

3245−opening `#`s of an ATX heading and the heading text, so that

2111+opening `#`s of an ATX header and the header text, so that

3246−`#5 bolt` and `#hashtag` count as headings. With this extension,

2112+`#5 bolt` and `#hashtag` count as headers. With this extension,

3247pandoc does require the space.

2113pandoc does require the space.

3248

2114

3249−### Heading identifiers ###

2115+### Header identifiers ###

3250

2116

3251−See also the [`auto_identifiers`

3252−extension](#extension-auto_identifiers) above.

2117+See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.

3253

2118

3254#### Extension: `header_attributes` ####

2119#### Extension: `header_attributes` ####

3255

2120

3256−Headings can be assigned attributes using this syntax at the end

2121+Headers can be assigned attributes using this syntax at the end

3257−of the line containing the heading text:

2122+of the line containing the header text:

3258

2123

3259 {#identifier .class .class key=value key=value}

2124 {#identifier .class .class key=value key=value}

3260

2125

3261−Thus, for example, the following headings will all be assigned the identifier

2126+Thus, for example, the following headers will all be assigned the identifier

3262`foo`:

2127`foo`:

3263

2128

3264− # My heading {#foo}

2129+ # My header {#foo}

3265

2130

3266− ## My heading ## {#foo}

2131+ ## My header ## {#foo}

3267

2132

3268− My other heading {#foo}

2133+ My other header {#foo}

3269 ---------------

2134 ---------------

3270

2135

3271(This syntax is compatible with [PHP Markdown Extra].)

2136(This syntax is compatible with [PHP Markdown Extra].)

@@ -3274,56 +2139,51 @@ Note that although this syntax allows assignment of classes and key/value

3274attributes, writers generally don't use all of this information. Identifiers,

2139attributes, writers generally don't use all of this information. Identifiers,

3275classes, and key/value attributes are used in HTML and HTML-based formats such

2140classes, and key/value attributes are used in HTML and HTML-based formats such

3276as EPUB and slidy. Identifiers are used for labels and link anchors in the

2141as EPUB and slidy. Identifiers are used for labels and link anchors in the

3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.

2142+LaTeX, ConTeXt, Textile, and AsciiDoc writers.

3278

2143

3279−Headings with the class `unnumbered` will not be numbered, even if

2144+Headers with the class `unnumbered` will not be numbered, even if

3280`--number-sections` is specified. A single hyphen (`-`) in an attribute

2145`--number-sections` is specified. A single hyphen (`-`) in an attribute

3281context is equivalent to `.unnumbered`, and preferable in non-English

2146context is equivalent to `.unnumbered`, and preferable in non-English

3282documents. So,

2147documents. So,

3283

2148

3284− # My heading {-}

2149+ # My header {-}

3285

2150

3286is just the same as

2151is just the same as

3287

2152

3288− # My heading {.unnumbered}

2153+ # My header {.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.)

3294

2154

3295#### Extension: `implicit_header_references` ####

2155#### Extension: `implicit_header_references` ####

3296

2156

3297−Pandoc behaves as if reference links have been defined for each heading.

2157+Pandoc behaves as if reference links have been defined for each header.

3298−So, to link to a heading

2158+So, to link to a header

3299

2159

3300− # Heading identifiers in HTML

2160+ # Header identifiers in HTML

3301

2161

3302you can simply write

2162you can simply write

3303

2163

3304− [Heading identifiers in HTML]

2164+ [Header identifiers in HTML]

3305

2165

3306or

2166or

3307

2167

3308− [Heading identifiers in HTML][]

2168+ [Header identifiers in HTML][]

3309

2169

3310or

2170or

3311

2171

3312− [the section on heading identifiers][heading identifiers in

2172+ [the section on header identifiers][header identifiers in

3313 HTML]

2173 HTML]

3314

2174

3315instead of giving the identifier explicitly:

2175instead of giving the identifier explicitly:

3316

2176

3317− [Heading identifiers in HTML](#heading-identifiers-in-html)

2177+ [Header identifiers in HTML](#header-identifiers-in-html)

3318

2178

3319−If there are multiple headings with identical text, the corresponding

2179+If there are multiple headers with identical text, the corresponding

3320reference will link to the first one only, and you will need to use explicit

2180reference will link to the first one only, and you will need to use explicit

3321links to link to the others, as described above.

2181links to link to the others, as described above.

3322

2182

3323Like regular reference links, these references are case-insensitive.

2183Like regular reference links, these references are case-insensitive.

3324

2184

3325Explicit link reference definitions always take priority over

2185Explicit link reference definitions always take priority over

3326−implicit heading references. So, in the following example, the

2186+implicit header references. So, in the following example, the

3327link will point to `bar`, not to `#foo`:

2187link will point to `bar`, not to `#foo`:

3328

2188

3329 # Foo

2189 # Foo

@@ -3332,11 +2192,12 @@ link will point to `bar`, not to `#foo`:

3332

2192

3333 See [foo]

2193 See [foo]

3334

2194

3335−## Block quotations

2195+Block quotations

2196+----------------

3336

2197

3337Markdown uses email conventions for quoting blocks of text.

2198Markdown uses email conventions for quoting blocks of text.

3338A block quotation is one or more paragraphs or other block elements

2199A block quotation is one or more paragraphs or other block elements

3339−(such as lists or headings), with each line preceded by a `>` character

2200+(such as lists or headers), with each line preceded by a `>` character

3340and an optional space. (The `>` need not start at the left margin, but

2201and an optional space. (The `>` need not start at the left margin, but

3341it should not be indented more than three spaces.)

2202it should not be indented more than three spaces.)

3342

2203

@@ -3371,19 +2232,19 @@ block in a block quote, you need five spaces after the `>`:

3371

2232

3372#### Extension: `blank_before_blockquote` ####

2233#### Extension: `blank_before_blockquote` ####

3373

2234

3374−Standard Markdown syntax does not require a blank line before a

2235+Standard Markdown syntax does not require a blank line before a block

3375−block quote. Pandoc does require this (except, of course, at

2236+quote. Pandoc does require this (except, of course, at the beginning of the

3376−the beginning of the document). The reason for the requirement

2237+document). The reason for the requirement is that it is all too easy for a

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,

2238+`>` to end up at the beginning of a line by accident (perhaps through line

3379−unless the `markdown_strict` format is used, the following does

2239+wrapping). So, unless the `markdown_strict` format is used, the following does

3380not produce a nested block quote in pandoc:

2240not produce a nested block quote in pandoc:

3381

2241

3382 > This is a block quote.

2242 > This is a block quote.

3383 >> Nested.

2243 >> Nested.

3384

2244

3385

2245

3386−## Verbatim (code) blocks

2246+Verbatim (code) blocks

2247+----------------------

3387

2248

3388### Indented code blocks ###

2249### Indented code blocks ###

3389

2250

@@ -3445,16 +2306,14 @@ this syntax:

3445 qsort (filter (>= x) xs)

2306 qsort (filter (>= x) xs)

3446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

2307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3447

2308

3448−Here `mycode` is an identifier, `haskell` and `numberLines` are

2309+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and

3449−classes, and `startFrom` is an attribute with value `100`. Some

2310+`startFrom` is an attribute with value `100`. Some output formats can use this

3450−output formats can use this information to do syntax

3451−highlighting. Currently, the only output formats that uses this

2311+information to do syntax highlighting. Currently, the only output formats

3452−information are HTML, LaTeX, Docx, Ms, and PowerPoint. If

2312+that uses this information are HTML, LaTeX, Docx, Ms, and PowerPoint. If

3453−highlighting is supported for your output format and language,

2313+highlighting is supported for your output format and language, then the code

3454−then the code block above will appear highlighted, with numbered

2314+block above will appear highlighted, with numbered lines. (To see which

3455−lines. (To see which languages are supported, type `pandoc

2315+languages are supported, type `pandoc --list-highlight-languages`.) Otherwise,

3456−--list-highlight-languages`.) Otherwise, the code block above

3457−will appear as follows:

2316+the code block above will appear as follows:

3458

2317

3459 <pre id="mycode" class="haskell numberLines" startFrom="100">

2318 <pre id="mycode" class="haskell numberLines" startFrom="100">

3460 <code>

2319 <code>

@@ -3491,7 +2350,8 @@ To set the highlighting style, use `--highlight-style`.

3491For more information on highlighting, see [Syntax highlighting],

2350For more information on highlighting, see [Syntax highlighting],

3492below.

2351below.

3493

2352

3494−## Line blocks

2353+Line blocks

2354+-----------

3495

2355

3496#### Extension: `line_blocks` ####

2356#### Extension: `line_blocks` ####

3497

2357

@@ -3517,12 +2377,10 @@ line must begin with a space.

3517 | 200 Main St.

2377 | 200 Main St.

3518 | Berkeley, CA 94718

2378 | Berkeley, CA 94718

3519

2379

3520−Inline formatting (such as emphasis) is allowed in the content,

3521−but not block-level formatting (such as block quotes or lists).

3522−

3523This syntax is borrowed from [reStructuredText].

2380This syntax is borrowed from [reStructuredText].

3524

2381

3525−## Lists

2382+Lists

2383+-----

3526

2384

3527### Bullet lists ###

2385### Bullet lists ###

3528

2386

@@ -3692,12 +2550,6 @@ If default list markers are desired, use `#.`:

3692 #. two

2550 #. two

3693 #. three

2551 #. three

3694

2552

3695−#### Extension: `task_lists` ####

3696−

3697−Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.

3698−

3699− - [ ] an unchecked task list item

3700− - [x] checked item

3701

2553

3702### Definition lists ###

2554### Definition lists ###

3703

2555

@@ -3723,12 +2575,11 @@ a blank line, and must be followed by one or more definitions.

3723A definition begins with a colon or tilde, which may be indented one

2575A definition begins with a colon or tilde, which may be indented one

3724or two spaces.

2576or two spaces.

3725

2577

3726−A term may have multiple definitions, and each definition may

2578+A term may have multiple definitions, and each definition may consist of one or

3727−consist of one or more block elements (paragraph, code block,

2579+more block elements (paragraph, code block, list, etc.), each indented four

3728−list, etc.), each indented four spaces or one tab stop. The

3729−body of the definition (including the first line, aside from the

2580+spaces or one tab stop. The body of the definition (including the first line,

3730−colon or tilde) should be indented four spaces. However, as with

2581+aside from the colon or tilde) should be indented four spaces. However,

3731−other Markdown lists, you can "lazily" omit indentation except

2582+as with other Markdown lists, you can "lazily" omit indentation except

3732at the beginning of a paragraph or other block element:

2583at the beginning of a paragraph or other block element:

3733

2584

3734 Term 1

2585 Term 1

@@ -3754,10 +2605,9 @@ definition:

3754Note that space between items in a definition list is required.

2605Note that space between items in a definition list is required.

3755(A variant that loosens this requirement, but disallows "lazy"

2606(A variant that loosens this requirement, but disallows "lazy"

3756hard wrapping, can be activated with `compact_definition_lists`: see

2607hard wrapping, can be activated with `compact_definition_lists`: see

3757−[Non-default extensions], below.)

2608+[Non-pandoc extensions], below.)

3758

2609

3759−[^3]: I have been influenced by the suggestions of [David

2610+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).

3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).

3761

2611

3762### Numbered example lists ###

2612### Numbered example lists ###

3763

2613

@@ -3793,6 +2643,30 @@ list marker. That is, example lists always behave as if the

3793labels tend to be long, and indenting content to the

2643labels tend to be long, and indenting content to the

3794first non-space character after the label would be awkward.

2644first non-space character after the label would be awkward.

3795

2645

2646+### Compact and loose lists ###

2647+

2648+Pandoc behaves differently from `Markdown.pl` on some "edge

2649+cases" involving lists. Consider this source:

2650+

2651+ + First

2652+ + Second:

2653+ - Fee

2654+ - Fie

2655+ - Foe

2656+

2657+ + Third

2658+

2659+Pandoc transforms this into a "compact list" (with no `<p>` tags around

2660+"First", "Second", or "Third"), while Markdown puts `<p>` tags around

2661+"Second" and "Third" (but not "First"), because of the blank space

2662+around "Third". Pandoc follows a simple rule: if the text is followed by

2663+a blank line, it is treated as a paragraph. Since "Second" is followed

2664+by a list, and not a blank line, it isn't treated as a paragraph. The

2665+fact that the list is followed by a blank line is irrelevant. (Note:

2666+Pandoc works this way even when the `markdown_strict` format is specified. This

2667+behavior is consistent with the official Markdown syntax description,

2668+even though it is different from that of `Markdown.pl`.)

2669+

3796

2670

3797### Ending a list ###

2671### Ending a list ###

3798

2672

@@ -3831,7 +2705,8 @@ of one big list:

3831 2. dos

2705 2. dos

3832 3. tres

2706 3. tres

3833

2707

3834−## Horizontal rules

2708+Horizontal rules

2709+----------------

3835

2710

3836A line containing a row of three or more `*`, `-`, or `_` characters

2711A line containing a row of three or more `*`, `-`, or `_` characters

3837(optionally separated by spaces) produces a horizontal rule:

2712(optionally separated by spaces) produces a horizontal rule:

@@ -3841,7 +2716,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters

3841 ---------------

2716 ---------------

3842

2717

3843

2718

3844−## Tables

2719+Tables

2720+------

3845

2721

3846Four kinds of tables may be used. The first three kinds presuppose the use of

2722Four kinds of tables may be used. The first three kinds presuppose the use of

3847a fixed-width font, such as Courier. The fourth kind can be used with

2723a fixed-width font, such as Courier. The fourth kind can be used with

@@ -3866,7 +2742,7 @@ Simple tables look like this:

3866

2742

3867 Table: Demonstration of simple table syntax.

2743 Table: Demonstration of simple table syntax.

3868

2744

3869−The header and table rows must each fit on one line. Column

2745+The headers and table rows must each fit on one line. Column

3870alignments are determined by the position of the header text relative

2746alignments are determined by the position of the header text relative

3871to the dashed line below it:[^4]

2747to the dashed line below it:[^4]

3872

2748

@@ -3885,7 +2761,7 @@ to the dashed line below it:[^4]

3885The table must end with a blank line, or a line of dashes followed by

2761The table must end with a blank line, or a line of dashes followed by

3886a blank line.

2762a blank line.

3887

2763

3888−The column header row may be omitted, provided a dashed line is used

2764+The column headers may be omitted, provided a dashed line is used

3889to end the table. For example:

2765to end the table. For example:

3890

2766

3891 ------- ------ ---------- -------

2767 ------- ------ ---------- -------

@@ -3894,13 +2770,13 @@ to end the table. For example:

3894 1 1 1 1

2770 1 1 1 1

3895 ------- ------ ---------- -------

2771 ------- ------ ---------- -------

3896

2772

3897−When the header row is omitted, column alignments are determined on the basis

2773+When headers are omitted, column alignments are determined on the basis

3898of the first line of the table body. So, in the tables above, the columns

2774of the first line of the table body. So, in the tables above, the columns

3899would be right, left, center, and right aligned, respectively.

2775would be right, left, center, and right aligned, respectively.

3900

2776

3901#### Extension: `multiline_tables` ####

2777#### Extension: `multiline_tables` ####

3902

2778

3903−Multiline tables allow header and table rows to span multiple lines

2779+Multiline tables allow headers and table rows to span multiple lines

3904of text (but cells that span multiple columns or rows of the table are

2780of text (but cells that span multiple columns or rows of the table are

3905not supported). Here is an example:

2781not supported). Here is an example:

3906

2782

@@ -3922,7 +2798,7 @@ not supported). Here is an example:

3922These work like simple tables, but with the following differences:

2798These work like simple tables, but with the following differences:

3923

2799

3924 - They must begin with a row of dashes, before the header text

2800 - They must begin with a row of dashes, before the header text

3925− (unless the header row is omitted).

2801+ (unless the headers are omitted).

3926 - They must end with a row of dashes, then a blank line.

2802 - They must end with a row of dashes, then a blank line.

3927 - The rows must be separated by blank lines.

2803 - The rows must be separated by blank lines.

3928

2804

@@ -3931,7 +2807,7 @@ the columns, and the writers try to reproduce these relative widths in

3931the output. So, if you find that one of the columns is too narrow in the

2807the output. So, if you find that one of the columns is too narrow in the

3932output, try widening it in the Markdown source.

2808output, try widening it in the Markdown source.

3933

2809

3934−The header may be omitted in multiline tables as well as simple tables:

2810+Headers may be omitted in multiline tables as well as simple tables:

3935

2811

3936 ----------- ------- --------------- -------------------------

2812 ----------- ------- --------------- -------------------------

3937 First row 12.0 Example of a row that

2813 First row 12.0 Example of a row that

@@ -3942,7 +2818,7 @@ The header may be omitted in multiline tables as well as simple tables:

3942 rows.

2818 rows.

3943 ----------- ------- --------------- -------------------------

2819 ----------- ------- --------------- -------------------------

3944

2820

3945− : Here's a multiline table without a header.

2821+ : Here's a multiline table without headers.

3946

2822

3947It is possible for a multiline table to have just one row, but the row

2823It is possible for a multiline table to have just one row, but the row

3948should be followed by a blank line (and then the row of dashes that ends

2824should be followed by a blank line (and then the row of dashes that ends

@@ -3968,8 +2844,9 @@ The row of `=`s separates the header from the table body, and can be

3968omitted for a headerless table. The cells of grid tables may contain

2844omitted for a headerless table. The cells of grid tables may contain

3969arbitrary block elements (multiple paragraphs, code blocks, lists,

2845arbitrary block elements (multiple paragraphs, code blocks, lists,

3970etc.). Cells that span multiple columns or rows are not

2846etc.). Cells that span multiple columns or rows are not

3971−supported. Grid tables can be created easily using Emacs' table-mode

2847+supported. Grid tables can be created easily using [Emacs table mode].

3972−(`M-x table-insert`).

2848+

2849+[Emacs table mode]: http://table.sourceforge.net/

3973

2850

3974Alignments can be specified as with pipe tables, by putting

2851Alignments can be specified as with pipe tables, by putting

3975colons at the boundaries of the separator line after the

2852colons at the boundaries of the separator line after the

@@ -3997,7 +2874,7 @@ and the same number of rows in each column. For example, the

3997Docutils [sample grid tables] will not render as expected with

2874Docutils [sample grid tables] will not render as expected with

3998Pandoc.

2875Pandoc.

3999

2876

4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables

2877+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables

4001

2878

4002

2879

4003#### Extension: `pipe_tables` ####

2880#### Extension: `pipe_tables` ####

@@ -4030,13 +2907,11 @@ legal (though ugly) pipe table:

4030

2907

4031The cells of pipe tables cannot contain block elements like paragraphs

2908The cells of pipe tables cannot contain block elements like paragraphs

4032and lists, and cannot span multiple lines. If a pipe table contains a

2909and lists, and cannot span multiple lines. If a pipe table contains a

4033−row whose Markdown content is wider than the column width (see

2910+row whose printable content is wider than the column width (see

4034−`--columns`), then the table will take up the full text width and

4035−the cell contents will wrap, with the relative cell widths determined

2911+`--columns`), then the cell contents will wrap, with the

4036−by the number of dashes in the line separating the table header from

2912+relative cell widths determined by the widths of the separator

4037−the table body. (For example `---|-` would make the first column 3/4

2913+lines. (In this case, the table will take up the full text

4038−and the second column 1/4 of the full text width.)

4039−On the other hand, if no lines are wider than column width, then

2914+width.) If no lines are wider than column width, then

4040cell contents will not be wrapped, and the cells will be sized

2915cell contents will not be wrapped, and the cells will be sized

4041to their contents.

2916to their contents.

4042

2917

@@ -4054,7 +2929,8 @@ you'll need to add colons as above.

4054

2929

4055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table

2930[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table

4056

2931

4057−## Metadata blocks

2932+Metadata blocks

2933+---------------

4058

2934

4059#### Extension: `pandoc_title_block` ####

2935#### Extension: `pandoc_title_block` ####

4060

2936

@@ -4070,42 +2946,30 @@ output.) The block may contain just a title, a title and an author,

4070or all three elements. If you want to include an author but no

2946or all three elements. If you want to include an author but no

4071title, or a title and a date but no author, you need a blank line:

2947title, or a title and a date but no author, you need a blank line:

4072

2948

4073−```

4074−%

2949+ %

4075−% Author

2950+ % Author

4076−```

4077

2951

4078−```

4079−% My title

2952+ % My title

4080−%

2953+ %

4081−% June 15, 2006

2954+ % June 15, 2006

4082−```

4083

2955

4084The title may occupy multiple lines, but continuation lines must

2956The title may occupy multiple lines, but continuation lines must

4085begin with leading space, thus:

2957begin with leading space, thus:

4086

2958

4087−```

4088−% My title

2959+ % My title

4089− on multiple lines

2960+ on multiple lines

4090−```

4091

2961

4092If a document has multiple authors, the authors may be put on

2962If a document has multiple authors, the authors may be put on

4093separate lines with leading space, or separated by semicolons, or

2963separate lines with leading space, or separated by semicolons, or

4094both. So, all of the following are equivalent:

2964both. So, all of the following are equivalent:

4095

2965

4096−```

4097−% Author One

2966+ % Author One

4098− Author Two

2967+ Author Two

4099−```

4100

2968

4101−```

4102−% Author One; Author Two

2969+ % Author One; Author Two

4103−```

4104

2970

4105−```

4106−% Author One;

2971+ % Author One;

4107− Author Two

2972+ Author Two

4108−```

4109

2973

4110The date must fit on one line.

2974The date must fit on one line.

4111

2975

@@ -4146,7 +3010,7 @@ will also have "Version 4.0" in the header.

4146

3010

4147#### Extension: `yaml_metadata_block` ####

3011#### Extension: `yaml_metadata_block` ####

4148

3012

4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three

3013+A YAML metadata block is a valid YAML object, delimited by a line of three

4150hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots

3014hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots

4151(`...`) at the bottom. A YAML metadata block may occur anywhere in the

3015(`...`) at the bottom. A YAML metadata block may occur anywhere in the

4152document, but if it is not at the beginning, it must be preceded by a blank

3016document, but if it is not at the beginning, it must be preceded by a blank

@@ -4157,53 +3021,41 @@ and pass it to pandoc as an argument, along with your Markdown files:

4157 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html

3021 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html

4158

3022

4159Just be sure that the YAML file begins with `---` and ends with `---` or

3023Just be sure that the YAML file begins with `---` and ends with `---` or

4160−`...`.) Alternatively, you can use the `--metadata-file` option. Using

3024+`...`.)

4161−that approach however, you cannot reference content (like footnotes)

4162−from the main markdown input document.

4163

3025

4164Metadata will be taken from the fields of the YAML object and added to any

3026Metadata will be taken from the fields of the YAML object and added to any

4165existing document metadata. Metadata can contain lists and objects (nested

3027existing document metadata. Metadata can contain lists and objects (nested

4166arbitrarily), but all string scalars will be interpreted as Markdown. Fields

3028arbitrarily), but all string scalars will be interpreted as Markdown. Fields

4167with names ending in an underscore will be ignored by pandoc. (They may be

3029with names ending in an underscore will be ignored by pandoc. (They may be

4168−given a role by external processors.) Field names must not be

3030+given a role by external processors.)

4169−interpretable as YAML numbers or boolean values (so, for

4170−example, `yes`, `True`, and `15` cannot be used as field names).

4171

3031

4172−A document may contain multiple metadata blocks. If two

3032+A document may contain multiple metadata blocks. The metadata fields will

3033+be combined through a *left-biased union*: if two metadata blocks attempt

4173−metadata blocks attempt to set the same field, the value from

3034+to set the same field, the value from the first block will be taken.

4174−the second block will be taken.

4175

3035

4176When pandoc is used with `-t markdown` to create a Markdown document,

3036When pandoc is used with `-t markdown` to create a Markdown document,

4177a YAML metadata block will be produced only if the `-s/--standalone`

3037a YAML metadata block will be produced only if the `-s/--standalone`

4178option is used. All of the metadata will appear in a single block

3038option is used. All of the metadata will appear in a single block

4179at the beginning of the document.

3039at the beginning of the document.

4180

3040

4181−Note that [YAML] escaping rules must be followed. Thus, for example,

3041+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

3042+if a title contains a colon, it must be quoted. The pipe character

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

3043+(`|`) can be used to begin an indented block that will be interpreted

4186−escaping. This form is necessary when the field contains blank lines

3044+literally, without need for escaping. This form is necessary

4187−or block-level formatting:

3045+when the field contains blank lines or block-level formatting:

4188

3046

4189 ---

3047 ---

4190 title: 'This is the title: it contains a colon'

3048 title: 'This is the title: it contains a colon'

4191 author:

3049 author:

4192 - Author One

3050 - Author One

4193 - Author Two

3051 - Author Two

4194− keywords: [nothing, nothingness]

3052+ tags: [nothing, nothingness]

4195 abstract: |

3053 abstract: |

4196 This is the abstract.

3054 This is the abstract.

4197

3055

4198 It consists of two paragraphs.

3056 It consists of two paragraphs.

4199 ...

3057 ...

4200

3058

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−

4207Template variables will be set automatically from the metadata. Thus, for

3059Template variables will be set automatically from the metadata. Thus, for

4208example, in writing HTML, the variable `abstract` will be set to the HTML

3060example, in writing HTML, the variable `abstract` will be set to the HTML

4209equivalent of the Markdown in the `abstract` field:

3061equivalent of the Markdown in the `abstract` field:

@@ -4250,25 +3102,8 @@ will be interpreted as markdown. For example:

4250 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}

3102 \renewcommand{\section}[1]{\clearpage\oldsection{#1}}

4251 ```

3103 ```

4252

3104

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

3105+Backslash escapes

3106+-----------------

4272

3107

4273#### Extension: `all_symbols_escapable` ####

3108#### Extension: `all_symbols_escapable` ####

4274

3109

@@ -4294,12 +3129,9 @@ which allows only the following characters to be backslash-escaped:

4294(However, if the `markdown_strict` format is used, the standard Markdown rule

3129(However, if the `markdown_strict` format is used, the standard Markdown rule

4295will be used.)

3130will be used.)

4296

3131

4297−A backslash-escaped space is parsed as a nonbreaking space. In TeX output,

3132+A backslash-escaped space is parsed as a nonbreaking space. It will

4298−it will appear as `~`. In HTML and XML output, it will appear as a

3133+appear in TeX output as `~` and in HTML and XML as `\ ` or

4299−literal unicode nonbreaking space character (note that it will thus

3134+`\ `.

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).

4303

3135

4304A backslash-escaped newline (i.e. a backslash occurring at the end of

3136A backslash-escaped newline (i.e. a backslash occurring at the end of

4305a line) is parsed as a hard line break. It will appear in TeX output as

3137a line) is parsed as a hard line break. It will appear in TeX output as

@@ -4309,7 +3141,8 @@ two trailing spaces on a line.

4309

3141

4310Backslash escapes do not work in verbatim contexts.

3142Backslash escapes do not work in verbatim contexts.

4311

3143

4312−## Inline formatting

3144+Inline formatting

3145+-----------------

4313

3146

4314### Emphasis ###

3147### Emphasis ###

4315

3148

@@ -4357,13 +3190,12 @@ text by `~` characters. Thus, for example,

4357

3190

4358 H~2~O is a liquid. 2^10^ is 1024.

3191 H~2~O is a liquid. 2^10^ is 1024.

4359

3192

4360−The text between `^...^` or `~...~` may not contain spaces or

4361−newlines. If the superscripted or subscripted text contains

3193+If the superscripted or subscripted text contains spaces, these spaces

4362−spaces, these spaces must be escaped with backslashes. (This is

3194+must be escaped with backslashes. (This is to prevent accidental

4363−to prevent accidental superscripting and subscripting through

3195+superscripting and subscripting through the ordinary use of `~` and `^`.)

4364−the ordinary use of `~` and `^`, and also bad interactions with

4365−footnotes.) Thus, if you want the letter P with 'a cat' in

3196+Thus, if you want the letter P with 'a cat' in subscripts, use

4366−subscripts, use `P~a\ cat~`, not `P~a cat~`.

3197+`P~a\ cat~`, not `P~a cat~`.

3198+

4367

3199

4368### Verbatim ###

3200### Verbatim ###

4369

3201

@@ -4412,7 +3244,8 @@ For compatibility with other Markdown flavors, CSS is also supported:

4412This will work in all output formats that support small caps.

3244This will work in all output formats that support small caps.

4413

3245

4414

3246

4415−## Math

3247+Math

3248+----

4416

3249

4417#### Extension: `tex_math_dollars` ####

3250#### Extension: `tex_math_dollars` ####

4418

3251

@@ -4424,38 +3257,22 @@ left, and must not be followed immediately by a digit. Thus,

4424you need to enclose text in literal `$` characters, backslash-escape

3257you need to enclose text in literal `$` characters, backslash-escape

4425them and they won't be treated as math delimiters.

3258them and they won't be treated as math delimiters.

4426

3259

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−

4431TeX math will be printed in all output formats. How it is rendered

3260TeX math will be printed in all output formats. How it is rendered

4432depends on the output format:

3261depends on the output format:

4433

3262

4434−LaTeX

4435− ~ It will appear verbatim surrounded by `$...$` (for inline

4436− math) or `\[...\]` (for display math).

4437−

4438−Markdown, Emacs Org mode, ConTeXt, ZimWiki

3263+Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki

4439− ~ It will appear verbatim surrounded by `$...$` (for inline

3264+ ~ It will appear verbatim between `$` characters.

4440− math) or `$$...$$` (for display math).

4441−

4442−XWiki

4443− ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.

4444

3265

4445reStructuredText

3266reStructuredText

4446 ~ It will be rendered using an [interpreted text role `:math:`].

3267 ~ It will be rendered using an [interpreted text role `:math:`].

4447

3268

4448AsciiDoc

3269AsciiDoc

4449− ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim

3270+ ~ It will be rendered as `latexmath:[...]`.

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.

4454

3271

4455Texinfo

3272Texinfo

4456 ~ It will be rendered inside a `@math` command.

3273 ~ It will be rendered inside a `@math` command.

4457

3274

4458−roff man, Jira markup

3275+groff man

4459 ~ It will be rendered verbatim without `$`'s.

3276 ~ It will be rendered verbatim without `$`'s.

4460

3277

4461MediaWiki, DokuWiki

3278MediaWiki, DokuWiki

@@ -4489,9 +3306,10 @@ HTML, Slidy, DZSlides, S5, EPUB

4489 command-line options selected. Therefore see [Math rendering in HTML]

3306 command-line options selected. Therefore see [Math rendering in HTML]

4490 above.

3307 above.

4491

3308

4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math

3309+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math

4493

3310

4494−## Raw HTML

3311+Raw HTML

3312+--------

4495

3313

4496#### Extension: `raw_html` ####

3314#### Extension: `raw_html` ####

4497

3315

@@ -4502,17 +3320,8 @@ Markdown allows it, but it has been made an extension so that it can

4502be disabled if desired.)

3320be disabled if desired.)

4503

3321

4504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,

3322The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,

4505−DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile

3323+DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed

4506−output, and suppressed in other formats.

3324+in other formats.

4507−

4508−For a more explicit way of including raw HTML in a Markdown

4509−document, see the [`raw_attribute` extension][Extension: `raw_attribute`].

4510−

4511−In the CommonMark format, if `raw_html` is enabled, superscripts,

4512−subscripts, strikeouts and small capitals will be represented as HTML.

4513−Otherwise, plain-text fallbacks will be used. Note that even if

4514−`raw_html` is disabled, tables will be rendered with HTML syntax if

4515−they cannot use pipe syntax.

4516

3325

4517#### Extension: `markdown_in_html_blocks` ####

3326#### Extension: `markdown_in_html_blocks` ####

4518

3327

@@ -4529,7 +3338,7 @@ Thus, for example, pandoc will turn

4529 <table>

3338 <table>

4530 <tr>

3339 <tr>

4531 <td>*one*</td>

3340 <td>*one*</td>

4532− <td>[a link](https://google.com)</td>

3341+ <td>[a link](http://google.com)</td>

4533 </tr>

3342 </tr>

4534 </table>

3343 </table>

4535

3344

@@ -4538,14 +3347,14 @@ into

4538 <table>

3347 <table>

4539 <tr>

3348 <tr>

4540 <td><em>one</em></td>

3349 <td><em>one</em></td>

4541− <td><a href="https://google.com">a link</a></td>

3350+ <td><a href="http://google.com">a link</a></td>

4542 </tr>

3351 </tr>

4543 </table>

3352 </table>

4544

3353

4545whereas `Markdown.pl` will preserve it as is.

3354whereas `Markdown.pl` will preserve it as is.

4546

3355

4547−There is one exception to this rule: text between `<script>`,

3356+There is one exception to this rule: text between `<script>` and

4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.

3357+`<style>` tags is not interpreted as Markdown.

4549

3358

4550This departure from standard Markdown should make it easier to mix

3359This departure from standard Markdown should make it easier to mix

4551Markdown with HTML block elements. For example, one can surround

3360Markdown with HTML block elements. For example, one can surround

@@ -4587,10 +3396,6 @@ Note that in LaTeX environments, like

4587the material between the begin and end tags will be interpreted as raw

3396the material between the begin and end tags will be interpreted as raw

4588LaTeX, not as Markdown.

3397LaTeX, not as Markdown.

4589

3398

4590−For a more explicit and flexible way of including raw TeX in a

4591−Markdown document, see the [`raw_attribute`

4592−extension][Extension: `raw_attribute`].

4593−

4594Inline LaTeX is ignored in output formats other than Markdown, LaTeX,

3399Inline LaTeX is ignored in output formats other than Markdown, LaTeX,

4595Emacs Org mode, and ConTeXt.

3400Emacs Org mode, and ConTeXt.

4596

3401

@@ -4601,7 +3406,7 @@ Emacs Org mode, and ConTeXt.

4601Inline spans and fenced code blocks with a special

3406Inline spans and fenced code blocks with a special

4602kind of attribute will be parsed as raw content with the

3407kind of attribute will be parsed as raw content with the

4603designated format. For example, the following produces a raw

3408designated format. For example, the following produces a raw

4604−roff `ms` block:

3409+groff `ms` block:

4605

3410

4606 ```{=ms}

3411 ```{=ms}

4607 .MYMACRO

3412 .MYMACRO

@@ -4637,11 +3442,12 @@ example, to use a raw attribute with a backtick code block,

4637

3442

4638The raw attribute cannot be combined with regular attributes.

3443The raw attribute cannot be combined with regular attributes.

4639

3444

4640−## LaTeX macros

3445+LaTeX macros

3446+------------

4641

3447

4642#### Extension: `latex_macros` ####

3448#### Extension: `latex_macros` ####

4643

3449

4644−When this extension is enabled, pandoc will parse LaTeX

3450+For output formats other than LaTeX, pandoc will parse LaTeX

4645macro definitions and apply the resulting macros to all LaTeX

3451macro definitions and apply the resulting macros to all LaTeX

4646math and raw LaTeX. So, for example, the following will work in

3452math and raw LaTeX. So, for example, the following will work in

4647all output formats, not just LaTeX:

3453all output formats, not just LaTeX:

@@ -4651,20 +3457,18 @@ all output formats, not just LaTeX:

4651 $\tuple{a, b, c}$

3457 $\tuple{a, b, c}$

4652

3458

4653Note that LaTeX macros will not be applied if they occur

3459Note that LaTeX macros will not be applied if they occur

4654−inside a raw span or block marked with the

3460+inside inside a raw span or block marked with the

4655[`raw_attribute` extension](#extension-raw_attribute).

3461[`raw_attribute` extension](#extension-raw_attribute).

4656

3462

4657When `latex_macros` is disabled, the raw LaTeX and math will

3463When `latex_macros` is disabled, the raw LaTeX and math will

4658not have macros applied. This is usually a better approach when

3464not have macros applied. This is usually a better approach when

4659you are targeting LaTeX or PDF.

3465you are targeting LaTeX or PDF.

4660

3466

3467+Whether or not `latex_macros` is enabled, the macro definitions

4661−Macro definitions in LaTeX will be passed through as raw LaTeX

3468+will still 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.

4666

3469

4667−## Links

3470+Links

3471+-----

4668

3472

4669Markdown allows links to be specified in several ways.

3473Markdown allows links to be specified in several ways.

4670

3474

@@ -4673,7 +3477,7 @@ Markdown allows links to be specified in several ways.

4673If you enclose a URL or email address in pointy brackets, it

3477If you enclose a URL or email address in pointy brackets, it

4674will become a link:

3478will become a link:

4675

3479

4676− <https://google.com>

3480+ <http://google.com>

4677 <sam@green.eggs.ham>

3481 <sam@green.eggs.ham>

4678

3482

4679### Inline links ###

3483### Inline links ###

@@ -4683,7 +3487,7 @@ followed by the URL in parentheses. (Optionally, the URL can

4683be followed by a link title, in quotes.)

3487be followed by a link title, in quotes.)

4684

3488

4685 This is an [inline link](/url), and here's [one with

3489 This is an [inline link](/url), and here's [one with

4686− a title](https://fsf.org "click here for a good time!").

3490+ a title](http://fsf.org "click here for a good time!").

4687

3491

4688There can be no space between the bracketed part and the parenthesized part.

3492There can be no space between the bracketed part and the parenthesized part.

4689The link text can contain formatting (such as emphasis), but the title cannot.

3493The link text can contain formatting (such as emphasis), but the title cannot.

@@ -4712,7 +3516,7 @@ Here are some examples:

4712

3516

4713 [my label 1]: /foo/bar.html "My title, optional"

3517 [my label 1]: /foo/bar.html "My title, optional"

4714 [my label 2]: /foo

3518 [my label 2]: /foo

4715− [my label 3]: https://fsf.org (The free software foundation)

3519+ [my label 3]: http://fsf.org (The free software foundation)

4716 [my label 4]: /bar#special 'A title in single quotes'

3520 [my label 4]: /bar#special 'A title in single quotes'

4717

3521

4718The URL may optionally be surrounded by angle brackets:

3522The URL may optionally be surrounded by angle brackets:

@@ -4721,7 +3525,7 @@ The URL may optionally be surrounded by angle brackets:

4721

3525

4722The title may go on the next line:

3526The title may go on the next line:

4723

3527

4724− [my label 3]: https://fsf.org

3528+ [my label 3]: http://fsf.org

4725 "The free software foundation"

3529 "The free software foundation"

4726

3530

4727Note that link labels are not case sensitive. So, this will work:

3531Note that link labels are not case sensitive. So, this will work:

@@ -4759,7 +3563,7 @@ be omitted entirely:

4759### Internal links ###

3563### Internal links ###

4760

3564

4761To link to another section of the same document, use the automatically

3565To link to another section of the same document, use the automatically

4762−generated identifier (see [Heading identifiers]). For example:

3566+generated identifier (see [Header identifiers]). For example:

4763

3567

4764 See the [Introduction](#introduction).

3568 See the [Introduction](#introduction).

4765

3569

@@ -4772,7 +3576,8 @@ or

4772Internal links are currently supported for HTML formats (including

3576Internal links are currently supported for HTML formats (including

4773HTML slide shows and EPUB), LaTeX, and ConTeXt.

3577HTML slide shows and EPUB), LaTeX, and ConTeXt.

4774

3578

4775−## Images

3579+Images

3580+------

4776

3581

4777A link immediately preceded by a `!` will be treated as an image.

3582A link immediately preceded by a `!` will be treated as an image.

4778The link text will be used as the image's alt text:

3583The link text will be used as the image's alt text:

@@ -4818,11 +3623,10 @@ Attributes can be set on links and images:

4818(This syntax is compatible with [PHP Markdown Extra] when only `#id`

3623(This syntax is compatible with [PHP Markdown Extra] when only `#id`

4819and `.class` are used.)

3624and `.class` are used.)

4820

3625

4821−For HTML and EPUB, all known HTML5 attributes except `width` and

3626+For HTML and EPUB, all attributes except `width` and `height` (but

4822−`height` (but including `srcset` and `sizes`) are passed through

3627+including `srcset` and `sizes`) are passed through as is. The other

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.

3628+writers ignore attributes that are not supported by their output

3629+format.

4826

3630

4827The `width` and `height` attributes on images are treated specially. When

3631The `width` and `height` attributes on images are treated specially. When

4828used without a unit, the unit is assumed to be pixels. However, any of

3632used without a unit, the unit is assumed to be pixels. However, any of

@@ -4834,27 +3638,24 @@ For example:

4834![](file.jpg){ width=50% }

3638![](file.jpg){ width=50% }

4835```

3639```

4836

3640

4837−- Dimensions may be converted to a form that is compatible with

3641+- Dimensions are converted to inches for output in page-based formats like

4838− the output format (for example, dimensions given in pixels will

3642+ LaTeX. Dimensions are converted to pixels for output in HTML-like

4839− be converted to inches when converting HTML to LaTeX). Conversion

3643+ formats. Use the `--dpi` option to specify the number of pixels per

4840− between pixels and physical measurements is affected by the

3644+ inch. The default is 96dpi.

4841− `--dpi` option (by default, 96 dpi is assumed, unless the image

4842− itself contains dpi information).

4843- The `%` unit is generally relative to some available space.

3645- The `%` unit is generally relative to some available space.

4844− For example the above example will render to the following.

3646+ For example the above example will render to

4845− - HTML: `<img href="file.jpg" style="width: 50%;" />`

3647+ `<img href="file.jpg" style="width: 50%;" />` (HTML),

4846− - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`

3648+ `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or

4847− (If you're using a custom template, you need to configure `graphicx`

3649+ `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).

4848− as in the default template.)

4849− - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`

4850- Some output formats have a notion of a class

3650- Some output formats have a notion of a class

4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))

3651+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))

4852 or a unique identifier (LaTeX `\caption`), or both (HTML).

3652 or a unique identifier (LaTeX `\caption`), or both (HTML).

4853- When no `width` or `height` attributes are specified, the fallback

3653- When no `width` or `height` attributes are specified, the fallback

4854 is to look at the image resolution and the dpi metadata embedded in

3654 is to look at the image resolution and the dpi metadata embedded in

4855 the image file.

3655 the image file.

4856

3656

4857−## Divs and Spans

3657+Divs and Spans

3658+--------------

4858

3659

4859Using the `native_divs` and `native_spans` extensions

3660Using the `native_divs` and `native_spans` extensions

4860(see [above][Extension: `native_divs`]), HTML syntax can

3661(see [above][Extension: `native_divs`]), HTML syntax can

@@ -4910,7 +3711,8 @@ followed immediately by attributes:

4910

3711

4911 [This is *some text*]{.class key="val"}

3712 [This is *some text*]{.class key="val"}

4912

3713

4913−## Footnotes

3714+Footnotes

3715+---------

4914

3716

4915#### Extension: `footnotes` ####

3717#### Extension: `footnotes` ####

4916

3718

@@ -4956,401 +3758,45 @@ they cannot contain multiple paragraphs). The syntax is as follows:

4956

3758

4957Inline and regular footnotes may be mixed freely.

3759Inline and regular footnotes may be mixed freely.

4958

3760

4959−## Citation syntax

3761+Citations

3762+---------

4960

3763

4961#### Extension: `citations` ####

3764#### Extension: `citations` ####

4962

3765

4963−To cite a bibliographic item with an identifier foo, use the

4964−syntax `@foo`. Normal citations should be included in square

4965−brackets, with semicolons separating distinct items:

4966−

4967− Blah blah [@doe99; @smith2000; @smith2004].

4968−

4969−How this is rendered depends on the citation style. In an

4970−author-date style, it might render as

4971−

4972− Blah blah (Doe 1999, Smith 2000, 2004).

4973−

4974−In a footnote style, it might render as

4975−

4976− Blah blah.[^1]

4977−

4978− [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);

4979− Susan Smith, "Flies," *Journal of Insects* (2000);

4980− Susan Smith, "Bees," *Journal of Insects* (2004).

4981−

4982−See the [CSL user documentation] for more information about CSL

4983−styles and how they affect rendering.

4984−

4985−Unless a citation key start with a letter, digit, or `_`,

4986−and contains only alphanumerics and internal punctuation

4987−characters (`:.#$%&-+?<>~/`), it must be surrounded

4988−by curly braces, which are not considered part of the key.

4989−In `@Foo_bar.baz.`, the key is `Foo_bar.baz`. The final

4990−period is not *internal* punctuation, so it is not included in

4991−the key. In `@{Foo_bar.baz.}`, the key is `Foo_bar.baz.`, including

4992−the final period. The curly braces are recommended if you use URLs as

4993−keys: `[@{https://example.com/bib?name=foobar&date=2000}, p. 33]`.

4994−

4995−Citation items may optionally include a prefix, a locator, and

4996−a suffix. In

4997−

4998− Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].

4999−

5000−The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,

5001−and suffix `and *passim*`. The second item (`smith04`) has

5002−locator `chap. 1` and no prefix or suffix.

5003−

5004−Pandoc uses some heuristics to separate the locator from the

5005−rest of the subject. It is sensitive to the locator terms

5006−defined in the [CSL locale files]. Either abbreviated or

5007−unabbreviated forms are accepted. In the `en-US` locale, locator

5008−terms can be written in either singular or plural forms, as

5009−`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,

5010−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,

5011−`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;

5012−`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;

5013−`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,

5014−`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,

5015−`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no

5016−locator term is used, "page" is assumed.

5017−

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:

5021−

5022− [@smith{ii, A, D-Z}, with a suffix]

5023− [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]

5024− [@smith{}, 99 years later]

5025−

5026−A minus sign (`-`) before the `@` will suppress mention of

5027−the author in the citation. This can be useful when the

5028−author is already mentioned in the text:

5029−

5030− Smith says blah [-@smith04].

5031−

5032−You can also write an author-in-text citation, by omitting the

5033−square brackets:

5034−

5035− @smith04 says blah.

5036−

5037− @smith04 [p. 33] says blah.

5038−

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

5056−[Zotero Style Repository]: https://www.zotero.org/styles

5057−[finding and editing styles]: https://citationstyles.org/authors/

5058−[CSL locale files]: https://github.com/citation-style-language/locales

5059−

5060−## Non-default extensions

5061−

5062−The following Markdown syntax extensions are not enabled by default

5063−in pandoc, but may be enabled by adding `+EXTENSION` to the format

5064−name, where `EXTENSION` is the name of the extension. Thus, for

5065−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.

5066−

5067−#### Extension: `rebase_relative_paths` ####

5068−

5069−Rewrite relative paths for Markdown links and images, depending

5070−on the path of the file containing the link or image link. For

5071−each link or image, pandoc will compute the directory of the

5072−containing file, relative to the working directory, and prepend

5073−the resulting path to the link or image path.

5074−

5075−The use of this extension is best understood by example.

5076−Suppose you have a a subdirectory for each chapter of a book,

5077−`chap1`, `chap2`, `chap3`. Each contains a file `text.md` and a

5078−number of images used in the chapter. You would like to have

5079−`![image](spider.jpg)` in `chap1/text.md` refer to

5080−`chap1/spider.jpg` and `![image](spider.jpg)` in `chap2/text.md`

5081−refer to `chap2/spider.jpg`. To do this, use

5082−

5083− pandoc chap*/*.md -f markdown+rebase_relative_paths

5084−

5085−Without this extension, you would have to use

5086−`![image](chap1/spider.jpg)` in `chap1/text.md` and

5087−`![image](chap2/spider.jpg)` in `chap2/text.md`. Links with

5088−relative paths will be rewritten in the same way as images.

5089−

5090−Absolute paths and URLs are not changed. Neither are empty

5091−paths or paths consisting entirely of a fragment, e.g., `#foo`.

5092−

5093−Note that relative paths in reference links and images will

5094−be rewritten relative to the file containing the link

5095−reference definition, not the file containing the reference link

5096−or image itself, if these differ.

5097−

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−

5129−#### Extension: `old_dashes` ####

5130−

5131−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:

5132−`-` before a numeral is an en-dash, and `--` is an em-dash.

5133−This option only has an effect if `smart` is enabled. It is

5134−selected automatically for `textile` input.

5135−

5136−#### Extension: `angle_brackets_escapable` ####

5137−

5138−Allow `<` and `>` to be backslash-escaped, as they can be in

5139−GitHub flavored Markdown but not original Markdown. This is

5140−implied by pandoc's default `all_symbols_escapable`.

5141−

5142−#### Extension: `lists_without_preceding_blankline` ####

5143−

5144−Allow a list to occur right after a paragraph, with no intervening

5145−blank space.

5146−

5147−#### Extension: `four_space_rule` ####

5148−

5149−Selects the pandoc <= 2.0 behavior for parsing lists, so that

5150−four spaces indent are needed for list item continuation

5151−paragraphs.

5152−

5153−#### Extension: `spaced_reference_links` ####

5154−

5155−Allow whitespace between the two components of a reference link,

5156−for example,

5157−

5158− [foo] [bar].

5159−

5160−#### Extension: `hard_line_breaks` ####

5161−

5162−Causes all newlines within a paragraph to be interpreted as hard line

5163−breaks instead of spaces.

5164−

5165−#### Extension: `ignore_line_breaks` ####

5166−

5167−Causes newlines within a paragraph to be ignored, rather than being

5168−treated as spaces or as hard line breaks. This option is intended for

5169−use with East Asian languages where spaces are not used between words,

5170−but text is divided into lines for readability.

5171−

5172−#### Extension: `east_asian_line_breaks` ####

5173−

5174−Causes newlines within a paragraph to be ignored, rather than

5175−being treated as spaces or as hard line breaks, when they occur

5176−between two East Asian wide characters. This is a better choice

5177−than `ignore_line_breaks` for texts that include a mix of East

5178−Asian wide characters and other characters.

5179−

5180−#### Extension: `emoji` ####

5181−

5182−Parses textual emojis like `:smile:` as Unicode emoticons.

5183−

5184−#### Extension: `tex_math_single_backslash` ####

5185−

5186−Causes anything between `$` and `$` to be interpreted as inline

5187−TeX math, and anything between `\[` and `\]` to be interpreted

5188−as display TeX math. Note: a drawback of this extension is that

5189−it precludes escaping `(` and `[`.

5190−

5191−#### Extension: `tex_math_double_backslash` ####

5192−

5193−Causes anything between `\$` and `\$` to be interpreted as inline

5194−TeX math, and anything between `\\[` and `\\]` to be interpreted

5195−as display TeX math.

5196−

5197−#### Extension: `markdown_attribute` ####

5198−

5199−By default, pandoc interprets material inside block-level tags as Markdown.

5200−This extension changes the behavior so that Markdown is only parsed

5201−inside block-level tags if the tags have the attribute `markdown=1`.

5202−

5203−#### Extension: `mmd_title_block` ####

5204−

5205−Enables a [MultiMarkdown] style title block at the top of

5206−the document, for example:

5207−

5208− Title: My title

5209− Author: John Doe

5210− Date: September 1, 2008

5211− Comment: This is a sample mmd title block, with

5212− a field spanning multiple lines.

5213−

5214−See the MultiMarkdown documentation for details. If `pandoc_title_block` or

5215−`yaml_metadata_block` is enabled, it will take precedence over

5216−`mmd_title_block`.

5217−

5218−#### Extension: `abbreviations` ####

5219−

5220−Parses PHP Markdown Extra abbreviation keys, like

5221−

5222− *[HTML]: Hypertext Markup Language

5223−

5224−Note that the pandoc document model does not support

5225−abbreviations, so if this extension is enabled, abbreviation keys are

5226−simply skipped (as opposed to being parsed as paragraphs).

5227−

5228−#### Extension: `autolink_bare_uris` ####

5229−

5230−Makes all absolute URIs into links, even when not surrounded by

5231−pointy braces `<...>`.

5232−

5233−#### Extension: `mmd_link_attributes` ####

5234−

5235−Parses multimarkdown style key-value attributes on link

5236−and image references. This extension should not be confused with the

5237−[`link_attributes`](#extension-link_attributes) extension.

5238−

5239− This is a reference ![image][ref] with multimarkdown attributes.

5240−

5241− [ref]: https://path.to/image "Image title" width=20px height=30px

5242− id=myId class="myClass1 myClass2"

5243−

5244−#### Extension: `mmd_header_identifiers` ####

5245−

5246−Parses multimarkdown style heading identifiers (in square brackets,

5247−after the heading but before any trailing `#`s in an ATX heading).

5248−

5249−#### Extension: `compact_definition_lists` ####

5250−

5251−Activates the definition list syntax of pandoc 1.12.x and earlier.

5252−This syntax differs from the one described above under [Definition lists]

5253−in several respects:

5254−

5255− - No blank line is required between consecutive items of the

5256− definition list.

5257− - To get a "tight" or "compact" list, omit space between consecutive

5258− items; the space between a term and its definition does not affect

5259− anything.

5260− - Lazy wrapping of paragraphs is not allowed: the entire definition must

5261− be indented four spaces.[^6]

5262−

5263−[^6]: To see why laziness is incompatible with relaxing the requirement

5264− of a blank line between items, consider the following example:

5265−

5266− bar

5267− : definition

5268− foo

5269− : definition

5270−

5271− Is this a single list item with two definitions of "bar," the first of

5272− which is lazily wrapped, or two list items? To remove the ambiguity

5273− we must either disallow lazy wrapping or require a blank line between

5274− list items.

5275−

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

5292−

5293−In addition to pandoc's extended Markdown, the following Markdown

5294−variants are supported:

5295−

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

3766+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate

5320citations and a bibliography in a number of styles. Basic usage is

3767citations and a bibliography in a number of styles. Basic usage is

5321

3768

5322− pandoc --citeproc myinput.txt

3769+ pandoc --filter pandoc-citeproc myinput.txt

5323−

5324−To use this feature, you will need to have

5325

3770

5326−- a document containing citations (see [Extension: `citations`]);

3771+In order to use this feature, you will need to specify a bibliography file

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

3772+using the `bibliography` metadata field in a YAML metadata section, or

5335−`--bibliography` command line argument. If you want to use

3773+`--bibliography` command line argument. You can supply multiple `--bibliography`

5336−multiple bibliography files, you can supply multiple

5337−`--bibliography` arguments or set `bibliography` metadata field

3774+arguments or set `bibliography` metadata field to YAML array, if you want to

5338−to YAML array. A bibliography may have any of these formats:

3775+use multiple bibliography files. The bibliography may have any of these

3776+formats:

5339

3777

5340 Format File extension

3778 Format File extension

5341 ------------ --------------

3779 ------------ --------------

5342 BibLaTeX .bib

3780 BibLaTeX .bib

5343 BibTeX .bibtex

3781 BibTeX .bibtex

3782+ Copac .copac

5344 CSL JSON .json

3783 CSL JSON .json

5345 CSL YAML .yaml

3784 CSL YAML .yaml

3785+ EndNote .enl

3786+ EndNote XML .xml

3787+ ISI .wos

3788+ MEDLINE .medline

3789+ MODS .mods

3790+ RIS .ris

5346

3791

5347Note that `.bib` can be used with both BibTeX and BibLaTeX files;

3792Note that `.bib` can be used with both BibTeX and BibLaTeX files;

5348−use the extension `.bibtex` to force interpretation as BibTeX.

3793+use `.bibtex` to force BibTeX.

5349

3794

3795+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`

3796+can produce `.json` and `.yaml` files from any of the supported formats.

3797+

5350−In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup

3798+In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses

5351−inside fields such as `title`; in CSL YAML databases, pandoc

5352−Markdown; and in CSL JSON databases, an [HTML-like markup][CSL

3799+a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:

5353−markup specs]:

5354

3800

5355`<i>...</i>`

3801`<i>...</i>`

5356: italics

3802: italics

@@ -5370,11 +3816,14 @@ markup specs]:

5370`<span class="nocase">...</span>`

3816`<span class="nocase">...</span>`

5371: prevent a phrase from being capitalized as title case

3817: prevent a phrase from being capitalized as title case

5372

3818

3819+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON

3820+and CSL YAML formats as far as possible.

3821+

5373−As an alternative to specifying a bibliography file using

3822+As an alternative to specifying a bibliography file using `--bibliography`

5374−`--bibliography` or the YAML metadata field `bibliography`, you

3823+or the YAML metadata field `bibliography`, you can include

5375−can include the citation data directly in the `references` field

3824+the citation data directly in the `references` field of the

5376−of the document's YAML metadata. The field should contain an

3825+document's YAML metadata. The field should contain an array of

5377−array of YAML-encoded references, for example:

3826+YAML-encoded references, for example:

5378

3827

5379 ---

3828 ---

5380 references:

3829 references:

@@ -5390,273 +3839,322 @@ array of YAML-encoded references, for example:

5390 - - 1953

3839 - - 1953

5391 - 4

3840 - 4

5392 - 25

3841 - 25

5393− title: 'Molecular structure of nucleic acids: a structure for

3842+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose

5394− deoxyribose nucleic acid'

3843+ nucleic acid'

5395 title-short: Molecular structure of nucleic acids

3844 title-short: Molecular structure of nucleic acids

5396 container-title: Nature

3845 container-title: Nature

5397 volume: 171

3846 volume: 171

5398 issue: 4356

3847 issue: 4356

5399 page: 737-738

3848 page: 737-738

5400 DOI: 10.1038/171737a0

3849 DOI: 10.1038/171737a0

5401− URL: https://www.nature.com/articles/171737a0

3850+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html

5402 language: en-GB

3851 language: en-GB

5403 ...

3852 ...

5404

3853

5405−If both an external bibliography and inline (YAML metadata)

3854+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one

5406−references are provided, both will be used. In case of

3855+of the supported formats.)

5407−conflicting `id`s, the inline references will take precedence.

3856+

3857+Citations and references can be formatted using any style supported by the

3858+[Citation Style Language], listed in the [Zotero Style Repository].

3859+These files are specified using the `--csl` option or the `csl` metadata field.

3860+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date

3861+format. The CSL project provides further information on [finding and editing styles].

3862+

3863+To make your citations hyperlinks to the corresponding bibliography

3864+entries, add `link-citations: true` to your YAML metadata.

3865+

3866+Citations go inside square brackets and are separated by semicolons.

3867+Each citation must have a key, composed of '@' + the citation

3868+identifier from the database, and may optionally have a prefix,

3869+a locator, and a suffix. The citation key must begin with a letter, digit,

3870+or `_`, and may contain alphanumerics, `_`, and internal punctuation

3871+characters (`:.#$%&-+?<>~/`). Here are some examples:

3872+

3873+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].

3874+

3875+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

3876+

3877+ Blah blah [@smith04; @doe99].

3878+

3879+`pandoc-citeproc` detects locator terms in the [CSL locale files].

3880+Either abbreviated or unabbreviated forms are accepted. In the `en-US`

3881+locale, locator terms can be written in either singular or plural forms,

3882+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,

3883+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;

3884+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,

3885+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,

3886+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;

3887+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no

3888+locator term is used, "page" is assumed.

3889+

3890+A minus sign (`-`) before the `@` will suppress mention of

3891+the author in the citation. This can be useful when the

3892+author is already mentioned in the text:

3893+

3894+ Smith says blah [-@smith04].

3895+

3896+You can also write an in-text citation, as follows:

3897+

3898+ @smith04 says blah.

3899+

3900+ @smith04 [p. 33] says blah.

3901+

3902+If the style calls for a list of works cited, it will be placed

3903+at the end of the document. Normally, you will want to end your

3904+document with an appropriate header:

3905+

3906+ last paragraph...

3907+

3908+ # References

5408

3909

5409−Note that `pandoc` can be used to produce such a YAML metadata

3910+The bibliography will be inserted after this header. Note that

5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:

3911+the `unnumbered` class will be added to this header, so that the

3912+section will not be numbered.

5411

3913

5412− pandoc chem.bib -s -f biblatex -t markdown

3914+If you want to include items in the bibliography without actually

5413− pandoc chem.json -s -f csljson -t markdown

3915+citing them in the body text, you can define a dummy `nocite` metadata

3916+field and put the citations there:

5414

3917

5415−Indeed, `pandoc` can convert between any of these

3918+ ---

5416−citation formats:

3919+ nocite: |

3920+ @item1, @item2

3921+ ...

5417

3922

5418− pandoc chem.bib -s -f biblatex -t csljson

3923+ @item3

5419− pandoc chem.yaml -s -f markdown -t biblatex

5420

3924

5421−Running pandoc on a bibliography file with the `--citeproc`

3925+In this example, the document will contain a citation for `item3`

5422−option will create a formatted bibliography in the format

3926+only, but the bibliography will contain entries for `item1`, `item2`, and

5423−of your choice:

3927+`item3`.

5424

3928

5425− pandoc chem.bib -s --citeproc -o chem.html

3929+It is possible to create a bibliography with all the citations,

5426− pandoc chem.bib -s --citeproc -o chem.pdf

3930+whether or not they appear in the document, by using a wildcard:

5427

3931

5428−### Capitalization in titles

3932+ ---

3933+ nocite: |

3934+ @*

3935+ ...

5429

3936

5430−If you are using a bibtex or biblatex bibliography, then observe

3937+For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]

5431−the following rules:

3938+to render bibliography. In order to do so, specify bibliography files as

3939+outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`

3940+invocation. Bear in mind that bibliography files have to be in respective

3941+format (either BibTeX or BibLaTeX).

5432

3942

5433− - English titles should be in title case. Non-English titles should

3943+For more information, see the [pandoc-citeproc man page].

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

3944

5439− - As is standard with bibtex/biblatex, proper names should be

3945+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields

5440− protected with curly braces so that they won't be lowercased

3946+[Chicago Manual of Style]: http://chicagomanualofstyle.org

5441− in styles that call for sentence case. For example:

3947+[Citation Style Language]: http://citationstyles.org

3948+[Zotero Style Repository]: https://www.zotero.org/styles

3949+[finding and editing styles]: http://citationstyles.org/styles/

3950+[CSL locale files]: https://github.com/citation-style-language/locales

3951+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md

5442

3952

5443− title = {My Dinner with {Andre}}

3953+Non-pandoc extensions

3954+---------------------

5444

3955

5445− - In addition, words that should remain lowercase (or camelCase)

3956+The following Markdown syntax extensions are not enabled by default

5446− should be protected:

3957+in pandoc, but may be enabled by adding `+EXTENSION` to the format

3958+name, where `EXTENSION` is the name of the extension. Thus, for

3959+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.

5447

3960

5448− title = {Spin Wave Dispersion on the {nm} Scale}

3961+#### Extension: `old_dashes` ####

5449

3962

5450− Though this is not necessary in bibtex/biblatex, it is necessary

3963+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:

5451− with citeproc, which stores titles internally in sentence case,

3964+`-` before a numeral is an en-dash, and `--` is an em-dash.

5452− and converts to title case in styles that require it. Here we

3965+This option only has an effect if `smart` is enabled. It is

5453− protect "nm" so that it doesn't get converted to "Nm" at this stage.

3966+selected automatically for `textile` input.

5454

3967

5455−If you are using a CSL bibliography (either JSON or YAML), then observe

3968+#### Extension: `angle_brackets_escapable` ####

5456−the following rules:

5457

3969

5458− - All titles should be in sentence case.

3970+Allow `<` and `>` to be backslash-escaped, as they can be in

3971+GitHub flavored Markdown but not original Markdown. This is

3972+implied by pandoc's default `all_symbols_escapable`.

5459

3973

5460− - Use the `language` field for non-English titles to prevent their

3974+#### Extension: `lists_without_preceding_blankline` ####

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

3975

5464− - Protect words that should not be converted to title case using

3976+Allow a list to occur right after a paragraph, with no intervening

5465− this syntax:

3977+blank space.

5466

3978

5467− Spin wave dispersion on the <span class="nocase">nm</span> scale

3979+#### Extension: `four_space_rule` ####

5468

3980

5469−### Conference Papers, Published vs. Unpublished

3981+Selects the pandoc <= 2.0 behavior for parsing lists, so that

3982+four spaces indent are needed for list item continuation

3983+paragraphs.

5470

3984

5471−For a formally published conference paper, use the biblatex entry type

3985+#### Extension: `spaced_reference_links` ####

5472−`inproceedings` (which will be mapped to CSL `paper-conference`).

5473

3986

5474−For an unpublished manuscript, use the biblatex entry type

3987+Allow whitespace between the two components of a reference link,

5475−`unpublished` without an `eventtitle` field (this entry type

3988+for example,

5476−will be mapped to CSL `manuscript`).

5477

3989

5478−For a talk, an unpublished conference paper, or a poster

3990+ [foo] [bar].

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

3991

3992+#### Extension: `hard_line_breaks` ####

5488

3993

5489−## Specifying a citation style

3994+Causes all newlines within a paragraph to be interpreted as hard line

3995+breaks instead of spaces.

5490

3996

5491−Citations and references can be formatted using any style supported by the

3997+#### Extension: `ignore_line_breaks` ####

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

3998

3999+Causes newlines within a paragraph to be ignored, rather than being

4000+treated as spaces or as hard line breaks. This option is intended for

4001+use with East Asian languages where spaces are not used between words,

4002+but text is divided into lines for readability.

5508

4003

5509− { "default": {

4004+#### Extension: `east_asian_line_breaks` ####

5510− "container-title": {

5511− "Lloyd's Law Reports": "Lloyd's Rep",

5512− "Estates Gazette": "EG",

5513− "Scots Law Times": "SLT"

5514− }

5515− }

5516− }

5517

4005

4006+Causes newlines within a paragraph to be ignored, rather than

4007+being treated as spaces or as hard line breaks, when they occur

4008+between two East Asian wide characters. This is a better choice

4009+than `ignore_line_breaks` for texts that include a mix of East

4010+Asian wide characters and other characters.

5518

4011

5519−## Citations in note styles

4012+#### Extension: `emoji` ####

5520

4013

5521−Pandoc's citation processing is designed to allow you to

4014+Parses textual emojis like `:smile:` as Unicode emoticons.

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

4015

5528− Blah blah [@foo, p. 33].

4016+#### Extension: `tex_math_single_backslash` ####

5529

4017

5530−The footnote will be created automatically. Pandoc will take

4018+Causes anything between `$` and `$` to be interpreted as inline

5531−care of removing the space and moving the note before or

4019+TeX math, and anything between `\[` and `\]` to be interpreted

5532−after the period, depending on the setting of

4020+as display TeX math. Note: a drawback of this extension is that

5533−`notes-after-punctuation`, as described below in [Other relevant

4021+it precludes escaping `(` and `[`.

5534−metadata fields].

5535

4022

5536−In some cases you may need to put a citation inside a regular

4023+#### Extension: `tex_math_double_backslash` ####

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

4024

5542− [^1]: Some studies [@foo; @bar, p. 33] show that

4025+Causes anything between `\$` and `\$` to be interpreted as inline

5543− frubulicious zoosnaps are quantical. For a survey

4026+TeX math, and anything between `\\[` and `\\]` to be interpreted

5544− of the literature, see @baz [chap. 1].

4027+as display TeX math.

5545

4028

5546−## Raw content in a style

4029+#### Extension: `markdown_attribute` ####

5547

4030

5548−To include raw content in a prefix, suffix, delimiter, or term,

4031+By default, pandoc interprets material inside block-level tags as Markdown.

5549−surround it with these tags indicating the format:

4032+This extension changes the behavior so that Markdown is only parsed

4033+inside block-level tags if the tags have the attribute `markdown=1`.

5550

4034

5551− {{jats}}<ref>{{/jats}}

4035+#### Extension: `mmd_title_block` ####

5552

4036

5553−Without the tags, the string will be interpreted as a string

4037+Enables a [MultiMarkdown] style title block at the top of

5554−and escaped in the output, rather than being passed through raw.

4038+the document, for example:

5555

4039

5556−This feature allows stylesheets to be customized to give

4040+ Title: My title

5557−different output for different output formats. However,

4041+ Author: John Doe

5558−stylesheets customized in this way will not be usable

4042+ Date: September 1, 2008

5559−by other CSL implementations.

4043+ Comment: This is a sample mmd title block, with

4044+ a field spanning multiple lines.

5560

4045

4046+See the MultiMarkdown documentation for details. If `pandoc_title_block` or

4047+`yaml_metadata_block` is enabled, it will take precedence over

4048+`mmd_title_block`.

5561

4049

4050+#### Extension: `abbreviations` ####

5562

4051

5563−## Placement of the bibliography

4052+Parses PHP Markdown Extra abbreviation keys, like

5564

4053

5565−If the style calls for a list of works cited, it will be placed

4054+ *[HTML]: Hypertext Markup Language

5566−in a div with id `refs`, if one exists:

5567

4055

5568− ::: {#refs}

4056+Note that the pandoc document model does not support

5569− :::

4057+abbreviations, so if this extension is enabled, abbreviation keys are

4058+simply skipped (as opposed to being parsed as paragraphs).

5570

4059

5571−Otherwise, it will be placed at the end of the document.

4060+#### Extension: `autolink_bare_uris` ####

5572−Generation of the bibliography can be suppressed by setting

5573−`suppress-bibliography: true` in the YAML metadata.

5574

4061

5575−If you wish the bibliography to have a section heading, you can

4062+Makes all absolute URIs into links, even when not surrounded by

5576−set `reference-section-title` in the metadata, or put the heading

4063+pointy braces `<...>`.

5577−at the beginning of the div with id `refs` (if you are using it)

5578−or at the end of your document:

5579

4064

5580− last paragraph...

4065+#### Extension: `mmd_link_attributes` ####

5581

4066

5582− # References

4067+Parses multimarkdown style key-value attributes on link

4068+and image references. This extension should not be confused with the

4069+[`link_attributes`](#extension-link_attributes) extension.

5583

4070

5584−The bibliography will be inserted after this heading. Note that

4071+ This is a reference ![image][ref] with multimarkdown attributes.

5585−the `unnumbered` class will be added to this heading, so that the

5586−section will not be numbered.

5587

4072

5588−## Including uncited items in the bibliography

4073+ [ref]: http://path.to/image "Image title" width=20px height=30px

4074+ id=myId class="myClass1 myClass2"

5589

4075

5590−If you want to include items in the bibliography without actually

4076+#### Extension: `mmd_header_identifiers` ####

5591−citing them in the body text, you can define a dummy `nocite` metadata

5592−field and put the citations there:

5593

4077

5594− ---

4078+Parses multimarkdown style header identifiers (in square brackets,

5595− nocite: |

4079+after the header but before any trailing `#`s in an ATX header).

5596− @item1, @item2

5597− ...

5598

4080

5599− @item3

4081+#### Extension: `compact_definition_lists` ####

5600

4082

5601−In this example, the document will contain a citation for `item3`

4083+Activates the definition list syntax of pandoc 1.12.x and earlier.

5602−only, but the bibliography will contain entries for `item1`, `item2`, and

4084+This syntax differs from the one described above under [Definition lists]

5603−`item3`.

4085+in several respects:

5604

4086

5605−It is possible to create a bibliography with all the citations,

4087+ - No blank line is required between consecutive items of the

5606−whether or not they appear in the document, by using a wildcard:

4088+ definition list.

4089+ - To get a "tight" or "compact" list, omit space between consecutive

4090+ items; the space between a term and its definition does not affect

4091+ anything.

4092+ - Lazy wrapping of paragraphs is not allowed: the entire definition must

4093+ be indented four spaces.[^6]

5607

4094

5608− ---

4095+[^6]: To see why laziness is incompatible with relaxing the requirement

5609− nocite: |

4096+ of a blank line between items, consider the following example:

5610− @*

5611− ...

5612

4097

5613−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to

4098+ bar

5614−render the bibliography. In order to do so, specify bibliography

4099+ : definition

5615−files as outlined above, and add `--natbib` or `--biblatex`

4100+ foo

5616−argument to `pandoc` invocation. Bear in mind that bibliography

4101+ : definition

5617−files have to be in either BibTeX (for `--natbib`)

5618−or BibLaTeX (for `--biblatex`) format.

5619

4102

5620−## Other relevant metadata fields

4103+ Is this a single list item with two definitions of "bar," the first of

4104+ which is lazily wrapped, or two list items? To remove the ambiguity

4105+ we must either disallow lazy wrapping or require a blank line between

4106+ list items.

5621

4107

5622−A few other metadata fields affect bibliography formatting:

4108+Markdown variants

4109+-----------------

5623

4110

5624−`link-citations`

4111+In addition to pandoc's extended Markdown, the following Markdown

5625−: If true, citations will be

4112+variants are supported:

5626− hyperlinked to the corresponding bibliography entries

5627− (for author-date and numerical styles only).

5628

4113

5629−`lang`

4114+`markdown_phpextra` (PHP Markdown Extra)

5630−: The `lang` field will affect how the style is localized,

4115+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,

5631− for example in the translation of labels, the use

4116+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,

5632− of quotation marks, and the way items are sorted.

4117+ `header_attributes`, `link_attributes`, `abbreviations`,

5633− (For backwards compatibility, `locale` may be used instead

4118+ `shortcut_reference_links`, `spaced_reference_links`.

5634− of `lang`, but this use is deprecated.)

4119+

5635−

4120+`markdown_github` (deprecated GitHub-Flavored Markdown)

5636− A BCP 47 language tag is expected: for example, `en`,

4121+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,

5637− `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension

4122+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,

5638− syntax (after `-u-`) may be used to specify options for

4123+ `space_in_atx_header`, `intraword_underscores`, `strikeout`,

5639− collation (sorting) more precisely. Here are some examples:

4124+ `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,

5640−

4125+ `lists_without_preceding_blankline`.

5641− - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.

4126+

5642− - `es-u-co-trad` -- Spanish with the traditional collation

4127+`markdown_mmd` (MultiMarkdown)

5643− (with `Ch` sorting after `C`).

4128+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,

5644− - `fr-u-kb` -- French with "backwards" accent sorting

4129+ `tex_math_double_backslash`, `intraword_underscores`,

5645− (with `coté` sorting after `côte`).

4130+ `mmd_title_block`, `footnotes`, `definition_lists`,

5646− - `en-US-u-kf-upper` -- English with uppercase letters sorting

4131+ `all_symbols_escapable`, `implicit_header_references`,

5647− before lower (default is lower before upper).

4132+ `auto_identifiers`, `mmd_header_identifiers`,

5648−

4133+ `shortcut_reference_links`, `implicit_figures`,

5649−`notes-after-punctuation`

4134+ `superscript`, `subscript`, `backtick_code_blocks`,

5650−: If true (the default), pandoc will put footnote citations

4135+ `spaced_reference_links`, `raw_attribute`.

5651− after following punctuation. For example, if the source

4136+

5652− contains `blah blah [@jones99].`, the result will look like

4137+`markdown_strict` (Markdown.pl)

5653− `blah blah.[^1]`, with the note moved after the period and

4138+: `raw_html`, `shortcut_reference_links`,

5654− the space collapsed. If false, the space will still be

4139+ `spaced_reference_links`.

5655− collapsed, but the footnote will not be moved after the

4140+

5656− punctuation.

4141+We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,

5657−

4142+which is implemented as a set of extensions on `commonmark`).

5658−

4143+

5659−# Slide shows

4144+Note, however, that `commonmark` and `gfm` have limited support

4145+for extensions. Only those listed below (and `smart` and

4146+`raw_tex`) will work. The extensions can, however, all be

4147+individually disabled.

4148+Also, `raw_tex` only affects `gfm` output, not input.

4149+

4150+`gfm` (GitHub-Flavored Markdown)

4151+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,

4152+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,

4153+ `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,

4154+ `shortcut_reference_links`, `angle_brackets_escapable`.

4155+

4156+Producing slide shows with pandoc

4157+=================================

5660

4158

5661You can use pandoc to produce an HTML + JavaScript slide presentation

4159You can use pandoc to produce an HTML + JavaScript slide presentation

5662that can be viewed via a web browser. There are five ways to do this,

4160that can be viewed via a web browser. There are five ways to do this,

@@ -5704,21 +4202,18 @@ To produce an HTML/JavaScript slide show, simply type

5704

4202

5705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.

4203where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.

5706

4204

5707−For Slidy, Slideous, reveal.js, and S5, the file produced by

4205+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the

5708−pandoc with the `-s/--standalone` option embeds a link to

4206+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are

5709−JavaScript and CSS files, which are assumed to be available at

5710−the relative path `s5/default` (for S5), `slideous` (for

4207+assumed to be available at the relative path `s5/default` (for S5), `slideous`

5711−Slideous), `reveal.js` (for reveal.js), or at the Slidy website

4208+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at

5712−at `w3.org` (for Slidy). (These paths can be changed by setting

4209+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,

5713−the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`

5714−variables; see [Variables for HTML slides], above.) For

4210+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],

5715−DZSlides, the (relatively short) JavaScript and CSS are included

4211+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in

5716−in the file by default.

4212+the file by default.

5717−

4213+

5718−With all HTML slide formats, the `--self-contained` option can

4214+With all HTML slide formats, the `--self-contained` option can be used to

5719−be used to produce a single file that contains all of the data

4215+produce a single file that contains all of the data necessary to display the

5720−necessary to display the slide show, including linked scripts,

5721−stylesheets, images, and videos.

4216+slide show, including linked scripts, stylesheets, images, and videos.

5722

4217

5723To produce a PDF slide show using beamer, type

4218To produce a PDF slide show using beamer, type

5724

4219

@@ -5731,13 +4226,14 @@ To produce a Powerpoint slide show, type

5731

4226

5732 pandoc habits.txt -o habits.pptx

4227 pandoc habits.txt -o habits.pptx

5733

4228

5734−## Structuring the slide show

4229+Structuring the slide show

4230+--------------------------

5735

4231

5736−By default, the *slide level* is the highest heading level in

4232+By default, the *slide level* is the highest header level in

5737the hierarchy that is followed immediately by content, and not another

4233the hierarchy that is followed immediately by content, and not another

5738−heading, somewhere in the document. In the example above, level-1 headings

4234+header, somewhere in the document. In the example above, level 1 headers

5739−are always followed by level-2 headings, which are followed by content,

4235+are always followed by level 2 headers, which are followed by content,

5740−so the slide level is 2. This default can be overridden using

4236+so 2 is the slide level. This default can be overridden using

5741the `--slide-level` option.

4237the `--slide-level` option.

5742

4238

5743The document is carved up into slides according to the following

4239The document is carved up into slides according to the following

@@ -5745,21 +4241,17 @@ rules:

5745

4241

5746 * A horizontal rule always starts a new slide.

4242 * A horizontal rule always starts a new slide.

5747

4243

5748− * A heading at the slide level always starts a new slide.

4244+ * A header at the slide level always starts a new slide.

5749

4245

5750− * Headings *below* the slide level in the hierarchy create

4246+ * Headers *below* the slide level in the hierarchy create

5751− headings *within* a slide. (In beamer, a "block" will be

4247+ headers *within* a slide.

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.)

5756

4248

5757− * Headings *above* the slide level in the hierarchy create

4249+ * Headers *above* the slide level in the hierarchy create

5758 "title slides," which just contain the section title

4250 "title slides," which just contain the section title

5759 and help to break the slide show into sections.

4251 and help to break the slide show into sections.

5760− Non-slide content under these headings will be included

4252+

5761− on the title slide (for HTML slide shows) or in a

4253+ * Content *above* the slide level will not appear in the slide

5762− subsequent slide with the same title (for beamer).

4254+ show.

5763

4255

5764 * A title page is constructed automatically from the document's title

4256 * A title page is constructed automatically from the document's title

5765 block, if present. (In the case of beamer, this can be disabled

4257 block, if present. (In the case of beamer, this can be disabled

@@ -5767,16 +4259,17 @@ rules:

5767

4259

5768These rules are designed to support many different styles of slide show. If

4260These rules are designed to support many different styles of slide show. If

5769you don't care about structuring your slides into sections and subsections,

4261you 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

4262+you can just use level 1 headers for all each slide. (In that case, level 1

5771will be the slide level.) But you can also structure the slide show into

4263will be the slide level.) But you can also structure the slide show into

5772sections, as in the example above.

4264sections, as in the example above.

5773

4265

5774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional

4266Note: in reveal.js slide shows, if slide level is 2, a two-dimensional

5775−layout will be produced, with level-1 headings building horizontally

4267+layout will be produced, with level 1 headers building horizontally

5776−and level-2 headings building vertically. It is not recommended that

4268+and level 2 headers building vertically. It is not recommended that

5777you use deeper nesting of section levels with reveal.js.

4269you use deeper nesting of section levels with reveal.js.

5778

4270

5779−## Incremental lists

4271+Incremental lists

4272+-----------------

5780

4273

5781By default, these writers produce lists that display "all at once."

4274By default, these writers produce lists that display "all at once."

5782If you want your lists to display incrementally (one item at a time),

4275If you want your lists to display incrementally (one item at a time),

@@ -5814,10 +4307,8 @@ option):

5814Both methods allow incremental and nonincremental lists to be mixed

4307Both methods allow incremental and nonincremental lists to be mixed

5815in a single document.

4308in a single document.

5816

4309

5817−Note: Neither the `-i/--incremental` option nor any of the

5818−methods described here currently works for PowerPoint output.

5819−

5820−## Inserting pauses

4310+Inserting pauses

4311+----------------

5821

4312

5822You can add "pauses" within a slide by including a paragraph containing

4313You can add "pauses" within a slide by including a paragraph containing

5823three dots, separated by spaces:

4314three dots, separated by spaces:

@@ -5830,9 +4321,8 @@ three dots, separated by spaces:

5830

4321

5831 content after the pause

4322 content after the pause

5832

4323

5833−Note: this feature is not yet implemented for PowerPoint output.

5834−

5835−## Styling the slides

4324+Styling the slides

4325+------------------

5836

4326

5837You can change the style of HTML slides by putting customized CSS files

4327You can change the style of HTML slides by putting customized CSS files

5838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),

4328in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),

@@ -5857,9 +4347,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,

5857

4347

5858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf

4348 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf

5859

4349

5860−Note that heading attributes will turn into slide attributes

4350+Note that header attributes will turn into slide attributes

5861(on a `<div>` or `<section>`) in HTML slide formats, allowing you

4351(on a `<div>` or `<section>`) in HTML slide formats, allowing you

5862−to style individual slides. In beamer, the only heading attribute

4352+to style individual slides. In beamer, the only header attribute

5863that affects slides is the `allowframebreaks` class, which sets the

4353that affects slides is the `allowframebreaks` class, which sets the

5864`allowframebreaks` option, causing multiple slides to be created

4354`allowframebreaks` option, causing multiple slides to be created

5865if the content overfills the frame. This is recommended especially for

4355if the content overfills the frame. This is recommended especially for

@@ -5867,7 +4357,8 @@ bibliographies:

5867

4357

5868 # References {.allowframebreaks}

4358 # References {.allowframebreaks}

5869

4359

5870−## Speaker notes

4360+Speaker notes

4361+-------------

5871

4362

5872Speaker notes are supported in reveal.js and PowerPoint (pptx)

4363Speaker notes are supported in reveal.js and PowerPoint (pptx)

5873output. You can add notes to your Markdown document thus:

4364output. You can add notes to your Markdown document thus:

@@ -5888,7 +4379,8 @@ in handouts and presenter view.

5888Notes are not yet supported for other slide formats, but the notes

4379Notes are not yet supported for other slide formats, but the notes

5889will not appear on the slides themselves.

4380will not appear on the slides themselves.

5890

4381

5891−## Columns

4382+Columns

4383+-------

5892

4384

5893To put material in side by side columns, you can use a native

4385To put material in side by side columns, you can use a native

5894div container with class `columns`, containing two or more div

4386div container with class `columns`, containing two or more div

@@ -5903,46 +4395,12 @@ containers with class `column` and a `width` attribute:

5903 :::

4395 :::

5904 ::::::::::::::

4396 ::::::::::::::

5905

4397

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

4398+Frame attributes in beamer

4399+--------------------------

5942

4400

5943Sometimes it is necessary to add the LaTeX `[fragile]` option to

4401Sometimes it is necessary to add the LaTeX `[fragile]` option to

5944a frame in beamer (for example, when using the `minted` environment).

4402a frame in beamer (for example, when using the `minted` environment).

5945−This can be forced by adding the `fragile` class to the heading

4403+This can be forced by adding the `fragile` class to the header

5946introducing the slide:

4404introducing the slide:

5947

4405

5948 # Fragile slide {.fragile}

4406 # Fragile slide {.fragile}

@@ -5950,50 +4408,41 @@ introducing the slide:

5950All of the other frame attributes described in Section 8.1 of

4408All of the other frame attributes described in Section 8.1 of

5951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,

4409the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,

5952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,

4410`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,

5953−`shrink`, `standout`, `noframenumbering`.

4411+`shrink`.

5954

4412

5955−## Background in reveal.js and beamer

4413+Background in reveal.js

4414+-----------------------

5956

4415

5957−Background images can be added to self-contained reveal.js slideshows and

4416+Background images can be added to self-contained reveal.js slideshows.

5958−to beamer slideshows.

5959

4417

5960−For the same image on every slide, use the configuration

4418+For the same image on every slide, use the reveal.js configuration

5961−option `background-image` either in the YAML metadata block

4419+option `parallaxBackgroundImage` either in the YAML metadata block

5962−or as a command-line variable. (There are no other options in

4420+or as a command-line variable. You can also set

5963−beamer and the rest of this section concerns reveal.js slideshows.)

4421+`parallaxBackgroundHorizontal` and `parallaxBackgroundVertical` the same

4422+way and must also set `parallaxBackgroundSize` to have your values

4423+take effect.

5964

4424

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

5968−`parallaxBackgroundSize` to have your values take effect.

5969−

5970−To set an image for a particular reveal.js slide, add

4425+To set an image for a particular slide, add

5971`{data-background-image="/path/to/image"}`

4426`{data-background-image="/path/to/image"}`

5972−to the first slide-level heading on the slide (which may even be empty).

4427+to the first slide-level header on the slide (which may even be empty).

5973

4428

5974In reveal.js's overview mode, the parallaxBackgroundImage will show up

4429In reveal.js's overview mode, the parallaxBackgroundImage will show up

5975only on the first slide.

4430only on the first slide.

5976

4431

5977−Other reveal.js background settings also work on individual slides, including

4432+Other background settings also work on individual slides, including

5978`data-background-size`, `data-background-repeat`, `data-background-color`,

4433`data-background-size`, `data-background-repeat`, `data-background-color`,

5979`data-transition`, and `data-transition-speed`.

4434`data-transition`, and `data-transition-speed`.

5980

4435

5981−To add a background image to the automatically generated title slide, use the

4436+See the [reveal.js

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

4437+documentation](https://github.com/hakimel/reveal.js#slide-backgrounds)

5986−details.

4438+for more details.

5987

4439

5988−For example in reveal.js:

4440+For example:

5989

4441

5990```

4442```

5991---

4443---

5992title: My Slideshow

4444title: My Slideshow

5993parallaxBackgroundImage: /path/to/my/background_image.png

4445parallaxBackgroundImage: /path/to/my/background_image.png

5994−title-slide-attributes:

5995− data-background-image: /path/to/title_image.png

5996− data-background-size: contain

5997---

4446---

5998

4447

5999## Slide One

4448## Slide One

@@ -6002,12 +4451,14 @@ Slide 1 has background_image.png as its background.

6002

4451

6003## {data-background-image="/path/to/special_image.jpg"}

4452## {data-background-image="/path/to/special_image.jpg"}

6004

4453

6005−Slide 2 has a special image for its background, even though the heading has no content.

4454+Slide 2 has a special image for its background, even though the header has no content.

6006```

4455```

6007

4456

6008−# EPUBs

4457+Creating EPUBs with pandoc

4458+==========================

6009

4459

6010−## EPUB Metadata

4460+EPUB Metadata

4461+-------------

6011

4462

6012EPUB metadata may be specified using the `--epub-metadata` option, but

4463EPUB metadata may be specified using the `--epub-metadata` option, but

6013if the source document is Markdown, it is better to use a [YAML metadata

4464if the source document is Markdown, it is better to use a [YAML metadata

@@ -6085,20 +4536,11 @@ The following fields are recognized:

6085

4536

6086`rights`

4537`rights`

6087 ~ A string value.

4538 ~ 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.

6097

4539

6098`cover-image`

4540`cover-image`

6099 ~ A string value (path to cover image).

4541 ~ A string value (path to cover image).

6100

4542

6101−`css` (or legacy: `stylesheet`)

4543+`stylesheet`

6102 ~ A string value (path to CSS stylesheet).

4544 ~ A string value (path to CSS stylesheet).

6103

4545

6104`page-progression-direction`

4546`page-progression-direction`

@@ -6115,200 +4557,32 @@ The following fields are recognized:

6115 - `binding`: `true`|`false` (default `true`)

4557 - `binding`: `true`|`false` (default `true`)

6116 - `scroll-axis`: `vertical`|`horizontal`|`default`

4558 - `scroll-axis`: `vertical`|`horizontal`|`default`

6117

4559

6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html

4560+[MARC relators]: http://loc.gov/marc/relators/relaterm.html

6119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem

4561[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem

6120

4562

6121−## The `epub:type` attribute

6122−

6123−For `epub3` output, you can mark up the heading that corresponds to an EPUB

6124−chapter using the [`epub:type` attribute][epub-type]. For example, to set

6125−the attribute to the value `prologue`, use this markdown:

6126−

6127− # My chapter {epub:type=prologue}

6128−

6129−Which will result in:

6130−

6131− <body epub:type="frontmatter">

6132− <section epub:type="prologue">

6133− <h1>My chapter</h1>

6134−

6135−Pandoc will output `<body epub:type="bodymatter">`, unless

6136−you use one of the following values, in which case either

6137−`frontmatter` or `backmatter` will be output.

6138−

6139−`epub:type` of first section `epub:type` of body

6140−---------------------------- ------------------

6141−prologue frontmatter

6142−abstract frontmatter

6143−acknowledgments frontmatter

6144−copyright-page frontmatter

6145−dedication 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

6156−foreword frontmatter

6157−preface frontmatter

6158−appendix backmatter

6159−colophon backmatter

6160−bibliography backmatter

6161−index backmatter

6162−

6163−[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute

6164−

6165−## Linked media

4563+Linked media

6166−

4564+------------

4565+

6167−By default, pandoc will download media referenced from any `<img>`, `<audio>`,

4566+By default, pandoc will download linked media (including audio and

6168−`<video>` or `<source>` element present in the generated EPUB,

6169−and include it in the EPUB container, yielding a completely

4567+video) and include it in the EPUB container, yielding a completely

6170self-contained EPUB. If you want to link to external media resources

4568self-contained EPUB. If you want to link to external media resources

6171instead, use raw HTML in your source and add `data-external="1"` to the tag

4569instead, use raw HTML in your source and add `data-external="1"` to the tag

6172with the `src` attribute. For example:

4570with the `src` attribute. For example:

6173

4571

6174 <audio controls="1">

4572 <audio controls="1">

6175− <source src="https://example.com/music/toccata.mp3"

4573+ <source src="http://example.com/music/toccata.mp3"

6176 data-external="1" type="audio/mpeg">

4574 data-external="1" type="audio/mpeg">

6177 </source>

4575 </source>

6178 </audio>

4576 </audio>

6179

4577

6180−# Jupyter notebooks

6181−

6182−When creating a [Jupyter notebook], pandoc will try to infer the

6183−notebook structure. Code blocks with the class `code` will be

6184−taken as code cells, and intervening content will be taken as

6185−Markdown cells. Attachments will automatically be created for

6186−images in Markdown cells. Metadata will be taken from the

6187−`jupyter` metadata field. For example:

6188−

6189−````

6190−---

6191−title: My notebook

6192−jupyter:

6193− nbformat: 4

6194− nbformat_minor: 5

6195− kernelspec:

6196− display_name: Python 2

6197− language: python

6198− name: python2

6199− language_info:

6200− codemirror_mode:

6201− name: ipython

6202− version: 2

6203− file_extension: ".py"

6204− mimetype: "text/x-python"

6205− name: "python"

6206− nbconvert_exporter: "python"

6207− pygments_lexer: "ipython2"

6208− version: "2.7.15"

6209−---

6210−

6211−# Lorem ipsum

6212−

6213−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus

6214−bibendum felis dictum sodales.

6215−

6216−``` code

6217−print("hello")

6218−```

6219−

6220−## Pyout

6221−

6222−``` code

6223−from IPython.display import HTML

6224−HTML("""

6225−<script>

6226−console.log("hello");

6227−</script>

6228−<b>HTML</b>

6229−""")

6230−```

6231−

6232−## Image

6233−

6234−This image ![image](myimage.png) will be

6235−included as a cell attachment.

6236−````

6237−

6238−If you want to add cell attributes, group cells differently, or

6239−add output to code cells, then you need to include divs to

6240−indicate the structure. You can use either [fenced

6241−divs][Extension: `fenced_divs`] or [native divs][Extension:

6242−`native_divs`] for this. Here is an example:

6243−

6244−````

6245−:::::: {.cell .markdown}

6246−# Lorem

6247−

6248−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus

6249−bibendum felis dictum sodales.

6250−::::::

6251−

6252−:::::: {.cell .code execution_count=1}

6253−``` {.python}

6254−print("hello")

6255−```

6256−

6257−::: {.output .stream .stdout}

6258−```

6259−hello

6260−```

6261−:::

6262−::::::

6263−

6264−:::::: {.cell .code execution_count=2}

6265−``` {.python}

6266−from IPython.display import HTML

6267−HTML("""

6268−<script>

6269−console.log("hello");

6270−</script>

6271−<b>HTML</b>

6272−""")

6273−```

6274−

6275−::: {.output .execute_result execution_count=2}

6276−```{=html}

6277−<script>

6278−console.log("hello");

6279−</script>

6280−<b>HTML</b>

6281−hello

6282−```

6283−:::

6284−::::::

6285−````

6286−

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

4578+Syntax highlighting

4579+===================

6306

4580

6307Pandoc will automatically highlight syntax in [fenced code blocks] that

4581Pandoc will automatically highlight syntax in [fenced code blocks] that

6308are marked with a language name. The Haskell library [skylighting] is

4582are marked with a language name. The Haskell library [skylighting] is

6309−used for highlighting. Currently highlighting is supported only for

6310−HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names

4583+used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.

4584+To see a list of language names that pandoc will recognize, type

6311−that pandoc will recognize, type `pandoc --list-highlight-languages`.

4585+`pandoc --list-highlight-languages`.

6312

4586

6313The color scheme can be selected using the `--highlight-style` option.

4587The color scheme can be selected using the `--highlight-style` option.

6314The default color scheme is `pygments`, which imitates the default color

4588The default color scheme is `pygments`, which imitates the default color

@@ -6316,80 +4590,15 @@ scheme used by the Python library pygments (though pygments is not actually

6316used to do the highlighting). To see a list of highlight styles,

4590used to do the highlighting). To see a list of highlight styles,

6317type `pandoc --list-highlight-styles`.

4591type `pandoc --list-highlight-styles`.

6318

4592

6319−If you are not satisfied with the predefined styles, you can

6320−use `--print-highlight-style` to generate a JSON `.theme` file which

6321−can be modified and used as the argument to `--highlight-style`. To

6322−get a JSON version of the `pygments` style, for example:

6323−

6324− pandoc --print-highlight-style pygments > my.theme

6325−

6326−Then edit `my.theme` and use it like this:

6327−

6328− pandoc --highlight-style my.theme

6329−

6330−If you are not satisfied with the built-in highlighting, or you

6331−want highlight a language that isn't supported, you can use the

6332−`--syntax-definition` option to load a [KDE-style XML syntax definition

6333−file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).

6334−Before writing your own, have a look at KDE's [repository of syntax

6335−definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).

6336−

6337To disable highlighting, use the `--no-highlight` option.

4593To disable highlighting, use the `--no-highlight` option.

6338

4594

6339[skylighting]: https://github.com/jgm/skylighting

4595[skylighting]: https://github.com/jgm/skylighting

6340

4596

6341−# Custom Styles

4597+Custom Styles in Docx

6342−

4598+=====================

6343−Custom styles can be used in the docx and ICML formats.

6344−

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

4599

6390−[pandoc filters]: https://pandoc.org/filters.html

6391−

6392−## Input

4600+Input

4601+-----

6393

4602

6394The docx reader, by default, only reads those styles that it can

4603The docx reader, by default, only reads those styles that it can

6395convert into pandoc elements, either by direct conversion or

4604convert into pandoc elements, either by direct conversion or

@@ -6418,17 +4627,17 @@ And with the extension:

6418

4627

6419 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown

4628 $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown

6420

4629

6421− ::: {custom-style="First Paragraph"}

4630+ ::: {custom-style="FirstParagraph"}

6422 This is some text.

4631 This is some text.

6423 :::

4632 :::

6424

4633

6425− ::: {custom-style="Body Text"}

4634+ ::: {custom-style="BodyText"}

6426 This is text with an [emphasized]{custom-style="Emphatic"} text style.

4635 This is text with an [emphasized]{custom-style="Emphatic"} text style.

6427 And this is text with a [strengthened]{custom-style="Strengthened"}

4636 And this is text with a [strengthened]{custom-style="Strengthened"}

6428 text style.

4637 text style.

6429 :::

4638 :::

6430

4639

6431− ::: {custom-style="My Block Style"}

4640+ ::: {custom-style="MyBlockStyle"}

6432 > Here is a styled paragraph that inherits from Block Text.

4641 > Here is a styled paragraph that inherits from Block Text.

6433 :::

4642 :::

6434

4643

@@ -6436,85 +4645,75 @@ With these custom styles, you can use your input document as a

6436reference-doc while creating docx output (see below), and maintain the

4645reference-doc while creating docx output (see below), and maintain the

6437same styles in your input and output files.

4646same styles in your input and output files.

6438

4647

4648+Output

4649+------

4650+

4651+By default, pandoc's docx output applies a predefined set of styles for

4652+blocks such as paragraphs and block quotes, and uses largely default

4653+formatting (italics, bold) for inlines. This will work for most

4654+purposes, especially alongside a `reference.docx` file. However, if you

4655+need to apply your own styles to blocks, or match a preexisting set of

4656+styles, pandoc allows you to define custom styles for blocks and text

4657+using `div`s and `span`s, respectively.

4658+

4659+If you define a `div` or `span` with the attribute `custom-style`,

4660+pandoc will apply your specified style to the contained elements. So,

4661+for example using the `bracketed_spans` syntax,

4662+

4663+ [Get out]{custom-style="Emphatically"}, he said.

4664+

4665+would produce a docx file with "Get out" styled with character

4666+style `Emphatically`. Similarly, using the `fenced_divs` syntax,

4667+

4668+ Dickinson starts the poem simply:

4669+

4670+ ::: {custom-style="Poetry"}

4671+ | A Bird came down the Walk---

4672+ | He did not know I saw---

4673+ :::

4674+

4675+would style the two contained lines with the `Poetry` paragraph style.

4676+

4677+If the styles are not yet in your reference.docx, they will be defined

4678+in the output file as inheriting from normal text. If they are already

4679+defined, pandoc will not alter the definition.

4680+

4681+This feature allows for greatest customization in conjunction with

4682+[pandoc filters]. If you want all paragraphs after block quotes to be

4683+indented, you can write a filter to apply the styles necessary. If you

4684+want all italics to be transformed to the `Emphasis` character style

4685+(perhaps to change their color), you can write a filter which will

4686+transform all italicized inlines to inlines within an `Emphasis`

4687+custom-style `span`.

4688+

4689+[pandoc filters]: http://pandoc.org/filters.html

4690+

6439−# Custom writers

4691+Custom writers

4692+==============

6440

4693

6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc

4694+Pandoc can be extended with custom writers written in [lua]. (Pandoc

6442−includes a Lua interpreter, so Lua need not be installed separately.)

4695+includes a lua interpreter, so lua need not be installed separately.)

6443

4696

6444−To use a custom writer, simply specify the path to the Lua script

4697+To use a custom writer, simply specify the path to the lua script

6445in place of the output format. For example:

4698in place of the output format. For example:

6446

4699

6447 pandoc -t data/sample.lua

4700 pandoc -t data/sample.lua

6448

4701

6449−Creating a custom writer requires writing a Lua function for each

4702+Creating a custom writer requires writing a lua function for each

6450possible element in a pandoc document. To get a documented example

4703possible element in a pandoc document. To get a documented example

6451which you can modify according to your needs, do

4704which you can modify according to your needs, do

6452

4705

6453 pandoc --print-default-data-file sample.lua

4706 pandoc --print-default-data-file sample.lua

6454

4707

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

4708+[lua]: http://www.lua.org

6463−

4709+

6464−# Reproducible builds

6465−

6466−Some of the document formats pandoc targets (such as EPUB,

6467−docx, and ODT) include build timestamps in the generated document.

6468−That means that the files generated on successive builds will

6469−differ, even if the source does not. To avoid this, set the

6470−`SOURCE_DATE_EPOCH` environment variable, and the timestamp will

6471−be taken from it instead of the current time.

6472−`SOURCE_DATE_EPOCH` should contain an integer unix timestamp

6473−(specifying the number of second since midnight UTC January 1, 1970).

6474−

6475−Some document formats also include a unique identifier. For

6476−EPUB, this can be set explicitly by setting the `identifier`

6477−metadata field (see [EPUB Metadata], above).

6478−

6479−# A note on security

6480−

6481−If you use pandoc to convert user-contributed content in a web

6482−application, here are some things to keep in mind:

6483−

6484−1. Although pandoc itself will not create or modify any files other

6485− than those you explicitly ask it create (with the exception

6486− of temporary files used in producing PDFs), a filter or custom

6487− writer could in principle do anything on your file system. Please

6488− audit filters and custom writers very carefully before using them.

6489−

6490−2. If your application uses pandoc as a Haskell library (rather than

6491− shelling out to the executable), it is possible to use it in a mode

6492− that fully isolates pandoc from your file system, by running the

6493− pandoc operations in the `PandocPure` monad. See the document

6494− [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)

6495− for more details.

6496−

6497−3. Pandoc's parsers can exhibit pathological performance on some

6498− corner cases. It is wise to put any pandoc operations under

6499− a timeout, to avoid DOS attacks that exploit these issues.

6500− If you are using the pandoc executable, you can add the

6501− command line options `+RTS -M512M -RTS` (for example) to limit

6502− the heap size to 512MB.

6503−

6504−4. The HTML generated by pandoc is not guaranteed to be safe.

6505− If `raw_html` is enabled for the Markdown input, users can

6506− 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.

6510−

6511−# Authors

4710+Authors

6512−

4711+=======

4712+

6514under the [GPL], version 2 or greater. This software carries no

4714under the [GPL], version 2 or greater. This software carries no

6515warranty of any kind. (See COPYRIGHT for full copyright and

4715warranty of any kind. (See COPYRIGHT for full copyright and

6516warranty notices.) For a full list of contributors, see the file

4716warranty notices.) For a full list of contributors, see the file

6517AUTHORS.md in the pandoc source code.

4717AUTHORS.md in the pandoc source code.

6518

4718

6519−[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"

4719+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

6520−[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"

Makefile+63−89

@@ -1,79 +1,39 @@

1version?=$(shell grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')

2pandoc=$(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')

4BRANCH?=master

5−ARCH=$(shell uname -m)

5+RESOLVER=lts-10

6−DOCKERIMAGE=registry.gitlab.b-data.ch/ghc/ghc4pandoc:8.10.4

6+GHCOPTS=-fdiagnostics-color=always -Wall -fno-warn-unused-do-bind -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances

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

17WEBSITE=../../web/pandoc.org

7WEBSITE=../../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)",)

24quick:

9quick:

25− stack install --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --ghc-options='$(GHCOPTS)' --test-arguments='-j4 --hide-successes $(TESTARGS)'

10+ stack install --resolver=$(RESOLVER) --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --test-arguments='-j4 --hide-successes $(TESTARGS)'

26−

27−quick-cabal:

28− cabal new-configure . --ghc-options '$(GHCOPTS)' --disable-optimization --enable-tests

29− cabal new-build -j4 . --disable-optimization

30− cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)

31−

32−full-cabal:

33− cabal new-configure . --ghc-options '$(GHCOPTS)' --flags '+embed_data_files +trypandoc' --enable-tests --enable-benchmarks

34− cabal new-build . --disable-optimization

35− cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)

37full:

12full:

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)'

13+ 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)'

39−

40−ghci:

41− stack ghci --flag 'pandoc:embed_data_files'

43haddock:

15haddock:

44− stack haddock

16+ stack haddock --resolver=$(RESOLVER)

46# Note: to accept current results of golden tests,

18# Note: to accept current results of golden tests,

47# make test TESTARGS='--accept'

19# make test TESTARGS='--accept'

48test:

20test:

49− stack test --flag 'pandoc:embed_data_files' --fast --test-arguments='-j4 --hide-successes $(TESTARGS)' --ghc-options '$(GHCOPTS)'

21+ stack test --resolver=$(RESOLVER) --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"

57bench:

23bench:

58− stack bench \

59− --ghc-options '$(GHCOPTS)' \

60− --benchmark-arguments='$(BENCHARGS)' 2>&1 | \

24+ stack bench --benchmark-arguments='$(BENCHARGS)' --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)'

61− tee "bench_latest.txt"

25+

26+weigh:

27+ stack build --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)' --flag 'pandoc:weigh-pandoc' && stack exec weigh-pandoc

63reformat:

29reformat:

64 for f in $(SOURCEFILES); do echo $$f; stylish-haskell -i $$f ; done

30 for f in $(SOURCEFILES); do echo $$f; stylish-haskell -i $$f ; done

66−lint: hlint fix_spacing

32+lint:

67−

68−hlint:

69− for f in $(SOURCEFILES); do echo $$f; hlint --verbose --refactor --refactor-options='-s -o -' $$f; done

33+ for f in $(SOURCEFILES); do echo $$f; hlint --verbose --refactor --refactor-options='-i -s' $$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

75changes_github:

35changes_github:

76− pandoc --filter tools/extract-changes.hs changelog.md -t gfm --wrap=none --template tools/changes_template.html | sed -e 's/\\#/#/g' | pbcopy

36+ pandoc --filter tools/extract-changes.hs changelog -t gfm --wrap=none | sed -e 's/\\#/#/g' | pbcopy

78dist: man/pandoc.1

38dist: man/pandoc.1

79 cabal sdist

39 cabal sdist

@@ -82,34 +42,58 @@ dist: man/pandoc.1

82 cd pandoc-${version}

42 cd pandoc-${version}

83 stack setup && stack test && cd .. && rm -rf "pandoc-${version}"

43 stack setup && stack test && cd .. && rm -rf "pandoc-${version}"

85−check: checkdocs check-cabal

45+packages: checkdocs winpkg debpkg macospkg

87−checkdocs:

47+checkdocs: README.md

88− ! grep -q -n -e "\t" MANUAL.txt changelog.md

48+ ! grep -n -e "\t" MANUAL.txt changelog

90debpkg: man/pandoc.1

50debpkg: man/pandoc.1

91− docker run -v `pwd`:/mnt \

51+ make -C linux && \

92− -v `pwd`/linux/artifacts:/artifacts \

52+ cp linux/artifacts/pandoc-$(version)-*.* .

93− --user $(id -u):$(id -g) \

53+

94− -e REVISION=$(REVISION) \

54+macospkg: man/pandoc.1

95− -w /mnt \

55+ ./macos/make_macos_package.sh

96− --memory=0 \

56+

97− --rm \

57+winpkg: pandoc-$(version)-windows-i386.msi pandoc-$(version)-windows-i386.zip pandoc-$(version)-windows-x86_64.msi pandoc-$(version)-windows-x86_64.zip

98− $(DOCKERIMAGE) \

58+

99− bash \

59+pandoc-$(version)-windows-%.zip: pandoc-$(version)-windows-%.msi

100− /mnt/linux/make_artifacts.sh 2>&1 > docker.log

60+ -rm -rf wintmp && \

101−

61+ msiextract -C wintmp $< && \

62+ cd wintmp/"Program Files" && \

63+ mv Pandoc pandoc-$(version) && \

64+ zip -r $@ pandoc-$(version) && \

65+ mv $@ ../../ && \

66+ cd ../.. && \

67+ rm -rf wintmp

68+

69+pandoc-$(version)-windows-%.msi: pandoc-windows-%.msi

70+ osslsigncode sign -pkcs12 ~/Private/ComodoCodeSigning.exp2019.p12 -in $< -i http://johnmacfarlane.net/ -t http://timestamp.comodoca.com/ -out $@ -askpass

71+ rm $<

72+

73+pandoc-windows-i386.msi:

74+ JOBID=$(shell curl 'https://ci.appveyor.com/api/projects/jgm/pandoc' | jq -r '.build.jobs[0].jobId') && \

75+ wget "https://ci.appveyor.com/api/buildjobs/$$JOBID/artifacts/windows%2F$@" -O $@

76+

77+pandoc-windows-x86_64.msi:

78+ JOBID=$(shell curl 'https://ci.appveyor.com/api/projects/jgm/pandoc' | jq -r '.build.jobs[1].jobId') && \

79+ wget "https://ci.appveyor.com/api/buildjobs/$$JOBID/artifacts/windows%2F$@" -O $@

80+

102−man/pandoc.1: MANUAL.txt man/pandoc.1.before man/pandoc.1.after

81+man/pandoc.1: MANUAL.txt man/pandoc.1.template

103− pandoc $< -f markdown -t man -s \

82+ pandoc $< -f markdown-smart -t man -s --template man/pandoc.1.template \

104 --lua-filter man/manfilter.lua \

83 --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)" \

84+ --variable version="pandoc $(version)" \

109 -o $@

85 -o $@

110

87+doc/lua-filters.md: tools/ldoc.ltp data/pandoc.lua tools/update-lua-docs.lua

88+ cp $@ $@.tmp

89+ pandoc -t markdown --columns=64 --atx-headers \

90+ -f markdown -t markdown --standalone\

91+ --lua-filter tools/update-lua-docs.lua \

92+ -o $@ $@.tmp

93+ rm $@.tmp

94+

111README.md: README.template MANUAL.txt tools/update-readme.lua

95README.md: README.template MANUAL.txt tools/update-readme.lua

112− pandoc --lua-filter tools/update-readme.lua \

96+ pandoc --lua-filter tools/update-readme.lua --reference-links \

113 --reference-location=section -t gfm $< -o $@

97 --reference-location=section -t gfm $< -o $@

114

115download_stats:

99download_stats:

@@ -118,14 +102,14 @@ download_stats:

118

102

119pandoc-templates:

103pandoc-templates:

120 rm ../pandoc-templates/default.* ; \

104 rm ../pandoc-templates/default.* ; \

121− cp data/templates/* ../pandoc-templates/ ; \

105+ cp data/templates/default.* ../pandoc-templates/ ; \

122 pushd ../pandoc-templates/ && \

106 pushd ../pandoc-templates/ && \

123− git add * && \

107+ git add default.* && \

124 git commit -m "Updated templates for pandoc $(version)" && \

108 git commit -m "Updated templates for pandoc $(version)" && \

125 popd

109 popd

126

110

127trypandoc:

111trypandoc:

128− ssh -t macfarlane 'cd src/pandoc && git pull && stack install --flag pandoc:trypandoc --flag pandoc:embed_data_files && cd trypandoc && sudo make install'

112+ ssh -t macfarlane 'cd src/pandoc && git pull && ~/.local/bin/stack install --flag pandoc:trypandoc --flag pandoc:embed_data_files && cd trypandoc && sudo make install'

129

113

130update-website:

114update-website:

131 make -C $(WEBSITE) update

115 make -C $(WEBSITE) update

@@ -135,14 +119,4 @@ update-website:

135clean:

119clean:

136 stack clean

120 stack clean

137

121

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

122+.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+108−148

@@ -8,83 +8,65 @@ pandoc --lua-filter tools/update-readme.lua README.template -o README.md

8[![github

9release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)

10[![hackage

11−release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)

11+release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)

12−[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](https://formulae.brew.sh/formula/pandoc)

12+[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc)

13[![stackage LTS

14−package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)

14+package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)

15−[![CI

15+[![travis build

16−tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)

16+status](https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build)](https://travis-ci.org/jgm/pandoc)

17+[![appveyor build

18+status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)

17[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)

19[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)

18[![pandoc-discuss on google

20[![pandoc-discuss on google

19groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)

21groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)

21## The universal markup converter

23## The universal markup converter

23−Pandoc is a [Haskell](https://haskell.org) library for converting from

25+Pandoc is a \[Haskell\] library for converting from one markup format to

24−one markup format to another, and a command-line tool that uses this

26+another, and a command-line tool that uses this library. It can convert

25−library. It can convert *from*

27+*from*

27<div id="input-formats">

29<div id="input-formats">

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)

31+ - `commonmark` ([CommonMark](http://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))

32+ - `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))

33+ - `docbook` ([DocBook](http://docbook.org))

40−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

34+ - `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))

35+ - `epub` ([EPUB](http://idpf.org/epub))

43−- `fb2`

44− ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)

45− e-book)

46−- `gfm` ([GitHub-Flavored

36+ - `gfm` ([GitHub-Flavored

47 Markdown](https://help.github.com/articles/github-flavored-markdown/)),

37 Markdown](https://help.github.com/articles/github-flavored-markdown/)),

48− or the deprecated and less accurate `markdown_github`; use

38+ or `markdown_github`, which provides deprecated and less accurate

49− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)

39+ support for Github-Flavored Markdown; please use `gfm` instead,

50− only if you need extensions not supported in

40+ unless you need to use extensions other than `smart`.

51− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).

52−- `haddock` ([Haddock

41+ - `haddock` ([Haddock

53 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

42 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

54−- `html` ([HTML](https://www.w3.org/html/))

43+ - `html` ([HTML](http://www.w3.org/html/))

55−- `ipynb` ([Jupyter

56− notebook](https://nbformat.readthedocs.io/en/latest/))

57−- `jats` ([JATS](https://jats.nlm.nih.gov) XML)

44+ - `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)

45+ - `json` (JSON version of native AST)

62−- `latex` ([LaTeX](https://www.latex-project.org/))

46+ - `latex` ([LaTeX](http://latex-project.org))

63−- `markdown` ([Pandoc’s

47+ - `markdown` ([Pandoc’s Markdown](#pandocs-markdown))

64− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))

65−- `markdown_mmd`

48+ - `markdown_mmd`

66− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))

49+ ([MultiMarkdown](http://fletcherpenney.net/multimarkdown/))

67−- `markdown_phpextra` ([PHP Markdown

50+ - `markdown_phpextra` ([PHP Markdown

68 Extra](https://michelf.ca/projects/php-markdown/extra/))

51 Extra](https://michelf.ca/projects/php-markdown/extra/))

69−- `markdown_strict` (original unextended

52+ - `markdown_strict` (original unextended

70− [Markdown](https://daringfireball.net/projects/markdown/))

53+ [Markdown](http://daringfireball.net/projects/markdown/))

71−- `mediawiki` ([MediaWiki

54+ - `mediawiki` ([MediaWiki

72 markup](https://www.mediawiki.org/wiki/Help:Formatting))

55 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))

56+ - `muse` ([Muse](https://amusewiki.org/library/manual))

75−- `native` (native Haskell)

57+ - `native` (native Haskell)

76−- `odt` ([ODT](https://en.wikipedia.org/wiki/OpenDocument))

58+ - `odt` ([ODT](http://en.wikipedia.org/wiki/OpenDocument))

77−- `opml` ([OPML](http://dev.opml.org/spec2.html))

59+ - `opml` ([OPML](http://dev.opml.org/spec2.html))

78−- `org` ([Emacs Org mode](https://orgmode.org))

60+ - `org` ([Emacs Org mode](http://orgmode.org))

79−- `rst`

61+ - `rst`

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

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

81−- `t2t` ([txt2tags](https://txt2tags.org))

63+ - `t2t` ([txt2tags](http://txt2tags.org))

82−- `textile` ([Textile](https://www.promptworks.com/textile))

64+ - `textile` ([Textile](http://redcloth.org/textile))

83−- `tikiwiki` ([TikiWiki

65+ - `tikiwiki` ([TikiWiki

84 markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))

66 markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))

85−- `twiki` ([TWiki

67+ - `twiki` ([TWiki

86− markup](https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))

68+ markup](http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))

87−- `vimwiki` ([Vimwiki](https://vimwiki.github.io))

69+ - `vimwiki` ([Vimwiki](https://vimwiki.github.io))

89</div>

71</div>

@@ -92,102 +74,80 @@ It can convert *to*

93<div id="output-formats">

75<div id="output-formats">

95−- `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or

77+ - `asciidoc` ([AsciiDoc](http://www.methods.co.nz/asciidoc/))

96− `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))

97−- `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)

78+ - `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)

79+ - `commonmark` ([CommonMark](http://commonmark.org) Markdown)

101−- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with

102− extensions)

103−- `context` ([ConTeXt](https://www.contextgarden.net/))

80+ - `context` ([ConTeXt](http://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)

81+ - `docbook` or `docbook4` ([DocBook](http://docbook.org) 4)

108−- `docbook5` (DocBook 5)

82+ - `docbook5` (DocBook 5)

109−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

83+ - `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

110−- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

84+ - `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

111−- `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)

85+ - `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)

112−- `epub2` (EPUB v2)

86+ - `epub2` (EPUB v2)

113−- `fb2`

87+ - `fb2`

114 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)

88 ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)

115 e-book)

89 e-book)

116−- `gfm` ([GitHub-Flavored

90+ - `gfm` ([GitHub-Flavored

117 Markdown](https://help.github.com/articles/github-flavored-markdown/)),

91 Markdown](https://help.github.com/articles/github-flavored-markdown/)),

118− or the deprecated and less accurate `markdown_github`; use

92+ or `markdown_github`, which provides deprecated and less accurate

119− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)

93+ support for Github-Flavored Markdown; please use `gfm` instead,

120− only if you need extensions not supported in

94+ unless you use extensions that do not work with `gfm`.

121− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).

122−- `haddock` ([Haddock

95+ - `haddock` ([Haddock

123 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

96 markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

124−- `html` or `html5` ([HTML](https://www.w3.org/html/),

97+ - `html` or `html5` ([HTML](http://www.w3.org/html/), i.e.

125− i.e. [HTML5](https://html.spec.whatwg.org/)/XHTML [polyglot

98+ [HTML5](http://www.w3.org/TR/html5/)/XHTML [polyglot

126 markup](https://www.w3.org/TR/html-polyglot/))

99 markup](https://www.w3.org/TR/html-polyglot/))

127−- `html4` ([XHTML](https://www.w3.org/TR/xhtml1/) 1.0 Transitional)

100+ - `html4` ([XHTML](http://www.w3.org/TR/xhtml1/) 1.0 Transitional)

128−- `icml` ([InDesign

101+ - `icml` ([InDesign

129− ICML](https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))

102+ ICML](http://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))

130−- `ipynb` ([Jupyter

131− 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,

103+ - `jats` ([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)

104+ - `json` (JSON version of native AST)

143−- `latex` ([LaTeX](https://www.latex-project.org/))

105+ - `latex` ([LaTeX](http://latex-project.org))

144−- `man` ([roff man](https://man.cx/groff_man(7)))

106+ - `man` ([groff

107+ man](http://man7.org/linux/man-pages/man7/groff_man.7.html))

145−- `markdown` ([Pandoc’s

108+ - `markdown` ([Pandoc’s Markdown](#pandocs-markdown))

146− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))

147−- `markdown_mmd`

109+ - `markdown_mmd`

148− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))

110+ ([MultiMarkdown](http://fletcherpenney.net/multimarkdown/))

149−- `markdown_phpextra` ([PHP Markdown

111+ - `markdown_phpextra` ([PHP Markdown

150 Extra](https://michelf.ca/projects/php-markdown/extra/))

112 Extra](https://michelf.ca/projects/php-markdown/extra/))

151−- `markdown_strict` (original unextended

113+ - `markdown_strict` (original unextended

152− [Markdown](https://daringfireball.net/projects/markdown/))

114+ [Markdown](http://daringfireball.net/projects/markdown/))

153−- `mediawiki` ([MediaWiki

115+ - `mediawiki` ([MediaWiki

154 markup](https://www.mediawiki.org/wiki/Help:Formatting))

116 markup](https://www.mediawiki.org/wiki/Help:Formatting))

117+ - `ms` ([groff

155−- `ms` ([roff ms](https://man.cx/groff_ms(7)))

118+ ms](http://man7.org/linux/man-pages/man7/groff_ms.7.html))

156−- `muse` ([Muse](https://amusewiki.org/library/manual)),

119+ - `muse` ([Muse](https://amusewiki.org/library/manual)),

157−- `native` (native Haskell),

120+ - `native` (native Haskell),

158−- `odt` ([OpenOffice text

121+ - `odt` ([OpenOffice text

159− document](https://en.wikipedia.org/wiki/OpenDocument))

122+ document](http://en.wikipedia.org/wiki/OpenDocument))

160−- `opml` ([OPML](http://dev.opml.org/spec2.html))

123+ - `opml` ([OPML](http://dev.opml.org/spec2.html))

161−- `opendocument` ([OpenDocument](http://opendocument.xml.org))

124+ - `opendocument` ([OpenDocument](http://opendocument.xml.org))

162−- `org` ([Emacs Org mode](https://orgmode.org))

125+ - `org` ([Emacs Org mode](http://orgmode.org))

163−- `pdf` ([PDF](https://www.adobe.com/pdf/))

164−- `plain` (plain text),

126+ - `plain` (plain text),

165−- `pptx`

127+ - `pptx`

166 ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)

128 ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)

167 slide show)

129 slide show)

168−- `rst`

130+ - `rst`

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

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

170−- `rtf` ([Rich Text

132+ - `rtf` ([Rich Text

171− Format](https://en.wikipedia.org/wiki/Rich_Text_Format))

133+ Format](http://en.wikipedia.org/wiki/Rich_Text_Format))

172−- `texinfo` ([GNU Texinfo](https://www.gnu.org/software/texinfo/))

134+ - `texinfo` ([GNU Texinfo](http://www.gnu.org/software/texinfo/))

173−- `textile` ([Textile](https://www.promptworks.com/textile))

135+ - `textile` ([Textile](http://redcloth.org/textile))

174−- `slideous` ([Slideous](https://goessner.net/articles/slideous/) HTML

136+ - `slideous` ([Slideous](http://goessner.net/articles/slideous/) HTML

175 and JavaScript slide show)

137 and JavaScript slide show)

176−- `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and

138+ - `slidy` ([Slidy](http://www.w3.org/Talks/Tools/Slidy/) HTML and

177 JavaScript slide show)

139 JavaScript slide show)

178−- `dzslides` ([DZSlides](https://paulrouget.com/dzslides/) HTML5 +

140+ - `dzslides` ([DZSlides](http://paulrouget.com/dzslides/) HTML5 +

179 JavaScript slide show),

141 JavaScript slide show),

180−- `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript

142+ - `revealjs` ([reveal.js](http://lab.hakim.se/reveal-js/) HTML5 +

181− slide show)

143+ JavaScript slide show)

182−- `s5` ([S5](https://meyerweb.com/eric/tools/s5/) HTML and JavaScript

144+ - `s5` ([S5](http://meyerweb.com/eric/tools/s5/) HTML and JavaScript

183 slide show)

145 slide show)

184−- `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))

146+ - `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

147+ - `zimwiki` ([ZimWiki

188− markup](https://zim-wiki.org/manual/Help/Wiki_Syntax.html))

148+ markup](http://zim-wiki.org/manual/Help/Wiki_Syntax.html))

189−- the path of a custom Lua writer, see [Custom

149+ - the path of a custom lua writer, see [Custom

190− writers](https://pandoc.org/MANUAL.html#custom-writers) below

150+ writers](#custom-writers) below

191

151

192</div>

152</div>

193

153

@@ -205,7 +165,7 @@ convert this native representation into a target format. Thus, adding an

205input or output format requires only adding a reader or writer. Users

165input or output format requires only adding a reader or writer. Users

206can also run custom pandoc filters to modify the intermediate AST (see

166can also run custom pandoc filters to modify the intermediate AST (see

207the documentation for [filters](https://pandoc.org/filters.html) and

167the documentation for [filters](https://pandoc.org/filters.html) and

208−[Lua filters](https://pandoc.org/lua-filters.html)).

168+[lua filters](https://pandoc.org/lua-filters.html)).

209

169

210Because pandoc’s intermediate representation of a document is less

170Because pandoc’s intermediate representation of a document is less

211expressive than many of the formats it converts between, one should not

171expressive than many of the formats it converts between, one should not

@@ -238,7 +198,7 @@ opening a new issue.

238

198

239## License

199## License

240

200

242−[GPL](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"),

202+[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),

243version 2 or greater. This software carries no warranty of any kind.

203version 2 or greater. This software carries no warranty of any kind.

244(See COPYRIGHT for full copyright and warranty notices.)

204(See COPYRIGHT for full copyright and warranty notices.)

README.template+8−8

@@ -7,10 +7,11 @@ Pandoc

7======

9[![github release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)

10−[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)

10+[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)

11−[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](https://formulae.brew.sh/formula/pandoc)

11+[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc)

12−[![stackage LTS package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)

12+[![stackage LTS package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)

13−[![CI tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)

13+[![travis build status](https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build)](https://travis-ci.org/jgm/pandoc)

14+[![appveyor build status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)

14[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)

15[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)

15[![pandoc-discuss on google groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)

16[![pandoc-discuss on google groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)

@@ -43,7 +44,7 @@ this native representation into a target format. Thus, adding an input

43or output format requires only adding a reader or writer. Users can also

44or output format requires only adding a reader or writer. Users can also

44run custom pandoc filters to modify the intermediate AST (see

45run custom pandoc filters to modify the intermediate AST (see

45the documentation for [filters](https://pandoc.org/filters.html)

46the 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)).

48Because pandoc's intermediate representation of a document is less

49Because pandoc's intermediate representation of a document is less

49expressive than many of the formats it converts between, one should

50expressive than many of the formats it converts between, one should

@@ -81,9 +82,8 @@ new issue.

81License

82License

82-------

83-------

85[GPL], version 2 or greater. This software carries no warranty of

86[GPL], version 2 or greater. This software carries no warranty of

86any kind. (See COPYRIGHT for full copyright and warranty notices.)

87any kind. (See COPYRIGHT for full copyright and warranty notices.)

88−[GPL]: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"

89+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

89−[Haskell]: https://haskell.org

RELEASE-CHECKLIST+3−6

@@ -1,12 +1,9 @@

1−[ ] use 'policeman' to check API changes and version update

2[ ] make README.md and commit if needed

1[ ] make README.md and commit if needed

3[ ] make man/pandoc.1 and commit if needed

2[ ] make man/pandoc.1 and commit if needed

4[ ] Finalize changelog

3[ ] Finalize changelog

5−[ ] push release candidate branch rc/VERSION and (if it builds

4+ git log --pretty='format:%n%n* %s (%an)%n%b%n%h%n' \

6− successfully) download artifacts

5+ --reverse --name-only LASTRELEASE..HEAD > LOG

7−[ ] run tools/build-arm.sh to create and download arm64 linux package

6+[ ] make packages

8−[ ] download macos artifacts from CircleCI

9−[ ] Use 'make' in macos and windows artifacts to sign code

10[ ] make update-website

7[ ] make update-website

11[ ] make trypandoc

8[ ] make trypandoc

12[ ] Tag release in git

9[ ] Tag release in git

RELEASE-CHECKLIST.mdnew file+27

@@ -0,0 +1,27 @@

1+- [ ] Test, on Linux, Windows, macOS (inc. website demos)

3+- [ ] Finalize changelog:

4+ `git log --pretty='format:%n%n* %s (%an)%n%b%n%h%n' --reverse --name-only 1.17.0.3..HEAD > LOG`

6+- [ ] `make man/pandoc.1` and commit if needed

8+- [ ] Tag release in git

10+- [ ] Tag templates

11+

12+- [ ] Generate Windows package (`make winpkg`)

13+

14+- [ ] Generate macOS package (`make macospkg`)

15+

16+- [ ] Generate Ubuntu/Debian deb package (`make debpkg`)

17+

18+- [ ] Add release on github (use `make changes_github` and upload files)

19+

20+- [ ] Upload to HackageDB

21+

22+- [ ] Update website (`make update`), including short description of changes (`make changes`)

23+

24+- [ ] on server, `cabal install --enable-tests -ftrypandoc`

25+ and then `cd trypandoc; sudo make install`

26+

27+- [ ] Announce on pandoc-announce, pandoc-discuss

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.

Setup.hs+37−1

@@ -1,2 +1,38 @@

1+{-

4+This program is free software; you can redistribute it and/or modify

5+it under the terms of the GNU General Public License as published by

6+the Free Software Foundation; either version 2 of the License, or

7+(at your option) any later version.

9+This program is distributed in the hope that it will be useful,

10+but WITHOUT ANY WARRANTY; without even the implied warranty of

11+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

12+GNU General Public License for more details.

13+

14+You should have received a copy of the GNU General Public License

15+along with this program; if not, write to the Free Software

16+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

17+-}

18+

1import Distribution.Simple

19import Distribution.Simple

2−main = defaultMain

20+import Distribution.Simple.Setup (CopyFlags(..), fromFlag)

21+import Distribution.PackageDescription (PackageDescription(..))

22+import Distribution.Simple.Utils (notice, installOrdinaryFiles)

23+import Distribution.Simple.LocalBuildInfo

24+

25+main :: IO ()

26+main = defaultMainWithHooks $ simpleUserHooks {

27+ postCopy = installManPage

28+ }

29+

30+installManPage :: Args -> CopyFlags

31+ -> PackageDescription -> LocalBuildInfo -> IO ()

32+installManPage _ flags pkg lbi = do

33+ let verbosity = fromFlag (copyVerbosity flags)

34+ let copydest = fromFlag (copyDest flags)

35+ let mandest = mandir (absoluteInstallDirs pkg lbi copydest)

36+ ++ "/man1"

37+ notice verbosity $ "Copying man page to " ++ mandest

38+ installOrdinaryFiles verbosity mandest [("man", "pandoc.1")]

app/pandoc.hsdeleted−20

@@ -1,20 +0,0 @@

1−{- |

2− Module : Main

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+79

@@ -0,0 +1,79 @@

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+ STACK_YAML: "c:\\pandoc\\stack.yaml"

7+ STACK_BUILD_OPTS: "-j1 --no-terminal --test --local-bin-path=.\\windows"

8+ # see #4201, https://github.com/haskell-tools/haskell-tools/issues/277

9+ matrix:

10+ - STACK_VERSION: "windows-i386"

11+ STACK_ROOT: "c:\\sr32"

12+ STACK: "%STACK_ROOT%\\stack.exe"

13+ STACK_FLAGS: "--flag=hslua:lua_32bits"

14+ - STACK_VERSION: "windows-x86_64"

15+ STACK_ROOT: "c:\\sr64"

16+ STACK: "%STACK_ROOT%\\stack.exe"

17+ STACK_FLAGS: ""

18+

19+skip_commits:

20+ files:

21+ - '*.md'

22+ - '*.txt'

23+ - '.travis.yml'

24+ - 'Makefile'

25+ - 'man/pandoc.1'

26+ - 'linux/*'

27+ - 'macos/*'

28+

29+matrix:

30+ fast_finish: true

31+

32+cache:

33+ - "%STACK_ROOT%"

34+ - "%WIXBIN%"

35+ # This is where stack install ghc by default, but we don't

36+ # cache it because it's too large:

37+ # - "c:\\Users\\appveyor\\AppData\\Local\\Programs\\stack"

38+

39+# Note: to reset build cache, do the following in JavaScript

40+# console on appveyor:

41+# $.ajax({ url: 'https://ci.appveyor.com/api/projects/jgm/pandoc/buildcache', type: 'DELETE'})

42+# We don't do a normal C build, but build in test_script via stack

43+build: off

44+

45+install:

46+ - '"%WIXBIN%"\candle -? || choco install wixtoolset'

47+ - |

48+ %STACK% --version || curl -ostack.zip -L --insecure http://www.stackage.org/stack/%STACK_VERSION% && 7z e stack.zip -o"%STACK_ROOT%" stack.exe

49+

50+# before_test:

51+

52+test_script:

53+ # The ugly echo "" hack is to avoid complaints about 0 being an invalid file

54+ # descriptor

55+ - |

56+ %STACK% setup > nul

57+ %STACK% path

58+ echo "" | %STACK% clean

59+ echo "" | %STACK% install %STACK_BUILD_OPTS% pandoc pandoc-citeproc %STACK_FLAGS%

60+

61+after_test:

62+ # .\ in the stack commandline seems to be .\windows\ (where the stack-appveyor.yaml is)

63+ - cd windows

64+ - .\pandoc.exe -s --toc ..\MANUAL.txt -o MANUAL.html

65+ - .\pandoc.exe -s ..\COPYING.md -o COPYING.rtf

66+ - copy ..\COPYRIGHT COPYRIGHT.txt

67+ - 7z a "pandoc-%STACK_VERSION%.zip" pandoc.exe pandoc-citeproc.exe MANUAL.html COPYING.rtf

68+ - |

69+ set VERSION=

70+ for /f "tokens=1-2 delims= " %%a in ('.\pandoc.exe --version') do ( if not defined VERSION set "VERSION=%%b" )

71+ echo %VERSION%

72+ "%WIXBIN%\\candle" -dVERSION=%VERSION% -dBINPATH=. *.wxs -out wixobj\

73+ "%WIXBIN%\\light" -sw1076 -ext WixUIExtension -ext WixUtilExtension -cultures:en-us -loc Pandoc-en-us.wxl -out "pandoc-%STACK_VERSION%.msi" wixobj\*.wixobj

74+

75+artifacts:

76+ - path: 'windows\pandoc-%STACK_VERSION%.zip'

77+ name: exe

78+ - path: 'windows\pandoc-%STACK_VERSION%.msi'

79+ name: msi

benchmark/benchmark-pandoc.hs+57−72

@@ -1,6 +1,7 @@

1−{-# LANGUAGE OverloadedStrings #-}

1+{-# LANGUAGE NoImplicitPrelude #-}

2+{-# LANGUAGE TupleSections #-}

2{-

3{-

5This program is free software; you can redistribute it and/or modify

6This program is free software; you can redistribute it and/or modify

6it under the terms of the GNU General Public License as published by

7it under the terms of the GNU General Public License as published by

@@ -16,88 +17,72 @@ You should have received a copy of the GNU General Public License

16along with this program; if not, write to the Free Software

17along with this program; if not, write to the Free Software

17Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

18Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

18-}

19-}

20+import Prelude

19import Text.Pandoc

21import Text.Pandoc

20−import Text.Pandoc.MIME

21−import Control.DeepSeq (force)

22−import Control.Monad.Except (throwError)

23import qualified Text.Pandoc.UTF8 as UTF8

22import qualified Text.Pandoc.UTF8 as UTF8

24import qualified Data.ByteString as B

23import qualified Data.ByteString as B

25−import qualified Data.Text as T

24+import Criterion.Main

26−import Test.Tasty.Bench

25+import Criterion.Types (Config(..))

27−-- import Gauge

26+import Data.List (intersect)

28−import qualified Data.ByteString.Lazy as BL

29import Data.Maybe (mapMaybe)

27import Data.Maybe (mapMaybe)

30−import Data.List (sortOn)

28+import System.Environment (getArgs)

32readerBench :: Pandoc

30readerBench :: Pandoc

33− -> T.Text

31+ -> String

34 -> Maybe Benchmark

32 -> Maybe Benchmark

35−readerBench _ name

33+readerBench doc 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

34+ case res of

35+ Right (readerFun, inp) ->

36+ Just $ bench (name ++ " reader")

37+ $ nf (\i -> either (error . show) id $ runPure (readerFun i))

38+ inp

39+ Left _ -> Nothing

40+ where res = runPure $ do

42− (TextReader r, TextWriter w) -> do

41+ (TextReader r, rexts)

43− inp <- w def{ writerWrapText = WrapAuto

42+ <- either (fail . show) return $ getReader name

44− , writerExtensions = wexts } doc

43+ (TextWriter w, wexts)

45− return $ bench (T.unpack name) $

44+ <- either (fail . show) return $ getWriter 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

45+ inp <- w def{ writerWrapText = WrapAuto, writerExtensions = wexts }

50− , writerExtensions = wexts

46+ doc

51− , writerTemplate = tmpl } doc

52− return $ bench (T.unpack name) $

53− nf (either (error . show) id .

54− runPure . r def{readerExtensions = rexts}) inp

47+ return (r def{ readerExtensions = rexts }, inp)

55− _ -> throwError $ PandocSomeError $ "text/bytestring format mismatch: "

56− <> name

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

49+writerBench :: Pandoc

67− -> T.Text

50+ -> String

68 -> Maybe Benchmark

51 -> Maybe Benchmark

69−writerBench _ _ name

52+writerBench doc 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

53+ case res of

75− TextWriter writerFun ->

54+ Right writerFun ->

76− return $ bench (T.unpack name)

55+ Just $ bench (name ++ " writer")

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)

84 $ nf (\d -> either (error . show) id $

56 $ nf (\d -> either (error . show) id $

57+ runPure (writerFun d)) doc

58+ _ -> Nothing

85− runPure $ do

59+ where res = runPure $ do

86− mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs

60+ (TextWriter w, wexts)

61+ <- either (fail . show) return $ getWriter name

87− writerFun def{ writerExtensions = wexts} d)

62+ return $ w def{ writerExtensions = wexts }

88− doc

90main :: IO ()

64main :: IO ()

91main = do

65main = do

66+ args <- filter (\x -> take 1 x /= "-") <$> getArgs

67+ print args

68+ let matchReader (n, TextReader _) =

69+ null args || ("reader" `elem` args && n `elem` args)

70+ matchReader _ = False

71+ let matchWriter (n, TextWriter _) =

72+ null args || ("writer" `elem` args && n `elem` args)

73+ matchWriter _ = False

74+ let matchedReaders = map fst $ (filter matchReader readers

75+ :: [(String, Reader PandocPure)])

76+ let matchedWriters = map fst $ (filter matchWriter writers

77+ :: [(String, Writer PandocPure)])

92 inp <- UTF8.toText <$> B.readFile "test/testsuite.txt"

78 inp <- UTF8.toText <$> B.readFile "test/testsuite.txt"

93 let opts = def

79 let opts = def

94− let doc = either (error . show) force $ runPure $ readMarkdown opts inp

80+ let doc = either (error . show) id $ 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)

81+ let readerBs = mapMaybe (readerBench doc)

101− (sortOn fst

82+ $ filter (/="haddock")

102− readers :: [(T.Text, Reader PandocPure)])

83+ (matchedReaders `intersect` matchedWriters)

103− ]

84+ -- we need the corresponding writer to generate

85+ -- input for the reader

86+ let writerBs = mapMaybe (writerBench doc) matchedWriters

87+ defaultMainWith defaultConfig{ timeLimit = 6.0 }

88+ (writerBs ++ readerBs)

benchmark/weigh-pandoc.hsnew file+40

@@ -0,0 +1,40 @@

1+{-# LANGUAGE NoImplicitPrelude #-}

2+import Prelude

3+import Weigh

4+import Text.Pandoc

5+import Data.Text (Text)

7+main :: IO ()

8+main = do

9+ doc <- read <$> readFile "test/testsuite.native"

10+ mainWith $ do

11+ func "Pandoc document" id doc

12+ mapM_

13+ (\(n,r) -> weighReader doc n (either (error . show) id . runPure . r def{readerExtensions = pandocExtensions}))

14+ [("markdown", readMarkdown)

15+ ,("html", readHtml)

16+ ,("docbook", readDocBook)

17+ ,("latex", readLaTeX)

18+ ,("commonmark", readCommonMark)

19+ ]

20+ mapM_

21+ (\(n,w) -> weighWriter doc n (either (error . show) id . runPure . w def))

22+ [("markdown", writeMarkdown)

23+ ,("html", writeHtml5String)

24+ ,("docbook", writeDocbook5)

25+ ,("latex", writeLaTeX)

26+ ,("commonmark", writeCommonMark)

27+ ]

28+

29+weighWriter :: Pandoc -> String -> (Pandoc -> Text) -> Weigh ()

30+weighWriter doc name writer = func (name ++ " writer") writer doc

31+

32+weighReader :: Pandoc -> String -> (Text -> Pandoc) -> Weigh ()

33+weighReader doc name reader = do

34+ case lookup name writers of

35+ Just (TextWriter writer) ->

36+ let inp = either (error . show) id $ runPure $ writer def{ writerWrapText = WrapAuto} doc

37+ in func (name ++ " reader") reader inp

38+ _ -> return () -- no writer for reader

39+

40+

cabal.projectdeleted−13

@@ -1,13 +0,0 @@

1−packages: pandoc.cabal

2−tests: True

3−flags: +embed_data_files

4−

5−source-repository-package

6− type: git

7− location: https://github.com/jgm/doctemplates

8− tag: 428c26d5303cf7a2b1051fe1ffd9aafe9ba71c81

9−

10−source-repository-package

11− type: git

12− location: https://github.com/jgm/citeproc

13− tag: 4ce0501cd6f9c86eee087afcf878c256e49b9615

changelog.md → changelogrenamed+10706−16451