Skip to content

Commit

Permalink
enable citekey prefix inference
Browse files Browse the repository at this point in the history
  • Loading branch information
ploegieku authored Dec 27, 2020
1 parent 3e6de87 commit d244613
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
15 changes: 14 additions & 1 deletion USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,19 @@ When choosing which source to use for a citation, we recommend the following ord
9. For references that do not have any of the above persistent identifiers, the citation key does not need to include a prefix.
Citing `@old-manuscript` will work, but only if reference metadata is [provided manually](#reference-metadata).

Manubot is able to infer certain prefixes,
such some citations can be formatted like `@accession` (without a prefix).
Examples includes DOIs like `@10.15363/thinklab.4` or `@10/993`,
PMC / PubMed identifiers like `@PMC4497619` or `@26158728`,
arXiv identifier like `@1508.06576v2`,
and Wikidata identifiers like `@Q50051684`.
To disable citekey prefix inference, add the following to `metadata.yaml`:

```yaml
pandoc:
manubot-infer-citekey-prefixes: false
```
Cite multiple items at once like:
```md
Expand All @@ -136,7 +149,7 @@ By default, `pandoc-manubot-cite` does not fail upon invalid citations, although

```yaml
pandoc:
manubot-fail-on-errors: True
manubot-fail-on-errors: true
```
#### Citation aliases
Expand Down
2 changes: 1 addition & 1 deletion build/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ dependencies:
- yamllint=1.25.0
- pip:
- errorhandler==2.0.1
- git+https://github.com/manubot/manubot@55c5e1e526261ebadd2aefed2c2757792d8d2ebf
- git+https://github.com/manubot/manubot@553090a16ac24a9fdc3f8df241a91b790c140865
- isbnlib==3.10.3
- opentimestamps-client==0.7.0
- opentimestamps==0.4.1
Expand Down

0 comments on commit d244613

Please sign in to comment.