Blame Documentation/Models/Preface/docconvs.docbook

ffe42d
<section id="preface-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>
8d257f
        <term><command>command</command></term>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            Linux commands (and other operating system commands, when
8d257f
            used) are represented this way.  This style should
8d257f
            indicate to you that you can type the word or phrase on
8d257f
            the command line and press <keycap>Enter</keycap> to
8d257f
            invoke a command.  Sometimes a command contains words that
8d257f
            would be displayed in a different style on their own (such
8d257f
            as file names). In these cases, they are considered to be
8d257f
            part of the command, so the entire phrase is displayed as
8d257f
            a command.  For example:
8d257f
        </para>
8d257f
8d257f
        <para>
8d257f
            Use the <command>centos-art render
8d257f
            trunk/Identity/Images/Themes/TreeFlower/4/Distro/5/Anaconda
8d257f
            --filter="01-welcome"</command> command to produce the first
8d257f
            slide image used by Anaconda in the branch 5 of &TC;;
8d257f
            using the version 4 of TreeFlower artistic motif.
8d257f
        </para>
8d257f
        </listitem>
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
8d257f
        <term><filename>file name</filename></term>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            File names, directory names, paths, and RPM package names
8d257f
            are represented this way. This style indicates that a
8d257f
            particular file or directory exists with that name on your
8d257f
            system. Examples:
8d257f
        </para>
8d257f
8d257f
        <para>
8d257f
            The <filename>init.sh</filename> file in 
8d257f
            class="directory">trunk/Scripts/Bash/Cli/</filename>
8d257f
            directory is the initialization script, written in Bash,
8d257f
            used to automate most of tasks in the repository.
8d257f
        </para>
8d257f
8d257f
        <para>
8d257f
            The <command>centos-art</command> command uses the
8d257f
            <filename>ImageMagick</filename> RPM package to convert
8d257f
            images from PNG format to other formats.
8d257f
        </para>
8d257f
        </listitem>
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
8d257f
        <term><keycap>key</keycap></term>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            A key on the keyboard is shown in this style.  For
8d257f
            example:
8d257f
        </para>
8d257f
8d257f
        <para>
8d257f
            To use <keycap>Tab</keycap> completion to list particular
8d257f
            files in a directory, type <command>ls</command>, then a
8d257f
            character, and finally the <keycap>Tab</keycap> key. Your
8d257f
            terminal displays the list of files in the working
8d257f
            directory that begin with that character.
8d257f
        </para>
8d257f
        </listitem>
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
8d257f
        <term><keycombo action="simul"><keycap>key</keycap><keycap>combination</keycap></keycombo></term>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            A combination of keystrokes is represented in this way.
8d257f
            For example: 
8d257f
        </para>
8d257f
8d257f
        <para>
8d257f
            The 
8d257f
            action="simul"><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>Backspace</keycap></keycombo>
8d257f
            key combination exits your graphical session and returns
8d257f
            you to the graphical login screen or the console.
8d257f
        </para> 
8d257f
        </listitem> 
9a2c27
        </varlistentry>
9a2c27
9a2c27
        <varlistentry>
8d257f
        <term><computeroutput>computer output</computeroutput></term>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            Text in this style indicates text displayed to a shell
8d257f
            prompt such as error messages and responses to commands.
8d257f
            For example, the <command>ls</command> command displays
8d257f
            the contents of a directory using this style:
8d257f
        </para>
8d257f
8d257f
<screen>
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
8d257f
</screen>
e935c3
8d257f
        <para>
8d257f
            The output returned in response to the command (in this
8d257f
            case, the contents of the directory) is shown in this
8d257f
            style.
8d257f
        </para>
9a2c27
        </listitem>
8d257f
        </varlistentry>
9a2c27
8d257f
        <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:
8d257f
        </para>
9a2c27
8d257f
        <itemizedlist>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            <prompt>$</prompt>
8d257f
        </para>
8d257f
        </listitem>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            <prompt>#</prompt>
9a2c27
        </para>
9a2c27
        </listitem>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            <prompt>[centos@projects centos]$</prompt>
8d257f
        </para>
8d257f
        </listitem>
8d257f
        <listitem>
8d257f
        <para>
8d257f
            <prompt>projects login:</prompt>
8d257f
        </para>
8d257f
        </listitem>
8d257f
        </itemizedlist>
8d257f
        </listitem>
8d257f
        </varlistentry>
9a2c27
8d257f
        <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>
8d257f
        </varlistentry>
9a2c27
8d257f
        <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>
8d257f
        </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
de4714
</section>