Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phfaist/flm-citations
Extra citations support for FLM
https://github.com/phfaist/flm-citations
Last synced: 3 months ago
JSON representation
Extra citations support for FLM
- Host: GitHub
- URL: https://github.com/phfaist/flm-citations
- Owner: phfaist
- License: mit
- Created: 2022-08-29T16:30:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T08:35:25.000Z (5 months ago)
- Last Synced: 2024-10-05T12:06:49.008Z (3 months ago)
- Language: Python
- Homepage:
- Size: 163 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Extra citations support for FLM
See the [FLM README file](https://github.com/phfaist/flm/blob/main/README.md).
Install with:
```bash
$ pip install flm-citations
```
Use the additional config front matter in your FLM files to enable citations
with automatic citation retrieval from arXiv, DOI, etc.
```yaml
---
$import:
- pkg:flm_citations
bibliography:
- my-csl-bibliography.yaml
---
```
Then process your file as usual with `flm`.
The bibliography file(s) you provide (in the example above,
`my-csl-bibliography.yaml`) should be in CSL JSON or CSL YAML
format. They can easily be exported from Zotero, for example.
With the default configuration, the following citation keys are
processed:
- `\cite{arXiv:XXXX.YYYYY}` - fetch citation information from
the [arXiv](https://arxiv.org/), and from its corresponding
DOI if applicable.
- `\cite{doi:XXX}` - fetch citation information using its DOI
- `\cite{manual:{X et al., Journal of Future Results (2034)}}` -
manual citation text
- `\cite{bib:BibKey2023}` - use a citation from any of your
bibliography files specified in your document front matter.
### In case `citeproc` chokes on certain entries fetched by DOI
Sometimes automatically generated citeproc/JSON entries fetched
through various available online APIs (doi.org, crossref.org,
arXiv.org, etc.) might not be fully conforming or exactly
matching the structure expected by the
[`citeproc-py` citation formatting library](https://github.com/brechtm/citeproc-py)
that this project uses. If you run against such issues, you
might consider installing a patched version of the library that
smoothed out some issues I had in the past; you can install it
with
```
> pip install git+https://github.com/phfaist/citeproc-py.git@pr-branch
```
until my [upstream PR](https://github.com/brechtm/citeproc-py/pull/132)
is considered.
### Metadata Fetching
Thank you to [arXiv](https://arxiv.org/) and
[doi.org](https://doi.org/) for use of their open access
interoperability.