<section role="NotInToc" id="rich_insert">
      <title> &lt; rich:insert &gt; <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>&lt;rich:insert&gt;</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>
            <programlisting role="XML"><![CDATA[<rich:insert  src="/pages/sourcePage.xhtml" highlight="xhtml"/>]]></programlisting>

            <para>The result of using <emphasis role="bold"><property>&lt;rich:insert&gt;</property></emphasis> component is shown on the picture:</para>
            <figure>
                  <title>Source code highlighting with the help of &lt;rich:Insert&gt;></title>
                  <mediaobject>
                        <imageobject>
                              <imagedata fileref="images/insert_init.png"/>
                        </imageobject>
                  </mediaobject>
            </figure>
            <para>The <emphasis role="bold">
                        <property>&lt;rich:insert&gt;</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>
            <para>
                  The <emphasis><property>&quot;errorContent&quot;</property></emphasis> attribute defines the alternative content that will be shown in case the <emphasis role="bold"><property>&lt;rich:insert&gt;</property></emphasis> cannot read the resource defined with <emphasis><property>&quot;src&quot;</property></emphasis> attribute. 
                  If <emphasis><property>&quot;errorContent&quot;</property></emphasis> attribute is not defined, the component shown the actual error message in the place where the content is expected. 
            </para>
      </section>
      <section>
            <title>Reference Data</title>
            <para>
                  <ulink url="&tlddoc;rich/insert.html">Table of &lt;rich:insert&gt; attributes</ulink>. </para>
            <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>
      <section>
            <title>Relevant Resources Links</title>
            <para>
                  Visit the <ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/insert.jsf?c=insert">Insert page</ulink> at RichFaces LiveDemo for examples of component usage and their sources.
            </para>
      </section>
</section>
