middleman-pagegroups 1.0.2 → 1.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +8 -1
- data/.yardopts +8 -0
- data/CHANGELOG.md +24 -4
- data/README.md +5 -5
- data/Rakefile +201 -7
- data/documentation_project/Gemfile +2 -2
- data/documentation_project/config.rb +15 -19
- data/documentation_project/source/documentation/100_nested_folder/another_file.html.md.erb +19 -0
- data/documentation_project/source/documentation/100_nested_folder/index.html.md.erb +25 -0
- data/documentation_project/source/documentation/100_nested_folder/one_file.html.md.erb +11 -0
- data/documentation_project/source/documentation/100_nested_folder/stray.txt +6 -0
- data/documentation_project/source/documentation/10_concepts.html.md.erb +1 -1
- data/documentation_project/source/documentation/20_directory_organization.html.md.erb +12 -10
- data/documentation_project/source/documentation/40_resources.html.md.erb +3 -68
- data/documentation_project/source/documentation/50_helpers.html.md.erb +41 -163
- data/documentation_project/source/documentation/60_sample_partials.html.md.erb +23 -22
- data/documentation_project/source/documentation/80_config.html.md.erb +6 -0
- data/documentation_project/source/documentation/90_cli.html.md.erb +47 -0
- data/documentation_project/source/partials/_yard_config.erb +744 -0
- data/documentation_project/source/partials/_yard_helpers.erb +710 -0
- data/documentation_project/source/partials/_yard_helpers_css.erb +523 -0
- data/documentation_project/source/partials/_yard_helpers_extended.erb +56 -0
- data/documentation_project/source/partials/_yard_resources.erb +540 -0
- data/documentation_project/source/stylesheets/_middlemac_minimal.scss +287 -0
- data/features/helpers_and_resources.feature +120 -0
- data/features/support/env.rb +20 -0
- data/fixtures/middleman_pagegroups_app/config.rb +17 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/index.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/not_legitimate.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/sibling_one.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/20_sub_folder_02/sibling_two.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/_partial.md.erb +111 -0
- data/fixtures/middleman_pagegroups_app/source/index.html.md.erb +23 -0
- data/fixtures/middleman_pagegroups_app/source/layout.erb +6 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/10_sibling_one.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/20_sibling_two.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/30_sibling_three.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/sub_folder_01/index.html.md.erb +9 -0
- data/lib/middleman-pagegroups/extension.rb +468 -110
- data/lib/middleman-pagegroups/partials.rb +9 -12
- data/lib/middleman-pagegroups/version.rb +1 -1
- data/middleman-pagegroups.gemspec +10 -2
- data/yard/readme.md +5 -0
- data/yard/template-grouped/default/module/html/method_details_list.erb +11 -0
- data/yard/template-partials/default/method_details/setup.rb +4 -0
- data/yard/template-partials/default/module/html/attribute_details.erb +9 -0
- data/yard/template-partials/default/module/html/method_details_list.erb +10 -0
- data/yard/template-partials/default/module/setup.rb +6 -0
- data/yard/template-partials/default/onefile/html/layout.erb +1 -0
- data/yard/template-partials/default/onefile/html/setup.rb +4 -0
- data/yard/yard_extensions.rb +109 -0
- metadata +105 -7
|
@@ -0,0 +1,710 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
<div class="method_details_list">
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
<div class="method_details first">
|
|
11
|
+
<h3 class="signature first" id="nav_breadcrumbs-instance_method">
|
|
12
|
+
|
|
13
|
+
- (<tt>String</tt>) <strong>nav_breadcrumbs</strong>(locals = {})
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
</h3><div class="docstring">
|
|
20
|
+
<div class="discussion">
|
|
21
|
+
<p>Generates a breadcrumbs structure as an <code><ul></code>. The
|
|
22
|
+
trailing element is the current page.</p>
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</div>
|
|
26
|
+
</div>
|
|
27
|
+
<div class="tags">
|
|
28
|
+
<p class="tag_title">Parameters:</p>
|
|
29
|
+
<ul class="param">
|
|
30
|
+
|
|
31
|
+
<li>
|
|
32
|
+
|
|
33
|
+
<span class='name'>locals</span>
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
—
|
|
43
|
+
<div class='inline'><p>A hash of key-value pairs that
|
|
44
|
+
are passed to the structure as local variables.</p>
|
|
45
|
+
</div>
|
|
46
|
+
|
|
47
|
+
</li>
|
|
48
|
+
|
|
49
|
+
</ul>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
<p class="tag_title">Options Hash (<tt>locals</tt>):</p>
|
|
55
|
+
<ul class="option">
|
|
56
|
+
|
|
57
|
+
<li>
|
|
58
|
+
<span class="name">:klass</span>
|
|
59
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
60
|
+
<span class="default">
|
|
61
|
+
|
|
62
|
+
</span>
|
|
63
|
+
|
|
64
|
+
— <div class='inline'><p>The <code>class</code> attribute
|
|
65
|
+
value that should be assigned to the containing
|
|
66
|
+
element.</p>
|
|
67
|
+
</div>
|
|
68
|
+
|
|
69
|
+
</li>
|
|
70
|
+
|
|
71
|
+
</ul>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
<p class="tag_title">Returns:</p>
|
|
75
|
+
<ul class="return">
|
|
76
|
+
|
|
77
|
+
<li>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
—
|
|
85
|
+
<div class='inline'><p>An <code><ul></code> containing the breadcrumbs.</p>
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
</li>
|
|
89
|
+
|
|
90
|
+
</ul>
|
|
91
|
+
|
|
92
|
+
</div>
|
|
93
|
+
</div>
|
|
94
|
+
|
|
95
|
+
<div class="method_details ">
|
|
96
|
+
<h3 class="signature " id="nav_breadcrumbs_alt-instance_method">
|
|
97
|
+
|
|
98
|
+
- (<tt>String</tt>) <strong>nav_breadcrumbs_alt</strong>(locals = {})
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</h3><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
<p>Generates the breadcrumbs structure, alternate form,
|
|
107
|
+
wherein the trailing element consists of a label
|
|
108
|
+
indicating “current page,” as an <code><ul></code>.</p>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
<div class="tags">
|
|
114
|
+
<p class="tag_title">Parameters:</p>
|
|
115
|
+
<ul class="param">
|
|
116
|
+
|
|
117
|
+
<li>
|
|
118
|
+
|
|
119
|
+
<span class='name'>locals</span>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
—
|
|
129
|
+
<div class='inline'><p>A hash of key-value pairs that
|
|
130
|
+
are passed to the structure as local variables.</p>
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
</li>
|
|
134
|
+
|
|
135
|
+
</ul>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<p class="tag_title">Options Hash (<tt>locals</tt>):</p>
|
|
141
|
+
<ul class="option">
|
|
142
|
+
|
|
143
|
+
<li>
|
|
144
|
+
<span class="name">:klass</span>
|
|
145
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
146
|
+
<span class="default">
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
— <div class='inline'><p>The <code>class</code> attribute
|
|
151
|
+
value that should be assigned to the containing
|
|
152
|
+
element.</p>
|
|
153
|
+
</div>
|
|
154
|
+
|
|
155
|
+
</li>
|
|
156
|
+
|
|
157
|
+
<li>
|
|
158
|
+
<span class="name">:label</span>
|
|
159
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
160
|
+
<span class="default">
|
|
161
|
+
|
|
162
|
+
</span>
|
|
163
|
+
|
|
164
|
+
— <div class='inline'><p>The text for the label
|
|
165
|
+
that means “Current page.”</p>
|
|
166
|
+
</div>
|
|
167
|
+
|
|
168
|
+
</li>
|
|
169
|
+
|
|
170
|
+
</ul>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
<p class="tag_title">Returns:</p>
|
|
174
|
+
<ul class="return">
|
|
175
|
+
|
|
176
|
+
<li>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
—
|
|
184
|
+
<div class='inline'><p>An <code><ul></code> containing the breadcrumbs.</p>
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
</li>
|
|
188
|
+
|
|
189
|
+
</ul>
|
|
190
|
+
|
|
191
|
+
</div>
|
|
192
|
+
</div>
|
|
193
|
+
|
|
194
|
+
<div class="method_details ">
|
|
195
|
+
<h3 class="signature " id="nav_brethren-instance_method">
|
|
196
|
+
|
|
197
|
+
- (<tt>String</tt>) <strong>nav_brethren</strong>(locals = {})
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</h3><div class="docstring">
|
|
204
|
+
<div class="discussion">
|
|
205
|
+
<p>Generates a fuller list of related topics as a <code><dl></code>,
|
|
206
|
+
with a link to the page as the definition term and the
|
|
207
|
+
page’s front matter <code>:blurb</code> as the definition
|
|
208
|
+
definition.</p>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
</div>
|
|
212
|
+
</div>
|
|
213
|
+
<div class="tags">
|
|
214
|
+
<p class="tag_title">Parameters:</p>
|
|
215
|
+
<ul class="param">
|
|
216
|
+
|
|
217
|
+
<li>
|
|
218
|
+
|
|
219
|
+
<span class='name'>locals</span>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
—
|
|
229
|
+
<div class='inline'><p>A hash of key-value pairs that
|
|
230
|
+
are passed to the structure as local variables.</p>
|
|
231
|
+
</div>
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
</ul>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<p class="tag_title">Options Hash (<tt>locals</tt>):</p>
|
|
241
|
+
<ul class="option">
|
|
242
|
+
|
|
243
|
+
<li>
|
|
244
|
+
<span class="name">:klass</span>
|
|
245
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
246
|
+
<span class="default">
|
|
247
|
+
|
|
248
|
+
</span>
|
|
249
|
+
|
|
250
|
+
— <div class='inline'><p>The <code>class</code> attribute
|
|
251
|
+
value that should be assigned to the containing
|
|
252
|
+
element.</p>
|
|
253
|
+
</div>
|
|
254
|
+
|
|
255
|
+
</li>
|
|
256
|
+
|
|
257
|
+
<li>
|
|
258
|
+
<span class="name">:start</span>
|
|
259
|
+
<span class="type">(<tt>Sitemap::Resource</tt>)</span>
|
|
260
|
+
<span class="default">
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
— <div class='inline'><p>The resource
|
|
265
|
+
from which to start the list. If not specified,
|
|
266
|
+
then this resource’s brethren will be listed.</p>
|
|
267
|
+
</div>
|
|
268
|
+
|
|
269
|
+
</li>
|
|
270
|
+
|
|
271
|
+
</ul>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<p class="tag_title">Returns:</p>
|
|
275
|
+
<ul class="return">
|
|
276
|
+
|
|
277
|
+
<li>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
—
|
|
285
|
+
<div class='inline'><p>A <code><dl></code> containing the list.</p>
|
|
286
|
+
</div>
|
|
287
|
+
|
|
288
|
+
</li>
|
|
289
|
+
|
|
290
|
+
</ul>
|
|
291
|
+
|
|
292
|
+
</div>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
<div class="method_details ">
|
|
296
|
+
<h3 class="signature " id="nav_brethren_index-instance_method">
|
|
297
|
+
|
|
298
|
+
- (<tt>String</tt>) <strong>nav_brethren_index</strong>(locals = {})
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
</h3><div class="docstring">
|
|
305
|
+
<div class="discussion">
|
|
306
|
+
<p>Generates a condensed list of related topics as an
|
|
307
|
+
<code><ul></code>, omitting the <code>:blurb</code> front matter data.</p>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</div>
|
|
311
|
+
</div>
|
|
312
|
+
<div class="tags">
|
|
313
|
+
<p class="tag_title">Parameters:</p>
|
|
314
|
+
<ul class="param">
|
|
315
|
+
|
|
316
|
+
<li>
|
|
317
|
+
|
|
318
|
+
<span class='name'>locals</span>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
—
|
|
328
|
+
<div class='inline'><p>A hash of key-value pairs that
|
|
329
|
+
are passed to the structure as local variables.</p>
|
|
330
|
+
</div>
|
|
331
|
+
|
|
332
|
+
</li>
|
|
333
|
+
|
|
334
|
+
</ul>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
<p class="tag_title">Options Hash (<tt>locals</tt>):</p>
|
|
340
|
+
<ul class="option">
|
|
341
|
+
|
|
342
|
+
<li>
|
|
343
|
+
<span class="name">:klass</span>
|
|
344
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
345
|
+
<span class="default">
|
|
346
|
+
|
|
347
|
+
</span>
|
|
348
|
+
|
|
349
|
+
— <div class='inline'><p>The <code>class</code> attribute
|
|
350
|
+
value that should be assigned to the containing
|
|
351
|
+
element.</p>
|
|
352
|
+
</div>
|
|
353
|
+
|
|
354
|
+
</li>
|
|
355
|
+
|
|
356
|
+
<li>
|
|
357
|
+
<span class="name">:start</span>
|
|
358
|
+
<span class="type">(<tt>Sitemap::Resource</tt>)</span>
|
|
359
|
+
<span class="default">
|
|
360
|
+
|
|
361
|
+
</span>
|
|
362
|
+
|
|
363
|
+
— <div class='inline'><p>The resource
|
|
364
|
+
from which to start the list. If not specified,
|
|
365
|
+
then this resource’s brethren will be listed.</p>
|
|
366
|
+
</div>
|
|
367
|
+
|
|
368
|
+
</li>
|
|
369
|
+
|
|
370
|
+
</ul>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
<p class="tag_title">Returns:</p>
|
|
374
|
+
<ul class="return">
|
|
375
|
+
|
|
376
|
+
<li>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
—
|
|
384
|
+
<div class='inline'><p>An <code><ul></code> containing the list.</p>
|
|
385
|
+
</div>
|
|
386
|
+
|
|
387
|
+
</li>
|
|
388
|
+
|
|
389
|
+
</ul>
|
|
390
|
+
|
|
391
|
+
</div>
|
|
392
|
+
</div>
|
|
393
|
+
|
|
394
|
+
<div class="method_details ">
|
|
395
|
+
<h3 class="signature " id="nav_legitimate_children-instance_method">
|
|
396
|
+
|
|
397
|
+
- (<tt>String</tt>) <strong>nav_legitimate_children</strong>(locals = {})
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
</h3><div class="docstring">
|
|
404
|
+
<div class="discussion">
|
|
405
|
+
<p>Generates a fuller list of child topics as a <code><dl></code>,
|
|
406
|
+
with a link to the page as the definition term and the
|
|
407
|
+
page’s front matter <code>:blurb</code> as the definition
|
|
408
|
+
definition.</p>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
</div>
|
|
412
|
+
</div>
|
|
413
|
+
<div class="tags">
|
|
414
|
+
<p class="tag_title">Parameters:</p>
|
|
415
|
+
<ul class="param">
|
|
416
|
+
|
|
417
|
+
<li>
|
|
418
|
+
|
|
419
|
+
<span class='name'>locals</span>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
—
|
|
429
|
+
<div class='inline'><p>A hash of key-value pairs that
|
|
430
|
+
are passed to the structure as local variables.</p>
|
|
431
|
+
</div>
|
|
432
|
+
|
|
433
|
+
</li>
|
|
434
|
+
|
|
435
|
+
</ul>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<p class="tag_title">Options Hash (<tt>locals</tt>):</p>
|
|
441
|
+
<ul class="option">
|
|
442
|
+
|
|
443
|
+
<li>
|
|
444
|
+
<span class="name">:klass</span>
|
|
445
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
446
|
+
<span class="default">
|
|
447
|
+
|
|
448
|
+
</span>
|
|
449
|
+
|
|
450
|
+
— <div class='inline'><p>The <code>class</code> attribute
|
|
451
|
+
value that should be assigned to the containing
|
|
452
|
+
element.</p>
|
|
453
|
+
</div>
|
|
454
|
+
|
|
455
|
+
</li>
|
|
456
|
+
|
|
457
|
+
<li>
|
|
458
|
+
<span class="name">:start</span>
|
|
459
|
+
<span class="type">(<tt>Sitemap::Resource</tt>)</span>
|
|
460
|
+
<span class="default">
|
|
461
|
+
|
|
462
|
+
</span>
|
|
463
|
+
|
|
464
|
+
— <div class='inline'><p>The resource
|
|
465
|
+
from which to start the list. If not specified,
|
|
466
|
+
then this resource’s children will be listed.</p>
|
|
467
|
+
</div>
|
|
468
|
+
|
|
469
|
+
</li>
|
|
470
|
+
|
|
471
|
+
</ul>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
<p class="tag_title">Returns:</p>
|
|
475
|
+
<ul class="return">
|
|
476
|
+
|
|
477
|
+
<li>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
—
|
|
485
|
+
<div class='inline'><p>A <code><dl></code> containing the list.</p>
|
|
486
|
+
</div>
|
|
487
|
+
|
|
488
|
+
</li>
|
|
489
|
+
|
|
490
|
+
</ul>
|
|
491
|
+
|
|
492
|
+
</div>
|
|
493
|
+
</div>
|
|
494
|
+
|
|
495
|
+
<div class="method_details ">
|
|
496
|
+
<h3 class="signature " id="nav_prev_next-instance_method">
|
|
497
|
+
|
|
498
|
+
- (<tt>String</tt>) <strong>nav_prev_next</strong>(locals = {})
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</h3><div class="docstring">
|
|
505
|
+
<div class="discussion">
|
|
506
|
+
<p>Generates a previous and next item as two anchors
|
|
507
|
+
nested within a <code><div></code>. With appropriate CSS this
|
|
508
|
+
can be rendered as a set of navigation buttons.</p>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
</div>
|
|
512
|
+
</div>
|
|
513
|
+
<div class="tags">
|
|
514
|
+
<p class="tag_title">Parameters:</p>
|
|
515
|
+
<ul class="param">
|
|
516
|
+
|
|
517
|
+
<li>
|
|
518
|
+
|
|
519
|
+
<span class='name'>locals</span>
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
—
|
|
529
|
+
<div class='inline'><p>A hash of key-value pairs that
|
|
530
|
+
are passed to the structure as local variables.</p>
|
|
531
|
+
</div>
|
|
532
|
+
|
|
533
|
+
</li>
|
|
534
|
+
|
|
535
|
+
</ul>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
<p class="tag_title">Options Hash (<tt>locals</tt>):</p>
|
|
541
|
+
<ul class="option">
|
|
542
|
+
|
|
543
|
+
<li>
|
|
544
|
+
<span class="name">:klass</span>
|
|
545
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
546
|
+
<span class="default">
|
|
547
|
+
|
|
548
|
+
</span>
|
|
549
|
+
|
|
550
|
+
— <div class='inline'><p>The <code>class</code> attribute
|
|
551
|
+
value that should be assigned to the containing
|
|
552
|
+
element.</p>
|
|
553
|
+
</div>
|
|
554
|
+
|
|
555
|
+
</li>
|
|
556
|
+
|
|
557
|
+
<li>
|
|
558
|
+
<span class="name">:label_previous</span>
|
|
559
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
560
|
+
<span class="default">
|
|
561
|
+
|
|
562
|
+
</span>
|
|
563
|
+
|
|
564
|
+
— <div class='inline'><p>The text for
|
|
565
|
+
the label that means “Previous page.”</p>
|
|
566
|
+
</div>
|
|
567
|
+
|
|
568
|
+
</li>
|
|
569
|
+
|
|
570
|
+
<li>
|
|
571
|
+
<span class="name">:label_next</span>
|
|
572
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
573
|
+
<span class="default">
|
|
574
|
+
|
|
575
|
+
</span>
|
|
576
|
+
|
|
577
|
+
— <div class='inline'><p>The text for the
|
|
578
|
+
label that means “Next page.”</p>
|
|
579
|
+
</div>
|
|
580
|
+
|
|
581
|
+
</li>
|
|
582
|
+
|
|
583
|
+
</ul>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
<p class="tag_title">Returns:</p>
|
|
587
|
+
<ul class="return">
|
|
588
|
+
|
|
589
|
+
<li>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
—
|
|
597
|
+
<div class='inline'><p>A <code><div></code> containing the links.</p>
|
|
598
|
+
</div>
|
|
599
|
+
|
|
600
|
+
</li>
|
|
601
|
+
|
|
602
|
+
</ul>
|
|
603
|
+
|
|
604
|
+
</div>
|
|
605
|
+
</div>
|
|
606
|
+
|
|
607
|
+
<div class="method_details ">
|
|
608
|
+
<h3 class="signature " id="nav_toc_index-instance_method">
|
|
609
|
+
|
|
610
|
+
- (<tt>String</tt>) <strong>nav_toc_index</strong>(locals = {})
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
</h3><div class="docstring">
|
|
617
|
+
<div class="discussion">
|
|
618
|
+
<p>Generate a nested <code><ul></code> structure representing the
|
|
619
|
+
complete table of contents from any particular
|
|
620
|
+
starting point.</p>
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
</div>
|
|
624
|
+
</div>
|
|
625
|
+
<div class="tags">
|
|
626
|
+
<p class="tag_title">Parameters:</p>
|
|
627
|
+
<ul class="param">
|
|
628
|
+
|
|
629
|
+
<li>
|
|
630
|
+
|
|
631
|
+
<span class='name'>locals</span>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
—
|
|
641
|
+
<div class='inline'><p>A hash of key-value pairs that
|
|
642
|
+
are passed to the structure as local variables.</p>
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
</li>
|
|
646
|
+
|
|
647
|
+
</ul>
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<p class="tag_title">Options Hash (<tt>locals</tt>):</p>
|
|
653
|
+
<ul class="option">
|
|
654
|
+
|
|
655
|
+
<li>
|
|
656
|
+
<span class="name">:klass</span>
|
|
657
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
658
|
+
<span class="default">
|
|
659
|
+
|
|
660
|
+
</span>
|
|
661
|
+
|
|
662
|
+
— <div class='inline'><p>The <code>class</code> attribute
|
|
663
|
+
value that should be assigned to the containing
|
|
664
|
+
element.</p>
|
|
665
|
+
</div>
|
|
666
|
+
|
|
667
|
+
</li>
|
|
668
|
+
|
|
669
|
+
<li>
|
|
670
|
+
<span class="name">:start</span>
|
|
671
|
+
<span class="type">(<tt>Sitemap::Resource</tt>)</span>
|
|
672
|
+
<span class="default">
|
|
673
|
+
|
|
674
|
+
</span>
|
|
675
|
+
|
|
676
|
+
— <div class='inline'><p>The resource
|
|
677
|
+
from which to start the list. If not specified,
|
|
678
|
+
then this resource will be used as the root.</p>
|
|
679
|
+
</div>
|
|
680
|
+
|
|
681
|
+
</li>
|
|
682
|
+
|
|
683
|
+
</ul>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<p class="tag_title">Returns:</p>
|
|
687
|
+
<ul class="return">
|
|
688
|
+
|
|
689
|
+
<li>
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
—
|
|
697
|
+
<div class='inline'><p>An <code><ul></code> containing the list.</p>
|
|
698
|
+
</div>
|
|
699
|
+
|
|
700
|
+
</li>
|
|
701
|
+
|
|
702
|
+
</ul>
|
|
703
|
+
|
|
704
|
+
</div>
|
|
705
|
+
</div>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
</div>
|
|
709
|
+
|
|
710
|
+
|