Translate Archetypes Using CKM
Initially
The first time you would like to translate a CKM archetype, please take the time to do the following.
Translator for any archetype. Register yourself as CKM archetype translator:
Select Tools/Update my profile from CKM's main menu.
In the tab Availability as reviewer check the box I am available as a translator.
Select the languages you are willing to translate.
Translator for any/all archetypes owned by a project or incubator. As a translator for a project/incubator you can translate archetypes owned by this project or incubator.
Use CKM to request to be added to a project or incubator: Go to the project or incubator you are interested in and select the Project members icon and then the Your requests tab. In this tab, under Request to join project/incubator select the role Translator and click the I would like to join this project/incubator! button
Once the editor of the project or incubator has approved your request, you can then checkout an archetype for translation.
Checkout the Archetype
Right-click on an archetype and select Revise archetype/Checkout archetype from the context menu.
In the new CKM tab click on the Check-out archetype button.
Once check-out is completed, the translation of the archetype can either be done directly in CKM (Option 1) or using any tool for editing archetypes (Option 2).
Start Your Translation
Option 1: Translate Archetypes Directly in CKM
CKM supports translation of archetypes directly in CKM. That means that you do not have to download the archetype and open it in an external tool and once finished upload the archetype to CKM.
Select archetype and target language for translation.
Once the archetype has been checked out for your use on a "branch", you can start translating this archetype by right-clicking on an archetype in the left panel and selecting Translate archetype.
Select your Target language (the language you want to translate this archetype into) and click the Translate archetype button to start your translation. This button may also be labelled "Edit existing translation" if at least a part of the translation already exists for the selected language.
Start your translation
The complete tree of the archetype will appear and you can start your translation. Any item that has not been translated will appear in bold in the tree.
You can directly select an item to translate or you can use the Next button to walk through all items and translate them as required.
If you need a break, click on the Submit translation and continue later button to save your work. You can continue your work by following the steps above again.
Once you finished your translation, you can use the Submit Final Translation and Notify Editor button instead, which will also send an email to the editor(s) of the archetype, notifying them that you have completed the translation and it can be checked in again by the editor(s). The editor will also do any merging if required (if for example the trunk has moved on in the mean time).
You can ask others to review your translation or help with the translation. One way of doing this is to right-click on the archetype in the tree in the CKM left panel (after you have saved it), select Archetype History from the context menu and in the new CKM tab click on the "Details" button of YOUR BRANCH of the archetype and select Share with Colleague. This will email a direct link to your archetype branch to colleagues of yours. A official CKM translation review functionality has also been put into place to streamline the review of translations.
Option 2: Translate Archetypes using an External Editor
Download archetype to your local computer.
Translate the archetype using an external editor.
Once completed you can upload the archetype back to CKM by:
Right-click on the archetype in the CKM left panel.
Select Revise archetype/Upload modified archetype and on the new CKM tab, select the archetype from your local file system and upload the archetype.
Changes you have made to the archetype are shown and you need to provide a log message to describe the revision made for this archetype.
You can also view your uploaded archetype by selecting View uploaded branch.
You can repeat this several times until you are satisfied that the translation is correct.
Once you are satisfied that the translation is correct (and you have e.g. checked this with other colleagues), please notify the editor of the archetype. The editor will then commit the archetype back to the trunk.
Note: Please take care not to change any other parts of the archetype. The editor may not be able to use your translation.
Getting a translation committed
After a translation has been added to an archetype branch, an editor or translation editor will need to commit the translation to the trunk for the translation to become part of the published archetype. When the Submit Final Translation and Notify Editor button is clicked, editors and translation editors will be notified of the submitted translation, and asked to check and commit the translation.
If your translation branch is the only open branch of the archetype, a translation editor can commit the translation independently. However, if there are multiple branches, or the branch containing the translation also contains other changes to the archetype, an editor will need to review and resolve the branches before committing them.