[richfaces-issues] [JBoss JIRA] Assigned: (RF-398) Language correction

[Svetlana mukhina (JIRA)]

     [ https://jira.jboss.org/jira/browse/RF-398?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Svetlana mukhina reassigned RF-398:
-----------------------------------

    Assignee: Michael Sorokin  (was: Svetlana mukhina)


Language and content of the component suggestionbox should be improved 

below there are comments of Max Anderson on this component, use it also:

*Description*

"The component adds on-keypress suggestions capabilities to any  input text component (like <h:inputText> ). When a key is pressed  in the field Ajax request is sent to the server. When the  suggestion action returns a list of possible values, it pop ups  them inside the <div> element bellow the input."
Initial description is ok, but a bit vague (e.g. what is the point  of this box)

 "in the field Ajax request is sent" is broken english.

"pop ups them" is broken english.

"bellow the input" is misspelled (http://en.wikipedia.org/wiki/Bellows ) and the input is missing a adjective or reference, should be  "below the input component"

My suggestion: "<rich:suggestionbox> allows you to have a list show   up when the user is typing in a input text component (like  <h:inputText>) to provide suggestions to the user to quickly fill  in the text component. The component works by sending a ajax  request to the server when an on-keypress event occurs and if the suggstion action returns a list of values these values will be  shown as a list inside a <div> element below the input. The user  
can then either continue typing or select one of the suggestions  which will then be used as the value of the input text component."

The image is good, but shows a complex suggestion which is not   described in the following example. The example does not describe  what the values inside the returned List should be - readers would  assume a List of Strings when reading the Java code, but looking at  the example there is a property named "text".
After reading the text multiple times, looking at the livedemo and  reading some more I realize that if just the Java code example had  shown that it would return a list of non-string elements it would  have made sense much faster. In other words the Java examples  should be as complete as possible and not just a single line comment.

 *Details of usage*
 ""var" - a collection name that provides access for inputting into  a table in a popup"
I guess what is meant here is: "variable name that will be used for  each element in the returned suggestion collection. Can be used in   the <h:dataTable> and "fetch" attribute"

"There are also two size attributes ( "width" and "height" ) that  are obligatory for the suggestion component. The attributes have   initial Defaults but should be specified manually in order to be   changed."
That sentence is broken english. If they have initial defaults why  are they obligatory ? And what usage is it to be told that to  change a value you have to specfiy them ?

 Note: It also look like from the examples that the <div> element   will actually be rendered as if inside a h:dataTable - that is  actually never written anywhere. Just implied.

> Language correction
> -------------------
>
>                 Key: RF-398
>                 URL: https://jira.jboss.org/jira/browse/RF-398
>             Project: RichFaces
>          Issue Type: Task
>          Components: doc
>    Affects Versions: 3.2.0
>            Reporter: Svetlana mukhina
>            Assignee: Michael Sorokin
>            Priority: Minor
>             Fix For: 3.3.0
>
>
> Correct mistakes of xml markup, spelling and grammar in the guide

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