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
5730da
    <variablelist>
5730da
    <varlistentry>
5730da
    <term>Master Paths</term>
5730da
    <listitem>
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:
5730da
5730da
        <itemizedlist>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Identity/Models/Brands</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Manuals/Repository/Docbook</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>
5730da
        </itemizedlist>
054a7b
    </para>
5730da
    </listitem>
5730da
    </varlistentry>
5730da
5730da
    <varlistentry>
5730da
    <term>Auxiliar paths</term>
5730da
    <listitem>
054a7b
    <para>
5730da
        An auxiliar path refers a directory inside the repository
5730da
        considered auxiliar for the master path. Auxiliar path can be
5730da
        either for output or localization. Assuming the master path
5730da
        provides the input information, the auxiliar paths provide the
5730da
        auxiliar information which describes how and where that input 
5730da
        information is rendered by automation scripts. Examples of
5730da
        auxiliar paths inside the repository include:
5730da
        
5730da
        <itemizedlist>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Identity/Images/Brands</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Manuals/Repository/Docbook/es_ES</filename>
5730da
        </para>
5730da
        </listitem>
5730da
        <listitem>
5730da
        <para>
5730da
            <filename class="directory">trunk/Locales/Manuals/Repository/Docbook/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>
5730da
        </itemizedlist>
5730da
054a7b
    </para>
5730da
    </listitem>
5730da
    </varlistentry>
5730da
    </variablelist>
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>
5730da
        For example, if the <envar>LANG</envar> environment variable
5730da
        is set to <literal>es_ES.UTF-8</literal> and you execute the
5730da
        <function>render</function> functionality of
5730da
        <command>centos-art.sh</command> script with the 
5730da
        class="directory">trunk/Manuals/Repository/Docbook</filename>
5730da
        master path as argument, it will produce &TCARUG; in Spanish
5730da
        language using translation messages from 
5730da
        class="directory">trunk/Locales/Manuals/Repository/Docbook/es_ES</filename>
5730da
        auxiliar path and saving output files inside 
5730da
        class="directory">trunk/Manuals/Repository/Docbook/es_ES</filename>
5730da
        auxiliar path.
5730da
    </para> 
054a7b
ad4658
</sect1>