Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/nav"

Navigation File

Creation of the navigation file combining a template with the TOC fragment retrieved from the content DOM.

Index

Functions

Functions

create_nav_file

  • Create a navigation file, and return the necessary resource (to be added to the overall set of resources).

    The content of the original TOC element is serialized (using the innerHTML DOM method) and the result is added to a textual HTML template. The only change on the original content is the replacement of the purely fragment URLs in the TOC with a relative URL to Overview.xhtml.

    Parameters

    Returns ResourceRef[]

    • Resource representing the nav.xhtml file