Locale Configuration

The Locale Configuration page allows you to manage the languages available in your InstiKit installation.

By default, InstiKit is available in English, but you can easily add additional languages such as Arabic, French, Hindi, Spanish, German, or any other supported locale.

Once a locale is added and translated, administrators can set it as the default application language, while individual users can still choose their own preferred language.

Important

Adding a locale only makes the language available in the application.

You must also translate the language files before users will see the application in that language.

Adding a Locale

Click Add Locale and provide the following information.

Locale Name

Enter the display name of the language.

Examples:

• English
• Arabic
• Hindi
• French
• Spanish

This name is shown in language selection lists.

Locale Code

Enter the standard locale code.

Examples:

The locale code should match the language directory inside your application's lang folder.

Translation Files

After adding a locale, create a corresponding language directory inside:

lang/

For example, if your locale code is:

ar

create:

lang/ar

Copy the contents of the default language directory into the new locale directory.

Example:

lang/en
        ↓
lang/ar

You can then begin translating each language file.

Translating the Application

Each language directory contains multiple translation files used throughout the application.

Translate every file according to your preferred language.

You may translate the files manually or use an AI translation tool to speed up the process.

Popular AI tools include:

• ChatGPT
• Google Gemini
• Claude
• DeepL
• Microsoft Copilot

After translating the files, save them back into the locale directory.

Making a Locale the Default

Once the translation files are complete:

1. Open your profile menu.
2. Click Clear Cache.
3. Go to Configuration → System Configuration.
4. Change the Default Locale to your newly added language.
5. Click Save.
6. Refresh the browser.

The application will now display using the selected language.

User Language Preference

Each user can choose their own preferred language.

For example:

• The organization's default language is Arabic.
• A teacher prefers to use English.

The teacher can open User Preferences and change their preferred locale to English.

Only that user's interface will switch to English.

All other users will continue using the organization's default language unless they choose a different locale.

This allows multilingual organizations to support users with different language preferences simultaneously.

Best Practices

• Always use standard locale codes.
• Translate all language files before making a locale available to users.
• Keep translations consistent throughout the application.
• Use AI-assisted translation to speed up the process, then review the output for accuracy.
• Clear the application cache after updating translation files.

Important Notes

• Adding a locale does not automatically translate the application.
• Missing translations will fall back to the default language.
• Users can override the organization's default language through their own profile preferences.
• New InstiKit updates may introduce additional translation keys that should also be translated.

Saving Changes

After adding or updating a locale, click Save.

If you modify translation files manually, remember to clear the application cache and refresh your browser before testing the new language.