doc/xslt/params/generate.legalnotice.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.legalnotice.link">
   7 <refmeta>
   8 <refentrytitle>generate.legalnotice.link</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>generate.legalnotice.link</refname>
  13 <refpurpose>Write legalnotice to separate chunk and generate link?</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="generate.legalnotice.link.frag"><xsl:param name="generate.legalnotice.link" select="0"/></src:fragment>
  18 </refsynopsisdiv>
  19
  20 <refsection><info><title>Description</title></info>
  21
  22 <para>If the value of <parameter>generate.legalnotice.link</parameter>
  23 is non-zero, the stylesheet:
  24
  25 <itemizedlist>
  26   <listitem>
  27     <para>writes the contents of <tag>legalnotice</tag> to a separate
  28     HTML file</para>
  29   </listitem>
  30   <listitem>
  31     <para>inserts a hyperlink to the <tag>legalnotice</tag> file</para>
  32   </listitem>
  33   <listitem>
  34     <para>adds (in the HTML <literal>head</literal>) either a single
  35     <literal>link</literal> or element or multiple
  36     <literal>link</literal> elements (depending on the value of the
  37     <parameter>html.head.legalnotice.link.multiple</parameter>
  38     parameter), with the value or values derived from the
  39     <parameter>html.head.legalnotice.link.types</parameter>
  40     parameter</para>
  41   </listitem>
  42   </itemizedlist>
  43
  44   Otherwise, if <parameter>generate.legalnotice.link</parameter> is
  45   zero, <tag>legalnotice</tag> contents are rendered on the title
  46   page.</para>
  47
  48 <para>The name of the separate HTML file is computed as follows:
  49
  50 <orderedlist>
  51 <listitem>
  52   <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag>
  53 processing instruction, that filename is used.</para>
  54 </listitem>
  55 <listitem>
  56   <para>If the legalnotice has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  57 attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename
  58 is the concatenation of the id value and the value of the <parameter>html.ext</parameter>
  59 parameter.</para>
  60 </listitem>
  61 <listitem>
  62   <para>If the legalnotice does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  63  attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "ln-",
  64 auto-generated id value, and <parameter>html.ext</parameter> value.
  65   </para>
  66 </listitem>
  67 </orderedlist>
  68
  69 </para>
  70
  71 </refsection>
  72 </refentry>