~ubuntu-branches/ubuntu/trusty/docbook-xsl-doc/trusty

« back to all changes in this revision

Viewing changes to doc/common/template.get.refentry.source.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Leidert (dale)
  • Date: 2009-03-14 15:13:12 UTC
  • Revision ID: james.westby@ubuntu.com-20090314151312-31veakxfen1x36in
Tags: upstream-1.74.3
Import upstream version 1.74.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>get.refentry.source</title><link rel="stylesheet" href="reference.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.3"><link rel="home" href="../index.html" title="DocBook XSL Stylesheets: Reference�Documentation"><link rel="up" href="refentry.html" title="Common � Refentry Metadata Template Reference"><link rel="prev" href="template.get.refentry.date.html" title="get.refentry.date"><link rel="next" href="template.get.refentry.source.name.html" title="get.refentry.source.name"><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.source</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="template.get.refentry.date.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.source.name.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="template.get.refentry.source"></a><div class="titlepage"></div>
 
2
<div class="refnamediv"><h2>get.refentry.source</h2><p>
 
3
get.refentry.source
 
4
 &#8212; Gets source metadata for a refentry
 
5
</p></div>
 
6
<div class="refsynopsisdiv"><h2>Synopsis</h2>
 
7
<pre class="synopsis">&lt;xsl:template name="get.refentry.source"&gt;
 
8
&lt;xsl:param name="refname"/&gt;
 
9
&lt;xsl:param name="info"/&gt;
 
10
&lt;xsl:param name="prefs"/&gt;
 
11
  ...
 
12
&lt;/xsl:template&gt;</pre>
 
13
</div>
 
14
<div class="refsect1" lang="en"><a name="id1457324"></a><h2>Description</h2>
 
15
    
 
16
<p>The <code class="literal">man(7)</code> man page describes this as "the
 
17
    source of the command", and provides the following examples:
 
18
    
 
19
</p><div class="itemizedlist"><ul type="disc"><li>
 
20
        
 
21
<p>For binaries, use something like: GNU, NET-2, SLS
 
22
        Distribution, MCC Distribution.</p>
 
23
 
 
24
      </li><li>
 
25
        
 
26
<p>For system calls, use the version of the kernel that you are
 
27
        currently looking at: Linux 0.99.11.</p>
 
28
 
 
29
      </li><li>
 
30
        
 
31
<p>For library calls, use the source of the function: GNU, BSD
 
32
        4.3, Linux DLL 4.4.1.</p>
 
33
 
 
34
      </li></ul></div><p>
 
35
 
 
36
    </p>
 
37
 
 
38
 
 
39
    
 
40
<p>The <code class="literal">solbook(5)</code> man page describes
 
41
    something very much like what <code class="literal">man(7)</code> calls
 
42
    "source", except that <code class="literal">solbook(5)</code> names it
 
43
    "software" and describes it like this:
 
44
    </p><div class="blockquote"><blockquote class="blockquote">
 
45
      
 
46
<p>This is the name of the software product that the topic
 
47
      discussed on the reference page belongs to. For example UNIX
 
48
      commands are part of the <code class="literal">SunOS x.x</code>
 
49
      release.</p>
 
50
 
 
51
    </blockquote></div><p>
 
52
    </p>
 
53
 
 
54
 
 
55
    
 
56
<p>In practice, there are many pages that simply have a version
 
57
    number in the "source" field. So, it looks like what we have is a
 
58
    two-part field,
 
59
    <em class="replaceable"><code>Name</code></em>�<em class="replaceable"><code>Version</code></em>,
 
60
    where:
 
61
    
 
62
</p><div class="variablelist"><dl><dt><span class="term">Name</span></dt><dd>
 
63
          
 
64
<p>product name (e.g., BSD) or org. name (e.g., GNU)</p>
 
65
 
 
66
        </dd><dt><span class="term">Version</span></dt><dd>
 
67
          
 
68
<p>version name</p>
 
69
 
 
70
        </dd></dl></div><p>
 
71
 
 
72
    Each part is optional. If the <em class="replaceable"><code>Name</code></em> is a
 
73
    product name, then the <em class="replaceable"><code>Version</code></em> is probably
 
74
    the version of the product. Or there may be no
 
75
    <em class="replaceable"><code>Name</code></em>, in which case, if there is a
 
76
    <em class="replaceable"><code>Version</code></em>, it is probably the version of the
 
77
    item itself, not the product it is part of. Or, if the
 
78
    <em class="replaceable"><code>Name</code></em> is an organization name, then there
 
79
    probably will be no <em class="replaceable"><code>Version</code></em>.
 
80
    </p>
 
81
 
 
82
  </div><div class="refsect1" lang="en"><a name="id1457475"></a><h2>Parameters</h2>
 
83
    
 
84
<div class="variablelist"><dl><dt><span class="term">refname</span></dt><dd>
 
85
          
 
86
<p>The first <a href="http://docbook.org/tdg5/en/html/refname.html"><code class="sgmltag-element">refname</code></a> in the refentry</p>
 
87
 
 
88
        </dd><dt><span class="term">info</span></dt><dd>
 
89
          
 
90
<p>A set of info nodes (from a <a href="http://docbook.org/tdg5/en/html/refentry.html"><code class="sgmltag-element">refentry</code></a>
 
91
          element and its ancestors)</p>
 
92
 
 
93
        </dd><dt><span class="term">prefs</span></dt><dd>
 
94
          
 
95
<p>A node containing users preferences (from global
 
96
          stylesheet parameters)</p>
 
97
 
 
98
        </dd></dl></div>
 
99
 
 
100
  </div><div class="refsect1" lang="en"><a name="id1457540"></a><h2>Returns</h2>
 
101
    
 
102
<p>Returns a <code class="sgmltag-element">source</code> node.</p>
 
103
 
 
104
  </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.date.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.source.name.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">get.refentry.date�</td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top">�get.refentry.source.name</td></tr></table></div></body></html>
 
105