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 LIPIcs article format, closes #232 #288

Merged
merged 8 commits into from
Oct 29, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: rticles
Type: Package
Title: Article Formats for R Markdown
Version: 0.16.3
Version: 0.16.4
Authors@R: c(
person("JJ", "Allaire", role = "aut", email = "jj@rstudio.com"),
person("Yihui", "Xie", role = c("aut", "cre"), email = "xie@yihui.name", comment = c(ORCID = "0000-0003-0645-5666")),
Expand Down Expand Up @@ -49,10 +49,12 @@ Authors@R: c(
Description: A suite of custom R Markdown formats and templates for
authoring journal articles and conference submissions.
License: GPL-3
Imports: utils, rmarkdown (>= 2.5), knitr (>= 1.30), yaml, tinytex (>= 0.19), xfun
Imports: utils, rmarkdown (>= 2.5), knitr (>= 1.30), yaml, tinytex (>= 0.26.7), xfun
SystemRequirements: GNU make
URL: https://github.com/rstudio/rticles
BugReports: https://github.com/rstudio/rticles/issues
RoxygenNote: 7.1.1
Suggests: testit, bookdown, xtable
Encoding: UTF-8
Remotes:
yihui/tinytex
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export(ieee_article)
export(joss_article)
export(journals)
export(jss_article)
export(lipics_article)
export(mdpi_article)
export(mnras_article)
export(oup_article)
Expand Down
7 changes: 4 additions & 3 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
rticles 0.17
---------------------------------------------------------------------

- Fixes `ams_article()` template regarding authors insertion (thanks, #340, @ConorIA)
- Fixes `ams_article()` template regarding authors insertion (thanks, #340, @ConorIA).

- Update Copernicus Publications template to version 6.0 (#331) and sanitize
and issue that caused `pdftex` from hanging.
- Update Copernicus Publications template to version 6.0 and sanitize and issue that caused `pdftex` from hanging (thanks, #331, @RLumSK).

- Add `CSLReferences` environment to support new Pandoc 2.11 citation processing (#335).

- Add article template `lipics_article()` for *Leibniz International Proceedings in Informatics* (LIPIcs) (thanks, @nuest, #288).

rticles 0.16
---------------------------------------------------------------------

Expand Down
28 changes: 27 additions & 1 deletion R/article.R
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,32 @@ frontiers_article <- function(..., keep_tex = TRUE) {
pdf_document_format("frontiers", keep_tex = keep_tex, ...)
}

#' @section \code{lipics_article}: Format for creating submissions to
#' LIPIcs - Leibniz International Proceedings Informatics - articles.
#' Adapted from the official Instructions for Authors at
#' \url{https://submission.dagstuhl.de/documentation/authors} and the
#' template from the archive \code{authors-lipics-v2019.zip} downloaded
#' with version tag v2019.2. The template is provided under The LaTeX
#' Project Public License (LPPL), Version 1.3c.
#' @export
#' @rdname article
lipics_article <- function(
..., latex_engine = 'xelatex', # xelatex used for 'thin space' Unicode
# character, see YAML field 'authorrunning'
keep_tex = TRUE, citation_package = "natbib", md_extensions = c(
"-autolink_bare_uris", # disables automatic links
"-auto_identifiers" # disables \hypertarget commands
)
) {
# quick dev shortcut for Ubuntu: click "Install and restart" then run:
# unlink("MyArticle/", recursive = TRUE); rmarkdown::draft("MyArticle.Rmd", template = "lipics", package = "rticles", edit = FALSE); rmarkdown::render("MyArticle/MyArticle.Rmd"); system(paste0("xdg-open ", here::here("MyArticle", "MyArticle.pdf")))
pdf_document_format(
"lipics", latex_engine = latex_engine,
citation_package = citation_package, keep_tex = keep_tex,
md_extensions = md_extensions, ...
)
}

#' @section \code{mdpi_article}: Format for creating submissions to
#' Multidisciplinary Digital Publishing Institute (MDPI) journals. Adapted
#' from \url{https://www.mdpi.com/authors/latex}.
Expand Down Expand Up @@ -301,7 +327,7 @@ sim_article <- function(..., highlight = NULL, citation_package = "natbib") {
#' Macro package for Springer Journals.
#' @export
#' @rdname article
springer_article <- function(..., keep_tex = TRUE, citation_package = 'none'){
springer_article <- function(..., keep_tex = TRUE, citation_package = 'default'){
pdf_document_format(
"springer", keep_tex = keep_tex, citation_package = citation_package, ...
)
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Currently included templates and their contributors are the following:
| [IEEE Transaction](http://www.ieee.org/publications_standards/publications/authors/author_templates.html) | [@Emaasit](https://github.com/Emaasit), [@espinielli](https://github.com/espinielli), [@nathanweeks](https://github.com/nathanweeks), [@DunLug](https://github.com/DunLug) | [#97](https://github.com/rstudio/rticles/pull/97), [#169](https://github.com/rstudio/rticles/pull/169), [#227](https://github.com/rstudio/rticles/pull/227), [#263](https://github.com/rstudio/rticles/pull/263), [#264](https://github.com/rstudio/rticles/pull/264), [#265](https://github.com/rstudio/rticles/pull/265) | `ieee_article()` |
| [JOSS: Journal of Open Source Software](https://joss.theoj.org/) [JOSE: Journal of Open Source Education](https://jose.theoj.org/) | [@noamross](https://github.com/noamross) | [#229](https://github.com/rstudio/rticles/pull/229) | `joss_article()` |
| [JSS: Journal of Statistical Software](https://www.jstatsoft.org) | | | `jss_article()` |
| [LIPIcs](https://www.dagstuhl.de/en/publications/lipics) | [@nuest](https://github.com/nuest) | [#288](https://github.com/rstudio/rticles/pull/288) | `lipics_article()` |
| [MDPI](https://www.mdpi.com) | [@dleutnant](https://github.com/dleutnant) | [#147](https://github.com/rstudio/rticles/pull/147) | `mdpi_article()` |
| [MNRAS: Monthly Notices of the Royal Astronomical Society](https://academic.oup.com/mnras) | [@oleskiewicz](https://github.com/oleskiewicz) | [#175](https://github.com/rstudio/rticles/pull/175) | `mnras_article()` |
| [OUP: Oxford University Press](https://academic.oup.com/journals/pages/authors/preparing_your_manuscript) | [@dmkaplan](https://github.com/dmkaplan) | [#284](https://github.com/rstudio/rticles/pull/284) | `oup_articles()` |
Expand Down
74 changes: 74 additions & 0 deletions inst/rmarkdown/templates/lipics/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
LIPICS Style - CHANGELOG

* 19/07/2019 LIPIcs-v2019 v2.2
* New Feature
* explicitly defined/named colors used in style to ease reusing them (requires load of package xcolor instead of color)
* added document option "authorcolumns" to activate displaying author details in two columns (only allowed for more than 6 authors)
* revised style of algorithm environments provided by algorithm or algorithm2e packages
* added qed-like symbol to mark end of e.g. definitions (command \lipicsEnd)
* Bugfix
* fixed problem caused by "\\" in title macro

* 06/06/2019 LIPIcs-v2019 v2.1
* New Feature
* added document option "anonymous" to make author related information anonymous (e.g. for double-blind review)
* Bugfix
* fixed problems with using thm-restate (added new documentclass option thm-restate)
* fixed bug when using algorithm2e package and cleveref package
* fixed problems with texorpdfstring in author macro
* fixed spacing variation between author name and orcid symbol
* capitalised labels when using autoref (e.g. section -> Section)


* 10/12/2018 LIPIcs-v2019 v2.0
* New Features
* support of metadata in PDF file (e.g. author, title, keywords)
* revised displaying of author-related funding acknowledgements (now displayed as part of the funding block instead of footnotes)
* added support for cleveref package (new document option 'cleveref')
* added support for using autoref for theorem-like environments (new document option 'autoref')
* added new environment claim and claimproof to realize sub-proofs
* added new environment proposition
* Bugfixes
* fixed problems with theorem-like environments when using cleveref and autoref (see new features above)
* switched several URL from http to https
* fixed problems with using of ACM 2012 classification (deactivated subjclass and revised support of ccsdesc macro)
* Minor changes
* moved ORCID symbol behind author name (according https://orcid.org/content/journal-display-guidelines)
* added separator \and to split several affiliations
* added warnings when package 'enumitem' or 'paralist' are loaded; they manipulate the pre-defined enumeration styles and are partly incompatible
* preloaded package 'microtype' in style
* revised spacings/font sizes for top matter

* 09/04/2018 LIPIcs-v2018 v1.5
* Bugfixes
* Fixed problem with page style in case of many authors
* Fixed aggregation of authors for ToC file

* 15/03/2018 LIPIcs-v2018 v1.4
* Bugfixes
* Fixed enumerations
* Fixed aggregation of authors for ToC file

* 26/02/2018 LIPIcs-v2018 v1.3
* Bugfixes
* Fixed \hideLIPIcs
* Fixed enumerations
* Fixed typo
* Revised display of ORCIDs following recommendation by ORCID

* 06/02/2018 LIPIcs-v2018 v1.2
* Release of LIPIcs-v2018
* revised author macro \author{name}{affil}{email}{orcid}{funding}
* added support for ORCIDs
* switched to ACM 2012 classification system
* added new macros for extended metadata \category, \relatedversion, \supplement, \funding, \acknowledgements
* added warnings for missing mandatory metadata
* added preconfigured enumeration styles based on the enumerate package
* added option \hideLIPIcs to hide all LIPIcs related information
* added support for line numbers
* Bugfixes
* fixed copyright line
* added warning when using outdated subfig package due to incompatibilities in preloaded subcaption package
* fixed bug when using MnSymbol package
* fixed bug in numbering in theorem-like environments used in appendix
* fixed problems in ToC file
Loading