Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support to all bibliography styles required by Taylor & Francis journals #581

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

rlaboiss
Copy link

  • R/article.R: Check whether the biblio-style field in the YAML header contains one of the allowed values
  • inst/rmarkdown/templates/tf/skeleton/interact.cls: Update to version v1.05
  • inst/rmarkdown/templates/tf/resources/template.tex: Choose the bibliography-related code according to biblio-style
  • inst/rmarkdown/templates/tf/skeleton/tf{nlm,p,q,s}.bst: Add lacking bibliography style files from T&F
  • man/article.Rd: Document the changes

How to contribute a new output format ?

To contribute a new article template to this package, please make sure you have done the following things (note that journalname_article below is only an example name):

  • This project uses a Contributor Licence Agreement (CLA) that you'll be asked to sign when opening a PR. This is required for a significant pull request (it is fine not to sign it if a PR is only intended to fix a few typos). Unless you have done it in any other RStudio / Posit projects before, sign the individual or corporate contributor agreement as appropriate. You can send the signed copy to [email protected].

  • Add the journalname_article() function to R/article.R if the output format is simple enough, otherwise create a separate R/journalname_article.R.

  • Document your function using roxygen2. Markdown syntax is supported. Refer to https://roxygen2.r-lib.org/articles/rd-formatting.html for formatting references.

  • Add the Pandoc LaTeX template inst/rmarkdown/templates/journalname/resources/template.tex.

  • Add a skeleton article inst/rmarkdown/templates/journalname/skeleton/skeleton.Rmd.

  • Add a description of the template inst/rmarkdown/templates/journalname/template.yaml.

  • Please include the document class file (*.cls) if needed, but please do not include standard LaTeX packages (*.sty) that can be downloaded from CTAN. If you are using TinyTeX or TeX Live, you can verify if a package is available on CTAN via tinytex::parse_packages(files = "FILENAME"") (e.g., when FILENAME is plain.bst, it should return "bibtex", which means this file is from a standard CTAN package). Please keep the number of new files absolutely minimal (e.g., do not include PDF output files), and also make examples minimal (e.g., if you need a .bib example, try to only leave one or two bibliography entries in it, and don't include too many items in it without using all of them).

  • Update Rd and namespace (could be done by devtools::document()).

  • Update NEWS.

  • Update README with a link to the newly supported journal. Please add your Github username and the full name of the journal (follow other examples in the list).

  • Add a test to tests/testit/test-formats.R by adding a line test_format("journalname"). We try to keep them in alphabetical order.

  • Add your name to the list of authors Authors@R in DESCRIPTION. You don't need to bump the package version in DESCRIPTION.

Lastly, please try your best to do only one thing per pull request (e.g., if you want to add two output formats, do them in two separate pull requests), and refrain from making cosmetic changes in the code base: https://yihui.name/en/2018/02/bite-sized-pull-requests/

Thank you!

…ournals

* R/article.R: Check whether the biblio-style field in the YAML header
  contains one of the allowed values
* inst/rmarkdown/templates/tf/skeleton/interact.cls: Update to version v1.05
* inst/rmarkdown/templates/tf/resources/template.tex: Choose the
  bibliography-related code according to biblio-style
* inst/rmarkdown/templates/tf/skeleton/tf{nlm,p,q,s}.bst: Add lacking
  bibliography style files from T&F
* man/article.Rd: Document the changes
@CLAassistant
Copy link

CLAassistant commented Nov 30, 2024

CLA assistant check
All committers have signed the CLA.

* R/article.R: Add option biblio_style (with default value "CAD"), which is
used to set the bst-name pandoc substitution variable
* inst/rmarkdown/templates/tf/resources/template.tex:
  - Use variable bst-name
  - This simplifies the \bibliographystyle command
* man/article.Rd: Update documentation for tf_article
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants