middleman-targets 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a0c601e30b8d5beb37283c652cf41790157c314
-  data.tar.gz: 5a24bebde45c5a00ea98d9152ae57fc60337ff59
+  metadata.gz: 5d85fe59332483c81a049792ad7a00eae847e3d2
+  data.tar.gz: eeba5c5a693173341bff0cfa0b81fcabdb37a245
 SHA512:
-  metadata.gz: 1f351b50ebaeb1f243ccc6c7a2c2c56681e0c175cc055b6642c18d602dc5de8266f904b33ae0bd13754bbfbbee6471f01065ebc28659694b451fdb5541e16c59
-  data.tar.gz: b327da177ded0c89ce0ba06355506d0f2cee7b3bba59da8de80744726bad0d0afadcc6c4b372a35f6344ddee3edb0c6d7c06b354c6bfd90f162008b03d0fde7b
+  metadata.gz: bcceac1f84f709dd37eff8d7cb953ec5eb01a8a0b03d013a337f13b4d273d08e1d96295aacb7cc0f9a58029e94555f099b1e1fa825597a8d65c43314d6dc6ee0
+  data.tar.gz: 9b54fc64ccd56e90c70cc2e4f32ffb71070300e2262a2d755b9d2139d40a3945c07206b969ca960f69fc60f6c9a3ab31d3b42a583a0b57990a7e1553747292e8

data/Rakefile

@@ -14,3 +14,24 @@ end
 YARD::Rake::YardocTask.new(:yard) do |task|
   task.stats_options = ['--list-undoc']
 end
+
+
+desc 'Make separate documents for documentation_project.'
+task :partials do
+
+  sections = [
+      { :file => 'helpers.erb',          :group => 'Helpers',  },
+      { :file => 'helpers_extended.erb', :group => 'Extended Helpers' },
+      { :file => 'config.erb',           :group => 'Middleman Configuration' },
+      { :file => 'resources.erb',        :group => 'Resource Extensions',  },
+      { :file => 'instance.erb',         :group => 'Instance Methods',  },
+  ]
+
+  sections.each do |s|
+    command = "yardoc --query 'o.group == \"#{s[:group]}\" || has_tag?(:author)' -o doc -t default -p #{File.join(File.dirname(__FILE__), 'yard', 'template-partials')}"
+    puts command
+    system(command)
+    File.rename('doc/index.html', "doc/#{s[:file]}")
+  end
+
+end

data/documentation_project/Gemfile

@@ -9,6 +9,6 @@ gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
 gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
 
 # Middleman Gems
-gem 'middleman-targets', '~>1.0.4'
+gem 'middleman-targets', '~>1.0.5'
 gem 'middleman', '~> 4.1.6'
 gem 'middleman-syntax'

data/documentation_project/config.rb

@@ -103,7 +103,7 @@ helpers do
   end
 
   def product_version
-    '1.0.4'
+    '1.0.5'
   end
 
   def product_uri

data/documentation_project/source/helpers-resources.html.md.erb

@@ -6,13 +6,10 @@ layout: template-logo-medium
 # <%= current_page.data.title %>
 
 `middleman-targets` includes some helpers and some page resources that make
-working with multiple targets easier.
+working with multiple targets easier. Most of them are demonstrated at [Simple
+features demonstration](simple-demo.html).
 
-
-## Helpers
-
-This extension provides several useful helpers to manage multiple targets and
-features. Most of them are demonstrated at [Simple features demonstration](simple-demo.html).
+<%= partial 'partials/helpers_extended' %>
 
 <%= partial 'partials/helpers' %>
 

data/documentation_project/source/partials/config.erb

@@ -1,326 +1,372 @@
-<div class="attr_details">
 
-  <div class="method_details first">
-    <h3 class="signature first" id="config[:build_dir]=-instance_method">
 
-      - (<tt>String</tt>) <strong>config[:build_dir]=</strong>(value)
 
 
+  <div id="instance_attr_details" class="attr_details">
+    
+      
+      <span id="config[:build_dir]=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="config[:build_dir]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>config[:build_dir]=</strong>(value) 
+  
 
+  
 
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Indicates where <strong>Middleman</strong> will put build output. This standard config
+value will be treated as a <em>prefix</em>; for example if the current target is
+<code>:pro</code> and this value is set to its default <code>build</code>, then the actual build
+directory will be <code>build (pro)/</code>.</p>
 
-    </h3><div class="docstring">
-    <div class="discussion">
+<p>If the <code>build_dir</code> key is present for any of the <code>config[:targets]</code>, they
+will override this setting.</p>
 
-      <p>Indicates where <strong>Middleman</strong> will put build output. This standard config
-        value will be treated as a <em>prefix</em>; for example if the current target is <code>:pro</code> and this
-        value is set to its default <code>build</code>, then the actual build directory will
-        be <code>build (pro)/</code>.</p>
 
-      <p>If the <code>build_dir</code> key is present for any of the <code>config[:targets]</code>, they
-        will override this setting.</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>String</tt>)</span>
-
-
-
-          &mdash;
-          <div class='inline'><p>Indicate the build directory prefix that should be
-            used for build output.</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 the current value of this configuration setting.</p>
-          </div>
-
-        </li>
-
-      </ul>
-
-    </div>
-  </div>
-
-
-  <div class="method_details">
-    <h3 class="signature">
-
-      - (<tt>Symbol</tt>) <strong>config[:target]=</strong>(value)
-
-
-
-
-
-    </h3><div class="docstring">
-    <div class="discussion">
-
-      <p>Indicates the current target that is being built or served. When
-        set in <code>config.rb</code> it indicates the default target if one is not
-        specified on the command line.</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>Symbol</tt>)</span>
-
-
-
-          &mdash;
-          <div class='inline'><p>The target from <code>config[:targets]</code> that should
-            be used as the default.</p>
-          </div>
-
-        </li>
-
-      </ul>
-
-      <p class="tag_title">Returns:</p>
-      <ul class="return">
-
-        <li>
-
-
-          <span class='type'>(<tt>Symbol</tt>)</span>
-
-
-
-          &mdash;
-          <div class='inline'><p>Returns the current target.</p>
-          </div>
-
-        </li>
-
-      </ul>
-
-    </div>
   </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Indicate the build directory prefix that should be
+used for build output.</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 the current value of this configuration setting.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
-
-  <div class="method_details ">
-    <h3 class="signature ">
-
-      - (<tt>Boolean</tt>) <strong>config[:target_magic_images]=</strong>(value)
-
-
-
-
-
-    </h3><div class="docstring">
-    <div class="discussion">
-
-      <p>This option is used to enable or disable the target magic images feature.
-        If it’s <code>true</code> then the <code>image_tag</code> helper will attempt to substitute
-        target-specific images instead of the specified image, if the specified
-        image begins with <code>:target_magic_word</code>.</p>
+</div>
+</div>
+    
+      
+      <span id="config[:target]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="config[:target]=-instance_method">
+  
+    - (<tt>Symbol</tt>) <strong>config[:target]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Indicates the current target that is being built or served. When
+set in <code>config.rb</code> it indicates the default target if one is not
+specified on the command line.</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>Specify whether or not automatic target-specific
-            image substitution should be enabled.</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 state of this option.</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>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The target from <code>config[:targets]</code> that should
+be used as the default.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Symbol</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current target.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
-        </li>
+</div>
+</div>
+    
+      
+      <span id="config[:target_magic_images]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="config[:target_magic_images]=-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>config[:target_magic_images]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>This option is used to enable or disable the target magic images feature.
+If it’s <code>true</code> then the <code>image_tag</code> helper will attempt to substitute
+target-specific images instead of the specified image, if the specified
+image begins with <code>:target_magic_word</code>.</p>
 
-      </ul>
 
-    </div>
   </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>Specify whether or not automatic target-specific
+image substitution should be enabled.</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 state of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
-
-  <div class="method_details ">
-    <h3 class="signature ">
-
-      - (<tt>String</tt>) <strong>config[:target_magic_word]=</strong>(value)
-
-
-
-
-
-    </h3><div class="docstring">
-    <div class="discussion">
-
-      <p>Indicates the magic image prefix for image substitution with the
-        <code>image_tag</code> helper when <code>:target_magic_images</code> is enabled. For example
-        if you specify <code>all-image.png</code> and <code>pro-image.png</code> exists, then the
-        latter will be used by the helper instead of the former.</p>
+</div>
+</div>
+    
+      
+      <span id="config[:target_magic_word]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="config[:target_magic_word]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>config[:target_magic_word]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Indicates the magic image prefix for image substitution with the
+<code>image_tag</code> helper when <code>:target_magic_images</code> is enabled. For example
+if you specify <code>all-image.png</code> and <code>pro-image.png</code> exists, then the
+latter will be used by the helper instead of the former.</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>String</tt>)</span>
-
-
-
-          &mdash;
-          <div class='inline'><p>Indicate the prefix that should indicate and image
-            the should be substituted, such as <code>all</code>.</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 the current magic prefix.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Indicate the prefix that should indicate and image
+the should be substituted, such as <code>all</code>.</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 the current magic prefix.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
-        </li>
+</div>
+</div>
+    
+      
+      <span id="config[:targets]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="config[:targets]=-instance_method">
+  
+    - (<tt>Hash</tt>) <strong>config[:targets]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>A hash that defines all of the characteristics of your individual targets.
+The <code>build_dir</code> and <code>features</code> keys in a target have special meanings;
+other keys can be added arbitrarily and helpers can fetch these for you.
+A best practice is to assign the same features to <em>all</em> of your targets and
+toggle them <code>on</code> or <code>off</code> on a target-specific basis.</p>
 
-      </ul>
 
-    </div>
   </div>
-
-
-  <div class="method_details ">
-    <h3 class="signature ">
-
-      - (<tt>Hash</tt>) <strong>config[:targets]=</strong>(value)
-
-
-
-
-
-    </h3><div class="docstring">
-    <div class="discussion">
-
-      <p>A hash that defines all of the characteristics of your individual targets.
-        The <code>build_dir</code> and <code>features</code> keys in a target have special meanings;
-        other keys can be added arbitrarily and helpers can fetch these for you.
-        A best practice is to assign the same features to <em>all</em> of your targets and
-        toggle them <code>on</code> or <code>off</code> on a target-specific basis.</p>
-
-
-    </div>
+</div>
+<div class="tags">
+  
+  <div class="examples">
+    <p class="tag_title">Examples:</p>
+    
+      
+        <p class="example_title"><div class='inline'><p>You might define this in your <code>config.rb</code> like this:</p>
+</div></p>
+      
+      <pre class="example code"><code><span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:targets</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span>
+  <span class='symbol'>:free</span> <span class='op'>=&gt;</span>
+      <span class='lbrace'>{</span>
+          <span class='symbol'>:sample_key</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>People who use free versions don\&#39;t drive profits.</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+          <span class='symbol'>:build_dir</span>  <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>build (%s)</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+          <span class='symbol'>:features</span>   <span class='op'>=&gt;</span>
+              <span class='lbrace'>{</span>
+                  <span class='symbol'>:feature_advertise_pro</span> <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span>
+                  <span class='symbol'>:insults_user</span>          <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span>
+                  <span class='symbol'>:grants_wishes</span>         <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
+              <span class='rbrace'>}</span>
+      <span class='rbrace'>}</span><span class='comma'>,</span>
+
+      <span class='symbol'>:pro</span> <span class='op'>=&gt;</span>
+      <span class='lbrace'>{</span>
+          <span class='symbol'>:sample_key</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>You are a valued contributor to our balance sheet!</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
+          <span class='symbol'>:features</span> <span class='op'>=&gt;</span>
+              <span class='lbrace'>{</span>
+                  <span class='symbol'>:feature_advertise_pro</span> <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
+                  <span class='symbol'>:insults_user</span>          <span class='op'>=&gt;</span> <span class='kw'>false</span><span class='comma'>,</span>
+                  <span class='symbol'>:grants_wishes</span>         <span class='op'>=&gt;</span> <span class='kw'>true</span><span class='comma'>,</span>
+              <span class='rbrace'>}</span>
+      <span class='rbrace'>}</span><span class='comma'>,</span>
+  <span class='rbrace'>}</span></code></pre>
+    
   </div>
-    <div class="tags">
-
-    <p class="tag_title">Parameters:</p>
-    <ul class="param">
-
-      <li>
-
+<p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
         <span class='name'>value</span>
-
-
+      
+      
         <span class='type'>(<tt>Hash</tt>)</span>
-
-
-
+      
+      
+      
         &mdash;
         <div class='inline'><p>The complete definition of your targets, their
-          features, and other keys-value pairs that you wish to include.</p>
-        </div>
-
-      </li>
-
-    </ul>
-
-    <p class="tag_title">Returns:</p>
-    <ul class="return">
-
-      <li>
-
-
+features, and other keys-value pairs that you wish to include.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
         <span class='type'>(<tt>Hash</tt>)</span>
-
-
-
+      
+      
+      
         &mdash;
         <div class='inline'><p>Returns the attributes of your targets.</p>
-        </div>
+</div>
+      
+    </li>
+  
+</ul>
 
-      </li>
+</div>
+</div>
+    
+  </div>
 
-    </ul>
 
-  </div>
-</div>
 
-</div>