middlemac 2.0.0 → 3.0.0

data/fixtures/middlemac_app/Contents/Resources/en.lproj/10_hello_world_file.html.md.erb

@@ -0,0 +1,17 @@
+---
+title:  Hello World
+blurb:  Discover your project saying “Hello, world!” 
+---
+<%= md_links %>
+<%= md_images %>
+
+Because there's no chapter (this file is not in a group), there's no chapter
+heading.
+
+The item below represents the `helpbook_task` helper being used. Because there
+is only a single task on this page, it is present statically without a
+disclosure button to reveal and hide it.
+
+<% helpbook_task "hello_world_lorem", "Lorem", :markdown => true do %>
+<%= lorem.paragraphs 3 %>
+<% end %>

data/fixtures/middlemac_app/Contents/Resources/en.lproj/30_sample_group_number_one/index.html.md.erb

@@ -0,0 +1,8 @@
+---
+title:  First Sample Group
+layout: layout-blank
+---
+
+This file isn’t actually used for content, but only for metadata in the
+frontmatter. Generally, you should leave this content empty so that the help
+indexer doesn’t index it.

data/fixtures/middlemac_app/Contents/Resources/en.lproj/30_sample_group_number_one/page_one.html.md.erb

@@ -0,0 +1,108 @@
+---
+title:  Some Apple Features
+blurb:  Let’s demonstrate some of Apple’s built-in features.
+order: 10
+---
+<%= md_links %>
+<%= md_images %>
+
+<%= current_page.data.blurb %>
+
+- It looks like blurbs aren’t really user visible, but they are captured in the
+  `navigation.json` file, so should be provided nonetheless.
+
+- Because this page is part of the “Sample Group Number One” (having the title
+  “First Sample Group”), Apple’s help system places this as a chapter heading
+  at the top of this page.
+  
+- Note that this page number is defined by frontmatter, and _not_ by prefixing
+  the file name.
+
+
+Images
+------
+Apple’s images are always in a `figure` tag. Middlemac will automatically provide
+framesets for these.
+
+<%= image_tag 'icon_32x32' %>
+
+Asides
+------
+
+“Asides” are loaded via AJAX from another file into a popup element on the 
+current page. In this sample project any asides have been put into the `asides`
+directory, but that's just for organization and not a requirement.
+
+So, what is <%= link_to "an aside", "aside_description.html", :aside => true %>?
+Activate the specially decorated link to find out.
+
+
+Tasks
+-----
+
+Apple currently uses “tasks” in many of its modern Help Books, and these are
+relatively simply to implement with the `helpbook_task` helper.
+
+Single tasks are always displayed in the expanded state, but when multiple tasks
+are on the same page, like here, they have working disclosure triangles to 
+reveal them.
+
+Make sure you provide unique id’s to the tasks, because Apple’s help system
+keeps track of which one are revealed or hidden in between page visits.
+
+
+<% helpbook_task "task1", "Expand this task to see what content it contains", :markdown => true do %>
+<%= lorem.paragraphs 2 %>
+<% end %>
+
+
+<% helpbook_task "task2", "This task indicates the answer to the question of life" do %>
+
+The generally accepted answer to this query is **forty-two**.
+
+<%= lorem.paragraphs 2 %>
+<% end %>
+
+
+<% helpbook_task "task3", "Perform this third task" do %>
+<%= lorem.paragraphs 1 %>
+![Icon loaded with the Markdown reference format][icon_256x256]
+<%= lorem.paragraphs 1 %>
+<% end %>
+
+
+Tips
+----
+<div class="Alert">
+<p class="Tip">
+    <strong class="tip">Tip</strong> You can do lots of neat things like use 
+    Apple’s tip style, and it’s easy with the plethora of helpers. This tip
+    uses the official Apple way to make a tip, but you have to use HTML to
+    conform to Apple’s `&lt;div>` and `&lt;p>` structure.
+</p>
+</div>
+
+
+However that’s kind of pain to remember, so _Middlemac_ makes it really
+easy to add single-paragraph tips right in Markdown, by assigning a style.
+The appearance is a _little_ bit different than Apple’s way, but honors the
+look and feel.
+{: .tip}
+
+
+Although I couldn’t find any **warning** examples in Apple’s help, it’s
+something that’s sure to be needed by other developers, and so imitating
+Apple’s **Tip** style gives _Middlemac_ access to simple warnings, too.
+{: .warning}
+
+Can you guess that this is a note? It’s also a good place to point out that
+Apple-like “see also” sections are automatically included at the bottom of
+pages if you include a `content_for :seeAlso` block in your source code.
+{: .note}
+
+<% content_for :seeAlso do %>
+<%= link_to 'Hello World File', 'hello_world_file.html' %>
+<%= link_to 'Page Two', 'page_two.html' %>
+<%= link_to 'Goodbye World', 'goodbye_world_file.html' %>
+<% end %>
+

data/fixtures/middlemac_app/Contents/Resources/en.lproj/30_sample_group_number_one/page_two.html.md.erb

@@ -0,0 +1,36 @@
+---
+title:  Writers
+blurb:  Here are some writers, added using Middleman’s `data` system.
+order: 20
+---
+
+<%= current_page.data.blurb %>
+
+- Because this page is part of the “Sample Group Number One,” Apple’s help
+  system places this as a chapter heading at the top of this page.
+
+- Note that this page number is defined by frontmatter, and _not_ by prefixing
+  the file name.
+  
+Sample Works
+------------
+
+The table below is a nice markdown table with Apple’s CSS.
+
+
+
+<% data.globals.famous_writers.each do |writer| %>
+| <%= writer.author %> | <%= writer.sample_work %>
+<% end %>
+
+
+Sample Works as a `<DL>`
+---------------------------
+
+Here's the data again as a definition list. Apple’s default style is horribly
+broken, so _Middlemac_ reimplements it similar to Apple’s table style.
+
+<% data.globals.famous_writers.each do |writer| %>
+<%= writer.author %>
+: <%= writer.sample_work + "\n"  %>
+<% end %>

data/fixtures/middlemac_app/Contents/Resources/{Base.lproj → en.lproj}/40_sample_group_number_two/01_nested_group_example/01_page_one.html.md.erb

@@ -1,15 +1,10 @@
 ---
 title:  Page 1
 blurb:  Think of something interesting for this blurb.
-layout: template-logo-medium
 ---
 <%= md_links %>
 <%= md_images %>
 
-
-<%= current_page.data.title %>
-==============================
-
 <%= current_page.data.blurb %>
 
 Lorem

data/fixtures/middlemac_app/Contents/Resources/{Base.lproj → en.lproj}/40_sample_group_number_two/01_nested_group_example/02_pagina_dos.html.md.erb

@@ -1,15 +1,10 @@
 ---
 title:  Page 2
 blurb:  Think of something else interesting for this blurb.
-layout: template-logo-medium
 ---
 <%= md_links %>
 <%= md_images %>
 
-
-<%= current_page.data.title %>
-==============================
-
 <%= current_page.data.blurb %>
 
 

data/fixtures/middlemac_app/Contents/Resources/{Base.lproj → en.lproj}/40_sample_group_number_two/01_nested_group_example/03_page_san.html.md.erb

@@ -1,15 +1,10 @@
 ---
 title:  Page 3
 blurb:  Think of something interesting for this blurb, as well.
-layout: template-logo-medium
 ---
 <%= md_links %>
 <%= md_images %>
 
-
-<%= current_page.data.title %>
-==============================
-
 <%= current_page.data.blurb %>
 
 Lorem

data/fixtures/middlemac_app/Contents/Resources/en.lproj/40_sample_group_number_two/01_nested_group_example/index.html.md.erb

@@ -0,0 +1,4 @@
+---
+title:  A nested group example
+layout: layout-blank
+---

data/fixtures/middlemac_app/Contents/Resources/{Base.lproj → en.lproj}/40_sample_group_number_two/02_page_two.html.md.erb

@@ -1,15 +1,10 @@
 ---
 title:  Page two
 blurb:  Page two sort order is by filename, not by frontmatter.
-layout: template-logo-medium
 ---
 <%= md_links %>
 <%= md_images %>
 
-
-<%= current_page.data.title %>
-==============================
-
 <%= current_page.data.blurb %>
 
 

data/fixtures/middlemac_app/Contents/Resources/{Base.lproj → en.lproj}/40_sample_group_number_two/03_page_three.html.md.erb

@@ -1,15 +1,10 @@
 ---
 title:  The third page
 blurb:  Page three sort order is by filename, not by frontmatter, also.
-layout: template-logo-medium
 ---
 <%= md_links %>
 <%= md_images %>
 
-
-<%= current_page.data.title %>
-==============================
-
 <%= current_page.data.blurb %>
 
 

data/fixtures/middlemac_app/Contents/Resources/en.lproj/40_sample_group_number_two/index.html.md.erb

@@ -0,0 +1,4 @@
+---
+title:  Sample Group Number 2
+layout: layout-blank
+---

data/fixtures/middlemac_app/Contents/Resources/en.lproj/50_testing_world_file.html.md.erb

@@ -0,0 +1,58 @@
+---
+title:  Testing World
+blurb:  Another page that uses Middlemac’s helpers so that Cucumber
+        has something predictable to examine.
+---
+<%= md_links %>
+<%= md_images %>
+
+This is another page that uses some of _Middlemac_’s helpers so that Cucumber
+testing can be performed. This sample project is also the fixture for testing;
+if you have this Gem’s source, you can
+
+~~~ bash
+rake test
+~~~
+
+…from the Gem’s directory to run the tests yourself.
+
+Note that this isn’t the only file tested, but it’s a nice place to capture
+some of the test output.
+{:.note}
+
+
+Middlemac configuration information:
+------------------------------------
+
+partials_dir:       | <%= partials_dir %>
+
+cfBundleIdentifier: | <%= cfBundleIdentifier %>
+
+cfBundleName:       | <%= cfBundleName %>
+
+product_name:       | <%= product_name %>
+
+product_version:    | <%= product_version %>
+
+product_uri:        | <%= product_uri %>
+
+
+
+New Style Middleman Partial
+---------------------------
+
+~~~ html
+<%= partial 'new_style_partial' %>
+~~~
+
+## Partial from `partials_dir`
+
+~~~ html
+<%= partial 'partials_dir_partial' %>
+~~~
+
+## Partial from localized `partials_dir`
+
+~~~ html
+<%= partial 'localized_partials_dir_partial' %>
+~~~

data/fixtures/middlemac_app/Contents/Resources/en.lproj/60_goodbye_world_file.html.md.erb

@@ -0,0 +1,203 @@
+---
+title:  Goodbye World
+blurb:  Discover your project saying “Goodbye, world!” 
+---
+<%= md_links %>
+<%= md_images %>
+
+This is another page that uses some of _Middlemac_’s helpers so that Cucumber
+testing can be performed. This sample project is also the fixture for testing;
+if you have this Gem’s source, you can
+
+~~~ bash
+rake test
+~~~
+
+…from the Gem’s directory to run the tests yourself.
+
+Note that this isn’t the only file tested, but it’s a nice place to capture
+some of the test output.
+{:.note}
+
+
+<% helpbook_task "css_image_sizes", "css_image_sizes", :markdown => true do %>
+~~~
+<%= css_image_sizes %>
+~~~
+<% end %>
+
+<% helpbook_task "md_images", "md_images", :markdown => true do %>
+~~~
+<%= md_images %>
+~~~
+<% end %>
+
+<% helpbook_task "md_links", "md_links", :markdown => true do %>
+~~~
+<%= md_links %>
+~~~
+<% end %>
+
+
+image_tag
+---------
+
+### Absolute
+Asked for `/Resources/SharedGlobalAssets/convention/icon_32x32`.
+This should have a srcset.
+
+<%= image_tag '/Resources/SharedGlobalAssets/convention/icon_32x32' %>
+~~~
+<%= image_tag '/Resources/SharedGlobalAssets/convention/icon_32x32' %>
+~~~
+
+
+### Located elsewhere in the project (SharedGlobalAssets/convention)
+Asked for `icon_256x256`.
+This should have a srcset.
+
+<%= image_tag 'icon_256x256' %>
+~~~
+<%= image_tag 'icon_256x256' %>
+~~~
+
+
+### Located in a subdirectory of `:images_dir`
+Asked for `logo_32x32`.
+
+<%= image_tag 'logo_32x32' %>
+~~~
+<%= image_tag 'logo_32x32' %>
+~~~
+
+
+### Located in a subdirectory of `:images_dir`, specifying extension.
+Asked for `logo_32x32.png`.
+
+<%= image_tag 'logo_32x32.png' %>
+~~~
+<%= image_tag 'logo_32x32.png' %>
+~~~
+
+
+### Located in a subdirectory of `:images_dir`
+Asked for `subdirectory/logo_32x32`.
+
+<%= image_tag 'subdirectory/logo_32x32' %>
+~~~
+<%= image_tag 'subdirectory/logo_32x32' %>
+~~~
+
+
+### Located in `:images_dir`
+Asked for `neat_thing_32x32`.
+
+<%= image_tag 'neat_thing_32x32' %>
+~~~
+<%= image_tag 'neat_thing_32x32' %>
+~~~
+
+
+### Target specific image, located in a subdirectory of `:images_dir`
+Asked for `all-image_32x32`.
+
+<%= image_tag 'all-image_32x32' %>
+~~~
+<%= image_tag 'all-image_32x32' %>
+~~~
+
+
+### No target specific image, located in `:images_dir`
+Asked for `all-graphic_32x32`.
+
+<%= image_tag 'all-graphic_32x32' %>
+~~~
+<%= image_tag 'all-graphic_32x32' %>
+~~~
+
+
+### Invalid or missing file.
+Asked for `myfile`.
+
+<%= image_tag 'myfile' %>
+~~~
+<%= image_tag 'myfile' %>
+~~~
+
+### Invalid or missing file.
+Asked for `myfile.png`.
+
+<%= image_tag 'myfile.png' %>
+~~~
+<%= image_tag 'myfile.png' %>
+~~~
+
+
+Link Tag
+--------
+
+### Link to `hello_world_file.html`
+Asked for `hello_world_file.html`. I expect an Apple HB link because the
+given HTML file appears in the sitemap.
+
+<%= link_to 'Hello World File', 'hello_world_file.html' %>
+
+~~~
+<%= link_to 'Hello World File', 'hello_world_file.html' %>
+~~~
+
+
+### Link to `page_one.html`
+Asked for `page_one.html`. I expect an Apple HB link because the given HTML
+file appears in the sitemap.
+
+<%= link_to 'Page One', 'page_one.html' %>
+
+~~~
+<%= link_to 'Page One', 'page_one.html' %>
+~~~
+
+
+### Link to `page_two.html`
+Asked for `page_two.html`. I expect an Apple HB link because the given HTML
+file appears in the sitemap. However I'm not specifying the path to the
+file, and there are multiple files with the same name, so which will I get?
+
+<%= link_to 'Page Two', 'page_two.html' %>
+
+~~~
+<%= link_to 'Page Two', 'page_two.html' %>
+~~~
+
+
+### Link to `page_two.html` again.
+Asked for `page_two.html`. I expect an Apple HB link because the given HTML
+file appears in the sitemap. This time I'm specifying a path to the page_two
+that I actually want.
+
+<%= link_to 'Page Two Again', 'sample_group_number_two/page_two.html' %>
+
+~~~
+<%= link_to 'Page Two Again', 'sample_group_number_two/page_two.html' %>
+~~~
+
+
+### Link to `doesnt_exist.html`
+Asked for `doesnt_exist.html`. Because the file doesn't exist in the sitemap,
+it will be handled as a normal link.
+
+<%= link_to 'Doesn’t exist', 'doesntexist.html' %>
+
+~~~
+<%= link_to 'Doesn’t exist', 'doesntexist.html' %>
+~~~
+
+
+### Link to `page_four.html`
+Asked for `page_four.html`.
+
+<%= link_to 'Page four', 'sample_group_number_two/page_four.html' %>
+
+~~~
+<%= link_to 'Page four', 'sample_group_number_two/page_four.html' %>
+~~~

data/fixtures/middlemac_app/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/fixtures/middlemac_app/Contents/Resources/en.lproj/InfoPlist.strings.erb

@@ -0,0 +1,10 @@
+<?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>
+	<key>CFBundleName</key>
+	<string><%= cfBundleName %></string>
+	<key>HPDBookTitle</key>
+	<string><%= cfBundleName %> Help</string>
+</dict>
+</plist>

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

@@ -0,0 +1,20 @@
+---
+title:     What is an aside?
+blurb:     A short article describing what an “aside” is in a help file.
+categories:
+ - aside
+---
+
+<%= current_page.data.title %>
+==============================
+
+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.
+
+Note that the source frontmatter for this page indicates a layout of
+`layout-apple-modern-aside`, which should be used for asides because they
+contain extra metadata need for this feature to work.
+
+Because these asides are separate HTML files, they can be re-used in multiple
+locations throughout your project.

data/fixtures/middlemac_app/Contents/Resources/en.lproj/assets/_partials/_localized_partials_dir_partial.erb

@@ -0,0 +1 @@
+This is _localized_partials_dir_partial.

data/fixtures/middlemac_app/Contents/Resources/en.lproj/copyright.html.md.erb

@@ -0,0 +1,19 @@
+---
+title:  License
+blurb:  License Page
+categories:
+  - copyright
+---
+<%= md_links %>
+<%= md_images %>
+
+This page appears here because it’s the first one in the sitemap that has
+“copyright” among its categories. It’s not a required file, and the link that
+you followed to get here will by displayed as text instead of a link if this
+file isn’t provided.
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 3 %>

data/fixtures/middlemac_app/Contents/Resources/en.lproj/index.html.md.erb

@@ -0,0 +1,20 @@
+---
+title: Middlemac Project
+categories:
+  - landing
+---
+<%= md_links %>
+<%= md_images %>
+
+This is a (mostly) blank project, and this is its landing page.
+
+There are a few sample groups already set up, and some of the sample pages
+demonstrate the basic features of Apple’s help system and Middlemac’s helpers.
+
+* * *
+
+This project includes a few sample pages in another locale, and as such a
+language selector should be available below, _if_ this page is viewed in a
+browser.
+
+* * *

data/fixtures/middlemac_app/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 %>