middleman-pagegroups 1.0.4 → 1.0.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.gitattributes +4 -0
- data/CHANGELOG.md +53 -3
- data/README.md +9 -0
- data/README_doc.html +5172 -0
- data/Rakefile +5 -1
- data/documentation_project/Gemfile +2 -2
- data/documentation_project/config.rb +5 -1
- data/documentation_project/source/partials/_yard_config.erb +12 -12
- data/documentation_project/source/partials/_yard_helpers.erb +7 -7
- data/documentation_project/source/partials/_yard_helpers_css.erb +10 -10
- data/documentation_project/source/partials/_yard_helpers_extended.erb +1 -1
- data/documentation_project/source/partials/_yard_resources.erb +59 -13
- data/features/helpers_and_resources.feature +1 -1
- data/features/support/env.rb +0 -14
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/10_sibling_one.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/20_sibling_two.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/image.png +7 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/index.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/index.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/sibling_one.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/sibling_two.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/index.html.md.erb +7 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/sibling_one.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/30_nested_top/sibling_two.html.md.erb +8 -0
- data/fixtures/middleman_pagegroups_app/source/image.png +7 -0
- data/lib/middleman-pagegroups/extension.rb +63 -15
- data/lib/middleman-pagegroups/version.rb +1 -1
- data/middleman-pagegroups.gemspec +16 -1
- metadata +31 -20
data/Rakefile
CHANGED
@@ -17,7 +17,11 @@ task :default => :test
|
|
17
17
|
# Perform Cucumber testing.
|
18
18
|
###############################################################################
|
19
19
|
Cucumber::Rake::Task.new(:test, 'Features that must pass') do |task|
|
20
|
-
task.cucumber_opts = '--require features --color --tags
|
20
|
+
task.cucumber_opts = '--publish-quiet --require features --color --tags "not @wip" --strict --format pretty 2>/dev/null'
|
21
|
+
end
|
22
|
+
|
23
|
+
Cucumber::Rake::Task.new(:testnoisy, 'Features that must pass') do |task|
|
24
|
+
task.cucumber_opts = '--publish-quiet --require features --color --tags "not @wip" --strict --format pretty'
|
21
25
|
end
|
22
26
|
|
23
27
|
|
@@ -9,8 +9,8 @@ gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
|
|
9
9
|
gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
|
10
10
|
|
11
11
|
# Middleman Gems
|
12
|
-
gem 'middleman-pagegroups', '~> 1.0.
|
13
|
-
gem 'middleman', '~> 4.
|
12
|
+
gem 'middleman-pagegroups', '~> 1.0.9'
|
13
|
+
gem 'middleman', '~> 4.3.7'
|
14
14
|
gem 'middleman-syntax'
|
15
15
|
|
16
16
|
|
@@ -9,7 +9,7 @@
|
|
9
9
|
<div class="method_details first">
|
10
10
|
<h3 class="signature first" id="options[:extend_page_class]=-instance_method">
|
11
11
|
|
12
|
-
|
12
|
+
#<strong>options[:extend_page_class]=</strong>(value) ⇒ <tt>Boolean</tt>
|
13
13
|
|
14
14
|
|
15
15
|
|
@@ -70,7 +70,7 @@ to include simple <code>group</code> and <code>page_name</code> for each resourc
|
|
70
70
|
<div class="method_details ">
|
71
71
|
<h3 class="signature " id="options[:nav_breadcrumbs_alt_class]=-instance_method">
|
72
72
|
|
73
|
-
|
73
|
+
#<strong>options[:nav_breadcrumbs_alt_class]=</strong>(value) ⇒ <tt>String</tt>
|
74
74
|
|
75
75
|
|
76
76
|
|
@@ -131,7 +131,7 @@ containing element.</p>
|
|
131
131
|
<div class="method_details ">
|
132
132
|
<h3 class="signature " id="options[:nav_breadcrumbs_alt_label]=-instance_method">
|
133
133
|
|
134
|
-
|
134
|
+
#<strong>options[:nav_breadcrumbs_alt_label]=</strong>(value) ⇒ <tt>String</tt>
|
135
135
|
|
136
136
|
|
137
137
|
|
@@ -192,7 +192,7 @@ containing element.</p>
|
|
192
192
|
<div class="method_details ">
|
193
193
|
<h3 class="signature " id="options[:nav_breadcrumbs_class]=-instance_method">
|
194
194
|
|
195
|
-
|
195
|
+
#<strong>options[:nav_breadcrumbs_class]=</strong>(value) ⇒ <tt>String</tt>
|
196
196
|
|
197
197
|
|
198
198
|
|
@@ -253,7 +253,7 @@ containing element.</p>
|
|
253
253
|
<div class="method_details ">
|
254
254
|
<h3 class="signature " id="options[:nav_brethren_class]=-instance_method">
|
255
255
|
|
256
|
-
|
256
|
+
#<strong>options[:nav_brethren_class]=</strong>(value) ⇒ <tt>String</tt>
|
257
257
|
|
258
258
|
|
259
259
|
|
@@ -314,7 +314,7 @@ containing element.</p>
|
|
314
314
|
<div class="method_details ">
|
315
315
|
<h3 class="signature " id="options[:nav_brethren_index_class]=-instance_method">
|
316
316
|
|
317
|
-
|
317
|
+
#<strong>options[:nav_brethren_index_class]=</strong>(value) ⇒ <tt>String</tt>
|
318
318
|
|
319
319
|
|
320
320
|
|
@@ -375,7 +375,7 @@ containing element.</p>
|
|
375
375
|
<div class="method_details ">
|
376
376
|
<h3 class="signature " id="options[:nav_legitimate_children_class]=-instance_method">
|
377
377
|
|
378
|
-
|
378
|
+
#<strong>options[:nav_legitimate_children_class]=</strong>(value) ⇒ <tt>String</tt>
|
379
379
|
|
380
380
|
|
381
381
|
|
@@ -436,7 +436,7 @@ containing element.</p>
|
|
436
436
|
<div class="method_details ">
|
437
437
|
<h3 class="signature " id="options[:nav_prev_next_class]=-instance_method">
|
438
438
|
|
439
|
-
|
439
|
+
#<strong>options[:nav_prev_next_class]=</strong>(value) ⇒ <tt>String</tt>
|
440
440
|
|
441
441
|
|
442
442
|
|
@@ -497,7 +497,7 @@ containing element.</p>
|
|
497
497
|
<div class="method_details ">
|
498
498
|
<h3 class="signature " id="options[:nav_prev_next_label_next]=-instance_method">
|
499
499
|
|
500
|
-
|
500
|
+
#<strong>options[:nav_prev_next_label_next]=</strong>(value) ⇒ <tt>String</tt>
|
501
501
|
|
502
502
|
|
503
503
|
|
@@ -558,7 +558,7 @@ containing element.</p>
|
|
558
558
|
<div class="method_details ">
|
559
559
|
<h3 class="signature " id="options[:nav_prev_next_label_prev]=-instance_method">
|
560
560
|
|
561
|
-
|
561
|
+
#<strong>options[:nav_prev_next_label_prev]=</strong>(value) ⇒ <tt>String</tt>
|
562
562
|
|
563
563
|
|
564
564
|
|
@@ -619,7 +619,7 @@ containing element.</p>
|
|
619
619
|
<div class="method_details ">
|
620
620
|
<h3 class="signature " id="options[:nav_toc_index_class]=-instance_method">
|
621
621
|
|
622
|
-
|
622
|
+
#<strong>options[:nav_toc_index_class]=</strong>(value) ⇒ <tt>String</tt>
|
623
623
|
|
624
624
|
|
625
625
|
|
@@ -680,7 +680,7 @@ containing element.</p>
|
|
680
680
|
<div class="method_details ">
|
681
681
|
<h3 class="signature " id="options[:strip_file_prefixes]=-instance_method">
|
682
682
|
|
683
|
-
|
683
|
+
#<strong>options[:strip_file_prefixes]=</strong>(value) ⇒ <tt>Boolean</tt>
|
684
684
|
|
685
685
|
|
686
686
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
<div class="method_details first">
|
11
11
|
<h3 class="signature first" id="nav_breadcrumbs-instance_method">
|
12
12
|
|
13
|
-
|
13
|
+
#<strong>nav_breadcrumbs</strong>(locals = {}) ⇒ <tt>String</tt>
|
14
14
|
|
15
15
|
|
16
16
|
|
@@ -95,7 +95,7 @@ element.</p>
|
|
95
95
|
<div class="method_details ">
|
96
96
|
<h3 class="signature " id="nav_breadcrumbs_alt-instance_method">
|
97
97
|
|
98
|
-
|
98
|
+
#<strong>nav_breadcrumbs_alt</strong>(locals = {}) ⇒ <tt>String</tt>
|
99
99
|
|
100
100
|
|
101
101
|
|
@@ -194,7 +194,7 @@ that means “Current page.”</p>
|
|
194
194
|
<div class="method_details ">
|
195
195
|
<h3 class="signature " id="nav_brethren-instance_method">
|
196
196
|
|
197
|
-
|
197
|
+
#<strong>nav_brethren</strong>(locals = {}) ⇒ <tt>String</tt>
|
198
198
|
|
199
199
|
|
200
200
|
|
@@ -295,7 +295,7 @@ then this resource’s brethren will be listed.</p>
|
|
295
295
|
<div class="method_details ">
|
296
296
|
<h3 class="signature " id="nav_brethren_index-instance_method">
|
297
297
|
|
298
|
-
|
298
|
+
#<strong>nav_brethren_index</strong>(locals = {}) ⇒ <tt>String</tt>
|
299
299
|
|
300
300
|
|
301
301
|
|
@@ -394,7 +394,7 @@ then this resource’s brethren will be listed.</p>
|
|
394
394
|
<div class="method_details ">
|
395
395
|
<h3 class="signature " id="nav_legitimate_children-instance_method">
|
396
396
|
|
397
|
-
|
397
|
+
#<strong>nav_legitimate_children</strong>(locals = {}) ⇒ <tt>String</tt>
|
398
398
|
|
399
399
|
|
400
400
|
|
@@ -495,7 +495,7 @@ then this resource’s children will be listed.</p>
|
|
495
495
|
<div class="method_details ">
|
496
496
|
<h3 class="signature " id="nav_prev_next-instance_method">
|
497
497
|
|
498
|
-
|
498
|
+
#<strong>nav_prev_next</strong>(locals = {}) ⇒ <tt>String</tt>
|
499
499
|
|
500
500
|
|
501
501
|
|
@@ -607,7 +607,7 @@ label that means “Next page.”</p>
|
|
607
607
|
<div class="method_details ">
|
608
608
|
<h3 class="signature " id="nav_toc_index-instance_method">
|
609
609
|
|
610
|
-
|
610
|
+
#<strong>nav_toc_index</strong>(locals = {}) ⇒ <tt>String</tt>
|
611
611
|
|
612
612
|
|
613
613
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
<div class="method_details first">
|
11
11
|
<h3 class="signature first" id="nav_breadcrumbs_alt_class-instance_method">
|
12
12
|
|
13
|
-
|
13
|
+
#<strong>nav_breadcrumbs_alt_class</strong> ⇒ <tt>String</tt>
|
14
14
|
|
15
15
|
|
16
16
|
|
@@ -61,7 +61,7 @@ can be changed using the extension options.</p>
|
|
61
61
|
<div class="method_details ">
|
62
62
|
<h3 class="signature " id="nav_breadcrumbs_alt_label-instance_method">
|
63
63
|
|
64
|
-
|
64
|
+
#<strong>nav_breadcrumbs_alt_label</strong> ⇒ <tt>String</tt>
|
65
65
|
|
66
66
|
|
67
67
|
|
@@ -112,7 +112,7 @@ can be changed using the extension options.</p>
|
|
112
112
|
<div class="method_details ">
|
113
113
|
<h3 class="signature " id="nav_breadcrumbs_class-instance_method">
|
114
114
|
|
115
|
-
|
115
|
+
#<strong>nav_breadcrumbs_class</strong> ⇒ <tt>String</tt>
|
116
116
|
|
117
117
|
|
118
118
|
|
@@ -163,7 +163,7 @@ can be changed using the extension options.</p>
|
|
163
163
|
<div class="method_details ">
|
164
164
|
<h3 class="signature " id="nav_brethren_class-instance_method">
|
165
165
|
|
166
|
-
|
166
|
+
#<strong>nav_brethren_class</strong> ⇒ <tt>String</tt>
|
167
167
|
|
168
168
|
|
169
169
|
|
@@ -214,7 +214,7 @@ can be changed using the extension options.</p>
|
|
214
214
|
<div class="method_details ">
|
215
215
|
<h3 class="signature " id="nav_brethren_index_class-instance_method">
|
216
216
|
|
217
|
-
|
217
|
+
#<strong>nav_brethren_index_class</strong> ⇒ <tt>String</tt>
|
218
218
|
|
219
219
|
|
220
220
|
|
@@ -265,7 +265,7 @@ can be changed using the extension options.</p>
|
|
265
265
|
<div class="method_details ">
|
266
266
|
<h3 class="signature " id="nav_legitimate_children_class-instance_method">
|
267
267
|
|
268
|
-
|
268
|
+
#<strong>nav_legitimate_children_class</strong> ⇒ <tt>String</tt>
|
269
269
|
|
270
270
|
|
271
271
|
|
@@ -316,7 +316,7 @@ can be changed using the extension options.</p>
|
|
316
316
|
<div class="method_details ">
|
317
317
|
<h3 class="signature " id="nav_prev_next_class-instance_method">
|
318
318
|
|
319
|
-
|
319
|
+
#<strong>nav_prev_next_class</strong> ⇒ <tt>String</tt>
|
320
320
|
|
321
321
|
|
322
322
|
|
@@ -367,7 +367,7 @@ can be changed using the extension options.</p>
|
|
367
367
|
<div class="method_details ">
|
368
368
|
<h3 class="signature " id="nav_prev_next_label_next-instance_method">
|
369
369
|
|
370
|
-
|
370
|
+
#<strong>nav_prev_next_label_next</strong> ⇒ <tt>String</tt>
|
371
371
|
|
372
372
|
|
373
373
|
|
@@ -418,7 +418,7 @@ can be changed using the extension options.</p>
|
|
418
418
|
<div class="method_details ">
|
419
419
|
<h3 class="signature " id="nav_prev_next_label_prev-instance_method">
|
420
420
|
|
421
|
-
|
421
|
+
#<strong>nav_prev_next_label_prev</strong> ⇒ <tt>String</tt>
|
422
422
|
|
423
423
|
|
424
424
|
|
@@ -469,7 +469,7 @@ can be changed using the extension options.</p>
|
|
469
469
|
<div class="method_details ">
|
470
470
|
<h3 class="signature " id="nav_toc_index_class-instance_method">
|
471
471
|
|
472
|
-
|
472
|
+
#<strong>nav_toc_index_class</strong> ⇒ <tt>String</tt>
|
473
473
|
|
474
474
|
|
475
475
|
|
@@ -10,7 +10,7 @@
|
|
10
10
|
<div class="method_details first">
|
11
11
|
<h3 class="signature first" id="resource.breadcrumbs-instance_method">
|
12
12
|
|
13
|
-
|
13
|
+
#<strong>resource.breadcrumbs</strong> ⇒ <tt>Array<Sitemap::Resource></tt>
|
14
14
|
|
15
15
|
|
16
16
|
|
@@ -50,7 +50,7 @@ resources.</p>
|
|
50
50
|
<div class="method_details ">
|
51
51
|
<h3 class="signature " id="resource.brethren-instance_method">
|
52
52
|
|
53
|
-
|
53
|
+
#<strong>resource.brethren</strong> ⇒ <tt>Array<Sitemap::Resource></tt>
|
54
54
|
|
55
55
|
|
56
56
|
|
@@ -100,7 +100,7 @@ resources.</p>
|
|
100
100
|
<div class="method_details ">
|
101
101
|
<h3 class="signature " id="resource.brethren_next-instance_method">
|
102
102
|
|
103
|
-
|
103
|
+
#<strong>resource.brethren_next</strong> ⇒ <tt>Sitemap::Resource</tt>
|
104
104
|
|
105
105
|
|
106
106
|
|
@@ -141,7 +141,7 @@ the next sibling.</p>
|
|
141
141
|
<div class="method_details ">
|
142
142
|
<h3 class="signature " id="resource.brethren_previous-instance_method">
|
143
143
|
|
144
|
-
|
144
|
+
#<strong>resource.brethren_previous</strong> ⇒ <tt>Sitemap::Resource</tt>
|
145
145
|
|
146
146
|
|
147
147
|
|
@@ -182,7 +182,7 @@ the previous sibling.</p>
|
|
182
182
|
<div class="method_details ">
|
183
183
|
<h3 class="signature " id="resource.group_count-instance_method">
|
184
184
|
|
185
|
-
|
185
|
+
#<strong>resource.group_count</strong> ⇒ <tt>Integer</tt>
|
186
186
|
|
187
187
|
|
188
188
|
|
@@ -218,13 +218,59 @@ this page’s current group.</p>
|
|
218
218
|
|
219
219
|
</ul>
|
220
220
|
|
221
|
+
</div>
|
222
|
+
</div>
|
223
|
+
|
224
|
+
<div class="method_details ">
|
225
|
+
<h3 class="signature " id="resource.legitimate?-instance_method">
|
226
|
+
|
227
|
+
#<strong>resource.legitimate?</strong> ⇒ <tt>Boolean</tt>
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
|
232
|
+
|
233
|
+
</h3><div class="docstring">
|
234
|
+
<div class="discussion">
|
235
|
+
<p>Indicates whether or not a page is “legitimate” in
|
236
|
+
terms of automatic navigation, based in:</p>
|
237
|
+
|
238
|
+
<ul>
|
239
|
+
<li>The resource has a sort order and isn’t zero.</li>
|
240
|
+
<li>The resource isn’t ignored.</li>
|
241
|
+
</ul>
|
242
|
+
|
243
|
+
|
244
|
+
</div>
|
245
|
+
</div>
|
246
|
+
<div class="tags">
|
247
|
+
|
248
|
+
<p class="tag_title">Returns:</p>
|
249
|
+
<ul class="return">
|
250
|
+
|
251
|
+
<li>
|
252
|
+
|
253
|
+
|
254
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
—
|
259
|
+
<div class='inline'><p>Returns <code>true</code> if this pages
|
260
|
+
participates in automatic navigation features.</p>
|
261
|
+
</div>
|
262
|
+
|
263
|
+
</li>
|
264
|
+
|
265
|
+
</ul>
|
266
|
+
|
221
267
|
</div>
|
222
268
|
</div>
|
223
269
|
|
224
270
|
<div class="method_details ">
|
225
271
|
<h3 class="signature " id="resource.legitimate_children-instance_method">
|
226
272
|
|
227
|
-
|
273
|
+
#<strong>resource.legitimate_children</strong> ⇒ <tt>Array<Sitemap::Resource></tt>
|
228
274
|
|
229
275
|
|
230
276
|
|
@@ -274,7 +320,7 @@ resources.</p>
|
|
274
320
|
<div class="method_details ">
|
275
321
|
<h3 class="signature " id="resource.navigator_eligible?-instance_method">
|
276
322
|
|
277
|
-
|
323
|
+
#<strong>resource.navigator_eligible?</strong> ⇒ <tt>Boolean</tt>
|
278
324
|
|
279
325
|
|
280
326
|
|
@@ -309,7 +355,7 @@ use of <code>:navigator => false</code> in its front matter.</li>
|
|
309
355
|
|
310
356
|
|
311
357
|
—
|
312
|
-
<div class='inline'><p>Returns <code>true</code> if this
|
358
|
+
<div class='inline'><p>Returns <code>true</code> if this page is
|
313
359
|
eligible for a previous/next page control.</p>
|
314
360
|
</div>
|
315
361
|
|
@@ -323,7 +369,7 @@ eligible for a previous/next page control.</p>
|
|
323
369
|
<div class="method_details ">
|
324
370
|
<h3 class="signature " id="resource.page_group-instance_method">
|
325
371
|
|
326
|
-
|
372
|
+
#<strong>resource.page_group</strong> ⇒ <tt>String</tt>
|
327
373
|
|
328
374
|
|
329
375
|
|
@@ -364,7 +410,7 @@ conditionals.</p>
|
|
364
410
|
<div class="method_details ">
|
365
411
|
<h3 class="signature " id="resource.page_name-instance_method">
|
366
412
|
|
367
|
-
|
413
|
+
#<strong>resource.page_name</strong> ⇒ <tt>String</tt>
|
368
414
|
|
369
415
|
|
370
416
|
|
@@ -405,7 +451,7 @@ Useful for assigning classes, etc.</p>
|
|
405
451
|
<div class="method_details ">
|
406
452
|
<h3 class="signature " id="resource.page_sequence-instance_method">
|
407
453
|
|
408
|
-
|
454
|
+
#<strong>resource.page_sequence</strong> ⇒ <tt>Integer</tt>, <tt>Nil</tt>
|
409
455
|
|
410
456
|
|
411
457
|
|
@@ -448,7 +494,7 @@ this resource among its brethren.</p>
|
|
448
494
|
<div class="method_details ">
|
449
495
|
<h3 class="signature " id="resource.parent-instance_method">
|
450
496
|
|
451
|
-
|
497
|
+
#<strong>resource.parent</strong> ⇒ <tt>Sitemap::Resource</tt>
|
452
498
|
|
453
499
|
|
454
500
|
|
@@ -491,7 +537,7 @@ the resource’s parent.</p>
|
|
491
537
|
<div class="method_details ">
|
492
538
|
<h3 class="signature " id="resource.sort_order-instance_method">
|
493
539
|
|
494
|
-
|
540
|
+
#<strong>resource.sort_order</strong> ⇒ <tt>Integer</tt>
|
495
541
|
|
496
542
|
|
497
543
|
|