middlemac 2.0.0 → 3.1.2

data/documentation_project/Contents/Resources/Base.lproj/050_structure/050_navigator.html.md.erb

@@ -1,26 +0,0 @@
----
-title:  Navigator
-blurb:  Learn how the page navigator can make navigation easy for your users, as
-        well as how to turn it on or off for groups and individual pages.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-Near the bottom of this page you can see the navigator. It’s visible because
-this page’s parent `index.html` file includes `navigate: true` in its
-frontmatter.
-
-Setting `:navigate` in the frontmatter will cause all pages with an
-[order][groups] to display the navigator. This can be overridden on a
-page-per-page basis by using the `:navigator` frontmatter key, e.g., `navigator:
-false`.
-
-The helper `nav_prev_next` provides the navigator structure, and the appearance
-is set in CSS.

data/documentation_project/Contents/Resources/Base.lproj/050_structure/060_targets.html.md.erb

@@ -1,63 +0,0 @@
----
-title:  Targets
-blurb:  Targets let you build help files that are specific to each version or
-        variant of your Mac OS X application.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-
-Demonstration
---------------
-<% if target_name?(:pro) %>
-You are reading this help book using the `:pro` target. You can try rebuilding
-the project or starting the server with the `:free` target to get a different
-result.
-<% end %>
-<% if target_name?(:free) %>
-You are reading this help book using the `:free` target. You can try rebuilding
-the project or starting the server with the `:pro` target to get a different
-result.
-<% end %>
-
-
-How did this work?
-------------------
-The source file uses a simple conditional and helper to display content based on
-the target name. Here’s the (nearly) exact code that was used:
-
-~~~ erb
-<%% if target_name?(:pro) %>
-You are reading this help book using the `:pro` target. You can try rebuilding
-the project or starting the server with the `:free` target to get a different
-result.
-<%% end %>
-<%% if target_name?(:free) %>
-You are reading this help book using the `:free` target. You can try rebuilding
-the project or starting the server with the `:pro` target to get a different
-result.
-<%% end %>
-~~~
-
-Why “nearly” exact code? If you examine the `.md.erb` file you will see how to
-escape ERB delimiters so that ERB doesn’t try to process them as Ruby code.
-In order to display `<%% %>` it is necessary to specify `<%%% %>` in code
-blocks. And of course you can read about code blocks and other Markdown
-formatting on
-[kramdown’s documentation site](http://kramdown.gettalong.org/documentation.html).
-
-
-Include or exclude entire pages
--------------------------------
-
-Whether you’re currently using the `:pro` or `:free` target, try visiting
-each of these pages:
-
-- [sample page excludes target `:free`](not_free.html)
-- [sample page excludes target `:pro`](not_pro.html)

data/documentation_project/Contents/Resources/Base.lproj/050_structure/070_features.html.md.erb

@@ -1,122 +0,0 @@
----
-title:  Features
-blurb:  Features work similarly to targets, but give you much more fine-grained
-        control.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-
-Demonstrations
----------------
-
-* * *
-
-<% if target_feature?(:feature_advertise_pro) %>
-**New! Today Only!!! Act before this special offer is gone forever!** Why settle
-for the limitations of _Middlemac Free_ when you can upgrade to _Middlemac Pro_
-for this limited time, special price of only $1299.99?
-
-(Note: there is no _Middlemac Pro_. This is part of the Features demonstration.)
-
-* * *
-<% end %>
-
-
-<% if target_feature?(:feature_performs_miracles) %>
-If you open your water faucet, clean, safe, potable water will flow out of it.
-_Middlemac_ has made this miracle happen for you.
-
-* * *
-<% end %>
-
-
-<% if target_feature?(:feature_insults_user) %>
-If you have made it this far, dear reader, you should know that if brains were
-dynamite, you wouldn’t have enough to blow your nose.
-<% else %>
-If you have made it this far, dear reader, you should know that you are one of
-the best people in the world.
-<% end %>
-
-* * *
-
-<% if target_feature?(:feature_shows_pink_rectangle) %>
-I made a special, pink rectangle just for you!
-<svg style="width:50px; height:35px; display:block; margin:auto;">
-  <rect width="50" height="35" style="fill:pink;stroke-width:0" />
-</svg>
-<% else %>
-Too bad; other people got to see a nice, pink rectangle.
-<% end %>
-
-* * *
-
-
-Recall our targets’ `feature` settings
---------------------------------------
-
-Our `:free` target uses these `feature` settings:
-
-~~~ ruby
-:feature_advertise_pro        => true,
-:feature_performs_miracles    => false,
-:feature_insults_user         => true,
-:feature_shows_pink_rectangle => true,
-~~~
-
-And `:pro` was setup with these `feature` settings:
-
-~~~ ruby
-:feature_advertise_pro        => false,
-:feature_performs_miracles    => true,
-:feature_insults_user         => false,
-:feature_shows_pink_rectangle => true,
-~~~
-
-Depending on the target that you are currently viewing, you should very easily
-be able to correlate what appears in the **Demonstrations** section with the
-`feature`s settings above. Try changing some of the values and see what happens
-to this page.
-
-
-Targets vs Features
--------------------
-
-While you can use targets exclusively, it’s then up to you to decide which
-content you want to include in each of your help books when your Mac OS X
-applications have different features. For example, what happens when you decide
-to enable or disable a feature in a future release of your application? If you
-use targets alone, you’ll have to go back and make a lot of changes to your
-help content. If you use **features**, instead, it’s as simple as toggling the
-value of your target’s `:features` sub-key between `true` and `false`.
-
-
-How did this work?
-------------------
-Features work nearly identically to [targets][targets]. Instead of using the
-`target_name?` helper, use the `target_feature?` helper instead. For example:
-
-~~~ erb
-<%% if target_feature?(:feature_insults_user) %>
-If you have made it this far, dear reader, you should know that if brains were
-dynamite, you wouldn’t have enough to blow your nose.
-<%% else %>
-If you have made it this far, dear reader, you should know that you are one of
-the best people in the world.
-<%% end %>
-~~~
-
-
-Include or exclude entire pages
--------------------------------
-
-Just as with targets, you can use front matter `target` and `exclude` to include
-or exclude entire pages.

data/documentation_project/Contents/Resources/Base.lproj/050_structure/index.html.md.erb

@@ -1,21 +0,0 @@
----
-title:  "Workflow: Develop your Help Structure"
-blurb:  Before you get busy writing all of your content, learn how
-        <em>Middlemac</em> expects your project to be structured, and how this
-        structure benefits you.
-layout: template-logo-large
-navigate: true
----
-<%= md_links %>
-<%= md_images %>
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-* * *
-
-<%= nav_legitimate_children %>
-
-* * *

data/documentation_project/Contents/Resources/Base.lproj/060_content/010_frontmatter.html.md.erb

@@ -1,88 +0,0 @@
----
-title:  Frontmatter and keys
-blurb:  Examine all of the different frontmatter keys and their use in a single
-        location.
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-
-Frontmatter
------------
-Frontmatter is metadata that is included at the top of every content page but
-will not be present in the output. It is used to provide information to
-_Middleman_ and _Middlemac_ on a page by page and group basis.
-
-Here is the frontmatter from this very page’s source file:
-
-~~~ yaml
----
-title:  Frontmatter and keys
-blurb:  Examine all of the different frontmatter keys and their use in a single
-        location.
-layout: template-logo-medium
----
-~~~
-
-You can also specify your own frontmatter keys and values. All frontmatter is
-available for use in your pages and templates via `current_page.data`, e.g.,
-`current_page.data.title`.
-
-Also know that if you want to style content that will be rendered to HTML in
-the frontmatter, such as in a blurb, then HTML is required. HAML and Markdown
-do not touch content in the frontmatter. For example, if you want to emphasize
-text in a blurb, you will have do to something like this example:
-
-~~~ yaml
-blurb: I must <em>emphasize</em> that going to war with an empty treasury is bad.
-~~~
-
-
-Middlemac Frontmatter Keys
---------------------------
-
-`title`
- : The page title will be used in to the HTML `<title>` tag for every page,
-   and more importantly, will be the text displayed for links by all of
-   _Middlemac_’s built-in partials.
-
-`blurb`
- : The blurb will be used as a description for a link for the included
-   _Middlemac_ partials that render indexes. This help documentation also
-   repeats the blurb at the top of every article.
-
-`layout`
- : Specify the layout or template to use to render the page. If you don’t
-   specify a layout, then the `layout-html4` layout will be used by default.
-
-`xhtml`
- : Specify this key if you want to force a page to use the `layout-xhtml`
-   layout instead of an html4 layout. You should never do this, though, except
-   for the main, top-level landing page. Apple’s help specifications require
-   HTML4.
-
-`order`
- : Set the sorting/display order for a particular file within its group.
-
-`navigate`
- : When used in a group’s parent (i.e., the `index.html` for the group) then
-   members of the group will display the page navigator buttons.
-
-`navigator`
- : When set to `false`, overrides the display of the page navigator for this
-   page only.
-
-`target`
- : Indicates which [targets][targets] and [features][features] this page is
-   applicable for.
-
-`exclude`
- : Indicates which [targets][targets] and [features][features] this page should
-   be hidden from.

data/documentation_project/Contents/Resources/Base.lproj/060_content/040_partials.html.md.erb

@@ -1,121 +0,0 @@
----
-title:  Partials
-blurb:  Take advantage of <em>Middlemac</em>’s partials, and maybe even learn to
-        write your own!
-layout: template-logo-medium
----
-<%= md_links %>
-<%= md_images %>
-
-
-<%= current_page.data.title %>
-==============================
-
-<%= current_page.data.blurb %>
-
-_Middlemac_ includes several partials that it uses to provide a structured,
-easy to use framework for generating Apple Help Books. You can use these 
-partials as they are or modify them to suit your preferences.
-
-The included partials are mostly functional, but you can also make partials for
-other content that you use repeatedly throughout your project.
-
-Note that all partials source filenames are prefixed with an underscore, and
-they also don’t have an `.html` extension. Partials will be included in your
-content pages; we don’t want _Middleman_ to output them into the build
-directory!
-{:.note}
-
-Although the partials discussed below are included in the source code for this
-documentation project, they’re not used in this project. Instead this project
-uses the helpers that correspond to the partials below.
-{:.note}
-
-
-Included partials
------------------
-
-Note: because partials are included with the `partial` helper without the
-leading underscore and extension, by convention they are mentioned in this
-documentation without these decorations, too.
-
-`nav_breadcrumbs` and `nav_breadcrumbs_alt`
- : These (two variations) render the breadcrumbs widget at the top of the 
-   window.
-
-`nav_brethren` and `nav_brethren_index`
- : These partials render lists of all sibling pages that have a sort order and
-   are part of the current target and feature settings. `nav_brethren` includes
-   the page’s `:blurb` front matter data, and `nav_brethren_index` lacks this.
- 
-`nav_legitimate_children`
- : Renders a list with link and blurb for all legitimate children, i.e.,
-   children that have a sort order and are allowed by the current target and
-   features settings.
-
-`nav_prev_next`
- : This partial renders the navigation widget on pages that have it enabled.
-
-`nav_toc_index`
- : Renders a site-map style index starting at `current_page` or at a passed-in
-   resource.
-   
-Partials are an excellent alternative to the provided helpers, especially if
-you want to make modifications. Because they correspond exactly with their
-eponymic helpers, you should refer to the [helper API reference][helpers_ref].
-
-
-Your Own Partials
------------------
-
-The included partials are purely functional, i.e., they provide service to key
-parts of _Middlemac_’s framework. You can write your own partials that provide
-functionality, too, such as rendering something from a
-[local data file][using_local_data].
-
-You can also use partials to contain oft-used content. Maybe pieces of a change
-log, should you want to present that information to your users in multiple
-places. Maybe common warnings that can be included in multiple pages.
-
-
-Conventions
------------
-
-Partials should be placed into the correct `partials` directory so that
-_Middleman_’s `partial` helper can find them.
-
-Because partials are not rendered into final HTML output files, you should
-prefix their filenames with and underscore, and _not_ include `.html` in the
-extensions chain.
-
-When using the `partial` helper, _Middleman_ already expects the actual file to
-be prefixed with an underscore, therefore you should _not_ include the
-underscore when you use the helper.
-
-~~~ erb
-<%%= partial 'include_me' %>
-~~~
-
-_not_
-
-~~~ erb
-<%%= partial '_include_me' %>
-~~~
-
-You can pass data to partials as local variable context within the partial.
-For example:
-
-~~~ erb
-<%%= partial 'hello_world', :locals => { :one => 'Rabbit', :color => 'pink' } %>
-~~~
-
-Then, within the code of the partial, you will have local variables `one` and
-`color` available to you with their respective values.
-
-Note: these hash key-values use a symbol as a key, and a value as the value for
-the key. This is not the same as assigning a value to the Ruby symbol, because
-the symbol’s value is simply itself. The hash key is like an `id` object in an
-`NSDictionary`. Then when passed to the partial, there will exist a new local
-variable using the symbol name. The symbol `:one` becomes the variable `one`
-having a string value “pink” in this example.
-{:.note}