content/dev_docs/source/conventions.html

<html><head>
<meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
</head>
<body>
<STYLE>
<!--
KBD {font-weight: bold;}
VAR {font-style: italic;}

-->

</STYLE>




<H1>Documentation Conventions</H1>
<P>The following conventions are used in the build documents on this site:</P>

	
		
			
			<TABLE BORDER=1 BORDERCOLOR="#000000" CELLPADDING=5 CELLSPACING=0>
				
				<THEAD>
					<TR VALIGN=TOP>
						<TH BGCOLOR="#c0c0c0">
							Convention
						</TH>
						<TH BGCOLOR="#c0c0c0">
							Description
						</TH>
					</TR>
				</THEAD>
				<TBODY>
					<TR VALIGN=TOP>
						<TD>
							<B>boldface type</B>
						</TD>
						<TD>
							Boldface type indicates an item that is contained in the
							glossary. 
							
						</TD>
					</TR>
					<TR VALIGN=TOP>
						<TD>
							<CODE>monospace
							type</CODE>
						</TD>
						<TD>
							Monospace type indicates the
							following: 
							
							<UL TYPE=DISC>
								<LI>Filenames</LI>
								<LI>Macros</LI>
								<LI>CVS module names</LI>
								<LI>Tools</LI>
							</UL>
						</TD>
					</TR>
					<TR VALIGN=TOP>
						<TD>
							<KBD>monospace,
							bold type</KBD>
						</TD>
						<TD>
							Monospace bold type indicates
							user input on a command line.
						</TD>
					</TR>
					<TR VALIGN=TOP>
						<TD>
							<CODE>%</CODE>
						</TD>
						<TD>
							Represents a Linux or Solaris
							system prompt, regardless of what the current shell is. 
							
						</TD>
					</TR>
					<TR VALIGN=TOP>
						<TD>
							<CODE>C:\&gt;</CODE>
						</TD>
						<TD>
							Represents a Win32 command
							prompt. 
						</TD>
					</TR>
					<TR VALIGN=TOP>
						<TD>
							<I>italic type</I>
						</TD>
						<TD>
							<P>Italic type indicates a variable value where you enter a
							value appropriate to your circumstances. The following example
							indicates to change directory to the module
							that you want to work on: </P>
							
							<P><CODE>%</CODE> <KBD>cd</KBD> <VAR>module-name</VAR></P>
							<P>Italic type also indicates complete titles of manuals and
							emphasized text. 
							</P>
						</TD>
					</TR>
					<TR VALIGN=TOP>
						<TD>
							UPPERCASE
						</TD>
						<TD>
							Uppercase letters indicate abbreviations of known entities
							such as JDK. 
							
						</TD>
					</TR>
				</TBODY>
			</TABLE>
		</html>