Skip to content

Commit 2050263

Browse files
committed
add LIPIcs article format, closes rstudio#232
1 parent 0cbd7ac commit 2050263

File tree

17 files changed

+3550
-0
lines changed

17 files changed

+3550
-0
lines changed

NAMESPACE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export(frontiers_article)
1616
export(ieee_article)
1717
export(joss_article)
1818
export(jss_article)
19+
export(lipics_article)
1920
export(mdpi_article)
2021
export(mnras_article)
2122
export(oup_article)

NEWS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
rticles 0.15
22
---------------------------------------------------------------------
33

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

57
rticles 0.14
68
---------------------------------------------------------------------

R/lipics_article.R

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
#' LIPIcs article format.
2+
#'
3+
#' Format for creating submissions to LIPIcs - Leibniz International Proceedings in Informatics.
4+
#'
5+
#' @inheritParams rmarkdown::pdf_document
6+
#' @param ... Additional arguments to \code{rmarkdown::pdf_document()}.
7+
#'
8+
#' @return An R Markdown output format.
9+
#'
10+
#' @details This was adapted from the official Instructions for Authors at
11+
#' \url{https://submission.dagstuhl.de/documentation/authors#} and the template from the archive \code{authors-lipics-v2019.zip} downloaded with version tag v2019.1.
12+
#' The template is provided under The LaTeX Project Public License (LPPL), Version 1.3c.
13+
#'
14+
#' \strong{Important note:} This template is not officially supported by Dagstuhl Publishing.
15+
#' Therefore please carefully ensure that the mandatory elements and the "don'ts" in the official Instructions for Authors are followed.
16+
#'
17+
#' @references
18+
#' Instructions for Authors website.
19+
#' \url{https://submission.dagstuhl.de/documentation/authors#}
20+
#'
21+
#' Dagstuhl Publishing, 2019. LIPIcs: Instructions for Authors and the \code{lipics-v2019} Class.
22+
#' \url{https://submission.dagstuhl.de/styles/instructions/9}
23+
#'
24+
#' @examples
25+
#' \dontrun{
26+
#' library("rmarkdown")
27+
#' draft("MyArticle.Rmd", template = "lipics_article", package = "rticles")
28+
#' render("MyArticle/MyArticle.Rmd")
29+
#' }
30+
#' @export
31+
lipics_article <- function(
32+
..., keep_tex = TRUE, citation_package = "natbib", md_extensions = c(
33+
"-autolink_bare_uris", # disables automatic links
34+
"-auto_identifiers" # disables \hypertarget commands
35+
)
36+
) {
37+
pdf_document_format(
38+
"lipics_article", citation_package = citation_package,
39+
keep_tex = keep_tex, md_extensions = md_extensions, ...
40+
)
41+
}
42+
43+
# quick dev shortcut for Ubuntu: click "Install and restart" then run:
44+
# 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")))

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ The **rticles** package provides a suite of custom [R Markdown](http://rmarkdown
4343

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

46+
- [LIPIcs](https://www.dagstuhl.de/en/publications/lipics) articles
47+
4648
- [MDPI](http://www.mdpi.com) journal submissions
4749

4850
- [Monthly Notices of the Royal Astronomical Society](https://academic.oup.com/mnras) articles
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
LIPICS Style - CHANGELOG
2+
3+
* 19/07/2019 LIPIcs-v2019 v2.2
4+
* New Feature
5+
* explicitly defined/named colors used in style to ease reusing them (requires load of package xcolor instead of color)
6+
* added document option "authorcolumns" to activate displaying author details in two columns (only allowed for more than 6 authors)
7+
* revised style of algorithm environments provided by algorithm or algorithm2e packages
8+
* added qed-like symbol to mark end of e.g. definitions (command \lipicsEnd)
9+
* Bugfix
10+
* fixed problem caused by "\\" in title macro
11+
12+
* 06/06/2019 LIPIcs-v2019 v2.1
13+
* New Feature
14+
* added document option "anonymous" to make author related information anonymous (e.g. for double-blind review)
15+
* Bugfix
16+
* fixed problems with using thm-restate (added new documentclass option thm-restate)
17+
* fixed bug when using algorithm2e package and cleveref package
18+
* fixed problems with texorpdfstring in author macro
19+
* fixed spacing variation between author name and orcid symbol
20+
* capitalised labels when using autoref (e.g. section -> Section)
21+
22+
23+
* 10/12/2018 LIPIcs-v2019 v2.0
24+
* New Features
25+
* support of metadata in PDF file (e.g. author, title, keywords)
26+
* revised displaying of author-related funding acknowledgements (now displayed as part of the funding block instead of footnotes)
27+
* added support for cleveref package (new document option 'cleveref')
28+
* added support for using autoref for theorem-like environments (new document option 'autoref')
29+
* added new environment claim and claimproof to realize sub-proofs
30+
* added new environment proposition
31+
* Bugfixes
32+
* fixed problems with theorem-like environments when using cleveref and autoref (see new features above)
33+
* switched several URL from http to https
34+
* fixed problems with using of ACM 2012 classification (deactivated subjclass and revised support of ccsdesc macro)
35+
* Minor changes
36+
* moved ORCID symbol behind author name (according https://orcid.org/content/journal-display-guidelines)
37+
* added separator \and to split several affiliations
38+
* added warnings when package 'enumitem' or 'paralist' are loaded; they manipulate the pre-defined enumeration styles and are partly incompatible
39+
* preloaded package 'microtype' in style
40+
* revised spacings/font sizes for top matter
41+
42+
* 09/04/2018 LIPIcs-v2018 v1.5
43+
* Bugfixes
44+
* Fixed problem with page style in case of many authors
45+
* Fixed aggregation of authors for ToC file
46+
47+
* 15/03/2018 LIPIcs-v2018 v1.4
48+
* Bugfixes
49+
* Fixed enumerations
50+
* Fixed aggregation of authors for ToC file
51+
52+
* 26/02/2018 LIPIcs-v2018 v1.3
53+
* Bugfixes
54+
* Fixed \hideLIPIcs
55+
* Fixed enumerations
56+
* Fixed typo
57+
* Revised display of ORCIDs following recommendation by ORCID
58+
59+
* 06/02/2018 LIPIcs-v2018 v1.2
60+
* Release of LIPIcs-v2018
61+
* revised author macro \author{name}{affil}{email}{orcid}{funding}
62+
* added support for ORCIDs
63+
* switched to ACM 2012 classification system
64+
* added new macros for extended metadata \category, \relatedversion, \supplement, \funding, \acknowledgements
65+
* added warnings for missing mandatory metadata
66+
* added preconfigured enumeration styles based on the enumerate package
67+
* added option \hideLIPIcs to hide all LIPIcs related information
68+
* added support for line numbers
69+
* Bugfixes
70+
* fixed copyright line
71+
* added warning when using outdated subfig package due to incompatibilities in preloaded subcaption package
72+
* fixed bug when using MnSymbol package
73+
* fixed bug in numbering in theorem-like environments used in appendix
74+
* fixed problems in ToC file

0 commit comments

Comments
 (0)