Skip to content

Commit 17e20db

Browse files
committed
Fix filename as __from_DOI.bib
1 parent cf2d0c5 commit 17e20db

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

doi2cite/README.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This pandoc lua filiter helps users to insert references in a document
33
with using DOI(Digital Object Identifier) tags. With this filter, users
44
do not need to make bibtex file by themselves. Instead, the filter
55
automatically generate .bib file from the DOI tags, and convert the DOI
6-
tags into citation keys available by `pandoc-crossref`.
6+
tags into citation keys available by `--citeproc`.
77

88
<img src="https://user-images.githubusercontent.com/30950088/117561410-87ec5d00-b0d1-11eb-88be-931f3158ec44.png" width="960">
99

@@ -32,15 +32,12 @@ Following DOI tags can be used:
3232
The first one (@https://doi.org/) may be the most useful because it is
3333
same as the accessible URL.
3434

35-
# Specify auto-generated bibliography file path
36-
The filename of the auto-generated bibliography file must be
37-
`__from_DOI.bib`, but the place of the file can be changed like
38-
`../reference/__from_DOI.bib`. You can designate the filepath in the
35+
# YAML header
36+
The file **name** of the auto-generated bibliography file **MUST** be
37+
`__from_DOI.bib`, but the **place** of the file can be changed (e.g.
38+
`./refs/__from_DOI.bib`). You can designate the filepath in the
3939
document yaml header. The yaml key is `bibliography`, which is also
40-
recognized by Pandoc `--citeproc`. If the path does not explicitly
41-
given, the filepath will be set as `__from_DOI.bib` by default. Note
42-
that users typically should add same file path also in `bibliography`,
43-
in order to be recognized by `--citeproc`.
40+
used by Pandoc `--citeproc`.
4441

4542

4643
# Example
@@ -49,9 +46,8 @@ example1.md:
4946

5047
---
5148
bibliography:
52-
- "doi_refs.bib"
5349
- "my_refs.bib"
54-
bib_from_doi: "doi_refs.bib"
50+
- "__from_DOI.bib"
5551
---
5652

5753
# Introduction

0 commit comments

Comments
 (0)