]> git.stg.codes - stg.git/blob - doc/xslt/params/html.head.legalnotice.link.types.xml
Merge branch 'master' into naffanya-dev
[stg.git] / doc / xslt / params / html.head.legalnotice.link.types.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="html.head.legalnotice.link.types">
7 <refmeta>
8 <refentrytitle>html.head.legalnotice.link.types</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>html.head.legalnotice.link.types</refname>
13 <refpurpose>Specifies link types for legalnotice link in html head</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="html.head.legalnotice.link.types.frag">
18 <xsl:param name="html.head.legalnotice.link.types">copyright</xsl:param>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>The value of
25 <parameter>html.head.legalnotice.link.types</parameter> is a
26 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
27 of the HTML 4.01 specification</link>. If the value of the
28 <parameter>generate.legalnotice.link</parameter> parameter is
29 non-zero, then the stylesheet generates (in the
30 <literal>head</literal> section of the HTML source) either a single
31 HTML <literal>link</literal> element or, if the value of the
32 <parameter>html.head.legalnotice.link.multiple</parameter> is
33 non-zero, one <literal>link</literal> element for each link type
34 specified. Each <literal>link</literal> has the following attributes:
35
36 <itemizedlist>
37   <listitem>
38     <para>a <tag class="attribute">rel</tag> attribute whose
39     value is derived from the value of
40     <parameter>html.head.legalnotice.link.types</parameter></para>
41   </listitem>
42   <listitem>
43     <para>an <tag class="attribute">href</tag> attribute whose
44     value is set to the URL of the file containing the
45     <tag>legalnotice</tag></para>
46   </listitem>
47   <listitem>
48     <para>a <tag class="attribute">title</tag> attribute whose
49     value is set to the title of the corresponding
50     <tag>legalnotice</tag> (or a title programatically
51     determined by the stylesheet)</para>
52   </listitem>
53 </itemizedlist>
54
55 For example:
56
57 <screen>  &lt;link rel="license" href="ln-id2524073.html" title="Legal Notice"&gt;</screen>
58 </para>
59
60 <refsection><info><title>About the default value</title></info>
61   
62   <para>In an ideal world, the default value of
63   <parameter>html.head.legalnotice.link.types</parameter> would
64   probably be “<literal>license</literal>”, since the content of the
65   DocBook <tag>legalnotice</tag> is typically license
66   information, not copyright information. However, the default value
67   is “<literal>copyright</literal>” for pragmatic reasons: because
68   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
69   6.12 of the HTML 4.01 specification</link>, and because certain
70   browsers and browser extensions are preconfigured to recognize that
71   value.</para>
72 </refsection>
73
74 </refsection>
75 </refentry>