Translating CKEditor

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

After you are accepted as a member of a CKEditor translation team, you will be able to contribute your translations. In order to start translating, go to the team page and choose a resource that you would like to work on, like CKEditor core or one of its plugins.

Team translation resources in Transifex

Pay attention to project resource statistics on the main team translation page. The second column shows you the graphic and percentage representation of the completion status for a given resource. When you hover over the completion bar, the number of translated, untranslated and reviewed language strings will be displayed in a tooltip.

important note

Please note that it is recommended to complete missing translations before attempting to correct the existing ones.

When you choose a translation resource, a pop-up window with various options for a given resource will be displayed. Depending on your permissions (i.e. whether you are a team member) you will be able to download the translated version of the resource as well as the original language file, view the language strings online, see the resource status and, last but not least, start translating.

important note
See the Localization Tips article for some important pointers for working on CKEditor translations. The Localization Troubleshooting article will explain how to solve some issues that you may encounter while translating.

Translating a Resource

After you are accepted as a language team member, you can go to the team page and view the resources available for translation. Choose an incomplete translation that you want to start working on and check its statistics on the pop-up window that will open.

Translation details in Transifex

The translation process can be performed in two ways: online and offline.

  • Online translation – uses the built-in Transifex editor (two versions are available) and lets you translate the strings in your browser, without the need to download or upload any files and even see the source file format. This is a recommended method, especially for the beginners.
  • Offline translation – requires downloading the language file to your local computer and uploading it back to Transifex when you are done. This method is only recommended for more experienced users.

Online Translation

If you want to translate online, go to the language team page and choose a resource that you want to work on from the resources list. In the resource pop-up window that opens click the Translate now button.

The online editor that will open shows you the list of all language strings for a given resource, including the ones that have already been translated. You can change this setting by clicking the Untranslated and Unreviewed buttons above the editor text input field.

Display options for resource translation in Transifex

You are now ready to go. The left-hand side column displays the language strings in their original versions (for CKEditor — in English). When you choose a language string from the list, it will be shown in the top part of the text input area that contains the source string. The bottom gray part of the input area is where you should enter your translation.

Source string and translation in Transifex

After a translation is entered and checked by you, click the Submit button (or use the Alt+Enter keyboard shortcut) to submit it. It will be added to CKEditor files and used automatically in the next build.

Continue translating the language strings until you are done. You can use all the tools that are normally available in Transifex and described in the official documentation, like machine translate, copy source, history, spell checking, revert and so on.

important note
Using Transifex keyboard shortcuts can significantly speed up the translation process. The keyboard shortcuts list is available when you click the Transifex online translation keyboard.png (keyboard) icon near the progress bar at the top of the editor.

It is quite useful to check the Suggestions tab as it contains suggestions based on similar language strings from CKEditor resources. In this way you will be able to preserve consistency across the localization.

Suggestions tab in Transifex

When you are not sure of the context where the translation is used, check the Details tab. It contains the Developer comment field with additional information explaining the language string context.

Details tab in Transifex

When you are done, you can simply exit the page to finish your work. You can now go back to your language team page and choose another untranslated resource to work on.

Offline Translation

If you want to translate offline, go to the language team page and choose a resource that you want to work on from the resources list. In the resource pop-up that opens choose the Download for translation option.

Offline translation in Transifex

When you choose this option, Transifex will lock the file to prevent multiple translators from working on the same resource and possibly duplicating their efforts. The file will be locked for up to 48 hours and if you do not upload the translated file during this time (or extend the lock by using the Transifex UI), it will become available to other translators after that.

File lock status in Transifex

You will be prompted to save the file on your local computer; please note that it will have the .po extension that comes from the gettext format.

important note
Please note that all CKEditor language files should be UTF-8 encoded, without BOM. Transifex will reject any other file encoding, often without a clear error message.

You can now open the file with your favorite gettext editor and add your translations. When you are done, go back to the resource's page on Transifex and upload the file by using the Upload file option. While the upload is in progress, a suitable notice will be displayed in your browser.

When the upload is finished, your translations will be added to the project and the file lock will be released. If the lock is not released, it is recommended to remove it manually in order to make the file accessible to other team members.

This page was last edited on 27 February 2013, at 18:45.