[richfaces-svn-commits] JBoss Rich Faces SVN: r2531 - trunk/docs/userguide/en/src/main/docbook/included.

richfaces-svn-commits at lists.jboss.org richfaces-svn-commits at lists.jboss.org
Tue Aug 28 08:44:27 EDT 2007


Author: smukhina
Date: 2007-08-28 08:44:27 -0400 (Tue, 28 Aug 2007)
New Revision: 2531

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
   trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml
   trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml
   trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
   trunk/docs/userguide/en/src/main/docbook/included/dropSupport.xml
   trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
Log:
http://jira.jboss.com/jira/browse/RF-744
some tags are corrected 

Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml	2007-08-28 12:24:53 UTC (rev 2530)
+++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml	2007-08-28 12:44:27 UTC (rev 2531)
@@ -62,7 +62,7 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-      &lt;rich:calendar popup="false"/&gt;
+      <rich:calendar popup="false"/>
 ...]]></programlisting>
   </section>
 
@@ -162,11 +162,11 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-      &lt;f:facet name="header"&gt;
-            &lt;f:verbatim&gt;
+      <f:facet name="header">
+            <f:verbatim>
                   {previousMonthControl} | {nextMonthControl}					
-            &lt;/f:verbatim&gt;
-      &lt;/f:facet&gt;
+            </f:verbatim>
+      </f:facet>
 ...]]></programlisting>
     <para>It&apos;s possible to define <emphasis>
         <property>&quot;footer&quot;</property>
@@ -192,9 +192,9 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-      &lt;f:facet name="weekNumber"&gt;
-            &lt;h:outputText style="font-weight: bold;" value="{weekNumber}" /&gt;
-      &lt;/f:facet&gt;
+      <f:facet name="weekNumber">
+            <h:outputText style="font-weight: bold;" value="{weekNumber}" />
+      </f:facet>
 ...]]></programlisting>
 
     <para>The example of using JavaScript API is placed below:</para>

Modified: trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml	2007-08-28 12:24:53 UTC (rev 2530)
+++ trunk/docs/userguide/en/src/main/docbook/included/dndParam.xml	2007-08-28 12:44:27 UTC (rev 2531)
@@ -58,10 +58,10 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;rich:dragSupport dragType="file"&gt;
-        &lt;rich:dndParam name="testDrag" value="testDragValue" 
-                        type="drag"/&gt;
-    &lt;/rich:dragSupport&gt;
+    <rich:dragSupport dragType="file">
+        <rich:dndParam name="testDrag" value="testDragValue" 
+                        type="drag"/>
+    </rich:dragSupport>
 ...
 ]]></programlisting>
   </section>
@@ -106,12 +106,12 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="JSP"><![CDATA[...
-    &lt;rich:dragSupport ...&gt; 
-        &lt;rich:dndParam type="drag" name="dragging"&gt; 
-            &lt;h:graphicImage value="/img/product1_small.png"/&gt; 
-        &lt;/rich:dndParam&gt; 
-        &lt;h:graphicImage value="product1.png"/&gt; 
-    &lt;/rich:dragSupport&gt;
+    <rich:dragSupport ...> 
+        <rich:dndParam type="drag" name="dragging"> 
+            <h:graphicImage value="/img/product1_small.png"/> 
+        </rich:dndParam> 
+        <h:graphicImage value="product1.png"/> 
+    </rich:dragSupport>
 ...
 ]]></programlisting>
 
@@ -132,10 +132,10 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="JSP"><![CDATA[...
-    &lt;rich:dragSupport ...&gt; 
-        &lt;rich:dndParam type="drag" name="label" value="#{msg.subj}"/&gt;
+    <rich:dragSupport ...> 
+        <rich:dndParam type="drag" name="label" value="#{msg.subj}"/>
         ...
-    &lt;/rich:dragSupport&gt;
+    </rich:dragSupport>
 ...
 ]]></programlisting>
 
@@ -156,12 +156,12 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="JSP"><![CDATA[...
-    &lt;rich:dropSupport ...&gt; 
-        &lt;rich:dndParam type="drop" name="comp" &gt; 
-            &lt;h:graphicImage height="16" width="16" value="/images/comp.png"/&gt; 
-        &lt;/rich:dndParam&gt;
+    <rich:dropSupport ...> 
+        <rich:dndParam type="drop" name="comp" > 
+            <h:graphicImage height="16" width="16" value="/images/comp.png"/> 
+        </rich:dndParam>
         ...
-    &lt;/rich:dropSupport &gt;
+    </rich:dropSupport >
 ...
 ]]></programlisting>
 

Modified: trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml	2007-08-28 12:24:53 UTC (rev 2530)
+++ trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml	2007-08-28 12:44:27 UTC (rev 2531)
@@ -66,10 +66,10 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;h:panelGrid id="drag1"&gt;
-        &lt;rich:dragSupport dragType="item"/&gt;
-            &lt;!--Some content to be dragged--&gt;
-    &lt;/h:panelGrid&gt;
+    <h:panelGrid id="drag1">
+        <rich:dragSupport dragType="item"/>
+            <!--Some content to be dragged-->
+    </h:panelGrid>
 ...
 ]]></programlisting>
   </section>
@@ -102,12 +102,12 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;h:column&gt;
-        &lt;rich:dragSupport dragIndicator=":form:iii" dragType="text"&gt;
-            &lt;a4j:actionparam value="#{caps.name}" name="name"/&gt;
-        &lt;/rich:dragSupport&gt;
-        &lt;h:outputText value="#{caps.name}"/&gt; 
-    &lt;/h:column&gt;
+    <h:column>
+        <rich:dragSupport dragIndicator=":form:iii" dragType="text">
+            <a4j:actionparam value="#{caps.name}" name="name"/>
+        </rich:dragSupport>
+        <h:outputText value="#{caps.name}"/> 
+    </h:column>
 ...
 ]]></programlisting>
 
@@ -119,14 +119,14 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;h:column&gt;
-        &lt;a4j:outputPanel&gt;
-            &lt;rich:dragSupport dragIndicator=":form:iii" dragType="text"&gt;
-                &lt;a4j:actionparam value="#{caps.name}" name="name"/&gt;
-            &lt;/rich:dragSupport&gt;
-            &lt;h:outputText value="#{caps.name}"/&gt; 
-        &lt;/a4j:outputPanel&gt;
-    &lt;/h:column&gt;
+    <h:column>
+        <a4j:outputPanel>
+            <rich:dragSupport dragIndicator=":form:iii" dragType="text">
+                <a4j:actionparam value="#{caps.name}" name="name"/>
+            </rich:dragSupport>
+            <h:outputText value="#{caps.name}"/> 
+        </a4j:outputPanel>
+    </h:column>
 ...
 ]]></programlisting>
 
@@ -142,20 +142,20 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;h:panelGrid id="drag1"&gt;
-        &lt;rich:dragSupport dragType="singleItems" .../&gt;
-        &lt;!--Some content to be dragged--&gt;
-    &lt;/h:panelGrid&gt;		
+    <h:panelGrid id="drag1">
+        <rich:dragSupport dragType="singleItems" .../>
+        <!--Some content to be dragged-->
+    </h:panelGrid>		
 ...
-    &lt;h:panelGrid id="drag2"&gt;
-        &lt;rich:dragSupport dragType="groups" .../&gt;
-        &lt;!--Some content to be dragged--&gt;
-    &lt;/h:panelGrid&gt;		
+    <h:panelGrid id="drag2">
+        <rich:dragSupport dragType="groups" .../>
+        <!--Some content to be dragged-->
+    </h:panelGrid>		
 ...
-    &lt;h:panelGrid id="drop1"&gt;
-        &lt;rich:dropSupport acceptedTypes="singleItems" .../&gt;
-        &lt;!--Drop zone content--&gt;
-    &lt;/h:panelGrid&gt;
+    <h:panelGrid id="drop1">
+        <rich:dropSupport acceptedTypes="singleItems" .../>
+        <!--Drop zone content-->
+    </h:panelGrid>
 ...
 ]]></programlisting>
 

Modified: trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml	2007-08-28 12:24:53 UTC (rev 2530)
+++ trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml	2007-08-28 12:44:27 UTC (rev 2531)
@@ -62,9 +62,9 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-    &lt;rich:dropDownMenu value="Item1"&gt;
-        &lt;!--Nested menu components--&gt;
-    &lt;/rich:dropDownMenu&gt;
+    <rich:dropDownMenu value="Item1">
+        <!--Nested menu components-->
+    </rich:dropDownMenu>
 ...
   </programlisting>
   </section>
@@ -103,9 +103,9 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-    &lt;f:facet name="label"&gt;
-        &lt;h:graphicImage value="/images/img1.gif"/&gt;
-    &lt;/f:facet&gt;
+    <f:facet name="label">
+        <h:graphicImage value="/images/img1.gif"/>
+    </f:facet>
 ...
   </programlisting>
 
@@ -119,9 +119,9 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-    &lt;rich:dropDownMenu event="onclick" value="Item1"&gt;
-        &lt;!--Nested menu components--&gt;
-    &lt;/rich:dropDownMenu&gt;
+    <rich:dropDownMenu event="onclick" value="Item1">
+        <!--Nested menu components-->
+    </rich:dropDownMenu>
 ...]]></programlisting>
 
     <para>The <emphasis role="bold">
@@ -240,9 +240,9 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-    &lt;rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr"&gt;
-        &lt;!--Nested menu components--&gt;
-    &lt;/rich:dropDownMenu&gt;
+    <rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr">
+        <!--Nested menu components-->
+    </rich:dropDownMenu>
 ...
 ]]></programlisting>
 
@@ -272,9 +272,9 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml"><![CDATA[...
-    &lt;rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr" horizontalOffset="-15" verticalOffset="0"&gt;
-        &lt;!--Nested menu components--&gt;
-    &lt;/rich:dropDownMenu&gt;
+    <rich:dropDownMenu value="Item1" direction="bottom-right" jointPoint="tr" horizontalOffset="-15" verticalOffset="0">
+        <!--Nested menu components-->
+    </rich:dropDownMenu>
 ...
         </programlisting>
 

Modified: trunk/docs/userguide/en/src/main/docbook/included/dropSupport.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dropSupport.xml	2007-08-28 12:24:53 UTC (rev 2530)
+++ trunk/docs/userguide/en/src/main/docbook/included/dropSupport.xml	2007-08-28 12:44:27 UTC (rev 2531)
@@ -67,9 +67,9 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;rich:panel&gt;
-        &lt;rich:dropSupport acceptedTypes="text"/&gt;
-    &lt;/rich:panel&gt;
+    <rich:panel>
+        <rich:dropSupport acceptedTypes="text"/>
+    </rich:panel>
 ...
 ]]></programlisting>
   </section>
@@ -92,21 +92,21 @@
     <title>Details of Usage</title>
 
     <para>As shown in the example, the key attribute for <emphasis role="bold">
-        <property>&lt;rich:dropSupport&gt;</property>
+        <property><rich:dropSupport&gt;</property>
       </emphasis> is <emphasis>
         <property>"acceptedTypes"</property>
       </emphasis>. This attribute defines the types of draggable items that can be dropped onto the
       designated drop zone.</para>
 
     <para>The second most important attribute for <emphasis role="bold">
-        <property>&lt;rich:dropSupport&gt;</property>
+        <property><rich:dropSupport&gt;</property>
       </emphasis> is <emphasis>
         <property>"typeMapping"</property>
       </emphasis>. This attribute maps a specific type among the acceptable types for draggable
       items to a specific <emphasis role="bold">
-        <property>&lt;rich:dndParam&gt;</property>
+        <property><rich:dndParam&gt;</property>
       </emphasis> child element under <emphasis role="bold">
-        <property>&lt;rich:dropSupport&gt;</property>
+        <property><rich:dropSupport&gt;</property>
       </emphasis>.</para>
 
 
@@ -114,10 +114,10 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;rich:dropSupport acceptedTypes="[iconsDragged, textDragged]" typeMapping="{iconsDragged: DropIcon}"&gt; 
-        &lt;rich:dndParam name="DropIcon"&gt;
-            &lt;h:graphicImage value="/images/drop-icon.png"/&gt;
-		&lt;/rich:dndParam&gt;
+    <rich:dropSupport acceptedTypes="[iconsDragged, textDragged]" typeMapping="{iconsDragged: DropIcon}"> 
+        <rich:dndParam name="DropIcon">
+            <h:graphicImage value="/images/drop-icon.png"/>
+		</rich:dndParam>
 ...
 ]]></programlisting>
 
@@ -138,17 +138,17 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;rich:dataTable value="#{capitalsBean.capitals}" var="caps"&gt;
-        &lt;f:facet name="caption"&gt;Capitals List&lt;/f:facet&gt;
-        &lt;h:column&gt;
-        &lt;a4j:outputPanel&gt;
-            &lt;rich:dragSupport dragIndicator=":form:ind" dragType="text"&gt;
-                &lt;a4j:actionparam value="#{caps.name}" name="name"/&gt;
-            &lt;/rich:dragSupport&gt;
-            &lt;h:outputText value="#{caps.name}"/&gt; 
-        &lt;/a4j:outputPanel&gt;
-        &lt;/h:column&gt;
-    &lt;/rich:dataTable&gt;
+    <rich:dataTable value="#{capitalsBean.capitals}" var="caps">
+        <f:facet name="caption">Capitals List</f:facet>
+        <h:column>
+        <a4j:outputPanel>
+            <rich:dragSupport dragIndicator=":form:ind" dragType="text">
+                <a4j:actionparam value="#{caps.name}" name="name"/>
+            </rich:dragSupport>
+            <h:outputText value="#{caps.name}"/> 
+        </a4j:outputPanel>
+        </h:column>
+    </rich:dataTable>
 ...
 ]]></programlisting>
 
@@ -160,11 +160,11 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;rich:panel style="width:100px;height:100px;"&gt;
-        &lt;f:facet name="header"&gt;Drop Zone&lt;/f:facet&gt;
-        &lt;rich:dropSupport acceptedTypes="text" reRender="box" 
-                        dropListener="#{capitalsBean.addCapital2}"/&gt;
-    &lt;/rich:panel&gt;
+    <rich:panel style="width:100px;height:100px;">
+        <f:facet name="header">Drop Zone</f:facet>
+        <rich:dropSupport acceptedTypes="text" reRender="box" 
+                        dropListener="#{capitalsBean.addCapital2}"/>
+    </rich:panel>
 ...
 ]]></programlisting>
 
@@ -176,12 +176,12 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;rich:dataTable value="#{capitalsBean.capitals2}" var="cap2" id="box"&gt;
-        &lt;f:facet name="caption"&gt;Capitals chosen&lt;/f:facet&gt;
-        &lt;h:column&gt;
-            &lt;h:outputText value="#{cap2.name}"/&gt;
-        &lt;/h:column&gt;
-    &lt;/rich:dataTable&gt;
+    <rich:dataTable value="#{capitalsBean.capitals2}" var="cap2" id="box">
+        <f:facet name="caption">Capitals chosen</f:facet>
+        <h:column>
+            <h:outputText value="#{cap2.name}"/>
+        </h:column>
+    </rich:dataTable>
 ...]]></programlisting>
 
     <para>And finally, as a listener, this listener will implement the dropped element:</para>
@@ -217,7 +217,7 @@
       common Ajax request is performed that renders results in the third table.</para>
 
     <para>As with every Ajax action component, <emphasis role="bold">
-        <property>&lt;rich:dropSupport&gt;</property>
+        <property><rich:dropSupport&gt;</property>
       </emphasis> has all the common attributes (<emphasis><property>"timeout"</property>,</emphasis>
       <emphasis><property>"limitToList"</property>,</emphasis>
       <emphasis><property>"reRender"</property>,</emphasis> etc.) for Ajax request customization. To
@@ -252,7 +252,7 @@
     <para>
       <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/dragSupport.jsf?c=dropSupport"
         >Here</ulink> you can see the example of <emphasis role="bold"
-        >&lt;rich:dropSupport&gt;</emphasis> usage and sources for the given example.
+        ><rich:dropSupport&gt;</emphasis> usage and sources for the given example.
     </para>
   </section>
 

Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml	2007-08-28 12:24:53 UTC (rev 2530)
+++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml	2007-08-28 12:44:27 UTC (rev 2531)
@@ -66,17 +66,17 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;rich:modalPanel id=&quot;panel&quot;&gt;
-        &lt;f:facet name="header"&gt;
-            &lt;h:outputText value="header"&gt;
-        &lt;/f:facet&gt;
+    <rich:modalPanel id=&quot;panel&quot;>
+        <f:facet name="header">
+            <h:outputText value="header">
+        </f:facet>
         ...
-        &lt;!--Any Content inside--&gt;
+        <!--Any Content inside-->
         ...
-        &lt;a href="javascript:RichFaces.hideModalPanel('form:panel')"&gt;Hide&lt;/a&gt;
-    &lt;/rich:modalpanel&gt;
+        <a href="javascript:RichFaces.hideModalPanel('form:panel')">Hide</a>
+    </rich:modalpanel>
 ...
-    &lt;a href="javascript:RichFaces.showModalPanel('form:panel')"&gt;Show&lt;/a&gt;
+    <a href="javascript:RichFaces.showModalPanel('form:panel')">Show</a>
 ...
 ]]></programlisting>
   </section>
@@ -144,16 +144,16 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="XML"><![CDATA[...
-    &lt;form jsfc="h:form" id="form"&gt;
-        &lt;rich:modalPanel id="panel" width="400" height="300"&gt;
-            &lt;f:facet name="header"&gt;
-                &lt;h:outputText value="Modal Panel"/&gt;
-            &lt;/f:facet&gt;
-        &lt;h:graphicImage value="/pages/california_large.gif"/&gt;
-        &lt;a href="javascript:Richfaces.hideModalPanel('form:panel')"&gt;Close&lt;/a&gt;
-        &lt;/rich:modalPanel&gt;
-        &lt;a href="javascript:Richfaces.showModalPanel('form:panel');"&gt;Open&lt;/a&gt;
-    &lt;/form&gt;
+    <form jsfc="h:form" id="form">
+        <rich:modalPanel id="panel" width="400" height="300">
+            <f:facet name="header">
+                <h:outputText value="Modal Panel"/>
+            </f:facet>
+        <h:graphicImage value="/pages/california_large.gif"/>
+        <a href="javascript:Richfaces.hideModalPanel('form:panel')">Close</a>
+        </rich:modalPanel>
+        <a href="javascript:Richfaces.showModalPanel('form:panel');">Open</a>
+    </form>
 ...
 ]]></programlisting>
 
@@ -177,14 +177,14 @@
     <para>
       <emphasis role="bold">Example:</emphasis>
     </para>
-    <programlisting role="XML">
-    &lt;rich:modalPanel id="panel"&gt;
-        &lt;f:facet name="header"&gt;&lt;h:outputText value="Modal Panel"/&gt;&lt;/f:facet&gt;
-        &lt;f:facet name="controls"&gt;
-            &lt;a href="javascript:Richfaces.hideModalPanel('form:panel')"&gt;X&lt;/a&gt;
-        &lt;/f:facet&gt;
-        &lt;h:graphicImage value="/pages/california_large.gif"/&gt;
-    &lt;/rich:modalPanel&gt;
+    <programlisting role="XML"><![CDATA[...
+    <rich:modalPanel id="panel">
+        <f:facet name="header"><h:outputText value="Modal Panel"/></f:facet>
+        <f:facet name="controls">
+            <a href="javascript:Richfaces.hideModalPanel('form:panel')">X</a>
+        </f:facet>
+        <h:graphicImage value="/pages/california_large.gif"/>
+    </rich:modalPanel>
 ]]></programlisting>
 
     <para>The result displays like this:</para>




More information about the richfaces-svn-commits mailing list