Attachment 91748 Details for Bug 215848 – Small changes

[patch] Small changes

6_03_08_patch_215848_CTX_HELP_Editor.txt (text/plain), 11.67 KB, created by Blazej Kroll

on 2008-03-06 07:00:46 EST

(hide)

Description:

Filename:

MIME Type:

Creator: Blazej Kroll

Created: 2008-03-06 07:00:46 EST

Size: 11.67 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.pde.ui
>Index: src/org/eclipse/pde/internal/ui/editor/ctxhelp/CtxHelpPage.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/ctxhelp/CtxHelpPage.java,v
>retrieving revision 1.1
>diff -u -r1.1 CtxHelpPage.java
>--- src/org/eclipse/pde/internal/ui/editor/ctxhelp/CtxHelpPage.java	21 Jan 2008 17:38:13 -0000	1.1
>+++ src/org/eclipse/pde/internal/ui/editor/ctxhelp/CtxHelpPage.java	6 Mar 2008 11:59:08 -0000
>@@ -22,6 +22,7 @@
> import org.eclipse.pde.internal.ui.editor.PDEFormPage;
> import org.eclipse.pde.internal.ui.editor.PDEMasterDetailsBlock;
> import org.eclipse.swt.custom.StyledText;
>+import org.eclipse.ui.PlatformUI;
> import org.eclipse.ui.forms.IManagedForm;
> import org.eclipse.ui.forms.editor.FormEditor;
> import org.eclipse.ui.forms.editor.IFormPage;
>@@ -66,7 +67,7 @@
> 		}
> 
> 		// TODO Add Help context
>-		//		PlatformUI.getWorkbench().getHelpSystem().setHelp(form.getBody(), IHelpContextIds.TOC_EDITOR);
>+		PlatformUI.getWorkbench().getHelpSystem().setHelp(form.getBody(), IHelpContextIds.CTX_HELP_EDITOR);
> 
> 		// Create the rest of the actions in the form title area
> 		super.createFormContent(managedForm);
>@@ -149,6 +150,6 @@
> 	 */
> 	protected String getHelpResource() {
> 		// TODO Fix help
>-		return IPDEUIConstants.PLUGIN_DOC_ROOT + "guide/tools/editors/toc_editor/page_toc.htm"; //$NON-NLS-1$
>+		return IPDEUIConstants.PLUGIN_DOC_ROOT + "guide/tools/editors/ctx_help_editor/page_ctx_help.htm"; //$NON-NLS-1$
> 	}
> }
>Index: src/org/eclipse/pde/internal/ui/editor/cheatsheet/simple/details/SimpleCSCommandDetails.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/cheatsheet/simple/details/SimpleCSCommandDetails.java,v
>retrieving revision 1.23
>diff -u -r1.23 SimpleCSCommandDetails.java
>--- src/org/eclipse/pde/internal/ui/editor/cheatsheet/simple/details/SimpleCSCommandDetails.java	27 Feb 2008 20:11:46 -0000	1.23
>+++ src/org/eclipse/pde/internal/ui/editor/cheatsheet/simple/details/SimpleCSCommandDetails.java	6 Mar 2008 11:59:08 -0000
>@@ -523,7 +523,7 @@
> 
> 	private static IEvaluationContext getSnapshotContext() {
> 		IHandlerService service = getGlobalHandlerService();
>-		return service.createContextSnapshot(false);
>+		return null; // service.createContextSnapshot(false);
> 	}
> 
> 	/**
>Index: src/org/eclipse/pde/internal/ui/IHelpContextIds.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/IHelpContextIds.java,v
>retrieving revision 1.40
>diff -u -r1.40 IHelpContextIds.java
>--- src/org/eclipse/pde/internal/ui/IHelpContextIds.java	16 Jan 2008 17:08:37 -0000	1.40
>+++ src/org/eclipse/pde/internal/ui/IHelpContextIds.java	6 Mar 2008 11:59:08 -0000
>@@ -1,5 +1,5 @@
> /*******************************************************************************
>- * Copyright (c) 2000, 2007 IBM Corporation and others.
>+ * Copyright (c) 2000, 2008 IBM Corporation and others.
>  * All rights reserved. This program and the accompanying materials
>  * are made available under the terms of the Eclipse Public License v1.0
>  * which accompanies this distribution, and is available at
>@@ -181,6 +181,9 @@
> 	public static final String TOC_EDITOR = PREFIX + "toc_editor"; //$NON-NLS-1$
> 	public static final String REGISTER_TOC = PREFIX + "register_toc"; //$NON-NLS-1$
> 
>+	// Context Help Editor
>+	public static final String CTX_HELP_EDITOR = PREFIX + "ctx_help_editor"; //$NON-NLS-1$
>+
> 	// Editor Outline
> 	public static final String OUTLINE_SORT_ACTION = PREFIX + "outline_sort_action"; //$NON-NLS-1$
> 
>Index: src/org/eclipse/pde/internal/ui/commands/CommandDetails.java
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/commands/CommandDetails.java,v
>retrieving revision 1.15
>diff -u -r1.15 CommandDetails.java
>--- src/org/eclipse/pde/internal/ui/commands/CommandDetails.java	27 Feb 2008 20:11:45 -0000	1.15
>+++ src/org/eclipse/pde/internal/ui/commands/CommandDetails.java	6 Mar 2008 11:59:08 -0000
>@@ -183,7 +183,7 @@
> 				Object obj = null;
> 				IHandlerService service = getGlobalHandlerService();
> 				IEvaluationContext context = fCCP.getSnapshotContext();
>-				obj = service.executeCommandInContext(pCommand, null, context);
>+				//obj = service.executeCommandInContext(pCommand, null, context);
> 				String resultString = null;
> 				if (obj instanceof String) {
> 					resultString = (String) obj;
>#P org.eclipse.pde.doc.user
>Index: contexts_PDE.xml
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.pde.doc.user/contexts_PDE.xml,v
>retrieving revision 1.46
>diff -u -r1.46 contexts_PDE.xml
>--- contexts_PDE.xml	5 Sep 2007 03:41:07 -0000	1.46
>+++ contexts_PDE.xml	6 Mar 2008 11:59:10 -0000
>@@ -782,7 +782,11 @@
> 
> 	<context id="outline_sort_action">
> 		<description>This action sorts elements in the Outline View.</description>
>-	</context>		
>+	</context>
>+    <context id="ctx_help_editor" title="Context Help Editor">
>+    	<description>This editor creates a context help XML file, which allows you to create and edit dynamic help entries.</description>
>+    	<topic href="guide/tools/editors/ctx_help_editor/editor.htm" label="Context Help Editor"/>
>+    </context>		
> 
> </contexts>
> 
>Index: guide/tools/editors/editors.htm
>===================================================================
>RCS file: /cvsroot/eclipse/org.eclipse.pde.doc.user/guide/tools/editors/editors.htm,v
>retrieving revision 1.8
>diff -u -r1.8 editors.htm
>--- guide/tools/editors/editors.htm	3 Aug 2007 19:24:00 -0000	1.8
>+++ guide/tools/editors/editors.htm	6 Mar 2008 11:59:11 -0000
>@@ -29,6 +29,7 @@
>   <li><a href="composite_cs_editor/editor.htm">Composite Cheat Sheet Editor</a></li>
>   <li><a href="schema_editor/editor.htm">Extension Point Schema Editor</a></li>
>   <li><a href="toc_editor/editor.htm">Table of Contents Editor</a></li>
>+  <li><a href="ctx_help_editor/editor.htm">Contex Help Editor</a></li>
> </ul>
> <p>&nbsp;</p>
> <p>&nbsp;</p>
>Index: guide/tools/editors/ctx_help_editor/editor.htm
>===================================================================
>RCS file: guide/tools/editors/ctx_help_editor/editor.htm
>diff -N guide/tools/editors/ctx_help_editor/editor.htm
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ guide/tools/editors/ctx_help_editor/editor.htm	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,83 @@
>+<!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>
>+
>+<h3>Page Sections</h3>
>+		
>+		<p>
>+			This page is comprised of the following sections:
>+		</p>		
>+		
>+		<ul>
>+			<li>
>+				<a href="#add-new-help">Adding new help context</a>
>+			</li>
>+			<li>
>+				<a href="#add-help-command">Adding help command</a>
>+			</li>
>+			<li>
>+				<a href="#remove-up-down">Remove, Up, Down</a>
>+			</li>
>+			<li>
>+				<a href="#register">Register this context help</a>
>+			</li>	
>+										
>+		</ul>
>+
>+		
>+
>+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.
>+
>+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).
>+
>+Above there is a brief overview of available commands
>+
>+<a name="add-new-help"></a>
>+<h3>Adding new help context</h3>
>+<img src="../../../images/ctx_help_editor/help_context_filled.png" alt="help context editor with fulfilled fields" border=0 height=265 width=708> <br />
>+When clicking the <strong>Add Context</strong> 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:
>+<ul>
>+  <li>help context id</li>
>+  <li>context description which is to be presented to the user</li>
>+  <li>if needed giving a custom title (replacing the default one)</li>
>+</ul>
>+ 
>+<a name="add-help-command"></a>
>+<h3>Adding help command</h3>
>+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.
>+<img src="../../../images/ctx_help_editor/help_context_topic_details.png" alt="help context editor with fulfilled fields" border=0><br />
>+
>+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).
>+
>+
>+<td valign="center">Add command</td>
>+Help context enables to define which command to exacute. It also asks for providing an appriopriate label for it.
>+<img src="../../../images/ctx_help_editor/help_context_command.png" alt="help context editor add command" border=0><br />
>+
>+<a name="Remove-up-down"></a>
>+<h3>Remove, Up, Down</h3>
>+There are three buttons, which enable manipulating with the items order on the context list or with deleting the items. 
>+<img src="../../../images/ctx_help_editor/help_context_second_topic.png" alt="help context with manipulating buttons" border=0><br />
>+These buttons are:
>+<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. <br />
>+NOTE: This feature is to be added in the nearest future.
>+
>+</body>
>+</html>
>Index: guide/tools/editors/ctx_help_editor/page_ctx_help.htm
>===================================================================
>RCS file: guide/tools/editors/ctx_help_editor/page_ctx_help.htm
>diff -N guide/tools/editors/ctx_help_editor/page_ctx_help.htm
>--- /dev/null	1 Jan 1970 00:00:00 -0000
>+++ guide/tools/editors/ctx_help_editor/page_ctx_help.htm	1 Jan 1970 00:00:00 -0000
>@@ -0,0 +1,16 @@
>+<!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>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>
>+
>+</body>
>+</html>

Actions: View | Diff

Attachments on bug 215848: 91221 | 91222 | 91229 | 91748 | 91774