Set Parameters for the Macro
In the Macro browser window, you need to specify the parameters, otherwise it will automatically use the default values. Here are the Parameter Definitions and Usage:
Parameter
Default
Label in Browser Window
Usage
enabled
Checked
Enable this Macro
Checked: this macro is enabled on the current page.
Unchecked: this macro is disabled on the current page.
Unchecked option is to give you the ability to exclude the specified pages when you have applied the macro to the whole space. In this case you have to put the macro in footer not header in Space Tool → Look and Feel → Sidebar, header and footer.
selector
h1,h2,h3
Choose heading levels to be applied
From h1 to h6, you can include any of them by split with comma. Leaving this parmeter empty will by default use the value of all headings: h1,h2,h3,h4,h5,h6.
headingIndent
20
Heading indent on the page
This indent in pixel is for each level of heading blocks on the page.
expandOption
expand-all-by-default
Expand headings in the way of
expand-all-by-default: make all headings expandable and initially expand all of them.
collapse-all-by-default: make all headings expandable and initially collapse all of them.
collapse-all-but-headings-1: collapse all headings but heading 1
collapse-all-but-headings-1-2: collapse all headings but heading 1 and heading 2
collapse-all-but-headings-1-3: collapse all headings but heading 1 to heading 3
collapse-all-but-headings-1-4: collapse all headings but heading 1 to heading 4
disable-expand-collapse: disable the expandable feature for all headings.
titleExpandClickable
false
Make the heading title clickable for expanding or collapsing
Checked: make the heading titles clickable
Unchecked: make the heading titles not clickable so only arrow buttons are clickable
useNavigation
true
Enable floating side bar
Checked: enable the navigation side bar on the current page.
Unchecked: disable the navigation side bar on the current page.
useNavigationHiddenMode
false
By default hide the side bar
Checked: this mode hides the navigation side bar and give a icon for user to hover to popup the Table of Contents
Unchecked: this mode always display the Table of Contents
wrapNavigationText
false
wrap the text in side bar
Checked: wrap the text of all links in side bar
Unchecked: trim the text exceeding the width of the side bar
navigationTitle
Table of Content
Title of floating side bar
Display the title in the navigation bar as the title.
navigationWidth
230
Width of floating side bar
Set a number in pixel as the width of the navigation side bar.
navigationIndent
10
Heading indent in floating side bar
This indent in pixel is for each level of heading items in the navigation bar.
disableNavLinksUnder
0
Disable side bar when its links less than
The side bar will be disabled when the number of heading links in the sidebar is less than the defined value. The value 0 means side bar will be never disabled.
navigationExpandOption
collapse-all-by-default
Choose way to expand links in the side bar
expand-all-by-default: make all sub headings links expandable and initially expand all of them.
collapse-all-by-default: make all sub headings links expandable and initially collapse all of them.
collapse-all-but-headings-1: collapse all headings but heading 1
collapse-all-but-headings-1-2: collapse all headings but heading 1 and heading 2
collapse-all-but-headings-1-3: collapse all headings but heading 1 to heading 3
collapse-all-but-headings-1-4: collapse all headings but heading 1 to heading 4
disable-expand-collapse: disable the expandable feature for all headings links in navigation bar.
Last updated
Was this helpful?