documentation_project/source/partials/helpers.erb in middleman-targets-1.0.4 vs documentation_project/source/partials/helpers.erb in middleman-targets-1.0.5
- old
+ new
@@ -1,354 +1,236 @@
-<div class="method_details_list">
- <div class="method_details first">
- <h3 class="signature first" id="image_tag-instance_method">
- - (<tt>Void</tt>) <strong>image_tag</strong>(path, params = {})
+ <div class="method_details_list">
+
+
+ <h2>Helpers</h2>
+
+ <div class="method_details first">
+ <h3 class="signature first" id="target_feature?-instance_method">
+
+ - (<tt>Boolean</tt>) <strong>target_feature?</strong>(feature)
+
- </h3><div class="docstring">
- <div class="discussion">
+
- <p>Override the built-in <code>image-tag</code> helper in order to
- support additional features.</p>
+
+</h3><div class="docstring">
+ <div class="discussion">
+ <p>Does the target have the feature <code>feature</code> enabled?</p>
- <ul>
- <li>Automatic target-specific images. Note that this
- only works on local files, and only if enabled
- with the option <code>:target_magic_images</code>.</li>
- <li>Target and feature dependent images using the
- <code>params</code> hash.</li>
- <li>Absolute paths, which Middleman sometimes bungles.</li>
- </ul>
- <p>Note that in addition to the options described below,
- <code>middleman-targets</code> inherits all of the built-in
- option parameters as well.</p>
-
-
- </div>
</div>
- <div class="tags">
- <p class="tag_title">Parameters:</p>
- <ul class="param">
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>feature</span>
+
+
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>Specifies a proposed
+feature.</p>
+</div>
+
+ </li>
+
+</ul>
- <li>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>Returns <code>true</code> if the current target
+has the features <code>feature</code> and the features is
+enabled.</p>
+</div>
+
+ </li>
+
+</ul>
- <span class='name'>path</span>
+</div>
+</div>
+
+ <div class="method_details ">
+ <h3 class="signature " id="target_name-instance_method">
+
+ - (<tt>Symbol</tt>) <strong>target_name</strong>
+
+
- <span class='type'>(<tt>String</tt>)</span>
+
+</h3><div class="docstring">
+ <div class="discussion">
+ <p>Return the current build target.</p>
-
- —
- <div class='inline'><p>The 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>
-
-
- —
- <div class='inline'><p>Optional parameters to pass to
- the helper.</p>
- </div>
-
- </li>
-
- </ul>
-
-
-
-
-
-
- <p class="tag_title">Options Hash (<tt>params</tt>):</p>
- <ul class="option">
-
- <li>
- <span class="name">:target</span>
- <span class="type">(<tt>String</tt>, <tt>Symbol</tt>)</span>
- <span class="default">
-
- </span>
-
- — <div class='inline'><p>This image
- tag will only be applied if the current target is
- <code>target</code>.</p>
- </div>
-
- </li>
-
- <li>
- <span class="name">:feature</span>
- <span class="type">(<tt>String</tt>, <tt>Symbol</tt>)</span>
- <span class="default">
-
- </span>
-
- — <div class='inline'><p>This image
- tag will only be applied if the current target
- enables the feature <code>feature</code>.</p>
- </div>
-
- </li>
-
- </ul>
-
-
- <p class="tag_title">Returns:</p>
- <ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Void</tt>)</span>
-
-
-
- </li>
-
- </ul>
-
- </div>
</div>
+</div>
+<div class="tags">
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Symbol</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>Returns the current build target.</p>
+</div>
+
+ </li>
+
+</ul>
- <div class="method_details ">
- <h3 class="signature " id="target_feature?-instance_method">
+</div>
+</div>
+
+ <div class="method_details ">
+ <h3 class="signature " id="target_name?-instance_method">
+
+ - (<tt>Boolean</tt>) <strong>target_name?</strong>(proposal)
+
- - (<tt>Boolean</tt>) <strong>target_feature?</strong>(feature)
+
+
+</h3><div class="docstring">
+ <div class="discussion">
+ <p>Is the current target <code>proposal</code>?</p>
-
-
- </h3><div class="docstring">
- <div class="discussion">
-
- <p>Does the target have the feature <code>feature</code> enabled?</p>
-
-
- </div>
</div>
- <div class="tags">
- <p class="tag_title">Parameters:</p>
- <ul class="param">
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>proposal</span>
+
+
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>Specifies a proposed
+target.</p>
+</div>
+
+ </li>
+
+</ul>
- <li>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>Returns <code>true</code> if the current target
+matches the parameter <code>proposal</code>.</p>
+</div>
+
+ </li>
+
+</ul>
- <span class='name'>feature</span>
+</div>
+</div>
+
+ <div class="method_details ">
+ <h3 class="signature " id="target_value-instance_method">
+
+ - (<tt>String</tt>, <tt>Nil</tt>) <strong>target_value</strong>(key)
+
+
- <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
+
+</h3><div class="docstring">
+ <div class="discussion">
+ <p>Attempts to return arbitrary key values for the key
+ <code>key</code> for the current target.</p>
-
- —
- <div class='inline'><p>Specifies a proposed
- feature.</p>
- </div>
-
- </li>
-
- </ul>
-
- <p class="tag_title">Returns:</p>
- <ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- —
- <div class='inline'><p>Returns <code>true</code> if the current target
- has the features <code>feature</code> and the features is
- enabled.</p>
- </div>
-
- </li>
-
- </ul>
-
- </div>
</div>
+</div>
+<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+ <li>
+
+ <span class='name'>key</span>
+
+
+ <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>Specifies the desired key
+to look up.</p>
+</div>
+
+ </li>
+
+</ul>
- <div class="method_details ">
- <h3 class="signature " id="target_name-instance_method">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+ <li>
+
+
+ <span class='type'>(<tt>String</tt>, <tt>Nil</tt>)</span>
+
+
+
+ —
+ <div class='inline'><p>Returns the value for <code>key</code> in
+the <code>:targets</code> structure, or <code>nil</code> if it doesn’t
+exist.</p>
+</div>
+
+ </li>
+
+</ul>
- - (<tt>Symbol</tt>) <strong>target_name</strong>
-
-
-
-
-
- </h3><div class="docstring">
- <div class="discussion">
-
- <p>Return the current build target.</p>
-
-
- </div>
+</div>
+</div>
+
+
</div>
- <div class="tags">
- <p class="tag_title">Returns:</p>
- <ul class="return">
- <li>
-
-
- <span class='type'>(<tt>Symbol</tt>)</span>
-
-
-
- —
- <div class='inline'><p>Returns the current build target.</p>
- </div>
-
- </li>
-
- </ul>
-
- </div>
- </div>
-
- <div class="method_details ">
- <h3 class="signature " id="target_name?-instance_method">
-
- - (<tt>Boolean</tt>) <strong>target_name?</strong>(proposal)
-
-
-
-
-
- </h3><div class="docstring">
- <div class="discussion">
-
- <p>Is the current target <code>proposal</code>?</p>
-
-
- </div>
- </div>
- <div class="tags">
- <p class="tag_title">Parameters:</p>
- <ul class="param">
-
- <li>
-
- <span class='name'>proposal</span>
-
-
- <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
-
-
-
- —
- <div class='inline'><p>Specifies a proposed
- target.</p>
- </div>
-
- </li>
-
- </ul>
-
- <p class="tag_title">Returns:</p>
- <ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>Boolean</tt>)</span>
-
-
-
- —
- <div class='inline'><p>Returns <code>true</code> if the current target
- matches the parameter <code>proposal</code>.</p>
- </div>
-
- </li>
-
- </ul>
-
- </div>
- </div>
-
- <div class="method_details ">
- <h3 class="signature " id="target_value-instance_method">
-
- - (<tt>String</tt>, <tt>Nil</tt>) <strong>target_value</strong>(key)
-
-
-
-
-
- </h3><div class="docstring">
- <div class="discussion">
-
- <p>Attempts to return arbitrary key values for the key
- <code>key</code> for the current target.</p>
-
-
- </div>
- </div>
- <div class="tags">
- <p class="tag_title">Parameters:</p>
- <ul class="param">
-
- <li>
-
- <span class='name'>key</span>
-
-
- <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
-
-
-
- —
- <div class='inline'><p>Specifies the desired key
- to look up.</p>
- </div>
-
- </li>
-
- </ul>
-
- <p class="tag_title">Returns:</p>
- <ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>String</tt>, <tt>Nil</tt>)</span>
-
-
-
- —
- <div class='inline'><p>Returns the value for <code>key</code> in
- the <code>:targets</code> structure, or <code>nil</code> if it doesn’t
- exist.</p>
- </div>
-
- </li>
-
- </ul>
-
- </div>
- </div>
-
-</div>