OLD | NEW |
| (Empty) |
1 <refentry xmlns="http://docbook.org/ns/docbook" | |
2 xmlns:xlink="http://www.w3.org/1999/xlink" | |
3 xmlns:xi="http://www.w3.org/2001/XInclude" | |
4 xmlns:src="http://nwalsh.com/xmlns/litprog/fragment" | |
5 xmlns:xsl="http://www.w3.org/1999/XSL/Transform" | |
6 version="5.0" xml:id="highlight.source"> | |
7 <refmeta> | |
8 <refentrytitle>highlight.source</refentrytitle> | |
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo> | |
10 </refmeta> | |
11 <refnamediv> | |
12 <refname>highlight.source</refname> | |
13 <refpurpose>Should the content of <tag>programlisting</tag> | |
14 be syntactically highlighted?</refpurpose> | |
15 </refnamediv> | |
16 | |
17 <refsynopsisdiv> | |
18 <src:fragment xml:id="highlight.source.frag"> | |
19 <xsl:param name="highlight.source" select="0"/> | |
20 </src:fragment> | |
21 </refsynopsisdiv> | |
22 | |
23 <refsection><info><title>Description</title></info> | |
24 | |
25 <para>When this parameter is non-zero, the stylesheets will try to do syntax hig
hlighting of the | |
26 content of <tag>programlisting</tag> elements. You specify the language for each
programlisting | |
27 by using the <tag class="attribute">language</tag> attribute. The <parameter>hig
hlight.default.language</parameter> | |
28 parameter can be used to specify the language for programlistings without a <tag
class="attribute">language</tag> | |
29 attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsi
s</tag> elements.</para> | |
30 | |
31 <para>The actual highlighting work is done by the XSLTHL extension module. This
is an external Java library that has to be | |
32 downloaded separately (see below).</para> | |
33 | |
34 <itemizedlist> | |
35 <para>In order to use this extension, you must</para> | |
36 | |
37 <listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath
. The latest version is available | |
38 from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax h
ighlighting project</link> | |
39 at SourceForge.</para> | |
40 </listitem> | |
41 <listitem> | |
42 <para>use a customization layer in which you import one of the following stylesh
eet modules: | |
43 <itemizedlist> | |
44 <listitem> | |
45 <para><filename>html/highlight.xsl</filename> | |
46 </para> | |
47 </listitem> | |
48 <listitem> | |
49 <para><filename>xhtml/highlight.xsl</filename> | |
50 </para> | |
51 </listitem> | |
52 <listitem> | |
53 <para><filename>xhtml-1_1/highlight.xsl</filename> | |
54 </para> | |
55 </listitem> | |
56 <listitem> | |
57 <para><filename>fo/highlight.xsl</filename> | |
58 </para> | |
59 </listitem> | |
60 </itemizedlist> | |
61 </para> | |
62 </listitem> | |
63 <listitem><para>let either the <literal>xslthl.config</literal> Java system prop
erty or the | |
64 <parameter>highlight.xslthl.config</parameter> parameter point to the configurat
ion file for syntax | |
65 highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configura
tion file, | |
66 <filename>highlighting/xslthl-config.xml</filename>.</para> | |
67 </listitem> | |
68 </itemizedlist> | |
69 | |
70 <para>The extension works with Saxon 6.5.x and Xalan-J. (Saxon 8.5 or later is a
lso supported, but since it is | |
71 an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circu
mstances.)</para> | |
72 | |
73 <para>The following is an example of a Saxon 6 command adapted for syntax highli
ghting, to be used on Windows:</para> | |
74 | |
75 <informalexample> | |
76 <para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar | |
77 -Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.sa
xon.StyleSheet | |
78 -o test.html test.xml myhtml.xsl</command></para> | |
79 </informalexample> | |
80 | |
81 </refsection> | |
82 </refentry> | |
OLD | NEW |