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

adjustment to the conventions of the editor specifications to Sage-Ha… #452

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

maltehueckstaedt
Copy link
Contributor

adjustment to the conventions of the editor specifications to Sage-Havard.

  • "eds." -> "eds"
  • "ed." -> "ed"

See:
https://www.sagepub.com/sites/default/files/sage_harvard_reference_style_0.pdf

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). 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 [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!

@cderv
Copy link
Collaborator

cderv commented Nov 29, 2021

Hi @maltehueckstaedt !

I am fine with the change because you know more about me on this.

However, this included template is based on the files found on the sage pub website
https://uk.sagepub.com/en-gb/eur/manuscript-submission-guidelines#LATEX
There is a zip you can download there: https://uk.sagepub.com/sites/default/files/sage_latex_template_4.zip

In this zip folder, you will find a SageH.bst which is what we copied for our template. This contains

FUNCTION {bbl.editors}
{ "eds." }

FUNCTION {bbl.editor}
{ "ed." }

So should we made a change like this only in our version ? If there is an issue with the SageH.bst file, it would be better to ask them to update there template.

Otherwise, even if we make the correction here, next time we will update it will be lost.

Have you already reached out to Sage about this ?

@maltehueckstaedt
Copy link
Contributor Author

Hi @cderv!

So should we made a change like this only in our version ? If there is an issue with the SageH.bst file, it would be better to ask them to update there template.

Okay, I'll write Sage and get back to you when I have an answer.

regards,
Malte

@cderv
Copy link
Collaborator

cderv commented Nov 29, 2021

That is awesome, thanks a lot !

@cderv
Copy link
Collaborator

cderv commented Apr 19, 2023

Okay, I'll write Sage and get back to you when I have an answer.

@maltehueckstaedt did you get an answer after contacting Sage ?

@maltehueckstaedt
Copy link
Contributor Author

hey @cderv, no, unfortunately not!

@cderv cderv added the WIP label Apr 19, 2023
@cderv
Copy link
Collaborator

cderv commented Apr 19, 2023

Ok - thanks I'll see what to do with that. Maybe the bst file was updated

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Malte Hückstädt 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants