Details
-
Type: Improvement
-
Status: Closed
-
Priority: Major
-
Resolution: Fixed
-
Affects Version/s: 2.1-Beta2
-
Fix Version/s: 3.0
-
Component/s: ACE-Components
-
Labels:None
-
Environment:ICEfaces 3 ACE components
-
Affects:Documentation (User Guide, Ref. Guide, etc.)
Description
The ACE TLD documentation requires a general edit/review pass to improve overall quality and usefulness, and to ensure correctness.
---
Let's make sure that our documentation is truly useful. Some of it leaves a lot to be desired. I'll provide examples in ace:tooltip since I ran across it randomly.
@Property(tlddoc="Boolean value that makes tooltip global, which uses title attributes of elements in page to create the tooltip.", defaultValue="false")
private boolean global;
No idea what this means. Does global place the tooltip directly inside the body? Or it will somehow be used on every element in the page that has a title attribute?
@Property(tlddoc="The mouse event that the tooltip will be displayed (default mouseover)", defaultValue="mouseover")
private String showEvent;
@Property(tlddoc="The mouse event that the tooltip will be closed (default mouseout)", defaultValue="mouseout")
private String hideEvent;
What are all possible values?
@Property(tlddoc="The delay time of the tooltip display in milliseconds (default 140)", defaultValue="140")
private int showDelay;
@Property(tlddoc="The delay time of the tooltip hide in milliseconds (default 0)", defaultValue="0")
private int hideDelay;
@Property(tlddoc="Duration to display the show effect (default 500)", defaultValue="500")
private int showEffectLength;
@Property(tlddoc="Duration to display the hide effect (default 500)", defaultValue="500")
private int hideEffectLength;
The first two explain that the time is in milliseconds but the last two don't.
@Property(name="for", tlddoc="Specifies the id of the component that will display the tooltip")
private String forValue;
@Property(tlddoc="Specifies the id of the element that will display the tooltip")
private String forElement;
I'm not sure what the difference between these is. Is forElement an alternative to for, where I can display the tooltip on an element instead of a component? What is the precedence between the two?
---
Let's make sure that our documentation is truly useful. Some of it leaves a lot to be desired. I'll provide examples in ace:tooltip since I ran across it randomly.
@Property(tlddoc="Boolean value that makes tooltip global, which uses title attributes of elements in page to create the tooltip.", defaultValue="false")
private boolean global;
No idea what this means. Does global place the tooltip directly inside the body? Or it will somehow be used on every element in the page that has a title attribute?
@Property(tlddoc="The mouse event that the tooltip will be displayed (default mouseover)", defaultValue="mouseover")
private String showEvent;
@Property(tlddoc="The mouse event that the tooltip will be closed (default mouseout)", defaultValue="mouseout")
private String hideEvent;
What are all possible values?
@Property(tlddoc="The delay time of the tooltip display in milliseconds (default 140)", defaultValue="140")
private int showDelay;
@Property(tlddoc="The delay time of the tooltip hide in milliseconds (default 0)", defaultValue="0")
private int hideDelay;
@Property(tlddoc="Duration to display the show effect (default 500)", defaultValue="500")
private int showEffectLength;
@Property(tlddoc="Duration to display the hide effect (default 500)", defaultValue="500")
private int hideEffectLength;
The first two explain that the time is in milliseconds but the last two don't.
@Property(name="for", tlddoc="Specifies the id of the component that will display the tooltip")
private String forValue;
@Property(tlddoc="Specifies the id of the element that will display the tooltip")
private String forElement;
I'm not sure what the difference between these is. Is forElement an alternative to for, where I can display the tooltip on an element instead of a component? What is the precedence between the two?
Activity
Ken Fyten
created issue -
Ken Fyten
made changes -
Field | Original Value | New Value |
---|---|---|
Salesforce Case | [] | |
Fix Version/s | 2.1 [ 10241 ] | |
Affects | [Documentation (User Guide, Ref. Guide, etc.)] | |
Assignee | Mark Collette [ mark.collette ] |
Ken Fyten
made changes -
Fix Version/s | 3.1 [ 10312 ] | |
Fix Version/s | 3.0 [ 10241 ] |
Ken Fyten
made changes -
Salesforce Case | [] | |
Fix Version/s | 3.0 [ 10241 ] | |
Fix Version/s | 3.1 [ 10312 ] | |
Assignee Priority | P2 |
Ken Fyten
made changes -
Salesforce Case | [] | |
Assignee Priority | P2 | P1 |
Assignee | Mark Collette [ mark.collette ] | Ken Fyten [ ken.fyten ] |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27067 | Fri Dec 23 13:06:53 MST 2011 | ken.fyten | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/sliderentry/SliderEntryMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27069 | Fri Dec 23 14:02:53 MST 2011 | ken.fyten | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/sliderentry/SliderEntryMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27169 | Thu Jan 12 10:31:53 MST 2012 | art.zambrano | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/contextmenu/ContextMenuMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/animation/AnimationBehaviorHandlerMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/dataexporter/DataExporterMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/pushbutton/PushButtonMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/checkboxbutton/CheckboxButtonMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/linkbutton/LinkButtonMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/ajax/AjaxBehaviorHandlerMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27171 | Thu Jan 12 12:23:39 MST 2012 | art.zambrano | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/menuitem/MenuItemMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/menu/MenuMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/contextmenu/ContextMenuMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/menubar/MenuBarMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/menubutton/MenuButtonMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27184 | Fri Jan 13 09:18:33 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/accordion/AccordionMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/accordion/AccordionPaneMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27185 | Fri Jan 13 10:20:35 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/accordion/AccordionPaneMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/pushbutton/PushButtonMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/checkboxbutton/CheckboxButtonMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/linkbutton/LinkButtonMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27191 | Fri Jan 13 14:39:58 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/dialog/DialogMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/confirmationdialog/ConfirmationDialogMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27194 | Fri Jan 13 16:30:47 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/datetimeentry/DateTimeEntryMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27195 | Fri Jan 13 16:40:43 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/notificationpanel/NotificationPanelMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27202 | Mon Jan 16 11:45:37 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/tooltip/TooltipMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27204 | Mon Jan 16 13:21:52 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/progressbar/ProgressBarMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27207 | Mon Jan 16 14:26:43 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/resizable/ResizableMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27218 | Tue Jan 17 12:21:35 MST 2012 | art.zambrano | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/panel/PanelMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/submenu/SubmenuMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/excludefromexport/ExcludeFromExportMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/maskedentry/MaskedEntryMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/dnd/DraggableMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/dnd/DroppableMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/printer/PrinterMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27231 | Tue Jan 17 23:33:20 MST 2012 | art.zambrano | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/panel/PanelMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/excludefromexport/ExcludeFromExportMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/maskedentry/MaskedEntryMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/dnd/DraggableMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/dnd/DroppableMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27272 | Thu Jan 19 16:37:05 MST 2012 | art.zambrano | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/confirmationdialog/ConfirmationDialogMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/contextmenu/ContextMenuMeta.java |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27288 | Fri Jan 20 13:28:49 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/linkbutton/LinkButtonMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27295 | Fri Jan 20 14:56:34 MST 2012 | yip.ng | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/maskedentry/MaskedEntryMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27300 | Fri Jan 20 18:56:18 MST 2012 | mark.collette | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/fileentry/FileEntryMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27301 | Fri Jan 20 18:57:02 MST 2012 | mark.collette | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/tabset/TabPaneMeta.java
MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/tabset/TabSetProxyMeta.java MODIFY /icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/tabset/TabSetMeta.java |
Ken Fyten
made changes -
Salesforce Case | [] | |
Assignee Priority | P1 | |
Security | Private [ 10001 ] |
Ken Fyten
made changes -
Status | Open [ 1 ] | Resolved [ 5 ] |
Resolution | Fixed [ 1 ] |
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27504 | Mon Jan 30 13:06:44 MST 2012 | art.zambrano | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/resizable/ResizableMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27522 | Mon Jan 30 15:35:51 MST 2012 | ken.fyten | |
Files Changed | ||||
MODIFY
/icefaces3/tags/icefaces-3.0.0/icefaces/ace/component/src/org/icefaces/ace/component/resizable/ResizableMeta.java
|
Repository | Revision | Date | User | Message |
ICEsoft Public SVN Repository | #27597 | Wed Feb 01 16:07:20 MST 2012 | art.zambrano | |
Files Changed | ||||
MODIFY
/icefaces3/trunk/icefaces/ace/component/src/org/icefaces/ace/component/submenu/SubmenuMeta.java
|
Ken Fyten
made changes -
Status | Resolved [ 5 ] | Closed [ 6 ] |
All of our @Component and @Property annotations should have real tlddoc entries specified, but some of them don't. We should get around to that before the release, since we can't do it later like the wiki. I just searched for missing @Component tlddoc, and didn't even try for @Property.
@Component(
tagName = "cellEditor",
componentClass = "org.icefaces.ace.component.celleditor.CellEditor",
generatedClass = "org.icefaces.ace.component.celleditor.CellEditorBase",
rendererClass = "org.icefaces.ace.component.celleditor.CellEditorRenderer",
extendsClass = "javax.faces.component.UIComponentBase",
componentType = "org.icefaces.ace.component.CellEditor",
rendererType = "org.icefaces.ace.component.CellEditorRenderer",
componentFamily = "org.icefaces.ace.CellEditor",
tlddoc = ""
@Component(
tagName = "dataTable",
componentClass = "org.icefaces.ace.component.datatable.DataTable",
generatedClass = "org.icefaces.ace.component.datatable.DataTableBase",
rendererClass = "org.icefaces.ace.component.datatable.DataTableRenderer",
extendsClass = "javax.faces.component.UIData",
componentType = "org.icefaces.ace.component.DataTable",
rendererType = "org.icefaces.ace.component.DataTableRenderer",
componentFamily = "org.icefaces.ace.DataTable",
tlddoc = ""
@Component(
tagName = "expansionToggler",
componentClass = "org.icefaces.ace.component.expansiontoggler.ExpansionToggler",
generatedClass = "org.icefaces.ace.component.expansiontoggler.ExpansionTogglerBase",
rendererClass = "org.icefaces.ace.component.expansiontoggler.ExpansionTogglerRenderer",
extendsClass = "javax.faces.component.UIComponentBase",
componentType = "org.icefaces.ace.component.ExpansionToggler",
rendererType = "org.icefaces.ace.component.ExpansionTogglerRenderer",
componentFamily = "org.icefaces.ace.ExpansionToggler",
tlddoc = ""
@Component(
tagName = "linkButton",
componentClass = "org.icefaces.ace.component.linkbutton.LinkButton",
rendererClass = "org.icefaces.ace.component.linkbutton.LinkButtonRenderer",
generatedClass = "org.icefaces.ace.component.linkbutton.LinkButtonBase",
extendsClass = "javax.faces.component.UICommand",
componentType = "org.icefaces.ace.component.LinkButton",
rendererType = "org.icefaces.ace.component.LinkButtonRenderer",
componentFamily = "org.icefaces.ace.LinkButton"
)
@Component(
tagName = "row",
componentClass = "org.icefaces.ace.component.row.Row",
generatedClass = "org.icefaces.ace.component.row.RowBase",
extendsClass = "javax.faces.component.UIComponentBase",
componentType = "org.icefaces.ace.component.Row",
componentFamily = "org.icefaces.ace.Row",
tlddoc = ""
@Component(
tagName = "rowEditor",
componentClass = "org.icefaces.ace.component.roweditor.RowEditor",
generatedClass = "org.icefaces.ace.component.roweditor.RowEditorBase",
rendererClass = "org.icefaces.ace.component.roweditor.RowEditorRenderer",
extendsClass = "javax.faces.component.UIComponentBase",
componentType = "org.icefaces.ace.component.RowEditor",
rendererType = "org.icefaces.ace.component.RowEditorRenderer",
componentFamily = "org.icefaces.ace.RowEditor",
tlddoc = ""
@Component(
tagName = "rowExpansion",
componentClass = "org.icefaces.ace.component.rowexpander.RowExpander",
generatedClass = "org.icefaces.ace.component.rowexpander.RowExpanderBase",
extendsClass = "javax.faces.component.UIComponentBase",
componentType = "org.icefaces.ace.component.RowExpander",
componentFamily = "org.icefaces.ace.RowExpander",
tlddoc = ""
@Component(
tagName = "panelExpansion",
componentClass = "org.icefaces.ace.component.rowpanelexpander.RowPanelExpander",
generatedClass = "org.icefaces.ace.component.rowpanelexpander.RowPanelExpanderBase",
extendsClass = "javax.faces.component.UIColumn",
componentType = "org.icefaces.ace.component.RowPanelExpander",
componentFamily = "org.icefaces.ace.RowPanelExpander",
tlddoc = ""
@Component(
tagName = "tableConfigPanel",
extendsClass = "javax.faces.component.UIComponentBase",
rendererClass = "org.icefaces.ace.component.tableconfigpanel.TableConfigPanelRenderer",
rendererType = "org.icefaces.ace.component.TableConfigPanelRenderer",
generatedClass = "org.icefaces.ace.component.tableconfigpanel.TableConfigPanelBase",
componentType = "org.icefaces.ace.component.TableConfigPanel",
componentClass = "org.icefaces.ace.component.tableconfigpanel.TableConfigPanel",
componentFamily = "org.icefaces.ace.TableConfigPanel",
tlddoc = "")