Skip to content

Commit ae1cf7c

Browse files
ben-schwenaitap
andauthored
switch output format in vignettes to litedown html (#7628)
* switch output format in vignettes to litedown html * adjust paths * adjust path for base vignette * Detect current directory being "vignettes" * Update inline code blocks * Also update inline code blocks in translations * Don't normalize paths that are't necessarily valid Just check against "vignettes/foo.Rmd" or (implied ./)"bar.Rmd". * Clean up duplicated translation links --------- Co-authored-by: Ivan K <krylov.r00t@gmail.com>
1 parent b537ec4 commit ae1cf7c

16 files changed

Lines changed: 25 additions & 34 deletions

vignettes/_translation_links.R

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,15 @@
22
# idea is to look like 'Other languages: en | fr | de'
33
.write.translation.links = function(fmt) {
44
url = "https://rdatatable.gitlab.io/data.table/articles"
5-
path = dirname(litedown::get_context("input"))
6-
if (basename(path) == "vignettes") {
5+
context = litedown::get_context("input")
6+
path = dirname(context)
7+
if (basename(path) %in% c(".", "vignettes")) {
78
lang = "en"
89
} else {
910
lang = basename(path)
10-
path = dirname(path)
11+
path = ".."
1112
}
12-
translation = dir(path,
13-
recursive = TRUE,
14-
pattern = glob2rx(litedown::get_context("input"))
15-
)
13+
translation = dir(path = path, recursive = TRUE, pattern = basename(context))
1614
transl_lang = ifelse(dirname(translation) == ".", "en", dirname(translation))
1715
block = if (!all(transl_lang == lang)) {
1816
linked_transl = sprintf("[%s](%s)", transl_lang, file.path(url, sub("(?i)\\.Rmd$", ".html", translation)))

vignettes/datatable-fread-and-fwrite.Rmd

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: "Fast Read and Fast Write"
3-
date: "`r Sys.Date()`"
4-
output:
5-
markdown::html_format
3+
date: "`{r} Sys.Date()`"
4+
output: litedown::html_format
65
vignette: >
76
%\VignetteIndexEntry{Fast Read and Fast Write}
87
%\VignetteEngine{litedown::vignette}
@@ -11,7 +10,7 @@ vignette: >
1110

1211
```{r echo=FALSE, file='_translation_links.R'}
1312
```
14-
`r .write.translation.links("Translations of this document are available in: %s")`
13+
`{r} .write.translation.links("Translations of this document are available in: %s")`
1514

1615
```{r, echo = FALSE, message = FALSE}
1716
require(data.table)

vignettes/es/datatable-fread-and-fwrite.Rmd

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: "Lectura y escritura rápida: fread()/fwrite()"
3-
date: "`r Sys.Date()`"
4-
output:
5-
markdown::html_format
3+
date: "`{r} Sys.Date()`"
4+
output: litedown::html_format
65
vignette: >
76
%\VignetteIndexEntry{Fast Read and Fast Write}
87
%\VignetteEngine{litedown::vignette}
@@ -12,7 +11,7 @@ vignette: >
1211
```{r echo=FALSE, file='../_translation_links.R'}
1312
```
1413

15-
`r .write.translation.links("Las traducciones de este documento están disponibles en: %s")`
14+
`{r} .write.translation.links("Las traducciones de este documento están disponibles en: %s")`
1615

1716
```{r, echo = FALSE, message = FALSE}
1817
require(data.table)

vignettes/fr/datatable-benchmarking.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Analyse comparative (benchmark) de data.table"
33
date: "`{r} Sys.Date()`"
44
output:
5-
markdown::html_format:
5+
litedown::html_format:
66
options:
77
toc: true
88
number_sections: true

vignettes/fr/datatable-faq.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Foire aux questions de data.table"
33
date: "`{r} Sys.Date()`"
44
output:
5-
markdown::html_format:
5+
litedown::html_format:
66
options:
77
toc: true
88
number_sections: true

vignettes/fr/datatable-fread-and-fwrite.Rmd

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: "Lecture et écriture rapides"
3-
date: "`r Sys.Date()`"
4-
output:
5-
markdown::html_format
3+
date: "`{r} Sys.Date()`"
4+
output: litedown::html_format
65
vignette: >
76
%\VignetteIndexEntry{Lecture et écriture rapides}
87
%\VignetteEngine{litedown::vignette}

vignettes/fr/datatable-intro.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Introduction à data.table"
33
date: "`{r} Sys.Date()`"
44
output:
5-
markdown::html_format
5+
litedown::html_format
66
vignette: >
77
%\VignetteIndexEntry{Introduction à data.table}
88
%\VignetteEngine{litedown::vignette}

vignettes/fr/datatable-keys-fast-subset.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Extraire des sous-ensemble avec les clés et la recherche binaire rapide"
33
date: "`{r} Sys.Date()`"
44
output:
5-
markdown::html_format
5+
litedown::html_format
66
vignette: >
77
%\VignetteIndexEntry{Extraire des sous-ensemble avec les clés et la recherche binaire rapide}
88
%\VignetteEngine{litedown::vignette}

vignettes/fr/datatable-programming.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Programmation avec data.table"
33
date: "`{r} Sys.Date()`"
44
output:
5-
markdown::html_format
5+
litedown::html_format
66
vignette: >
77
%\VignetteIndexEntry{Programmation avec data.table}
88
%\VignetteEngine{litedown::vignette}

vignettes/fr/datatable-reference-semantics.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Sémantique de référence"
33
date: "`{r} Sys.Date()`"
44
output:
5-
markdown::html_format
5+
litedown::html_format
66
vignette: >
77
%\VignetteIndexEntry{Sémantique de référence}
88
%\VignetteEngine{litedown::vignette}

0 commit comments

Comments
 (0)