documentation-template/ldoc.ltp at main · limelight-development/documentation-template · GitHub

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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<!DOCTYPE html>
<html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=$(ldoc.doc_charset)">
    	<title>$(ldoc.title)</title>
    	<link rel="stylesheet" href="$(ldoc.css)" type="text/css">

# if ldoc.custom_css then -- add custom CSS file if configured.
		<link rel="stylesheet" href="$(ldoc.custom_css)" type="text/css">
# end
	</head>
	<body>
	<div id="container">
		<div id="product">
			<div id="product_logo"></div>
			<div id="product_name"><big><b></b></big></div>
			<div id="product_description"></div>
		</div>
		<!-- id="product" -->

		<div id="main">
# local no_spaces = ldoc.no_spaces
# local use_li = ldoc.use_li
# local display_name = ldoc.display_name
# local iter = ldoc.modules.iter
# local function M(txt,item) return ldoc.markup(txt,item,ldoc.plain) end
# local nowrap = ldoc.wrap and '' or 'nowrap'

			<!-- Menu -->
			<div id="navigation">
				<div class="ll-kind-header">
					<h1>$(ldoc.project)</h1>
# if module and module.info then
					<div class="header-module">
#  for tag, value in module.info:iter() do
        				<li>$(tag): $(M(value,module))</li>
#  end
					</div>
# end -- if module.info
				</div>
# if not ldoc.single and module then -- reference back to project index
				<div class="ll-kind-body">
					<ul>
						<li><a href="../$(ldoc.output).html">Index</a></li>
					</ul>
				</div>
# end

# -- Module Contents
# if module and not ldoc.no_summary and #module.items > 0 then
				<div class="ll-kind-header"><h2>Contents</h2></div>
				<ul class="ll-kind-body">
# for kind,items in module.kinds() do
					<li><a href="#$(no_spaces(kind))">$(kind)</a></li>
# end
				</ul>
# end

# -- Module Functions
# if ldoc.no_summary and module and not ldoc.one then -- bang out the functions on the side
# for kind, items in module.kinds() do
				<div class="ll-kind-header"><h2>$(kind)</h2></div>
				<ul class="ll-kind-body nowrap">
# for item in items() do
				    <li><a href="#$(item.name)">$(display_name(item))</a></li>
# end
				</ul>
# end
# end


# -- Project Contents
# local this_mod = module and module.name
# for kind, mods, type in ldoc.kinds() do
#  if ldoc.allowed_in_contents(type,module) then
				<div class="ll-kind-header"><h2>$(kind)</h2></div>
				<ul class="ll-kind-body $(kind=='Topics' and '' or 'nowrap')">
#  for mod in mods() do local name = display_name(mod)
#   if mod.name == this_mod then
					<li><strong>$(name)</strong></li>
#   else
					<li><a href="$(ldoc.ref_to_module(mod))">$(name)</a></li>
#   end
#  end
# end
				</ul>

# end
				<div class="ll-kind-header"><h2>Credits</h2></div>
				<ul class="ll-kind-body">
					<li><p>Generated by <a href="http://github.com/stevedonovan/LDoc">LDoc $(ldoc.version)</a>.</p></li>
					<li><p>Generated using the <a href="https://limelightgaming.info">Limelight Theme</a>.</p></li>
					<li><p>Last Updated at $(ldoc.updatetime).</p></li>
				</div>
</div>


</div>


			<div id="content">
# if ldoc.body then -- verbatim HTML as contents; 'non-code' entries
				<div class="ll-module-header"><h2>$(display_name(ldoc.module))</h2></div>
				<div class="ll-module-body">$(ldoc.body)</div>
# elseif module then -- module documentation
				<div class="ll-module-header"><h1>$(ldoc.module_typename(module)) <code>$(module.name)</code></h1></div>
# if module.summary or module.description then
				<div class="ll-module-body">
# if module.summary then
					$(M(module.summary, module))
# end
# if module.description then
					$(M(module.description, module))
# end
# end
				</div>

#   if module.tags.include then
				<div class="ll-module-header"><h2>Includes</h2></div>
       			<div class="ll-module-includes">$(M(ldoc.include_file(module.tags.include)))</div>
#   end

#   if module.see then
				<div class="ll-module-header"><h2>Also See</h2></div>
#     local li,il = use_li(module.see)
				<div class="ll-module-body">
				<h3>See also:</h3>
    			<ul>
#     for see in iter(module.see) do
         			$(li)<a href="$(ldoc.href(see))">$(see.label)</a>$(il)
#    end -- for
				</ul>
				</div>
#   end -- if see


#   if module.usage then
<div class="ll-module-header"><h2>Example Usage</h2></div>
<div class="ll-module-usage">
#     local li,il = use_li(module.usage)
    <h3>Usage:</h3>
    <ul>
#     for usage in iter(module.usage) do
        $(li)<pre class="example">$(ldoc.escape(usage))</pre>$(il)
#     end -- for
    </ul>
	</div>
#   end -- if usage


# if not ldoc.no_summary then
#  local length = 0
#  for _, itm in module.kinds() do
#   length = length + 1
#  end
#  if length > 0 then
# -- bang out the tables of item types for this module (e.g Functions, Tables, etc)
<div class="ll-module-header"><h2>$(ldoc.module_typename(module)) Overview</h2></div>
<div class="ll-module-body">

# for kind,items in module.kinds() do
<h3><a href="#$(no_spaces(kind))">$(kind)</a></h3>
<table class="function_list">
#  for item in items() do
	<tr>
	<td class="name" $(nowrap)><a href="#$(item.name)">$(display_name(item))</a></td>
	<td class="summary">$(M(item.summary,item))</td>
	</tr>
#  end -- for items
</table>
#end -- for kinds
</div>
# end -- if length > 0
#end -- if not no_summary

# --- currently works for both Functions and Tables. The params field either contains
# --- function parameters or table fields.
# local show_return = not ldoc.no_return_or_parms
# local show_parms = show_return
# for kind, items in module.kinds() do
#   local kitem = module.kinds:get_item(kind)
#   local has_description = kitem and ldoc.descript(kitem) ~= ""
	<div class="ll-module-header"><h2 class="section-header $(has_description and 'has-description')"><a name="$(no_spaces(kind))"></a>$(kind)</h2></div>
    <div class="ll-module-body">
#   if kitem then
#       if has_description then
          <div class="section-description">
          $(M(ldoc.descript(kitem),kitem))
          </div>
#       end
#       if kitem.usage then
            <h3>Usage:</h3>
            <pre class="example">$(ldoc.prettify(kitem.usage[1]))</pre>
#        end
#   end
    <dl class="function">
#  for item in items() do
    <dt>
    <a name = "$(item.name)"></a>
    <strong>$(display_name(item))</strong>
#   if ldoc.prettify_files and ldoc.is_file_prettified[item.module.file.filename] then
    <a style="float:right;" href="$(ldoc.source_ref(item))">line $(item.lineno)</a>
#  end
    </dt>
    <dd>
    $(M(ldoc.descript(item),item))
#   if ldoc.custom_tags then
#    for custom in iter(ldoc.custom_tags) do
#     local tag = item.tags[custom[1]]
#     if tag and not custom.hidden then
#      local li,il = use_li(tag)
    <h3>$(custom.title or custom[1]):</h3>
    <ul>
#      for value in iter(tag) do
         $(li)$(custom.format and custom.format(value) or M(value))$(il)
#      end -- for
#     end -- if tag
    </ul>
#    end -- iter tags
#   end
#  if show_parms and item.params and #item.params > 0 then
#    local subnames = module.kinds:type_of(item).subnames
#    if subnames then
    <h3>$(subnames):</h3>
#    end
    <ul>
#   for parm in iter(item.params) do
#     local param,sublist = item:subparam(parm)
#     if sublist then
        <li><span class="parameter">$(sublist)</span>$(M(item.params.map[sublist],item))
        <ul>
#     end
#     for p in iter(param) do
#        local name,tp,def = item:display_name_of(p), ldoc.typename(item:type_of_param(p)), item:default_of_param(p)
        <li><span class="parameter">$(name)</span>
#       if tp ~= '' then
            <span class="types">$(tp)</span>
#       end
        $(M(item.params.map[p],item))
#       if def == true then
         (<em>optional</em>)
#      elseif def then
         (<em>default</em> $(def))
#       end
#       if item:readonly(p) then
          <em>readonly</em>
#       end
        </li>
#     end
#     if sublist then
        </li></ul>
#     end
#   end -- for
    </ul>
#   end -- if params
#  if show_return and item.retgroups then local groups = item.retgroups
    <h3>Returns:</h3>
#   for i,group in ldoc.ipairs(groups) do local li,il = use_li(group)
    <ol>
#   for r in group:iter() do local type, ctypes = item:return_type(r); local rt = ldoc.typename(type)
        $(li)
#     if rt ~= '' then
           <span class="types">$(rt)</span>
#     end
        $(M(r.text,item))$(il)
#    if ctypes then
      <ul>
#    for c in ctypes:iter() do
            <li><span class="parameter">$(c.name)</span>
            <span class="types">$(ldoc.typename(c.type))</span>
            $(M(c.comment,item))</li>
#     end
        </ul>
#    end -- if ctypes
#     end -- for r
    </ol>
#   if i < #groups then
     <h3>Or</h3>
#   end
#   end -- for group
#   end -- if returns
#   if show_return and item.raise then
    <h3>Raises:</h3>
    $(M(item.raise,item))
#   end
#	if item.inheretedFrom then
	<h3>Inhereted from:</h3>
	<ul>
		$(li)$(M("@{" .. item.inheretedFrom .. "}",nil))$(il)
	</ul>
#	end
#   if item.see then
#     local li,il = use_li(item.see)
    <h3>See also:</h3>
    <ul>
#     for see in iter(item.see) do
         $(li)<a href="$(ldoc.href(see))">$(see.label)</a>$(il)
#    end -- for
    </ul>
#   end -- if see
#   if item.usage then
#     local li,il = use_li(item.usage)
    <h3>Usage:</h3>
    <ul>
#     for usage in iter(item.usage) do
        $(li)<pre class="example">$(ldoc.prettify(usage))</pre>$(il)
#     end -- for
    </ul>
#   end -- if usage
</dd>
# end -- for items
</dl>
</div>
# end -- for kinds
</div>
# else -- if module; project-level contents
# if ldoc.description then
  <h2>$(M(ldoc.description,nil))</h2>
# end
# if ldoc.full_description then
  <p>$(M(ldoc.full_description,nil))</p>
# end
# for kind, mods in ldoc.kinds() do
<div class="ll-module-header">
	<h2>$(kind)</h2>
</div>
<div class="ll-module-body">
# kind = kind:lower()
<table class="module_list">
# for m in mods() do
	<tr>
		<td class="name"  $(nowrap)><a href="$(no_spaces(kind))/$(m.name).html">$(m.name)</a></td>
		<td class="summary">$(M(ldoc.strip_header(m.summary),m))</td>
	</tr>
#  end -- for modules
</table>
</div>
# end -- for kinds
# end -- if module
</div> <!-- id="content" -->
</div>
</div> <!-- id="main" -->
<br class="clearfix">
</div> <!-- id="container" -->
</body>
</html>