translation-quick-start-guide/en_US doc-entities.xml, NONE, 1.1 translation-quick-start.xml, 1.1, 1.2
Paul W. Frields (pfrields)
fedora-docs-commits at redhat.com
Sat May 27 14:38:32 UTC 2006
Author: pfrields
Update of /cvs/docs/translation-quick-start-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv16195/en_US
Modified Files:
translation-quick-start.xml
Added Files:
doc-entities.xml
Log Message:
Push 0.3 version with procedural fixes and correctly building bits
--- NEW FILE doc-entities.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE entities SYSTEM "../../docs-common/common/entities/entities.dtd">
<entities>
<title>Document entities for Translation QSG</title>
<group name="Document versioning">
<entity name="DOCNAME">
<comment>Document name</comment>
<text>translation-quick-start-guide</text>
</entity>
<entity name="DOCVERSION">
<comment>Document version</comment>
<text>0.3</text>
</entity>
<entity name="DOCDATE">
<comment>Revision date</comment>
<text>2006-05-27</text>
</entity>
<entity name="DOCID">
<comment>Revision ID</comment>
<text><use entity="DOCNAME"/>-<use entity="DOCVERSION"/> (<use
entity="DOCDATE"/>)</text>
</entity>
</group>
<group name="General terms">
<entity name="FCLOCALVER">
<comment>Local version of Fedora Core</comment>
<text>4</text>
</entity>
<entity name="FCMINVER">
<comment>Minimum version of Fedora Core to use</comment>
<text>4</text>
</entity>
</group>
</entities>
Index: translation-quick-start.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/translation-quick-start.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- translation-quick-start.xml 11 Apr 2006 21:24:29 -0000 1.1
+++ translation-quick-start.xml 27 May 2006 14:38:30 -0000 1.2
@@ -2,18 +2,13 @@
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
- <!ENTITY % FEDORA-ENTITIES-EN SYSTEM
- "../../docs-common/common/fedora-entities-en.ent">
- %FEDORA-ENTITIES-EN;
-
- <!ENTITY DOCNAME "translation-quick-start-guide">
- <!ENTITY DOCVERSION "0.2.2.2">
- <!ENTITY DOCDATE "2006-02-13">
- <!ENTITY DOCID "&DOCNAME;-&DOCVERSION; (&DOCDATE;)">
+<!ENTITY % FDP-ENTITIES SYSTEM "fdp-entities.ent">
+%FDP-ENTITIES;
- <!ENTITY FCLOCALVER "4">
+<!ENTITY % DOC-ENTITIES SYSTEM "doc-entities.ent">
+%DOC-ENTITIES;
- ]>
+]>
<article id="translation-quickstart-guide" lang="en_US">
@@ -302,63 +297,87 @@
<title>Translating Documentation</title>
<para>
- The Fedora documentation is also stored in a CVS repository under
- the directory <filename>docs/</filename>.
+ 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>
+ </listitem>
+ <listitem>
+ <para><package>xmlto</package></para>
+ </listitem>
+ <listitem>
+ <para><package>make</package></para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ To install these packages, use the following command:
+ </para>
+
+<screen>
+<command>su -c 'yum install gnome-doc-utils xmlto make'</command>
+</screen>
<section id="sn-downloading-docs">
<title>Downloading Documentation</title>
<para>
- The process to download the documentation is similar to the one
- used to download <filename>.po</filename> files:
+ 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:
</para>
<screen>
<command>export CVSROOT=:ext:<replaceable>username</replaceable>@cvs.fedora.redhat.com:/cvs/docs</command>
-<command>cvs co docs</command>
-</screen>
-
- <para>
- This step downloads all the current documents in the directory.
- To download only a single document 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 check document
- validity for building.
- </para>
-
-<screen>
<command>cvs co -c</command>
-<command>cvs co example-tutorial docs-common</command>
</screen>
<para>
- The documents are written in DocBook XML format and named using
- the specific-language locale, such as
- <filename>example-tutorial-en.xml</filename>. If you plan to
- translate directly from the original XML file, you should create
- the document for your language:
+ 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.
</para>
<screen>
-<command>cp example-tutorial-en.xml example-tutorial-<replaceable>es</replaceable>.xml</command>
+<command>cvs co example-tutorial docs-common</command>
</screen>
<para>
- Afterwards you can work on the new copy.
+ 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.
</para>
</section>
<section id="sn-translating-with-apps">
<title>Using Translation Applications</title>
+ <note>
+ <title>Creating the <filename class="directory">po/</filename>
+ Directory</title>
+ <para>
+ If the <filename class="directory">po/</filename> directory
+ does not exist, you can create it and the translation
+ template file with the following commands:
+ </para>
+
+<screen>
+<command>mkdir po</command>
+<command>cvs add po/</command>
+<command>make pot</command>
+</screen>
+ </note>
<para>
- You can also convert the XML files into <filename>.po</filename>
- files and work with a <filename>.po</filename> editor like
- <application>KBabel</application> or
- <application>gtranslator</application>. To do so, follow these
+ To work with a <filename class="extension">.po</filename> editor
+ like <application>KBabel</application> or
+ <application>gtranslator</application>, follow these
steps:
</para>
<procedure>
@@ -375,138 +394,75 @@
</step>
<step>
<para>
- Extract the translatable strings with
- <command>xml2pot</command>:
+ In the <filename>Makefile</filename>, add your translation
+ language code to the <varname>OTHERS</varname> variable:
</para>
<screen>
-<command>xml2pot example-tutorial-en.xml > <replaceable>lang</replaceable>.po</command>
+<computeroutput>OTHERS = it <userinput><replaceable>pt_BR</replaceable></userinput></computeroutput>
</screen>
</step>
<step>
<para>
- Now you can translate the file using the same application
- used to translate software:
- </para>
-
-<screen>
-<command>kbabel <replaceable>lang</replaceable>.po</command>
-</screen>
-
- </step>
- <step>
- <para>
- Once you finish, you must convert the translated
- <filename>.po</filename> file to <filename>.xml</filename>
- file in the target language with <command>po2xml</command>:
+ Make a new <filename class="extension">.po</filename> file
+ for your locale:
</para>
<screen>
-<command>po2xml example-tutorial-en.xml <replaceable>lang</replaceable>.po > example-tutorial-<replaceable>lang</replaceable>.xml</command>
+<command>make po/<replaceable>pt_BR</replaceable>.po</command>
</screen>
</step>
<step>
<para>
- The <command>xml2pot</command> filter does not include
- entities in the <filename>.po</filename> file. You must
- change the language of the document. Locate a line like the
- following near the top of the document:
- </para>
-
-<screen>
-<computeroutput><article id="example-tutorial" lang="en"></computeroutput>
-</screen>
-
- </step>
- <step>
- <para>Change the attribute to your language:</para>
-
-<screen>
-<computeroutput><article id="example-tutorial" lang="<userinput><replaceable>es</replaceable></userinput>"></computeroutput>
-</screen>
-
- </step>
- <step>
- <para>
- When the translated file is ready, add it to the repository:
+ Now you can translate the file using the same application
+ used to translate software:
</para>
-
+
<screen>
-<command>cvs add example-tutorial-<replaceable>lang</replaceable>.xml</command>
-<command>cvs commit -m '<replaceable>Any comment</replaceable>' example-tutorial-<replaceable>lang</replaceable>.xml</command>
+<command>kbabel po/<replaceable>pt_BR</replaceable>.po</command>
</screen>
</step>
- </procedure>
-
- </section>
-
- <section id="sn-changing-makefile">
- <title>Changing the <filename>Makefile</filename></title>
-
- <para>
- You may have to change the <filename>Makefile</filename> so the
- document can be built in HTML and PDF formats.
- </para>
- <important>
- <title>Avoid Translation Conflicts</title>
- <para>
- Please advise the community through fedora-docs-list and
- fedora-trans-<replaceable>locale</replaceable> that you are
- modifying the <filename>Makefile</filename>. Inform the
- community that you are working on the translation of this
- document before you begin, to avoid conflict between
- translators working on the same file.
- </para>
- </important>
-
- <procedure>
- <step>
- <para>
- In the text editor of your preference, open the
- <filename>Makefile</filename>.
- </para>
-
-<screen>
-<command>vi Makefile</command>
-</screen>
- </step>
<step>
<para>
- Add the locale of the new translation after the other
- languages as in the following example:
+ Test your translation using the HTML build tools:
</para>
<screen>
-<computeroutput>LANGUAGES = en de <userinput><replaceable>lang</replaceable></userinput></computeroutput>
+<command>make html-<replaceable>pt_BR</replaceable></command>
</screen>
</step>
<step>
<para>
- Commit the <filename>Makefile</filename>.
+ 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 commit -m '<replaceable>Any comment</replaceable>' Makefile</command>
+<command>cvs ci -m <replaceable>'Message about commit'</replaceable> po/<replaceable>pt_BR</replaceable>.po</command>
</screen>
- </step>
- <step>
- <para>
- Then, you can build the document in your langugage by
- typing:
- </para>
+ <important>
+ <title>Committing the <filename>Makefile</filename></title>
+ <para>
+ <emphasis>Do not commit the <filename>Makefile</filename>
+ until your translation is finished.</emphasis> To do so,
+ run this command:
+ </para>
<screen>
-<command>make html-<replaceable>lang</replaceable></command>
+<command>cvs ci -m 'Translation to <replaceable>pt_BR</replaceable> finished' Makefile</command>
</screen>
+ </important>
</step>
</procedure>
-
+
</section>
</section>
More information about the Fedora-docs-commits
mailing list