Blame Documentation/Models/Docbook/Tcar-ug/Manuals/Production/maintaining-structure.docbook

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