dgv2/en_US creating-document.xml, 1.2, 1.3 documentation-guide.xml, 1.1, 1.2 entering-project.xml, 1.2, 1.3
Paul W. Frields (pfrields)
fedora-docs-commits at redhat.com
Mon Jun 12 00:20:41 UTC 2006
Author: pfrields
Update of /cvs/docs/dgv2/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv4106/en_US
Modified Files:
creating-document.xml documentation-guide.xml
entering-project.xml
Log Message:
Added a bit of content, still working on initial version...
Index: creating-document.xml
===================================================================
RCS file: /cvs/docs/dgv2/en_US/creating-document.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- creating-document.xml 4 Jun 2006 17:42:53 -0000 1.2
+++ creating-document.xml 12 Jun 2006 00:20:34 -0000 1.3
@@ -10,7 +10,7 @@
]>
-<chapter id="creating-document">
+<chapter id="ch-creating-document">
<title>Creating a Document in &SCM;</title>
<para>
The &FDP; uses a standard organization for its work in &SCM;. This
@@ -22,7 +22,7 @@
and published. To create a new document, follow these steps.
</para>
<procedure>
- <step>
+ <step id="st-checkout-common-tools">
<title>Checkout Common Tools</title>
<para>
The <filename class="directory">docs-common</filename> module in
@@ -38,7 +38,7 @@
</screen>
</step>
- <step>
+ <step id="st-create-module-directory">
<title>Create a Module Directory</title>
<para>
Use a descriptive name, but do not use the word "&FED;" in your
@@ -63,7 +63,7 @@
</screen>
</step>
- <step>
+ <step id="st-create-makefile">
<title>Create a <filename>Makefile</filename></title>
<para>
The <filename>Makefile</filename> contains information required
@@ -129,7 +129,8 @@
document-specific entity definition files. In general, you
only need to create one of these files, although you may use
as many as you wish. Most documents only use the standard
- <filename>doc-entities.xml</filename> file.
+ <filename>doc-entities.xml</filename> file. See <xref
+ linkend="st-create-doc-entities"/> for more information.
</para>
</listitem>
<listitem>
@@ -152,7 +153,7 @@
</listitem>
</orderedlist>
</step>
- <step>
+ <step id="st-create-rpm-info">
<title>Create <filename>rpm-info.xml</filename> File</title>
<para>
The <filename>rpm-info.xml</filename> file contains information
@@ -171,7 +172,7 @@
make changes where appropriate.
</para>
</step>
- <step>
+ <step id="st-create-doc-entities">
<title>Create <filename>doc-entities.xml</filename> File</title>
<para>
The <filename>doc-entities.xml</filename> file contains required
@@ -191,7 +192,7 @@
</para>
<para>
You <emphasis>must</emphasis> include at least the following
- entities in your document. Each entity's <sgmltag
+ four (4) entities in your document. Each entity's <sgmltag
class="attribute">kind</sgmltag> attribute must be the default
value of <sgmltag class="attvalue">term</sgmltag>, with the
<sgmltag class="element">text</sgmltag> element contents as
@@ -243,17 +244,65 @@
</varlistentry>
</variablelist>
</step>
- <step>
+ <step id="st-create-content">
<title>Create Content</title>
- <para></para>
+ <para>
+ Use DocBook XML to create your documents. You may have more
+ than one XML file for a document as needed. If you are not
+ familiar with using DocBook XML, refer to <xref
+ linkend="ch-using-docbook"/> for more information.
+ </para>
+ <para>
+ Do not use the word "&FED;" in your file names or other
+ identifiers. This term is redundant and may interfere with
+ collaboration efforts.
+ </para>
</step>
- <step>
+ <step id="st-create-l10n">
<title>Create L10N Support</title>
- <para></para>
+ <para>
+ When you have finished creating content, you must create a
+ translation template file. This file, sometimes called a
+ <filename class="extension">POT</filename> file, contains a list
+ of strings of text to be translated. A translator copies this
+ template to a language-specific <filename
+ class="extension">PO</filename> file and creates a translation
+ for each string.
+ </para>
+ <para>
+ To create the <filename class="extension">POT</filename> file,
+ run the following commands:
+ </para>
+
+<screen>
+<command>cd ~/fdp/my-tutorial/</command>
+<command>mkdir po</command>
+<command>cvs add po</command>
+<command>make pot</command>
+</screen>
+
+ <para>
+ These commands create a
+ <filename>po/<replaceable>my-tutorial</replaceable>.pot</filename>
+ file. The <filename class="extension">POT</filename> file is a
+ template for multiple <filename class="extension">PO</filename>
+ files, each translating the document into a different language.
+ The contents of all XML files are contained in a single
+ <filename class="extension">POT</filename> file.
+ </para>
+ <important>
+ <title>Updating <filename class="extension">POT</filename>
+ Files</title>
+ <para>
+ If you make changes to your document, remember to update the
+ <filename class="extension">POT</filename> file with the
+ command <command>make pot</command>.
+ </para>
+ </important>
</step>
</procedure>
</chapter>
-
+
<!--
Index: documentation-guide.xml
===================================================================
RCS file: /cvs/docs/dgv2/en_US/documentation-guide.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- documentation-guide.xml 2 Jun 2006 05:16:13 -0000 1.1
+++ documentation-guide.xml 12 Jun 2006 00:20:34 -0000 1.2
@@ -44,4 +44,11 @@
</xi:fallback>
</xi:include>
+ <xi:include href="using-docbook.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+ <xi:fallback>
+ <para>using-docbook.xml is missing!</para>
+ </xi:fallback>
+ </xi:include>
+
</book>
Index: entering-project.xml
===================================================================
RCS file: /cvs/docs/dgv2/en_US/entering-project.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- entering-project.xml 2 Jun 2006 06:19:36 -0000 1.2
+++ entering-project.xml 12 Jun 2006 00:20:34 -0000 1.3
@@ -13,36 +13,42 @@
<chapter id="entering-project">
<title>Entering the &FDP;</title>
<abstract>
- <para>This chapter covers the following steps to joining the &FDP;:
- </para>
+ <para>
+ This chapter covers the following steps to joining the &FDP;:
<orderedlist>
<listitem>
- <para><ulink
- url="http://fedoraproject.org/wiki/DocsProject/UsingGpg/CreatingKeys">Creating
- a GPG key</ulink> [<xref
- linkend="sn-entering-project-gpg"/>More ..<ulink>]</para>
+ <para><ulink
+ url="http://fedoraproject.org/wiki/DocsProject/UsingGpg/CreatingKeys">Creating
+ a GPG key</ulink> [<xref
+ linkend="sn-entering-project-gpg"/>]</para>
</listitem>
<listitem>
- <para><ulink
- url="http://www.redhat.com/mailman/listinfo/fedora-docs-list/">Joining the mailing list</ulink> [<xref
- linkend="sn-entering-project-docs-list"/>More ..<ulink>]</para>
+ <para><ulink
+ url="http://www.redhat.com/mailman/listinfo/fedora-docs-list/">Joining
+ the mailing list</ulink> [<xref
+ linkend="sn-entering-project-docs-list"/>]</para>
</listitem>
<listitem>
- <para><ulink url="http://fedoraproject.org/wiki/WikiEditing?">Creating a Wiki account</ulink> [<xref
- linkend="sn-entering-project-wiki"/>More ..<ulink>]</para>
+ <para><ulink
+ url="http://fedoraproject.org/wiki/WikiEditing">Creating
+ a Wiki account</ulink> [<xref
+ linkend="sn-entering-project-wiki"/>]</para>
</listitem>
<listitem>
- <para><ulink url="http://fedoraproject.org/wiki/Cryptography">Creating an SSH key</ulink> [<xref
- linkend="sn-entering-project-ssh-key"/>More ..<ulink>]</para>
+ <para><ulink
+ url="http://fedoraproject.org/wiki/Cryptography">Creating
+ an SSH key</ulink> [<xref
+ linkend="sn-entering-project-ssh-keys"/>]</para>
</listitem>
<listitem>
<para>(Optional) Creating a Bugzilla account [<xref
- linkend="sn-entering-project-bugzilla"/>More ..<ulink>]</para>
+ linkend="sn-entering-project-bugzilla"/>]</para>
</listitem>
<listitem>
- <para>(Optional) <ulink
- url="http://fedoraproject.org/wiki/DocsProject/CvsUsage">Getting a CVS account</ulink> [<xref
- linkend="sn-entering-project-cvs"/>More ..<ulink>]</para>
+ <para>(Optional) <ulink
+ url="http://fedoraproject.org/wiki/DocsProject/CvsUsage">Getting
+ a CVS account</ulink> [<xref
+ linkend="sn-entering-project-cvs"/>]</para>
</listitem>
</orderedlist>
</para>
@@ -55,42 +61,45 @@
</para>
</section>
- <section id="sn-entering-project-docs-list">
- <title>Joining fedora-docs-list</title>
- <para>
-
- </para>
- </section>
- <section id="sn-entering-project-wiki">
- <title>Creating a Wiki account</title>
- <para>
-
- </para>
- </section>
- <section id="creating-ssh-keys">
+ <section id="sn-entering-project-docs-list">
+ <title>Joining fedora-docs-list</title>
+ <para>
+
+ </para>
+ </section>
+ <section id="sn-entering-project-wiki">
+ <title>Creating a Wiki account</title>
+ <para>
+
+ </para>
+ </section>
+ <section id="sn-entering-project-ssh-keys">
<title>Creating SSH Keys</title>
- <para></ulink>
- <firstterm>Secure Shell</firstterm>, or <acronym>SSH</acronym>, is
- a way for a user to communicate securely with a host. SSH uses
- very secure cryptographic routines to make your communications
- unreadable by anyone on a network other than the intended
- recipient. To ensure you can trust the information you receive
- from &FP; servers, we recommend you create a keypair.
- </para>
- </section>
-
- <section id="sn-entering-project-bugzilla">
- <title>Creating a Bugzilla account</title>
- <para>
-
- </para>
- </section>
- <section id="sn-entering-project-cvs">
- <title>Getting a CVS account</title>
- <para>
+ <para><firstterm>Secure Shell</firstterm>, or
+ <acronym>SSH</acronym>, is a way for a user to communicate
+ securely with a host. SSH uses very secure cryptographic routines
+ to make your communications unreadable by anyone on a network
+ other than the intended recipient. To ensure you can trust the
+ information you receive from &FP; servers, we recommend you create
+ a keypair.
+ </para>
+ </section>
+
+ <section id="sn-entering-project-bugzilla">
+ <title>Creating a Bugzilla account</title>
+ <para>
+
+ </para>
+ </section>
+ <section id="sn-entering-project-cvs">
+ <title>Getting a CVS account</title>
+ <para>
+
+ </para>
+ </section>
+
+</chapter>
- </para>
- </section>
<!--
Local variables:
More information about the Fedora-docs-commits
mailing list