git.iko.soy/typeable/pandoc
on 5164ecd 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+1−9
@@ -8,17 +8,9 @@ indent_size = 2
8insert_final_newline = true
8insert_final_newline = true
9trim_trailing_whitespace = true
9trim_trailing_whitespace = true
10
10
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
21
13
22−[test/*]
14+[tests/*]
23insert_final_newline = false
15insert_final_newline = false
24trim_trailing_whitespace = false
16trim_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.
5+
6+Reporting a bug?
7+Please include your pandoc version and an example that allows us
8+to reproduce the problem (complete input, exact command line
9+used, expected and actual output). The smaller the example, the
10+better.
11+
.github/ISSUE_TEMPLATE/bug_report.mddeleted−25
@@ -1,25 +0,0 @@
1−---
2−name: Bug report
3−about: Create a report to help us improve
4−title: ''
5−labels: 'bug'
6−assignees: ''
7−
8−---
9−
10−<!--
11−Thank you for reporting an issue! Before you continue, please make sure that you have
12−
13−- searched the issue tracker for similar issues (including closed issues): https://github.com/jgm/pandoc/issues
14−- searched the pandoc-discuss mailing list for solutions: https://groups.google.com/forum/#!forum/pandoc-discuss
15−- reproduced your issue on the latest release of pandoc, or on https://pandoc.org/try
16−
17−Note that this bug tracker is for reporting bugs, not asking questions. For questions, use the pandoc-discuss mailing list.
18−-->
19−
20−**Explain the problem.**
21−Include the exact command line you used and all inputs necessary to reproduce the issue. Please create as minimal an example as possible, to help the maintainers isolate the problem. Explain the output you received and how it differs from what you expected.
22−
23−**Pandoc version?**
24−What version of pandoc are you using, on what OS?
25−
.github/ISSUE_TEMPLATE/config.ymldeleted−9
@@ -1,9 +0,0 @@
1−blank_issues_enabled: false
2−contact_links:
3− - name: Ask a question
4− url: https://groups.google.com/forum/#!forum/pandoc-discuss
5− about: "Discussion forum for pandoc (may be used as an email list)"
6− - name: Contributing Guidelines
7− url: https://pandoc.org/CONTRIBUTING.html
8− about: "Guidelines for submitting bug reports and code improvements"
9−
.github/ISSUE_TEMPLATE/feature_request.mddeleted−21
@@ -1,21 +0,0 @@
1−---
2−name: Feature request
3−about: Suggest an idea for this project
4−title: ''
5−labels: 'enhancement'
6−assignees: ''
7−
8−---
9−
10−<!--
11−Thank you for suggesting a feature! Before you continue, please make sure that you have
12−
13−- read the contributing guidelines: https://pandoc.org/CONTRIBUTING.html
14−- searched the issue tracker for similar issues (including closed issues): https://github.com/jgm/pandoc/issues
15−- searched the pandoc-discuss mailing list for relevant discussions: https://groups.google.com/forum/#!forum/pandoc-discuss
16−-->
17−
18−**Describe your proposed improvement and the problem it solves.**
19−
20−**Describe alternatives you've considered.**
21−
.github/workflows/ci.ymldeleted−275
@@ -1,275 +0,0 @@
1−name: CI tests
2−
3−on:
4− push:
5− branches:
6− - '*'
7− - '!rc/*'
8− paths-ignore:
9− - 'doc/**'
10− - 'MANUAL.txt'
11− - '*.md'
12− - 'RELEASE_CHECKLIST'
13− - 'BUGS'
14− - 'changelog'
15− - 'README.template'
16− - 'appveyor.yml'
17− - 'tools/**'
18− - 'linux/**'
19− - 'macos/**'
20− - 'windows/**'
21− - 'man/**'
22− pull_request:
23− paths-ignore:
24− - 'doc/**'
25− - 'MANUAL.txt'
26− - '*.md'
27− - 'RELEASE_CHECKLIST'
28− - 'BUGS'
29− - 'changelog'
30− - 'README.template'
31− - 'appveyor.yml'
32− - 'tools/**'
33− - 'linux/**'
34− - 'macos/**'
35− - 'windows/**'
36− - 'man/**'
37−
38−jobs:
39− linux:
40−
41− runs-on: ubuntu-18.04
42− strategy:
43− fail-fast: true
44− matrix:
45− versions:
46− - ghc: '8.0.2'
47− cabal: '2.4'
48− prefix: 'v2-'
49− cabalopts: ''
50− testopts: ''
51− - ghc: '8.2.2'
52− cabal: '2.4'
53− prefix: 'v2-'
54− cabalopts: ''
55− testopts: ''
56− - ghc: '8.4.4'
57− cabal: '2.4'
58− prefix: 'v2-'
59− cabalopts: '-f-embed_data_files'
60− testopts: ''
61− - ghc: '8.6.5'
62− cabal: '3.2'
63− prefix: ''
64− cabalopts: ''
65− testopts: '--test-option=--hide-successes'
66− - ghc: '8.8.4'
67− cabal: '3.2'
68− prefix: ''
69− cabalopts: ''
70− testopts: '--test-option=--hide-successes'
71− - ghc: '8.10.4'
72− cabal: '3.2'
73− prefix: ''
74− cabalopts: '-ftrypandoc'
75− testopts: '--test-option=--hide-successes'
76− - ghc: '9.0.1'
77− cabal: '3.4'
78− prefix: ''
79− cabalopts: ''
80− testopts: '--test-option=--hide-successes'
81− steps:
82− - uses: actions/checkout@v2
83−
84− # needed by memory
85− - name: Install numa
86− run: sudo apt-get install libnuma-dev
87−
88− # need to install older cabal/ghc versions from ppa repository
89−
90− - name: Install recent cabal/ghc
91− uses: haskell/actions/setup@v1
92− with:
93− ghc-version: ${{ matrix.versions.ghc }}
94− cabal-version: ${{ matrix.versions.cabal }}
95−
96− # declare/restore cached things
97− # caching doesn't work for scheduled runs yet
98− # https://github.com/actions/cache/issues/63
99−
100− - name: Cache cabal global package db
101− id: cabal-global
102− uses: actions/cache@v2
103− with:
104− path: |
105− ~/.cabal
106− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}
107−
108− - name: Cache cabal work
109− id: cabal-local
110− uses: actions/cache@v2
111− with:
112− path: |
113− dist-newstyle
114− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local
115−
116− - name: Install dependencies
117− run: |
118− cabal ${{ matrix.versions.prefix }}update
119− cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --dependencies-only --enable-tests --disable-optimization
120−
121− - name: Build and test
122− run: |
123− cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --enable-tests --disable-optimization 2>&1 | tee build.log
124− # fail if warnings in local build
125− ! grep -q ": *[Ww]arning:" build.log || exit 1
126− cabal ${{ matrix.versions.prefix }}test ${{ matrix.versions.cabalopts }} --disable-optimization ${{ matrix.versions.testopts }}
127−
128− windows:
129−
130− runs-on: windows-2019
131−
132− steps:
133− - uses: actions/checkout@v2
134−
135− # We should have ghc 8.10, cabal, stack pre-installed
136− # - uses: haskell/actions/setup@v1
137− # with:
138− # enable-stack: true
139− # stack-version: 'latest'
140−
141− # declare/restore cached things
142− # caching doesn't work for scheduled runs yet
143− # https://github.com/actions/cache/issues/63
144−
145− - name: Cache stack global package db
146− id: stack-global-package-db
147− uses: actions/cache@v2
148− with:
149− path: |
150− C:\Users\runneradmin\AppData\Roaming\stack\
151− key: ${{ runner.os }}-appdata-roaming-stack-${{ hashFiles('stack.yaml') }}
152−
153− # stack's local package dbs for the project and each package
154− # - name: Cache .stack-work
155− # uses: actions/cache@v1
156− # with:
157− # path: .stack-work
158− # key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}
159− # restore-keys: ${{ runner.os }}-stack-work
160−
161− - name: Install dependencies
162− run: |
163− stack update
164− stack install happy
165− stack test --dependencies-only --fast
166− - name: Build and test
167− shell: cmd
168− run: |
169− stack test --fast --test-arguments=--hide-successes
170−
171− macos:
172−
173− runs-on: macOS-10.15
174− strategy:
175− fail-fast: true
176− matrix:
177− versions:
178− - ghc: '8.8.4'
179− cabal: '3.2'
180−
181− steps:
182− - uses: actions/checkout@v2
183−
184− - name: Install recent cabal/ghc
185− uses: haskell/actions/setup@v1
186− with:
187− ghc-version: ${{ matrix.versions.ghc }}
188− cabal-version: ${{ matrix.versions.cabal }}
189−
190− # declare/restore cached things
191− # caching doesn't work for scheduled runs yet
192− # https://github.com/actions/cache/issues/63
193−
194− - name: Cache cabal global package db
195− id: cabal-global
196− uses: actions/cache@v2
197− with:
198− path: |
199− ~/.cabal
200− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}
201−
202− - name: Cache cabal work
203− id: cabal-local
204− uses: actions/cache@v2
205− with:
206− path: |
207− dist-newstyle
208− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local
209−
210− - name: Install dependencies
211− run: |
212− cabal v2-update
213− cabal v2-build --dependencies-only --enable-tests --disable-optimization
214− - name: Build and test
215− run: |
216− cabal v2-build --enable-tests --disable-optimization 2>&1 | tee build.log
217− # fail if warnings in local build
218− ! grep -q ": *[Ww]arning:" build.log || exit 1
219− cabal v2-test --disable-optimization
220−
221− benchmark:
222−
223− runs-on: ubuntu-18.04
224− strategy:
225− fail-fast: true
226− matrix:
227− versions:
228− - ghc: '8.8.4'
229− cabal: '3.2'
230− - ghc: '8.10.2'
231− cabal: '3.2'
232− steps:
233− - uses: actions/checkout@v2
234−
235− # need to install older cabal/ghc versions from ppa repository
236−
237− - name: Install recent cabal/ghc
238− uses: haskell/actions/setup@v1
239− with:
240− ghc-version: ${{ matrix.versions.ghc }}
241− cabal-version: ${{ matrix.versions.cabal }}
242−
243− # declare/restore cached things
244− # caching doesn't work for scheduled runs yet
245− # https://github.com/actions/cache/issues/63
246−
247− - name: Cache cabal global package db
248− id: cabal-global
249− uses: actions/cache@v2
250− with:
251− path: |
252− ~/.cabal
253− key: benchmark-${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}
254−
255− - name: Cache cabal work
256− id: cabal-local
257− uses: actions/cache@v2
258− with:
259− path: |
260− dist-newstyle
261− key: benchmark-${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local
262−
263− - name: Install dependencies
264− run: |
265− v2=$([ "${{ matrix.versions.cabal }}" = "2.2" ] && printf 'new' || printf 'v2')
266− cabal $v2-update
267− cabal $v2-build --dependencies-only --enable-optimization=1 --enable-benchmarks --disable-tests
268−
269− - name: Build and test
270− run: |
271− v2=$([ "${{ matrix.versions.cabal }}" = "2.2" ] && printf 'new' || printf 'v2')
272− cabal $v2-build --enable-optimization=1 --enable-benchmarks --disable-tests 2>&1 | tee build.log
273− # fail if warnings in local build
274− ! grep -q ": *[Ww]arning:" build.log || exit 1
275− cabal $v2-bench --enable-optimization=1 --benchmark-options='--timeout=6 +RTS -T -RTS'
.github/workflows/commit-validation.ymldeleted−38
@@ -1,38 +0,0 @@
1−name: commit-validation
2−on: [ push, pull_request ]
3−
4−jobs:
5− check-commit-msg-length:
6− runs-on: ubuntu-latest
7− steps:
8− - uses: actions/checkout@v1
9− - name: Check commit message length
10− run: |
11− # Get last commit messages
12− if [ "${{github.event_name}}" = "push" ]; then
13− if [ "${{github.event.before}}" = "0000000000000000000000000000000000000000" ]; then
14− # We are on a new branch
15− current="$(echo '${{github.ref}}' | sed 's!^refs/heads!origin!')"
16− readarray -t other < <(git show-ref | awk -F' ' '{ sub(/^refs\/remotes\//,"",$NF); }($NF != "'"$current"'"){print "^" $NF;}')
17− LOG_RANGE=( "$current" "${other[@]}" )
18− unset current other
19− else
20− # We are on existing branch
21− LOG_RANGE=( "${{github.event.before}}.." )
22− fi
23− elif [ "${{github.event_name}}" = "pull_request" ]; then
24− LOG_RANGE=( "origin/${{github.base_ref}}.." )
25− fi
26− if [[ -v LOG_RANGE ]]; then
27− if git log --no-merges --pretty=format:"%s" "${LOG_RANGE[@]}" -- | grep -qE "^[^#].{78}"; then
28− echo -e "Last commit log contains a line with more than 78 characters:\n"
29− git log --no-merges --pretty=format:"%h: %s" "${LOG_RANGE[@]}" -- | grep -E "^[^:]+: [^#].{78}"
30− echo
31− exit 1
32− else
33− echo "Commit log looks good."
34− fi
35− unset LOG_RANGE
36− else
37− echo "Not checking commits on ${{github.event_name}}"
38− fi
.github/workflows/format-validation.ymldeleted−88
@@ -1,88 +0,0 @@
1−name: Format validation
2−
3−on:
4− push:
5− branches:
6− - '*'
7− - '!rc/*'
8− paths:
9− - 'test/writer.jats_articleauthoring'
10− - 'test/writer.jats_publishing'
11− - 'test/writer.jats_archiving'
12− - 'test/tables.jats_archiving'
13− - 'test/tables/nordics.jats_archiving'
14− - 'test/tables/planets.jats_archiving'
15− - 'test/tables/students.jats_archiving'
16− pull_request:
17− branches:
18− - '*'
19− - '!rc/*'
20− paths:
21− - 'test/writer.jats_articleauthoring'
22− - 'test/writer.jats_publishing'
23− - 'test/writer.jats_archiving'
24− - 'test/tables.jats_archiving'
25− - 'test/tables/nordics.jats_archiving'
26− - 'test/tables/planets.jats_archiving'
27− - 'test/tables/students.jats_archiving'
28−
29−jobs:
30− jats:
31− name: JATS
32− runs-on: ubuntu-latest
33− env:
34− VALIDATOR_URL: "https://jats-validator.hubmed.org/dtd/"
35− strategy:
36− fail-fast: false
37− matrix:
38− tagset:
39− - articleauthoring
40− - publishing
41− - archiving
42− steps:
43− - name: Checkout
44− uses: actions/checkout@v2
45−
46− - name: Validate writer output
47− run: |
48− filename=test/writer.jats_${{ matrix.tagset }}
49− printf "Validating file %s\n" "$filename"
50− json="$(curl --form "xml=@${filename}" --silent "$VALIDATOR_URL")"
51− err_count="$(printf '%s' "$json" | jq '.errors | length')"
52− if [ "$err_count" -eq 0 ]; then
53− printf "File was validated successfully.\n"
54− exit 0
55− else
56− printf "Validator report:\n%s" "$json"
57− exit 1
58− fi
59−
60− - name: Validate tables
61− # Archiving has the simplest template, so we only check with that.
62− if: matrix.tagset == 'archiving'
63− run: |
64− tmpl="$(cat <<EOF
65− <?xml version="1.0" encoding="utf-8" ?>
66− <!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Archiving and Interchange DTD v1.2 20190208//EN"
67− "JATS-archivearticle1.dtd">
68− <article xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink" dtd-version="1.2" article-type="other">
69− <front><article-meta></article-meta></front>
70− <body>%s</body></article>
71− EOF
72− )"
73− jats_file="$(mktemp jats-tables.XXXXX)"
74− exit_code=0
75− for f in tables tables/nordics tables/planets tables/students; do
76− filename=test/$f.jats_archiving
77− printf "Validating %s...\n" "$filename"
78− printf "$tmpl" "$(cat $filename)" > "$jats_file"
79− json="$(curl --form "xml=@${jats_file}" --silent "$VALIDATOR_URL")"
80− err_count="$(printf "%s" "$json" | jq '.errors | length')"
81− if [ "$err_count" -eq 0 ]; then
82− printf "Table output is valid when used as body content.\n"
83− else
84− printf "Validator report:\n%s" "$json"
85− exit_code=1
86− fi
87− done
88− exit "$exit_code"
.github/workflows/lint.ymldeleted−33
@@ -1,33 +0,0 @@
1−name: Lint
2−
3−# Trigger the workflow on push or pull request, but only for the
4−# master branch
5−on:
6− pull_request:
7− branch: [master]
8− push:
9− branch: [master]
10− paths-ignore:
11− - LICENSE
12− - README.md
13− - CHANGELOG.md
14− - stack.yaml
15− - .travis.yml
16−
17−jobs:
18− lint:
19− name: Lint
20− runs-on: ubuntu-latest
21− env:
22− hlint_script: https://raw.github.com/ndmitchell/hlint/master/misc/run.sh
23−
24− steps:
25− - name: Checkout
26− uses: actions/checkout@v2
27−
28− - name: Check cabal file for missing test files
29− run: make check-cabal
30−
31− - name: Download and run hlint
32− run: |
33− curl -sSL "${hlint_script}" | sh -s .
.github/workflows/nightly.ymldeleted−91
@@ -1,91 +0,0 @@
1−name: Nightly
2−
3−on:
4− schedule:
5− - cron: '53 7 * * *'
6−
7−jobs:
8− linux:
9−
10− runs-on: ubuntu-18.04
11− steps:
12− - uses: actions/checkout@v2
13−
14− - name: Install recent cabal/ghc
15− uses: haskell/actions/setup@v1
16− with:
17− ghc-version: '8.10.3'
18− cabal-version: '3.2'
19−
20− - name: Install dependencies
21− run: |
22− ghc --version
23− cabal --version
24− cabal v2-update
25− cabal v2-build --dependencies-only
26− - name: Build
27− run: |
28− cabal v2-install
29− strip $HOME/.cabal/bin/pandoc
30− - name: Install artifact
31− run: |
32− export ARTIFACTS=nightly-linux/pandoc-nightly-linux-$(date +%Y-%m-%d)
33− mkdir -p ${ARTIFACTS}
34− cp $HOME/.cabal/bin/pandoc ${ARTIFACTS}/
35− cp COPYRIGHT ${ARTIFACTS}/
36− echo "Built from ${GITHUB_SHA}" > ${ARTIFACTS}/README.nightly.txt
37− - uses: actions/upload-artifact@master
38− with:
39− name: nightly-linux
40− path: nightly-linux
41−
42− windows:
43−
44− runs-on: windows-2019
45−
46− steps:
47− - uses: actions/checkout@v2
48− - name: Install dependencies
49− run: |
50− stack update
51− stack build --dependencies-only pandoc
52− - name: Build artifacts
53− shell: cmd
54− run: |
55− for /f %%a in ('powershell -Command "Get-Date -format yyyy-MM-dd"') do set THEDATE=%%a
56− set ARTIFACTS=%CD%\nightly-windows\pandoc-nightly-windows-%THEDATE%
57− mkdir %ARTIFACTS%
58− stack build pandoc
59− forfiles /P .\.stack-work\install /M pandoc*.exe /S /C "cmd /C copy @path %%ARTIFACTS%%"
60− copy COPYRIGHT %ARTIFACTS%
61− ren %ARTIFACTS%\COPYRIGHT COPYRIGHT.txt
62− echo Built from %GITHUB_SHA% > %ARTIFACTS%\README.nightly.txt
63− - uses: actions/upload-artifact@master
64− with:
65− name: nightly-windows
66− path: nightly-windows
67−
68− macos:
69−
70− runs-on: macOS-10.15
71−
72− steps:
73− - uses: actions/checkout@v2
74− - name: Install dependencies
75− run: |
76− stack update
77− stack build --dependencies-only pandoc
78− - name: Build artifacts
79− run: |
80− export ARTIFACTS=nightly-macos/pandoc-nightly-macos-$(date +%Y-%m-%d)
81− mkdir -p ${ARTIFACTS}
82− stack build pandoc
83− for f in $(find .stack-work/install -name 'pandoc*' -perm +001 -type f); do cp $f ${ARTIFACTS}/; done
84− mv ${ARTIFACTS}/pandoc ${ARTIFACTS}/pandoc
85− cp COPYRIGHT ${ARTIFACTS}/
86− echo "Built from ${GITHUB_SHA}" > ${ARTIFACTS}/README.nightly.txt
87− - uses: actions/upload-artifact@master
88− with:
89− name: nightly-macos
90− path: nightly-macos
91−
.github/workflows/release-candidate.ymldeleted−83
@@ -1,83 +0,0 @@
1−name: Release candidate
2−
3−on:
4− push:
5− branches:
6− - 'rc/**'
7−
8−jobs:
9− linux:
10−
11− runs-on: ubuntu-18.04
12− steps:
13− - uses: actions/checkout@v1
14− - name: Create linux package
15− run: |
16− make debpkg
17− mkdir linux-release-candidate
18− cp linux/artifacts/*.deb linux-release-candidate/
19− cp linux/artifacts/*.tar.gz linux-release-candidate/
20− - uses: actions/upload-artifact@v2
21− with:
22− name: linux-release-candidate
23− path: linux-release-candidate
24−
25− windows:
26−
27− runs-on: windows-2019
28− strategy:
29− fail-fast: true
30− matrix:
31− versions:
32− - osarch: "windows-x86_64"
33− arch: "x64"
34− stack_opts: "-j1"
35− steps:
36− - uses: actions/checkout@v1
37− - name: Install dependencies
38− run: |
39− stack update
40− stack build ${{ matrix.versions.stack_opts }} --dependencies-only pandoc
41− - name: Create windows package
42− shell: cmd
43− run: |
44− for /f %%a in ('powershell -Command "Get-Date -format yyyy-MM-dd"') do set THEDATE=%%a
45− stack build ${{ matrix.versions.stack_opts }} pandoc
46− for /f "tokens=1-2 delims= " %%a in ('stack exec pandoc -- --version') do (
47− @set VERSION=%%b
48− goto :next
49− )
50− :next
51− if "%VERSION%" == "" (
52− echo Error: could not determine version number.
53− exit /b 1
54− )
55− echo Detected version %VERSION%
56− @set WINDOWS=%CD%\windows
57− @set RELEASE=%WINDOWS%\pandoc-%VERSION%
58− mkdir %RELEASE%
59− forfiles /P .\.stack-work\install /M pandoc.exe /S /C "cmd /C echo @path && echo %%WINDOWS%% && copy @path %%RELEASE%%"
60− stack exec pandoc -- -s --toc MANUAL.txt -o %RELEASE%\MANUAL.html
61− stack exec pandoc -- -s COPYING.md -t rtf -o %RELEASE%\COPYING.rtf
62− copy %RELEASE%\COPYING.rtf %WINDOWS%
63− copy COPYRIGHT %RELEASE%\COPYRIGHT.txt
64− cd windows
65− echo Creating msi...
66− dir
67− @set WIXBIN="c:\Program Files (x86)\WiX Toolset v3.11\bin"
68− @set WORKDIR=%CD%
69− echo Running candle...
70− %WIXBIN%\candle -arch ${{ matrix.versions.arch }} -dVERSION=%VERSION% -dBINPATH=%RELEASE% *.wxs -out wixobj\
71− if %errorlevel% neq 0 exit /b %errorlevel%
72− echo Running light...
73− %WIXBIN%\light -sw1076 -ext WixUIExtension -ext WixUtilExtension -cultures:en-us -loc Pandoc-en-us.wxl -out %WORKDIR%\pandoc-%VERSION%-${{ matrix.versions.osarch }}-UNSIGNED.msi wixobj\*.wixobj
74− 7z a "pandoc-%VERSION%-${{ matrix.versions.osarch }}.zip" pandoc-%VERSION%
75− cd ..
76− mkdir windows-release-candidate
77− copy windows\pandoc-%VERSION%-${{ matrix.versions.osarch }}-UNSIGNED.msi windows-release-candidate
78− copy windows\pandoc-%VERSION%-${{ matrix.versions.osarch }}.zip windows-release-candidate
79− copy windows\Makefile windows-release-candidate
80− - uses: actions/upload-artifact@v2
81− with:
82− name: windows-release-candidate
83− path: windows-release-candidate
.gitignore−10
@@ -1,6 +1,4 @@
1*~
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.yamldeleted−112
@@ -1,112 +0,0 @@
1−# HLint configuration file
2−# https://github.com/ndmitchell/hlint
3−##########################
4−
5−# Specify additional command line arguments
6−#
7−- arguments: [--color=auto, --cpp-ansi]
8−
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
42−
43−# With recent hlint this rule has given false positives on TH
44−- ignore:
45− name: "Redundant bracket"
46−
47−
48−- ignore:
49− name: "Use <$>"
50− within:
51− - Text.Pandoc.Readers.LaTeX
52− - Text.Pandoc.Readers.Markdown
53−
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
66−
67−- ignore:
68− name: "Use forM_"
69− within:
70− - Text.Pandoc.Readers.DocBook
71−
72−- ignore:
73− name: "Use Just"
74− within:
75− - Text.Pandoc.Citeproc.MetaValue
76− - Text.Pandoc.Readers.Odt.ContentReader
77− - Text.Pandoc.Writers.Roff
78−
79−- ignore:
80− name: "Use list comprehension"
81− within: Text.Pandoc.Citeproc.BibTeX
82−
83−- ignore:
84− name: "Use list literal pattern"
85− within: Text.Pandoc.Citeproc.MetaValue
86−
87−# TODO: check
88−- ignore:
89− name: "Use second"
90− within:
91− - Text.Pandoc.Citeproc.BibTeX
92− - Text.Pandoc.Citeproc.Locator
93−
94−# TODO: check
95−- ignore:
96− name: "Use sortOn"
97− within: Text.Pandoc.Writers.OpenDocument
98−
99−- ignore:
100− name: "Use tuple-section"
101− within:
102− - Text.Pandoc.Readers.EPUB
103− - Text.Pandoc.ImageSize
104− - Text.Pandoc.Readers.Markdown
105− - Text.Pandoc.Readers.RST
106−
107−# fromRight is only in base >= 4.10
108−- ignore:
109− name: "Use fromRight"
110−
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.
41 # Default: global.
42 align: none
42 align: none
43
43
44− # Following options affect only import list alignment.
44+ # Folowing options affect only import list alignment.
45 #
45 #
46 # List align has following options:
46 # List align has following options:
47 #
47 #
@@ -75,7 +75,7 @@ steps:
75 # short enough to fit to single line. Otherwise it'll be multiline.
75 # short enough to fit to single line. Otherwise it'll be multiline.
76 #
76 #
77 # - multiline: One line per import list entry.
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 #
79 #
80 # > import qualified Data.Map as M
80 # > import qualified Data.Map as M
81 # > ( empty
81 # > ( empty
@@ -91,7 +91,7 @@ steps:
91 # This option affects 'list_align' and 'long_list_align'.
91 # This option affects 'list_align' and 'long_list_align'.
92 list_padding: 4
92 list_padding: 4
93
93
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
95 # or class. The only difference is single space between type and list
96 # of constructors, selectors and class functions.
96 # of constructors, selectors and class functions.
97 #
97 #
@@ -124,7 +124,7 @@ steps:
124
124
125 # Align affects alignment of closing pragma brackets.
125 # Align affects alignment of closing pragma brackets.
126 #
126 #
127− # - true: Brackets are aligned in same column.
127+ # - true: Brackets are aligned in same collumn.
128 #
128 #
129 # - false: Brackets are not aligned together. There is only one space
129 # - false: Brackets are not aligned together. There is only one space
130 # between actual import and closing bracket.
130 # between actual import and closing bracket.
.travis.ymlnew file+133
@@ -0,0 +1,133 @@
1+# This .travis.yml is modified from the sample at
2+# https://docs.haskellstack.org/en/stable/GUIDE/#travis-with-caching
3+
4+# Use new container infrastructure to enable caching
5+sudo: false
6+
7+# Do not choose a language; we provide our own build tools.
8+language: generic
9+
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+ - env: BUILD=cabal GHCVER=7.8.4 CABALVER=1.18 OPTS="-O0 -Wall -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS="--enable-benchmarks"
35+ compiler: ": #GHC 7.8.4"
36+ addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4,happy-1.19.5], sources: [hvr-ghc]}}
37+
38+ # don't build benchmarks for ghc 7.10.3, because build takes too long...
39+ - 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=""
40+ compiler: ": #GHC 7.10.3"
41+ addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.3,happy-1.19.5], sources: [hvr-ghc]}}
42+
43+ # don't build benchmarks for ghc 8.0.2, because build takes too long...
44+ - 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=""
45+ compiler: ": #GHC 8.0.2"
46+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.0.2,happy-1.19.5], sources: [hvr-ghc]}}
47+
48+ - env: BUILD=cabal GHCVER=8.2.1 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"
49+ compiler: ": #GHC 8.2.1"
50+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.2.1,happy-1.19.5], sources: [hvr-ghc]}}
51+
52+ - env: BUILD=cabal GHCVER=8.2.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.2.1"
54+ addons: {apt: {packages: [cabal-install-2.0,ghc-8.2.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="--resolver lts-9" 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+ # Nightly builds are allowed to fail
69+ - env: BUILD=stack ARGS="--resolver nightly"
70+ compiler: ": #stack nightly"
71+ addons: {apt: {packages: [ghc-8.2.1], sources: [hvr-ghc]}}
72+
73+ # - env: BUILD=stack ARGS="--resolver lts-8"
74+ # compiler: ": #stack 8.0.2 osx"
75+ # os: osx
76+
77+ # - env: BUILD=stack ARGS="--resolver nightly"
78+ # compiler: ": #stack nightly osx"
79+ # os: osx
80+
81+ allow_failures:
82+ - env: BUILD=cabal GHCVER=head CABALVER=head
83+ - env: BUILD=stack ARGS="--resolver nightly"
84+
85+ fast_finish: true
86+
87+before_install:
88+# Using compiler above sets CC to an invalid value, so unset it
89+- unset CC
90+- export PATH=$PATH:/opt/happy/1.19.5/bin/:/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.local/bin:$HOME/.cabal/bin
91+# Download and unpack the stack executable
92+- |
93+ if [[ $BUILD == "stack" ]]; then
94+ mkdir -p ~/.local/bin
95+ if [ `uname` = "Darwin" ]
96+ then
97+ curl --insecure -L https://www.stackage.org/stack/osx-x86_64 | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin
98+ else
99+ curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
100+ fi
101+ fi
102+
103+install:
104+- echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"
105+- if [ -f configure.ac ]; then autoreconf -i; fi
106+- |
107+ case "$BUILD" in
108+ stack)
109+ ulimit -n 4096
110+ stack --no-terminal --install-ghc $ARGS build --only-dependencies --fast --flag 'pandoc:embed_data_files' --flag 'aeson:fast'
111+ ;;
112+ cabal)
113+ cabal --version
114+ travis_retry cabal update
115+ cabal install --disable-optimization --only-dependencies --flags="$FLAGS" --enable-tests --force-reinstalls --reorder-goals --max-backjumps=-1 $CABALARGS
116+ ;;
117+ esac
118+
119+script:
120+- |
121+ case "$BUILD" in
122+ stack)
123+ ulimit -n 4096
124+ stack --no-terminal $ARGS test --fast --flag 'aeson:fast' --flag pandoc:embed_data_files --haddock --no-haddock-deps --ghc-options="$OPTS"
125+ ;;
126+ cabal)
127+ cabal sdist --output-directory=sourcedist && \
128+ cd sourcedist && \
129+ cabal configure --disable-optimization --enable-tests -v2 --flags="$FLAGS" --ghc-options="$OPTS" $CABALARGS && \
130+ cabal build -v2 -j2 && \
131+ cabal test
132+ ;;
133+ esac
AUTHORS.md+3−140
@@ -1,100 +1,57 @@
1# Contributors
1# Contributors
2
2
3−- Anabra
4−- Aner Lucero
5- Arata Mizuki
3- Arata Mizuki
6−- Arfon Smith
7- Aaron Wolen
4- Aaron Wolen
8- Albert Krewinkel
5- Albert Krewinkel
9- Alex Ivkin
6- Alex Ivkin
10−- Alex Toldaiev
11- Alex Vong
7- Alex Vong
12- Alexander Kondratskiy
8- Alexander Kondratskiy
13- Alexander Krotov
9- Alexander Krotov
14- Alexander Sulfrian
10- Alexander Sulfrian
15- Alexander V Vershilov
11- Alexander V Vershilov
16−- Alexandre Franke
17- Alfred Wechselberger
12- Alfred Wechselberger
18−- Amogh Rathore
19−- Anders Waldenborg
20- Andreas Lööw
13- Andreas Lööw
21- Andrew Dunning
14- Andrew Dunning
22−- Andy Morris
23−- Anti-Distinctlyminty
24- Antoine Latter
15- Antoine Latter
25−- Antonio Terceiro
26- Arata Mizuki
16- Arata Mizuki
27−- Arfon Smith
28- Arlo O'Keeffe
17- Arlo O'Keeffe
29- Artyom Kazak
18- Artyom Kazak
30- Agustín Martín Barbero
19- Agustín Martín Barbero
31- B. Scott Michel
20- B. Scott Michel
32- Ben Firshman
21- Ben Firshman
33- Ben Gamari
22- Ben Gamari
34−- Ben Steinberg
35- Beni Cherniavsky-Paskin
23- Beni Cherniavsky-Paskin
36- Benoit Schweblin
24- Benoit Schweblin
37- Bjorn Buckwalter
25- Bjorn Buckwalter
38−- Blake Eryx
39−- Bodigrim
40- Bradley Kuhn
26- Bradley Kuhn
41- Brent Yorgey
27- Brent Yorgey
42−- Brian Leung
43- Bryan O'Sullivan
28- Bryan O'Sullivan
44- Caleb McDaniel
29- Caleb McDaniel
45−- Caleb Mclennan
46- Calvin Beck
30- Calvin Beck
47- Carlos Sosa
31- Carlos Sosa
48−- Cécile Chemin
49−- Cédric Couralet
50−- Charanjit Singh
51- Chris Black
32- Chris Black
52- Christian Conkle
33- Christian Conkle
53−- Christian Despres
54- Christoffer Ackelman
34- Christoffer Ackelman
55- Christoffer Sawicki
35- Christoffer Sawicki
56- Clare Macrae
36- Clare Macrae
57- Clint Adams
37- Clint Adams
58- Conal Elliott
38- Conal Elliott
59−- Cormac Relf
60- Craig S. Bosma
39- Craig S. Bosma
61−- Damien Clochard
62- Daniel Bergey
40- Daniel Bergey
63−- Daniel Maslowski
64- Daniel T. Staal
41- Daniel T. Staal
65- Daniele D'Orazio
42- Daniele D'Orazio
66- David A Roberts
43- David A Roberts
67- David Lazar
44- David Lazar
68−- David Martschenko
69- David Röthlisberger
45- David Röthlisberger
70- Denis Laxalde
46- Denis Laxalde
71−- Denis Maier
72−- Derek Chen-Becker
73−- Diego Balseiro
74−- Dimitri Sabadie
75−- Dmitry Pogodin
76−- Dmitry Volodin
77- Douglas Calvert
47- Douglas Calvert
78−- Eigil Rischel
79- Emanuel Evans
48- Emanuel Evans
80−- Emerson Harkin
81−- Emily Bourke
82- Emily Eisenberg
49- Emily Eisenberg
83- Eric Kow
50- Eric Kow
84−- Erik Rask
85- Eric Seidel
51- Eric Seidel
86−- Eric Schrijver
87−- Ethan Riley
88−- Étienne Bersac
89- Felix Yan
52- Felix Yan
90−- Félix Baylac-Jacqué
91−- Florian Beeres
92- Florian Eitel
53- Florian Eitel
93−- Florian Klink
94−- Florian Kohrt
95−- Francesco Occhipinti
96- François Gannaz
54- François Gannaz
97−- Frederik Elwert
98- Freiric Barral
55- Freiric Barral
99- Freirich Raabe
56- Freirich Raabe
100- Frerich Raabe
57- Frerich Raabe
@@ -106,73 +63,44 @@
106- Greg Rundlett
63- Greg Rundlett
107- Grégory Bataille
64- Grégory Bataille
108- Gwern Branwen
65- Gwern Branwen
109−- Hamish Mackenzie
110- Hans-Peter Deifel
66- Hans-Peter Deifel
111−- Heiko Schlittermann
112- Henrik Tramberend
67- Henrik Tramberend
113- Henry de Valence
68- Henry de Valence
114- Hubert Plociniczak
69- Hubert Plociniczak
115−- Ian Max Andolina
116−- Igor Khorlo
117−- Igor Pashev
118- Ilya V. Portnov
70- Ilya V. Portnov
119−- Ivan Trubach
120- Ivo Clarysse
71- Ivo Clarysse
121−- Jared Lander
122−- J. B. Rainsberger
123- J. Lewis Muir
72- J. Lewis Muir
124- Jaime Marquínez Ferrándiz
73- Jaime Marquínez Ferrándiz
125−- Jake Zimmerman
126- Jakob Voß
74- Jakob Voß
127- James Aspnes
75- James Aspnes
128- Jamie F. Olson
76- Jamie F. Olson
129- Jan Larres
77- Jan Larres
130- Jan Schulz
78- Jan Schulz
131−- Jan Tojnar
132−- Jan-Otto Kröpke
133- Jason Ronallo
79- Jason Ronallo
134- Jeff Arnold
80- Jeff Arnold
135- Jeff Runningen
81- Jeff Runningen
136- Jens Getreu
82- Jens Getreu
137- Jens Petersen
83- Jens Petersen
138−- Jeroen de Haas
139−- Jerry Sky
140- Jesse Rosenthal
84- Jesse Rosenthal
141−- Joe Hermaszewski
142- Joe Hillenbrand
85- Joe Hillenbrand
143−- John KetzerX
144- John MacFarlane
86- John MacFarlane
145- John Muccigrosso
87- John Muccigrosso
146- John Luke Bentley
88- John Luke Bentley
147- Jonas Smedegaard
89- Jonas Smedegaard
148−- Jonas Scholl
149- Jonathan Daugherty
90- Jonathan Daugherty
150- Jose Luis Duran
91- Jose Luis Duran
151−- José de Mattos Neto
152- Josef Svenningsson
92- Josef Svenningsson
153−- Joseph C. Sible
154- Julien Cretel
93- Julien Cretel
155−- Julien Dutant
156−- Juliette Fourcot
157- Juliusz Gonera
94- Juliusz Gonera
158- Justin Bogner
95- Justin Bogner
159- Jérémy Bobbio
96- Jérémy Bobbio
160−- Karl Pettersson
161- Keiichiro Shikano
97- Keiichiro Shikano
162- Kelsey Hightower
98- Kelsey Hightower
163- Kolen Cheung
99- Kolen Cheung
164- Konstantin Zudov
100- Konstantin Zudov
165- Kristof Bastiaensen
101- Kristof Bastiaensen
166−- Krystof Beuermann
167- Herwig Stuetz
102- Herwig Stuetz
168- Lars-Dominik Braun
103- 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
104- Luke Plant
177- Marc Schreiber
105- Marc Schreiber
178- Mark Szepieniec
106- Mark Szepieniec
@@ -181,10 +109,7 @@
181- Masayoshi Takahashi
109- Masayoshi Takahashi
182- Matej Kollar
110- Matej Kollar
183- Mathias Schenner
111- Mathias Schenner
184−- Mathias Walter
185−- Mathieu Boespflug
186- Mathieu Duponchelle
112- Mathieu Duponchelle
187−- Matthew Doty
188- Matthew Eddey
113- Matthew Eddey
189- Matthew Pickering
114- Matthew Pickering
190- Matthias C. M. Troffaes
115- Matthias C. M. Troffaes
@@ -194,66 +119,41 @@
194- Merijn Verstraaten
119- Merijn Verstraaten
195- Michael Beaumont
120- Michael Beaumont
196- Michael Chladek
121- Michael Chladek
197−- Michael Hoffmann
198−- Michael Peyton Jones
199−- Michael Reed
200- Michael Snoyman
122- Michael Snoyman
201- Michael Thompson
123- Michael Thompson
202−- Mike Tzou
203- MinRK
124- MinRK
204- Morton Fox
125- Morton Fox
205- Nathan Gass
126- Nathan Gass
206- Neil Mayhew
127- Neil Mayhew
207- Nick Bart
128- Nick Bart
208−- Nick Berendsen
209−- Nick Fleisher
210- Nicolas Kaiser
129- Nicolas Kaiser
211- Nikolay Yakimov
130- Nikolay Yakimov
212−- Nils Carlson
213−- Nixon Enraght-Moony
214−- Nokome Bentley
215−- Ole Martin Ruud
216- Oliver Matthews
131- Oliver Matthews
217- Ophir Lifshitz
132- Ophir Lifshitz
218- Or Neeman
133- Or Neeman
219−- OvidiusCicero
220−- Owen McGrath
221- Pablo Rodríguez
134- Pablo Rodríguez
222−- Pascal Wagler
223−- Paul Tilley
224- Paul Rivier
135- Paul Rivier
225- Paulo Tanimoto
136- Paulo Tanimoto
226−- Pete Ryland
227- Peter Wang
137- Peter Wang
228−- Philip Pesca
229- Philippe Ombredanne
138- Philippe Ombredanne
230- Phillip Alday
139- Phillip Alday
231- Prayag Verma
140- Prayag Verma
232- Puneeth Chaganti
141- Puneeth Chaganti
233- Ralf Stephan
142- Ralf Stephan
234- Raniere Silva
143- Raniere Silva
235−- Raymond Ehlers
236- Recai Oktaş
144- Recai Oktaş
237- Roland Hieber
145- Roland Hieber
238−- Roman Beránek
239- RyanGlScott
146- RyanGlScott
240−- Salim B
241−- Sascha Wilde
242- Scott Morrison
147- Scott Morrison
243−- Sebastian Talmon
244- Sergei Trofimovich
148- Sergei Trofimovich
245- Sergey Astanin
149- Sergey Astanin
246- Shahbaz Youssefi
150- Shahbaz Youssefi
247- Shaun Attfield
151- Shaun Attfield
248−- Shim Myeongseob
249−- Shin Sang-jae
250- Sidarth Kapur
152- Sidarth Kapur
251- Sidharth Kapur
153- Sidharth Kapur
252- Simon Hengel
154- Simon Hengel
253- Stefan Dresselhaus
155- Stefan Dresselhaus
254- Sumit Sahrawat
156- Sumit Sahrawat
255−- Tarik Graba
256−- Tatiana Porras
257- Thenaesh Elango
157- Thenaesh Elango
258- Thomas Hodgson
158- Thomas Hodgson
259- Thomas Weißschuh
159- Thomas Weißschuh
@@ -263,54 +163,25 @@
263- Tiziano Müller
163- Tiziano Müller
264- Todd Sifleet
164- Todd Sifleet
265- Tom Leese
165- Tom Leese
266−- Tristan de Cacqueray
267−- Tristan Stenner
268- Uli Köhler
166- Uli Köhler
269−- Urs Liska
270- Václav Zeman
167- Václav Zeman
271−- Václav Haisman
272−- Vaibhav Sagar
273−- Vanessa McHale
274−- Vasily Alferov
275- Viktor Kronvall
168- Viktor Kronvall
276- Vincent
169- Vincent
277−- Vlad Hanciuta
170+- Václav Haisman
171+- Václav Zeman
278- Wandmalfarbe
172- Wandmalfarbe
279- Waldir Pimenta
173- Waldir Pimenta
280- Wikiwide
174- Wikiwide
281−- Winnie Hellmann
282- Xavier Olive
175- Xavier Olive
283−- Yan Pashkovsky
284−- Yoan Blanc
285- Yuchen Pei
176- Yuchen Pei
286−- Zihang Chen
287−- a-vrma
288−- andrebauer
289−- argent0
290−- badumont
291−- blmage
292- bucklereed
177- bucklereed
293- bumper314
178- bumper314
294−- chinapedia
295−- cholonam
296- csforste
179- csforste
297−- dbecher-ito
298- d-dorazio
180- d-dorazio
299−- ebiim
181+- iandol
300−- favonia
301- infinity0x
182- infinity0x
302−- jeongminkim-islab
303−- kaizshang91
304−- lux-lth
305- lwolfsonkin
183- lwolfsonkin
306−- mbrackeantidot
307- nkalvi
184- nkalvi
308−- niszet
309−- nuew
310−- obcat
311−- oltolm
312−- oquechy
313−- quasicomputational
314- qerub
185- qerub
315- robabla
186- robabla
316- roblabla
187- roblabla
@@ -318,13 +189,5 @@
318- rski
189- rski
319- shreevatsa.public
190- shreevatsa.public
320- takahashim
191- takahashim
321−- taotieren
322−- tecosaur
323−- TEC
324- tgkokk
192- tgkokk
325−- the-solipsist
326−- timo-a
327- thsutton
193- thsutton
328−- vijayphoenix
329−- wiefling
330−- wuffi
CONTRIBUTING.md+54−202
@@ -1,64 +1,6 @@
1Contributing to pandoc
1Contributing to pandoc
2======================
2======================
3
3
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----------------
64
6
@@ -68,21 +10,15 @@ Ask on [pandoc-discuss].
68Found a bug?
10Found a bug?
69------------
11------------
70
12
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].
73
15
74−Before you submit a bug report, search the [open issues] *and* [closed issues]
16+Before you submit a bug report, search the (open *and* closed) issues to make
75−to make sure the issue hasn't come up before. Also, check the [User's Guide] and
17+sure the issue hasn't come up before. Also, check the [User's Guide] and [FAQs]
76−[FAQs] for anything relevant.
18+for anything relevant.
77
19
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,
21+(or, even better, the development version).
80−since the bug may have been fixed since the last release.
81−[Nightly builds] are available, so you don't need to compile
82−from source to test against the development version.
83−(To fetch a nightly, visit the link, click the topmost "Nightly"
84−in the table, then choose your platform under "Artifacts." Note
85−that you must be logged in with a GitHub account.)
86
22
87Your report should give detailed, *reproducible* instructions, including
23Your report should give detailed, *reproducible* instructions, including
88
24
@@ -101,25 +37,25 @@ Out of scope?
101A less than perfect conversion does not necessarily mean there's
37A less than perfect conversion does not necessarily mean there's
102a bug in pandoc. Quoting from the MANUAL:
38a bug in pandoc. Quoting from the MANUAL:
103
39
104−> Because pandoc's intermediate representation of a document is less
40+> Because Pandoc's intermediate representation of a document is less
105> expressive than many of the formats it converts between, one should
41> expressive than many of the formats it converts between, one should
106> not expect perfect conversions between every format and every other.
42> not expect perfect conversions between every format and every other.
107> Pandoc attempts to preserve the structural elements of a document, but
43> Pandoc attempts to preserve the structural elements of a document, but
108> not formatting details such as margin size. And some document elements,
44> not formatting details such as margin size. And some document elements,
109−> such as complex tables, may not fit into pandoc's simple document
45+> such as complex tables, may not fit into Pandoc's simple document
110−> model. While conversions from pandoc's Markdown to all formats aspire
46+> model. While conversions from Pandoc's Markdown to all formats aspire
111−> to be perfect, conversions from formats more expressive than pandoc's
47+> to be perfect, conversions from formats more expressive than Pandoc's
112> Markdown can be expected to be lossy.
48> Markdown can be expected to be lossy.
113
49
114−For example, both `docx` and `odt` formats can represent margin size, but
50+For example, both docx and odt can represent margin size, but because
115−because pandoc's internal document model does not contain a representation of
51+pandoc's internal document model does not contain a representation of
116margin size, this information will be lost on converting from docx
52margin size, this information will be lost on converting from docx
117−to `odt`. (You can, however, customize margin size using `--reference-doc`.)
53+to odt. (You can, however, customize margin size using `--reference-odt`.)
118
54
119So before submitting a bug report, consider whether it might be
55So before submitting a bug report, consider whether it might be
120−"out of scope." If it concerns a feature of documents that isn't
56+"out of scope." If it concerns a feature of documents that isn't
121representable in pandoc's Markdown, then it very likely is.
57representable in pandoc's Markdown, then it very likely is.
122−(If in doubt, you can always ask on [pandoc-discuss].)
58+(If in doubt, you can always ask on pandoc-discuss.)
123
59
124Fixing bugs from the issue tracker
60Fixing bugs from the issue tracker
125----------------------------------
61----------------------------------
@@ -127,9 +63,9 @@ Fixing bugs from the issue tracker
127Almost all the bugs on the issue tracker have one or more associated
63Almost all the bugs on the issue tracker have one or more associated
128tags. These are used to indicate the *complexity* and *nature* of a
64tags. These are used to indicate the *complexity* and *nature* of a
129bug. There is not yet a way to indicate priority. An up to date
65bug. There is not yet a way to indicate priority. An up to date
130−summary of issues can be found on [GitHub labels].
66+summary of issues can be found [here](https://github.com/jgm/pandoc/labels).
131
67
132−* [good first issue] — The perfect starting point for new contributors. The
68+* [beginner-friendly] — The perfect starting point for new contributors. The
133 issue is generic and can be resolved without deep knowledge of the code
69 issue is generic and can be resolved without deep knowledge of the code
134 base.
70 base.
135* [enhancement] — A feature which would be desirable. We recommend
71* [enhancement] — A feature which would be desirable. We recommend
@@ -156,19 +92,14 @@ or bug reports related to Markdown are labelled with [format:markdown].
156Have an idea for a new feature?
92Have an idea for a new feature?
157-------------------------------
93-------------------------------
158
94
159−First, search [pandoc-discuss] and the issue tracker (both [open issues] *and*
95+First, search [pandoc-discuss] and the issue tracker (both open and closed
160−[closed issues]) to make sure that the idea has not been discussed before.
96+issues) to make sure that the idea has not been discussed before.
161
97
162Explain the rationale for the feature you're requesting. Why would this
98Explain 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
@@ -205,7 +136,7 @@ Please follow these guidelines:
205 below under [Tests](#tests).) If you are adding a new writer or reader,
136 below under [Tests](#tests).) If you are adding a new writer or reader,
206 you must include tests.
137 you must include tests.
207
138
208−7. If you are adding a new feature, include updates to `MANUAL.txt`.
139+7. If you are adding a new feature, include updates to MANUAL.txt.
209
140
2108. All code must be released under the general license governing pandoc
1418. All code must be released under the general license governing pandoc
211 (GPL v2).
142 (GPL v2).
@@ -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,29 +182,31 @@ 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
200+```
332− :set -fobject-code
201+:set -fobject-code
333− :set -XTypeSynonymInstances
202+:set -XTypeSynonymInstances
334− :set -XScopedTypeVariables
203+:set -XScopedTypeVariables
335− :set -XOverloadedStrings
204+:set -XOverloadedStrings
205+```
336
206
337Profiling
207Profiling
338---------
208---------
339
209
340−To diagnose a performance issue with parsing, first try using
341−the `--trace` option. This will give you a record of when block
342−parsers succeed, so you can spot backtracking issues.
343−
344To use the GHC profiler with cabal:
210To use the GHC profiler with cabal:
345
211
346 cabal clean
212 cabal clean
@@ -376,7 +242,7 @@ The code
376--------
242--------
377
243
378Pandoc has a publicly accessible git repository on
244Pandoc has a publicly accessible git repository on
379−GitHub: <https://github.com/jgm/pandoc>. To get a local copy of the source:
245+github: <http://github.com/jgm/pandoc>. To get a local copy of the source:
380
246
381 git clone https://github.com/jgm/pandoc.git
247 git clone https://github.com/jgm/pandoc.git
382
248
@@ -386,7 +252,7 @@ the pandoc library is in `src/`, the source for the tests is in
386
252
387The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
253The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and
388`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can
254`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can
389−be found in <https://github.com/jgm/pandoc-types>.
255+be found in a <http://github.com/jgm/pandoc-types>.
390
256
391To build pandoc, you will need a working installation of the
257To build pandoc, you will need a working installation of the
392[Haskell platform].
258[Haskell platform].
@@ -399,18 +265,18 @@ The library is structured as follows:
399 - `Text.Pandoc.Definition` (in `pandoc-types`) defines the types
265 - `Text.Pandoc.Definition` (in `pandoc-types`) defines the types
400 used for representing a pandoc document.
266 used for representing a pandoc document.
401 - `Text.Pandoc.Builder` (in `pandoc-types`) provides functions for
267 - `Text.Pandoc.Builder` (in `pandoc-types`) provides functions for
402− building pandoc documents programmatically.
268+ building pandoc documents programatically.
403 - `Text.Pandoc.Generics` (in `pandoc-types`) provides functions allowing
269 - `Text.Pandoc.Generics` (in `pandoc-types`) provides functions allowing
404 you to promote functions that operate on parts of pandoc documents
270 you to promote functions that operate on parts of pandoc documents
405 to functions that operate on whole pandoc documents, walking the
271 to functions that operate on whole pandoc documents, walking the
406 tree automatically.
272 tree automatically.
407 - `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*`
273 - `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*`
408 are the writers.
274 are the writers.
409− - `Text.Pandoc.Citeproc.*` contain the code for citation handling,
275+ - `Text.Pandoc.Biblio` is a utility module for formatting citations
410− including an interface to the [citeproc] library.
276+ using citeproc-hs.
411 - `Text.Pandoc.Data` is used to embed data files when the `embed_data_files`
277 - `Text.Pandoc.Data` is used to embed data files when the `embed_data_files`
412− cabal flag is used.
278+ cabal flag is used. It is generated from `src/Text/Pandoc/Data.hsb` using
413− - `Text.Pandoc.Emoji` is a thin wrapper around [emojis].
279+ the preprocessor [hsb2hs].
414 - `Text.Pandoc.Highlighting` contains the interface to the
280 - `Text.Pandoc.Highlighting` contains the interface to the
415 skylighting library, which is used for code syntax highlighting.
281 skylighting library, which is used for code syntax highlighting.
416 - `Text.Pandoc.ImageSize` is a utility module containing functions for
282 - `Text.Pandoc.ImageSize` is a utility module containing functions for
@@ -421,6 +287,7 @@ The library is structured as follows:
421 - `Text.Pandoc.PDF` contains functions for producing a PDF from a
287 - `Text.Pandoc.PDF` contains functions for producing a PDF from a
422 LaTeX source.
288 LaTeX source.
423 - `Text.Pandoc.Parsing` contains parsing functions used in multiple readers.
289 - `Text.Pandoc.Parsing` contains parsing functions used in multiple readers.
290+ - `Text.Pandoc.Pretty` is a pretty-printing library specialized to
424 the needs of pandoc.
291 the needs of pandoc.
425 - `Text.Pandoc.SelfContained` contains functions for making an HTML
292 - `Text.Pandoc.SelfContained` contains functions for making an HTML
426 file "self-contained," by importing remotely linked images, CSS,
293 file "self-contained," by importing remotely linked images, CSS,
@@ -437,30 +304,14 @@ The library is structured as follows:
437 - `Text.Pandoc.UUID` contains functions for generating UUIDs.
304 - `Text.Pandoc.UUID` contains functions for generating UUIDs.
438 - `Text.Pandoc.XML` contains functions for formatting XML.
305 - `Text.Pandoc.XML` contains functions for formatting XML.
439
306
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
448−[closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed
449−[latest released version]: https://github.com/jgm/pandoc/releases/latest
450−[Nightly builds]: https://github.com/jgm/pandoc/actions?query=workflow%3ANightly
451−[pandoc-discuss]: https://groups.google.com/group/pandoc-discuss
307+[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss
452[issue tracker]: https://github.com/jgm/pandoc/issues
308[issue tracker]: https://github.com/jgm/pandoc/issues
453−[User's Guide]: https://pandoc.org/MANUAL.html
309+[User's Guide]: http://pandoc.org/MANUAL.html
454−[FAQs]: https://pandoc.org/faqs.html
310+[FAQs]: http://pandoc.org/faqs.html
455−[EditorConfig]: https://editorconfig.org/
311+[EditorConfig]: http://editorconfig.org/
456−[Haskell platform]: https://www.haskell.org/platform/
312+[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
313+[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
314+[beginner-friendly]: https://github.com/jgm/pandoc/labels/beginner-friendly
463−[good first issue]:https://github.com/jgm/pandoc/labels/good%20first%20issue
464[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
315[enhancement]: https://github.com/jgm/pandoc/labels/enhancement
465[bug]: https://github.com/jgm/pandoc/labels/bug
316[bug]: https://github.com/jgm/pandoc/labels/bug
466[complexity:low]: https://github.com/jgm/pandoc/labels/complexity:low
317[complexity:low]: https://github.com/jgm/pandoc/labels/complexity:low
@@ -473,3 +324,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
324[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
325[status:more-info-needed]: https://github.com/jgm/pandoc/labels/status:more-info-needed
475[stack]: https://github.com/commercialhaskell/stack
326[stack]: https://github.com/commercialhaskell/stack
327+
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
357you may consider it more useful to permit linking proprietary
358applications with the library. If this is what you want to do, use the
358applications with the library. If this is what you want to do, use the
359[GNU Lesser General Public
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.
361License.
COPYRIGHT+36−55
@@ -1,5 +1,5 @@
1Pandoc
1Pandoc
2−Copyright (C) 2006-2021 John MacFarlane <jgm at berkeley dot edu>
2+Copyright (C) 2006-2017 John MacFarlane <jgm at berkeley dot edu>
3
3
4With the exceptions noted below, this code is released under the [GPL],
4With the exceptions noted below, this code is released under the [GPL],
5version 2 or later:
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
22the source distribution. On Debian systems, the complete text of the
23GPL can be found in `/usr/share/common-licenses/GPL`.
23GPL can be found in `/usr/share/common-licenses/GPL`.
24
24
25−[GPL]: https://www.gnu.org/copyleft/gpl.html
25+[GPL]: http://www.gnu.org/copyleft/gpl.html
26
26
27Pandoc's complete source code is available from the [Pandoc home page].
27Pandoc's complete source code is available from the [Pandoc home page].
28
28
29−[Pandoc home page]: https://pandoc.org
29+[Pandoc home page]: http://pandoc.org
30
30
31Pandoc includes some code with different copyrights, or subject to different
31Pandoc includes some code with different copyrights, or subject to different
32licenses. The copyright and license statements for these sources are included
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,
37Text.Pandoc.Builder, Text.Pandoc.Generics, Text.Pandoc.JSON,
38Text.Pandoc.Walk) are licensed under the BSD 3-clause license:
38Text.Pandoc.Walk) are licensed under the BSD 3-clause license:
39
39
40−Copyright (c) 2006-2021, John MacFarlane
40+Copyright (c) 2006-2017, John MacFarlane
41
41
42All rights reserved.
42All rights reserved.
43
43
@@ -69,33 +69,32 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
69OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
69OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
70
70
71----------------------------------------------------------------------
71----------------------------------------------------------------------
72−Pandoc's templates (in `data/templates`) are dual-licensed as either
72+Pandoc's templates (in `data/templates`) are dual-licensed GPL (v2 or
73−GPL (v2 or higher, same as pandoc) or (at your option) the BSD
73+higher, same as pandoc) and the BSD 3-clause license.
74−3-clause license.
75
74
76−Copyright (c) 2014--2021, John MacFarlane
75+Copyright (c) 2014--2017, John MacFarlane
77
76
78----------------------------------------------------------------------
77----------------------------------------------------------------------
79src/Text/Pandoc/Writers/Muse.hs
78src/Text/Pandoc/Writers/Muse.hs
80−Copyright (C) 2017-2020 Alexander Krotov
79+Copyright (C) 2017 Alexander Krotov
81
80
82Released under the GNU General Public License version 2 or later.
81Released under the GNU General Public License version 2 or later.
83
82
84----------------------------------------------------------------------
83----------------------------------------------------------------------
85src/Text/Pandoc/Writers/Texinfo.hs
84src/Text/Pandoc/Writers/Texinfo.hs
86−Copyright (C) 2008-2021 John MacFarlane and Peter Wang
85+Copyright (C) 2008-2017 John MacFarlane and Peter Wang
87
86
88Released under the GNU General Public License version 2 or later.
87Released under the GNU General Public License version 2 or later.
89
88
90----------------------------------------------------------------------
89----------------------------------------------------------------------
91src/Text/Pandoc/Writers/OpenDocument.hs
90src/Text/Pandoc/Writers/OpenDocument.hs
92−Copyright (C) 2008-2021 Andrea Rossato and John MacFarlane
91+Copyright (C) 2008-2017 Andrea Rossato and John MacFarlane
93
92
94Released under the GNU General Public License version 2 or later.
93Released under the GNU General Public License version 2 or later.
95
94
96----------------------------------------------------------------------
95----------------------------------------------------------------------
97src/Text/Pandoc/Writers/Org.hs
96src/Text/Pandoc/Writers/Org.hs
98−Copyright (C) 2010-2021 Puneeth Chaganti, John MacFarlane, and
97+Copyright (C) 2010-2017 Puneeth Chaganti, John MacFarlane, and
99 Albert Krewinkel
98 Albert Krewinkel
100
99
101Released under the GNU General Public License version 2 or later.
100Released under the GNU General Public License version 2 or later.
@@ -109,81 +108,54 @@ Released under the GNU General Public License version 2 or later.
109----------------------------------------------------------------------
108----------------------------------------------------------------------
110src/Text/Pandoc/Readers/Docx.hs
109src/Text/Pandoc/Readers/Docx.hs
111src/Text/Pandoc/Readers/Docx/*
110src/Text/Pandoc/Readers/Docx/*
112−Copyright (C) 2014-2020 Jesse Rosenthal
111+Copyright (C) 2014-2017 Jesse Rosenthal
113
112
114Released under the GNU General Public License version 2 or later.
113Released under the GNU General Public License version 2 or later.
115
114
116----------------------------------------------------------------------
115----------------------------------------------------------------------
117src/Text/Pandoc/Readers/Textile.hs
116src/Text/Pandoc/Readers/Textile.hs
118−Copyright (C) 2010-2021 Paul Rivier and John MacFarlane
117+Copyright (C) 2010-2017 Paul Rivier and John MacFarlane
119−
120−Released under the GNU General Public License version 2 or later.
121−
122−----------------------------------------------------------------------
123−src/Text/Pandoc/Readers/TikiWiki.hs
124−Copyright (C) 2017 Robin Lee Powell
125−
126−Released under the GNU General Public License version 2 or later.
127−
128−----------------------------------------------------------------------
129−src/Text/Pandoc/Readers/JATS.hs
130−Copyright (C) 2017-2018 Hamish Mackenzie
131−
132−Released under the GNU General Public License version 2 or later.
133−
134−----------------------------------------------------------------------
135−src/Text/Pandoc/Readers/EPUB.hs
136−Copyright (C) 2014-2021 Matthew Pickering and John MacFarlane
137
118
138Released under the GNU General Public License version 2 or later.
119Released under the GNU General Public License version 2 or later.
139
120
140----------------------------------------------------------------------
121----------------------------------------------------------------------
141src/Text/Pandoc/Readers/Org.hs
122src/Text/Pandoc/Readers/Org.hs
142−src/Text/Pandoc/Readers/Org/*
143−test/Tests/Readers/Org/*
123+test/Tests/Readers/Org.hs
144−Copyright (C) 2014-2021 Albert Krewinkel
145−
146−Released under the GNU General Public License version 2 or later.
147−
148−----------------------------------------------------------------------
149−src/Text/Pandoc/Lua.hs
150−src/Text/Pandoc/Lua/*
151−test/lua/*
152−Copyright (C) 2017--2021 Albert Krewinkel and John MacFarlane
124+Copyright (C) 2014-2017 Albert Krewinkel
153
125
154Released under the GNU General Public License version 2 or later.
126Released under the GNU General Public License version 2 or later.
155
127
156----------------------------------------------------------------------
128----------------------------------------------------------------------
157−src/Text/Pandoc/Readers/Jira.hs
129+data/LaTeXMathML.js
158−src/Text/Pandoc/Writers/Jira.hs
130+Adapted by Jeff Knisely and Douglas Woodall from
159−test/Tests/Readers/Jira.hs
131+ASCIIMathML.js v. 1.4.7
160−Copyright (C) 2019--2021 Albert Krewinkel
132+Copyright (C) 2005 Peter Jipsen
161
133
162Released under the GNU General Public License version 2 or later.
134Released under the GNU General Public License version 2 or later.
163
135
164----------------------------------------------------------------------
136----------------------------------------------------------------------
165−src/Text/Pandoc/Readers/FB2.hs
137+data/MathMLinHTML.js
166−Copyright (C) 2018--2019 Alexander Krotov
138+Copyright (C) 2004 Peter Jipsen http://www.chapman.edu/~jipsen
167
139
168Released under the GNU General Public License version 2 or later.
140Released under the GNU General Public License version 2 or later.
169
141
170−----------------------------------------------------------------------
142+------------------------------------------------------------------------
171data/pandoc.lua
143data/pandoc.lua
172−Copyright (C) 2017-2021 Albert Krewinkel
144+Copyright (C) 2017 Albert Krewinkel
173
145
174Released under the GNU General Public License version 2 or later.
146Released under the GNU General Public License version 2 or later.
175
147
176----------------------------------------------------------------------
148----------------------------------------------------------------------
177−The dzslides template contains JavaScript and CSS from Paul Rouget's
149+The dzslides template contains javascript and CSS from Paul Rouget's
178dzslides template.
150dzslides template.
179−https://github.com/paulrouget/dzslides
151+http://github.com/paulrouget/dzslides
180
152
181Released under the Do What the Fuck You Want To Public License.
153Released under the Do What the Fuck You Want To Public License.
182
154
183------------------------------------------------------------------------
155------------------------------------------------------------------------
184−Pandoc embeds a Lua interpreter (via hslua).
156+Pandoc embeds a lua interpreter (via hslua).
185
157
186−Copyright © 1994–2020 Lua.org, PUC-Rio.
158+Copyright © 1994–2015 Lua.org, PUC-Rio.
187
159
188Permission is hereby granted, free of charge, to any person obtaining
160Permission is hereby granted, free of charge, to any person obtaining
189a copy of this software and associated documentation files (the
161a copy of this software and associated documentation files (the
@@ -203,3 +175,12 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
203LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
175LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
204OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
176OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
205WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
177WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
178+
179+------------------------------------------------------------------------
180+The template pandoc.jats is Copyright 2013--15 Martin Fenner,
181+released under GPL version 2 or later.
182+
183+The file data/jats.csl is derived from a csl file by Martin Fenner,
184+revised by Martin Paul Eve and then John MacFarlane.
185+"This work is licensed under a Creative Commons Attribution-ShareAlike 3.0
186+License. Originally by Martin Fenner."
INSTALL.md+123−179
@@ -1,167 +1,96 @@
1# Installing pandoc
1# Installing pandoc
2
2
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
14
4
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
17−update your path to include the directory where pandoc's
18−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
6
28− choco install pandoc
7+ - For PDF output, you'll also need to install LaTeX.
8+ We recommend [MiKTeX](http://miktex.org/).
29
9
30−Chocolatey can also install other software that integrates with Pandoc.
10+ - If you'd prefer, you can extract the pandoc and pandoc-citeproc
31−For example, to install `rsvg-convert` (from [librsvg], covering formats
11+ executables from the MSI and copy them directly to any directory,
32−without SVG support), [Python] (to use Pandoc filters), and
12+ without running the installer. Here is an example showing how to
33−[MiKTeX] (to typeset PDFs with [LaTeX]):
13+ extract the executables from the pandoc-1.19.1 installer and copy
14+ them to `C:\Utils\Console\`:
34
15
35− choco install rsvg-convert python miktex
16+ mkdir "%TEMP%\pandoc\"
36−
17+ start /wait msiexec.exe /a pandoc-1.19.1-windows.msi /qn targetdir="%TEMP%\pandoc\"
37−Using multiple installation methods can result in two separate
18+ copy /y "%TEMP%\pandoc\pandoc.exe" C:\Utils\Console\
38−installations of pandoc; it is recommended to properly uninstall
19+ copy /y "%TEMP%\pandoc\pandoc-citeproc.exe" C:\Utils\Console\
39−pandoc before switching to an alternative installation method.
20+ rmdir /s /q "%TEMP%\pandoc\"
40−
41−By default, Pandoc creates PDFs using LaTeX.
42−We recommend installing it via [MiKTeX].
43
21
44## macOS
22## macOS
45
23
46−There is a package installer at pandoc's [download page].
24+ - There is a package installer at pandoc's [download page].
47−If you later want to uninstall the package, you can do so
25+ If you later want to uninstall the package, you can do so
48−by downloading [this script][uninstaller]
26+ by downloading [this script][uninstaller]
49−and running it with `perl uninstall-pandoc.pl`.
27+ and running it with `perl uninstall-pandoc.pl`.
50−
51−Alternatively, you can install pandoc using
52−[Homebrew](https://brew.sh):
53−
54− brew install pandoc
55−
56−Homebrew can also install other software that integrates with Pandoc.
57−For example, to install [librsvg] (its `rsvg-convert` covers formats
58−without SVG support), [Python] (to use Pandoc filters), and
59−[BasicTeX] (to typeset PDFs with [LaTeX]):
60
28
61− brew install librsvg python homebrew/cask/basictex
29+ - It is possible to extract the pandoc and pandoc-citeproc
30+ executables from the macOS pkg file, if you'd rather not run
31+ the installer. To do this (for the version 1.19.1 package):
62
32
63−Note: On unsupported versions of macOS (more than three releases old),
33+ mkdir pandoc-extract
64−Homebrew installs from source, which takes additional time and disk space
34+ cd pandoc-extract
65−for the `ghc` compiler and dependent Haskell libraries.
35+ xar -x ../pandoc-2.0-macOS.pkg
36+ cat pandoc.pkg/Payload | gunzip -dc | cpio -i
37+ # executables are now in ./usr/bin/, man pages in ./usr/share/man
66
38
67−We also provide a zip file containing the binaries and man
39+ - You can also install pandoc using
68−pages, for those who prefer not to use the installer. Simply
40+ [homebrew](http://brew.sh): `brew install pandoc`.
69−unzip the file and move the binaries and man pages to
70−whatever directory you like.
71
41
72−By default, Pandoc creates PDFs using LaTeX. Because a full [MacTeX]
42+ - For PDF output, you'll also need LaTeX. Because a full [MacTeX]
73−installation uses four gigabytes of disk space, we recommend
43+ installation takes more than a gigabyte of disk space, we recommend
74−[BasicTeX] or [TinyTeX](https://yihui.org/tinytex/)
44+ installing [BasicTeX](http://www.tug.org/mactex/morepackages.html)
75−and using the `tlmgr` tool to install additional packages
45+ (64M) and using the `tlmgr` tool to install additional packages
76−as needed. If you receive errors warning of fonts not found:
46+ as needed. If you get errors warning of fonts not found, try
77
47
78− tlmgr install collection-fontsrecommended
48+ tlmgr install collection-fontsrecommended
79
49
80## Linux
50## Linux
81
51
82−Check whether the pandoc version in your package manager is
52+ - First, try your package manager.
83−not outdated. Pandoc is in the [Debian], [Ubuntu], [Slackware],
53+ Pandoc is in the [Debian], [Ubuntu], [Slackware],
84−[Arch], [Fedora], [NiXOS], [openSUSE], [gentoo] and [Void] repositories.
54+ [Arch], [Fedora], [NiXOS], [openSUSE], and [gentoo] repositories.
55+ Note, however, that versions in the repositories are often
56+ old.
85
57
86−To get the latest release, we provide a binary package for amd64
58+ - For 64-bit [Debian] and [Ubuntu], we provide a debian package
87−architecture on the **[download page]**.
59+ on the [download page].
88
60
89−The executable is statically linked and
61+ sudo dpkg -i $DEB
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
62
95−Both a tarball and a deb installer are provided. To install the deb:
63+ where `$DEB` is the path to the downloaded deb, will
64+ install the `pandoc` and `pandoc-citeproc` executables
65+ and man pages.
96
66
97− sudo dpkg -i $DEB
67+ - If you use an RPM-based distro, you may be
68+ able to install this deb using `alien`, or try
98
69
99−where `$DEB` is the path to the downloaded deb. This will
70+ ar p $DEB data.tar.gz | sudo tar xvz --strip-components 2 -C /usr/local
100−install the `pandoc` executable and man page.
101
71
102−If you use an RPM-based distro, you may be able to install
72+ - If you'd rather install pandoc in your home directory, say
103−the deb from our download page using `alien`.
73+ in `$HOME/.local`, then you can extract the files manually
74+ from the deb:
104
75
105−On any distro, you may install from the tarball into `$DEST`
76+ ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $HOME/.local/
106−(say, `/usr/local/` or `$HOME/.local`) by doing
107
77
108− tar xvzf $TGZ --strip-components 1 -C $DEST
78+ where, again, `$DEB` is the path to the downloaded deb.
109
79
110−where `$TGZ` is the path to the downloaded zipped tarball.
80+ - If the version in your repository is too old and you cannot
111−For Pandoc versions before 2.0, which don't provide
81+ use the deb we provide, you can install from source, using the
112−a tarball, try instead
82+ instructions below under [Compiling from source].
83+ Note that most distros have the Haskell platform in their
84+ package repositories. For example, on Debian/Ubuntu,
85+ you can install it with `apt-get install haskell-platform`.
113
86
114− ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST
115−
116−You can also install from source, using the
117−instructions below under [Compiling from source].
118−Note that most distros have the Haskell platform in their
119−package repositories. For example, on Debian/Ubuntu,
120−you can install it with `apt-get install haskell-platform`.
121−
122−For PDF output, you'll need LaTeX. We recommend installing
87+ - For PDF output, you'll need LaTeX. We recommend installing
123−[TeX Live](https://www.tug.org/texlive/) via your package
88+ [TeX Live](http://www.tug.org/texlive/) via your package
124−manager. (On Debian/Ubuntu, `apt-get install texlive`.)
89+ manager. (On Debian/Ubuntu, `apt-get install texlive`.)
125−
126−## Chrome OS
127−
128−On Chrome OS, pandoc can be installed using the
129−[chromebrew](https://github.com/skycocker/chromebrew) package manager
130−with the command:
131−
132−```sh
133−crew install pandoc
134−```
135−
136−This will automatically build and configure pandoc for the specific
137−device you are using.
138
90
139## BSD
91## BSD
140
92
141−Pandoc is in the [NetBSD] and [FreeBSD ports] repositories.
93+ - 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
94
166## Compiling from source
95## Compiling from source
167
96
@@ -191,14 +120,14 @@ the last released version.
191
120
192### Quick stack method
121### Quick stack method
193
122
194−The easiest way to build pandoc from source is to use [stack][stack]:
123+The easiest way to build pandoc from source is to use [stack]:
195
124
196−1. Install [stack][stack]. Note that Pandoc requires stack >= 1.7.0.
125+1. Install [stack].
197
126
1982. Change to the pandoc source directory and issue the following commands:
1272. Change to the pandoc source directory and issue the following commands:
199
128
200 stack setup
129 stack setup
201− stack install
130+ stack install --test
202
131
203 `stack setup` will automatically download the ghc compiler
132 `stack setup` will automatically download the ghc compiler
204 if you don't have it. `stack install` will install the
133 if you don't have it. `stack install` will install the
@@ -210,23 +139,15 @@ The easiest way to build pandoc from source is to use [stack][stack]:
210
139
2111. Install the [Haskell platform]. This will give you [GHC] and
1401. Install the [Haskell platform]. This will give you [GHC] and
212 the [cabal-install] build tool. Note that pandoc requires
141 the [cabal-install] build tool. Note that pandoc requires
213− GHC >= 7.10 and cabal >= 2.0.
142+ GHC >= 7.8.
214
143
2152. Update your package database:
1442. Update your package database:
216
145
217 cabal update
146 cabal update
218
147
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:
148+3. Use `cabal` to install pandoc and its dependencies:
228
149
229− cabal install pandoc
150+ cabal install pandoc --enable-tests
230
151
231 This procedure will install the released version of pandoc,
152 This procedure will install the released version of pandoc,
232 which will be downloaded automatically from HackageDB.
153 which will be downloaded automatically from HackageDB.
@@ -237,35 +158,42 @@ The easiest way to build pandoc from source is to use [stack][stack]:
237
158
238 cabal install
159 cabal install
239
160
240−5. Make sure the `$CABALDIR/bin` directory is in your path. You should
161+4. Make sure the `$CABALDIR/bin` directory is in your path. You should
241 now be able to run `pandoc`:
162 now be able to run `pandoc`:
242
163
243 pandoc --help
164 pandoc --help
244
165
245− [Not sure where `$CABALDIR` is?](https://wiki.haskell.org/Cabal-Install#The_cabal-install_configuration_file)
166+ [Not sure where `$CABALDIR` is?](http://www.haskell.org/haskellwiki/Cabal-Install#The_cabal-install_configuration_file)
246
167
168+5. If you want to process citations with pandoc, you will also need to
169+ install a separate package, `pandoc-citeproc`. This can be installed
170+ using cabal:
171+
172+ cabal install pandoc-citeproc
173+
247−5. By default `pandoc` uses the "i;unicode-casemap" method
174+ By default `pandoc-citeproc` uses the "i;unicode-casemap" method
248 to sort bibliography entries (RFC 5051). If you would like to
175 to sort bibliography entries (RFC 5051). If you would like to
249 use the locale-sensitive unicode collation algorithm instead,
176 use the locale-sensitive unicode collation algorithm instead,
250− specify the `icu` flag (which affects the dependency `citeproc`):
177+ specify the `unicode_collation` flag:
251
178
252− cabal install pandoc -ficu
179+ cabal install pandoc-citeproc -funicode_collation
253
180
254 Note that this requires the `text-icu` library, which in turn
181 Note that this requires the `text-icu` library, which in turn
255 depends on the C library `icu4c`. Installation directions
182 depends on the C library `icu4c`. Installation directions
256− vary by platform. Here is how it might work on macOS with Homebrew:
183+ vary by platform. Here is how it might work on macOS with homebrew:
257
184
258 brew install icu4c
185 brew install icu4c
259− stack install pandoc \
186+ cabal install --extra-lib-dirs=/usr/local/Cellar/icu4c/51.1/lib \
260− --flag "citeproc:icu" \
187+ --extra-include-dirs=/usr/local/Cellar/icu4c/51.1/include \
261− --extra-lib-dirs=/usr/local/opt/icu4c/lib \
188+ -funicode_collation text-icu pandoc-citeproc
262− --extra-include-dirs=/usr/local/opt/icu4c/include
263
189
2646. The `pandoc.1` man page will be installed automatically. cabal shows
1906. The `pandoc.1` man page will be installed automatically. cabal shows
265 you where it is installed: you may need to set your `MANPATH`
191 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
192 accordingly. If `MANUAL.txt` has been modified, the man page can be
267 rebuilt: `make man/pandoc.1`.
193 rebuilt: `make man/pandoc.1`.
268
194
195+ The `pandoc-citeproc.1` man page will also be installed automatically.
196+
269
197
270### Custom cabal method
198### Custom cabal method
271
199
@@ -274,7 +202,6 @@ over the build and installation. Most users should use the
274quick install, but this information may be of use to packagers.
202quick install, but this information may be of use to packagers.
275For more details, see the [Cabal User's Guide]. These instructions
203For more details, see the [Cabal User's Guide]. These instructions
276assume that the pandoc source directory is your working directory.
204assume that the pandoc source directory is your working directory.
277−You will need cabal version 2.0 or higher.
278
205
2791. Install dependencies: in addition to the [Haskell platform],
2061. Install dependencies: in addition to the [Haskell platform],
280 you will need a number of additional libraries. You can install
207 you will need a number of additional libraries. You can install
@@ -347,7 +274,6 @@ test`.
347To run particular tests (pattern-matching on their names), use
274To run particular tests (pattern-matching on their names), use
348the `-p` option:
275the `-p` option:
349
276
350− cabal install pandoc --enable-tests
351 cabal test --test-options='-p markdown'
277 cabal test --test-options='-p markdown'
352
278
353Or with stack:
279Or with stack:
@@ -385,31 +311,49 @@ To run just the markdown benchmarks:
385
311
386 cabal bench --benchmark-options='markdown'
312 cabal bench --benchmark-options='markdown'
387
313
314+### Building the whole pandoc ecosystem
315+
316+Sometimes pandoc's development code depends on unreleased versions
317+of dependent libraries. You'll need to build these as well. A
318+maximal build method would be
319+
320+ mkdir pandoc-build
321+ cd pandoc-build
322+ git clone https://github.com/jgm/pandoc-types
323+ git clone https://github.com/jgm/texmath
324+ git clone https://github.com/jgm/pandoc-citeproc
325+ git clone https://github.com/jgm/pandoc
326+ git clone https://github.com/jgm/cmark-hs
327+ git clone https://github.com/jgm/zip-archive
328+ cd pandoc
329+ stack install --test --install-ghc --stack-yaml stack.full.yaml
330+
331+To pull in the latest changes, after you've done this and there have been
332+changes in the repositories: Visit each repository in pandoc-build
333+(pandoc-types, texmath, pandoc-citeproc, pandoc, zip-archive, cmark-hs) and do
334+`git pull`. In the pandoc repo, also do `stack install --test
335+--stack-yaml stack.full.yaml`.
336+
388
337
389[Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/
338[Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/
390−[Cabal User's Guide]: https://cabal.readthedocs.io/
339+[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
340+[Debian]: http://packages.debian.org/lenny/pandoc
392[Fedora]: https://apps.fedoraproject.org/packages/pandoc
341[Fedora]: https://apps.fedoraproject.org/packages/pandoc
393−[FreeBSD ports]: https://www.freshports.org/textproc/hs-pandoc/
342+[FreeBSD ports]: http://www.freshports.org/textproc/pandoc/
394−[GHC]: https://www.haskell.org/ghc/
343+[GHC]: http://www.haskell.org/ghc/
344+[GPL]: http://www.gnu.org/copyleft/gpl.html
395−[Haskell platform]: https://hackage.haskell.org/platform/
345+[Haskell platform]: http://hackage.haskell.org/platform/
396−[MacPorts]: https://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile
346+[MacPorts]: http://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile
397[MacTeX]: https://tug.org/mactex/
347[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
348+[NetBSD]: http://pkgsrc.se/wip/pandoc
404−[NixOS]: https://nixos.org/nixos/packages.html
349+[NixOS]: http://nixos.org/nixos/
405−[Slackware]: https://www.slackbuilds.org/result/?search=pandoc&sv=
350+[Slackware]: http://www.linuxpackages.net/search_view.php?by=name&name=pandoc&ver=
406−[Ubuntu]: https://packages.ubuntu.com/pandoc
351+[Ubuntu]: http://www.ubuntu.com
407[download page]: https://github.com/jgm/pandoc/releases/latest
352[download page]: https://github.com/jgm/pandoc/releases/latest
408−[gentoo]: https://packages.gentoo.org/package/app-text/pandoc
353+[gentoo]: http://packages.gentoo.org/package/app-text/pandoc
409[haskell repository]: https://wiki.archlinux.org/index.php/Haskell_Package_Guidelines#.5Bhaskell.5D
354[haskell repository]: https://wiki.archlinux.org/index.php/Haskell_Package_Guidelines#.5Bhaskell.5D
410[openSUSE]: https://software.opensuse.org/package/pandoc
355[openSUSE]: https://software.opensuse.org/package/pandoc
411−[source tarball]: https://hackage.haskell.org/package/pandoc
356+[source tarball]: http://hackage.haskell.org/package/pandoc
412−[stack]: https://docs.haskellstack.org/en/stable/install_and_upgrade.html
357+[stack]: http://docs.haskellstack.org/en/stable/install_and_upgrade.html
413−[cabal-install]: https://hackage.haskell.org/package/cabal-install
358+[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
359[uninstaller]: https://raw.githubusercontent.com/jgm/pandoc/master/macos/uninstall-pandoc.pl
MANUAL.txt+1725−3963
@@ -1,34 +1,50 @@
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 26, 2017
5−---
6
4
7−# Synopsis
5+Synopsis
6+========
8
7
9`pandoc` [*options*] [*input-file*]...
8`pandoc` [*options*] [*input-file*]...
10
9
11−# Description
10+Description
11+===========
12
12
13Pandoc is a [Haskell] library for converting from one markup format to
13Pandoc is a [Haskell] library for converting from one markup format to
14−another, and a command-line tool that uses this library.
14+another, and a command-line tool that uses this library. It can read
15−
15+[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored
16−Pandoc can convert between numerous markup and word processing formats,
16+Markdown], [MultiMarkdown], and (subsets of) [Textile],
17−including, but not limited to, various flavors of [Markdown], [HTML],
17+[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],
18−[LaTeX] and [Word docx]. For the full lists of input and output formats,
18+[TikiWiki markup], [Haddock markup], [OPML], [Emacs Org mode], [DocBook],
19−see the `--from` and `--to` [options below][General options].
19+[Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and [Word docx]; and it can
20+write plain text, [Markdown], [CommonMark], [PHP Markdown
21+Extra], [GitHub-Flavored Markdown], [MultiMarkdown],
22+[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including
23+[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook],
24+[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
25+markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
26+[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
27+[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
28+Simple], [Muse] and [Slidy], [Slideous], [DZSlides], [reveal.js]
20−Pandoc can also produce [PDF] output: see [creating a PDF], below.
29+or [S5] HTML slide shows. It can also produce [PDF] output on
21−
30+systems where LaTeX, ConTeXt, `pdfroff`, or `wkhtmltopdf` is
31+installed.
32+
22−Pandoc's enhanced version of Markdown includes syntax for [tables],
33+Pandoc's enhanced version of Markdown includes syntax for [footnotes],
23−[definition lists], [metadata blocks], [footnotes], [citations], [math],
34+[tables], flexible [ordered lists], [definition lists], [fenced code
24−and much more. See below under [Pandoc's Markdown].
35+blocks], [superscripts and subscripts], [strikeout], [metadata blocks],
25−
36+automatic tables of contents, embedded LaTeX [math], [citations], and
37+[Markdown inside HTML block elements][Extension:
38+`markdown_in_html_blocks`]. (These enhancements, described further under
39+[Pandoc's Markdown], can be disabled using the `markdown_strict` input
40+or output format.)
41+
42+In contrast to most existing tools for converting Markdown to HTML, which
26−Pandoc has a modular design: it consists of a set of readers, which parse
43+use regex substitutions, pandoc has a modular design: it consists of a
27−text in a given format and produce a native representation of the document
44+set of readers, which parse text in a given format and produce a native
28−(an _abstract syntax tree_ or AST), and a set of writers, which convert
45+representation of the document, and a set of writers, which convert
29this native representation into a target format. Thus, adding an input
46this native representation into a target format. Thus, adding an input
30−or output format requires only adding a reader or writer. Users can also
47+or output format requires only adding a reader or writer.
31−run custom [pandoc filters] to modify the intermediate AST.
32
48
33Because pandoc's intermediate representation of a document is less
49Because pandoc's intermediate representation of a document is less
34expressive than many of the formats it converts between, one should
50expressive than many of the formats it converts between, one should
@@ -40,33 +56,95 @@ model. While conversions from pandoc's Markdown to all formats aspire
40to be perfect, conversions from formats more expressive than pandoc's
56to be perfect, conversions from formats more expressive than pandoc's
41Markdown can be expected to be lossy.
57Markdown can be expected to be lossy.
42
58
59+[Markdown]: http://daringfireball.net/projects/markdown/
60+[CommonMark]: http://commonmark.org
61+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
62+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
63+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
64+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
65+[S5]: http://meyerweb.com/eric/tools/s5/
66+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
67+[Slideous]: http://goessner.net/articles/slideous/
68+[HTML]: http://www.w3.org/html/
69+[HTML5]: http://www.w3.org/TR/html5/
70+[polyglot markup]: https://www.w3.org/TR/html-polyglot/
71+[XHTML]: http://www.w3.org/TR/xhtml1/
72+[LaTeX]: http://latex-project.org
73+[`beamer`]: https://ctan.org/pkg/beamer
74+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
75+[ConTeXt]: http://www.contextgarden.net/
76+[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
77+[DocBook]: http://docbook.org
78+[txt2tags]: http://txt2tags.org
79+[EPUB]: http://idpf.org/epub
80+[OPML]: http://dev.opml.org/spec2.html
81+[OpenDocument]: http://opendocument.xml.org
82+[ODT]: http://en.wikipedia.org/wiki/OpenDocument
83+[Textile]: http://redcloth.org/textile
84+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
85+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
86+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
87+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
88+[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
89+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
90+[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
91+[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
92+[Haskell]: https://www.haskell.org
93+[GNU Texinfo]: http://www.gnu.org/software/texinfo/
94+[Emacs Org mode]: http://orgmode.org
95+[AsciiDoc]: http://www.methods.co.nz/asciidoc/
96+[DZSlides]: http://paulrouget.com/dzslides/
97+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
98+[PDF]: https://www.adobe.com/pdf/
99+[reveal.js]: http://lab.hakim.se/reveal-js/
100+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
101+[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
102+[TEI Simple]: https://github.com/TEIC/TEI-Simple
103+[Muse]: https://amusewiki.org/library/manual
104+[Vimwiki]: https://vimwiki.github.io
105+
43−## Using pandoc
106+Using `pandoc`
107+--------------
44
108
45−If no *input-files* are specified, input is read from *stdin*.
109+If no *input-file* is specified, input is read from *stdin*.
110+Otherwise, the *input-files* are concatenated (with a blank
46−Output goes to *stdout* by default. For output to a file,
111+line between each) and used as input. Output goes to *stdout* by
112+default (though output to the terminal is disabled for the
113+`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is
114+forced using `-o -`). For output to a file, use the `-o`
47−use the `-o` option:
115+option:
48
116
49 pandoc -o output.html input.txt
117 pandoc -o output.html input.txt
50
118
51−By default, pandoc produces a document fragment. To produce a standalone
119+By default, pandoc produces a document fragment, not a standalone
52−document (e.g. a valid HTML file including `<head>` and `<body>`),
120+document with a proper header and footer. To produce a standalone
53−use the `-s` or `--standalone` flag:
121+document, use the `-s` or `--standalone` flag:
54
122
55 pandoc -s -o output.html input.txt
123 pandoc -s -o output.html input.txt
56
124
57For more information on how standalone documents are produced, see
125For more information on how standalone documents are produced, see
58−[Templates] below.
126+[Templates], below.
59
127
60−If multiple input files are given, `pandoc` will concatenate them all (with
128+Instead of a file, an absolute URI may be given. In this case
61−blank lines between them) before parsing. (Use `--file-scope` to parse files
129+pandoc will fetch the content using HTTP:
62−individually.)
63
130
64−## Specifying formats
131+ pandoc -f html -t markdown http://www.fsf.org
132+
133+It is possible to supply a custom User-Agent string or other
134+header when requesting a document from a URL:
135+
136+ pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
137+ http://www.fsf.org
138+
139+If multiple input files are given, `pandoc` will concatenate them all (with
140+blank lines between them) before parsing. This feature is disabled for
141+ binary input formats such as `EPUB`, `odt`, and `docx`.
65
142
66The format of the input and output can be specified explicitly using
143The format of the input and output can be specified explicitly using
67command-line options. The input format can be specified using the
144command-line options. The input format can be specified using the
68−`-f/--from` option, the output format using the `-t/--to` option.
145+`-r/--read` or `-f/--from` options, the output format using the
146+`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from
69−Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:
147+Markdown to LaTeX, you could type:
70
148
71 pandoc -f markdown -t latex hello.txt
149 pandoc -f markdown -t latex hello.txt
72
150
@@ -74,15 +152,14 @@ To convert `hello.html` from HTML to Markdown:
74
152
75 pandoc -f html -t markdown hello.html
153 pandoc -f html -t markdown hello.html
76
154
77−Supported input and output formats are listed below under [Options]
155+Supported output formats are listed below under the `-t/--to` option.
78−(see `-f` for input formats and `-t` for output formats). You
156+Supported input formats are listed below under the `-f/--from` option. Note
79−can also use `pandoc --list-input-formats` and
157+that the `rst`, `textile`, `latex`, and `html` readers are not complete;
80−`pandoc --list-output-formats` to print lists of supported
158+there are some constructs that they do not parse.
81−formats.
82
159
83If the input or output format is not specified explicitly, `pandoc`
160If the input or output format is not specified explicitly, `pandoc`
84−will attempt to guess it from the extensions of the filenames.
161+will attempt to guess it from the extensions of
85−Thus, for example,
162+the input and output filenames. Thus, for example,
86
163
87 pandoc -o hello.tex hello.txt
164 pandoc -o hello.tex hello.txt
88
165
@@ -91,9 +168,7 @@ is specified (so that output goes to *stdout*), or if the output file's
91extension is unknown, the output format will default to HTML.
168extension is unknown, the output format will default to HTML.
92If no input file is specified (so that input comes from *stdin*), or
169If no input file is specified (so that input comes from *stdin*), or
93if the input files' extensions are unknown, the input format will
170if the input files' extensions are unknown, the input format will
94−be assumed to be Markdown.
171+be assumed to be Markdown unless explicitly specified.
95−
96−## Character encoding
97
172
98Pandoc uses the UTF-8 character encoding for both input and output.
173Pandoc uses the UTF-8 character encoding for both input and output.
99If your local character encoding is not UTF-8, you
174If your local character encoding is not UTF-8, you
@@ -106,247 +181,156 @@ RTF, OPML, DocBook, and Texinfo), information about
106the character encoding is included in the document header, which
181the character encoding is included in the document header, which
107will only be included if you use the `-s/--standalone` option.
182will only be included if you use the `-s/--standalone` option.
108
183
109−[`iconv`]: https://www.gnu.org/software/libiconv/
184+[`iconv`]: http://www.gnu.org/software/libiconv/
110
185
111−## Creating a PDF
186+Creating a PDF
187+--------------
112
188
113−To produce a PDF, specify an output file with a `.pdf` extension:
189+To produce a PDF, specify an output file with a `.pdf` extension.
190+By default, pandoc will use LaTeX to create the PDF:
114
191
115 pandoc test.txt -o test.pdf
192 pandoc test.txt -o test.pdf
116
193
117−By default, pandoc will use LaTeX to create the PDF, which requires
118−that a LaTeX engine be installed (see `--pdf-engine` below).
194+Production of a PDF requires that a LaTeX engine be installed (see
119−Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an
195+`--pdf-engine`, below), and assumes that the following LaTeX packages
120−intermediate format. To do this, specify an output file with a
121−`.pdf` extension, as before, but add the `--pdf-engine` option
122−or `-t context`, `-t html`, or `-t ms` to the command line.
123−The tool used to generate the PDF from the intermediate format
124−may be specified using `--pdf-engine`.
125−
126−You can control the PDF style using variables, depending on
127−the intermediate format used: see [variables for LaTeX],
128−[variables for ConTeXt], [variables for `wkhtmltopdf`],
129−[variables for ms]. When HTML is used as an intermediate
130−format, the output can be styled using `--css`.
131−
132−To debug the PDF creation, it can be useful to look at the intermediate
133−representation: instead of `-o test.pdf`, use for example `-s -o test.tex`
134−to output the generated LaTeX. You can then test it with `pdflatex test.tex`.
135−
136−When using LaTeX, the following packages need to be available
137−(they are included with all recent versions of [TeX Live]):
138−[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
196+are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],
139−[`iftex`], [`listings`] (if the
197+[`ifxetex`], [`ifluatex`], [`listings`] (if the
140`--listings` option is used), [`fancyvrb`], [`longtable`],
198`--listings` option is used), [`fancyvrb`], [`longtable`],
141−[`booktabs`], [`graphicx`] (if the document
199+[`booktabs`], [`graphicx`] and [`grffile`] (if the document
142−contains images), [`hyperref`], [`xcolor`],
200+contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the
143−[`ulem`], [`geometry`] (with the `geometry` variable set),
144−[`setspace`] (with `linestretch`), and
201+`geometry` variable set), [`setspace`] (with `linestretch`), and
145[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
202[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as
146−the PDF engine requires [`fontspec`]. `lualatex` uses
203+the LaTeX engine requires [`fontspec`]. `xelatex` uses
147−[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),
204+[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the
148−[`xecjk`], and [`bidi`] (with the `dir` variable set). If the
205+`dir` variable set). If the `mathspec` variable is set,
149−`mathspec` variable is set, `xelatex` will use [`mathspec`]
206+`xelatex` will use [`mathspec`] instead of [`unicode-math`].
150−instead of [`unicode-math`]. The [`upquote`] and [`microtype`]
207+The [`upquote`] and [`microtype`] packages are used if
151−packages are used if available, and [`csquotes`] will be used
208+available, and [`csquotes`] will be used for [smart punctuation]
152−for [typography] if the `csquotes` variable or metadata field is
209+if added to the template or included in any header file. The
153−set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],
210+[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can
154−and [`biber`] packages can optionally be used for [citation
211+optionally be used for [citation rendering]. These are included
155−rendering]. The following packages will be used to improve
212+with all recent versions of [TeX Live].
156−output quality if present, but pandoc does not require them to
213+
157−be present: [`upquote`] (for straight quotes in verbatim
214+Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the
158−environments), [`microtype`] (for better spacing adjustments),
215+following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],
159−[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for
216+[`weasyprint`] or [`prince`].
160−better line breaks in URLs), [`bookmark`] (for better PDF
217+To do this, specify an output file with a `.pdf` extension, as before,
161−bookmarks), and [`footnotehyper`] or [`footnote`] (to allow
218+but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`
162−footnotes in tables).
219+to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).
163−
220+
164−[TeX Live]: https://www.tug.org/texlive/
221+PDF output can be controlled using [variables for LaTeX] (if
222+LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).
223+When using an HTML/CSS-to-PDF-engine, `--css` affects the output.
224+If `wkhtmltopdf` is used, then the variables `margin-left`,
225+`margin-right`, `margin-top`, `margin-bottom`, and `papersize`
226+will affect the output.
227+
165[`amsfonts`]: https://ctan.org/pkg/amsfonts
228[`amsfonts`]: https://ctan.org/pkg/amsfonts
166[`amsmath`]: https://ctan.org/pkg/amsmath
229[`amsmath`]: https://ctan.org/pkg/amsmath
167−[`babel`]: https://ctan.org/pkg/babel
230+[`lm`]: https://ctan.org/pkg/lm
168−[`biber`]: https://ctan.org/pkg/biber
231+[`ifxetex`]: https://ctan.org/pkg/ifxetex
169−[`biblatex`]: https://ctan.org/pkg/biblatex
232+[`ifluatex`]: https://ctan.org/pkg/ifluatex
170−[`bibtex`]: https://ctan.org/pkg/bibtex
233+[`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
234[`fancyvrb`]: https://ctan.org/pkg/fancyvrb
176−[`fontspec`]: https://ctan.org/pkg/fontspec
235+[`longtable`]: https://ctan.org/pkg/longtable
177−[`footnote`]: https://ctan.org/pkg/footnote
236+[`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
237[`graphicx`]: https://ctan.org/pkg/graphicx
181[`grffile`]: https://ctan.org/pkg/grffile
238[`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
239+[`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
240[`setspace`]: https://ctan.org/pkg/setspace
241+[`xecjk`]: https://ctan.org/pkg/xecjk
242+[`hyperref`]: https://ctan.org/pkg/hyperref
194[`ulem`]: https://ctan.org/pkg/ulem
243[`ulem`]: https://ctan.org/pkg/ulem
244+[`babel`]: https://ctan.org/pkg/babel
245+[`bidi`]: https://ctan.org/pkg/bidi
246+[`mathspec`]: https://ctan.org/pkg/mathspec
195[`unicode-math`]: https://ctan.org/pkg/unicode-math
247[`unicode-math`]: https://ctan.org/pkg/unicode-math
248+[`polyglossia`]: https://ctan.org/pkg/polyglossia
249+[`fontspec`]: https://ctan.org/pkg/fontspec
196[`upquote`]: https://ctan.org/pkg/upquote
250[`upquote`]: https://ctan.org/pkg/upquote
197−[`weasyprint`]: https://weasyprint.org
251+[`microtype`]: https://ctan.org/pkg/microtype
252+[`csquotes`]: https://ctan.org/pkg/csquotes
253+[`natbib`]: https://ctan.org/pkg/natbib
254+[`biblatex`]: https://ctan.org/pkg/biblatex
255+[`bibtex`]: https://ctan.org/pkg/bibtex
256+[`biber`]: https://ctan.org/pkg/biber
257+[TeX Live]: http://www.tug.org/texlive/
198[`wkhtmltopdf`]: https://wkhtmltopdf.org
258[`wkhtmltopdf`]: https://wkhtmltopdf.org
199−[`xcolor`]: https://ctan.org/pkg/xcolor
259+[`weasyprint`]: http://weasyprint.org
200−[`xecjk`]: https://ctan.org/pkg/xecjk
260+[`prince`]: https://www.princexml.com/
201−[`xurl`]: https://ctan.org/pkg/xurl
202−[`selnolig`]: https://ctan.org/pkg/selnolig
203−
204−
205−
206−## Reading from the Web
207−
208−Instead of an input file, an absolute URI may be given. In this case
209−pandoc will fetch the content using HTTP:
210−
211− pandoc -f html -t markdown https://www.fsf.org
212−
213−It is possible to supply a custom User-Agent string or other
214−header when requesting a document from a URL:
215−
216− pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \
217− https://www.fsf.org
218
261
219−# Options
262+Options
263+=======
220
264
221−## General options {.options}
265+General options
266+---------------
222
267
223`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
268`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*
224
269
225−: Specify input format. *FORMAT* can be:
270+: Specify input format. *FORMAT* can be `native` (native Haskell),
226−
227− ::: {#input-formats}
228− - `bibtex` ([BibTeX] bibliography)
229− - `biblatex` ([BibLaTeX] bibliography)
230− - `commonmark` ([CommonMark] Markdown)
231− - `commonmark_x` ([CommonMark] Markdown with extensions)
232− - `creole` ([Creole 1.0])
233− - `csljson` ([CSL JSON] bibliography)
234− - `csv` ([CSV] table)
235− - `docbook` ([DocBook])
236− - `docx` ([Word docx])
237− - `dokuwiki` ([DokuWiki markup])
238− - `epub` ([EPUB])
239− - `fb2` ([FictionBook2] e-book)
240− - `gfm` ([GitHub-Flavored Markdown]),
241− or the deprecated and less accurate `markdown_github`;
242− use [`markdown_github`](#markdown-variants) only
243− if you need extensions not supported in [`gfm`](#markdown-variants).
244− - `haddock` ([Haddock markup])
245− - `html` ([HTML])
246− - `ipynb` ([Jupyter notebook])
247− - `jats` ([JATS] XML)
248− - `jira` ([Jira]/Confluence wiki markup)
249− - `json` (JSON version of native AST)
271+ `json` (JSON version of native AST), `markdown` (pandoc's
250− - `latex` ([LaTeX])
272+ extended Markdown), `markdown_strict` (original unextended
251− - `markdown` ([Pandoc's Markdown])
252− - `markdown_mmd` ([MultiMarkdown])
253− - `markdown_phpextra` ([PHP Markdown Extra])
273+ Markdown), `markdown_phpextra` (PHP Markdown Extra),
254− - `markdown_strict` (original unextended [Markdown])
274+ `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),
255− - `mediawiki` ([MediaWiki markup])
275+ `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`
256− - `man` ([roff man])
276+ (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
257− - `muse` ([Muse])
277+ (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),
258− - `native` (native Haskell)
259− - `odt` ([ODT])
260− - `opml` ([OPML])
261− - `org` ([Emacs Org mode])
278+ `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
262− - `rst` ([reStructuredText])
263− - `t2t` ([txt2tags])
264− - `textile` ([Textile])
265− - `tikiwiki` ([TikiWiki markup])
279+ markup), `tikiwiki` (TikiWiki markup), `haddock` (Haddock markup), or
266− - `twiki` ([TWiki markup])
280+ `latex` (LaTeX). (`markdown_github` provides deprecated and
267− - `vimwiki` ([Vimwiki])
281+ less accurate suppport for Github-Flavored Markdown; please
268− :::
282+ use `gfm` instead, unless you use extensions that do not work
269−
283+ with `gfm`.) If `+lhs` is appended to `markdown`, `rst`, `latex`, or
284+ `html`, the input will be treated as literate Haskell source: see
285+ [Literate Haskell support], below. Markdown
270− Extensions can be individually enabled or disabled by
286+ syntax extensions can be individually enabled or disabled by
271− appending `+EXTENSION` or `-EXTENSION` to the format name.
287+ appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
288+ example, `markdown_strict+footnotes+definition_lists` is strict
289+ Markdown with footnotes and definition lists enabled, and
290+ `markdown-pipe_tables+hard_line_breaks` is pandoc's Markdown
291+ without pipe tables and with hard line breaks. See [Pandoc's
272− See [Extensions] below, for a list of extensions and
292+ Markdown], below, for a list of extensions and
273 their names. See `--list-input-formats` and `--list-extensions`,
293 their names. See `--list-input-formats` and `--list-extensions`,
274 below.
294 below.
275
295
276`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
296`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*
277
297
278−: Specify output format. *FORMAT* can be:
298+: Specify output format. *FORMAT* can be `native` (native Haskell),
279−
280− ::: {#output-formats}
281− - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])
282− - `beamer` ([LaTeX beamer][`beamer`] slide show)
283− - `bibtex` ([BibTeX] bibliography)
284− - `biblatex` ([BibLaTeX] bibliography)
285− - `commonmark` ([CommonMark] Markdown)
286− - `commonmark_x` ([CommonMark] Markdown with extensions)
287− - `context` ([ConTeXt])
288− - `csljson` ([CSL JSON] bibliography)
289− - `docbook` or `docbook4` ([DocBook] 4)
290− - `docbook5` (DocBook 5)
291− - `docx` ([Word docx])
292− - `dokuwiki` ([DokuWiki markup])
293− - `epub` or `epub3` ([EPUB] v3 book)
294− - `epub2` (EPUB v2)
295− - `fb2` ([FictionBook2] e-book)
296− - `gfm` ([GitHub-Flavored Markdown]),
297− or the deprecated and less accurate `markdown_github`;
298− use [`markdown_github`](#markdown-variants) only
299− if you need extensions not supported in [`gfm`](#markdown-variants).
300− - `haddock` ([Haddock markup])
301− - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])
302− - `html4` ([XHTML] 1.0 Transitional)
303− - `icml` ([InDesign ICML])
304− - `ipynb` ([Jupyter notebook])
305− - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)
306− - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)
307− - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)
308− - `jats` (alias for `jats_archiving`)
309− - `jira` ([Jira]/Confluence wiki markup)
310− - `json` (JSON version of native AST)
299+ `json` (JSON version of native AST), `plain` (plain text),
311− - `latex` ([LaTeX])
300+ `markdown` (pandoc's extended Markdown), `markdown_strict`
312− - `man` ([roff man])
313− - `markdown` ([Pandoc's Markdown])
314− - `markdown_mmd` ([MultiMarkdown])
315− - `markdown_phpextra` ([PHP Markdown Extra])
316− - `markdown_strict` (original unextended [Markdown])
301+ (original unextended Markdown), `markdown_phpextra` (PHP Markdown
302+ Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored
303+ Markdown), `commonmark` (CommonMark Markdown), `rst`
304+ (reStructuredText), `html4` (XHTML 1.0 Transitional), `html`
305+ or `html5` (HTML5/XHTML [polyglot markup]), `latex`
306+ (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
317− - `mediawiki` ([MediaWiki markup])
307+ `man` (groff man), `mediawiki` (MediaWiki markup),
318− - `ms` ([roff ms])
308+ `dokuwiki` (DokuWiki markup), `zimwiki` (ZimWiki markup),
319− - `muse` ([Muse]),
320− - `native` (native Haskell),
321− - `odt` ([OpenOffice text document][ODT])
322− - `opml` ([OPML])
323− - `opendocument` ([OpenDocument])
324− - `org` ([Emacs Org mode])
325− - `pdf` ([PDF])
326− - `plain` (plain text),
327− - `pptx` ([PowerPoint] slide show)
328− - `rst` ([reStructuredText])
329− - `rtf` ([Rich Text Format])
330− - `texinfo` ([GNU Texinfo])
309+ `textile` (Textile), `org` (Emacs Org mode), `texinfo` (GNU Texinfo),
331− - `textile` ([Textile])
310+ `opml` (OPML), `docbook` or `docbook4` (DocBook 4), `docbook5`
332− - `slideous` ([Slideous] HTML and JavaScript slide show)
311+ (DocBook 5), `jats` (JATS XML), `opendocument` (OpenDocument),
312+ `odt` (OpenOffice text document), `docx` (Word docx), `haddock`
313+ (Haddock markup), `rtf` (rich text format), `epub2` (EPUB v2 book),
314+ `epub` or `epub3` (EPUB v3), `fb2` (FictionBook2 e-book),
315+ `asciidoc` (AsciiDoc), `icml` (InDesign ICML), `tei` (TEI
333− - `slidy` ([Slidy] HTML and JavaScript slide show)
316+ Simple), `slidy` (Slidy HTML and JavaScript slide show),
317+ `slideous` (Slideous HTML and JavaScript slide show),
334− - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),
318+ `dzslides` (DZSlides HTML5 + JavaScript slide show),
335− - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)
319+ `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5`
336− - `s5` ([S5] HTML and JavaScript slide show)
320+ (S5 HTML and JavaScript slide show), or the path of a custom
337− - `tei` ([TEI Simple])
338− - `xwiki` ([XWiki markup])
339− - `zimwiki` ([ZimWiki markup])
340− - the path of a custom Lua writer, see [Custom writers] below
321+ lua writer (see [Custom writers], below). (`markdown_github`
341− :::
322+ provides deprecated and less accurate suppport for
342−
323+ Github-Flavored Markdown; please use `gfm` instead, unless
324+ you use extensions that do not work with `gfm`.) Note that `odt`,
343− Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed
325+ `epub`, and `epub3` output will not be directed to *stdout*;
344− to *stdout* unless forced with `-o -`.
326+ an output filename must be specified using the `-o/--output`
345−
327+ option. If `+lhs` is appended to `markdown`, `rst`, `latex`,
328+ `beamer`, `html4`, or `html5`, the output will be rendered as
329+ literate Haskell source: see [Literate Haskell support],
346− Extensions can be individually enabled or
330+ below. Markdown syntax extensions can be individually
347− disabled by appending `+EXTENSION` or `-EXTENSION` to the format
331+ enabled or disabled by appending `+EXTENSION` or
348− name. See [Extensions] below, for a list of extensions and their
332+ `-EXTENSION` to the format name, as described above under `-f`.
349− names. See `--list-output-formats` and `--list-extensions`, below.
333+ See `--list-output-formats` and `--list-extensions`, below.
350
334
351`-o` *FILE*, `--output=`*FILE*
335`-o` *FILE*, `--output=`*FILE*
352
336
@@ -358,43 +342,35 @@ header when requesting a document from a URL:
358
342
359: Specify the user data directory to search for pandoc data files.
343: Specify the user data directory to search for pandoc data files.
360 If this option is not specified, the default user data directory
344 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`
345+ will be used. This is, in UNIX:
362− subdirectory of the XDG data directory (by default,
346+
363− `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`
347+ $HOME/.pandoc
364− environment variable). If that directory does not exist and
348+
365− `$HOME/.pandoc` exists, it will be used (for backwards compatibility).
349+ in Windows XP:
366− On Windows the default user data directory is
350+
351+ C:\Documents And Settings\USERNAME\Application Data\pandoc
352+
353+ and in Windows Vista or later:
354+
367− `C:\Users\USERNAME\AppData\Roaming\pandoc`.
355+ C:\Users\USERNAME\AppData\Roaming\pandoc
356+
368 You can find the default user data directory on your system by
357 You can find the default user data directory on your system by
369 looking at the output of `pandoc --version`.
358 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
359+ A `reference.odt`, `reference.docx`, `epub.css`, `templates`,
360+ `slidy`, `slideous`, or `s5` directory
372− pandoc's normal defaults.
361+ 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
362
388`--bash-completion`
363`--bash-completion`
389
364
390: Generate a bash completion script. To enable bash completion
365: Generate a bash completion script. To enable bash completion
391 with pandoc, add this to your `.bashrc`:
366 with pandoc, add this to your `.bashrc`:
392
367
393− eval "$(pandoc --bash-completion)"
368+ eval "$(pandoc --bash-completion)"
394
369
395`--verbose`
370`--verbose`
396
371
397−: Give verbose debugging output.
372+: Give verbose debugging output. Currently this only has an effect
373+ with PDF output.
398
374
399`--quiet`
375`--quiet`
400
376
@@ -418,12 +394,11 @@ header when requesting a document from a URL:
418
394
419: List supported output formats, one per line.
395: List supported output formats, one per line.
420
396
421−`--list-extensions`[`=`*FORMAT*]
397+`--list-extensions`
422
398
423−: List supported extensions for *FORMAT*, one per line, preceded
399+: List supported Markdown extensions, one per line, followed
424 by a `+` or `-` indicating whether it is enabled by default
400 by a `+` or `-` indicating whether it is enabled by default
425− in *FORMAT*. If *FORMAT* is not specified, defaults for
426− pandoc's Markdown are given.
401+ in pandoc's Markdown.
427
402
428`--list-highlight-languages`
403`--list-highlight-languages`
429
404
@@ -443,95 +418,12 @@ header when requesting a document from a URL:
443
418
444: Show usage message.
419: Show usage message.
445
420
446−[Markdown]: https://daringfireball.net/projects/markdown/
447−[CommonMark]: https://commonmark.org
448−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
449−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
450−[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/
451−[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html
452−[S5]: https://meyerweb.com/eric/tools/s5/
453−[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/
454−[Slideous]: https://goessner.net/articles/slideous/
455−[HTML]: https://www.w3.org/html/
456−[HTML5]: https://html.spec.whatwg.org/
457−[polyglot markup]: https://www.w3.org/TR/html-polyglot/
458−[XHTML]: https://www.w3.org/TR/xhtml1/
459−[LaTeX]: https://www.latex-project.org/
460−[`beamer`]: https://ctan.org/pkg/beamer
461−[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf
462−[ConTeXt]: https://www.contextgarden.net/
463−[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format
464−[DocBook]: https://docbook.org
465−[JATS]: https://jats.nlm.nih.gov
466−[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all
467−[txt2tags]: https://txt2tags.org
468−[EPUB]: http://idpf.org/epub
469−[OPML]: http://dev.opml.org/spec2.html
470−[OpenDocument]: http://opendocument.xml.org
471−[ODT]: https://en.wikipedia.org/wiki/OpenDocument
472−[Textile]: https://www.promptworks.com/textile
473−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
474−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
475−[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html
476−[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/
477−[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
478−[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
480−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
481−[CSV]: https://tools.ietf.org/html/rfc4180
482−[roff man]: https://man.cx/groff_man(7)
483−[roff ms]: https://man.cx/groff_ms(7)
484−[Haskell]: https://www.haskell.org
485−[GNU Texinfo]: https://www.gnu.org/software/texinfo/
486−[Emacs Org mode]: https://orgmode.org
487−[AsciiDoc]: https://www.methods.co.nz/asciidoc/
488−[AsciiDoctor]: https://asciidoctor.org/
489−[DZSlides]: https://paulrouget.com/dzslides/
490−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
491−[PDF]: https://www.adobe.com/pdf/
492−[reveal.js]: https://revealjs.com/
493−[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
496−[TEI Simple]: https://github.com/TEIC/TEI-Simple
497−[Muse]: https://amusewiki.org/library/manual
498−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
499−[Vimwiki]: https://vimwiki.github.io
500−[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html
501−[BibTeX]: https://ctan.org/pkg/bibtex
502−[BibLaTeX]: https://ctan.org/pkg/biblatex
503−
504−## Reader options {.options}
421+Reader options
505−
422+--------------
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
423
523`--base-header-level=`*NUMBER*
424`--base-header-level=`*NUMBER*
524
425
525−: *Deprecated. Use `--shift-heading-level-by`=X instead,
526− where X = NUMBER - 1.* Specify the base level for headings
426+: Specify the base level for headers (defaults to 1).
527− (defaults to 1).
528−
529−`--strip-empty-paragraphs`
530−
531−: *Deprecated. Use the `+empty_paragraphs` extension instead.*
532− Ignore paragraphs with no content. This option is useful
533− for converting word processing documents where users have
534− used empty paragraphs to create inter-paragraph space.
535
427
536`--indented-code-classes=`*CLASSES*
428`--indented-code-classes=`*CLASSES*
537
429
@@ -554,7 +446,7 @@ header when requesting a document from a URL:
554 footnotes and links will not work across files. Reading binary
446 footnotes and links will not work across files. Reading binary
555 files (docx, odt, epub) implies `--file-scope`.
447 files (docx, odt, epub) implies `--file-scope`.
556
448
557−`-F` *PROGRAM*, `--filter=`*PROGRAM*
449+`--filter=`*PROGRAM*
558
450
559: Specify an executable to be used as a filter transforming the
451: Specify an executable to be used as a filter transforming the
560 pandoc AST after the input is parsed and before the output is
452 pandoc AST after the input is parsed and before the output is
@@ -576,7 +468,7 @@ header when requesting a document from a URL:
576 Those who would prefer to write filters in python can use the
468 Those who would prefer to write filters in python can use the
577 module [`pandocfilters`], installable from PyPI. There are also
469 module [`pandocfilters`], installable from PyPI. There are also
578 pandoc filter libraries in [PHP], [perl], and
470 pandoc filter libraries in [PHP], [perl], and
579− [JavaScript/node.js].
471+ [javascript/node.js].
580
472
581 In order of preference, pandoc will look for filters in
473 In order of preference, pandoc will look for filters in
582
474
@@ -589,65 +481,47 @@ header when requesting a document from a URL:
589
481
590 3. `$PATH` (executable only)
482 3. `$PATH` (executable only)
591
483
592− Filters, Lua-filters, and citeproc processing are applied in
593− the order specified on the command line.
594−
595−`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*
484+`--lua-filter=`*SCRIPT*
596
485
597: Transform the document in a similar fashion as JSON filters (see
486: Transform the document in a similar fashion as JSON filters (see
598− `--filter`), but use pandoc's built-in Lua filtering system. The given
487+ `--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
488+ 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
489+ applied in order. Each lua filter must contain element-transforming
601 functions indexed by the name of the AST element on which the filter
490 functions indexed by the name of the AST element on which the filter
602 function should be applied.
491 function should be applied.
603
492
604− The `pandoc` Lua module provides helper functions for element
493+ The `pandoc` lua module provides helper functions for element
605− creation. It is always loaded into the script's Lua environment.
494+ creation. It is always loaded into the script's lua environment.
606
495
607− See the [Lua filters documentation] for further details.
496+ The following is an example lua script for macro-expansion:
608
497
609− In order of preference, pandoc will look for Lua filters in
498+ function expand_hello_world(inline)
499+ if inline.c == '{{helloworld}}' then
500+ return pandoc.Emph{ pandoc.Str "Hello, World" }
501+ else
502+ return inline
503+ end
504+ end
610
505
611− 1. a specified full or relative path
506+ return {{Str = expand_hello_world}}
612
507
613− 2. `$DATADIR/filters` where `$DATADIR` is the user data
614− directory (see `--data-dir`, above).
615−
616− Filters, Lua filters, and citeproc processing are applied in
617− the order specified on the command line.
618
508
619`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
509`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]
620
510
621: Set the metadata field *KEY* to the value *VAL*. A value specified
511: Set the metadata field *KEY* to the value *VAL*. A value specified
622− on the command line overrides a value specified in the document
512+ on the command line overrides a value specified in the document.
623− using [YAML metadata blocks][Extension: `yaml_metadata_block`].
624 Values will be parsed as YAML boolean or string values. If no value is
513 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
514 specified, the value will be treated as Boolean true. Like
626 `--variable`, `--metadata` causes template variables to be set.
515 `--variable`, `--metadata` causes template variables to be set.
627 But unlike `--variable`, `--metadata` affects the metadata of the
516 But unlike `--variable`, `--metadata` affects the metadata of the
628 underlying document (which is accessible from filters and may be
517 underlying document (which is accessible from filters and may be
629− printed in some output formats) and metadata values will be escaped
518+ printed in some output formats).
630− when inserted into the template.
631−
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
519
645`-p`, `--preserve-tabs`
520`-p`, `--preserve-tabs`
646
521
647−: Preserve tabs instead of converting them to spaces. (By default, pandoc
522+: 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
523+ Note that this will only affect tabs in literal code spans and code
650− text are always treated as spaces.
524+ blocks; tabs in regular text will be treated as spaces.
651
525
652`--tab-stop=`*NUMBER*
526`--tab-stop=`*NUMBER*
653
527
@@ -657,30 +531,27 @@ header when requesting a document from a URL:
657
531
658: Specifies what to do with insertions, deletions, and comments
532: Specifies what to do with insertions, deletions, and comments
659 produced by the MS Word "Track Changes" feature. `accept` (the
533 produced by the MS Word "Track Changes" feature. `accept` (the
660− default) processes all the insertions and deletions.
534+ default), inserts all insertions, and ignores all
535+ deletions. `reject` inserts all deletions and ignores
661− `reject` ignores them. Both `accept` and `reject` ignore comments.
536+ insertions. Both `accept` and `reject` ignore comments. `all` puts
662− `all` includes all insertions, deletions, and comments, wrapped
537+ in insertions, deletions, and comments, wrapped in spans with
663− in spans with `insertion`, `deletion`, `comment-start`, and
538+ `insertion`, `deletion`, `comment-start`, and `comment-end`
664− `comment-end` classes, respectively. The author and time of
539+ classes, respectively. The author and time of change is
665− change is included. `all` is useful for scripting: only
540+ included. `all` is useful for scripting: only accepting changes
666− accepting changes from a certain reviewer, say, or before a
541+ from a certain reviewer, say, or before a certain date. This
667− certain date. If a paragraph is inserted or deleted,
668− `track-changes=all` produces a span with the class
669− `paragraph-insertion`/`paragraph-deletion` before the
670− affected paragraph break. This option only affects the docx
542+ option only affects the docx reader.
671− reader.
672
543
673`--extract-media=`*DIR*
544`--extract-media=`*DIR*
674
545
675: Extract images and other media contained in or linked from
546: Extract images and other media contained in or linked from
676 the source document to the path *DIR*, creating it if
547 the source document to the path *DIR*, creating it if
677 necessary, and adjust the images references in the document
548 necessary, and adjust the images references in the document
678− so they point to the extracted files. Media are downloaded,
549+ so they point to the extracted files. If the source format is
679− read from the file system, or extracted from a binary
550+ a binary container (docx, epub, or odt), the media is
680− container (e.g. docx), as needed. The original file paths
551+ extracted from the container and the original
681− are used if they are relative paths not containing `..`.
552+ filenames are used. Otherwise the media is read from the
682− Otherwise filenames are constructed from the SHA1 hash of
553+ file system or downloaded, and new filenames are constructed
683− the contents.
554+ based on SHA1 hashes of the contents.
684
555
685`--abbreviations=`*FILE*
556`--abbreviations=`*FILE*
686
557
@@ -691,30 +562,29 @@ header when requesting a document from a URL:
691 system default, use
562 system default, use
692 `pandoc --print-default-data-file=abbreviations`. The only
563 `pandoc --print-default-data-file=abbreviations`. The only
693 use pandoc makes of this list is in the Markdown reader.
564 use pandoc makes of this list is in the Markdown reader.
694− Strings found in this list will be followed by a nonbreaking
565+ Strings ending in a period that are found in this list will
566+ be followed by a nonbreaking space, so that the period will
695− space, and the period will not produce sentence-ending space
567+ not produce sentence-ending space in formats like LaTeX.
696− in formats like LaTeX. The strings may not contain spaces.
697
568
698[`pandocfilters`]: https://github.com/jgm/pandocfilters
569[`pandocfilters`]: https://github.com/jgm/pandocfilters
699[PHP]: https://github.com/vinai/pandocfilters-php
570[PHP]: https://github.com/vinai/pandocfilters-php
700[perl]: https://metacpan.org/pod/Pandoc::Filter
571[perl]: https://metacpan.org/pod/Pandoc::Filter
701−[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
572+[javascript/node.js]: https://github.com/mvhenderson/pandoc-filter-node
702−[Lua filters documentation]: https://pandoc.org/lua-filters.html
703
573
704−## General writer options {.options}
574+General writer options
575+----------------------
705
576
706`-s`, `--standalone`
577`-s`, `--standalone`
707
578
708: Produce output with an appropriate header and footer (e.g. a
579: Produce output with an appropriate header and footer (e.g. a
709 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
580 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option
710 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
581 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`
711− output. For `native` output, this option causes metadata to
582+ output.
712− be included; otherwise, metadata is suppressed.
713
583
714−`--template=`*FILE*|*URL*
584+`--template=`*FILE*
715
585
716−: Use the specified file as a custom template for the generated document.
586+: Use *FILE* as a custom template for the generated document. Implies
717− Implies `--standalone`. See [Templates], below, for a description
587+ `--standalone`. See [Templates], below, for a description
718 of template syntax. If no extension is specified, an extension
588 of template syntax. If no extension is specified, an extension
719 corresponding to the writer will be added, so that `--template=special`
589 corresponding to the writer will be added, so that `--template=special`
720 looks for `special.html` for HTML output. If the template is not
590 looks for `special.html` for HTML output. If the template is not
@@ -726,29 +596,22 @@ header when requesting a document from a URL:
726`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
596`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]
727
597
728: Set the template variable *KEY* to the value *VAL* when rendering the
598: Set the template variable *KEY* to the value *VAL* when rendering the
729− document in standalone mode. If no *VAL* is specified, the
599+ document in standalone mode. This is generally only useful when the
600+ `--template` option is used to specify a custom template, since
601+ pandoc automatically sets the variables used in the default
602+ templates. If no *VAL* is specified, the key will be given the
730− key will be given the value `true`.
603+ value `true`.
731
604
732`-D` *FORMAT*, `--print-default-template=`*FORMAT*
605`-D` *FORMAT*, `--print-default-template=`*FORMAT*
733
606
734: Print the system default template for an output *FORMAT*. (See `-t`
607: Print the system default template for an output *FORMAT*. (See `-t`
735 for a list of possible *FORMAT*s.) Templates in the user data
608 for a list of possible *FORMAT*s.) Templates in the user data
736− directory are ignored. This option may be used with
609+ 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
610
746`--print-default-data-file=`*FILE*
611`--print-default-data-file=`*FILE*
747
612
748: Print a system default data file. Files in the user data directory
613: Print a system default data file. Files in the user data directory
749− are ignored. This option may be used with `-o`/`--output` to
614+ are ignored.
750− redirect output to a file, but `-o`/`--output` must come before
751− `--print-default-data-file` on the command line.
752
615
753`--eol=crlf`|`lf`|`native`
616`--eol=crlf`|`lf`|`native`
754
617
@@ -759,12 +622,9 @@ header when requesting a document from a URL:
759
622
760`--dpi`=*NUMBER*
623`--dpi`=*NUMBER*
761
624
762−: Specify the default dpi (dots per inch) value for conversion
625+: Specify the dpi (dots per inch) value for conversion from pixels
763− from pixels to inch/centimeters and vice versa. (Technically,
626+ to inch/centimeters and vice versa. The default is 96dpi.
764− the correct term would be ppi: pixels per inch.) The default
627+ 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
628
769`--wrap=auto`|`none`|`preserve`
629`--wrap=auto`|`none`|`preserve`
770
630
@@ -777,8 +637,6 @@ header when requesting a document from a URL:
777 where there are nonsemantic newlines in the source, there
637 where there are nonsemantic newlines in the source, there
778 will be nonsemantic newlines in the output as well).
638 will be nonsemantic newlines in the output as well).
779 Automatic wrapping does not currently work in HTML output.
639 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
640
783`--columns=`*NUMBER*
641`--columns=`*NUMBER*
784
642
@@ -791,21 +649,14 @@ header when requesting a document from a URL:
791: Include an automatically generated table of contents (or, in
649: Include an automatically generated table of contents (or, in
792 the case of `latex`, `context`, `docx`, `odt`,
650 the case of `latex`, `context`, `docx`, `odt`,
793 `opendocument`, `rst`, or `ms`, an instruction to create
651 `opendocument`, `rst`, or `ms`, an instruction to create
794− one) in the output document. This option has no effect
652+ 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.
653+ `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
654
804`--toc-depth=`*NUMBER*
655`--toc-depth=`*NUMBER*
805
656
806: Specify the number of section levels to include in the table
657: 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
658+ of contents. The default is 3 (which means that level 1, 2, and 3
808− headings will be listed in the contents).
659+ headers will be listed in the contents).
809
660
810`--strip-comments`
661`--strip-comments`
811
662
@@ -832,19 +683,8 @@ header when requesting a document from a URL:
832 Instead of a *STYLE* name, a JSON file with extension
683 Instead of a *STYLE* name, a JSON file with extension
833 `.theme` may be supplied. This will be parsed as a KDE
684 `.theme` may be supplied. This will be parsed as a KDE
834 syntax highlighting theme and (if valid) used as the
685 syntax highlighting theme and (if valid) used as the
835− highlighting style.
686+ highlighting style. To see a sample theme that can be
836−
687+ modified, `pandoc --print-default-data-file default.theme`.
837− To generate the JSON version of an existing style,
838− use `--print-highlight-style`.
839−
840−`--print-highlight-style=`*STYLE*|*FILE*
841−
842−: Prints a JSON version of a highlighting style, which can
843− be modified, saved with a `.theme` extension, and used
844− with `--highlight-style`. This option may be used with
845− `-o`/`--output` to redirect output to a file, but
846− `-o`/`--output` must come before `--print-highlight-style`
847− on the command line.
848
688
849`--syntax-definition=`*FILE*
689`--syntax-definition=`*FILE*
850
690
@@ -852,10 +692,9 @@ header when requesting a document from a URL:
852 which will be used for syntax highlighting of appropriately
692 which will be used for syntax highlighting of appropriately
853 marked code blocks. This can be used to add support for
693 marked code blocks. This can be used to add support for
854 new languages or to use altered syntax definitions for
694 new languages or to use altered syntax definitions for
855− existing languages. This option may be repeated to add
695+ existing languages.
856− multiple syntax definitions.
857
696
858−`-H` *FILE*, `--include-in-header=`*FILE*|*URL*
697+`-H` *FILE*, `--include-in-header=`*FILE*
859
698
860: Include contents of *FILE*, verbatim, at the end of the header.
699: Include contents of *FILE*, verbatim, at the end of the header.
861 This can be used, for example, to include special
700 This can be used, for example, to include special
@@ -863,7 +702,7 @@ header when requesting a document from a URL:
863 repeatedly to include multiple files in the header. They will be
702 repeatedly to include multiple files in the header. They will be
864 included in the order specified. Implies `--standalone`.
703 included in the order specified. Implies `--standalone`.
865
704
866−`-B` *FILE*, `--include-before-body=`*FILE*|*URL*
705+`-B` *FILE*, `--include-before-body=`*FILE*
867
706
868: Include contents of *FILE*, verbatim, at the beginning of the
707: Include contents of *FILE*, verbatim, at the beginning of the
869 document body (e.g. after the `<body>` tag in HTML, or the
708 document body (e.g. after the `<body>` tag in HTML, or the
@@ -872,7 +711,7 @@ header when requesting a document from a URL:
872 used repeatedly to include multiple files. They will be included in
711 used repeatedly to include multiple files. They will be included in
873 the order specified. Implies `--standalone`.
712 the order specified. Implies `--standalone`.
874
713
875−`-A` *FILE*, `--include-after-body=`*FILE*|*URL*
714+`-A` *FILE*, `--include-after-body=`*FILE*
876
715
877: Include contents of *FILE*, verbatim, at the end of the document
716: Include contents of *FILE*, verbatim, at the end of the document
878 body (before the `</body>` tag in HTML, or the
717 body (before the `</body>` tag in HTML, or the
@@ -891,39 +730,28 @@ header when requesting a document from a URL:
891 will not be searched. For example:
730 will not be searched. For example:
892 `--resource-path=.:test` will search the working directory
731 `--resource-path=.:test` will search the working directory
893 and the `test` subdirectory, in that order.
732 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
733
900`--request-header=`*NAME*`:`*VAL*
734`--request-header=`*NAME*`:`*VAL*
901
735
902: Set the request header *NAME* to the value *VAL* when making
736: Set the request header *NAME* to the value *VAL* when making
903 HTTP requests (for example, when a URL is given on the
737 HTTP requests (for example, when a URL is given on the
904 command line, or when resources used in a document must be
738 command line, or when resources used in a document must be
905− downloaded). If you're behind a proxy, you also need to set
739+ 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
740
914−## Options affecting specific writers {.options}
741+Options affecting specific writers
742+----------------------------------
915
743
916`--self-contained`
744`--self-contained`
917
745
918: Produce a standalone HTML file with no external dependencies, using
746: Produce a standalone HTML file with no external dependencies, using
919 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
747 `data:` URIs to incorporate the contents of linked scripts, stylesheets,
920− images, and videos. Implies `--standalone`. The resulting file should be
748+ images, and videos. The resulting file should be "self-contained,"
921− "self-contained," in the sense that it needs no external files and no net
749+ in the sense that it needs no external files and no net access to be
922− access to be displayed properly by a browser. This option works only with
750+ displayed properly by a browser. This option works only with HTML output
923− HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,
751+ formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,
924− `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,
752+ `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and
925− and stylesheets at absolute URLs will be downloaded; those at relative
753+ stylesheets at absolute URLs will be downloaded; those at relative URLs
926− URLs will be sought relative to the working directory (if the first source
754+ will be sought relative to the working directory (if the first source
927 file is local) or relative to the base URL (if the first source
755 file is local) or relative to the base URL (if the first source
928 file is remote). Elements with the attribute
756 file is remote). Elements with the attribute
929 `data-external="1"` will be left alone; the documents they
757 `data-external="1"` will be left alone; the documents they
@@ -936,18 +764,13 @@ header when requesting a document from a URL:
936
764
937`--html-q-tags`
765`--html-q-tags`
938
766
939−: Use `<q>` tags for quotes in HTML. (This option only has an
767+: Use `<q>` tags for quotes in HTML.
940− effect if the `smart` extension is enabled for the input
941− format used.)
942
768
943`--ascii`
769`--ascii`
944
770
945−: Use only ASCII characters in output. Currently supported for XML
771+: Use only ASCII characters in output. Currently supported only for
946− and HTML formats (which use entities instead of UTF-8 when this
772+ HTML and DocBook output (which uses numerical entities instead of
947− option is selected), CommonMark, gfm, and Markdown (which use
773+ UTF-8 when this option is selected).
948− entities), roff ms (which use hexadecimal escapes), and to a
949− limited degree LaTeX (which uses standard commands for accented
950− characters when possible). roff man output uses ASCII by default.
951
774
952`--reference-links`
775`--reference-links`
953
776
@@ -956,45 +779,35 @@ header when requesting a document from a URL:
956 placement of link references is affected by the
779 placement of link references is affected by the
957 `--reference-location` option.
780 `--reference-location` option.
958
781
959−`--reference-location=block`|`section`|`document`
782+`--reference-location = block`|`section`|`document`
960
783
961: Specify whether footnotes (and references, if `reference-links` is
784: Specify whether footnotes (and references, if `reference-links` is
962 set) are placed at the end of the current (top-level) block, the
785 set) are placed at the end of the current (top-level) block, the
963 current section, or the document. The default is
786 current section, or the document. The default is
964 `document`. Currently only affects the markdown writer.
787 `document`. Currently only affects the markdown writer.
965
788
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`
789`--atx-headers`
975
790
976−: *Deprecated synonym for `--markdown-headings=atx`.*
791+: Use ATX-style headers in Markdown and AsciiDoc output. The default is
792+ to use setext-style headers for levels 1-2, and then ATX headers.
977
793
978−`--top-level-division=default`|`section`|`chapter`|`part`
794+`--top-level-division=[default|section|chapter|part]`
979
795
980−: Treat top-level headings as the given division type in
796+: Treat top-level headers as the given division type in LaTeX, ConTeXt,
981− LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy
797+ 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
798+ all headers are shifted such that the top-level header becomes the specified
984− specified type. The default behavior is to determine the
799+ type. The default behavior is to determine the best division type via
985− best division type via heuristics: unless other conditions
800+ 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
801+ LaTeX document class is set to `report`, `book`, or `memoir` (unless the
988− `article` option is specified), `chapter` is implied as the
802+ `article` option is specified), `chapter` is implied as the setting for this
989− setting for this option. If `beamer` is the output format,
803+ option. If `beamer` is the output format, specifying either `chapter` or
990− specifying either `chapter` or `part` will cause top-level
804+ `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.
805+ second-level headers remain as their default type.
993
806
994`-N`, `--number-sections`
807`-N`, `--number-sections`
995
808
996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB
809+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.
997− output. By default, sections are not numbered. Sections with class
810+ By default, sections are not numbered. Sections with class
998 `unnumbered` will never be numbered, even if `--number-sections`
811 `unnumbered` will never be numbered, even if `--number-sections`
999 is specified.
812 is specified.
1000
813
@@ -1002,19 +815,16 @@ header when requesting a document from a URL:
1002
815
1003: Offset for section headings in HTML output (ignored in other
816: Offset for section headings in HTML output (ignored in other
1004 output formats). The first number is added to the section number for
817 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.
818+ 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
819+ So, for example, if you want the first top-level header in your
1007 document to be numbered "6", specify `--number-offset=5`.
820 document to be numbered "6", specify `--number-offset=5`.
1008− If your document starts with a level-2 heading which you want to
821+ If your document starts with a level-2 header which you want to
1009 be numbered "1.5", specify `--number-offset=1,4`.
822 be numbered "1.5", specify `--number-offset=1,4`.
1010 Offsets are 0 by default. Implies `--number-sections`.
823 Offsets are 0 by default. Implies `--number-sections`.
1011
824
1012`--listings`
825`--listings`
1013
826
1014−: Use the [`listings`] package for LaTeX code blocks. The package
827+: 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
828
1019`-i`, `--incremental`
829`-i`, `--incremental`
1020
830
@@ -1023,22 +833,22 @@ header when requesting a document from a URL:
1023
833
1024`--slide-level=`*NUMBER*
834`--slide-level=`*NUMBER*
1025
835
1026−: Specifies that headings with the specified level create
836+: Specifies that headers with the specified level create
1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings
837+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers
1028 above this level in the hierarchy are used to divide the
838 above this level in the hierarchy are used to divide the
1029− slide show into sections; headings below this level create
839+ slide show into sections; headers below this level create
1030 subheads within a slide. Note that content that is
840 subheads within a slide. Note that content that is
1031− not contained under slide-level headings will not appear in
841+ not contained under slide-level headers will not appear in
1032 the slide show. The default is to set the slide level based
842 the slide show. The default is to set the slide level based
1033 on the contents of the document; see [Structuring the slide
843 on the contents of the document; see [Structuring the slide
1034 show].
844 show].
1035
845
1036`--section-divs`
846`--section-divs`
1037
847
1038−: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),
848+: Wrap sections in `<div>` tags (or `<section>` tags in HTML5),
1039− and attach identifiers to the enclosing `<section>` (or `<div>`)
849+ and attach identifiers to the enclosing `<div>` (or `<section>`)
1040− rather than the heading itself. See
850+ rather than the header itself. See
1041− [Heading identifiers], below.
851+ [Header identifiers], below.
1042
852
1043`--email-obfuscation=none`|`javascript`|`references`
853`--email-obfuscation=none`|`javascript`|`references`
1044
854
@@ -1059,7 +869,8 @@ header when requesting a document from a URL:
1059
869
1060: Specify *STRING* as a prefix at the beginning of the title
870: 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
871 that appears in the HTML header (but not in the title as it
1062− appears at the beginning of the HTML body). Implies `--standalone`.
872+ appears at the beginning of the HTML body). Implies
873+ `--standalone`.
1063
874
1064`-c` *URL*, `--css=`*URL*
875`-c` *URL*, `--css=`*URL*
1065
876
@@ -1067,8 +878,8 @@ header when requesting a document from a URL:
1067 include multiple files. They will be included in the order specified.
878 include multiple files. They will be included in the order specified.
1068
879
1069 A stylesheet is required for generating EPUB. If none is
880 A stylesheet is required for generating EPUB. If none is
1070− provided using this option (or the `css` or `stylesheet`
881+ provided using this option (or the `stylesheet` metadata
1071− metadata fields), pandoc will look for a file `epub.css` in the
882+ field), pandoc will look for a file `epub.css` in the
1072 user data directory (see `--data-dir`). If it is not
883 user data directory (see `--data-dir`). If it is not
1073 found there, sensible defaults will be used.
884 found there, sensible defaults will be used.
1074
885
@@ -1091,56 +902,20 @@ header when requesting a document from a URL:
1091
902
1092 To produce a custom `reference.docx`, first get a copy of
903 To produce a custom `reference.docx`, first get a copy of
1093 the default `reference.docx`: `pandoc
904 the default `reference.docx`: `pandoc
1094− -o custom-reference.docx --print-default-data-file reference.docx`.
905+ --print-default-data-file reference.docx >
1095− Then open `custom-reference.docx` in Word, modify the
906+ custom-reference.docx`. Then open `custom-reference.docx`
1096− styles as you wish, and save the file. For best
907+ in Word, modify the styles as you wish, and save the file.
1097− results, do not make changes to this file other than
908+ For best results, do not make changes to this file other
1098− modifying the styles used by pandoc:
909+ than modifying the styles used by pandoc: [paragraph]
1099−
1100− Paragraph styles:
1101−
1102− - Normal
1103− - Body Text
1104− - First Paragraph
910+ Normal, Body Text, First Paragraph, Compact, Title,
1105− - Compact
1106− - Title
1107− - Subtitle
1108− - Author
1109− - Date
1110− - Abstract
1111− - Bibliography
911+ Subtitle, Author, Date, Abstract, Bibliography, Heading 1,
1112− - Heading 1
912+ 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
913+ Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,
1123− - Definition Term
914+ Definition Term, Definition, Caption, Table Caption,
1124− - Definition
1125− - Caption
1126− - Table Caption
1127− - Image Caption
1128− - Figure
1129− - Captioned Figure
915+ Image Caption, Figure, Captioned Figure, TOC Heading;
1130− - TOC Heading
1131−
1132− Character styles:
1133−
1134− - Default Paragraph Font
916+ [character] Default Paragraph Font, Body Text Char,
1135− - Body Text Char
1136− - Verbatim Char
1137− - Footnote Reference
917+ Verbatim Char, Footnote Reference, Hyperlink; [table]
1138− - Hyperlink
1139− - Section Number
1140−
1141− Table style:
1142−
1143− - Table
918+ Table.
1144
919
1145 ODT
920 ODT
1146
921
@@ -1154,33 +929,10 @@ header when requesting a document from a URL:
1154
929
1155 To produce a custom `reference.odt`, first get a copy of
930 To produce a custom `reference.odt`, first get a copy of
1156 the default `reference.odt`: `pandoc
931 the default `reference.odt`: `pandoc
1157− -o custom-reference.odt --print-default-data-file reference.odt`.
932+ --print-default-data-file reference.odt >
1158− Then open `custom-reference.odt` in LibreOffice, modify
933+ custom-reference.odt`. Then open `custom-reference.odt` in
1159− the styles as you wish, and save the file.
934+ LibreOffice, modify the styles as you wish, and save the
1160−
935+ file.
1161− PowerPoint
1162−
1163− : Templates included with Microsoft PowerPoint 2013 (either with
1164− `.pptx` or `.potx` extension) are known to work, as are most
1165− templates derived from these.
1166−
1167− The specific requirement is that the template should begin with
1168− the following first four layouts:
1169−
1170− 1. Title Slide
1171− 2. Title and Content
1172− 3. Section Header
1173− 4. Two Content
1174−
1175− All templates included with a recent version of MS PowerPoint
1176− will fit these criteria. (You can click on `Layout` under the
1177− `Home` menu to check.)
1178−
1179− You can also modify the default `reference.pptx`: first run
1180− `pandoc -o custom-reference.pptx --print-default-data-file
1181− reference.pptx`, and then modify `custom-reference.pptx`
1182− in MS PowerPoint (pandoc will use the first four layout
1183− slides, as mentioned above).
1184
936
1185`--epub-cover-image=`*FILE*
937`--epub-cover-image=`*FILE*
1186
938
@@ -1248,12 +1000,12 @@ header when requesting a document from a URL:
1248
1000
1249`--epub-chapter-level=`*NUMBER*
1001`--epub-chapter-level=`*NUMBER*
1250
1002
1251−: Specify the heading level at which to split the EPUB into separate
1003+: 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
1004+ "chapter" files. The default is to split into chapters at level 1
1253− headings. This option only affects the internal composition of the
1005+ headers. This option only affects the internal composition of the
1254 EPUB, not the way chapters and sections are displayed to users. Some
1006 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
1007 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
1008+ documents with few level 1 headers, one might want to use a chapter
1257 level of 2 or 3.
1009 level of 2 or 3.
1258
1010
1259`--epub-subdirectory=`*DIRNAME*
1011`--epub-subdirectory=`*DIRNAME*
@@ -1262,145 +1014,111 @@ header when requesting a document from a URL:
1262 the EPUB-specific contents. The default is `EPUB`. To put
1014 the EPUB-specific contents. The default is `EPUB`. To put
1263 the EPUB contents in the top level, use an empty string.
1015 the EPUB contents in the top level, use an empty string.
1264
1016
1265−`--ipynb-output=all|none|best`
1017+`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`
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
1018
1276: Use the specified engine when producing PDF output.
1019: 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
1020+ The default is `pdflatex`. If the engine is not in your PATH,
1280− path of the engine may be specified here. If this option
1021+ 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
1022
1292`--pdf-engine-opt=`*STRING*
1023`--pdf-engine-opt=`*STRING*
1293
1024
1294: Use the given string as a command-line argument to the `pdf-engine`.
1025: 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
1026+ 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.
1027+ them. Note that no check for duplicate options is done.
1298−
1028+
1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/
1029+[Dublin Core elements]: http://dublincore.org/documents/dces/
1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime
1030+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime
1301−[Encoding issue with the listings package]:
1031+
1302− https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue
1303−
1304−## Citation rendering {.options}
1032+Citation rendering
1305−
1033+------------------
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
1034
1325`--bibliography=`*FILE*
1035`--bibliography=`*FILE*
1326
1036
1327: Set the `bibliography` field in the document's metadata to *FILE*,
1037: Set the `bibliography` field in the document's metadata to *FILE*,
1328− overriding any value set in the metadata. If you supply
1038+ overriding any value set in the metadata, and process citations
1039+ using `pandoc-citeproc`. (This is equivalent to
1040+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)
1041+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not
1042+ used, making this equivalent to `--metadata bibliography=FILE`.
1329− this argument multiple times, each *FILE* will be added to
1043+ If you supply this argument multiple times, each *FILE* will be added
1330− bibliography. If *FILE* is a URL, it will be fetched
1044+ 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
1045
1335`--csl=`*FILE*
1046`--csl=`*FILE*
1336
1047
1337: Set the `csl` field in the document's metadata to *FILE*,
1048: Set the `csl` field in the document's metadata to *FILE*,
1338 overriding any value set in the metadata. (This is equivalent to
1049 overriding any value set in the metadata. (This is equivalent to
1339− `--metadata csl=FILE`.) If *FILE* is a URL, it will be
1050+ `--metadata csl=FILE`.)
1340− fetched via HTTP. If *FILE* is not found relative to the
1051+ 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
1052
1345`--citation-abbreviations=`*FILE*
1053`--citation-abbreviations=`*FILE*
1346
1054
1347: Set the `citation-abbreviations` field in the document's metadata to
1055: Set the `citation-abbreviations` field in the document's metadata to
1348 *FILE*, overriding any value set in the metadata. (This is equivalent to
1056 *FILE*, overriding any value set in the metadata. (This is equivalent to
1349 `--metadata citation-abbreviations=FILE`.)
1057 `--metadata citation-abbreviations=FILE`.)
1350− If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not
1058+ 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
1059
1355`--natbib`
1060`--natbib`
1356
1061
1357−: Use [`natbib`] for citations in LaTeX output. This option
1062+: 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
1063+ 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`].
1064+ use in producing a LaTeX file that can be processed with [`bibtex`].
1361
1065
1362`--biblatex`
1066`--biblatex`
1363
1067
1364−: Use [`biblatex`] for citations in LaTeX output. This option
1068+: 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
1069+ 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`].
1070+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].
1071+
1072+Math rendering in HTML
1073+----------------------
1074+
1075+`-m` [*URL*], `--latexmathml`[`=`*URL*]
1076+
1077+: Use the [LaTeXMathML] script to display embedded TeX math in HTML output.
1078+ To insert a link to a local copy of the `LaTeXMathML.js` script,
1079+ provide a *URL*. If no *URL* is provided, the contents of the
1080+ script will be inserted directly into the HTML header, preserving
1081+ portability at the price of efficiency. If you plan to use math on
1082+ several pages, it is much better to link to a copy of the script,
1083+ so it can be cached.
1084+
1085+`--mathml`
1086+
1087+: Convert TeX math to [MathML] (in `docbook4`, `docbook5`, `jats`,
1088+ `html4` and `html5`). This is the default in `odt` output.
1368
1089
1369−## Math rendering in HTML {.options}
1090+`--jsmath`[`=`*URL*]
1370
1091
1371−The default is to render TeX math as far as possible using
1092+: Use [jsMath] to display embedded TeX math in HTML output.
1372−Unicode characters. Formulas are put inside a `span` with
1093+ The *URL* should point to the jsMath load script (e.g.
1373−`class="math"`, so that they may be styled differently from the
1094+ `jsMath/easy/load.js`); if provided, it will be linked to in
1374−surrounding text if needed. However, this gives acceptable
1095+ the header of standalone HTML documents. If a *URL* is not provided,
1375−results only for basic math, usually you will want to use
1096+ no link to the jsMath load script will be inserted; it is then
1376−`--mathjax` or another of the following options.
1097+ up to the author to provide such a link in the HTML template.
1377
1098
1378`--mathjax`[`=`*URL*]
1099`--mathjax`[`=`*URL*]
1379
1100
1380: Use [MathJax] to display embedded TeX math in HTML output.
1101: Use [MathJax] to display embedded TeX math in HTML output.
1381− TeX math will be put between `\(...\)` (for inline math)
1382− or `\[...\]` (for display math) and wrapped in `<span>` tags
1383− with class `math`. Then the MathJax JavaScript will render it.
1384 The *URL* should point to the `MathJax.js` load script.
1102 The *URL* should point to the `MathJax.js` load script.
1385− If a *URL* is not provided, a link to the Cloudflare CDN will
1103+ If a *URL* is not provided, a link to the MathJax CDN will
1386 be inserted.
1104 be inserted.
1387
1105
1388−`--mathml`
1106+`--gladtex`
1389
1107
1390−: Convert TeX math to [MathML] (in `epub3`, `docbook4`,
1108+: Enclose TeX math in `<eq>` tags in HTML output. These can then
1391− `docbook5`, `jats`, `html4` and `html5`). This is the
1109+ be processed by [gladTeX] to produce links to images of the typeset
1392− default in `odt` output. Note that currently only Firefox
1110+ formulas.
1393− and Safari (and select e-book readers) natively support
1111+
1394− MathML.
1112+`--mimetex`[`=`*URL*]
1113+
1114+: Render TeX math using the [mimeTeX] CGI script. If *URL* is not
1115+ specified, it is assumed that the script is at `/cgi-bin/mimetex.cgi`.
1395
1116
1396`--webtex`[`=`*URL*]
1117`--webtex`[`=`*URL*]
1397
1118
1398−: Convert TeX formulas to `<img>` tags that link to an external script
1119+: Render TeX formulas using an external script that converts TeX
1399− that converts formulas to images. The formula will be URL-encoded
1120+ formulas to images. The formula will be concatenated with the URL
1400− and concatenated with the URL provided. For SVG images you can for
1401− example use `--webtex https://latex.codecogs.com/svg.latex?`.
1402− If no URL is specified, the CodeCogs URL generating PNGs
1121+ provided. If *URL* is not specified, the CodeCogs will be used.
1403− will be used (`https://latex.codecogs.com/png.latex?`).
1404 Note: the `--webtex` option will affect Markdown output
1122 Note: the `--webtex` option will affect Markdown output
1405 as well as HTML, which is useful if you're targeting a
1123 as well as HTML, which is useful if you're targeting a
1406 version of Markdown without native math support.
1124 version of Markdown without native math support.
@@ -1408,26 +1126,26 @@ results only for basic math, usually you will want to use
1408`--katex`[`=`*URL*]
1126`--katex`[`=`*URL*]
1409
1127
1410: Use [KaTeX] to display embedded TeX math in HTML output.
1128: Use [KaTeX] to display embedded TeX math in HTML output.
1411− The *URL* is the base URL for the KaTeX library. That directory
1129+ 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.
1130+ not provided, a link to the KaTeX CDN will be inserted.
1414−
1131+ Note: [KaTeX] seems to work best with `html5` output.
1415−`--gladtex`
1416
1132
1417−: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML
1133+`--katex-stylesheet=`*URL*
1418− can then be processed by [GladTeX] to produce SVG images of the typeset
1419− formulas and an HTML file with these images embedded.
1420
1134
1421− pandoc -s --gladtex input.md -o myfile.htex
1135+: The *URL* should point to the `katex.css` stylesheet. If this option is
1422− gladtex -d image_dir myfile.htex
1136+ not specified, a link to the KaTeX CDN will be inserted. Note that this
1423− # produces myfile.html and images in image_dir
1137+ option does not imply `--katex`.
1424
1138
1425−[MathML]: https://www.w3.org/Math/
1139+[MathML]: http://www.w3.org/Math/
1140+[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/
1141+[jsMath]: http://www.math.union.edu/~dpvc/jsmath/
1426[MathJax]: https://www.mathjax.org
1142[MathJax]: https://www.mathjax.org
1143+[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/
1144+[mimeTeX]: http://www.forkosh.com/mimetex.html
1427[KaTeX]: https://github.com/Khan/KaTeX
1145[KaTeX]: https://github.com/Khan/KaTeX
1428−[GladTeX]: https://humenda.github.io/GladTeX/
1429
1146
1430−## Options for wrapper scripts {.options}
1147+Options for wrapper scripts
1148+---------------------------
1431
1149
1432`--dump-args`
1150`--dump-args`
1433
1151
@@ -1451,277 +1169,8 @@ results only for basic math, usually you will want to use
1451
1169
1452 pandoc -o foo.html -s
1170 pandoc -o foo.html -s
1453
1171
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
1172+Templates
1173+=========
1725
1174
1726When the `-s/--standalone` option is used, pandoc uses a template to
1175When the `-s/--standalone` option is used, pandoc uses a template to
1727add header and footer material that is needed for a self-standing
1176add header and footer material that is needed for a self-standing
@@ -1738,1592 +1187,687 @@ directory (see `--data-dir`, above). *Exceptions:*
1738- For `odt` output, customize the `default.opendocument`
1187- For `odt` output, customize the `default.opendocument`
1739 template.
1188 template.
1740- For `pdf` output, customize the `default.latex` template
1189- For `pdf` output, customize the `default.latex` template
1741− (or the `default.context` template, if you use `-t context`,
1190+ (or the `default.beamer` template, if you use `-t beamer`,
1742− or the `default.ms` template, if you use `-t ms`, or the
1191+ or the `default.context` template, if you use `-t context`).
1743− `default.html` template, if you use `-t html`).
1744−- `docx` and `pptx` have no template (however, you can use
1192+- `docx` has no template (however, you can use
1745 `--reference-doc` to customize the output).
1193 `--reference-doc` to customize the output).
1746
1194
1747Templates contain *variables*, which allow for the inclusion of
1195Templates contain *variables*, which allow for the inclusion of
1748−arbitrary information at any point in the file. They may be set at the
1196+arbitrary information at any point in the file. Variables may be set
1749−command 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
1751−using either [YAML metadata blocks][Extension: `yaml_metadata_block`]
1197+within the document using [YAML metadata blocks][Extension:
1752−or with the `-M/--metadata` option. In addition, some variables
1198+`yaml_metadata_block`]. They may also be set at the
1753−are given default values by pandoc. See [Variables] below for
1199+command line using the `-V/--variable` option: variables set in this
1754−a list of variables used in pandoc's default templates.
1200+way override metadata fields with the same name.
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
1201
1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates
1202+Variables set by pandoc
1203+-----------------------
1763
1204
1764−## Template syntax
1205+Some variables are set automatically by pandoc. These vary somewhat
1206+depending on the output format, but include metadata fields as well
1207+as the following:
1765
1208
1766−### Comments
1209+`sourcefile`, `outputfile`
1210+: source and destination filenames, as given on the command line.
1211+ `sourcefile` can also be a list if input comes from multiple files, or empty
1212+ if input is from stdin. You can use the following snippet in your template
1213+ to distinguish them:
1767
1214
1768−Anything between the sequence `$--` and the end of the
1215+ $if(sourcefile)$
1769−line will be treated as a comment and omitted from the output.
1216+ $for(sourcefile)$
1217+ $sourcefile$
1218+ $endfor$
1219+ $else$
1220+ (stdin)
1221+ $endif$
1770
1222
1771−### Delimiters
1223+ Similarly, `outputfile` can be `-` if output goes to the terminal.
1772
1224
1773−To mark variables and control structures in the template,
1225+`title`, `author`, `date`
1774−either `$`...`$` or `${`...`}` may be used as delimiters.
1226+: allow identification of basic aspects of the document. Included
1775−The styles may also be mixed in the same template, but the
1227+ in PDF metadata through LaTeX and ConTeXt. These can be set
1776−opening and closing delimiter must match in each case. The
1228+ through a [pandoc title block][Extension: `pandoc_title_block`],
1777−opening delimiter may be followed by one or more spaces
1229+ 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
1230
1782−To include a literal `$` in the document, use `$$`.
1231+ ---
1232+ author:
1233+ - Aristotle
1234+ - Peter Abelard
1235+ ...
1783
1236
1784−### Interpolated variables
1237+`subtitle`
1238+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;
1239+ renders in LaTeX only when using a document class that supports
1240+ `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,
1241+ `scrreprt`, `scrbook`).[^subtitle]
1785
1242
1786−A slot for an interpolated variable is a variable name surrounded
1243+`institute`
1787−by matched delimiters. Variable names must begin with a letter
1244+: author affiliations (in LaTeX and Beamer only). Can be a
1788−and can contain letters, numbers, `_`, `-`, and `.`. The
1245+ 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
1246
1792−```
1247+`abstract`
1793−$foo$
1248+: 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
1249
1803−Variable names with periods are used to get at structured
1250+`keywords`
1804−variable values. So, for example, `employee.salary` will return the
1251+: 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
1252+ may be repeated as for `author`, above
1806−the `employee` field.
1807
1253
1808−- If the value of the variable is simple value, it will be
1254+`header-includes`
1809− rendered verbatim. (Note that no escaping is done;
1255+: contents specified by `-H/--include-in-header` (may have multiple
1810− the assumption is that the calling program will escape
1256+ 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
1257
1816−### Conditionals
1258+`toc`
1259+: non-null value if `--toc/--table-of-contents` was specified
1817
1260
1818−A conditional begins with `if(variable)` (enclosed in
1261+`toc-title`
1819−matched delimiters) and ends with `endif` (enclosed in matched
1262+: title of table of contents (works only with EPUB,
1820−delimiters). It may optionally contain an `else` (enclosed in
1263+ opendocument, odt, docx)
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
1264
1825−```
1265+`include-before`
1826−$if(foo)$bar$endif$
1266+: contents specified by `-B/--include-before-body` (may have
1267+ multiple values)
1827
1268
1828−$if(foo)$
1269+`include-after`
1829− $foo$
1270+: contents specified by `-A/--include-after-body` (may have
1830−$endif$
1271+ multiple values)
1831
1272
1832−$if(foo)$
1273+`body`
1833−part one
1274+: body of document
1834−$else$
1835−part two
1836−$endif$
1837
1275
1838−${if(foo)}bar${endif}
1276+`meta-json`
1277+: JSON representation of all of the document's metadata. Field
1278+ values are transformed to the selected output format.
1839
1279
1840−${if(foo)}
1280+[^subtitle]: To make `subtitle` work with other LaTeX
1841− ${foo}
1281+ document classes, you can add the following to `header-includes`:
1842−${endif}
1843
1282
1844−${if(foo)}
1283+ \providecommand{\subtitle}[1]{%
1845−${ foo.bar }
1284+ \usepackage{titling}
1846−${else}
1285+ \posttitle{%
1847−no foo!
1286+ \par\large#1\end{center}}
1848−${endif}
1287+ }
1849−```
1850
1288
1851−The keyword `elseif` may be used to simplify complex nested
1289+Language variables
1852−conditionals:
1290+------------------
1853
1291
1854−```
1292+`lang`
1855−$if(foo)$
1293+: identifies the main language of the document,
1856−XXX
1294+ using a code according to [BCP 47] (e.g. `en` or `en-GB`).
1857−$elseif(bar)$
1295+ For some output formats, pandoc will convert it to an appropriate
1858−YYY
1296+ format stored in the additional variables `babel-lang`,
1859−$else$
1297+ `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).
1860−ZZZ
1298+
1861−$endif$
1299+ Native pandoc `span`s and `div`s with the lang attribute
1862−```
1300+ (value in BCP 47) can be used to switch the language in
1301+ that range.
1302+
1303+`otherlangs`
1304+: a list of other languages used in the document
1305+ in the YAML metadata, according to [BCP 47]. For example:
1306+ `otherlangs: [en-GB, fr]`.
1307+ This is automatically generated from the `lang` attributes
1308+ in all `span`s and `div`s but can be overridden.
1309+ Currently only used by LaTeX through the generated
1310+ `babel-otherlangs` and `polyglossia-otherlangs` variables.
1311+ The LaTeX writer outputs polyglossia commands in the text but
1312+ the `babel-newcommands` variable contains mappings for them
1313+ to the corresponding babel.
1863
1314
1864−### For loops
1315+`dir`
1316+: the base direction of the document, either `rtl` (right-to-left)
1317+ or `ltr` (left-to-right).
1865
1318
1866−A for loop begins with `for(variable)` (enclosed in
1319+ For bidirectional documents, native pandoc `span`s and `div`s
1867−matched delimiters) and ends with `endfor` (enclosed in matched
1320+ with the `dir` attribute (value `rtl` or `ltr`) can be used to
1868−delimiters.
1321+ override the base direction in some output formats.
1322+ This may not always be necessary if the final renderer
1323+ (e.g. the browser, when generating HTML) supports the
1324+ [Unicode Bidirectional Algorithm].
1869
1325
1870−- If `variable` is an array, the material inside the loop will
1326+ When using LaTeX for bidirectional documents, only the `xelatex` engine
1871− be evaluated repeatedly, with `variable` being set to each
1327+ 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
1328
1878−Examples:
1329+[BCP 47]: https://tools.ietf.org/html/bcp47
1330+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1879
1331
1880−```
1332+Variables for slides
1881−$for(foo)$$foo$$sep$, $endfor$
1333+--------------------
1882
1334
1883−$for(foo)$
1335+Variables are available for [producing slide shows with pandoc],
1884− - $foo.last$, $foo.first$
1336+including all [reveal.js configuration options].
1885−$endfor$
1886
1337
1887−${ for(foo.bar) }
1338+`titlegraphic`
1888− - ${ foo.bar.last }, ${ foo.bar.first }
1339+: title graphic for Beamer documents
1889−${ endfor }
1890
1340
1891−$for(mymap)$
1341+`logo`
1892−$it.name$: $it.office$
1342+: logo for Beamer documents
1893−$endfor$
1894−```
1895
1343
1896−You may optionally specify a separator between consecutive
1344+`slidy-url`
1897−values using `sep` (enclosed in matched delimiters). The
1345+: base URL for Slidy documents (defaults to
1898−material between `sep` and the `endfor` is the separator.
1346+ `https://www.w3.org/Talks/Tools/Slidy2`)
1899
1347
1900−```
1348+`slideous-url`
1901−${ for(foo) }${ foo }${ sep }, ${ endfor }
1349+: base URL for Slideous documents (defaults to `slideous`)
1902−```
1903
1350
1904−Instead of using `variable` inside the loop, the special
1351+`s5-url`
1905−anaphoric keyword `it` may be used.
1352+: base URL for S5 documents (defaults to `s5/default`)
1906
1353
1907−```
1354+`revealjs-url`
1908−${ for(foo.bar) }
1355+: base URL for reveal.js documents (defaults to `reveal.js`)
1909− - ${ it.last }, ${ it.first }
1910−${ endfor }
1911−```
1912
1356
1913−### Partials
1357+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1358+: themes for LaTeX [`beamer`] documents
1914
1359
1915−Partials (subtemplates stored in different files) may be
1360+`themeoptions`
1916−included by using the name of the partial, followed
1361+: options for LaTeX beamer themes (a list).
1917−by `()`, for example:
1918
1362
1919−```
1363+`navigation`
1920−${ styles() }
1364+: controls navigation symbols in `beamer` documents
1921−```
1365+ (default is `empty` for no navigation symbols; other valid values
1366+ are `frame`, `vertical`, and `horizontal`).
1922
1367
1923−Partials will be sought in the directory containing
1368+`section-titles`
1924−the main template. The file name will be assumed to
1369+: enables on "title pages" for new sections in `beamer`
1925−have the same extension as the main template if it
1370+ documents (default = true).
1926−lacks an extension. When calling the partial, the
1927−full name including file extension can also be used:
1928
1371
1929−```
1372+`beamerarticle`
1930−${ styles.html() }
1373+: when true, the `beamerarticle` package is loaded (for
1931−```
1374+ producing an article from beamer slides).
1932
1375
1933−(If a partial is not found in the directory of the
1376+`aspectratio`
1934−template and the template path is given as a relative
1377+: 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`
1378+ `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.)
1379+ default, and `32` for 3:2).
1937
1380
1938−Partials may optionally be applied to variables using
1381+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration
1939−a colon:
1940
1382
1941−```
1383+Variables for LaTeX
1942−${ date:fancy() }
1384+-------------------
1943
1385
1944−${ articles:bibentry() }
1386+LaTeX variables are used when [creating a PDF].
1945−```
1946
1387
1947−If `articles` is an array, this will iterate over its
1388+`papersize`
1948−values, applying the partial `bibentry()` to each one. So the
1389+: paper size, e.g. `letter`, `a4`
1949−second example above is equivalent to
1950
1390
1951−```
1391+`fontsize`
1952−${ for(articles) }
1392+: font size for body text (e.g. `10pt`, `12pt`)
1953−${ it:bibentry() }
1954−${ endfor }
1955−```
1956
1393
1957−Note that the anaphoric keyword `it` must be used when
1394+`documentclass`
1958−iterating over partials. In the above examples,
1395+: 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
1396
1962−Final newlines are omitted from included partials.
1397+`classoption`
1398+: option for document class, e.g. `oneside`; may be repeated
1399+ for multiple options
1963
1400
1964−Partials may include other partials.
1401+`geometry`
1402+: option for [`geometry`] package, e.g. `margin=1in`;
1403+ may be repeated for multiple options
1965
1404
1966−A separator between values of an array may be specified
1405+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1967−in square brackets, immediately after the variable name
1406+: sets margins, if `geometry` is not used (otherwise `geometry`
1968−or partial:
1407+ overrides these)
1969
1408
1970−```
1409+`linestretch`
1971−${months[, ]}$
1410+: adjusts line spacing using the [`setspace`]
1411+ package, e.g. `1.25`, `1.5`
1972
1412
1973−${articles:bibentry()[; ]$
1413+`fontfamily`
1974−```
1414+: font package for use with `pdflatex`:
1415+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].
1416+ The default is [Latin Modern][`lm`].
1975
1417
1976−The separator in this case is literal and (unlike with `sep`
1418+`fontfamilyoptions`
1977−in an explicit `for` loop) cannot contain interpolated
1419+: options for package used as `fontfamily`: e.g. `osf,sc` with
1978−variables or other template directives.
1420+ `fontfamily` set to [`mathpazo`] provides Palatino with old-style
1421+ figures and true small caps; may be repeated for multiple options
1979
1422
1980−### Nesting
1423+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`
1424+: font families for use with `xelatex` or
1425+ `lualatex`: take the name of any system font, using the
1426+ [`fontspec`] package. Note that if `CJKmainfont` is used,
1427+ the [`xecjk`] package must be available.
1981
1428
1982−To ensure that content is "nested," that is, subsequent lines
1429+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`
1983−indented, use the `^` directive:
1430+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,
1431+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices
1432+ available through [`fontspec`], such as the OpenType features
1433+ `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.
1984
1434
1985−```
1435+`fontenc`
1986−$item.number$ $^$$item.description$ ($item.price$)
1436+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);
1987−```
1437+ default is `T1` (see guide to [LaTeX font encodings])
1988
1438
1989−In this example, if `item.description` has multiple lines,
1439+`microtypeoptions`
1990−they will all be indented to line up with the first line:
1440+: options to pass to the microtype package
1991
1441
1992−```
1442+`colorlinks`
1993−00123 A fine bottle of 18-year old
1443+: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,
1994− Oban whiskey. ($148)
1444+ `urlcolor`, or `toccolor` are set
1995−```
1996
1445
1997−To nest multiple lines to the same level, align them
1446+`linkcolor`, `citecolor`, `urlcolor`, `toccolor`
1998−with the `^` directive in the template. For example:
1447+: color for internal links, citation links, external links, and links in table of contents:
1448+ uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists
1999
1449
2000−```
1450+`links-as-notes`
2001−$item.number$ $^$$item.description$ ($item.price$)
1451+: causes links to be printed as footnotes
2002− (Available til $item.sellby$.)
2003−```
2004
1452
2005−will produce
1453+`indent`
1454+: uses document class settings for indentation (the default LaTeX template
1455+ otherwise removes indentation and adds space between paragraphs)
2006
1456
2007−```
1457+`subparagraph`
2008−00123 A fine bottle of 18-year old
1458+: disables default behavior of LaTeX template that redefines (sub)paragraphs
2009− Oban whiskey. ($148)
1459+ as sections, changing the appearance of nested headings in some classes
2010− (Available til March 30, 2020.)
2011−```
2012
1460
2013−If a variable occurs by itself on a line, preceded by whitespace
1461+`thanks`
2014−and not followed by further text or directives on the same line,
1462+: specifies contents of acknowledgments footnote after document title.
2015−and the variable's value contains multiple lines, it will be
2016−nested automatically.
2017
1463
2018−### Breakable spaces
1464+`toc`
1465+: include table of contents (can also be set using `--toc/--table-of-contents`)
2019
1466
2020−Normally, spaces in the template itself (as opposed to values of
1467+`toc-depth`
2021−the interpolated variables) are not breakable, but they can be
1468+: level of section to include in table of contents
2022−made breakable in part of the template by using the `~` keyword
2023−(ended with another `~`).
2024
1469
2025−```
1470+`secnumdepth`
2026−$~$This long line may break if the document is rendered
1471+: numbering depth for sections, if sections are numbered
2027−with a short line length.$~$
2028−```
2029
1472
2030−### Pipes
1473+`lof`, `lot`
1474+: include list of figures, list of tables
2031
1475
2032−A pipe transforms the value of a variable or partial. Pipes are
1476+`bibliography`
2033−specified using a slash (`/`) between the variable name (or partial)
1477+: bibliography to use for resolving references
2034−and the pipe name. Example:
2035
1478
2036−```
1479+`biblio-style`
2037−$for(name)$
1480+: bibliography style, when used with `--natbib` and `--biblatex`.
2038−$name/uppercase$
2039−$endfor$
2040
1481
2041−$for(metadata/pairs)$
1482+`biblio-title`
2042−- $it.key$: $it.value$
1483+: bibliography title, when used with `--natbib` and `--biblatex`.
2043−$endfor$
2044
1484
2045−$employee:name()/uppercase$
1485+`biblatexoptions`
2046−```
1486+: list of options for biblatex.
2047
1487
2048−Pipes may be chained:
1488+`natbiboptions`
1489+: list of options for natbib.
2049
1490
2050−```
1491+[`article`]: https://ctan.org/pkg/article
2051−$for(employees/pairs)$
1492+[`report`]: https://ctan.org/pkg/report
2052−$it.key/alpha/uppercase$. $it.name$
1493+[`book`]: https://ctan.org/pkg/book
2053−$endfor$
1494+[KOMA-Script]: https://ctan.org/pkg/koma-script
2054−```
1495+[`memoir`]: https://ctan.org/pkg/memoir
1496+[`xcolor`]: https://ctan.org/pkg/xcolor
1497+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/
1498+[`mathpazo`]: https://ctan.org/pkg/mathpazo
1499+[LaTeX font encodings]: https://ctan.org/pkg/encguide
2055
1500
2056−Some pipes take parameters:
1501+Variables for ConTeXt
1502+---------------------
2057
1503
2058−```
1504+`papersize`
2059−|----------------------|------------|
1505+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);
2060−$for(employee)$
1506+ may be repeated for multiple options
2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
2062−$endfor$
2063−|----------------------|------------|
2064−```
2065
1507
2066−Currently the following pipes are predefined:
1508+`layout`
1509+: options for page margins and text arrangement (see [ConTeXt Layout]);
1510+ may be repeated for multiple options
2067
1511
2068−- `pairs`: Converts a map or array to an array of maps,
1512+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2069− each with `key` and `value` fields. If the original
1513+: sets margins, if `layout` is not used (otherwise `layout`
2070− value was an array, the `key` will be the array index,
1514+ overrides these)
2071− starting with 1.
2072
1515
2073−- `uppercase`: Converts text to uppercase.
1516+`fontsize`
1517+: font size for body text (e.g. `10pt`, `12pt`)
2074
1518
2075−- `lowercase`: Converts text to lowercase.
1519+`mainfont`, `sansfont`, `monofont`, `mathfont`
1520+: font families: take the name of any system font (see [ConTeXt Font Switching])
2076
1521
2077−- `length`: Returns the length of the value: number
1522+`linkcolor`, `contrastcolor`
2078− of characters for a textual value, number of elements
1523+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])
2079− for a map or array.
2080
1524
2081−- `reverse`: Reverses a textual value or array,
1525+`linkstyle`
2082− and has no effect on other values.
1526+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`
2083
1527
2084−- `first`: Returns the first value of an array, if
1528+`indenting`
2085− applied to a non-empty array; otherwise returns
1529+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);
2086− the original value.
1530+ may be repeated for multiple options
2087
1531
2088−- `last`: Returns the last value of an array, if
1532+`whitespace`
2089− applied to a non-empty array; otherwise returns
1533+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])
2090− the original value.
2091
1534
2092−- `rest`: Returns all but the first value of an array, if
1535+`interlinespace`
2093− applied to a non-empty array; otherwise returns
1536+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);
2094− the original value.
1537+ may be repeated for multiple options
2095
1538
2096−- `allbutlast`: Returns all but the last value of an array, if
1539+`headertext`, `footertext`
2097− applied to a non-empty array; otherwise returns
1540+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);
2098− the original value.
1541+ may be repeated up to four times for different placement
2099
1542
2100−- `chomp`: Removes trailing newlines (and breakable space).
1543+`pagenumbering`
1544+: page number style and location (using [`setuppagenumbering`]);
1545+ may be repeated for multiple options
2101
1546
2102−- `nowrap`: Disables line wrapping on breakable spaces.
1547+`toc`
1548+: include table of contents (can also be set using `--toc/--table-of-contents`)
2103
1549
2104−- `alpha`: Converts textual values that can be
1550+`lof`, `lot`
2105− read as an integer into lowercase alphabetic
1551+: include list of figures, list of tables
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
1552
2110−- `roman`: Converts textual values that can be
1553+[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup
2111− read as an integer into lowercase roman numerials.
1554+[ConTeXt Layout]: http://wiki.contextgarden.net/Layout
2112− This can be used to get lettered enumeration from array indices.
1555+[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching
2113− To get uppercase roman, chain with `uppercase`.
1556+[ConTeXt Color]: http://wiki.contextgarden.net/Color
1557+[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers
1558+[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation
1559+[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace
1560+[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace
1561+[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering
2114
1562
2115−- `left n "leftborder" "rightborder"`: Renders a textual value
1563+Variables for man pages
2116− in a block of width `n`, aligned to the left, with an optional
1564+-----------------------
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
1565
2123−- `right n "leftborder" "rightborder"`: Renders a textual value
1566+`section`
2124− in a block of width `n`, aligned to the right, and has no
1567+: section number in man pages
2125− effect on other values.
2126
1568
2127−- `center n "leftborder" "rightborder"`: Renders a textual
1569+`header`
2128− value in a block of width `n`, aligned to the center, and has
1570+: header in man pages
2129− no effect on other values.
2130
1571
1572+`footer`
1573+: footer in man pages
2131
1574
2132−## Variables
1575+`adjusting`
1576+: adjusts text to left (`l`), right (`r`), center (`c`),
1577+ or both (`b`) margins
2133
1578
2134−### Metadata variables
1579+`hyphenate`
1580+: if `true` (the default), hyphenation will be used
2135
1581
2136−`title`, `author`, `date`
1582+Variables for ms
2137−: allow identification of basic aspects of the document. Included
1583+----------------
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
1584
2143− ---
1585+`pointsize`
2144− author:
1586+: point size (e.g. `10p`)
2145− - Aristotle
2146− - Peter Abelard
2147− ...
2148
1587
2149− Note that if you just want to set PDF or HTML metadata, without
1588+`lineheight`
2150− including a title block in the document itself, you can
1589+: line height (e.g. `12p`)
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
1590
2156−`subtitle`
1591+`fontfamily`
2157−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx
1592+: font family (e.g. `T` or `P`)
2158− documents
2159
1593
2160−`abstract`
1594+`indent`
2161−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx
1595+: paragraph indent (e.g. `2m`)
2162− documents
2163
1596
2164−`keywords`
1597+Using variables in templates
2165−: list of keywords to be included in HTML, PDF, ODT, pptx, docx
1598+----------------------------
2166− and AsciiDoc metadata; repeat as for `author`, above
2167
1599
2168−`subject`
1600+Variable names are sequences of alphanumerics, `-`, and `_`,
2169−: document subject, included in ODT, PDF, docx and pptx metadata
1601+starting with a letter. A variable name surrounded by `$` signs
1602+will be replaced by its value. For example, the string `$title$` in
2170
1603
2171−`description`
1604+ <title>$title$</title>
2172−: document description, included in ODT, docx and pptx metadata. Some
2173− applications show this as `Comments` metadata.
2174
1605
2175−`category`
1606+will be replaced by the document title.
2176−: document category, included in docx and pptx metadata
2177
1607
2178−Additionally,
1608+To write a literal `$` in a template, use `$$`.
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
1609
2183− ---
1610+Templates may contain conditionals. The syntax is as follows:
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
1611
2193− It consists of two paragraphs
1612+ $if(variable)$
2194− ...
1613+ X
1614+ $else$
1615+ Y
1616+ $endif$
2195
1617
2196−will include `title`, `author` and `description` as standard document
1618+This will include `X` in the template if `variable` has a non-null
2197−properties and `subtitle` as a custom property when converting to docx,
1619+value; otherwise it will include `Y`. `X` and `Y` are placeholders for
2198−ODT or pptx.
1620+any valid template text, and may include interpolated variables or other
1621+conditionals. The `$else$` section may be omitted.
2199
1622
2200−### Language variables
1623+When variables can have multiple values (for example, `author` in
1624+a multi-author document), you can use the `$for$` keyword:
2201
1625
2202−`lang`
1626+ $for(author)$
2203−: identifies the main language of the document using IETF language
1627+ <meta name="author" content="$author$" />
2204− tags (following the [BCP 47] standard), such as `en` or `en-GB`.
1628+ $endfor$
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
1629
2209− Use native pandoc [Divs and Spans] with the `lang` attribute to
1630+You can optionally specify a separator to be used between
2210− switch the language:
1631+consecutive items:
2211
1632
2212− ---
1633+ $for(author)$$author$$sep$, $endfor$
2213− lang: en-GB
2214− ...
2215
1634
2216− Text in the main document language (British English).
1635+A dot can be used to select a field of a variable that takes
1636+an object as its value. So, for example:
2217
1637
2218− ::: {lang=fr-CA}
1638+ $author.name$ ($author.affiliation$)
2219− > Cette citation est écrite en français canadien.
2220− :::
2221
1639
2222− More text in English. ['Zitat auf Deutsch.']{lang=de}
1640+If you use custom templates, you may need to revise them as pandoc
1641+changes. We recommend tracking the changes in the default templates,
1642+and modifying your custom templates accordingly. An easy way to do this
1643+is to fork the [pandoc-templates] repository and merge in changes after each
1644+pandoc release.
2223
1645
2224−`dir`
1646+Templates may contain comments: anything on a line after `$--`
2225−: the base script direction, either `rtl` (right-to-left)
1647+will be treated as a comment and ignored.
2226− or `ltr` (left-to-right).
2227
1648
2228− For bidirectional documents, native pandoc `span`s and
1649+[pandoc-templates]: https://github.com/jgm/pandoc-templates
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
1650
2235− When using LaTeX for bidirectional documents, only the
1651+Pandoc's Markdown
2236− `xelatex` engine is fully supported (use
1652+=================
2237− `--pdf-engine=xelatex`).
2238
1653
2239−[BCP 47]: https://tools.ietf.org/html/bcp47
1654+Pandoc understands an extended and slightly revised version of
2240−[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics
1655+John Gruber's [Markdown] syntax. This document explains the syntax,
2241−[Language subtag lookup]: https://r12a.github.io/app-subtags/
1656+noting differences from standard Markdown. Except where noted, these
1657+differences can be suppressed by using the `markdown_strict` format instead
1658+of `markdown`. An extensions can be enabled by adding `+EXTENSION`
1659+to the format name and disabled by adding `-EXTENSION`. For example,
1660+`markdown_strict+footnotes` is strict Markdown with footnotes
1661+enabled, while `markdown-footnotes-pipe_tables` is pandoc's
1662+Markdown without footnotes or pipe tables.
2242
1663
2243−### Variables for HTML
1664+Philosophy
1665+----------
2244
1666
2245−`document-css`
1667+Markdown is designed to be easy to write, and, even more importantly,
2246−: Enables inclusion of most of the [CSS] in the `styles.html`
1668+easy to read:
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
1669
2253−`mainfont`
1670+> A Markdown-formatted document should be publishable as-is, as plain
2254−: sets the CSS `font-family` property on the `html` element.
1671+> text, without looking like it's been marked up with tags or formatting
1672+> instructions.
1673+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)
2255
1674
2256−`fontsize`
1675+This principle has guided pandoc's decisions in finding syntax for
2257−: sets the base CSS `font-size`, which you'd usually set
1676+tables, footnotes, and other extensions.
2258− to e.g. `20px`, but it also accepts `pt`
2259− (12pt = 16px in most browsers).
2260
1677
2261−`fontcolor`
1678+There is, however, one respect in which pandoc's aims are different
2262−: sets the CSS `color` property on the `html` element.
1679+from the original aims of Markdown. Whereas Markdown was originally
1680+designed with HTML generation in mind, pandoc is designed for multiple
1681+output formats. Thus, while pandoc allows the embedding of raw HTML,
1682+it discourages it, and provides other, non-HTMLish ways of representing
1683+important document elements like definition lists, tables, mathematics, and
1684+footnotes.
2263
1685
2264−`linkcolor`
1686+Paragraphs
2265−: sets the CSS `color` property on all links.
1687+----------
2266
1688
2267−`monofont`
1689+A paragraph is one or more lines of text followed by one or more blank lines.
2268−: sets the CSS `font-family` property on `code` elements.
1690+Newlines are treated as spaces, so you can reflow your paragraphs as you like.
1691+If you need a hard line break, put two or more spaces at the end of a line.
2269
1692
2270−`monobackgroundcolor`
1693+#### Extension: `escaped_line_breaks` ####
2271−: sets the CSS `background-color` property on `code` elements
2272− and adds extra padding.
2273
1694
2274−`linestretch`
1695+A backslash followed by a newline is also a hard line break.
2275−: sets the CSS `line-height` property on the `html` element,
1696+Note: in multiline and grid table cells, this is the only way
2276− which is preferred to be unitless.
1697+to create a hard line break, since trailing spaces in the cells
1698+are ignored.
2277
1699
2278−`backgroundcolor`
1700+Headers
2279−: sets the CSS `background-color` property on the `html` element.
1701+-------
2280
1702
2281−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
1703+There are two kinds of headers: Setext and ATX.
2282−: sets the corresponding CSS `padding` properties on the `body` element.
2283
1704
2284−To override or extend some [CSS] for just one document, include for example:
1705+### Setext-style headers ###
2285
1706
2286− ---
1707+A setext-style header is a line of text "underlined" with a row of `=` signs
2287− header-includes: |
1708+(for a level one header) or `-` signs (for a level two header):
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
1709
2304−[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS
1710+ A level-one header
1711+ ==================
2305
1712
2306−### Variables for HTML math
1713+ A level-two header
1714+ ------------------
2307
1715
2308−`classoption`
1716+The header text can contain inline formatting, such as emphasis (see
2309−: when using [KaTeX](#option--katex), you can render display
1717+[Inline formatting], below).
2310−math equations flush left using [YAML metadata](#layout) or with
2311−`-M classoption=fleqn`.
2312
1718
2313−### Variables for HTML slides
2314
1719
2315−These affect HTML output when [producing slide shows with pandoc].
1720+### ATX-style headers ###
2316
1721
2317−`institute`
1722+An ATX-style header consists of one to six `#` signs and a line of
2318−: author affiliations: can be a list when there are multiple authors
1723+text, optionally followed by any number of `#` signs. The number of
1724+`#` signs at the beginning of the line is the header level:
2319
1725
2320−`revealjs-url`
1726+ ## A level-two header
2321−: base URL for reveal.js documents (defaults to
2322− `https://unpkg.com/reveal.js@^4/`)
2323
1727
2324−`s5-url`
1728+ ### A level-three header ###
2325−: base URL for S5 documents (defaults to `s5/default`)
2326
1729
2327−`slidy-url`
1730+As with setext-style headers, the header text can contain formatting:
2328−: base URL for Slidy documents (defaults to
2329− `https://www.w3.org/Talks/Tools/Slidy2`)
2330
1731
2331−`slideous-url`
1732+ # A level-one header with a [link](/url) and *emphasis*
2332−: base URL for Slideous documents (defaults to `slideous`)
2333
1733
2334−`title-slide-attributes`
1734+#### Extension: `blank_before_header` ####
2335−: additional attributes for the title slide of reveal.js slide shows.
2336− See [background in reveal.js and beamer] for an example.
2337
1735
2338−All [reveal.js configuration options] are available as variables.
1736+Standard Markdown syntax does not require a blank line before a header.
2339−To turn off boolean flags that default to true in reveal.js, use `0`.
1737+Pandoc does require this (except, of course, at the beginning of the
1738+document). The reason for the requirement is that it is all too easy for a
1739+`#` to end up at the beginning of a line by accident (perhaps through line
1740+wrapping). Consider, for example:
2340
1741
2341−[reveal.js configuration options]: https://revealjs.com/config/
1742+ I like several of their flavors of ice cream:
1743+ #22, for example, and #5.
2342
1744
2343−### Variables for Beamer slides
1745+#### Extension: `space_in_atx_header` ####
2344
1746
2345−These variables change the appearance of PDF slides using [`beamer`].
1747+Many Markdown implementations do not require a space between the
1748+opening `#`s of an ATX header and the header text, so that
1749+`#5 bolt` and `#hashtag` count as headers. With this extension,
1750+pandoc does require the space.
2346
1751
2347−`aspectratio`
1752+### Header identifiers ###
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
1753
2352−`beamerarticle`
1754+#### Extension: `header_attributes` ####
2353−: produce an article from Beamer slides
2354
1755
2355−`beameroption`
1756+Headers can be assigned attributes using this syntax at the end
2356−: add extra beamer option with `\setbeameroption{}`
1757+of the line containing the header text:
2357
1758
2358−`institute`
1759+ {#identifier .class .class key=value key=value}
2359−: author affiliations: can be a list when there are multiple authors
2360
1760
2361−`logo`
1761+Thus, for example, the following headers will all be assigned the identifier
2362−: logo image for slides
1762+`foo`:
2363
1763
2364−`navigation`
1764+ # My header {#foo}
2365−: controls navigation symbols (default is `empty` for no navigation
2366− symbols; other valid values are `frame`, `vertical`, and `horizontal`)
2367
1765
2368−`section-titles`
1766+ ## My header ## {#foo}
2369−: enables "title pages" for new sections (default is true)
2370
1767
2371−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`
1768+ My other header {#foo}
2372−: beamer themes
1769+ ---------------
2373
1770
2374−`themeoptions`
1771+(This syntax is compatible with [PHP Markdown Extra].)
2375−: options for LaTeX beamer themes (a list).
2376
1772
2377−`titlegraphic`
1773+Note that although this syntax allows assignment of classes and key/value
2378−: image for title slide
1774+attributes, writers generally don't use all of this information. Identifiers,
1775+classes, and key/value attributes are used in HTML and HTML-based formats such
1776+as EPUB and slidy. Identifiers are used for labels and link anchors in the
1777+LaTeX, ConTeXt, Textile, and AsciiDoc writers.
2379
1778
2380−### Variables for PowerPoint
1779+Headers with the class `unnumbered` will not be numbered, even if
1780+`--number-sections` is specified. A single hyphen (`-`) in an attribute
1781+context is equivalent to `.unnumbered`, and preferable in non-English
1782+documents. So,
2381
1783
2382−These variables control the visual aspects of a slide show that
1784+ # My header {-}
2383−are not easily controlled via templates.
2384
1785
2385−`monofont`
1786+is just the same as
2386−: font to use for code.
2387
1787
2388−### Variables for LaTeX
1788+ # My header {.unnumbered}
2389
1789
2390−Pandoc uses these variables when [creating a PDF] with a LaTeX engine.
1790+#### Extension: `auto_identifiers` ####
2391
1791
2392−#### Layout
1792+A header without an explicitly specified identifier will be
1793+automatically assigned a unique identifier based on the header text.
1794+To derive the identifier from the header text,
2393
1795
2394−`block-headings`
1796+ - Remove all formatting, links, etc.
2395−: make `\paragraph` and `\subparagraph` (fourth- and
1797+ - Remove all footnotes.
2396− fifth-level headings, or fifth- and sixth-level with book
1798+ - Remove all punctuation, except underscores, hyphens, and periods.
2397− classes) free-standing rather than run-in; requires further
1799+ - Replace all spaces and newlines with hyphens.
2398− formatting to distinguish from `\subsubsection` (third- or
1800+ - Convert all alphabetic characters to lowercase.
2399− fourth-level headings). Instead of using this option,
1801+ - Remove everything up to the first letter (identifiers may
2400− [KOMA-Script] can adjust headings more extensively:
1802+ not begin with a number or punctuation mark).
1803+ - If nothing is left after this, use the identifier `section`.
2401
1804
2402− ---
1805+Thus, for example,
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
1806
2416−`classoption`
1807+ Header Identifier
2417−: option for document class, e.g. `oneside`; repeat for multiple options:
1808+ ------------------------------- ----------------------------
1809+ `Header identifiers in HTML` `header-identifiers-in-html`
1810+ `*Dogs*?--in *my* house?` `dogs--in-my-house`
1811+ `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
1812+ `3. Applications` `applications`
1813+ `33` `section`
2418
1814
2419− ---
1815+These rules should, in most cases, allow one to determine the identifier
2420− classoption:
1816+from the header text. The exception is when several headers have the
2421− - twocolumn
1817+same text; in this case, the first will get an identifier as described
2422− - landscape
1818+above; the second will get the same identifier with `-1` appended; the
2423− ...
1819+third with `-2`; and so on.
2424
1820
2425−`documentclass`
1821+These identifiers are used to provide link targets in the table of
2426−: document class: usually one of the standard classes,
1822+contents generated by the `--toc|--table-of-contents` option. They
2427− [`article`], [`book`], and [`report`]; the [KOMA-Script]
1823+also make it easy to provide links from one section of a document to
2428− equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which
1824+another. A link to this section, for example, might look like this:
2429− default to smaller margins; or [`memoir`]
2430
1825
2431−`geometry`
1826+ See the section on
2432−: option for [`geometry`] package, e.g. `margin=1in`;
1827+ [header identifiers](#header-identifiers-in-html-latex-and-context).
2433− repeat for multiple options:
2434
1828
2435− ---
1829+Note, however, that this method of providing links to sections works
2436− geometry:
1830+only in HTML, LaTeX, and ConTeXt formats.
2437− - top=30mm
2438− - left=20mm
2439− - heightrounded
2440− ...
2441
1831
2442−`hyperrefoptions`
1832+If the `--section-divs` option is specified, then each section will
2443−: option for [`hyperref`] package, e.g. `linktoc=all`;
1833+be wrapped in a `div` (or a `section`, if `html5` was specified),
2444− repeat for multiple options:
1834+and the identifier will be attached to the enclosing `<div>`
1835+(or `<section>`) tag rather than the header itself. This allows entire
1836+sections to be manipulated using JavaScript or treated differently in
1837+CSS.
2445
1838
2446− ---
1839+#### Extension: `implicit_header_references` ####
2447− hyperrefoptions:
2448− - linktoc=all
2449− - pdfwindowui
2450− - pdfpagemode=FullScreen
2451− ...
2452
1840
2453−`indent`
1841+Pandoc behaves as if reference links have been defined for each header.
2454−: if true, pandoc will use document class settings for
1842+So, to link to a header
2455− indentation (the default LaTeX template otherwise removes
2456− indentation and adds space between paragraphs)
2457
1843
2458−`linestretch`
1844+ # Header identifiers in HTML
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`
2464− overrides these)
2465−
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`
2592−: font size for body text (e.g. `10pt`, `12pt`)
2593−
2594−`headertext`, `footertext`
2595−: text to be placed in running header or footer (see [ConTeXt Headers and
2596− Footers]); repeat up to four times for different placement
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−
2610−`linkcolor`, `contrastcolor`
2611−: color for links outside and inside a page, e.g. `red`, `blue` (see
2612− [ConTeXt Color])
2613−
2614−`linkstyle`
2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,
2616− `type`, `cap`, `small`
2617−
2618−`lof`, `lot`
2619−: include list of figures, list of tables
2620−
2621−`mainfont`, `sansfont`, `monofont`, `mathfont`
2622−: font families: take the name of any system font (see
2623− [ConTeXt Font Switching])
2624−
2625−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2626−: sets margins, if `layout` is not used (otherwise `layout`
2627− overrides these)
2628−
2629−`pagenumbering`
2630−: page number style and location (using [`setuppagenumbering`]);
2631− repeat 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−
2663−`toc`
2664−: include table of contents (can also be set using
2665− `--toc/--table-of-contents`)
2666−
2667−`whitespace`
2668−: spacing between paragraphs, e.g. `none`, `small` (using
2669− [`setupwhitespace`])
2670−
2671−`includesource`
2672−: include all source documents as file attachments in the PDF file
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−
2691−`footer-html`, `header-html`
2692−: add information to the header and footer
2693−
2694−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`
2695−: set the page margins
2696−
2697−`papersize`
2698−: sets the PDF paper size
2699−
2700−### Variables for man pages
2701−
2702−`adjusting`
2703−: adjusts text to left (`l`), right (`r`), center (`c`),
2704− or both (`b`) margins
2705−
2706−`footer`
2707−: footer in man pages
2708−
2709−`header`
2710−: header in man pages
2711−
2712−`hyphenate`
2713−: if `true` (the default), hyphenation will be used
2714−
2715−`section`
2716−: section number in man pages
2717−
2718−### Variables for ms
2719−
2720−`fontfamily`
2721−: font family (e.g. `T` or `P`)
2722−
2723−`indent`
2724−: paragraph indent (e.g. `2m`)
2725−
2726−`lineheight`
2727−: line height (e.g. `12p`)
2728−
2729−`pointsize`
2730−: point size (e.g. `10p`)
2731−
2732−### Variables set automatically
2733−
2734−Pandoc sets these variables automatically in response to [options] or
2735−document contents; users can also modify them. These vary depending
2736−on the output format, and include the following:
2737−
2738−`body`
2739−: body of document
2740−
2741−`date-meta`
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−
2751−`header-includes`
2752−: contents specified by `-H/--include-in-header` (may have multiple
2753− values)
2754−
2755−`include-before`
2756−: contents specified by `-B/--include-before-body` (may have
2757− multiple values)
2758−
2759−`include-after`
2760−: contents specified by `-A/--include-after-body` (may have
2761− multiple values)
2762−
2763−`meta-json`
2764−: JSON representation of all of the document's metadata. Field
2765− values are transformed to the selected output format.
2766−
2767−`numbersections`
2768−: non-null value if `-N/--number-sections` was specified
2769−
2770−`sourcefile`, `outputfile`
2771−: source and destination filenames, as given on the command line.
2772− `sourcefile` can also be a list if input comes from multiple files,
2773− or empty if input is from stdin. You can use the following snippet in
2774− your template to distinguish them:
2775−
2776− $if(sourcefile)$
2777− $for(sourcefile)$
2778− $sourcefile$
2779− $endfor$
2780− $else$
2781− (stdin)
2782− $endif$
2783−
2784− Similarly, `outputfile` can be `-` if output goes to the terminal.
2785−
2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.
2787−
2788−`curdir`
2789−: working directory from which pandoc is run.
2790−
2791−`toc`
2792−: non-null value if `--toc/--table-of-contents` was specified
2793−
2794−`toc-title`
2795−: title of table of contents (works only with EPUB,
2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)
2797−
2798−[pandoc-templates]: https://github.com/jgm/pandoc-templates
2799−
2800−# Extensions
2801−
2802−The behavior of some of the readers and writers can be adjusted by
2803−enabling or disabling various extensions.
2804−
2805−An extension can be enabled by adding `+EXTENSION`
2806−to the format name and disabled by adding `-EXTENSION`. For example,
2807−`--from markdown_strict+footnotes` is strict Markdown with footnotes
2808−enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's
2809−Markdown without footnotes or pipe tables.
2810−
2811−The markdown reader and writer make by far the most use of extensions.
2812−Extensions only used by them are therefore covered in the
2813−section [Pandoc's Markdown] below (See [Markdown variants] for
2814−`commonmark` and `gfm`.) In the following, extensions that also work
2815−for other formats are covered.
2816−
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
2822−
2823−#### Extension: `smart` ####
2824−
2825−Interpret straight quotes as curly quotes, `---` as em-dashes,
2826−`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
2827−inserted after certain abbreviations, such as "Mr."
2828−
2829−This extension can be enabled/disabled for the following formats:
2830−
2831−input formats
2832−: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`
2833−
2834−output formats
2835−: `markdown`, `latex`, `context`, `rst`
2836−
2837−enabled by default in
2838−: `markdown`, `latex`, `context` (both input and output)
2839−
2840−Note: If you are *writing* Markdown, then the `smart` extension
2841−has the reverse effect: what would have been curly quotes comes
2842−out straight.
2843−
2844−In LaTeX, `smart` means to use the standard TeX ligatures
2845−for quotation marks (` `` ` and ` '' ` for double quotes,
2846−`` ` `` and `` ' `` for single quotes) and dashes (`--` for
2847−en-dash and `---` for em-dash). If `smart` is disabled,
2848−then in reading LaTeX pandoc will parse these characters
2849−literally. In writing LaTeX, enabling `smart` tells pandoc
2850−to use the ligatures when possible; if `smart` is disabled
2851−pandoc will use unicode quotation mark and dash characters.
2852−
2853−## Headings and sections
2854−
2855−#### Extension: `auto_identifiers` ####
2856−
2857−A heading without an explicitly specified identifier will be
2858−automatically assigned a unique identifier based on the heading text.
2859−
2860−This extension can be enabled/disabled for the following formats:
2861−
2862−input formats
2863−: `markdown`, `latex`, `rst`, `mediawiki`, `textile`
2864−
2865−output formats
2866−: `markdown`, `muse`
2867−
2868−enabled by default in
2869−: `markdown`, `muse`
2870−
2871−The default algorithm used to derive the identifier from the
2872−heading text is:
2873−
2874− - Remove all formatting, links, etc.
2875− - Remove all footnotes.
2876− - Remove all non-alphanumeric characters,
2877− except underscores, hyphens, and periods.
2878− - Replace all spaces and newlines with hyphens.
2879− - Convert all alphabetic characters to lowercase.
2880− - Remove everything up to the first letter (identifiers may
2881− not begin with a number or punctuation mark).
2882− - If nothing is left after this, use the identifier `section`.
2883−
2884−Thus, for example,
2885−
2886− Heading Identifier
2887− ------------------------------- ----------------------------
2888− `Heading identifiers in HTML` `heading-identifiers-in-html`
2889− `Maître d'hôtel` `maître-dhôtel`
2890− `*Dogs*?--in *my* house?` `dogs--in-my-house`
2891− `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`
2892− `3. Applications` `applications`
2893− `33` `section`
2894−
2895−These rules should, in most cases, allow one to determine the identifier
2896−from the heading text. The exception is when several headings have the
2897−same text; in this case, the first will get an identifier as described
2898−above; the second will get the same identifier with `-1` appended; the
2899−third with `-2`; and so on.
2900−
2901−(However, a different algorithm is used if
2902−`gfm_auto_identifiers` is enabled; see below.)
2903−
2904−These identifiers are used to provide link targets in the table of
2905−contents generated by the `--toc|--table-of-contents` option. They
2906−also make it easy to provide links from one section of a document to
2907−another. A link to this section, for example, might look like this:
2908−
2909− See the section on
2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).
2911−
2912−Note, however, that this method of providing links to sections works
2913−only in HTML, LaTeX, and ConTeXt formats.
2914−
2915−If the `--section-divs` option is specified, then each section will
2916−be wrapped in a `section` (or a `div`, if `html4` was specified),
2917−and the identifier will be attached to the enclosing `<section>`
2918−(or `<div>`) tag rather than the heading itself. This allows entire
2919−sections to be manipulated using JavaScript or treated differently in
2920−CSS.
2921−
2922−#### Extension: `ascii_identifiers` ####
2923−
2924−Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
2925−Accents are stripped off of accented Latin letters, and non-Latin
2926−letters are omitted.
2927−
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
2937−
2938−The extensions [`tex_math_dollars`](#extension-tex_math_dollars),
2939−[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and
2940−[`tex_math_double_backslash`](#extension-tex_math_double_backslash)
2941−are described in the section about Pandoc's Markdown.
2942−
2943−However, they can also be used with HTML input. This is handy for
2944−reading web pages formatted using MathJax, for example.
2945−
2946−## Raw HTML/TeX
2947−
2948−The following extensions are described in more detail in
2949−their respective sections of [Pandoc's Markdown]:
2950−
2951−- [`raw_html`](#extension-raw_html) allows HTML elements which
2952− are not representable in pandoc's AST to be parsed as raw HTML.
2953− By default, this is disabled for HTML input.
2954−
2955−- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt
2956− to be included in a document. This extension can be enabled/disabled
2957− for the following formats (in addition to `markdown`):
2958−
2959− input formats
2960− : `latex`, `textile`, `html` (environments, `\ref`, and
2961− `\eqref` only), `ipynb`
2962−
2963− output formats
2964− : `textile`, `commonmark`
2965−
2966− Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not
2967− only raw TeX in markdown cells, but data with mime type
2968− `text/html` in output cells. Since the `ipynb` reader attempts
2969− to preserve the richest possible outputs when several options
2970− are given, you will get best results if you disable `raw_html`
2971− and `raw_tex` when converting to formats like `docx` which don't
2972− allow raw `html` or `tex`.
2973−
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`.
2978−
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−
2986−## Literate Haskell support
2987−
2988−#### Extension: `literate_haskell` ####
2989−
2990−Treat the document as literate Haskell source.
2991−
2992−This extension can be enabled/disabled for the following formats:
2993−
2994−input formats
2995−: `markdown`, `rst`, `latex`
2996−
2997−output formats
2998−: `markdown`, `rst`, `latex`, `html`
2999−
3000−If you append `+lhs` (or `+literate_haskell`) to one of the formats
3001−above, pandoc will treat the document as literate Haskell source.
3002−This means that
3003−
3004− - In Markdown input, "bird track" sections will be parsed as Haskell
3005− code rather than block quotations. Text between `\begin{code}`
3006− and `\end{code}` will also be treated as Haskell code. For
3007− ATX-style headings the character '=' will be used instead of '#'.
3008−
3009− - In Markdown output, code blocks with classes `haskell` and `literate`
3010− will be rendered using bird tracks, and block quotations will be
3011− indented one space, so they will not be treated as Haskell code.
3012− In addition, headings will be rendered setext-style (with underlines)
3013− rather than ATX-style (with '#' characters). (This is because ghc
3014− treats '#' characters in column 1 as introducing line numbers.)
3015−
3016− - In restructured text input, "bird track" sections will be parsed
3017− as Haskell code.
3018−
3019− - In restructured text output, code blocks with class `haskell` will
3020− be rendered using bird tracks.
3021−
3022− - In LaTeX input, text in `code` environments will be parsed as
3023− Haskell code.
3024−
3025− - In LaTeX output, code blocks with class `haskell` will be rendered
3026− inside `code` environments.
3027−
3028− - In HTML output, code blocks with class `haskell` will be rendered
3029− with class `literatehaskell` and bird tracks.
3030−
3031−Examples:
3032−
3033− pandoc -f markdown+lhs -t html
3034−
3035−reads literate Haskell source formatted with Markdown conventions and writes
3036−ordinary HTML (without bird tracks).
3037−
3038− pandoc -f markdown+lhs -t html+lhs
3039−
3040−writes HTML with the Haskell code in bird tracks, so it can be copied
3041−and pasted as literate Haskell source.
3042−
3043−Note that GHC expects the bird tracks in the first column, so indented
3044−literate code blocks (e.g. inside an itemized environment) will not be
3045−picked up by the Haskell compiler.
3046−
3047−## Other extensions
3048−
3049−#### Extension: `empty_paragraphs` ####
3050−
3051−Allows empty paragraphs. By default empty paragraphs are
3052−omitted.
3053−
3054−This extension can be enabled/disabled for the following formats:
3055−
3056−input formats
3057−: `docx`, `html`
3058−
3059−output formats
3060−: `docx`, `odt`, `opendocument`, `html`
3061−
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}
3110−
3111−When converting from docx, read all docx styles as divs (for
3112−paragraph styles) and spans (for character styles) regardless
3113−of whether pandoc understands the meaning of these styles.
3114−This can be used with [docx custom styles](#custom-styles).
3115−Disabled by default.
3116−
3117−input formats
3118−: `docx`
3119−
3120−#### Extension: `amuse` ####
3121−
3122−In the `muse` input format, this enables Text::Amuse
3123−extensions to Emacs Muse markup.
3124−
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}
3134−
3135−Some aspects of [Pandoc's Markdown citation syntax](#citations)
3136−are also accepted in `org` input.
3137−
3138−#### Extension: `element_citations` ####
3139−
3140−In the `jats` output formats, this causes reference items to
3141−be replaced with `<element-citation>` elements. These
3142−elements are not influenced by CSL styles, but all information
3143−on the item is included in tags.
3144−
3145−#### Extension: `ntb` ####
3146−
3147−In the `context` output format this enables the use of [Natural Tables
3148−(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default
3149−[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).
3150−Natural tables allow more fine-grained global customization but come
3151−at a performance penalty compared to extreme tables.
3152−
3153−
3154−# Pandoc's Markdown
3155−
3156−Pandoc understands an extended and slightly revised version of
3157−John Gruber's [Markdown] syntax. This document explains the syntax,
3158−noting differences from standard Markdown. Except where noted, these
3159−differences can be suppressed by using the `markdown_strict` format instead
3160−of `markdown`. Extensions can be enabled or disabled to specify the
3161−behavior more granularly. They are described in the following. See also
3162−[Extensions] above, for extensions that work also on other formats.
3163−
3164−## Philosophy
3165−
3166−Markdown is designed to be easy to write, and, even more importantly,
3167−easy to read:
3168−
3169−> 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
3171−> instructions.
3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)
3173−
3174−This principle has guided pandoc's decisions in finding syntax for
3175−tables, footnotes, and other extensions.
3176−
3177−There is, however, one respect in which pandoc's aims are different
3178−from the original aims of Markdown. Whereas Markdown was originally
3179−designed with HTML generation in mind, pandoc is designed for multiple
3180−output formats. Thus, while pandoc allows the embedding of raw HTML,
3181−it discourages it, and provides other, non-HTMLish ways of representing
3182−important document elements like definition lists, tables, mathematics, and
3183−footnotes.
3184−
3185−## Paragraphs
3186−
3187−A paragraph is one or more lines of text followed by one or more blank lines.
3188−Newlines are treated as spaces, so you can reflow your paragraphs as you like.
3189−If you need a hard line break, put two or more spaces at the end of a line.
3190−
3191−#### Extension: `escaped_line_breaks` ####
3192−
3193−A backslash followed by a newline is also a hard line break.
3194−Note: in multiline and grid table cells, this is the only way
3195−to create a hard line break, since trailing spaces in the cells
3196−are ignored.
3197−
3198−## Headings
3199−
3200−There are two kinds of headings: Setext and ATX.
3201−
3202−### Setext-style headings ###
3203−
3204−A setext-style heading is a line of text "underlined" with a row of `=` signs
3205−(for a level-one heading) or `-` signs (for a level-two heading):
3206−
3207− A level-one heading
3208− ===================
3209−
3210− A level-two heading
3211− -------------------
3212−
3213−The heading text can contain inline formatting, such as emphasis (see
3214−[Inline formatting], below).
3215−
3216−
3217−### ATX-style headings ###
3218−
3219−An ATX-style heading consists of one to six `#` signs and a line of
3220−text, optionally followed by any number of `#` signs. The number of
3221−`#` signs at the beginning of the line is the heading level:
3222−
3223− ## A level-two heading
3224−
3225− ### A level-three heading ###
3226−
3227−As with setext-style headings, the heading text can contain formatting:
3228−
3229− # A level-one heading with a [link](/url) and *emphasis*
3230−
3231−#### Extension: `blank_before_header` ####
3232−
3233−Standard Markdown syntax does not require a blank line before a heading.
3234−Pandoc does require this (except, of course, at the beginning of the
3235−document). The reason for the requirement is that it is all too easy for a
3236−`#` to end up at the beginning of a line by accident (perhaps through line
3237−wrapping). Consider, for example:
3238−
3239− I like several of their flavors of ice cream:
3240− #22, for example, and #5.
3241−
3242−#### Extension: `space_in_atx_header` ####
3243−
3244−Many Markdown implementations do not require a space between the
3245−opening `#`s of an ATX heading and the heading text, so that
3246−`#5 bolt` and `#hashtag` count as headings. With this extension,
3247−pandoc does require the space.
3248−
3249−### Heading identifiers ###
3250−
3251−See also the [`auto_identifiers`
3252−extension](#extension-auto_identifiers) above.
3253−
3254−#### Extension: `header_attributes` ####
3255−
3256−Headings can be assigned attributes using this syntax at the end
3257−of the line containing the heading text:
3258−
3259− {#identifier .class .class key=value key=value}
3260−
3261−Thus, for example, the following headings will all be assigned the identifier
3262−`foo`:
3263−
3264− # My heading {#foo}
3265−
3266− ## My heading ## {#foo}
3267−
3268− My other heading {#foo}
3269− ---------------
3270−
3271−(This syntax is compatible with [PHP Markdown Extra].)
3272−
3273−Note that although this syntax allows assignment of classes and key/value
3274−attributes, writers generally don't use all of this information. Identifiers,
3275−classes, and key/value attributes are used in HTML and HTML-based formats such
3276−as EPUB and slidy. Identifiers are used for labels and link anchors in the
3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.
3278−
3279−Headings with the class `unnumbered` will not be numbered, even if
3280−`--number-sections` is specified. A single hyphen (`-`) in an attribute
3281−context is equivalent to `.unnumbered`, and preferable in non-English
3282−documents. So,
3283−
3284− # My heading {-}
3285−
3286−is just the same as
3287−
3288− # My heading {.unnumbered}
3289−
3290−If the `unlisted` class is present in addition to `unnumbered`,
3291−the heading will not be included in a table of contents.
3292−(Currently this feature is only implemented for certain
3293−formats: those based on LaTeX and HTML, PowerPoint, and RTF.)
3294−
3295−#### Extension: `implicit_header_references` ####
3296−
3297−Pandoc behaves as if reference links have been defined for each heading.
3298−So, to link to a heading
3299−
3300− # Heading identifiers in HTML
3301
1845
3302you can simply write
1846you can simply write
3303
1847
3304− [Heading identifiers in HTML]
1848+ [Header identifiers in HTML]
3305
1849
3306or
1850or
3307
1851
3308− [Heading identifiers in HTML][]
1852+ [Header identifiers in HTML][]
3309
1853
3310or
1854or
3311
1855
3312− [the section on heading identifiers][heading identifiers in
1856+ [the section on header identifiers][header identifiers in
3313 HTML]
1857 HTML]
3314
1858
3315instead of giving the identifier explicitly:
1859instead of giving the identifier explicitly:
3316
1860
3317− [Heading identifiers in HTML](#heading-identifiers-in-html)
1861+ [Header identifiers in HTML](#header-identifiers-in-html)
3318
1862
3319−If there are multiple headings with identical text, the corresponding
1863+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
1864reference will link to the first one only, and you will need to use explicit
3321links to link to the others, as described above.
1865links to link to the others, as described above.
3322
1866
3323Like regular reference links, these references are case-insensitive.
1867Like regular reference links, these references are case-insensitive.
3324
1868
3325Explicit link reference definitions always take priority over
1869Explicit link reference definitions always take priority over
3326−implicit heading references. So, in the following example, the
1870+implicit header references. So, in the following example, the
3327link will point to `bar`, not to `#foo`:
1871link will point to `bar`, not to `#foo`:
3328
1872
3329 # Foo
1873 # Foo
@@ -3332,11 +1876,12 @@ link will point to `bar`, not to `#foo`:
3332
1876
3333 See [foo]
1877 See [foo]
3334
1878
3335−## Block quotations
1879+Block quotations
1880+----------------
3336
1881
3337Markdown uses email conventions for quoting blocks of text.
1882Markdown uses email conventions for quoting blocks of text.
3338A block quotation is one or more paragraphs or other block elements
1883A block quotation is one or more paragraphs or other block elements
3339−(such as lists or headings), with each line preceded by a `>` character
1884+(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
1885and an optional space. (The `>` need not start at the left margin, but
3341it should not be indented more than three spaces.)
1886it should not be indented more than three spaces.)
3342
1887
@@ -3371,19 +1916,19 @@ block in a block quote, you need five spaces after the `>`:
3371
1916
3372#### Extension: `blank_before_blockquote` ####
1917#### Extension: `blank_before_blockquote` ####
3373
1918
3374−Standard Markdown syntax does not require a blank line before a
1919+Standard Markdown syntax does not require a blank line before a block
3375−block quote. Pandoc does require this (except, of course, at
1920+quote. Pandoc does require this (except, of course, at the beginning of the
3376−the beginning of the document). The reason for the requirement
1921+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,
1922+`>` 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
1923+wrapping). So, unless the `markdown_strict` format is used, the following does
3380not produce a nested block quote in pandoc:
1924not produce a nested block quote in pandoc:
3381
1925
3382 > This is a block quote.
1926 > This is a block quote.
3383 >> Nested.
1927 >> Nested.
3384
1928
3385
1929
3386−## Verbatim (code) blocks
1930+Verbatim (code) blocks
1931+----------------------
3387
1932
3388### Indented code blocks ###
1933### Indented code blocks ###
3389
1934
@@ -3445,16 +1990,14 @@ this syntax:
3445 qsort (filter (>= x) xs)
1990 qsort (filter (>= x) xs)
3446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1991 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3447
1992
3448−Here `mycode` is an identifier, `haskell` and `numberLines` are
1993+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and
3449−classes, and `startFrom` is an attribute with value `100`. Some
1994+`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
1995+information to do syntax highlighting. Currently, the only output formats
3452−information are HTML, LaTeX, Docx, Ms, and PowerPoint. If
1996+that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting
3453−highlighting is supported for your output format and language,
1997+is supported for your output format and language, then the code block above
3454−then the code block above will appear highlighted, with numbered
1998+will appear highlighted, with numbered lines. (To see which languages are
3455−lines. (To see which languages are supported, type `pandoc
3456−--list-highlight-languages`.) Otherwise, the code block above
1999+supported, type `pandoc --list-highlight-languages`.) Otherwise, the code
3457−will appear as follows:
2000+block above will appear as follows:
3458
2001
3459 <pre id="mycode" class="haskell numberLines" startFrom="100">
2002 <pre id="mycode" class="haskell numberLines" startFrom="100">
3460 <code>
2003 <code>
@@ -3462,12 +2005,6 @@ will appear as follows:
3462 </code>
2005 </code>
3463 </pre>
2006 </pre>
3464
2007
3465−The `numberLines` (or `number-lines`) class will cause the lines
3466−of the code block to be numbered, starting with `1` or the value
3467−of the `startFrom` attribute. The `lineAnchors` (or
3468−`line-anchors`) class will cause the lines to be clickable
3469−anchors in HTML output.
3470−
3471A shortcut form can also be used for specifying the language of
2008A shortcut form can also be used for specifying the language of
3472the code block:
2009the code block:
3473
2010
@@ -3491,7 +2028,8 @@ To set the highlighting style, use `--highlight-style`.
3491For more information on highlighting, see [Syntax highlighting],
2028For more information on highlighting, see [Syntax highlighting],
3492below.
2029below.
3493
2030
3494−## Line blocks
2031+Line blocks
2032+-----------
3495
2033
3496#### Extension: `line_blocks` ####
2034#### Extension: `line_blocks` ####
3497
2035
@@ -3517,12 +2055,10 @@ line must begin with a space.
3517 | 200 Main St.
2055 | 200 Main St.
3518 | Berkeley, CA 94718
2056 | Berkeley, CA 94718
3519
2057
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].
2058This syntax is borrowed from [reStructuredText].
3524
2059
3525−## Lists
2060+Lists
2061+-----
3526
2062
3527### Bullet lists ###
2063### Bullet lists ###
3528
2064
@@ -3692,12 +2228,6 @@ If default list markers are desired, use `#.`:
3692 #. two
2228 #. two
3693 #. three
2229 #. three
3694
2230
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
2231
3702### Definition lists ###
2232### Definition lists ###
3703
2233
@@ -3723,12 +2253,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
2253A definition begins with a colon or tilde, which may be indented one
3724or two spaces.
2254or two spaces.
3725
2255
3726−A term may have multiple definitions, and each definition may
2256+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,
2257+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
2258+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
2259+aside from the colon or tilde) should be indented four spaces. However,
3731−other Markdown lists, you can "lazily" omit indentation except
2260+as with other Markdown lists, you can "lazily" omit indentation except
3732at the beginning of a paragraph or other block element:
2261at the beginning of a paragraph or other block element:
3733
2262
3734 Term 1
2263 Term 1
@@ -3754,10 +2283,9 @@ definition:
3754Note that space between items in a definition list is required.
2283Note that space between items in a definition list is required.
3755(A variant that loosens this requirement, but disallows "lazy"
2284(A variant that loosens this requirement, but disallows "lazy"
3756hard wrapping, can be activated with `compact_definition_lists`: see
2285hard wrapping, can be activated with `compact_definition_lists`: see
3757−[Non-default extensions], below.)
2286+[Non-pandoc extensions], below.)
3758
2287
3759−[^3]: I have been influenced by the suggestions of [David
2288+[^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
2289
3762### Numbered example lists ###
2290### Numbered example lists ###
3763
2291
@@ -3786,12 +2314,30 @@ document:
3786The label can be any string of alphanumeric characters, underscores,
2314The label can be any string of alphanumeric characters, underscores,
3787or hyphens.
2315or hyphens.
3788
2316
3789−Note: continuation paragraphs in example lists must always
2317+
3790−be indented four spaces, regardless of the length of the
2318+### Compact and loose lists ###
3791−list marker. That is, example lists always behave as if the
2319+
3792−`four_space_rule` extension is set. This is because example
2320+Pandoc behaves differently from `Markdown.pl` on some "edge
3793−labels tend to be long, and indenting content to the
2321+cases" involving lists. Consider this source:
3794−first non-space character after the label would be awkward.
2322+
2323+ + First
2324+ + Second:
2325+ - Fee
2326+ - Fie
2327+ - Foe
2328+
2329+ + Third
2330+
2331+Pandoc transforms this into a "compact list" (with no `<p>` tags around
2332+"First", "Second", or "Third"), while Markdown puts `<p>` tags around
2333+"Second" and "Third" (but not "First"), because of the blank space
2334+around "Third". Pandoc follows a simple rule: if the text is followed by
2335+a blank line, it is treated as a paragraph. Since "Second" is followed
2336+by a list, and not a blank line, it isn't treated as a paragraph. The
2337+fact that the list is followed by a blank line is irrelevant. (Note:
2338+Pandoc works this way even when the `markdown_strict` format is specified. This
2339+behavior is consistent with the official Markdown syntax description,
2340+even though it is different from that of `Markdown.pl`.)
3795
2341
3796
2342
3797### Ending a list ###
2343### Ending a list ###
@@ -3831,7 +2377,8 @@ of one big list:
3831 2. dos
2377 2. dos
3832 3. tres
2378 3. tres
3833
2379
3834−## Horizontal rules
2380+Horizontal rules
2381+----------------
3835
2382
3836A line containing a row of three or more `*`, `-`, or `_` characters
2383A line containing a row of three or more `*`, `-`, or `_` characters
3837(optionally separated by spaces) produces a horizontal rule:
2384(optionally separated by spaces) produces a horizontal rule:
@@ -3841,7 +2388,8 @@ A line containing a row of three or more `*`, `-`, or `_` characters
3841 ---------------
2388 ---------------
3842
2389
3843
2390
3844−## Tables
2391+Tables
2392+------
3845
2393
3846Four kinds of tables may be used. The first three kinds presuppose the use of
2394Four 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
2395a fixed-width font, such as Courier. The fourth kind can be used with
@@ -3866,7 +2414,7 @@ Simple tables look like this:
3866
2414
3867 Table: Demonstration of simple table syntax.
2415 Table: Demonstration of simple table syntax.
3868
2416
3869−The header and table rows must each fit on one line. Column
2417+The headers and table rows must each fit on one line. Column
3870alignments are determined by the position of the header text relative
2418alignments are determined by the position of the header text relative
3871to the dashed line below it:[^4]
2419to the dashed line below it:[^4]
3872
2420
@@ -3885,7 +2433,7 @@ to the dashed line below it:[^4]
3885The table must end with a blank line, or a line of dashes followed by
2433The table must end with a blank line, or a line of dashes followed by
3886a blank line.
2434a blank line.
3887
2435
3888−The column header row may be omitted, provided a dashed line is used
2436+The column headers may be omitted, provided a dashed line is used
3889to end the table. For example:
2437to end the table. For example:
3890
2438
3891 ------- ------ ---------- -------
2439 ------- ------ ---------- -------
@@ -3894,13 +2442,13 @@ to end the table. For example:
3894 1 1 1 1
2442 1 1 1 1
3895 ------- ------ ---------- -------
2443 ------- ------ ---------- -------
3896
2444
3897−When the header row is omitted, column alignments are determined on the basis
2445+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
2446of the first line of the table body. So, in the tables above, the columns
3899would be right, left, center, and right aligned, respectively.
2447would be right, left, center, and right aligned, respectively.
3900
2448
3901#### Extension: `multiline_tables` ####
2449#### Extension: `multiline_tables` ####
3902
2450
3903−Multiline tables allow header and table rows to span multiple lines
2451+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
2452of text (but cells that span multiple columns or rows of the table are
3905not supported). Here is an example:
2453not supported). Here is an example:
3906
2454
@@ -3922,7 +2470,7 @@ not supported). Here is an example:
3922These work like simple tables, but with the following differences:
2470These work like simple tables, but with the following differences:
3923
2471
3924 - They must begin with a row of dashes, before the header text
2472 - They must begin with a row of dashes, before the header text
3925− (unless the header row is omitted).
2473+ (unless the headers are omitted).
3926 - They must end with a row of dashes, then a blank line.
2474 - They must end with a row of dashes, then a blank line.
3927 - The rows must be separated by blank lines.
2475 - The rows must be separated by blank lines.
3928
2476
@@ -3931,7 +2479,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
2479the output. So, if you find that one of the columns is too narrow in the
3932output, try widening it in the Markdown source.
2480output, try widening it in the Markdown source.
3933
2481
3934−The header may be omitted in multiline tables as well as simple tables:
2482+Headers may be omitted in multiline tables as well as simple tables:
3935
2483
3936 ----------- ------- --------------- -------------------------
2484 ----------- ------- --------------- -------------------------
3937 First row 12.0 Example of a row that
2485 First row 12.0 Example of a row that
@@ -3942,7 +2490,7 @@ The header may be omitted in multiline tables as well as simple tables:
3942 rows.
2490 rows.
3943 ----------- ------- --------------- -------------------------
2491 ----------- ------- --------------- -------------------------
3944
2492
3945− : Here's a multiline table without a header.
2493+ : Here's a multiline table without headers.
3946
2494
3947It is possible for a multiline table to have just one row, but the row
2495It 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
2496should be followed by a blank line (and then the row of dashes that ends
@@ -3968,8 +2516,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
2516omitted for a headerless table. The cells of grid tables may contain
3969arbitrary block elements (multiple paragraphs, code blocks, lists,
2517arbitrary block elements (multiple paragraphs, code blocks, lists,
3970etc.). Cells that span multiple columns or rows are not
2518etc.). Cells that span multiple columns or rows are not
3971−supported. Grid tables can be created easily using Emacs' table-mode
2519+supported. Grid tables can be created easily using [Emacs table mode].
3972−(`M-x table-insert`).
2520+
2521+[Emacs table mode]: http://table.sourceforge.net/
3973
2522
3974Alignments can be specified as with pipe tables, by putting
2523Alignments can be specified as with pipe tables, by putting
3975colons at the boundaries of the separator line after the
2524colons at the boundaries of the separator line after the
@@ -3997,7 +2546,7 @@ and the same number of rows in each column. For example, the
3997Docutils [sample grid tables] will not render as expected with
2546Docutils [sample grid tables] will not render as expected with
3998Pandoc.
2547Pandoc.
3999
2548
4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables
2549+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables
4001
2550
4002
2551
4003#### Extension: `pipe_tables` ####
2552#### Extension: `pipe_tables` ####
@@ -4030,15 +2579,10 @@ legal (though ugly) pipe table:
4030
2579
4031The cells of pipe tables cannot contain block elements like paragraphs
2580The cells of pipe tables cannot contain block elements like paragraphs
4032and lists, and cannot span multiple lines. If a pipe table contains a
2581and lists, and cannot span multiple lines. If a pipe table contains a
4033−row whose Markdown content is wider than the column width (see
2582+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
2583+`--columns`), then the cell contents will wrap, with the
4036−by the number of dashes in the line separating the table header from
2584+relative cell widths determined by the widths of the separator
4037−the table body. (For example `---|-` would make the first column 3/4
2585+lines.
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
4040−cell contents will not be wrapped, and the cells will be sized
4041−to their contents.
4042
2586
4043Note: pandoc also recognizes pipe tables of the following
2587Note: pandoc also recognizes pipe tables of the following
4044form, as can be produced by Emacs' orgtbl-mode:
2588form, as can be produced by Emacs' orgtbl-mode:
@@ -4054,7 +2598,8 @@ you'll need to add colons as above.
4054
2598
4055[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
2599[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table
4056
2600
4057−## Metadata blocks
2601+Metadata blocks
2602+---------------
4058
2603
4059#### Extension: `pandoc_title_block` ####
2604#### Extension: `pandoc_title_block` ####
4060
2605
@@ -4070,42 +2615,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
2615or 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:
2616title, or a title and a date but no author, you need a blank line:
4072
2617
4073−```
4074−%
2618+ %
4075−% Author
2619+ % Author
4076−```
4077
2620
4078−```
4079−% My title
2621+ % My title
4080−%
2622+ %
4081−% June 15, 2006
2623+ % June 15, 2006
4082−```
4083
2624
4084The title may occupy multiple lines, but continuation lines must
2625The title may occupy multiple lines, but continuation lines must
4085begin with leading space, thus:
2626begin with leading space, thus:
4086
2627
4087−```
4088−% My title
2628+ % My title
4089− on multiple lines
2629+ on multiple lines
4090−```
4091
2630
4092If a document has multiple authors, the authors may be put on
2631If a document has multiple authors, the authors may be put on
4093separate lines with leading space, or separated by semicolons, or
2632separate lines with leading space, or separated by semicolons, or
4094both. So, all of the following are equivalent:
2633both. So, all of the following are equivalent:
4095
2634
4096−```
4097−% Author One
2635+ % Author One
4098− Author Two
2636+ Author Two
4099−```
4100
2637
4101−```
4102−% Author One; Author Two
2638+ % Author One; Author Two
4103−```
4104
2639
4105−```
4106−% Author One;
2640+ % Author One;
4107− Author Two
2641+ Author Two
4108−```
4109
2642
4110The date must fit on one line.
2643The date must fit on one line.
4111
2644
@@ -4146,7 +2679,7 @@ will also have "Version 4.0" in the header.
4146
2679
4147#### Extension: `yaml_metadata_block` ####
2680#### Extension: `yaml_metadata_block` ####
4148
2681
4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three
2682+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
2683hyphens (`---`) 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
2684(`...`) 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
2685document, but if it is not at the beginning, it must be preceded by a blank
@@ -4157,53 +2690,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
2690 pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
4158
2691
4159Just be sure that the YAML file begins with `---` and ends with `---` or
2692Just be sure that the YAML file begins with `---` and ends with `---` or
4160−`...`.) Alternatively, you can use the `--metadata-file` option. Using
2693+`...`.)
4161−that approach however, you cannot reference content (like footnotes)
4162−from the main markdown input document.
4163
2694
4164Metadata will be taken from the fields of the YAML object and added to any
2695Metadata will be taken from the fields of the YAML object and added to any
4165existing document metadata. Metadata can contain lists and objects (nested
2696existing document metadata. Metadata can contain lists and objects (nested
4166arbitrarily), but all string scalars will be interpreted as Markdown. Fields
2697arbitrarily), but all string scalars will be interpreted as Markdown. Fields
4167with names ending in an underscore will be ignored by pandoc. (They may be
2698with 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
2699+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
2700
4172−A document may contain multiple metadata blocks. If two
2701+A document may contain multiple metadata blocks. The metadata fields will
2702+be combined through a *left-biased union*: if two metadata blocks attempt
4173−metadata blocks attempt to set the same field, the value from
2703+to set the same field, the value from the first block will be taken.
4174−the second block will be taken.
4175
2704
4176When pandoc is used with `-t markdown` to create a Markdown document,
2705When pandoc is used with `-t markdown` to create a Markdown document,
4177a YAML metadata block will be produced only if the `-s/--standalone`
2706a YAML metadata block will be produced only if the `-s/--standalone`
4178option is used. All of the metadata will appear in a single block
2707option is used. All of the metadata will appear in a single block
4179at the beginning of the document.
2708at the beginning of the document.
4180
2709
4181−Note that [YAML] escaping rules must be followed. Thus, for example,
2710+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
2711+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
2712+(`|`) can be used to begin an indented block that will be interpreted
4186−escaping. This form is necessary when the field contains blank lines
2713+literally, without need for escaping. This form is necessary
4187−or block-level formatting:
2714+when the field contains blank lines or block-level formatting:
4188
2715
4189 ---
2716 ---
4190 title: 'This is the title: it contains a colon'
2717 title: 'This is the title: it contains a colon'
4191 author:
2718 author:
4192 - Author One
2719 - Author One
4193 - Author Two
2720 - Author Two
4194− keywords: [nothing, nothingness]
2721+ tags: [nothing, nothingness]
4195 abstract: |
2722 abstract: |
4196 This is the abstract.
2723 This is the abstract.
4197
2724
4198 It consists of two paragraphs.
2725 It consists of two paragraphs.
4199 ...
2726 ...
4200
2727
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
2728Template variables will be set automatically from the metadata. Thus, for
4208example, in writing HTML, the variable `abstract` will be set to the HTML
2729example, in writing HTML, the variable `abstract` will be set to the HTML
4209equivalent of the Markdown in the `abstract` field:
2730equivalent of the Markdown in the `abstract` field:
@@ -4237,38 +2758,9 @@ template:
4237 $endif$
2758 $endif$
4238 $endfor$
2759 $endfor$
4239
2760
4240−Raw content to include in the document's header may be specified
4241−using `header-includes`; however, it is important to mark up
4242−this content as raw code for a particular output format, using
4243−the [`raw_attribute` extension](#extension-raw_attribute)), or it
4244−will be interpreted as markdown. For example:
4245−
4246− header-includes:
4247− - |
4248− ```{=latex}
4249− \let\oldsection\section
4250− \renewcommand{\section}[1]{\clearpage\oldsection{#1}}
4251− ```
4252−
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
2761
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
2762+Backslash escapes
2763+-----------------
4272
2764
4273#### Extension: `all_symbols_escapable` ####
2765#### Extension: `all_symbols_escapable` ####
4274
2766
@@ -4294,12 +2786,9 @@ which allows only the following characters to be backslash-escaped:
4294(However, if the `markdown_strict` format is used, the standard Markdown rule
2786(However, if the `markdown_strict` format is used, the standard Markdown rule
4295will be used.)
2787will be used.)
4296
2788
4297−A backslash-escaped space is parsed as a nonbreaking space. In TeX output,
2789+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
2790+appear in TeX output as `~` and in HTML and XML as `\&#160;` or
4299−literal unicode nonbreaking space character (note that it will thus
2791+`\&nbsp;`.
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
2792
4304A backslash-escaped newline (i.e. a backslash occurring at the end of
2793A 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
2794a line) is parsed as a hard line break. It will appear in TeX output as
@@ -4309,7 +2798,8 @@ two trailing spaces on a line.
4309
2798
4310Backslash escapes do not work in verbatim contexts.
2799Backslash escapes do not work in verbatim contexts.
4311
2800
4312−## Inline formatting
2801+Inline formatting
2802+-----------------
4313
2803
4314### Emphasis ###
2804### Emphasis ###
4315
2805
@@ -4357,13 +2847,12 @@ text by `~` characters. Thus, for example,
4357
2847
4358 H~2~O is a liquid. 2^10^ is 1024.
2848 H~2~O is a liquid. 2^10^ is 1024.
4359
2849
4360−The text between `^...^` or `~...~` may not contain spaces or
4361−newlines. If the superscripted or subscripted text contains
2850+If the superscripted or subscripted text contains spaces, these spaces
4362−spaces, these spaces must be escaped with backslashes. (This is
2851+must be escaped with backslashes. (This is to prevent accidental
4363−to prevent accidental superscripting and subscripting through
2852+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
2853+Thus, if you want the letter P with 'a cat' in subscripts, use
4366−subscripts, use `P~a\ cat~`, not `P~a cat~`.
2854+`P~a\ cat~`, not `P~a cat~`.
2855+
4367
2856
4368### Verbatim ###
2857### Verbatim ###
4369
2858
@@ -4397,22 +2886,19 @@ Attributes can be attached to verbatim text, just as with
4397
2886
4398### Small caps ###
2887### Small caps ###
4399
2888
4400−To write small caps, use the `smallcaps` class:
2889+To write small caps, you can use an HTML span tag:
4401−
4402− [Small caps]{.smallcaps}
4403−
4404−Or, without the `bracketed_spans` extension:
4405−
4406− <span class="smallcaps">Small caps</span>
4407−
4408−For compatibility with other Markdown flavors, CSS is also supported:
4409
2890
4410 <span style="font-variant:small-caps;">Small caps</span>
2891 <span style="font-variant:small-caps;">Small caps</span>
4411
2892
2893+(The semicolon is optional and there may be space after the
4412−This will work in all output formats that support small caps.
2894+colon.) This will work in all output formats that support small caps.
4413
2895
2896+Alternatively, you can also use the new `bracketed_spans` syntax:
4414
2897
2898+ [Small caps]{style="font-variant:small-caps;"}
2899+
4415−## Math
2900+Math
2901+----
4416
2902
4417#### Extension: `tex_math_dollars` ####
2903#### Extension: `tex_math_dollars` ####
4418
2904
@@ -4424,38 +2910,22 @@ left, and must not be followed immediately by a digit. Thus,
4424you need to enclose text in literal `$` characters, backslash-escape
2910you need to enclose text in literal `$` characters, backslash-escape
4425them and they won't be treated as math delimiters.
2911them and they won't be treated as math delimiters.
4426
2912
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
2913TeX math will be printed in all output formats. How it is rendered
4432depends on the output format:
2914depends on the output format:
4433
2915
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
2916+Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki
4439− ~ It will appear verbatim surrounded by `$...$` (for inline
2917+ ~ 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
2918
4445reStructuredText
2919reStructuredText
4446 ~ It will be rendered using an [interpreted text role `:math:`].
2920 ~ It will be rendered using an [interpreted text role `:math:`].
4447
2921
4448AsciiDoc
2922AsciiDoc
4449− ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim
2923+ ~ 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
2924
4455Texinfo
2925Texinfo
4456 ~ It will be rendered inside a `@math` command.
2926 ~ It will be rendered inside a `@math` command.
4457
2927
4458−roff man, Jira markup
2928+groff man
4459 ~ It will be rendered verbatim without `$`'s.
2929 ~ It will be rendered verbatim without `$`'s.
4460
2930
4461MediaWiki, DokuWiki
2931MediaWiki, DokuWiki
@@ -4486,12 +2956,58 @@ FictionBook2
4486
2956
4487HTML, Slidy, DZSlides, S5, EPUB
2957HTML, Slidy, DZSlides, S5, EPUB
4488 ~ The way math is rendered in HTML will depend on the
2958 ~ The way math is rendered in HTML will depend on the
4489− command-line options selected. Therefore see [Math rendering in HTML]
2959+ command-line options selected:
4490− above.
2960+
4491−
2961+ 1. The default is to render TeX math as far as possible using Unicode
2962+ characters, as with RTF, DocBook, and OpenDocument output. Formulas
2963+ are put inside a `span` with `class="math"`, so that they may be
2964+ styled differently from the surrounding text if needed.
2965+
2966+ 2. If the `--latexmathml` option is used, TeX math will be displayed
2967+ between `$` or `$$` characters and put in `<span>` tags with class `LaTeX`.
2968+ The [LaTeXMathML] script will be used to render it as formulas.
2969+ (This trick does not work in all browsers, but it works in Firefox.
2970+ In browsers that do not support LaTeXMathML, TeX math will appear
2971+ verbatim between `$` characters.)
2972+
2973+ 3. If the `--jsmath` option is used, TeX math will be put inside
2974+ `<span>` tags (for inline math) or `<div>` tags (for display math)
2975+ with class `math`. The [jsMath] script will be used to render
2976+ it.
2977+
2978+ 4. If the `--mimetex` option is used, the [mimeTeX] CGI script will
2979+ be called to generate images for each TeX formula. This should
2980+ work in all browsers. The `--mimetex` option takes an optional URL
2981+ as argument. If no URL is specified, it will be assumed that the
2982+ mimeTeX CGI script is at `/cgi-bin/mimetex.cgi`.
2983+
2984+ 5. If the `--gladtex` option is used, TeX formulas will be enclosed
2985+ in `<eq>` tags in the HTML output. The resulting `htex` file may then
2986+ be processed by [gladTeX], which will produce image files for each
2987+ formula and an HTML file with links to these images. So, the
2988+ procedure is:
2989+
2990+ pandoc -s --gladtex myfile.txt -o myfile.htex
2991+ gladtex -d myfile-images myfile.htex
2992+ # produces myfile.html and images in myfile-images
2993+
2994+ 6. If the `--webtex` option is used, TeX formulas will be converted
2995+ to `<img>` tags that link to an external script that converts
2996+ formulas to images. The formula will be URL-encoded and concatenated
2997+ with the URL provided. For SVG images you can for example use
2998+ `--webtex https://latex.codecogs.com/svg.latex?`.
2999+ If no URL is specified, the CodeCogs URL generating PNGs
3000+ will be used (`https://latex.codecogs.com/png.latex?`).
3001+
3002+ 7. If the `--mathjax` option is used, TeX math will be displayed
3003+ between `\(...\)` (for inline math) or `\[...\]` (for display
3004+ math) and put in `<span>` tags with class `math`.
3005+ The [MathJax] script will be used to render it as formulas.
3006+
4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math
3007+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math
4493−
3008+
4494−## Raw HTML
3009+Raw HTML
3010+--------
4495
3011
4496#### Extension: `raw_html` ####
3012#### Extension: `raw_html` ####
4497
3013
@@ -4502,17 +3018,8 @@ Markdown allows it, but it has been made an extension so that it can
4502be disabled if desired.)
3018be disabled if desired.)
4503
3019
4504The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
3020The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,
4505−DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile
3021+DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed
4506−output, and suppressed in other formats.
3022+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
3023
4517#### Extension: `markdown_in_html_blocks` ####
3024#### Extension: `markdown_in_html_blocks` ####
4518
3025
@@ -4529,7 +3036,7 @@ Thus, for example, pandoc will turn
4529 <table>
3036 <table>
4530 <tr>
3037 <tr>
4531 <td>*one*</td>
3038 <td>*one*</td>
4532− <td>[a link](https://google.com)</td>
3039+ <td>[a link](http://google.com)</td>
4533 </tr>
3040 </tr>
4534 </table>
3041 </table>
4535
3042
@@ -4538,14 +3045,14 @@ into
4538 <table>
3045 <table>
4539 <tr>
3046 <tr>
4540 <td><em>one</em></td>
3047 <td><em>one</em></td>
4541− <td><a href="https://google.com">a link</a></td>
3048+ <td><a href="http://google.com">a link</a></td>
4542 </tr>
3049 </tr>
4543 </table>
3050 </table>
4544
3051
4545whereas `Markdown.pl` will preserve it as is.
3052whereas `Markdown.pl` will preserve it as is.
4546
3053
4547−There is one exception to this rule: text between `<script>`,
3054+There is one exception to this rule: text between `<script>` and
4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.
3055+`<style>` tags is not interpreted as Markdown.
4549
3056
4550This departure from standard Markdown should make it easier to mix
3057This departure from standard Markdown should make it easier to mix
4551Markdown with HTML block elements. For example, one can surround
3058Markdown with HTML block elements. For example, one can surround
@@ -4587,10 +3094,6 @@ Note that in LaTeX environments, like
4587the material between the begin and end tags will be interpreted as raw
3094the material between the begin and end tags will be interpreted as raw
4588LaTeX, not as Markdown.
3095LaTeX, not as Markdown.
4589
3096
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,
3097Inline LaTeX is ignored in output formats other than Markdown, LaTeX,
4595Emacs Org mode, and ConTeXt.
3098Emacs Org mode, and ConTeXt.
4596
3099
@@ -4601,7 +3104,7 @@ Emacs Org mode, and ConTeXt.
4601Inline spans and fenced code blocks with a special
3104Inline spans and fenced code blocks with a special
4602kind of attribute will be parsed as raw content with the
3105kind of attribute will be parsed as raw content with the
4603designated format. For example, the following produces a raw
3106designated format. For example, the following produces a raw
4604−roff `ms` block:
3107+groff `ms` block:
4605
3108
4606 ```{=ms}
3109 ```{=ms}
4607 .MYMACRO
3110 .MYMACRO
@@ -4611,24 +3114,9 @@ And the following produces a raw `html` inline element:
4611
3114
4612 This is `<a>html</a>`{=html}
3115 This is `<a>html</a>`{=html}
4613
3116
4614−This can be useful to insert raw xml into `docx` documents, e.g.
4615−a pagebreak:
4616−
4617− ```{=openxml}
4618− <w:p>
4619− <w:r>
4620− <w:br w:type="page"/>
4621− </w:r>
4622− </w:p>
4623− ```
4624−
4625The format name should match the target format name (see
3117The format name should match the target format name (see
4626`-t/--to`, above, for a list, or use `pandoc
3118`-t/--to`, above, for a list, or use `pandoc
4627−--list-output-formats`). Use `openxml` for `docx` output,
3119+--list-output-formats`).
4628−`opendocument` for `odt` output, `html5` for `epub3` output,
4629−`html4` for `epub2` output, and `latex`, `beamer`,
4630−`ms`, or `html5` for `pdf` output (depending on what you
4631−use for `--pdf-engine`).
4632
3120
4633This extension presupposes that the relevant kind of
3121This extension presupposes that the relevant kind of
4634inline code or fenced code block is enabled. Thus, for
3122inline code or fenced code block is enabled. Thus, for
@@ -4637,34 +3125,26 @@ example, to use a raw attribute with a backtick code block,
4637
3125
4638The raw attribute cannot be combined with regular attributes.
3126The raw attribute cannot be combined with regular attributes.
4639
3127
4640−## LaTeX macros
3128+LaTeX macros
3129+------------
4641
3130
4642#### Extension: `latex_macros` ####
3131#### Extension: `latex_macros` ####
4643
3132
4644−When this extension is enabled, pandoc will parse LaTeX
3133+For output formats other than LaTeX, pandoc will parse LaTeX `\newcommand` and
4645−macro definitions and apply the resulting macros to all LaTeX
3134+`\renewcommand` definitions and apply the resulting macros to all LaTeX
4646−math and raw LaTeX. So, for example, the following will work in
3135+math. So, for example, the following will work in all output formats,
4647−all output formats, not just LaTeX:
3136+not just LaTeX:
4648
3137
4649 \newcommand{\tuple}[1]{\langle #1 \rangle}
3138 \newcommand{\tuple}[1]{\langle #1 \rangle}
4650
3139
4651 $\tuple{a, b, c}$
3140 $\tuple{a, b, c}$
4652
3141
4653−Note that LaTeX macros will not be applied if they occur
3142+In LaTeX output, the `\newcommand` definition will simply be passed
4654−inside a raw span or block marked with the
3143+unchanged to the output.
4655−[`raw_attribute` extension](#extension-raw_attribute).
4656
3144
4657−When `latex_macros` is disabled, the raw LaTeX and math will
4658−not have macros applied. This is usually a better approach when
4659−you are targeting LaTeX or PDF.
4660
3145
4661−Macro definitions in LaTeX will be passed through as raw LaTeX
4662−only if `latex_macros` is not enabled. Macro definitions in
4663−Markdown source (or other formats allowing `raw_tex`) will
4664−be passed through regardless of whether `latex_macros` is
4665−enabled.
4666−
4667−## Links
3146+Links
3147+-----
4668
3148
4669Markdown allows links to be specified in several ways.
3149Markdown allows links to be specified in several ways.
4670
3150
@@ -4673,7 +3153,7 @@ Markdown allows links to be specified in several ways.
4673If you enclose a URL or email address in pointy brackets, it
3153If you enclose a URL or email address in pointy brackets, it
4674will become a link:
3154will become a link:
4675
3155
4676− <https://google.com>
3156+ <http://google.com>
4677 <sam@green.eggs.ham>
3157 <sam@green.eggs.ham>
4678
3158
4679### Inline links ###
3159### Inline links ###
@@ -4683,7 +3163,7 @@ followed by the URL in parentheses. (Optionally, the URL can
4683be followed by a link title, in quotes.)
3163be followed by a link title, in quotes.)
4684
3164
4685 This is an [inline link](/url), and here's [one with
3165 This is an [inline link](/url), and here's [one with
4686− a title](https://fsf.org "click here for a good time!").
3166+ a title](http://fsf.org "click here for a good time!").
4687
3167
4688There can be no space between the bracketed part and the parenthesized part.
3168There 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.
3169The link text can contain formatting (such as emphasis), but the title cannot.
@@ -4712,7 +3192,7 @@ Here are some examples:
4712
3192
4713 [my label 1]: /foo/bar.html "My title, optional"
3193 [my label 1]: /foo/bar.html "My title, optional"
4714 [my label 2]: /foo
3194 [my label 2]: /foo
4715− [my label 3]: https://fsf.org (The free software foundation)
3195+ [my label 3]: http://fsf.org (The free software foundation)
4716 [my label 4]: /bar#special 'A title in single quotes'
3196 [my label 4]: /bar#special 'A title in single quotes'
4717
3197
4718The URL may optionally be surrounded by angle brackets:
3198The URL may optionally be surrounded by angle brackets:
@@ -4721,7 +3201,7 @@ The URL may optionally be surrounded by angle brackets:
4721
3201
4722The title may go on the next line:
3202The title may go on the next line:
4723
3203
4724− [my label 3]: https://fsf.org
3204+ [my label 3]: http://fsf.org
4725 "The free software foundation"
3205 "The free software foundation"
4726
3206
4727Note that link labels are not case sensitive. So, this will work:
3207Note that link labels are not case sensitive. So, this will work:
@@ -4731,626 +3211,247 @@ Note that link labels are not case sensitive. So, this will work:
4731 [Foo]: /bar/baz
3211 [Foo]: /bar/baz
4732
3212
4733In an *implicit* reference link, the second pair of brackets is
3213In an *implicit* reference link, the second pair of brackets is
4734−empty:
3214+empty:
4735−
4736− See [my website][].
4737−
4738− [my website]: http://foo.bar.baz
4739−
4740−Note: In `Markdown.pl` and most other Markdown implementations,
4741−reference link definitions cannot occur in nested constructions
4742−such as list items or block quotes. Pandoc lifts this arbitrary
4743−seeming restriction. So the following is fine in pandoc, though
4744−not in most other implementations:
4745−
4746− > My block [quote].
4747− >
4748− > [quote]: /foo
4749−
4750−#### Extension: `shortcut_reference_links` ####
4751−
4752−In a *shortcut* reference link, the second pair of brackets may
4753−be omitted entirely:
4754−
4755− See [my website].
4756−
4757− [my website]: http://foo.bar.baz
4758−
4759−### Internal links ###
4760−
4761−To link to another section of the same document, use the automatically
4762−generated identifier (see [Heading identifiers]). For example:
4763−
4764− See the [Introduction](#introduction).
4765−
4766−or
4767−
4768− See the [Introduction].
4769−
4770− [Introduction]: #introduction
4771−
4772−Internal links are currently supported for HTML formats (including
4773−HTML slide shows and EPUB), LaTeX, and ConTeXt.
4774−
4775−## Images
4776−
4777−A link immediately preceded by a `!` will be treated as an image.
4778−The link text will be used as the image's alt text:
4779−
4780− ![la lune](lalune.jpg "Voyage to the moon")
4781−
4782− ![movie reel]
4783−
4784− [movie reel]: movie.gif
4785−
4786−#### Extension: `implicit_figures` ####
4787−
4788−An image with nonempty alt text, occurring by itself in a
4789−paragraph, will be rendered as a figure with a caption. The
4790−image's alt text will be used as the caption.
4791−
4792− ![This is the caption](/url/of/image.png)
4793−
4794−How this is rendered depends on the output format. Some output
4795−formats (e.g. RTF) do not yet support figures. In those
4796−formats, you'll just get an image in a paragraph by itself, with
4797−no caption.
4798−
4799−If you just want a regular inline image, just make sure it is not
4800−the only thing in the paragraph. One way to do this is to insert a
4801−nonbreaking space after the image:
4802−
4803− ![This image won't be a figure](/url/of/image.png)\
4804−
4805−Note that in reveal.js slide shows, an image in a paragraph
4806−by itself that has the `stretch` class will fill the screen,
4807−and the caption and figure tags will be omitted.
4808−
4809−#### Extension: `link_attributes` ####
4810−
4811−Attributes can be set on links and images:
4812−
4813− An inline ![image](foo.jpg){#id .class width=30 height=20px}
4814− and a reference ![image][ref] with attributes.
4815−
4816− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
4817−
4818−(This syntax is compatible with [PHP Markdown Extra] when only `#id`
4819−and `.class` are used.)
4820−
4821−For HTML and EPUB, all known HTML5 attributes except `width` and
4822−`height` (but including `srcset` and `sizes`) are passed through
4823−as is. Unknown attributes are passed through as custom
4824−attributes, with `data-` prepended. The other writers ignore
4825−attributes that are not specifically supported by their output format.
4826−
4827−The `width` and `height` attributes on images are treated specially. When
4828−used without a unit, the unit is assumed to be pixels. However, any of
4829−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
4830−and `%`. There must not be any spaces between the number and the unit.
4831−For example:
4832−
4833−```
4834−![](file.jpg){ width=50% }
4835−```
4836−
4837−- Dimensions may be converted to a form that is compatible with
4838− the output format (for example, dimensions given in pixels will
4839− be converted to inches when converting HTML to LaTeX). Conversion
4840− between pixels and physical measurements is affected by the
4841− `--dpi` option (by default, 96 dpi is assumed, unless the image
4842− itself contains dpi information).
4843−- The `%` unit is generally relative to some available space.
4844− For example the above example will render to the following.
4845− - HTML: `<img href="file.jpg" style="width: 50%;" />`
4846− - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`
4847− (If you're using a custom template, you need to configure `graphicx`
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
4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
4852− or a unique identifier (LaTeX `\caption`), or both (HTML).
4853−- When no `width` or `height` attributes are specified, the fallback
4854− is to look at the image resolution and the dpi metadata embedded in
4855− the image file.
4856−
4857−## Divs and Spans
4858−
4859−Using the `native_divs` and `native_spans` extensions
4860−(see [above][Extension: `native_divs`]), HTML syntax can
4861−be used as part of markdown to create native `Div` and `Span`
4862−elements in the pandoc AST (as opposed to raw HTML).
4863−However, there is also nicer syntax available:
4864−
4865−#### Extension: `fenced_divs` ####
4866−
4867−Allow special fenced syntax for native `Div` blocks. A Div
4868−starts with a fence containing at least three consecutive
4869−colons plus some attributes. The attributes may optionally
4870−be followed by another string of consecutive colons.
4871−The attribute syntax is exactly as in fenced code blocks (see
4872−[Extension: `fenced_code_attributes`]). As with fenced
4873−code blocks, one can use either attributes in curly braces
4874−or a single unbraced word, which will be treated as a class
4875−name. The Div ends with another line containing a string of at
4876−least three consecutive colons. The fenced Div should be
4877−separated by blank lines from preceding and following blocks.
4878−
4879−Example:
4880−
4881− ::::: {#special .sidebar}
4882− Here is a paragraph.
4883−
4884− And another.
4885− :::::
4886−
4887−Fenced divs can be nested. Opening fences are distinguished
4888−because they *must* have attributes:
4889−
4890− ::: Warning ::::::
4891− This is a warning.
4892−
4893− ::: Danger
4894− This is a warning within a warning.
4895− :::
4896− ::::::::::::::::::
4897−
4898−Fences without attributes are always closing fences. Unlike
4899−with fenced code blocks, the number of colons in the closing
4900−fence need not match the number in the opening fence. However,
4901−it can be helpful for visual clarity to use fences of different
4902−lengths to distinguish nested divs from their parents.
4903−
4904−
4905−#### Extension: `bracketed_spans` ####
4906−
4907−A bracketed sequence of inlines, as one would use to begin
4908−a link, will be treated as a `Span` with attributes if it is
4909−followed immediately by attributes:
4910−
4911− [This is *some text*]{.class key="val"}
4912−
4913−## Footnotes
4914−
4915−#### Extension: `footnotes` ####
4916−
4917−Pandoc's Markdown allows footnotes, using the following syntax:
4918−
4919− Here is a footnote reference,[^1] and another.[^longnote]
4920−
4921− [^1]: Here is the footnote.
4922−
4923− [^longnote]: Here's one with multiple blocks.
4924−
4925− Subsequent paragraphs are indented to show that they
4926− belong to the previous footnote.
4927−
4928− { some.code }
4929−
4930− The whole paragraph can be indented, or just the first
4931− line. In this way, multi-paragraph footnotes work like
4932− multi-paragraph list items.
4933−
4934− This paragraph won't be part of the note, because it
4935− isn't indented.
4936−
4937−The identifiers in footnote references may not contain spaces, tabs,
4938−or newlines. These identifiers are used only to correlate the
4939−footnote reference with the note itself; in the output, footnotes
4940−will be numbered sequentially.
4941−
4942−The footnotes themselves need not be placed at the end of the
4943−document. They may appear anywhere except inside other block elements
4944−(lists, block quotes, tables, etc.). Each footnote should be
4945−separated from surrounding content (including other footnotes)
4946−by blank lines.
4947−
4948−#### Extension: `inline_notes` ####
4949−
4950−Inline footnotes are also allowed (though, unlike regular notes,
4951−they cannot contain multiple paragraphs). The syntax is as follows:
4952−
4953− Here is an inline note.^[Inlines notes are easier to write, since
4954− you don't have to pick an identifier and move down to type the
4955− note.]
4956−
4957−Inline and regular footnotes may be mixed freely.
4958−
4959−## Citation syntax
4960−
4961−#### Extension: `citations` ####
4962−
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
3215
5129−#### Extension: `old_dashes` ####
3216+ See [my website][].
5130
3217
5131−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
3218+ [my website]: http://foo.bar.baz
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
3219
5136−#### Extension: `angle_brackets_escapable` ####
3220+Note: In `Markdown.pl` and most other Markdown implementations,
3221+reference link definitions cannot occur in nested constructions
3222+such as list items or block quotes. Pandoc lifts this arbitrary
3223+seeming restriction. So the following is fine in pandoc, though
3224+not in most other implementations:
5137
3225
5138−Allow `<` and `>` to be backslash-escaped, as they can be in
3226+ > My block [quote].
5139−GitHub flavored Markdown but not original Markdown. This is
3227+ >
5140−implied by pandoc's default `all_symbols_escapable`.
3228+ > [quote]: /foo
5141
3229
5142−#### Extension: `lists_without_preceding_blankline` ####
3230+#### Extension: `shortcut_reference_links` ####
5143
3231
5144−Allow a list to occur right after a paragraph, with no intervening
3232+In a *shortcut* reference link, the second pair of brackets may
5145−blank space.
3233+be omitted entirely:
5146
3234
5147−#### Extension: `four_space_rule` ####
3235+ See [my website].
5148
3236
5149−Selects the pandoc <= 2.0 behavior for parsing lists, so that
3237+ [my website]: http://foo.bar.baz
5150−four spaces indent are needed for list item continuation
5151−paragraphs.
5152
3238
5153−#### Extension: `spaced_reference_links` ####
3239+### Internal links ###
5154
3240
5155−Allow whitespace between the two components of a reference link,
3241+To link to another section of the same document, use the automatically
5156−for example,
3242+generated identifier (see [Header identifiers]). For example:
5157
3243
5158− [foo] [bar].
3244+ See the [Introduction](#introduction).
5159
3245
5160−#### Extension: `hard_line_breaks` ####
3246+or
5161
3247
5162−Causes all newlines within a paragraph to be interpreted as hard line
3248+ See the [Introduction].
5163−breaks instead of spaces.
5164
3249
5165−#### Extension: `ignore_line_breaks` ####
3250+ [Introduction]: #introduction
5166
3251
5167−Causes newlines within a paragraph to be ignored, rather than being
3252+Internal links are currently supported for HTML formats (including
5168−treated as spaces or as hard line breaks. This option is intended for
3253+HTML slide shows and EPUB), LaTeX, and ConTeXt.
5169−use with East Asian languages where spaces are not used between words,
5170−but text is divided into lines for readability.
5171
3254
5172−#### Extension: `east_asian_line_breaks` ####
3255+Images
3256+------
5173
3257
5174−Causes newlines within a paragraph to be ignored, rather than
3258+A link immediately preceded by a `!` will be treated as an image.
5175−being treated as spaces or as hard line breaks, when they occur
3259+The link text will be used as the image's alt text:
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
3260
5180−#### Extension: `emoji` ####
3261+ ![la lune](lalune.jpg "Voyage to the moon")
5181
3262
5182−Parses textual emojis like `:smile:` as Unicode emoticons.
3263+ ![movie reel]
5183
3264
5184−#### Extension: `tex_math_single_backslash` ####
3265+ [movie reel]: movie.gif
5185
3266
5186−Causes anything between `\(` and `\)` to be interpreted as inline
3267+#### Extension: `implicit_figures` ####
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
3268
5191−#### Extension: `tex_math_double_backslash` ####
3269+An image with nonempty alt text, occurring by itself in a
3270+paragraph, will be rendered as a figure with a caption. The
3271+image's alt text will be used as the caption.
5192
3272
5193−Causes anything between `\\(` and `\\)` to be interpreted as inline
3273+ ![This is the caption](/url/of/image.png)
5194−TeX math, and anything between `\\[` and `\\]` to be interpreted
5195−as display TeX math.
5196
3274
5197−#### Extension: `markdown_attribute` ####
3275+How this is rendered depends on the output format. Some output
3276+formats (e.g. RTF) do not yet support figures. In those
3277+formats, you'll just get an image in a paragraph by itself, with
3278+no caption.
5198
3279
5199−By default, pandoc interprets material inside block-level tags as Markdown.
3280+If you just want a regular inline image, just make sure it is not
5200−This extension changes the behavior so that Markdown is only parsed
3281+the only thing in the paragraph. One way to do this is to insert a
5201−inside block-level tags if the tags have the attribute `markdown=1`.
3282+nonbreaking space after the image:
5202
3283
5203−#### Extension: `mmd_title_block` ####
3284+ ![This image won't be a figure](/url/of/image.png)\
5204
3285
5205−Enables a [MultiMarkdown] style title block at the top of
3286+Note that in reveal.js slide shows, an image in a paragraph
5206−the document, for example:
3287+by itself that has the `stretch` class will fill the screen,
3288+and the caption and figure tags will be omitted.
5207
3289
5208− Title: My title
3290+#### Extension: `link_attributes` ####
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
3291
5214−See the MultiMarkdown documentation for details. If `pandoc_title_block` or
3292+Attributes can be set on links and images:
5215−`yaml_metadata_block` is enabled, it will take precedence over
5216−`mmd_title_block`.
5217
3293
5218−#### Extension: `abbreviations` ####
3294+ An inline ![image](foo.jpg){#id .class width=30 height=20px}
3295+ and a reference ![image][ref] with attributes.
5219
3296
5220−Parses PHP Markdown Extra abbreviation keys, like
3297+ [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}
5221
3298
5222− *[HTML]: Hypertext Markup Language
3299+(This syntax is compatible with [PHP Markdown Extra] when only `#id`
3300+and `.class` are used.)
5223
3301
5224−Note that the pandoc document model does not support
3302+For HTML and EPUB, all attributes except `width` and `height` (but
5225−abbreviations, so if this extension is enabled, abbreviation keys are
3303+including `srcset` and `sizes`) are passed through as is. The other
5226−simply skipped (as opposed to being parsed as paragraphs).
3304+writers ignore attributes that are not supported by their output
3305+format.
5227
3306
5228−#### Extension: `autolink_bare_uris` ####
3307+The `width` and `height` attributes on images are treated specially. When
3308+used without a unit, the unit is assumed to be pixels. However, any of
3309+the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`
3310+and `%`. There must not be any spaces between the number and the unit.
3311+For example:
5229
3312
5230−Makes all absolute URIs into links, even when not surrounded by
3313+```
5231−pointy braces `<...>`.
3314+![](file.jpg){ width=50% }
3315+```
5232
3316
5233−#### Extension: `mmd_link_attributes` ####
3317+- Dimensions are converted to inches for output in page-based formats like
3318+ LaTeX. Dimensions are converted to pixels for output in HTML-like
3319+ formats. Use the `--dpi` option to specify the number of pixels per
3320+ inch. The default is 96dpi.
3321+- The `%` unit is generally relative to some available space.
3322+ For example the above example will render to
3323+ `<img href="file.jpg" style="width: 50%;" />` (HTML),
3324+ `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or
3325+ `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).
3326+- Some output formats have a notion of a class
3327+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))
3328+ or a unique identifier (LaTeX `\caption`), or both (HTML).
3329+- When no `width` or `height` attributes are specified, the fallback
3330+ is to look at the image resolution and the dpi metadata embedded in
3331+ the image file.
5234
3332
5235−Parses multimarkdown style key-value attributes on link
3333+Spans
5236−and image references. This extension should not be confused with the
3334+-----
5237−[`link_attributes`](#extension-link_attributes) extension.
5238
3335
5239− This is a reference ![image][ref] with multimarkdown attributes.
3336+#### Extension: `bracketed_spans` ####
5240
3337
5241− [ref]: https://path.to/image "Image title" width=20px height=30px
3338+A bracketed sequence of inlines, as one would use to begin
5242− id=myId class="myClass1 myClass2"
3339+a link, will be treated as a span with attributes if it is
3340+followed immediately by attributes:
5243
3341
5244−#### Extension: `mmd_header_identifiers` ####
3342+ [This is *some text*]{.class key="val"}
5245
3343
5246−Parses multimarkdown style heading identifiers (in square brackets,
3344+Footnotes
5247−after the heading but before any trailing `#`s in an ATX heading).
3345+---------
5248
3346
5249−#### Extension: `compact_definition_lists` ####
3347+#### Extension: `footnotes` ####
5250
3348
5251−Activates the definition list syntax of pandoc 1.12.x and earlier.
3349+Pandoc's Markdown allows footnotes, using the following syntax:
5252−This syntax differs from the one described above under [Definition lists]
5253−in several respects:
5254
3350
5255− - No blank line is required between consecutive items of the
3351+ Here is a footnote reference,[^1] and another.[^longnote]
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
3352
5263−[^6]: To see why laziness is incompatible with relaxing the requirement
3353+ [^1]: Here is the footnote.
5264− of a blank line between items, consider the following example:
5265
3354
5266− bar
3355+ [^longnote]: Here's one with multiple blocks.
5267− : definition
5268− foo
5269− : definition
5270
3356
5271− Is this a single list item with two definitions of "bar," the first of
3357+ Subsequent paragraphs are indented to show that they
5272− which is lazily wrapped, or two list items? To remove the ambiguity
3358+ belong to the previous footnote.
5273− we must either disallow lazy wrapping or require a blank line between
5274− list items.
5275
3359
5276−#### Extension: `gutenberg` ####
3360+ { some.code }
5277
3361
5278−Use [Project Gutenberg] conventions for `plain` output:
3362+ The whole paragraph can be indented, or just the first
5279−all-caps for strong emphasis, surround by underscores
3363+ line. In this way, multi-paragraph footnotes work like
5280−for regular emphasis, add extra blank space around headings.
3364+ multi-paragraph list items.
5281
3365
5282− [Project Gutenberg]: https://www.gutenberg.org
3366+ This paragraph won't be part of the note, because it
3367+ isn't indented.
5283
3368
5284−#### Extension: `sourcepos` ####
3369+The identifiers in footnote references may not contain spaces, tabs,
3370+or newlines. These identifiers are used only to correlate the
3371+footnote reference with the note itself; in the output, footnotes
3372+will be numbered sequentially.
5285
3373
5286−Include source position attributes when parsing `commonmark`.
3374+The footnotes themselves need not be placed at the end of the
5287−For elements that accept attributes, a `data-pos` attribute
3375+document. They may appear anywhere except inside other block elements
5288−is added; other elements are placed in a surrounding
3376+(lists, block quotes, tables, etc.). Each footnote should be
5289−Div or Span elemnet with a `data-pos` attribute.
3377+separated from surrounding content (including other footnotes)
3378+by blank lines.
5290
3379
5291−## Markdown variants
3380+#### Extension: `inline_notes` ####
5292
3381
5293−In addition to pandoc's extended Markdown, the following Markdown
3382+Inline footnotes are also allowed (though, unlike regular notes,
5294−variants are supported:
3383+they cannot contain multiple paragraphs). The syntax is as follows:
5295
3384
5296−- `markdown_phpextra` (PHP Markdown Extra)
3385+ Here is an inline note.^[Inlines notes are easier to write, since
5297−- `markdown_github` (deprecated GitHub-Flavored Markdown)
3386+ you don't have to pick an identifier and move down to type the
5298−- `markdown_mmd` (MultiMarkdown)
3387+ note.]
5299−- `markdown_strict` (Markdown.pl)
5300−- `commonmark` (CommonMark)
5301−- `gfm` (Github-Flavored Markdown)
5302−- `commonmark_x` (CommonMark with many pandoc extensions)
5303
3388
5304−To see which extensions are supported for a given format,
3389+Inline and regular footnotes may be mixed freely.
5305−and which are enabled by default, you can use the command
5306
3390
5307− pandoc --list-extensions=FORMAT
3391+Typography
3392+----------
5308
3393
5309−where `FORMAT` is replaced with the name of the format.
3394+#### Extension: `smart` ####
5310
3395
5311−Note that the list of extensions for `commonmark`,
3396+Interpret straight quotes as curly quotes, `---` as em-dashes,
5312−`gfm`, and `commonmark_x` are defined relative to default
3397+`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are
5313−commonmark. So, for example, `backtick_code_blocks`
3398+inserted after certain abbreviations, such as "Mr." This
5314−does not appear as an extension, since it is enabled by
3399+option currently affects the input formats `markdown`,
5315−default and cannot be disabled.
3400+`commonmark`, `latex`, `mediawiki`, `org`, `rst`, and `twiki`,
3401+and the output formats `markdown`, `latex`, and `context`.
5316
3402
5317−# Citations
3403+Note: If you are *writing* Markdown, then the `smart` extension
3404+has the reverse effect: what would have been curly quotes comes
3405+out straight.
5318
3406
5319−When the `--citeproc` option is used, pandoc can automatically generate
3407+In LaTeX, `smart` means to use the standard TeX ligatures
5320−citations and a bibliography in a number of styles. Basic usage is
3408+for quotation marks (` `` ` and ` '' ` for double quotes,
3409+`` ` `` and `` ' `` for single quotes) and dashes (`--` for
3410+en-dash and `---` for em-dash). If `smart` is disabled,
3411+then in reading LaTeX pandoc will parse these characters
3412+literally. In writing LaTeX, enabling `smart` tells pandoc
3413+to use the ligatures when possible; if `smart` is disabled
3414+pandoc will use unicode quotation mark and dash characters.
5321
3415
5322− pandoc --citeproc myinput.txt
3416+Citations
3417+---------
5323
3418
5324−To use this feature, you will need to have
3419+#### Extension: `citations` ####
5325
3420
5326−- a document containing citations (see [Extension: `citations`]);
3421+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate
5327−- a source of bibliographic data: either an external bibliography
3422+citations and a bibliography in a number of styles. Basic usage is
5328− file or a list of `references` in the document's YAML metadata
5329−- optionally, a [CSL] citation style.
5330
3423
5331−## Specifying bibliographic data
3424+ pandoc --filter pandoc-citeproc myinput.txt
5332
3425
5333−You can specify an external bibliography using the
3426+In order to use this feature, you will need to specify a bibliography file
5334−`bibliography` metadata field in a YAML metadata section or the
3427+using the `bibliography` metadata field in a YAML metadata section, or
5335−`--bibliography` command line argument. If you want to use
3428+`--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
3429+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:
3430+use multiple bibliography files. The bibliography may have any of these
3431+formats:
5339
3432
5340 Format File extension
3433 Format File extension
5341 ------------ --------------
3434 ------------ --------------
5342 BibLaTeX .bib
3435 BibLaTeX .bib
5343 BibTeX .bibtex
3436 BibTeX .bibtex
3437+ Copac .copac
5344 CSL JSON .json
3438 CSL JSON .json
5345 CSL YAML .yaml
3439 CSL YAML .yaml
3440+ EndNote .enl
3441+ EndNote XML .xml
3442+ ISI .wos
3443+ MEDLINE .medline
3444+ MODS .mods
3445+ RIS .ris
5346
3446
5347Note that `.bib` can be used with both BibTeX and BibLaTeX files;
3447Note that `.bib` can be used with both BibTeX and BibLaTeX files;
5348−use the extension `.bibtex` to force interpretation as BibTeX.
3448+use `.bibtex` to force BibTeX.
3449+
3450+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`
3451+can produce `.json` and `.yaml` files from any of the supported formats.
5349
3452
5350−In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup
3453+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
3454+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
3455
5355`<i>...</i>`
3456`<i>...</i>`
5356: italics
3457: italics
@@ -5370,11 +3471,14 @@ markup specs]:
5370`<span class="nocase">...</span>`
3471`<span class="nocase">...</span>`
5371: prevent a phrase from being capitalized as title case
3472: prevent a phrase from being capitalized as title case
5372
3473
3474+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON
3475+and CSL YAML formats as far as possible.
3476+
5373−As an alternative to specifying a bibliography file using
3477+As an alternative to specifying a bibliography file using `--bibliography`
5374−`--bibliography` or the YAML metadata field `bibliography`, you
3478+or the YAML metadata field `bibliography`, you can include
5375−can include the citation data directly in the `references` field
3479+the citation data directly in the `references` field of the
5376−of the document's YAML metadata. The field should contain an
3480+document's YAML metadata. The field should contain an array of
5377−array of YAML-encoded references, for example:
3481+YAML-encoded references, for example:
5378
3482
5379 ---
3483 ---
5380 references:
3484 references:
@@ -5390,279 +3494,328 @@ array of YAML-encoded references, for example:
5390 - - 1953
3494 - - 1953
5391 - 4
3495 - 4
5392 - 25
3496 - 25
5393− title: 'Molecular structure of nucleic acids: a structure for
3497+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose
5394− deoxyribose nucleic acid'
3498+ nucleic acid'
5395 title-short: Molecular structure of nucleic acids
3499 title-short: Molecular structure of nucleic acids
5396 container-title: Nature
3500 container-title: Nature
5397 volume: 171
3501 volume: 171
5398 issue: 4356
3502 issue: 4356
5399 page: 737-738
3503 page: 737-738
5400 DOI: 10.1038/171737a0
3504 DOI: 10.1038/171737a0
5401− URL: https://www.nature.com/articles/171737a0
3505+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
5402 language: en-GB
3506 language: en-GB
5403 ...
3507 ...
5404
3508
5405−If both an external bibliography and inline (YAML metadata)
3509+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one
5406−references are provided, both will be used. In case of
3510+of the supported formats.)
5407−conflicting `id`s, the inline references will take precedence.
3511+
3512+Citations and references can be formatted using any style supported by the
3513+[Citation Style Language], listed in the [Zotero Style Repository].
3514+These files are specified using the `--csl` option or the `csl` metadata field.
3515+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
3516+format. The CSL project provides further information on [finding and editing styles].
3517+
3518+To make your citations hyperlinks to the corresponding bibliography
3519+entries, add `link-citations: true` to your YAML metadata.
3520+
3521+Citations go inside square brackets and are separated by semicolons.
3522+Each citation must have a key, composed of '@' + the citation
3523+identifier from the database, and may optionally have a prefix,
3524+a locator, and a suffix. The citation key must begin with a letter, digit,
3525+or `_`, and may contain alphanumerics, `_`, and internal punctuation
3526+characters (`:.#$%&-+?<>~/`). Here are some examples:
3527+
3528+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].
3529+
3530+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].
3531+
3532+ Blah blah [@smith04; @doe99].
3533+
3534+`pandoc-citeproc` detects locator terms in the [CSL locale files].
3535+Either abbreviated or unabbreviated forms are accepted. In the `en-US`
3536+locale, locator terms can be written in either singular or plural forms,
3537+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,
3538+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;
3539+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,
3540+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,
3541+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;
3542+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no
3543+locator term is used, "page" is assumed.
3544+
3545+A minus sign (`-`) before the `@` will suppress mention of
3546+the author in the citation. This can be useful when the
3547+author is already mentioned in the text:
3548+
3549+ Smith says blah [-@smith04].
3550+
3551+You can also write an in-text citation, as follows:
3552+
3553+ @smith04 says blah.
3554+
3555+ @smith04 [p. 33] says blah.
3556+
3557+If the style calls for a list of works cited, it will be placed
3558+at the end of the document. Normally, you will want to end your
3559+document with an appropriate header:
3560+
3561+ last paragraph...
3562+
3563+ # References
3564+
3565+The bibliography will be inserted after this header. Note that
3566+the `unnumbered` class will be added to this header, so that the
3567+section will not be numbered.
3568+
3569+If you want to include items in the bibliography without actually
3570+citing them in the body text, you can define a dummy `nocite` metadata
3571+field and put the citations there:
3572+
3573+ ---
3574+ nocite: |
3575+ @item1, @item2
3576+ ...
3577+
3578+ @item3
3579+
3580+In this example, the document will contain a citation for `item3`
3581+only, but the bibliography will contain entries for `item1`, `item2`, and
3582+`item3`.
3583+
3584+It is possible to create a bibliography with all the citations,
3585+whether or not they appear in the document, by using a wildcard:
3586+
3587+ ---
3588+ nocite: |
3589+ @*
3590+ ...
3591+
3592+For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]
3593+to render bibliography. In order to do so, specify bibliography files as
3594+outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
3595+invocation. Bear in mind that bibliography files have to be in respective
3596+format (either BibTeX or BibLaTeX).
5408
3597
5409−Note that `pandoc` can be used to produce such a YAML metadata
3598+For more information, see the [pandoc-citeproc man page].
5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:
5411
3599
5412− pandoc chem.bib -s -f biblatex -t markdown
3600+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
5413− pandoc chem.json -s -f csljson -t markdown
3601+[Chicago Manual of Style]: http://chicagomanualofstyle.org
3602+[Citation Style Language]: http://citationstyles.org
3603+[Zotero Style Repository]: https://www.zotero.org/styles
3604+[finding and editing styles]: http://citationstyles.org/styles/
3605+[CSL locale files]: https://github.com/citation-style-language/locales
3606+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
5414
3607
5415−Indeed, `pandoc` can convert between any of these
3608+Non-pandoc extensions
5416−citation formats:
3609+---------------------
5417
3610
5418− pandoc chem.bib -s -f biblatex -t csljson
3611+The following Markdown syntax extensions are not enabled by default
5419− pandoc chem.yaml -s -f markdown -t biblatex
3612+in pandoc, but may be enabled by adding `+EXTENSION` to the format
3613+name, where `EXTENSION` is the name of the extension. Thus, for
3614+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.
5420
3615
5421−Running pandoc on a bibliography file with the `--citeproc`
3616+#### Extension: `old_dashes` ####
5422−option will create a formatted bibliography in the format
5423−of your choice:
5424
3617
5425− pandoc chem.bib -s --citeproc -o chem.html
3618+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:
5426− pandoc chem.bib -s --citeproc -o chem.pdf
3619+`-` before a numeral is an en-dash, and `--` is an em-dash.
3620+This option only has an effect if `smart` is enabled. It is
3621+selected automatically for `textile` input.
5427
3622
5428−### Capitalization in titles
3623+#### Extension: `angle_brackets_escapable` ####
5429
3624
5430−If you are using a bibtex or biblatex bibliography, then observe
3625+Allow `<` and `>` to be backslash-escaped, as they can be in
5431−the following rules:
3626+GitHub flavored Markdown but not original Markdown. This is
3627+implied by pandoc's default `all_symbols_escapable`.
5432
3628
5433− - English titles should be in title case. Non-English titles should
3629+#### Extension: `lists_without_preceding_blankline` ####
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
3630
5439− - As is standard with bibtex/biblatex, proper names should be
3631+Allow a list to occur right after a paragraph, with no intervening
5440− protected with curly braces so that they won't be lowercased
3632+blank space.
5441− in styles that call for sentence case. For example:
5442
3633
5443− title = {My Dinner with {Andre}}
3634+#### Extension: `four_space_rule` ####
5444
3635
5445− - In addition, words that should remain lowercase (or camelCase)
3636+Selects the pandoc <= 2.0 behavior for parsing lists, so that
5446− should be protected:
3637+four spaces indent are needed for list item continuation
3638+paragraphs.
5447
3639
5448− title = {Spin Wave Dispersion on the {nm} Scale}
3640+#### Extension: `spaced_reference_links` ####
5449
3641
5450− Though this is not necessary in bibtex/biblatex, it is necessary
3642+Allow whitespace between the two components of a reference link,
5451− with citeproc, which stores titles internally in sentence case,
3643+for example,
5452− and converts to title case in styles that require it. Here we
5453− protect "nm" so that it doesn't get converted to "Nm" at this stage.
5454
3644
5455−If you are using a CSL bibliography (either JSON or YAML), then observe
3645+ [foo] [bar].
5456−the following rules:
5457
3646
5458− - All titles should be in sentence case.
3647+#### Extension: `hard_line_breaks` ####
5459
3648
5460− - Use the `language` field for non-English titles to prevent their
3649+Causes all newlines within a paragraph to be interpreted as hard line
5461− conversion to title case in styles that call for this. (Conversion
3650+breaks instead of spaces.
5462− happens only if `language` begins with `en` or is left empty.)
5463
3651
5464− - Protect words that should not be converted to title case using
3652+#### Extension: `ignore_line_breaks` ####
5465− this syntax:
5466
3653
5467− Spin wave dispersion on the <span class="nocase">nm</span> scale
3654+Causes newlines within a paragraph to be ignored, rather than being
3655+treated as spaces or as hard line breaks. This option is intended for
3656+use with East Asian languages where spaces are not used between words,
3657+but text is divided into lines for readability.
5468
3658
5469−### Conference Papers, Published vs. Unpublished
3659+#### Extension: `east_asian_line_breaks` ####
5470
3660
5471−For a formally published conference paper, use the biblatex entry type
3661+Causes newlines within a paragraph to be ignored, rather than
5472−`inproceedings` (which will be mapped to CSL `paper-conference`).
3662+being treated as spaces or as hard line breaks, when they occur
3663+between two East Asian wide characters. This is a better choice
3664+than `ignore_line_breaks` for texts that include a mix of East
3665+Asian wide characters and other characters.
5473
3666
5474−For an unpublished manuscript, use the biblatex entry type
3667+##### Extension: `emoji` ####
5475−`unpublished` without an `eventtitle` field (this entry type
5476−will be mapped to CSL `manuscript`).
5477
3668
5478−For a talk, an unpublished conference paper, or a poster
3669+Parses textual emojis like `:smile:` as Unicode emoticons.
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
3670
3671+#### Extension: `tex_math_single_backslash` ####
5488
3672
5489−## Specifying a citation style
3673+Causes anything between `\(` and `\)` to be interpreted as inline
3674+TeX math, and anything between `\[` and `\]` to be interpreted
3675+as display TeX math. Note: a drawback of this extension is that
3676+it precludes escaping `(` and `[`.
5490
3677
5491−Citations and references can be formatted using any style supported by the
3678+#### Extension: `tex_math_double_backslash` ####
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
3679
3680+Causes anything between `\\(` and `\\)` to be interpreted as inline
3681+TeX math, and anything between `\\[` and `\\]` to be interpreted
3682+as display TeX math.
5508
3683
5509− { "default": {
3684+#### Extension: `markdown_attribute` ####
5510− "container-title": {
5511− "Lloyd's Law Reports": "Lloyd's Rep",
5512− "Estates Gazette": "EG",
5513− "Scots Law Times": "SLT"
5514− }
5515− }
5516− }
5517
3685
3686+By default, pandoc interprets material inside block-level tags as Markdown.
3687+This extension changes the behavior so that Markdown is only parsed
3688+inside block-level tags if the tags have the attribute `markdown=1`.
5518
3689
5519−## Citations in note styles
3690+#### Extension: `mmd_title_block` ####
5520
3691
5521−Pandoc's citation processing is designed to allow you to
3692+Enables a [MultiMarkdown] style title block at the top of
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,
3693+the document, for example:
5527
3694
5528− Blah blah [@foo, p. 33].
3695+ Title: My title
3696+ Author: John Doe
3697+ Date: September 1, 2008
3698+ Comment: This is a sample mmd title block, with
3699+ a field spanning multiple lines.
5529
3700
5530−The footnote will be created automatically. Pandoc will take
3701+See the MultiMarkdown documentation for details. If `pandoc_title_block` or
5531−care of removing the space and moving the note before or
3702+`yaml_metadata_block` is enabled, it will take precedence over
5532−after the period, depending on the setting of
3703+`mmd_title_block`.
5533−`notes-after-punctuation`, as described below in [Other relevant
5534−metadata fields].
5535
3704
5536−In some cases you may need to put a citation inside a regular
3705+#### Extension: `abbreviations` ####
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
3706
5542− [^1]: Some studies [@foo; @bar, p. 33] show that
3707+Parses PHP Markdown Extra abbreviation keys, like
5543− frubulicious zoosnaps are quantical. For a survey
5544− of the literature, see @baz [chap. 1].
5545
3708
5546−## Raw content in a style
3709+ *[HTML]: Hypertext Markup Language
5547
3710
5548−To include raw content in a prefix, suffix, delimiter, or term,
3711+Note that the pandoc document model does not support
5549−surround it with these tags indicating the format:
3712+abbreviations, so if this extension is enabled, abbreviation keys are
3713+simply skipped (as opposed to being parsed as paragraphs).
5550
3714
5551− {{jats}}&lt;ref&gt;{{/jats}}
3715+#### Extension: `autolink_bare_uris` ####
5552
3716
5553−Without the tags, the string will be interpreted as a string
3717+Makes all absolute URIs into links, even when not surrounded by
5554−and escaped in the output, rather than being passed through raw.
3718+pointy braces `<...>`.
5555
3719
5556−This feature allows stylesheets to be customized to give
3720+#### Extension: `ascii_identifiers` ####
5557−different output for different output formats. However,
5558−stylesheets customized in this way will not be usable
5559−by other CSL implementations.
5560
3721
3722+Causes the identifiers produced by `auto_identifiers` to be pure ASCII.
3723+Accents are stripped off of accented Latin letters, and non-Latin
3724+letters are omitted.
5561
3725
3726+#### Extension: `mmd_link_attributes` ####
5562
3727
5563−## Placement of the bibliography
3728+Parses multimarkdown style key-value attributes on link
3729+and image references. This extension should not be confused with the
3730+[`link_attributes`](#extension-link_attributes) extension.
5564
3731
5565−If the style calls for a list of works cited, it will be placed
3732+ This is a reference ![image][ref] with multimarkdown attributes.
5566−in a div with id `refs`, if one exists:
5567
3733
5568− ::: {#refs}
3734+ [ref]: http://path.to/image "Image title" width=20px height=30px
5569− :::
3735+ id=myId class="myClass1 myClass2"
5570
3736
5571−Otherwise, it will be placed at the end of the document.
3737+#### Extension: `mmd_header_identifiers` ####
5572−Generation of the bibliography can be suppressed by setting
5573−`suppress-bibliography: true` in the YAML metadata.
5574
3738
5575−If you wish the bibliography to have a section heading, you can
3739+Parses multimarkdown style header identifiers (in square brackets,
5576−set `reference-section-title` in the metadata, or put the heading
3740+after the header but before any trailing `#`s in an ATX header).
5577−at the beginning of the div with id `refs` (if you are using it)
5578−or at the end of your document:
5579
3741
5580− last paragraph...
3742+#### Extension: `compact_definition_lists` ####
5581
3743
5582− # References
3744+Activates the definition list syntax of pandoc 1.12.x and earlier.
3745+This syntax differs from the one described above under [Definition lists]
3746+in several respects:
5583
3747
5584−The bibliography will be inserted after this heading. Note that
3748+ - No blank line is required between consecutive items of the
5585−the `unnumbered` class will be added to this heading, so that the
3749+ definition list.
5586−section will not be numbered.
3750+ - To get a "tight" or "compact" list, omit space between consecutive
3751+ items; the space between a term and its definition does not affect
3752+ anything.
3753+ - Lazy wrapping of paragraphs is not allowed: the entire definition must
3754+ be indented four spaces.[^6]
5587
3755
5588−## Including uncited items in the bibliography
3756+[^6]: To see why laziness is incompatible with relaxing the requirement
3757+ of a blank line between items, consider the following example:
5589
3758
5590−If you want to include items in the bibliography without actually
3759+ bar
5591−citing them in the body text, you can define a dummy `nocite` metadata
3760+ : definition
5592−field and put the citations there:
3761+ foo
3762+ : definition
5593
3763
5594− ---
3764+ Is this a single list item with two definitions of "bar," the first of
5595− nocite: |
3765+ which is lazily wrapped, or two list items? To remove the ambiguity
5596− @item1, @item2
3766+ we must either disallow lazy wrapping or require a blank line between
5597− ...
3767+ list items.
5598
3768
5599− @item3
3769+Markdown variants
3770+-----------------
5600
3771
5601−In this example, the document will contain a citation for `item3`
3772+In addition to pandoc's extended Markdown, the following Markdown
5602−only, but the bibliography will contain entries for `item1`, `item2`, and
3773+variants are supported:
5603−`item3`.
5604
3774
5605−It is possible to create a bibliography with all the citations,
3775+`markdown_phpextra` (PHP Markdown Extra)
5606−whether or not they appear in the document, by using a wildcard:
3776+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,
3777+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,
3778+ `header_attributes`, `link_attributes`, `abbreviations`,
3779+ `shortcut_reference_links`.
5607
3780
5608− ---
3781+`gfm` and `markdown_github` (GitHub-Flavored Markdown)
5609− nocite: |
3782+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,
5610− @*
3783+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,
5611− ...
3784+ `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,
3785+ `shortcut_reference_links`, `angle_brackets_escapable`.
5612
3786
5613−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to
3787+`markdown_mmd` (MultiMarkdown)
5614−render the bibliography. In order to do so, specify bibliography
3788+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,
5615−files as outlined above, and add `--natbib` or `--biblatex`
3789+ `tex_math_double_backslash`, `intraword_underscores`,
5616−argument to `pandoc` invocation. Bear in mind that bibliography
3790+ `mmd_title_block`, `footnotes`, `definition_lists`,
5617−files have to be in either BibTeX (for `--natbib`)
3791+ `all_symbols_escapable`, `implicit_header_references`,
5618−or BibLaTeX (for `--biblatex`) format.
3792+ `auto_identifiers`, `mmd_header_identifiers`,
3793+ `shortcut_reference_links`.
5619
3794
5620−## Other relevant metadata fields
3795+`markdown_strict` (Markdown.pl)
3796+: `raw_html`
5621
3797
5622−A few other metadata fields affect bibliography formatting:
3798+Extensions with formats other than Markdown
3799+-------------------------------------------
5623
3800
5624−`link-citations`
3801+Some of the extensions discussed above can be used with formats
5625−: If true, citations will be
3802+other than Markdown:
5626− hyperlinked to the corresponding bibliography entries
5627− (for author-date and numerical styles only).
5628
3803
5629−`lang`
3804+* `auto_identifiers` can be used with `latex`, `rst`, `mediawiki`,
5630−: The `lang` field will affect how the style is localized,
3805+ and `textile` input (and is used by default).
5631− for example in the translation of labels, the use
3806+
5632− of quotation marks, and the way items are sorted.
3807+* `tex_math_dollars`, `tex_math_single_backslash`, and
5633− (For backwards compatibility, `locale` may be used instead
3808+ `tex_math_double_backslash` can be used with `html` input.
5634− of `lang`, but this use is deprecated.)
3809+ (This is handy for reading web pages formatted using MathJax,
5635−
3810+ for example.)
5636− A BCP 47 language tag is expected: for example, `en`,
3811+
5637− `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension
3812+Producing slide shows with pandoc
5638− syntax (after `-u-`) may be used to specify options for
3813+=================================
5639− collation (sorting) more precisely. Here are some examples:
5640−
5641− - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.
5642− - `es-u-co-trad` -- Spanish with the traditional collation
5643− (with `Ch` sorting after `C`).
5644− - `fr-u-kb` -- French with "backwards" accent sorting
5645− (with `coté` sorting after `côte`).
5646− - `en-US-u-kf-upper` -- English with uppercase letters sorting
5647− before lower (default is lower before upper).
5648−
5649−`notes-after-punctuation`
5650−: If true (the default), pandoc will put footnote citations
5651− after following punctuation. For example, if the source
5652− contains `blah blah [@jones99].`, the result will look like
5653− `blah blah.[^1]`, with the note moved after the period and
5654− the space collapsed. If false, the space will still be
5655− collapsed, but the footnote will not be moved after the
5656− punctuation.
5657−
5658−
5659−# Slide shows
5660
3814
5661You can use pandoc to produce an HTML + JavaScript slide presentation
3815You 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,
3816that can be viewed via a web browser. There are five ways to do this,
5663using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
3817using [S5], [DZSlides], [Slidy], [Slideous], or [reveal.js].
5664−You can also produce a PDF slide show using LaTeX [`beamer`], or
3818+You can also produce a PDF slide show using LaTeX [`beamer`].
5665−slides shows in Microsoft [PowerPoint] format.
5666
3819
5667Here's the Markdown source for a simple slide show, `habits.txt`:
3820Here's the Markdown source for a simple slide show, `habits.txt`:
5668
3821
@@ -5704,21 +3857,18 @@ To produce an HTML/JavaScript slide show, simply type
5704
3857
5705where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
3858where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.
5706
3859
5707−For Slidy, Slideous, reveal.js, and S5, the file produced by
3860+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
3861+`-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
3862+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
3863+(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
3864+`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
3865+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],
5715−DZSlides, the (relatively short) JavaScript and CSS are included
3866+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in
5716−in the file by default.
3867+the file by default.
5717−
3868+
5718−With all HTML slide formats, the `--self-contained` option can
3869+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
3870+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.
3871+slide show, including linked scripts, stylesheets, images, and videos.
5722
3872
5723To produce a PDF slide show using beamer, type
3873To produce a PDF slide show using beamer, type
5724
3874
@@ -5727,17 +3877,14 @@ To produce a PDF slide show using beamer, type
5727Note that a reveal.js slide show can also be converted to a PDF
3877Note that a reveal.js slide show can also be converted to a PDF
5728by printing it to a file from the browser.
3878by printing it to a file from the browser.
5729
3879
5730−To produce a Powerpoint slide show, type
3880+Structuring the slide show
3881+--------------------------
5731
3882
5732− pandoc habits.txt -o habits.pptx
5733−
5734−## Structuring the slide show
5735−
5736−By default, the *slide level* is the highest heading level in
3883+By default, the *slide level* is the highest header level in
5737the hierarchy that is followed immediately by content, and not another
3884the hierarchy that is followed immediately by content, and not another
5738−heading, somewhere in the document. In the example above, level-1 headings
3885+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,
3886+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
3887+so 2 is the slide level. This default can be overridden using
5741the `--slide-level` option.
3888the `--slide-level` option.
5742
3889
5743The document is carved up into slides according to the following
3890The document is carved up into slides according to the following
@@ -5745,21 +3892,17 @@ rules:
5745
3892
5746 * A horizontal rule always starts a new slide.
3893 * A horizontal rule always starts a new slide.
5747
3894
5748− * A heading at the slide level always starts a new slide.
3895+ * A header at the slide level always starts a new slide.
5749
3896
5750− * Headings *below* the slide level in the hierarchy create
3897+ * Headers *below* the slide level in the hierarchy create
5751− headings *within* a slide. (In beamer, a "block" will be
3898+ 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
3899
5757− * Headings *above* the slide level in the hierarchy create
3900+ * Headers *above* the slide level in the hierarchy create
5758 "title slides," which just contain the section title
3901 "title slides," which just contain the section title
5759 and help to break the slide show into sections.
3902 and help to break the slide show into sections.
5760− Non-slide content under these headings will be included
3903+
5761− on the title slide (for HTML slide shows) or in a
3904+ * Content *above* the slide level will not appear in the slide
5762− subsequent slide with the same title (for beamer).
3905+ show.
5763
3906
5764 * A title page is constructed automatically from the document's title
3907 * A title page is constructed automatically from the document's title
5765 block, if present. (In the case of beamer, this can be disabled
3908 block, if present. (In the case of beamer, this can be disabled
@@ -5767,57 +3910,32 @@ rules:
5767
3910
5768These rules are designed to support many different styles of slide show. If
3911These rules are designed to support many different styles of slide show. If
5769you don't care about structuring your slides into sections and subsections,
3912you 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
3913+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
3914will be the slide level.) But you can also structure the slide show into
5772sections, as in the example above.
3915sections, as in the example above.
5773
3916
5774Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
3917Note: in reveal.js slide shows, if slide level is 2, a two-dimensional
5775−layout will be produced, with level-1 headings building horizontally
3918+layout will be produced, with level 1 headers building horizontally
5776−and level-2 headings building vertically. It is not recommended that
3919+and level 2 headers building vertically. It is not recommended that
5777you use deeper nesting of section levels with reveal.js.
3920you use deeper nesting of section levels with reveal.js.
5778
3921
5779−## Incremental lists
3922+Incremental lists
3923+-----------------
5780
3924
5781By default, these writers produce lists that display "all at once."
3925By default, these writers produce lists that display "all at once."
5782If you want your lists to display incrementally (one item at a time),
3926If you want your lists to display incrementally (one item at a time),
5783use the `-i` option. If you want a particular list to depart from the
3927use the `-i` option. If you want a particular list to depart from the
5784−default, put it in a `div` block with class `incremental` or
5785−`nonincremental`. So, for example, using the `fenced div` syntax, the
5786−following would be incremental regardless of the document default:
5787−
5788− ::: incremental
5789−
5790− - Eat spaghetti
5791− - Drink wine
5792−
5793− :::
5794−
5795−or
5796−
5797− ::: nonincremental
5798−
5799− - Eat spaghetti
5800− - Drink wine
5801−
5802− :::
5803−
5804−While using `incremental` and `nonincremental` divs are the
5805−recommended method of setting incremental lists on a per-case basis,
5806−an older method is also supported: putting lists inside a blockquote
5807−will depart from the document default (that is, it will display
5808−incrementally without the `-i` option and all at once with the `-i`
3928+default (that is, to display incrementally without the `-i` option and
5809−option):
3929+all at once with the `-i` option), put it in a block quote:
5810
3930
5811 > - Eat spaghetti
3931 > - Eat spaghetti
5812 > - Drink wine
3932 > - Drink wine
5813
3933
5814−Both methods allow incremental and nonincremental lists to be mixed
3934+In this way incremental and nonincremental lists can be mixed in
5815−in a single document.
3935+a single document.
5816
3936
5817−Note: Neither the `-i/--incremental` option nor any of the
5818−methods described here currently works for PowerPoint output.
5819−
5820−## Inserting pauses
3937+Inserting pauses
3938+----------------
5821
3939
5822You can add "pauses" within a slide by including a paragraph containing
3940You can add "pauses" within a slide by including a paragraph containing
5823three dots, separated by spaces:
3941three dots, separated by spaces:
@@ -5830,9 +3948,8 @@ three dots, separated by spaces:
5830
3948
5831 content after the pause
3949 content after the pause
5832
3950
5833−Note: this feature is not yet implemented for PowerPoint output.
5834−
5835−## Styling the slides
3951+Styling the slides
3952+------------------
5836
3953
5837You can change the style of HTML slides by putting customized CSS files
3954You can change the style of HTML slides by putting customized CSS files
5838in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
3955in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),
@@ -5857,9 +3974,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,
5857
3974
5858 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
3975 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf
5859
3976
5860−Note that heading attributes will turn into slide attributes
3977+Note that header attributes will turn into slide attributes
5861(on a `<div>` or `<section>`) in HTML slide formats, allowing you
3978(on a `<div>` or `<section>`) in HTML slide formats, allowing you
5862−to style individual slides. In beamer, the only heading attribute
3979+to style individual slides. In beamer, the only header attribute
5863that affects slides is the `allowframebreaks` class, which sets the
3980that affects slides is the `allowframebreaks` class, which sets the
5864`allowframebreaks` option, causing multiple slides to be created
3981`allowframebreaks` option, causing multiple slides to be created
5865if the content overfills the frame. This is recommended especially for
3982if the content overfills the frame. This is recommended especially for
@@ -5867,82 +3984,30 @@ bibliographies:
5867
3984
5868 # References {.allowframebreaks}
3985 # References {.allowframebreaks}
5869
3986
5870−## Speaker notes
3987+Speaker notes
3988+-------------
5871
3989
5872−Speaker notes are supported in reveal.js and PowerPoint (pptx)
3990+reveal.js has good support for speaker notes. You can add notes to your
5873−output. You can add notes to your Markdown document thus:
3991+Markdown document thus:
5874−
5875− ::: notes
5876
3992
3993+ <div class="notes">
5877 This is my note.
3994 This is my note.
5878
3995
5879 - It can contain Markdown
3996 - It can contain Markdown
5880 - like this list
3997 - like this list
5881
3998
5882− :::
3999+ </div>
5883−
5884−To show the notes window in reveal.js, press `s` while viewing the
5885−presentation. Speaker notes in PowerPoint will be available, as usual,
5886−in handouts and presenter view.
5887
4000
4001+To show the notes window, press `s` while viewing the presentation.
5888Notes are not yet supported for other slide formats, but the notes
4002Notes are not yet supported for other slide formats, but the notes
5889will not appear on the slides themselves.
4003will not appear on the slides themselves.
5890
4004
5891−## Columns
5892−
5893−To put material in side by side columns, you can use a native
5894−div container with class `columns`, containing two or more div
5895−containers with class `column` and a `width` attribute:
5896−
5897− :::::::::::::: {.columns}
5898− ::: {.column width="40%"}
5899− contents...
5900− :::
5901− ::: {.column width="60%"}
5902− contents...
5903− :::
5904− ::::::::::::::
5905−
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
4005+Frame attributes in beamer
4006+--------------------------
5942
4007
5943Sometimes it is necessary to add the LaTeX `[fragile]` option to
4008Sometimes it is necessary to add the LaTeX `[fragile]` option to
5944a frame in beamer (for example, when using the `minted` environment).
4009a frame in beamer (for example, when using the `minted` environment).
5945−This can be forced by adding the `fragile` class to the heading
4010+This can be forced by adding the `fragile` class to the header
5946introducing the slide:
4011introducing the slide:
5947
4012
5948 # Fragile slide {.fragile}
4013 # Fragile slide {.fragile}
@@ -5950,64 +4015,13 @@ introducing the slide:
5950All of the other frame attributes described in Section 8.1 of
4015All of the other frame attributes described in Section 8.1 of
5951the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
4016the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,
5952`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
4017`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,
5953−`shrink`, `standout`, `noframenumbering`.
4018+`shrink`.
5954−
5955−## Background in reveal.js and beamer
5956−
5957−Background images can be added to self-contained reveal.js slideshows and
5958−to beamer slideshows.
5959−
5960−For the same image on every slide, use the configuration
5961−option `background-image` either in the YAML metadata block
5962−or as a command-line variable. (There are no other options in
5963−beamer and the rest of this section concerns reveal.js slideshows.)
5964−
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
5971−`{data-background-image="/path/to/image"}`
5972−to the first slide-level heading on the slide (which may even be empty).
5973−
5974−In reveal.js's overview mode, the parallaxBackgroundImage will show up
5975−only on the first slide.
5976−
5977−Other reveal.js background settings also work on individual slides, including
5978−`data-background-size`, `data-background-repeat`, `data-background-color`,
5979−`data-transition`, and `data-transition-speed`.
5980−
5981−To add a background image to the automatically generated title slide, use the
5982−`title-slide-attributes` variable in the YAML metadata block. It must contain
5983−a map of attribute names and values.
5984−
5985−See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more
5986−details.
5987−
5988−For example in reveal.js:
5989−
5990−```
5991−---
5992−title: My Slideshow
5993−parallaxBackgroundImage: /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−---
5998−
5999−## Slide One
6000−
6001−Slide 1 has background_image.png as its background.
6002−
6003−## {data-background-image="/path/to/special_image.jpg"}
6004−
6005−Slide 2 has a special image for its background, even though the heading has no content.
6006−```
6007
4019
6008−# EPUBs
4020+Creating EPUBs with pandoc
4021+==========================
6009
4022
6010−## EPUB Metadata
4023+EPUB Metadata
4024+-------------
6011
4025
6012EPUB metadata may be specified using the `--epub-metadata` option, but
4026EPUB metadata may be specified using the `--epub-metadata` option, but
6013if the source document is Markdown, it is better to use a [YAML metadata
4027if the source document is Markdown, it is better to use a [YAML metadata
@@ -6085,20 +4099,11 @@ The following fields are recognized:
6085
4099
6086`rights`
4100`rights`
6087 ~ A string value.
4101 ~ 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
4102
6098`cover-image`
4103`cover-image`
6099 ~ A string value (path to cover image).
4104 ~ A string value (path to cover image).
6100
4105
6101−`css` (or legacy: `stylesheet`)
4106+`stylesheet`
6102 ~ A string value (path to CSS stylesheet).
4107 ~ A string value (path to CSS stylesheet).
6103
4108
6104`page-progression-direction`
4109`page-progression-direction`
@@ -6115,200 +4120,83 @@ The following fields are recognized:
6115 - `binding`: `true`|`false` (default `true`)
4120 - `binding`: `true`|`false` (default `true`)
6116 - `scroll-axis`: `vertical`|`horizontal`|`default`
4121 - `scroll-axis`: `vertical`|`horizontal`|`default`
6117
4122
6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html
4123+[MARC relators]: http://loc.gov/marc/relators/relaterm.html
6119[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
4124[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem
6120
4125
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
4126+Linked media
6166−
4127+------------
4128+
6167−By default, pandoc will download media referenced from any `<img>`, `<audio>`,
4129+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
4130+video) and include it in the EPUB container, yielding a completely
6170self-contained EPUB. If you want to link to external media resources
4131self-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
4132instead, use raw HTML in your source and add `data-external="1"` to the tag
6172with the `src` attribute. For example:
4133with the `src` attribute. For example:
6173
4134
6174 <audio controls="1">
4135 <audio controls="1">
6175− <source src="https://example.com/music/toccata.mp3"
4136+ <source src="http://example.com/music/toccata.mp3"
6176 data-external="1" type="audio/mpeg">
4137 data-external="1" type="audio/mpeg">
6177 </source>
4138 </source>
6178 </audio>
4139 </audio>
6179
4140
6180−# Jupyter notebooks
4141+Literate Haskell support
6181−
4142+========================
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
4143
6220−## Pyout
4144+If you append `+lhs` (or `+literate_haskell`) to an appropriate input or output
4145+format (`markdown`, `markdown_strict`, `rst`, or `latex` for input or output;
4146+`beamer`, `html4` or `html5` for output only), pandoc will treat the document as
4147+literate Haskell source. This means that
6221
4148
6222−``` code
4149+ - In Markdown input, "bird track" sections will be parsed as Haskell
6223−from IPython.display import HTML
4150+ code rather than block quotations. Text between `\begin{code}`
6224−HTML("""
4151+ and `\end{code}` will also be treated as Haskell code. For
6225−<script>
4152+ ATX-style headers the character '=' will be used instead of '#'.
6226−console.log("hello");
4153+
6227−</script>
4154+ - In Markdown output, code blocks with classes `haskell` and `literate`
6228−<b>HTML</b>
4155+ will be rendered using bird tracks, and block quotations will be
6229−""")
4156+ indented one space, so they will not be treated as Haskell code.
6230−```
4157+ In addition, headers will be rendered setext-style (with underlines)
4158+ rather than ATX-style (with '#' characters). (This is because ghc
4159+ treats '#' characters in column 1 as introducing line numbers.)
6231
4160
6232−## Image
4161+ - In restructured text input, "bird track" sections will be parsed
4162+ as Haskell code.
6233
4163
6234−This image ![image](myimage.png) will be
4164+ - In restructured text output, code blocks with class `haskell` will
6235−included as a cell attachment.
4165+ be rendered using bird tracks.
6236−````
6237
4166
6238−If you want to add cell attributes, group cells differently, or
4167+ - In LaTeX input, text in `code` environments will be parsed as
6239−add output to code cells, then you need to include divs to
4168+ Haskell code.
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
4169
6244−````
4170+ - In LaTeX output, code blocks with class `haskell` will be rendered
6245−:::::: {.cell .markdown}
4171+ inside `code` environments.
6246−# Lorem
6247
4172
6248−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus
4173+ - In HTML output, code blocks with class `haskell` will be rendered
6249−bibendum felis dictum sodales.
4174+ with class `literatehaskell` and bird tracks.
6250−::::::
6251
4175
6252−:::::: {.cell .code execution_count=1}
4176+Examples:
6253−``` {.python}
6254−print("hello")
6255−```
6256
4177
6257−::: {.output .stream .stdout}
4178+ pandoc -f markdown+lhs -t html
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
4179
6275−::: {.output .execute_result execution_count=2}
4180+reads literate Haskell source formatted with Markdown conventions and writes
6276−```{=html}
4181+ordinary HTML (without bird tracks).
6277−<script>
4182+
6278−console.log("hello");
4183+ pandoc -f markdown+lhs -t html+lhs
6279−</script>
4184+
6280−<b>HTML</b>
4185+writes HTML with the Haskell code in bird tracks, so it can be copied
6281−hello
4186+and pasted as literate Haskell source.
6282−```
4187+
6283−:::
4188+Note that GHC expects the bird tracks in the first column, so indentend literate
6284−::::::
4189+code blocks (e.g. inside an itemized environment) will not be picked up by the
6285−````
4190+Haskell compiler.
6286−
4191+
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
4192+Syntax highlighting
4193+===================
6306
4194
6307Pandoc will automatically highlight syntax in [fenced code blocks] that
4195Pandoc will automatically highlight syntax in [fenced code blocks] that
6308are marked with a language name. The Haskell library [skylighting] is
4196are 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
4197+used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.
4198+To see a list of language names that pandoc will recognize, type
6311−that pandoc will recognize, type `pandoc --list-highlight-languages`.
4199+`pandoc --list-highlight-languages`.
6312
4200
6313The color scheme can be selected using the `--highlight-style` option.
4201The color scheme can be selected using the `--highlight-style` option.
6314The default color scheme is `pygments`, which imitates the default color
4202The default color scheme is `pygments`, which imitates the default color
@@ -6316,36 +4204,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,
4204used to do the highlighting). To see a list of highlight styles,
6317type `pandoc --list-highlight-styles`.
4205type `pandoc --list-highlight-styles`.
6318
4206
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.
4207To disable highlighting, use the `--no-highlight` option.
6338
4208
6339[skylighting]: https://github.com/jgm/skylighting
4209[skylighting]: https://github.com/jgm/skylighting
6340
4210
6341−# Custom Styles
4211+Custom Styles in Docx Output
4212+============================
6342
4213
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
4214+By default, pandoc's docx output applies a predefined set of styles for
6348−for blocks such as paragraphs and block quotes, and uses largely default
4215+blocks such as paragraphs and block quotes, and uses largely default
6349formatting (italics, bold) for inlines. This will work for most
4216formatting (italics, bold) for inlines. This will work for most
6350purposes, especially alongside a `reference.docx` file. However, if you
4217purposes, especially alongside a `reference.docx` file. However, if you
6351need to apply your own styles to blocks, or match a preexisting set of
4218need to apply your own styles to blocks, or match a preexisting set of
@@ -6353,28 +4220,26 @@ styles, pandoc allows you to define custom styles for blocks and text
6353using `div`s and `span`s, respectively.
4220using `div`s and `span`s, respectively.
6354
4221
6355If you define a `div` or `span` with the attribute `custom-style`,
4222If you define a `div` or `span` with the attribute `custom-style`,
6356−pandoc will apply your specified style to the contained elements (with
4223+pandoc will apply your specified style to the contained elements. So,
6357−the exception of elements whose function depends on a style, like
4224+for example,
6358−headings, code blocks, block quotes, or links). So, for example, using
6359−the `bracketed_spans` syntax,
6360
4225
6361− [Get out]{custom-style="Emphatically"}, he said.
4226+ <span custom-style="Emphatically">Get out,</span> he said.
6362
4227
6363−would produce a docx file with "Get out" styled with character
4228+would produce a docx file with "Get out," styled with character
6364−style `Emphatically`. Similarly, using the `fenced_divs` syntax,
4229+style `Emphatically`. Similarly,
6365
4230
6366 Dickinson starts the poem simply:
4231 Dickinson starts the poem simply:
6367
4232
6368− ::: {custom-style="Poetry"}
4233+ <div custom-style="Poetry">
6369 | A Bird came down the Walk---
4234 | A Bird came down the Walk---
6370 | He did not know I saw---
4235 | He did not know I saw---
6371− :::
4236+ </div>
6372
4237
6373would style the two contained lines with the `Poetry` paragraph style.
4238would style the two contained lines with the `Poetry` paragraph style.
6374
4239
4240+If the styles are not yet in your reference.docx, they will be defined
6375−For docx output, styles will be defined in the output file as inheriting
4241+in the output file as inheriting from normal text. If they are already
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.
4242+defined, pandoc will not alter the definition.
6378
4243
6379This feature allows for greatest customization in conjunction with
4244This feature allows for greatest customization in conjunction with
6380[pandoc filters]. If you want all paragraphs after block quotes to be
4245[pandoc filters]. If you want all paragraphs after block quotes to be
@@ -6384,137 +4249,34 @@ want all italics to be transformed to the `Emphasis` character style
6384transform all italicized inlines to inlines within an `Emphasis`
4249transform all italicized inlines to inlines within an `Emphasis`
6385custom-style `span`.
4250custom-style `span`.
6386
4251
6387−For docx output, you don't need to enable any extensions for
6388−custom styles to work.
6389−
6390−[pandoc filters]: https://pandoc.org/filters.html
4252+[pandoc filters]: http://pandoc.org/scripting.html
6391
4253
6392−## Input
4254+Custom writers
4255+==============
6393
4256
6394−The docx reader, by default, only reads those styles that it can
4257+Pandoc can be extended with custom writers written in [lua]. (Pandoc
6395−convert into pandoc elements, either by direct conversion or
4258+includes a lua interpreter, so lua need not be installed separately.)
6396−interpreting the derivation of the input document's styles.
6397
4259
6398−By enabling the [`styles` extension](#ext-styles) in the docx reader
6399−(`-f docx+styles`), you can produce output that maintains the styles
6400−of the input document, using the `custom-style` class. Paragraph
6401−styles are interpreted as divs, while character styles are interpreted
6402−as spans.
6403−
6404−For example, using the `custom-style-reference.docx` file in the test
6405−directory, we have the following different outputs:
6406−
6407−Without the `+styles` extension:
6408−
6409− $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown
6410− This is some text.
6411−
6412− This is text with an *emphasized* text style. And this is text with a
6413− **strengthened** text style.
6414−
6415− > Here is a styled paragraph that inherits from Block Text.
6416−
6417−And with the extension:
6418−
6419− $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown
6420−
6421− ::: {custom-style="First Paragraph"}
6422− This is some text.
6423− :::
6424−
6425− ::: {custom-style="Body Text"}
6426− This is text with an [emphasized]{custom-style="Emphatic"} text style.
6427− And this is text with a [strengthened]{custom-style="Strengthened"}
6428− text style.
6429− :::
6430−
6431− ::: {custom-style="My Block Style"}
6432− > Here is a styled paragraph that inherits from Block Text.
6433− :::
6434−
6435−With these custom styles, you can use your input document as a
6436−reference-doc while creating docx output (see below), and maintain the
6437−same styles in your input and output files.
6438−
6439−# Custom writers
6440−
6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc
6442−includes a Lua interpreter, so Lua need not be installed separately.)
6443−
6444−To use a custom writer, simply specify the path to the Lua script
4260+To use a custom writer, simply specify the path to the lua script
6445in place of the output format. For example:
4261in place of the output format. For example:
6446
4262
6447 pandoc -t data/sample.lua
4263 pandoc -t data/sample.lua
6448
4264
6449−Creating a custom writer requires writing a Lua function for each
4265+Creating a custom writer requires writing a lua function for each
6450possible element in a pandoc document. To get a documented example
4266possible element in a pandoc document. To get a documented example
6451which you can modify according to your needs, do
4267which you can modify according to your needs, do
6452
4268
6453 pandoc --print-default-data-file sample.lua
4269 pandoc --print-default-data-file sample.lua
6454
4270
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
4271+[lua]: http://www.lua.org
6463−
4272+
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
4273+Authors
6512−
4274+=======
4275+
6513−Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released
4276+Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released
6514under the [GPL], version 2 or greater. This software carries no
4277under the [GPL], version 2 or greater. This software carries no
6515warranty of any kind. (See COPYRIGHT for full copyright and
4278warranty of any kind. (See COPYRIGHT for full copyright and
6516warranty notices.) For a full list of contributors, see the file
4279warranty notices.) For a full list of contributors, see the file
6517AUTHORS.md in the pandoc source code.
4280AUTHORS.md in the pandoc source code.
6518
4281
6519−[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"
4282+[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+41−109
@@ -1,79 +1,38 @@
1−version?=$(shell grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')
1+version?=$(shell grep '^Version:' pandoc.cabal | awk '{print $$2;}')
2pandoc=$(shell find dist -name pandoc -type f -exec ls -t {} \; | head -1)
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
4BRANCH?=master
5−ARCH=$(shell uname -m)
5+RESOLVER=nightly-2017-08-09
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
17−WEBSITE=../../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)",)
23
7
24quick:
8quick:
25− stack install --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --ghc-options='$(GHCOPTS)' --test-arguments='-j4 --hide-successes $(TESTARGS)'
9+ 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)
36
10
37full:
11full:
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)'
12+ 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'
42
13
43haddock:
14haddock:
44− stack haddock
15+ stack haddock --resolver=$(RESOLVER)
45
16
46# Note: to accept current results of golden tests,
17# Note: to accept current results of golden tests,
47# make test TESTARGS='--accept'
18# make test TESTARGS='--accept'
48test:
19test:
49− stack test --flag 'pandoc:embed_data_files' --fast --test-arguments='-j4 --hide-successes $(TESTARGS)' --ghc-options '$(GHCOPTS)'
20+ 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"
56
21
57bench:
22bench:
58− stack bench \
59− --ghc-options '$(GHCOPTS)' \
60− --benchmark-arguments='$(BENCHARGS)' 2>&1 | \
23+ stack bench --benchmark-arguments='$(BENCHARGS)' --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)'
61− tee "bench_latest.txt"
62
24
63−reformat:
25+weigh:
64− for f in $(SOURCEFILES); do echo $$f; stylish-haskell -i $$f ; done
26+ stack build --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)' --flag 'pandoc:weigh-pandoc' && stack exec weigh-pandoc
65−
66−lint: hlint fix_spacing
67
27
68−hlint:
28+reformat:
69− for f in $(SOURCEFILES); do echo $$f; hlint --verbose --refactor --refactor-options='-s -o -' $$f; done
29+ for f in $(sourcefiles); do echo $$f; stylish-haskell -i $$f ; done
70
30
71−fix_spacing:
31+lint:
72− # Fix trailing newlines and spaces at ends of lines
32+ for f in $(sourcefiles); do echo $$f; hlint --verbose --refactor --refactor-options='-i -s' $$f; done
73− for f in $(SOURCEFILES); do printf '%s\n' "`cat $$f`" | sed -e 's/ *$$//' > $$f.tmp; mv $$f.tmp $$f; done
74
33
75changes_github:
34changes_github:
76− pandoc --filter tools/extract-changes.hs changelog.md -t gfm --wrap=none --template tools/changes_template.html | sed -e 's/\\#/#/g' | pbcopy
35+ pandoc --filter extract-changes.hs changelog -t markdown_github | sed -e 's/\\#/#/g' | pbcopy
77
36
78dist: man/pandoc.1
37dist: man/pandoc.1
79 cabal sdist
38 cabal sdist
@@ -82,67 +41,40 @@ dist: man/pandoc.1
82 cd pandoc-${version}
41 cd pandoc-${version}
83 stack setup && stack test && cd .. && rm -rf "pandoc-${version}"
42 stack setup && stack test && cd .. && rm -rf "pandoc-${version}"
84
43
85−check: checkdocs check-cabal
44+debpkg: man/pandoc.1
45+ make -C linux
46+
47+macospkg: man/pandoc.1
48+ ./macos/make_macos_package.sh
86
49
87−checkdocs:
50+winpkg: pandoc-$(version)-windows.msi
88− ! grep -q -n -e "\t" MANUAL.txt changelog.md
89
51
90−debpkg: man/pandoc.1
52+pandoc-$(version)-windows.msi:
91− docker run -v `pwd`:/mnt \
53+ wget 'https://ci.appveyor.com/api/projects/jgm/pandoc/artifacts/windows/pandoc-windows-i386.msi?branch=$(BRANCH)' -O pandoc.msi && \
92− -v `pwd`/linux/artifacts:/artifacts \
54+ osslsigncode sign -pkcs12 ~/Private/ComodoCodeSigning.exp2019.p12 -in pandoc.msi -i http://johnmacfarlane.net/ -t http://timestamp.comodoca.com/ -out $@ -askpass
93− --user $(id -u):$(id -g) \
55+ rm pandoc.msi
94− -e REVISION=$(REVISION) \
56+
95− -w /mnt \
96− --memory=0 \
97− --rm \
98− $(DOCKERIMAGE) \
99− bash \
100− /mnt/linux/make_artifacts.sh 2>&1 > docker.log
101−
102−man/pandoc.1: MANUAL.txt man/pandoc.1.before man/pandoc.1.after
57+man/pandoc.1: MANUAL.txt man/pandoc.1.template
103− pandoc $< -f markdown -t man -s \
58+ pandoc $< -t man -s --template man/pandoc.1.template \
104− --lua-filter man/manfilter.lua \
59+ --filter man/capitalizeHeaders.hs \
105− --include-before-body man/pandoc.1.before \
60+ --filter man/removeNotes.hs \
106− --include-after-body man/pandoc.1.after \
61+ --filter man/removeLinks.hs \
107− --metadata author="" \
108− --variable footer="pandoc $(version)" \
62+ --variable version="pandoc $(version)" \
109 -o $@
63 -o $@
110
64
111−README.md: README.template MANUAL.txt tools/update-readme.lua
65+doc/lua-filters.md: tools/ldoc.ltp data/pandoc.lua tools/update-lua-docs.lua
112− pandoc --lua-filter tools/update-readme.lua \
66+ cp $@ $@.tmp
113− --reference-location=section -t gfm $< -o $@
67+ pandoc -t markdown --columns=64 --atx-headers \
68+ -f markdown -t markdown --standalone\
69+ --lua-filter tools/update-lua-docs.lua \
70+ -o $@ $@.tmp
71+ rm $@.tmp
114
72
115download_stats:
73download_stats:
116 curl https://api.github.com/repos/jgm/pandoc/releases | \
74 curl https://api.github.com/repos/jgm/pandoc/releases | \
117 jq -r '.[] | .assets | .[] | "\(.download_count)\t\(.name)"'
75 jq -r '.[] | .assets | .[] | "\(.download_count)\t\(.name)"'
118
76
119−pandoc-templates:
120− rm ../pandoc-templates/default.* ; \
121− cp data/templates/* ../pandoc-templates/ ; \
122− pushd ../pandoc-templates/ && \
123− git add * && \
124− git commit -m "Updated templates for pandoc $(version)" && \
125− popd
126−
127−trypandoc:
128− ssh -t macfarlane 'cd src/pandoc && git pull && stack install --flag pandoc:trypandoc --flag pandoc:embed_data_files && cd trypandoc && sudo make install'
129−
130−update-website:
131− make -C $(WEBSITE) update
132− make -C $(WEBSITE)
133− make -C $(WEBSITE) upload
134−
135clean:
77clean:
136 stack clean
78 stack clean
137
79
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
80+.PHONY: deps quick full haddock install clean test bench changes_github macospkg dist prof download_stats reformat lint weigh doc/lua-filters.md
README.md+145−237
@@ -1,244 +1,152 @@
1−<!-- Do not edit this file. It is generated automatically from
1+Pandoc
2−README.template and MANUAL.txt via the command:
2+======
3−pandoc --lua-filter tools/update-readme.lua README.template -o README.md
3+
4−-->
5−
6−# Pandoc
7−
8−[![github
9−release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
4+[![github release](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)
5+[![hackage 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)
6+[![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)
7+[![stackage LTS package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
15−[![CI
8+[![travis build status](https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build)](https://travis-ci.org/jgm/pandoc)
16−tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)
9+[![appveyor build 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)
10[![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
18−[![pandoc-discuss on google
19−groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
11+[![pandoc-discuss on google groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
20−
12+
13+
21−## The universal markup converter
14+The universal markup converter
22−
15+------------------------------
16+
23−Pandoc is a [Haskell](https://haskell.org) library for converting from
17+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
18+another, and a command-line tool that uses this library. It can read
25−library. It can convert *from*
19+[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored
26−
20+Markdown], [MultiMarkdown], and (subsets of) [Textile],
27−<div id="input-formats">
21+[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],
28−
22+[TikiWiki markup], [Haddock markup], [OPML], [Emacs Org mode], [DocBook],
29−- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)
23+[Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and [Word docx]; and it can
30−- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)
31−- `commonmark` ([CommonMark](https://commonmark.org) Markdown)
32−- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with
33− extensions)
34−- `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))
35−- `csljson` ([CSL
36− JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)
37− bibliography)
38−- `csv` ([CSV](https://tools.ietf.org/html/rfc4180) table)
39−- `docbook` ([DocBook](https://docbook.org))
40−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
41−- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
42−- `epub` ([EPUB](http://idpf.org/epub))
43−- `fb2`
44− ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
45− e-book)
46−- `gfm` ([GitHub-Flavored
47− Markdown](https://help.github.com/articles/github-flavored-markdown/)),
48− or the deprecated and less accurate `markdown_github`; use
49− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)
50− only if you need extensions not supported in
51− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).
52−- `haddock` ([Haddock
53− markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
54−- `html` ([HTML](https://www.w3.org/html/))
55−- `ipynb` ([Jupyter
56− notebook](https://nbformat.readthedocs.io/en/latest/))
57−- `jats` ([JATS](https://jats.nlm.nih.gov) XML)
58−- `jira`
59− ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence
60− wiki markup)
61−- `json` (JSON version of native AST)
62−- `latex` ([LaTeX](https://www.latex-project.org/))
63−- `markdown` ([Pandoc’s
64− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))
65−- `markdown_mmd`
66− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))
67−- `markdown_phpextra` ([PHP Markdown
68− Extra](https://michelf.ca/projects/php-markdown/extra/))
69−- `markdown_strict` (original unextended
70− [Markdown](https://daringfireball.net/projects/markdown/))
71−- `mediawiki` ([MediaWiki
72− markup](https://www.mediawiki.org/wiki/Help:Formatting))
73−- `man` ([roff man](https://man.cx/groff_man(7)))
74−- `muse` ([Muse](https://amusewiki.org/library/manual))
75−- `native` (native Haskell)
76−- `odt` ([ODT](https://en.wikipedia.org/wiki/OpenDocument))
77−- `opml` ([OPML](http://dev.opml.org/spec2.html))
78−- `org` ([Emacs Org mode](https://orgmode.org))
79−- `rst`
80− ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))
81−- `t2t` ([txt2tags](https://txt2tags.org))
82−- `textile` ([Textile](https://www.promptworks.com/textile))
83−- `tikiwiki` ([TikiWiki
84− markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))
85−- `twiki` ([TWiki
86− markup](https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))
87−- `vimwiki` ([Vimwiki](https://vimwiki.github.io))
88−
89−</div>
90−
91−It can convert *to*
92−
93−<div id="output-formats">
94−
95−- `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or
96− `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))
97−- `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)
98−- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)
99−- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)
100−- `commonmark` ([CommonMark](https://commonmark.org) Markdown)
24+write plain text, [Markdown], [CommonMark], [PHP Markdown
101−- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with
25+Extra], [GitHub-Flavored Markdown], [MultiMarkdown],
102− extensions)
26+[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including
103−- `context` ([ConTeXt](https://www.contextgarden.net/))
27+[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook],
104−- `csljson` ([CSL
28+[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki
105− JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)
29+markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
106− bibliography)
30+[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],
107−- `docbook` or `docbook4` ([DocBook](https://docbook.org) 4)
31+[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
108−- `docbook5` (DocBook 5)
32+Simple], [Muse] and [Slidy], [Slideous], [DZSlides], [reveal.js]
109−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))
110−- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))
111−- `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)
112−- `epub2` (EPUB v2)
113−- `fb2`
114− ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
115− e-book)
116−- `gfm` ([GitHub-Flavored
117− Markdown](https://help.github.com/articles/github-flavored-markdown/)),
118− or the deprecated and less accurate `markdown_github`; use
119− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)
120− only if you need extensions not supported in
121− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).
122−- `haddock` ([Haddock
123− markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))
124−- `html` or `html5` ([HTML](https://www.w3.org/html/),
125− i.e. [HTML5](https://html.spec.whatwg.org/)/XHTML [polyglot
126− markup](https://www.w3.org/TR/html-polyglot/))
127−- `html4` ([XHTML](https://www.w3.org/TR/xhtml1/) 1.0 Transitional)
128−- `icml` ([InDesign
129− ICML](https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))
130−- `ipynb` ([Jupyter
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,
135− Article Authoring Tag Set)
136−- `jats_publishing` ([JATS](https://jats.nlm.nih.gov) XML, Journal
137− Publishing Tag Set)
138−- `jats` (alias for `jats_archiving`)
139−- `jira`
140− ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence
141− wiki markup)
142−- `json` (JSON version of native AST)
143−- `latex` ([LaTeX](https://www.latex-project.org/))
144−- `man` ([roff man](https://man.cx/groff_man(7)))
145−- `markdown` ([Pandoc’s
146− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))
147−- `markdown_mmd`
148− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))
149−- `markdown_phpextra` ([PHP Markdown
150− Extra](https://michelf.ca/projects/php-markdown/extra/))
151−- `markdown_strict` (original unextended
152− [Markdown](https://daringfireball.net/projects/markdown/))
153−- `mediawiki` ([MediaWiki
154− markup](https://www.mediawiki.org/wiki/Help:Formatting))
155−- `ms` ([roff ms](https://man.cx/groff_ms(7)))
156−- `muse` ([Muse](https://amusewiki.org/library/manual)),
157−- `native` (native Haskell),
158−- `odt` ([OpenOffice text
159− document](https://en.wikipedia.org/wiki/OpenDocument))
160−- `opml` ([OPML](http://dev.opml.org/spec2.html))
161−- `opendocument` ([OpenDocument](http://opendocument.xml.org))
162−- `org` ([Emacs Org mode](https://orgmode.org))
163−- `pdf` ([PDF](https://www.adobe.com/pdf/))
164−- `plain` (plain text),
165−- `pptx`
166− ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)
167− slide show)
168−- `rst`
169− ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))
170−- `rtf` ([Rich Text
171− Format](https://en.wikipedia.org/wiki/Rich_Text_Format))
172−- `texinfo` ([GNU Texinfo](https://www.gnu.org/software/texinfo/))
173−- `textile` ([Textile](https://www.promptworks.com/textile))
174−- `slideous` ([Slideous](https://goessner.net/articles/slideous/) HTML
175− and JavaScript slide show)
176−- `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and
177− JavaScript slide show)
178−- `dzslides` ([DZSlides](https://paulrouget.com/dzslides/) HTML5 +
179− JavaScript slide show),
180−- `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript
181− slide show)
182−- `s5` ([S5](https://meyerweb.com/eric/tools/s5/) HTML and JavaScript
183− slide show)
184−- `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))
185−- `xwiki` ([XWiki
186− markup](https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/))
187−- `zimwiki` ([ZimWiki
188− markup](https://zim-wiki.org/manual/Help/Wiki_Syntax.html))
189−- the path of a custom Lua writer, see [Custom
190− writers](https://pandoc.org/MANUAL.html#custom-writers) below
191−
192−</div>
193−
194−Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.
33+or [S5] HTML slide shows. It can also produce [PDF] output on
195−
34+systems where LaTeX, ConTeXt, `pdfroff`, or `wkhtmltopdf` is
35+installed.
36+
196−Pandoc’s enhanced version of Markdown includes syntax for tables,
37+Pandoc's enhanced version of Markdown includes syntax for [footnotes],
197−definition lists, metadata blocks, footnotes, citations, math, and much
38+[tables], flexible [ordered lists], [definition lists], [fenced code
198−more. See the User’s Manual below under [Pandoc’s
39+blocks], [superscripts and subscripts], [strikeout], [metadata blocks],
199−Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
40+automatic tables of contents, embedded LaTeX [math], [citations], and
200−
41+[Markdown inside HTML block elements][Extension:
42+`markdown_in_html_blocks`]. (These enhancements, described further under
43+[Pandoc's Markdown], can be disabled using the `markdown_strict` input
44+or output format.)
45+
46+In contrast to most existing tools for converting Markdown to HTML, which
201−Pandoc has a modular design: it consists of a set of readers, which
47+use regex substitutions, pandoc has a modular design: it consists of a
202−parse text in a given format and produce a native representation of the
48+set of readers, which parse text in a given format and produce a native
203−document (an *abstract syntax tree* or AST), and a set of writers, which
49+representation of the document, and a set of writers, which convert
204−convert this native representation into a target format. Thus, adding an
50+this native representation into a target format. Thus, adding an input
205−input or output format requires only adding a reader or writer. Users
51+or output format requires only adding a reader or writer.
206−can also run custom pandoc filters to modify the intermediate AST (see
52+
207−the documentation for [filters](https://pandoc.org/filters.html) and
208−[Lua filters](https://pandoc.org/lua-filters.html)).
209−
210−Because pandoc’s intermediate representation of a document is less
53+Because pandoc's intermediate representation of a document is less
211−expressive than many of the formats it converts between, one should not
54+expressive than many of the formats it converts between, one should
212−expect perfect conversions between every format and every other. Pandoc
55+not expect perfect conversions between every format and every other.
213−attempts to preserve the structural elements of a document, but not
56+Pandoc attempts to preserve the structural elements of a document, but
214−formatting details such as margin size. And some document elements, such
57+not formatting details such as margin size. And some document elements,
215−as complex tables, may not fit into pandoc’s simple document model.
58+such as complex tables, may not fit into pandoc's simple document
216−While conversions from pandoc’s Markdown to all formats aspire to be
59+model. While conversions from pandoc's Markdown to all formats aspire
217−perfect, conversions from formats more expressive than pandoc’s Markdown
60+to be perfect, conversions from formats more expressive than pandoc's
218−can be expected to be lossy.
61+Markdown can be expected to be lossy.
219−
62+
63+[Markdown]: http://daringfireball.net/projects/markdown/
64+[CommonMark]: http://commonmark.org
65+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
66+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
67+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
68+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
69+[S5]: http://meyerweb.com/eric/tools/s5/
70+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
71+[Slideous]: http://goessner.net/articles/slideous/
72+[HTML]: http://www.w3.org/html/
73+[HTML5]: http://www.w3.org/TR/html5/
74+[XHTML]: http://www.w3.org/TR/xhtml1/
75+[LaTeX]: http://latex-project.org
76+[`beamer`]: https://ctan.org/pkg/beamer
77+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf
78+[ConTeXt]: http://www.contextgarden.net/
79+[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
80+[DocBook]: http://docbook.org
81+[txt2tags]: http://txt2tags.org
82+[EPUB]: http://idpf.org/epub
83+[OPML]: http://dev.opml.org/spec2.html
84+[OpenDocument]: http://opendocument.xml.org
85+[ODT]: http://en.wikipedia.org/wiki/OpenDocument
86+[Textile]: http://redcloth.org/textile
87+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
88+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
89+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
90+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
91+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
92+[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
93+[Haskell]: https://www.haskell.org
94+[GNU Texinfo]: http://www.gnu.org/software/texinfo/
95+[Emacs Org mode]: http://orgmode.org
96+[AsciiDoc]: http://www.methods.co.nz/asciidoc/
97+[DZSlides]: http://paulrouget.com/dzslides/
98+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
99+[PDF]: https://www.adobe.com/pdf/
100+[reveal.js]: http://lab.hakim.se/reveal-js/
101+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
102+[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
103+[TEI Simple]: https://github.com/TEIC/TEI-Simple
104+[Muse]: https://amusewiki.org/library/manual
105+[Vimwiki]: https://vimwiki.github.io
106+
107+
108+
109+
110+[footnotes]: http://pandoc.org/MANUAL.html#footnotes
111+[tables]: http://pandoc.org/MANUAL.html#tables
112+[ordered lists]: http://pandoc.org/MANUAL.html#ordered-lists
113+[definition lists]: http://pandoc.org/MANUAL.html#definition-lists
114+[fenced code blocks]: http://pandoc.org/MANUAL.html#fenced-code-blocks
115+[superscripts and subscripts]: http://pandoc.org/MANUAL.html#superscripts-and-subscripts
116+[strikeout]: http://pandoc.org/MANUAL.html#strikeout
117+[metadata blocks]: http://pandoc.org/MANUAL.html#metadata-blocks
118+[math]: http://pandoc.org/MANUAL.html#math
119+[citations]: http://pandoc.org/MANUAL.html#citations
120+[Markdown inside HTML block elements]: http://pandoc.org/MANUAL.html#extension-markdown_in_html_blocks
121+[Pandoc's Markdown]: http://pandoc.org/MANUAL.html#pandocs-markdown
122+
220−## Installing
123+Installing
221−
124+----------
125+
222−Here’s [how to install pandoc](INSTALL.md).
126+Here's [how to install pandoc](INSTALL.md).
223−
127+
224−## Documentation
128+Documentation
225−
129+-------------
130+
226−Pandoc’s website contains a full [User’s
131+Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).
227−Guide](https://pandoc.org/MANUAL.html). It is also available
228−[here](MANUAL.txt) as pandoc-flavored Markdown. The website also
132+It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.
229−contains some [examples of the use of
133+The website also contains some [examples of the use of
230pandoc](https://pandoc.org/demos.html) and a limited [online
134pandoc](https://pandoc.org/demos.html) and a limited [online
231demo](https://pandoc.org/try).
135demo](https://pandoc.org/try).
232
136
233−## Contributing
137+Contributing
138+------------
234
139
235−Pull requests, bug reports, and feature requests are welcome. Please
140+Pull requests, bug reports, and feature requests are welcome. Please make
236−make sure to read [the contributor guidelines](CONTRIBUTING.md) before
141+sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a
237−opening a new issue.
142+new issue.
238
143
239−## License
240
144
145+License
146+-------
147+
241−© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the
148+© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
242−[GPL](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"),
243−version 2 or greater. This software carries no warranty of any kind.
149+[GPL], version 2 or greater. This software carries no warranty of
244−(See COPYRIGHT for full copyright and warranty notices.)
150+any kind. (See COPYRIGHT for full copyright and warranty notices.)
151+
152+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"
README.templatedeleted−89
@@ -1,89 +0,0 @@
1−<!-- Do not edit this file. It is generated automatically from
2−README.template and MANUAL.txt via the command:
3−pandoc --lua-filter tools/update-readme.lua README.template -o README.md
4−-->
5−
6−Pandoc
7−======
8−
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)
11−[![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](https://formulae.brew.sh/formula/pandoc)
12−[![stackage LTS package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)
13−[![CI tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)
14−[![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−
17−
18−The universal markup converter
19−------------------------------
20−
21−Pandoc is a [Haskell] library for converting from one markup format to
22−another, and a command-line tool that uses this library. It can convert *from*
23−
24−::: {#input-formats}
25−:::
26−
27−It can convert *to*
28−
29−::: {#output-formats}
30−:::
31−
32−Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.
33−
34−Pandoc's enhanced version of Markdown includes syntax for tables,
35−definition lists, metadata blocks, footnotes, citations, math,
36−and much more. See the User's Manual below under
37−[Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
38−
39−Pandoc has a modular design: it consists of a set of readers, which parse
40−text in a given format and produce a native representation of the document
41−(an _abstract syntax tree_ or AST), and a set of writers, which convert
42−this native representation into a target format. Thus, adding an input
43−or output format requires only adding a reader or writer. Users can also
44−run custom pandoc filters to modify the intermediate AST (see
45−the documentation for [filters](https://pandoc.org/filters.html)
46−and [Lua filters](https://pandoc.org/lua-filters.html)).
47−
48−Because pandoc's intermediate representation of a document is less
49−expressive than many of the formats it converts between, one should
50−not expect perfect conversions between every format and every other.
51−Pandoc attempts to preserve the structural elements of a document, but
52−not formatting details such as margin size. And some document elements,
53−such as complex tables, may not fit into pandoc's simple document
54−model. While conversions from pandoc's Markdown to all formats aspire
55−to be perfect, conversions from formats more expressive than pandoc's
56−Markdown can be expected to be lossy.
57−
58−
59−Installing
60−----------
61−
62−Here's [how to install pandoc](INSTALL.md).
63−
64−Documentation
65−-------------
66−
67−Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).
68−It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.
69−The website also contains some [examples of the use of
70−pandoc](https://pandoc.org/demos.html) and a limited [online
71−demo](https://pandoc.org/try).
72−
73−Contributing
74−------------
75−
76−Pull requests, bug reports, and feature requests are welcome. Please make
77−sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a
78−new issue.
79−
80−
81−License
82−-------
83−
84−© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the
85−[GPL], version 2 or greater. This software carries no warranty of
86−any kind. (See COPYRIGHT for full copyright and warranty notices.)
87−
88−[GPL]: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"
89−[Haskell]: https://haskell.org
RELEASE-CHECKLIST+33−20
@@ -1,21 +1,34 @@
1−[ ] use 'policeman' to check API changes and version update
1+_ Test, on Linux, Windows, macOS (inc. website demos)
2−[ ] make README.md and commit if needed
2+
3−[ ] 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' --reverse --name-only 1.17.0.3..HEAD > LOG
6− successfully) download artifacts
5+
7−[ ] run tools/build-arm.sh to create and download arm64 linux package
6+_ make man/pandoc.1 and commit if needed
8−[ ] download macos artifacts from CircleCI
7+
9−[ ] Use 'make' in macos and windows artifacts to sign code
10−[ ] make update-website
11−[ ] make trypandoc
12−[ ] Tag release in git
8+_ Tag release in git
9+
13−[ ] make pandoc-templates
10+_ Push templates:
14− cd ../pandoc-templates
11+ git subtree push --prefix=data/templates git@github.com:jgm/pandoc-templates.git master
15− git tag REL
12+
16− git push
13+_ Generate Windows package (make winpkg)
17− git push --tags
14+
15+_ Generate macOS package (make macospkg)
16+
17+_ Generate Ubuntu/Debian deb package (make debpkg)
18+
18−[ ] Add release on github (use 'make changes_github' and upload files)
19+- Add release on github (use 'make changes_github' and upload files)
20+
19−[ ] stack upload .
21+_ Upload to HackageDB: stack upload .
22+
23+_ if docs don't build on Hackage:
24+ 'cabal install neil && neil docs --username=MYUSERNAME'
25+
26+_ Update website, including short description of changes ('make changes')
27+
20−[ ] Announce on pandoc-announce, pandoc-discuss
28+_ Announce on pandoc-announce, pandoc-discuss
29+
30+_ on server, stack install --flag 'pandoc:trypandoc'
31+ and then 'cd trypandoc; sudo make install'
32+
33+_ recompile gitit
21
34
RELEASE-CHECKLIST.mdnew file+27
@@ -0,0 +1,27 @@
1+- [ ] Test, on Linux, Windows, macOS (inc. website demos)
2+
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`
5+
6+- [ ] `make man/pandoc.1` and commit if needed
7+
8+- [ ] Tag release in git
9+
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+{-
2+Copyright (C) 2006-2015 John MacFarlane <jgm@berkeley.edu>
3+
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.
8+
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
3− Copyright : Copyright (C) 2006-2021 John MacFarlane
4− License : GNU GPL, version 2 or above
5−
6− Maintainer : John MacFarlane <jgm@berkeley@edu>
7− Stability : alpha
8− Portability : portable
9−
10−Parses command-line options and calls the appropriate readers and
11−writers.
12−-}
13−module Main where
14−import qualified Control.Exception as E
15−import Text.Pandoc.App (convertWithOpts, defaultOpts, options, parseOptions)
16−import Text.Pandoc.Error (handleError)
17−
18−main :: IO ()
19−main = E.catch (parseOptions options defaultOpts >>= convertWithOpts)
20− (handleError . Left)
appveyor.ymlnew file+80
@@ -0,0 +1,80 @@
1+clone_folder: "c:\\pandoc"
2+environment:
3+ global:
4+ WIXBIN: "c:\\Program Files (x86)\\WiX Toolset v3.11\\bin"
5+ STACK_YAML: "c:\\pandoc\\stack.pkg.yaml"
6+ STACK_BUILD_OPTS: "-j1 --no-terminal --test --local-bin-path=.\\windows"
7+ matrix:
8+ - STACK_VERSION: "windows-i386"
9+ STACK_ROOT: "c:\\sr32"
10+ STACK: "%STACK_ROOT%\\stack.exe"
11+ STACK_FLAGS: "--flag=hslua:lua_32bits"
12+# - STACK_VERSION: "windows-x86_64"
13+# STACK_ROOT: "c:\\sr64"
14+# STACK: "%STACK_ROOT%\\stack.exe"
15+# STACK_FLAGS: ""
16+
17+skip_commits:
18+ files:
19+ - '*.md'
20+ - '*.txt'
21+ - '.travis.yml'
22+ - 'Makefile'
23+ - 'man/pandoc.1'
24+ - 'linux/*'
25+ - 'macos/*'
26+
27+matrix:
28+ fast_finish: true
29+
30+cache:
31+ - "%STACK_ROOT%"
32+ - "%WIXBIN%"
33+ # This is where stack install ghc by default, but we don't
34+ # cache it because it's too large:
35+ # - "c:\\Users\\appveyor\\AppData\\Local\\Programs\\stack"
36+
37+# Note: to reset build cache, do the following in JavaScript
38+# console on appveyor:
39+# $.ajax({
40+# url: 'https://ci.appveyor.com/api/projects/jgm/pandoc/buildcache',
41+# type: 'DELETE'})
42+
43+# We don't do a normal C build, but build in test_script via stack
44+build: off
45+
46+install:
47+ - '"%WIXBIN%"\candle -? || choco install wixtoolset'
48+ - |
49+ %STACK% --version || curl -ostack.zip -L --insecure http://www.stackage.org/stack/%STACK_VERSION% && 7z e stack.zip -o"%STACK_ROOT%" stack.exe
50+
51+# before_test:
52+
53+test_script:
54+ # The ugly echo "" hack is to avoid complaints about 0 being an invalid file
55+ # descriptor
56+ - |
57+ %STACK% setup > nul
58+ %STACK% path
59+ echo "" | %STACK% clean
60+ echo "" | %STACK% %STACK_BUILD_OPTS% install pandoc pandoc-citeproc %STACK_FLAGS%
61+
62+after_test:
63+ # .\ in the stack commandline seems to be .\windows\ (where the stack-appveyor.yaml is)
64+ - cd windows
65+ - .\pandoc.exe -s --toc ..\MANUAL.txt -o MANUAL.html
66+ - .\pandoc.exe -s ..\COPYING.md -o COPYING.rtf
67+ - copy ..\COPYRIGHT COPYRIGHT.txt
68+ - 7z a "pandoc-%STACK_VERSION%.zip" pandoc.exe pandoc-citeproc.exe MANUAL.html COPYING.rtf
69+ - |
70+ set VERSION=
71+ for /f "tokens=1-2 delims= " %%a in ('.\pandoc.exe --version') do ( if not defined VERSION set "VERSION=%%b" )
72+ echo %VERSION%
73+ "%WIXBIN%\\candle" -dVERSION=%VERSION% -dBINPATH=. *.wxs -out wixobj\
74+ "%WIXBIN%\\light" -sw1076 -ext WixUIExtension -ext WixUtilExtension -cultures:en-us -loc Pandoc-en-us.wxl -out "pandoc-%STACK_VERSION%.msi" wixobj\*.wixobj
75+
76+artifacts:
77+ - path: 'windows\pandoc-%STACK_VERSION%.zip'
78+ name: exe
79+ - path: 'windows\pandoc-%STACK_VERSION%.msi'
80+ name: msi
benchmark/benchmark-pandoc.hs+59−74
@@ -1,6 +1,5 @@
1−{-# LANGUAGE OverloadedStrings #-}
2{-
1{-
3−Copyright (C) 2012-2021 John MacFarlane <jgm@berkeley.edu>
2+Copyright (C) 2012-2014 John MacFarlane <jgm@berkeley.edu>
4
3
5This program is free software; you can redistribute it and/or modify
4This program is free software; you can redistribute it and/or modify
6it under the terms of the GNU General Public License as published by
5it under the terms of the GNU General Public License as published by
@@ -17,87 +16,73 @@ along with this program; if not, write to the Free Software
17Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18-}
17-}
19import Text.Pandoc
18import Text.Pandoc
20−import Text.Pandoc.MIME
19+import Text.Pandoc.Class hiding (getCurrentTime, trace)
21−import Control.DeepSeq (force)
22−import Control.Monad.Except (throwError)
23import qualified Text.Pandoc.UTF8 as UTF8
20import qualified Text.Pandoc.UTF8 as UTF8
21+import Data.Text (Text)
22+import Data.Time (getCurrentTime)
24import qualified Data.ByteString as B
23import qualified Data.ByteString as B
25−import qualified Data.Text as T
24+import qualified Data.Map as Map
26−import Test.Tasty.Bench
25+import Criterion.Main
27−-- import Gauge
26+import Criterion.Types (Config(..))
28−import qualified Data.ByteString.Lazy as BL
29import Data.Maybe (mapMaybe)
27import Data.Maybe (mapMaybe)
30−import Data.List (sortOn)
28+import Debug.Trace (trace)
29+import System.Environment (getArgs)
31
30
32readerBench :: Pandoc
31readerBench :: Pandoc
33− -> T.Text
32+ -> (String, ReaderOptions -> Text -> Pandoc)
34 -> Maybe Benchmark
33 -> Maybe Benchmark
35−readerBench _ name
34+readerBench doc (name, reader) =
36− | name `elem` ["bibtex", "biblatex", "csljson"] = Nothing
35+ case lookup name writers of
37−readerBench doc name = either (const Nothing) Just $
38− runPure $ do
39− (rdr, rexts) <- getReader name
40− (wtr, wexts) <- getWriter name
41− case (rdr, wtr) of
42− (TextReader r, TextWriter w) -> do
36+ Just (TextWriter writer) ->
43− inp <- w def{ writerWrapText = WrapAuto
44− , writerExtensions = wexts } doc
45− return $ bench (T.unpack name) $
46− nf (either (error . show) id . runPure . r def) inp
37+ let inp = either (error . show) id $ runPure
47− (ByteStringReader r, ByteStringWriter w) -> do
48− tmpl <- Just <$> compileDefaultTemplate name
49− inp <- w def{ writerWrapText = WrapAuto
38+ $ writer def{ writerWrapText = WrapAuto} doc
50− , writerExtensions = wexts
51− , writerTemplate = tmpl } doc
52− return $ bench (T.unpack name) $
39+ in return $ bench (name ++ " reader") $ nf
53− nf (either (error . show) id .
40+ (reader def) inp
54− runPure . r def{readerExtensions = rexts}) inp
41+ _ -> trace ("\nCould not find writer for " ++ name ++ "\n") Nothing
55− _ -> throwError $ PandocSomeError $ "text/bytestring format mismatch: "
56− <> name
57
42
58−getImages :: IO [(FilePath, MimeType, BL.ByteString)]
43+writerBench :: Pandoc
59−getImages = do
44+ -> (String, WriterOptions -> Pandoc -> Text)
60− ll <- B.readFile "test/lalune.jpg"
61− mv <- B.readFile "test/movie.jpg"
62− return [("lalune.jpg", "image/jpg", BL.fromStrict ll)
63− ,("movie.jpg", "image/jpg", BL.fromStrict mv)]
64−
65−writerBench :: [(FilePath, MimeType, BL.ByteString)]
66− -> Pandoc
67− -> T.Text
68− -> Maybe Benchmark
45+ -> Benchmark
69−writerBench _ _ name
46+writerBench doc (name, writer) = bench (name ++ " writer") $ nf
70− | name `elem` ["bibtex", "biblatex", "csljson"] = Nothing
47+ (writer def{ writerWrapText = WrapAuto }) doc
71−writerBench imgs doc name = either (const Nothing) Just $
72− runPure $ do
73− (wtr, wexts) <- getWriter name
74− case wtr of
75− TextWriter writerFun ->
76− return $ bench (T.unpack name)
77− $ nf (\d -> either (error . show) id $
78− runPure $ do
79− mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs
80− writerFun def{ writerExtensions = wexts} d)
81− doc
82− ByteStringWriter writerFun ->
83− return $ bench (T.unpack name)
84− $ nf (\d -> either (error . show) id $
85− runPure $ do
86− mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs
87− writerFun def{ writerExtensions = wexts} d)
88− doc
89
48
90main :: IO ()
49main :: IO ()
91main = do
50main = do
51+ args <- getArgs
52+ let matchReader (n, TextReader _) =
53+ case args of
54+ [] -> True
55+ [x] -> x == n
56+ (x:y:_) -> x == n && y == "reader"
57+ matchReader (_, _) = False
58+ let matchWriter (n, TextWriter _) =
59+ case args of
60+ [] -> True
61+ [x] -> x == n
62+ (x:y:_) -> x == n && y == "writer"
63+ matchWriter (_, _) = False
64+ let matchedReaders = filter matchReader readers
65+ let matchedWriters = filter matchWriter writers
92 inp <- UTF8.toText <$> B.readFile "test/testsuite.txt"
66 inp <- UTF8.toText <$> B.readFile "test/testsuite.txt"
67+ lalune <- B.readFile "test/lalune.jpg"
68+ movie <- B.readFile "test/movie.jpg"
69+ time <- getCurrentTime
70+ let setupFakeFiles = modifyPureState $ \st -> st{ stFiles =
71+ FileTree $ Map.fromList [
72+ ("lalune.jpg", FileInfo time lalune),
73+ ("movie.jpg", FileInfo time movie)
74+ ]}
93 let opts = def
75 let opts = def
94− let doc = either (error . show) force $ runPure $ readMarkdown opts inp
76+ let doc = either (error . show) id $ runPure $ readMarkdown opts inp
95− defaultMain
77+ let readers' = [(n, \o d ->
96− [ env getImages $ \imgs ->
78+ either (error . show) id $ runPure $ r o d)
79+ | (n, TextReader r) <- matchedReaders]
80+ let readerBs = mapMaybe (readerBench doc)
81+ $ filter (\(n,_) -> n /="haddock") readers'
82+ let writers' = [(n, \o d ->
83+ either (error . show) id $ runPure $ setupFakeFiles >> w o d)
84+ | (n, TextWriter w) <- matchedWriters]
97− bgroup "writers" $ mapMaybe (writerBench imgs doc . fst)
85+ let writerBs = map (writerBench doc)
98− (sortOn fst
99− writers :: [(T.Text, Writer PandocPure)])
86+ $ writers'
100− , bgroup "readers" $ mapMaybe (readerBench doc . fst)
87+ defaultMainWith defaultConfig{ timeLimit = 6.0 }
101− (sortOn fst
88+ (writerBs ++ readerBs)
102− readers :: [(T.Text, Reader PandocPure)])
103− ]
benchmark/weigh-pandoc.hsnew file+38
@@ -0,0 +1,38 @@
1+import Weigh
2+import Text.Pandoc
3+import Data.Text (Text)
4+
5+main :: IO ()
6+main = do
7+ doc <- read <$> readFile "test/testsuite.native"
8+ mainWith $ do
9+ func "Pandoc document" id doc
10+ mapM_
11+ (\(n,r) -> weighReader doc n (either (error . show) id . runPure . r def{readerExtensions = pandocExtensions}))
12+ [("markdown", readMarkdown)
13+ ,("html", readHtml)
14+ ,("docbook", readDocBook)
15+ ,("latex", readLaTeX)
16+ ,("commonmark", readCommonMark)
17+ ]
18+ mapM_
19+ (\(n,w) -> weighWriter doc n (either (error . show) id . runPure . w def))
20+ [("markdown", writeMarkdown)
21+ ,("html", writeHtml5String)
22+ ,("docbook", writeDocbook5)
23+ ,("latex", writeLaTeX)
24+ ,("commonmark", writeCommonMark)
25+ ]
26+
27+weighWriter :: Pandoc -> String -> (Pandoc -> Text) -> Weigh ()
28+weighWriter doc name writer = func (name ++ " writer") writer doc
29+
30+weighReader :: Pandoc -> String -> (Text -> Pandoc) -> Weigh ()
31+weighReader doc name reader = do
32+ case lookup name writers of
33+ Just (TextWriter writer) ->
34+ let inp = either (error . show) id $ runPure $ writer def{ writerWrapText = WrapAuto} doc
35+ in func (name ++ " reader") reader inp
36+ _ -> return () -- no writer for reader
37+
38+
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
changelognew file+10953

This diff is too big to show here.

changelog.mddeleted−20339

This diff is too big to show here.

citeproc/biblatex-localization/.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/UKenglish.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/USenglish.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/american.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/australian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/austrian.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/brazil.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/brazilian.lbx.stringsdeleted−233

This diff is too big to show here.

citeproc/biblatex-localization/british.lbx.stringsdeleted−3

This diff is too big to show here.

citeproc/biblatex-localization/bulgarian.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/canadian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/catalan.lbx.stringsdeleted−158

This diff is too big to show here.

citeproc/biblatex-localization/croatian.lbx.stringsdeleted−214

This diff is too big to show here.

citeproc/biblatex-localization/czech.lbx.stringsdeleted−91

This diff is too big to show here.

citeproc/biblatex-localization/danish.lbx.stringsdeleted−106

This diff is too big to show here.

citeproc/biblatex-localization/dutch.lbx.stringsdeleted−23

This diff is too big to show here.

citeproc/biblatex-localization/english.lbx.stringsdeleted−254

This diff is too big to show here.

citeproc/biblatex-localization/estonian.lbx.stringsdeleted−178

This diff is too big to show here.

citeproc/biblatex-localization/finnish.lbx.stringsdeleted−254

This diff is too big to show here.

citeproc/biblatex-localization/french.lbx.stringsdeleted−245

This diff is too big to show here.

citeproc/biblatex-localization/galician.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/german.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/greek.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/hungarian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/icelandic.lbx.stringsdeleted−7

This diff is too big to show here.

citeproc/biblatex-localization/italian.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/latvian.lbx.stringsdeleted−75

This diff is too big to show here.

citeproc/biblatex-localization/lithuanian.lbx.stringsdeleted−31

This diff is too big to show here.

citeproc/biblatex-localization/magyar.lbx.stringsdeleted−29

This diff is too big to show here.

citeproc/biblatex-localization/naustrian.lbx.stringsdeleted−2

This diff is too big to show here.

citeproc/biblatex-localization/newzealand.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/ngerman.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/norsk.lbx.stringsdeleted−98

This diff is too big to show here.

citeproc/biblatex-localization/nswissgerman.lbx.stringsdeleted−2

This diff is too big to show here.

citeproc/biblatex-localization/nynorsk.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/polish.lbx.stringsdeleted−100

This diff is too big to show here.

citeproc/biblatex-localization/portuges.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/portuguese.lbx.stringsdeleted−95

This diff is too big to show here.

citeproc/biblatex-localization/russian.lbx.stringsdeleted−102

This diff is too big to show here.

citeproc/biblatex-localization/serbian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/serbianc.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/slovak.lbx.stringsdeleted−82

This diff is too big to show here.

citeproc/biblatex-localization/slovene.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/slovenian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/spanish.lbx.stringsdeleted−190

This diff is too big to show here.

citeproc/biblatex-localization/swedish.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/swissgerman.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/turkish.lbx.stringsdeleted−157

This diff is too big to show here.

citeproc/biblatex-localization/ukrainian.lbx.stringsdeleted−102

This diff is too big to show here.

data/LaTeXMathML.jsnew file+198

This diff is too big to show here.

data/abbreviations+19−71

This diff is too big to show here.

data/bash_completion.tpl+4−8

This diff is too big to show here.

data/default.csldeleted−658

This diff is too big to show here.

data/default.themenew file+177

This diff is too big to show here.

data/docx/[Content_Types].xml+1−1

This diff is too big to show here.

data/docx/_rels/.rels+1−2

This diff is too big to show here.

data/docx/docProps/core.xml+1−1

This diff is too big to show here.

data/docx/docProps/custom.xmldeleted−2

This diff is too big to show here.

data/docx/word/_rels/document.xml.rels+1−1

This diff is too big to show here.

data/docx/word/_rels/footnotes.xml.rels+1−1

This diff is too big to show here.

data/docx/word/comments.xmldeleted−2

This diff is too big to show here.

data/docx/word/document.xml+2−398

This diff is too big to show here.

data/docx/word/footnotes.xml+26−7

This diff is too big to show here.

data/docx/word/numbering.xml+3−2

This diff is too big to show here.

data/docx/word/settings.xml+15−5

This diff is too big to show here.

data/docx/word/styles.xml+16−27

This diff is too big to show here.

data/epub.css+6−20

This diff is too big to show here.

data/init.luadeleted−3

This diff is too big to show here.

test/command/jats.csl → data/jats.cslrenamed

The content is the same.

data/make-reference-files.hsnew file+27

This diff is too big to show here.

data/odt/styles.xml+12−16

This diff is too big to show here.

data/pandoc.List.luadeleted−142

This diff is too big to show here.

data/pandoc.lua+275−599

This diff is too big to show here.

data/pptx/[Content_Types].xmldeleted−2

This diff is too big to show here.

data/pptx/_rels/.relsdeleted−2

This diff is too big to show here.

data/pptx/docProps/app.xmldeleted−2

This diff is too big to show here.

data/pptx/docProps/core.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/_rels/presentation.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/notesMasters/_rels/notesMaster1.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/notesMasters/notesMaster1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/_rels/notesSlide1.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/_rels/notesSlide2.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/notesSlide1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/notesSlide2.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/presProps.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/presentation.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout1.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout10.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout11.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout2.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout3.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout4.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout5.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout6.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout7.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout8.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/_rels/slideLayout9.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout10.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout11.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout2.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout3.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout4.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout5.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout6.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout7.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout8.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout9.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slideMasters/_rels/slideMaster1.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slideMasters/slideMaster1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide1.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide2.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide3.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide4.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide2.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide3.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide4.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/tableStyles.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/theme/theme1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/theme/theme2.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/viewProps.xmldeleted−2

This diff is too big to show here.

data/sample.lua+32−46

This diff is too big to show here.

data/templates/.github/ISSUE_TEMPLATE.mdnew file+3

This diff is too big to show here.

data/templates/.github/PULL_REQUEST_TEMPLATE.mdnew file+4

This diff is too big to show here.

data/templates/README.markdownnew file+49

This diff is too big to show here.

data/templates/affiliations.jatsdeleted−38

This diff is too big to show here.

data/templates/default.asciidoc+1−4

This diff is too big to show here.

data/templates/default.asciidoctordeleted−41

This diff is too big to show here.

data/templates/default.biblatexdeleted−10

This diff is too big to show here.

data/templates/default.bibtexdeleted−10

This diff is too big to show here.

data/templates/default.context+14−50

This diff is too big to show here.

data/templates/default.docbook4+3−3

This diff is too big to show here.

data/templates/default.docbook5+3−3

This diff is too big to show here.

data/templates/default.dzslides+13−3

This diff is too big to show here.

data/templates/default.epub2+8−8

This diff is too big to show here.

data/templates/default.epub3+11−11

This diff is too big to show here.

data/templates/default.html4+12−7

This diff is too big to show here.

data/templates/default.html5+16−11

This diff is too big to show here.

data/templates/default.icml+2−2

This diff is too big to show here.

data/templates/article.jats_publishing → data/templates/default.jatsrenamed+28−36

This diff is too big to show here.

data/templates/default.jats_archivingdeleted−7

This diff is too big to show here.

data/templates/default.jats_articleauthoringdeleted−93

This diff is too big to show here.

data/templates/default.jats_publishingdeleted−7

This diff is too big to show here.

data/templates/default.jiradeleted−9

This diff is too big to show here.

data/templates/default.latex+134−283

This diff is too big to show here.

data/templates/default.man+3−3

This diff is too big to show here.

data/templates/default.ms+5−15

This diff is too big to show here.

data/templates/default.muse+1−1

This diff is too big to show here.

data/templates/default.opendocument+4−8

This diff is too big to show here.

data/templates/default.org+3−3

This diff is too big to show here.

data/templates/default.revealjs+97−156

This diff is too big to show here.

data/templates/default.rst+8−6

This diff is too big to show here.

data/templates/default.s5+13−5

This diff is too big to show here.

data/templates/default.slideous+12−8

This diff is too big to show here.

data/templates/default.slidy+12−6

This diff is too big to show here.

data/templates/default.tei+4−16

This diff is too big to show here.

data/templates/default.texinfo+22

This diff is too big to show here.

data/templates/default.xwikideleted−13

This diff is too big to show here.

data/templates/styles.htmldeleted−180

This diff is too big to show here.

data/translations/de.yaml−1

This diff is too big to show here.

data/translations/en.yaml+1−1

This diff is too big to show here.

data/translations/fr.yaml+10−10

This diff is too big to show here.

data/translations/ru.yaml+10−9

This diff is too big to show here.

data/translations/uk.yaml+1

This diff is too big to show here.

data/translations/zh-Hans.yamldeleted−22

This diff is too big to show here.

data/translations/zh-Hant.yamldeleted−22

This diff is too big to show here.

data/vimwiki.cssnew file+82

This diff is too big to show here.

default.nixdeleted−13

This diff is too big to show here.

doc/customizing-pandoc.mddeleted−168

This diff is too big to show here.

doc/epub.mddeleted−163

This diff is too big to show here.

doc/faqs.mddeleted−128

This diff is too big to show here.

doc/filters.md+160−203

This diff is too big to show here.

doc/getting-started.mddeleted−318

This diff is too big to show here.

doc/jats.mddeleted−414

This diff is too big to show here.

doc/libraries.mddeleted−63

This diff is too big to show here.

doc/lua-filters.md+592−3057

This diff is too big to show here.

doc/org.mddeleted−379

This diff is too big to show here.

doc/using-the-pandoc-api.md+26−444

This diff is too big to show here.

lib/fonts/Makefilenew file+6

This diff is too big to show here.

lib/fonts/parseUnicodeMapping.hsnew file+40

This diff is too big to show here.

lib/fonts/symbol.txtnew file+256

This diff is too big to show here.

linux/Dockerfilenew file+30

This diff is too big to show here.

linux/Makefilenew file+18

This diff is too big to show here.

linux/control.in+2−2

This diff is too big to show here.

linux/make_artifacts.shdeleted−84

This diff is too big to show here.

linux/make_deb.shnew file+53

This diff is too big to show here.

linux/make_tarball.shnew file+18

This diff is too big to show here.

macos/Makefiledeleted−35

This diff is too big to show here.

macos/make_macos_package.shnew file+73

This diff is too big to show here.

man/capitalizeHeaders.hsnew file+20

This diff is too big to show here.

man/manfilter.luadeleted−22

This diff is too big to show here.

man/pandoc.1+3070−5469

This diff is too big to show here.

man/pandoc.1.afterdeleted−3

This diff is too big to show here.

man/pandoc.1.beforedeleted−2

This diff is too big to show here.

man/pandoc.1.templatenew file+10

This diff is too big to show here.

man/removeLinks.hsnew file+9

This diff is too big to show here.

man/removeNotes.hsnew file+9

This diff is too big to show here.

pandoc.cabal+206−434

This diff is too big to show here.

pandoc.hsnew file+43

This diff is too big to show here.

prelude/Prelude.hs+19−8

This diff is too big to show here.

release.nixdeleted−4

This diff is too big to show here.

shell.nixdeleted−106

This diff is too big to show here.

src/Text/Pandoc.hs+25−2

This diff is too big to show here.

src/Text/Pandoc/App.hs+1524−256

This diff is too big to show here.

src/Text/Pandoc/App/CommandLineOptions.hsdeleted−1092

This diff is too big to show here.

src/Text/Pandoc/App/FormatHeuristics.hsdeleted−90

This diff is too big to show here.

src/Text/Pandoc/App/Opt.hsdeleted−747

This diff is too big to show here.

src/Text/Pandoc/App/OutputSettings.hsdeleted−256

This diff is too big to show here.

src/Text/Pandoc/Asciify.hs+408−14

This diff is too big to show here.

src/Text/Pandoc/BCP47.hsnew file+125

This diff is too big to show here.

src/Text/Pandoc/CSS.hs+24−37

This diff is too big to show here.

src/Text/Pandoc/CSV.hs+35−13

This diff is too big to show here.

src/Text/Pandoc/Citeproc.hsdeleted−661

This diff is too big to show here.

src/Text/Pandoc/Citeproc/BibTeX.hsdeleted−1476

This diff is too big to show here.

src/Text/Pandoc/Citeproc/CslJson.hsdeleted−37

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Data.hsdeleted−32

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Locator.hsdeleted−295

This diff is too big to show here.

src/Text/Pandoc/Citeproc/MetaValue.hsdeleted−255

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Util.hsdeleted−70

This diff is too big to show here.

src/Text/Pandoc/Class.hs+970−14

This diff is too big to show here.

src/Text/Pandoc/Class/CommonState.hsdeleted−83

This diff is too big to show here.

src/Text/Pandoc/Class/IO.hsdeleted−231

This diff is too big to show here.

src/Text/Pandoc/Class/PandocIO.hsdeleted−74

This diff is too big to show here.

src/Text/Pandoc/Class/PandocMonad.hsdeleted−711

This diff is too big to show here.

src/Text/Pandoc/Class/PandocPure.hsdeleted−218

This diff is too big to show here.

src/Text/Pandoc/Compat/Time.hsnew file+30

This diff is too big to show here.

src/Text/Pandoc/Data.hs+1−12

This diff is too big to show here.

src/Text/Pandoc/Emoji.hs+892−10

This diff is too big to show here.

src/Text/Pandoc/Error.hs+82−171

This diff is too big to show here.

src/Text/Pandoc/Extensions.hs+119−373

This diff is too big to show here.

src/Text/Pandoc/Filter.hsdeleted−100

This diff is too big to show here.

src/Text/Pandoc/Filter/JSON.hsdeleted−80

This diff is too big to show here.

src/Text/Pandoc/Filter/Lua.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Filter/Path.hsdeleted−35

This diff is too big to show here.

src/Text/Pandoc/Highlighting.hs+44−37

This diff is too big to show here.

src/Text/Pandoc/Image.hsdeleted−37

This diff is too big to show here.

src/Text/Pandoc/ImageSize.hs+382−160

This diff is too big to show here.

src/Text/Pandoc/Logging.hs+177−254

This diff is too big to show here.

src/Text/Pandoc/Lua.hs+242−15

This diff is too big to show here.

src/Text/Pandoc/Lua/ErrorConversion.hsdeleted−61

This diff is too big to show here.

src/Text/Pandoc/Lua/Filter.hsdeleted−253

This diff is too big to show here.

src/Text/Pandoc/Lua/Global.hsdeleted−89

This diff is too big to show here.

src/Text/Pandoc/Lua/Init.hsdeleted−103

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling.hsdeleted−19

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/AST.hsdeleted−378

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/AnyValue.hsdeleted−24

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/CommonState.hsdeleted−102

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/Context.hsdeleted−28

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/List.hsdeleted−43

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/MediaBag.hsdeleted−73

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/PandocError.hsdeleted−65

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/ReaderOptions.hsdeleted−79

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/SimpleTable.hsdeleted−59

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/Version.hsdeleted−154

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/MediaBag.hsdeleted−103

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Pandoc.hsdeleted−133

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/System.hsdeleted−33

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Types.hsdeleted−68

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Utils.hsdeleted−175

This diff is too big to show here.

src/Text/Pandoc/Lua/Packages.hsdeleted−60

This diff is too big to show here.

src/Text/Pandoc/Lua/PandocLua.hsdeleted−141

This diff is too big to show here.

src/Text/Pandoc/Lua/PandocModule.hsnew file+185

This diff is too big to show here.

src/Text/Pandoc/Lua/StackInstances.hsnew file+309

This diff is too big to show here.

src/Text/Pandoc/Lua/Util.hs+70−106

This diff is too big to show here.

src/Text/Pandoc/Lua/Walk.hsdeleted−158

This diff is too big to show here.

src/Text/Pandoc/MIME.hs+37−56

This diff is too big to show here.

src/Text/Pandoc/MediaBag.hs+32−61

This diff is too big to show here.

src/Text/Pandoc/Options.hs+70−161

This diff is too big to show here.

src/Text/Pandoc/PDF.hs+289−380

This diff is too big to show here.

src/Text/Pandoc/Parsing.hs+511−733

This diff is too big to show here.

src/Text/Pandoc/Pretty.hsnew file+559

This diff is too big to show here.

src/Text/Pandoc/Process.hs+50−64

This diff is too big to show here.

src/Text/Pandoc/Readers.hs+70−104

This diff is too big to show here.

src/Text/Pandoc/Readers/BibTeX.hsdeleted−77

This diff is too big to show here.

src/Text/Pandoc/Readers/CSV.hsdeleted−48

This diff is too big to show here.

src/Text/Pandoc/Readers/CommonMark.hs+219−98

This diff is too big to show here.

src/Text/Pandoc/Readers/Creole.hsdeleted−294

This diff is too big to show here.

src/Text/Pandoc/Readers/CslJson.hsdeleted−54

This diff is too big to show here.

src/Text/Pandoc/Readers/DocBook.hs+271−491

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx.hs+309−443

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Combine.hs+77−110

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Fields.hsdeleted−74

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Lists.hs+77−56

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Parse.hs+416−528

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Parse/Styles.hsdeleted−322

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/StyleMap.hsnew file+108

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Util.hs+19−42

This diff is too big to show here.

src/Text/Pandoc/Readers/DokuWiki.hsdeleted−516

This diff is too big to show here.

src/Text/Pandoc/Readers/EPUB.hs+70−95

This diff is too big to show here.

src/Text/Pandoc/Readers/FB2.hsdeleted−462

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML.hs+708−551

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Parsing.hsdeleted−225

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Table.hsdeleted−283

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/TagCategories.hsdeleted−78

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Types.hsdeleted−97

This diff is too big to show here.

src/Text/Pandoc/Readers/Haddock.hs+42−62

This diff is too big to show here.

src/Text/Pandoc/Readers/Ipynb.hsdeleted−230

This diff is too big to show here.

src/Text/Pandoc/Readers/JATS.hsdeleted−531

This diff is too big to show here.

src/Text/Pandoc/Readers/Jira.hsdeleted−203

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX.hs+2030−650

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Citation.hsdeleted−210

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Inline.hsdeleted−397

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Lang.hsdeleted−234

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Macro.hsdeleted−184

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Math.hsdeleted−221

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Parsing.hsdeleted−1004

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/SIunitx.hsdeleted−434

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Table.hsdeleted−378

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Types.hs+21−19

This diff is too big to show here.

src/Text/Pandoc/Readers/Man.hsdeleted−520

This diff is too big to show here.

src/Text/Pandoc/Readers/Markdown.hs+663−828

This diff is too big to show here.

src/Text/Pandoc/Readers/MediaWiki.hs+165−169

This diff is too big to show here.

src/Text/Pandoc/Readers/Metadata.hsdeleted−200

This diff is too big to show here.

src/Text/Pandoc/Readers/Muse.hs+536−834

This diff is too big to show here.

src/Text/Pandoc/Readers/Native.hs+31−15

This diff is too big to show here.

src/Text/Pandoc/Readers/OPML.hs+45−51

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt.hs+63−47

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Arrows/Utils.hs+32−14

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Base.hs+23−2

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/ContentReader.hs+137−155

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Fallible.hs+25−3

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Namespaces.hs+20−3

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/SetMap.hs+18

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Utils.hs+64−16

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/XMLConverter.hs+55−95

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Namespaces.hs+26−9

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/StyleReader.hs+103−81

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/BlockStarts.hs+42−33

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Blocks.hs+254−352

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/DocumentTree.hs+90−194

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ExportSettings.hs+49−67

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Inlines.hs+153−156

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Meta.hs+152−202

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ParserState.hs+46−64

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Parsing.hs+35−32

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Shared.hs+49−34

This diff is too big to show here.

src/Text/Pandoc/Readers/RST.hs+491−530

This diff is too big to show here.

src/Text/Pandoc/Readers/Roff.hsdeleted−728

This diff is too big to show here.

src/Text/Pandoc/Readers/TWiki.hs+157−119

This diff is too big to show here.

src/Text/Pandoc/Readers/Textile.hs+194−181

This diff is too big to show here.

src/Text/Pandoc/Readers/TikiWiki.hs+119−117

This diff is too big to show here.

src/Text/Pandoc/Readers/Txt2Tags.hs+143−153

This diff is too big to show here.

src/Text/Pandoc/Readers/Vimwiki.hs+183−181

This diff is too big to show here.

src/Text/Pandoc/RoffChar.hsdeleted−421

This diff is too big to show here.

src/Text/Pandoc/SelfContained.hs+97−84

This diff is too big to show here.

src/Text/Pandoc/Shared.hs+339−586

This diff is too big to show here.

src/Text/Pandoc/Slides.hs+25−12

This diff is too big to show here.

src/Text/Pandoc/Sources.hsdeleted−195

This diff is too big to show here.

src/Text/Pandoc/Templates.hs+46−84

This diff is too big to show here.

src/Text/Pandoc/Translations.hs+52−61

This diff is too big to show here.

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

This diff is too big to show here.

src/Text/Pandoc/UUID.hs+32−15

This diff is too big to show here.

src/Text/Pandoc/Writers.hs+39−68

This diff is too big to show here.

src/Text/Pandoc/Writers/AnnotatedTable.hsdeleted−323

This diff is too big to show here.

src/Text/Pandoc/Writers/AsciiDoc.hs+197−316

This diff is too big to show here.

src/Text/Pandoc/Writers/BibTeX.hsdeleted−61

This diff is too big to show here.

src/Text/Pandoc/Writers/CommonMark.hs+273−2

This diff is too big to show here.

src/Text/Pandoc/Writers/ConTeXt.hs+218−298

This diff is too big to show here.

src/Text/Pandoc/Writers/CslJson.hsdeleted−91

This diff is too big to show here.

src/Text/Pandoc/Writers/Custom.hs+142−123

This diff is too big to show here.

src/Text/Pandoc/Writers/Docbook.hs+168−219

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx.hs+708−649

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/StyleMap.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Table.hsdeleted−227

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Types.hsdeleted−185

This diff is too big to show here.

src/Text/Pandoc/Writers/DokuWiki.hs+212−200

This diff is too big to show here.

src/Text/Pandoc/Writers/EPUB.hs+405−583

This diff is too big to show here.

src/Text/Pandoc/Writers/FB2.hs+269−207

This diff is too big to show here.

src/Text/Pandoc/Writers/GridTable.hsdeleted−157

This diff is too big to show here.

src/Text/Pandoc/Writers/HTML.hs+781−989

This diff is too big to show here.

src/Text/Pandoc/Writers/Haddock.hs+152−91

This diff is too big to show here.

src/Text/Pandoc/Writers/ICML.hs+232−282

This diff is too big to show here.

src/Text/Pandoc/Writers/Ipynb.hsdeleted−239

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS.hs+254−390

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/References.hsdeleted−164

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Table.hsdeleted−268

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Types.hsdeleted−57

This diff is too big to show here.

src/Text/Pandoc/Writers/Jira.hsdeleted−339

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX.hs+984−553

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Caption.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Citation.hsdeleted−181

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Lang.hsdeleted−192

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Notes.hsdeleted−34

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Table.hsdeleted−307

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Types.hsdeleted−83

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Util.hsdeleted−275

This diff is too big to show here.

src/Text/Pandoc/Writers/Man.hs+193−116

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown.hs+858−441

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Inline.hsdeleted−616

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Types.hsdeleted−81

This diff is too big to show here.

src/Text/Pandoc/Writers/Math.hs+13−10

This diff is too big to show here.

src/Text/Pandoc/Writers/MediaWiki.hs+136−163

This diff is too big to show here.

src/Text/Pandoc/Writers/Ms.hs+334−306

This diff is too big to show here.

src/Text/Pandoc/Writers/Muse.hs+203−550

This diff is too big to show here.

src/Text/Pandoc/Writers/Native.hs+34−47

This diff is too big to show here.

src/Text/Pandoc/Writers/ODT.hs+82−125

This diff is too big to show here.

src/Text/Pandoc/Writers/OOXML.hsdeleted−99

This diff is too big to show here.

src/Text/Pandoc/Writers/OPML.hs+65−38

This diff is too big to show here.

src/Text/Pandoc/Writers/OpenDocument.hs+252−505

This diff is too big to show here.

src/Text/Pandoc/Writers/Org.hs+172−237

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint.hsdeleted−43

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Output.hsdeleted−1922

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Presentation.hsdeleted−1004

This diff is too big to show here.

src/Text/Pandoc/Writers/RST.hs+233−422

This diff is too big to show here.

src/Text/Pandoc/Writers/RTF.hs+165−146

This diff is too big to show here.

src/Text/Pandoc/Writers/Roff.hsdeleted−125

This diff is too big to show here.

src/Text/Pandoc/Writers/Shared.hs+189−406

This diff is too big to show here.

src/Text/Pandoc/Writers/TEI.hs+135−95

This diff is too big to show here.

src/Text/Pandoc/Writers/Texinfo.hs+145−131

This diff is too big to show here.

src/Text/Pandoc/Writers/Textile.hs+178−170

This diff is too big to show here.

src/Text/Pandoc/Writers/XWiki.hsdeleted−267

This diff is too big to show here.

src/Text/Pandoc/Writers/ZimWiki.hs+177−159

This diff is too big to show here.

src/Text/Pandoc/XML.hs+60−462

This diff is too big to show here.

src/Text/Pandoc/XML/Light.hsdeleted−89

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Output.hsdeleted−234

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Proc.hsdeleted−139

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Types.hsdeleted−193

This diff is too big to show here.

stack.full.yamlnew file+25

This diff is too big to show here.

stack.pkg.yamlnew file+29

This diff is too big to show here.

stack.yaml+12−16

This diff is too big to show here.

test/Tests/Command.hs+48−89

This diff is too big to show here.

test/Tests/Helpers.hs+24−37

This diff is too big to show here.

test/Tests/Lua.hs+32−168

This diff is too big to show here.

test/Tests/Lua/Module.hsdeleted−37

This diff is too big to show here.

test/Tests/Old.hs+203−269

This diff is too big to show here.

test/Tests/Readers/Creole.hsdeleted−298

This diff is too big to show here.

test/Tests/Readers/Docx.hs+26−149

This diff is too big to show here.

test/Tests/Readers/DokuWiki.hsdeleted−321

This diff is too big to show here.

test/Tests/Readers/EPUB.hs+3−49

This diff is too big to show here.

test/Tests/Readers/FB2.hsdeleted−39

This diff is too big to show here.

test/Tests/Readers/HTML.hs+2−75

This diff is too big to show here.

test/Tests/Readers/JATS.hsdeleted−145

This diff is too big to show here.

test/Tests/Readers/Jira.hsdeleted−204

This diff is too big to show here.

test/Tests/Readers/LaTeX.hs+7−112

This diff is too big to show here.

test/Tests/Readers/Man.hsdeleted−144

This diff is too big to show here.

test/Tests/Readers/Markdown.hs+13−79

This diff is too big to show here.

test/Tests/Readers/Muse.hs+128−1064

This diff is too big to show here.

test/Tests/Readers/Odt.hs+4−19

This diff is too big to show here.

test/Tests/Readers/Org.hs+1846−19

This diff is too big to show here.

test/Tests/Readers/Org/Block.hsdeleted−213

This diff is too big to show here.

test/Tests/Readers/Org/Block/CodeBlock.hsdeleted−205

This diff is too big to show here.

test/Tests/Readers/Org/Block/Figure.hsdeleted−75

This diff is too big to show here.

test/Tests/Readers/Org/Block/Header.hsdeleted−272

This diff is too big to show here.

test/Tests/Readers/Org/Block/List.hsdeleted−279

This diff is too big to show here.

test/Tests/Readers/Org/Block/Table.hsdeleted−186

This diff is too big to show here.

test/Tests/Readers/Org/Directive.hsdeleted−359

This diff is too big to show here.

test/Tests/Readers/Org/Inline.hsdeleted−385

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Citation.hsdeleted−230

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Note.hsdeleted−97

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Smart.hsdeleted−57

This diff is too big to show here.

test/Tests/Readers/Org/Meta.hsdeleted−292

This diff is too big to show here.

test/Tests/Readers/Org/Shared.hsdeleted−41

This diff is too big to show here.

test/Tests/Readers/RST.hs+24−48

This diff is too big to show here.

test/Tests/Readers/Txt2Tags.hs+23−54

This diff is too big to show here.

test/Tests/Shared.hs+19−92

This diff is too big to show here.

test/Tests/Writers/AnnotatedTable.hsdeleted−253

This diff is too big to show here.

test/Tests/Writers/AsciiDoc.hs+11−18

This diff is too big to show here.

test/Tests/Writers/ConTeXt.hs+38−129

This diff is too big to show here.

test/Tests/Writers/Docbook.hs+1−104

This diff is too big to show here.

test/Tests/Writers/Docx.hs+126−161

This diff is too big to show here.

test/Tests/Writers/FB2.hsdeleted−34

This diff is too big to show here.

test/Tests/Writers/HTML.hs+13−62

This diff is too big to show here.

test/Tests/Writers/JATS.hsdeleted−164

This diff is too big to show here.

test/Tests/Writers/Jira.hsdeleted−124

This diff is too big to show here.

test/Tests/Writers/LaTeX.hs+2−2

This diff is too big to show here.

test/Tests/Writers/Markdown.hs+27−29

This diff is too big to show here.

test/Tests/Writers/Ms.hsdeleted−35

This diff is too big to show here.

test/Tests/Writers/Muse.hs+123−423

This diff is too big to show here.

test/Tests/Writers/Native.hs+2−2

This diff is too big to show here.

test/Tests/Writers/OOXML.hsdeleted−187

This diff is too big to show here.

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

This diff is too big to show here.

test/Tests/Writers/Plain.hs+1−3

This diff is too big to show here.

test/Tests/Writers/Powerpoint.hsdeleted−132

This diff is too big to show here.

test/Tests/Writers/RST.hs+10−81

This diff is too big to show here.

test/Tests/Writers/TEI.hs+1−1

This diff is too big to show here.

test/command/01.csvdeleted−4

This diff is too big to show here.

test/command/1126.mddeleted−28

This diff is too big to show here.

test/command/1279.md+1−1

This diff is too big to show here.

test/command/1592.md−21

This diff is too big to show here.

test/command/1608.mddeleted−41

This diff is too big to show here.

test/command/168.mddeleted−43

This diff is too big to show here.

test/command/1710.md+14−8

This diff is too big to show here.

test/command/1718.md+1−1

This diff is too big to show here.

test/command/1762.mddeleted−18

This diff is too big to show here.

test/command/1881.md+18−50

This diff is too big to show here.

test/command/2103.mddeleted−8

This diff is too big to show here.

test/command/2118.md+1−1

This diff is too big to show here.

test/command/2378.md+3−3

This diff is too big to show here.

test/command/2649.md+15−14

This diff is too big to show here.

test/command/2662.md+1−1

This diff is too big to show here.

test/command/2874.md+2−2

This diff is too big to show here.

test/command/3123.mddeleted−13

This diff is too big to show here.

test/command/3324.mddeleted−18

This diff is too big to show here.

test/command/3348.md+7−20

This diff is too big to show here.

test/command/3407.md+2−2

This diff is too big to show here.

test/command/3432.md+1−1

This diff is too big to show here.

test/command/3450.md+2−2

This diff is too big to show here.

test/command/3494.md+2−1

This diff is too big to show here.

test/command/3516.md+14−44

This diff is too big to show here.

test/command/3523.mddeleted−31

This diff is too big to show here.

test/command/3530.md+5−2

This diff is too big to show here.

test/command/3531.md+1

This diff is too big to show here.

test/command/3533-rst-csv-tables.md+25−77

This diff is too big to show here.

test/command/3534.md−22

This diff is too big to show here.

test/command/3558.md+2−2

This diff is too big to show here.

test/command/3568.md+3−4

This diff is too big to show here.

test/command/3577.md+5−3

This diff is too big to show here.

test/command/3587.md+2−128

This diff is too big to show here.

test/command/3596.md+4−2

This diff is too big to show here.

test/command/3674.md+1−1

This diff is too big to show here.

test/command/3675.md+2−2

This diff is too big to show here.

test/command/3706.md+17−38

This diff is too big to show here.

test/command/3708.md+7−20

This diff is too big to show here.

test/command/3716.md+1−1

This diff is too big to show here.

test/command/3734.md+22−4

This diff is too big to show here.

test/command/3736.md+6−3

This diff is too big to show here.

test/command/3752.mddeleted−60

This diff is too big to show here.

test/command/3792.md+1−1

This diff is too big to show here.

test/command/3804.md+1−1

This diff is too big to show here.

test/command/3824.md+1−1

This diff is too big to show here.

test/command/3937.md+1−1

This diff is too big to show here.

test/command/3947.md+1−1

This diff is too big to show here.

test/command/3968.md+2−3

This diff is too big to show here.

test/command/3983.md+3−3

This diff is too big to show here.

test/command/3989.mddeleted−7

This diff is too big to show here.

test/command/4007.mddeleted−23

This diff is too big to show here.

test/command/4012.mddeleted−8

This diff is too big to show here.

test/command/4016.mddeleted−42

This diff is too big to show here.

test/command/4019.mddeleted−8

This diff is too big to show here.

test/command/4038.mddeleted−6

This diff is too big to show here.

test/command/4054.mddeleted−14

This diff is too big to show here.

test/command/4056.mddeleted−35

This diff is too big to show here.

test/command/4061.mddeleted−14

This diff is too big to show here.

test/command/4062.mddeleted−6

This diff is too big to show here.

test/command/4063.mddeleted−29

This diff is too big to show here.

test/command/4068.mddeleted−9

This diff is too big to show here.

test/command/4091.mddeleted−6

This diff is too big to show here.

test/command/4113.mddeleted−12

This diff is too big to show here.

test/command/4119.mddeleted−32

This diff is too big to show here.

test/command/4125.mddeleted−6

This diff is too big to show here.

test/command/4134.mddeleted−25

This diff is too big to show here.

test/command/4156.mddeleted−10

This diff is too big to show here.

test/command/4159.mddeleted−8

This diff is too big to show here.

test/command/4162.mddeleted−10

This diff is too big to show here.

test/command/4164.mddeleted−31

This diff is too big to show here.

test/command/4171.mddeleted−34

This diff is too big to show here.

test/command/4172.mddeleted−29

This diff is too big to show here.

test/command/4183.mddeleted−32

This diff is too big to show here.

test/command/4186.mddeleted−60

This diff is too big to show here.

test/command/4193.mddeleted−10

This diff is too big to show here.

test/command/4199.mddeleted−6

This diff is too big to show here.

test/command/4208.mddeleted−18

This diff is too big to show here.

test/command/4235.mddeleted−12

This diff is too big to show here.

test/command/4240.mddeleted−33

This diff is too big to show here.

test/command/4253.mddeleted−8

This diff is too big to show here.

test/command/4254.mddeleted−12

This diff is too big to show here.

test/command/4280.mddeleted−7

This diff is too big to show here.

test/command/4281.mddeleted−18

This diff is too big to show here.

test/command/4284.mddeleted−40

This diff is too big to show here.

test/command/4306.mddeleted−10

This diff is too big to show here.

test/command/4320.mddeleted−29

This diff is too big to show here.

test/command/4374.mddeleted−7

This diff is too big to show here.

test/command/4382.mddeleted−10

This diff is too big to show here.

test/command/4420.mddeleted−11

This diff is too big to show here.

test/command/4424.mddeleted−10

This diff is too big to show here.

test/command/4442.mddeleted−9

This diff is too big to show here.

test/command/4454.mddeleted−9

This diff is too big to show here.

test/command/4465.mddeleted−15

This diff is too big to show here.

test/command/4499.mddeleted−87

This diff is too big to show here.

test/command/4513.mddeleted−20

This diff is too big to show here.

test/command/4527.mddeleted−36

This diff is too big to show here.

test/command/4528.mddeleted−156

This diff is too big to show here.

test/command/4529.mddeleted−36

This diff is too big to show here.

test/command/4545.mddeleted−20

This diff is too big to show here.

test/command/4550.mddeleted−7

This diff is too big to show here.

test/command/4553.mddeleted−15

This diff is too big to show here.

test/command/4576.mddeleted−6

This diff is too big to show here.

test/command/4578.mddeleted−14

This diff is too big to show here.

test/command/4579.mddeleted−30

This diff is too big to show here.

test/command/4589.mddeleted−14

This diff is too big to show here.

test/command/4594.mddeleted−24

This diff is too big to show here.

test/command/4598.mddeleted−10

This diff is too big to show here.

test/command/4624.mddeleted−30

This diff is too big to show here.

test/command/4635.mddeleted−31

This diff is too big to show here.

test/command/4637.mddeleted−6

This diff is too big to show here.

test/command/4639.mddeleted−10

This diff is too big to show here.

test/command/4653.mddeleted−8

This diff is too big to show here.

test/command/4667.mddeleted−20

This diff is too big to show here.

test/command/4669.mddeleted−29

This diff is too big to show here.

test/command/4677.mddeleted−8

This diff is too big to show here.

test/command/4690.mddeleted−26

This diff is too big to show here.

test/command/4715.mddeleted−16

This diff is too big to show here.

test/command/4722.mddeleted−34

This diff is too big to show here.

test/command/4742.mddeleted−29

This diff is too big to show here.

test/command/4743.mddeleted−25

This diff is too big to show here.

test/command/4748.mddeleted−16

This diff is too big to show here.

test/command/4768.mddeleted−7

This diff is too big to show here.

test/command/4781.mddeleted−22

This diff is too big to show here.

test/command/4794.mddeleted−17

This diff is too big to show here.

test/command/4805-beamer-columns-alignment.mddeleted−40

This diff is too big to show here.

test/command/4811.mddeleted−48

This diff is too big to show here.

test/command/4817.mddeleted−10

This diff is too big to show here.

test/command/4819.mddeleted−50

This diff is too big to show here.

test/command/4832.mddeleted−21

This diff is too big to show here.

test/command/4833.mddeleted−20

This diff is too big to show here.

test/command/4842.mddeleted−6

This diff is too big to show here.

test/command/4845.mddeleted−6

This diff is too big to show here.

test/command/4848.mddeleted−59

This diff is too big to show here.

test/command/4860.mddeleted−9

This diff is too big to show here.

test/command/4877.mddeleted−13

This diff is too big to show here.

test/command/4880.mddeleted−7

This diff is too big to show here.

test/command/4885.mddeleted−8

This diff is too big to show here.

test/command/4908.mddeleted−16

This diff is too big to show here.

test/command/4913.mddeleted−34

This diff is too big to show here.

test/command/4919.mddeleted−14

This diff is too big to show here.

test/command/4928.mddeleted−48

This diff is too big to show here.

test/command/4933.mddeleted−6

This diff is too big to show here.

test/command/4960.mddeleted−22

This diff is too big to show here.

test/command/5010.mddeleted−21

This diff is too big to show here.

test/command/5014.mddeleted−30

This diff is too big to show here.

test/command/5039.mddeleted−27

This diff is too big to show here.

test/command/5050.mddeleted−7

This diff is too big to show here.

test/command/5053.mddeleted−14

This diff is too big to show here.

test/command/5072.mddeleted−14

This diff is too big to show here.

test/command/5079.mddeleted−25

This diff is too big to show here.

test/command/5080.mddeleted−13

This diff is too big to show here.

test/command/5099.mddeleted−13

This diff is too big to show here.

test/command/5107.mddeleted−23

This diff is too big to show here.

test/command/5119.mddeleted−9

This diff is too big to show here.

test/command/512.md+1−1

This diff is too big to show here.

test/command/5121.mddeleted−12

This diff is too big to show here.

test/command/5128.mddeleted−26

This diff is too big to show here.

test/command/5177.mddeleted−12

This diff is too big to show here.

test/command/5178.mddeleted−41

This diff is too big to show here.

test/command/5182.mddeleted−6

This diff is too big to show here.

test/command/5182.txtdeleted−5

This diff is too big to show here.

test/command/5195.mddeleted−7

This diff is too big to show here.

test/command/5233.mddeleted−9

This diff is too big to show here.

test/command/5241.mddeleted−12

This diff is too big to show here.

test/command/5271.mddeleted−12

This diff is too big to show here.

test/command/5285.mddeleted−32

This diff is too big to show here.

test/command/5304.mddeleted−24

This diff is too big to show here.

test/command/5321.mddeleted−24

This diff is too big to show here.

test/command/5340.mddeleted−14

This diff is too big to show here.

test/command/5360.mddeleted−19

This diff is too big to show here.

test/command/5367.mddeleted−43

This diff is too big to show here.

test/command/5368.mddeleted−23

This diff is too big to show here.

test/command/5369.mddeleted−7

This diff is too big to show here.

test/command/5407.mddeleted−14

This diff is too big to show here.

test/command/5410.mddeleted−7

This diff is too big to show here.

test/command/5416.mddeleted−13

This diff is too big to show here.

test/command/5420.mddeleted−6

This diff is too big to show here.

test/command/5439.mddeleted−6

This diff is too big to show here.

test/command/5446.mddeleted−6

This diff is too big to show here.

test/command/5474-figures.mddeleted−15

This diff is too big to show here.

test/command/5474-tables.mddeleted−63

This diff is too big to show here.

test/command/5476.mddeleted−12

This diff is too big to show here.

test/command/5495.mddeleted−18

This diff is too big to show here.

test/command/5519.mddeleted−14

This diff is too big to show here.

test/command/5529.mddeleted−10

This diff is too big to show here.

test/command/5540.mddeleted−8

This diff is too big to show here.

test/command/5541-localLink.mddeleted−149

This diff is too big to show here.

test/command/5541-nesting.mddeleted−98

This diff is too big to show here.

test/command/5541-urlLink.mddeleted−112

This diff is too big to show here.

test/command/5543.mddeleted−8

This diff is too big to show here.

test/command/5549.mddeleted−9

This diff is too big to show here.

test/command/5565.mddeleted−6

This diff is too big to show here.

test/command/5566.mddeleted−6

This diff is too big to show here.

test/command/5574.mddeleted−8

This diff is too big to show here.

test/command/5619.mddeleted−10

This diff is too big to show here.

test/command/5620.mddeleted−9

This diff is too big to show here.

test/command/5627.mddeleted−83

This diff is too big to show here.

test/command/5635.mddeleted−23

This diff is too big to show here.

test/command/5642.mddeleted−8

This diff is too big to show here.

test/command/5650.mddeleted−22

This diff is too big to show here.

test/command/5654.mddeleted−6

This diff is too big to show here.

test/command/5655.mddeleted−14

This diff is too big to show here.

test/command/5682.mddeleted−8

This diff is too big to show here.

test/command/5684.mddeleted−6

This diff is too big to show here.

test/command/5686.mddeleted−9

This diff is too big to show here.

test/command/5690.mddeleted−16

This diff is too big to show here.

test/command/5700-metadata-file-1.ymldeleted−1

This diff is too big to show here.

test/command/5700-metadata-file-2.ymldeleted−2

This diff is too big to show here.

test/command/5700.mddeleted−6

This diff is too big to show here.

test/command/5705.mddeleted−11

This diff is too big to show here.

test/command/5708.mddeleted−22

This diff is too big to show here.

test/command/5711.mddeleted−22

This diff is too big to show here.

test/command/5714.mddeleted−13

This diff is too big to show here.

test/command/5740.mddeleted−9

This diff is too big to show here.

test/command/5753.mddeleted−15

This diff is too big to show here.

test/command/5795.mddeleted−20

This diff is too big to show here.

test/command/5797.mddeleted−20

This diff is too big to show here.

test/command/5805.mddeleted−20

This diff is too big to show here.

test/command/5813.mddeleted−6

This diff is too big to show here.

test/command/5819.mddeleted−18

This diff is too big to show here.

test/command/5836.mddeleted−27

This diff is too big to show here.

test/command/5845.mddeleted−16

This diff is too big to show here.

test/command/5846.mddeleted−170

This diff is too big to show here.

test/command/5849-prefix.mddeleted−31

This diff is too big to show here.

test/command/5857.mddeleted−11

This diff is too big to show here.

test/command/5878.mddeleted−7

This diff is too big to show here.

test/command/5881.mddeleted−14

This diff is too big to show here.

test/command/5885.mddeleted−20

This diff is too big to show here.

test/command/5898.mddeleted−36

This diff is too big to show here.

test/command/5899.mddeleted−51

This diff is too big to show here.

test/command/5904.mddeleted−10

This diff is too big to show here.

test/command/5918.mddeleted−6

This diff is too big to show here.

test/command/5936.mddeleted−40

This diff is too big to show here.

test/command/5967.mddeleted−15

This diff is too big to show here.

test/command/5986.mddeleted−17

This diff is too big to show here.

test/command/6009.mddeleted−18

This diff is too big to show here.

test/command/6026.mddeleted−19

This diff is too big to show here.

test/command/6030.mddeleted−96

This diff is too big to show here.

test/command/6033.mddeleted−91

This diff is too big to show here.

test/command/6034.mddeleted−11

This diff is too big to show here.

test/command/6043.mddeleted−8

This diff is too big to show here.

test/command/6062.mddeleted−6

This diff is too big to show here.

test/command/6107.mddeleted−27

This diff is too big to show here.

test/command/6114.mddeleted−7

This diff is too big to show here.

test/command/6119.mddeleted−10

This diff is too big to show here.

test/command/6133.mddeleted−12

This diff is too big to show here.

test/command/6137.mddeleted−47

This diff is too big to show here.

test/command/6194.mddeleted−14

This diff is too big to show here.

test/command/6265.mddeleted−6

This diff is too big to show here.

test/command/6288.mddeleted−8

This diff is too big to show here.

test/command/6296.mddeleted−14

This diff is too big to show here.

test/command/6308.mddeleted−18

This diff is too big to show here.

test/command/6324.mddeleted−17

This diff is too big to show here.

test/command/6360.mddeleted−6

This diff is too big to show here.

test/command/6385.mddeleted−18

This diff is too big to show here.

test/command/6388.mddeleted−16

This diff is too big to show here.

test/command/6481.mddeleted−38

This diff is too big to show here.

test/command/6541.mddeleted−27

This diff is too big to show here.

test/command/6549.mddeleted−26

This diff is too big to show here.

test/command/6620.mddeleted−18

This diff is too big to show here.

test/command/6658.mddeleted−75

This diff is too big to show here.

test/command/6675.mddeleted−134

This diff is too big to show here.

test/command/6699.mddeleted−13

This diff is too big to show here.

test/command/6709.mddeleted−11

This diff is too big to show here.

test/command/6719.mddeleted−18

This diff is too big to show here.

test/command/6723.mddeleted−32

This diff is too big to show here.

test/command/6739.mddeleted−21

This diff is too big to show here.

test/command/6740.mddeleted−7

This diff is too big to show here.

test/command/6741.mddeleted−145

This diff is too big to show here.

test/command/6752.mddeleted−36

This diff is too big to show here.

test/command/6755.mddeleted−11

This diff is too big to show here.

test/command/6765.mddeleted−31

This diff is too big to show here.

test/command/6768.mddeleted−21

This diff is too big to show here.

test/command/6774.mddeleted−63

This diff is too big to show here.

test/command/6783.mddeleted−26

This diff is too big to show here.

test/command/6791.mddeleted−32

This diff is too big to show here.

test/command/6792.mddeleted−66

This diff is too big to show here.

test/command/6796.mddeleted−16

This diff is too big to show here.

test/command/6802.mddeleted−9

This diff is too big to show here.

test/command/6836.mddeleted−17

This diff is too big to show here.

test/command/6837.mddeleted−29

This diff is too big to show here.

test/command/6844.mddeleted−27

This diff is too big to show here.

test/command/6855.mddeleted−12

This diff is too big to show here.

test/command/6858.mddeleted−52

This diff is too big to show here.

test/command/6869.mddeleted−6

This diff is too big to show here.

test/command/6873.mddeleted−7

This diff is too big to show here.

test/command/6890.mddeleted−36

This diff is too big to show here.

test/command/6925.mddeleted−34

This diff is too big to show here.

test/command/6948.mddeleted−31

This diff is too big to show here.

test/command/6951.mddeleted−18

This diff is too big to show here.

test/command/6958.mddeleted−10

This diff is too big to show here.

test/command/6993.mddeleted−21

This diff is too big to show here.

test/command/7003.mddeleted−37

This diff is too big to show here.

test/command/7006.mddeleted−20

This diff is too big to show here.

test/command/7009.mddeleted−8

This diff is too big to show here.

test/command/7016.mddeleted−48

This diff is too big to show here.

test/command/7041.mddeleted−23

This diff is too big to show here.

test/command/7042.mddeleted−146

This diff is too big to show here.

test/command/7058.mddeleted−6

This diff is too big to show here.

test/command/7064.mddeleted−32

This diff is too big to show here.

test/command/7067.mddeleted−90

This diff is too big to show here.

test/command/7080.mddeleted−8

This diff is too big to show here.

test/command/7092.mddeleted−8

This diff is too big to show here.

test/command/7099.mddeleted−18

This diff is too big to show here.

test/command/7112.mddeleted−15

This diff is too big to show here.

test/command/7129.mddeleted−27

This diff is too big to show here.

test/command/7132.mddeleted−10

This diff is too big to show here.

test/command/7134.mddeleted−16

This diff is too big to show here.

test/command/7145.mddeleted−12

This diff is too big to show here.

test/command/7155.mddeleted−15

This diff is too big to show here.

test/command/7173.mddeleted−137

This diff is too big to show here.

test/command/7208.mddeleted−6

This diff is too big to show here.

test/command/7214.mddeleted−28

This diff is too big to show here.

test/command/7216.mddeleted−19

This diff is too big to show here.

test/command/7266.mddeleted−10

This diff is too big to show here.

test/command/7272.mddeleted−27

This diff is too big to show here.

test/command/7278.mddeleted−38

This diff is too big to show here.

test/command/7282.mddeleted−7

This diff is too big to show here.

test/command/7288.mddeleted−40

This diff is too big to show here.

test/command/7299.mddeleted−23

This diff is too big to show here.

test/command/7321.mddeleted−24

This diff is too big to show here.

test/command/7323.mddeleted−29

This diff is too big to show here.

test/command/7324.mddeleted−25

This diff is too big to show here.

test/command/7339.mddeleted−11

This diff is too big to show here.

test/command/7340.mddeleted−6

This diff is too big to show here.

test/command/7376.mddeleted−16

This diff is too big to show here.

test/command/7394.mddeleted−85

This diff is too big to show here.

test/command/7397.mddeleted−14

This diff is too big to show here.

test/command/7400.mddeleted−9

This diff is too big to show here.

test/command/7416.mddeleted−19

This diff is too big to show here.

test/command/A.txtdeleted−1

This diff is too big to show here.

test/command/B.txtdeleted−1

This diff is too big to show here.

test/command/C.txtdeleted−1

This diff is too big to show here.

test/command/D.txtdeleted−1

This diff is too big to show here.

test/command/adjacent_latex_blocks.mddeleted−9

This diff is too big to show here.

test/command/advanced-optical-materials.csldeleted−155

This diff is too big to show here.

test/command/annales.csldeleted−334

This diff is too big to show here.

test/command/apa.csldeleted−474

This diff is too big to show here.

test/command/archeologie-medievale.csldeleted−291

This diff is too big to show here.

test/command/ascii.mddeleted−89

This diff is too big to show here.

test/command/averroes.bibdeleted−95

This diff is too big to show here.

test/command/bar.texdeleted−1

This diff is too big to show here.

test/command/biblatex-266.mddeleted−34

This diff is too big to show here.

test/command/biblatex-aksin.mddeleted−78

This diff is too big to show here.

test/command/biblatex-almendro.mddeleted−71

This diff is too big to show here.

test/command/biblatex-angenendt.mddeleted−66

This diff is too big to show here.

test/command/biblatex-aristotle-anima.mddeleted−62

This diff is too big to show here.

test/command/biblatex-aristotle-physics.mddeleted−63

This diff is too big to show here.

test/command/biblatex-aristotle-poetics.mddeleted−65

This diff is too big to show here.

test/command/biblatex-aristotle-rhetoric.mddeleted−80

This diff is too big to show here.

test/command/biblatex-article.mddeleted−128

This diff is too big to show here.

test/command/biblatex-augustine.mddeleted−56

This diff is too big to show here.

test/command/biblatex-averroes-bland.mddeleted−85

This diff is too big to show here.

test/command/biblatex-averroes-hannes.mddeleted−84

This diff is too big to show here.

test/command/biblatex-averroes-hercz.mddeleted−85

This diff is too big to show here.

test/command/biblatex-baez-article.mddeleted−76

This diff is too big to show here.

test/command/biblatex-baez-online.mddeleted−69

This diff is too big to show here.

test/command/biblatex-basic.mddeleted−71

This diff is too big to show here.

test/command/biblatex-bertram.mddeleted−66

This diff is too big to show here.

test/command/biblatex-bibstring-resolution.mddeleted−20

This diff is too big to show here.

test/command/biblatex-book-averroes.mddeleted−129

This diff is too big to show here.

test/command/biblatex-book-coleridge.mddeleted−59

This diff is too big to show here.

test/command/biblatex-book-title-maintitle-series.mddeleted−39

This diff is too big to show here.

test/command/biblatex-book-vazques-de-parga.mddeleted−48

This diff is too big to show here.

test/command/biblatex-brandt.mddeleted−88

This diff is too big to show here.

test/command/biblatex-britannica.mddeleted−85

This diff is too big to show here.

test/command/biblatex-chiu.mddeleted−77

This diff is too big to show here.

test/command/biblatex-cicero.mddeleted−82

This diff is too big to show here.

test/command/biblatex-cms.mddeleted−81

This diff is too big to show here.

test/command/biblatex-coleridge.mddeleted−86

This diff is too big to show here.

test/command/biblatex-companion.mddeleted−70

This diff is too big to show here.

test/command/biblatex-cotton.mddeleted−69

This diff is too big to show here.

test/command/biblatex-crossref-inbook-mvbook.mddeleted−58

This diff is too big to show here.

test/command/biblatex-crossref-nested.mddeleted−100

This diff is too big to show here.

test/command/biblatex-ctan.mddeleted−73

This diff is too big to show here.

test/command/biblatex-dates.mddeleted−162

This diff is too big to show here.

test/command/biblatex-doody.mddeleted−101

This diff is too big to show here.

test/command/biblatex-edtf-date.mddeleted−72

This diff is too big to show here.

test/command/biblatex-escapedquotes.mddeleted−51

This diff is too big to show here.

test/command/biblatex-formatting.mddeleted−23

This diff is too big to show here.

test/command/biblatex-gaonkar-in.mddeleted−62

This diff is too big to show here.

test/command/biblatex-gaonkar.mddeleted−59

This diff is too big to show here.

test/command/biblatex-geer.mddeleted−70

This diff is too big to show here.

test/command/biblatex-gerhardt.mddeleted−64

This diff is too big to show here.

test/command/biblatex-gillies.mddeleted−69

This diff is too big to show here.

test/command/biblatex-glashow.mddeleted−51

This diff is too big to show here.

test/command/biblatex-gonzalez.mddeleted−62

This diff is too big to show here.

test/command/biblatex-hammond.mddeleted−63

This diff is too big to show here.

test/command/biblatex-herrmann.mddeleted−70

This diff is too big to show here.

test/command/biblatex-hyman.mddeleted−79

This diff is too big to show here.

test/command/biblatex-iliad.mddeleted−68

This diff is too big to show here.

test/command/biblatex-inbook-title-booktitle-maintitle-series-2.mddeleted−48

This diff is too big to show here.

test/command/biblatex-inbook-title-booktitle-maintitle-series.mddeleted−44

This diff is too big to show here.

test/command/biblatex-inbook.mddeleted−147

This diff is too big to show here.

test/command/biblatex-incollection-2.mddeleted−98

This diff is too big to show here.

test/command/biblatex-incollection.mddeleted−130

This diff is too big to show here.

test/command/biblatex-inproceedings.mddeleted−88

This diff is too big to show here.

test/command/biblatex-issue288.mddeleted−35

This diff is too big to show here.

test/command/biblatex-itzhaki.mddeleted−82

This diff is too big to show here.

test/command/biblatex-jaffe.mddeleted−82

This diff is too big to show here.

test/command/biblatex-jcg.mddeleted−54

This diff is too big to show here.

test/command/biblatex-kant-kpv.mddeleted−90

This diff is too big to show here.

test/command/biblatex-kant-ku.mddeleted−82

This diff is too big to show here.

test/command/biblatex-kastenholz.mddeleted−126

This diff is too big to show here.

test/command/biblatex-knuth-ct-a.mddeleted−78

This diff is too big to show here.

test/command/biblatex-knuth-ct-b.mddeleted−70

This diff is too big to show here.

test/command/biblatex-knuth-ct-c.mddeleted−69

This diff is too big to show here.

test/command/biblatex-knuth-ct-d.mddeleted−71

This diff is too big to show here.

test/command/biblatex-knuth-ct-e.mddeleted−66

This diff is too big to show here.

test/command/biblatex-knuth-ct-related.mddeleted−72

This diff is too big to show here.

test/command/biblatex-knuth-ct.mddeleted−66

This diff is too big to show here.

test/command/biblatex-kowalik.mddeleted−68

This diff is too big to show here.

test/command/biblatex-kullback-related.mddeleted−62

This diff is too big to show here.

test/command/biblatex-kullback-reprint.mddeleted−71

This diff is too big to show here.

test/command/biblatex-kullback.mddeleted−52

This diff is too big to show here.

test/command/biblatex-laufenberg.mddeleted−109

This diff is too big to show here.

test/command/biblatex-loh.mddeleted−65

This diff is too big to show here.

test/command/biblatex-malinowski.mddeleted−67

This diff is too big to show here.

test/command/biblatex-manual.mddeleted−51

This diff is too big to show here.

test/command/biblatex-markey.mddeleted−65

This diff is too big to show here.

test/command/biblatex-maron.mddeleted−70

This diff is too big to show here.

test/command/biblatex-massa.mddeleted−56

This diff is too big to show here.

test/command/biblatex-moore-related.mddeleted−66

This diff is too big to show here.

test/command/biblatex-moore.mddeleted−56

This diff is too big to show here.

test/command/biblatex-moraux.mddeleted−94

This diff is too big to show here.

test/command/biblatex-murray.mddeleted−105

This diff is too big to show here.

test/command/biblatex-nietzsche-historie.mddeleted−100

This diff is too big to show here.

test/command/biblatex-nietzsche-ksa.mddeleted−89

This diff is too big to show here.

test/command/biblatex-nietzsche-ksa1.mddeleted−95

This diff is too big to show here.

test/command/biblatex-online.mddeleted−64

This diff is too big to show here.

test/command/biblatex-options-url-false-doi-false.mddeleted−57

This diff is too big to show here.

test/command/biblatex-padhye.mddeleted−117

This diff is too big to show here.

test/command/biblatex-patent.mddeleted−158

This diff is too big to show here.

test/command/biblatex-periodical.mddeleted−31

This diff is too big to show here.

test/command/biblatex-piccato.mddeleted−59

This diff is too big to show here.

test/command/biblatex-pines.mddeleted−77

This diff is too big to show here.

test/command/biblatex-quotes.mddeleted−44

This diff is too big to show here.

test/command/biblatex-reese.mddeleted−71

This diff is too big to show here.

test/command/biblatex-report.mddeleted−119

This diff is too big to show here.

test/command/biblatex-salam.mddeleted−69

This diff is too big to show here.

test/command/biblatex-sarfraz.mddeleted−65

This diff is too big to show here.

test/command/biblatex-shore.mddeleted−66

This diff is too big to show here.

test/command/biblatex-sigfridsson.mddeleted−106

This diff is too big to show here.

test/command/biblatex-sorace.mddeleted−65

This diff is too big to show here.

test/command/biblatex-spiegelberg.mddeleted−74

This diff is too big to show here.

test/command/biblatex-springer.mddeleted−58

This diff is too big to show here.

test/command/biblatex-strings.mddeleted−46

This diff is too big to show here.

test/command/biblatex-test-case-conversion.mddeleted−73

This diff is too big to show here.

test/command/biblatex-textnormal.mddeleted−17

This diff is too big to show here.

test/command/biblatex-thesis.mddeleted−68

This diff is too big to show here.

test/command/biblatex-title-and-shorttitle.mddeleted−76

This diff is too big to show here.

test/command/biblatex-vangennep-related.mddeleted−69

This diff is too big to show here.

test/command/biblatex-vangennep-trans.mddeleted−69

This diff is too big to show here.

test/command/biblatex-vangennep.mddeleted−61

This diff is too big to show here.

test/command/biblatex-vazques-de-parga-mvbook.mddeleted−75

This diff is too big to show here.

test/command/biblatex-vazques-de-parga.mddeleted−74

This diff is too big to show here.

test/command/biblatex-video.mddeleted−19

This diff is too big to show here.

test/command/biblatex-vizedom-related.mddeleted−68

This diff is too big to show here.

test/command/biblatex-wassenberg.mddeleted−83

This diff is too big to show here.

test/command/biblatex-weinberg.mddeleted−52

This diff is too big to show here.

test/command/biblatex-westfahl-frontier.mddeleted−60

This diff is too big to show here.

test/command/biblatex-westfahl-space.mddeleted−106

This diff is too big to show here.

test/command/biblatex-wilde.mddeleted−65

This diff is too big to show here.

test/command/biblatex-worman.mddeleted−60

This diff is too big to show here.

test/command/biblatex-yoon.mddeleted−67

This diff is too big to show here.

test/command/biblio.bibdeleted−26

This diff is too big to show here.

test/command/bibtex-basic.mddeleted−71

This diff is too big to show here.

test/command/bioethics.csldeleted−226

This diff is too big to show here.

test/command/chap1/spider.pngdeleted

Binary file not shown.

test/command/chap1/text.mddeleted−17

This diff is too big to show here.

test/command/chap2/spider.pngdeleted

Binary file not shown.

test/command/chap2/text.mddeleted−5

This diff is too big to show here.

test/command/chicago-annotated-bibliography.csldeleted−1207

This diff is too big to show here.

test/command/chicago-author-date-with-original-date-and-status.csldeleted−575

This diff is too big to show here.

test/command/chicago-fullnote-bibliography.csldeleted−1430

This diff is too big to show here.

test/command/chicago-note-bibliography.csldeleted−1005

This diff is too big to show here.

test/command/chinese-gb7714-2005-numeric.csldeleted−213

This diff is too big to show here.

test/command/cite-in-inline-note.mddeleted−6

This diff is too big to show here.

test/command/citeproc-17.mddeleted−17

This diff is too big to show here.

test/command/citeproc-20.mddeleted−25

This diff is too big to show here.

test/command/citeproc-7a.mddeleted−42

This diff is too big to show here.

test/command/citeproc-7b.mddeleted−36

This diff is too big to show here.

test/command/citeproc-author-in-text-suffix.mddeleted−6

This diff is too big to show here.

test/command/csv.mddeleted−46

This diff is too big to show here.

test/command/custom-attributes.htmlnew file+16

This diff is too big to show here.

test/command/defaults-inheritance-1.mddeleted−6

This diff is too big to show here.

test/command/defaults-inheritance-2.mddeleted−5

This diff is too big to show here.

test/command/defaults-inheritance-3.mddeleted−6

This diff is too big to show here.

test/command/defaults1.yamldeleted−1

This diff is too big to show here.

test/command/defaults2.yamldeleted−4

This diff is too big to show here.

test/command/defaults3.yamldeleted−4

This diff is too big to show here.

test/command/defaults4.yamldeleted−3

This diff is too big to show here.

test/command/defaults5.yamldeleted−2

This diff is too big to show here.

test/command/defaults6.yamldeleted−2

This diff is too big to show here.

test/command/defaults7.yamldeleted−2

This diff is too big to show here.

test/command/defaults8.yamldeleted−2

This diff is too big to show here.

test/command/defaults9.yamldeleted−1

This diff is too big to show here.

test/command/din-1505-2.csldeleted−406

This diff is too big to show here.

test/command/docbook-bibliography.mddeleted−20

This diff is too big to show here.

test/command/duplicate_attributes.mddeleted−7

This diff is too big to show here.

test/command/emoji.mddeleted−27

This diff is too big to show here.

test/command/empty_paragraphs.mddeleted−93

This diff is too big to show here.

test/command/gfm.md+17−80

This diff is too big to show here.

test/command/harvard-university-of-kent.csldeleted−253

This diff is too big to show here.

test/command/hspace.md+3−3

This diff is too big to show here.

test/command/html-trim-definition-list-terms.mddeleted−17

This diff is too big to show here.

test/command/ieee.csldeleted−339

This diff is too big to show here.

test/command/ifstrequal.md+2−1

This diff is too big to show here.

test/command/indented-fences.mddeleted−20

This diff is too big to show here.

test/command/issue160.csldeleted−28

This diff is too big to show here.

test/command/issue437.csldeleted−26

This diff is too big to show here.

test/command/issue58.csldeleted−553

This diff is too big to show here.

test/command/latex-center.mddeleted−13

This diff is too big to show here.

test/command/latex-command-comment.mddeleted−7

This diff is too big to show here.

test/command/latex-tabular-column-specs.md+10−31

This diff is too big to show here.

test/command/le-tapuscrit-note.csldeleted−496

This diff is too big to show here.

test/command/lettrine.mddeleted−9

This diff is too big to show here.

test/command/lists-inside-definition.mddeleted−67

This diff is too big to show here.

test/command/locators.csldeleted−68

This diff is too big to show here.

test/command/lua-pandoc-state.luadeleted−11

This diff is too big to show here.

test/command/lua-pandoc-state.mddeleted−14

This diff is too big to show here.

test/command/macro-defs-in-preamble.mddeleted−16

This diff is too big to show here.

test/command/macros.md+6−63

This diff is too big to show here.

test/command/make-section-column-divs.mddeleted−28

This diff is too big to show here.

test/command/md-abbrevs.md+11

This diff is too big to show here.

test/command/mmd-metadata.mddeleted−20

This diff is too big to show here.

test/command/modern-humanities-research-association.csldeleted−445

This diff is too big to show here.

test/command/multiple-metadata-blocks.md+1−1

This diff is too big to show here.

test/command/nested-table-to-asciidoc-6942.mddeleted−82

This diff is too big to show here.

test/command/newif.mddeleted−55

This diff is too big to show here.

test/command/oscola.csldeleted−680

This diff is too big to show here.

test/command/pandoc-citeproc-118.mddeleted−28

This diff is too big to show here.

test/command/pandoc-citeproc-119.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-13.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-136.mddeleted−23

This diff is too big to show here.

test/command/pandoc-citeproc-14.mddeleted−77

This diff is too big to show here.

test/command/pandoc-citeproc-152.mddeleted−63

This diff is too big to show here.

test/command/pandoc-citeproc-160.mddeleted−44

This diff is too big to show here.

test/command/pandoc-citeproc-175.mddeleted−43

This diff is too big to show here.

test/command/pandoc-citeproc-197.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-213.mddeleted−33

This diff is too big to show here.

test/command/pandoc-citeproc-25.mddeleted−30

This diff is too big to show here.

test/command/pandoc-citeproc-250.mddeleted−21

This diff is too big to show here.

test/command/pandoc-citeproc-27.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-292.mddeleted−43

This diff is too big to show here.

test/command/pandoc-citeproc-301.mddeleted−25

This diff is too big to show here.

test/command/pandoc-citeproc-307.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-31.mddeleted−48

This diff is too big to show here.

test/command/pandoc-citeproc-312.mddeleted−171

This diff is too big to show here.

test/command/pandoc-citeproc-320.mddeleted−254

This diff is too big to show here.

test/command/pandoc-citeproc-320a.mddeleted−87

This diff is too big to show here.

test/command/pandoc-citeproc-322.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-325.mddeleted−30

This diff is too big to show here.

test/command/pandoc-citeproc-327.mddeleted−51

This diff is too big to show here.

test/command/pandoc-citeproc-338.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-351.mddeleted−27

This diff is too big to show here.

test/command/pandoc-citeproc-356.mddeleted−20

This diff is too big to show here.

test/command/pandoc-citeproc-360.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-361.mddeleted−80

This diff is too big to show here.

test/command/pandoc-citeproc-365.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-371.mddeleted−40

This diff is too big to show here.

test/command/pandoc-citeproc-38.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-386.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-392.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-399.mddeleted−45

This diff is too big to show here.

test/command/pandoc-citeproc-401.mddeleted−59

This diff is too big to show here.

test/command/pandoc-citeproc-408.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-416.mddeleted−60

This diff is too big to show here.

test/command/pandoc-citeproc-437.mddeleted−23

This diff is too big to show here.

test/command/pandoc-citeproc-47.mddeleted−112

This diff is too big to show here.

test/command/pandoc-citeproc-51.mddeleted−45

This diff is too big to show here.

test/command/pandoc-citeproc-53.mddeleted−56

This diff is too big to show here.

test/command/pandoc-citeproc-57.mddeleted−37

This diff is too big to show here.

test/command/pandoc-citeproc-58.mddeleted−32

This diff is too big to show here.

test/command/pandoc-citeproc-61.mddeleted−77

This diff is too big to show here.

test/command/pandoc-citeproc-64.mddeleted−24

This diff is too big to show here.

test/command/pandoc-citeproc-65.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-68.mddeleted−56

This diff is too big to show here.

test/command/pandoc-citeproc-7.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-70.mddeleted−73

This diff is too big to show here.

test/command/pandoc-citeproc-75.mddeleted−67

This diff is too big to show here.

test/command/pandoc-citeproc-76.mddeleted−64

This diff is too big to show here.

test/command/pandoc-citeproc-77.mddeleted−67

This diff is too big to show here.

test/command/pandoc-citeproc-82.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-87.mddeleted−156

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-author-date.mddeleted−109

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-fullnote-bibliography.mddeleted−134

This diff is too big to show here.

test/command/pandoc-citeproc-ieee.mddeleted−113

This diff is too big to show here.

test/command/pandoc-citeproc-locators-delimited.mddeleted−127

This diff is too big to show here.

test/command/pandoc-citeproc-locators-integrated.mddeleted−159

This diff is too big to show here.

test/command/pandoc-citeproc-move-period-inside-quote.mddeleted−52

This diff is too big to show here.

test/command/pandoc-citeproc-no-author.mddeleted−73

This diff is too big to show here.

test/command/pandoc-citeproc-number-of-volumes.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-page-range.mddeleted−32

This diff is too big to show here.

test/command/parse-raw.md+5−2

This diff is too big to show here.

test/command/refs.md+2−45

This diff is too big to show here.

test/command/rst-links.mddeleted−18

This diff is too big to show here.

test/command/sage-harvard.csldeleted−202

This diff is too big to show here.

test/command/science.csldeleted−245

This diff is too big to show here.

test/command/section-divs.mddeleted−25

This diff is too big to show here.

test/command/setext-fenced-div.mddeleted−9

This diff is too big to show here.

test/command/shift-heading-level-by.mddeleted−32

This diff is too big to show here.

test/command/sloppypar.mddeleted−23

This diff is too big to show here.

test/command/style399.csldeleted−12

This diff is too big to show here.

test/command/svg.md+15−17

This diff is too big to show here.

test/command/table-with-cell-align.mddeleted−82

This diff is too big to show here.

test/command/table-with-column-span.md−276

This diff is too big to show here.

test/command/tabularx.md+48−123

This diff is too big to show here.

test/command/tasklist.md−113

This diff is too big to show here.

test/command/tex-group.md−12

This diff is too big to show here.

test/command/toc.md−47

This diff is too big to show here.

test/command/unicode-collation.md−130

This diff is too big to show here.

test/command/vancouver.csl−351

This diff is too big to show here.

test/command/video-audio.md−19

This diff is too big to show here.

test/command/write18.md+1−1

This diff is too big to show here.

test/command/yaml-metadata-blocks.md−63

This diff is too big to show here.

test/command/yaml-metadata.yaml−4

This diff is too big to show here.

test/command/yaml-with-chomp.md−12

This diff is too big to show here.

test/command/zeitschrift-fur-kunstgeschichte.csl−346

This diff is too big to show here.

test/creole-reader.native−132

This diff is too big to show here.

test/creole-reader.txt−137

This diff is too big to show here.

test/docbook-chapter.docbook−30

This diff is too big to show here.

test/docbook-chapter.native−17

This diff is too big to show here.

test/docbook-reader.docbook+2−39

This diff is too big to show here.

test/docbook-reader.native+107−293

This diff is too big to show here.

test/docbook-xref.native+1−1

This diff is too big to show here.

test/docx/0_level_headers.native+14−41

This diff is too big to show here.

test/docx/adjacent_codeblocks.docx

This diff is too big to show here.

test/docx/adjacent_codeblocks.native−6

This diff is too big to show here.

test/docx/adjacent_links.docx

This diff is too big to show here.

test/docx/adjacent_links.native+1

This diff is too big to show here.

test/docx/alternate_document_path.docx

This diff is too big to show here.

test/docx/alternate_document_path.native−3

This diff is too big to show here.

test/docx/block_quotes.docx

This diff is too big to show here.

test/docx/char_styles.docx

This diff is too big to show here.

test/docx/compact-style-removal.docx

This diff is too big to show here.

test/docx/compact-style-removal.native−5

This diff is too big to show here.

test/docx/custom-style-no-styles.native−4

This diff is too big to show here.

test/docx/custom-style-preserve.native−15

This diff is too big to show here.

test/docx/custom-style-roundtrip-start.native

This diff is too big to show here.

test/docx/custom-style-with-styles.native−7

This diff is too big to show here.

test/docx/deep_normalize.docx

This diff is too big to show here.

test/docx/document-properties-short-desc.native−2

This diff is too big to show here.

test/docx/document-properties.native−2

This diff is too big to show here.

test/docx/drop_cap.docx

This diff is too big to show here.

test/docx/golden/block_quotes.docx

This diff is too big to show here.

test/docx/golden/codeblock.docx

This diff is too big to show here.

test/docx/golden/comments.docx

This diff is too big to show here.

test/docx/golden/custom_style_no_reference.docx

This diff is too big to show here.

test/docx/golden/custom_style_preserve.docx

This diff is too big to show here.

test/docx/golden/custom_style_reference.docx

This diff is too big to show here.

test/docx/golden/definition_list.docx

This diff is too big to show here.

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

This diff is too big to show here.

test/docx/golden/document-properties.docx

This diff is too big to show here.

test/docx/golden/headers.docx

This diff is too big to show here.

test/docx/golden/image.docx

This diff is too big to show here.

test/docx/golden/inline_code.docx

This diff is too big to show here.

test/docx/golden/inline_formatting.docx

This diff is too big to show here.

test/docx/golden/inline_images.docx

This diff is too big to show here.

test/docx/golden/link_in_notes.docx

This diff is too big to show here.

test/docx/golden/links.docx

This diff is too big to show here.

test/docx/golden/lists.docx

This diff is too big to show here.

test/docx/golden/lists_continuing.docx

This diff is too big to show here.

test/docx/golden/lists_multiple_initial.docx

This diff is too big to show here.

test/docx/golden/lists_restarting.docx

This diff is too big to show here.

test/docx/golden/nested_anchors_in_header.docx

This diff is too big to show here.

test/docx/golden/notes.docx

This diff is too big to show here.

test/docx/golden/raw-blocks.docx

This diff is too big to show here.

test/docx/golden/raw-bookmarks.docx

This diff is too big to show here.

test/docx/golden/table_one_row.docx

This diff is too big to show here.

test/docx/golden/table_with_list_cell.docx

This diff is too big to show here.

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

This diff is too big to show here.

test/docx/golden/tables.docx

This diff is too big to show here.

test/docx/golden/track_changes_deletion.docx

This diff is too big to show here.

test/docx/golden/track_changes_insertion.docx

This diff is too big to show here.

test/docx/golden/track_changes_move.docx

This diff is too big to show here.

test/docx/golden/track_changes_scrubbed_metadata.docx

This diff is too big to show here.

test/docx/golden/unicode.docx

This diff is too big to show here.

test/docx/golden/verbatim_subsuper.docx

This diff is too big to show here.

test/docx/hanging_indent.docx

This diff is too big to show here.

test/docx/headers.docx

This diff is too big to show here.

test/docx/image_vml_as_object.docx

This diff is too big to show here.

test/docx/image_vml_as_object.native−2

This diff is too big to show here.

test/docx/image_writer_test.native−8

This diff is too big to show here.

test/docx/inline_formatting.docx

This diff is too big to show here.

test/docx/inline_formatting.native+1−2

This diff is too big to show here.

test/docx/inline_images.docx

This diff is too big to show here.

test/docx/inline_images_writer_test.native−2

This diff is too big to show here.

test/docx/instrText_hyperlink.docx

This diff is too big to show here.

test/docx/instrText_hyperlink.native−1

This diff is too big to show here.

test/docx/link_in_notes.docx

This diff is too big to show here.

test/docx/links.docx

This diff is too big to show here.

test/docx/lists-compact.docx

This diff is too big to show here.

test/docx/lists-compact.native−5

This diff is too big to show here.

test/docx/lists.docx

This diff is too big to show here.

test/docx/lists.native+1−1

This diff is too big to show here.

test/docx/lists_continuing.docx

This diff is too big to show here.

test/docx/lists_continuing.native−7

This diff is too big to show here.

test/docx/lists_level_override.docx

This diff is too big to show here.

test/docx/lists_level_override.native−37

This diff is too big to show here.

test/docx/lists_multiple_initial.native−8

This diff is too big to show here.

test/docx/lists_restarting.docx

This diff is too big to show here.

test/docx/lists_restarting.native−8

This diff is too big to show here.

test/docx/lists_sublist_reset.docx

This diff is too big to show here.

test/docx/lists_sublist_reset.native−8

This diff is too big to show here.

test/docx/metadata.docx

This diff is too big to show here.

test/docx/metadata_after_normal.docx

This diff is too big to show here.

test/docx/nested_anchors_in_header.native+1−6

This diff is too big to show here.

test/docx/nested_sdt.docx

This diff is too big to show here.

test/docx/nested_sdt.native−3

This diff is too big to show here.

test/docx/nested_smart_tags.docx

This diff is too big to show here.

test/docx/nested_smart_tags.native−7

This diff is too big to show here.

test/docx/normalize.docx

This diff is too big to show here.

test/docx/notes.docx

This diff is too big to show here.

test/docx/numbered_header.docx

This diff is too big to show here.

test/docx/overlapping_targets.docx

This diff is too big to show here.

test/docx/overlapping_targets.native−3

This diff is too big to show here.

test/docx/paragraph_insertion_deletion.docx

This diff is too big to show here.

test/docx/paragraph_insertion_deletion_accept.native−2

This diff is too big to show here.

test/docx/paragraph_insertion_deletion_all.native−3

This diff is too big to show here.

test/docx/paragraph_insertion_deletion_reject.native−2

This diff is too big to show here.

test/docx/raw-blocks.native−6

This diff is too big to show here.

test/docx/raw-bookmarks.native−3

This diff is too big to show here.

test/docx/sdt_elements.docx

This diff is too big to show here.

test/docx/sdt_elements.native−24

This diff is too big to show here.

test/docx/sdt_in_footnote.docx

This diff is too big to show here.

test/docx/sdt_in_footnote.native−1

This diff is too big to show here.

test/docx/table_captions_no_field.docx

This diff is too big to show here.

test/docx/table_captions_no_field.native−34

This diff is too big to show here.

test/docx/table_captions_with_field.docx

This diff is too big to show here.

test/docx/table_captions_with_field.native−54

This diff is too big to show here.

test/docx/table_header_rowspan.docx

This diff is too big to show here.

test/docx/table_header_rowspan.native−189

This diff is too big to show here.

test/docx/table_one_header_row.docx

This diff is too big to show here.

test/docx/table_one_header_row.native−18

This diff is too big to show here.

test/docx/table_one_row.docx

This diff is too big to show here.

test/docx/table_one_row.native+7−18

This diff is too big to show here.

test/docx/table_variable_width.docx

This diff is too big to show here.

test/docx/table_variable_width.native−40

This diff is too big to show here.

test/docx/table_with_list_cell.docx

This diff is too big to show here.

test/docx/table_with_list_cell.native+11−25

This diff is too big to show here.

test/docx/tables-default-widths.native−92

This diff is too big to show here.

test/docx/tables.docx

This diff is too big to show here.

test/docx/tables.native+35−91

This diff is too big to show here.

test/docx/track_changes_scrubbed_metadata.docx

This diff is too big to show here.

test/docx/track_changes_scrubbed_metadata.native−9

This diff is too big to show here.

test/docx/trim_last_inline.docx

This diff is too big to show here.

test/docx/trim_last_inline.native−2

This diff is too big to show here.

test/docx/unused_anchors.docx

This diff is too big to show here.

test/docx/unused_anchors.native−3

This diff is too big to show here.

test/dokuwiki_external_images.dokuwiki+1−1

This diff is too big to show here.

test/dokuwiki_multiblock_table.dokuwiki+3−4

This diff is too big to show here.

test/dokuwiki_multiblock_table.native+13−41

This diff is too big to show here.

test/epub/epub2_cover.epub

This diff is too big to show here.

test/epub/epub2_no_cover.epub

This diff is too big to show here.

test/epub/epub2_picture.epub

This diff is too big to show here.

test/epub/features.epub

This diff is too big to show here.

test/epub/features.native+3−3

This diff is too big to show here.

test/epub/img_no_cover.epub

This diff is too big to show here.

test/epub/wasteland.epub

This diff is too big to show here.

test/epub/wasteland.native+892−889

This diff is too big to show here.

test/fb2/basic.fb2+2−72

This diff is too big to show here.

test/fb2/images-embedded.fb2+1−1

This diff is too big to show here.

test/fb2/images.fb2+1−1

This diff is too big to show here.

test/fb2/math.fb2+1−1

This diff is too big to show here.

test/fb2/meta.fb2−3

This diff is too big to show here.

test/fb2/meta.markdown−7

This diff is too big to show here.

test/fb2/reader/emphasis.fb2−11

This diff is too big to show here.

test/fb2/reader/emphasis.native−6

This diff is too big to show here.

test/fb2/reader/epigraph.fb2−18

This diff is too big to show here.

test/fb2/reader/epigraph.native−9

This diff is too big to show here.

test/fb2/reader/meta.fb2−26

This diff is too big to show here.

test/fb2/reader/meta.native−2

This diff is too big to show here.

test/fb2/reader/notes.fb2−19

This diff is too big to show here.

test/fb2/reader/notes.native−4

This diff is too big to show here.

test/fb2/reader/poem.fb2−28

This diff is too big to show here.

test/fb2/reader/poem.native−14

This diff is too big to show here.

test/fb2/reader/titles.fb2−18

This diff is too big to show here.

test/fb2/reader/titles.native−8

This diff is too big to show here.

test/fb2/test.jpg

This diff is too big to show here.

test/fb2/titles.fb2+1−1

This diff is too big to show here.

test/fb2/titles.markdown+1−1

This diff is too big to show here.

test/html-reader.html−82

This diff is too big to show here.

test/html-reader.native+131−497

This diff is too big to show here.

test/ipynb/simple.in.native−15

This diff is too big to show here.

test/ipynb/simple.ipynb−86

This diff is too big to show here.

test/ipynb/simple.out.native−15

This diff is too big to show here.

test/jats-reader.native−671

This diff is too big to show here.

test/jats-reader.xml−1161

This diff is too big to show here.

test/jira-reader.jira−284

This diff is too big to show here.

test/jira-reader.native−185

This diff is too big to show here.

test/latex-reader.latex+9−4

This diff is too big to show here.

test/latex-reader.native+24−65

This diff is too big to show here.

test/lhs-test-markdown.native+1−1

This diff is too big to show here.

test/lhs-test.html+62−205

This diff is too big to show here.

test/lhs-test.html+lhs+62−205

This diff is too big to show here.

test/lhs-test.latex+65−61

This diff is too big to show here.

test/lhs-test.latex+lhs+40−38

This diff is too big to show here.

test/lhs-test.markdown+1−1

This diff is too big to show here.

test/lhs-test.native+1−1

This diff is too big to show here.

test/lhs-test.rst+5−5

This diff is too big to show here.

test/lhs-test.rst+lhs+2−2

This diff is too big to show here.

test/lua/attr-test.lua−6

This diff is too big to show here.

test/lua/blocks-filter.lua−8

This diff is too big to show here.

test/lua/inlines-filter.lua−19

This diff is too big to show here.

test/lua/math.lua−10

This diff is too big to show here.

test/lua/meta.lua−6

This diff is too big to show here.

test/lua/module/pandoc-list.lua−160

This diff is too big to show here.

test/lua/module/pandoc-mediabag.lua−72

This diff is too big to show here.

test/lua/module/pandoc-path.lua−44

This diff is too big to show here.

test/lua/module/pandoc-types.lua−111

This diff is too big to show here.

test/lua/module/pandoc-utils.lua−159

This diff is too big to show here.

test/lua/module/pandoc.lua−253

This diff is too big to show here.

test/lua/require-file.lua−2

This diff is too big to show here.

test/lua/script-name.lua−3

This diff is too big to show here.

test/lua/smart-constructors.lua−10

This diff is too big to show here.

test/lua/uppercase-header.lua−9

This diff is too big to show here.

test/man-reader.man−391

This diff is too big to show here.

test/man-reader.native−300

This diff is too big to show here.

test/markdown-citations.native+14−14

This diff is too big to show here.

test/markdown-reader-more.native+82−194

This diff is too big to show here.

test/mediawiki-reader.native+85−241

This diff is too big to show here.

test/odt/markdown/formula.md−1

This diff is too big to show here.

test/odt/native/simpleTable.native+1−1

This diff is too big to show here.

test/odt/native/simpleTableWithCaption.native+1−1

This diff is too big to show here.

test/odt/native/tab.native−1

This diff is too big to show here.

test/odt/native/tableWithContents.native+1−1

This diff is too big to show here.

test/odt/odt/tab.odt

This diff is too big to show here.

test/org-select-tags.native−7

This diff is too big to show here.

test/org-select-tags.org−17

This diff is too big to show here.

test/pipe-tables.native+104−315

This diff is too big to show here.

test/pptx/code-custom.pptx

This diff is too big to show here.

test/pptx/code-custom_templated.pptx

This diff is too big to show here.

test/pptx/code.native−21

This diff is too big to show here.

test/pptx/code.pptx

This diff is too big to show here.

test/pptx/code_templated.pptx

This diff is too big to show here.

test/pptx/document-properties-short-desc.native−2

This diff is too big to show here.

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

This diff is too big to show here.

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

This diff is too big to show here.

test/pptx/document-properties.native−2

This diff is too big to show here.

test/pptx/document-properties.pptx

This diff is too big to show here.

test/pptx/document-properties_templated.pptx

This diff is too big to show here.

test/pptx/endnotes.native−2

This diff is too big to show here.

test/pptx/endnotes.pptx

This diff is too big to show here.

test/pptx/endnotes_templated.pptx

This diff is too big to show here.

test/pptx/endnotes_toc.pptx

This diff is too big to show here.

test/pptx/endnotes_toc_templated.pptx

This diff is too big to show here.

test/pptx/images.native−5

This diff is too big to show here.

test/pptx/images.pptx

This diff is too big to show here.

test/pptx/images_templated.pptx

This diff is too big to show here.

test/pptx/inline_formatting.native−5

This diff is too big to show here.

test/pptx/inline_formatting.pptx

This diff is too big to show here.

test/pptx/inline_formatting_templated.pptx

This diff is too big to show here.

test/pptx/lists.native−18

This diff is too big to show here.

test/pptx/lists.pptx

This diff is too big to show here.

test/pptx/lists_templated.pptx

This diff is too big to show here.

test/pptx/raw_ooxml.native−3

This diff is too big to show here.

test/pptx/raw_ooxml.pptx

This diff is too big to show here.

test/pptx/raw_ooxml_templated.pptx

This diff is too big to show here.

test/pptx/reference_depth.pptx

This diff is too big to show here.

test/pptx/remove_empty_slides.native−5

This diff is too big to show here.

test/pptx/remove_empty_slides.pptx

This diff is too big to show here.

test/pptx/remove_empty_slides_templated.pptx

This diff is too big to show here.

test/pptx/slide_breaks.native−7

This diff is too big to show here.

test/pptx/slide_breaks.pptx

This diff is too big to show here.

test/pptx/slide_breaks_slide_level_1.pptx

This diff is too big to show here.

test/pptx/slide_breaks_slide_level_1_templated.pptx

This diff is too big to show here.

test/pptx/slide_breaks_templated.pptx

This diff is too big to show here.

test/pptx/slide_breaks_toc.pptx

This diff is too big to show here.

test/pptx/slide_breaks_toc_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes.native−17

This diff is too big to show here.

test/pptx/speaker_notes.pptx

This diff is too big to show here.

test/pptx/speaker_notes_after_metadata.native−5

This diff is too big to show here.

test/pptx/speaker_notes_after_metadata.pptx

This diff is too big to show here.

test/pptx/speaker_notes_after_metadata_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterheader.native−3

This diff is too big to show here.

test/pptx/speaker_notes_afterheader.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterheader_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterseps.native−63

This diff is too big to show here.

test/pptx/speaker_notes_afterseps.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterseps_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes_templated.pptx

This diff is too big to show here.

test/pptx/start_numbering_at.native−9

This diff is too big to show here.

test/pptx/start_numbering_at.pptx

This diff is too big to show here.

test/pptx/start_numbering_at_templated.pptx

This diff is too big to show here.

test/pptx/tables.native−95

This diff is too big to show here.

test/pptx/tables.pptx

This diff is too big to show here.

test/pptx/tables_templated.pptx

This diff is too big to show here.

test/pptx/two_column.native−9

This diff is too big to show here.

test/pptx/two_column.pptx

This diff is too big to show here.

test/pptx/two_column_templated.pptx

This diff is too big to show here.

test/rst-reader.native+72−180

This diff is too big to show here.

test/rst-reader.rst+1−25

This diff is too big to show here.

test/s5-basic.html+5−8

This diff is too big to show here.

test/s5-fancy.html+207−9

This diff is too big to show here.

test/s5-inserts.html+4−7

This diff is too big to show here.

test/tables-rstsubset.native+107−294

This diff is too big to show here.

test/tables.asciidoc+17−17

This diff is too big to show here.

test/tables.asciidoctor−67

This diff is too big to show here.

test/tables.context+155−210

This diff is too big to show here.

test/tables.custom−200

This diff is too big to show here.

test/tables.docbook4+3−3

This diff is too big to show here.

test/tables.docbook5+3−3

This diff is too big to show here.

test/tables.dokuwiki+1

This diff is too big to show here.

test/tables.fb2+2−14

This diff is too big to show here.

test/tables.haddock+56−70

This diff is too big to show here.

test/tables.html4+6−6

This diff is too big to show here.

test/tables.html5+6−6

This diff is too big to show here.

test/tables.icml+3−3

This diff is too big to show here.

test/tables.jats+614

This diff is too big to show here.

test/tables.jats_archiving−226

This diff is too big to show here.

test/tables.jats_articleauthoring−226

This diff is too big to show here.

test/tables.jats_publishing−226

This diff is too big to show here.

test/tables.jira−43

This diff is too big to show here.

test/tables.latex+101−67

This diff is too big to show here.

test/tables.man+7−7

This diff is too big to show here.

test/tables.mediawiki+4−3

This diff is too big to show here.

test/tables.ms+7−51

This diff is too big to show here.

test/tables.muse+11−24

This diff is too big to show here.

test/tables.native+107−286

This diff is too big to show here.

test/tables.opendocument+96−98

This diff is too big to show here.

test/tables.org+31−31

This diff is too big to show here.

test/tables.rst+64−56

This diff is too big to show here.

test/tables.rtf+9−8

This diff is too big to show here.

test/tables.tei+12

This diff is too big to show here.

test/tables.texinfo+3−3

This diff is too big to show here.

test/tables.textile+4−3

This diff is too big to show here.

test/tables.txt+1

This diff is too big to show here.

test/tables.xwiki−45

This diff is too big to show here.

test/tables.zimwiki+1

This diff is too big to show here.

test/tables/nordics.html4−59

This diff is too big to show here.

test/tables/nordics.html5−59

This diff is too big to show here.

test/tables/nordics.jats_archiving−58

This diff is too big to show here.

test/tables/nordics.latex−42

This diff is too big to show here.

test/tables/nordics.native−73

This diff is too big to show here.

test/tables/planets.html4−133

This diff is too big to show here.

test/tables/planets.html5−133

This diff is too big to show here.

test/tables/planets.jats_archiving−128

This diff is too big to show here.

test/tables/planets.latex−30

This diff is too big to show here.

test/tables/planets.native−241

This diff is too big to show here.

test/tables/students.html4−55

This diff is too big to show here.

test/tables/students.html5−55

This diff is too big to show here.

test/tables/students.jats_archiving−56

This diff is too big to show here.

test/tables/students.latex−31

This diff is too big to show here.

test/tables/students.native−54

This diff is too big to show here.

test/test-pandoc.hs+7−52

This diff is too big to show here.

test/testsuite.native+6−6

This diff is too big to show here.

test/textile-reader.native+42−105

This diff is too big to show here.

test/textile-reader.textile+2−3

This diff is too big to show here.

test/tikiwiki-reader.native+67−149

This diff is too big to show here.

test/twiki-reader.native+34−110

This diff is too big to show here.

test/txt2tags.native+304−661

This diff is too big to show here.

test/txt2tags.t2t+2−2

This diff is too big to show here.

test/vimwiki-reader.native+76−216

This diff is too big to show here.

test/vimwiki-reader.wiki+1−12

This diff is too big to show here.

test/writer.asciidoc+149−108

This diff is too big to show here.

test/writer.asciidoctor−649

This diff is too big to show here.

test/writer.context+79−97

This diff is too big to show here.

test/writer.custom−782

This diff is too big to show here.

test/writer.docbook4+1266−1272

This diff is too big to show here.

test/writer.docbook5+1230−1237

This diff is too big to show here.

test/writer.dokuwiki+3−14

This diff is too big to show here.

test/writer.fb2+519−264

This diff is too big to show here.

test/writer.haddock+7−8

This diff is too big to show here.

test/writer.html4+17−150

This diff is too big to show here.

test/writer.html5+21−154

This diff is too big to show here.

test/writer.icml+161−92

This diff is too big to show here.

test/writer.jats+1436

This diff is too big to show here.

test/writer.jats_archiving−902

This diff is too big to show here.

test/writer.jats_articleauthoring−874

This diff is too big to show here.

test/writer.jats_publishing−902

This diff is too big to show here.

test/writer.jira−537

This diff is too big to show here.

test/writer.latex+60−59

This diff is too big to show here.

test/writer.man+161−124

This diff is too big to show here.

test/writer.markdown+57−77

This diff is too big to show here.

test/writer.mediawiki+2−2

This diff is too big to show here.

test/writer.ms+124−130

This diff is too big to show here.

test/writer.muse+72−63

This diff is too big to show here.

test/writer.native+6−6

This diff is too big to show here.

test/writer.opendocument+236−625

This diff is too big to show here.

test/writer.opml+2−2

This diff is too big to show here.

test/writer.org+142−116

This diff is too big to show here.

test/writer.plain+89−36

This diff is too big to show here.

test/writer.rst+140−82

This diff is too big to show here.

test/writer.rtf+1−1

This diff is too big to show here.

test/writer.tei+33−33

This diff is too big to show here.

test/writer.texinfo+22−11

This diff is too big to show here.

test/writer.textile+9−9

This diff is too big to show here.

test/writer.xwiki−650

This diff is too big to show here.

test/writer.zimwiki+93−93

This diff is too big to show here.

test/writers-lang-and-dir.context+17−25

This diff is too big to show here.

test/writers-lang-and-dir.latex+57−58

This diff is too big to show here.

tools/build-arm.sh−110

This diff is too big to show here.

tools/changelog-helper.sh−30

This diff is too big to show here.

tools/changes_template.html−6

This diff is too big to show here.

tools/diff-zip.sh−33

This diff is too big to show here.

tools/extract-changes.hs+3−9

This diff is too big to show here.

tools/ldoc.ltp+38

This diff is too big to show here.

tools/pandoc-template-mode.el+3−9

This diff is too big to show here.

tools/parseTimings.pl−33

This diff is too big to show here.

tools/update-lua-docs.lua+32

This diff is too big to show here.

tools/update-readme.lua−28

This diff is too big to show here.

trypandoc/index.html+29−73

This diff is too big to show here.

trypandoc/trypandoc.hs+11−21

This diff is too big to show here.

windows/Makefile−10

This diff is too big to show here.

windows/Pandoc-en-us.wxl+1−1

This diff is too big to show here.

windows/make-windows-installer.bat+29

This diff is too big to show here.

windows/pandoc.wxs+7−5

This diff is too big to show here.