Please remove this {{Draft}}template, when you're sure the page is complete and correct.
|
| Note: Translations are no longer done in Calenco, but directly in git or in Transifex Please read Internationalisation_Team_(i18n) and introduce yourself on i18n-discuss@ml.mageia.org and on the i18n mailing list for your language, if the latter exists, if you want to help |
Contents
Aim
|
This Howto deals with the use of Calenco and xxe for writing and translation of Mageia installer help files. Further information can be obtained on the mailing list doc-discuss@ml.mageia.org, and on the IRC Channel #mageia-doc. |
Credentials
Getting them
If we don't manage to communicate well with you, for instance if we've seen that we don't manage to explain you well enough how to correctly contribute to the wiki, then we first need to find a way to improve our communication.
If that isn't a problem and if you have done all of the following:
- successfuly translated some of our .xml files by yourself after which they were uploaded to Calenco
- someone with Calenco access will download the needed .xml files for you, it is impossible to do that without credentials
- read the following:
then you can ask for credentials (a username and password) to access the Mageia Calenco repository.
The simplest way to get them is to send an e-mail to John at the address
"john At neodoc DOT biz" with a copy to
"marja11 AT xs4all DOT nl"
("AT" to be replaced by @ and DOT by ".").
This e-mail must include the following information:
- Your full name (given name + surname)
- The chosen nickname
- The language(s) you are able to work with.
- Your languages names in your own language or typeface so the language interface render correctly, eg. in this form: Greek ελληνικά [el] or Estonian Eesti [et]
Very important information for translators is often given on our mailing list doc-discuss@ml.mageia.org.
Losing them
If you never use your credentials to edit a file, or if you disappear and we don't manage to contact you, there is a grace period of 6 months. After that your Calenco account will be removed.
Of course it will be possible to get them again for good reasons.
Installation
You can already use Calenco without installing anything, just connect your favourite browser at the address : https://mageia.calenco.com/
There is an xxe rpm package available here if you would like to have a wysiwyg editor.
Please be aware that this xxe package is written around sun-java and may not behave as expected if you are using openjdk on your system.
Neodoc recommends for best results with the full editor (xxe) in the Calenco workspace, that you should install sun-java 1.7.*.
| Note: Due to the recent changes in Oracle Java's license, it is no longer provided in the Mageia 2 repositories. You can download the latest official package on Java's website. |
Proceeding
Please join #mageia-doc IRC channel on Liberachat when you start. It can for instance happen that Calenco needs to be restarted. Camille always warns us in that channel.
Starting
Login to https://mageia.calenco.com/ and give your Login and password. this screen appears :
- On the top right corner is a drop-down list of all the languages. Select English.
- On the left frame are the available folders, open the "NewInstallerText" folder
- A list of all the English files appear in the middle frame
- Click on a file and check the Preview box to display its content. The text here is in read only mode, that is normal.
Editing a file
Open the file
Begin by displaying the file as above, then click on file/full editor in the Calenco menu. A new tab opens and will ask again for the username and password. You may be asked to authenticate several (possibly 3) times, so be patient. Accept the script execution. Now the file can be edited in the xxe browser tab and modification is allowed.
Sometimes modification appears to be blocked, just click on the Calenco tab and then back on the xxe tab, modification ability is restored
Close the file
Save the file: File/save
Close the windows: Window/close
Kill the tab.
You must open a new xxe tab for each new file opened.
- The menu bar
- The tool bar
- The node path bar: Shows which XML node is selected and which are its ancestor elements. Allows to explicitly select an XML node.
- The document tab
- The edit tool
- The attributes tool
- The search tool
- The spell tool
- The characters tool
- The validity tool
Translate a file
Open the English (en) file in the first tab and edit it in the second tab like above. Click on File/save as ... in the xxe menu. A dialog box appears with the path to the English file. Just change the directory en (for English) by your language letters. The file is now saved in your language workspace and translation is possible.
For exemple, if I want to translate in French the English file selectKeyboard.xml, I edit this file and click on File/save as ..., in the dialog box I change the path:
http://vargas.calenco.com:8284/workspaces/Documentation/classifications/NewInstallerText/en/selectKeyboard.xml
to:
http://vargas.calenco.com:8284/workspaces/Documentation/classifications/NewInstallerText/fr/selectKeyboard.xml.
Use the regular File/save for the next saves.
Some translating rules
- You must preserve the attributes, their presence is shown by a bold or special font prints and also in the node path bar just under the tool bar.
- You must preserve the tags (like xref for instance)
- You must not translate the key words like Warning, note,
- You must not translate the file names (of the images for instance)
- You must update the related board:
Uploading files in group
Calenco offers the function to upload files grouped in a Zip file. For that, you must follow the structure as described hereunder. If the files are not grouped according this tree, the import will abort. The root should be "content". Then, the directory "content" holds directories named with the language code, such as "en, "fr" or "pt-BR". The files in "International" section are stored directly in the directory "content".
