Blame Documentation/Manuals/Docbook/Tcar-ug/Preface/docconvs.docbook

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