Skip to content

Commit

Permalink
add LIPIcs article format, closes #232
Browse files Browse the repository at this point in the history
  • Loading branch information
nuest committed May 7, 2020
1 parent 0cbd7ac commit 2050263
Show file tree
Hide file tree
Showing 17 changed files with 3,550 additions and 0 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export(frontiers_article)
export(ieee_article)
export(joss_article)
export(jss_article)
export(lipics_article)
export(mdpi_article)
export(mnras_article)
export(oup_article)
Expand Down
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
rticles 0.15
---------------------------------------------------------------------

- Added Leibniz International Proceedings in Informatics (LIPIcs) template (thanks, @nuest, #288).


rticles 0.14
---------------------------------------------------------------------
Expand Down
44 changes: 44 additions & 0 deletions R/lipics_article.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
#' LIPIcs article format.
#'
#' Format for creating submissions to LIPIcs - Leibniz International Proceedings in Informatics.
#'
#' @inheritParams rmarkdown::pdf_document
#' @param ... Additional arguments to \code{rmarkdown::pdf_document()}.
#'
#' @return An R Markdown output format.
#'
#' @details This was 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.1.
#' The template is provided under The LaTeX Project Public License (LPPL), Version 1.3c.
#'
#' \strong{Important note:} This template is not officially supported by Dagstuhl Publishing.
#' Therefore please carefully ensure that the mandatory elements and the "don'ts" in the official Instructions for Authors are followed.
#'
#' @references
#' Instructions for Authors website.
#' \url{https://submission.dagstuhl.de/documentation/authors#}
#'
#' Dagstuhl Publishing, 2019. LIPIcs: Instructions for Authors and the \code{lipics-v2019} Class.
#' \url{https://submission.dagstuhl.de/styles/instructions/9}
#'
#' @examples
#' \dontrun{
#' library("rmarkdown")
#' draft("MyArticle.Rmd", template = "lipics_article", package = "rticles")
#' render("MyArticle/MyArticle.Rmd")
#' }
#' @export
lipics_article <- function(
..., keep_tex = TRUE, citation_package = "natbib", md_extensions = c(
"-autolink_bare_uris", # disables automatic links
"-auto_identifiers" # disables \hypertarget commands
)
) {
pdf_document_format(
"lipics_article", citation_package = citation_package,
keep_tex = keep_tex, md_extensions = md_extensions, ...
)
}

# quick dev shortcut for Ubuntu: click "Install and restart" then run:
# unlink("MyArticle/", recursive = TRUE); rmarkdown::draft("MyArticle.Rmd", template = "lipics_article", package = "rticles", edit = FALSE); rmarkdown::render("MyArticle/MyArticle.Rmd"); system(paste0("xdg-open ", here::here("MyArticle", "MyArticle.pdf")))
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ The **rticles** package provides a suite of custom [R Markdown](http://rmarkdown

- [JOSS](http://joss.theoj.org/) and [JOSE](https://jose.theoj.org/) articles

- [LIPIcs](https://www.dagstuhl.de/en/publications/lipics) articles

- [MDPI](http://www.mdpi.com) journal submissions

- [Monthly Notices of the Royal Astronomical Society](https://academic.oup.com/mnras) articles
Expand Down
74 changes: 74 additions & 0 deletions inst/rmarkdown/templates/lipics_article/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

0 comments on commit 2050263

Please sign in to comment.