simpletoc / readme.txt

readme.txt in SimpleTOC – Table of Contents Block 7.1.1, at readme.txt

168 lines 8.8 KB

Raw Download Zip

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.0
6	Stable tag: 7.1.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 for the TOC with a default gray background.
46	* Style SimpleTOC with Gutenberg's native group styling options.
47	* Inherits the style of your theme.
48	* Smooth scrolling effect using CSS.
49	* Accessibility built-in by following web standards.
50	* Optional ARIA Label and navigation role attributes.
51	* Translated in [multiple languages](https://translate.wordpress.org/projects/wp-plugins/simpletoc/). Including German, Japanese, Chinese (Taiwan), Dutch, Brazilian Portuguese, French, Spanish and Latvia.
52	* Ideal for creating a Frequently Asked Questions section on your website.
53
54	= Customization =
55
56	* Administrators can utilize global settings to supersede the individual block settings.
57	* Add background and text color with Gutenberg groups.
58	* Native block support for wide and full width.
59	* Control the maximum depth of the headings.
60	* Choose between an ordered, bullet HTML list. Or indent the list.
61	* Enable a box style and choose a box color directly in the block sidebar.
62	* Select a heading level or turn it into a paragraph.
63	* Disable the h2 heading of the TOC block and add your own.
64
65	= Compatibility =
66
67	* GeneratePress and Rank Math support.
68	* Works with popular AMP plugins.
69
70	= How to contribute =
71
72	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.
73
74	== Changelog ==
75	= 7.1.1 =
76	* Fixed: Prevented WordPress HTML API notices when nested block content is not a string.
77	* Fixed: Escaped TOC links and titles before rendering them.
78	* Fixed: Preserved legacy SimpleTOC block validity in the WordPress editor.
79
80	= 7.1.0 =
81	* Fixed: Avoid DOMDocument HTML parsing for highlighted heading markup by using the WordPress HTML API.
82	* Changed: Minimum required WordPress version is now 6.2.
83	* Added: PHPUnit coverage for core rendering helpers and an editor e2e smoke test.
84
85	= 7.0.10 =
86	* Fixed: Prevent the SimpleTOC editor preview from collapsing during WordPress autosaves.
87	* Changed: Automatic editor refresh now runs after manual post saves and keeps the previous TOC visible while updating.
88
89	= 7.0.9 =
90	* Fixed: Restored WordPress 7.0 editor previews for existing SimpleTOC blocks that contain legacy editor-only attributes.
91	* Fixed: The "Hide SimpleTOC" editor toggle no longer stores a redundant helper attribute.
92
93	= 7.0.8 =
94	* Fixed: Prevent editor preview errors when another plugin adds editor-only attributes to blocks, for example Noted! block notes. Thanks Hans-Gerd Gerhards (@hage).
95
96	== Installation ==
97
98	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...
99
100	In Gutenberg, add a block and search for "SimpleTOC" or just "TOC". Please save your content before you use the block.
101
102	== Frequently Asked Questions ==
103
104	= Configuring Global Settings in SimpleTOC =
105
106	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.
107
108	= How do I add a background color to SimpleTOC using Gutenberg groups? =
109
110	Select the block and select "group" in the context menu. Apply "background color", "link color" and "text color" to this group. SimpleTOC will inherit these styles. You would like to use this styled SimpleTOC group next time you write a post? Convert it to a reusable block.
111
112	= How to exclude a single heading from the TOC? =
113
114	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?
115
116	= I would like to save my SimpleTOC settings as default. Is that possible? =
117
118	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.
119
120	= How to add a div tag wrapper to the TOC? =
121
122	If you add a custom class to the SimpleTOC block in "Advanced" and then "Additional CSS Class(es)" a div with that class will be wrapped around the HTML output.
123
124	= How to allow developers to exclude specific headings programmatically? =
125
126	Use the 'simpletoc_excluded_blocks' filter. For example, this code will exclude heading blocks that are inside a column block.
127
128	Example:
129
130	add_filter( 'simpletoc_excluded_blocks', function ( array $blocks ) {
131	$blocks[] = 'core/column';
132
133	return $blocks;
134	} );
135
136
137	= How do I change the color of the accordion menu? =
138
139	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.
140
141	.simpletoc-collapsible::after {
142	content: "✖";
143	color: #e94c89;
144	}
145
146	= How do I add SimpleTOC to all articles automatically? =
147
148	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.
149
150	== Screenshots ==
151	1. SimpleTOC block in Gutenberg editor.
152	2. SimpleTOC in the post.
153	3. Simple but powerful. Customize each TOC as you like.
154	4. Control the maximum depth of the headings.
155	5. SimpleTOC styled with Gutenbergs native group styles.
156	6. SimpleTOC Advanced Features
157	7. Gutenberg Heading block: Set a custom anchor
158	8. SimpleTOC hidden in the accordion menu.
159	9. SimpleTOC global settings.
160
161	== Credits ==
162
163	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
164
165	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!
166
167	Thanks to Quintus Valerius Soranus for inventing the Table of Contents around 100 BC.
168