diff options
Diffstat (limited to 'en_US/module-struct.xml')
| -rw-r--r-- | en_US/module-struct.xml | 31 |
1 files changed, 24 insertions, 7 deletions
diff --git a/en_US/module-struct.xml b/en_US/module-struct.xml index 25851ec..46eea9b 100644 --- a/en_US/module-struct.xml +++ b/en_US/module-struct.xml @@ -19,7 +19,8 @@ <title>Structure of a Module</title> <para><xref linkend="ex-module-structure"/> shows a directory tree of an example module, excluding any <filename - class="directory">CVS</filename> folders:</para> + class="directory">CVS</filename> folders. Note that this + example document does not have branches.</para> <example id="ex-module-structure"> <title>Example Module Structure</title> <screen><computeroutput><![CDATA[example-doc/ @@ -77,11 +78,11 @@ <seg>Translation (PO) directory</seg> <seg>optional</seg> <seg>The <filename class="directory">po/</filename> directory - contains specially formatted files created and used by - translators. The &FDP; build tools use these files to create - translated versions of documents. The translated documents are - not stored in CVS; they are created as needed from these PO - files.</seg> + contains specially formatted Portable Object, or + <acronym>PO</acronym>, files created and used by translators. + The &FDP; build tools use these files to create translated + versions of documents. The translated documents are not stored + in CVS; they are created as needed from these PO files.</seg> </seglistitem> <seglistitem> <seg>Makefile</seg> @@ -97,13 +98,29 @@ document specific metadata</seg> </seglistitem> </segmentedlist> + <important> + <title>Common Build Tools</title> + <para>Never add the <systemitem>docs-common</systemitem> build + tools directory to an individual module. Special formatting in + the module list downloads these tools when a user checks out a + document module. For more information, refer to <xref + linkend="ch-getting-files-naming-modules"/>.</para> + </important> </section> <section id="sn-build-system"> <title>The Document Build System</title> <para> The build system can render the document into another format such as <abbrev>HTML</abbrev> or <abbrev>PDF</abbrev>, using - <command>make(1)</command> and shell scripts. Authors need + <command>make(1)</command><footnote> + <para>In Linux and &DISTRO; documentation, references to + commands often include a number inside parentheses. This + number represents the section of + <firstterm>manpages</firstterm> that includes documentation + for that command. To read the manpage for + <command>make(1)</command>, use the command <command>man 1 + make</command>.</para> + </footnote> and shell scripts. Authors need <emphasis>no</emphasis> prior experience with either shell scripts or a <command>make(1)</command>. </para> |