middlemac-extras 1.0.6 → 1.0.7

data/documentation_project/source/partials/_yard_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/source/partials/_yard_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>
+
+

data/documentation_project/source/partials/_yard_helpers_extended.erb

@@ -0,0 +1,135 @@
+
+
+
+
+
+  <div class="method_details_list">
+    
+    
+      
+        <div class="method_details first">
+  <h3 class="signature first" id="image_tag-instance_method">
+  
+    - (<tt>String</tt>) <strong>image_tag</strong>(path, params = {}) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>With the proper options enabled this helper extends
+the built-in functionality of <strong>Middleman</strong>’s helpers
+in a couple of ways. With <code>:retina_srcset</code> enabled,
+automatic <code>srcset</code> attributes will be applied to
+<code>&lt;img&gt;</code> tags if an @2x version of the specified image
+is found. With <code>:img_auto_extensions</code> it’s possible to
+specify image names without the file name extension.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>path</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Specify path to the image file.</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>params</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'><p>Optional parameters to pass to
+the helper. <strong>Middleman</strong> (and other extensions)
+provide other parameters in addition to these.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>params</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">:img_auto_extensions</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>Allows
+control of the automatic image extensions option
+on a per-use basis.</p>
+</div>
+          
+        </li>
+      
+        <li>
+          <span class="name">:retina_srcset</span>
+          <span class="type">(<tt>Boolean</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'><p>Allows control
+of the automatic @2x images feature on a per-use
+basis.</p>
+</div>
+          
+        </li>
+      
+    </ul>
+  
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns an HTML <code>&lt;img&gt;</code> tag.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+    
+  </div>
+
+