...
Parameters | Default | Label in macro browser | Notes | Usage |
---|---|---|---|---|
enabled | true (checked) | Enable this Macro | (Uncheck this to exclude current page when you put the macro into the footer in space tool) | true: this macro is enabled on the current page. false: 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 | (Format: h1,h2,h3,h4,h5,h6) | 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 | (Input an integer for width in pixel) | 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 |
| |
titleExpandClickable | false (unchecked) | Make the heading title clickable for expanding or collapsing |
| |
useNavigation | true (checked) | Enable floating side bar |
| |
useNavigationHiddenMode | false (unchecked) | By default hide the side bar |
| |
wrapNavigationText | false (unchecked) | wrap the text in side bar |
| |
navigationTitle | Table of Content | Title of floating side bar | Display the title in the navigation bar as the title. | |
navigationTop | 90 | Top of floating side bar | (Input an integer for top in pixel) | |
navigationWidth | 230 | Width of floating side bar | (Input an integer for width in pixel) | Set a number in pixel as the width of the navigation side bar. |
navigationIndent | 10 | Heading indent in floating side bar | (Input an integer for width in pixel) | 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 | Input an integer number, the default 0 means never disable sidebar | 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 |
| |
relatedLinksTitle | Related Links | Title of related links | When there are no links, this title will be not displayed. | |
relatedLinksTarget | new-window | Open related links in |
| |
linkText1 | (empty) | Link 1 text | ||
linkUrl1 | (empty) | Link 1 url | ||
linkText2 | (empty) | Link 2 text | ||
linkUrl2 | (empty) | Link 2 url | ||
linkText3 | (empty) | Link 3 text | ||
linkUrl3 | (empty) | Link 3 url | ||
linkText4 | (empty) | Link 4 text | ||
linkUrl4 | (empty) | Link 4 url | ||
linkText5 | (empty) | Link 5 text | ||
linkUrl5 | (empty) | Link 5 url | ||
linkText6 | (empty) | Link 6 text | ||
linkUrl6 | (empty) | Link 6 url | ||
macrosTOCDisabled | (empty) | Disable this macro inside of macros | (Format: name1,name2. Workaround to prevent applying this macro to headings within the specified macros.) | |
macrosToRemoveContainer | (empty) | Remove container of macros | (Format: name1,name2. Workaround to apply this macro to headings within the specified macros by removing their outmost div.) |