Bug 125221 - [doc] missing context help
Summary: [doc] missing context help
Status: RESOLVED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.4 RC2   Edit
Assignee: Benjamin Cabé CLA
QA Contact:
URL:
Whiteboard:
Keywords: contributed, greatbug
Depends on:
Blocks:
 
Reported: 2006-01-25 14:06 EST by Curtis d'Entremont CLA
Modified: 2008-05-22 15:33 EDT (History)
3 users (show)

See Also:
curtis.windatt.public: review+
caniszczyk: review+


Attachments
Patch (34.66 KB, patch)
2008-05-21 17:16 EDT, Benjamin Cabé CLA
no flags Details | Diff
Updated patch (PluginContentPage.java invalid modifications removed) (33.01 KB, patch)
2008-05-22 15:02 EDT, Benjamin Cabé CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Curtis d'Entremont CLA 2006-01-25 14:06:42 EST
There are many instances in PDE (well, not just PDE) where there is no context help available - it is either just not there or we get the default parent help like for the new or import/export wizards. This will become more apparent once the help button is added to dialogs.

Here are some examples as I was going through.. but this list is not complete:

Preferences:
  Target platform page:
    Target Profiles section (bottom):
       Profile link -> resulting dialog
       Browse... -> resulting dialog
    Launching Arguments tab:
      Variables...:
         resulting dialog
         Edit Variables... -> New... -> resulting dialog
         Configure... -> resulting dialog
    Implicit Dependencies tab:
      Add... -> resulting dialog
Views:
  Error Log:
    Right click -> Event Details -> resulting dialog
    View menu -> Filters... -> resulting dialog
  Plug-in Dependencies:
    Right click -> Focus On... -> resulting dialog
Editors:
  plugin.xml editor:
    Overview tab:
      Browse... -> resulting dialog
      Add.. -> resulting dialog
    Dependencies tab:
      both Add.. buttons -> resulting dialog
      both Properties... buttons -> resulting dialog
    Runtime tab:
      all Add... buttons -> resulting dialog
      Properties... -> resulting dialog
      New... -> resulting dialog
    Extension points tab:
      Browse... -> resulting dialog
Wizards:
  New:
    Extension Point Schema:
      Extensino Point Schema Properties (first page) -> Browse... -> resulting dialog (both buttons)
    Feature Patch:
      Patch Properties (page 2) -> Browse... -> resulting dialog
    Fragment Project:
      Fragment Content (page 2) -> Browse... -> resulting dialog
    Plug-in from existing JAR file:
      Add.. -> resulting dialog
    Product Configuration:
      wizard page
    Target Profile:
      wizard page
  Export:
    Eclipse product:
      main wizard page
      Browse... -> resulting dialog
Comment 1 Chris Aniszczyk CLA 2008-04-15 13:14:46 EDT
joy :(
Comment 2 Benjamin Cabé CLA 2008-05-10 12:58:56 EDT
I will provide a patch for RC1.
Comment 3 Chris Aniszczyk CLA 2008-05-20 12:35:25 EDT
Are you planning to provide a patch or is this too much Ben :)?
Comment 4 Chris Aniszczyk CLA 2008-05-21 14:47:12 EDT
bumping to RC3 for doc pass
Comment 5 Benjamin Cabé CLA 2008-05-21 17:16:15 EDT
Created attachment 101390 [details]
Patch

Oops, sorry for being a bit late... RC3 seems more reasonable indeed.
The patch has outgoing modifications for o.e.pde.doc.user, o.e.pde.ui, and o.e.ui.views.log.
Comment 6 Benjamin Cabé CLA 2008-05-21 17:19:08 EDT
(In reply to comment #0)

Every problem explicited in the original comment should have been addressed. See below.

However, there are probably some other places where context help is not available. We probably need to do a more exhaustive search among every dialogs, wizards and preference pages... Joy once again :( !


Preferences:
  Target platform page:
    Target Profiles section (bottom):
       Profile link -> resulting dialog ALREADY FIXED
       Browse... -> resulting dialog FIXED
    Launching Arguments tab:
      Variables...:
         resulting dialog ALREADY FIXED but the help is talking about "launching platforms" (because it comes from Platform/Debug).
         Edit Variables... -> New... -> resulting dialog --> bug against Platform/Debug
         Configure... -> resulting dialog -> This is a Platform/DEBUG bug
    Implicit Dependencies tab:
      Add... -> resulting dialog FIXED
Views:
  Error Log:
    Right click -> Event Details -> resulting dialog FIXED
    View menu -> Filters... -> resulting dialog FIXED
  Plug-in Dependencies:
    Right click -> Focus On... -> resulting dialog FIXED
Editors:
  plugin.xml editor:
    Overview tab:
      Browse... -> resulting dialog ALREADY FIXED
      Add.. -> resulting dialog FIXED 
    Dependencies tab:
      both Add.. buttons -> resulting dialog HELP HAS BEEN DISABLED
      both Properties... buttons -> resulting dialog FIXED
    Runtime tab:
      all Add... buttons -> resulting dialog FIXED
      Properties... -> resulting dialog FIXED
      New... -> resulting dialog FIXED
      Add... -> resulting dialog (not initially mentioned by Curtis) FIXED
    Extension points tab:
      Browse... -> resulting dialog FIXED
Wizards:
  New:
    Extension Point Schema:
      Extensino Point Schema Properties (first page) -> Browse... -> resulting
dialog (both buttons) FIXED
    Feature Patch:
      Patch Properties (page 2) -> Browse... -> resulting dialog FIXED
    Fragment Project:
      Fragment Content (page 2) -> Browse... -> resulting dialog FIXED (???)
    Plug-in from existing JAR file:
      Add.. -> resulting dialog FIXED
    Product Configuration:
      wizard page ALREADY FIXED, see bug 139104
    Target Profile:
      wizard page ALREADY FIXED, see bug 139104
  Export:
    Eclipse product:
      main wizard page ALREADY FIXED, see bug 139104
      Browse... -> resulting dialog FIXED
Comment 7 Chris Aniszczyk CLA 2008-05-21 17:43:24 EDT
wow, greatest patch ever

Thanks Ben.
Comment 8 Chris Aniszczyk CLA 2008-05-21 17:43:49 EDT
+1, please review Curtis, we can get this in on RC3
Comment 9 Curtis Windatt CLA 2008-05-22 14:46:40 EDT
There are some extra changes to PluginContentPage.java that cause errors.  We'll also have to try to add help topic links.  But overall an awesome contribution to PDE help.  Thanks!

+1 for RC3.
Comment 10 Benjamin Cabé CLA 2008-05-22 15:00:04 EDT
Ouch, PluginContentPage shouldn't have been included in the patch, sorry! :/
If you commit my patch early enough in RC3 (without PluginContentPage..!), I'll try to verify once again every item listed in the initial comment has been addressed, and I'll probably find some other places where context help need to be added!
Comment 11 Benjamin Cabé CLA 2008-05-22 15:02:53 EDT
Created attachment 101596 [details]
Updated patch (PluginContentPage.java invalid modifications removed)
Comment 12 Curtis Windatt CLA 2008-05-22 15:03:59 EDT
(In reply to comment #10)
> Ouch, PluginContentPage shouldn't have been included in the patch, sorry! :/
> If you commit my patch early enough in RC3 (without PluginContentPage..!), I'll
> try to verify once again every item listed in the initial comment has been
> addressed, and I'll probably find some other places where context help need to
> be added!
> 

Well, with an offer like that we have no choice but to get it in at the start
of RC3.  In fact, I'm seriously considering putting it in right now :)
Comment 13 Curtis Windatt CLA 2008-05-22 15:20:02 EDT
Applied the updated patch to HEAD.  Thanks again.
Comment 14 Chris Aniszczyk CLA 2008-05-22 15:33:03 EDT
This will make it into RC2 when I tag tonight.
Comment 15 Chris Aniszczyk CLA 2008-05-22 15:33:18 EDT
Thanks Ben and Curtis!