generate.revhistory.link.xml 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  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. <refsynopsisdiv>
  16. <src:fragment xml:id="generate.revhistory.link.frag"><xsl:param name="generate.revhistory.link" select="0"/></src:fragment>
  17. </refsynopsisdiv>
  18. <refsection><info><title>Description</title></info>
  19. <para>If non-zero, the contents of <tag>revhistory</tag> are written
  20. to a separate HTML file and a link to the file is
  21. generated. Otherwise, <tag>revhistory</tag> contents are rendered on
  22. the title page.</para>
  23. <para>The name of the separate HTML file is computed as follows:
  24. <orderedlist>
  25. <listitem>
  26. <para>If a filename is given by the <tag class="xmlpi">dbhtml filename</tag> processing instruction,
  27. that filename is used.</para>
  28. </listitem>
  29. <listitem>
  30. <para>If the revhistory has an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  31. attribute, and if <parameter>use.id.as.filename</parameter> != 0, the filename is the concatenation of
  32. the id value and the value of the <parameter>html.ext</parameter> parameter.</para>
  33. </listitem>
  34. <listitem>
  35. <para>If the revhistory does not have an <tag class="attribute">id</tag>/<tag class="attribute">xml:id</tag>
  36. attribute, or if <parameter>use.id.as.filename</parameter> = 0, the filename is the concatenation of "rh-",
  37. auto-generated id value, and <parameter>html.ext</parameter> value.
  38. </para>
  39. </listitem>
  40. </orderedlist>
  41. </para>
  42. </refsection>
  43. </refentry>