translation-quick-start-guide/en_US Accounts_And_Subscriptions.xml, NONE, 1.1 Introduction.xml, NONE, 1.1 Translating_Documentation.xml, NONE, 1.1 Translating_Software.xml, NONE, 1.1 rpm-info.xml, 1.13, 1.14 translation-quick-start.xml, 1.21, 1.22
Noriko Mizumoto (noriko)
fedora-docs-commits at redhat.com
Thu Aug 23 04:19:58 UTC 2007
Author: noriko
Update of /cvs/docs/translation-quick-start-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv31512/en_US
Modified Files:
rpm-info.xml translation-quick-start.xml
Added Files:
Accounts_And_Subscriptions.xml Introduction.xml
Translating_Documentation.xml Translating_Software.xml
Log Message:
split main file into multiple files
--- NEW FILE Accounts_And_Subscriptions.xml ---
<!-- $Id: -->
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % FDP-ENTITIES SYSTEM "fdp-entities.ent">
%FDP-ENTITIES;
<!ENTITY % DOC-ENTITIES SYSTEM "doc-entities.ent">
%DOC-ENTITIES;
]>
<section id="sn_accounts">
<title>Accounts and Subscriptions</title>
<section id="sn-ssh-key">
<title>Making an SSH Key</title>
<para>
If you do not have a SSH key yet, generate one using the
following steps:
</para>
<procedure>
<step>
<para>
Type in a comand line:
</para>
<screen>
<command>ssh-keygen -t dsa</command>
</screen>
<para>
Accept the default location
(<filename>~/.ssh/id_dsa</filename>) and enter a passphrase.
</para>
<caution>
<title>Don't Forget Your Passphrase!</title>
<para>
You must have your passphrase to access to the CVS
repository. It cannot be recovered if you forget it.
</para>
</caution>
</step>
<step>
<para>
Change permissions to your key and <filename>.ssh</filename>
directory:
</para>
<screen>
<command>chmod 700 ~/.ssh</command>
</screen>
</step>
<step>
<para>
Copy and paste the SSH key in the space provided in order to
complete the account application.
</para>
</step>
</procedure>
</section>
<section id="sn-accounts-trans">
<title>Accounts for Software Translation</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, an email address, a target language
— most likely your native language — and the public
part of your SSH key.
</para>
<para>
There are also two lists where you can discuss translation
issues. The first is <firstterm>fedora-trans-list</firstterm>, a
general list to discuss problems that affect all languages.
Refer to <ulink
url="http://www.redhat.com/archives/fedora-trans-list"/> for
more information. The second is the language-specific list,
such as <firstterm>fedora-trans-es</firstterm> for Spanish
translators, to discuss issues that affect only the individual
community of translators.
</para>
</section>
<section id="sn-accounts-docs">
<title>Accounts for Documentation</title>
<para>
Follow this procedure to start working directly with the &FDP;
to translate documentation.
</para>
<procedure>
<step>
<para>
The &FDP; encourages all participants to sign e-mails with a
GPG key. To create a key, use the following command:
</para>
<screen>
<command>gpg --gen-key</command>
</screen>
<para>
A series of prompts guides you through the process. Press
<keycap>Enter</keycap> to select the default values.
</para>
<para>
You must export your public key so other people can verify
your signature. Use this command to export your key to a
public server:
</para>
<screen>
<command>gpg --keyserver pgp.mit.edu --send-keys GPGKEYID</command>
</screen>
</step>
<step>
<para>
Request a membership on the &FDP; mailing list. To do that,
fill out the form at <ulink
url="http://www.redhat.com/mailman/listinfo/fedora-docs-list/"/>.
</para>
</step>
<step>
<para>
You should post a self-introduction to the &FDP; mailing
list. For details, refer to <ulink
url="http://fedoraproject.org/wiki/DocsProject/SelfIntroduction"/>.
</para>
</step>
<step>
<para>
You also need to sign up for a &FED; account. Visit <ulink
url="https://admin.fedoraproject.org/accounts/"/> and
select the link <guilabel>Apply for a new
account</guilabel>. After filling out this form, you have
a basic account.
</para>
<para>
You must complete the Contributors License Agreement
(<acronym>CLA</acronym>), refer to <ulink
url="http://fedoraproject.org/wiki/Infrastructure/AccountSystem/CLAHowTo"
/> for instructions.
</para>
</step>
<step>
<para>
Once you have successfully completed the CLA, return to the
account system and select <guilabel>Edit Your
Account</guilabel>. Enter the password you received by
email and select <guilabel>Add new membership</guilabel> at
the bottom of the page. In the field
<guilabel>Groupname</guilabel>, enter
<userinput>cvsl10n</userinput> and select
<guilabel>Add</guilabel>. This action requests access
to the CVS repository where the documentation is stored.
</para>
<important>
<title>CVS Access is Not Automatic</title>
<para>
When you fill out this form, you are not automatically
granted write access to the CVS repository. You may need
sponsorship from one of the &FDP; managers to get this
access.
</para>
</important>
</step>
<step>
<para>
The next step is to create a wiki account. Fill out the form
at <ulink
url="http://fedoraproject.org/wiki/UserPreferences" />,
and select <guilabel>Create Profile</guilabel>.
</para>
</step>
<step>
<para>
Contact any person with edit access and ask to be added to
the Wiki edit account in <ulink
url="http://fedoraproject.org/wiki/EditGroup" />. You can
do this on IRC or by posting on the
<systemitem>fedora-docs-list</systemitem> mailing list you
joined in a previous step.
</para>
</step>
</procedure>
</section>
</section>
--- NEW FILE Introduction.xml ---
<!-- $Id: -->
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % FDP-ENTITIES SYSTEM "fdp-entities.ent">
%FDP-ENTITIES;
<!ENTITY % DOC-ENTITIES SYSTEM "doc-entities.ent">
%DOC-ENTITIES;
]>
<section id="sn-intro">
<title>Introduction</title>
<para>
This guide is a fast, simple, step-by-step set of instructions for
translating &FP; software and documents. If you are interested in
better understanding the translation process involved, refer to
the Translation guide or the manual of the specific translation
tool.
</para>
<!-- Remove this until we figure out better snippet usage. -->
<!-- &BUG-REPORTING; -->
</section>
--- NEW FILE Translating_Documentation.xml ---
<!-- $Id: -->
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % FDP-ENTITIES SYSTEM "fdp-entities.ent">
%FDP-ENTITIES;
<!ENTITY % DOC-ENTITIES SYSTEM "doc-entities.ent">
%DOC-ENTITIES;
]>
<section id="sn_translating_docs">
<title>Translating Documentation</title>
<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>
</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 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.fedoraproject.org:/cvs/docs</command>
<command>cvs co -c</command>
</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
with some modules.
</para>
<screen>
<command>cvs co example-tutorial docs-common</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.
</para>
</section>
<section id="sn-creating-common">
<title>Creating Common Files</title>
<para>
If you are creating the first-ever translation for a locale, you
must first translate some common files used in all documents for
your locale. The common files are located in <filename
class="directory">docs-common/common/</filename>.
</para>
<procedure>
<step>
<para>
Read the <filename>README.txt</filename> file in the
<filename
class="directory">docs-common/common/entities</filename> and
follow the directions to create new entities.
</para>
</step>
<step>
<para>
Once you have created common entities for your locale and
committed the results to CVS, create a locale file for the
legal notice:
</para>
<screen>
<command>cd docs-common/common/</command>
<command>cp legalnotice-opl-en_US.xml legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
</screen>
<important>
<title>Do Not Translate Legal Notice</title>
<para>
To ensure it is legally equivalent in all locales, do not
translate the OPL.
</para>
</important>
</step>
<step>
<para>
Then commit that file to CVS also:
</para>
<screen>
<command>cvs add legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
<command>cvs ci -m 'Added legal notice for <replaceable>pt_BR</replaceable>' legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
</screen>
</step>
<step>
<para>
Next, build the draft watermark for your locale in the
<filename class="directory">docs-common/images/</filename>
folder:
</para>
<screen>
<command>cd docs-common/images/</command>
<command>cp watermark-en_US.svg watermark-<replaceable>pt_BR</replaceable>.svg</command>
</screen>
<para>
Translate the <sgmltag class="element">text</sgmltag>
elements in the SVG. Then add your locale's SVG file to the
<filename>Makefile</filename>, produce the PNG and commit
the results:
</para>
<screen>
<command>make watermark-<replaceable>pt_BR</replaceable>.png</command>
<command>cvs add watermark-<replaceable>pt_BR</replaceable>*</command>
<command>cvs ci -m 'Added <replaceable>pt_BR</replaceable> images' Makefile watermark-<replaceable>pt_BR</replaceable>*</command>
</screen>
</step>
</procedure>
<important>
<title>Build Errors</title>
<para>
If you do not create these common entities, building your
document may fail.
</para>
</important>
</section>
<section id="sn-translating-with-apps">
<title>Using Translation Applications</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>
<para>
To work with a <filename class="extension">.po</filename> editor
like <application>KBabel</application> or
<application>gtranslator</application>, 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>To add your locale, you must locate and change the
appropriate locale list. Some documents are using the
<filename>po/LINGUAS</filename> file, as standardized in the
GNOME project, to track locales. Some documents have not
been updated to this standard yet. If you find the module
you are translating has not been updated, notify the &FDP;
or file a bug using &BZ;.</para>
<para>In the <filename>po/LINGUAS</filename>, add your
translation language code to the list. <emphasis>Keep the
list in alphabetical order.</emphasis></para>
</step>
<step>
<para>
Make a new <filename class="extension">.po</filename> file
for your locale:
</para>
<screen>
<command>make po/<replaceable>pt_BR</replaceable>.po</command>
</screen>
</step>
<step>
<para>
Now you can translate the file using the same application
used to translate software:
</para>
<screen>
<command>kbabel po/<replaceable>pt_BR</replaceable>.po</command>
</screen>
</step>
<step>
<para>
Test your translation using the HTML build tools:
</para>
<screen>
<command>make html-<replaceable>pt_BR</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>
</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.
</para>
<screen>
<command>cvs ci -m <replaceable>'Message about commit'</replaceable> po/<replaceable>pt_BR</replaceable>.po</command>
</screen>
<para>
<emphasis>Do not commit the <filename>Makefile</filename>
until your translation is finished.</emphasis> To do so,
run this command:
</para>
<screen>
<command>cvs ci -m 'Translation to <replaceable>pt_BR</replaceable> finished' Makefile</command>
</screen>
<caution>
<title>Do Not Make Manual POT Changes</title>
<para>Authors and editors generate the POT file from the
source XML files, which overwrite any manual changes to a
POT file. If you find a problem in the original messages
of a POT file, visit &BZ; at &BZ-URL; to file a bug
against the document.</para>
</caution>
</step>
</procedure>
</section>
</section>
<!--
Local variables:
mode: xml
fill-column: 72
End:
-->
--- NEW FILE Translating_Software.xml ---
<!-- $Id: -->
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY % FDP-ENTITIES SYSTEM "fdp-entities.ent">
%FDP-ENTITIES;
<!ENTITY % DOC-ENTITIES SYSTEM "doc-entities.ent">
%DOC-ENTITIES;
]>
<section id="sn_translating_software">
<title>Translating Software</title>
<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:
</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>
</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;.
</para>
</note>
<para>
You can now start translating.
</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>
<screen>
<command>cvs up</command>
</screen>
</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:
</para>
<screen>
<command>msgmerge <replaceable>lang</replaceable>.po <replaceable>package_name</replaceable>.pot > <replaceable>tmp</replaceable>.po</command>
</screen>
</step>
<step>
<para>Check the integrity of the new file:</para>
<screen>
<command>msgfmt -cvo /dev/null <replaceable>tmp</replaceable>.po</command>
</screen>
</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>
<step>
<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:
</para>
<screen>
<command>kbabel es.po</command>
</screen>
</step>
<step>
<para>
When you finish your work, commit your changes back to the
repository:
</para>
<screen>
<command>cvs commit -m '<replaceable>comments</replaceable>' <replaceable>lang</replaceable>.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>
</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>
<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>
</step>
</procedure>
<para>
The application related to the translated package runs with
the translated strings.
</para>
</section>
</section>
Index: rpm-info.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/rpm-info.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- rpm-info.xml 29 Jul 2007 23:41:08 -0000 1.13
+++ rpm-info.xml 23 Aug 2007 04:19:56 -0000 1.14
@@ -19,9 +19,11 @@
<worker firstname="Damien" surname="Durand" email="splinux at fedoraproject.org" wholename="Damien Durand" id="DamienDurand" initials="DD"/>
<worker firstname="Guillermo" surname="Gomez" email="guillermo.gomez at gmail.com" wholename="Guillermo Gómez" id="GuillermoGomez" initials="GG"/>
<worker firstname="Diego" othername="Búrigo" surname="Zacarão" email="diegobz at projetofedora.org" wholename="Diego Búrigo Zacarão" id="DiegoZacarao" initials="DZ"/>
+ <worker surname="Mizumoto" firstname="Noriko" id="NorikoMizumoto" email="noriko at redhat.com" wholename="Noriko Mizumoto" initials="NM"/>
</colophon>
<author worker="ManuelOspina"/>
<editor worker="PaulWFrields"/>
+ <editor worker="NorikoMizumoto"/>
<translator worker="HugoCisneiros"/>
<translator worker="FrancescoTombolini"/>
<translator worker="AndrewMartynov"/>
@@ -32,6 +34,7 @@
<translator worker="GuillermoGomez"/>
<translator worker="DiegoZacarao"/>
<license>
+
<rights>OPL</rights>
<version>1.0</version>
</license>
@@ -44,6 +47,10 @@
<title>Translation Quick Start Guide</title>
<desc>Quick start guide to providing translations on the Fedora Project.</desc>
<changelog order="newest-first">
+ <revision date="2007-08-23" number="0.3.8">
+ <author worker="NorikoMizumoto"/>
+ <details>Brokeup main file into multiple files based on chapters</details>
+ </revision>
<revision date="2007-07-29" number="0.3.7.5">
<author worker="PaulWFrields"/>
<details>Add information about LINGUAS and remove unnecessary admonitions</details>
Index: translation-quick-start.xml
===================================================================
RCS file: /cvs/docs/translation-quick-start-guide/en_US/translation-quick-start.xml,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- translation-quick-start.xml 29 Jul 2007 23:41:08 -0000 1.21
+++ translation-quick-start.xml 23 Aug 2007 04:19:56 -0000 1.22
@@ -1,4 +1,4 @@
-<!-- $Id: -->
+<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
@@ -10,709 +10,25 @@
]>
-<article id="translation-quickstart-guide" lang="en_US">
+<article id="translation-quick-start" lang="en_US">
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="fdp-info.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="fdp-info.xml"/>
+ <!-- INTRODUCION -->
+ <xi:include href="Introduction.xml" xpointer="element(sn-intro)"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <!-- Accounts And Subscription -->
+ <xi:include href="Accounts_And_Subscriptions.xml" xpointer="element(sn_accounts)"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <!-- Translating Software -->
+ <xi:include href="Translating_Software.xml" xpointer="element(sn_translating_software)"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+ <!-- Translating Documentation -->
+ <xi:include href="Translating_Documentation.xml" xpointer="element(sn_translating_docs)"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
- <section id="sn-intro">
- <title>Introduction</title>
-
- <para>
- This guide is a fast, simple, step-by-step set of instructions for
- translating &FP; software and documents. If you are interested in
- better understanding the translation process involved, refer to
- the Translation guide or the manual of the specific translation
- tool.
- </para>
-
- <!-- Remove this until we figure out better snippet usage. -->
- <!-- &BUG-REPORTING; -->
-
- </section>
-
- <section id="sn_accounts">
- <title>Accounts and Subscriptions</title>
-
- <section id="sn-ssh-key">
- <title>Making an SSH Key</title>
-
- <para>
- If you do not have a SSH key yet, generate one using the
- following steps:
- </para>
-
- <procedure>
- <step>
- <para>
- Type in a comand line:
- </para>
-
-<screen>
-<command>ssh-keygen -t dsa</command>
-</screen>
-
- <para>
- Accept the default location
- (<filename>~/.ssh/id_dsa</filename>) and enter a passphrase.
- </para>
- <caution>
- <title>Don't Forget Your Passphrase!</title>
- <para>
- You must have your passphrase to access to the CVS
- repository. It cannot be recovered if you forget it.
- </para>
- </caution>
- </step>
- <step>
- <para>
- Change permissions to your key and <filename>.ssh</filename>
- directory:
- </para>
-
-<screen>
-<command>chmod 700 ~/.ssh</command>
-</screen>
-
- </step>
- <step>
- <para>
- Copy and paste the SSH key in the space provided in order to
- complete the account application.
- </para>
- </step>
- </procedure>
- </section>
-
- <section id="sn-accounts-trans">
- <title>Accounts for Software Translation</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, an email address, a target language
- — most likely your native language — and the public
- part of your SSH key.
- </para>
-
- <para>
- There are also two lists where you can discuss translation
- issues. The first is <firstterm>fedora-trans-list</firstterm>, a
- general list to discuss problems that affect all languages.
- Refer to <ulink
- url="http://www.redhat.com/archives/fedora-trans-list"/> for
- more information. The second is the language-specific list,
- such as <firstterm>fedora-trans-es</firstterm> for Spanish
- translators, to discuss issues that affect only the individual
- community of translators.
- </para>
- </section>
-
- <section id="sn-accounts-docs">
- <title>Accounts for Documentation</title>
- <para>
- Follow this procedure to start working directly with the &FDP;
- to translate documentation.
- </para>
- <procedure>
- <step>
- <para>
- The &FDP; encourages all participants to sign e-mails with a
- GPG key. To create a key, use the following command:
- </para>
-
-<screen>
-<command>gpg --gen-key</command>
-</screen>
-
- <para>
- A series of prompts guides you through the process. Press
- <keycap>Enter</keycap> to select the default values.
- </para>
- <para>
- You must export your public key so other people can verify
- your signature. Use this command to export your key to a
- public server:
- </para>
-
-<screen>
-<command>gpg --keyserver pgp.mit.edu --send-keys GPGKEYID</command>
-</screen>
-
- </step>
- <step>
- <para>
- Request a membership on the &FDP; mailing list. To do that,
- fill out the form at <ulink
- url="http://www.redhat.com/mailman/listinfo/fedora-docs-list/"/>.
- </para>
- </step>
- <step>
- <para>
- You should post a self-introduction to the &FDP; mailing
- list. For details, refer to <ulink
- url="http://fedoraproject.org/wiki/DocsProject/SelfIntroduction"/>.
- </para>
- </step>
- <step>
- <para>
- You also need to sign up for a &FED; account. Visit <ulink
- url="https://admin.fedoraproject.org/accounts/"/> and
- select the link <guilabel>Apply for a new
- account</guilabel>. After filling out this form, you have
- a basic account.
- </para>
- <para>
- You must complete the Contributors License Agreement
- (<acronym>CLA</acronym>), refer to <ulink
- url="http://fedoraproject.org/wiki/Infrastructure/AccountSystem/CLAHowTo"
- /> for instructions.
- </para>
- </step>
- <step>
- <para>
- Once you have successfully completed the CLA, return to the
- account system and select <guilabel>Edit Your
- Account</guilabel>. Enter the password you received by
- email and select <guilabel>Add new membership</guilabel> at
- the bottom of the page. In the field
- <guilabel>Groupname</guilabel>, enter
- <userinput>cvsl10n</userinput> and select
- <guilabel>Add</guilabel>. This action requests access
- to the CVS repository where the documentation is stored.
- </para>
- <important>
- <title>CVS Access is Not Automatic</title>
- <para>
- When you fill out this form, you are not automatically
- granted write access to the CVS repository. You may need
- sponsorship from one of the &FDP; managers to get this
- access.
- </para>
- </important>
- </step>
- <step>
- <para>
- The next step is to create a wiki account. Fill out the form
- at <ulink
- url="http://fedoraproject.org/wiki/UserPreferences" />,
- and select <guilabel>Create Profile</guilabel>.
- </para>
- </step>
- <step>
- <para>
- Contact any person with edit access and ask to be added to
- the Wiki edit account in <ulink
- url="http://fedoraproject.org/wiki/EditGroup" />. You can
- do this on IRC or by posting on the
- <systemitem>fedora-docs-list</systemitem> mailing list you
- joined in a previous step.
- </para>
- </step>
- </procedure>
- </section>
-
- </section>
-
- <section id="sn_translating_software">
- <title>Translating Software</title>
-
- <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:
- </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>
-</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;.
- </para>
- </note>
- <para>
- You can now start translating.
- </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>
-
-<screen>
-<command>cvs up</command>
-</screen>
-
- </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:
- </para>
-
-<screen>
-<command>msgmerge <replaceable>lang</replaceable>.po <replaceable>package_name</replaceable>.pot > <replaceable>tmp</replaceable>.po</command>
-</screen>
-
- </step>
-
- <step>
- <para>Check the integrity of the new file:</para>
-
-<screen>
-<command>msgfmt -cvo /dev/null <replaceable>tmp</replaceable>.po</command>
-</screen>
-
- </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>
- <step>
- <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:
- </para>
-
-<screen>
-<command>kbabel es.po</command>
-</screen>
-
- </step>
- <step>
- <para>
- When you finish your work, commit your changes back to the
- repository:
- </para>
-
-<screen>
-<command>cvs commit -m '<replaceable>comments</replaceable>' <replaceable>lang</replaceable>.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>
- </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>
-
-<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>
-
- </step>
- </procedure>
- <para>
- The application related to the translated package runs with
- the translated strings.
- </para>
- </section>
-
- </section>
-
- <section id="sn_translating_docs">
- <title>Translating Documentation</title>
-
- <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>
- </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 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.fedoraproject.org:/cvs/docs</command>
-<command>cvs co -c</command>
-</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
- with some modules.
- </para>
-
-<screen>
-<command>cvs co example-tutorial docs-common</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.
- </para>
-
- </section>
-
- <section id="sn-creating-common">
- <title>Creating Common Files</title>
-
- <para>
- If you are creating the first-ever translation for a locale, you
- must first translate some common files used in all documents for
- your locale. The common files are located in <filename
- class="directory">docs-common/common/</filename>.
- </para>
-
- <procedure>
- <step>
- <para>
- Read the <filename>README.txt</filename> file in the
- <filename
- class="directory">docs-common/common/entities</filename> and
- follow the directions to create new entities.
- </para>
- </step>
- <step>
- <para>
- Once you have created common entities for your locale and
- committed the results to CVS, create a locale file for the
- legal notice:
- </para>
-
-<screen>
-<command>cd docs-common/common/</command>
-<command>cp legalnotice-opl-en_US.xml legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
-</screen>
-
- <important>
- <title>Do Not Translate Legal Notice</title>
- <para>
- To ensure it is legally equivalent in all locales, do not
- translate the OPL.
- </para>
- </important>
- </step>
- <step>
- <para>
- Then commit that file to CVS also:
- </para>
-
-<screen>
-<command>cvs add legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
-<command>cvs ci -m 'Added legal notice for <replaceable>pt_BR</replaceable>' legalnotice-opl-<replaceable>pt_BR</replaceable>.xml</command>
-</screen>
-
- </step>
- <step>
- <para>
- Next, build the draft watermark for your locale in the
- <filename class="directory">docs-common/images/</filename>
- folder:
- </para>
-
-<screen>
-<command>cd docs-common/images/</command>
-<command>cp watermark-en_US.svg watermark-<replaceable>pt_BR</replaceable>.svg</command>
-</screen>
-
- <para>
- Translate the <sgmltag class="element">text</sgmltag>
- elements in the SVG. Then add your locale's SVG file to the
- <filename>Makefile</filename>, produce the PNG and commit
- the results:
- </para>
-
-<screen>
-<command>make watermark-<replaceable>pt_BR</replaceable>.png</command>
-<command>cvs add watermark-<replaceable>pt_BR</replaceable>*</command>
-<command>cvs ci -m 'Added <replaceable>pt_BR</replaceable> images' Makefile watermark-<replaceable>pt_BR</replaceable>*</command>
-</screen>
-
- </step>
- </procedure>
- <important>
- <title>Build Errors</title>
- <para>
- If you do not create these common entities, building your
- document may fail.
- </para>
- </important>
- </section>
-
- <section id="sn-translating-with-apps">
- <title>Using Translation Applications</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>
-
- <para>
- To work with a <filename class="extension">.po</filename> editor
- like <application>KBabel</application> or
- <application>gtranslator</application>, 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>To add your locale, you must locate and change the
- appropriate locale list. Some documents are using the
- <filename>po/LINGUAS</filename> file, as standardized in the
- GNOME project, to track locales. Some documents have not
- been updated to this standard yet. If you find the module
- you are translating has not been updated, notify the &FDP;
- or file a bug using &BZ;.</para>
- <para>In the <filename>po/LINGUAS</filename>, add your
- translation language code to the list. <emphasis>Keep the
- list in alphabetical order.</emphasis></para>
- </step>
- <step>
- <para>
- Make a new <filename class="extension">.po</filename> file
- for your locale:
- </para>
-
-<screen>
-<command>make po/<replaceable>pt_BR</replaceable>.po</command>
-</screen>
-
- </step>
- <step>
- <para>
- Now you can translate the file using the same application
- used to translate software:
- </para>
-
-<screen>
-<command>kbabel po/<replaceable>pt_BR</replaceable>.po</command>
-</screen>
-
- </step>
- <step>
- <para>
- Test your translation using the HTML build tools:
- </para>
-
-<screen>
-<command>make html-<replaceable>pt_BR</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>
- </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.
- </para>
-
-<screen>
-<command>cvs ci -m <replaceable>'Message about commit'</replaceable> po/<replaceable>pt_BR</replaceable>.po</command>
-</screen>
-
- <para>
- <emphasis>Do not commit the <filename>Makefile</filename>
- until your translation is finished.</emphasis> To do so,
- run this command:
- </para>
-
-<screen>
-<command>cvs ci -m 'Translation to <replaceable>pt_BR</replaceable> finished' Makefile</command>
-</screen>
-
- <caution>
- <title>Do Not Make Manual POT Changes</title>
- <para>Authors and editors generate the POT file from the
- source XML files, which overwrite any manual changes to a
- POT file. If you find a problem in the original messages
- of a POT file, visit &BZ; at &BZ-URL; to file a bug
- against the document.</para>
- </caution>
- </step>
- </procedure>
-
- </section>
-
- </section>
+ <index id="generated-index"/>
</article>
-
-<!--
-Local variables:
-mode: xml
-fill-column: 72
-End:
--->
More information about the Fedora-docs-commits
mailing list