Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Plugin Development Environment (PDE) » Cheat sheets in modal dialogs(How to display cheat sheets in dialogs and wizards?)
icon5.gif  Cheat sheets in modal dialogs [message #500628] Fri, 27 November 2009 08:56 Go to next message
Enrico Daga is currently offline Enrico DagaFriend
Messages: 8
Registered: November 2009
Junior Member
Hi all,
I have found some documentation about showing the help section on the right side of a dialog. My issue is about using cheat sheets. When the user follow a cheat sheet, if the action requires to open a modal dialog or wizard, he cannot go on following the cheat sheet. Is there a way to have it opened in the right side of the dialog?

Thank you

Enrico
Re: Cheat sheets in modal dialogs [message #500638 is a reply to message #500628] Fri, 27 November 2009 09:24 Go to previous messageGo to next message
Ankur Sharma is currently offline Ankur SharmaFriend
Messages: 68
Registered: July 2009
Member
Enrico Daga wrote:
> Hi all,
> I have found some documentation about showing the help section on the
> right side of a dialog. My issue is about using cheat sheets. When the
> user follow a cheat sheet, if the action requires to open a modal dialog
> or wizard, he cannot go on following the cheat sheet. Is there a way to
> have it opened in the right side of the dialog?
>
> Thank you
>
> Enrico

You may associate the command to open the dialog with that step. When the user clicks that "green
arrow" action button, the cheat sheet automatically gets attached to the dialog.

For example, take a look at "Creating an Eclipse plug-in" cheat sheet. Sub-Step 2 of the step
"Configure PDE".

--
hth,
Ankur..
Eclipse PDE UI Committer | IBM India Software Lab, Bangalore
+91-99456-94011 | @ankur_sharma | http://blog.ankursharma.org
icon9.gif  Re: Cheat sheets in modal dialogs [message #500646 is a reply to message #500638] Fri, 27 November 2009 10:14 Go to previous messageGo to next message
Enrico Daga is currently offline Enrico DagaFriend
Messages: 8
Registered: November 2009
Junior Member
Thank you for your answer.

My problem is that the dialog must be opened by selecting a file in the navigator. I cannot know which parameter to pass to the dialog through the command (am I wrong?).
It would be enough to have the current sheet opened when the dialog is opened.
Another solution could be let the user choose one of its files directly from the sheet, but I think this is not possible...

What do you think?
Re: Cheat sheets in modal dialogs [message #500668 is a reply to message #500646] Fri, 27 November 2009 12:26 Go to previous messageGo to next message
Ankur Sharma is currently offline Ankur SharmaFriend
Messages: 68
Registered: July 2009
Member
Enrico Daga wrote:
> Thank you for your answer.
>
> My problem is that the dialog must be opened by selecting a file in the
> navigator. I cannot know which parameter to pass to the dialog through
> the command (am I wrong?).
> It would be enough to have the current sheet opened when the dialog is
> opened.
> Another solution could be let the user choose one of its files directly
> from the sheet, but I think this is not possible...
>
> What do you think?
>

Generally, cheat sheet are guided tour. A CS will tell user to create a particular file and then ask
to open it. Suppose a CS will tell you how it open a plug-in, then it probably will tell you first
that create a plugin x.y.z This way you would know which plug-in (command parameter) you have to
open. But this is just a general practice not a rule.

When a CS is open, user may be opening any dialog. It may not be related to the CS. That way, it
will not be correct to attach the CS to the dialog.

You can provide a action button to open a file. That is possible.

Thinking of the ideal solution, there should be a way to pin or carry along the CS. How about filing
an enhancement request. A patch would be even better ;-)


--
Ankur..
Eclipse PDE UI Committer | IBM India Software Lab, Bangalore
+91-99456-94011 | @ankur_sharma | http://blog.ankursharma.org
Re: Cheat sheets in modal dialogs [message #500675 is a reply to message #500668] Fri, 27 November 2009 13:25 Go to previous messageGo to next message
Enrico Daga is currently offline Enrico DagaFriend
Messages: 8
Registered: November 2009
Junior Member
Yes, there should be the possibility to go on with the cheat sheets in modal dialogs (and then continue on the whole workbench...), in particular with wizards, to guide the user for each step/page of the process.

What about direct help from the Dialog? How to link the help button with some help content? (this can be my alternative solution...)
Re: Cheat sheets in modal dialogs [message #500682 is a reply to message #500675] Fri, 27 November 2009 13:48 Go to previous messageGo to next message
Ankur Sharma is currently offline Ankur SharmaFriend
Messages: 68
Registered: July 2009
Member
Enrico Daga wrote:
> Yes, there should be the possibility to go on with the cheat sheets in
> modal dialogs (and then continue on the whole workbench...), in
> particular with wizards, to guide the user for each step/page of the
> process.
>
> What about direct help from the Dialog? How to link the help button with
> some help content? (this can be my alternative solution...)
>

This is generally done where you configure the shell for the dialog

This is from PluginSelectionDialog

protected void configureShell(Shell newShell) {
super.configureShell(newShell);
PlatformUI.getWorkbench().getHelpSystem().setHelp(newShell, IHelpContextIds.PLUGIN_SELECTION);
}


Constants are declared separately like

public static final String PLUGIN_SELECTION = PREFIX + "plugin_selection"; //$NON-NLS-1$


The context resides in the context help file - in this case contexts_PDE.xml

<context id="plugin_selection">
<description>This dialog allows you to select a plug-in.</description>
....

--
Ankur..
Eclipse PDE UI Committer | IBM India Software Lab, Bangalore
+91-99456-94011 | @ankur_sharma | http://blog.ankursharma.org
icon14.gif  Re: Cheat sheets in modal dialogs [message #500727 is a reply to message #500682] Fri, 27 November 2009 18:41 Go to previous messageGo to next message
Enrico Daga is currently offline Enrico DagaFriend
Messages: 8
Registered: November 2009
Junior Member
I skipped the problem by attaching the help as general html help.
This is ok at the moment.

Thank you very much for your suggestions.
Smile
Re: Cheat sheets in modal dialogs [message #603641 is a reply to message #500638] Fri, 27 November 2009 10:14 Go to previous messageGo to next message
Enrico Daga is currently offline Enrico DagaFriend
Messages: 8
Registered: November 2009
Junior Member
Thank you for your answer.

My problem is that the dialog must be opened by selecting a file in the navigator. I cannot know which parameter to pass to the dialog through the command (am I wrong?).
It would be enough to have the current sheet opened when the dialog is opened.
Another solution could be let the user choose one of its files directly from the sheet, but I think this is not possible...

What do you think?
Re: Cheat sheets in modal dialogs [message #603644 is a reply to message #603641] Fri, 27 November 2009 12:26 Go to previous messageGo to next message
Ankur Sharma is currently offline Ankur SharmaFriend
Messages: 68
Registered: July 2009
Member
Enrico Daga wrote:
> Thank you for your answer.
>
> My problem is that the dialog must be opened by selecting a file in the
> navigator. I cannot know which parameter to pass to the dialog through
> the command (am I wrong?).
> It would be enough to have the current sheet opened when the dialog is
> opened.
> Another solution could be let the user choose one of its files directly
> from the sheet, but I think this is not possible...
>
> What do you think?
>

Generally, cheat sheet are guided tour. A CS will tell user to create a particular file and then ask
to open it. Suppose a CS will tell you how it open a plug-in, then it probably will tell you first
that create a plugin x.y.z This way you would know which plug-in (command parameter) you have to
open. But this is just a general practice not a rule.

When a CS is open, user may be opening any dialog. It may not be related to the CS. That way, it
will not be correct to attach the CS to the dialog.

You can provide a action button to open a file. That is possible.

Thinking of the ideal solution, there should be a way to pin or carry along the CS. How about filing
an enhancement request. A patch would be even better ;-)


--
Ankur..
Eclipse PDE UI Committer | IBM India Software Lab, Bangalore
+91-99456-94011 | @ankur_sharma | http://blog.ankursharma.org
Re: Cheat sheets in modal dialogs [message #603648 is a reply to message #500668] Fri, 27 November 2009 13:25 Go to previous messageGo to next message
Enrico Daga is currently offline Enrico DagaFriend
Messages: 8
Registered: November 2009
Junior Member
Yes, there should be the possibility to go on with the cheat sheets in modal dialogs (and then continue on the whole workbench...), in particular with wizards, to guide the user for each step/page of the process.

What about direct help from the Dialog? How to link the help button with some help content? (this can be my alternative solution...)
Re: Cheat sheets in modal dialogs [message #603651 is a reply to message #500675] Fri, 27 November 2009 13:48 Go to previous messageGo to next message
Ankur Sharma is currently offline Ankur SharmaFriend
Messages: 68
Registered: July 2009
Member
Enrico Daga wrote:
> Yes, there should be the possibility to go on with the cheat sheets in
> modal dialogs (and then continue on the whole workbench...), in
> particular with wizards, to guide the user for each step/page of the
> process.
>
> What about direct help from the Dialog? How to link the help button with
> some help content? (this can be my alternative solution...)
>

This is generally done where you configure the shell for the dialog

This is from PluginSelectionDialog

protected void configureShell(Shell newShell) {
super.configureShell(newShell);
PlatformUI.getWorkbench().getHelpSystem().setHelp(newShell, IHelpContextIds.PLUGIN_SELECTION);
}


Constants are declared separately like

public static final String PLUGIN_SELECTION = PREFIX + "plugin_selection"; //$NON-NLS-1$


The context resides in the context help file - in this case contexts_PDE.xml

<context id="plugin_selection">
<description>This dialog allows you to select a plug-in.</description>
....

--
Ankur..
Eclipse PDE UI Committer | IBM India Software Lab, Bangalore
+91-99456-94011 | @ankur_sharma | http://blog.ankursharma.org
Re: Cheat sheets in modal dialogs [message #603666 is a reply to message #500682] Fri, 27 November 2009 18:41 Go to previous message
Enrico Daga is currently offline Enrico DagaFriend
Messages: 8
Registered: November 2009
Junior Member
I skipped the problem by attaching the help as general html help.
This is ok at the moment.

Thank you very much for your suggestions.
:)
Previous Topic:Can't launch runtime workspace
Next Topic:releng is empty?
Goto Forum:
  


Current Time: Sat Aug 15 17:02:31 GMT 2020

Powered by FUDForum. Page generated in 0.02413 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top