HTML Page Sitemap (Block and Shortcode) vs SimpleTOC – Table of Contents Block

This simple plugin adds an HTML (Not XML) sitemap of your pages (not posts) by using the shortcode [html_sitemap]. This plugin can display a sitemap with specific depths, from a specific parent page and include/exclude specific pages by ID. The sitemap uses the unordered HTML list tags and . New for 2.0 is the HTML Sitemap Block, now you can add a HTML Sitemap using the WordPress Block Editor. Attributes include sort_column, sort_order, exclude, include, depth, child_of, meta_key, meta_value, authors, number, offset, post_type, and post_status parameters from the wp_list_pages function. In addition you can also set class, id, and ordered_list_type to further customize the html page sitemap. This plugin is perfect for those who use WordPress as a CMS. Block / Shortcode Tag Attribute Options The following wp_list_pages tag attribute options are supported: authors — Comma-separated list of author IDs. Default empty (all authors). child_of — ID of child page, ‘CURRENT’, or ‘PARENT’. The value ‘CURRENT’ will use the current page ID. The value ‘PARENT’ will use the current page parent ID. depth — -1 (any depth), 0 (all pages), 1 (top-level pages only), 2 (top-level and 2nd level pages only), etc. date_format — e.g. ‘l, F j, Y’. See WordPress Date Format exclude — Comma-separated list of page IDs to exclude. include — Comma-separated list of page IDs to include. item_spacing — Whether to preserve whitespace within the menu’s HTML. Accepts ‘preserve’ or ‘discard’. meta_key — Limits output to pages having a specific custom field key. meta_value — Limits output to pages having a specific custom field value. number — Limits the number of links displayed (SQL LIMIT). offset — Skips a specific number of pages before displaying the list. post_type — Post type to query for. Default ‘page’ post_status — Comma-separated list or array of post statuses to include. Default ‘publish’ show_date — Whether to display the page publish or modified date for each page. Accepts ‘modified’ or any other value. An empty value hides the date. sort_column — Comma-separated list of column names to sort the pages by. Accepts ‘post_author’, ‘post_date’, ‘post_title’, ‘post_name’, ‘post_modified’, ‘post_modified_gmt’, ‘menu_order’, ‘post_parent’, ‘ID’, ‘rand’, or ‘comment_count’. Default ‘menu_order, post_title’. sort_order — ‘ASC’ or ‘DESC’. Default ‘ASC’. Please see documentation for the wp_list_pages function for reference. Demos Demo of the HTML Sitemap Block Demo of the HTML Sitemap shortcode In addition the following tag attributes are available exclusively for this plugin: class — Specify class values for the initial HTML Page Sitemap list tag. id — Specify ID values for the initial HTML Page Sitemap list tag. ordered_list_type — Specify the ordered list type. Accepts ”, ‘1’, ‘A’, ‘a’, ‘I’, and ‘i’. Default empty value will display an unordered list. The ordered_list_type attribute options in more detail: ordered_list_type="" — The list items will be unordered ordered_list_type="1" — The list items will be numbered with numbers ordered_list_type="A" — The list items will be numbered with uppercase letters ordered_list_type="a" — The list items will be numbered with lowercase letters ordered_list_type="I" — The list items will be numbered with uppercase roman numbers ordered_list_type="i" — The list items will be numbered with lowercase roman numbers Note: This plugin only works with Hierarchical Custom Post Types such as pages. This plugin will not work if your post type is not hierarchical. Not setting an ordered_list_type will use an unordered list (default). Examples First example shows how to add a sitemap for the entire site. [html_sitemap] Example shortcode will add a sitemap to a page displaying a depth limit of 3 and exclude page ID 708. [html_sitemap depth=3 exclude=708] Example shortcode will add a sitemap to a page displaying only children and grandchildren of the current page. [html_sitemap depth=2 child_of=CURRENT] Example shortcode will add a sitemap to a page displaying children and grandchildren of the parent page (would include the curent page as well). [html_sitemap depth=2 child_of=PARENT] Example shortcode will add a sitemap displaying the page modified date with the pages sorted by the menu order number. [html_sitemap show_date=modified sort_column=menu_order] Example shortcode excluding multiple pages with ids 708, 1024 and 42. [html_sitemap exclude="708,1024,42"] Example shortcode will add a class attribute to the tag. [html_sitemap class="custom-class"] Example shortcode will add an id attribute to the tag. [html_sitemap id="custom-element-id"] Example shortcode will display an ordered list using lowercase letters with a depth of 1. [html_sitemap ordered_list_type="a" depth=1] Example shortcode with roman numbering in capitalization, with custom field “featured-list” and custom value “yes” [html_sitemap ordered_list_type="I" meta_key=featured-list meta_value=yes sort_column=post_date] For the latest information visit the website. http://www.pluginspodcast.com/plugins/html-page-sitemap/ Contributors Angelo Mandato, founder of Painless Analytics and FrontPup – Plugin author

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”. 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. Spin up a new WordPress instance with the SimpleTOC plugin already installed. User Feedback “It is lightweight, stable, and fully compatible with WordPress Full Site Editing. A reliable solution that integrates seamlessly and performs exactly as expected.” — @js100 on wordpress.org “Does the job perfectly, and adds no bloat.” — @clicknathan on wordpress.org “Simple yet powerful. Great plugin that does exactly what you need.” — @mixey on wordpress.org Accessibility 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 and we’ll try to address it promptly. Hidden TOCs use native and semantics without extra ARIA references that require custom IDs. Features Designed for Gutenberg. Zero configuration: Add the SimpleTOC block to your post and that’s it. Minimal and valid HTML output. Utilizes the browser’s built-in details tag for a collapsible interface. No JavaScript or CSS by default. Optional features such as the accordion menu, smooth scrolling, or box style add minimal assets only when enabled. Optional Box style in Gutenberg’s Styles tab with a default gray background. Native text, link, background, spacing, and typography controls. Global block styling through theme.json. Inherits the style of your theme. Smooth scrolling effect using CSS. Accessibility built-in by following web standards. Standard Gutenberg block wrapper with navigation role and ARIA label attributes. Translated in multiple languages. Including German, Japanese, Chinese (Taiwan), Dutch, Brazilian Portuguese, French, Spanish and Latvia. Ideal for creating a Frequently Asked Questions section on your website. Customization Administrators can utilize global settings to supersede the individual block settings. Set text, link, and background colors in Gutenberg’s Styles tab. Native block support for wide and full width. Set vertical margins and padding with native spacing controls. Control the maximum depth of the headings. Choose between an ordered, bullet HTML list. Or indent the list. Select the Box style directly in Gutenberg’s Styles tab. Select a heading level or turn it into a paragraph. Disable the h2 heading of the TOC block and add your own. Compatibility GeneratePress and Rank Math support. Works with popular AMP plugins. How to contribute SimpleTOC is open-source and developed on GitHub Pages. If you find a bug or have an idea for a feature please feel free to contribute and create a pull request. Credits Many thanks to Tom J Nowell and and Sally CJ who both helped me a lot with my questions over at wordpress.stackexchange.com And many more thanks to all the developers on GitHub who helped me making SimpleTOC what it is today! Thanks to Quintus Valerius Soranus for inventing the Table of Contents around 100 BC.