Developers Documentation



301 error for file:

User Tools

Site Tools

Getting Started with Localization

This document provides a step-by-step walkthrough for translating ClearOS. By the end of this document, you will be able to translate using the online Translation System and see the results in your local ClearOS installation!

Prepare Your ClearOS Environment

Request an Account

Before you can get started with the Translation System, please request an account by going through the first three steps described in the Getting Started document.

Install the ClearOS Developer App

Once your translator account is active, you can go ahead and install the Developer Tools app on your ClearOS system, run:

yum install app-devel

Once installed, you can find the Developer Tools under System|Developer|Developer Tools in the menu.

Configure the ClearOS Developer App

ClearOS Translation tool To enable translator mode in ClearOS, click on in the Translations widget. Select your language, enable Translation Mode, and enable Synchronize Updates if you would like to synchronize (rsync) the translations to your ClearOS system every 5 minutes. Even though the tool (rsync) is smart about synchronizing just the changes, the synchronization will automatically expire after 12 hours.

It may take a few minutes for the translations to download, so please be patient! The translations from the Pootle server are synchronized to /var/clearos/base/translations. Anything in this directory will override the installed translations when Translation Mode is enabled.

If you are starting a brand new translation, the screen full of untranslated tags will look quite messy! See screenshot below and read on how to best clean things up.

ClearOS Translation First Look

Getting Started on the Translation Server - Pootle

Now you can get started with doing some translating! Here's a good place to start.


First, login to the server:

  • Go to the Translate Server
  • Click on Login in the top right corner and sign in.
  • Click on Home in the top navigation
  • Click on ClearOS under the Projects section
  • Select your language

What you are seeing at this point is a list of translation files - each one represents a ClearOS app. Hopefully the base name of the file is intuitive.

Base Categories

To make it easier to navigate and to clean up a lot of the webconfig page layout issues, the first file that you will want to translate is base_categories_lang.php. This file contains all the categories and subcategories that you see in the menu system (Server, Gateway, Network, etc).

If you have synchronization enabled, you should see changes that you have made on the translation server appear on your ClearOS system every 5th minute of the hour (e.g. 10:05, 10:10, 10:15, etc.).

Base Countries

The next translation file to review is base_countries_lang.php. As you have probably already guessed, this is a list of countries and kind-of countries around the world. Most, if not all, of the translations have already been imported thanks to the work of Saša Stamenković using CLDR data.

Base System

The final part of the base app also happens to be one of the biggest to translate: there are approximately 500 generic words in the base. A lot of those standard buttons (e.g. Add, Edit, Delete) and widgets will start to look normal in webconfig after going through this translation set.

The Rest

After tackling the base translations, it's a matter of going through all the other apps. We'll be adding more apps as the weeks and months go by.


If you have already translated ClearOS using the file system, please see Importing Translations for more information.

content/en_us/dev_translations_getting_started.txt · Last modified: 2015/08/24 14:17 (external edit)