More internationalization

NEWS.md

@@ -18,6 +18,7 @@ learnr (development version)
 * Added an event handler system, with the functions `event_register_handler()` and `one_time()`. There is also a new event `"section_viewed"`, which is triggered when a new section becomes visible. ([#398](https://github.com/rstudio/learnr/pull/398))
 * Previously, when a question submission was reset, it would be recorded as a `"question_submission"` event with the value `reset=TRUE`. Now it a separate event, `"reset_question_submission"`. ([#398](https://github.com/rstudio/learnr/pull/398))
 * Added a new `polyglot` tutorial to learnr. This tutorial displays mixing R, python, and sql exercises. See [`run_tutorial("polyglot", "learnr")`](https://learnr-examples.shinyapps.io/polyglot) for a an example. ([#397](https://github.com/rstudio/learnr/pull/397))
+* Text throughout the learnr interface can be customized or localized using the new `language` argument of `tutorial()`. Translations for English and French are provided and contributes will be welcomed. Read more about these features in `vignette("multilang", package = "learnr")`. ([#456](https://github.com/rstudio/learnr/pull/456))
 
 ## Minor new features and improvements
 

R/i18n.R

@@ -138,6 +138,8 @@ i18n_translations <- function() {
           startover = "Start Over",
           areyousure = "Are you sure you want to start over? (all exercise progress will be reset)",
           youmustcomplete = "You must complete the",
+          exercise = "exercise",
+          exercise_plural = "exercises",
           inthissection = "in this section before continuing."
         )
       )
@@ -157,9 +159,11 @@ i18n_translations <- function() {
         ),
         text = list(
           startover = "Recommencer",
-          areyousure = "\u00cates-vous certains de vouloir recommencer ? (La progression sera remise \u00e0 z\u00e9ro)",
-          youmustcomplete = "Vous devez d'abord compl\u00e9ter l'exercice",
-          inthissection = "de cette section avec de continuer."
+          areyousure = "\u00cates-vous certains de vouloir recommencer? (La progression sera remise \u00e0 z\u00e9ro)",
+          youmustcomplete = "Vous devez d'abord compl\u00e9ter",
+          inthissection = "de cette section avec de continuer.",
+          exercise = "l'exercice",
+          exercise_plural = "des exercices"
         )
       )
     ),
@@ -180,6 +184,8 @@ i18n_translations <- function() {
           startover = "\u23ee",
           areyousure = "\U0001f914",
           youmustcomplete = "\u26a0 \U0001f449",
+          exercise = "",
+          exercise_plural = "",
           inthissection = "."
         )
       )

R/quiz.R

@@ -568,6 +568,8 @@ question_button_label <- function(question, label_type = "submit", is_valid = TR
   # We don't want to localize button labels that were customized by the user
   # If they're default labels, we'll add the `data-i18n` attribute for localization
   default_label <- eval(formals("question")[[paste0(label_type, "_button")]])
+  # At this point, `button_label` has been upgraded to HTML. 
+  # Need to format() for a fair comparison
   is_default_label <- identical(format(button_label), default_label)
 
   default_class <- "btn-primary"

R/tutorial-format.R

@@ -24,9 +24,9 @@
 #'        \code{---} to em-dashes, \code{--} to en-dashes, and \code{...} to ellipses.
 #'        Deprecated in \pkg{rmarkdown} v2.2.0.
 #' @param ... Forward parameters to html_document
-#' @param language Language or custom text of the UI elements. See the
-#'        `multilang` vignette for more information about available options and
-#'        formatting.
+#' @param language Language or custom text of the UI elements. See
+#'        `vignette("multilang", package = "learnr")` for more information
+#'        about available options and formatting
 #'
 #' @export
 #' @importFrom utils getFromNamespace

inst/rmarkdown/templates/tutorial/resources/tutorial-format.js

@@ -153,6 +153,10 @@ $(document).ready(function() {
 
     }
 
+    function i18nextLang(fallbackLng = 'en') {
+      return i18next.language || window.localStorage.i18nextLng || fallbackLng || 'en';
+    }
+
     function handleSkipClick(event) {
       $(this).data('n_clicks', $(this).data('n_clicks') + 1)
 
@@ -176,21 +180,15 @@ $(document).ready(function() {
       })
       // if the section has exercises and is not complete, don't skip - put up message
       if (section.exercises.length && !section.completed && !section.allowSkip) {
-        var exs = section.exercises.length == 1 ? 'exercise' : 'exercises';
-
-        var youmustcomplete = i18next.t("text.youmustcomplete")
-        // Checking that the translation exists, if not, default to english
-        if (youmustcomplete == "text.youmustcomplete") {
-          youmustcomplete = "You must complete the"
-        }
-        var inthissection = i18next.t("text.inthissection")
-        // Checking that the translation exists, if not, default to english
-        if (inthissection == "text.inthissection") {
-          inthissection = "in this section before continuing."
-        }
-        // defaulting to english if nothing works
-        bootbox.setLocale(i18next.language || window.localStorage.i18nextLng || "en")
-        bootbox.alert(inthissection + " " + exs + " " + inthissection);
+        var exs = i18next.t(
+          ['text.exercise', 'exercise'],
+          {count: section.exercises.length, lngs: [i18nextLang(), 'en']}
+        );
+        var youmustcomplete = i18next.t(['text.youmustcomplete', 'You must complete the']);
+        var inthissection = i18next.t(['text.inthissection', 'in this section before continuing.']);
+
+        bootbox.setLocale(i18nextLang());
+        bootbox.alert(youmustcomplete + " " + exs + " " + inthissection);
       }
       else {
         if (sectionIndex == topic.sections.length - 1) {
@@ -356,18 +354,11 @@ $(document).ready(function() {
 
       var resetButton = $('<span class="resetButton" data-i18n="text.startover">Start Over</span>');
       resetButton.on('click', function() {
-        var areyousure = i18next.t("text.areyousure")
-        // Default to english if no translation is found
-         if (areyousure == "text.areyousure") {
-          areyousure = "Are you sure you want to start over? (all exercise progress will be reset)"
-        }
-        // defaulting to english if nothing works
-        bootbox.setLocale(i18next.language || window.localStorage.i18nextLng || "en")
-        bootbox.confirm(areyousure,
-                        function(result) {
-                          if (result)
-                            tutorial.startOver();
-                        });
+
+        var areyousure = i18next.t(['text.areyousure', 'Are you sure you want to start over? (all exercise progress will be reset)']);
+
+        bootbox.setLocale(i18nextLang());
+        bootbox.confirm(areyousure, function(result) { result && tutorial.startOver(); });
       });
       topicsFooter.append(resetButton);
       topicsList.append(topicsFooter);