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

Bug 352611

Summary: [Usability] Annotation description is not properly displayed in Add Annotation dialog
Product: [Technology] Tigerstripe Reporter: Navid Mehregani <nmehrega>
Component: AnnotationsAssignee: Project Inbox <tigerstripe.annotations-inbox>
Status: CLOSED FIXED QA Contact:
Severity: enhancement    
Priority: P3 CC: sjerman, skanton
Version: unspecified   
Target Milestone: 0.5M0   
Hardware: PC   
OS: Mac OS X - Carbon (unsup.)   
Whiteboard:
Attachments:
Description Flags
Annotation Dialog Wizard none

Description Navid Mehregani CLA 2011-07-20 11:31:20 EDT 
Build Identifier: 

At the moment the annotation description is added to the top part of the wizard.  If an annotation has a long description associated with it, the description is cut off and the user won't be able to see the rest of the description (as indicated in the attached snapshot).  

Instead, annotation description should be displayed in a scrollable section on the bottom of the wizard.  This is similar to "Add Stereotype" dialog.  Please use the following format:

Annotation Description:

<Description>


Reproducible: Always
Comment 1 Navid Mehregani CLA 2011-07-20 11:31:54 EDT 
Created attachment 200016 [details]
Annotation Dialog Wizard
Comment 2 Anton Salnik CLA 2011-07-21 09:14:22 EDT 
Annotation description moved to scrollable section on the bottom of the wizard.
Comment 3 Steve Jerman CLA 2011-07-21 16:52:50 EDT 
There are a few more issues that should be considered...

I'm not currently sure how you are getting hold of annotation documentation but I assume that it is from the description attribute of the extension element. This is a really poor way to pass in documentation.

It allows for no formatting and is really difficult to get right.

I would recommend the either an eAnnotation element in the ecore model be used instead or an element in the extension point that allows XHTML.
Comment 4 Navid Mehregani CLA 2011-08-09 14:48:43 EDT 
Verified. Thanks!

Steve, your suggestion makes sense.  We can file an enhancement to implement this later.  At the moment, the annotation descriptions we have are quite short and don't seem to have a need for rich formatting, but hopefully that will change once we implement the tooling to support what you're suggesting.