Skip to content

Commit cda99c1

Browse files
committed
Document citation recipe
1 parent 62ae937 commit cda99c1

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

tools/make/lib/bib/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,36 @@ This directory contains [`make`][make] recipes for managing the project bibliogr
1212

1313
<!-- /.intro -->
1414

15+
<!-- Usage documentation. -->
16+
17+
<section class="usage">
18+
19+
## Usage
20+
21+
```text
22+
Usage: make <command> [<ENV_VAR>=<value> <ENV_VAR>=<value> ...]
23+
```
24+
25+
### Commands
26+
27+
#### citation-reference
28+
29+
Returns a Markdown formatted reference corresponding to a provided citation identifier.
30+
31+
```bash
32+
$ make citation-reference CITATION=@marsaglia:2000a
33+
```
34+
35+
The recipe recognizes the following environment variables:
36+
37+
- **CITATION**: citation identifier prefixed with an `@` symbol; e.g., `@marsaglia:2000a`.
38+
- **CITATION_REFERENCE_DATABASE**: path to a citation reference database.
39+
- **CITATION_REFERENCE_CSL**: path to a Citation Style Language (CSL) file.
40+
41+
</section>
42+
43+
<!-- /.usage -->
44+
1545
<!-- Section to include notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
1646

1747
<section class="notes">

tools/make/lib/bib/reference.mk

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ CITATION_REFERENCE ?= $(NODE) $(TOOLS_PKGS_DIR)/bib/citation-reference/bin/cli
1010
# Define the path to a citation reference database:
1111
CITATION_REFERENCE_DATABASE ?= $(ROOT_DIR)/docs/references/bib.bib
1212

13-
# Define the path to a citation style language (CSL) file:
13+
# Define the path to a Citation Style Language (CSL) file:
1414
CITATION_REFERENCE_CSL ?= $(ROOT_DIR)/docs/references/csl/chicago-author-date.csl
1515

1616
# Define the command-line options to be used when executing the command:

0 commit comments

Comments
 (0)