blob: c4eb1a836f10222a0938b0a071f32f50d9bac9c9 [file] [log] [blame]
<refentry xmlns=""
version="5.0" xml:id="highlight.source">
<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
<refpurpose>Should the content of <tag>programlisting</tag>
be syntactically highlighted?</refpurpose>
<src:fragment xml:id="highlight.source.frag">
<xsl:param name="highlight.source" select="0"/>
<para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the
content of <tag>programlisting</tag> elements. You specify the language for each programlisting
by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter>
parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag>
attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>
<para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be
downloaded separately (see below).</para>
<para>In order to use this extension, you must</para>
<listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available
from <link xlink:href="">the XSLT syntax highlighting project</link>
at SourceForge.</para>
<para>use a customization layer in which you import one of the following stylesheet modules:
<listitem><para>let either the <literal>xslthl.config</literal> Java system property or the
<parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax
highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file,
<para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is also supported, but since it is
an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>
<para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>
<para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar
-Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet
-o test.html test.xml myhtml.xsl</command></para>