diff options
Diffstat (limited to 'doc/yelp-xsl/C/mal.link.topiclinks.page')
-rw-r--r-- | doc/yelp-xsl/C/mal.link.topiclinks.page | 115 |
1 files changed, 90 insertions, 25 deletions
diff --git a/doc/yelp-xsl/C/mal.link.topiclinks.page b/doc/yelp-xsl/C/mal.link.topiclinks.page index 271ac00e..36f48d2b 100644 --- a/doc/yelp-xsl/C/mal.link.topiclinks.page +++ b/doc/yelp-xsl/C/mal.link.topiclinks.page @@ -1,25 +1,90 @@ -<?xml version="1.0"?> -<page xmlns="http://projectmallard.org/1.0/" id="mal.link.topiclinks" type="topic" style="xslt-template"><info><link type="guide" xref="mal-link" group="templates"/><link type="guide" xref="templates" group="mal"/><revision version="3.18" date="2015-06-06" status="final"/><desc>Output the topic links for a page or section.</desc></info><title>mal.link.topiclinks</title><p>Output the topic links for a page or section.</p> - - - <synopsis><title>Parameters</title><terms> - <item> - <title><code>node</code></title> - <p>The <code>page</code> or <code>section</code> element to generate links for.</p> - </item> - <item> - <title><code>groups</code></title> - <p>The list of all valid link groups for <code style="xslt-param">node</code>.</p> - </item> - <item> - <title><code>role</code></title> - <p>A space-separated list of link roles, used to select the appropriate title, default <code>"topic"</code>.</p> - </item> - </terms></synopsis> - <p>This template outputs all the topic links for a guide page or section, whether declared as topic links in the page or section or as guide links from another page or section. It outputs each of the links as a <code>link</code> element within the Mallard namespace. Each <code>link</code> element has an <code>xref</code> attribute pointing to the target page or section. Or, in the case of external links, the <code>link</code> element has an <code>href</code> attribute pointing to the external resource.</p> - <p>Each <code>link</code> element contains a <code>title</code> with <code>type="sort"</code> providing the sort title of the target page or section. The <code style="xslt-param">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 <code>xsl:sort</code> on the sort titles to sort the results.</p> - <p>Each <code>link</code> element also contains a <code>group</code> attribute. The <code>group</code> attribute is normalized. It will either point to a link group declared in <code style="xslt-param">groups</code>, or it will be set to <code>#default</code>. Each <code>link</code> element also contains a <code>groupsort</code> attribute giving the numerical position of the <code>group</code> attribute in the normalized group list for <code style="xslt-param">node</code>.</p> - <p>The <code style="xslt-param">groups</code> parameter can be calculated automatically from <code style="xslt-param">node</code>.</p> - <p>When a link comes from a topic link on <code style="xslt-param">node</code> that has an <code>href</code> attribute but not an <code>xref</code> attribute, it is taken to be an external link. In that case, the output link has an <code>href</code> attribute instead of an <code>xref</code> attribute, and it has an <code>info</code> child element. This element has a copy of all the child elements of the source <code>link</code> element.</p> - <p>The output is a result tree fragment. To use these results, call <code>exsl:node-set</code> on them.</p> -<list style="compact"><title>Calls Templates</title><item><p><link xref="mal.link.linkid"/></p></item><item><p><link xref="mal.link.xref.linkid"/></p></item><item><p><link xref="mal.link.sorttitle"/></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 Parameters</title><item><p><link xref="mal.cache"/></p></item></list></page> +<?xml version="1.0" encoding="utf-8"?> +<page xmlns="http://projectmallard.org/1.0/" xmlns:xsl="FIXME" style="xslt-template" id="mal.link.topiclinks"> + <info> + <link type="guide" xref="mal-link" group="templates"/> + <link type="guide" xref="templates" group="mal"/> + <desc>Output the topic links for a page or section.</desc> + <revision version="3.18" date="2015-06-06" status="final"/> + </info> + <title>mal.link.topiclinks</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>$groups</code></title> + <p>The list of all valid link groups for <code>$node</code>.</p> + </item> + <item> + <title><code>$role</code></title> + <p>A space-separated list of link roles, used to select the appropriate title, default <sys>"topic"</sys>.</p> + </item> + </terms> + </synopsis> + <p>This template outputs all the topic links for a guide page or section, whether + declared as topic links in the page or section or as guide links from another + page or section. 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>Each <sys>link</sys> element also contains a <sys>group</sys> attribute. The <sys>group</sys> + attribute is normalized. It will either point to a link group declared + in <code>$groups</code>, or it will be set to <sys>#default</sys>. Each <sys>link</sys> element also + contains a <sys>groupsort</sys> attribute giving the numerical position of the + <sys>group</sys> attribute in the normalized group list for <code>$node</code>.</p> + <p>The <code>$groups</code> parameter can be calculated automatically from <code>$node</code>.</p> + <p>When a link comes from a topic 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> |