params/chunked.filename.prefix.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

<refentry xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
          version="5.0" xml:id="chunked.filename.prefix">
<refmeta>
<refentrytitle>chunked.filename.prefix</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>chunked.filename.prefix</refname>
<refpurpose>Filename prefix for chunked files</refpurpose>
</refnamediv>

<refsynopsisdiv>
<src:fragment xml:id="chunked.filename.prefix.frag">
<xsl:param name="chunked.filename.prefix"></xsl:param>
</src:fragment>
</refsynopsisdiv>

<refsection><info><title>Description</title></info>

<para>If specified, the <parameter>chunked.filename.prefix</parameter> 
parameter specifies a prefix string to add to each generated chunk filename.
For example:</para>
<programlisting>&lt;xsl:param name="chunked.filename.prefix"&gt;admin-&lt;xsl:param&gt;</programlisting>
<para>will produce chunked filenames like:</para>
<programlisting>admin-index.html
admin-ch01.html
admin-ch01s01.html
...
</programlisting>

<caution><para>Trying to use the <parameter>base.dir</parameter>
parameter to add a string prefix (by omitting the trailing slash)
no longer works (it never worked completely anyway). That parameter
value should contain only a directory path, and
now gets a trailing slash appended if it was omitted from the param.</para></caution>
</refsection>
</refentry>