[richfaces-svn-commits] JBoss Rich Faces SVN: r2564 - in trunk/docs/userguide/en/src/main/docbook: modules and 1 other directory.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Wed Aug 29 08:54:35 EDT 2007
Author: smukhina
Date: 2007-08-29 08:54:34 -0400 (Wed, 29 Aug 2007)
New Revision: 2564
Modified:
trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml
trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml
trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml
trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
trunk/docs/userguide/en/src/main/docbook/included/form.xml
trunk/docs/userguide/en/src/main/docbook/included/insert.xml
trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml
trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml
trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml
trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml
trunk/docs/userguide/en/src/main/docbook/included/menuSeparator.xml
trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml
trunk/docs/userguide/en/src/main/docbook/included/repeat.xml
trunk/docs/userguide/en/src/main/docbook/included/tree.xml
trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml
Log:
http://jira.jboss.com/jira/browse/RF-745
uppercase letters for programlisting role are written
some minor syntax and format mistakes are corect in programlisting patterns
Modified: trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/ajaxListener.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -46,13 +46,13 @@
<section>
<title>Dynamical creation of a component from Java code</title>
<para>
- <emphasis role="bold">Example:</emphasis>
+ <emphasis role="bold">Example:</emphasis></para>
<programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.AjaxListener;
...
AjaxListener myListener = new AjaxListener();
...
]]></programlisting>
- </para>
+
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -72,7 +72,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.component.html.HtmlCalendar;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlCalendar;
...
HtmlCalendar myCalendar = new HtmlCalendar();
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/commandLink.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -54,7 +54,7 @@
<section>
<title>Key attributes and ways of usage</title>
<para>The component <emphasis role="bold"><property><a4j:commandLink></property></emphasis> placed on a page generates the following HTML code:</para>
- <programlisting role="JSP"><![CDATA[<a href="#" onclick="A4J.AJAX.Submit(?"request parameters");
+ <programlisting role="XML"><![CDATA[<a href="#" onclick="A4J.AJAX.Submit(?"request parameters");
return
<a href="#" onclick="A4J.AJAX.Submit(?"request parameters");
return false;">
Modified: trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -105,7 +105,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="JSP"><![CDATA[...
+ <programlisting role="XML"><![CDATA[...
<rich:dragSupport ...>
<rich:dndParam type="drag" name="dragging">
<h:graphicImage value="/img/product1_small.png"/>
@@ -131,7 +131,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="JSP"><![CDATA[...
+ <programlisting role="XML"><![CDATA[...
<rich:dragSupport ...>
<rich:dndParam type="drag" name="label" value="#{msg.subj}"/>
...
@@ -155,7 +155,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="JSP"><![CDATA[...
+ <programlisting role="XML"><![CDATA[...
<rich:dropSupport ...>
<rich:dndParam type="drop" name="comp" >
<h:graphicImage height="16" width="16" value="/images/comp.png"/>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -76,7 +76,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.component.html.HtmlDropDownMenu;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlDropDownMenu;
...
HtmlDropDownMenu myDropDownMenu = new HtmlDropDownMenu();
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/form.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/form.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -48,8 +48,7 @@
<programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.AjaxForm;
...
AjaxForm myForm = new AjaxForm();
-...
-]]></programlisting>
+...]]></programlisting>
</section>
<section>
<title>Key attributes and ways of usage</title>
Modified: trunk/docs/userguide/en/src/main/docbook/included/insert.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/insert.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/insert.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -72,7 +72,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.ui.component.html.HtmlInsert;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.ui.component.html.HtmlInsert;
...
HtmlInsert myInsert = new HtmlInsert();
...
@@ -97,7 +97,7 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:insert src="/pages/sourcePage.xhtml" highlight="xhtml"/>
- ...]]></programlisting>
+...]]></programlisting>
<figure>
<para>The result of using <emphasis role="bold">
<property><rich:insert></property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -32,22 +32,23 @@
<para>Simple Component definition on a page:</para>
<para>
- <emphasis role="bold">Example:</emphasis>
+ <emphasis role="bold">Example:</emphasis> </para>
<programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "#{myClass.testBean}"/>]]></programlisting>
- </para>
+
</section>
<section>
<title>Dynamical creation of a component from Java code</title>
<para>
- <emphasis role="bold">Example:</emphasis>
+ <emphasis role="bold">Example:</emphasis> </para>
+
<programlisting role="JAVA"><![CDATA[import org.ajax4jsf.ajax.AjaxKeepAlive;
...
AjaxKeepAlive myKeepAlive = new AjaxKeepAlive();
...
]]></programlisting>
- </para>
+
</section>
<section>
@@ -61,14 +62,13 @@
</emphasis> is used to maintain the state of the whole bean object among subsequent request.
</para>
- <para>
- <emphasis role="bold">Example:</emphasis>
+ <para><emphasis role="bold">Example:</emphasis></para>
+
<programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "#{myClass.testBean}"/>]]></programlisting>
-</para>
<para>
Note that the attribute 'beanName' must point to a legal jsf EL expression which resolves to a managed mean instance. For example for
- the above code the class definition may look like this:
+ the above code the class definition may look like this:</para>
<programlisting role="XML"><![CDATA[
class MyClass{
@@ -78,8 +78,8 @@
...
}
]]></programlisting>
-</para>
+
</section>
<section>
<title>Relevant resources links</title>
Modified: trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/loadBundle.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -32,22 +32,22 @@
<para>Simple component definition on a page:</para>
<para>
- <emphasis role="bold">Example:</emphasis>
+ <emphasis role="bold">Example:</emphasis></para>
<programlisting role="XML"><![CDATA[<a4j:loadBundle baseName="demo.bundle.Messages" var="Message"/>]]></programlisting>
- </para>
+
</section>
<section>
<title>Dynamical creation of a component from Java code</title>
<para>
- <emphasis role="bold">Example:</emphasis>
+ <emphasis role="bold">Example:</emphasis></para>
<programlisting role="JAVA"><![CDATA[import org.ajax4jsf.component.html.AjaxLoadBundle;
...
AjaxLoadBundle myBundle = new AjaxLoadBundle();
...
]]></programlisting>
- </para>
+
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -65,7 +65,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.component.html.HtmlMenuGroup;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlMenuGroup;
...
HtmlMenuGroup myMenuGroup = new HtmlMenuGroup();
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -63,7 +63,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.component.html.HtmlMenuItem;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlMenuItem;
...
HtmlMenuItem myMenuItem = new HtmlMenuItem();
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/menuSeparator.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuSeparator.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuSeparator.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -63,7 +63,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.component.html.HtmlMenuSeparator;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlMenuSeparator;
...
HtmlMenuSeparator myMenuSeparator = new HtmlMenuSeparator();
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -239,7 +239,9 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="JAVA"><![CDATA[onshow="alert(event.parameters.param1)"</programlisting>
+
+ <programlisting role="JAVA"><![CDATA[onshow="alert(event.parameters.param1)"]]></programlisting>
+
<para> Here, during modalPanel opening the value of a passing parameter is output. </para>
<para> More information about this problem could be found on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=111804"
@@ -261,6 +263,7 @@
<a href="javascript:Richfaces.showModalPanel('_panel', {top:'10px', left:'10px', height:'400'});">Show</a>
...
]]></programlisting>
+
<para> Here, if user opens modal dialog window using current link and after submits data then
modalPanel destination and height on new loaded page will be restored. </para>
<para>if you need the content of the modalPanel to be submitted - you need to remember two important rules: </para>
@@ -270,9 +273,9 @@
<listitem>modalPanel must not be included into the form (on any level up) if it has the
form inside.</listitem>
</itemizedlist>
- <para>Simple example of using
- commandButton within modalPanel is placed below.</para>
- <emphasis role="bold">Example:</emphasis>
+ <para>Simple example of using commandButton within modalPanel is placed below.</para>
+ <emphasis role="bold">Example:</emphasis></para>
+
<programlisting role="XML"><![CDATA[...
<rich:modalPanel>
<f:facet name="header">
@@ -291,6 +294,7 @@
</h:form>
...
]]></programlisting>
+
<para>See also discussion about this problem on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4064191"
>RichFaces Users Forum</ulink>.</para>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -76,7 +76,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.component.html.HtmlPanelMenuGroup;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlPanelMenuGroup;
...
HtmlPanelMenuGroup myPanelMenuGroup = new HtmlPanelMenuGroup();
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -76,7 +76,7 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="java"><![CDATA[import org.richfaces.component.html.HtmlPanelMenuItem;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlPanelMenuItem;
...
HtmlPanelMenuItem myPanelMenuItem = new HtmlPanelMenuItem();
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/repeat.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/repeat.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -60,7 +60,8 @@
<para>The main difference of this component from iterative components of other libraries is a special <emphasis >
<property>"ajaxKeys"</property>
</emphasis> attribute. This attribute defines strings that are updated after an Ajax request. As a result it becomes easier to update several child components separately without updating the whole page.</para>
- <programlisting role="JSP"><![CDATA[<a4j:poll intervall="1000" action="#{repeater.action}" reRender="list">
+
+<programlisting role="XML"><![CDATA[<a4j:poll intervall="1000" action="#{repeater.action}" reRender="list">
...
<table>
<tbody>
@@ -75,6 +76,7 @@
<tbody>
<table>
]]></programlisting>
+
<para>Thus, a list with a table structure from <emphasis >
<property>"bean.props"</property>
</emphasis> is output.</para>
@@ -101,7 +103,7 @@
</note>
<para>One more benefit of this component is absence of strictly defined markup as JSF HTML DataTable and Tomahawk DataTable has, hence the components could be used more flexibly anywhere where it's necessary to output the results of selection from some collection.</para>
<para>The next example shows collection output as a plain HTML list</para>
- <programlisting role="JSP"><![CDATA[<ul>
+ <programlisting role="XML"><![CDATA[<ul>
<a4j:repeat ...>
<li>...<li/>
...
Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -139,7 +139,10 @@
<property>"iconLeaf"</property>
</emphasis> attributes define icons for the component. Also you can define icons using facets
with the same names. If the facets are defined, the corresponding attributes are ignored and
- facets contents are used as icons. The width of a rendered facet area is 16px. <programlisting role="JAVA"><![CDATA[...
+ facets contents are used as icons. The width of a rendered facet area is 16px.
+ </para>
+
+ <programlisting role="JAVA"><![CDATA[...
<rich:tree ....>
...
<f:facet name="icon">
@@ -157,7 +160,7 @@
...
</rich:tree>
...
-]]></programlisting></para>
+]]></programlisting>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/included/treeNode.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -82,8 +82,10 @@
<property>"iconLeaf"</property>
</emphasis> attributes define icons for the component. Also you can define icons using facets
with the same names. If the facets are defined, the corresponding attributes are ignored and
- facets contents are used as icons. The width of a rendered facet area is 16px. <programlisting role="JAVA"><![CDATA[...
- <rich:tree ....>
+ facets contents are used as icons. The width of a rendered facet area is 16px. </para>
+
+ <programlisting role="JAVA"><![CDATA[...
+ <rich:tree ...>
...
<rich:treeNode ...>
<f:facet name="icon">
@@ -102,7 +104,7 @@
...
</rich:tree>
...
-]]></programlisting></para>
+]]></programlisting>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCGettingStarted.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -105,7 +105,9 @@
<?dbhtml filename="JSPPage.html"?>
<title>JSP Page</title>
<para>Here is the necessary page (echo.jsp):</para>
- <programlisting role="JSP"> <![CDATA[<%@ taglib uri="http://richfaces.org/a4j" prefix="a4j"%>
+
+ <programlisting role="XML"><![CDATA[
+ <%@ taglib uri="http://richfaces.org/a4j" prefix="a4j"%>
<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<html>
@@ -125,6 +127,7 @@
</f:view>
</body>
</html>]]></programlisting>
+
<para>Only two tags distinguish this page from a "regular" JSF
one. There are <emphasis role="bold">
<property><rich:panel></property>
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml 2007-08-29 11:55:34 UTC (rev 2563)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCfaq.xml 2007-08-29 12:54:34 UTC (rev 2564)
@@ -292,7 +292,7 @@
<h:outputLink value="http://labs.jboss.com/jbossrichfaces/">
<h:outputText value="RichFaces Home Page"></h:outputText>
</h:outputLink>
- </rich: treeNode>
+ </rich:treeNode>
...
</rich:tree ...>
...
More information about the richfaces-svn-commits
mailing list