Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 200586 - Context sensitive help requires refactoring and new content.
Summary: Context sensitive help requires refactoring and new content.
Status: CLOSED WONTFIX
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: TPTP (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P2 normal (vote)
Target Milestone: ---   Edit
Assignee: Paul Slauenwhite CLA
QA Contact:
URL:
Whiteboard: housecleaned462
Keywords:
Depends on: 135983 194946 194947 199607 199610 200964 213622 246111 257266 263647 271007 296286
Blocks:
  Show dependency tree
 
Reported: 2007-08-20 13:44 EDT by Paul Slauenwhite CLA
Modified: 2016-05-05 11:00 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Slauenwhite CLA 2007-08-20 13:44:18 EDT
Context sensitive help requires refactoring.

The following refactoring is required for the context sensitive help for the Test Tools:

1) Create content for invalid context IDs.  For example, 

org.eclipse.hyades.test.tools.ui.http.internal.importWizard.HttpImportWizard.createPageControls(Composite)

2) Create content for all missing context IDs in all \org.eclipse.hyades.test.ui\infopop\*.xml file.  For example,

<!-- the following doc does not exist. Add back when available. -->

3) Correct paths/file names in all \org.eclipse.hyades.test.ui\infopop\*.xml files.

4) Using a consistent naming convention for context IDs.

5) Ensure all widgets has context sensitive help.
Comment 1 Paul Slauenwhite CLA 2007-08-24 12:05:37 EDT
[From 189977]

In the "Create New Test From Recording" wizard page, pressing F1 opens the help
pane with the generic message ("Opens a creation wizard"). This wizard page
needs to have context-sensitive help associated with it, including a context ID
so that downstream products can extend this context-sensitive help.
Comment 2 Paul Slauenwhite CLA 2007-08-24 12:05:40 EDT
*** Bug 189977 has been marked as a duplicate of this bug. ***
Comment 3 Paul Slauenwhite CLA 2007-08-24 14:53:44 EDT
CSH should be enabled for all WizardDialogs consistent with the File > Import, File > Export, or File > New wizard dialog.  For example, see org.eclipse.hyades.internal.execution.recorder.ui.actions.NewGenericRecordingAction.run().
Comment 4 Paul Slauenwhite CLA 2007-11-07 06:33:26 EST
Bulk update of the target field to reflect the change in iteration numbers.
Comment 5 Paul Slauenwhite CLA 2008-01-21 12:21:22 EST
Replaced all deprecated calls to org.eclipse.ui.help.WorkbenchHelp#setHelp() with <Plug-in class>.getDefault().getWorkbench().getHelpSystem().setHelp().
Comment 6 Paul Slauenwhite CLA 2008-04-18 12:06:47 EDT
Candidate for deferral to I8 since we are doing a full technical review of the product documentation in the I7 TP, which may cause the product documentation to change and we want to do this defect after the final product documentation edits are complete.
Comment 7 Paul Slauenwhite CLA 2008-04-21 09:05:31 EDT
Requires a technical review of the Test Tools documentation.
Comment 8 Paul Slauenwhite CLA 2008-05-21 14:24:59 EDT
Deferring to future as approved by the TPTP PMC (http://dev.eclipse.org/mhonarc/lists/tptp-pmc/msg04926.html).
Comment 9 Paul Slauenwhite CLA 2008-11-26 08:08:15 EST
Deferring to TPTP 4.5.3 since this defect requires new documentation, which requires translation.
Comment 10 Paul Slauenwhite CLA 2009-02-09 08:23:29 EST
Decreasing priority to P2 since TPTP 4.5.3 defect plan has not been finalized.
Comment 11 May Zhu CLA 2009-02-18 22:51:02 EST
(In reply to comment #0)
> Context sensitive help requires refactoring.
> The following refactoring is required for the context sensitive help for the
> Test Tools:
> 1) Create content for invalid context IDs.  For example, 
> org.eclipse.hyades.test.tools.ui.http.internal.importWizard.HttpImportWizard.createPageControls(Composite)
> 2) Create content for all missing context IDs in all
> \org.eclipse.hyades.test.ui\infopop\*.xml file.  For example,
> <!-- the following doc does not exist. Add back when available. -->
> 3) Correct paths/file names in all \org.eclipse.hyades.test.ui\infopop\*.xml
> files.
> 4) Using a consistent naming convention for context IDs.
> 5) Ensure all widgets has context sensitive help.

We need Test Log specific introduction in the "About Test Log (viewer) " section. We recommend that the "About..." section of each CS help provide an short introduction to the tool, and hardcode the most relevant links under the "See also".  In this way, it speeds up users' access to the most helpful info. 
Comment 12 Paul Slauenwhite CLA 2009-02-24 06:59:50 EST
Consider completing https://bugs.eclipse.org/bugs/show_bug.cgi?id=135983 as the same time to increase the maintainability of the Test Project documentation.
Comment 13 Paul Slauenwhite CLA 2009-02-25 10:59:06 EST
Approved for the TPTP 4.5.3 defect plan (see PMC minutes from 02/25/09).
Comment 14 Paul Slauenwhite CLA 2009-03-31 09:39:52 EDT
(In reply to comment #1)
> [From 189977]
> 
> In the "Create New Test From Recording" wizard page, pressing F1 opens the help
> pane with the generic message ("Opens a creation wizard"). This wizard page
> needs to have context-sensitive help associated with it, including a context ID
> so that downstream products can extend this context-sensitive help.
> 

Covered under https://bugs.eclipse.org/bugs/show_bug.cgi?id=246111.
Comment 15 Paul Slauenwhite CLA 2009-05-01 14:55:20 EDT
Requires documentation for the context menu actions on HTTP Requests in the URL Test Editor.
Comment 16 Paul Slauenwhite CLA 2009-05-20 14:53:02 EDT
Approved by the PMC to defer to future.
Comment 17 Paul Slauenwhite CLA 2009-05-20 15:47:47 EDT
(In reply to comment #16)
> Approved by the PMC to defer to future.
> 

Correction, deferring to TPTP 4.6.1.
Comment 18 Paul Slauenwhite CLA 2009-06-01 07:57:25 EDT
Requires defect 210289 for refactoring documentation on the ANT results property.

In addition, the other properties (see org.eclipse.hyades.test.doc.user/ref/rsupported-test-execution-service-properties.htm) should be refactored to clarify the intent, requirements, and valid values (e.g. only absolute and project-relative paths) for these properties.
Comment 19 Paul Slauenwhite CLA 2010-03-10 12:18:00 EST
As of TPTP 4.6.0, TPTP is in maintenance mode and focusing on improving quality by resolving relevant defects and increasing test coverage through test creation, automation, Build Verification Tests (BVTs), and expanded run-time execution. Since this defect is more than 2 years old, it may be no longer relevant. As part of the TPTP Bugzilla housecleaning process (see http://wiki.eclipse.org/Bugzilla_Housecleaning_Processes), this defect is resolved as WONTFIX. If this defect is still relevant and reproducible in the latest TPTP release (http://www.eclipse.org/tptp/home/downloads/), please re-open.
Comment 20 Paul Slauenwhite CLA 2010-03-25 20:01:30 EDT
Closing.