Rename package to revealjs.ids
Renames the fork so the IDS corporate design edition can be installed
alongside upstream rstudio/revealjs (same pattern as posterdown.ids).
Use revealjs.ids::revealjs_presentation in the R Markdown yaml header.
Changes: DESCRIPTION (Package name, Version -> 0.9.1.9009, Title notes
the IDS edition), R/utils.R package lookups, skeleton + RStudio
template identity (now 'Reveal.js Presentation (IDS CD theme)'),
README usage, GitLab CI render call, tests, examples. Old documents
referring to revealjs::revealjs_presentation need upstream revealjs
or a search/replace of the prefix.
Change-Id: Id3988b2c3fd348faca3c0951223d0b90c01741dc
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 37cb405..83bac2d 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -80,7 +80,7 @@
- start_section render "Running scripts"
- R_CACHE_ROOTPATH=./cache R -e "require(rmarkdown);
render('examples/ids.Rmd',
- output_format='revealjs::revealjs_presentation', output_dir='target')"
+ output_format='revealjs.ids::revealjs_presentation', output_dir='target')"
- ./ci/screenshot file://`pwd`/target/ids.html target/title.png
file://`pwd`/target/ids.html#/light-verb-constructions target/lvc.png
file://`pwd`/target/ids.html#/registered-users target/users.png
diff --git a/DESCRIPTION b/DESCRIPTION
index 06e0d4a..ac4cfe0 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
Type: Package
-Package: revealjs
-Title: R Markdown Format for 'reveal.js' Presentations
-Version: 0.9.1.9008
+Package: revealjs.ids
+Title: R Markdown Format for 'reveal.js' Presentations -- IDS Mannheim Corporate Design Theme Edition
+Version: 0.9.1.9009
Date: 2017-03-13
Authors@R: c(
person("Christophe", "Dervieux", , "cderv@posit.co", role = "cre"),
diff --git a/NEWS.md b/NEWS.md
index c67f08d..40a6e95 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,3 +1,7 @@
+# revealjs.ids 0.9.1.9009
+
+- Package renamed from `revealjs` to `revealjs.ids`, so the IDS corporate design edition can be installed alongside upstream rstudio/revealjs. Use it with `revealjs.ids::revealjs_presentation` in the R Markdown yaml header. Existing documents using `revealjs::revealjs_presentation` require upstream revealjs (or can be migrated by replacing the prefix).
+
# revealjs 0.9.1.9008
## REVEAL JS LIBRARY UPDATE
diff --git a/R/revealjs_presentation.R b/R/revealjs_presentation.R
index 8d1c9d8..bdc4153 100644
--- a/R/revealjs_presentation.R
+++ b/R/revealjs_presentation.R
@@ -119,7 +119,7 @@
#' \dontrun{
#'
#' library(rmarkdown)
-#' library(revealjs)
+#' library(revealjs.ids)
#'
#' # simple invocation
#' render("pres.Rmd", revealjs_presentation())
diff --git a/R/utils.R b/R/utils.R
index 10cd223..0c13ae5 100644
--- a/R/utils.R
+++ b/R/utils.R
@@ -2,14 +2,14 @@
reveal_resources <- function(...) {
system.file("rmarkdown/templates/revealjs_presentation/resources",
...,
- package = "revealjs")
+ package = "revealjs.ids")
}
revealjs_lib_path <- function(...) {
- pkg <- system.file(package = "revealjs")
+ pkg <- system.file(package = "revealjs.ids")
lib_folder <- list.files(pkg, pattern = "reveal.js-")[1]
- system.file(lib_folder, ..., package = "revealjs")
+ system.file(lib_folder, ..., package = "revealjs.ids")
}
revealjs_version <- function() {
diff --git a/README.Rmd b/README.Rmd
index 4b4a71e..089e48a 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -6,7 +6,7 @@
<!-- badges: start -->
[](https://CRAN.R-project.org/package=revealjs)
[](https://github.com/rstudio/revealjs/actions/workflows/R-CMD-check.yaml)
-[`-yellow)](https://github.com/rstudio/revealjs/tree/main/inst/reveal.js-`r revealjs:::revealjs_version()`)
+[`-yellow)](https://github.com/rstudio/revealjs/tree/main/inst/reveal.js-`r revealjs.ids:::revealjs_version()`)
<!-- badges: end -->
## Screenshots
@@ -22,7 +22,7 @@
## Overview
-This repository provides an [R Markdown](http://rmarkdown.rstudio.com) custom format for [reveal.js](https://revealjs.com/) HTML presentations. The packages includes _reveal.js_ library in version `r revealjs:::revealjs_version()`
+This repository provides an [R Markdown](http://rmarkdown.rstudio.com) custom format for [reveal.js](https://revealjs.com/) HTML presentations. The packages includes _reveal.js_ library in version `r revealjs.ids:::revealjs_version()`
You can use this format in R Markdown documents by installing this package as follows:
@@ -37,7 +37,7 @@
title: "Habits"
author: John Doe
date: March 22, 2005
-output: revealjs::revealjs_presentation
+output: revealjs.ids::revealjs_presentation
---
# In the morning
@@ -120,7 +120,7 @@
``` yaml
---
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
incremental: true
---
```
@@ -177,7 +177,7 @@
There are several options that control the appearance of revealjs presentations:
-- `theme` specifies the theme to use for the presentation (available themes are `r knitr::combine_words(setdiff(revealjs:::revealjs_themes(), "default"), before = '"', and = " or ")`
+- `theme` specifies the theme to use for the presentation (available themes are `r knitr::combine_words(setdiff(revealjs.ids:::revealjs_themes(), "default"), before = '"', and = " or ")`
- `highlight` specifies the syntax highlighting style. Supported styles include `r knitr::combine_words(rmarkdown:::highlighters(), before = '"', and = " or ")`. Pass null to prevent syntax highlighting.
@@ -187,7 +187,7 @@
``` yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
theme: sky
highlight: pygments
center: true
@@ -199,7 +199,7 @@
You can use the `transition` and `background_transition` options to specify the global default slide transition style:
-- `transition` specifies the visual effect when moving between slides. Available transitions are `r (trans <- knitr::combine_words(setdiff(revealjs:::revealjs_transitions(), "default"), before = '"', and = " or "))`.
+- `transition` specifies the visual effect when moving between slides. Available transitions are `r (trans <- knitr::combine_words(setdiff(revealjs.ids:::revealjs_transitions(), "default"), before = '"', and = " or "))`.
- `background_transition` specifies the background transition effect when moving between full page slides. Available transitions are `r trans`
@@ -207,7 +207,7 @@
``` yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
transition: fade
background_transition: slide
```
@@ -278,7 +278,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_options:
slideNumber: true
@@ -304,7 +304,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
fig_width: 7
fig_height: 6
fig_caption: true
@@ -349,7 +349,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
mathjax: local
self_contained: false
---
@@ -361,7 +361,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
mathjax: "http://example.com/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
---
```
@@ -372,7 +372,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
mathjax: null
---
```
@@ -385,7 +385,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
---
```
@@ -398,7 +398,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
lib_dir: libs
---
@@ -422,7 +422,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_plugins: ["notes", "search"]
---
@@ -434,7 +434,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_plugins: ["chalkboard", "menu"]
reveal_options:
@@ -487,7 +487,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
includes:
in_header: header.html
before_body: doc_prefix.html
@@ -503,7 +503,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
pandoc_args: [
"--title-prefix", "Foo",
"--id-prefix", "Bar"
@@ -520,7 +520,7 @@
**\_output.yaml**
``` yaml
-revealjs::revealjs_presentation:
+revealjs.ids::revealjs_presentation:
theme: sky
transition: fade
highlight: pygments
diff --git a/README.md b/README.md
index abb3c36..4400c22 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@
title: "Habits"
author: John Doe
date: March 22, 2005
-output: revealjs::revealjs_presentation
+output: revealjs.ids::revealjs_presentation
---
# In the morning
@@ -140,7 +140,7 @@
``` yaml
---
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
incremental: true
---
```
@@ -215,7 +215,7 @@
``` yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
theme: sky
highlight: pygments
center: true
@@ -240,7 +240,7 @@
``` yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
transition: fade
background_transition: slide
```
@@ -334,7 +334,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_options:
slideNumber: true
@@ -366,7 +366,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
fig_width: 7
fig_height: 6
fig_caption: true
@@ -421,7 +421,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
mathjax: local
self_contained: false
---
@@ -433,7 +433,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
mathjax: "http://example.com/mathjax/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
---
```
@@ -444,7 +444,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
mathjax: null
---
```
@@ -462,7 +462,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
---
```
@@ -484,7 +484,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
lib_dir: libs
---
@@ -511,7 +511,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_plugins: ["notes", "search"]
---
@@ -524,7 +524,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_plugins: ["chalkboard", "menu"]
reveal_options:
@@ -589,7 +589,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
includes:
in_header: header.html
before_body: doc_prefix.html
@@ -607,7 +607,7 @@
---
title: "Habits"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
pandoc_args: [
"--title-prefix", "Foo",
"--id-prefix", "Bar"
@@ -628,7 +628,7 @@
**\_output.yaml**
``` yaml
-revealjs::revealjs_presentation:
+revealjs.ids::revealjs_presentation:
theme: sky
transition: fade
highlight: pygments
diff --git a/examples/ids.Rmd b/examples/ids.Rmd
index 34c1f5f..4f6ea73 100644
--- a/examples/ids.Rmd
+++ b/examples/ids.Rmd
@@ -7,7 +7,7 @@
institute: "IDS Mannheim"
date: "`r paste0('Mannheim, ', Sys.Date())`"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
reveal_plugins:
- search
- zoom
diff --git a/examples/simple.Rmd b/examples/simple.Rmd
index 3ab2404..5565beb 100644
--- a/examples/simple.Rmd
+++ b/examples/simple.Rmd
@@ -1,7 +1,7 @@
---
title: "Untitled"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_plugins:
- search
diff --git a/inst/rmarkdown/templates/revealjs_presentation/skeleton/skeleton.Rmd b/inst/rmarkdown/templates/revealjs_presentation/skeleton/skeleton.Rmd
index d8309b9..27cb3fa 100644
--- a/inst/rmarkdown/templates/revealjs_presentation/skeleton/skeleton.Rmd
+++ b/inst/rmarkdown/templates/revealjs_presentation/skeleton/skeleton.Rmd
@@ -1,7 +1,7 @@
---
title: "Untitled"
output:
- revealjs::revealjs_presentation: default
+ revealjs.ids::revealjs_presentation: default
---
# R Markdown
@@ -118,7 +118,7 @@
```yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
transition: zoom
```
# Slide background {data-background-color="#33ffd8"}
@@ -147,7 +147,7 @@
```yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
background_transition: "zoom"
```
@@ -177,7 +177,7 @@
````yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_plugins: notes
````
@@ -199,7 +199,7 @@
This can be done on a per slide basis using `data-autoslide` or globally using
````yaml
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
autoSlide: 10000 #10 sec
````
# Auto slide next
diff --git a/inst/rmarkdown/templates/revealjs_presentation/template.yaml b/inst/rmarkdown/templates/revealjs_presentation/template.yaml
index 044aa0b..d88ce65 100644
--- a/inst/rmarkdown/templates/revealjs_presentation/template.yaml
+++ b/inst/rmarkdown/templates/revealjs_presentation/template.yaml
@@ -1,4 +1,4 @@
-name: Reveal.js Presentation (HTML)
+name: Reveal.js Presentation (IDS CD theme)
description: >
- Template for HTML presentations based on reveal.js
+ Template for HTML presentations in the IDS Mannheim corporate design (based on reveal.js)
create_dir: false
diff --git a/tests/manual/test-incremental-attributes.Rmd b/tests/manual/test-incremental-attributes.Rmd
index d9ff640..b90d424 100644
--- a/tests/manual/test-incremental-attributes.Rmd
+++ b/tests/manual/test-incremental-attributes.Rmd
@@ -1,7 +1,7 @@
---
title: "Incremental using attributes"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
incremental: false
---
diff --git a/tests/manual/test-incremental-globally.Rmd b/tests/manual/test-incremental-globally.Rmd
index c4a3c80..6435590 100644
--- a/tests/manual/test-incremental-globally.Rmd
+++ b/tests/manual/test-incremental-globally.Rmd
@@ -1,7 +1,7 @@
---
title: "Incremental globally"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
incremental: true
---
diff --git a/tests/manual/test-incremental-locally.Rmd b/tests/manual/test-incremental-locally.Rmd
index 1d1ebe6..38ad0c2 100644
--- a/tests/manual/test-incremental-locally.Rmd
+++ b/tests/manual/test-incremental-locally.Rmd
@@ -1,7 +1,7 @@
---
title: "Incremental locally"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
incremental: false
---
diff --git a/tests/manual/test-incremental-pausing.Rmd b/tests/manual/test-incremental-pausing.Rmd
index 48174db..0da11f5 100644
--- a/tests/manual/test-incremental-pausing.Rmd
+++ b/tests/manual/test-incremental-pausing.Rmd
@@ -1,6 +1,6 @@
---
title: "Incremental by pausing"
-output: revealjs::revealjs_presentation
+output: revealjs.ids::revealjs_presentation
---
# Pausing using pandoc syntax
diff --git a/tests/manual/test-options-size.Rmd b/tests/manual/test-options-size.Rmd
index 89862d8..a4a675a 100644
--- a/tests/manual/test-options-size.Rmd
+++ b/tests/manual/test-options-size.Rmd
@@ -1,6 +1,6 @@
---
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
reveal_options:
width: "100%"
height: "100%"
diff --git a/tests/manual/test-plugin-chalkboard.Rmd b/tests/manual/test-plugin-chalkboard.Rmd
index 1f6c00b..215ae75 100644
--- a/tests/manual/test-plugin-chalkboard.Rmd
+++ b/tests/manual/test-plugin-chalkboard.Rmd
@@ -1,7 +1,7 @@
---
title: "chalkboard plugin"
output:
- revealjs::revealjs_presentation:
+ revealjs.ids::revealjs_presentation:
self_contained: false
reveal_plugins: ["chalkboard"]
reveal_options:
diff --git a/tests/manual/test-widget-highcharter.Rmd b/tests/manual/test-widget-highcharter.Rmd
index 34cdc8e..c0a2673 100644
--- a/tests/manual/test-widget-highcharter.Rmd
+++ b/tests/manual/test-widget-highcharter.Rmd
@@ -1,7 +1,7 @@
---
title: "Rmarkdown Presentation including Plotly"
output:
- revealjs::revealjs_presentation
+ revealjs.ids::revealjs_presentation
---
# Setup
diff --git a/tests/manual/test-widget-leaflet.Rmd b/tests/manual/test-widget-leaflet.Rmd
index 2b57ede..6abe75e 100644
--- a/tests/manual/test-widget-leaflet.Rmd
+++ b/tests/manual/test-widget-leaflet.Rmd
@@ -1,7 +1,7 @@
---
title: "Rmarkdown Presentation including Leaflet"
output:
- revealjs::revealjs_presentation
+ revealjs.ids::revealjs_presentation
---
```{r, include = FALSE}
diff --git a/tests/manual/test-widget-plotly.Rmd b/tests/manual/test-widget-plotly.Rmd
index 1090198..2291d15 100644
--- a/tests/manual/test-widget-plotly.Rmd
+++ b/tests/manual/test-widget-plotly.Rmd
@@ -1,7 +1,7 @@
---
title: "Rmarkdown Presentation including Plotly"
output:
- revealjs::revealjs_presentation
+ revealjs.ids::revealjs_presentation
---
# Setup
diff --git a/tests/testthat.R b/tests/testthat.R
index e6bfcd1..5daa18b 100644
--- a/tests/testthat.R
+++ b/tests/testthat.R
@@ -1,4 +1,4 @@
library(testthat)
-library(revealjs)
+library(revealjs.ids)
-test_check("revealjs")
+test_check("revealjs.ids")
diff --git a/tests/testthat/helpers.R b/tests/testthat/helpers.R
index ce5d6c4..894f680 100644
--- a/tests/testthat/helpers.R
+++ b/tests/testthat/helpers.R
@@ -9,7 +9,7 @@
# TODO: Use `rmarkdown::draft()` when rmarkdown 2.12 is out.
pkg_file <- getFromNamespace("pkg_file", "rmarkdown")
template_path <- pkg_file("rmarkdown", "templates", "revealjs_presentation",
- package = "revealjs")
+ package = "revealjs.ids")
rmarkdown::draft(path, template_path, edit = FALSE)
}
diff --git a/tests/testthat/test-themes.R b/tests/testthat/test-themes.R
index d217d06..b19e1de 100644
--- a/tests/testthat/test-themes.R
+++ b/tests/testthat/test-themes.R
@@ -13,7 +13,7 @@
testdoc <- "testdoc.Rmd"
rmarkdown::draft(testdoc,
system.file("rmarkdown", "templates", "revealjs_presentation",
- package = "revealjs"),
+ package = "revealjs.ids"),
create_dir = FALSE,
edit = FALSE)
@@ -31,4 +31,4 @@
}
# test all themes
-sapply(revealjs:::revealjs_themes(), test_theme)
+sapply(revealjs.ids:::revealjs_themes(), test_theme)
diff --git a/tests/testthat/test-utils.R b/tests/testthat/test-utils.R
index 98ec1d0..56e95a4 100644
--- a/tests/testthat/test-utils.R
+++ b/tests/testthat/test-utils.R
@@ -35,7 +35,7 @@
})
test_that("revealjs lib path is found in package", {
- expect_match(revealjs_lib_path(), "revealjs/(inst/)?reveal\\.js-")
+ expect_match(revealjs_lib_path(), "revealjs(\\.ids)?/(inst/)?reveal\\.js-")
expect_true(dir.exists(revealjs_lib_path()))
})