middlemac 2.0.0 → 3.1.2

data/documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-apple-modern-aside.haml

@@ -0,0 +1,19 @@
+!!!
+%html{:lang => "#{current_page.hb_locale}"}
+  %head
+    %meta{:charset => 'UTF-8'}
+    %meta{:name => 'robots', :content => 'noindex'}
+    %title= current_page.data.title || "#{product_name} Help"
+  - classes = ["apd-topic", "Aside"]
+  - id = current_page.hb_NavId
+  %body{:dir => "ltr", :class => classes, :id => id}
+    %a{:name => id}
+
+    = yield
+
+-#
+  This layout will be used for every aside portion of your help book. The key
+  difference is that the meta robots prevents this page from being indexed,
+  because it's not a free-standing page. Additionally, it's a good idea to
+  assign your group-definition index files to this layout, as well, since
+  they have no content and we don’t want them indexed.

data/documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-apple-modern.haml

@@ -0,0 +1,61 @@
+- landing = current_page.data.categories && current_page.data.categories.include?('landing')
+- debug = extensions[:Middlemac].options[:show_debug]
+!!!
+%html{:lang => "#{current_page.hb_locale}"}
+  %head
+    - if !debug
+      :JavaScript
+        window.location.href = "#{current_page.hb_redirect_path}";
+    %meta{:charset => 'UTF-8'}
+    %meta{:'http-equiv' => 'refresh', :content => "#{debug ? 100 : 0}; url=#{current_page.hb_redirect_path}" }
+    - if current_page.data.blurb
+      %meta{:name => 'description', :content => strip_tags(current_page.data.blurb)}
+    - if current_page.data.keywords
+      %meta{:name => 'keywords', :content => current_page.data.keywords.join(', ')}
+    %title= current_page.data.title || "#{product_name} Help"
+  - classes = ["AppleTopic"]
+  - id = current_page.hb_NavId
+  - current_page.data.categories.each { |c| classes << c unless classes.include?(c) } if current_page.data.categories
+  %body{:dir => "ltr", :class => classes, :id => id}
+    %a{:name => current_page.data.anchor || current_page.page_name}
+
+    - if landing
+      = image_tag "all-icon_256x256"
+      %h1 #{product_name} #{product_version}
+      %h2
+        %a{:href => "#{product_uri}" } #{product_uri}
+    - else
+      = image_tag current_page.data.topicIcon || "all-icon_256x256", :figure_class => 'topicIcon'
+      %h1 #{current_page.data.title}
+    
+    = yield
+    
+    -# Need an empty <ul> for the show/hide topics to show up.
+    - if landing
+      %ul
+    
+    - if content_for?(:seeAlso)
+      .LinkUniversal
+        %strong
+          See Also
+        = yield_content :seeAlso
+    
+    - if debug
+      .middlemac-debug
+        %hr
+        %p
+          These following appear here because `config.rb` has `options.show_debug = true`.
+        %h2 Images Available with md_images
+        = md_images
+        %h2 Links Available with md_links
+        = md_links
+
+-#
+  This layout will be used for nearly every page of your help book. Apple’s
+  scripts will strip out everything from the head, and so everything set here
+  is really only useful for indexers and for Apple’s JavaScript to use; they
+  won’t appear in the finished document. Note, too, that when a client attempts
+  to load this page directly, the browser will be directed to the index page
+  instead, which loads this content via AJAX. This is important because the
+  Help Indexer will index the page, and the Help Viewer will attempt to load
+  the page, and it would be ugly and unstyled if that happened.

data/documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-blank.haml

@@ -0,0 +1,11 @@
+!!!
+%html{:lang => "#{current_page.hb_locale}"}
+  %head
+    %meta{:charset => 'UTF-8'}
+    %meta{:name => 'robots', :content => 'noindex'}
+    %title= current_page.data.title || "#{product_name} Help"
+  %body
+
+-#
+  This layout should be used for pages with no content, such as the index.html
+  pages used as group metadata containers.

data/documentation_project/Contents/Resources/SharedGlobalAssets/_layouts/layout-hpd.haml

@@ -0,0 +1,14 @@
+!!!
+%html{:lang => "#{current_page.hb_locale}"}
+  %head
+    :javascript
+          window.location.href = "./index.html";
+    %meta{:charset => 'UTF-8'}
+    %meta{:name => 'robots', :content => 'noindex'}
+    %meta{:'http-equiv' => 'refresh', :content => "0;url=./index.html" }
+    %title= current_page.data.title || "#{product_name} Help"
+  %body
+
+-#
+  This layout should be used for pages with no content, such as the index.html
+  pages used as group metadata containers.

data/documentation_project/Contents/Resources/SharedGlobalAssets/_partials/_yard_middlemac_config.erb

@@ -0,0 +1,366 @@
+
+
+
+
+  <div id="instance_attr_details" class="attr_details">
+    
+      
+      <span id="options[:help_output_avoid_spaces]=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="options[:help_output_avoid_spaces]=-instance_method">
+  
+    #<strong>options[:help_output_avoid_spaces]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Indicates whethr or not the <code>help_output_location</code> includes spaces in its
+filename or not. Some GNU tools, such as make, choke on spaces. The default
+setting for this option is <em>yes</em> in order to maintain backward
+compatibility.</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><code>true</code> or <code>false</code> to enable or disable this behavior.</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">
+  
+    #<strong>options[:help_output_location]=</strong>(value)  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</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">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <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>
+
+</div>
+</div>
+    
+      
+      <span id="options[:help_output_use_target]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:help_output_use_target]=-instance_method">
+  
+    #<strong>options[:help_output_use_target]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Indicates whether or not the <code>help_output_location</code> includes the <code>(target)</code>
+prefix in the help book bundle name. The default, <code>true</code>, will result in
+<code>#{CFBundleName} (target).help</code>, which is the historical behavior. Setting
+this to <code>false</code> will result in a help book named <code>#{CFBundleName}.help</code>,
+instead. This can be useful if you are building help books from scripts via
+XCode, and you set <code>help_output_location</code> to <code>ENV['BUILT_PRODUCTS_DIR']</code>.</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><code>true</code> or <code>false</code> to enable or disable this behavior.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:img_auto_extensions]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:img_auto_extensions]=-instance_method">
+  
+    #<strong>options[:img_auto_extensions]=</strong>(value)  &#x21d2; <tt>Array&lt;String&gt;</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option determines whether or not to support specifying images without
+using a file name extension, as well as the priority of the possible file
+extensions. If not empty or nil, 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 in
+the sitemap that has one of the extensions in the array.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<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>Set to an array of image extensions.</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">
+  
+    #<strong>options[:retina_srcset]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</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">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <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>
+
+</div>
+</div>
+    
+      
+      <span id="options[:show_debug]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:show_debug]=-instance_method">
+  
+    #<strong>options[:show_debug]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option determines whether or not extra debug information is provided
+at the bottom of each content page.</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><code>true</code> or <code>false</code> to enable or disable this feature.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:show_previous_next]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:show_previous_next]=-instance_method">
+  
+    #<strong>options[:show_previous_next]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option determines whether or not the Apple Help System should display
+previous and next page navigators at the bottom of each content page. Note
+that Apple itself does not use this feature.</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><code>true</code> or <code>false</code> to enable or disable this feature.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:strip_file_prefixes]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:strip_file_prefixes]=-instance_method">
+  
+    #<strong>options[:strip_file_prefixes]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>If <code>true</code> leading numbers used for sorting files will be removed for
+presentation purposes. This makes it possible to neatly organize your
+source files in their presentation order on your filesystem but output
+nice filenames without ugly prefix numbers.</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><code>true</code> or <code>false</code> to enable or disable this feature.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+  </div>
+
+
+