[ http://issues.apache.org/jira/browse/BEEHIVE-710?page=all ]

Carlin Rogers updated BEEHIVE-710:
----------------------------------

    Attachment: j710examplepatch.txt

Attaching a patch to update some examples changing netui:label to netui:span.

Also, the patch updates the FormatTags test. The test had commented out
the use of a currency in a different local because the symbol did not
record correctly in the TestRecorder. A fix to the TestRecorder a while 
back to support multi byte characters allows us to update this test.

> netui tag libraries documentation: imageAnchor through textBox tags
> -------------------------------------------------------------------
>
>          Key: BEEHIVE-710
>          URL: http://issues.apache.org/jira/browse/BEEHIVE-710
>      Project: Beehive
>         Type: Bug
>   Components: Documentation
>     Versions: V1Beta
>     Reporter: Krista Baker
>     Assignee: Rich Feit
>      Fix For: V1
>  Attachments: j710docpatch.txt, j710examplepatch.txt
>
> All files associated with the below tags html version are from the 05/10/05 
> dist: 
> /docs/apidocs/taglib/beehive.apache.org/netui/tags-html-1.0/***TAG***.html
> Items are separated by the ___ line followed by their tag name on the 
> following line.  Most issues should be numbered within the tag items.
> _____________________________________
> <netui:imageAnchor>
> Description:
> 1.  Description: An anchor must have one of five attributes... in the 
> bulleted items, "* page - the module-relative page URL to which this 
> hyperlink will be rendered" however, page is not a valid attribute of the 
> netui:imageAnchor tag. The tagId may be used as a sole attribute of the 
> imageAnchor tag, to produce an id="" and name="" (in html mode). Also, 
> formSubmit="true" is also valid as a sole attribute of the anchor tag. 
>   Also the second item in the bulleted list needs to be removed, "* forward - 
> a forward to redirect to", forward is also not a valid attribute of the 
> imageAnchor tag.
>   clientAction should be added to the bulleted list along with a description. 
> Tag error when missing required attribute:
> Tag Type: ImageAnchor 
> Message: The ImageAnchor URI is invalid; it must be exactly one of href, 
> action, linkName, clientAction 
> For more information see: netui:anchor documentation bug: 
> http://issues.apache.org/jira/browse/BEEHIVE-639
> 2. JavaScript: The following function is actually what gets output:
> // submit the form from an Anchor or ImageAnchor
> // Search for the form by actionName,
> // Replace the action with the passed in action
> // Submit the form
> function anchor_submit_form(netuiName, newAction)
> {
>   for (var i=0; i&lt;document.forms.length; i++) {
>      if (document.forms[i].id == netuiName) {
>         document.forms[i].method = "POST";
>         document.forms[i].action = newAction;
>         document.forms[i].submit();
>      }
>    }
> }
> Attributes:
> 3. alt, height, hspace, imageStyle, imageStyleClass, longdesc, src, vspace, 
> and width do not have a Data bindable: value
> 4. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> 5. imageStyle and imageStyleClass do not have attribute descriptions.
> 6. longdesc does not have an attribute description.  A long description of 
> the image.
> 7. rel - "The rel." The relationship between the current document and the 
> target Url.
> 8. rev - "The rev." The relationship between the target URL and the current 
> document. 
> 9. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> _____________________________________
> <netui:imageButton>
> Attributes:
> 1. alt, disabled, ismap, onBlur, onChange, onFocus, onSelect, src, and usemap 
> do not have a Data bindable: value
> 2. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> 3. disabled does not have an attribute description: Disables the element so 
> that it cannot be selected or clicked
> 4. ismap does not have an attribute description: The server-side map 
> declaration.
> 5. onBlur, onChange, onFocus, and onSelect do not have attribute 
> descriptions.  The typical: "The on** JavaScript event." should be sufficient.
> 6. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> 7. usemap does not have an attribute description: The client-side image map 
> declaration
> _____________________________________
> <netui:label>
> Attributes:
> 1.  defaultValue, escapeWhiteSpaceForHtml, for, formatDefaultValue, and value 
> do not have Data bindable: values
> 2. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> The following do not currently have attribute descriptions.  Here are the 
> attribute names followed by a possible description.
> 3. defaultValue - "The String literal or expression to be used as the default 
> output"
> 4. escapeWhiteSpaceForHtml - "Boolean. Determines whether white space is 
> escaped in the html output."
> 5. for - "Defines which form element the label is for. Set to an id or tagId 
> of a form element"
> 6. formatDefaultValue - "Boolean. Determines whether formatting will be 
> applied to the default value."
> 7. value - "The String literal or expression used to output the label 
> content."
> 8. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> _____________________________________
> <netui:parameter>
> Attributes:
> 1. value does not have a Data bindable: value, however, the description says 
> the value can be dynamically determined and the attribute description says it 
> may be a literal or databinding expression.
> _____________________________________
> <netui:parameterMap>
> Attributes:
> 1. map does not have a Data bindable: value, however, the attribute 
> description says that it is "A data binding expression".
> Example:
> 2. In the code snippet under "The following set of tags will read the HashMap 
> object and generate a link with a set of URL parameters." the parameterMap 
> tag needs the $:
>  Current: <netui:parameterMap map="{pageFlow.hashMap}"/>
>  Updated: <netui:parameterMap map="${pageFlow.hashMap}"/>
> _____________________________________
> <netui:radioButtonGroup>
> When looking at the HTML output, later on there were examples which said: 
> "HTML which is similar will be output" with that wording, the HTML output 
> items that I have suggested for change, I think can stay the same.
> 1. Directly under the <netui:radioButtonGroup> Tag should be updated:
>  Current: Renders a collection of radiobutton options and handles the data 
> binding of their values.
>  Updated: Renders a collection of radiobutton options as <input type="radio"> 
> and handles the data binding of their values.
> 2.  Updated the above item in the first line of the Description
> Description:
> 1. Dynamically Generated Radiobutton Options:
>   The line following "To point the <netui:radioButtonGroup> at the Map 
> object..." does not have a dataSource attribute which is required and the 
> optionsDataSource needs the $.
>   Current: <netui:radioButtonGroup optionsDataSource="{pageFlow.hashMap}">
>   Updated: <netui:radioButtonGroup dataSource="actionForm.selection" 
> optionsDataSource="${pageFlow.hashMap}">
> 2. The generated radiobutton options also need to be updated as the text is 
> not quite the same as listed
>   Current:
>      <input type="radio" value="value1">Display Text 1</input>
>      <input type="radio" value="value2">Display Text 2</input>
>      <input type="radio" value="value3">Display Text 3</input>
>   Updated: 
>      <input type="radio" 
> name="wlw-radio_button_group_key:{actionForm.selection}" 
> value="value1"><span>Display Text 1</span><br>
>      <input type="radio" 
> name="wlw-radio_button_group_key:{actionForm.selection}" 
> value="value2"><span>Display Text 2</span><br>
>      <input type="radio" 
> name="wlw-radio_button_group_key:{actionForm.selection}" 
> value="value3"><span>Display Text 3</span><br>
> 3.  Statically Generated Radiobutton Options, the dataSource does not need 
> the {}
>  Current: <netui:radioButtonGroup dataSource="{actionForm.selection}">
>  Updated: <netui:radioButtonGroup dataSource="actionForm.selection">
> Attributes:
> 4. NONE OF the attributes have an attribute description or Data bindable: 
> value
> dataSource - see the dataSource attribute for <netui:checkBox> as well as 
> JIRA-664, which describes the bad examples in the dataSource attribute 
> description.
> defaultValue - also see the defaultValue attribute for the <netui:checkBox>
> disabled - Boolean. If set to true, the group will be visible, but disabled.
> labelStyle - The style of the label for each contained 
> <netui:radioButtonOption> tag
> labelStyleClass - The class of the labels for each contained 
> <netui:radioButtonOption> tag.
> optionsDataSource - The optionsDataSource attribute determines the set of 
> options presented to the user.
> orientation - **not sure"
> repeater - Boolean: **plus more description**
> style - Sets the style of the rendered HTML tag
> styleClass - The class of the rendered HTML tag
> Example:
> 5.   First example needs {} removed and $ put in
>  Current: <netui:radioButtonGroup optionsDataSource="{pageFlow.hashMap}" 
> dataSource="{actionForm.selections}">
>  Updated: <netui:radioButtonGroup optionsDataSource="${pageFlow.hashMap}" 
> dataSouce="actionForm.selections">
> 6.  Second Example: "...then the following HTML" will be generated in the 
> browser..." However the items listed here are not HTML, this can either be 
> fixed to html as is shown at the top, OR can be reworded to something like 
> ...then the following equivalent will be generated into HTML for the 
> browser...
> _____________________________________
> <netui:radioButtonOption>
> Attributes:
> 1.  The following attributes are missing a Data bindable: value:
>  alt, disabled, onBlur, onChange, onFocus, onSelect, value
> The following attributes are missing their descriptions:
> 2. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> 3. disabled - Boolean. If set to true, the option will be visible, but unable 
> to be selected or clicked
> 4. onBlur, onChange, onFocus, and onSelect do not have attribute 
> descriptions.  The typical: "The on** JavaScript event." should be sufficient.
> 5. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> Example:
> 6. radioButtonGroup item needs {} removed from dataSource attribute
>  Current: <netui:radioButtonGroup dataSource="{actionForm.selection}">
>  Updated: <netui:radioButtonGroup dataSource="actionForm.selection">
> _____________________________________
> <netui:rewriteName>
> Description: 
> 1. Should this line still exist?: Some containers such as WebLogic Portal 
> rewrite name attributes so they are unique.  
>   I am just not sure if we want to single out WebLogic Portal in our docs.
> 2.  getNetuiTagName has been deprecated and is not the default lookup funcion 
> for tagId names.
>  Current: "This tag will cause the name to be made available from the 
> getNetuiTagName (tagId, tag ) JavaScript function." 
>  Updated: "This tag will cause the name to be made available from the 
> lookupIdByTagId ( id, tag ) JavaScript function."
> Example:
> 3. references Portal (see #1), both spans on either side of "instead of" are 
> the same, and getNetuiTagName is referenced again.
>  Current: For example, a Portal container may change render <span 
> name="scope1_foo"> instead of <span name="scope1_foo">. But the value 'foo' 
> can be passed to getNetuiTagName( tagId, tag ) to find the rendered value of 
> the name attribute. 
>     <span id="<netui:rewriteName name="foo"/>">
>  Updated: For example, a Portal container may render to <span 
> name="scope1_foo"> instead of <span name="foo">.  But the value 'foo' can be 
> passed to lookupIdByTagId (id, tag ) to find the rendered value of the name 
> attribute.
>      <span id="<netui:rewriteName name="foo"/>">
> _____________________________________
> <netui:rewriteUrl>
> see above issues from <netui:rewriteName>, items are very similar.
> _____________________________________
> <netui:scriptHeader>
> This element should have notes that the element is A) required to be empty 
> and B) is required for <netui:tree runAtClient="true"> 
> _____________________________________
> <netui:select>
> Description: 
> 1. Dynamically Generated options, the example after "To point the 
> <netui:select> tag at the String[]..., <netui:select> needs {} removed from 
> optionsDataSource and needs the required dataSource attribute and an end tag 
> (changed the _ in front of options because a getter for _options will be 
> needed.
>  Current: <netui:select optionsDataSource="{pageFlow._options}"
>  Updated: <netui:select dataSource="actionForm.selections" 
> optionsDataSource="{pageFlow.options}">
> 2. Update the following HTML will be generated.
>   Current: 
>      <select size="3">
>           <option value="#3333ff">blue</option>
>           <option value="#33ff33">green</option>
>           <option value="#ff3333">red</option>
>       </select>
>   Updated:
>       <input type="hidden" 
> name="wlw-select_key:{actionForm.selections}OldValue" value="true">
>       <select name="wlw-select_key:{actionForm.selections}">
>           <option value="#3333ff">blue</option>
>           <option value="#33ff33">green</option>
>           <option value="#ff3333">red</option></select>
> 3. Statically Generated Options, the <netui:select> tag has {} around the 
> dataSource attribute
>   Current: <netui:select dataSource="{actionForm.selections}" size="5">
>   Updated: <netui:select dataSource="actionForm.selections" size="5">
> 4. Submitting Selections, the <netui:select tag is started with </ and has {}
>   Current: </netui:select dataSource="{actionForm.selections}">
>   Updated: <netui:select dataSource="actionForm.selections" />
> Attributes:
> 5. The following attributes are missing a Data bindable: value:
>   dataSource, defaultValue, disabled, onBlur, onChange, onFocus, 
> optionsDataSource, repeater, repeatingOrder
> 6. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> The following attributes are missing attribute descriptions:
> 7. disabled - Boolean. If set to true, the options will be visible, but 
> unable to be selected or clicked
> 8. onBlur, onChange, and onFocus do not have attribute descriptions.  The 
> typical: "The on** JavaScript event." should be sufficient.
> 9. optionsDataSource - The optionsDataSource attribute determines the set of 
> options presented to the user. Use a data binding expression to point the 
> optionsDataSource at the String[] or java.util.Map object.
> 10. repeater -  Boolean: **plus more description**
> 11. repeatingOrder - ***Needs description, in order to actually use, needs 
> c:if statements
>   For an example, look at coreWeb/coretags/selectOrder/index.jsp for a list 
> of possible values and usage information
> 12. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> Examples:
> 13. <netui:select> has {} and no $
>   Current: <netui:select dataSource="{actionForm.selectedOption}" 
> optionsDataSource="{actionForm.itemOptions}" />
>   Updated: <netui:select dataSource="actionForm.selectedOption" 
> optionsDataSource="${actionForm.itemOptions}" />
> YAY - Html that is similar will be rendered!!  That's good wording to 
> remember if you don't want to have to make sure it is exactly or very close 
> to what will render.
> _____________________________________
> <netui:selectOption>
> Attributes: 
> 1. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> 2. The following attributes do not have a data bindable: value
>   disabled, repeatingType, and value
> 3. repeatingType does not have an attribute description see above coreWeb 
> example from <netui:select> tag for hopefully more information
> 4. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> Examples:
> 5. <netui:select> has {} on the dataSource attribute
>   Current: <netui:select dataSource="{actionForm.selections}" size="5"/>
>   Updated: <netui:select dataSource="actionForm.selections" size="5"/>
> _____________________________________
> <netui:span>
> (pretty much identical to netui:label)
> Attributes:
> 1. The following attributes do not have a Data bindable: value:
>  defaultValue, escapeWhiteSpaceForHtml, formatDefaultValue, value
> 2. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> The following do not currently have attribute descriptions.  Here are the 
> attribute names followed by a possible description.
> 3. defaultValue - "The String literal or expression to be used as the default 
> output"
> 4. escapeWhiteSpaceForHtml - "Boolean. Determines whether white space is 
> escaped in the html output."
> 5. formatDefaultValue - "Boolean. Determines whether formatting will be 
> applied to the default value."
> 7. value - "The String literal or expression used to output the span content."
> 8. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> _____________________________________
> <netui:textArea>
> Attributes:
> 1. The following attributes do not have a Data bindable: value:
>  cols, dataSource, defaultValue, disabled, onBlur, onChange, onFocus, 
> onSelect, and rows
> 2. dataSource - see the dataSource attribute for <netui:checkBox> as well as 
> JIRA-664, which describes the bad examples in the dataSource attribute 
> description.
> 3. Even though dir is a Standard Html Attribute, the description is lacking: 
> "The dir." The description taken from the standard Attributes Value 
> Description:
> dir ltr | rtl Sets the text direction 
> 4. disabled - Boolean. If set to true, the options will be visible, but 
> unable to be selected, clicked, or typed in.
> 5. onBlur, onChange, and onFocus do not have attribute descriptions.  The 
> typical: "The on** JavaScript event." should be sufficient.
> 6. tagId - see JIRA-637 - http://issues.apache.org/jira/browse/BEEHIVE-637
> Example:
> 7. Needs to remove {} from dataSource and add $ to defaultValue
>  Current: <netui:textArea dataSource="{actionForm.description}" 
> defaultValue="{pageFlow.defaultDescription}" cols="25" rows="3" />
>  Updated: <netui:textArea dataSource="actionForm.description" 
> defaultValue="${pageFlow.defaultDescription}" cols="25" rows="3" />
> _____________________________________
> <netui:textBox>
> See <netui:textArea> for issues
> Differences: 
>  No Data bindable: value:
>     alt, (cols invalid for textBox), maxlength, size, (rows invalid for 
> textBox)
> Example:
> 7. Needs to remove {} from dataSource and add $ to defaultValue
>  Current: <netui:textBox dataSource="{actionForm.firstName}" 
> defaultValue="{pageFlow.defaultFirstName}" size="20" />
>  Updated: <netui:textBox dataSource="actionForm.firstName" 
> defaultValue="${pageFlow.defaultFirstName}" size="20" />
> _____________________________________
> Not included in this CR: <netui:tree> and related, these will be filed 
> seperately

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira

Reply via email to