Author: atsebro
Date: 2009-08-27 08:15:13 -0400 (Thu, 27 Aug 2009)
New Revision: 15340
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_insert.xml
Log:
RF-7756: Rich Miscellaneous component group description review --> rich:Insert
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_insert.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_insert.xml 2009-08-27
12:00:50 UTC (rev 15339)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_insert.xml 2009-08-27
12:15:13 UTC (rev 15340)
@@ -1,125 +1,114 @@
<section role="NotInToc" id="rich_insert">
- <title>
- <
- rich:insert
- >
- <emphasis role="since">
- <superscript> available since <emphasis
role="version">3.1.0</emphasis>
- </superscript>
- </emphasis>
- </title>
- <section>
- <title>Description</title>
- <para>The <emphasis role="bold">
- <property><rich:insert></property>
- </emphasis> component is used for highlighting, source code inserting and,
optionally, format the file from the application context into the page.</para>
- </section>
- <section>
- <title>Key Features</title>
- <itemizedlist>
- <listitem>
- <para>Source code highlighting</para>
- </listitem>
- <listitem>
- <para>Variety of formats for source code highlighting</para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Details of Usage</title>
- <para>The are two basic attributes. The <emphasis>
- <property>"src"</property>
- </emphasis> attribute defines the path to the file with source code. The
<emphasis>
- <property>"highlight"</property>
- </emphasis> attribute defines the type of a syntax
highlighting.</para>
- <para>If <emphasis>
- <property>"highlight"</property>
- </emphasis> attribute is defined and <ulink
url="https://jhighlight.dev.java.net/">
- JHighlight</ulink> open source library is in the classpath, the text from the
file is
- formated and colorized.</para>
- <para>An example is placed below.</para>
- <para>
- <emphasis role="bold">Example:</emphasis>
- </para>
- <programlisting role="XML">...
+ <title> < rich:insert > <emphasis
role="since">
+ <superscript> available since <emphasis
role="version">3.1.0</emphasis>
+ </superscript>
+ </emphasis>
+ </title>
+ <section>
+ <title>Description</title>
+ <para>The <emphasis role="bold">
+ <property><rich:insert></property>
+ </emphasis> component is used for highlighting, source code
inserting and, optionally, format the file from the application context into the
page.</para>
+ </section>
+ <section>
+ <title>Key Features</title>
+ <itemizedlist>
+ <listitem>
+ <para>Source code highlighting</para>
+ </listitem>
+ <listitem>
+ <para>Variety of formats for source code
highlighting</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>Details of Usage</title>
+ <para>The are two basic attributes. The <emphasis>
+ <property>"src"</property>
+ </emphasis> attribute defines the path to the file with source
code. The <emphasis>
+ <property>"highlight"</property>
+ </emphasis> attribute defines the type of a syntax
highlighting.</para>
+ <para>If <emphasis>
+ <property>"highlight"</property>
+ </emphasis> attribute is defined and <ulink
url="https://jhighlight.dev.java.net/"> JHighlight</ulink> open source
library is in the classpath, the text from the file is formated and
colorized.</para>
+ <para>An example is placed below.</para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML">...
<rich:insert src="/pages/sourcePage.xhtml"
highlight="xhtml"/>
...</programlisting>
-
- <para>The result of using <emphasis role="bold">
- <property><rich:insert></property>
- </emphasis> component is shown on the picture:</para>
- <figure>
- <title>Source code highlighting</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/insert_init.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The <emphasis role="bold">
- <property><rich:insert></property>
- </emphasis> component provides the same functionality as <ulink
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 your
names, which are
- used by the <ulink
url="https://jhighlight.dev.java.net/">JHighlight</ulink>
library.</para>
- </section>
- <section>
- <title>Reference Data</title>
- <para>
- <ulink url="&tlddoc;rich/insert.html">Table of
- <rich:insert>
- attributes</ulink>.
- </para>
- <table>
- <title>Component Identification Parameters</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Name</entry>
+ <para>The result of using <emphasis role="bold">
+ <property><rich:insert></property>
+ </emphasis> component is shown on the picture:</para>
+ <figure>
+ <title>Source code highlighting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/insert_init.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The <emphasis role="bold">
+ <property><rich:insert></property>
+ </emphasis> component provides the same functionality as
<ulink
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 your names, which are used by the <ulink
url="https://jhighlight.dev.java.net/">JHighlight</ulink>
library.</para>
+ </section>
+ <section>
+ <title>Reference Data</title>
+ <para>
+ <ulink url="&tlddoc;rich/insert.html">Table of
<rich:insert> attributes</ulink>. </para>
+ <table>
+ <title>Component Identification Parameters</title>
- <entry>Value</entry>
- </row>
- </thead>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Name</entry>
- <tbody>
- <row>
- <entry>component-type</entry>
+ <entry>Value</entry>
+ </row>
+ </thead>
- <entry>org.richfaces.ui.Insert</entry>
- </row>
+ <tbody>
+ <row>
+ <entry>component-type</entry>
- <row>
- <entry>component-class</entry>
+ <entry>org.richfaces.ui.Insert</entry>
+ </row>
- <entry>org.richfaces.ui.component.html.HtmlInsert</entry>
- </row>
+ <row>
+ <entry>component-class</entry>
- <row>
- <entry>component-family</entry>
+
<entry>org.richfaces.ui.component.html.HtmlInsert</entry>
+ </row>
- <entry>org.richfaces.ui.Insert</entry>
- </row>
+ <row>
+ <entry>component-family</entry>
- <row>
- <entry>renderer-type</entry>
+ <entry>org.richfaces.ui.Insert</entry>
+ </row>
- <entry>org.richfaces.ui.InsertRenderer</entry>
- </row>
+ <row>
+ <entry>renderer-type</entry>
- <row>
- <entry>tag-class</entry>
+
<entry>org.richfaces.ui.InsertRenderer</entry>
+ </row>
- <entry>org.richfaces.ui.taglib.InsertTag</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
- <section>
- <title>Relevant Resources Links</title>
- <para>
- <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/insert.jsf?...
RichFaces LiveDemo page </ulink> you can found some additional information for
<emphasis role="bold">
- <property><rich:insert></property>
- </emphasis> component usage. </para>
- </section>
+ <row>
+ <entry>tag-class</entry>
+
+
<entry>org.richfaces.ui.taglib.InsertTag</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section>
+ <title>Relevant Resources Links</title>
+ <para>
+ Visit the <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/insert.jsf?...
page</ulink> at RichFaces LiveDemo page for examples of component usage and their
sources.
+ </para>
+ </section>
</section>
\ No newline at end of file