Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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