middlemac 2.0.0 → 3.1.2

data/fixtures/middlemac_app/Contents/Resources/locale-list.json.erb

@@ -0,0 +1,14 @@
+[
+  <% locales = data[:'locale-list'].select { |locale| hb_locale_list.include?(locale[:folder]) } %>
+  <% locales.each do |locale| %>
+  {
+    "text-direction": "<%= locale[:'text-direction'] %>",
+    "name": "<%= locale[:name] %>‎",
+    "isoName": "<%= locale[:isoName] %>‎",
+    "isoCodes": [
+      <%= locale[:isoCodes].map { |e| "\"#{e}\"" }.join(",\n      ") %>
+    ],
+    "folder": "<%= locale[:folder] %>"
+  }<%= ',' unless locale.equal?(locales.last) %>
+  <% end %>
+]

data/fixtures/middlemac_app/Gemfile

@@ -17,35 +17,22 @@ source 'https://rubygems.org'
 #######################################
 # Middlemac, natch.
 #######################################
-gem 'middlemac', '~> 2.0.0'
-gem 'middlemac-extras', '~> 1.0.8'
-gem 'middleman-targets', '~> 1.0.7'
-gem 'middleman-pagegroups', '~> 1.0.4'
+gem 'middlemac', '~> 3.1.2'
+gem 'middleman-targets', '~> 1.0.12'
 
 
 #######################################
 # Core gems
 #######################################
-gem 'middleman', '~> 4.1.7'
+gem 'middleman', '~> 4.3.7'
 gem 'middleman-core'
 gem 'middleman-cli'
 gem 'middleman-livereload' # Live-reloading plugin
 gem 'middleman-syntax'     # Syntax Highlighting
-
-
-#######################################
-# Style and fonts
-#######################################
 gem 'middleman-compass'
-gem 'font-awesome-sass'
 
 
 #######################################
-# Utilities and tools
-#######################################
-
-
-#######################################
-# Core gems
+# Other gems
 #######################################
 gem 'tzinfo-data', platforms: [:mswin, :mingw] # Time zone data for Windows

data/fixtures/middlemac_app/config.rb

@@ -1,9 +1,19 @@
 ################################################################################
 #  config.rb
-#    Configure Middleman to generate Apple HelpBook containers for multiple
+#    Configure Middleman to generate Apple Help Book containers for multiple
 #    targets.
 ################################################################################
 
+##########################################################################
+# Build System Integration
+#  If built from Xcode (or another build system you create), then setup
+#  some of our variables automatically from the environment variables
+#  that the build system sets for us. You’ll have to set up Xcode to
+#  set this environment variable, of course.
+##########################################################################
+version_app = ENV.has_key?('MIDDLEMAC_CFBundleShortVersionString') ? ENV['MIDDLEMAC_CFBundleShortVersionString'] : nil
+
+
 ##########################################################################
 # Targets Configuration
 #  Middlemac is capable of building multiple targets for variants of your
@@ -39,13 +49,14 @@ config[:target] = :pro
 # :HPDBookIconPath
 # If specified a target-specific icon will be used as the help book icon by
 # Apple’s help viewer. This path must be relative to the location of the
-# `Resources` directory per Apple’s specification. If `nil` (or not present) 
-# then the default `shared/icon_32x32@2x.png` will be used.
+# `Resources` directory per Apple’s specification. If `nil` (or not present)
+# then the default `SharedGlobalAssets/convention/icon_32x32@2x.png` will be
+# used.
 
 # :CFBundleName
 # This value will be used for correct .plists and .strings setup, and will
 # determine final .help directory name. All targets should use the same
-# :CFBundleName. Built targets will be named `CFBundleName (target).help`.
+# :CFBundleName. Built targets will be named `CFBundleName_(target).help`.
 # This is *not* intended to be a product name, which is defined below.
 
 # :ProductName
@@ -61,6 +72,10 @@ config[:target] = :pro
 # You can specify different product URIs for each build target. The URI
 # for the current target will be available via the `product_uri` helper.
 
+# :ProductCopyright
+# You should specify a copyright string to be included in the Apple Help Book.
+# This typically appears when you print a Help Book.
+
 # (other)
 # You can specify additional .plist and .strings keys here, too. Have a look
 # at `Info.plist.erb` and `InfoPlist.strings.erb`; simply use the exact key
@@ -79,8 +94,9 @@ config[:targets] = {
                 :HPDBookIconPath  => nil,
                 :CFBundleName     => 'New Project',
                 :ProductName      => 'New Project',
-                :ProductVersion   => '2.0.0',
+                :ProductVersion   => version_app || '3.1.1',
                 :ProductURI       => 'http://www.sample.com',
+                :ProductCopyright => '© 2021 Jim Derry. All rights reserved.',
                 :features =>
                     {
                         :feature_advertise_pro        => true,
@@ -96,8 +112,9 @@ config[:targets] = {
                 :HPDBookIconPath  => nil,
                 :CFBundleName     => 'New Project',
                 :ProductName      => 'New Project Pro',
-                :ProductVersion   => '2.0.0',
+                :ProductVersion   => version_app || '3.1.1',
                 :ProductURI       => 'http://www.sample.com',
+                :ProductCopyright => '© 2021 Jim Derry. All rights reserved.',
                 :features =>
                     {
                         :feature_advertise_pro        => false,
@@ -121,64 +138,6 @@ config[:target_magic_images] = true
 config[:target_magic_word] = 'all'
 
 
-################################################################
-# Page Groups Configuration
-#  Middlemac uses the `middleman-pagegroups` gem in order to
-#  automate nearly all of the navigation in your help book
-#  project.
-################################################################
-activate :MiddlemanPageGroups do |config|
-
-  # Indicate whether or not numeric file name prefixes used for sorting
-  # pages should be eliminated during output. This results in cleaner
-  # URI's. Helpers such as `page_name` and Middleman helpers such as
-  # `page_class` will reflect the pretty name.
-  config.strip_file_prefixes = true
-
-  # Indicates whether or not Middleman's built-in `page_class` helper is
-  # extended to include the page_group and page_name.
-  config.extend_page_class = true
-
-  # the following options provide defaults for the built-in helpers and
-  # sample partials. They'll also work in your own partials and helpers.
-
-  config.nav_breadcrumbs_class = 'breadcrumbs'
-  config.nav_breadcrumbs_alt_class = 'breadcrumbs'
-  config.nav_breadcrumbs_alt_label = 'Current page'
-  config.nav_brethren_class = 'table_contents'
-  config.nav_brethren_index_class = 'related-topics'
-  config.nav_legitimate_children_class = 'table_contents'
-  config.nav_prev_next_class = 'navigate_prev_next'
-  config.nav_prev_next_label_prev = 'Previous'
-  config.nav_prev_next_label_next = 'Next'
-  config.nav_toc_index_class = 'help_map'
-
-end
-
-
-################################################################
-# Extras Configuration
-#  Middlemac uses the `middlemac-extras` gem in order to
-#  provide other useful tools. They can be configured here.
-################################################################
-activate :MiddlemacExtras do |config|
-
-  # If set to true, then the enhanced image_tag helper will be used
-  # to include @2x srcset automatically, if the image asset exists.
-  config.retina_srcset = true
-
-  # If set to true then the `image_tag` helper will work for images even
-  # if you don't specify an extension, but only if a file exists on disk
-  # that has one of the extensions in :img_auto_extensions_order.
-  config.img_auto_extensions = true
-
-  # Set this to an array of extensions in the order of precedence for
-  # using `image_tag` without file extensions.
-  config.img_auto_extensions_order = %w(.svg .png .jpg .jpeg .gif .tiff .tif)
-
-end
-
-
 ################################################################
 # Configuration
 #  Change the option values to suit your needs.
@@ -191,16 +150,49 @@ activate :Middlemac do |options|
   # named in the form `#{CFBundleName} (target).help`. You might want to target
   # the `Resources` directory of your XCode project so that your XCode project
   # is always up to date.
-  options.Help_Output_Location = nil
+  options.help_output_location = nil
+
+  # Indicates whether or not spaces should be avoided in the name of the help
+  # bundle. The default value for backwards compatibility is `true` because
+  # some tools, such a make, don't like spaces.
+  options.help_output_avoid_spaces = true
+
+  # Indicates whether or not the `help_output_location` includes the `(target)`
+  # prefix in the help book bundle name. The default, `true`, will result in
+  # `#{CFBundleName} (target).help`, which is the historical behavior. Setting
+  # this to `false` will result in a help book named `#{CFBundleName}.help`,
+  # instead. This can be useful if you are building help books from scripts via
+  # XCode, and you set `help_output_location` to `ENV['BUILT_PRODUCTS_DIR']`.
+  # @return [Boolean] `true` or `false` to enable or disable this behavior.
+  options.help_output_use_target = true
 
-  # Indicates the name of the breadcrumbs helper to use for breadcrumbs.
-  # Built-in breadcrumbs are "nav_breadcrumbs" and "nav_breadcrumbs_alt".
-  # Change to `nil` to disable breadcrumbs completely.
-  options.Breadcrumbs = 'nav_breadcrumbs'
+  # If set to true, then the enhanced image_tag helper will be used
+  # to include @2x, @3x, and @4x srcset automatically, if the image assets
+  # exist.
+  options.retina_srcset = true
+
+  # If set to an array of possible image extension values, then the `image_tag`
+  # 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 these extensions. Set this to
+  # an array of extensions in the order of precedence.
+  options.img_auto_extensions = %w(.svg .png .jpg .jpeg .gif .tiff .tif)
+
+  # If set to true, some of the templates will show additional information
+  # when pages are generated, such as contents of md_links and md_images.
+  # Also, JavaScript redirects will be omitted from naked pages, and the
+  # meta refresh will be set to 100 seconds for such pages.
+  options.show_debug = false
+
+  # If set to true, Apple will provide next page and previous page navigation
+  # gadgets automatically at the bottom of each content page. Apple itself
+  # does not use this feature currently.
+  options.show_previous_next = false
 
-  # This was removed in Middleman version 4.0. We are reintroducing it
-  # as a Middlemac feature.
-  options.partials_dir = 'Resources/Base.lproj/assets/partials'
+  # Indicate whether or not numeric file name prefixes used for sorting
+  # pages should be eliminated during output. This results in cleaner
+  # URI's. Helpers such as `page_name` and Middleman helpers such as
+  # `page_class` will reflect the pretty name.
+  config.strip_file_prefixes = true
 
 end #activate
 
@@ -214,42 +206,33 @@ end #activate
 #===============================================================
 # Setup directories to mirror Help Book directory layout.
 #===============================================================
-set :source,       'Contents'
-set :build_dir,    'Contents (build)'
-
-set :fonts_dir,    'Resources/Base.lproj/assets/fonts'
-set :images_dir,   'Resources/Base.lproj/assets/images'
-set :js_dir,       'Resources/Base.lproj/assets/javascripts'
-set :css_dir,      'Resources/Base.lproj/assets/stylesheets'
-
-set :layouts_dir,  'Resources/Base.lproj/assets/_layouts'
-set :data_dir,     'Contents/Resources/Base.lproj/assets/_data'
-
-
-#===============================================================
-# Ignore items we don't want copied to the destination
-#===============================================================
-#ignore 'data/*'
+set :source,         'Contents'
+set :data_dir,       'Contents/Resources/SharedGlobalAssets/_data'
+set :assets_dir,     'Resources/SharedGlobalAssets'
+set :partials_dir,   '_partials'
+set :layouts_dir,    '_layouts'
+set :convention_dir, 'convention'
+set :css_dir,        'css'
+set :fonts_dir,      'fonts'
+set :images_dir,     'images'
+set :js_dir,         'js'
 
 
 #===============================================================
-# All of our links and assets must be relative to the file
-# location, and never absolute. However we will *use* absolute
-# paths with root being the source directory; they will be
-# converted to relative paths at build.
+# Other required setup. Note: don't use relative assets or
+# links here, as Apple require very specific hrefs.
 #===============================================================
 set :strip_index_file, false
-set :relative_links, true
-activate :relative_assets do |options|
-  options.rewrite_ignore = [/image_sizes\.css/]
-end
 
 
 #===============================================================
-# Default to Apple-recommended HTML 4.01 layout.
+# Default to HTML5 Layout.
+# Specify layouts from most specific to least specific.
 #===============================================================
-set :haml, :format => :html4
-page 'Resources/Base.lproj/*.html', :layout => :'layout-html4'
+Haml::TempleEngine.disable_option_validator!
+set :haml, :format => :html5
+page 'Resources/*.lproj/asides/*.html', :layout => :'layout-apple-modern-aside'
+page 'Resources/*.lproj/*.html', :layout => :'layout-apple-modern'
 
 
 #===============================================================

data/fixtures/middlemac_app/makefile

@@ -0,0 +1,93 @@
+###############################################################################
+# Building from make rather than the previous shell script gives us a lot of
+# flexibility and is a bit simpler to integrate with Xcode.
+#
+# Usage:
+# make build|clean TARGET=target
+# Specifying a target is required.
+#
+# Make will assume that this makefile is in the root of your project, at the
+# same level as your source Contents/ directory. To use this file from Xcode,
+# create an External Build System target, and specify `/usr/bin/make` as the
+# build tool, `$(ACTION) TARGET=your_target_or_variable` as the arguments,
+# and for Directory, a path to this file, e.g., `$(PROJECT_DIR)/path/to/me`.
+###############################################################################
+
+
+#====================================================================
+# Prerequisites:
+# - Ensure that a TARGET is specified.
+# - Make sure Middlemac is installed and reachable. Although we
+#   could do that in a recipe, we need to discover our BUILD_DIR, 
+#   which cannot be done in a recipe.
+# - Discover our BUILD_DIR, by asking Middleman for the build 
+#   directory for the specified target.
+# Output will be provided in a target recipe if these conditions
+# cannot be met.
+#====================================================================
+
+ifdef TARGET
+	MM_EXISTS := $(shell [[ -s "$(HOME)/.rvm/environments/default" ]] && source "$(HOME)/.rvm/environments/default" ; which middlemac)
+endif
+ifdef MM_EXISTS
+	BUILD_DIR := $(shell export LANG=en_US.UTF-8 && [[ -s "$(HOME)/.rvm/environments/default" ]] && source "$(HOME)/.rvm/environments/default" ; bundle exec middleman list_all | grep "$(TARGET)," | cut -d\  -f2- )
+endif
+
+
+#====================================================================
+# "Source" files to monitor for changes. If any of these change,
+# then they will have a new file modification date than the
+# $(BUILD_DIR), causing the action to execute.
+#====================================================================
+SRC_FILES = $(shell find Contents)
+SRC_FILES += config.rb Gemfile Gemfile.lock
+
+#====================================================================
+# The default action, will build the specified TARGET using
+# Middleman, by depending on the $(BUILD_DIR).
+#====================================================================
+.PHONY: build
+build: check_prerequisites $(BUILD_DIR)
+
+
+#====================================================================
+# The action that will actually perform the building of the help
+# book. If the directory specified by $(BUILD_DIR) is older than
+# any of the given source files, then this action will be executed.
+# NOTE: make does NOT work with spaces in filenames.
+#====================================================================
+$(BUILD_DIR): $(SRC_FILES)
+	@echo "Make will have Middleman build target '$(TARGET)'"
+# 	@echo "RECIPE AS KNOWN TO MAKE: $@"
+# 	@echo "       ACTUAL BUILD_DIR: $(BUILD_DIR)"
+# 	@echo "       EXECUTION REASON: $?"
+	@export LANG=en_US.UTF-8 && \
+	[[ -s "$(HOME)/.rvm/environments/default" ]] && source "$(HOME)/.rvm/environments/default" ; \
+	bundle exec middleman build --target "$(TARGET)"
+	@touch "$(BUILD_DIR)"
+
+
+#====================================================================
+# Clean the given target.
+#====================================================================
+.PHONY: clean
+clean: check_prerequisites
+	@echo "Cleaning $(BUILD_DIR)…"
+	@rm -rf "$(BUILD_DIR)"
+
+
+#====================================================================
+# Ensure that we have everything that we need to proceed with doing
+# something with Middlemac and with the target.
+#====================================================================
+.PHONY: check_prerequisites
+check_prerequisites:
+ifndef TARGET
+	$(error "ERROR: It's required to specify a target macro, e.g., TARGET=default.")
+endif
+ifndef MM_EXISTS
+	$(error "ERROR: Middlemac was not found, and is required to continue.")
+endif
+ifndef BUILD_DIR
+	$(error "ERROR: Target ${TARGET} was specified, but Middlemac did not find any valid targets.")
+endif

data/lib/middlemac.rb

@@ -2,5 +2,9 @@ require 'middleman-core'
 
 Middleman::Extensions.register :Middlemac, :before_configuration do
   require_relative 'middlemac/extension'
+  require_relative 'middlemac/sitemap'
+  require_relative 'middlemac/helpers'
+  require_relative 'middlemac/private'
+  require_relative 'middlemac/trie-extension'
   Middlemac
 end

data/lib/middlemac/extension.rb

@@ -1,29 +1,70 @@
 require 'middleman-core'
-
+require 'fastimage'
+require 'pathname'
+require 'json'
+require 'nokogiri'
+require 'words_counted'
+require 'trie/trie'
 
 ################################################################################
-# **Middlemac** (an extension to **Middleman**) is a tool to build Mac OS X
-# application help book files from simple source documents. It handles all of
-# the esoteric details for you, and provides easy-to-use helpers for working
-# with multiple versions of your application (e.g., pro and free versions)
-# while minimizing source code.
+# **Middlemac** is a tool to build macOS application help book files from 
+# simple source documents. It handles all of the esoteric details for you, 
+# and provides easy-to-use helpers for working with multiple versions of 
+# your application (e.g., pro and free) while minimizing source code.
 # @author Jim Derry <balthisar@gmail.com>
 ################################################################################
+
 class Middlemac < ::Middleman::Extension
 
 
+  ############################################################
+  # Define additional Middleman settings.
+  ############################################################
+  define_setting :assets_dir, 'Resources/SharedGlobalAssets', 'The assets base directory. All other assets are relative to this.'
+  define_setting :convention_dir, 'convention', 'The directory for Middlemac conventions items.'
+  define_setting :partials_dir, '_partials', 'A convenient shortcut to common partials.'
+
+  # @!group Middleman Configuration
+
+  # @!attribute [rw] config[:assets_dir]=
+  # Specifies the high-level, shared assets root directory.
+  # @return [String] The shared assets root directory.
+  # @note This is a Middleman application level config option.
+
+  # @!attribute [rw] config[:convention_dir]=
+  # Specifies the special directory for assets the middlemac
+  # requires by convention. This directory does not have a
+  # localized variant.
+  # @return [String] The special convention directory.
+  # @note This is a Middleman application level config option.
+
+  # @!attribute [rw] options[:partials_dir]=
+  # Specifies the default location for partials. Prior to **Middleman** 4.0,
+  # all partials were kept in a common directory. **Middlemac** restores this
+  # previous behavior by allowing all partials to be grouped in a common
+  # directory. When using the `partial` helper, this directory will be checked
+  # first for the existence of a partial; if not found, then the default,
+  # built-in behavior will take over.
+  # @return [String] The directory to search for partials.
+
+
   ############################################################
   # Define the options that are to be set within `config.rb`
   # as extension options.
   ############################################################
-  option :Help_Output_Location, nil, 'Directory to place the built helpbook.'
-  option :Breadcrumbs, 'breadcrumbs', 'The name of the breadcrumbs helper to use for breadcrumbs.'
-  option :partials_dir, 'Resources/Base.lproj/assets/partials', 'A convenient shortcut to common partials.'
+  option :help_output_location, nil, 'Directory to place the built helpbook.'
+  option :help_output_avoid_spaces, true, 'If true, spaces in the help book file name bundle will be replaced with underscores.'
+  option :help_output_use_target, true, 'If false, the help book will not include (target) in its bundle name.'
+  option :img_auto_extensions, %w(.svg .png .jpg .jpeg .gif .tiff .tif), 'If not empty, then `image_tag` will work without filename extensions.'
+  option :retina_srcset, true, 'If true then the image_tag helper will be extended to include automatic @2x images.'
+  option :show_debug, false, 'If true, the main layout will show some debug information and site contents.'
+  option :show_previous_next, false, 'If true, show navigation controls at the bottom of each content page.'
+  option :strip_file_prefixes, true, 'If true leading numbers used for sorting files will be removed for presentation purposes.'
 
 
   # @!group Extension Configuration
 
-  # @!attribute [rw] options[:Help_Output_Location]=
+  # @!attribute [rw] options[:help_output_location]=
   # Specifies the directory where the finished `.help` bundle should go. It
   # must be relative to your `config.rb` file, or set it to `nil` to leave the
   # output in the default location (in the help project directory). The *actual*
@@ -32,28 +73,56 @@ class Middlemac < ::Middleman::Extension
   # 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.
-  # @param [String] value The directory where the final help bundle will be
-  #   built.
-  # @return [String] Returns the current value of this option.
-
-  # @!attribute [rw] options[:Breadcrumbs]=
-  # Indicates the name of the breadcrumbs helper to use for breadcrumbs.
-  # Built-in breadcrumbs are "nav_breadcrumbs" and "nav_breadcrumbs_alt".
-  # Change to `nil` to disable breadcrumbs completely. Breadcrumbs helpers are
-  # part of the `middleman-pagegroups` extension (which is a component of this
-  # extension).
-  # @param [String] value The name of the breadcrumbs helper to use.
-  # @return [String] Returns the current value of this option.
-
-  # @!attribute [rw] options[:partials_dir]=
-  # Specifies the default location for partials. Prior to **Middleman** 4.0,
-  # all partials were kept in a common directory. **Middlemac** restores this
-  # previous behavior by allowing all partials to be grouped in a common
-  # directory. When using the `partial` helper, this directory will be checked
-  # first for the existence of a partial; if not found then the default, built
-  # in behavior will take over.
-  # @param [String] value The directory to search for partials.
-  # @return [String] Returns the current value of this option.
+  # @return [String] The directory where the final help bundle will be built.
+  
+  # @!attribute [rw] options[:help_output_avoid_spaces]=
+  # Indicates whethr or not the `help_output_location` includes spaces in its
+  # filename or not. Some GNU tools, such as make, choke on spaces. The default
+  # setting for this option is *yes* in order to maintain backward
+  # compatibility.
+  # @return [Boolean] `true` or `false` to enable or disable this behavior.
+  
+  # @!attribute [rw] options[:help_output_use_target]=
+  # Indicates whether or not the `help_output_location` includes the `(target)`
+  # prefix in the help book bundle name. The default, `true`, will result in
+  # `#{CFBundleName} (target).help`, which is the historical behavior. Setting
+  # this to `false` will result in a help book named `#{CFBundleName}.help`,
+  # instead. This can be useful if you are building help books from scripts via
+  # XCode, and you set `help_output_location` to `ENV['BUILT_PRODUCTS_DIR']`.
+  # @return [Boolean] `true` or `false` to enable or disable this behavior.
+
+  # @!attribute [rw] options[:img_auto_extensions]=
+  # 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 `image_tag` 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.
+  # @return [Array<String>] Set to an array of image extensions.
+
+  # @!attribute [rw] options[:show_debug]=
+  # This option determines whether or not extra debug information is provided
+  # at the bottom of each content page.
+  # @return [Boolean] `true` or `false` to enable or disable this feature.
+
+  # @!attribute [rw] options[:show_previous_next]=
+  # 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.
+  # @return [Boolean] `true` or `false` to enable or disable this feature.
+
+  # @!attribute [rw] options[:retina_srcset]=
+  # This option determines whether or not the enhanced `image_tag` helper will
+  # be used to include an @2x `srcset` attribute automatically. This automatic
+  # behavior will only be applied if the image asset exists on disk and this
+  # option is set to `true`.
+  # @return [Boolean] `true` or `false` to enable or disable this feature.
+
+  # @!attribute [rw] options[:strip_file_prefixes]=
+  # If `true` 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.
+  # @return [Boolean] `true` or `false` to enable or disable this feature.
 
   # @!endgroup
 
@@ -66,6 +135,11 @@ class Middlemac < ::Middleman::Extension
 
     super
 
+    @md_links_b = {}
+    @md_images_b = {}
+    @md_sizes_b = nil
+    @hb_search_tree_b = nil
+
   end # initialize
 
 
@@ -76,13 +150,51 @@ class Middlemac < ::Middleman::Extension
   #############################################################
   def after_configuration
 
-    # Set the correct :build_dir based on the options.
+	puts "****************************************************"
+	puts "after_configuration"
+	puts "****************************************************"
 
-    dir = options[:Help_Output_Location] || File.expand_path('./')
+    # Set the correct :build_dir based on the options.
+    dir = options[:help_output_location] || File.expand_path('./')
     cf_bundle_name = app.config[:targets][app.config[:target]][:CFBundleName]
     target = app.config[:target]
-
-    app.config[:build_dir] = File.join(dir, "#{cf_bundle_name} (#{target}).help", 'Contents')
+    
+    if options[:help_output_use_target]
+      output_name = "#{cf_bundle_name} (#{target}).help"
+    else
+      output_name = "#{cf_bundle_name}.help"
+    end
+    output_name.gsub!(' ', '_') if options[:help_output_avoid_spaces]
+    
+    app.config[:build_dir] = File.join(dir, output_name, 'Contents')
+
+    return if app.config[:exit_before_ready]
+
+    # Set the other directories accordingly.
+    app.config[:layouts_dir]    = File.join(app.config[:assets_dir], app.config[:layouts_dir])
+    app.config[:partials_dir]   = File.join(app.config[:assets_dir], app.config[:partials_dir])
+    app.config[:convention_dir] = File.join(app.config[:assets_dir], app.config[:convention_dir])
+    app.config[:css_dir]        = File.join(app.config[:assets_dir], app.config[:css_dir])
+    app.config[:fonts_dir]      = File.join(app.config[:assets_dir], app.config[:fonts_dir])
+    app.config[:images_dir]     = File.join(app.config[:assets_dir], app.config[:images_dir])
+    app.config[:js_dir]         = File.join(app.config[:assets_dir], app.config[:js_dir])
+
+    # Reset the helpers' buffers when the configuration
+    # changes. For speed we don't want to recalculate everything
+    # every time a helper is used, but only the first time.
+    @md_links_b = {}
+    @md_images_b = {}
+    @md_sizes_b = nil
+    @hb_search_tree_b = nil
+
+    # Build a list of all of the available localizations, so that
+    #  - We can run the help indexer multiple times, and
+    #  - We can build the data for locale-list.json.
+    project_root = File.join(app.config[:source], 'Resources')
+    @localizations = Pathname.new(project_root).children.select { |c| c.directory? && c.basename.to_s.end_with?('.lproj') }
+                         .map { |p| p.basename.to_s }
+
+    @localizations.each { |k| say "Middlemac will handle localized content for #{k}.", :blue }
 
   end
 
@@ -94,181 +206,10 @@ class Middlemac < ::Middleman::Extension
   ############################################################
   def after_build(builder)
 
-    run_help_indexer
-
-  end # after_build
-
-
-  ############################################################
-  #  Helpers
-  #    Methods defined in this helpers block are available in
-  #    templates.
-  ############################################################
-
-  helpers do
-
-    #--------------------------------------------------------
-    # This helper returns the name of the breadcrumbs
-    # partial configured to be used in your project, i.e.,
-    # the value of `options[:Breadcrumbs]`.
-    # @return [String] The name of the configured breadcrumbs
-    #   partial.
-    #--------------------------------------------------------
-    def breadcrumbs
-      extensions[:Middlemac].options[:Breadcrumbs]
-    end
-
-
-    #--------------------------------------------------------
-    # Returns the name of the configured partials directory
-    # to use by default with the `partials` helper, i.e., the
-    # value of `options[:partials_dir]`.
-    # @return [String] The path of the configured default
-    #   partials directory.
-    #--------------------------------------------------------
-    def partials_dir
-      extensions[:Middlemac].options[:partials_dir]
-    end
-
-
-    #--------------------------------------------------------
-    # Returns the product `CFBundleIdentifier` for the
-    # current target as configured in your `config.rb`.
-    # @return [String] The `cfBundleIdentifier`.
-    #--------------------------------------------------------
-    def cfBundleIdentifier
-      config[:targets][config[:target]][:CFBundleID]
-    end
-
-
-    #--------------------------------------------------------
-    # Returns the product `CFBundleName` for the current
-    # target as configured in your `config.rb`.
-    # @return [String] The `CFBundleName`.
-    #--------------------------------------------------------
-    def cfBundleName
-      config[:targets][config[:target]][:CFBundleName]
-    end
-
-
-    #--------------------------------------------------------
-    # Returns the `ProductName` for the current target
-    # as configured in your `config.rb`.
-    # @return [String] The `ProductName`.
-    #--------------------------------------------------------
-    def product_name
-      config[:targets][config[:target]][:ProductName]
-    end
-
-
-    #--------------------------------------------------------
-    # Returns the `ProductVersion` for the current target
-    # as configured in your `config.rb`.
-    # @return [String] The `ProductVersion`.
-    #--------------------------------------------------------
-    def product_version
-      config[:targets][config[:target]][:ProductVersion]
-    end
-
-
-    #--------------------------------------------------------
-    # Returns the `ProductURI` for the current target
-    # as configured in your `config.rb`.
-    # @return [String] The `ProductURI`.
-    #--------------------------------------------------------
-    def product_uri
-      config[:targets][config[:target]][:ProductURI]
-    end
-
-
-    #--------------------------------------------------------
-    # Extends the built-in `partials` helper to allow the
-    # use of a default partials directory as configured with
-    # `options[:partials_dir]`. Middleman 4.0 removed the
-    # option `partials_dir` which increased flexibility a 
-    # lot, but hurt backwards compatibility. When used the
-    # default location will be searched first for the
-    # specified partial; if not found then the built-in
-    # behavior will be used.
-    # @param [String] template The partial file to use.
-    # @param [Hash] opts Options to use for the partial.
-    #   Consult **Middleman**’s documentation for possible
-    #   options.
-    # @param [Block] &block An option block as per the
-    #   default implementation by **Middleman**.
-    # @group Extended Helpers
-    #--------------------------------------------------------
-    def partial(template, opts={}, &block)
-      file_check = File.join(extensions[:Middlemac].options[:partials_dir], "_#{template}")
-      if ::Middleman::TemplateRenderer.resolve_template( @app, file_check)
-        super(file_check, opts, &block)
-      else
-        super(template, opts, &block)
-        end
-    end
-
-
-  end #helpers
-
-
-  ############################################################
-  # Instance Methods
-  # @!group Instance Methods
-  ############################################################
-
-
-  #########################################################
-  # Runs Apple’s the help indexer if it is available on
-  # the system.
-  # @return [Void]
-  #########################################################
-  def run_help_indexer
-
-    cf_bundle_name = app.config[:targets][app.config[:target]][:CFBundleName]
-    target = app.config[:target]
-
-    # see whether a help indexer is available.
-    `command -v hiutil > /dev/null`
-    if $?.success?
-
-      index_dir = File.expand_path(File.join(app.config[:build_dir], 'Resources/', 'Base.lproj/'))
-      index_dst = File.expand_path(File.join(index_dir, "#{cf_bundle_name}.helpindex"))
-
-      say "'…#{index_dir.split(//).last(60).join}' (indexing)", :cyan
-      say "'…#{index_dst.split(//).last(60).join}' (final file)", :cyan
-
-      `hiutil -Cf "#{index_dst}" "#{index_dir}"`
-    else
-      say "NOTE: `hiutil` is not found, so no index will exist for target '#{target}'.", :red
+    @localizations.each do |locale|
+      run_help_indexer(locale)
     end
 
-  end #run_help_indexer
-
-
-  #########################################################
-  # Output colored messages using ANSI codes.
-  # @param [String] message The message to output to the
-  #   console.
-  # @param [Symbol] color The color in which to display
-  #   the message.
-  # @returns [Void]
-  # @!visibility private
-  #########################################################
-  def say(message = '', color = :reset)
-    colors = { :blue   => "\033[34m",
-               :cyan   => "\033[36m",
-               :green  => "\033[32m",
-               :red    => "\033[31m",
-               :yellow => "\033[33m",
-               :reset  => "\033[0m",
-    }
-
-    if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
-      puts message
-    else
-      puts colors[color] + message + colors[:reset]
-    end
-  end # say
-
+  end # after_build
 
-end # class MiddlemacExtras
+end # class Middlemac