DocBook documentation stub added

[stg.git] / doc / help / xslt / params / highlight.source.xml

diff --git a/doc/help/xslt/params/highlight.source.xml b/doc/help/xslt/params/highlight.source.xml
new file mode 100644 (file)
index 0000000..41d7b2f
--- /dev/null
+++ b/doc/help/xslt/params/highlight.source.xml
@@ -0,0 +1,82 @@
+<refentry xmlns="http://docbook.org/ns/docbook"\r
+          xmlns:xlink="http://www.w3.org/1999/xlink"\r
+          xmlns:xi="http://www.w3.org/2001/XInclude"\r
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"\r
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"\r
+          version="5.0" xml:id="highlight.source">\r
+<refmeta>\r
+<refentrytitle>highlight.source</refentrytitle>\r
+<refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>\r
+</refmeta>\r
+<refnamediv>\r
+<refname>highlight.source</refname>\r
+<refpurpose>Should the content of <tag>programlisting</tag>\r
+be syntactically highlighted?</refpurpose>\r
+</refnamediv>\r
+\r
+<refsynopsisdiv>\r
+<src:fragment xml:id="highlight.source.frag">\r
+<xsl:param name="highlight.source" select="0"/>\r
+</src:fragment>\r
+</refsynopsisdiv>\r
+\r
+<refsection><info><title>Description</title></info>\r
+\r
+<para>When this parameter is non-zero, the stylesheets will try to do syntax highlighting of the \r
+content of <tag>programlisting</tag> elements. You specify the language for each programlisting \r
+by using the <tag class="attribute">language</tag> attribute. The <parameter>highlight.default.language</parameter> \r
+parameter can be used to specify the language for programlistings without a <tag class="attribute">language</tag> \r
+attribute. Syntax highlighting also works for <tag>screen</tag> and <tag>synopsis</tag> elements.</para>\r
+\r
+<para>The actual highlighting work is done by the XSLTHL extension module. This is an external Java library that has to be \r
+downloaded separately (see below).</para>\r
+\r
+<itemizedlist>\r
+<para>In order to use this extension, you must</para> \r
+\r
+<listitem><para>add <filename>xslthl-2.x.x.jar</filename> to your Java classpath. The latest version is available\r
+from <link xlink:href="http://sourceforge.net/projects/xslthl">the XSLT syntax highlighting project</link> \r
+at SourceForge.</para>\r
+</listitem>\r
+<listitem>\r
+<para>use a customization layer in which you import one of the following stylesheet modules: \r
+<itemizedlist>\r
+  <listitem>\r
+    <para><filename>html/highlight.xsl</filename>\r
+    </para>\r
+  </listitem>\r
+<listitem>\r
+    <para><filename>xhtml/highlight.xsl</filename>\r
+    </para>\r
+  </listitem>\r
+<listitem>\r
+    <para><filename>xhtml-1_1/highlight.xsl</filename>\r
+    </para>\r
+  </listitem>\r
+<listitem>\r
+    <para><filename>fo/highlight.xsl</filename>\r
+    </para>\r
+</listitem>\r
+</itemizedlist>\r
+</para>\r
+</listitem>\r
+<listitem><para>let either the <literal>xslthl.config</literal> Java system property or the\r
+<parameter>highlight.xslthl.config</parameter> parameter point to the configuration file for syntax \r
+highlighting (using URL syntax). DocBook XSL comes with a ready-to-use configuration file, \r
+<filename>highlighting/xslthl-config.xml</filename>.</para>\r
+</listitem>\r
+</itemizedlist>\r
+\r
+<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
+an XSLT 2.0 processor it is not guaranteed to work with DocBook XSL in all circumstances.)</para>\r
+\r
+<para>The following is an example of a Saxon 6 command adapted for syntax highlighting, to be used on Windows:</para>\r
+\r
+<informalexample>\r
+<para><command>java -cp c:/Java/saxon.jar;c:/Java/xslthl-2.0.1.jar \r
+-Dxslthl.config=file:///c:/docbook-xsl/highlighting/xslthl-config.xml com.icl.saxon.StyleSheet \r
+-o test.html test.xml myhtml.xsl</command></para>\r
+</informalexample>\r
+\r
+</refsection>\r
+</refentry>\r