middlemac 2.0.0 → 3.0.0

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

@@ -1,207 +0,0 @@
-
-
-
-
-  <div id="instance_attr_details" class="attr_details">
-    
-      
-      <span id="options[:Breadcrumbs]=-instance_method"></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="options[:Breadcrumbs]=-instance_method">
-  
-    - (<tt>String</tt>) <strong>options[:Breadcrumbs]=</strong>(value) 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Indicates the name of the breadcrumbs helper to use for breadcrumbs.
-Built-in breadcrumbs are “nav_breadcrumbs” and “nav_breadcrumbs_alt”.
-Change to <code>nil</code> to disable breadcrumbs completely. Breadcrumbs helpers are
-part of the <code>middleman-pagegroups</code> extension (which is a component of this
-extension).</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>The name of the breadcrumbs helper to use.</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 option.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-    
-      
-      <span id="options[:Help_Output_Location]=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="options[:Help_Output_Location]=-instance_method">
-  
-    - (<tt>String</tt>) <strong>options[:Help_Output_Location]=</strong>(value) 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Specifies the directory where the finished <code>.help</code> bundle should go. It
-must be relative to your <code>config.rb</code> file, or set it to <code>nil</code> to leave the
-output in the default location (in the help project directory). The <em>actual</em>
-output directory will be an Apple Help bundle at this location named in the
-form <code>#{CFBundleName} (target).help</code>. By targeting the <code>Resources</code> directory
-of your XCode project with this option, it’s possible to ensure that an
-Xcode project is automatically up to date every time a help project is
-built.</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>The directory where the final help bundle will be
-built.</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 option.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-    
-      
-      <span id="options[:partials_dir]=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="options[:partials_dir]=-instance_method">
-  
-    - (<tt>String</tt>) <strong>options[:partials_dir]=</strong>(value) 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Specifies the default location for partials. Prior to <strong>Middleman</strong> 4.0,
-all partials were kept in a common directory. <strong>Middlemac</strong> restores this
-previous behavior by allowing all partials to be grouped in a common
-directory. When using the <code>partial</code> helper, this directory will be checked
-first for the existence of a partial; if not found then the default, built
-in behavior will take over.</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>The directory to search for partials.</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 option.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-    
-  </div>
-
-
-

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

@@ -1,297 +0,0 @@
-
-
-
-
-
-  <div class="method_details_list">
-    
-    
-      
-        <div class="method_details first">
-  <h3 class="signature first" id="breadcrumbs-instance_method">
-  
-    - (<tt>String</tt>) <strong>breadcrumbs</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>This helper returns the name of the breadcrumbs
-partial configured to be used in your project, i.e.,
-the value of <code>options[:Breadcrumbs]</code>.</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>The name of the configured breadcrumbs
-partial.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-      
-        <div class="method_details ">
-  <h3 class="signature " id="cfBundleIdentifier-instance_method">
-  
-    - (<tt>String</tt>) <strong>cfBundleIdentifier</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the product <code>CFBundleIdentifier</code> for the
-current target as configured in your <code>config.rb</code>.</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>The <code>cfBundleIdentifier</code>.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-      
-        <div class="method_details ">
-  <h3 class="signature " id="cfBundleName-instance_method">
-  
-    - (<tt>String</tt>) <strong>cfBundleName</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the product <code>CFBundleName</code> for the current
-target as configured in your <code>config.rb</code>.</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>The <code>CFBundleName</code>.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-      
-        <div class="method_details ">
-  <h3 class="signature " id="partials_dir-instance_method">
-  
-    - (<tt>String</tt>) <strong>partials_dir</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the name of the configured partials directory
-to use by default with the <code>partials</code> helper, i.e., the
-value of <code>options[:partials_dir]</code>.</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>The path of the configured default
-partials directory.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-      
-        <div class="method_details ">
-  <h3 class="signature " id="product_name-instance_method">
-  
-    - (<tt>String</tt>) <strong>product_name</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the <code>ProductName</code> for the current target
-as configured in your <code>config.rb</code>.</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>The <code>ProductName</code>.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-      
-        <div class="method_details ">
-  <h3 class="signature " id="product_uri-instance_method">
-  
-    - (<tt>String</tt>) <strong>product_uri</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the <code>ProductURI</code> for the current target
-as configured in your <code>config.rb</code>.</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>The <code>ProductURI</code>.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-      
-        <div class="method_details ">
-  <h3 class="signature " id="product_version-instance_method">
-  
-    - (<tt>String</tt>) <strong>product_version</strong> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Returns the <code>ProductVersion</code> for the current target
-as configured in your <code>config.rb</code>.</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>The <code>ProductVersion</code>.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-</div>
-</div>
-      
-    
-  </div>
-
-

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

@@ -1,96 +0,0 @@
-
-
-
-
-
-  <div class="method_details_list">
-    
-    
-      
-        <div class="method_details first">
-  <h3 class="signature first" id="partial-instance_method">
-  
-    - (<tt>Object</tt>) <strong>partial</strong>(template, opts = {}, &amp;block) 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Extends the built-in <code>partials</code> helper to allow the
-use of a default partials directory as configured with
-<code>options[:partials_dir]</code>. Middleman 4.0 removed the
-option <code>partials_dir</code> which increased flexibility a 
-lot, but hurt backwards compatibility. When used the
-default location will be searched first for the
-specified partial; if not found then the built-in
-behavior will be used.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-  
-    <li>
-      
-        <span class='name'>template</span>
-      
-      
-        <span class='type'>(<tt>String</tt>)</span>
-      
-      
-      
-        &mdash;
-        <div class='inline'><p>The partial file to use.</p>
-</div>
-      
-    </li>
-  
-    <li>
-      
-        <span class='name'>opts</span>
-      
-      
-        <span class='type'>(<tt>Hash</tt>)</span>
-      
-      
-        <em class="default">(defaults to: <tt>{}</tt>)</em>
-      
-      
-        &mdash;
-        <div class='inline'><p>Options to use for the partial.
-Consult <strong>Middleman</strong>’s documentation for possible
-options.</p>
-</div>
-      
-    </li>
-  
-    <li>
-      
-        <span class='name'>&amp;block</span>
-      
-      
-        <span class='type'>(<tt>Block</tt>)</span>
-      
-      
-      
-        &mdash;
-        <div class='inline'><p>An option block as per the
-default implementation by <strong>Middleman</strong>.</p>
-</div>
-      
-    </li>
-  
-</ul>
-
-
-</div>
-</div>
-      
-    
-  </div>
-
-