]> git.stg.codes - stg.git/blob - doc/xslt/params/dry-run.xml
Minor ChangeLog fix
[stg.git] / doc / xslt / params / dry-run.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="dry-run">
7 <refmeta>
8 <refentrytitle>dry-run</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>dry-run</refname>
13 <refpurpose>Indicates that no files should be produced</refpurpose>
14 </refnamediv>
15 <refsynopsisdiv>
16   <src:fragment xml:id="dry-run.frag">
17     <xsl:param name="dry-run" select="0"/>
18   </src:fragment>
19 </refsynopsisdiv>
20 <refsection><info><title>Description</title></info>
21 <para>When using the XSLT processor to manage dependencies and construct
22 the website, this parameter can be used to suppress the generation of
23 new and updated files. Effectively, this allows you to see what the
24 stylesheet would do, without actually making any changes.</para>
25 <para>Only applies when XSLT-based chunking is being used.</para>
26 </refsection>
27 </refentry>