doc/xslt/params/textinsert.extension.xml

   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="textinsert.extension">
   7   <refmeta>
   8     <refentrytitle>textinsert.extension</refentrytitle>
   9     <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10   </refmeta>
  11   <refnamediv>
  12     <refname>textinsert.extension</refname>
  13     <refpurpose>Enables the textinsert extension element</refpurpose>
  14   </refnamediv>
  15   <refsynopsisdiv>
  16     <src:fragment xml:id="textinsert.extension.frag">
  17   <xsl:param name="textinsert.extension" select="1"/>
  18 </src:fragment>
  19   </refsynopsisdiv>
  20   <refsection><info><title>Description</title></info>
  21     <para>The textinsert extension element inserts the contents of
  22       a file into the result tree (as text).</para>
  23     <note>
  24       <para>To use the textinsert extension element, you must use
  25         either Saxon or Xalan as your XSLT processor (it doesn’t
  26         work with xsltproc), along with either the DocBook Saxon
  27         extensions or DocBook Xalan extensions (for more
  28         information about those extensions, see <link
  29           role="tcg" xlink:href="InstallingAProcessor.html#SaxonExtensions"
  30           >DocBook Saxon Extensions</link> and <link
  31           role="tcg" xlink:href="InstallingAProcessor.html#XalanExtensions"
  32           >DocBook Xalan Extensions</link>), and you must set both
  33         the <parameter>use.extensions</parameter> and
  34         <parameter>textinsert.extension</parameter> parameters to
  35         <literal>1</literal>.</para>
  36       <para>As an alternative to using the textinsert element,
  37         consider using an Xinclude element with the
  38         <literal>parse="text"</literal> attribute and value
  39         specified, as detailed in <link
  40           role="tcg" xlink:href="ExternalCode.html#XIncludeCode"
  41           >Using XInclude for text inclusions</link>.</para>
  42     </note>
  43   </refsection>
  44   <refsection><info><title>See Also</title></info>
  45     <para>You can also use the <tag
  46         class="xmlpi">dbhtml-include href</tag> processing
  47       instruction to insert external files — both files containing
  48       plain text and files with markup content (including HTML
  49       content).</para>
  50   </refsection>
  51   <refsection><info><title>More information</title></info>
  52     <para>For how-to documentation on inserting contents of
  53       external code files and other text files into output, see
  54       <link
  55         role="tcg" xlink:href="ExternalCode.html"
  56         >External code files</link>.</para>
  57     <para>For guidelines on inserting contents of
  58       HTML files into output, see <link
  59         role="tcg" xlink:href="InsertExtHtml.html"
  60         >Inserting external HTML code</link>.</para>
  61   </refsection>
  62 </refentry>