Blame Manuals/Repository/Docbook/Preface/Docconvs.docbook

5e5a98
<preface id="docconvs">
e935c3
0ded16
    <title>Document Convenctions</title>
e935c3
9a2c27
    <para>
9a2c27
        In this manual, certain words are represented in different
9a2c27
        fonts, typefaces, sizes, and weights. This highlighting is
9a2c27
        systematic; different words are represented in the same style
9a2c27
        to indicate their inclusion in a specific category. The types
9a2c27
        of words that are represented this way include the
9a2c27
        following:
9a2c27
    </para>
9a2c27
9a2c27
    <variablelist>
9a2c27
        <varlistentry>
9a2c27
            <term><command>command</command></term>
9a2c27
            <listitem>
9a2c27
                <para>
9a2c27
                    Linux commands (and other operating system
9a2c27
                    commands, when used) are represented this way.
9a2c27
                    This style should indicate to you that you can
9a2c27
                    type the word or phrase on the command line and
9a2c27
                    press Enter to invoke a command. Sometimes a
9a2c27
                    command contains words that would be displayed in
9a2c27
                    a different style on their own (such as file
9a2c27
                    names). In these cases, they are considered to be
9a2c27
                    part of the command, so the entire phrase is
fe1cb1
                    displayed as a command.  For example:
9a2c27
                </para>
9a2c27
9a2c27
                <itemizedlist>
9a2c27
                <listitem>
9a2c27
                <para>
9a2c27
                    Use the <command>centos-art render 
9a2c27
                    class="directory">trunk/Manuals/Repository/Docbook</filename>
9a2c27
                    --filter="repository"</command> command to produce
9a2c27
                    the CentOS Artwork Repository User's Guide.
9a2c27
                </para>
9a2c27
                </listitem>
9a2c27
                </itemizedlist>
ca81f7
                
9a2c27
            </listitem>
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
9a2c27
            <term><filename>file name</filename></term>
9a2c27
            <listitem>
9a2c27
                <para>
9a2c27
                    File names, directory names, paths, and RPM
9a2c27
                    package names are represented this way. This style
9a2c27
                    indicates that a particular file or directory
fe1cb1
                    exists with that name on your system. Examples:
9a2c27
                </para>
9a2c27
9a2c27
                <itemizedlist>
9a2c27
                <listitem>
9a2c27
                <para>
9a2c27
                    The <filename>init.sh</filename> file in 
9a2c27
                    class="directory">trunk/Scripts/Bash/Cli/</filename>
9a2c27
                    directory is the initialization script, written in
9a2c27
                    Bash, used to automate most of tasks in the
9a2c27
                    repository.
9a2c27
                </para>
9a2c27
                </listitem>
9a2c27
                <listitem>
9a2c27
                <para>
9a2c27
                    The <command>centos-art</command> command uses the
9a2c27
                    <package>ImageMagick</package> RPM package to
9a2c27
                    convert images from PNG format to other
9a2c27
                    formats.
9a2c27
                </para>
9a2c27
                </listitem>
9a2c27
                </itemizedlist>
9a2c27
9a2c27
            </listitem>
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
9a2c27
            <term><keycap>key</keycap></term>
9a2c27
            <listitem>
9a2c27
                <para>
9a2c27
                    A key on the keyboard is shown in this style.
fe1cb1
                    For example:
9a2c27
                </para>
9a2c27
9a2c27
                <itemizedlist>
9a2c27
                <listitem>
fe1cb1
                <para>
fe1cb1
                    To use <keycap>Tab</keycap> completion to list
fe1cb1
                    particular files in a directory, type
fe1cb1
                    <command>ls</command>, then a character, and
fe1cb1
                    finally the <keycap>Tab</keycap> key. Your
fe1cb1
                    terminal displays the list of files in the working
fe1cb1
                    directory that begin with that character.
fe1cb1
                </para>
9a2c27
                </listitem>
9a2c27
                </itemizedlist>
9a2c27
            </listitem>
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
9a2c27
            <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term>
9a2c27
            <listitem>
9a2c27
                <para>
9a2c27
                    A combination of keystrokes is represented in this
fe1cb1
                    way. For example: 
9a2c27
                </para>
9a2c27
                <itemizedlist> 
9a2c27
                <listitem> 
9a2c27
                <para>
9a2c27
                    The 
9a2c27
                    action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo>
9a2c27
                    key combination exits your graphical session and
9a2c27
                    returns you to the graphical login screen or the
9a2c27
                    console.
9a2c27
                </para> 
9a2c27
                </listitem>
9a2c27
                </itemizedlist>
e935c3
                
9a2c27
            </listitem> 
e935c3
                
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
9a2c27
            <term><computeroutput>computer output</computeroutput></term>
9a2c27
            <listitem>
9a2c27
            <para>
9a2c27
                Text in this style indicates text displayed to a shell
9a2c27
                prompt such as error messages and responses to
9a2c27
                commands. For example, the <command>ls</command>
9a2c27
                command displays the contents of a directory using
9a2c27
                this style:
9a2c27
            </para>
e935c3
ca8d80
<programlisting>
9a2c27
render_doTranslation.sh     render_getDirTemplate.sh    render_doBaseActions.sh
9a2c27
render_getConfigOption.sh   render_getOptions.sh        render_doThemeActions.sh  
9a2c27
render_getDirOutput.sh      render.sh
ca8d80
</programlisting>
e935c3
9a2c27
            <para>
9a2c27
                The output returned in response to the command (in
9a2c27
                this case, the contents of the directory) is shown in
9a2c27
                this style.
9a2c27
            </para>
9a2c27
        </listitem>
9a2c27
    </varlistentry>
9a2c27
9a2c27
    <varlistentry>
9a2c27
        <term><prompt>prompt</prompt></term>
9a2c27
        <listitem>
9a2c27
        <para>
9a2c27
            A prompt, which is a computer's way of signifying that it
9a2c27
            is ready for you to input something, is shown in this
9a2c27
            style. Examples:
9a2c27
            <itemizedlist>
9a2c27
                <listitem>
9a2c27
                <para>
9a2c27
                    <prompt>$</prompt>
9a2c27
                </para>
9a2c27
                </listitem>
9a2c27
                <listitem>
9a2c27
                <para>
9a2c27
                    <prompt>#</prompt>
9a2c27
                </para>
9a2c27
                </listitem>
9a2c27
                <listitem>
9a2c27
                <para>
9a2c27
                    <prompt>[centos@projects centos]$</prompt>
9a2c27
                </para>
9a2c27
                </listitem>
9a2c27
                <listitem>
9a2c27
                <para>
9a2c27
                    <prompt>projects login:</prompt>
9a2c27
                </para>
9a2c27
                </listitem>
9a2c27
            </itemizedlist>
9a2c27
9a2c27
        </para>
9a2c27
        </listitem>
9a2c27
    </varlistentry>
9a2c27
9a2c27
    <varlistentry>
9a2c27
        <term><userinput>user input</userinput></term>
9a2c27
        <listitem>
9a2c27
        <para>
9a2c27
            Text that the user types, either on the command line or
9a2c27
            into a text box on a GUI screen, is displayed in this
9a2c27
            style. In the following example,
9a2c27
            <userinput>text</userinput> is displayed in this style: To
9a2c27
            boot your system into the text based installation program,
9a2c27
            you must type in the <userinput>text</userinput> command
9a2c27
            at the <prompt>boot:</prompt> prompt.
9a2c27
        </para>
9a2c27
        </listitem>
9a2c27
    </varlistentry>
9a2c27
9a2c27
    <varlistentry>
9a2c27
        <term><replaceable>replaceable</replaceable></term>
9a2c27
        <listitem>
9a2c27
        <para>
9a2c27
           Text used in examples that is meant to be replaced with
9a2c27
           data provided by the user is displayed in this style. In
9a2c27
           the following example,
9a2c27
           <replaceable>version-number</replaceable> is displayed in
9a2c27
           this style: The directory for the kernel source is
9a2c27
           
9a2c27
           class="directory">/usr/src/kernels/<replaceable>version-number</replaceable>/</filename>,
9a2c27
           where <replaceable>version-number</replaceable> is the
9a2c27
           version and type of kernel installed on this system. 
9a2c27
        </para>
9a2c27
        </listitem>
9a2c27
    </varlistentry>
9a2c27
    </variablelist>
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>
ca8d80
        <para>The directory 
ca8d80
        class="directory">/usr/share/doc/</filename> contains
ca8d80
        additional documentation for packages installed on your
ca8d80
        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
5e5a98
</preface>