middlemac 2.0.0

data/documentation_project/Contents/Resources/Base.lproj/assets/javascripts/all.js

@@ -0,0 +1 @@
+//= require_tree .

data/documentation_project/Contents/Resources/Base.lproj/assets/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/Contents/Resources/Base.lproj/assets/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/Contents/Resources/Base.lproj/assets/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/Contents/Resources/Base.lproj/assets/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/Contents/Resources/Base.lproj/assets/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/Contents/Resources/Base.lproj/assets/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/Contents/Resources/Base.lproj/assets/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/Contents/Resources/Base.lproj/assets/partials/_yard_extras_config.erb

@@ -0,0 +1,200 @@
+
+
+
+
+  <div id="instance_attr_details" class="attr_details">
+    
+      
+      <span id="options[:img_auto_extensions]=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="options[:img_auto_extensions]=-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>options[:img_auto_extensions]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option determines whether or not to support specifying images without
+using a file name extension. If set to <code>true</code> then the <code>image_tag</code> helper
+will work for images even if you don’t specify an extension, but only if a
+file exists on disk that has one of the extensions in 
+<code>:img_auto_extensions_order</code>.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this feature.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:img_auto_extensions_order]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:img_auto_extensions_order]=-instance_method">
+  
+    - (<tt>Array&lt;String&gt;</tt>) <strong>options[:img_auto_extensions_order]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option defines the eligible file name extensions and their precedence
+when you specify an image without an extension using the <code>image_tag</code> helper.
+Set this to an array of image file extensions in your desired order of
+of precedence.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Set to an array of image extensions.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:retina_srcset]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:retina_srcset]=-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>options[:retina_srcset]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option determines whether or not the enhanced <code>image_tag</code> helper will
+be used to include an @2x <code>srcset</code> attribute automatically. This automatic
+behavior will only be applied if the image asset exists on disk and this
+option is set to <code>true</code>.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this feature.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+  </div>
+
+
+

data/documentation_project/Contents/Resources/Base.lproj/assets/partials/_yard_extras_helpers.erb

@@ -0,0 +1,146 @@
+
+
+
+
+
+  <div class="method_details_list">
+    
+    
+      
+        <div class="method_details first">
+  <h3 class="signature first" id="css_image_sizes-instance_method">
+  
+    - (<tt>String</tt>) <strong>css_image_sizes</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides CSS for every image in your
+project. Each image will have a declaration that sets
+<code>max-width</code> and <code>max-height</code> to the actual size of the
+image. Proper @2x image support is included. It’s most
+useful to use this helper in a <code>some_file.css.erb</code>
+file.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the CSS markup
+for every image found in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+        <div class="method_details ">
+  <h3 class="signature " id="md_images-instance_method">
+  
+    - (<tt>String</tt>) <strong>md_images</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides access to <code>middlemac-extras</code>’ 
+index of images in Markdown reference format, enabling
+you to use reference-style images in documents. Because
+this helper includes literal Markdown, it’s only useful
+in Markdown documents.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the Markdown
+index of every image in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+        <div class="method_details ">
+  <h3 class="signature " id="md_links-instance_method">
+  
+    - (<tt>String</tt>) <strong>md_links</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides access to <code>middlemac-extras</code>’ 
+index of links in Markdown reference format, enabling
+you to use reference-style links in documents. Because
+this helper includes literal Markdown, it’s only useful
+in Markdown documents.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the Markdown
+index of every page in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+    
+  </div>
+
+