This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 86132 - Need a description for each Properties item displayed at the Properties editor's description area
Summary: Need a description for each Properties item displayed at the Properties edito...
Status: NEW
Alias: None
Product: uml
Classification: Unclassified
Component: Properties (show other bugs)
Version: 5.x
Hardware: All All
: P4 blocker (vote)
Assignee: issues@uml
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-09-29 12:46 UTC by bugbridge
Modified: 2009-05-25 21:06 UTC (History)
2 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments
fields list from initial CR (2.18 KB, text/plain)
2006-09-29 12:49 UTC, Sergey Petrov
Details

Note You need to log in before you can comment on or make changes to this bug.
Description bugbridge 2006-09-29 12:46:51 UTC
Original submitter: petersl

Description:
Currently a duplicate name of the Properties item is displayed for each item. A
more descriptive description should be displayed in the Properties editor's
description area at the bottom when an item is in focus.
xxx@xxxx 2005-05-27 00:13:21 GMT

Evaluation:
Annette and Trey discussed this area and Trey has 'wired up' the properties to
accept and display a field level description.
xxx@xxxx 2005-06-17 23:49:18 GMT

Field descriptions for the first 11 fields that were defined in the UML Glossary
are being added by Annette.
xxx@xxxx 2005-06-22 23:58:49 GMT

Evaluation (Entry 2):
some field do not have description(for example users may want to know what for
alias can be used etc) and CR status in progress, seems reproducible with coke
060927

Suggested Fix:
As agreed in uml iteam discussions and email, docs will enter field descriptions
on a case by case basis.

To do this, we need the following information for each field needing an
additional description:
	element name
	field name
	description

Note: we only plan to add descriptions when it is a clear 'value-add' to the
user. Several fields are self-explanatory without additional decription.

xxx@xxxx 2005-06-17 23:49:18 GMT


============
==From Comments
============
This is the agreed upon process:
remembering that
> The file where the descriptions are stored has one entry for each
>  property, no matter where it's used, and that same description is
> shown in the "help pane" of the Properties window. 

and taking into account our team resources:
 1. QA will add to this bug  -  a list of the fields  needing a description
noting that

> For Buzz we will go with the minimal number of field descriptions, and
reconsider the coverage for Coke (hoping for user input in the meantime).
>
2. Docs will see if descriptions exist in the UML Glossary
3. Docs will send descriptions to Trey for approval, including those terms still
needing a description
4. Engineering will approve/provide the descriptions
5. Docs will add descriptions and integrate
6. QA will verify after fix is integrated.
xxxx 2005-06-20 23:19:42 GMT


The original table of Properties have been updated to indicate which property
fields need description. These fields are indicated by "Red" text and "Light
Violet" background colors in each sheet in the attached staroffice spreadsheet
"Properties-field-need-desc.sxc". This is only my opinion.
xxxx 2005-06-21 00:42:42 GMT

I have extracted the fields from Peter's spreadsheet and researched which ones 
need further definition by engineering. I have sent email to Annette
indicating she can start with the 11 fields that have definitions in the current
UML Glossary. I have sent email to Trey with the list of fields that 
need descriptions.
I have attached a text file with the list of fields for record-keeping.

xxxx 2005-06-22 23:58:49 GMT
*** (#1 of 1): 2005-06-21 03:19:42 MSD xxxx
*** Last Edit: 2005-06-23 03:58:49 MSD xxx
Comment 1 Sergey Petrov 2006-09-29 12:49:34 UTC
Created attachment 34700 [details]
fields list from initial CR
Comment 2 Annette Wegscheider 2006-10-02 22:35:20 UTC
Reassigned to Cindy. She's the docs owner for UML. 
Comment 3 Cynthia Castillo 2008-04-17 17:50:20 UTC
Reassigned to Bob. He's the docs owner for UML now. 
Comment 4 Joanne Lau 2008-06-19 20:03:40 UTC
still reproducible in 6.5