middlemac 2.0.0 → 3.0.0

data/documentation_project/Contents/Resources/Base.lproj/090_build_application/20_xcode_integration.html.md.erb

@@ -1,64 +0,0 @@
----
-title:  Optional Xcode Integration
-blurb:  Learn some tips and techniques for getting Xcode to cooperate with
-        <em>Middlemac</em> projects.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-In the [previous section][apple_help_setup] you learned how simple it is to make
-Xcode include your built help projects in your application, but with a little
-bit of extra work you can even have Xcode build your help projects for you.
-
-**HelpViewerApp**
------------------
-
-Included the the source directory for this documentation project is a directory
-named `HelpViewerApp` that includes a simple Xcode project. Aside from the
-ability to display this project’s built help files in Help Viewer (instead of
-a web browser), it demonstrates one technique for having Xcode build your help
-books for you.
-
-It consists of the following four targets:
-
-`Help (free)` 
-
-  : This is an external build system target that uses **Middlemac** to generate
-    the help files for the `HelpViewerApp (free)` target.
-  
-`Help (pro)`
-
-  : This is an external build system target that uses **Middlemac** to generate
-    the help files for the `HelpViewerApp (pro)` target.
-
-`HelpViewerApp (free)`
-
-  : The “free” version of this application will display the `:free` target in
-    the Help Viewer. It uses the target `Help (free)` as a build dependency.
-
-`HelpViewerApp (pro)`
-
-  : The “pro” version of this application will display the `:pro` target in the
-    Help Viewer.  It uses the target `Help (pro)` as a build dependency.
-
-
-## The Help file “build system”
-
-The build system is a bash script that executes the default version of
-**Middleman** on your system. In order to prevent re-building the help file
-every time you run the HelpViewerApp it tries to remember that it was already
-built using a marker file in the Xcode build directory.
-
-It's a simple script and doesn’t try at all to know whether or not you’ve made
-changes to the source. If you want to rebuild the help files using the build
-command in Xcode, then perform **Clean**, which will remove this marker file.
-
-Xcode’s **Clean** will _not_ remove the built help book using this script; you
-are free to make the script do so if you want, however.

data/documentation_project/Contents/Resources/Base.lproj/090_build_application/index.html.md.erb

@@ -1,25 +0,0 @@
----
-title:  "Workflow: Build your Mac Application"
-blurb:  Having put the final touches on your Help Book, it’s time to build your
-        Mac OS X application and see the payoff for your hard work.
-layout: template-logo-large
-navigate: true
----
-<%= md_links %>
-<%= md_images %>
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-While it’s true that an Apple Help Book is simply a glorified web site, there
-are details that are required to be satisfied in order to make them work with
-your Mac OS X applications. Luckily _Middlemac_ takes care of most of these
-details for you.
-
-* * *
-
-<%= nav_legitimate_children %>
-
-* * *

data/documentation_project/Contents/Resources/Base.lproj/100_reference/20_config_ref.html.md.erb

@@ -1,56 +0,0 @@
----
-title:  <code>config.rb</code> Settings
-blurb:  Learn about all of the possible configuration settings for your
-        projects.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-<%= current_page.data.title %>
-==============================
-
-<%= 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_targets_config' %>
-
-Additional information about the contents of the `targets` hash is available 
-in the [Set up your Help Project][setup-index] article.
-
-
-* * *
-
-## Page Groups Configuration
-
-The items in the block `activate :MiddlemanPageGroups do |config|` pertain to
-the automatic navigation features.
-
-<%= partial 'yard_pagegroups_config' %>
-
-
-* * *
-
-## Extras Configuration
-
-Items in the `activate :MiddlemacExtras do |config|` block control some of
-_Middlemac_’s behavior and abilities:
-
-<%= partial 'yard_extras_config' %>
-
-
-* * *
-
-## Middlemac Configuration
-
-Finally, the `activate :Middlemac do |options|` block adds some finishing
-touches.
-
-<%= partial 'yard_middlemac_config' %>

data/documentation_project/Contents/Resources/Base.lproj/100_reference/40_helpers_ref.html.md.erb

@@ -1,45 +0,0 @@
----
-title:  Helpers
-blurb:  <em>Middlemac</em> offers several helper methods to make designing and
-        building your content easier.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-## `middleman-targets` helpers
-
-<%= partial 'yard_targets_helpers' %>
-
-
-* * *
-
-## `middleman-pagegroups` helpers (partials and helpers CSS)
-
-<%= partial 'yard_pagegroups_helpers_css' %>
-
-
-* * *
-
-## `middleman-pagegroups` helpers
-
-<%= partial 'yard_pagegroups_helpers' %>
-
-
-* * *
-
-## `middlemac-extras` helpers
-
-<%= partial 'yard_extras_helpers' %>
-
-
-* * *
-
-## `middlemac` helpers
-
-<%= partial 'yard_middlemac_helpers' %>

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

@@ -1,26 +0,0 @@
----
-title:  Reference
-blurb:  The content in this section is pure reference without the blather. If
-        you know what you’re doing and just need to check something, it’s
-        probably right here.
-layout: template-logo-large
-navigate: true
----
-
-<%= md_images %>
-<%= md_links %>
-
-<%= current_page.data.title %>
-==============================
-<%= current_page.data.blurb %>
-
-_Middlemac_ is a system consisting of four Ruby gems plus _Middleman_ and all of
-its gems. As such all of the wonderful things that make _Middlemac_ such a nice
-tool in the composite come from several sources. This reference section attempts
-to put everything together in a single spot.
-
-* * *
-
-<%= nav_legitimate_children %>
-
-* * *

data/documentation_project/Contents/Resources/Base.lproj/120_backwards_compatibility/index.html.md.erb

@@ -1,88 +0,0 @@
----
-title:  Backwards Compatibility
-blurb:  Notes about Backwards Compatibility with earlier versions of Middlemac.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-<%= current_page.data.title %>
-==============================
-
-_Middlemac_ version 2.0.0 is a **major** update. It’s an API-breaking update and
-projects using _Middlemac_ version 1.0 will _not_ build without some changes to
-your project.
-
-Additionally because _Middlemac_ now requires _Middleman_ 4.1.7 or higher, there
-are some _Middleman_-related changes, too.
-
-This version of _Middlemac_ is a complete rewrite, and it was designed in such a
-way that in the future it _can_ be upgraded without breaking your projects. We
-hope that the improvements, though, make it completely worth the trouble to
-update.
-
-
-Upgrading a project
--------------------
-
-No automated method of upgrading a project is provided, but the steps for
-achieving an upgrade are fairly simple.
-
-### Files
-
-`middlemac.rb`
-  : This file is no longer required and should be removed from your project.
-    _Middlemac_ is now a proper Ruby gem and is managed by Ruby directly.
-
-`Gemfile`
-  : You must replace your `Gemfile` with ours, or at least ensure that your
-    `Gemfile` is edited to reflect the new gem requirements.
-
-`config.rb`
-  : You should use our new `config.rb` as a starting point for replacing your
-    current `config.rb` file. Most of the changes are obvious, and pay special
-    attention to some of the items that have letter case changes.
-    
-`Contents/Resources/Base.lproj/assets/`
-`   layouts/layout-html4.haml`
-`   fonts/*`
-`   stylesheets/*`
-  : These files from a new project (or this sample documentation project) must
-    replace the corresponding files in your current project. In particular the
-    `layouts/layout-html4.haml` file enables the new `breadcrumbs` configuration
-    option. The new `fonts/` directory ensures that the required `font-awesome`
-    fonts are always available, and there have been visual tweaks in all of the
-    `stylesheets/` files (in particular we now have to include the `github`
-    styles in a new way).
-
-
-### Configuration Changes
-
-Amongst the changes mentioned above to `config.rb` is the removal of support for
-_Middleman_’s `partials_dir` configuration setting. However in order to maintain
-backwards compatibility we have preserved this functionality in _Middlemac_.
-Simply move the `partials_dir` setting into the `activate Middlemac` block.
-
-If you are following _Middlemac_ conventions, you can delete the `partials_dir`
-setting completely, as the default is appropriate.
-{: .note }
-
-
-### Other Partials Changes
-
-By default the automatic navigation partials are no longer included in the
-sample project, and if you were using them you will have to keep your own
-partials.
-  
-New partials are available as part of the required `middleman-pagegroups` gem,
-but we also suggest that you consider using the new helpers instead of partials.
-
-Also keep in mind that `md_links` and `md_images` helpers replace previous
-partial functionality. Use these helpers to generate Markdown shortcuts instead.
-
-
-### Other Changes
-
-_Read_ this documentation and have a close look at the sample project. This is
-a big **2.0** release, and lots of things have changed for the better. Before
-long, you’ll have your old projects working again.

data/documentation_project/Contents/Resources/Base.lproj/130_all_help_content/index.html.md.erb

@@ -1,15 +0,0 @@
----
-title:  All Help Content
-blurb:  See all help content topics in a single list.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-<%= current_page.data.title %>
-==============================
-
-The directory below indicates all of the help content that is available in this
-help book.
-
-<%= nav_toc_index :start => current_page.breadcrumbs.first %>

data/documentation_project/Contents/Resources/Base.lproj/assets/_layouts/layout-html4.haml

@@ -1,22 +0,0 @@
-!!! Strict
-%html
-  %head
-    %title= current_page.data.title || "#{product_name} Help"
-    %meta{:content => 'text/html; charset=utf-8', :'http-equiv' => 'Content-Type'}/
-    = stylesheet_link_tag 'style'
-    = stylesheet_link_tag 'image_sizes'
-    = javascript_include_tag  'all'
-  %body{:class => "#{page_classes}"}
-    - if breadcrumbs
-      %nav#breadcrumbs
-        - if self.respond_to?(breadcrumbs)
-          = self.public_send(breadcrumbs)
-    = yield
-
--#
-  This layout will be used for every page of your help book except for Apple’s
-  main landing page, i.e., your root-level index.html file. It contains only
-  the minimum metadata content required by Apple.
-
-  If you intend to use the help file outside of Apple's help system, you may
-  want to modify this layout to include additional metadata.

data/documentation_project/Contents/Resources/Base.lproj/assets/_layouts/layout-xhtml.haml

@@ -1,28 +0,0 @@
-= "<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>"
-%html{:xmlns => 'http://www.w3.org/1999/xhtml'}
-  %head
-    %title= current_page.data.title || "#{product_name} Help"
-    %meta{:content => 'text/html; charset=utf-8', :'http-equiv' => 'Content-Type'}/
-    %meta{:content => cfBundleIdentifier, :name => 'AppleTitle'}/
-    %meta{:content => '../shared/icon_32x32@2x.png', :name => 'AppleIcon'}/
-    = stylesheet_link_tag 'style'
-    = stylesheet_link_tag 'image_sizes'
-    = javascript_include_tag  'all'
-  %body{:class => "#{page_classes}"}
-    = yield
-
--#
-  This layout file is used ONLY for Apple’s required, top-level landing page
-  at index.html. For legacy reasons the entry page must be XHTML 1.0 Strict.
-  This top-level layout file also provides additional metadata required by the
-  Apple help system that's not required on other pages (and therefore not
-  included in the other layouts).
-
-  Strictly speaking, Middleman won't generate a true XHTML document because the
-  HAML interpreter currently isn't capable of supporting multiple document
-  types. The actual contents will be generated as HTML4.01 Strict.
-
-  Apple's help viewer application and modern web browsers won't really care,
-  but if validation is needed for some reason then consider running *just*
-  the finished index.html through Tidy (e.g., Balthisar Tidy) to fix it up.
-  The rest of your help files will be HTML4.01 Strict as Apple specifies.

data/documentation_project/Contents/Resources/Base.lproj/assets/_layouts/template-logo-large.haml

@@ -1,30 +0,0 @@
-= wrap_layout ((current_page.data['xhtml'] && 'layout-xhtml'.to_sym) || 'layout-html4'.to_sym) do
-  .container-logo-large
-    %div
-      %div
-        = image_tag '/Resources/shared/all-icon_256x256.png', :alt => 'logo'
-        %h1= "#{product_name}"
-        %h2= "version #{product_version}"
-        %a{:href => product_uri}= product_uri
-
-      - if content_for?(:seeAlso)
-        .related_topics
-          %h1 See Also
-          = yield_content :seeAlso
-
-    %div
-      .yield-content
-        ~ yield
-        - if current_page.navigator_eligible?
-          %hr
-          = nav_prev_next
-
--#
-  This template is suitable for your landing page or major sections, and features
-  a large version of your logo, the application name, and the application URI.
-  It can include optional :seeAlso content below the application URI.
-
-  It will normally use the standard layout-html4 layout which is required for
-  all of your help pages except for the main landing page. If you include
-  `xhtml: true` in any page’s frontmatter then it will be built using the
-  layout-xhtml layout instead. You shouldn’t do so, however.

data/documentation_project/Contents/Resources/Base.lproj/assets/_layouts/template-logo-medium.haml

@@ -1,30 +0,0 @@
-= wrap_layout ((current_page.data['xhtml'] && 'layout-xhtml'.to_sym) || 'layout-html4'.to_sym) do
-  .container-logo-medium
-    %div
-      .yield-content
-        ~ yield
-        - if current_page.navigator_eligible?
-          %hr
-          = nav_prev_next
-
-    %div
-      %div
-        = image_tag '/Resources/shared/all-icon_256x256.png', :alt => 'logo'
-      .related_topics
-        = nav_brethren_index
-
-        - if content_for?(:seeAlso)
-          %h1 See Also
-          = yield_content :seeAlso
-
--#
-  This template is suitable for general pages within a group, as it makes
-  navigation between the different pages in the group obvious and easy. It
-  features a medium version of your logo on the right, followed by navigation
-  to the other pages in the group. Optionally :seeAlso content can follow the
-  related pages.
-
-  It will normally use the standard layout-html4 layout which is required for
-  all of your help pages except for the main landing page. If you include
-  `xhtml: true` in any page’s frontmatter then it will be built using the
-  layout-xhtml layout instead. You shouldn’t do so, however.

data/documentation_project/Contents/Resources/Base.lproj/assets/_layouts/template-logo-small.haml

@@ -1,30 +0,0 @@
-= wrap_layout ((current_page.data['xhtml'] && 'layout-xhtml'.to_sym) || 'layout-html4'.to_sym) do
-  .container-logo-small
-    .yield-content
-      = image_tag '/Resources/shared/all-icon_256x256.png', :alt => 'logo'
-      ~ yield
-      - if current_page.navigator_eligible?
-        %hr
-        = nav_prev_next
-
-    - if !current_page.brethren.to_a.empty? || content_for?(:seeAlso)
-      %hr/
-
-    .related_topics
-      = nav_brethren_index
-
-      - if content_for?(:seeAlso)
-        %h1 See Also
-        = yield_content :seeAlso
-
--#
-  This template is suitable for general pages that aren’t meant to participate
-  within a group. It does show related pages followed by :seeAlso content at
-  the bottom on the page, but it’s not as obvious for simple navigation as the
-  template-logo-medium. It features a small version of your help logo in the
-  top left, followed by the title.
-
-  It will normally use the standard layout-html4 layout which is required for
-  all of your help pages except for the main landing page. If you include
-  `xhtml: true` in any page’s frontmatter then it will be built using the
-  layout-xhtml layout instead. You shouldn’t do so, however.