Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 121 lines (58 sloc) 3.304 kb
8da5e78 first commit; not yet working right
Ulf Wiger authored
1 Module edown_layout
2 ===================
3
4 <div class="navbar">
5 <a name="#navbar_top"></a>
6
7 <table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table>
8 </div>
9
10
11 #Module edown_layout#
12 * [Description](#description)
13 * [Function Index](#index)
14 * [Function Details](#functions)
15 Github-flavored Markdown layout module for EDoc.
16 Copyright © 2010 Erlang Solutions Ltd
17 __Authors:__ Ulf Wiger ([`ulf.wiger@erlang-solutions.com`](mailto:ulf.wiger@erlang-solutions.com)).
18
19 ##<a name="description">Description</a>##
20 Github-flavored Markdown layout module for EDoc.
21 Derived from `edoc_layout`, which is part of the Erlang/OTP application EDoc.
22 The module is intended to be used together with edoc.
23
24 ##<a name="index">Function Index</a>##
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
28 <a name="functions"></a>
29
30
31 ##Function Details##
32
33 <a name="markdown-3"></a>
34
35
36 ###markdown/3##
37
38
39 `markdown(Title, CSS, Body) -> any()`
40
41 <a name="module-2"></a>
42
43
44 ###module/2##
45
46
47 `module(Element, Options) -> any()`
48
49
50 The layout function.
51
52 Options to the standard layout:
53
54
55
56 ###`{index_columns, integer()}`##
57
58
59 Specifies the number of column pairs used for the function
60 index tables. The default value is 1.
61
62
63
64 ###`{stylesheet, string()}`##
65
66
67 Specifies the URI used for referencing the stylesheet. The
68 default value is `"stylesheet.css"`. If an empty string is
69 specified, no stylesheet reference will be generated.
70
71
72
73 ###`{sort_functions, bool()}`##
74
75
76 If `true`, the detailed function descriptions are listed by
77 name, otherwise they are listed in the order of occurrence in
78 the source file. The default value is `true`.
79
80
81
82 ###`{xml_export, Module::atom()}`##
83
84
85 Specifies an [`xmerl`](/Users/uwiger/ETC/git/xmerl/doc/index.html) callback module to be
86 used for exporting the documentation. See [`//xmerl/xmerl:export_simple_content/2`](/Users/uwiger/ETC/git/xmerl/doc/xmerl.html#export_simple_content-2) for details.
87
88
89
90 __See also:__ [edoc:layout/2](edoc.html#layout-2).
91 <a name="overview-2"></a>
92
93
94 ###overview/2##
95
96
97 `overview(E, Options) -> any()`
98
99 <a name="package-2"></a>
100
101
102 ###package/2##
103
104
105 `package(E, Options) -> any()`
106
107 <a name="type-1"></a>
108
109
110 ###type/1##
111
112
113 `type(E) -> any()`
114
115 <div class="navbar">
116 <a name="#navbar_bottom"></a>
117
118 <table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table>
119 </div>
120
121 _Generated by EDoc, Oct 22 2010, 15:27:00._
Something went wrong with that request. Please try again.