Bugzilla – Full Text Bug Listing
| Summary: | document list of commands for use from UA document contexts | ||
|---|---|---|---|
| Product: | [Eclipse Project] Platform | Reporter: | Christopher Daly <cjdaly> |
| Component: | User Assistance | Assignee: | platform-ua-inbox <platform-ua-inbox> |
| Status: | RESOLVED DUPLICATE | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | P3 | CC: | isafer, janek.lb, wassim.melhem |
| Version: | 3.2 | ||
| Target Milestone: | --- | ||
| Hardware: | All | ||
| OS: | All | ||
| Whiteboard: | |||
| Attachments: | |||
|
Description
Christopher Daly
Created attachment 33044 [details]
catalog of commands for embedding in UA documents (first draft)
Created attachment 33132 [details]
document update
added text describing how to execute commands from Cheatsheets and Intro content
A number of commands normally accessible through the menu bar are also needed. I presume they are already defined for the menu bar (e.g. opening various dialogs and wizards such as 'switch workspace', 'Preferences', 'Run', 'Debug' etc. Created attachment 33685 [details]
update to draft document (ver 0.3)
Created attachment 33881 [details]
update to draft document (ver 0.4)
Created attachment 34409 [details]
update to draft document (ver 0.5)
Chris, we also need to indicate command return values when they are not null. Created attachment 34444 [details]
update to draft document (ver 0.6)
only 2 commands currently return values, but those are now indicated in the document. I also made a few other minor corrections.
Created attachment 34981 [details]
authoring tool for command embedding
This is a tool I've been working on to help authors of Help/Cheatsheets/Intro embed commands in their content.
The tool helps:
- find commands that might be useful for embedding
- parameterize the commands that use parameters
- test execute commands
- copy command text to the clipboard so it can be pasted into the document
The attached zipped plugin contains the first cut of the tool. Look for the view called "Command Conquerer".
Created attachment 35216 [details]
authoring tool for command embedding (ver 0,2)
This version of the authoring tool has a few minor improvements.
one thing that should be worked into the authoring tool and the catalog of commands is the recent changes we've made to the format used for commands embedded in help described in bug 130834 and bug 130244. The summary is that commands in help should look like this: <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.jdt.ui.preferences.ClasspathVariablesPreferencePage)")'> <img src="PLUGINS_ROOT/PRODUCT_PLUGIN/command_link.png"> <b>Java > Build Path > Classpath Variables</b></a> preference page. The class="command-link" and <img...> help to distinguish the command link from ordinary HTML links. Hi, I was reading the Eclipse 3.2 online docs re Active Help, and have a question. Is the anchor format in Chris's last append supported for use in the main help topics? I mean, for the set of commands in the list, can I use this format in place of having to create my own ILiveHelpAction? Thanks! --Lee Anne Yes, all the command links you see in the SDK docs are done this way. In fact I encourage you to use commands instead custom live actions and I would like to eventually deprecate the live help actions in favor of commands. It's a great way to state your intent without binding yourself to a particular implementation. Fabulous! Great to hear this! --Lee Anne The command authoring is now a part of the cheat sheet editor so I'm going to close out this bug. I'm not sure what the most appropriate resolution is so I'll set this as a duplicate of one of the cheat sheet editor bugs that relates to the command composer. *** This bug has been marked as a duplicate of bug 157737 *** |