generate.legalnotice.link.xml 2.6 KB

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