|
 |
1c9079 |
<sect1 id="manuals-production-implementing-structure">
|
|
|
1c9079 |
<title>Implementing Document Structure</title>
|
|
|
1c9079 |
|
|
|
1c9079 |
<para>
|
|
|
1c9079 |
To create a manual like the one described in
|
|
|
1c9079 |
linkend="manuals-production-identifying-structure" />,
|
|
|
1c9079 |
you need to use the help functionality of
|
|
|
1c9079 |
<command>centos-art.sh</command> script as it is described in
|
|
|
1c9079 |
the following list of commands:
|
|
|
1c9079 |
</para>
|
|
|
1c9079 |
|
|
|
1c9079 |
<variablelist>
|
|
|
1c9079 |
|
|
|
1c9079 |
<varlistentry>
|
|
|
1c9079 |
<term>
|
|
|
1c9079 |
<command>centos-art help --edit "tcar-fs"</command>
|
|
|
1c9079 |
</term>
|
|
|
1c9079 |
<listitem>
|
|
|
1c9079 |
<para>
|
|
|
1c9079 |
This command creates the base structure of
|
|
|
1c9079 |
<citetitle>TCAR-FS</citetitle> manual and opens its main
|
|
|
1c9079 |
definition file with your favorite text editor so you can
|
|
|
1c9079 |
update manual's definition values like title, subtitle,
|
|
|
1c9079 |
author, etc.
|
|
|
1c9079 |
</para>
|
|
|
1c9079 |
</listitem>
|
|
|
1c9079 |
</varlistentry>
|
|
|
1c9079 |
|
|
|
1c9079 |
<varlistentry>
|
|
|
1c9079 |
<term>
|
|
|
1c9079 |
<command>centos-art help --edit "tcar-fs::trunk"</command>
|
|
|
1c9079 |
</term>
|
|
|
1c9079 |
<listitem>
|
|
|
1c9079 |
<para>
|
|
|
1c9079 |
This command creates the base structure for the
|
|
|
1c9079 |
<quote>trunk</quote> chapter and opens its main definition
|
|
|
1c9079 |
file with your favorite text editor so you can update the
|
|
|
1c9079 |
chapter introduction. This very same procedure is used to
|
|
|
1c9079 |
create <quote>branches</quote> and <quote>tags</quote>
|
|
|
1c9079 |
chapters, just be sure to change the chapter field
|
|
|
1c9079 |
accordingly.
|
|
|
1c9079 |
</para>
|
|
|
1c9079 |
</listitem>
|
|
|
1c9079 |
</varlistentry>
|
|
|
1c9079 |
|
|
|
1c9079 |
<varlistentry>
|
|
|
1c9079 |
<term>
|
|
|
1c9079 |
<command>centos-art help --edit "tcar-fs::trunk:identity"</command>
|
|
|
1c9079 |
</term>
|
|
|
1c9079 |
<listitem>
|
|
|
1c9079 |
<para>
|
|
|
1c9079 |
This command creates the <quote>identity</quote> section
|
|
|
1c9079 |
inside the <quote>trunk</quote> chapter. If the chapter
|
|
|
1c9079 |
doesn't exist it will be created first. In this command, the
|
|
|
1c9079 |
<quote>identity</quote> section refers to
|
|
|
1c9079 |
class="directory">trunk/Identity</filename> directory inside
|
|
|
1c9079 |
&TCAR;. In order to document other directories, follow the
|
|
|
1c9079 |
same procedure but using minus signs to separate directories.
|
|
|
1c9079 |
For example, to document the <quote>
|
|
|
1c9079 |
class="directory">trunk/Identity/Models/Themes</filename></quote>
|
|
|
1c9079 |
directory you should use the
|
|
|
1c9079 |
<quote>tcar-fs::trunk:identity-models-themes</quote>
|
|
|
1c9079 |
documentation entry.
|
|
|
1c9079 |
</para>
|
|
|
1c9079 |
|
|
|
1c9079 |
<note>
|
|
|
1c9079 |
<para>
|
|
|
1c9079 |
In the very specific case of
|
|
|
1c9079 |
<citetitle>TCAR-FS</citetitle> manual, it is also possible
|
|
|
1c9079 |
to refer chapters and sections using a <quote>
|
|
|
1c9079 |
class="directory">path/to/dir</filename></quote> format.
|
|
|
1c9079 |
For example, the reference
|
|
|
1c9079 |
<quote>tcar-fs::trunk:identity-models-themes</quote>
|
|
|
1c9079 |
can also be specified as <quote>
|
|
|
1c9079 |
class="directory">trunk/Identity/Models/Themes</filename></quote>,
|
|
|
1c9079 |
in case you feel more confortable with it than the former
|
|
|
1c9079 |
one.
|
|
|
1c9079 |
</para>
|
|
|
1c9079 |
</note>
|
|
|
1c9079 |
</listitem>
|
|
|
1c9079 |
</varlistentry>
|
|
|
1c9079 |
</variablelist>
|
|
|
1c9079 |
|
|
|
1c9079 |
</sect1>
|