File: otpsgml_layout.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 23,284 kB
  • ctags: 10,724
  • sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (65 lines) | stat: -rw-r--r-- 2,675 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module otpsgml_layout</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css">
</head>
<body bgcolor="white">

<h1>Module otpsgml_layout</h1>
The OTP SGML layout module for EDoc.
<p>Copyright  2001-2004 Richard Carlsson</p>
<ul><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<p><b>Authors:</b> Richard Carlsson (<a href="mailto:richardc@csd.uu.se"><tt>richardc@csd.uu.se</tt></a>), Kenneth Lundin (<a href="mailto:kenneth@erix.ericsson.se"><tt>kenneth@erix.ericsson.se</tt></a>).</p>
<p><b>See also:</b> <a href="edoc_layout.html">edoc_layout</a>.</p>

<h2><a name="description">Description</a></h2>The OTP SGML layout module for EDoc. See the module <a href="edoc.html"><code>edoc</code></a>
  for details on usage.
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1"><tr><td valign="top"><a href="#module-2">module/2</a></td><td>The layout function.</td></tr>
<tr><td valign="top"><a href="#overview-2">overview/2</a></td><td/></tr>
<tr><td valign="top"><a href="#package-2">package/2</a></td><td/></tr>
<tr><td valign="top"><a href="#type-1">type/1</a></td><td/></tr>
</table>

<h2><a name="functions">Function Details</a></h2>

<h3><a name="module-2">module/2</a></h3>
<tt>module(Element, Options) -&gt; term()
</tt><p><p>The layout function.</p>
 
  Options:
  <dl>
   <dt><code>{index_columns, integer()}</code>
   </dt>
   <dd>Specifies the number of column pairs used for the function
       index tables. The default value is 1.
   </dd>
   <dt><code>{stylesheet, string()}</code>
   </dt>
   <dd>Specifies the URI used for referencing the stylesheet. The
       default value is <code>"stylesheet.css"</code>. If an empty string is
       specified, no stylesheet reference will be generated.
   </dd>
   <dt><code>{xml_export, Module::atom()}</code>
   </dt>
   <dd>Specifies an <a href="/clearcase/otp/internal_tools/xmerl/doc/index.html" target="_top"><code>xmerl</code></a> callback module to be
       used for exporting the documentation. See <a href="/clearcase/otp/internal_tools/xmerl/doc/xmerl.html#export_simple-3"><code>//xmerl/xmerl:export_simple/3</code></a> for details.
   </dd>
  </dl>
 </p>
<p><b>See also:</b> <a href="edoc.html#layout-2">edoc:layout/2</a>.</p>

<h3><a name="overview-2">overview/2</a></h3>
<tt>overview(E, Options) -&gt; term()
</tt>

<h3><a name="package-2">package/2</a></h3>
<tt>package(E, Options) -&gt; term()
</tt>

<h3><a name="type-1">type/1</a></h3>
<tt>type(E) -&gt; term()
</tt>
</body>
</html>