Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 169 lines (62 sloc) 3.167 kB
8da5e78 first commit; not yet working right
Ulf Wiger authored
1 Module edown_layout
2 ===================
3
4
659a33f more context-sensitive markup
Ulf Wiger authored
5 <h1>Module edown_layout</h1>
6
8da5e78 first commit; not yet working right
Ulf Wiger authored
7 * [Description](#description)
8 * [Function Index](#index)
9 * [Function Details](#functions)
2b22898 fix uri redirect & nl after index
Ulf Wiger authored
10
11
e4da232 It's normal Markdown - not GFM
Ulf Wiger authored
12 Markdown layout module for EDoc.
659a33f more context-sensitive markup
Ulf Wiger authored
13
9036f27 URI rewriting & special treatment of first sentence
Ulf Wiger authored
14
15
8fbee6d Copyright symbol changed to (c)
Ulf Wiger authored
16 Copyright (c) 2010 Erlang Solutions Ltd
659a33f more context-sensitive markup
Ulf Wiger authored
17
8da5e78 first commit; not yet working right
Ulf Wiger authored
18 __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com)).
19
659a33f more context-sensitive markup
Ulf Wiger authored
20 <h2><a name="description">Description</a></h2>
21
9036f27 URI rewriting & special treatment of first sentence
Ulf Wiger authored
22 Derived from `edoc_layout`, which is part of the Erlang/OTP application EDoc.
c7f546e normalize #text#
Ulf Wiger authored
23 The module is intended to be used together with edoc.
8da5e78 first commit; not yet working right
Ulf Wiger authored
24
659a33f more context-sensitive markup
Ulf Wiger authored
25 <h2><a name="index">Function Index</a></h2>
26
27
8da5e78 first commit; not yet working right
Ulf Wiger authored
28
29 <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#markdown-3">markdown/3</a></td><td></td></tr><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></td></tr><tr><td valign="top"><a href="#package-2">package/2</a></td><td></td></tr><tr><td valign="top"><a href="#type-1">type/1</a></td><td></td></tr></table>
30
659a33f more context-sensitive markup
Ulf Wiger authored
31
8da5e78 first commit; not yet working right
Ulf Wiger authored
32
33
56d4aae updated for R14B02 & layout fixes
Ulf Wiger authored
34 <h2><a name="functions">Function Details</a></h2>
659a33f more context-sensitive markup
Ulf Wiger authored
35
8da5e78 first commit; not yet working right
Ulf Wiger authored
36
37 <a name="markdown-3"></a>
38
659a33f more context-sensitive markup
Ulf Wiger authored
39 <h3>markdown/3</h3>
40
41
42
8da5e78 first commit; not yet working right
Ulf Wiger authored
43
44
45 `markdown(Title, CSS, Body) -> any()`
46
47 <a name="module-2"></a>
48
659a33f more context-sensitive markup
Ulf Wiger authored
49 <h3>module/2</h3>
50
51
52
8da5e78 first commit; not yet working right
Ulf Wiger authored
53
54
55 `module(Element, Options) -> any()`
56
57
659a33f more context-sensitive markup
Ulf Wiger authored
58
59
60
8da5e78 first commit; not yet working right
Ulf Wiger authored
61 The layout function.
c7f546e normalize #text#
Ulf Wiger authored
62
63 Options to the standard layout:
64
65
8da5e78 first commit; not yet working right
Ulf Wiger authored
66
659a33f more context-sensitive markup
Ulf Wiger authored
67 <dt><code>{index_columns, integer()}</code>
c7f546e normalize #text#
Ulf Wiger authored
68 </dt>
69
659a33f more context-sensitive markup
Ulf Wiger authored
70
8da5e78 first commit; not yet working right
Ulf Wiger authored
71
659a33f more context-sensitive markup
Ulf Wiger authored
72
73 <dd>Specifies the number of column pairs used for the function
c7f546e normalize #text#
Ulf Wiger authored
74 index tables. The default value is 1.
75 </dd>
76
659a33f more context-sensitive markup
Ulf Wiger authored
77
78
8da5e78 first commit; not yet working right
Ulf Wiger authored
79
56d4aae updated for R14B02 & layout fixes
Ulf Wiger authored
80 <dt><code>{pretty_printer, atom()}</code>
81 </dt>
82
83
84
85
86 <dd>Specifies how types and specifications are pretty printed.
87 If the value <code>erl_pp</code> is specified the Erlang pretty printer
88 (the module <code>erl_pp</code>) will be used. The default is to do
89 no pretty printing which implies that lines can be very long.
90 </dd>
91
92
93
94
659a33f more context-sensitive markup
Ulf Wiger authored
95 <dt><code>{stylesheet, string()}</code>
c7f546e normalize #text#
Ulf Wiger authored
96 </dt>
97
659a33f more context-sensitive markup
Ulf Wiger authored
98
8da5e78 first commit; not yet working right
Ulf Wiger authored
99
659a33f more context-sensitive markup
Ulf Wiger authored
100
101 <dd>Specifies the URI used for referencing the stylesheet. The
c7f546e normalize #text#
Ulf Wiger authored
102 default value is <code>"stylesheet.css"</code>. If an empty string is
103 specified, no stylesheet reference will be generated.
104 </dd>
105
659a33f more context-sensitive markup
Ulf Wiger authored
106
107
8da5e78 first commit; not yet working right
Ulf Wiger authored
108
8fbee6d Copyright symbol changed to (c)
Ulf Wiger authored
109 <dt><code>{sort_functions, <a href="#type-boolean">boolean()</a>}</code>
c7f546e normalize #text#
Ulf Wiger authored
110 </dt>
111
659a33f more context-sensitive markup
Ulf Wiger authored
112
8da5e78 first commit; not yet working right
Ulf Wiger authored
113
659a33f more context-sensitive markup
Ulf Wiger authored
114
115 <dd>If <code>true</code>, the detailed function descriptions are listed by
c7f546e normalize #text#
Ulf Wiger authored
116 name, otherwise they are listed in the order of occurrence in
117 the source file. The default value is <code>true</code>.
118 </dd>
119
8da5e78 first commit; not yet working right
Ulf Wiger authored
120
121
659a33f more context-sensitive markup
Ulf Wiger authored
122
123 <dt><code>{xml_export, Module::atom()}</code>
c7f546e normalize #text#
Ulf Wiger authored
124 </dt>
125
659a33f more context-sensitive markup
Ulf Wiger authored
126
127
128
8fc6e87 more general URI redirect
Ulf Wiger authored
129 <dd>Specifies an <a href="http://www.erlang.org/doc/man/index.html" target="_top"><code>xmerl</code></a> callback module to be
130 used for exporting the documentation. See <a href="http://www.erlang.org/doc/man/xmerl.html#export_simple_content-2"><code>//xmerl/xmerl:export_simple_content/2</code></a> for details.
c7f546e normalize #text#
Ulf Wiger authored
131 </dd>
132
133
659a33f more context-sensitive markup
Ulf Wiger authored
134
135
136
56d4aae updated for R14B02 & layout fixes
Ulf Wiger authored
137 __See also:__ [//edoc/edoc:layout/2](http://www.erlang.org/doc/man/edoc.html#layout-2), [edown_doclet:layout/2](edown_doclet.md#layout-2).<a name="overview-2"></a>
8da5e78 first commit; not yet working right
Ulf Wiger authored
138
659a33f more context-sensitive markup
Ulf Wiger authored
139 <h3>overview/2</h3>
140
141
142
8da5e78 first commit; not yet working right
Ulf Wiger authored
143
144
145 `overview(E, Options) -> any()`
146
147 <a name="package-2"></a>
148
659a33f more context-sensitive markup
Ulf Wiger authored
149 <h3>package/2</h3>
150
151
152
8da5e78 first commit; not yet working right
Ulf Wiger authored
153
154
155 `package(E, Options) -> any()`
156
157 <a name="type-1"></a>
158
659a33f more context-sensitive markup
Ulf Wiger authored
159 <h3>type/1</h3>
160
161
162
8da5e78 first commit; not yet working right
Ulf Wiger authored
163
164
165 `type(E) -> any()`
166
659a33f more context-sensitive markup
Ulf Wiger authored
167
168
8fbee6d Copyright symbol changed to (c)
Ulf Wiger authored
169 _Generated by EDoc, Mar 24 2011, 14:59:08._
Something went wrong with that request. Please try again.