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 glossa_article() #361

Merged
merged 48 commits into from
Sep 7, 2021
Merged

add glossa_article() #361

merged 48 commits into from
Sep 7, 2021

Conversation

stefanocoretta
Copy link
Contributor

The pull request adds glossa_article() for articles of Glossa: a journal of general linguistics (Glossa).

✅ R CMD check succeeded.

✅ Pull request check list:

  • Unless you have done it in any other RStudio's projects before, please sign the individual or corporate contributor agreement for a significant pull request (it is fine not to sign it if a PR is only intended to fix a few typos). 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.

  • 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.

@stefanocoretta stefanocoretta marked this pull request as draft April 3, 2021 10:34
@stefanocoretta stefanocoretta marked this pull request as ready for review April 3, 2021 11:10
@stefanocoretta
Copy link
Contributor Author

@cderv macOS check fails with tlmgr not found.

@cderv cderv self-requested a review April 21, 2021 16:42
Copy link
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.

Thanks a lot for the contribution !

This looks good. But I have still a few questions.

Among the things that needs to be improve, the general feedback I have is that the skeleton needs to have some more content acting as documentation for user.

  • The template allows some configuration that are not shown in the skeleton (Pandoc's variable)
  • The content of the skeleton is empty, whereas the official template contains a lot of Guidelines that needs to be followed by a user. This should be used in the skeleton as documentation and demo.
  • Example Bibliography file is missing to test out that this works correctly with the citation processing (at least the default one)

I'll be happy to answer any questions about this and discuss anything. Feel free to ping me.

Thanks !

README.md Outdated Show resolved Hide resolved
inst/rmarkdown/templates/glossa/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
inst/rmarkdown/templates/glossa/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/glossa/resources/template.tex Outdated Show resolved Hide resolved
inst/rmarkdown/templates/glossa/skeleton/skeleton.Rmd Outdated Show resolved Hide resolved
R/article.R Show resolved Hide resolved
@stefanocoretta stefanocoretta marked this pull request as draft July 4, 2021 13:20
@stefanocoretta
Copy link
Contributor Author

I think I implemented all the fixes and changes. Let me know if there's anything else! Thanks for the patience.

@stefanocoretta stefanocoretta marked this pull request as ready for review July 10, 2021 14:48
Copy link
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.

Thanks! This looks good !

Two more questions before I merge.

Thanks!

inst/rmarkdown/templates/glossa/skeleton/glossa.csl Outdated Show resolved Hide resolved
@stefanocoretta stefanocoretta requested a review from cderv August 13, 2021 14:23
Copy link
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.

LGTM!

Just so you know, I adapted the skeleton to show how to use with natbib.
By default, you are using Pandoc's citeproc, the default with pdf_document(). In this case, a # References header will be required so that there is a title for the bibliography. When using biblatex, it seems the class option needs to be activated.

Anyway, this is working, we can adjust later if something is not right.

@cderv cderv merged commit 03b308e into rstudio:master Sep 7, 2021
@stefanocoretta stefanocoretta deleted the glossa-article branch September 7, 2021 19:58
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 7, 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.

5 participants