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

[richfaces-svn-commits at lists.jboss.org]

Author: vkorluzhenko
Date: 2007-08-17 10:28:01 -0400 (Fri, 17 Aug 2007)
New Revision: 2320

Modified:
   trunk/docs/userguide/en/src/main/docbook/included/insert.xml
Log:
http://jira.jboss.com/jira/browse/RF-589

Modified: trunk/docs/userguide/en/src/main/docbook/included/insert.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/insert.xml	2007-08-17 14:20:25 UTC (rev 2319)
+++ trunk/docs/userguide/en/src/main/docbook/included/insert.xml	2007-08-17 14:28:01 UTC (rev 2320)
@@ -62,7 +62,7 @@
       <emphasis role="bold">Example:</emphasis>
     </para>
     <programlisting role="xml">...
-      &lt;rich:insert  src="#{sourcepath}" highlight="#{empty sourcetype? 'xhtml' : sourcetype }"/&gt;
+      &lt;rich:insert  src="/pages/sourcePage.xhtml" highlight="xhtml"/&gt;
 ...</programlisting>
   </section>
 
@@ -79,10 +79,35 @@
 
   <section>
     <title>Details of Usage</title>
+    <para>The are two basic attributes. The <emphasis>
+        <property>&quot;src&quot;</property>
+      </emphasis> attribute defines the path to the file with source code. The <emphasis>
+        <property>&quot;highlight&quot;</property>
+      </emphasis> attribute defines a language.</para>
+    <para>An example is placed below.</para>
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="xml">...
+      &lt;rich:insert  src="/pages/sourcePage.xhtml" highlight="xhtml"/&gt;
+      ...</programlisting>
+    <figure>
+      <para>The result of using <emphasis role="bold">
+          <property>&lt;rich:insert&gt;</property>
+        </emphasis> component is shown on the picture:</para>
+      <title>Source code highlighting</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/insert.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
     <para>The <emphasis role="bold">
         <property>&lt;rich:insert&gt;</property>
       </emphasis> component provides the same functionalitity as <ulink
-        url="https://jhighlight.dev.java.net/"> JHighlight.</ulink></para>
+        url="https://jhighlight.dev.java.net/"> JHighlight</ulink>. Thus, all names of highlight
+      style classes for source code of particular language could be changed to user names, wich are
+      used by the <ulink url="https://jhighlight.dev.java.net/">JHighlight</ulink> library.</para>
   </section>
 
 </section>