PageRenderTime 30ms CodeModel.GetById 17ms app.highlight 6ms RepoModel.GetById 2ms app.codeStats 0ms

/protocols/asn/docs/sources/src/main/resources/en-US/common/Section-Conventions.xml

http://mobicents.googlecode.com/
XML | 172 lines | 159 code | 13 blank | 0 comment | 0 complexity | d6fe95a37a1eddb9d9feab580025109e MD5 | raw file
  1<?xml version='1.0' encoding='utf-8' ?>
  2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  3]>
  4
  5<section>
  6	<title>Document Conventions</title>
  7	<para>
  8		This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.
  9	</para>
 10	<para>
 11		In PDF and paper editions, this manual uses typefaces drawn from the <ulink url="https://fedorahosted.org/liberation-fonts/">Liberation Fonts</ulink> set. The Liberation Fonts set is also used in HTML editions if the set is installed on your system. If not, alternative but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later includes the Liberation Fonts set by default.
 12	</para>
 13	<section>
 14		<title>Typographic Conventions</title>
 15		<para>
 16			Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.
 17		</para>
 18		<para>
 19			<literal>Mono-spaced Bold</literal>
 20		</para>
 21		<para>
 22			Used to highlight system input, including shell commands, file names and paths. Also used to highlight key caps and key-combinations. For example:
 23		</para>
 24		<blockquote>
 25			<para>
 26				To see the contents of the file <filename>my_next_bestselling_novel</filename> in your current working directory, enter the <command>cat my_next_bestselling_novel</command> command at the shell prompt and press <keycap>Enter</keycap> to execute the command.
 27			</para>
 28		</blockquote>
 29		<para>
 30			The above includes a file name, a shell command and a key cap, all presented in Mono-spaced Bold and all distinguishable thanks to context.
 31		</para>
 32		<para>
 33			Key-combinations can be distinguished from key caps by the hyphen connecting each part of a key-combination. For example:
 34		</para>
 35		<blockquote>
 36			<para>
 37				Press <keycap>Enter</keycap> to execute the command.
 38			</para>
 39			<para>
 40				Press <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>F1</keycap></keycombo> to switch to the first virtual terminal. Press <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap><keycap>F7</keycap></keycombo> to return to your X-Windows session.
 41			</para>
 42		</blockquote>
 43		<para>
 44			The first sentence highlights the particular key cap to press. The second highlights two sets of three key caps, each set pressed simultaneously.
 45		</para>
 46		<para>
 47			If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in <literal>Mono-spaced Bold</literal>. For example:
 48		</para>
 49		<blockquote>
 50			<para>
 51				File-related classes include <classname>filesystem</classname> for file systems, <classname>file</classname> for files, and <classname>dir</classname> for directories. Each class has its own associated set of permissions.
 52			</para>
 53		</blockquote>
 54		<para>
 55			<application>Proportional Bold</application>
 56		</para>
 57		<para>
 58			This denotes words or phrases encountered on a system, including application names; dialogue box text; labelled buttons; check-box and radio button labels; menu titles and sub-menu titles. For example:
 59		</para>
 60		<blockquote>
 61			<para>
 62				Choose <guimenu>System &gt; Preferences &gt; Mouse</guimenu> from the main menu bar to launch <application>Mouse Preferences</application>. In the <guilabel>Buttons</guilabel> tab, click the <guilabel>Left-handed mouse</guilabel> check box and click <guibutton>Close</guibutton> to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand).
 63			</para>
 64			<para>
 65				To insert a special character into a <application>gedit</application> file, choose <guimenu>Applications &gt; Accessories &gt; Character Map</guimenu> from the main menu bar. Next, choose <guimenu>Search &gt; Find&hellip;</guimenu> from the <application>Character Map</application> menu bar, type the name of the character in the <guilabel>Search</guilabel> field and click <guibutton>Next</guibutton>. The character you sought will be highlighted in the <guilabel>Character Table</guilabel>. Double-click this highlighted character to place it in the <guilabel>Text to copy</guilabel> field and then click the <guibutton>Copy</guibutton> button. Now switch back to your document and choose <guimenu>Edit &gt; Paste</guimenu> from the <application>gedit</application> menu bar.
 66			</para>
 67		</blockquote>
 68		<para>
 69			The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in Proportional Bold and all distinguishable by context.
 70		</para>
 71		<para>
 72			Note the <guimenu>&gt;</guimenu> shorthand used to indicate traversal through a menu and its sub-menus. This is to avoid the difficult-to-follow &#39;Select <guimenuitem>Mouse</guimenuitem> from the <guimenu>Preferences</guimenu> sub-menu in the <guimenu>System</guimenu> menu of the main menu bar&#39; approach.
 73		</para>
 74		<para>
 75			<command><replaceable>Mono-spaced Bold Italic</replaceable></command> or <application><replaceable>Proportional Bold Italic</replaceable></application>
 76		</para>
 77		<para>
 78			Whether Mono-spaced Bold or Proportional Bold, the addition of Italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:
 79		</para>
 80		<blockquote>
 81			<para>
 82				To connect to a remote machine using ssh, type <command>ssh <replaceable>username</replaceable>@<replaceable>domain.name</replaceable></command> at a shell prompt. If the remote machine is <filename>example.com</filename> and your username on that machine is john, type <command>ssh john@example.com</command>.
 83			</para>
 84			<para>
 85				The <command>mount -o remount <replaceable>file-system</replaceable></command> command remounts the named file system. For example, to remount the <filename>/home</filename> file system, the command is <command>mount -o remount /home</command>.
 86			</para>
 87			<para>
 88				To see the version of a currently installed package, use the <command>rpm -q <replaceable>package</replaceable></command> command. It will return a result as follows: <command><replaceable>package-version-release</replaceable></command>.
 89			</para>
 90		</blockquote>
 91		<para>
 92			Note the words in bold italics above &mdash; username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.
 93		</para>
 94		<para>
 95			Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:
 96		</para>
 97		<blockquote>
 98			<para>
 99				When the Apache HTTP Server accepts requests, it dispatches child processes or threads to handle them. This group of child processes or threads is known as a <firstterm>server-pool</firstterm>. Under Apache HTTP Server 2.0, the responsibility for creating and maintaining these server-pools has been abstracted to a group of modules called <firstterm>Multi-Processing Modules</firstterm> (<firstterm>MPMs</firstterm>). Unlike other modules, only one module from the MPM group can be loaded by the Apache HTTP Server.
100			</para>
101		</blockquote>
102	</section>
103	
104	<section>
105		<title>Pull-quote Conventions</title>
106		<para>
107			Two, commonly multi-line, data types are set off visually from the surrounding text.
108		</para>
109		<para>
110			Output sent to a terminal is set in <computeroutput>Mono-spaced Roman</computeroutput> and presented thus:
111		</para>
112		
113<screen>
114books        Desktop   documentation  drafts  mss    photos   stuff  svn
115books_tests  Desktop1  downloads      images  notes  scripts  svgs
116</screen>
117		<para>
118			Source-code listings are also set in <computeroutput>Mono-spaced Roman</computeroutput> but are presented and highlighted as follows:
119		</para>
120		
121<programlisting language="java">
122package org.jboss.book.jca.ex1;
123
124import javax.naming.InitialContext;
125
126public class ExClient
127{
128   public static void main(String args[]) 
129       throws Exception
130   {
131      InitialContext iniCtx = new InitialContext();
132      Object         ref    = iniCtx.lookup("EchoBean");
133      EchoHome       home   = (EchoHome) ref;
134      Echo           echo   = home.create();
135
136      System.out.println("Created Echo");
137
138      System.out.println("Echo.echo(&#39;Hello&#39;) = " + echo.echo("Hello"));
139   }
140   
141}
142</programlisting>
143	</section>
144	
145	<section>
146		<title>Notes and Warnings</title>
147		<para>
148			Finally, we use three visual styles to draw attention to information that might otherwise be overlooked.
149		</para>
150		<note>
151			<title>Note</title>
152			<para>
153				A note is a tip or shortcut or alternative approach to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier.
154			</para>
155		</note>
156		<important>
157			<title>Important</title>
158			<para>
159				Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring Important boxes won&#39;t cause data loss but may cause irritation and frustration.
160			</para>
161		</important>
162		<warning>
163			<title>Warning</title>
164			<para>
165				A Warning should not be ignored. Ignoring warnings will most likely cause data loss.
166			</para>
167		</warning>
168	</section>
169
170</section>
171
172