DocBook documentation stub added

[stg.git] / doc / help / xslt / params / html.head.legalnotice.link.types.xml

diff --git a/doc/help/xslt/params/html.head.legalnotice.link.types.xml b/doc/help/xslt/params/html.head.legalnotice.link.types.xml
new file mode 100644 (file)
index 0000000..4ca02ff
--- /dev/null
+++ b/doc/help/xslt/params/html.head.legalnotice.link.types.xml
@@ -0,0 +1,75 @@
+<refentry xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:xi="http://www.w3.org/2001/XInclude"
+          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
+          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+          version="5.0" xml:id="html.head.legalnotice.link.types">
+<refmeta>
+<refentrytitle>html.head.legalnotice.link.types</refentrytitle>
+<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>html.head.legalnotice.link.types</refname>
+<refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment xml:id="html.head.legalnotice.link.types.frag">
+<xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsection><info><title>Description</title></info>
+
+<para>The value of
+<parameter>html.head.legalnotice.link.types</parameter> is a
+space-separated list of link types, as described in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section 6.12
+of the HTML 4.01 specification</link>. If the value of the
+<parameter>generate.legalnotice.link</parameter> parameter is
+non-zero, then the stylesheet generates (in the
+<literal>head</literal> section of the HTML source) either a single
+HTML <literal>link</literal> element or, if the value of the
+<parameter>html.head.legalnotice.link.multiple</parameter> is
+non-zero, one <literal>link</literal> element for each link type
+specified. Each <literal>link</literal> has the following attributes:
+
+<itemizedlist>
+  <listitem>
+    <para>a <tag class="attribute">rel</tag> attribute whose
+    value is derived from the value of
+    <parameter>html.head.legalnotice.link.types</parameter></para>
+  </listitem>
+  <listitem>
+    <para>an <tag class="attribute">href</tag> attribute whose
+    value is set to the URL of the file containing the
+    <tag>legalnotice</tag></para>
+  </listitem>
+  <listitem>
+    <para>a <tag class="attribute">title</tag> attribute whose
+    value is set to the title of the corresponding
+    <tag>legalnotice</tag> (or a title programatically
+    determined by the stylesheet)</para>
+  </listitem>
+</itemizedlist>
+
+For example:
+
+<screen>  &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
+</para>
+
+<refsection><info><title>About the default value</title></info>
+  
+  <para>In an ideal world, the default value of
+  <parameter>html.head.legalnotice.link.types</parameter> would
+  probably be “<literal>license</literal>”, since the content of the
+  DocBook <tag>legalnotice</tag> is typically license
+  information, not copyright information. However, the default value
+  is “<literal>copyright</literal>” for pragmatic reasons: because
+  that’s among the set of “recognized link types” listed in <link xlink:href="http://www.w3.org/TR/html401/types.html#type-links">Section
+  6.12 of the HTML 4.01 specification</link>, and because certain
+  browsers and browser extensions are preconfigured to recognize that
+  value.</para>
+</refsection>
+
+</refsection>
+</refentry>