The <rich:insert> component is used for highlighting, source code inserting and, optionally, format the file from the application context into the page.

The are two basic attributes. The "src" attribute defines the path to the file with source code. The "highlight" attribute defines the type of a syntax highlighting.

If "highlight" attribute is defined and JHighlight open source library is in the classpath, the text from the file is formated and colorized.

An example is placed below:

<rich:insert  src="/pages/sourcePage.xhtml" highlight="xhtml"/>

The result of using <rich:insert> component is shown on the picture:

Figure 6.184. Source code highlighting with the help of <rich:Insert>>

The <rich:insert> component provides the same functionality as JHighlight. Thus, all names of highlight style classes for source code of particular language could be changed to your names, which are used by the JHighlight library.

The "errorContent" attribute defines the alternative content that will be shown in case the <rich:insert> cannot read the resource defined with "src" attribute. If "errorContent" attribute is not defined, the component shown the actual error message in the place where the content is expected.

Table of <rich:insert> attributes.

Visit the Insert page at RichFaces LiveDemo for examples of component usage and their sources.