File: template.get.refentry.title.html

package info (click to toggle)
docbook-xsl-doc 1.75.2-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 6,848 kB
  • ctags: 3,038
  • sloc: makefile: 34; sh: 5
file content (33 lines) | stat: -rw-r--r-- 3,877 bytes parent folder | download
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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>get.refentry.title</title><link rel="stylesheet" href="reference.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="../index.html" title="DocBook XSL Stylesheets: ReferenceDocumentation"><link rel="up" href="refentry.html" title="Common  Refentry Metadata Template Reference"><link rel="prev" href="template.get.refentry.metadata.html" title="get.refentry.metadata"><link rel="next" href="template.get.refentry.section.html" title="get.refentry.section"><link rel="copyright" href="copyright.html" title="License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">get.refentry.title</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="template.get.refentry.metadata.html">Prev</a></td><th width="60%" align="center">Common  Refentry Metadata Template Reference</th><td width="20%" align="right"><a accesskey="n" href="template.get.refentry.section.html">Next</a></td></tr></table><hr></div><div class="refentry" title="get.refentry.title"><a name="template.get.refentry.title"></a><div class="titlepage"></div>
<div class="refnamediv"><h2>get.refentry.title</h2><p>
get.refentry.title
 &#8212; Gets title metadata for a refentry
</p></div>
<div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2>
<pre class="synopsis">&lt;xsl:template name="get.refentry.title"&gt;
&lt;xsl:param name="refname"/&gt;
  ...
&lt;/xsl:template&gt;</pre>
</div>
<div class="refsect1" title="Description"><a name="id1458738"></a><h2>Description</h2>
    
<p>The <code class="literal">man(7)</code> man page describes this as "the
    title of the man page (e.g., <code class="literal">MAN</code>). This differs
    from <a href="http://docbook.org/tdg5/en/html/refname.html"><code class="sgmltag-element">refname</code></a> in that, if the <a href="http://docbook.org/tdg5/en/html/refentry.html"><code class="sgmltag-element">refentry</code></a> has a
    <a href="http://docbook.org/tdg5/en/html/refentrytitle.html"><code class="sgmltag-element">refentrytitle</code></a>, we use that as the <a href="http://docbook.org/tdg5/en/html/title.html"><code class="sgmltag-element">title</code></a>;
    otherwise, we just use first <a href="http://docbook.org/tdg5/en/html/refname.html"><code class="sgmltag-element">refname</code></a> in the first
    <a href="http://docbook.org/tdg5/en/html/refnamediv.html"><code class="sgmltag-element">refnamediv</code></a> in the source.</p>

  </div><div class="refsect1" title="Parameters"><a name="id1458779"></a><h2>Parameters</h2>
    
<div class="variablelist"><dl><dt><span class="term">refname</span></dt><dd>
          
<p>The first <a href="http://docbook.org/tdg5/en/html/refname.html"><code class="sgmltag-element">refname</code></a> in the refentry</p>

        </dd></dl></div>

  </div><div class="refsect1" title="Returns"><a name="id1458808"></a><h2>Returns</h2>
  
<p>Returns a <a href="http://docbook.org/tdg5/en/html/title.html"><code class="sgmltag-element">title</code></a> node.</p>
</div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="template.get.refentry.metadata.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="refentry.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="template.get.refentry.section.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">get.refentry.metadata</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">get.refentry.section</td></tr></table></div></body></html>