I18N

Internationalization (i18n) is defined in wikipedia as the process of:

"adapting computer software to different languages and regional differences"

Algid is built with i18n in mind and allows the same CFML application to be used in different locales based upon the user's language settings and preferences.

Submitting and Maintaining Translations

While algid framework does not directly contain translations, each plugin is built with an i18n directory to hold translations. If you have a skill with languages, the plugins you use would enjoy having more translations available.

Translation Tools

One open source tool available for translating the resource bundles is Attesoro. It is written in java and can be run on most OSes.

For more information on using Attesoro please see the instruction pages.

Application i18n

Even though applications in algid do not have any i18n translations the config file contains a list of the enabled locales for the application.

Adding an Application Locale

To add a new locale to the application the locale needs to be added to the config/application.json.cfm file under the i18n.locales array. This will enable the locale to be selected.

_**Note:**_ The application will not work if there are not `.properties` files for the new locale in **all** of the plugins. Even if the `.properties` file is empty, it must exist.

Default Application Locale

To set a new default locale for the application change the i18n.default key in the config/application.json.cfm file to the desired default locale.

Plugin i18n

The i18n information for a plugin is contained within the i18n/ directory inside .properties files.

Adding a Plugin Locale

To add a new locale to a plugin the locale needs to be added to the config/plugin.json.cfm file under the i18n.locales array. This will enable the locale for the plugin. The new locale will also need to be added to the application to be enabled.

_**Note:**_ The application will not work if there are not `.properties` files for the new locale in **all** of the plugins. Even if the `.properties` file is empty, it must exist.

Standard Plugin Translations

The following are basic areas of a plugin that can be translated. Some plugins may have more, but the following should always exist and should be translated when adding a new locale. There may be other, custom, directories that need to also be translated so its safer to just translate anything found in the plugin's i18n/ directory.

File	Description
i18n/config/plugin.properties	General information about the plugin.
i18n/extend/*	Information used by other plugins, such as navigation.
i18n/inc/model/*	Properties for models.
i18n/inc/view/*	Properties for views.