middlemac 2.0.0 → 3.0.0

data/documentation_project/Contents/Resources/en.lproj/100_reference/120_api_reference/070_config_ref.html.md.erb

@@ -0,0 +1,31 @@
+---
+title:  ‹config.rb› Settings
+blurb:  Learn about all of the possible configuration settings for your
+        projects.
+---
+<%= md_links %>
+<%= md_images %>
+
+<%= current_page.data.blurb %>
+
+## Targets Configuration
+
+The targets configuration appears immediately after the
+`activate :MiddlemanTargets` line.
+
+Note that `:build_dir` is included for the sake of completeness in the list
+below, but it’s not currently used in a _Middleman_ project’s `config.rb` file.
+
+<%= partial 'yard_mmtargets_config' %>
+
+Additional information about the contents of the `targets` hash is available 
+in the [Set up your Help Project][setup] article.
+
+
+* * *
+
+## Middlemac Configuration
+
+The `activate :Middlemac do |options|` block adds some finishing touches.
+
+<%= partial 'yard_middlemac_config' %>

data/documentation_project/Contents/Resources/en.lproj/100_reference/120_api_reference/090_helpers_ref.html.md.erb

@@ -0,0 +1,20 @@
+---
+title:  Helpers
+blurb:  <em>Middlemac</em> offers several helper methods to make designing and
+        building your content easier.
+---
+<%= md_links %>
+<%= md_images %>
+
+<%= current_page.data.blurb %>
+
+## `middleman-targets` helpers
+
+<%= partial 'yard_mmtargets_helpers' %>
+
+
+* * *
+
+## `middlemac` helpers
+
+<%= partial 'yard_middlemac_helpers' %>

data/documentation_project/Contents/Resources/{Base.lproj/100_reference/30_helpers_ext_ref.html.md.erb → en.lproj/100_reference/120_api_reference/091_helpers_ext_ref.html.md.erb}

@@ -2,14 +2,10 @@
 title:  Extended Helpers
 blurb:  Find out how <em>Middlemac</em> changes the behavior and functions of
         the built-in helpers.
-layout: template-logo-medium
 ---
 <%= md_links %>
 <%= md_images %>
 
-<%= current_page.data.title %>
-==============================
-
 <%= current_page.data.blurb %>
 
 Although _Middlemac_ has plenty of its own helpers, it also offers extensions
@@ -18,28 +14,14 @@ They are organized by the Ruby gem that introduces their functionality.
 
 * * *
 
-## `middleman-targets` extended helpers
-
-<%= partial 'yard_targets_helpers_extended' %>
-
-
-* * *
-
-## `middleman-pagegroups` extended helpers
-
-<%= partial 'yard_pagegroups_helpers_extended' %>
-
-
-* * *
-
-## `middlemac-extras` extended helpers
+## middleman-targets extended helpers
 
-<%= partial 'yard_extras_helpers_extended' %>
+<%= partial 'yard_mmtargets_helpers_extended' %>
 
 
 * * *
 
-## `middlemac` extended helpers
+## middlemac extended helpers
 
 <%= partial 'yard_middlemac_helpers_extended' %>
 

data/documentation_project/Contents/Resources/{Base.lproj/100_reference/50_resource_ext_ref.html.md.erb → en.lproj/100_reference/120_api_reference/100_resource_ext_ref.html.md.erb}

@@ -2,24 +2,19 @@
 title:  Resource Extensions
 blurb:  Find out what new resource methods are available to your project’s
         pages.
-layout: template-logo-medium
 ---
 <%= md_links %>
 <%= md_images %>
 
-<%= current_page.data.title %>
-==============================
-
 <%= current_page.data.blurb %>
 
 ## `middleman-targets` resource extensions
 
-<%= partial 'yard_targets_resources' %>
+<%= partial 'yard_mmtargets_resources' %>
 
 
 * * *
 
-## `middleman-pagegroups` resource extensions
-
-<%= partial 'yard_pagegroups_resources' %>
+## `middlemac` resource extensions
 
+<%= partial 'yard_middlemac_resources' %>

data/documentation_project/Contents/Resources/en.lproj/100_reference/120_api_reference/index.html.md.erb

@@ -0,0 +1,4 @@
+---
+title:  API Reference
+layout: layout-blank
+---

data/documentation_project/Contents/Resources/en.lproj/100_reference/index.html.md.erb

@@ -0,0 +1,4 @@
+---
+title:  Reference
+layout: layout-blank
+---

data/documentation_project/Contents/Resources/{Base.lproj → en.lproj}/110_acknowledgements/index.html.md.erb

@@ -1,16 +1,14 @@
 ---
 title:  Acknowledgements and License
 blurb:  Discover many of the people whom <em>Middlemac</em> owes thanks to, and
-        read about <em>Middlemac</em>’s open source license. 
-layout: template-logo-small
+        read about <em>Middlemac</em>’s open source license.
+anchor: my_ack
+categories:
+  - copyright
 ---
 <%= md_links %>
 <%= md_images %>
 
-
-<%= current_page.data.title %>
-==============================
-
 Acknowledgements
 ----------------
 _Middlemac_ depends entirely on [_Middleman_](http://middlemanapp.com), without
@@ -41,7 +39,7 @@ of _Middlemac_ do not pretend to override.
 
 ### The MIT License (MIT)
 
-Copyright (c) 2014-2016 Jim Derry and balthisar.com
+Copyright (c) 2014-2018 Jim Derry and balthisar.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/documentation_project/Contents/Resources/en.lproj/ExactMatch.plist.erb

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <% sitemap = hb_sitemap.select { |r| r.data.exactmatch } %>
+  <% if sitemap.count > 0 %>
+    <% sitemap.each do |r| %>
+      <% r.data.exactmatch.each do |m| %>
+  <key><%= m %></key>
+  <string><%= r.data.anchor || r.page_name  %></string>
+      <% end %>
+    <% end %>
+  <% end %>
+</dict>
+</plist>

data/documentation_project/Contents/Resources/en.lproj/asides/aside_description.html.md.erb

@@ -0,0 +1,21 @@
+---
+title:     What is an aside?
+blurb:     A short article describing what an “aside” is in a help file.
+categories:
+ - aside
+---
+<%= md_links %>
+
+Apple’s modern Help Books use a feature call an “aside” to show short bits of
+information that can be referenced in the current page without having to load
+a new page.
+
+The [frontmatter][frontmatter] for this page should indicate
+`layout-apple-modern-aside`, but because the source file is in the `asides/`
+directory, _Middlemac_ is smart enough to supply that automatically. This is
+necessary because the layout for asides contains extra metadata needed for
+this feature to work.
+{: .tip .callout}
+
+Because these asides are separate HTML files, they can be re-used in multiple
+locations throughout your project, much like partials.

data/documentation_project/Contents/Resources/{Base.lproj → en.lproj}/index.html.md.erb

@@ -1,16 +1,13 @@
 ---
 title:  Middlemac Help
-layout: template-logo-large
-xhtml:  true
+categories:
+  - landing
 ---
 
-<%= product_name %> 
-===================
-
 _Middlemac_ is the specialized [Apple
 Help](http://en.wikipedia.org/wiki/Apple_Help_Viewer) building system that uses
 the tools of [_Middleman_](http://middlemanapp.com) to make building Apple
-Help Books for your Mac OS X applications a snap. Whether you are targeting
+Help Books for your macOS applications a snap. Whether you are targeting
 multiple versions of your application or a single version, once properly 
 configured, _Middlemac_ will take all of the pain out of building Help files.
 
@@ -18,14 +15,7 @@ configured, _Middlemac_ will take all of the pain out of building Help files.
 You are viewing the `:pro` target. You will see a lot of branding indicating
 _Middlemac Pro_, but remember there’s only a single version of _Middlemac_.
 The different branding is one of the core benefits of using _Middlemac_.
-{:.note}
 <% end %>
 
-* * *
-
-<%= nav_legitimate_children %>
-
-* * *
-
 **Please note that _Middlemac_ is not associated in any way with the the team at
 _Middleman_.**

data/documentation_project/Contents/Resources/en.lproj/locale-info.json.erb

@@ -0,0 +1,16 @@
+<% data[:'locale-list'].each do |locale| %>
+<%   lproj = current_resource.path.match(/([^\/]+\.lproj)/i).captures[0] %>
+<%   if locale[:folder] == lproj %>
+{
+    "meta": {
+        "text-direction": "<%= locale[:'text-direction'] %>",
+        "name": "<%= locale[:name] %>‎",
+        "isoName": "<%= locale[:isoName] %>‎",
+        "isoCodes": [
+            <%= locale[:isoCodes].map { |e| "\"#{e}\"" }.join(",\n            ") %>
+        ],
+        "folder": "<%= locale[:folder] %>"
+    }
+}
+<%   end %>
+<% end %>

data/documentation_project/Contents/Resources/en.lproj/navigation.json.erb

@@ -0,0 +1,57 @@
+{
+    "birdseed_version": 5,
+    "build_id": "<%= config[:targets][config[:target]][:CFBundleVersion] || product_version %>",
+    "build_date": "<%= Time.now.strftime("%Y.%m.%d-%H:%M:%S") %>",
+    "collect_feedback": false,
+    "copyright": "<%= hb_copyright_page ? "#{hb_copyright_page.hb_NavId}" : nil %>",
+    "copyright_text": "<%= product_copyright %>",
+    "css": "",
+    "enable_tracking": false,
+    "framework": "<%= hb_framework %>",
+    "icon": "<%= config[:targets][config[:target]][:HPDBookIconPath] %>",
+    "landing": "<%= hb_landing_page.hb_NavId %>",
+    "locale": "<%= current_resource.hb_locale %>",
+    "platform": "mac",
+    "printable_page": "",
+    "product": "<%= product_name %>",
+    "quick_links": [],
+    "sections": {
+        <%- o = hb_sitemap.select{|r| r.hb_Section?}.sort_by{|r| r.hb_NavId}; o.each do |p| %>
+        "<%= p.hb_NavId %>": {
+            "name": "<%= p.data.title %>",
+            "children": [
+                <%- q = p.legitimate_children; q.each do |s| %>
+                "<%= s.hb_NavId %>"<%- if !s.equal?q.last %>,<%- end %>
+                <%- end # q-s loop %>
+            ]
+      }<%- if !p.equal?o.last %>,<%- end %>
+      <%- end # o-p loop %>      
+    },
+    "show_previous_next": <%= extensions[:Middlemac].options[:show_previous_next] %>,
+    "source_schema": "apd-schema",
+    "title": "<%= product_name %> Help",
+    "toc": [
+        <%- o = hb_landing_page.legitimate_children; o.each do |p| %>
+        "<%= p.hb_NavId %>"<%- if !p.equal?o.last %>,<%- end %>
+        <%- end # p loop %>
+    ],
+    "topics": {
+        <%- o = hb_sitemap.select{|r| !r.hb_Section?}.sort_by{|r| r.hb_NavId}; o.each do |p| %>
+        "<%= p.hb_NavId %>": {
+            <%- outp = [] %>
+            <%- outp << "\"name\": \"#{p.data.title}\"," if p.data.title %>
+            <%- outp << "\"summary\": \"#{strip_tags(p.data.blurb)}\"," if p.data.blurb %>
+            <%- outp << "\"searchName\": \"#{p.data.searchName}\"," if p.data.searchName %>
+            <%- outp << "\"href\": \"#{p.hb_Path}\"," if p.hb_Path %>
+            <%= outp.join("\n            ") %>
+            "categories": [
+              <%- if p.data.categories; p.data.categories.each do |s| %>
+              "<%= s %>"<%- if !s.equal?p.data.categories.last %>,<%- end %>
+              <%- end; end # q-s loop %>
+            ]
+        }<%- if !p.equal?o.last %>,<%- end %>
+        <%- end # o-p loop %>
+    },
+    "urls": {},
+    "version": "<%= product_version %>"
+}

data/documentation_project/Contents/Resources/en.lproj/searchTree.json.erb

@@ -0,0 +1 @@
+<%= hb_search_tree %>

data/documentation_project/Contents/Resources/es.lproj/ExactMatch.plist.erb

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <% sitemap = hb_sitemap.select { |r| r.data.exactmatch } %>
+  <% if sitemap.count > 0 %>
+    <% sitemap.each do |r| %>
+      <% r.data.exactmatch.each do |m| %>
+  <key><%= m %></key>
+  <string><%= r.data.anchor || r.page_name  %></string>
+      <% end %>
+    <% end %>
+  <% end %>
+</dict>
+</plist>

data/documentation_project/Contents/Resources/es.lproj/index.html.md.erb

@@ -0,0 +1,27 @@
+---
+title:  Middlemac Help
+categories:
+  - landing
+---
+
+This is the Spanish version of the landing page, and is included in this
+documentation to demonstrate just a couple of features of Apple’s modern
+Help Books:
+
+- It demonstrates that _Middlemac_ plays nicely with multi-lingual help files.
+
+- It demonstrates that when your Help Book is served to a browser, the help
+  system will provide a language picker, allowing you to choose to view the
+  help content in another language.
+  
+  In Apple’s Help Viewer, languages are managed automatically by the Help
+  Viewer application from your macOS locale.
+  {: .tip}
+  
+- It demonstrates Apple’s single-topic help style, e.g., such as those used
+  for Help Books for simple applications that require only one page of
+  content.
+  
+If you arrived here inadvertently (perhaps your locale is Spanish), the rest
+of this documentation is available in the English version of the Help Book.
+Please select the language chooser, below, to switch to English.

data/documentation_project/Contents/Resources/es.lproj/locale-info.json.erb

@@ -0,0 +1,16 @@
+<% data[:'locale-list'].each do |locale| %>
+<%   lproj = current_resource.path.match(/([^\/]+\.lproj)/i).captures[0] %>
+<%   if locale[:folder] == lproj %>
+{
+    "meta": {
+        "text-direction": "<%= locale[:'text-direction'] %>",
+        "name": "<%= locale[:name] %>‎",
+        "isoName": "<%= locale[:isoName] %>‎",
+        "isoCodes": [
+            <%= locale[:isoCodes].map { |e| "\"#{e}\"" }.join(",\n            ") %>
+        ],
+        "folder": "<%= locale[:folder] %>"
+    }
+}
+<%   end %>
+<% end %>

data/documentation_project/Contents/Resources/es.lproj/navigation.json.erb

@@ -0,0 +1,57 @@
+{
+    "birdseed_version": 5,
+    "build_id": "<%= config[:targets][config[:target]][:CFBundleVersion] || product_version %>",
+    "build_date": "<%= Time.now.strftime("%Y.%m.%d-%H:%M:%S") %>",
+    "collect_feedback": false,
+    "copyright": "<%= hb_copyright_page ? "#{hb_copyright_page.hb_NavId}" : nil %>",
+    "copyright_text": "<%= product_copyright %>",
+    "css": "",
+    "enable_tracking": false,
+    "framework": "<%= hb_framework %>",
+    "icon": "<%= config[:targets][config[:target]][:HPDBookIconPath] %>",
+    "landing": "<%= hb_landing_page.hb_NavId %>",
+    "locale": "<%= current_resource.hb_locale %>",
+    "platform": "mac",
+    "printable_page": "",
+    "product": "<%= product_name %>",
+    "quick_links": [],
+    "sections": {
+        <%- o = hb_sitemap.select{|r| r.hb_Section?}.sort_by{|r| r.hb_NavId}; o.each do |p| %>
+        "<%= p.hb_NavId %>": {
+            "name": "<%= p.data.title %>",
+            "children": [
+                <%- q = p.legitimate_children; q.each do |s| %>
+                "<%= s.hb_NavId %>"<%- if !s.equal?q.last %>,<%- end %>
+                <%- end # q-s loop %>
+            ]
+      }<%- if !p.equal?o.last %>,<%- end %>
+      <%- end # o-p loop %>      
+    },
+    "show_previous_next": <%= extensions[:Middlemac].options[:show_previous_next] %>,
+    "source_schema": "apd-schema",
+    "title": "<%= product_name %> Help",
+    "toc": [
+        <%- o = hb_landing_page.legitimate_children; o.each do |p| %>
+        "<%= p.hb_NavId %>"<%- if !p.equal?o.last %>,<%- end %>
+        <%- end # p loop %>
+    ],
+    "topics": {
+        <%- o = hb_sitemap.select{|r| !r.hb_Section?}.sort_by{|r| r.hb_NavId}; o.each do |p| %>
+        "<%= p.hb_NavId %>": {
+            <%- outp = [] %>
+            <%- outp << "\"name\": \"#{p.data.title}\"," if p.data.title %>
+            <%- outp << "\"summary\": \"#{strip_tags(p.data.blurb)}\"," if p.data.blurb %>
+            <%- outp << "\"searchName\": \"#{p.data.searchName}\"," if p.data.searchName %>
+            <%- outp << "\"href\": \"#{p.hb_Path}\"," if p.hb_Path %>
+            <%= outp.join("\n            ") %>
+            "categories": [
+              <%- if p.data.categories; p.data.categories.each do |s| %>
+              "<%= s %>"<%- if !s.equal?p.data.categories.last %>,<%- end %>
+              <%- end; end # q-s loop %>
+            ]
+        }<%- if !p.equal?o.last %>,<%- end %>
+        <%- end # o-p loop %>
+    },
+    "urls": {},
+    "version": "<%= product_version %>"
+}

data/documentation_project/Contents/Resources/es.lproj/searchTree.json.erb

@@ -0,0 +1 @@
+<%= hb_search_tree %>