README.md

Index A Page

• Contributors: sloanthrasher
• Plugin Name: Index A Page
• Text Domain: cstidx_makeindex
• Donate link: https://sloansweb.com/say-thanks
• Tags: table of contents, idx, index, page index, headings
• Requires at least: 5.0
• Tested up to: 6.6
• Requires PHP: 7.2
• Stable tag: 1.0
• License: GPLv3 or later
• License URI: http://www.gnu.org/licenses/gpl-3.0.html
• Plugin URI: https://sloansweb.com/page-6/
• Author: Sloan Thrasher
• Author URI: https://sloansweb.com/about/
• Description: A plugin to generate a dynamic, hierarchical index of pages (IDX) based on page headings using a customizable shortcode.

---

Description

A plugin to generate a dynamic, hierarchical index of pages (IDX) based on page headings using a customizable shortcode. This plugin is particularly useful for longer pages, allowing users to jump directly to specific sections. The plugin includes several pre-configured styles for the index placement, which can be customized as needed.

Installation

There are two ways to install the cstidx_makeindex plugin:

From the WordPress Plugin Directory

1. Go to the WordPress dashboard.
2. Navigate to Plugins > Add New.
3. In the search box, type Index A Page.
4. Once you find the plugin, click Install Now.
5. After installation, click Activate to enable the plugin.

Manual Installation

1. Upload the plugin files to the /wp-content/plugins/cstidx_makeindex directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.

---

After Installing and activating the plugin

• Navigate to the 'Settings' menu and select 'Index A Page' to configure the plugin.
• Use the [cstidx_index] shortcode in any page or post to generate the index.

Frequently Asked Questions

• How do I add the index to my page? *

Simply add the [cstidx_index] shortcode to any post or page where you want the index to appear.

• Can I customize the style of the index? *

Yes! You can choose from several included styles or add your own custom CSS by selecting the 'Custom' option in the settings.

• What elements are indexed by default? *

By default, the plugin indexes h2, h3, and h4 elements. You can modify this through the settings.

Screenshots

1. Example of Index - Shows an example of the generated index on a page.
2. Plugin Settings Page - The settings page where the index customization options are configured.
3. Shortcode - Shortcode Example.

Changelog

• 1.0 *
• Initial release.

Upgrade Notice

• 1.0 * First release. No upgrade required.

License

This plugin is licensed under the GPLv3 or later. For more details, see the included LICENSE file or visit the following link: GPL License