Add citations feature (+ backmatter). #206
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds support for citations, and introduce `\beginbackmatter` command to
mark back matter sections. This avoids the references/bibliography to be
part of the appendices (which is wrong, references/bibliography are no
appendix).
You can write something like "The TPM 2.0 architecture
[@{cite:tcg-tpm2-architecture}] describes ..." in your Markdown document
which results in a
clickable link (e.g., "The TPM 2.0 architecture [1] describes ...") to
the references/citations list at the
end of the PDF document.
In the YAML front matter you add something like:
```yaml
---
bibliography: citations.yaml
csl: transactions-on-computer-systems.csl
...
```
The `citations.yaml` may look as follows:
```yaml
references:
- id: "cite:tcg-tpm2-architecture"
title: "Trusted Platform Module Library - Part 1: Architecture"
author:
- family: "(TCG)"
given: "Trusted Computing Group"
edition: "Family 2.0, Level 00, Revision 01.83"
organization: "Trusted Computing Group"
publisher: "Trusted Computing Group (TCG)"
series: "TCG Specification"
issued:
year: 2024
month: 1
day: 25
url:
"https://trustedcomputinggroup.org/resourcetpm-library-specification/"
```
For the back matter, please put the `\beginbackmatter` command in the
Markdown source and add the references as follows:
```md
\beginbackmatter
# References
::: {#refs}
:::
```
Signed-off-by: Michael Eckel <[email protected]>
|
Merging this despite the 403 on docker. Will check and fix if the issue persists. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #205.
Adds support for citations, and introduces
\beginbackmattercommand to mark back matter sections. This avoids the list of references/citations (bibliography) to be part of the appendices (which is wrong, references/bibliography are no appendix).You can write something like "The TPM 2.0 architecture [@{cite:tcg-tpm2-architecture}] describes ..." in your Markdown document which results in a clickable link (e.g., "The TPM 2.0 architecture [1] describes ...") to the references/citations list at the
end of the PDF document.
In the YAML front matter you add something like:
The
citations.yamlmay look as follows:For the back matter, please put the
\beginbackmattercommand in the Markdown source and add the list of references/citations (bibliography) as follows:\beginbackmatter # References ::: {#refs} :::