diff options
| author | John MacFarlane <jgm@berkeley.edu> | 2015-11-21 11:13:31 -0800 |
|---|---|---|
| committer | John MacFarlane <jgm@berkeley.edu> | 2015-11-21 11:14:02 -0800 |
| commit | 39a92b23a33868fb23020c24d4ffb45e919b2530 (patch) | |
| tree | 9a5b6cc30f39f3c0eb927dda6aff7a8b91bf10d7 | |
| parent | 67b49d786cfadbdb2f11a7de221d433fb65ab3a0 (diff) | |
| download | pandoc-39a92b23a33868fb23020c24d4ffb45e919b2530.tar.gz | |
Improved Citations section of README.
Added information about `link-citations` and a link
to the pandoc-citeproc man page.
Closes #2551.
| -rw-r--r-- | README | 13 |
1 files changed, 10 insertions, 3 deletions
@@ -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 `--bibliography` command line argument. You can supply multiple `--bibliography` arguments or set `bibliography` metadata field to YAML array, if you want to -use multiple bibliography files. -The bibliography may have any of these formats: +use multiple bibliography files. The bibliography may have any of these +formats: 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 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 document's YAML metadata. The field should contain an array of 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 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. Each citation must have a key, composed of '@' + the citation 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 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 [Chicago Manual of Style]: http://chicagomanualofstyle.org [Citation Style Language]: http://citationstyles.org [Zotero Style Repository]: https://www.zotero.org/styles [finding and editing styles]: http://citationstyles.org/styles/ [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 --------------------- |