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

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

Author: vkorluzhenko
Date: 2007-08-16 13:15:05 -0400 (Thu, 16 Aug 2007)
New Revision: 2300

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

Added: trunk/docs/userguide/en/src/main/docbook/included/insert.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/insert.desc.xml	                        (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/insert.desc.xml	2007-08-16 17:15:05 UTC (rev 2300)
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+    <sectioninfo>
+        <keywordset>
+            <keyword>insert</keyword>
+        </keywordset>
+    </sectioninfo>
+    <section>
+        <para>The <emphasis role="bold">
+                <property>&lt;rich:insert&gt;</property>
+        </emphasis> component is used for syntax highlighting.</para>
+    </section>
+    <section>
+        <title>Key Features</title>
+        <itemizedlist>
+            <listitem>Source code highlighting</listitem>
+            <listitem>Variety of formats for source code representation</listitem>
+        </itemizedlist>
+    </section>
+</section>

Added: trunk/docs/userguide/en/src/main/docbook/included/insert.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/insert.xml	                        (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/insert.xml	2007-08-16 17:15:05 UTC (rev 2300)
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+  <sectioninfo>
+    <keywordset>
+      <keyword>insert</keyword>
+    </keywordset>
+  </sectioninfo>
+
+  <table>
+    <title>Component identification parameters</title>
+
+    <tgroup cols="2">
+      <thead>
+        <row>
+          <entry>Name</entry>
+
+          <entry>Value</entry>
+        </row>
+      </thead>
+
+      <tbody>
+        <row>
+          <entry>component-type</entry>
+
+          <entry>org.richfaces.ui.Insert</entry>
+        </row>
+
+        <row>
+          <entry>component-class</entry>
+
+          <entry>org.richfaces.ui.component.html.HtmlInsert</entry>
+        </row>
+
+        <row>
+          <entry>component-family</entry>
+
+          <entry>org.richfaces.ui.Insert</entry>
+        </row>
+
+        <row>
+          <entry>renderer-type</entry>
+
+          <entry>org.richfaces.ui.InsertRenderer</entry>
+        </row>
+
+        <row>
+          <entry>tag-class</entry>
+
+          <entry>org.richfaces.ui.taglib.InsertTag</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </table>
+
+  <section>
+    <title>Creating the Component with a Page Tag</title>
+
+    <para>To create the simplest variant on the page use the following syntax:</para>
+
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="xml">...
+      &lt;rich:insert  src="#{sourcepath}" highlight="#{empty sourcetype? 'xhtml' : sourcetype }"/&gt;
+...</programlisting>
+  </section>
+
+  <section>
+    <title>Creating the Component Dynamically Using Java</title>
+
+    <para>
+      <emphasis role="bold">Example:</emphasis>
+    </para>
+    <programlisting role="java">...
+      org.richfaces.ui.component.html.HtmlInsert myInsert = new  org.richfaces.ui.component.html.HtmlInsert ();
+...</programlisting>
+  </section>
+
+  <section>
+    <title>Details of Usage</title>
+    <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>
+  </section>
+
+</section>