]> git.stg.codes - stg.git/blob - doc/xslt/params/show.revisionflag.xml
Documentation intermediate update
[stg.git] / doc / xslt / params / show.revisionflag.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="show.revisionflag">
7 <refmeta>
8 <refentrytitle>show.revisionflag</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>show.revisionflag</refname>
13 <refpurpose>Enable decoration of elements that have a revisionflag</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="show.revisionflag.frag">
18 <xsl:param name="show.revisionflag" select="0"/>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>
25 If <parameter>show.revisionflag</parameter> is turned on, then the stylesheets
26 may produce additional markup designed to allow a CSS stylesheet to
27 highlight elements that have specific revisionflag settings.</para>
28
29 <para>The markup inserted will be usually be either a &lt;span&gt; or
30 &lt;div&gt; with an appropriate <literal>class</literal>
31 attribute. (The value of the class attribute will be the same as the
32 value of the revisionflag attribute). In some contexts, for example
33 tables, where extra markup would be structurally illegal, the class
34 attribute will be added to the appropriate container element.</para>
35
36 <para>In general, the stylesheets only test for revisionflag in contexts
37 where an importing stylesheet would have to redefine whole templates.
38 Most of the revisionflag processing is expected to be done by another
39 stylesheet, for example <filename>changebars.xsl</filename>.</para>
40
41 </refsection>
42 </refentry>