Blame Manuals/Tcar-ug/Repository/Convenctions/relbdirs.docbook

3c5068
<sect1 id="repo-convs-relbdirs">
054a7b
3c5068
    <title>Repository Path Types</title>
054a7b
054a7b
    <para>
054a7b
        In order for automation scripts to produce content inside a
3abc34
        working copy of &TCAR;, it is required that all work lines be
5730da
        related somehow.  The relation between work lines is used by
5730da
        automation scripts to know where to retrive the information
5730da
        they need to work with (e.g., input files, translation
5730da
        messages, output locations, etc.).  This kind of relation is
5730da
        built using two path constructions known as <emphasis>master
5730da
        paths</emphasis> and <emphasis>auxiliar paths</emphasis>.
054a7b
    </para>
5730da
22bb26
    <sect2 id="repo-convs-relbdirs-master">
22bb26
    <title>Master Paths</title>
22bb26
054a7b
    <para>
5730da
        A master path refers to a directory inside the repository that
5730da
        contain input files required to produce output files through
5730da
        automation scripts. Examples of master paths inside the
5730da
        repository include:
22bb26
    </para>
5730da
22bb26
    <itemizedlist>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Identity/Models/Brands</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
01fefe
            <filename class="directory">trunk/Manuals/Tcar-ug</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Identity/Models/Themes/Default/Distro/5/Anaconda</filename>
5730da
        </para>
5730da
        </listitem>
22bb26
    </itemizedlist>
22bb26
22bb26
    </sect2>
22bb26
22bb26
    <sect2 id="repo-convs-relbdirs-auxiliar">
22bb26
    <title>Auxiliar Paths</title>
5730da
054a7b
    <para>
22bb26
        An auxiliar path refers to directories inside the repository
22bb26
        considered auxiliar for one single master path. Auxiliar path
22bb26
        can be either for output or localization. Assuming the master
22bb26
        path provides the input information, the auxiliar paths
22bb26
        provide the auxiliar information which describes how and where
22bb26
        that input information must be rendered by automation scripts.
22bb26
        Examples of auxiliar paths inside the repository include:
22bb26
    </para>
5730da
        
22bb26
    <itemizedlist>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Identity/Images/Brands</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
01fefe
            <filename class="directory">trunk/Manuals/Tcar-ug/es_ES</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
01fefe
            <filename class="directory">trunk/Locales/Manuals/Tcar-ug/es_ES</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Identity/Images/Themes/Flame/3/Distro/5/Anaconda/es_ES</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Locales/Identity/Models/Default/Distro/5/Anaconda/es_ES</filename>
5730da
        </para>
5730da
        </listitem>
22bb26
    </itemizedlist>
5730da
054a7b
    <para>
5730da
        The relationship between master and auxiliar paths is built by
5730da
        combining the second directory level of master paths with
5730da
        directories in the second directory level of repository
5730da
        layout. In the second directory level of repository layout,
5730da
        the <filename class="directory">Identity</filename>, 
5730da
        class="directory">Manuals</filename> and 
5730da
        class="directory">Scripts</filename> directories are always
5730da
        used to create the master paths and the output auxiliar paths.
5730da
        The <filename class="directory">Locales</filename> directory,
5730da
        on the other hand, is always used to create localization
5730da
        auxiliar paths for all the master paths available under
5730da
        <filename class="directory">Identity</filename>, 
5730da
        class="directory">Manuals</filename> and 
5730da
        class="directory">Scripts directories</filename>.
054a7b
    </para>
5730da
        
5730da
    <para>
22bb26
        For example, if the <varname>LANG</varname> environment
22bb26
        variable is set to <quote>es_ES.UTF-8</quote> and you execute
22bb26
        the <function>render</function> functionality of
5730da
        <command>centos-art.sh</command> script with the 
22bb26
        class="directory">trunk/Manuals/Tcar-ug</filename>  master
22bb26
        path as argument, it will produce &TCARUG; in Spanish language
22bb26
        using translation messages from
22bb26
        <filename>trunk/Locales/Manuals/Tcar-ug/es_ES</filename>
22bb26
        auxiliar path and would save final documentation output files
22bb26
        under 
22bb26
        class="directory">trunk/Manuals/Tcar-ug/es_ES</filename>
5730da
        auxiliar path.
22bb26
    </para>
22bb26
22bb26
    </sect2>
054a7b
ad4658
</sect1>