|Version 15 (modified by damato, 22 months ago) (diff)|
Table of Contents
Right from the beginning, YAM has been translated to multiple languages. However, the responsible translator for each specific language changed over the years. As YAM is an open source development effort since 2000, we are continously searching for individual translators joining our project. The following tables lists the currently existing translations and their responsible translator which joined our project. If you feel that you have the time and knowledge to translate YAM in your language please feel free to join our project so that we can provide a translated YAM for more and more languages.
|Language||compatible YAM version||Translator|
|bosnian||2.3 (outdated)||no current maintainer|
|danish||outdated||no current maintainer|
|english-british||2.6||Jens Maus, Thore Böckelmann|
|finnish (suomi)||outdated||no current maintainer|
|german||2.6||Jens Maus, Thore Böckelmann|
|hungarian||outdated||no current maintainer|
|italian||2.6||Luca Longone, Samir Hawamdeh|
|norwegian||2.3 (outdated)||no current maintainer|
|polish||2.7||Mariusz Danilewicz, Kamil Niescioruk|
|portuguese-brazil||outdated||no current maintainer|
|portuguese||outdated||no current maintainer|
|russian||outdated||no current maintainer|
|serbian||2.3 (outdated)||no current maintainer|
|slovenian||outdated||no current maintainer|
All other languages here are currently not supported and you are of course free to contribute with your own translations to our development. So in case you are interested please feel free to contact our development team.
HowTo contribute your translation to us
This how-to assumes that you have enough experience to install and setup subversion (svn) and using the Shell.
First, you need to get the subversion client "svn" from AmiNET for OS3/OS4:
After that, you can go and do a checkout by doing something like this:
cd "where you want to store the files" svn co https://svn.yam.ch/svn/yam/trunk yam
This will checkout the sources from our "trunk" to your local directory "yam". Now you can go into the "locale" subdir and change the *.ct file for your language in there (Don't change the directory layout and such).
However, you need to make sure you keep the following in mind:
- Always do a "svn update" in that "yam" directory (not in any subdir of it) right before your next change or checkin so that you make sure you get the very latest changes.
- Always bump the revision and date of your *.ct file (in the header of it) before you checkin your changes back to the repository, that's very important!
- Always adapt the "ChangeLog" yourself by adding an entry to it right before you checkin (keep the style like we are doing it)
After you have done your changes you might do a "svn status" in the "yam" directory and subversion should tell you which files you changed (not the 'M' sign). And after that you could even do a "svn diff" in the directory and subversion should show you a diff file with the particular local changes you have made.
If you then have added a comment to the ChangeLog you can do a "svn commit" in the directory "yam" and subversion will prompt you for a log message. This should open c:Ed and here you should add a comment, same like you added to the ChangeLog file. It will also show you which files have been changed and thus which changes will be checked in. After that you will be promted for your login and password and after that you are done!
In the future you do not need to do a complete new checkout again, all you need to do, to update yam, is:
cd "your yam directory" svn update
And please note, before you are able to use "svn commit" you need to got our permission to submit your changes. So please inform us first in case you want to submit your .ct file to us.
Good luck translating YAM!
HowTo translate the online documentation
You don't need a subversion client here. Your favorite browser and an account on the Yam's site is enough.
You need to know the ISO639-1 code of the language you wish to translate the documentation.
For example, if you wish to translate into Italian, the code is "it". For a complete List of the possible language codes see the following page: http://yam.ch/wiki/TracLanguages
A little bit of knowledge about WikiFormatting will help, but is not required.
Here are the steps to start a new translation:
- Login - This is needed to be allowed to create and edit wiki documents.
- Go to the main default (English) documentation page.
- Click on the Edit button and copy the content.
- Cancel the edition of that page.
- Now you have to create a new main page for your translation. Let's say the translation will be in Italian.
In the URL text gadget of your browser, type:
- "it" is the ISO639-1 code for Italian
- "%3A" is the URL replacement for ":".
- You will be prompted that the document does not exist. Click on Create.
- Paste the content you have previously copied, and start replacing the English strings by the Italian equivalent.
- Use the Preview Page button as much as needed, then save your work with the Submit changes button.
IMPORTANT for the main page (and the main page only):
This page is the root of all subsequent documents, linked by an absolute path.
To make those links point to the future translated pages and not the English ones, you need to edit each occurence of
Links in the other documents won't need to be edited as they will be all relatives to wiki:it:Documentation/.
When the main documentation page is created, with the links in it properly edited, you can just follow those links to create or edit other documentation pages.
Editing the macro instructions
On top of most pages, you will find 2 macros :
TranslatedPages This creates a list of all available languages the current page is translated to.
Translated pages must be given the revision argument. For example, if the English page you wish to translate is at version 4, add or edit the macro instruction on the translation so that it looks like this :[[TranslatedPages(revision=4)]]
Another useful argument is outdated.[[TranslatedPages(revision=4,outdated=Needs proof-reading)]]
means the page is flagged as to be updated (in yellow in the below table), and the text "Needs proof-reading" will appear on top of the page.
TOC Creates a Table Of Content.
As with the main first page, where you see a pattern starting with "Documentation", you have to prepend the language code to it.
Example:[[TOC(titleindex, heading=ARexx API, notitle, depth=2, it:Documentation/ARexx API/*)]] ^^^
Status of online documentation translations
To assist in properly translating the online documentation and wiki pages please see the following list of status messages for all currently translated pages:
- Red: There is an error with this page (see error list below)
- Yellow: Page needs update
- Green: Everything up-to-date
- Grey: Page is missing
If you have questions or wish to discuss about translations, please post on the Locale Translations forum.
Thank for your help !