bundles/org.eclipse.pde.doc.user/guide/tools/editors/ctx_help_editor/ctx_help_editor.htm - platform/eclipse.platform.common - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
 	<head>
 		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 		<title>Context Help Editor</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>Context Help Editor</h2>

 <p>
 Context-sensitive help is a mechanism that enables linking a user interface part with a specific help topic.  When the user activates the associated user interface part, the help page is displayed in the dynamic help area.  The user interface and the help pages are associated with each other in two ways a static XML file or a dynamic context provider.  The context help editor assists in the creation of the context help XML files that statically associate help to the user interface.
 </p>
 <p>
 The <strong>Definition</strong> page of the editor provides a graphical view of the xml file, separated into two columns.  The one on the left is titled <strong>Context Help</strong> and displays the xml elements in a tree format along with actions to add, move and remove them.  The other column provides more detailed information about the element selected in the left column and enables editing of the details.
 </p>
 <ul>
 	<li>
 		<a href="#add-new-help">Adding new help contexts</a>
 	</li>
 	<li>
 		<a href="#add-help-command">Adding help topics and commands</a>
 	</li>
 	<li>
 		<a href="#remove-up-down">Remove, Up, Down commands</a>
 	</li>
 	<!-- <li>
 		<a href="#register">Register this context help</a>
 	</li> -->

 </ul>

 <a name="add-new-help"></a>
 <h3>Adding new help contexts</h3>

 <p>
 <img src="../../../images/ctx_help_editor/help_context_filled.png" alt="Help context editor with filled fields" border=0 height=265 width=708>
 </p>
 <p>
 When clicking the <strong>Add Context</strong> button a new context is added to the help context list.  As well as a <strong>Context Details</strong> column apears where more detailed information can be provided. Such as:
 </p>
 <ul>
   <li>A help context id</li>
   <li>A description of the help topic</li>
   <li>A custom page title (replacing the default one)</li>
 </ul>

 <p>
 <a name="add-help-command"></a>
 <h3>Adding help topics and commands</h3>
 <p>
 A help context topic gives a very short description about the provided help and most commonly gives a link to a more detailed help page.
 </p>
 <p>
 <img src="../../../images/ctx_help_editor/help_context_topic_details.png" alt="Help context editor with filled detail fields" border=0>
 </p>
 <p>
 In the <strong>Topic Details</strong> section the label of the topic as well as location of the page with more details (most commonly it would be a *.htm page).
 </p>

 <p>
 A help context command executes a specified action when the user clicks on it.
 </p>
 <p>
 <img src="../../../images/ctx_help_editor/help_context_command.png" alt="Help context editor add command" border=0>
 </p>

 <a name="Remove-up-down"></a>
 <h3>Remove, Up, Down</h3>
 <p>
 There are three buttons, which enable manipulating with the items order on the context list or with deleting the items.
 </p>
 <p>
 <img src="../../../images/ctx_help_editor/help_context_second_topic.png" alt="Help context with manipulating buttons" border=0>
 </p>
 <p>
 These buttons are:
 </p>
 <ul>
   <li><strong>Remove</strong> - removes an item from the list</li>
   <li><strong>Up</strong> moves up an item on the context list</li>
   <li><strong>Down</strong> moves down an item on the context list</li>
 </ul>

 <!--
 <a name="Register"></a>
 <h3>Register this context help</h3>

 Add this context help to the Help Infocenter.
 NOTE: This feature is to be added in the nearest future.
 -->

 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<html>
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
	<title>Context Help Editor</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>Context Help Editor</h2>

	<p>
	Context-sensitive help is a mechanism that enables linking a user interface part with a specific help topic. When the user activates the associated user interface part, the help page is displayed in the dynamic help area. The user interface and the help pages are associated with each other in two ways a static XML file or a dynamic context provider. The context help editor assists in the creation of the context help XML files that statically associate help to the user interface.
	</p>
	<p>
	The <strong>Definition</strong> page of the editor provides a graphical view of the xml file, separated into two columns. The one on the left is titled <strong>Context Help</strong> and displays the xml elements in a tree format along with actions to add, move and remove them. The other column provides more detailed information about the element selected in the left column and enables editing of the details.
	</p>
	<ul>
	<li>
	<a href="#add-new-help">Adding new help contexts</a>
	</li>
	<li>
	<a href="#add-help-command">Adding help topics and commands</a>
	</li>
	<li>
	<a href="#remove-up-down">Remove, Up, Down commands</a>
	</li>
	<!-- <li>
	<a href="#register">Register this context help</a>
	</li> -->

	</ul>

	<a name="add-new-help"></a>
	<h3>Adding new help contexts</h3>

	<p>
	<img src="../../../images/ctx_help_editor/help_context_filled.png" alt="Help context editor with filled fields" border=0 height=265 width=708>
	</p>
	<p>
	When clicking the <strong>Add Context</strong> button a new context is added to the help context list. As well as a <strong>Context Details</strong> column apears where more detailed information can be provided. Such as:
	</p>
	<ul>
	<li>A help context id</li>
	<li>A description of the help topic</li>
	<li>A custom page title (replacing the default one)</li>
	</ul>

	<p>
	<a name="add-help-command"></a>
	<h3>Adding help topics and commands</h3>
	<p>
	A help context topic gives a very short description about the provided help and most commonly gives a link to a more detailed help page.
	</p>
	<p>
	<img src="../../../images/ctx_help_editor/help_context_topic_details.png" alt="Help context editor with filled detail fields" border=0>
	</p>
	<p>
	In the <strong>Topic Details</strong> section the label of the topic as well as location of the page with more details (most commonly it would be a *.htm page).
	</p>

	<p>
	A help context command executes a specified action when the user clicks on it.
	</p>
	<p>
	<img src="../../../images/ctx_help_editor/help_context_command.png" alt="Help context editor add command" border=0>
	</p>

	<a name="Remove-up-down"></a>
	<h3>Remove, Up, Down</h3>
	<p>
	There are three buttons, which enable manipulating with the items order on the context list or with deleting the items.
	</p>
	<p>
	<img src="../../../images/ctx_help_editor/help_context_second_topic.png" alt="Help context with manipulating buttons" border=0>
	</p>
	<p>
	These buttons are:
	</p>
	<ul>
	<li><strong>Remove</strong> - removes an item from the list</li>
	<li><strong>Up</strong> moves up an item on the context list</li>
	<li><strong>Down</strong> moves down an item on the context list</li>
	</ul>

	<!--
	<a name="Register"></a>
	<h3>Register this context help</h3>

	Add this context help to the Help Infocenter.
	NOTE: This feature is to be added in the nearest future.
	-->

	</body>
	</html>