Blame Manuals/Docbook/repository-parts/Introduction/document-convenctions.docbook

e935c3
e935c3
<section>
e935c3
e935c3
    <title>Document convenctions</title>
e935c3
ca81f7
    <para>In this manual the personal pronoun <emphasis>we</emphasis>
ca81f7
    is used to repesent <emphasis>The CentOS Artwork SIG</emphasis>,
ca81f7
    the group of persons that build The CentOS Project corporate
ca81f7
    visual identity through the CentOS Artwork Repository.</para>
e935c3
e935c3
    <para>In this manual, certain words are represented in different
e935c3
    fonts, typefaces, sizes, and weights. This highlighting is
e935c3
    systematic; different words are represented in the same style to
e935c3
    indicate their inclusion in a specific category. The types of
e935c3
    words that are represented this way include the following:</para>
e935c3
e935c3
    <glosslist>
e935c3
        <glossentry>
e935c3
            <glossterm><command>command</command></glossterm>
e935c3
            <glossdef>
e935c3
                <para> Linux commands (and other operating system
e935c3
                commands, when used) are represented this way. This
e935c3
                style should indicate to you that you can type the
e935c3
                word or phrase on the command line and press Enter to
e935c3
                invoke a command. Sometimes a command contains words
e935c3
                that would be displayed in a different style on their
e935c3
                own (such as file names). In these cases, they are
e935c3
                considered to be part of the command, so the entire
e935c3
                phrase is displayed as a command. For example:</para>
e935c3
ca81f7
                <para>Use the <command>centos-art identity
ca81f7
                --render='path/to/dir'</command> command to produce
ca81f7
                contents inside the 
ca81f7
                class="directory">trunk/Identity</filename> directory
ca81f7
                structure.</para>
ca81f7
                
e935c3
            </glossdef>
e935c3
        </glossentry>
e935c3
e935c3
        <glossentry>
e935c3
            <glossterm><filename>file name</filename></glossterm>
e935c3
            <glossdef>
e935c3
                <para>File names, directory names, paths, and RPM
e935c3
                package names are represented this way. This style
e935c3
                indicates that a particular file or directory exists
e935c3
                with that name on your system. Examples:</para>
e935c3
ca81f7
                <para>The <filename>init.sh</filename> file in
ca81f7
                
ca81f7
                class="directory">trunk/Scripts/Bash/Cli/</filename>
ca81f7
                directory is the initialization script, written in
ca81f7
                Bash, used to automate most of tasks in the
ca81f7
                repository.</para>
ca81f7
ca81f7
                <para>The <command>centos-art</command> command uses
ca81f7
                the <package>ImageMagick</package> RPM package to
ca81f7
                convert images from PNG format to other
ca81f7
                formats.</para>
e935c3
e935c3
            </glossdef>
e935c3
        </glossentry>
e935c3
e935c3
        <glossentry>
e935c3
            <glossterm><keycap>key</keycap></glossterm>
e935c3
            <glossdef>
e935c3
                <para> A key on the keyboard is shown in this style.
e935c3
                For example:</para>
e935c3
e935c3
                <para>To use <keycap>TAB</keycap> completion to list
e935c3
                particular files in a directory, type @command{ls},
e935c3
                then a character, and finally the Tab key. Your
e935c3
                terminal displays the list of files in the working
e935c3
                directory that begin with that character.</para>
e935c3
            </glossdef>
e935c3
        </glossentry>
e935c3
e935c3
        <glossentry>
e935c3
            <glossterm><keycombo action="simul"><keycap>key-combination</keycap></keycombo></glossterm>
e935c3
            <glossdef>
e935c3
                <para>A combination of keystrokes is represented in
e935c3
                this way. For example:</para>
e935c3
e935c3
                <para>The 
e935c3
                action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo>
e935c3
                key combination exits your graphical session and
e935c3
                returns you to the graphical login screen or the
e935c3
                console.</para> 
e935c3
                
e935c3
            </glossdef> 
e935c3
                
e935c3
        </glossentry>
e935c3
e935c3
        <glossentry>
e935c3
            <glossterm><computeroutput>computer output</computeroutput></glossterm>
e935c3
            <glossdef>
e935c3
            <para> Text in this style indicates text displayed to a
e935c3
            shell prompt such as error messages and responses to
e935c3
            commands. For example:</para>
e935c3
ca81f7
            <para>The <command>ls</command> command displays the
ca81f7
            contents of a directory. For example:
e935c3
e935c3
            <programlisting>
e935c3
Config                          help_renameEntry.sh
e935c3
help_copyEntry.sh               help_restoreCrossReferences.sh
e935c3
help_deleteCrossReferences.sh   help_searchIndex.sh
e935c3
            </programlisting>
e935c3
e935c3
            The output returned in response to the command (in this
e935c3
            case, the contents of the directory) is shown in this
e935c3
            style.</para>
e935c3
        </glossdef>
e935c3
    </glossentry>
e935c3
    </glosslist>
e935c3
e935c3
    <para>Additionally, we use several different strategies to draw
e935c3
    your attention to certain pieces of information. In order of
e935c3
    urgency, these items are marked as a note, tip, important,
e935c3
    caution, or warning. For example:</para>
e935c3
e935c3
    <note>
ca81f7
        <para>Remember that Linux is case sensitive. In other words, a
ca81f7
        rose is not a ROSE is not a rOsE.</para>
e935c3
    </note> 
e935c3
e935c3
    <tip>
ca81f7
        <para>The directory @file{/usr/share/doc/} contains additional
ca81f7
        documentation for packages installed on your system.</para>
e935c3
    </tip>
e935c3
e935c3
    <important>
ca81f7
        <para>If you modify the DHCP configuration file, the changes
ca81f7
        do not take effect until you restart the DHCP daemon.</para>
e935c3
    </important>
e935c3
e935c3
    <caution>
ca81f7
        <para>Do not perform routine tasks as root — use a
ca81f7
        regular user account unless you need to use the root account
ca81f7
        for system administration tasks.</para>
e935c3
    </caution>
e935c3
e935c3
    <warning>
ca81f7
        <para>Be careful to remove only the necessary partitions.
ca81f7
        Removing other partitions could result in data loss or a
ca81f7
        corrupted system environment.</para>
e935c3
    </warning>
e935c3
e935c3
</section>