translation-quick-start-guide/en_US Translating_Software.xml, 1.1, 1.2
Noriko Mizumoto (noriko)
fedora-docs-commits at redhat.com
Fri Sep 28 04:25:02 UTC 2007
Author: noriko
Update of /cvs/docs/translation-quick-start-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv8321
Modified Files:
Translating_Software.xml
Log Message:
the content has been re-written entirely for new obtain/commit module system
Index: Translating_Software.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/Translating_Software.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Translating_Software.xml 23 Aug 2007 04:19:56 -0000 1.1
+++ Translating_Software.xml 28 Sep 2007 04:25:00 -0000 1.2
@@ -15,154 +15,153 @@
<para>
The translatable part of a software package is available in one or
- more <filename>po</filename> files. The &FP; stores these files in
- a CVS repository under the directory
- <filename>translate/</filename>. Once your account has been
- approved, download this directory typing the following
- instructions in a command line:
+ more <filename>po</filename> files. These files are maintained with various VCSs (Version Control System) depending on the project, such as cvs, svn, hg and git, and they are hosted on either fedoraproject.org or i18n.redhat.com server. The latter i18.redhat.com is not enabled to work with the cvsl10n group. please visit: <ulink url="http://i18n.redhat.com/cgi-bin/i18n-signup/"/>. This warning will probably be deprecated soon.
+ </para>
+ <para>
+ This chapter explains how to translate the modules hosted on fedoraproject.org. Translators will need to work on two interfaces, one is for obtaining modules and another is for committing modules. Before doing these, the direcotries which hold your po files need to be prepared.
</para>
+ <section id="sn-file-structure">
+ <title>File Structure</title>
+ <para>
+ To find which modules are translatable, please visit <ulink url="https://publictest5.fedora.redhat.com/submit/module/"/> to find the Module List.
+ </para>
+ <para>
+ Before downloading any file, it would be good idea to prepare the structure holding those files. The described structure below is just for example, and your structure can be formed differently.
+ </para>
+ <para>
+ For example, assuming to download 'comps' module as first file to start, you can make the following directories for this module.
+ </para>
<screen>
-<command>export CVS_RSH=ssh</command>
-<command>export CVSROOT=:ext:<replaceable>username</replaceable>@i18n.redhat.com:/usr/local/CVS</command>
-<command>cvs -z9 co translate/</command>
+<command>mkdir -p ~/myproject/comps/</command>
</screen>
-
- <para>
- These commands download all the modules and
- <filename>.po</filename> files to your machine following the same
- hierarchy of the repository. Each directory contains a
- <filename>.pot</filename> file, such as
- <filename>anaconda.pot</filename>, and the
- <filename>.po</filename> files for each language, such as
- <filename>zh_CN.po</filename>, <filename>de.po</filename>, and so
- forth.
- </para>
- <para>
- You can check the status of the translations at <ulink
- url="http://i18n.redhat.com/cgi-bin/i18n-status"/>. Choose your
- language in the dropdown menu or check the overall status. Select
- a package to view the maintainer and the name of the last
- translator of this module. If you want to translate a module,
- contact your language-specific list and let your community know
- you are working on that module. Afterwards, select
- <literal>take</literal> in the status page. The module is then
- assigned to you. At the password prompt, enter the one you
- received via e-mail when you applied for your account.
- </para>
- <note>
- <title>Requesting a Language Status Page</title>
<para>
- If your language is not in the list of available languages,
- select <guilabel>Other</guilabel> and click <guibutton>Show
- Status</guibutton>. On the next page, select your language and
- press <guibutton>Continue</guibutton> to show your interest.
- Send an email to <email>fedora-trans-list at redhat.com</email> to
- express your interest in translating for the selected language
- in &FED;.
+ Please replace the directory name 'myproject' with appropriate name. For next module to work, you only make a directory with module-name under the parent directory such as 'myproject' in this case.
</para>
- </note>
- <para>
- You can now start translating.
- </para>
-
- <section id="sn-translating-strings">
- <title>Translating Strings</title>
-
+</section>
+
+ <section id="sn-obtain-translate-modules">
+ <title>Obtaining and Translating Modules</title>
+ <para>
+ Now the structure is ready, a file to translate can be downloaded.
+ </para>
<procedure>
+ <step>
+ <para>
+ Click the target module from here <ulink url="http://translate.fedoraproject.org/module/"/>. It will take you to that module page, such as <ulink url="http://translate.fedoraproject.org/module/comps/"/>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Scroll down the page, there is the table of all po files available with pot file on the top. Use the green download icon next to each language to download the file to the directory created at previous section.
+ </para>
+ </step>
<step>
<para>
- Change directory to the location of the package you have
- taken.
+ Since the file name to commit must follow the name convention of lang.po, change the downloaded file's name (the example uses Japanese po file);
</para>
<screen>
-<command>cd ~/translate/<replaceable>package_name</replaceable></command>
+<command>ls ~/myproject/comps/</command>
+<command>comps.HEAD.ja.po </command>
+<command>mv ~/myproject/comps/comps.HEAD.ja.po ja.po</command>
+<command>ls ~/myproject/comps/</command>
+<command>ja.po</command>
</screen>
- </step>
+ </step>
<step>
<para>
- Update the files with the following command:
+ Now the file is ready for translation. Translate the .po file of your language in a .po editor such as KBabel or gtranslator.
</para>
-
-<screen>
-<command>cvs up</command>
-</screen>
-
- </step>
+ </step>
<step>
<para>
- Before you start translating, make sure the <filename
- class="extension">.po</filename> file reflects the latest
- <filename class="extension">.pot</filename>. Run the
- following command to synchronize your <filename
- class="extension">.po</filename> file:
+ Please check the integrity of your file before commit;
</para>
-
<screen>
-<command>msgmerge <replaceable>lang</replaceable>.po <replaceable>package_name</replaceable>.pot > <replaceable>tmp</replaceable>.po</command>
+<command>msgfmt -cvo /dev/null ja.po</command>
</screen>
-
</step>
+ </procedure>
+
+ <important>
+ <para>
+ If any error message appears, please correct it before commit.
+ </para>
+ </important>
+
+ </section>
+ <section id="sn-commit-modules">
+ <title>Committing Modules</title>
+ <para>
+ Once you finish translation work, the file can be committed from separate interface called 'transifex'. You can find the detailed information on this web tool at <ulink url="https://publictest5.fedora.redhat.com/submit/"/>.
+ </para>
+ <procedure>
<step>
- <para>Check the integrity of the new file:</para>
-
-<screen>
-<command>msgfmt -cvo /dev/null <replaceable>tmp</replaceable>.po</command>
-</screen>
-
+ <para>
+ At the page of <ulink url="https://publictest5.fedora.redhat.com/submit/"/>, click the link <guilabel>Jump to Modules!</guilabel> to go to <guilabel>Modules and repositories</guilabel>, where you can see the modules commitable. Find the module to commit from the list and click it. You will be taken to the <guilabel>Submit</guilabel> page of the module.
+ </para>
</step>
-
<step>
- <para>
- If no error message appears, run the following command to
- overwrite the
- <filename><replaceable>lang</replaceable>.po</filename> with
- <filename><replaceable>tmp</replaceable>.po</filename>:
- </para>
-
-<screen>
-<command>mv <replaceable>tmp</replaceable>.po <replaceable>lang</replaceable>.po</command>
-</screen>
-
- </step>
+ <title>Login</title>
+ <para>
+ At the bottom of the <guilabel>Submit</guilabel> page, click <guilabel>Authenticate as a translator</guilabel>, you will be taken to <guilabel>Login</guilabel> page. Authenticate with your Fedora Account System username and password there. Then you will be taken back to the <guilabel>Submit</guilabel> page upon successful login.
+ </para>
+ </step>
<step>
+ <title>Submit</title>
<para>
- Translate the <filename class="extension">.po</filename>
- file of your language in a <filename
- class="extension">.po</filename> editor such as
- <application>KBabel</application> or
- <application>gtranslator</application>. For example, to open
- the <filename class="extension">.po</filename> file for
- Spanish in <application>KBabel</application>, type:
+ At the section of <guilabel>Local file</guilabel>, click the browse button to locate your translated file.
</para>
+ <para>
+ At the section of <guilabel>Destination file</guilabel>, click the dropdown menu of <guilabel>Overwrite an existing file:</guilabel> field to select your language.
+ </para>
+ <para>
+ At the section of <guilabel>Commit message</guilabel>, enter your comment in free format to describe your work.
+ </para>
+ <para>
+ Click <guibutton>Preview</guibutton> button, you'll be taken to <guilabel>Preview submission</guilabel> page. Check <guilabel>Differences</guilabel> section and click <guibutton>Submit</guibutton> button.
+ </para>
+ <para>
+ The Submit page appears and display the message 'Your submission was committed successfully.'. If you get an error message other than this success message, please post in fedora-trans-list, the admin team will look after the problem.
+ </para>
+ </step>
+ </procedure>
+ </section>
-<screen>
-<command>kbabel es.po</command>
-</screen>
-
- </step>
+ <section id="sn-add-new-file">
+ <title>Adding New .po file</title>
+ <para>
+ If there is no .po file for your language, you can add it.
+ </para>
+ <procedure>
<step>
<para>
- When you finish your work, commit your changes back to the
- repository:
+ First download the .pot file and make it to your own language .po file.
</para>
-
<screen>
-<command>cvs commit -m '<replaceable>comments</replaceable>' <replaceable>lang</replaceable>.po</command>
+<command>cp ~/myproject/comps/comps.HEAD.pot ja.po</command>
+<command>kbabel ja.po</command>
+<command>msgfmt -cvo /dev/null ja.po</command>
</screen>
-
</step>
<step>
<para>
- Click the <literal>Release</literal> link on the status page
- to release the module so other people can work on it.
- </para>
+ Once you finish the translation, follow same steps described in previous section.
+ </para>
</step>
- </procedure>
- </section>
+ <step>
+ <para>
+ Now at the section <guilabel>Destination file</guilabel>, type in your new filename in <guilabel>type the name for a new one:</guilabel> field (replace the filename with your locale);
+ </para>
+<screen>
+<userinput>po/ja.po</userinput>
+</screen>
+ </step>
+ </procedure>
+</section>
<section id="sn-proofreading">
<title>Proofreading</title>
@@ -178,7 +177,7 @@
</para>
<screen>
-<command>cd ~/translate/<replaceable>package_name</replaceable></command>
+<command>cd ~/myproject/<replaceable>package_name</replaceable></command>
</screen>
</step>
@@ -223,6 +222,5 @@
the translated strings.
</para>
</section>
-
- </section>
-
+
+</section>
\ No newline at end of file
More information about the docs-commits
mailing list