Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Extract localised text from AJS (or other EJS-style) templates

tag: 0.1.0

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README.md
Octocat-spinner-32 package.json
README.md

ajs-xgettext

A utility for extracting localised text from AJS templates (and probably other EJS-style templates). Extracted text is stored in the standard PO template format.

PO template file(s) can then be processed by the GNU gettext or other compatible tools. Binary message catalogues can be read and accessed using node-gettext.

Installation

$ npm install ajs-xgettext

Usage

$ ajs-xgettext template.ajs

By default the extractor looks for translation methods from the gettext module, as described in its README, and assumes the gettext module is available in the gt variable.

The --gettext option allows you to specify an alternate variable for accessing the gettext module. E.g.:

$ ajs-xgettext --gettext=GetText template.ajs

The --method option allows you to specify alternate gettext object method calls and which of their parameters to extract. E.g.:

$ ajs-xgettext --method=gt --method=dngt:2,3 template.ajs

The --function option allows you to specify top-level translation functions. E.g.:

$ ajs-xgettext --function=_ --function=_s:1,2 template.ajs

Please run with --help to see all available options.

Hacking

To run the unit tests use expresso. It should work if you run it without arguments from the top-level project directory.

License

(The MIT License)

Copyright (c) 2011 Duane Griffin <duaneg@dghda.com>

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.