rstudio / rstudio/rticles

JOSS template - `link-citations: yes` option fails to link citations

Open
#590 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
1.5k
Forks
517
Avg merge
1d 8h
Merged PRs (30d)
5

Description

with recent versions of pandoc (I have tried with v3.2 and v3.4), I have noticed that the link-citations option in the JOSS template fails.

When the YAML option link-citations: yes is enabled, the citations do not get linked, and are displayed as their bibtex index in the rendered PDF, e.g: [ref-astropy].

To replicate:

In RStudio:

  1. install rticles package
  2. create new RMarkdown "From Template"
  3. select "Journal of Open Source Software Article"
  4. edit the <title>.Rmd file and add link-citations: yes in YAML header
  5. knit the document
Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Journal of Open Source Software Article template created by the RStudio reproduction steps, and test the YAML option link-citations: yes using pandoc 3.2 and 3.4. Compare the rendered PDF with the expected linked citations; done means citations are linked rather than displayed as BibTeX indexes such as [ref-astropy].

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, r
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.