Skip to content

Latest commit

 

History

History
110 lines (56 loc) · 3.48 KB

README.md

File metadata and controls

110 lines (56 loc) · 3.48 KB
Raw

Stone.js Tools

Build Status NPM Version License

Tools for extracting/compiling translatable string from Javascript/HTML source.

Getting Started

To start using Stone.js tools, you first have to install them globally:

npm install -g stonejs-tools

Internationalization

See the Stone.js documentation to know how internationalize your application:

Extracting Translatable Strings

To extract translatable strings from your Javascript and HTML sources, you should use the stonejs extract command:

stonejs extract [options] <source js/html> <output pot>
  • <source js/html>: all Javascript and HTML files where translatable string will be extracted (globbing allowed)
  • <output pot>: the output translation template (.pot`)

The available options are:

  • --funtions: list of the gettext function names (default=_,gettext,lazyGettext)
  • --quiet, -q: do not output progress log to stdout

Examples:

stonejs extract "src/**/*.js" locales/catalog.pot

stonejs extract --functions="_,gettext,lazyGettext" "src/**/*.js" "*.html" locales/catalog.pot

Translating to a New Language

To start translating to a new langage, just copy the translation template file (.pot) and update the Language and the Plural-Forms fields.

Example: translating to French

First copy the .pot file:

cp locales/catalog.pot locales/fr.po

Then edit it:

"Language: fr\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"

NOTE: A list of plural forms for many languages is is available here:

Updating Translations

When you already translated your app but you have new string to translate, you can update your .po files to add the new strings to them.

First, extract again your translatable strings to recreate the translation template file (.pot) with the stonejs extract command (see above).

Then you can update your translation files (.po) using the stonejs update command:

stonejs update [options] <po files> <source pot>
  • <po files>: translation files (.po) to update (globbing allowed)
  • <source pot>: the source translation template (.pot)

The available options are:

  • --quiet, -q: do not output progress log to stdout

Example:

stonejs locales/*.po locales/catalog.pot

Building Translations

To be used by Stone.js, your translation must be built into one ore more JSON or Javascript files using the stonejs build command:

stonejs build [options] <po files> <output>
  • <po files>: translation files (.po) to build (globbing allowed)
  • <output>: The output directory where build files will be created (or ouput file if you used the --merge option)

The available options are:

  • --merge: Merge all languages into a single file (default: false)
  • --format: The output format: json, javascript or js (default: json)
  • --quiet, -q: do not output progress log to stdout

Examples:

stonejs build --format=json locales/*.po locales

stonejs build --merge locales/*.po locales/catalogs.json

stonejs build --format=js --merge locales/*.po locales/catalogs.js