Skip to content

oup_article() support for old and new template#431

Merged
cderv merged 64 commits intorstudio:masterfrom
dmkaplan2000:newoldouptemplate
Nov 30, 2021
Merged

oup_article() support for old and new template#431
cderv merged 64 commits intorstudio:masterfrom
dmkaplan2000:newoldouptemplate

Conversation

@dmkaplan2000
Copy link
Copy Markdown
Contributor

Update to OUP format including both old and new templates, with a parameter in the formatting function controlling switching between the two.

It is generally working, but the testing part of the package will not work because it currently assumes that 1 format = 1 directory with the same name, which is not the case for this format. I will leave it to you to correct this.


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):

  • [X ] 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). We use a tool called CLA assistant for that.
    You could also, unless you have done it in any other RStudio's projects before, sign the individual or corporate contributor agreement. You can send the signed copy to jj@rstudio.com.

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

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

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

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

  • [X ] 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).

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

  • [X ] Update NEWS.

  • [X ] 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.

  • [X ] 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!

David M. Kaplan and others added 30 commits January 23, 2020 00:22
Citations not working and strange things happen with a final section, but most other things seem to be working.

Template needs further work to do equations and cross-referencing correctly.
Merging back my changes accepted into rstudio version of rticles after pull request.
…box.

Modifying template to show how to use knitr::kable for generating tables
and how to use place floats at end and number lines using header-includes.
Progress towards working template.tex, but still not done.
…meric

and namedate bibliographies work, but citations not working correctly for
numeric and tables and figures are out of whack.
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Jul 29, 2021

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ cderv
✅ yihui
❌ David M. Kaplan


David M. Kaplan seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Copy Markdown
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @dmkaplan2000 !

I have finished the PR based on our previous discussions. Thanks a lot for the hard work on this and all the answers you gave.

We have now one oup_article() but using two templates based on oup_version().
Hopefully this should solve the issue and suits the need of #418 and #419, right ?

About the CLA, I think you have already send it from your previous work.

I'll merge this PR and we can adapt for the other needs if somethings are missing.

@cderv cderv mentioned this pull request Nov 30, 2021
[skip ci]
@cderv cderv changed the title Newoldouptemplate - update including both old and new OUP formats with possibility to switch between the two with a parameter oup_article() support for old and new template Nov 30, 2021
@cderv cderv merged commit f4ef534 into rstudio:master Nov 30, 2021
@dmkaplan2000
Copy link
Copy Markdown
Contributor Author

Thanks for this. I will look at the new version down the road, but I am a bit busy right now, so it won't be right away.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jun 6, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants