]> git.stg.codes - stg.git/blob - doc/xslt/params/draft.mode.xml
Documentation updated (DocBook)
[stg.git] / doc / xslt / params / draft.mode.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="draft.mode">
7 <refmeta>
8 <refentrytitle>draft.mode</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo>
10 <refmiscinfo class="other" otherclass="value">no</refmiscinfo> 
11 <refmiscinfo class="other" otherclass="value">yes</refmiscinfo>
12 <refmiscinfo class="other" otherclass="value">maybe</refmiscinfo>
13 </refmeta>
14 <refnamediv>
15 <refname>draft.mode</refname>
16 <refpurpose>Select draft mode</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20 <src:fragment xml:id="draft.mode.frag">
21 <xsl:param name="draft.mode">no</xsl:param>
22 </src:fragment>
23 </refsynopsisdiv>
24
25 <refsection><info><title>Description</title></info>
26
27 <para>Selects draft mode. If <parameter>draft.mode</parameter> is
28 <quote><literal>yes</literal></quote>, the entire document will be treated
29 as a draft. If it is <quote><literal>no</literal></quote>, the entire document
30 will be treated as a final copy. If it is <quote><literal>maybe</literal></quote>,
31 individual sections will be treated as draft or final independently, depending
32 on how their <literal>status</literal> attribute is set.
33 </para>
34
35 </refsection>
36 </refentry>