Rocket I18N

A crate to help you internationalize your Rocket applications.

Features

• Create .po files for locales listed in po/LINGUAS, from a POT file
• Update .po files from the POT file if needed
• Compile .po files into .mo ones
• Select the correct locale for each request
• Integrates with Tera templates

Usage

First add it to your Cargo.toml:

toml [dependencies] rocket_i18n = "0.1"

Then, in your main.rs:

```rust extern crate rocket_i18n;

// ...

fn main() { rocket::ignite() // Register the fairing. The parameter is the domain you want to use (the name of your app most of the time) .attach(rocketi18n::I18n::new("myapp")) // Eventually register the Tera filters (only works with the master branch of Rocket) .attach(rocketcontrib::Template::custom(|engines| { rocketi18n::tera(&mut engines.tera); })) // Register routes, etc } ```

For the developers

Using Tera filters

If you called rocket_i18n::tera, you'll be able to use two Tera filters to translate your interface.

The first one, _, corresponds to the gettext function of gettext. It takes a string as input and translate it. Any argument given to the filter can be used in the translated string using the Tera syntax.

```jinja

{{ "Hello, world" | _ }}

{{ "Your name is {{ name }}" | _(name=user.name) }} ``` The second one, `_n`, is equivalent to `ngettext`. It takes the plural form as input, and two required arguments in addition to those you may want to use for interpolation: - `singular`, the singular form of this string - `count`, the number of items, to determine how the string should be pluralized ```jinja

{{ "{{ count }} new messages" | _n(singular="One new message", count=messages.unread_count) }}

```

In Rust code

You can also use all the gettext functions in your Rust code.

```rust use rocket_i18n;

[get("/")]

fn index() -> String { gettext("Hello, world!") }

[get("/")]

fn hello(name: String) -> String { format!(gettext("Hello, {}!"), name) } ```

Editing the POT

For those strings to be translatable you should also add them to the po/YOUR_DOMAIN.pot file. To add a simple message, just do:

po msgid "Hello, world" # The string you used with your filter msgstr "" # Always empty

For plural forms, the syntax is a bit different:

po msgid "You have one new notification" # The singular form msgid_plural "You have {{ count }} new notifications" # The plural one msgstr[0] "" msgstr[1] ""