Blame Documentation/Models/Docbook/Book/Preface/docconvs.docbook

70e978
<section id="preface-docconvs">
70e978
70e978
    <title>Document Convenctions</title>
70e978
70e978
    <para>
70e978
        In this manual, certain words are represented in different
70e978
        fonts, typefaces, sizes, and weights. This highlighting is
70e978
        systematic; different words are represented in the same style
70e978
        to indicate their inclusion in a specific category. The types
70e978
        of words that are represented this way include the
70e978
        following:
70e978
    </para>
70e978
70e978
    <variablelist>
70e978
        <varlistentry>
70e978
        <term><command>command</command></term>
70e978
        <listitem>
70e978
        <para>
70e978
            Linux commands (and other operating system commands, when
70e978
            used) are represented this way.  This style should
70e978
            indicate to you that you can type the word or phrase on
70e978
            the command line and press <keycap>Enter</keycap> to
70e978
            invoke a command.  Sometimes a command contains words that
70e978
            would be displayed in a different style on their own (such
70e978
            as file names). In these cases, they are considered to be
70e978
            part of the command, so the entire phrase is displayed as
70e978
            a command.  For example:
70e978
        </para>
70e978
70e978
        <para>
70e978
            Use the <command>centos-art render
70e978
            trunk/Identity/Images/Themes/TreeFlower/4/Distro/5/Anaconda
70e978
            --filter="01-welcome"</command> command to produce the first
70e978
            slide image used by Anaconda in the branch 5 of &TC;;
70e978
            using the version 4 of TreeFlower artistic motif.
70e978
        </para>
70e978
        </listitem>
70e978
        </varlistentry>
70e978
70e978
        <varlistentry>
70e978
        <term><filename>file name</filename></term>
70e978
        <listitem>
70e978
        <para>
70e978
            File names, directory names, paths, and RPM package names
70e978
            are represented this way. This style indicates that a
70e978
            particular file or directory exists with that name on your
70e978
            system. Examples:
70e978
        </para>
70e978
70e978
        <para>
70e978
            The <filename>init.sh</filename> file in 
70e978
            class="directory">trunk/Scripts/Bash/Cli/</filename>
70e978
            directory is the initialization script, written in Bash,
70e978
            used to automate most of tasks in the repository.
70e978
        </para>
70e978
70e978
        <para>
70e978
            The <command>centos-art</command> command uses the
70e978
            <filename>ImageMagick</filename> RPM package to convert
70e978
            images from PNG format to other formats.
70e978
        </para>
70e978
        </listitem>
70e978
        </varlistentry>
70e978
70e978
        <varlistentry>
70e978
        <term><keycap>key</keycap></term>
70e978
        <listitem>
70e978
        <para>
70e978
            A key on the keyboard is shown in this style.  For
70e978
            example:
70e978
        </para>
70e978
70e978
        <para>
70e978
            To use <keycap>Tab</keycap> completion to list particular
70e978
            files in a directory, type <command>ls</command>, then a
70e978
            character, and finally the <keycap>Tab</keycap> key. Your
70e978
            terminal displays the list of files in the working
70e978
            directory that begin with that character.
70e978
        </para>
70e978
        </listitem>
70e978
        </varlistentry>
70e978
70e978
        <varlistentry>
70e978
        <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term>
70e978
        <listitem>
70e978
        <para>
70e978
            A combination of keystrokes is represented in this way.
70e978
            For example: 
70e978
        </para>
70e978
70e978
        <para>
70e978
            The 
70e978
            action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo>
70e978
            key combination exits your graphical session and returns
70e978
            you to the graphical login screen or the console.
70e978
        </para> 
70e978
        </listitem> 
70e978
        </varlistentry>
70e978
70e978
        <varlistentry>
70e978
        <term><computeroutput>computer output</computeroutput></term>
70e978
        <listitem>
70e978
        <para>
70e978
            Text in this style indicates text displayed to a shell
70e978
            prompt such as error messages and responses to commands.
70e978
            For example, the <command>ls</command> command displays
70e978
            the contents of a directory using this style:
70e978
        </para>
70e978
70e978
<screen>
70e978
render_doTranslation.sh     render_getDirTemplate.sh    render_doBaseActions.sh
70e978
render_getConfigOption.sh   render_getOptions.sh        render_doThemeActions.sh  
70e978
render_getDirOutput.sh      render.sh
70e978
</screen>
70e978
70e978
        <para>
70e978
            The output returned in response to the command (in this
70e978
            case, the contents of the directory) is shown in this
70e978
            style.
70e978
        </para>
70e978
        </listitem>
70e978
        </varlistentry>
70e978
70e978
        <varlistentry>
70e978
        <term><prompt>prompt</prompt></term>
70e978
        <listitem>
70e978
        <para>
70e978
            A prompt, which is a computer's way of signifying that it
70e978
            is ready for you to input something, is shown in this
70e978
            style. Examples:
70e978
        </para>
70e978
70e978
        <itemizedlist>
70e978
        <listitem>
70e978
        <para>
70e978
            <prompt>$</prompt>
70e978
        </para>
70e978
        </listitem>
70e978
        <listitem>
70e978
        <para>
70e978
            <prompt>#</prompt>
70e978
        </para>
70e978
        </listitem>
70e978
        <listitem>
70e978
        <para>
70e978
            <prompt>[centos@projects centos]$</prompt>
70e978
        </para>
70e978
        </listitem>
70e978
        <listitem>
70e978
        <para>
70e978
            <prompt>projects login:</prompt>
70e978
        </para>
70e978
        </listitem>
70e978
        </itemizedlist>
70e978
        </listitem>
70e978
        </varlistentry>
70e978
70e978
        <varlistentry>
70e978
        <term><userinput>user input</userinput></term>
70e978
        <listitem>
70e978
        <para>
70e978
            Text that the user types, either on the command line or
70e978
            into a text box on a GUI screen, is displayed in this
70e978
            style. In the following example,
70e978
            <userinput>text</userinput> is displayed in this style: To
70e978
            boot your system into the text based installation program,
70e978
            you must type in the <userinput>text</userinput> command
70e978
            at the <prompt>boot:</prompt> prompt.
70e978
        </para>
70e978
        </listitem>
70e978
        </varlistentry>
70e978
70e978
        <varlistentry>
70e978
        <term><replaceable>replaceable</replaceable></term>
70e978
        <listitem>
70e978
        <para>
70e978
           Text used in examples that is meant to be replaced with
70e978
           data provided by the user is displayed in this style. In
70e978
           the following example,
70e978
           <replaceable>version-number</replaceable> is displayed in
70e978
           this style: The directory for the kernel source is
70e978
           
70e978
           class="directory">/usr/src/kernels/<replaceable>version-number</replaceable>/</filename>,
70e978
           where <replaceable>version-number</replaceable> is the
70e978
           version and type of kernel installed on this system. 
70e978
        </para>
70e978
        </listitem>
70e978
        </varlistentry>
70e978
    </variablelist>
70e978
70e978
    <para>Additionally, we use several different strategies to draw
70e978
    your attention to certain pieces of information. In order of
70e978
    urgency, these items are marked as a note, tip, important,
70e978
    caution, or warning. For example:</para>
70e978
70e978
    <note>
70e978
        <para>Remember that Linux is case sensitive. In other words, a
70e978
        rose is not a ROSE is not a rOsE.</para>
70e978
    </note> 
70e978
70e978
    <tip>
70e978
        <para>The directory 
70e978
        class="directory">/usr/share/doc/</filename> contains
70e978
        additional documentation for packages installed on your
70e978
        system.</para>
70e978
    </tip>
70e978
70e978
    <important>
70e978
        <para>If you modify the DHCP configuration file, the changes
70e978
        do not take effect until you restart the DHCP daemon.</para>
70e978
    </important>
70e978
70e978
    <caution>
70e978
        <para>Do not perform routine tasks as root — use a
70e978
        regular user account unless you need to use the root account
70e978
        for system administration tasks.</para>
70e978
    </caution>
70e978
70e978
    <warning>
70e978
        <para>Be careful to remove only the necessary partitions.
70e978
        Removing other partitions could result in data loss or a
70e978
        corrupted system environment.</para>
70e978
    </warning>
70e978
70e978
</section>