Tutorial / tips for adapting templates

[eliocamp]

Is there a guide or tutorial that teaches people to create a pandonc template suitable to use with rmarkdown and possibly to include in rticles? I'm considering writing something but woudln't want to duplicate any existing work.

---

By filing an issue to this repo, I promise that

• I have fully read the issue guide at https://yihui.name/issue/.
• I have provided the necessary information about my issue.
  • If I'm asking a question, I have already asked it on Stack Overflow or RStudio Community, waited for at least 24 hours, and included a link to my question there.
  • If I'm filing a bug report, I have included a minimal, self-contained, and reproducible example, and have also included xfun::session_info('rticles'). I have upgraded all my packages to their latest versions (e.g., R, RStudio, and R packages), and also tried the development version: remotes::install_github('rstudio/rticles').
  • If I have posted the same issue elsewhere, I have also mentioned it in this issue.
• I have learned the Github Markdown syntax, and formatted my issue correctly.

I understand that my issue may be closed if I don't fulfill my promises.

[cderv]

Apart from the quick advice and links in README (https://pkgs.rstudio.com/rticles/index.html#contribute-a-new-template-format-opening-a-pull-request) there is not writing in rticles that thoroughly details the step to create a new template.

I still plan to write about custom format in another edition of the R Markdown Cookbook (rstudio/rmarkdown-cookbook#285) but nothing it yet on paper and we did not cover this in the first edition.

Such guide or tutorial seems useful to me so feel free to write it from your experience. I'll be happy to review and link here!

[eliocamp]

Great. It would be great to have a list of tips, tricks, common patterns and gotchas to include. I'd love to have some from all the people who contributed.

[davidjrea]

Came across this issue while adapting a Springer-Nature template for purposes of submitting a paper to Health Care Management Science. Unfortunately, the rticles springer template doesn't quite match the expectations there.

I found this blog post to be helpful while adapting the original nature template for Rmarkdown and I think could act as a good starting place for a guide.

[cderv]

Unfortunately, the rticles springer template doesn't quite match the expectations there.

Unfortunately, we don't know exactly when a template does not fit anymore with expectation. Springer one was added in 2018 by #164 and not sure it has been updated by anyone since.

Please submit an issue about this and if you work on it, we are definitely welcoming a PR. I can help at any point in the process.
The template should definitely be updated.

And thanks for sharing the blog post - it is definitely a good resource. I'll try to write something specific to rticles soon.

[eliocamp]

I adapted the LNCS template (this PR) as part of developing the tutorial.

[davidjrea]

Unfortunately, we don't know exactly when a template does not fit anymore with expectation. Springer one was added in 2018 by #164 and not sure it has been updated by anyone since.

Please submit an issue about this and if you work on it, we are definitely welcoming a PR. I can help at any point in the process. The template should definitely be updated.

@cderv I think the issue is the source of the template --- svjour if I remember correctly. On compilation it looked more like a book than article. It also just might the odd requests of the specific journal, or a lack of effort on my part (I'm completely new to rticles).

I'll try and find some time to formalize the template I used and submit a PR, but it will likely not be for a good while.