middleman-pagegroups 1.0.0

data/documentation_project/source/index.html.md.erb

@@ -0,0 +1,39 @@
+---
+title:    Welcome to <code>middleman-pagegroups</code>
+blurb:    <em>middleman-pageGroups</em> is a great way to serve organized content.
+layout:   template-logo-large
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+Thanks for having a look at `middlemac-pagegroups`! This documentation is an
+example of “eating your own dog food,” and uses the features of this extension
+to demonstrate itself.
+
+`middleman-pagegroups` principally enables **automatic navigation** via the
+management of **sort order**, **groups** (including nested groups), and making
+a determination about the **legitimacy** of these relationships.
+
+It provides sample partials to enable **breadcrumbs**, **previous** and 
+**next** buttons, **tables of contents**, and **related pages**, all using the
+concepts that enable automatic navigation.
+
+The extension itself is quite simple; it adds a few methods to each resource
+(those that you access with `current_page`, as well as several helpers, and if
+you prefer to use partials, `middleman-pagegroups` can even generate some sample
+partials for you.
+
+* * *
+
+<%= nav_legitimate_children %>
+
+* * *
+
+The table of contents above is the result of using the `nav_legitimate_children`
+helper; all of the data comes automatically from the front matter of the files
+that are part of this `source` group.
+
+~~~ erb
+<%%= nav_legitimate_children %>
+~~~

data/documentation_project/source/javascripts/all.js

@@ -0,0 +1 @@
+// This is where it all goes :)

data/documentation_project/source/layouts/layout.haml

@@ -0,0 +1,11 @@
+!!! 5
+%html
+  %head
+    %title= current_page.data.title || 'middleman-targets'
+    %meta{:content => 'text/html; charset=utf-8', :'http-equiv' => 'Content-Type'}/
+    = stylesheet_link_tag 'style'
+    = javascript_include_tag 'all'
+  %body{:class => "#{page_classes}"}
+    %nav#breadcrumbs
+      = nav_breadcrumbs_alt
+    = yield

data/documentation_project/source/layouts/template-logo-large.haml

@@ -0,0 +1,25 @@
+= wrap_layout ('layout'.to_sym) do
+  .container-logo-large
+    %div
+      %div
+        = image_tag 'middleman-pagegroups-small.png', :alt => 'middleman-pagegroups logo'
+        %h1= "#{product_name}"
+        %h2= "version #{product_version}"
+        %a{:href => product_uri}= product_uri
+
+      - if content_for?(:seeAlso)
+        .related_topics
+          %h1 See Also
+          = yield_content :seeAlso
+
+    %div
+      .yield-content
+        ~ yield
+        - if current_page.navigator_eligible?
+          %hr
+          = nav_prev_next
+
+-#
+  This template is suitable for your landing page or major sections, and features
+  a large version of your logo, the application name, and the application URI.
+  It can include optional :seeAlso content below the application URI.

data/documentation_project/source/layouts/template-logo-medium.haml

@@ -0,0 +1,26 @@
+= wrap_layout ('layout'.to_sym) do
+  .container-logo-medium
+    %div
+      .yield-content
+        ~ yield
+        - if current_page.navigator_eligible?
+          %hr
+          = nav_prev_next
+
+    %div
+      %div
+        = image_tag 'middleman-pagegroups-small.png', :alt => 'middleman-pagegroups logo'
+      .related_topics
+        %h1 Related Topics
+        = nav_brethren_index
+
+        - if content_for?(:seeAlso)
+          %h1 See Also
+          = yield_content :seeAlso
+
+-#
+  This template is suitable for general pages within a group, as it makes
+  navigation between the different pages in the group obvious and easy. It
+  features a medium version of your logo on the right, followed by navigation
+  to the other pages in the group. Optionally :seeAlso content can follow the
+  related pages.

data/documentation_project/source/layouts/template-logo-small.haml

@@ -0,0 +1,26 @@
+= wrap_layout ('layout'.to_sym) do
+  .container-logo-small
+    .yield-content
+      = image_tag 'middleman-pagegroups-small.png', :alt => 'middleman-pagegroups logo'
+      ~ yield
+      - if current_page.navigator_eligible?
+        %hr
+        = nav_prev_next
+
+    - if !current_page.brethren.to_a.empty? || content_for?(:seeAlso)
+      %hr/
+
+    .related_topics
+      %h1 Related Topics
+      = nav_brethren_index
+
+      - if content_for?(:seeAlso)
+        %h1 See Also
+        = yield_content :seeAlso
+
+-#
+  This template is suitable for general pages that aren’t meant to participate
+  within a group. It does show related pages followed by :seeAlso content at
+  the bottom on the page, but it’s not as obvious for simple navigation as the
+  template-logo-medium. It features a small version of your help logo in the
+  top left, followed by the title.

data/documentation_project/source/license.html.md.erb

@@ -0,0 +1,29 @@
+---
+title:    The MIT License
+blurb:    Describes your legal rights and obligations for using these materials.
+layout:   template-logo-medium
+order:    40
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+**Copyright (c) 2016 Jim Derry**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/documentation_project/source/partials/_nav_breadcrumbs.haml

@@ -0,0 +1,11 @@
+- pages = current_page.breadcrumbs
+- unless pages.to_a.empty?
+  %div{:class => (defined?(klass) && klass) || nav_breadcrumbs_class}
+    %ul
+      - pages.each do |p|
+        %li= link_to p.data.title, p
+
+-#
+  - This partial renders links into an <ul>.
+  - You probably need a class in order to render this properly.
+  - :klass - pass in this local to specify a class for the containing div.

data/documentation_project/source/partials/_nav_breadcrumbs_alt.haml

@@ -0,0 +1,15 @@
+- pages = current_page.breadcrumbs
+- unless pages.to_a.empty?
+  %div{:class => (defined?(klass) && klass) || nav_breadcrumbs_alt_class}
+    %ul
+      - pages[0...pages.count-1].each do |p|
+        %li= link_to p.data.title, p
+      %li= (defined?(label) && label) || nav_breadcrumbs_alt_label
+
+-#
+  - This partial renders links into an <ul>.
+  - You probably need a class in order to render this properly.
+  - This alternate version replaces the last link with the extension's
+    `nav_breadcrumbs_alt_label` value.
+  - :label - pass in this local instead of using the default.
+  - :klass - pass in this local to specify a class for the containing div.

data/documentation_project/source/partials/_nav_brethren.haml

@@ -0,0 +1,18 @@
+- commence = (defined?(start) && start) || current_page
+- pages = commence.brethren
+- unless pages.to_a.empty?
+  %div{:class => (defined?(klass) && klass) || nav_brethren_class}
+    %dl
+      - pages.each do |p|
+        %dt<
+          = link_to p.data.title, p
+        - if p.data.blurb
+          %dd= p.data.blurb
+
+-#
+  - This partial renders links with blurbs into a <dl> to serve as
+    a related links table of contents.
+  - You probably need a class in order to render this properly.
+  - For a compact form without blurbs, see also `_nav_brethren_index.haml.
+  - :klass - pass in this local to specify a class for the containing div.
+  - :start - pass in this local to specify a different starting point.

data/documentation_project/source/partials/_nav_brethren_index.haml

@@ -0,0 +1,14 @@
+- commence = (defined?(start) && start) || current_page
+- pages = commence.brethren
+- unless pages.to_a.empty?
+  %div{:class => (defined?(klass) && klass) || nav_brethren_index_class}
+    %ul
+      - pages.each do |p|
+        %li= link_to p.data.title, p
+
+-#
+  This partial renders brethren into an <ul> to serve as a related-pages type
+  of table of contents.
+  - You probably need a class in order to render this properly.
+  - :klass - pass in this local to specify a class for the containing div.
+  - :start - pass in this local to specify a different starting point.

data/documentation_project/source/partials/_nav_legitimate_children.haml

@@ -0,0 +1,16 @@
+- commence = (defined?(start) && start) || current_page
+- pages = commence.legitimate_children
+- unless pages.to_a.empty?
+  %div{:class => (defined?(klass) && klass) || nav_legitimate_children_class}
+    %dl
+      - pages.each do |p|
+        %dt= link_to p.data.title, p
+        - if p.data.blurb
+          %dd= p.data.blurb
+
+-#
+  This partial renders links with blurbs into a <dl> to serve as a high-level
+  table of contents.
+  - You probably need a class in order to render this properly.
+  - :klass - pass in this local to specify a class for the containing div.
+  - :start - pass in this local to specify a different starting point.

data/documentation_project/source/partials/_nav_prev_next.haml

@@ -0,0 +1,21 @@
+- p_prev = current_page.brethren_previous
+- p_next = current_page.brethren_next
+- b_prev = (defined?(label_previous) && label_previous) || nav_prev_next_label_prev
+- b_next = (defined?(label_next) && label_next) || nav_prev_next_label_next
+%div{:class => (defined?(klass) && klass) || nav_prev_next_class}
+  - if p_prev.nil?
+    %span= b_prev
+  - else
+    = link_to b_prev, p_prev
+  - if p_next.nil?
+    %span= b_next
+  - else
+    = link_to b_next, p_next
+
+-#
+  This partial renders a div with two spans that are suitable for use as
+  previous and next buttons when properly styled.
+  - You probably need a class in order to render this properly.
+  - :klass          - pass in this local to specify a class for the containing div.
+  - :label_previous - the label for the Previous button. Default is "Previous".
+  - :label_next     - the label for the Next button. Default is "Next".

data/documentation_project/source/partials/_nav_toc_index.haml

@@ -0,0 +1,21 @@
+- commence = (defined?(start) && start) || current_page
+- pages = commence.legitimate_children
+- if defined?(recurse) && recurse
+  - unless pages.to_a.empty?
+    %ul
+      - pages.each do |p|
+        %li<
+          = link_to p.data.title, p
+          = partial 'partials/toc_index', :locals => { :start => p, :recurse => true }
+- else
+  %ul{:class => (defined?(klass) && klass) || nav_toc_index_class}
+    %li<
+      = link_to commence.data.title, commence
+      = partial 'partials/toc_index', :locals => { :start => commence, :recurse => true }
+
+-#
+  - This partial renders nested links into an <ul>. The top level item is the
+    start page followed by the entire directory structure below it.
+  - You probably need a class in order to render this properly.
+  - :start - pass in this local to specify the starting page.
+  - :klass - pass in this local to specify a class for the containing div.

data/documentation_project/source/stylesheets/_github.scss

@@ -0,0 +1,61 @@
+.hll { background-color: #ffffcc }
+.c { color: #999988; font-style: italic } /* Comment */
+.err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.k { color: #000000; font-weight: bold } /* Keyword */
+.o { color: #000000; font-weight: bold } /* Operator */
+.cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.cp { color: #999999; font-weight: bold; font-style: italic } /* Comment.Preproc */
+.c1 { color: #999988; font-style: italic } /* Comment.Single */
+.cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.ge { color: #000000; font-style: italic } /* Generic.Emph */
+.gr { color: #aa0000 } /* Generic.Error */
+.gh { color: #999999 } /* Generic.Heading */
+.gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.go { color: #888888 } /* Generic.Output */
+.gp { color: #555555 } /* Generic.Prompt */
+.gs { font-weight: bold } /* Generic.Strong */
+.gu { color: #aaaaaa } /* Generic.Subheading */
+.gt { color: #aa0000 } /* Generic.Traceback */
+.kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+.kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+.kn { color: #000000; font-weight: bold } /* Keyword.Namespace */
+.kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+.kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+.kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.m { color: #009999 } /* Literal.Number */
+.s { color: #d01040 } /* Literal.String */
+.na { color: #008080 } /* Name.Attribute */
+.nb { color: #0086B3 } /* Name.Builtin */
+.nc { color: #445588; font-weight: bold } /* Name.Class */
+.no { color: #008080 } /* Name.Constant */
+.nd { color: #3c5d5d; font-weight: bold } /* Name.Decorator */
+.ni { color: #800080 } /* Name.Entity */
+.ne { color: #990000; font-weight: bold } /* Name.Exception */
+.nf { color: #990000; font-weight: bold } /* Name.Function */
+.nl { color: #990000; font-weight: bold } /* Name.Label */
+.nn { color: #555555 } /* Name.Namespace */
+.nt { color: #000080 } /* Name.Tag */
+.nv { color: #008080 } /* Name.Variable */
+.ow { color: #000000; font-weight: bold } /* Operator.Word */
+.w { color: #bbbbbb } /* Text.Whitespace */
+.mf { color: #009999 } /* Literal.Number.Float */
+.mh { color: #009999 } /* Literal.Number.Hex */
+.mi { color: #009999 } /* Literal.Number.Integer */
+.mo { color: #009999 } /* Literal.Number.Oct */
+.sb { color: #d01040 } /* Literal.String.Backtick */
+.sc { color: #d01040 } /* Literal.String.Char */
+.sd { color: #d01040 } /* Literal.String.Doc */
+.s2 { color: #d01040 } /* Literal.String.Double */
+.se { color: #d01040 } /* Literal.String.Escape */
+.sh { color: #d01040 } /* Literal.String.Heredoc */
+.si { color: #d01040 } /* Literal.String.Interpol */
+.sx { color: #d01040 } /* Literal.String.Other */
+.sr { color: #009926 } /* Literal.String.Regex */
+.s1 { color: #d01040 } /* Literal.String.Single */
+.ss { color: #990073 } /* Literal.String.Symbol */
+.bp { color: #999999 } /* Name.Builtin.Pseudo */
+.vc { color: #008080 } /* Name.Variable.Class */
+.vg { color: #008080 } /* Name.Variable.Global */
+.vi { color: #008080 } /* Name.Variable.Instance */
+.il { color: #009999 } /* Literal.Number.Integer.Long */