Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Improved Citations section of README.

Browse source 
Added information about `link-citations` and a link
to the pandoc-citeproc man page.

Closes #2551.
This commit is contained in:
John MacFarlane 2015-11-21 11:13:31 -08:00
parent 67b49d786c
commit 39a92b23a3
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README
View file

@ -3021,8 +3021,8 @@ In order to use this feature, you will need to specify a bibliography file
using the `bibliography` metadata field in a YAML metadata section, or using the `bibliography` metadata field in a YAML metadata section, or
`--bibliography` command line argument. You can supply multiple `--bibliography` `--bibliography` command line argument. You can supply multiple `--bibliography`
arguments or set `bibliography` metadata field to YAML array, if you want to arguments or set `bibliography` metadata field to YAML array, if you want to
use multiple bibliography files. use multiple bibliography files. The bibliography may have any of these
The bibliography may have any of these formats: formats:
Format File extension Format File extension
------------ -------------- ------------ --------------
@ -3068,7 +3068,8 @@ a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSO
`pandoc-citeproc -j` and `-y` interconvert the CSL JSON `pandoc-citeproc -j` and `-y` interconvert the CSL JSON
and CSL YAML formats as far as possible. and CSL YAML formats as far as possible.
As an alternative to specifying a bibliography file, you can include As an alternative to specifying a bibliography file using `--bibliography`
or the YAML metadata field `bibliography`, you can include
the citation data directly in the `references` field of the the citation data directly in the `references` field of the
document's YAML metadata. The field should contain an array of document's YAML metadata. The field should contain an array of
YAML-encoded references, for example: YAML-encoded references, for example:
@ -3108,6 +3109,9 @@ These files are specified using the `--csl` option or the `csl` metadata field.
By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date
format. The CSL project provides further information on [finding and editing styles]. format. The CSL project provides further information on [finding and editing styles].
To make your citations hyperlinks to the corresponding bibliography
entries, add `link-citations: true` to your YAML metadata.
Citations go inside square brackets and are separated by semicolons. Citations go inside square brackets and are separated by semicolons.
Each citation must have a key, composed of '@' + the citation Each citation must have a key, composed of '@' + the citation
identifier from the database, and may optionally have a prefix, identifier from the database, and may optionally have a prefix,
@ -3177,12 +3181,15 @@ outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`
invocation. Bear in mind that bibliography files have to be in respective invocation. Bear in mind that bibliography files have to be in respective
format (either BibTeX or BibLaTeX). format (either BibTeX or BibLaTeX).
For more information, see the [pandoc-citeproc man page].
[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields [CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields
[Chicago Manual of Style]: http://chicagomanualofstyle.org [Chicago Manual of Style]: http://chicagomanualofstyle.org
[Citation Style Language]: http://citationstyles.org [Citation Style Language]: http://citationstyles.org
[Zotero Style Repository]: https://www.zotero.org/styles [Zotero Style Repository]: https://www.zotero.org/styles
[finding and editing styles]: http://citationstyles.org/styles/ [finding and editing styles]: http://citationstyles.org/styles/
[CSL locale files]: https://github.com/citation-style-language/locales [CSL locale files]: https://github.com/citation-style-language/locales
[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md
Non-pandoc extensions Non-pandoc extensions
--------------------- ---------------------