Translations
Currently only three languages are primary supported: english, german and slovak. Slovak was the native language of developers from Cyclone3's propietary era and because most current developers are in fact Slovak. English is the obvious choice as the primary translation langage because of its broad acceptance and international status. It is recommended to transale only from English sources.
If you can you translate to any language (we mean any) we would really welcome your help with the translation.
What is translated and where/how is it stored?
We divide texts into three main categories:
-
Common documents
-
Source code documentation
-
XULadmin i18n
As the method used to directly comment perl code does not allow us to write multilanguage comments we use only English for this purpose.
XULadmin i18n (as any other XUL project) has i18n strings stored in .ent files (entity form).
All other documents are stored as DocBook files which are used to generate the content of our web presentation (excluding news). Most translation therefore consists of translating these sources.
-
doc/ - basic web content
-
frame/.core/doc/ - developers documentation
-
frame/_addons/Ext/XULadmin/help/ - user manual for XULAdmin
-
xuladmin/doc/ - developers documentation for XULAdmin
-
xuladmin/xpi-source/locale/ - XULadmin i18n
How to translate?
Most document direcotries contain many .docbook files. Most of these have -en.docbook or -sk.docbook suffixes which means that if you want to create for example german version of the document you can do so by copying the -en.docbook file into -de.docbook. Afterwards translat its contents into german and submit it into the subversion repository.
We recommend to use the multiplatform and free XML editor XXE. If you manage to submit any translation to our mailing list we will offer you full write access into the subversion repository so you can manage the translations yourself.
We therefore require the following skills
-
Subversion basics
-
Knowledge of English and language you are planing to translate into
-
Docbook editing
-
Don't forget tracking all documentation changes in special RSS channel!
Commiting
For commiting documentation we use special subversion messages that helps us to track commits better. Every commit of documentation must end with "(minor)" statement at the end which ensures that developers will not be alarmed of any important source code change.
eg. you added german translation of a document in /doc/contribute/:
[+][doc:contribute] translation - added 'de' version (minor)
eg. you changed the documentation of requirements in /frame/.core/doc/:
[*][frame:doc] system requirements - changed description (minor)
eg. you fixed missing link in /frame/_addons/Ext/XULadmin/help/:
[!][frame:eXULadmin] content - fixed broken link (minor)
User Comments