Add help buttons for different views #5852
Conversation
|
Setting to Draft PR again because I will add the |
If you can find a better icon with open source use, just add it to the bndtools.core properties, see org.bndtools.core.ui.icons.Icons class. You could also scale them. I thought we had a list of open source projects we used in bndtools but can't find it anymore. Maybe time to add it. |
HELP_BTN_REPOSITORIES, HELP_BTN_BNDTOOLS_EXPLORER, HELP_BTN_RESOLUTION_VIEW Signed-off-by: Christoph Rueger <[email protected]>
Signed-off-by: Christoph Rueger <[email protected]>
chrisrueger
force-pushed
the
add-help-buttons
branch
from
3d4e61a to
98cf605
Compare
* add Bndtools to Overview and Tutorials and link to relevant pages on bndtools.org * before this change there was already an entry in the Whats new section, but usually the Overview is the first thing shown. So I added it to the overview too to have more visibility for bndtools Signed-off-by: Christoph Rueger <[email protected]>
Maybe you mean this in the main README? |
this icon is a bit smaller got the help.gif from Eclipse (License Eclipse Puglic License EPL) https://git.eclipse.org/c/platform/eclipse.platform.ui.git/plain/examples/org.eclipse.ui.forms.examples/icons/ see https://git.eclipse.org/c/platform/eclipse.platform.ui.git/plain/examples/org.eclipse.ui.forms.examples/about.html for license information) Signed-off-by: Christoph Rueger <[email protected]>
e.g. for the main cnf/build.bnd Signed-off-by: Christoph Rueger <[email protected]>
* the resolver now adds the same bundles which I aded manually in an earlier commit. I verified.. files are exactly the same. Signed-off-by: Christoph Rueger <[email protected]>
chrisrueger
force-pushed
the
add-help-buttons
branch
from
c374a31 to
2591b3a
Compare
|
I think I am done so far. Would be glad to get feedback. |
implement suggested changes (rename classes, move to method to util class) Signed-off-by: Christoph Rueger <[email protected]>
See #5849
The goal of this PR is to make it easier to get context sensitive help inside Bndtools using "help" buttons to each View linking to the relevant sections of the manual.
Each button should also have a helpful tooltip summarizing the basic concept of the view ideally being helpful already. A click should open the webbrowser with the relevant page.
This would bridge the gap between Eclipse and the manual and allow us to improve especially those entry-pages in the manual, since we now know they are most likely clicked from bndtools in Eclipse.
Current status of this PR
I provided the following Help buttons:
Bndtools Explorer
Link: https://bndtools.org/manual/packageexplorer.html
Repositories View
Link: https://bndtools.org/manual/repositories-view.html
Resolution View
Link: https://bndtools.org/manual/resolution-view.html
Bnd Editor for
bnd.bndfilesLink: https://bndtools.org/manual/bndeditor.html
Bnd Editor for
.bndrunfilesLink: https://bndtools.org/manual/bndeditor.html#run
Workspace Bnd Editor e.g. cnf/build.bnd
Link: https://bndtools.org/manual/bndeditor.html
Welcome Screen
Now the following sections of the Eclipse Welcome Screen contain a Bndtools relevant entry linking to a page on the bndtools.org website
Icons
The help icon is currently from Eclipse internally and might be a bit big. But maybe this is a good thing, as it catches the eye more.
If you can tell me where to get a better icon which is allowed to be used, please let me know. @pkriens