Blame Documentation/Models/Docbook/Tcar-ug/Repository/Conventions/filenames.docbook

5aaf9d
<section id="repo-convs-filenames">
054a7b
        
3c5068
    <title>Repository File Names</title>
5aaf9d
5aaf9d
    <section id="repo-convs-filenames-rfiles">
5aaf9d
    <title>Regular Files</title>
054a7b
        
054a7b
    <para>
5aaf9d
        Inside &TCAR;, file names are always written in lowercase.
5aaf9d
        Digits (e.g., 0, 1, 2), hyphen (-), dot
5aaf9d
        (.) and low line (_)
5aaf9d
        characters are also accepted. In case you use hyphen and dot
5aaf9d
        characters, don't use them as first character in the file
5aaf9d
        name.
054a7b
    </para>
5aaf9d
 
5aaf9d
    <section id="repo-convs-filenames-rfiles-ok">
5aaf9d
    <title>Files Written Correctly</title>
5aaf9d
    <para>
5aaf9d
        The following file names are written correctly:
5aaf9d
    </para>
5aaf9d
    <itemizedlist>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename>01-welcome.png</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename>splash.png</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename>anaconda_header.png</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    </itemizedlist>
5aaf9d
    </section>
5aaf9d
5aaf9d
    <section id="repo-convs-filenames-rfiles-wrong">
5aaf9d
    <title>Files Written Incorrectly</title>
5aaf9d
    <para>
5aaf9d
        The following file names are written incorrectly:
5aaf9d
    </para>
5aaf9d
    <itemizedlist>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename>01-Welcome.png</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename>-welcome.png</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename>Splash.png</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename>AnacondaHeader.png</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    </itemizedlist>
5aaf9d
    </section>
5aaf9d
5aaf9d
    <section id="repo-convs-filenames-rfiles-exceptions">
5aaf9d
    <title>Exceptions</title>
5aaf9d
    <para>
5aaf9d
        When you name files, consider the following exceptions:
5aaf9d
    </para>
5aaf9d
    <itemizedlist>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        In the very specific case of repository documentation entries
5aaf9d
        written in Texinfo format, file names follow the directory
5aaf9d
        structure naming convenction.  This is because they are
5aaf9d
        documenting directories and that is something
5aaf9d
        we want to remark. So, to better describe what we are
5aaf9d
        documenting, files related to documentation entries follow the
5aaf9d
        name convenction used by the item they document.
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    </itemizedlist>
5aaf9d
5aaf9d
    </section>
5aaf9d
5aaf9d
    </section>
5aaf9d
5aaf9d
    <section id="repo-convs-filenames-hfiles">
5aaf9d
    <title>Symbolic Links</title>
5aaf9d
    <para>
5aaf9d
        Inside &TCAR;, symbolic link names follow the same
5aaf9d
        convenctions described in 
5aaf9d
        linkend="repo-convs-filenames-rfiles"/>.
5aaf9d
    </para>
5aaf9d
    </section>
5aaf9d
    
5aaf9d
    <section id="repo-convs-filenames-dfiles">
5aaf9d
    <title>Directories</title>
5aaf9d
    <para>
5aaf9d
        Inside &TCAR;, directory names are all written capitalized and
5aaf9d
        sometimes in cammel case. Digits (e.g., 0, 1, 2), hyphen
5aaf9d
        (-), dot (.) and low line
5aaf9d
        (_) characters are also accepted. In case you
5aaf9d
        use hyphen and dot characters, don't use them as first
5aaf9d
        character in the directory name.
5aaf9d
    </para>
5aaf9d
    
5aaf9d
    <section id="repo-convs-filenames-dfiles-ok">
5aaf9d
    <title>Directories Written Correctly</title>
5aaf9d
    <para>
5aaf9d
        The following directory names are written correctly:
5aaf9d
    </para>
5aaf9d
    <itemizedlist>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename class="directory">Identity</filename>,
5aaf9d
        <filename class="directory">Themes</filename>,
5aaf9d
        <filename class="directory">Motifs</filename>,
5aaf9d
        <filename class="directory">TreeFlower</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename class="directory">Tcar-ug</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename class="directory">0.0.1</filename>, 
5aaf9d
        class="directory">0.0.1-35</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    </itemizedlist>
5aaf9d
    </section>
5aaf9d
5aaf9d
    <section id="repo-convs-filenames-dfiles-wrong">
5aaf9d
    <title>Directories Written Incorrectly</title>
5aaf9d
    <para>
5aaf9d
        The following directory names are written incorrectly:
5aaf9d
    </para>
5aaf9d
    <itemizedlist>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename class="directory">identitY</filename>,
5aaf9d
        <filename class="directory">theMes</filename>,
5aaf9d
        <filename class="directory">MOTIFS</filename>,
5aaf9d
        <filename class="directory">treeFlower</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename class="directory">tcar-ug</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        <filename class="directory">.0.1</filename>, 
5aaf9d
        class="directory">.0.1-35</filename>
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    </itemizedlist>
5aaf9d
    </section>
5aaf9d
5aaf9d
    <section id="repo-convs-filenames-dfiles-exceptions">
5aaf9d
    <title>Exceptions</title>
5aaf9d
    <para>
5aaf9d
        When you name directories, consider the following exceptions:
5aaf9d
    </para>
5aaf9d
    <itemizedlist>
5aaf9d
    <listitem>
5aaf9d
    <para>
5aaf9d
        No one so far.
5aaf9d
    </para>
5aaf9d
    </listitem>
5aaf9d
    </itemizedlist>
5aaf9d
    </section>
5aaf9d
5aaf9d
    </section> 
5aaf9d
5aaf9d
</section>