From 4b206855621b71263d5521851b5b7fbfa7d28ac7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Wed, 1 Apr 2015 22:17:12 +0200 Subject: [PATCH 1/2] Use i18n node module for template translation --- lib/book.js | 12 +++- lib/configuration.js | 3 +- lib/generators/website.js | 11 +-- lib/utils/i18n.js | 71 ++++++++++--------- package.json | 2 +- theme/i18n/ar.json | 2 +- theme/i18n/bn.json | 2 +- theme/i18n/de.json | 2 +- theme/i18n/en.json | 2 +- theme/i18n/es.json | 2 +- theme/i18n/fa.json | 2 +- theme/i18n/fr.json | 2 +- theme/i18n/it.json | 2 +- theme/i18n/no.json | 2 +- theme/i18n/pl.json | 2 +- theme/i18n/pt.json | 2 +- theme/i18n/ru.json | 2 +- theme/i18n/zh-cn.json | 2 +- theme/i18n/zh-tw.json | 2 +- theme/templates/ebook/glossary.html | 6 +- theme/templates/ebook/summary.html | 8 +-- theme/templates/website/glossary.html | 2 +- .../website/includes/font-settings.html | 10 +-- theme/templates/website/includes/header.html | 30 +++++--- theme/templates/website/includes/summary.html | 8 ++- theme/templates/website/langs.html | 4 +- theme/templates/website/page.html | 2 +- 27 files changed, 108 insertions(+), 89 deletions(-) diff --git a/lib/book.js b/lib/book.js index 42e2c2366..e357ad804 100644 --- a/lib/book.js +++ b/lib/book.js @@ -2,9 +2,9 @@ var Q = require("q"); var _ = require("lodash"); var path = require("path"); var util = require("util"); -var lunr = require('lunr'); +var lunr = require("lunr"); var parsers = require("gitbook-parsers"); -var color = require('bash-color'); +var color = require("bash-color"); var fs = require("./utils/fs"); var parseNavigation = require("./utils/navigation"); @@ -12,6 +12,7 @@ var parseProgress = require("./utils/progress"); var pageUtil = require("./utils/page"); var batch = require("./utils/batch"); var links = require("./utils/links"); +var i18n = require("./utils/i18n"); var logger = require("./utils/logger"); var Configuration = require("./configuration"); @@ -425,7 +426,7 @@ Book.prototype.parseSummary = function() { .then(function(content) { return summary.parser.summary(content, { entryPoint: that.readmeFile, - entryPointTitle: "", + entryPointTitle: that.i18n('SUMMARY_INTRODUCTION'), files: that.files }); }); @@ -727,6 +728,11 @@ Book.prototype.setOutput = function(p) { }); }; +// Translate a strign according to the book language +Book.prototype.i18n = function(phrase) { + var args = Array.prototype.slice.call(arguments); + return i18n.__.apply({}, [this.config.normalizeLanguage()].concat(args)); +}; // Init and return a book Book.init = function(root) { diff --git a/lib/configuration.js b/lib/configuration.js index 70b2eb5c7..3f8c82261 100644 --- a/lib/configuration.js +++ b/lib/configuration.js @@ -60,7 +60,6 @@ function normalizePluginsNames(plugins) { return _.pluck(normalizePluginsList(plugins), "name"); }; - var Configuration = function(book, options) { var that = this; @@ -125,7 +124,7 @@ Configuration.prototype.load = function() { // Default value for text direction (from language) if (!that.options.direction) { - var lang = i18n.getByLanguage(that.options.language); + var lang = i18n.getCatalog(that.options.language); if (lang) that.options.direction = lang.direction; } diff --git a/lib/generators/website.js b/lib/generators/website.js index 9405a1cc5..fbf0a8d32 100644 --- a/lib/generators/website.js +++ b/lib/generators/website.js @@ -6,7 +6,6 @@ var _ = require("lodash"); var nunjucks = require("nunjucks"); var AutoEscapeExtension = require("nunjucks-autoescape"); var FilterExtension = require("nunjucks-filter"); -var I18nExtension = require("nunjucks-i18n"); var fs = require("../utils/fs"); var BaseGenerator = require("../generator"); @@ -79,8 +78,8 @@ Generator.prototype.prepareTemplateEngine = function() { .then(function() { var language = that.book.config.normalizeLanguage(); - if (!i18n.getByLanguage(language) && language != "en") { - that.book.log.warn.ln("Language '"+language+"' is not available as a layout locales (en, "+i18n.getLanguages().join(", ")+")"); + if (!i18n.hasLocale(language)) { + that.book.log.warn.ln("Language '"+language+"' is not available as a layout locales (en, "+i18n.getLocales().join(", ")+")"); } var folders = _.chain(that.templates) @@ -101,15 +100,11 @@ Generator.prototype.prepareTemplateEngine = function() { that.env.addFilter('lvl', function(lvl) { return lvl.split(".").length; }); + that.env.addGlobal('__', that.book.i18n.bind(that.book)); // Add extension that.env.addExtension('AutoEscapeExtension', new AutoEscapeExtension(that.env)); that.env.addExtension('FilterExtension', new FilterExtension(that.env)); - that.env.addExtension('I18nExtension', new I18nExtension({ - env: that.env, - translations: i18n.getLocales(), - locale: "language" - })); }); }; diff --git a/lib/utils/i18n.js b/lib/utils/i18n.js index 449fccb71..d504e9af0 100644 --- a/lib/utils/i18n.js +++ b/lib/utils/i18n.js @@ -2,32 +2,19 @@ var _ = require("lodash"); var path = require("path"); var fs = require("fs"); -var I18N_PATH = path.resolve(__dirname, "../../theme/i18n/") +var i18n = require("i18n"); -var getLocales = _.memoize(function() { - var locales = fs.readdirSync(I18N_PATH); - return _.chain(locales) - .map(function(local) { - local = path.basename(local, ".json"); - return [local, _.extend({ - direction: "ltr" - }, require(path.join(I18N_PATH, local)), { - id: local - })]; - }) - .object() - .value(); +var I18N_PATH = path.resolve(__dirname, "../../theme/i18n/") +var DEFAULT_LANGUAGE = "en"; +var LOCALES = _.map(fs.readdirSync(I18N_PATH), function(lang) { + return path.basename(lang, ".json"); }); -var getLanguages = function() { - return _.keys(getLocales()); -}; - -var getByLanguage = function(lang) { - lang = normalizeLanguage(lang); - var locales = getLocales(); - return locales[lang]; -}; +i18n.configure({ + locales: LOCALES, + directory: I18N_PATH, + defaultLocale: DEFAULT_LANGUAGE +}); var compareLocales = function(lang, locale) { var langMain = _.first(lang.split("-")); @@ -43,12 +30,9 @@ var compareLocales = function(lang, locale) { }; var normalizeLanguage = _.memoize(function(lang) { - var locales = getLocales(); - var language = _.chain(locales) + var language = _.chain(LOCALES) .values() .map(function(locale) { - locale = locale.id; - return { locale: locale, score: compareLocales(lang, locale) @@ -64,9 +48,32 @@ var normalizeLanguage = _.memoize(function(lang) { return language || lang; }); -module.exports = { - getLocales: getLocales, - getLanguages: getLanguages, - getByLanguage: getByLanguage, - normalizeLanguage: normalizeLanguage +var translate = function(locale, phrase) { + var args = Array.prototype.slice.call(arguments, 2); + + return i18n.__.apply({}, [{ + locale: locale, + phrase: phrase + }].concat(args)); +}; + +var getCatalog = function(locale) { + locale = normalizeLanguage(locale); + return i18n.getCatalog(locale); +}; + +var getLocales = function() { + return LOCALES; +}; + +var hasLocale = function(locale) { + return _.contains(LOCALES, locale); +} + +module.exports = { + __: translate, + normalizeLanguage: normalizeLanguage, + getCatalog: getCatalog, + getLocales: getLocales, + hasLocale: hasLocale }; diff --git a/package.json b/package.json index 633700eed..44221a99a 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "nunjucks": "git+https://github.com/mozilla/nunjucks.git#0f8b21b8df7e8e852b2e1889388653b7075f0d09", "nunjucks-autoescape": "0.1.1", "nunjucks-filter": "0.1.0", - "nunjucks-i18n": "1.0.0", + "i18n": "0.5.0", "semver": "2.2.1", "npmi": "0.1.1", "cheerio": "0.19.0", diff --git a/theme/i18n/ar.json b/theme/i18n/ar.json index a0d7f30ff..a0e7e56d4 100644 --- a/theme/i18n/ar.json +++ b/theme/i18n/ar.json @@ -12,7 +12,7 @@ "SEARCH_PLACEHOLDER": "اكتب للبحث", "FONTSETTINGS_TOGGLE": "إعدادات الخط", "SHARE_TOGGLE": "حصة", - "SHARE_ON": "على __platform__ حصة", + "SHARE_ON": "على {{platform}} حصة", "FONTSETTINGS_WHITE": "أبيض", "FONTSETTINGS_SEPIA": "بني داكن", "FONTSETTINGS_NIGHT": "ليل", diff --git a/theme/i18n/bn.json b/theme/i18n/bn.json index 4c672ed01..24baec340 100644 --- a/theme/i18n/bn.json +++ b/theme/i18n/bn.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "অনুসন্ধান", "FONTSETTINGS_TOGGLE": "ফন্ট সেটিংস", "SHARE_TOGGLE": "শেয়ার", - "SHARE_ON": "__platform__-এ শেয়ার", + "SHARE_ON": "{{platform}}-এ শেয়ার", "FONTSETTINGS_WHITE": "সাদা", "FONTSETTINGS_SEPIA": "সেপিয়া", "FONTSETTINGS_NIGHT": "রাত", diff --git a/theme/i18n/de.json b/theme/i18n/de.json index 73a998e4b..b51732e1b 100644 --- a/theme/i18n/de.json +++ b/theme/i18n/de.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Suchbegriff eingeben", "FONTSETTINGS_TOGGLE": "Schrifteinstellungen", "SHARE_TOGGLE": "Teilen", - "SHARE_ON": "Auf __platform__ teilen", + "SHARE_ON": "Auf {{platform}} teilen", "FONTSETTINGS_WHITE": "Hell", "FONTSETTINGS_SEPIA": "Sepia", "FONTSETTINGS_NIGHT": "Nacht", diff --git a/theme/i18n/en.json b/theme/i18n/en.json index 159655898..fb4485e5a 100644 --- a/theme/i18n/en.json +++ b/theme/i18n/en.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Type to search", "FONTSETTINGS_TOGGLE": "Font Settings", "SHARE_TOGGLE": "Share", - "SHARE_ON": "Share on __platform__", + "SHARE_ON": "Share on {{platform}}", "FONTSETTINGS_WHITE": "White", "FONTSETTINGS_SEPIA": "Sepia", "FONTSETTINGS_NIGHT": "Night", diff --git a/theme/i18n/es.json b/theme/i18n/es.json index a00595f9b..132cb77c0 100644 --- a/theme/i18n/es.json +++ b/theme/i18n/es.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Escribe para buscar", "FONTSETTINGS_TOGGLE": "Configuración de fuente", "SHARE_TOGGLE": "Comparte", - "SHARE_ON": "Comparte en __platform__", + "SHARE_ON": "Comparte en {{platform}}", "FONTSETTINGS_WHITE": "Claro", "FONTSETTINGS_SEPIA": "Sépia", "FONTSETTINGS_NIGHT": "Noche", diff --git a/theme/i18n/fa.json b/theme/i18n/fa.json index 258c6125d..44445c1df 100644 --- a/theme/i18n/fa.json +++ b/theme/i18n/fa.json @@ -12,7 +12,7 @@ "SEARCH_PLACEHOLDER": "چیزی برای جستجو بنویسید", "FONTSETTINGS_TOGGLE": "تنظیمات فونت", "SHARE_TOGGLE": "اشتراک", - "SHARE_ON": "در __platform__ به اشتراک بگذارید", + "SHARE_ON": "در {{platform}} به اشتراک بگذارید", "FONTSETTINGS_WHITE": "سفید", "FONTSETTINGS_SEPIA": "سپیا", "FONTSETTINGS_NIGHT": "شب", diff --git a/theme/i18n/fr.json b/theme/i18n/fr.json index 9262c2e87..8cc10e25c 100644 --- a/theme/i18n/fr.json +++ b/theme/i18n/fr.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Tapez pour rechercher", "FONTSETTINGS_TOGGLE": "Paramètres de Police", "SHARE_TOGGLE": "Partage", - "SHARE_ON": "Partager sur __platform__", + "SHARE_ON": "Partager sur {{platform}}", "FONTSETTINGS_WHITE": "Clair", "FONTSETTINGS_SEPIA": "Sépia", "FONTSETTINGS_NIGHT": "Nuit", diff --git a/theme/i18n/it.json b/theme/i18n/it.json index e856d7ee3..3f5e95df7 100644 --- a/theme/i18n/it.json +++ b/theme/i18n/it.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Scrivi per cercare", "FONTSETTINGS_TOGGLE": "Impostazioni dei caratteri", "SHARE_TOGGLE": "Condividi", - "SHARE_ON": "Condividi su __platform__", + "SHARE_ON": "Condividi su {{platform}}", "FONTSETTINGS_WHITE": "Bianco", "FONTSETTINGS_SEPIA": "Seppia", "FONTSETTINGS_NIGHT": "Notte", diff --git a/theme/i18n/no.json b/theme/i18n/no.json index 70f9b33e3..1ed6236aa 100644 --- a/theme/i18n/no.json +++ b/theme/i18n/no.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Skriv inn søkeord", "FONTSETTINGS_TOGGLE": "Tekstinnstillinger", "SHARE_TOGGLE": "Del", - "SHARE_ON": "Del på __platform__", + "SHARE_ON": "Del på {{platform}}", "FONTSETTINGS_WHITE": "Lys", "FONTSETTINGS_SEPIA": "Sepia", "FONTSETTINGS_NIGHT": "Mørk", diff --git a/theme/i18n/pl.json b/theme/i18n/pl.json index 7c0cdf4c3..4f009fcda 100644 --- a/theme/i18n/pl.json +++ b/theme/i18n/pl.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Wpisz szukaną frazę", "FONTSETTINGS_TOGGLE": "Ustawienia czcionki", "SHARE_TOGGLE": "Udostępnij", - "SHARE_ON": "Udostępnij na __platform__", + "SHARE_ON": "Udostępnij na {{platform}}", "FONTSETTINGS_WHITE": "Jasny", "FONTSETTINGS_SEPIA": "Sepia", "FONTSETTINGS_NIGHT": "Noc", diff --git a/theme/i18n/pt.json b/theme/i18n/pt.json index 5413a48e8..9d6bde0a8 100644 --- a/theme/i18n/pt.json +++ b/theme/i18n/pt.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Escreva para pesquisar", "FONTSETTINGS_TOGGLE": "Configurações de fonte", "SHARE_TOGGLE": "Compartilhar", - "SHARE_ON": "Compartilhar no __platform__", + "SHARE_ON": "Compartilhar no {{platform}}", "FONTSETTINGS_WHITE": "Claro", "FONTSETTINGS_SEPIA": "Sépia", "FONTSETTINGS_NIGHT": "Noite", diff --git a/theme/i18n/ru.json b/theme/i18n/ru.json index 1a70f0726..9e6b9dd83 100644 --- a/theme/i18n/ru.json +++ b/theme/i18n/ru.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "Введите условия поиска", "FONTSETTINGS_TOGGLE": "Шрифт", "SHARE_TOGGLE": "Поделиться", - "SHARE_ON": "Поделиться в __platform__", + "SHARE_ON": "Поделиться в {{platform}}", "FONTSETTINGS_WHITE": "Светлый", "FONTSETTINGS_SEPIA": "Сепия", "FONTSETTINGS_NIGHT": "Тёмный", diff --git a/theme/i18n/zh-cn.json b/theme/i18n/zh-cn.json index dfeb2b85e..8aa372c41 100644 --- a/theme/i18n/zh-cn.json +++ b/theme/i18n/zh-cn.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "输入并搜索", "FONTSETTINGS_TOGGLE": "字体设置", "SHARE_TOGGLE": "分享", - "SHARE_ON": "分享到 __platform__", + "SHARE_ON": "分享到 {{platform}}", "FONTSETTINGS_WHITE": "白色", "FONTSETTINGS_SEPIA": "棕褐色", "FONTSETTINGS_NIGHT": "夜间", diff --git a/theme/i18n/zh-tw.json b/theme/i18n/zh-tw.json index 6ae26aa10..d5ff1ad14 100644 --- a/theme/i18n/zh-tw.json +++ b/theme/i18n/zh-tw.json @@ -11,7 +11,7 @@ "SEARCH_PLACEHOLDER": "輸入並搜尋", "FONTSETTINGS_TOGGLE": "字型設定", "SHARE_TOGGLE": "分享", - "SHARE_ON": "分享到 __platform__", + "SHARE_ON": "分享到 {{platform}}", "FONTSETTINGS_WHITE": "白色", "FONTSETTINGS_SEPIA": "棕褐色", "FONTSETTINGS_NIGHT": "夜間", diff --git a/theme/templates/ebook/glossary.html b/theme/templates/ebook/glossary.html index d4d46f2e4..1266f27db 100644 --- a/theme/templates/ebook/glossary.html +++ b/theme/templates/ebook/glossary.html @@ -1,11 +1,11 @@ {% extends "./page.html" %} -{% block title %}{% i18n "GLOSSARY" %}Glossary{% endi18n %} | {{ title }}{% endblock %} +{% block title %}{{ __("GLOSSARY") }} | {{ title }}{% endblock %} {% block content %}
-

{% i18n "GLOSSARY" %}Glossary{% endi18n %}

-

{% i18n "GLOSSARY" %}Glossary{% endi18n %}

+

{{ __("GLOSSARY") }}

+

{{ __("GLOSSARY") }}

{% for item in glossary %}

{{ item.name }}

diff --git a/theme/templates/ebook/summary.html b/theme/templates/ebook/summary.html index c0d6d1e15..fa79a98e4 100644 --- a/theme/templates/ebook/summary.html +++ b/theme/templates/ebook/summary.html @@ -1,13 +1,13 @@ {% extends "./page.html" %} -{% block title %}{% i18n "SUMMARY" %}Table of Contents{% endi18n %} | {{ title }}{% endblock %} +{% block title %}{{ __("SUMMARY") }} | {{ title }}{% endblock %} {% macro articles(_articles) %} {% for item in _articles %}
  • {% if item.path and item.exists %} {% if not item.external %} - {% if item.introduction %}{% i18n "SUMMARY_INTRODUCTION" %}Introduction{% endi18n %}{% else %}{{ item.title }}{% endif %} + {{ item.title }} {% else %} {{ item.title }} {% endif %} @@ -25,12 +25,12 @@ {% block content %}
    -

    {% i18n "SUMMARY" %}Table of Contents{% endi18n %}

    +

    {{ __("SUMMARY") }}

      {{ articles(summary.chapters) }} {% if glossary.length > 0 %} -
    1. {% i18n "GLOSSARY" %}Glossary{% endi18n %}
      2. +
    2. {{ __("GLOSSARY") }}
      3. {% endif %}
    diff --git a/theme/templates/website/glossary.html b/theme/templates/website/glossary.html index 1a78c7690..dd3f719c8 100644 --- a/theme/templates/website/glossary.html +++ b/theme/templates/website/glossary.html @@ -1,6 +1,6 @@ {% extends "page.html" %} -{% block title %}{% i18n "GLOSSARY" %}Glossary{% endi18n %} | {{ title }}{% endblock %} +{% block title %}{{ __("GLOSSARY") }} | {{ title }}{% endblock %} {% block page_inner %} {% for item in glossary %} diff --git a/theme/templates/website/includes/font-settings.html b/theme/templates/website/includes/font-settings.html index 6a5433462..2d5024b11 100644 --- a/theme/templates/website/includes/font-settings.html +++ b/theme/templates/website/includes/font-settings.html @@ -10,13 +10,13 @@
    • - - + +
    - - - + + +
    diff --git a/theme/templates/website/includes/header.html b/theme/templates/website/includes/header.html index 119dd62b5..7a987b04f 100644 --- a/theme/templates/website/includes/header.html +++ b/theme/templates/website/includes/header.html @@ -1,12 +1,12 @@
    - - + + {% if glossary.length > 0 %} - + {% endif %} @@ -14,7 +14,7 @@ {% if options.links.sharing.all != false %}
    - +
    @@ -22,11 +22,21 @@
    - - - - - + + + + +
    diff --git a/theme/templates/website/includes/summary.html b/theme/templates/website/includes/summary.html index e0160249a..312fc2d1a 100644 --- a/theme/templates/website/includes/summary.html +++ b/theme/templates/website/includes/summary.html @@ -8,7 +8,7 @@ {% if item.level != "0" %} {{ item.level }}. {% endif %} - {% if item.introduction and not item.title %}{% i18n "SUMMARY_INTRODUCTION" %}Introduction{% endi18n %}{% else %}{{ item.title }}{% endif %} + {{ item.title }} {% else %} @@ -33,7 +33,7 @@
    - +
    diff --git a/theme/templates/website/langs.html b/theme/templates/website/langs.html index 89a075e38..6005cbbbc 100755 --- a/theme/templates/website/langs.html +++ b/theme/templates/website/langs.html @@ -9,7 +9,7 @@ {% block content %}
    -

    {% i18n "LANGS_CHOOSE" %}Choose a language{% endi18n %}

    +

    {{ __("LANGS_CHOOSE") }}

      {% for lang in langs %} @@ -22,4 +22,4 @@
    {% endblock %} -{% block javascript %}{% endblock %} \ No newline at end of file +{% block javascript %}{% endblock %} diff --git a/theme/templates/website/page.html b/theme/templates/website/page.html index d4b5e0b50..37fc9ddbb 100644 --- a/theme/templates/website/page.html +++ b/theme/templates/website/page.html @@ -10,7 +10,7 @@ {% endif %} {% endblock %} -{% block title %}{% if progress.current.introduction and not progress.current.title %}{% i18n "SUMMARY_INTRODUCTION" %}Introduction{% endi18n %}{% else %}{{ progress.current.title }}{% endif %} | {{ title }}{% endblock %} +{% block title %}{{ progress.current.title }} | {{ title }}{% endblock %} {% block description %}{% if progress.current.level == "0" %}{{ description }}{% endif %}{% endblock %} {% block content %} From 8da91de51405bb3631d3fa38dd2afd31e109badc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Wed, 1 Apr 2015 22:21:13 +0200 Subject: [PATCH 2/2] Don't update translations --- lib/utils/i18n.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/utils/i18n.js b/lib/utils/i18n.js index d504e9af0..c3253b78a 100644 --- a/lib/utils/i18n.js +++ b/lib/utils/i18n.js @@ -13,7 +13,8 @@ var LOCALES = _.map(fs.readdirSync(I18N_PATH), function(lang) { i18n.configure({ locales: LOCALES, directory: I18N_PATH, - defaultLocale: DEFAULT_LANGUAGE + defaultLocale: DEFAULT_LANGUAGE, + updateFiles: false }); var compareLocales = function(lang, locale) {