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

Author: vsukhov Date: 2008-03-28 15:39:15 -0400 (Fri, 28 Mar 2008) New Revision: 7386 Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml trunk/docs/userguide/en/src/main/docbook/included/contextMenu.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/keepAlive.xml trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.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/page.desc.xml trunk/docs/userguide/en/src/main/docbook/included/paint2D.xml trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml trunk/docs/userguide/en/src/main/docbook/included/poll.xml trunk/docs/userguide/en/src/main/docbook/included/push.xml trunk/docs/userguide/en/src/main/docbook/included/tab.xml trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml Log: fixing errors in note sections Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -126,12 +126,12 @@ <para>Calendar loads an initial portion of data in a specified range and use this data to render months. Additional data requests are not sent.</para> <note> - <title>Note:</title><emphasis> + <title>Note:</title><para><emphasis> <property>&quot;preloadDateRangeBegin&quot;</property> </emphasis> and <emphasis> <property>&quot;preloadDateRangeEnd&quot;</property> </emphasis> attributes was designed only for the - <property>&quot;client&quot;</property> mode to load some data initially.</note> + <property>&quot;client&quot;</property> mode to load some data initially.</para></note> <para><emphasis> <property>&quot;ondataselect&quot;</property> </emphasis> attribute is used to define an event that is triggered before date selection.</para> Modified: trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -288,10 +288,14 @@ </emphasis> item&apos;s attributes are ignored. Menu items don't fire any submits themselves. The behavior is fully defined by the components nested inside items.</para> - <note><title>Note:</title> As the <emphasis role="bold"> + <note><title>Note:</title><para> As the <emphasis role="bold"> <property>&lt;rich:contextMenu&gt;</property> </emphasis> component doesn't provide its own form, use it between - &lt;h:form&gt; and &lt;/h:form&gt; tags.</note> + <emphasis role="bold"> + <property>&lt;h:form&gt;</property> + </emphasis> and <emphasis role="bold"> + <property>&lt;/h:form&gt;</property> + </emphasis> tags.</para></note> Modified: trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/dragSupport.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -190,8 +190,8 @@ <para>You can use your own custom JavaScript functions to handle these events.</para> - <note><title>Note:</title> If you define width for a outputPanel, in Internet Explorer 6 you can - perform a drag and drop operation, placing the mouse cursor on the text in the outputPanel only.</note> + <note><title>Note:</title><para> If you define width for a outputPanel, in Internet Explorer 6 you can + perform a drag and drop operation, placing the mouse cursor on the text in the outputPanel only.</para></note> </section> Modified: trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -155,10 +155,10 @@ </emphasis> item&apos;s attributes are ignored. Menu items don&apos;t fire any submits themselves. The behavior is fully defined by the components nested into items.</para> - <note><title>Note:</title> As the <emphasis role="bold"> + <note><title>Note:</title><para> As the <emphasis role="bold"> <property>&lt;rich:dropDownMenu&gt;</property> - </emphasis> component doesn't provide its own form, use it between <emphasis><property>&lt;h:form&gt;</property></emphasis> and - <emphasis><property>&lt;/h:form&gt;</property></emphasis> tags.</note> + </emphasis> component doesn't provide its own form, use it between <emphasis role="bold"><property>&lt;h:form&gt;</property></emphasis> and + <emphasis role="bold"><property>&lt;/h:form&gt;</property></emphasis> tags.</para></note> <para>The <emphasis> <property>"direction"</property> Modified: trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/keepAlive.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -33,7 +33,7 @@ <para> <emphasis role="bold">Example:</emphasis> </para> - <programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "#{myClass.testBean}"/>]]></programlisting> + <programlisting role="XML"><![CDATA[<a4j:keepAlive beanName = "testBean"/>]]></programlisting> </section> Modified: trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/mediaOutput.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -92,7 +92,8 @@ Value specifies a bean class keeping data for transmitting into a method that transmits it into a stream. </listitem> </itemizedlist> - <note><title>Note:</title>A bean class transmitted into value should implement Serializable interface. + <note><title>Note:</title><para>A bean class transmitted into value should implement Serializable interface. + </para> </note> <para>Hence, when using the component it's possible to output your data of any type on a page with Ajax requests.</para> </section> Modified: trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/menuGroup.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -157,9 +157,9 @@ </imageobject> </mediaobject> </figure> - <note><title>Note:</title> The <emphasis role="bold"> + <note><title>Note:</title><para> The <emphasis role="bold"> <property>&lt;rich:menuGroup&gt;</property> - </emphasis> component was designed to be used only for pop-up menu list creation.</note> + </emphasis> component was designed to be used only for pop-up menu list creation.</para></note> </section> <section> Modified: trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -159,9 +159,9 @@ <rich:dropDownMenu> ... ]]></programlisting> - <note><title>Note:</title> The <emphasis role="bold"> + <note><title>Note:</title><para> The <emphasis role="bold"> <property>&lt;rich:menuItem&gt;</property> - </emphasis> component was designed to be used only for pop-up menu list creation.</note> + </emphasis> component was designed to be used only for pop-up menu list creation.</para></note> </section> <section> Modified: trunk/docs/userguide/en/src/main/docbook/included/page.desc.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/page.desc.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/page.desc.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -9,6 +9,6 @@ </sectioninfo> <title>Description</title> - <para><emphasis role="bold"><property>&lt;a4j:page&gt;</property></emphasis> is a deprecated component used for solving of incompatibility problems in early Ajax4jsf and MyFaces versions. The component encodes the full html page structure. </para> + <para><emphasis role="bold"><property>&lt;a4j:page&gt;</property></emphasis> is used for solving of incompatibility problems in early Ajax4jsf versions. The component encodes the full html page structure. </para> </section> </root> Modified: trunk/docs/userguide/en/src/main/docbook/included/paint2D.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/paint2D.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/paint2D.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -95,7 +95,7 @@ </itemizedlist> <para> <note> - <title>Note:</title>data object should implement serializable interface </note> + <title>Note:</title><para>data object should implement serializable interface </para></note> </para> <para>The <emphasis> <property>&quot;format&quot;</property> Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -183,10 +183,10 @@ </rich:panelMenu> ...]]></programlisting> - <note><title>Note:</title> As the <emphasis role="bold"> + <note><title>Note:</title><para> As the <emphasis role="bold"> <property>&lt;rich:panelMenu&gt;</property> </emphasis> component doesn&apos;t provide its own form, use it between - &lt;h:form&gt; and &lt;/h:form&gt; tags.</note> + <emphasis role="bold"> <property>&lt;h:form&gt;</property></emphasis> and <emphasis role="bold"><property>&lt;/h:form&gt;</property> </emphasis> tags.</para></note> <para>The <emphasis> <property>&quot;expandSingle&quot;</property> Modified: trunk/docs/userguide/en/src/main/docbook/included/poll.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/poll.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -137,9 +137,9 @@ <property>&quot;enabled&quot;</property> </emphasis> attribute.</para> - <note><title>Note:</title> The form around the <emphasis role="bold"> + <note><title>Note:</title><para> The form around the <emphasis role="bold"> <property>&lt;a4j:poll&gt;</property> - </emphasis> component is required.</note> + </emphasis> component is required.</para></note> <!--para>The component decodes all necessary JavaScript for time count and on the expiry of some interval for calling of a RichFaces utility method for Ajax request sending (A4J.AJAX.Submit Modified: trunk/docs/userguide/en/src/main/docbook/included/push.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/push.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/push.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -131,9 +131,9 @@ </emphasis> attributes gives an opportunity to set short polls of queue state or long connections, or permanent connection.</para> - <note><title>Note:</title> The form around the <emphasis role="bold"> + <note><title>Note:</title><para> The form around the <emphasis role="bold"> <property>&lt;a4j:push&gt;</property> - </emphasis> component is required.</note> + </emphasis> component is required.</para></note> </section> <!--section> Modified: trunk/docs/userguide/en/src/main/docbook/included/tab.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/tab.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/tab.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -162,8 +162,9 @@ <property>skin parameters.</property> </emphasis></para> - <note><title>Note:</title> + <note><title>Note:</title><para> A panel appearance and content is defined with a <property>tab</property> panel i.e. on the <property>tab</property> level it&apos;s possible to define only an appearance of this <property>tab</property> header. + </para> </note> <para>There are two ways to redefine the appearance of all <emphasis role="bold"> Modified: trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/tabPanel.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -76,10 +76,10 @@ <para>As it was mentioned <link linkend="tabPanel">above</link>, <property>tabPanel</property> groups content on panels and performs switching from one to another. Hence, modes of switching between panels are described first of all.</para> - <note><title>Note:</title> All <property>tabPanels</property> should be wrapped into a form + <note><title>Note:</title><para> All <property>tabPanels</property> should be wrapped into a form element so as content is correctly submitted inside. If a form is placed into each tab, the Action elements of Tab controls appear to be out of the form and content submission inside the - panels could be performed only for Action components inside tabs.</note> + panels could be performed only for Action components inside tabs.</para></note> <para>Switching mode could be chosen with the <property>tabPanel</property> attribute <emphasis> <property>&quot;mode&quot;</property> </emphasis> with three possible parameters.</para> Modified: trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/togglePanel.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -85,9 +85,9 @@ <para>The initial component state is defined with <emphasis> <property>&quot;initialState&quot;</property> </emphasis> attribute, where a facet name that is shown at first is defined.</para> - <note><title>Note:</title> It&apos;s also possible to define an + <note><title>Note:</title><para> It&apos;s also possible to define an <property>&quot;empty&quot;</property> facet to implement the functionality as - drop-down panels have and make the facet active when no content is required to be rendered.</note> + drop-down panels have and make the facet active when no content is required to be rendered.</para></note> <para>Switching mode could be defined with the <emphasis> <property>&quot;switchType&quot;</property> </emphasis> attribute with three possible parameters:</para> Modified: trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml =================================================================== --- trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-03-28 19:28:31 UTC (rev 7385) +++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2008-03-28 19:39:15 UTC (rev 7386) @@ -132,8 +132,9 @@ </para> <note> -<title>Note:</title> +<title>Note:</title> <para> It is recommended to define parent component <emphasis><property>&quot;id&quot;</property></emphasis> for correction of <property>toolTip</property> work. +</para> </note> <para>The attribute <emphasis><property>&quot;for&quot;</property></emphasis> is used for defining the <emphasis><property>&quot;id&quot;</property></emphasis> of an element a toolTip should be attached to. Look at the example: