Community
Participate
Working Groups
The new editor needs help.
Marking as bugday. This will have to be done sometime in 3.4.
The new context help wizard will need help as well. See Bug 216019.
I'd like to prepare a patch for this bug, for the nearest bugday.
I say go for it. Let me know if you need any more info on how the editor works.
Are you familiar with how to add context help Blazej?
Well, not quite. It's one of first serious assignment dealing with adding context help.. however, I'll do my best :-)
Created attachment 91221 [details] patch adding context help editor's context help I created a context help editor's context help page. Can you review it and give me remarks? Also attaching images, which are used by the help .htm page.
Created attachment 91222 [details] images used within help page images used within help page
Great work so far Blazej! Here are the things that still need to be fixed 1) Please replace the context help xml entry with the following (more consistent wording and changed 'content' to 'context'. <context id="ctx_help_editor" title="Context Help Editor"> <description>This editor creates a context help XML file, which allows you to create and edit dynamic help entries.</description> <topic href="guide/tools/editors/ctx_help_editor/editor.htm" label="Context Help Editor"/> </context> 2) The context has to be specified by the editor in code, I will attach a patch for this. 3) The editor page should use bolding for proper names of editors, pages and actions. Titles should be done as headings. Take a look at the Extension Point Schema Editor page (org.eclipse.pde.doc.user/guide/tools/editors/schema_editor/editor.htm) as an example. 4) It would be cool if we mentioned the extension to add to register the context help xml file. This isn't as important right now as in the future we will add an action that registers it for you similar to the ToC Editor. 5) The ToC entry points to the same page twice. I assume you meant to use the page html that is in the patch but is not used anywhere.
Created attachment 91229 [details] Associates context help id with UI
Created attachment 91748 [details] Small changes Changes made by instructions given.
Curtis, I've attached a patch which changes the files as you requested. As for the ToC entry point that I've linked - I deleted the link, however it was placed because I created a patch to a releated bug 198841. Waiting for your feedback.
Created attachment 91774 [details] Updated patch This patch fixes some things in the previous patch. 1) Fixed minor things that look bad when people find them in the SDK later, like spelling mistakes and incorrect capitalization. Removed the TODO to add the help. 2) Added <strong> tags to emphasize command/section titles, replacing the <p class="style2"> which just puts it on a new line. 3) Added <p> tags around the paragraphs so spaces show up in the right spot.
Great work Blazej! With my minor changes the doc is ready to be committed. I'm sure Chris will do the honours. If you are interested in doing other help doc for PDE (or any other kind of bug) we would love it. Chris, when getting the images, one of them context_details.png is not used anywhere, so it doesn't need to be committed.
Thanks guys!! This is a great bug. It goes to show that you don't have to just contribute code, documentation is valuable too. Thank you very much Blazej!
Thanks guys! Awesome stuff! I opened another bug for your picture Blazej to put on the PDE hall of fame :) > 20080306
