Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 215091

Summary:

Create Context Help Editor

Product:

[Eclipse Project] PDE

Reporter:

Curtis Windatt <curtis.windatt.public>

Component:

Assignee:

Curtis Windatt <curtis.windatt.public>

Status:

VERIFIED FIXED

QA Contact:

Severity:

enhancement

Priority:

CC:

baumanbr, caniszczyk, cgold

Version:

3.4

Keywords:

noteworthy

Target Milestone:

3.4 M5

Hardware:

OS:

Windows XP

Whiteboard:

Bug Depends on:

Bug Blocks:

203065, 215848, 215850, 216019

Attachments:

Description	Flags
Work in progress	none
Patch	none
Icons	none
Patch for review	none

Description Curtis Windatt

2008-01-11 16:40:10 EST

Breaking up bug 203065 into "smaller" chunks.

An editor for context help would make it faster and easier to edit context help xml files.  It's basic layout will be similar to the table of contents editor, where the xml elements are displayed in a tree on one half of the page while text fields allowing viewing/editing of the currently selected element would be on the other.

Other goals:
- Tree view of the xml, connected to the outline view and source tab
- Quick reordering of elements using cut/paste/drag/drop
- Html files can be dropped for quick topic additions
- Linked html files can be opened using actions/double click/etc
- Provide good location to connect other tools added as part of bug 203065

Comment 1 Curtis Windatt

2008-01-11 16:42:59 EST

Created attachment 86722 [details]
Work in progress

Patch holding my current work on the editor.  It is nearing completion, but the code needs to be cleaned up significantly and a few things tweaked.  Patch does not include icons borrowed from help.

Comment 2 Chris Aniszczyk

2008-01-11 16:46:22 EST

O M F G

Comment 3 Curtis Windatt

2008-01-17 13:28:51 EST

Created attachment 87186 [details]
Patch

This patch contains the context help editor.  It is ready to be reviewed and put into the platform, though the following problems still exist (I will create separate bug reports if this patch is committed).

1) I have turned off dragging and dropping.  There is a bug somewhere in the drag and drop that will often place the dropped element in odd places in the xml (such as before the root element).  As soon as I can figure out what is going on (adding new contexts using the button/action works but dragging doesn't) we can enable DND.

2) We should allow html files to be dragged and dropped into contexts to add new topics.

3) The help context editor needs a help context.

Comment 4 Curtis Windatt

2008-01-17 13:31:31 EST

Created attachment 87187 [details]
Icons

Zip files containing the three icons borrowed from user assistance needed by the editor.

Comment 5 Curtis Windatt

2008-01-17 13:32:42 EST

CC'ing Brian so he can have a chance to look at my 5000+ line patch :)

Comment 6 Curtis Windatt

2008-01-17 13:56:41 EST

4) The indents that the editor uses in the xml should be set better.  Probably using tabs.

Comment 7 Chris Aniszczyk

2008-01-17 14:06:32 EST

we love you Curtis

cc'ng Chris G to inform him about this awesomeness

Comment 8 Chris Goldthorpe

2008-01-17 14:27:19 EST

Awesome indeed.

Comment 9 Curtis Windatt

2008-01-18 14:50:53 EST

Created attachment 87291 [details]
Patch for review

This patch fixes the DnD problem as well as a number of smaller things including the indentation issue.  Filed bug 215848 to add help and bug 215850 to allow dropping of html files.

The editor is ready to be added to the platform as soon as a committer has the time to review it :)

Comment 10 Chris Aniszczyk

2008-01-21 12:39:38 EST

Awesome job Curtis! This should please the user assistance community.

Comment 11 Brian Bauman

2008-01-21 13:00:25 EST

Way to go Curtis!  Nice job getting it into M5.  I agree with Chris, this should be appreciated by quite a few users :)

Comment 12 Brian Bauman

2008-02-05 14:51:39 EST

Verified on I20080204-0800