navBar

Syntax navbar (outlineName, orientation, itemSeparator, lineSeparator, maxPerLine, linkColor, hoverColor, boldLinks, boldCurrentPage, boldCategories, categoryColor, showCategories, breakAtCategories, extraCategoryLine, indentSpaces, linkClass, adrPageTable)

Params outlineName is the name of the outline to render as an HTML navbar.

orientation specifies whether the navbar is vertical or horizontal.

itemSeparator is an optional string specifying what separates items.

lineSeparator is an optional string specifying what separates lines.

maxPerLine is an optional number specifying the maximum number of items on a line.

linkColor is an optional string specifying the color of links.

hoverColor is an optional string specifying the color of links when the mouse is held over a link.

boldLinks is an optional boolean specifying whether or not to make links bold.

boldCurrentPage is an optional boolean specifying whether or not the current page should be bold.

boldCategories is an optional boolean specifying whether or not category names should be bold.

categoryColor is an optional string specifying the text color of category names

showCategories is an optional boolean specifying whether or not category names should be included in the navbar.

breakAtCategories is an optional boolean specifying whether or not lines should be broken after categories.

extraCategoryLine is an optional boolean specifying whether or not there should be an extra blank line before categories.

indentSpaces is an optional number specifying how many lines to indent links.

linkClass is an optional string specifying the class attribute for links in the navbar.

adrPageTable is the optional address of the page table.

Action Builds an HTML navbar based from a Frontier outline.

Returns The HTML string containing the navbar.

Examples navbar ("mainLinks")

   » "<a href=\"default.html">Frontier 5 Home<p>\r<a href="whatIsFrontier.html">What is Frontier?</a><p>\r..."

navbar ("mainLinks", lineSeparator: "<br>")

   » "<a href=\"default.html">Frontier 5 Home</a><br>\r<a href="whatIsFrontier.html">What is Frontier?</a><br>\r..."

Notes This macro is stored at html.data.standardMacros.navbar.

For more information, read the HowTo on the navBar macro.

This macro is new in Frontier 5.1.

See Also outlineSite

Discuss