View | Details | Raw Unified | Return to bug 215848 | Differences between
and this patch

Collapse All | Expand All

(-)contexts_PDE.xml (-1 / +5 lines)
Lines 782-788 Link Here
782
<!-- Editor Outline -->
782
<!-- Editor Outline -->
783
	<context id="outline_sort_action">
783
	<context id="outline_sort_action">
784
		<description>This action sorts elements in the Outline View.</description>
784
		<description>This action sorts elements in the Outline View.</description>
785
	</context>		
785
	</context>
786
 <context id="ctx_help_editor" title="Context Help Editor">
787
    <description>This editor helps to create a context help XML file. And enables to edit context details.</description>
788
    <topic href="guide/tools/editors/ctx_help_editor/editor.htm" label="Using Content Help Editor"/>
789
 </context>		
786
790
787
</contexts>
791
</contexts>
788
792
(-)toc.xml (+4 lines)
Lines 129-134 Link Here
129
      			<topic label="Table of Contents Page" href="guide/tools/editors/toc_editor/page_toc.htm"/>
129
      			<topic label="Table of Contents Page" href="guide/tools/editors/toc_editor/page_toc.htm"/>
130
      			<topic label="Register Table of Contents Wizard" href="guide/tools/editors/toc_editor/wizard_register-toc.htm"/>
130
      			<topic label="Register Table of Contents Wizard" href="guide/tools/editors/toc_editor/wizard_register-toc.htm"/>
131
	  	    </topic>
131
	  	    </topic>
132
      <topic href="guide/tools/editors/ctx_help_editor/editor.htm" label="Context Help Editor">
133
         <topic href="guide/tools/editors/ctx_help_editor/editor.htm" label="Context Help">
134
         </topic>
135
      </topic>
132
		</topic>
136
		</topic>
133
		<topic label="Launchers" href="guide/tools/launchers/launchers.htm">
137
		<topic label="Launchers" href="guide/tools/launchers/launchers.htm">
134
			<topic label="Eclipse Application Launcher" href="guide/tools/launchers/eclipse_application_launcher.htm">
138
			<topic label="Eclipse Application Launcher" href="guide/tools/launchers/eclipse_application_launcher.htm">
(-)guide/tools/editors/ctx_help_editor/editor.htm (+67 lines)
Added Link Here
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2
"http://www.w3.org/TR/html4/loose.dtd">
3
<html>
4
<head>
5
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6
<title>Context Help Editor</title>
7
<link href="../../../book.css" rel="stylesheet" type="text/css">
8
<style type="text/css">
9
<!--
10
.style1 {
11
        font-size: 18px;
12
        font-weight: bold;
13
}
14
-->
15
</style>
16
</head>
17
18
<body>
19
<p class="style1">Context Help Editor</p>
20
21
Context-sensitive help is a mechanism that enables linking a user interface part with a specific help topic. It is then activated by a specific previously defined trigger. Such triggers can be associated with widgets statically using context IDs, or dynamically using context providers. The association made with statical context IDs is stored in an XML file, which can be accessed and edited by Context Help Editor.
22
23
On the <p class="style2">Definition</p> page of the editor there are two columns. The one on the left is titled <p class="style2">Context help</p> and stores all context help related information. The other one (on the right side) stores and enables editing detailed information about selected items from the context list (left column).
24
25
Above there is a brief overview of available commands
26
27
<p class="style2">Adding new help context</p>
28
<img src="../../../images/ctx_help_editor/help_context_filled.png" alt="help context editor with fulfilled fields" border=0 height=265 width=708> <br />
29
When clicking the <p class="style2">Add Context</p> button a new context is added to the help context list.  As well as a <p class="style2">Context details</p> column apears where more detailed information can be provided. Such as:
30
<ul>
31
  <li>help context id</li>
32
  <li>context description which is to be presented to the user</li>
33
  <li>if needed giving a custom title (replacing the default one)</li>
34
</ul>
35
 
36
37
<p class="style2">Adding help command</p>
38
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.
39
<img src="../../../images/ctx_help_editor/help_context_topic_details.png" alt="help context editor with fulfilled fields" border=0><br />
40
41
In the <p class="style2">Topic Details</p> section the label of the topic as well as location of the page with more details (most commonly it would be a *.htm page).
42
43
44
<td valign="center">Add command</td>
45
Help context enables to define which command to exacute. It also asks for providing an appriopriate label for it.
46
<img src="../../../images/ctx_help_editor/help_context_command.png" alt="help context editor add command" border=0><br />
47
48
49
<p class="style2">Remove, Up, Down</p>
50
There are three buttons, which enable manipulating with the items order on the context list or with deleting the items. 
51
<img src="../../../images/ctx_help_editor/help_context_second_topic.png" alt="help context with manipulating buttons" border=0><br />
52
These buttons are:
53
<ul>
54
  <li><strong>Remove</strong> - removes an item from the list</li>
55
  <li><strong>Up</strong> moves up an item on the context list</li>
56
  <li><strong>Down</strong> moves down an item on the context list</li>
57
</ul>
58
 
59
<p>For additional information, refer to the following document:</p>
60
<ul>
61
  <li><a href="../toc_editor/page_toc.htm">Table of Contents Editor</a></li>  
62
</ul>
63
64
<p>&nbsp;</p>
65
<p>&nbsp;</p>
66
</body>
67
</html>
(-)guide/tools/editors/ctx_help_editor/page_ctx_help.htm (+29 lines)
Added Link Here
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2
"http://www.w3.org/TR/html4/loose.dtd">
3
<html>
4
<head>
5
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
6
<title>Context Help Editor Page</title>
7
<link href="../../../book.css" rel="stylesheet" type="text/css">
8
<style type="text/css">
9
<!--
10
.style1 {
11
        font-size: 18px;
12
        font-weight: bold;
13
}
14
.style2 {
15
        font-size: 12pt;
16
        font-weight: bold;
17
}
18
-->
19
</style>
20
</head>
21
22
<body>
23
<p class="style1"><strong>Context Help Editor</strong></p>
24
<p>The Context Help Editor is a form-based editor  that manages the <em>XML</em> file in which context help contexts, topics and commands are managed.</p>
25
26
<p>&nbsp;</p>
27
<p>&nbsp;</p>
28
</body>
29
</html>

Return to bug 215848