File: template.set.refentry.metadata.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 (48 lines) | stat: -rw-r--r-- 3,760 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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>set.refentry.metadata</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.prefs.html" title="get.refentry.metadata.prefs"><link rel="next" href="utility.html" title="Common  Utility Template Reference"><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">set.refentry.metadata</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="template.get.refentry.metadata.prefs.html">Prev</a></td><th width="60%" align="center">Common  Refentry Metadata Template Reference</th><td width="20%" align="right"><a accesskey="n" href="utility.html">Next</a></td></tr></table><hr></div><div class="refentry" title="set.refentry.metadata"><a name="template.set.refentry.metadata"></a><div class="titlepage"></div>
<div class="refnamediv"><h2>set.refentry.metadata</h2><p>
set.refentry.metadata
 &#8212; Sets content of a refentry metadata item
</p></div>
<div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2>
<pre class="synopsis">&lt;xsl:template name="set.refentry.metadata"&gt;
&lt;xsl:param name="refname"/&gt;
&lt;xsl:param name="info"/&gt;
&lt;xsl:param name="contents"/&gt;
&lt;xsl:param name="context"/&gt;
&lt;xsl:param name="preferred"/&gt;
  ...
&lt;/xsl:template&gt;</pre>
</div>
<div class="refsect1" title="Description"><a name="id1459926"></a><h2>Description</h2>
    
<p>The <code class="function">set.refentry.metadata</code> template is
    called each time a suitable source element is found for a certain
    metadata field.</p>

  </div><div class="refsect1" title="Parameters"><a name="id1459941"></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><dt><span class="term">info</span></dt><dd>
          
<p>A single *info node that contains the selected source element.</p>

        </dd><dt><span class="term">contents</span></dt><dd>
          
<p>A node containing the selected source element.</p>

        </dd><dt><span class="term">context</span></dt><dd>
          
<p>A string describing the metadata context in which the
          <code class="function">set.refentry.metadata</code> template was
          called: either "date", "source", "version", or "manual".</p>

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

  </div><div class="refsect1" title="Returns"><a name="id1460024"></a><h2>Returns</h2>
  
<p>Returns formatted contents of a selected source element.</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.prefs.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="utility.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">get.refentry.metadata.prefs</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">Common  Utility Template Reference</td></tr></table></div></body></html>