Skip to contents

Multilingual Quarto books with babeldown and babelquarto

Source: vignettes/articles/quarto.Rmd
quarto.Rmd

With babelquarto, you can create and render an HTML book in multiple languages, where each book page will link to the version in other languages. An example is rOpenSci dev guide’s dev version.

You might first write a whole book in a main language, English for instance. Then you add chapters in another language, say Spanish, one by one. The file intro.qmd is now accompanied by intro.es.qmd.

babelquarto helps you render the book thanks to registering languages in the configuration.

babeldown helps you translate each book chapter. An ideal workflow is to

  1. first register languages in the configuration,
  2. after which you translate chapters one by one with babeldown before having a human review the translation.

Create and render a multilingual book

Here we create a book with Quarto and then register languages.

You could also create a babelquarto-like Quarto book directly by running babelquarto::quarto_multilingual_book() but that’s perhaps less realistic: we imagine it’s more likely you’re starting from an existing book in a default language.

parent_dir <- withr::local_tempdir()
book_dir <- "babelbook"
quarto_bin <- quarto::quarto_path()
withr::with_dir(parent_dir, {
  sys::exec_wait(
    quarto_bin,
    args = c("create-project", book_dir, "--type", "book")
  )
})
#> [1] 0

Now let’s edit the Quarto configuration.

book_path <- file.path(parent_dir, book_dir)
babelquarto::register_main_language(main_language = "en", project_path = book_path)
babelquarto::register_further_languages(further_languages = "es", project_path = book_path)

This is how the config file now looks like:

project:
  type: book

book:
  title: "babelbook"
  author: "Norah Jones"
  date: "4/19/2024"
  chapters:
    - index.qmd
    - intro.qmd
    - summary.qmd
    - references.qmd

bibliography: references.bib

format:
  html:
    theme: cosmo
  pdf:
    documentclass: scrreprt




babelquarto:
  languagecodes:
  - name: es
    text: "Version in es"
  - name: en
    text: "Version in en"
  mainlanguage: 'en'
  languages: ['es']
title-es: title in es
description-es: description in es
author-es: author in es
lang: en

You can either fill in or delete the fields title-es, description-es, author-es: babelquarto will fall back to the English fields. The author string in particular, might be the same in all languages, unless some of it is “team members” instead of names.

From here, we can already render our book in the two languages. But at this point, since there’s no Spanish chapter, the Spanish version will fall back on English chapters and the only difference will be the language of, say, “table of contents”.

babelquarto::render_book(book_path)
# servr::httw(file.path(parent_dir, book_dir, "_book"))

Translate multilingual book chapters

Now let’s translate one of the chapters, automatically, to Spanish.

Ideally you’d pair this with the creation of a git branch! This way, the translation can be reviewed in a PR.

Workflow 1

  • Initiate the PR.
# In practice you'd probably be inside the book project!
usethis::local_project(book_path)
usethis::pr_init("index-es")
  • Translate intro.qmd.
Sys.setenv("DEEPL_API_URL" = "https://api.deepl.com")
Sys.setenv(DEEPL_API_KEY = keyring::key_get("deepl"))
babeldown::deepl_translate_quarto(
  book_path,
  "intro.qmd",
  render = TRUE,
  source_lang = "EN",
  target_lang = "ES",
  formality = "less"
)
  • Commit and push
gert::git_add("index.es.qmd")
gert::git_commit(message = "Translate index.qmd to Spanish")
usethis::pr_push()

Example PR

Actually this might be a not optimal PR: you might prefer to first create a Spanish file index.es.qmd with the content of the English file on the main branch, then to create the branch and translation, so that the diff might contain the difference between the Spanish and English version, not between the Spanish version and nothing. For this, see the workflow 2.

Workflow 2

  • Duplicate the file on the main branch.
withr::local_dir(book_path)
fs::file_copy("index.qmd", "index.es.qmd")
gert::git_add("index.es.qmd")
gert::git_commit("Add placeholder index.es.qmd")
gert::git_push()
  • Initiate the PR.
# In practice you'd probably be inside the book project!
usethis::local_project(book_path)
usethis::pr_init("index-es2")
  • Translate intro.qmd.
Sys.setenv("DEEPL_API_URL" = "https://api.deepl.com")
Sys.setenv(DEEPL_API_KEY = keyring::key_get("deepl"))
babeldown::deepl_translate_quarto(
  book_path,
  "index.qmd",
  render = TRUE,
  source_lang = "EN",
  target_lang = "ES",
  formality = "less",
  force = TRUE
)
  • Commit and push
gert::git_add("index.es.qmd")
gert::git_commit(message = "Translate index.qmd to Spanish")
usethis::pr_push()

Example PR

Conclusion

This article explained how you can use babelquarto to set up and render a multilingual Quarto book, and babeldown to translate each individual chapter automatically with DeepL API (before review and edits by human translators!).