Help

Built with Seam

You can find the full source code for this website in the Seam package in the directory /examples/wiki. It is licensed under the LGPL.

This page contains the instructions for translating the community Seam documentation into your own native language.

The first step, is to find your language in the following table:

Code Language Territory Translation?
as-IN Assamese India None
bn-IN India Bengali None
de-DE German Germany None
es-ES Spanish Spain JBSEAM-2944
es-MX Spanish Mexico JBSEAM-3667
fr-FR French France JBSEAM-3541
gu-IN Gujarati India None
hi-IN Hindi India None
it-IT Italian Italy JBSEAM-3767
ja-JP Japanese Japan None
kn-IN Kannada India None
ko-KR Hangul Korea None
ml-IN Malayalam India None
mr-IN Marathi India None
or-IN Oriya India None
pa-IN Punjabi India None
pt-BR Portugese Brazil JBSEAM-3401
ru-RU Russian Russia JBSEAM-3723
si-LK Sinhala Sri Lanka None
sl-SL Slovenian Slovenia JBSEAM-2912
ta-IN Tamil India None
te-IN Telugu India None
th-TH Thai Thailand JBSEAM-3216
zh-CN Simplified Chinese China JBSEAM-3695
zh-TW Traditional Chinese Taiwan None

If your language does not appear in the above table, then please raise a feature request in JIRA describing which language and locale you would like to translate Seam into. Our documentation team will then create the necessary directory structure in Seam SVN to contain the translation in your own language.

The next step, is to check out the .po files for your language from the Seam SVN repository. These files are stored in SVN under their individual language directories (based on the language-locale code in the above table). You can feed the following URL into an SVN client to check out the entire reference guide or you can navigate to the URL in your browser to select the link for a specific locale:

http://anonsvn.jboss.org/repos/seam/branches/community/Seam_2_3/seam-reference-guide/

Each chapter of the documentation is represented by a separate .po (Gettext) file. We recommend the use of a PO file editor such as KBabel (if you're running KDE) or POEdit for translating the text contained within the .po files. These tools allow you to work with a paragraph at a time, by displaying the source text (in US-English) and allowing you to enter the corresponding translated text for the same paragraph. Both versions (English, and the translated version) are contained within the .po file.

To build your translations, you must have the poxml program installed. Once you have the program installed, just run in seam-reference-guide submodule:

mvn clean package -Dbuild.translations

You'll then find the translated html and pdf next to the en-US docs in doc/reference/{language}-{country}.

Our documentation team will synchronize any documentation changes made to the source version of the documentation (en-US) which will flag any modified paragraphs as fuzzy (meaning they may require an updated translation) regularly.

Please contribute the translation it to us as a patch (in unified diff format) via JIRA and we will include it in Seam. It's up to you how much of the documentation you translate - but we ask that you translate at a minimum one chapter. You can contribute your translation as you proceed if you wish - just keep the JIRA issue open and update it as you go.

Releasing translated documentation

As the Seam documentation is worked up until the last minute for a release, translations from English may not be released immediately. The process for releasing translations is:

  1. Seam X.Y.Z.GA is released with the English docs as prepared by the Seam development team.
  2. If a translation needs updates, the documentation from that release will be branched in SVN into branches/doc and the translation committed.
  3. Once the documentation is verified complete we will release a special jboss-seam-docs-X.Y.Z.zip just containing the documentation and translation. The documentation available from http://docs.jboss.org will be updated.
  4. Any changes made to a docs branch must be merged into the main branch as well.
10 comments:
 
19. Apr 2008, 15:04 America/New_York | Link

Link to SVN seems to be broken.

 
20. Apr 2008, 19:12 America/New_York | Link

Yes, currently you need to work on the 2.0 branch - I need to merge the 2.0 branch into trunk ;-)

 

Read about how to report a bug.

 
03. Nov 2008, 07:07 America/New_York | Link

Japan JBug is ready to start 2.1.0.GA translation. I guess it would take some time more than a couple of months from now. So I don' think the trunk is a good place for it because you may release newer versions before we finish the 2.1 translation. Do you have a plan to make the 2.1 branch?

Cheers, Miki

 
07. Nov 2008, 01:07 America/New_York | Link

I agree with you, right now I'm working on spanish (es-MX) translation and the documentation has some changes from version 2.0 to 2.1. A translation is not a trivial effort and I don't want to work in a translation that by the time is complete it is obsolete or it doesn't include the latest release.

 

Regards,
Omar

 
28. Nov 2008, 18:26 America/New_York | Link

Please Peter, update the 'it-IT' jira page reference to

https://jira.jboss.org/jira/browse/JBSEAM-3767

The previous one was about messages.properties file (now closed), this new one is about the Seam manual.

Thank you. Nicola

 
29. Nov 2008, 20:16 America/New_York | Link
Hi,
I need to clarify some points about the translation process with PO file.

1) I tried to run REFDOC ant's task with option

-D build.translations = true

with the aim to watch my work (it-IT translation)
But the task look for docs in fr-FR.
I saw that pm.xml contains only fr-FR in *translation* tag

<configuration>
     <sourceDirectory>${pom.basedir}</sourceDirectory>
     <sourceDocumentName>master.xml</sourceDocumentName>
     <masterTranslation>en-US</masterTranslation>
     <translations>
         <translation>fr-FR</translation>
     </translations
...

Trying to add manually it-IT is useless, because pom.xml is refreshed before running the task.

2) Anyway I get the following exception:

"[java] [INFO] Unable to locate PO file for [Performance.xml] in [fr-FR]
     [java] [INFO] ------------------------------------------------------------------------
     [java] [INFO] Trace
     [java] org.jboss.jdocbook.JDocBookProcessException: Unable to locate PO file for [Performance.xml] in [fr-FR]
     [java] at org.jboss.jdocbook.i18n.gettext.TranslationBuilderImpl.buildTranslation(TranslationBuilderImpl.java:60)"

From the above instruction it seems that I need the po2xml program (which I installed). Is the process of transforming PO to XML automatic into the script?
I have seen no reference.

Could you please give me some hints?

Thank you,
Nicola
 
15. Dec 2008, 09:26 America/New_York | Link

This problem no more exists now. I suggest to use Sun JVM instead of OpenJDK. This last one has problem compiling the manual.

Bye N

 
08. May 2009, 17:54 America/New_York | Link

Hi,

i have checked out: http://anonsvn.jboss.org/repos/seam/docs/trunk/SeamReferenceGuide/ and started with the german translation. My first chaper is complete and now started to check out how to generate the docs.

But in the svn are not build.xml or any pom.xml files. For sure this way is ant doing nothing.

I browsed over the svn, also in the branches for 2.0 and 2.1 and can't find any versions with build scripts.

The next thing is, i am using mac osx 10.5 and can't find any version of po2xml which is running on mac os x. Has some1 knowledge about translating the seam docs on a mac? if so, could u please share this knowledge with me? ;)

Ok translating futher is possible without building the docs. Till i get a solution, i will work on with poedit.

thanks alot and best regards rene

 
14. May 2009, 08:46 America/New_York | Link

So i figured out how to do it on Mac OSX.

First the provided svn path is useless. All so the first doc folder in svn, because this folders do not include the build configuration. The solution is to check out the development branch for the version u want to translate. I used:

http://anonsvn.jboss.org/repos/seam/branches/community/Seam_2_1/

Next is to get the po2xml tool. This programm is part of the Linux Desktop KDE in the kdesdk package. Thanks got that there is the Fink project. This project provides ports of linux open source projects for Mac OSX. Download the latest stable fink installer and run it. After installation copy the FinkCommander application to your programms folder. Start finkcommander and search for kdesdk3 and install it. In this package is the po2xml included. Fink is very nice, because it adds the application directly to your path environment. So that u can run it from commandline.

Now go in the checked out seam distribution and check all the pom.xml files for

<translation>nnn</translation>

. Add your language key like de-DE for me. To make the build faster delete the other translations. This way only your translation will be build.

Start translating your po files. I'm using poedit for mac osx.

When you want to see your work in the real documentation. Open a terminal, move to the distribution folder where the main build.xml is located and enter:

ant refdoc -Dbuild.translations=true

Wait until it is finished. First run will download a lot of dependies and it take some time ;)

When its done u will find your translation inside the doc/SeamReferenceGuide/target/docbook/publish. Every translation in a single folder named like the language key.

Thats it. I hope it will help other translators to start.

 
14. May 2009, 08:49 America/New_York | Link

One more thing. I don't checked it but it should be possible to get the po2xml application over cygwin on windows. Cygwin is a Linux environment for Windows, which allows u to run linux applications. This tool has also a nice installation manager.

I havent checked it, because i dont use windows ;)