doc/xslt/params/highlight.source.xml

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