Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
	<head>
	<meta name="copyright" content="Copyright (c) IBM Corporation and others 2007, 2009. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<title>Help Section</title>
		<link rel="STYLESHEET" href="../../../../book.css" type="text/css">
		<link rel="STYLESHEET" href="../../../tweak.css" type="text/css">
		<script language="JavaScript" type="text/javascript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
	</head>
	<body>
		<h2>Help Section</h2>
		
		<h3>About This Section</h3>

		<p>
			This collapsible section allows you to do the following:
		</p>

		<ul>
			<li>
				Add a help link to a step or introduction using either a help document link 
				or help context ID as input.
			</li>
			<li>
				Remove a help link from a step or introduction.
			</li>
			<li>
				Edit the help document link or help context 
				ID used as input to add a help link to a step or introduction.
			</li>
		</ul>

		<p>
			This section is accessible by selecting a step or introduction node in the <strong>Content</strong> section.
		</p>

		<img src="../../../images/simple_cs_editor/section_step_master_1.png" alt="Step Content Section">

		<h3>Section Fields</h3>

		<p>
			This section contains the following fields:
		</p>

		<table cellspacing="0">
			<tr>
				<td class="header">
					Label
				</td>
				<td class="header">
					Type
				</td>
				<td class="header">
					Name
				</td>
				<td class="header">
					Description
				</td>
				<td class="header">
					Required
				</td>					
			</tr>
			<tr>
				<td class="body">
					<strong>Type</strong>
				</td>
				<td class="body">
					Combo Box
				</td>
				<td class="body">
					Help Link Type
				</td>
				<td class="body">
					Select <strong>&lt;none&gt;</strong> to remove a help
					link from a step or introduction.  
					Consequently, the <strong>Value</strong> input field 
					will no longer be visible.
					<br>
					<br>
					Select <strong>Help Context ID</strong> to make the 
					<strong>Value</strong> input field visible right under
					this field and ready to accept a help context ID as input.
					<br>
					<br>
					Select <strong>Help Document Link</strong> to make the 
					<strong>Value</strong> input field visible right under
					this field and ready to accept a help document link as input.
				</td>
				<td class="body">
					No
				</td>				
			</tr>		
			<tr>
				<td class="body">
					<strong>Value</strong>
				</td>
				<td class="body">
					Text
				</td>
				<td class="body">
					Help Document Link Value or Help Context ID Value
				</td>
				<td class="body">
					If <strong>Help Context ID</strong> is selected in the
					<strong>Type</strong> field, specify a valid help
					context ID in this field to add a help link to a step
					or introduction.
					<br>
					<br>
					In the <strong>Cheat Sheet</strong> view, 
					clicking on a step or introduction's help link created
					using a help context ID will open that help
					context ID in the <strong>Help</strong> view.
					<br>
					<br>
					The format of a valid help context ID is the following:
					<em>&lt;plugin-id&gt;.&lt;help-context-id&gt;</em>
					<br>
					<br>
					If <strong>Help Document Link</strong> is selected in the
					<strong>Type</strong> field, specify a valid help
					document link in this field to add a help link to a step
					or introduction.
					<br>
					<br>
					In the <strong>Cheat Sheet</strong> view, 
					clicking on a step or introduction's help link created
					using a help document link will open that help
					document link in the <strong>Help</strong> Infocenter.
					<br>
					<br>
					The format of a valid help document link is the following:
					<em>/&lt;plugin-id&gt;/&lt;path&gt;/&lt;html-file&gt;</em>									
				</td>
				<td class="body">
					No
				</td>				
			</tr>						
		</table>

		<p>
			Example of a help link removed from a step or introduction.
			Note:  This section is collapsed by default when no help context ID or 
			help document link is specified.
		</p>

		<img src="../../../images/simple_cs_editor/section_help_details_none.png" alt="Definition Section: None">

		<p>
			Example of a help link added to a step or introduction defined using a help context ID as input.
			Note:  This section is expanded by default when a help context ID is specified.
		</p>

		<img src="../../../images/simple_cs_editor/section_help_details_id.png" alt="Definition Section: Help Context ID">

		<p>
			Example of a help link added to a step or introduction defined using a help document link as input.
			Note:  This section is expanded by default when a help document link is specified.
		</p>

		<img src="../../../images/simple_cs_editor/section_help_details_link.png" alt="Definition Section: Help Document Link">

		<h3>Representation</h3>

		<p>
			An introduction with a help link and various steps with help links are 
			represented in the <strong>Cheat Sheet</strong> view as follows:
		</p>

		<img src="../../../images/simple_cs_editor/section_title_view.png" alt="Title Cheat Sheet View">

		<p>
			Note:  A help link created using a help context ID is 
			indistinguishable from one created using a help document link
			in the <strong>Cheat Sheet</strong> view.
		</p>

		<h3>Relevant Links</h3>

		<ul>
			<li>
				<a href="section_content.htm">Content Section</a>
			</li>
			<li>
				<a href="section_step.htm">Step Section</a>
			</li>
			<li>
				<a href="section_introduction.htm">Introduction Section</a>
			</li>
		</ul>

	</body>
</html>
New to GrepCode? Check out our FAQ X