summaryrefslogtreecommitdiffstats
path: root/en_US
diff options
context:
space:
mode:
authorPaul W. Frields <stickster@gmail.com>2007-07-01 18:20:12 +0000
committerPaul W. Frields <stickster@gmail.com>2007-07-01 18:20:12 +0000
commit3ee3ca2862b1cf4b533735e5442736780f1a08f1 (patch)
tree6a923b4146cf648e15792f2aac73df5f8f4b63a3 /en_US
parent13a8999e5f95686111ec85dc2357a5d9ef58ea2c (diff)
downloaddocumentation-guide-3ee3ca2862b1cf4b533735e5442736780f1a08f1.tar.gz
documentation-guide-3ee3ca2862b1cf4b533735e5442736780f1a08f1.tar.xz
documentation-guide-3ee3ca2862b1cf4b533735e5442736780f1a08f1.zip
Additional upgrades and changes; this will go to publication ASAP.
Diffstat (limited to 'en_US')
-rw-r--r--en_US/getting-files.xml19
-rw-r--r--en_US/module-struct.xml5
-rw-r--r--en_US/rpm-info.xml2
3 files changed, 19 insertions, 7 deletions
diff --git a/en_US/getting-files.xml b/en_US/getting-files.xml
index 7789d4e..61f0812 100644
--- a/en_US/getting-files.xml
+++ b/en_US/getting-files.xml
@@ -88,14 +88,14 @@
documents for &DISTRO; users around the world. The flexibility of
XML allows for a single document to be used many times for many
purposes, like reusable code for a programmer.</para>
- <para>DocBook is iself very well documented. For more information
+ <para>DocBook is itself very well documented. For more information
about DocBook, visit <ulink url="http://www.docbook.org/"/>. The
- DocBook site also features complete browseable and downloadable
- copies of <citetitle>DocBook: The Definitive Guide</citetitle>,
- the canonical source for DocBook information.</para>
+ DocBook site also features complete copies of <citetitle>DocBook:
+ The Definitive Guide</citetitle> to browse and download, the
+ canonical source for DocBook information.</para>
<note>
<title>DocBook XML Versions</title>
- <para>DocBook XML, like a computer progam, has version numbers.
+ <para>DocBook XML, like a computer program, has version numbers.
The version used by &FDP; right now is &DBVER;. The DocBook web
site may document a slightly newer version, but the majority of
the schema still applies.</para>
@@ -149,10 +149,17 @@ documentation-guide documentation-guide &docs-common]]></computeroutput></screen
linkend="ch-cvs"/>.</para>
<para>Note in the listing above that the
<systemitem>about-fedora</systemitem> module has two branches
- avalable. One branch is for &DISTRO; 7 and one is for forward
+ available. One branch is for &DISTRO; 7 and one is for forward
development to match the current work of developers. On the other
hand, the <systemitem>documentation-guide</systemitem> module is
not branched.</para>
+ <tip>
+ <title>Modules Labeled <filename>-dir</filename></title>
+ <para>Modules ending with the suffix <filename>-dir</filename> are
+ not usually helpful to checkout directly. These modules do not
+ include the common build tools and thus do not provide many of
+ the functions contributors require.</para>
+ </tip>
<section id="ch-getting-files-naming-modules">
<title>Module Names</title>
<para>Choose a module name that accurately reflects your
diff --git a/en_US/module-struct.xml b/en_US/module-struct.xml
index 46eea9b..55758b7 100644
--- a/en_US/module-struct.xml
+++ b/en_US/module-struct.xml
@@ -291,6 +291,11 @@ include $(shell $(find-makefile-common))]]></screen>
well.</seg>
</seglistitem>
</segmentedlist>
+ <note>
+ <title>PDF Generation is Erratic</title>
+ <para><abbrev>PDF</abbrev> production is currently erratic and may
+ not work for your document.</para>
+ </note>
<section>
<title>Adding or Changing Targets</title>
<para>
diff --git a/en_US/rpm-info.xml b/en_US/rpm-info.xml
index d8bc50e..d9ebdf8 100644
--- a/en_US/rpm-info.xml
+++ b/en_US/rpm-info.xml
@@ -33,7 +33,7 @@
<title>Fedora Documentation Guide</title>
<desc>Guidelines and procedures for producing documentation for Fedora</desc>
<changelog order="newest-first">
- <revision date="2007-06-28" number="0.3.0.1">
+ <revision date="2007-07-01" number="0.3.0.1">
<author worker="PaulWFrields"/>
<details>Assorted fixes to reflect newer version of reality</details>
</revision>