[richfaces-svn-commits] JBoss Rich Faces SVN: r14722 - branches/community/3.3.X/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Thu Jun 25 07:50:07 EDT 2009
Author: atsebro
Date: 2009-06-25 07:50:05 -0400 (Thu, 25 Jun 2009)
New Revision: 14722
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.desc.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.xml
Log:
RF-7421: a4j:log component description review
Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.desc.xml
===================================================================
--- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.desc.xml 2009-06-25 11:29:12 UTC (rev 14721)
+++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.desc.xml 2009-06-25 11:50:05 UTC (rev 14722)
@@ -8,8 +8,6 @@
</keywordset>
</sectioninfo>
<title>Description</title>
- <para>The <emphasis role="bold">
- <property><a4j:log ></property>
- </emphasis> component generates JavaScript for opening of the window with client-side debug information on an Ajax request.</para>
+ <para>The <emphasis role="bold"><property><a4j:log ></property></emphasis> component generates JavaScript that opens a debug window with useful debug information.</para>
</section>
</root>
\ No newline at end of file
Modified: branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.xml
===================================================================
--- branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.xml 2009-06-25 11:29:12 UTC (rev 14721)
+++ branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/log.xml 2009-06-25 11:50:05 UTC (rev 14722)
@@ -51,36 +51,40 @@
AjaxLog myLog = new AjaxLog();
...]]></programlisting>
</section>
- <section>
- <title>Key attributes and ways of usage</title>
- <para>Usage of the appropriate component attributes could change a representation level of debug information as well as the hot key for a window opening.</para>
- <para>The hot key could be changed with the <emphasis >
- <property>"hotkey"</property>
- </emphasis>
-attribute, where it's necessary to define one letter that together with "CTRL+SHIFT" opens a window.</para>
- <para>The <emphasis >
- <property>"level"</property>
- </emphasis>
-attribute with several possible values ("FATAL", "ERROR", "WARN", "INFO", "ALL") could change a logging level.</para>
- <para>The log could be generated not only in a new window, but also on the current page in a separate <emphasis role="bold"><property><div></property></emphasis>, this is also controlled with the <emphasis >
- <property>"popup"</property>
- </emphasis>
-attribute on the component. </para>
- <para><emphasis role="bold">Example:</emphasis>
+
+ <section>
+ <title>Details of usage</title>
+ <para>
+ The <emphasis role="bold"><property><a4j:log ></property></emphasis> component generates JavaScript that opens a log window with useful debug information,
+ which contains data on requests and responses, DOM tree changes et al.
+ The log could be generated not only in a new window, but also on the current page in a separate <emphasis role="bold"><property><div></property></emphasis> element.
+ This feature is controlled with the component <emphasis><property>"popup"</property></emphasis> attribute.
+ The window is opened on pressing of "CTRL+SHIFT+L", which is default registered key.
+ The hot key could be changed with the <emphasis><property>"hotkey"</property></emphasis> attribute, where it's necessary to define one letter that together with "CTRL+SHIFT" opens a window.
+ </para>
+
+
+ <para>
+ The <emphasis><property>"level"</property></emphasis> attribute has several possible values "FATAL", "ERROR", "WARN", "INFO", "ALL" and is used when it is necessary to change a logging level.
</para>
- <programlisting role="XML"><![CDATA[<a4j:log level="ALL" popup="false" width="400" height="200"/>]]></programlisting>
- <para>The component defined this way is decoded on a page as <emphasis role="bold"><property><div></property></emphasis> inside a page, where all the information beginning with informational message is generated.</para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[<a4j:log level="ALL" popup="false" width="400" height="200"/>]]></programlisting>
+
+ <para>
+ The component defined this way is decoded on a page as <emphasis role="bold"><property><div></property></emphasis> inside a page, where all the information beginning with informational message is generated.</para>
<note>
<title>Note:</title>
- <para><emphasis role="bold"><property><a4j:log></property></emphasis> is getting renewed automatically after execution of Ajax requests. Don't renew <emphasis role="bold"><property><a4j:log></property></emphasis> by using reRender!</para>
+ <para><emphasis role="bold"><property><a4j:log></property></emphasis> is getting renewed automatically after execution of Ajax requests. Do not renew <emphasis role="bold"><property><a4j:log></property></emphasis> by using reRender!</para>
</note>
</section>
-
- <section>
+
+ <section>
<title>Relevant resources links</title>
<para>
- <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/log.jsf?c=log">On the component LiveDemo page</ulink> you can see the example of <emphasis role="bold"
- ><property><a4j:log></property></emphasis> usage and sources for the given example.
+ Vizit the <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/log.jsf?c=log">Log page</ulink> at RichFaces LiveDemo for example of component usage and their sources.
</para>
</section>
</chapter>
More information about the richfaces-svn-commits
mailing list