Quick Index is packed with options, giving you control over how it works and behaves. Here is the full list of the options you can find in the Quick Index system plugin settings:
Styling
| Class name | Set a class name to add to the div tag around the index list. Default setting: well |
| Class name Index Title | Set a class name to add to the title tag of the index. Default setting: index-header |
| Class name List | Set a class name to add to the index list tag. Default setting: index |
| Class name List Titles | Set a class name to add to the title elements inside the index list. Default setting: index-title |
| Class name List Items | Set a class name to add to the index list items. Default setting: index-item |
| Class name Headings | Set an optional class name to add to the heading tags. Default setting: indexed |
| Class name Numbers | Set a class name to add to the span around the numbers added to the headings. Default setting: heading_number |
Behaviour
| Index Title | Enter a title that will be placed at the top of the index list. This value will be handled as a Joomla language string. |
| Index Title Heading | Select the heading tag to use for the index title. Options: h2, h2, h2, h4, h5, h6, p |
Minimum / Maximum Levels
| Minimum Index Level | Set the minimum heading level to include in the index. Options: h2, h2, h2, h4, h5, h6 |
| Maximum Index Level | Set the maximum heading level to include in the index. Options: h2, h2, h2, h4, h5, h6 |
| Minimum Headings Level | Set the minimum heading level. All these headings will be converted based on your settings, like adding anchors, class names and numbered prefixes. Options: h2, h2, h2, h4, h5, h6 |
| Maximum Headings Level | Set the maximum heading level. All these headings will be converted based on your settings, like adding anchors, class names and numbered prefixes. Options: h2, h2, h2, h4, h5, h6 |
Ordered List
| Ordered List | Select whether to use ordered or unordered lists. Options: No, Yes, Set individually PRO Set individually allows you to choose the list style for each level. |
| Ordered List Style | Set the ordered list style. Options: 1, 2, 3 A, B, C a, b, c I, II, III i, ii, iii |
Auto Index
| Auto Index | Automatically add an index at the top of articles. |
| Categories | Limit the automatic adding of indexes to the selected categories. Options: Ignore, Include, Exclude |
| Also on child items | Also assign to child items of the selected items? |
Tag Syntax
| Quick Index Tag | The word to be used in the tags. Note: If you change this, all existing tags will not work anymore. Default setting: index |
| No Index Tag | The word to be used in the noindex tags. Headings in the content between these tags will not be included in the index. Default setting: nondex |
| Tag Characters | The surrounding characters of the tag syntax. Note: If you change this, all existing tags will not work anymore. Options: {...}, [...], {{...}}, [[...]], [:...:], [%...%] |
Advanced Settings
| No Index Class names | A comma separated list of class names. Headings with any of these class name will not be included in the index. |
| No Index Attributes | A comma separated list of attributes. Headings with any of these html attributes (key and value) will not be included in the index. |
| Index Title Class names | A comma separated list of class names. Headings with any of these class name will be displayed as a heading inside the index list. |
| Index Title Offset | Set an offset to be used as a heading tag inside the index. For instance, if the offset is set to 2 and a h2 heading has a title class name, it will appear as a h2 in the index. |
| Add Links | Select whether to add anchor links to the items in the index list. |
| Add Links to Headings | Select whether to add anchor links to the headings inside the content. |
| Add Anchors to Headings | Select whether to add anchor elements to the headings inside the content. Only switch this off if you are adding elements with the necessary ID in another way. |
| Add Number to Headings | Select whether to add the generated number to the headings. Options: No, Yes, Only when ordered |
| Number Separator | Set the character to place after the number, before the heading text. |
| Add Number to IDs | Select whether to add the generated number to the ids used for linking. |
| Add Parents to IDs | Select whether to add the parent headings to the ids used for linking. |
| Prefix IDs | Select to add a prefix to the ids used for linking |
| Prefix Numeric IDs | Select to add a prefix to the ids used for linking, when it starts with a number |
| Prefix | Enter the desired prefix to add to the ids used for linking |
| Remove HTML | Remove HTML tags from the titles inside the index. |
| Remove Words from IDs | A comma-separated list of words to remove from the ids used for linking. |
| Disable on Components | Select in which front-end components NOT to enable the use of this extension. |
| Remove in Disabled Components | If selected, the plugin syntax will get removed from the component. If not, the original plugins syntax will remain intact. |
| Place HTML comments | By default HTML comments are placed around the output of this extension. These comments can help you troubleshoot when you don't get the output you expect. If you prefer to not have these comments in your HTML output, turn this option off. |