rskibbe.I18n.Ini 1.0.10

Description

A package with default Ini implementations for rskibbe.I18n.

Getting started

If you followed the steps from the base package, you are ready to provide your custom translations. For this, you need to create a specific folder structure, as this package works with Ini files.

A quick translator setup recap

To setup your custom translator just go ahead and use this quick method (if you've installed rskibbe.I18n & rskibbe.I18n.Ini):

    Translator.Builder
        .Build()
        .StoreInstance();

This will take the Ini package with the autodetection mode and you don't need to configure much more.

Remember to do this "bestly" before any UI going on, the Bootstrapping point Program.cs/Program.vb or like the first Form Constructor could be the best place (but make sure it doesn't get called multiple times).

Creating the folder structure

Inside your output directory (where the finished exe resides, like bin/debug..), create this folder structure.

• bin
  • debug
    • i18n
      • ini
        • languages.ini
        • en-US_English.ini
        • de-DE_Deutsch.ini

languages.ini

This file represents/contains all available languages for your application - remember, in Ini format. Matching example contents to the example from above could look like this:

[English]
Iso=en-US
Name=English

[Deutsch]
Iso=de-DE
Name=Deutsch

I specified the german and english language over here. Each one with a name and an iso "property". The section header content doesn't really matter - more or less. Empty lines get ignored.

Translation files

Next, we will take a look at the translation files like "en-US_English.ini" from above. As you can see, you need to first mention the iso code (should correspond to your language file of course!). Then you just append an underscore with the specific language name.

The corresponding files from above would look like this:

Simple

en-US_English.ini

[en-US_English]
key1=Actions
greeting=Hello!

de-DE_Deutsch.ini

[de-DE_Deutsch]
key1=Aktionen
greeting=Hallo!

The section headers get ignored, but I think it feels right to provide them anyways, because this is just how a normal Ini would look like, right? But feel free to omit them. The corresponding translation key would be "key1", which would result in "Actions" or "Aktionen" depending on the language.

Take a look at the base package for more information like getting the available languages, changing the language, etc.