]> git.stg.codes - stg.git/blob - doc/xslt/params/generate.revhistory.link.xml
Implemented new command line options parser.
[stg.git] / doc / xslt / params / generate.revhistory.link.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="generate.revhistory.link">
7 <refmeta>
8 <refentrytitle>generate.revhistory.link</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>generate.revhistory.link</refname>
13 <refpurpose>Write revhistory to separate chunk and generate link?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"/></src:fragment>
18 </refsynopsisdiv>
19
20 <refsection><info><title>Description</title></info>
21
22 <para>If non-zero, the contents of <tag>revhistory</tag> are written
23 to a separate HTML file and a link to the file is
24 generated. Otherwise, <tag>revhistory</tag> contents are rendered on
25 the title page.</para>
26
27 <para>The name of the separate HTML file is computed as follows:
28
29 <orderedlist>
30 <listitem>
31   <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction, 
32 that filename is used.</para>
33 </listitem>
34 <listitem>
35   <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> 
36 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of 
37 the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
38 </listitem>
39 <listitem>
40   <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag> 
41 attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-", 
42 auto-generated id value, and <parameter>html.ext</parameter> value.
43   </para>
44 </listitem>
45 </orderedlist>
46
47 </para>
48
49 </refsection>
50 </refentry>