pandoc/test/command/pandoc-citeproc-locators-delimited.md
John MacFarlane e0984a43a9 Add built-in citation support using new citeproc library.
This deprecates the use of the external pandoc-citeproc
filter; citation processing is now built in to pandoc.

* Add dependency on citeproc library.
* Add Text.Pandoc.Citeproc module (and some associated unexported
  modules under Text.Pandoc.Citeproc).  Exports `processCitations`.
  [API change]
* Add data files needed for Text.Pandoc.Citeproc:  default.csl
  in the data directory, and a citeproc directory that is just
  used at compile-time.  Note that we've added file-embed as a mandatory
  rather than a conditional depedency, because of the biblatex
  localization files. We might eventually want to use readDataFile
  for this, but it would take some code reorganization.
* Text.Pandoc.Loging: Add `CiteprocWarning` to `LogMessage` and use it
  in `processCitations`. [API change]
* Add tests from the pandoc-citeproc package as command tests (including
  some tests pandoc-citeproc did not pass).
* Remove instructions for building pandoc-citeproc from CI and
  release binary build instructions.  We will no longer distribute
  pandoc-citeproc.
* Markdown reader: tweak abbreviation support.  Don't insert a
  nonbreaking space after a potential abbreviation if it comes right before
  a note or citation.  This messes up several things, including citeproc's
  moving of note citations.
* Add `csljson` as and input and output format. This allows pandoc
  to convert between `csljson` and other bibliography formats,
  and to generate formatted versions of CSL JSON bibliographies.
* Add module Text.Pandoc.Writers.CslJson, exporting `writeCslJson`. [API
  change]
* Add module Text.Pandoc.Readers.CslJson, exporting `readCslJson`. [API
  change]
* Added `bibtex`, `biblatex` as input formats.  This allows pandoc
  to convert between BibLaTeX and BibTeX and other bibliography formats,
  and to generated formatted versions of BibTeX/BibLaTeX bibliographies.
* Add module Text.Pandoc.Readers.BibTeX, exporting `readBibTeX` and
  `readBibLaTeX`. [API change]
* Make "standalone" implicit if output format is a bibliography format.
  This is needed because pandoc readers for bibliography formats put
  the bibliographic information in the `references` field of metadata;
  and unless standalone is specified, metadata gets ignored.
  (TODO: This needs improvement. We should trigger standalone for the
  reader when the input format is bibliographic, and for the writer
  when the output format is markdown.)
* Carry over `citationNoteNum` to `citationNoteNumber`.  This was just
  ignored in pandoc-citeproc.
* Text.Pandoc.Filter: Add `CiteprocFilter` constructor to Filter.
  [API change] This runs the processCitations transformation.
  We need to treat it like a filter so it can be placed
  in the sequence of filter runs (after some, before others).
  In FromYAML, this is parsed from `citeproc` or `{type: citeproc}`,
  so this special filter may be specified either way in a defaults file
  (or by `citeproc: true`, though this gives no control of positioning
  relative to other filters).  TODO: we need to add something to the
  manual section on defaults files for this.
* Add deprecation warning if `upandoc-citeproc` filter is used.
* Add `--citeproc/-C` option to trigger citation processing.
  This behaves like a filter and will be positioned
  relative to filters as they appear on the command line.
* Rewrote the manual on citatations, adding a dedicated Citations
  section which also includes some information formerly found in
  the pandoc-citeproc man page.
* Look for CSL styles in the `csl` subdirectory of the pandoc user data
  directory.  This changes the old pandoc-citeproc behavior, which looked
  in `~/.csl`.  Users can simply symlink `~/.csl` to the `csl`
  subdirectory of their pandoc user data directory if they want
  the old behavior.
* Add support for CSL bibliography entry formatting to LaTeX, HTML,
  Ms writers.  Added CSL-related CSS to styles.html.
2020-09-21 10:15:50 -07:00

2.5 KiB

% pandoc --citeproc -t markdown-citations
---
csl: command/locators.csl
references:
- id: citekey
  title: Title
  type: 'article-journal'
suppress-bibliography: true
---

See <https://github.com/jgm/pandoc-citeproc/pull/362>.

Standard page range[@citekey {35-89, 102}]

Alphanumeric[@citekey {abcdefg1234}]

Kitchen sink[@citekey, {123(4)a-8(\[a\]12.398{8})}]

Empty braces inside[@citekey, {{}}]

Label specified[@citekey {p. a}]

Should it work outside? No. [@citekey, p. {(a)}]

Empty locator [@citekey, {}]

Empty locator to force suffix[@citekey {} 123-35 numbers are suffix]

Suffix generally [@citekey {123-35} numbers not, but text is suffix]

With preceding comma[@citekey, {p. VI}]

No commas before label[@citekey, {, p. (p. is not recognised)}]

Trim white space[@citekey, { p. 9 }]

Without delimiters[@citekey, suffix]

With rendering label[@citekey {ss IV div 4 s 128L(7)(a)(i)-(iv), 129(5),
130(b)}]

The text is apparently NOT verbatim; it is lightly processed as page
numbers. [@citekey {no comma, no label, no nothing}]

AGLC-style page \[para\] [@citekey {584 \[78\]}]

Unbalanced curly { breaks the parse[@citekey {p. suffix{suffix}suffix]

Unbalanced curly } ends early[@citekey {green}suffix}suffix]
^D
See <https://github.com/jgm/pandoc-citeproc/pull/362>.

Standard page range[^1]

Alphanumeric[^2]

Kitchen sink[^3]

Empty braces inside[^4]

Label specified[^5]

Should it work outside? No.[^6]

Empty locator[^7]

Empty locator to force suffix[^8]

Suffix generally[^9]

With preceding comma[^10]

No commas before label[^11]

Trim white space[^12]

Without delimiters[^13]

With rendering label[^14]

The text is apparently NOT verbatim; it is lightly processed as page
numbers.[^15]

AGLC-style page \[para\][^16]

Unbalanced curly { breaks the parse[^17]

Unbalanced curly } ends early[^18]

[^1]: Title {35--89, 102}.

[^2]: Ibid-with-locator {abcdefg1234}.

[^3]: Ibid-with-locator {123(4)a--8(\[a\]12.398{8})}.

[^4]: Ibid-with-locator {{}}.

[^5]: Ibid-with-locator {a}.

[^6]: Subsequent, p. {(a)}.

[^7]: Ibid-with-locator.

[^8]: Ibid 123-35 numbers are suffix.

[^9]: Ibid-with-locator {123--35} numbers not, but text is suffix.

[^10]: Ibid-with-locator {VI}.

[^11]: Ibid-with-locator {, p. (p. is not recognised)}.

[^12]: Ibid-with-locator {9}.

[^13]: Subsequent, suffix.

[^14]: Ibid-with-locator ss {IV div 4 s 128L(7)(a)(i)--(iv), 129(5),
    130(b)}.

[^15]: Ibid-with-locator {no comma, no label, no nothing}.

[^16]: Ibid-with-locator {584 \[78\]}.

[^17]: Subsequent {p. suffix{suffix}suffix.

[^18]: Ibid-with-locator {green}suffix}suffix.