translation-quick-start-guide translation-quick-start-en.xml, 1.6, 1.7 rpm-info.xml, 1.3, 1.4
Paul W. Frields (pfrields)
fedora-docs-commits at redhat.com
Thu Jan 26 06:21:36 UTC 2006
Author: pfrields
Update of /cvs/docs/translation-quick-start-guide
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv14371
Modified Files:
translation-quick-start-en.xml rpm-info.xml
Log Message:
Additional style editing, division into more readable sections
Index: translation-quick-start-en.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/translation-quick-start-en.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- translation-quick-start-en.xml 21 Jan 2006 02:37:27 -0000 1.6
+++ translation-quick-start-en.xml 26 Jan 2006 06:21:28 -0000 1.7
@@ -7,8 +7,8 @@
%FEDORA-ENTITIES-EN;
<!ENTITY DOCNAME "translation-quick-start-guide">
- <!ENTITY DOCVERSION "0.1">
- <!ENTITY DOCDATE "2006-01-20">
+ <!ENTITY DOCVERSION "0.2">
+ <!ENTITY DOCDATE "2006-01-26">
<!ENTITY DOCID "&DOCNAME;-&DOCVERSION; (&DOCDATE;)">
<!ENTITY FCLOCALVER "4">
@@ -21,7 +21,7 @@
&FDP-INFO;
- <section id="sn_intro">
+ <section id="sn-intro">
<title>Introduction</title>
<para>
@@ -34,16 +34,16 @@
</section>
- <section id="sn_accounts">
- <title>Accounts and subscriptions</title>
+ <section id="sn-accounts">
+ <title>Accounts and Subscriptions</title>
<para>
To participate in the &FP; as a translator you need an account.
You can apply for an account at <ulink
- url="http://i18n.redhat.com/cgi-bin/i18n-signup/"/>. You need to
- provide a user name (login), an email address, a target language
- — most likely your native language — and the public
- part of your SSH key.
+ url="http://i18n.redhat.com/cgi-bin/i18n-signup/"/>. You need to
+ provide a user name, an email address, a target language —
+ most likely your native language — and the public part of
+ your SSH key.
</para>
<para>
@@ -66,10 +66,10 @@
(<filename>~/.ssh/id_dsa</filename>) and enter a passphrase.
</para>
<caution>
- <title>Note</title>
+ <title>Don't Forget Your Passphrase!</title>
<para>
- Do not forget this passphrase as you will need it to access
- to the CVS repository.
+ You will need your passphrase to access to the CVS
+ repository. It cannot be recovered if you forget it.
</para>
</caution>
</step>
@@ -96,15 +96,18 @@
directory:
</para>
+<!-- Why is this permission 755? The 700 mode is usually recommended -->
+<!-- for ~/.ssh/ for extra protection, since it does house an SSH -->
+<!-- private key. -->
+
<screen>
-<command>chmod 755 ~/.ssh</command>
-<!-- SEE ABOVE... <command>chmod 644 ~/.ssh/authorized_keys</command> -->
+<command>chmod 700 ~/.ssh</command><!-- SEE ABOVE... <command>chmod 644 ~/.ssh/authorized_keys</command> -->
</screen>
</step>
<step>
<para>
- Copy and paste the ssh key in the space provided in order to
+ Copy and paste the SSH key in the space provided in order to
complete the account application.
</para>
</step>
@@ -119,15 +122,18 @@
translators, to discuss issues that affect only the individual
community of translators.
</para>
- <para>
- You may also find it useful to subscribe to
- <firstterm>fedora-docs-list</firstterm> to stay informed about
- general documentation issues.
- </para>
+ <tip>
+ <title>General Documentation Issues</title>
+ <para>
+ You may also find it useful to subscribe to
+ <firstterm>fedora-docs-list</firstterm> to stay informed about
+ general documentation issues.
+ </para>
+ </tip>
</section>
- <section id="sn_translating_software">
- <title>Translating software</title>
+ <section id="sn-translating-software">
+ <title>Translating Software</title>
<para>
The translatable part of a software package is available in one or
@@ -169,91 +175,101 @@
<para>
You can now start translating.
</para>
- <procedure>
- <step>
- <para>
- Go to the directory of the package you have taken.
- </para>
+
+ <section id="sn-translating-strings">
+ <title>Translating Strings</title>
+
+ <procedure>
+ <step>
+ <para>
+ Change directory to the location of the package you have
+ taken.
+ </para>
<screen>
<command>cd ~/translate/<replaceable>package_name</replaceable></command>
</screen>
- </step>
- <step>
- <para>
- Update the files with the following command:
- </para>
+ </step>
+ <step>
+ <para>
+ Update the files with the following command:
+ </para>
<screen>
<command>cvs up</command>
</screen>
- </step>
- <step>
- <para>
- Translate the po file of your language in a po editor such as
- <application>KBabel</application> or
- <application>gtranslator</application>. For example, to open
- the <filename>.po</filename> file for Spanish in
- <application>KBabel</application>, type:
- </para>
+ </step>
+ <step>
+ <para>
+ Translate the <filename>.po</filename> file of your language
+ in a <filename>.po</filename> editor such as
+ <application>KBabel</application> or
+ <application>gtranslator</application>. For example, to open
+ the <filename>.po</filename> file for Spanish in
+ <application>KBabel</application>, type:
+ </para>
<screen>
<command>kbabel es.po</command>
</screen>
- </step>
- <step>
- <para>
- When you finish your work, commit your changes back to the
- repository:
- </para>
+ </step>
+ <step>
+ <para>
+ When you finish your work, commit your changes back to the
+ repository:
+ </para>
<screen>
-<command>cvs commit -m 'comments' <replaceable>lang</replaceable>.po</command>
+<command>cvs commit -m '<replaceable>comments</replaceable>' <replaceable>lang</replaceable>.po</command>
</screen>
- </step>
- <step>
- <para>
- As a last step, click the <literal>release</literal> link on
- the status page to release the module so other people can work
- on it.
- </para>
- </step>
- </procedure>
- <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>
+ </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>
+ </step>
+ </procedure>
+ </section>
+
+ <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 ~/translate/<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>
+ </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:
+ </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>
@@ -261,206 +277,237 @@
<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>
+ </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>
- </step>
- </procedure>
- <para>
- The application related to the translated package will run with
- the translated strings.
- </para>
+ </step>
+ </procedure>
+ <para>
+ The application related to the translated package will run with
+ the translated strings.
+ </para>
+ </section>
+
</section>
- <section id="sn_translating_docs">
- <title>Translating documentation</title>
+ <section id="sn-translating-docs">
+ <title>Translating Documentation</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:
+ the directory <filename>docs/</filename>.
</para>
+ <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:
+ </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>
+ <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:
- </para>
+ <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:
+ </para>
<screen>
<command>cp example-tutorial-en.xml example-tutorial-<replaceable>es</replaceable>.xml</command>
</screen>
- <para>
- Afterwards you can work on the new copy.
- </para>
- <para>
- You can also convert the XML files into <filename>.po</filename>
- files and work with a <replaceable>.po</replaceable> editor like
- <application>KBabel</application> or
- <application>gtranslator</application>. To do so, follow these
- steps:
- </para>
- <procedure>
- <step>
- <para>
- In a terminal, go to the directory of the document you want to
- translate:
- </para>
+ <para>
+ Afterwards you can work on the new copy.
+ </para>
+
+ </section>
+ <section id="sn-translating-with-apps">
+ <title>Using Translation Applications</title>
+
+ <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
+ steps:
+ </para>
+ <procedure>
+ <step>
+ <para>
+ In a terminal, go to the directory of the document you want
+ to translate:
+ </para>
+
<screen>
<command>cd ~/docs/example-tutorial</command>
</screen>
- </step>
- <step>
- <para>
- Extract the translatable strings with xml2pot:
- </para>
+ </step>
+ <step>
+ <para>
+ Extract the translatable strings with
+ <command>xml2pot</command>:
+ </para>
<screen>
<command>xml2pot example-tutorial-en.xml > <replaceable>lang</replaceable>.po</command>
</screen>
- </step>
- <step>
- <para>
- Now you can translate the file using the same application used
- to translate software:
- </para>
-
+ </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, it is necessary to convert the translated
- <filename>.po</filename> file to <filename>.xml</filename>
- file in the target language with <command>po2xml</command>:
- </para>
+ </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>:
+ </para>
<screen>
<command>po2xml example-tutorial-en.xml <replaceable>lang</replaceable>.po > example-tutorial-<replaceable>lang</replaceable>.xml</command>
</screen>
- </step>
- </procedure>
- <para>
- The <command>xml2po</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>
+ </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>
- <para>Change the attribute to your language:</para>
+ </step>
+ <step>
+ <para>Change the attribute to your language:</para>
<screen>
-<userinput><article id="example-tutorial" lang="<replaceable>es</replaceable>"></userinput>
+<computeroutput><article id="example-tutorial" lang="<userinput><replaceable>es</replaceable></userinput>"></computeroutput>
</screen>
- <para>
- When the translated file is ready, add it to the repository:
- </para>
+ </step>
+ <step>
+ <para>
+ When the translated file is ready, add it to the repository:
+ </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>
</screen>
- <para>
- You may have to change the <filename>Makefile</filename> so the
- document can be built in HTML and PDF formats.
- </para>
- <caution>
- <title>Note:</title>
+ </step>
+ </procedure>
+
+ </section>
+
+ <section id="sn-changing-makefile">
+ <title>Changing the <filename>Makefile</filename></title>
+
<para>
- Please advise the community through fedora-doc-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.
+ You may have to change the <filename>Makefile</filename> so the
+ document can be built in HTML and PDF formats.
</para>
- </caution>
-
- <procedure>
- <step>
+ <important>
+ <title>Avoid Translation Conflicts</title>
<para>
- In the text editor of your preference, open the
- <filename>Makefile</filename>.
+ Please advise the community through fedora-doc-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:
- </para>
+ </step>
+ <step>
+ <para>
+ Add the locale of the new translation after the other
+ languages as in the following example:
+ </para>
<screen>
-<userinput>LANGUAGES = en de <replaceable>lang</replaceable></userinput>
+<computeroutput>LANGUAGES = en de <userinput><replaceable>lang</replaceable></userinput></computeroutput>
</screen>
- </step>
- <step>
- <para>
- Commit the <filename>Makefile</filename>.
- </para>
+ </step>
+ <step>
+ <para>
+ Commit the <filename>Makefile</filename>.
+ </para>
<screen>
<command>cvs commit -m '<replaceable>Any comment</replaceable>' Makefile</command>
</screen>
- </step>
- <step>
- <para>
- Then, you can build the document in your langugage by typing:
- </para>
+ </step>
+ <step>
+ <para>
+ Then, you can build the document in your langugage by
+ typing:
+ </para>
<screen>
<command>make html-<replaceable>lang</replaceable></command>
</screen>
- </step>
- </procedure>
+ </step>
+ </procedure>
+
+ </section>
</section>
Index: rpm-info.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/rpm-info.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- rpm-info.xml 21 Jan 2006 02:48:19 -0000 1.3
+++ rpm-info.xml 26 Jan 2006 06:21:28 -0000 1.4
@@ -1,3 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+
+<!DOCTYPE rpm-info SYSTEM "../docs-common/packaging/rpm-info.dtd">
+
<rpm-info>
<colophon>
<worker surname="Ospina" firstname="Manuel" id="ManuelOspina" email="mospina at redhat.com" wholename="Manuel Ospina" initials="MO"/>
@@ -29,7 +33,12 @@
<!--PLEASE ADD A TRANSLATION FOR EACH ADDITIONAL LANGUAGE.-->
</titles>
<changelog order="newest-first">
- <revision date="2006-01-20" number="0.1" role="doc">
+ <revision date="2006-01-25" number="0.2" role="doc">
+ <author worker="PaulWFrields"/>
+ <details lang="en">Additional style editing, division of procedures into more readable
+ sections</details>
+ </revision>
+ <revision date="Fri Jan 20 2006" number="0.1" role="doc">
<author worker="PaulWFrields"/>
<details lang="en">First round of editing.</details>
</revision>
More information about the Fedora-docs-commits
mailing list