The newest version of Quick Index includes several improvements and fixes, and comes with a rewritten documentation.

Quick Index is the Joomla plugin that allows you to easily add an index (Table of Contents) to your content. The index will be generated based on the headings in your content.

A refactored version of Quick Index, version 2, has been released today, and the documentation has been revamped as well.

Below you find a breakdown of the new features that have been introduced with the latest update:

Ordered List Style PRO

In the Pro version of Quick Index you can now set the List Style that Ordered Indexes should use. You can set the default behavior in the Plugin Settings, or individually override the setting in the {index} tag.

The default is normal numbering. But you can choose any of these:

{index ordered_style="numbers"} or {index ordered_style="1"}

  1. Apples
  2. Bananas
  3. Cherries

{index ordered_style="letters"} or {index ordered_style="A"}

  1. Apples
  2. Bananas
  3. Cherries

{index ordered_style="letters_lowercase"} or {index ordered_style="a"}

  1. Apples
  2. Bananas
  3. Cherries

{index ordered_style="roman"} or {index ordered_style="I"}

  1. Apples
  2. Bananas
  3. Cherries

{index ordered_style="roman_lowercase"} or {index ordered_style="i"}

  1. Apples
  2. Bananas
  3. Cherries

Individual Level Style PRO

You can also set a different List Style for each individual level in an Ordered List. You can specify this both in the Default Settings and in the {index} tag, for example by using ordered_style_2 for Level 2, ordered_style_3 for Level 3, and so on.

{index ordered_style_1="numbers" ordered_style_2="letters" ordered_style_3="roman"}

This will result in something like:

  1. Fruit
    1. Apples
      1. Green Apples
      2. Red Apples
    2. Bananas
  2. Animals
    1. Cats
    2. Dogs
      1. Beagle
      2. Bulldog
      3. Labrador

You can also accomplish the same result with a simpler tag that includes all Levels styles in a single attribute, by simply listing the styles in order inside ordered_style:

{index ordered_style="numbers,letters,roman"}

Individual Ordered / Unordered Level PRO

The index will be displayed as an ordered (numbered) list by default. To override the default setting in the {index} tag, and display an unordered (bulleted) list instead, you can do:

{index ordered="false"}

You can also set a different list type for each individual level. You can specify this both in the Default Settings and in the {index} tag, for example by using ordered_2 for Level 2, ordered_3 for Level 3, and so on.

{index ordered_1="true" ordered_2="false" ordered_3="true"}

This will result in something like:

  1. Fruit
  2. Animals

You can now also accomplish the same result with a simpler tag that includes all Levels in a single attribute, by simply listing the types in order inside ordered:

{index ordered="true,false,true"}

New Settings PRO

Add parent headings in the ids used for linking

You can now select whether to add the parent headings to the ids used for linking.

What does that mean? Normally, the anchor URL simply has the name of the heading in it. So, for example, for a subheading called "Beagle", the anchor would be just "#beagle".

By enabling the "Add Parents to IDs" setting, the anchor URL will include the parent heading names as well. From our example above, our "Beagle" subheading would have an anchor of: "#animals-dogs-beagle".

Remove words from the ids used for linking

It's now also possible to prevent certain words to be used in the anchor links. For example, we might not want short words such as "and" or "the" to be included in these link names.

With this setting, we can input a comma separated list of words to remove from the ids used for linking.

Set the minimum and maximum levels for the index and headings separately

The "Minimum and Maximum Headings Level" settings allow us to separately control whether we want to add anchors and class names to the headings in the content.

For example, you might want to only include 2 levels in the Index, but add anchors and number prefixes to all the headings in the content.

With Quick Index Pro, you can now do that too.

Read the Changelog for Quick Index 2 for the full list of improvements and fixes that have been made in the new release.

For a complete overview of all the features included in Quick Index, head over to the full Documentation, and check out the Video Tutorials.