search

ahmedkaludi / easy-table-of-contents

WordPress plugin which adds a user friendly and fully automatic way to create and display a table of contents from the page content.
http://connections-pro.com
67 stars 46 forks source link

readme

=== Easy Table of Contents === Contributors: magazine3 Donate link: https://tocwp.com/ Tags: table of contents, toc Requires at least: 5.0 Tested up to: 6.6 Requires PHP: 5.6.20 Stable tag: 2.0.69 License: GPLv2 or later License URI: https://www.gnu.org/licenses/gpl-2.0.html

Adds a user friendly and fully automatic way to create and display a table of contents generated from the page content.

== Description ==

A user friendly, featured focused Easy Table of Contents plugin which allows you to insert a table of contents into your posts, pages and custom post types.

Home | Help & Tech Support | Documentation | Pro version Features

Features

= TAKE IT A STEP FURTHER WITH EASY TABLE OF CONTENTS PRO = With EASY TABLE OF CONTENTS PRO You will get access to more professional Settings, options and positions to really push your TOC to the next level.

Shortcode

With Our shortcode feature you are in command of the table of contents with very little effort and even if you have little to no programming skills.

[ez-toc] Would generate the table of contents.

Below are the attibutes we support and could be useful in configuring the table of contents:

[header_label="Title"] – title for the table of contents [display_header_label="no"] - no title for the table of contents [toggle_view="no"] – no toggle for the table of contents [initial_view="hide"] – initially hide the table of contents [initial_view="show"] – initially show the table of contents [display_counter="no"] – no counter for the table of contents [post_types="post,page"] – post types seperated by ,(comma) [post_in="1,2"] – ID's of the posts|pages seperated by ,(comma) [post_not_in="1,2"] – ID's of the posts|pages seperated by ,(comma) [device_target="desktop"] – mobile or desktop device support for the table of contents [view_more="5"] – 5, is the number of headings loads on first view, before user interaction (PRO)

Support

We try our best to provide support on WordPress.org forums. However, We have a special team support where you can ask us questions and get help. Delivering a good user experience means a lot to us and so we try our best to reply each and every question that gets asked.

Bug Reports

Bug reports for Easy Table of Contents are welcomed on GitHub. Please note GitHub is not a support forum, and issues that aren't properly qualified as bugs will be closed.

JOIN TELEGRAM GROUP COMMUNITY**: Purpose of this group is to get proper suggestions and feedback from plugin users and the community so that we can make the plugin even better.

Roadmap

Credit

Easy Table Contents is a fork of the excellent Table of Contents Plus plugin by Michael Tran.

Screenshots

  1. The General section of the settings.
  2. The Appearance section of the settings.
  3. The Advanced section of the settings.

Installation

= Using the WordPress Plugin Search =

  1. Navigate to the Add New sub-page under the Plugins admin page.
  2. Search for easy table of contents.
  3. The plugin should be listed first in the search results.
  4. Click the Install Now link.
  5. Lastly click the Activate Plugin link to activate the plugin.

= Uploading in WordPress Admin =

  1. Download the plugin zip file and save it to your computer.
  2. Navigate to the Add New sub-page under the Plugins admin page.
  3. Click the Upload link.
  4. Select Easy Table of Contents zip file from where you saved the zip file on your computer.
  5. Click the Install Now button.
  6. Lastly click the Activate Plugin link to activate the plugin.

= Using FTP =

  1. Download the plugin zip file and save it to your computer.
  2. Extract the Easy Table of Contents zip file.
  3. Create a new directory named easy-table-of-contents directory in the ../wp-content/plugins/ directory.
  4. Upload the files from the folder extracted in Step 2.
  5. Activate the plugin on the Plugins admin page.

== Changelog ==

= 2.0.69 28/08/2024 =

= 2.0.68.1 21/07/2024 =

= 2.0.68 20/07/2024 =

= 2.0.67.1 19/06/2024 =

= 2.0.67 18/06/2024 =

= 2.0.66.1 15/05/2024 =

= 2.0.66 15/05/2024 =

= 2.0.65 10/04/2024 =

= 2.0.64 28/03/2024 =

= 2.0.63 02/03/2024 =

= 2.0.62 12/01/2024 =

= 2.0.61 13/12/2023 =

= 2.0.60 05/12/2023 =

Full changelog available at changelog.txt

== Frequently Asked Questions ==

= Ok, I've installed this... what do I do next? =

You first stop should be the Table of Contents settings admin page. You can find this under the Settings menu item.

You first and only required decision is you need to decide which post types you want to enable Table of Contents support for. By default it is the Pages post type. If on Pages is the only place you plan on using Table of Contents, you have nothing to do on the Settings page. To keep things simple, I recommend not changing any of the other settings at this point. Many of the other settings control when and where the table of contents is inserted and changing these settings could cause it not to display making getting started a bit more difficult. After you get comfortable with how this works... then tweak away :)

With that out of the way make sure to read the How are the tables of contents created? FAQ so you know how the Table of Contents is automatically generated. After you have the page headers setup, or before, either way... Scroll down on the page you'll see a metabox named "Table of Contents", enable the Insert table of contents. option and Update and/or Publish you page. The table of contents should automatically be shown at the top of the page.

= How are the tables of contents created? =

The table of contents is generated by the headers found on a page. Headers are the <h1>,<h2>,<h3>,<h4>,<h5>,<h6> HTML tags. If you are using the WordPres Visual Post Editor, these header tags are used and inserted into the post when you select one of the Heading n options from the formatting drop down. Each header that is found on the page will create a table of content item. Here's an example which will create a table of contents containing the six items.

`

Item 1

Item 2

Item 3

Item 4

Item 5

Item 6

` You can also create "nested" table of contents. This is difficult to explain so I'll illustrate building on the previous example. In this example a table of contents will be created with the same six items but now the first three will each an child item nested underneath it. The indentation is not necessary, it was only added for illustration purposes. `

Item 1

<h2>Item 1.1 -- Level 2</h2>

Item 2

<h2>Item 2.1 -- Level 2</h2>

Item 3

<h2>Item 3.1 -- Level 2</h2>

Item 4

Item 5

Item 6

` You are not limited to a single a single nested item either. You can add as many as you need. You can even create multiple nested levels... `

Item 1

<h2>Item 1.1 -- Level 2</h2>
    <h3>Item 1.1.1 -- Level 3</h3>
    <h3>Item 1.1.2 -- Level 3</h3>
    <h3>Item 1.1.3 -- Level 3</h3>
<h2>Item 1.2 -- Level 2</h2>
  <h3>Item 1.2.1 -- Level 3</h3>
  <h3>Item 1.2.2 -- Level 3</h3>
  <h3>Item 1.2.3 -- Level 3</h3>
<h2>Item 1.3 -- Level 2</h2>

Item 2

<h2>Item 2.1 -- Level 2</h2>
<h2>Item 2.2 -- Level 2</h2>

Item 3

<h2>Item 3.1 -- Level 2</h2>
<h2>Item 3.2 -- Level 2</h2>

Item 4

Item 5

Item 6

` You can nest up 6 levels deep if needed. I hope this helps you understand how to create and build your own auto generated table of contents on your sites! = Is there any shortcode to add the table of content to anywhere I want ? = Yes you can add the TOC with this shortcode - [ez-toc] and with the help of this you can easily add the TOC in the content or anywhere in the WordPress and if you want to add the shortcode on the theme file then you can add it with the help of this code - and with this, you can add the TOC on any file according to your need. == Contact | Help | Technical Support == [Contact Us](https://tocwp.com/contact/) == Upgrade Notice == = 1.0 = Initial release. = 1.3 = Requires WordPress >= 4.4 and PHP >= 5.3. PHP version >= 7.1 recommended. = 1.4 = Requires WordPress >= 4.4 and PHP >= 5.3. PHP version >= 7.1 recommended. = 1.5 = Requires WordPress >= 4.4 and PHP >= 5.3. PHP version >= 7.1 recommended. = 1.6 = Requires WordPress >= 4.4 and PHP >= 5.3. PHP version >= 7.1 recommended. = 1.6.1 = Requires WordPress >= 4.4 and PHP >= 5.3. PHP version >= 7.1 recommended. = 1.7 = Requires WordPress >= 4.4 and PHP >= 5.3. PHP version >= 7.1 recommended. = 2.0-rc4 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.1 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.2 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.3 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.4 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.5 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.6 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.7 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.8 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.9 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.10 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.11 = Requires WordPress >= 5.0 and PHP version >= 5.6.20 (>= 7.1 is recommended). = 2.0.12 = Requires WordPress >= 5.3 and PHP version >= 5.6.20 (>= 7.4 is recommended). = 2.0.13 = Requires WordPress >= 5.3 and PHP version >= 5.6.20 (>= 7.4 is recommended). = 2.0.14 = Requires WordPress >= 5.3 and PHP version >= 5.6.20 (>= 7.4 is recommended). = 2.0.15 = Requires WordPress >= 5.3 and PHP version >= 5.6.20 (>= 7.4 is recommended). = 2.0.16 = Requires WordPress >= 5.3 and PHP version >= 5.6.20 (>= 7.4 is recommended). = 2.0.17 = Requires WordPress >= 5.3 and PHP version >= 5.6.20 (>= 7.4 is recommended).