<?xml version="1.0"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>CentOS Artwork Repository: 1.4 Document Convenctions</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="description" content="CentOS Artwork Repository: 1.4 Document Convenctions" />
<meta name="keywords" content="CentOS Artwork Repository: 1.4 Document Convenctions" />
<meta name="resource-type" content="document" />
<meta name="distribution" content="global" />
<meta name="generator" content="texi2html 1.76" />
<meta name="copyright" content="2009-2011 Alain Reguera Delgado" />
<link href="/home/centos/artwork/trunk/Identity/Manual/repository.css" rel="stylesheet" type="text/css" media="screen projection" />
</head>
<body>
<a name="top" />
<div id="wrap">
<div id="page-body">
<div id="content">
<!-- Created on March, 30 2011 by texi2html 1.76 -->
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="repository_4.xhtml#SEC9" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="repository_6.xhtml#SEC11" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="repository_1.xhtml#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="repository_1.xhtml#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="repository_7.xhtml#SEC12" title="Next chapter"> >> </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="repository.xhtml#SEC_Top" title="Cover (top) of document">Top</a>]</td>
<td valign="middle" align="left">[<a href="repository_toc.xhtml#SEC_Contents" title="Table of contents">Contents</a>]</td>
<td valign="middle" align="left">[<a href="repository_80.xhtml#SEC416" title="Index">Index</a>]</td>
<td valign="middle" align="left">[<a href="repository_abt.xhtml#SEC_About" title="About (help)"> ? </a>]</td>
</tr></table>
<a name="Convenctions"></a>
<a name="SEC10"></a>
<h2 class="section"> 1.4 Document Convenctions </h2>
<p>In this manual the personal pronoun <em>we</em> is used to repesent
<em>The CentOS Artwork SIG</em>. This is, the group of persons building
the CentOS Artwork Repository.
</p>
<p>In this manual, certain words are represented in different fonts,
typefaces, sizes, and weights. This highlighting is systematic;
different words are represented in the same style to indicate their
inclusion in a specific category. The types of words that are
represented this way include the following:
</p>
<dl compact="compact">
<dt> <code>command</code></dt>
<dd>
<p>Linux commands (and other operating system commands, when used) are
represented this way. This style should indicate to you that you can
type the word or phrase on the command line and press Enter to invoke
a command. Sometimes a command contains words that would be displayed
in a different style on their own (such as file names). In these
cases, they are considered to be part of the command, so the entire
phrase is displayed as a command. For example:
</p>
<p>Use the <code>centos-art identity --render='path/to/dir'</code> command
to produce contents inside the <tt>`trunk/Identity'</tt> directory
structure.
</p></dd>
</dl>
<dl compact="compact">
<dt> <tt>`file name'</tt></dt>
<dd>
<p>File names, directory names, paths, and RPM package names are
represented this way. This style indicates that a particular file or
directory exists with that name on your system. Examples:
</p>
<p>The <tt>`init.sh'</tt> file in <tt>`trunk/Scripts/Bash/Cli/'</tt> directory is
the initialization script, written in Bash, used to automate most of
tasks in the repository.
</p>
<p>The <code>centos-art</code> command uses the <tt>`ImageMagick'</tt> RPM
package to convert images from PNG format to other formats.
</p></dd>
</dl>
<dl compact="compact">
<dt> <kbd><kbd>key</kbd></kbd></dt>
<dd>
<p>A key on the keyboard is shown in this style. For example:
</p>
<p>To use <kbd>TAB</kbd> completion to list particular files in a directory,
type <code>ls</code>, then a character, and finally the Tab key. Your
terminal displays the list of files in the working directory that
begin with that character.
</p></dd>
</dl>
<dl compact="compact">
<dt> <kbd><kbd>key-combination</kbd></kbd></dt>
<dd><p>A combination of keystrokes is represented in this way. For example:
</p>
<p>The <kbd>Ctrl-Alt-Backspace</kbd> key combination exits your graphical
session and returns you to the graphical login screen or the console.
</p></dd>
</dl>
<dl compact="compact">
<dt> <code><code>computer output</code></code></dt>
<dd>
<p>Text in this style indicates text displayed to a shell prompt such as
error messages and responses to commands. For example:
</p>
<p>The <code>ls</code> command displays the contents of a directory. For example:
</p>
<pre class="verbatim">Config manual_renameEntry.sh
manual_copyEntry.sh manual_restoreCrossReferences.sh
manual_deleteCrossReferences.sh manual_searchIndex.sh
</pre>
<p>The output returned in response to the command (in this case, the
contents of the directory) is shown in this style.
</p></dd>
</dl>
<p>Additionally, we use several different strategies to draw your
attention to certain pieces of information. In order of urgency, these
items are marked as a note, tip, important, caution, or warning. For
example:
</p>
<blockquote class="blue icon"><img src="/home/centos/artwork/trunk/Identity/Images/Webenv/icon-admonition-info.png" alt="Info" /><h3>Note</h3><p> Remember that Linux is case sensitive. In other words, a
rose is not a ROSE is not a rOsE.
</p></blockquote>
<blockquote class="orange icon"><img src="/home/centos/artwork/trunk/Identity/Images/Webenv/icon-admonition-idea.png" alt="Idea" /><h3>Tip</h3><p> The directory <tt>`/usr/share/doc/'</tt> contains additional
documentation for packages installed on your system.
</p></blockquote>
<blockquote class="orange icon"><img src="/home/centos/artwork/trunk/Identity/Images/Webenv/icon-admonition-star.png" alt="Important" /><h3>Important</h3><p> If you modify the DHCP configuration file, the
changes do not take effect until you restart the DHCP daemon.
</p></blockquote>
<blockquote class="orange icon"><img src="/home/centos/artwork/trunk/Identity/Images/Webenv/icon-admonition-attention.png" alt="Caution" /><h3>Caution</h3><p> Do not perform routine tasks as root -- use a
regular user account unless you need to use the root account for
system administration tasks.
</p></blockquote>
<blockquote class="orange icon"><img src="/home/centos/artwork/trunk/Identity/Images/Webenv/icon-admonition-alert.png" alt="Warning" /><h3>Warning</h3><p> Be careful to remove only the necessary partitions.
Removing other partitions could result in data loss or a corrupted
system environment.
</p></blockquote>
<div class="page-line white"><hr style="display:none;" /></div>
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="repository_4.xhtml#SEC9" title="Previous section in reading order"> < </a>]</td>
<td valign="middle" align="left">[<a href="repository_6.xhtml#SEC11" title="Next section in reading order"> > </a>]</td>
<td valign="middle" align="left"> </td>
<td valign="middle" align="left">[<a href="repository_1.xhtml#SEC1" title="Beginning of this chapter or previous chapter"> << </a>]</td>
<td valign="middle" align="left">[<a href="repository_1.xhtml#SEC1" title="Up section"> Up </a>]</td>
<td valign="middle" align="left">[<a href="repository_7.xhtml#SEC12" title="Next chapter"> >> </a>]</td>
</tr></table>
<div class="page-line"><hr style="display:none;" /></div>
</div>
</div>
<div class="page-line white"><hr style="display:none;" /></div>
</div>
</body>
</html>