blob: 240ca62002ba2287a1e1fa8b88fee6519d39eca2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<?xml version="1.0" encoding="utf-8"?>
<page xmlns="http://projectmallard.org/1.0/" xmlns:xsl="FIXME" style="xslt-template" id="mal.link.guidelinks">
<info>
<link type="guide" xref="mal-link" group="templates"/>
<link type="guide" xref="templates" group="mal"/>
<desc>Output the guide links for a page or section.</desc>
<revision version="3.18" date="2015-06-07" status="final"/>
</info>
<title>mal.link.guidelinks</title>
<synopsis>
<title>Parameters</title>
<terms>
<item>
<title><code>$node</code></title>
<p>The <sys>page</sys> or <sys>section</sys> element to generate links for.</p>
</item>
<item>
<title><code>$role</code></title>
<p>A space-separated list of link roles, used to select the appropriate title, default <sys>"guide"</sys>.</p>
</item>
</terms>
</synopsis>
<p>This template outputs all the guide links for a page or section, whether
declared as guide links in the page or section or as topic links from another
guide page. It outputs each of the links as a <sys>link</sys> element within the
Mallard namespace. Each <sys>link</sys> element has an <sys>xref</sys> attribute pointing
to the target page or section. Or, in the case of external links, the <sys>link</sys>
element has an <sys>href</sys> attribute pointing to the external resource.</p>
<p>Each <sys>link</sys> element contains a <sys>title</sys> with <sys>type="sort"</sys> providing the
sort title of the target page or section. The <code>$role</code> attribute is used to
select a link title to sort on when a sort title is not present. The results
are not sorted when returned from this template. Use <sys>xsl:sort</sys> on the sort
titles to sort the results.</p>
<p>When a link comes from a guide link on <code>$node</code> that has an <sys>href</sys>
attribute but not an <sys>xref</sys> attribute, it is taken to be an external
link. In that case, the output link has an <sys>href</sys> attribute instead of
an <sys>xref</sys> attribute, and it has an <sys>info</sys> child element. This element
has a copy of all the child elements of the source <sys>link</sys> element.</p>
<p>The output is a result tree fragment. To use these results, call
<sys>exsl:node-set</sys> on them.</p>
<list style="compact">
<title>Calls Parameters</title>
<item>
<p><link xref="mal.cache"/></p>
</item>
<item>
<p><link xref="mal.cache.file"/></p>
</item>
<item>
<p><link xref="mal.link.default_root"/></p>
</item>
<item>
<p><link xref="mal.link.extension"/></p>
</item>
<item>
<p><link xref="mal.link.prefix"/></p>
</item>
</list>
<list style="compact">
<title>Calls Keys</title>
<item>
<p><link xref="mal.cache.key"/></p>
</item>
<item>
<p><link xref="mal.cache.link.key"/></p>
</item>
</list>
<list style="compact">
<title>Calls Templates</title>
<item>
<p><link xref="mal.link.linkid"/></p>
</item>
<item>
<p><link xref="mal.link.sorttitle"/></p>
</item>
<item>
<p><link xref="mal.link.xref.linkid"/></p>
</item>
</list>
</page>
|
