Bug 196543 - [ui] Add a view that shows annotation information for an XML with grammar
Summary: [ui] Add a view that shows annotation information for an XML with grammar
Status: NEW
Alias: None
Product: WTP Source Editing
Classification: WebTools
Component: wst.xml (show other bugs)
Version: 2.0   Edit
Hardware: PC All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: wst.xml CLA
QA Contact: Nick Sandonato CLA
URL:
Whiteboard:
Keywords: bugday, helpwanted
Depends on:
Blocks:
 
Reported: 2007-07-14 10:02 EDT by David Carver CLA
Modified: 2013-07-18 14:26 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David Carver CLA 2007-07-14 10:02:05 EDT
Currently in the source view, when hovering over an particular XML and a grammar is attached, information about the element is displayed.   However, if in design view this annotation information isn't available, and it would be helpful to have it available as a separate view.  This way, when the element is added or selected in the design editor, the annotation view would be updated with any annotation information that may exist in the grammar for that element.
Comment 1 Nitin Dahyabhai CLA 2007-08-31 02:45:23 EDT
Perhaps a request should be made to generalize the JavaDoc view into a "Documentation" view for such a purpose?
Comment 2 David Carver CLA 2007-08-31 08:19:51 EDT
(In reply to comment #1)
> Perhaps a request should be made to generalize the JavaDoc view into a
> "Documentation" view for such a purpose?
> 

Yes, if there is already an existing view that we could use as a base that would be good.   I guess the platform would need to create the abstract view, and then let the various plugins, extend the view for their needs, like the outline view is done today.

Maybe if I get some time, I'll take a crack at just creating a working view and use the javadoc view as a basis to start with (taking out any jdt specific dependencies).  However, this may be a while before I get to doing this.
Comment 3 David Carver CLA 2007-08-31 08:21:42 EDT
Another option would be to add another tab to the Properties view so that it could display the annotations.

Comment 4 Nitin Dahyabhai CLA 2007-08-31 10:42:05 EDT
(In reply to comment #3)
> Another option would be to add another tab to the Properties view so that it
> could display the annotations.

It's an interesting idea, but views should only be about one thing.
Comment 5 David Carver CLA 2007-08-31 12:22:55 EDT
Either way works for me, I prefer the separate view, to doing it with the properties view.
Comment 6 Nitin Dahyabhai CLA 2007-09-20 05:34:01 EDT
Agreed.  It's an interesting idea but the core team for sure won't have time for it in 3.0.  We'd happily accept high quality patches from someone motivated enough to work out the usability concerns, though.  Whether that means advocating a "language documentation" view across the entire IDE is up to that contributor, assuming it's not the core team down the road.
Comment 7 Nitin Dahyabhai CLA 2009-04-05 17:17:08 EDT
Dave, would this be a proper use for a general purpose "Documentation" view like we discussed at EclipseCon?
Comment 8 David Carver CLA 2009-04-06 09:28:32 EDT
(In reply to comment #7)
> Dave, would this be a proper use for a general purpose "Documentation" view
> like we discussed at EclipseCon?
> 

Yes, a documentation view would be good.  Based on the current node, grab any documentation and display it in the view.

Another idea is to have a Content Model view that shows a tree view of the underlying content model, so that people can see what is easily insertable at a particular point in time.