translation-quick-start-guide/en_US Translating_Documentation.xml, 1.1, 1.2
Noriko Mizumoto (noriko)
fedora-docs-commits at redhat.com
Fri Sep 28 06:33:26 UTC 2007
Author: noriko
Update of /cvs/docs/translation-quick-start-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv24121
Modified Files:
Translating_Documentation.xml
Log Message:
the content has been updated
Index: Translating_Documentation.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/Translating_Documentation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Translating_Documentation.xml 23 Aug 2007 04:19:56 -0000 1.1
+++ Translating_Documentation.xml 28 Sep 2007 06:33:24 -0000 1.2
@@ -14,18 +14,20 @@
<title>Translating Documentation</title>
<para>
- To translate documentation, you need a &FC; &FCMINVER; or later
- system with the following packages installed:
+ Once you have a Fedora Account and have become a member of the group 'cvsl10n', you'll be able to contribute translations to Docs (see Accounts and Subscriptions Chapter for detail).
+ </para>
+ <para>
+ To translate documentation, you need a &FC; &FCMINVER; or later system with the following packages installed:
</para>
<itemizedlist>
<listitem>
- <para><package>gnome-doc-utils</package></para>
+ <para><package>gnome-doc-utils // Provdies xml2po</package></para>
</listitem>
<listitem>
- <para><package>xmlto</package></para>
+ <para><package>xmlto //For testing build</package></para>
</listitem>
<listitem>
- <para><package>make</package></para>
+ <para><package>make //For testing build</package></para>
</listitem>
</itemizedlist>
<para>
@@ -36,15 +38,12 @@
<command>su -c 'yum install gnome-doc-utils xmlto make'</command>
</screen>
- <section id="sn-downloading-docs">
- <title>Downloading Documentation</title>
+ <section id="sn-get-started">
+ <title>Get Started</title>
<para>
- The Fedora documentation is also stored in a CVS repository
- under the directory <filename>docs/</filename>. The process to
- download the documentation is similar to the one used to
- download <filename>.po</filename> files. To list the available
- modules, run the following commands:
+ The Fedora documentation is stored in a CVS repository
+ under the directory <filename>docs/</filename>. To list the available modules, run the following commands:
</para>
<screen>
@@ -54,34 +53,42 @@
</screen>
<para>
- To download a module to translate, list the current modules in
- the repository and then check out that module. You must also
- check out the <filename>docs-common</filename> module to work
+ To download a module to translate, list the current modules in the repository and then check out that module. You must also check out the <filename>docs-common</filename> module to work
with some modules.
</para>
<screen>
-<command>cvs co example-tutorial docs-common</command>
+<command>cvs co release-notes/</command>
</screen>
- <para>Modules that are created for each release of &DISTRO; are
- separated into <firstterm>branches</firstterm>. The branch
- shows the release of &DISTRO; for which that document was
- created. The <filename>release-notes-F-7</filename> module, for
- example, contains the branch of the <citetitle>Release
- Notes</citetitle> created for Fedora 7.</para>
-
<para>
- The documents are written in DocBook XML format. Each is stored
- in a directory named for the specific-language locale, such as
- <filename>en_US/example-tutorial.xml</filename>. The
- translation <filename class="extension">.po</filename> files are
- stored in the <filename class="directory">po/</filename>
- directory.
+ Each release of &DISTRO; has their own subdirectory underneath.
+ </para>
+<screen>
+<command>ls release-notes/</command>
+<command>CVS F-7 FC-5 FC-6 FC3 FC4 devel</command>
+</screen>
+ <para>
+ Each subdirectory of &DISTRO; contains a set of it's release. And usually translator works on devel/ subdirectory for future release.
+ </para>
+<screen>
+<command>ls release-notes/devel/</command>
+<command>
+ CVS css indexhtml-foot readmes.xsl
+ Makefile en_US indexhtml-head scripts
+ README-Accessibility fedora-release-notes.spec messages.mo xmlbeats
+ README.fedora-release figs po</command>
+</screen>
+ <para>
+ Under po/ directory the above, .po files to be translated are stored. If you can not find your language .po file, then the .po file can be newly created from .pot file. Please remember that the newly created file must be added in cvs (cvs add) and then commited (cvs commit). Also you should check po/LINGUAS file if it contains your language code.
+ </para>
+ <para>
+ To translate the document, simply get your language .po file and work just like Software translation, such as with Kbabel or gtranslator.
</para>
-
</section>
+ <!--Is this section deprecated?
+
<section id="sn-creating-common">
<title>Creating Common Files</title>
@@ -167,7 +174,10 @@
</para>
</important>
</section>
+-->
+<!-- Is this section deprecated?
+
<section id="sn-translating-with-apps">
<title>Using Translation Applications</title>
<para>
@@ -233,36 +243,49 @@
<command>kbabel po/<replaceable>pt_BR</replaceable>.po</command>
</screen>
- </step>
- <step>
+-->
+ <section id="sn-check-integrity">
+ <title>Check Integrity</title>
+ <para>
+ Once you finish your work, it it time to commit. However one more step to go before committing your file.
+ </para>
+ <para>
+ Please do check integrity with the following command. If no error, now you can commit. This ensures sane build (where $Lang, replace your language code such as 'ja' without the quotes).
+ </para>
+<screen>
+<command>cd release-notes/devel/</command>
+<command>make validate-xml-$LANG</command>
+</screen>
+ <para>
+ It may take a while to complete. The $LANG/ directory is created if no error. Under this direcotry the translated xml files are generated from .po file.
+ </para>
+ </section>
+
+ <section id="sn-build-html">
+ <title>Build Html</title>
<para>
- Test your translation using the HTML build tools:
+ Instead 'make validate-xml-$LANG', the html can be generated. So that you can have a proofreading in html format.
</para>
<screen>
-<command>make html-<replaceable>pt_BR</replaceable></command>
+<command>cd release-notes/devel/</command>
+<command>make html-<replaceable>$LANG</replaceable></command>
</screen>
- <important>
- <title>Always Test Your Translation</title>
- <para>Do not go to the next step or commit changes until you
- test your work in this step. Erroneous changes can break
- documents for other users, editors, and automated
- applications.</para>
+ <important>
+ <para>
+ Any error must be corrected before comitting. Erroneous changes can break documents for other users, editors, and automated applications.</para>
</important>
- </step>
- <step>
+
<para>
- When you have finished your translation, commit the
- <filename class="extension">.po</filename> file. You may
- note the percent complete or some other useful message at
- commit time.
+ When you have finished your translation, commit the <filename class="extension">.po</filename> file. You may note the percent complete or some other useful message at commit time.
</para>
<screen>
-<command>cvs ci -m <replaceable>'Message about commit'</replaceable> po/<replaceable>pt_BR</replaceable>.po</command>
+<command>cvs ci -m <replaceable>'Translating... 400/10/126' </replaceable>po/<replaceable>ja</replaceable>.po</command>
</screen>
+<!-- Is this deprecated?
<para>
<emphasis>Do not commit the <filename>Makefile</filename>
until your translation is finished.</emphasis> To do so,
@@ -272,6 +295,7 @@
<screen>
<command>cvs ci -m 'Translation to <replaceable>pt_BR</replaceable> finished' Makefile</command>
</screen>
+-->
<caution>
<title>Do Not Make Manual POT Changes</title>
@@ -281,13 +305,51 @@
of a POT file, visit &BZ; at &BZ-URL; to file a bug
against the document.</para>
</caution>
- </step>
- </procedure>
</section>
+ <section id="sn-waht-to-translate">
+ <title>What to translate</title>
+ <para>
+ The most important docs modules/directories for each release are the following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>docs-common/common/entities</para>
+ </listitem>
+ <listitem>
+ <para>release-notes/devel</para>
+ </listitem>
+ <listitem>
+ <para>homepage/devel</para>
+ </listitem>
+ <listitem>
+ <para>install-guide/devel</para>
+ </listitem>
+ <listitem>
+ <para>about-fedora/devel</para>
+ </listitem>
+ <listitem>
+ <para>readme/devel</para>
+ </listitem>
+ <listitem>
+ <para>readme-burning-isos/devel</para>
+ </listitem>
+ <listitem>
+ <para>readme-live-image/devel</para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ To see all documents available in our repo, run:
+ </para>
+<screen>
+<command>export CVSROOT=:ext:username at cvs.fedoraproject.org:/cvs/docs</command>
+<command>cvs co -c</command>
+</screen>
+
</section>
+</section>
<!--
Local variables:
@@ -295,3 +357,4 @@
fill-column: 72
End:
-->
+
More information about the docs-commits
mailing list