Bugzilla – Full Text Bug Listing
| Summary: | JPA Wizard recommendations | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [WebTools] Dali JPA Tools | Reporter: | Milen Manov <milen.manov> | ||||
| Component: | General | Assignee: | dali.general-inbox <dali.general-inbox> | ||||
| Status: | RESOLVED WONTFIX | QA Contact: | |||||
| Severity: | enhancement | ||||||
| Priority: | P3 | CC: | karenfbutzke, paul.fullbright | ||||
| Version: | unspecified | ||||||
| Target Milestone: | --- | ||||||
| Hardware: | PC | ||||||
| OS: | Windows XP | ||||||
| Whiteboard: | |||||||
| Attachments: |
|
||||||
Created attachment 113852 [details]
patch
I propose the following patch.
(In reply to comment #0) >1, The "JPA implementation" area title should be changed to >"JPA Implementation" (words starting with capital letters). >2, The "Persistent class management" area title should be >changed to "Persistent Classes Management" (words starting with >capital letters; plural of a class). From the Eclipse UI guidelines: http://wiki.eclipse.org/index.php/User_Interface_Guidelines#Capitalization Use Headline style capitalization for menus, tooltip and all titles, including those used for windows, dialogs, tabs, column headings and push buttons. Capitalize the first and last words, and all nouns, pronouns, adjectives, verbs and adverbs. Do not include ending punctuation (Guideline 1.5). Use Sentence style capitalization for all control labels in a dialog or window, including those for check boxes, radio buttons, group labels, and simple text fields. Capitalize the first letter of the first word, and any proper names such as the word Java. (Guideline 1.6). I read this to mean that we shouldn't capitalize the 2 group labels you are suggesting. If anything the group labels on the first page of the JPA wizard (Target Runtime, EAR Membership) should not be headline capitalized as they are now. We don't follow capitalization requirements correctly in a lot of places, we have another bug for that (245283), I'm hoping to fix it for 2.1 though Neil suggested otherwise :) >3, The "Annotated classes must be listed in persistence.xml" >radio button label should be changed to "List annotated classes >in persistence.xml explicitly" (use of passive voice is not >recommended). I like this suggestion. (In reply to comment #2) > >3, The "Annotated classes must be listed in persistence.xml" > >radio button label should be changed to "List annotated classes > >in persistence.xml explicitly" (use of passive voice is not > >recommended). > > I like this suggestion. > I'm not sure I do. First off, "Annotated classes must be listed ..." is not in passive voice. "Listed" here is used as an adjective, such as in "My apartment is painted", which does not imply that my apartment is in a current state of actively being painted, but rather that it *is* in a painted state. Second off, the suggestion given implies that we will actively maintain the list, which we will not. Any text on this radio button must suggest that we are placing a requirement on the persistence.xml to explicitly list any classes that are to be included, not that the list will be maintained for the user by the tooling. > (In reply to comment #3) I tend to agree with Paul here, that we don't want to suggest that Dali will be doing something for the user in this case, beyond validating differently. As for capitalization, I think bug 245283 adequately covers this issue for Dali. |
Build ID: M20080911-1700 Steps To Reproduce: Hi, colleagues, Here are some recommendations concerning the New JPA Project Wizard 1, The "JPA implementation" area title should be changed to "JPA Implementation" (words starting with capital letters). 2, The "Persistent class management" area title should be changed to "Persistent Classes Management" (words starting with capital letters; plural of a class). 3, The "Annotated classes must be listed in persistence.xml" radio button label should be changed to "List annotated classes in persistence.xml explicitly" (use of passive voice is not recommended). More information: