rstudio / rstudio/rticles

Pinning tex template version ? (Self-contained mode ?)

Open
#359 3 comments 0 reactions 1 assignee View on GitHub

@cderv is already working on this.

Since Dec 17, 2020.

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

Description

Right now, when rticles updates a template, it risks either breaking older markdown documents (for example, if the name of a header variable changes; see https://github.com/rstudio/rticles/pull/358) or changing the resulting pdf. This poses a challenge to reproducibility and stability.

Some of that could be ameliorated if instead of using the template.tex file that lives with the package, each article format copied the template.tex file to the root of the project at creation time and then used that file as template. That document is then shielded from updates to rticles. Of course, that also means that it also doesn't receive new updates (but if the user wants to update, they could create a new rmakdown file and then copy the the new template.tex, or perhaps there could be a command that does the update).

@cderv suggested that this could be an optional "self-contained" mode for advanced users. I don't know if this is possible or worth it.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.