| 1 |
=== SimpleTOC - Table of Contents Block === |
| 2 |
Contributors: MarcDK |
| 3 |
Tags: TOC, Table of Contents, Block, Accessibility, Table |
| 4 |
Requires at least: 6.2 |
| 5 |
Tested up to: 7.1 |
| 6 |
Stable tag: 7.3.1 |
| 7 |
Requires PHP: 7.3 |
| 8 |
License: GPLv2 or later |
| 9 |
License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 10 |
Donate link: https://marc.tv/out/donate |
| 11 |
|
| 12 |
SEO-friendly Table of Contents Gutenberg block. No JavaScript or CSS by default. |
| 13 |
|
| 14 |
== Description == |
| 15 |
|
| 16 |
Add a Table of Contents block to your posts and pages. The TOC is a nested list of links to all heading found in the post or page. To use it, simply add a block and search for "SimpleTOC" or just "TOC". |
| 17 |
|
| 18 |
The maximum depth of the toc can be configured in in the blocks' sidebar among many other options. There can hide the headline "Table of Contents" and add your own by using a normal heading block. |
| 19 |
|
| 20 |
[Spin up](https://demo.tastewp.com/simpletoc) a new WordPress instance with the SimpleTOC plugin already installed. |
| 21 |
|
| 22 |
= User Feedback = |
| 23 |
|
| 24 |
> "It is lightweight, stable, and fully compatible with WordPress Full Site Editing. A reliable solution that integrates seamlessly and performs exactly as expected." |
| 25 |
— [@js100 on wordpress.org](https://wordpress.org/support/topic/good-job-1889/) |
| 26 |
|
| 27 |
> "Does the job perfectly, and adds no bloat." |
| 28 |
— [@clicknathan on wordpress.org](https://wordpress.org/support/topic/does-the-job-perfectly-and-adds-no-bloat/) |
| 29 |
|
| 30 |
> "Simple yet powerful. Great plugin that does exactly what you need." |
| 31 |
— [@mixey on wordpress.org](https://wordpress.org/support/topic/simple-yet-powerful-106/) |
| 32 |
|
| 33 |
= Accessibility = |
| 34 |
|
| 35 |
This plugin is designed & developed for WCAG 2.2 level AA conformance. The plugin is tested with assistive technology and intended to be accessible, however some third party plugins or themes may affect the individual accessibility on a given website. If you find an accessibility issue, please [let us know](https://github.com/mtoensing/simpletoc/issues) and we'll try to address it promptly. |
| 36 |
Hidden TOCs use native `<details>` and `<summary>` semantics without extra ARIA references that require custom IDs. |
| 37 |
|
| 38 |
= Features = |
| 39 |
|
| 40 |
* Designed for Gutenberg. |
| 41 |
* Zero configuration: Add the SimpleTOC block to your post and that's it. |
| 42 |
* Minimal and valid HTML output. |
| 43 |
* Utilizes the browser's built-in details tag for a collapsible interface. |
| 44 |
* No JavaScript or CSS by default. Optional features such as the accordion menu, smooth scrolling, or box style add minimal assets only when enabled. |
| 45 |
* Optional Box style in Gutenberg's Styles tab with a default gray background. |
| 46 |
* Native text, link, background, spacing, and typography controls. |
| 47 |
* Global block styling through theme.json. |
| 48 |
* Inherits the style of your theme. |
| 49 |
* Smooth scrolling effect using CSS. |
| 50 |
* Accessibility built-in by following web standards. |
| 51 |
* Standard Gutenberg block wrapper with navigation role and ARIA label attributes. |
| 52 |
* Translated in [multiple languages](https://translate.wordpress.org/projects/wp-plugins/simpletoc/). Including German, Japanese, Chinese (Taiwan), Dutch, Brazilian Portuguese, French, Spanish and Latvia. |
| 53 |
* Ideal for creating a Frequently Asked Questions section on your website. |
| 54 |
|
| 55 |
= Customization = |
| 56 |
|
| 57 |
* Administrators can utilize global settings to supersede the individual block settings. |
| 58 |
* Set text, link, and background colors in Gutenberg's Styles tab. |
| 59 |
* Native block support for wide and full width. |
| 60 |
* Set vertical margins and padding with native spacing controls. |
| 61 |
* Control the maximum depth of the headings. |
| 62 |
* Choose between an ordered, bullet HTML list. Or indent the list. |
| 63 |
* Select the Box style directly in Gutenberg's Styles tab. |
| 64 |
* Select a heading level or turn it into a paragraph. |
| 65 |
* Disable the h2 heading of the TOC block and add your own. |
| 66 |
|
| 67 |
= Compatibility = |
| 68 |
|
| 69 |
* GeneratePress and Rank Math support. |
| 70 |
* Works with popular AMP plugins. |
| 71 |
|
| 72 |
= How to contribute = |
| 73 |
|
| 74 |
SimpleTOC is open-source and developed on [GitHub Pages](https://github.com/mtoensing/SimpleTOC). If you find a bug or have an idea for a feature please feel free to contribute and create a pull request. |
| 75 |
|
| 76 |
== Changelog == |
| 77 |
= 7.3.1 = |
| 78 |
* Fixed: Heading anchors for non-Latin scripts (Japanese, Chinese, Korean, Cyrillic, etc.) were double URL-encoded, breaking externally shared or hand-written fragment links. Props to the reporter of issue #89. |
| 79 |
|
| 80 |
= 7.3.0 = |
| 81 |
* Changed: Box is now a native Gutenberg block style in the Styles tab. |
| 82 |
* Added: Native text, link, background color, margin, and padding controls. |
| 83 |
* Added: theme.json styling support for colors, spacing, and typography. |
| 84 |
* Added: WordPress 7.1 support and automated compatibility tests. |
| 85 |
* Changed: Existing box-style blocks and the global Force box style setting remain compatible. |
| 86 |
* Thanks: Lovro Hrust (@lovor) for the theme.json and block styling feedback. |
| 87 |
|
| 88 |
== Installation == |
| 89 |
|
| 90 |
SimpleTOC can be found and installed via the Plugin menu within WordPress administration (Plugins -> Add New). Alternatively, it can be downloaded from WordPress.org and installed manually... |
| 91 |
|
| 92 |
In Gutenberg, add a block and search for "SimpleTOC" or just "TOC". Please save your content before you use the block. |
| 93 |
|
| 94 |
== Frequently Asked Questions == |
| 95 |
|
| 96 |
= Configuring Global Settings in SimpleTOC = |
| 97 |
|
| 98 |
SimpleTOC allows you to configure global settings for your WordPress website. These settings can be enforced globally, overriding any block-level configurations that may exist. To access these settings, navigate to the SimpleTOC section of the WordPress Settings. |
| 99 |
|
| 100 |
= How do I add colors or the Box style to SimpleTOC? = |
| 101 |
|
| 102 |
Select the SimpleTOC block and open Gutenberg's Styles tab. Choose the Box style or use the native color controls to set text, link, and background colors. Native spacing controls are available for vertical margins and padding. |
| 103 |
|
| 104 |
= How to exclude a single heading from the TOC? = |
| 105 |
|
| 106 |
If you really want to hide a single heading from the table of contents, then add the CSS class "simpletoc-hidden" to a heading block. You can find this field in the same place as the HTML anchor field: In the Block > Advanced sidebar. But first, think about the reason you would like to hide a specific heading. Maybe you would like to remove all headings of a specific depth level. Then there is an option for that in the blocks options in Gutenberg. If you think this heading should not be part of the toc perhaps it is not needed in the post itself? |
| 107 |
|
| 108 |
= I would like to save my SimpleTOC settings as default. Is that possible? = |
| 109 |
|
| 110 |
You can convert your configured SimpleTOC block into a reusable block in Gutenberg. It will keep its settings. This way, you can use your desired settings for each new post by adding the reusable block. |
| 111 |
|
| 112 |
= How can I style SimpleTOC through theme.json? = |
| 113 |
|
| 114 |
Add styles for the `simpletoc/toc` block to your theme.json. SimpleTOC uses the standard Gutenberg block wrapper and supports native colors, vertical margins, padding, font size, and line height settings. |
| 115 |
|
| 116 |
The following example sets default colors, spacing, and typography for every SimpleTOC block: |
| 117 |
|
| 118 |
{ |
| 119 |
"$schema": "https://schemas.wp.org/trunk/theme.json", |
| 120 |
"version": 3, |
| 121 |
"styles": { |
| 122 |
"blocks": { |
| 123 |
"simpletoc/toc": { |
| 124 |
"color": { |
| 125 |
"background": "#f5f5f5", |
| 126 |
"text": "#1e1e1e" |
| 127 |
}, |
| 128 |
"elements": { |
| 129 |
"link": { |
| 130 |
"color": { |
| 131 |
"text": "#0057b8" |
| 132 |
} |
| 133 |
} |
| 134 |
}, |
| 135 |
"spacing": { |
| 136 |
"margin": { |
| 137 |
"top": "1.5rem", |
| 138 |
"bottom": "1.5rem" |
| 139 |
}, |
| 140 |
"padding": { |
| 141 |
"top": "1rem", |
| 142 |
"right": "1rem", |
| 143 |
"bottom": "1rem", |
| 144 |
"left": "1rem" |
| 145 |
} |
| 146 |
}, |
| 147 |
"typography": { |
| 148 |
"fontSize": "1rem", |
| 149 |
"lineHeight": "1.6" |
| 150 |
} |
| 151 |
} |
| 152 |
} |
| 153 |
} |
| 154 |
} |
| 155 |
|
| 156 |
Replace the example values with your theme's values or preset variables. Selecting the Box style adds the standard `is-style-boxed` class. |
| 157 |
|
| 158 |
= How to allow developers to exclude specific headings programmatically? = |
| 159 |
|
| 160 |
Use the 'simpletoc_excluded_blocks' filter. For example, this code will exclude heading blocks that are inside a column block. |
| 161 |
|
| 162 |
Example: |
| 163 |
|
| 164 |
add_filter( 'simpletoc_excluded_blocks', function ( array $blocks ) { |
| 165 |
$blocks[] = 'core/column'; |
| 166 |
|
| 167 |
return $blocks; |
| 168 |
} ); |
| 169 |
|
| 170 |
|
| 171 |
= How do I change the color of the accordion menu? = |
| 172 |
|
| 173 |
The heavy plus character I used can not be colored with css without hacks. But you can change the icon to something else and change the color of the new icon. |
| 174 |
|
| 175 |
.simpletoc-collapsible::after { |
| 176 |
content: "✖"; |
| 177 |
color: #e94c89; |
| 178 |
} |
| 179 |
|
| 180 |
= How do I add SimpleTOC to all articles automatically? = |
| 181 |
|
| 182 |
I don’t see an easy solution at the moment. SimpleTOC is only a block that can be placed in your post. If there was a plugin that adds blocks to every post, then this would be the solution. I think this should be another separate plug-in to keep the code of SimpleTOC clean and … well, simple. |
| 183 |
|
| 184 |
== Screenshots == |
| 185 |
1. SimpleTOC block in Gutenberg editor. |
| 186 |
2. SimpleTOC in the post. |
| 187 |
3. Simple but powerful. Customize each TOC as you like. |
| 188 |
4. Control the maximum depth of the headings. |
| 189 |
5. SimpleTOC styled with Gutenbergs native group styles. |
| 190 |
6. SimpleTOC Advanced Features |
| 191 |
7. Gutenberg Heading block: Set a custom anchor |
| 192 |
8. SimpleTOC hidden in the accordion menu. |
| 193 |
9. SimpleTOC global settings. |
| 194 |
|
| 195 |
== Credits == |
| 196 |
|
| 197 |
Many thanks to [Tom J Nowell](https://tomjn.com) and and Sally CJ who both helped me a lot with my questions over at wordpress.stackexchange.com |
| 198 |
|
| 199 |
And many more thanks to all the [developers on GitHub](https://github.com/mtoensing/simpletoc/graphs/contributors) who helped me making SimpleTOC what it is today! |
| 200 |
|
| 201 |
Thanks to Quintus Valerius Soranus for inventing the Table of Contents around 100 BC. |
| 202 |
|
