Title: Shortcode Table of Contents Author: jamesckemp Published: 2017 年 11 月 29 日 Last modified: 2018 年 7 月 31 日 --- 搜索插件 ![](https://ps.w.org/shortcode-toc/assets/banner-772x250.png?rev=1778245) **该插件尚未通过WordPress的最新3个主要版本进行测试**。 当与较新版本的WordPress一起 使用时，可能不再受到维护或支持，并且可能会存在兼容性问题。 ![](https://ps.w.org/shortcode-toc/assets/icon-256x256.png?rev=1778245) # Shortcode Table of Contents 作者：[jamesckemp](https://profiles.wordpress.org/jamesckemp/) [下载](https://downloads.wordpress.org/plugin/shortcode-toc.zip) * [详情](https://cn.wordpress.org/plugins/shortcode-toc/#description) * [评价](https://cn.wordpress.org/plugins/shortcode-toc/#reviews) * [安装](https://cn.wordpress.org/plugins/shortcode-toc/#installation) * [开发进展](https://cn.wordpress.org/plugins/shortcode-toc/#developers) [支持](https://wordpress.org/support/plugin/shortcode-toc/) ## 描述 Simply use the `[toc content=".your-container"]` shortcode to automatically generate a table of contents for any HTML container. The shortcode accepts a number of parameters: * `content` _string_ **required** A CSS selector indicating the container of your content. * `headers` _string_ A comma separated list of heading selectors that you want to include. * `speed` _int_ Speed of sliding back to top. * `anchor-class` _string_ Class of anchor links. * `anchor-text` _string_ Prepended or appended to anchor headings. Leave blank to disable anchor links. * `top_class` _string_ Back to top button or link class. * `spy` _true/false_ Enable scroll spy. This will highlight the list items as you scroll past them. * `position` _append/prepend_ Position of anchor text. * `spy-offset` _int_ Specify heading offset for spy scrolling. ## 屏幕截图 * [[ * Add the `[toc]` shortcode to any post/page/custom-post-type, at any position in the content. * [[ * A nested list will be generated based on the headings within your chosen HTML element. * [[ * Add the `anchor-text` parameter. * [[ * When the `anchor-text` parameter is set, the text will be appended to your headings so your users can easily copy the link to that section. ## 安装 1. Upload the plugin files to the `/wp-content/plugins/shortcode-toc` directory, or install the plugin through the WordPress plugins screen directly. 2. Activate the plugin through the ‘Plugins’ screen in WordPress ## 常见问题 Installation Instructions 1. Upload the plugin files to the `/wp-content/plugins/shortcode-toc` directory, or install the plugin through the WordPress plugins screen directly. 2. Activate the plugin through the ‘Plugins’ screen in WordPress Can I use the shortcode multiple times on a page? No. Currently it’ll only work once per page. The table of contents isn’t showing up. Did you set the `content` parameter of the shortcode to a valid CSS selector on your page? This is a required argument. Can I build a table of contents for just h2 and h3 tags? Yup, your shortcode would look like this `[toc content=".your-container" headers ="h2,h3"]` Is there a PHP version of the shortcode? You can use the `do_shortcode()` function like this: ``` ``` ## 评价 ![](https://secure.gravatar.com/avatar/ec90659e38270e106cb6c0b4ee0c3a35a735ed8b76aff7c0d3cc5dbdb4f48378? s=60&d=retro&r=g) ### 󠀁[No cyrillic](https://wordpress.org/support/topic/no-cyrillic-3/)󠁿 [hlammm](https://profiles.wordpress.org/hlammm/) 2019 年 2 月 26 日 It does not work if the site is in Cyrillic. ![](https://secure.gravatar.com/avatar/8e95c0528a1959250adbcf5d38b78b8b4ddbbacc1410e786f1a23d6c4271bea2? s=60&d=retro&r=g) ### 󠀁[Filter shortcode presets](https://wordpress.org/support/topic/filter-shortcode-presets/)󠁿 [nenontwerp](https://profiles.wordpress.org/nenontwerp/) 2018 年 10 月 28 日 Great simple plugin! There are no filters available to set shortcode defaults. My clients dont know the right class names to set the parameter ‘content’. So if you want to set the default class for ‘content’ or set the default set of headers, use filter ‘shortcode_atts_{shortcode}’. This way you the shortcode get much cleaner like ‘[toc]’. If the parameters in the shortcode are set, the default are over ruled. Filter like: add_action('shortcode_atts_toc','nen_shortcode_atts_toc'); function nen_shortcode_atts_toc( $out ) { if( isset( $out['content'] ) && empty( $out['content'])) $out['content'] = '.entry-content'; if( isset( $out['headers'] ) && $out['headers'] == 'h1, h2, h3, h4, h5, h6' ) $out['headers'] = 'h2, h3, h4'; return $out; } Hopefully James Kemp can apply a filter to add custom content before and/or after the div ‘ shortcode-toc’. This way we can add a custom toc-header or something. Thanx! ![](https://secure.gravatar.com/avatar/d97589e1287a4c27a39be552da7473323c1e697a9a6abf2d18d81935e5debfd5? s=60&d=retro&r=g) ### 󠀁[So simple and useful! Does what it promises 🙂 Thx bro!](https://wordpress.org/support/topic/so-simple-and-useful-does-what-it-promises-thx-bro/)󠁿 [smith64fx](https://profiles.wordpress.org/smith64fx/) 2018 年 8 月 30 日 I’m really happy with it ^^ ![](https://secure.gravatar.com/avatar/524156a645b53e512d163867db3acf844fcff4c68d44feced01e13041e0acad4? s=60&d=retro&r=g) ### 󠀁[Just what I need](https://wordpress.org/support/topic/just-what-i-need-94/)󠁿 [resident82](https://profiles.wordpress.org/resident82/) 2018 年 6 月 2 日 I needed to make navigation for posts, and this is a ready-made automated solution. Many thanks. ![](https://secure.gravatar.com/avatar/a4f72aa0ad82961554b9ecfa3201df9d41fc777704856ff00b710363284e0b4d? s=60&d=retro&r=g) ### 󠀁[Lightweight & versatile](https://wordpress.org/support/topic/lightweight-versatile/)󠁿 [](https://profiles.wordpress.org/t4tsu/) 2017 年 12 月 28 日 1 回复 Very lightweight and at the same time versatile enough with useful options. ![](https://secure.gravatar.com/avatar/ef861245e900fd7b6cfdab595980ad7597ea6f9973c4fc0a9dca3afbbf5c223b? s=60&d=retro&r=g) ### 󠀁[the best TOC](https://wordpress.org/support/topic/the-best-toc/)󠁿 [drweby2](https://profiles.wordpress.org/drweby2/) 2017 年 12 月 26 日 1 回复 the best TOC [ 阅读所有6条评价 ](https://wordpress.org/support/plugin/shortcode-toc/reviews/) ## 贡献者及开发者 「Shortcode Table of Contents」是开源软件。 以下人员对此插件做出了贡献。 贡献者 * [ jamesckemp ](https://profiles.wordpress.org/jamesckemp/) [帮助将「Shortcode Table of Contents」翻译成简体中文。](https://translate.wordpress.org/projects/wp-plugins/shortcode-toc) ### 对开发感兴趣吗? 您可以[浏览代码](https://plugins.trac.wordpress.org/browser/shortcode-toc/)，查看 [SVN仓库](https://plugins.svn.wordpress.org/shortcode-toc/)，或通过[RSS](https://plugins.trac.wordpress.org/log/shortcode-toc/?limit=100&mode=stop_on_copy&format=rss) 订阅[开发日志](https://plugins.trac.wordpress.org/log/shortcode-toc/)。 ## 更新日志 **v1.0.3 (31/07/2018)** [fix] Revert back to original anchorific. Bower one was an old version. **v1.0.2 (01/12/2017)** [update] Use latest anchorific. **v1.0.1 (30/11/2017)** [update] Remove anchor text by default. [fix] Ensure ‘spy’ param works with true/false values. **v1.0.0 (29/11/2017)** [release] Initial release. ## 额外信息 * 版本 **1.0.3** * 最后更新：**8 年前** * 活跃安装数量 **300+** * WordPress 版本 ** 4.0 或更高版本 ** * 已测试的最高版本为 **4.9.29** * 语言 * [English (US)](https://wordpress.org/plugins/shortcode-toc/) * 标签 * [anchors](https://cn.wordpress.org/plugins/tags/anchors/)[table of contents](https://cn.wordpress.org/plugins/tags/table-of-contents/) [toc](https://cn.wordpress.org/plugins/tags/toc/) * [高级视图](https://cn.wordpress.org/plugins/shortcode-toc/advanced/) ## 评级 4.7 星（最高 5 星）。 * [ 5 条 5 星评价 ](https://wordpress.org/support/plugin/shortcode-toc/reviews/?filter=5) * [ 0 条 4 星评价 ](https://wordpress.org/support/plugin/shortcode-toc/reviews/?filter=4) * [ 1 条 3 星评价 ](https://wordpress.org/support/plugin/shortcode-toc/reviews/?filter=3) * [ 0 条 2 星评价 ](https://wordpress.org/support/plugin/shortcode-toc/reviews/?filter=2) * [ 0 条 1 星评价 ](https://wordpress.org/support/plugin/shortcode-toc/reviews/?filter=1) [Your review](https://wordpress.org/support/plugin/shortcode-toc/reviews/#new-post) [查看全部评论](https://wordpress.org/support/plugin/shortcode-toc/reviews/) ## 贡献者 * [ jamesckemp ](https://profiles.wordpress.org/jamesckemp/) ## 支持 有话要说吗？是否需要帮助？ [查看支持论坛](https://wordpress.org/support/plugin/shortcode-toc/) ## 捐助 您愿意支持这个插件的发展吗? [ 捐助此插件 ](https://www.paypal.me/jamesckemp/)