]> git.stg.codes - stg.git/blob - doc/xslt/manpages/pi.xml
More clear plugin API
[stg.git] / doc / xslt / manpages / pi.xml
1 <?xml version="1.0"?>
2
3 <reference><info><title>manpages Processing Instruction Reference</title>
4     <releaseinfo role="meta">
5       $Id: pi.xsl 7644 2008-01-16 11:04:07Z xmldoc $
6     </releaseinfo>
7   </info>
8   <partintro xml:id="partintro">
9     <title>Introduction</title>
10     
11 <para>This is generated reference documentation for all
12       user-specifiable processing instructions (PIs) in the DocBook
13       XSL stylesheets for manpages output.
14       <note>
15         
16 <para>You add these PIs at particular points in a document to
17           cause specific “exceptions” to formatting/output behavior. To
18           make global changes in formatting/output behavior across an
19           entire document, it’s better to do it by setting an
20           appropriate stylesheet parameter (if there is one).</para>
21
22       </note>
23     </para>
24
25   </partintro>
26
27 <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="dbman_funcsynopsis-style">
28 <refnamediv>
29 <refname>dbman_funcsynopsis-style</refname>
30 <refpurpose>Specifies presentation style for a funcsynopsis.</refpurpose>
31 </refnamediv>
32 <refsynopsisdiv>
33
34     <synopsis><tag class="xmlpi">dbman funcsynopsis-style="kr"|"ansi"</tag></synopsis>
35   
36 </refsynopsisdiv>
37 <refsect1><title>Description</title>
38     
39 <para>Use the <tag class="xmlpi">dbman
40         funcsynopsis-style</tag> PI as a child of a
41       <tag>funcsynopsis</tag> or anywhere within a funcsynopsis
42       to control the presentation style for output of all
43       <tag>funcprototype</tag> instances within that funcsynopsis.</para>
44
45   </refsect1><refsect1><title>Parameters</title>
46     
47 <variablelist>
48       <varlistentry><term>funcsynopsis-style="kr"</term>
49         <listitem>
50           
51 <para>Displays the <tag>funcprototype</tag> in K&amp;R style</para>
52
53         </listitem>
54       </varlistentry>
55       <varlistentry><term>funcsynopsis-style="ansi"</term>
56         <listitem>
57           
58 <para>Displays the <tag>funcprototype</tag> in ANSI style</para>
59
60         </listitem>
61       </varlistentry>
62     </variablelist>
63
64   </refsect1><refsect1 role="params"><title>Related Global Parameters</title>
65     
66 <para><parameter>man.funcsynopsis.style</parameter></para>
67
68   </refsect1></refentry>
69 </reference>
70