#cfBundleIdentifier ⇒ String

Returns the product CFBundleIdentifier for the current target as configured in your config.rb.

Returns:

  • (String) —

    The cfBundleIdentifier.

#cfBundleName ⇒ String

Returns the product CFBundleName for the current target as configured in your config.rb.

Returns:

  • (String) —

    The CFBundleName.

#css_image_sizes ⇒ String

This helper provides CSS for every image in your project. Each image will have a declaration that sets max-width and max-height to the actual size of the image. Proper @2x image support is included. It’s most useful to use this helper in a some_file.css.erb file.

Returns:

  • (String) —

    Returns a string with the CSS markup for every image found in your project.

#hb_copyright_page ⇒ Sitemap::Resource

Returns the copyright page, if one is present. The first page in the hb_sitemap which includes “copyright” within its categories.

Returns:

  • (Sitemap::Resource) —

    The root resource.

#hb_framework ⇒ String

Returns the extension name and version; suitable for the framework field of modern Apple Help framework field.

Returns:

  • (String) —

    The extension name and version.

#hb_landing_page ⇒ Sitemap::Resource

Returns the very top of of the current target, i.e., generally your index.html landing page in the lproj directory.

Returns:

  • (Sitemap::Resource) —

    The root resource.

#hb_locale_list ⇒ Array<String>

Returns a list of the locales detected during config. This can be used to build locale-list.json from the data object.

Returns:

  • (Array<String>) —

    The list of locales.

#hb_search_tree ⇒ String

Returns the search tree for the current locale.

Returns:

  • (String) —

    The search tree in JSON format.

#hb_sitemap ⇒ Array<Sitemap::Resource>

Returns a filtered version of the sitemap for the current target containing only resources that the modern Apple Help can navigate to directly, in the current language. as configured in your config.rb.

Returns:

  • (Array<Sitemap::Resource>) —

    The applicable sitemap.

#helpbook_task(id, headline, options = nil, &block) ⇒ String

This helper makes it easy to create a help book task. It supports markdown for the body of the task.

Parameters:

  • id (String) —

    Specify the id attribute for the containing <div>. Ensure that these are unique throughout your project so that open-closed states are preserved.

  • headline (String) —

    Specify the task’s label. Note that markdown and HTML are stripped away by Apple’s scripts, and won’t influece the output.

  • options (Hash) (defaults to: nil) —

    Optional parameters to pass to the helper.

  • block (&block) —

    The content of the task.

Options Hash (options):

  • :markdown (Boolean) —

    By default, the helper expects that the &block contains markdown; be sure to set the :markdown option to false if this is not desired.

Returns:

  • (String) —

    Returns the complete task.

#link_to_anchor(caption, anchor) ⇒ String

Returns a link in the help:anchor:bookID format that Apple recommends in their documentation. Although they work, they’re not recommended: - Apple doesn’t use these in their own Help Books. - When served to a browser, Apple’s JavaScript removes the link (i.e., they don’t work) because it does not access the Help Index where the anchors are recorded.

Parameters:

  • caption (String) —

    The text of the link.

  • anchor (String) —

    The anchor to link to.

Returns:

  • (String) —

    Returns an HTML <a> tag.

#md_images ⇒ String

This helper provides access to an index of images in Markdown reference format, enabling you to use reference-style images in documents. Because this helper includes literal Markdown, it’s only useful in Markdown documents.

Returns:

  • (String) —

    Returns a string with the Markdown index of every image in your project.

#md_links ⇒ String

This helper provides access to an index of links in Markdown reference format, enabling you to use reference-style links in documents. Because this helper includes literal Markdown, it’s only useful in Markdown documents. These links are ready to use in modern Helpbooks.

Returns:

  • (String) —

    Returns a string with the Markdown index of every page in your project.

#partials_dir ⇒ String

Returns the name of the configured partials directory to use by default with the partials helper, i.e., the value of options[:partials_dir].

Returns:

  • (String) —

    The path of the configured default partials directory.

#product_copyright ⇒ String

Returns the ProductCopyright for the current target as configured in your config.rb.

Returns:

  • (String) —

    The ProductCopyright.

#product_name ⇒ String

Returns the ProductName for the current target as configured in your config.rb.

Returns:

  • (String) —

    The ProductName.

#product_uri ⇒ String

Returns the ProductURI for the current target as configured in your config.rb.

Returns:

  • (String) —

    The ProductURI.

#product_version ⇒ String

Returns the ProductVersion for the current target as configured in your config.rb.

Returns:

  • (String) —

    The ProductVersion.