Generates a breadcrumbs structure as an <ul>. The trailing element is the current page.

Parameters:

  • locals (Hash) (defaults to: {}) —

    A hash of key-value pairs that are passed to the structure as local variables.

Options Hash (locals):

  • :klass (String) —

    The class attribute value that should be assigned to the containing element.

Returns:

  • (String) —

    An <ul> containing the breadcrumbs.

#nav_breadcrumbs_alt(locals = {}) ⇒ String

Generates the breadcrumbs structure, alternate form, wherein the trailing element consists of a label indicating “current page,” as an <ul>.

Parameters:

  • locals (Hash) (defaults to: {}) —

    A hash of key-value pairs that are passed to the structure as local variables.

Options Hash (locals):

  • :klass (String) —

    The class attribute value that should be assigned to the containing element.

  • :label (String) —

    The text for the label that means “Current page.”

Returns:

  • (String) —

    An <ul> containing the breadcrumbs.

#nav_brethren(locals = {}) ⇒ String

Generates a fuller list of related topics as a <dl>, with a link to the page as the definition term and the page’s front matter :blurb as the definition definition.

Parameters:

  • locals (Hash) (defaults to: {}) —

    A hash of key-value pairs that are passed to the structure as local variables.

Options Hash (locals):

  • :klass (String) —

    The class attribute value that should be assigned to the containing element.

  • :start (Sitemap::Resource) —

    The resource from which to start the list. If not specified, then this resource’s brethren will be listed.

Returns:

  • (String) —

    A <dl> containing the list.

#nav_brethren_index(locals = {}) ⇒ String

Generates a condensed list of related topics as an <ul>, omitting the :blurb front matter data.

Parameters:

  • locals (Hash) (defaults to: {}) —

    A hash of key-value pairs that are passed to the structure as local variables.

Options Hash (locals):

  • :klass (String) —

    The class attribute value that should be assigned to the containing element.

  • :start (Sitemap::Resource) —

    The resource from which to start the list. If not specified, then this resource’s brethren will be listed.

Returns:

  • (String) —

    An <ul> containing the list.

#nav_legitimate_children(locals = {}) ⇒ String

Generates a fuller list of child topics as a <dl>, with a link to the page as the definition term and the page’s front matter :blurb as the definition definition.

Parameters:

  • locals (Hash) (defaults to: {}) —

    A hash of key-value pairs that are passed to the structure as local variables.

Options Hash (locals):

  • :klass (String) —

    The class attribute value that should be assigned to the containing element.

  • :start (Sitemap::Resource) —

    The resource from which to start the list. If not specified, then this resource’s children will be listed.

Returns:

  • (String) —

    A <dl> containing the list.

#nav_prev_next(locals = {}) ⇒ String

Generates a previous and next item as two anchors nested within a <div>. With appropriate CSS this can be rendered as a set of navigation buttons.

Parameters:

  • locals (Hash) (defaults to: {}) —

    A hash of key-value pairs that are passed to the structure as local variables.

Options Hash (locals):

  • :klass (String) —

    The class attribute value that should be assigned to the containing element.

  • :label_previous (String) —

    The text for the label that means “Previous page.”

  • :label_next (String) —

    The text for the label that means “Next page.”

Returns:

  • (String) —

    A <div> containing the links.

#nav_toc_index(locals = {}) ⇒ String

Generate a nested <ul> structure representing the complete table of contents from any particular starting point.

Parameters:

  • locals (Hash) (defaults to: {}) —

    A hash of key-value pairs that are passed to the structure as local variables.

Options Hash (locals):

  • :klass (String) —

    The class attribute value that should be assigned to the containing element.

  • :start (Sitemap::Resource) —

    The resource from which to start the list. If not specified, then this resource will be used as the root.

Returns:

  • (String) —

    An <ul> containing the list.