[richfaces-issues] [JBoss JIRA] Commented: (RF-2086) Errors in components section

[Vladimir Sukhov (JIRA)]

    [ http://jira.jboss.com/jira/browse/RF-2086?page=comments#action_12398280 ] 
            
Vladimir Sukhov commented on RF-2086:
-------------------------------------

< a4j:loadScript > < a4j:loadStyle >As it was mentioned above this component returns its value "as the value of  the "src" attribute" passing it to the getResourceUR()--added
10. Highlight meaningful word "A4J.AJAX.Submit",action1,someData--done
Creating on a page--done
11."Description"--done
make link on <a4j:poll>--done
It's possible to set value equal to "0"--checked--"true".
13. Creating on a page
<a4j:outputPanel layout="block">
                    <h:form>
                        <h:outputText value="Enter Text:"/>
                        <h:inputText id="text1" label="text1" value="#{rsBean.text1}">
                            <f:validateLength maximum="10"/>
                            <a4j:support event="onkeyup" reRender="out1" />
                        </h:inputText>
                    </h:form>
        </a4j:outputPanel>--added
highlight attributes, values--done
.....should be in Note box---done
<f:verbatim> component--replaced
 "true" - remove italic--done
14. highlight component names--done
15. Creating on a page 
<a4j:region>
                    <h:inputText value="#{userBean.name}">
                        <a4j:support event="onkeyup" reRender="outname" />
                    </h:inputText>
                </a4j:region>
create a link where to read--done
<h:form/a4j:form> component -> <h:form>/<a4j:form>--replaced
16. Key attribytes..
is decoded on a page as "the code shown in the example above":--added
(and with a lowercase letter)--done
"id" - blue "layout" - blue with italic--done
17.Creating on a page ---done
19Key attributes and ways of usage. - highlighting should be corrected--done.

> Errors in components section
> ----------------------------
>
>                 Key: RF-2086
>                 URL: http://jira.jboss.com/jira/browse/RF-2086
>             Project: RichFaces
>          Issue Type: Bug
>          Components: doc
>    Affects Versions: 3.1.0
>            Reporter: Svetlana mukhina
>         Assigned To: Vladimir Sukhov
>             Fix For: 3.2.0, 3.1.5
>
>
> 1. < a4j:ajaxListener > 
> Key attributes and ways of usage
> The <a4j:ajaxListener> component is the same one as "actionListener" or "ValueChangeListener", but for an Ajax container.
> "actionListener" -> <f: actionListener > 
> "ValueChangeListener" -> <f: f:valueChangeListener> 
> 2. < a4j:ajaxListener > 
> "Key attributes and ways of usage
> Attribute "type" described in the following chapter. "
> following chapter - the link doesn't work; 
> +better to make an attribute description here, it's the only one for the component . 
> +highlight "type". 
> revise the following description "Attribute "type" described in the following chapter. defines the fully", change it into 
> "Attribute "type" described in the following chapter. It defines the fully..."
> "This class should implement org.ajax4jsf.framework.ajax.ajaxListener interface." not "should implement", but "implements" (though, check it).
> 3.< a4j:keepAlive > 
> Key attributes and ways of usage
> highlight meaningful words ('managed-bean-scope' and etc.) and frame attributes names in quotes 'beanName'.
> 4. < a4j:actionparam > 
> Key attributes and ways of usage
> highlight attributes frame in quotes : "converter", "assignTo", "name" and etc. 
> "If it is set to "true", the value will be evaluated as a JavaScript code" (use present simple here and in other similar cases, not future ). 
> 5.. < a4j:commandButton > 
> in "Key attributes and ways of usage"
> highlight meaningful words.
> "see <a4j:support> chapter" (create a link).
> highlight  meaningful word 'A4J.AJAX.Submit'.
> "Creating on a page"
> the section should contain only the simplest tag usage example, thus all explanation should be moved to "Key attributes and ways of usage." As "Key attributes and ways of usage" section should contain continuation of Creating on a page section.
> meaningful word "action1" highlight in blue without italic 
> "someData" delete italic, as it's a meningfull word and not an attribute. 
> 6. < a4j:form >
> "Creating on a page
> <a4j:form>
>     <!--...Some content to be submitted.-->
> </a4j:form>"
> sentence "<!--...Some content to be submitted.-->" should be replaced with code.
> "Relevant resources links
> Here. you can see the example of <a4j:form> usage and sources for the given example."
> unnecessary point after here. 
> 7. Everywhere in Guide check that link should be only on the required words not on "." or space.
> 8. There are links to demo-site for all components, but not each component has examples, in this case we need to correct the link text, providing some  general sentence. E.g.  "Here you can found some additional information for ... component usage."

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