translation-quick-start-guide/en_US Translating_Software.xml, 1.2, 1.3
Paul W. Frields (pfrields)
fedora-docs-commits at redhat.com
Wed Nov 14 22:47:43 UTC 2007
Author: pfrields
Update of /cvs/docs/translation-quick-start-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv25776
Modified Files:
Translating_Software.xml
Log Message:
Finish editing this section (finally)
Index: Translating_Software.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/Translating_Software.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- Translating_Software.xml 28 Sep 2007 04:25:00 -0000 1.2
+++ Translating_Software.xml 14 Nov 2007 22:47:41 -0000 1.3
@@ -11,216 +11,283 @@
]>
<section id="sn_translating_software">
- <title>Translating Software</title>
+ <title>Translating Software</title>
+ <para>
+ The translatable part of a software package is available in one or
+ more <filename class="extension">po</filename> files. These files
+ may be maintained in any of a number of version control systems
+ (VCSs) depending on the project, such as CVS, Subversion, Mercurial,
+ and git. They may be hosted on either <systemitem
+ class="domainname">fedoraproject.org</systemitem> or the
+ <systemitem class="fqdomainname">i18n.redhat.com</systemitem>
+ server. The <systemitem
+ class="fqdomainname">i18n.redhat.com</systemitem> system is not
+ enabled to work with the <systemitem>cvsl10n</systemitem> group. To
+ sign up for an account on <systemitem
+ class="fqdomainname">i18n.redhat.com</systemitem>, 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
+ <systemitem class="domainname">fedoraproject.org</systemitem>.
+ Translators work on two interfaces, one for obtaining modules and
+ another for committing modules. Before you start, you must first
+ prepare the directories which hold your <filename
+ class="extension">po</filename> files.
+ </para>
+
+ <section id="sn-file-structure">
+ <title>File Structure</title>
<para>
- The translatable part of a software package is available in one or
- 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.
+ To find which modules are translatable, visit the Module List at
+ <ulink
+ url="https://publictest5.fedora.redhat.com/submit/module/"/>.
</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.
+ Before you download any files, prepare the structure holding those
+ files. The described structure below is an example, and your
+ structure can be formed differently. For example, if you want to
+ download the <systemitem>comps</systemitem> module for
+ translation, make the following directories:
</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>mkdir -p ~/myproject/comps/</command>
-</screen>
- <para>
- 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>
-</section>
+ <screen><command>mkdir -p ~/myproject/comps/</command></screen>
+ <para>
+ To work on another module later, make a directory with the module
+ name under the parent directory such as <filename
+ class="directory">myproject</filename>.
+ </para>
+ </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>
+ Now that you have prepared a directory structure, you can download
+ a file to translate.
+ </para>
+ <procedure>
+ <step>
+ <para>
+ Visit <ulink
+ url="http://translate.fedoraproject.org/module/"/> and
+ select a target module. The interface will redirect you to a
+ page for that module, such as <ulink
+ url="http://translate.fedoraproject.org/module/comps/"/>.
</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>
- 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>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>
- <para>
- Now the file is ready for translation. Translate the .po file of your language in a .po editor such as KBabel or gtranslator.
- </para>
- </step>
- <step>
- <para>
- Please check the integrity of your file before commit;
- </para>
-<screen>
-<command>msgfmt -cvo /dev/null ja.po</command>
-</screen>
- </step>
- </procedure>
+ </step>
+ <step>
+ <para>
+ Scroll down the page to find the table of all <filename
+ class="extension">po</filename> files
+ available. The <filename class="extension">pot</filename> file
+ appears at the top of the listing. Use the green download
+ icon next to each language to download the file to the
+ directory you created in the previous section.
+ </para>
+ </step>
+ <step>
+ <para>
+ Since the file name to commit follows the name convention of
+ <filename>lang.po</filename>, change the name of the
+ downloaded file. The following example uses the Japanese
+ locale for the <filename class="extension">po</filename> file:
+ </para>
+
+ <!-- The <![CDATA[...]]> containers will keep these pieces of
+ content out of the POT file since they don't need to be
+ translated. Unfortunately, each line of content after the first
+ one must be flush-left with the margin to keep it from being
+ indented in the output, since these appear in "verbatim" styles
+ once DocBook XSLT converts the XML to HTML. -->
+
+ <screen><userinput><![CDATA[ls ~/myproject/comps/]]></userinput>
+<computeroutput><![CDATA[comps.HEAD.ja.po]]></computeroutput>
+<userinput><![CDATA[mv ~/myproject/comps/comps.HEAD.ja.po ja.po]]></userinput>
+<userinput><![CDATA[ls ~/myproject/comps/]]></userinput>
+<computeroutput><![CDATA[ja.po]]></computeroutput></screen>
+
+ </step>
+ <step>
+ <para>
+ Now the file is ready for translation. Translate the <filename
+ class="extension">po</filename> file for your language in a
+ <filename class="extension">po</filename> editor such as
+ <application>KBabel</application> or
+ <application>gtranslator</application>.
+ </para>
+ </step>
+ <step>
+ <para>
+ Check the integrity of your file before you commit it.
+ </para>
+ <screen><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>
+ <important>
+ <para>
+ If any error message appears, 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>
- 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>
- <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>
- 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>
+ <para>
+ Once you finish translation work, commit the file using a separate
+ interface called <application>Transifex</application>. You can
+ find detailed information about this web tool at <ulink
+ url="https://publictest5.fedora.redhat.com/submit/"/>.
+ </para>
+ <procedure>
+ <step>
+ <para>
+ Visit <ulink
+ url="https://publictest5.fedora.redhat.com/submit/"/> and
+ click the link <guilabel>Jump to Modules!</guilabel> to go to
+ the <guilabel>Modules and repositories</guilabel> page. This
+ page displays all modules to which you can commit changes.
+ Find the module to commit from the list and select it to visit
+ the <guilabel>Submit</guilabel> page for that module.
+ </para>
+ </step>
+ <step>
+ <title>Login</title>
+ <para>
+ At the bottom of the <guilabel>Submit</guilabel> page, select
+ <guilabel>Authenticate as a translator</guilabel> to visit the
+ <guilabel>Login</guilabel> page. Authenticate with your Fedora
+ Account System username and password. Upon successful login,
+ the <guilabel>Submit</guilabel> page appears.
+ </para>
+ </step>
+ <step>
+ <title>Submit</title>
+ <para>
+ In the section labeled <guilabel>Local file</guilabel>, click
+ the browse button to locate your translated file. <!-- DO NOT
+ USE COLORS SINCE IT DISADVANTAGES VISUALLY IMPAIRED USERS. USE
+ A LABEL INSTEAD. -->
+ </para>
+ <para>
+ In the section labeled <guilabel>Destination file</guilabel>,
+ click the dropdown menu labeled <guilabel>Overwrite an
+ existing file:</guilabel> to select your language.
+ </para>
+ <para>
+ In the section labeled <guilabel>Commit message</guilabel>,
+ enter a comment to describe your work.
+ </para>
+ <para>
+ Select the <guibutton>Preview</guibutton> button to proceed to
+ the <guilabel>Preview submission</guilabel> page. Check the
+ <guilabel>Differences</guilabel> section to verify your
+ changes and select the <guibutton>Submit</guibutton> button.
+ </para>
+ <para>
+ The <guilabel>Submit</guilabel> page appears and displays the
+ message <guilabel>Your submission was committed
+ successfully</guilabel>. If you receive an error or some
+ other success message, please post it to the Fedora
+ Translation Project mailing list so it can be addressed.
+ </para>
+ </step>
+ </procedure>
</section>
<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>
- First download the .pot file and make it to your own language .po file.
- </para>
-<screen>
-<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>
- Once you finish the translation, follow same steps described in previous section.
- </para>
- </step>
- <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>
+ <title>Adding New .po file</title>
+ <para>
+ If there is no <filename class="extension">po</filename> file for
+ your language, add it.
+ </para>
+ <procedure>
+ <step>
+ <para>
+ Download the <filename class="extension">pot</filename> file
+ and copy it as your own language's <filename
+ class="extension">po</filename> file.
+ </para>
+ <screen><command><![CDATA[cp ~/myproject/comps/comps.HEAD.pot ja.po
+kbabel ja.po
+msgfmt -cvo /dev/null ja.po]]></command></screen>
+ </step>
+ <step>
+ <para>
+ Once you finish the translation, follow the same steps for
+ verifying and committing your translation described in
+ previous section.
+ </para>
+ </step>
+ <step>
+ <para>
+ In the section labeled <guilabel>Destination file</guilabel>,
+ type your new filename in the field marked <guilabel>Type the
+ name for a new one:</guilabel>, replacing the filename with
+ your locale:
+ </para>
+ <screen><userinput><![CDATA[po/ja.po]]></userinput></screen>
+ </step>
+ </procedure>
+ </section>
- <section id="sn-proofreading">
- <title>Proofreading</title>
+ <section id="sn-proofreading">
+ <title>Proofreading</title>
- <para>
- If you want to proofread your translation as part of the
- software, follow these steps:
- </para>
- <procedure>
- <step>
- <para>
- Go to the directory of the package you want to proofread:
- </para>
-
-<screen>
-<command>cd ~/myproject/<replaceable>package_name</replaceable></command>
-</screen>
-
- </step>
- <step>
- <para>
- Convert the <filename>.po</filename> file in
- <filename>.mo</filename> file with <command>msgfmt</command>:
- </para>
-
-<screen>
-<command>msgfmt <replaceable>lang</replaceable>.po</command>
-</screen>
-
- </step>
- <step>
- <para>
- Overwrite the existing <filename>.mo</filename> file in
- <filename>/usr/share/locale/<replaceable>lang</replaceable>/LC_MESSAGES/</filename>.
- First, back up the existing file:
- </para>
-
-<screen>
-<command>cp /usr/share/locale/<replaceable>lang</replaceable>/LC_MESSAGES/<replaceable>package_name</replaceable>.mo <replaceable>package_name</replaceable>.mo-backup</command>
-<command>mv <replaceable>package_name</replaceable>.mo /usr/share/locale/<replaceable>lang</replaceable>/LC_MESSAGES/</command>
-</screen>
-
- </step>
- <step>
- <para>
- Proofread the package with the translated strings as part of
- the application:
- </para>
-
-<screen>
-<command>LANG=<replaceable>lang</replaceable> rpm -qi <replaceable>package_name</replaceable></command>
-</screen>
+ <para>
+ To proofread your translation as part of the software, follow
+ these steps:
+ </para>
+ <procedure>
+ <step>
+ <para>
+ Change directory to the package you want to proofread:
+ </para>
- </step>
- </procedure>
- <para>
- The application related to the translated package runs with
- the translated strings.
- </para>
- </section>
+ <screen><command>cd ~/myproject/<replaceable>package_name</replaceable></command></screen>
+
+ </step>
+ <step>
+ <para>
+ Convert the <filename class="extension">.po</filename> file to
+ a <filename class="extension">.mo</filename> file with
+ <command>msgfmt</command>:
+ </para>
+
+ <screen><command>msgfmt <replaceable>lang</replaceable>.po</command></screen>
+
+ </step>
+ <step>
+ <para>
+ Overwrite the existing <filename
+ class="extension">.mo</filename> file in
+ <filename>/usr/share/locale/<replaceable>lang</replaceable>/LC_MESSAGES/</filename>.
+ First, back up the existing file:
+ </para>
+
+ <screen><command>cp /usr/share/locale/<replaceable>lang</replaceable>/LC_MESSAGES/<replaceable>package_name</replaceable>.mo <replaceable>package_name</replaceable>.mo-backup</command>
+<command>mv <replaceable>package_name</replaceable>.mo /usr/share/locale/<replaceable>lang</replaceable>/LC_MESSAGES/</command></screen>
+
+ </step>
+ <step>
+ <!-- IS THIS RIGHT? It looks more like you're checking the -->
+ <!-- contents of specspo, not the content of the -->
+ <!-- application. [PWF] -->
+ <para>
+ Proofread the package with the translated strings as part of
+ the application:
+ </para>
+
+ <screen><command>LANG=<replaceable>lang</replaceable> rpm -qi <replaceable>package_name</replaceable></command></screen>
+
+ </step>
+ </procedure>
+ <para>
+ The application related to the translated package runs with the
+ translated strings.
+ </para>
+ </section>
-</section>
\ No newline at end of file
+</section>
More information about the Fedora-docs-commits
mailing list