Blame Documentation/Tcar-ug/Manuals/Production/implementing-structure.docbook

1c9079
<sect1 id="manuals-production-implementing-structure">
39d073
1c9079
    <title>Implementing Document Structure</title>
1c9079
1c9079
    <para>
39d073
        This section describes the steps you should follow to
39d073
        implement document structures like that one described in 
39d073
        linkend="manuals-production-identifying-structure" />.
39d073
    </para>
39d073
39d073
    <sect2>
39d073
    <title>Creating Document Structure</title>
39d073
39d073
    <para>
39d073
        To create new documentation manuals inside &TCAR; you need to
39d073
        use the <function>help</function> functionality of
39d073
        <command>centos-art.sh</command> script, as shown in the
39d073
        following command: 
1c9079
    </para>
1c9079
39d073
    <screen>centos-art help --edit "<replaceable>manual-name</replaceable>"</screen>
1c9079
1c9079
    <para>
39d073
        The first time you execute this command, you will be prompted
39d073
        to enter manual specific information like document format,
39d073
        document title, document subtitle, document author, etc.  Once
39d073
        this information has been collected the
39d073
        <function>help</function> functionality performs some
39d073
        repository verifications and creates the manual source files
39d073
        inside the manual's directory name you specified as
39d073
        <replaceable>manual-name</replaceable>.
1c9079
    </para>
1c9079
1c9079
    <para>
39d073
        When you create new documentation manuals, take care of the
39d073
        locale information you are currently using. This information
39d073
        is generally set in the <envar>LANG</envar> environment
39d073
        variable and is used by the <function>help</function>
39d073
        functionality of <command>centos-art.sh</command> script to
39d073
        define the language of new documentation manual and the
39d073
        document template used to build it, as well.
1c9079
    </para>
1c9079
1c9079
    <para>
39d073
        Once the documentation structure has been created this way,
39d073
        the recently created documentation manual is ready to receive
39d073
        new chapters and sections as it is described in 
39d073
        linkend="manuals-production-maintaining-structure" />.
1c9079
    </para>
39d073
39d073
    </sect2>
1c9079
1c9079
</sect1>