middleman-targets 1.0.3 → 1.0.4

data/documentation_project/source/partials/helpers.erb

@@ -0,0 +1,354 @@
+<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 = {})
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>Override the built-in <code>image-tag</code> helper in order to
+        support additional features.</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">
+
+        <li>
+
+          <span class='name'>path</span>
+
+
+          <span class='type'>(<tt>String</tt>)</span>
+
+
+
+          &mdash;
+          <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>
+
+
+          &mdash;
+          <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>
+
+          &mdash; <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>
+
+          &mdash; <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 class="method_details ">
+    <h3 class="signature " id="target_feature?-instance_method">
+
+      - (<tt>Boolean</tt>) <strong>target_feature?</strong>(feature)
+
+
+
+
+
+    </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">
+
+        <li>
+
+          <span class='name'>feature</span>
+
+
+          <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
+
+
+
+          &mdash;
+          <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>
+
+
+
+          &mdash;
+          <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 class="method_details ">
+    <h3 class="signature " id="target_name-instance_method">
+
+      - (<tt>Symbol</tt>) <strong>target_name</strong>
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>Return the current build target.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+
+      <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 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>
+
+
+
+          &mdash;
+          <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>
+
+
+
+          &mdash;
+          <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>
+
+
+
+          &mdash;
+          <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>
+
+
+
+          &mdash;
+          <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>

data/documentation_project/source/partials/resources.erb

@@ -0,0 +1,100 @@
+<div id="instance_method_details" class="method_details_list">
+  <div class="method_details first ">
+    <h3 class="signature first" id="resource.targeted?-instance_method">
+
+      - (<tt>Boolean</tt>) <strong>resource.targeted?</strong>
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>Determines if the resource is eligible for inclusion
+        in the current target based on the front matter data
+        <code>target</code> and <code>exclude</code> fields.</p>
+
+      <ul>
+        <li>If <strong>frontmatter:target</strong> is used, the target or
+          feature appears in the frontmatter, and</li>
+        <li>If <strong>frontmatter:exclude</strong> is used, the target or
+          enabled feature does NOT appear in the
+          frontmatter</li>
+      </ul>
+
+      <p>In general you won’t use this resource method because
+        resources will already be excluded before you have a
+        chance to check them, and so any leftover resources
+        will always return <code>true</code> for this method.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+
+      <p class="tag_title">Returns:</p>
+      <ul class="return">
+
+        <li>
+
+
+          <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>Returns a value indicating whether
+            or not this resource belongs in the current target.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+    </div>
+  </div>
+
+  <div class="method_details ">
+    <h3 class="signature " id="resource.valid_features-instance_method">
+
+      - (<tt>Array</tt>) <strong>resource.valid_features</strong>
+
+
+
+
+
+    </h3><div class="docstring">
+    <div class="discussion">
+
+      <p>Returns an array of valid features for a resource
+        based on the current target, i.e., features that
+        are true for the current target.</p>
+
+
+    </div>
+  </div>
+    <div class="tags">
+
+      <p class="tag_title">Returns:</p>
+      <ul class="return">
+
+        <li>
+
+
+          <span class='type'>(<tt>Array</tt>)</span>
+
+
+
+          &mdash;
+          <div class='inline'><p>Returns an array of features.</p>
+          </div>
+
+        </li>
+
+      </ul>
+
+    </div>
+  </div>
+
+</div>