Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Extract translatable strings from Handlebars templates.
JavaScript
branch: master

This branch is 4 commits ahead, 140 commits behind gmarty:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
.gitignore
.npmignore
LICENSE-MIT
README.md
package.json

README.md

handlebars-xgettext

Extract translatable strings from Handlebars templates.

Getting Started

This script is called this way:

$ node handlebars-xgettext path/to/handlebars/templates/ translation.pot

This will find all the files located in path/to/handlebars/templates/, extract translatable strings and create a file called translation.pot.

The POT file is a catalog model used to update PO files.

Translatable strings should be marked up like this:

<button class="btn btn-large">{{gettext "Login"}}</button>

Documentation

The gettext helper can also be aliased to _:

<button class="btn btn-large">{{_ "Login"}}</button>

It is up to you to define the i18n logic. But you should probably do something like this in your JavaScript:

Handlebars.registerHelper('_', function(key) {
  return i18n.gettext(key);
});

Jed is a very convenient library to manage internationalization from JavaScript in the gettext way.

Warning

handlebars-xgettext is at a very early stage of development and may not meet your requirements at the moment.

A lot of common features of xgettext are not yet implemented.

But we plan on improving stability and functionalities (see @todo annotations). As such, pull requests and issues are greatly appreciated ;-)

Note

handlebars-xgettext development was founded by Dijiwan. We use it extensively on production.

License

Copyright (c) 2012 Guillaume Marty

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.