Table of Contents Plus

Beschreibung

A powerful yet user friendly plugin that automatically creates a context specific index or table of contents (TOC) for long pages (and custom post types). More than just a table of contents plugin, this plugin can also output a sitemap listing pages and/or categories across your entire site.

Built from the ground up and with Wikipedia in mind, the table of contents by default appears before the first heading on a page. This allows the author to insert lead-in content that may summarise or introduce the rest of the page. It also uses a unique numbering scheme that doesn’t get lost through CSS differences across themes.

This plugin is a great companion for content rich sites such as content management system oriented configurations. That said, bloggers also have the same benefits when writing long structured articles.

Enthält ein Administrations-Dashboard, in dem Einstellungen wie die Anzeigeposition, die Mindestanzahl der Überschriften vor der Anzeige eines Index, andere Erscheinungsformen und vieles mehr angepasst werden können. Als professionelle Benutzer können Sie die erweiterten Optionen anwenden, um ihr Verhalten weiter zu optimieren – z. B.: Ausschließen unerwünschter Überschriftenebenen wie h5 und h6 von der Aufnahme; Deaktivieren der Ausgabe der enthaltenen CSS-Datei; Anpassen des oberen Offsets und mehr. Mit Hilfe von Shortcodes kann das Standardverhalten, wie z. B. spezielle Ausschlüsse auf einer bestimmten Seite, überschrieben oder sogar das Inhaltsverzeichnis ganz ausblendet werden.

Möchten Sie den Index lieber in die Sidebar aufnehmen? Gehe zu Design > Widgets und ziehen Sie den TOC+ in die gewünschte Sidebar und Position.

Individuelle Inhaltstypen werden unterstützt, jedoch funktioniert die automatische Einfügung nur, wenn the_content() vom individuellen Inhaltstyp verwendet wurde. Jeder Beitragstyp wird im Optionenbereich angezeigt, also aktiviere die gewünschten.

Collaborate, participate, fork this plugin on Github.

Shortcodes

Das Plugin wurde so einfach und unkompliziert wie möglich gestaltet und erfordert keinen Einsatz eines Shortcodes für die Bedienung. Die Verwendung des Shortcodes ermöglicht es jedoch, die Position des Inhaltsverzeichnisses innerhalb der Seite vollständig zu steuern. Die folgenden Shortcodes sind mit diesem Plugin verfügbar.

Wenn Attribute für die unten stehenden Shortcodes weggelassen werden, fallen sie auf die Standard-Einstellungen zurück, die Sie unter Einstellungen > TOC+ definiert haben. Die folgenden Punkte werden im Hilfe-Tab erläutert.

[toc]

Ermöglicht das Erstellen des Inhaltsverzeichnisses an der bevorzugten Position. Nützlich für Websites, die nur ein Inhaltsverzeichnis auf einer kleinen Handvoll Seiten benötigen. Unterstützt die folgenden Attribute:

  • „label“: text, title of the table of contents
  • „no_label“: true/false, shows or hides the title
  • „wrapping“: text, either „left“ or „right“
  • „heading_levels“: numbers, this lets you select the heading levels you want included in the table of contents. Separate multiple levels with a comma. Example: include headings 3, 4 and 5 but exclude the others with heading_levels="3,4,5"
  • „class“: Text, gib CSS-Klassen ein, die dem Container hinzugefügt werden sollen. Trenne mehrere Klassen durch ein Leerzeichen.
  • „start“: Zahl, zeigt an, wann diese Anzahl von Überschriften im Inhalt vorhanden ist.

[no_toc]

Ermöglicht es, das Inhaltsverzeichnis für den aktuellen Beitrag, die Seite oder den individuellen Inhaltstyp zu deaktivieren.

[sitemap]

Erstellt eine Liste aller Seiten und Kategorien für die Website. Dies kann auf jedem Beitrag, jeder Seite oder sogar in einem Text-Widget verwenden. Beachte, dass dies keinen Index der Beiträge enthält, verwende also sitemap_posts, wenn es benötigt wird.

[sitemap_pages]

Gibt nur eine Liste mit Seiten aus. Folgende Attribute werden akzeptiert:

  • „heading“: Zahl zwischen 1 und 6, definiert welche HTML-Überschrift verwendet werden soll
  • „label“: Text, Titel der Liste
  • „no_label“: true/false, blendet die Listenüberschrift ein oder aus
  • „exclude“: IDs der Seiten oder Kategorien, die man ausschließe möchten
  • „exclude_tree“: ID der Seite oder Kategorie, die man ausschließen möchte, einschließlich aller untergeordneten.
  • „child_of“: „current“ or page ID of the parent page. Defaults to 0 which includes all pages.

[sitemap_categories]

Wie [sitemap_pages], aber für Kategorien.

[sitemap_posts]

Auf diese Weise kann ein Index aller veröffentlichten Beiträge auf der Website ausgegeben werden. Standardmäßig werden Beiträge in alphabetischer Reihenfolge sortiert nach ihren Anfangsbuchstaben aufgelistet. Folgende Attribute werden akzeptiert:

  • „order“: Text, entweder ASC oder DESC
  • „orderby“: Text, beliebte Optionen sind „title“, „date“, „ID“ und „rand“. Eine Liste findet sich unter WP_Query.
  • „separate“: true/false (standardmäßig true), trennt die Listen nicht nach Anfangsbuchstaben, wenn es auf false gesetzt ist.

Verwende die folgenden CSS-Klassen, um das Design der Liste anzupassen:

  • toc_sitemap_posts_section
  • toc_sitemap_posts_letter
  • toc_sitemap_posts_list

Credits

This plugin was created and maintained for many years by conjur3r. We are grateful for all the hard work he put in and we are excited to continue to build on that!

Screenshots

  • Ein Beispiel für das Inhaltsverzeichnis, oben positioniert, rechtsbündig und mit einer Breite von 275px.
  • Ein Beispiel für den Shortcode sitemap_pages
  • Ein Beispiel für den Shortcode sitemap_posts
  • Das Optionen-Feld unter Einstellungen > TOC+
  • Einige erweiterte Optionen
  • Das Sitemap-Tab

Installation

Es gilt der normale Plugin-Installationsprozess, d.h. die Suche nach Table of Contents Plus von Ihrem Plugin-Dashboard oder über die manuelle Methode:

  1. Lade den Ordner table-of-contents-plus in das /wp-content/plugins/ Verzeichnis hoch.
  2. Aktiviere das Plugin mittels dem ‚Plugins‘-Menü in WordPress

Das wars! Das Inhaltsverzeichnis wird auf Seiten mit mindestens vier oder mehr Überschriften angezeigt.

Du kannst die Standardeinstellungen und mehr unter Einstellungen > TOC+ ändern.

Rezensionen

7. September 2024
Thank you Mike, I have tried almost 10 plugins, and in my opinion, this is the best among them.If the following two options are added to the position section, it can be used everywhere:1- Before the first paragraph2- After the first paragraph
1. September 2024
It worked right out of the box! It didn’t slow down the page loading time at all. I’m using LiteSpeed Cache plugin and that might count, but still, this is exactly what I was looking for.
15. April 2024 1 Antwort
I have experienced a really tough day trying to resolve the issue that the TOC failed to display. Fortunately, I managed to find a solution, which is really simple. I hope it can be helpful to those guys encountering the same issue. Solution: Go to the advanced settings and select the heading levels you want to show. All the heading levels are kept unselected after the update and you just need to select them again.
Alle 157 Rezensionen lesen

Mitwirkende & Entwickler

„Table of Contents Plus“ ist Open-Source-Software. Folgende Menschen haben an diesem Plugin mitgewirkt:

Mitwirkende

„Table of Contents Plus“ wurde in 24 Sprachen übersetzt. Danke an die Übersetzerinnen und Übersetzer für ihre Mitwirkung.

Übersetze „Table of Contents Plus“ in deine Sprache.

Interessiert an der Entwicklung?

Durchstöbere den Code, sieh dir das SVN Repository an oder abonniere das Entwicklungsprotokoll per RSS.

Änderungsprotokoll

2411.1

  • Released: 21 November 2024
  • Security hardening reported by WPScan

2411

  • Released: 14 November 2024
  • Security hardening reported by Patchstack
  • Plugin updates for compatibility with Plugin Check

2408

  • Released: 14 August 2024
  • Redo XSS issue reported by wpscan

2406

  • Released: 16 June 2024
  • Revert ‚Do not output CSS/JS on pages not eligible‘ introduced in 2402 as it broke some clever edge cases
  • Fixed XSS issue requiring editor or higher privileges for show/hide text (thanks to wpscan)

2402.1

  • Released: 22 February 2024
  • Fixed check for shortcode use (#164)

2402

  • Released: 21 February 2024
  • Added option to generate TOC in REST requests, disabled by default (props ballpumpe)
  • Composer improvements (props mohjak)
  • Do not output CSS/JS on pages not eligible
  • Update POT translation file
  • Update links to help

2311

  • Released: 7 November 2023
  • Bump tested WordPress version to 6.4
  • Do not trigger on REST requests (props steffenster)
  • Update include mechanism in init.php (props maciejmackowiak)

2309

  • Released: 19 September 2023
  • Bump tested version to 6.3.1
  • Added child_of property to sitemap_pages shortcode (props flagsoft). This lets you output a listing of child pages for a set parent or „current“. Property is optional and defaults to all pages.
  • Fixed XSS possibility handling nonce while saving options (thanks to Patchstack)
  • Updated WordPress Coding Standard to 3.0

2302

  • Released: 9 February 2023
  • Added toc_brackets CSS class to square brackets around show/hide text
  • Added a filter to the toc_extract_headings function (props Raymond Radet)
  • Refactor using WordPress-Extra coding standard

2212

  • Released: 16 December 2022
  • Bump tested version to 6.1.1
  • When using the TOC+ widget, execute shortcodes beforehand (props endcoreCL)
  • When using the TOC+ widget, abort early when no post for edge cases (props jonas-hoebenreich)
  • Add start property to toc shortcode to override the minimum number of headings needed to display (props woutervanvliet)
  • Add no_numbers property to toc shortcode to disable leading heading indexes (props TedAvery)
  • Fixed XSS vulnerability in toc shortcode, class property (thanks to wpscan)
  • Fixed XSS vulnerabilities in sitemap_pages and sitemap_categories shortcodes, label property

2106

  • Released: 23 June 2021
  • Add compatibility with Rank Math SEO
  • Bump tested WordPress version to 5.7
  • Add PHP coding style
  • Adhere to majority of coding tips

2002

  • Released: 9 February 2020
  • Fixed encoding when using %PAGE_TITLE% or %PAGE_NAME%
  • Bump tested WordPress version to 5.3
  • Removed all local translations as you can find more up to date ones at translate.wordpress.org
  • Removed translators links from readme

1601

  • Veröffentlicht: 5. Januar 2016
  • Getestete WordPress-Version auf 4.4 erhöht
  • Fügen Sie API-Funktionen „aktivieren” und „deaktivieren” hinzu, damit ein Entwickler die Ausführung besser kontrollieren kann.
  • Add Brazilian Portuguese translation thanks to Blog de Niterói
  • Add Spanish translation thanks to David Saiz
  • TOC+ widget now adheres to a blank title if none provided. Thanks to Dirk for the cue.
  • jQuery Smooth Scroll von 1.5.5 auf 1.6.0 aktualisiert
  • Die Text Domain wurde aktualisiert, um die Übersetzungspakete besser zu unterstützen.

1509

  • Veröffentlicht: 4. September 2015
  • Added Hebrew translation thanks to Ahrale
  • Added Japaense translation thanks to シカマル
  • Added Greek translation thanks to Dimitrios Kaisaris
  • Updated jQuery Smooth Scroll 1.4.10 to 1.5.5
  • Supply both minified and unminified CSS and JS files, use minified versions.
  • Convert accented characters to ASCII in anchors.
  • Bump tested WordPress version to 4.3
  • Fixed: PHP notice introduced in WP 4.3
  • Fixed: javascript error with $.browser testing for Internet Explorer 7.
  • Plugin has moved to GitHub for better collaboration.
  • Help needed: preg_match_all failing with bad UTF8 characters producing no TOC. If you can help, please participate in this issue.

1507

  • Veröffentlicht: 5. Juli 2015
  • Added Danish translation courtesy of Cupunu
  • Simplified the translation duty by moving the help material to the plugin’s website.
  • Aktualisierte Übersetzungsdatei.

1505

  • Veröffentlicht: 2. Mai 2015
  • Huge thanks to Jason for an updated Simplified Chinese translation.
  • Added collapse property to the toc shortcode. When set to true, this will hide the table of contents when it loads. Example usage: [toc collapse=“true“]
  • Added label_show and label_hide properties to the toc shortcode. This lets you change the „show“ and „hide“ link text when using the shortcode.
  • Bump tested WordPress version to 4.2.1.

1408

  • Veröffentlicht: 1. August 2014
  • Added a human German translation courtesy Ben
  • Added „class“ attribute to the TOC shortcode to allow for custom CSS classes to be added to the container. Thanks to Joe for suggesting it

1407

  • Veröffentlicht: 5. Juli 2014
  • Added Ukrainian translation courtesy Michael Yunat
  • Französische Übersetzung hinzugefügt. Mit freundlicher Genehmigung von Jean-Michel Duriez.
  • Empty headings are now ignored, as suggested by archon810
  • Removed German translation, may have been machine translated, ref
  • Fixed: Special chars in TOC+ > Settings > Exclude Headings no longer get mangled on save. Thanks to N-Z for reporting it.

1404

  • Veröffentlicht: 18. April 2014
  • Bump WordPress support to 3.9
  • Fixed: Strip HTML tags from post titles for sitemap_posts so those items do not appear under a < heading. Thanks to Rose for reporting it.
  • Fictitious: This release was powered by three blind mice.

1402

  • Veröffentlicht 19. Februar 2014
  • Added German translation courtesy Cord Peter
  • Modify toc_get_index API function to also reset minimum number of headings to 0.
  • Removing the TOC+ widget from the sidebar no longer requires you to uncheck the ‚Show the table of contents only in the sidebar‘ option. It will be reset on removal.
  • Delay count of headings until disqualified have been removed. Thanks to Simone di Saintjust for raising it.
  • Using the TOC+ widget, you can now limit the display to selected post types. Thanks to Pete Markovic for the idea.
  • Aktualisierte Übersetzungsdatei (zusätzliche Optionen hinzugefügt).

1311

  • Veröffentlicht: 10 November 2013
  • Added third parameter to toc_get_index API function to enable eligibility check (eg apply minimum heading check, is post type enabled, etc). This has been switched off by default and only affects those using the API. Thanks Jonon for your comment.
  • Added Dutch translation courtesy Renee
  • Apply bullet option to TOC+ widget, thanks to Thomas Pani for the patch.

1308

  • Veröffentlicht: 5. August 2013
  • Fix javascript issue with minimum jQuery version check (broke smooth scrolling using WordPress 3.6).
  • Replaced Slovak translation with a human translated version courtesy Boris Gereg.
  • Remove signature from source when using the shortcode but not allowed to print (eg on homepage).
  • Add „separate“ attribute for sitemap_posts shortcode to not split by letter, thanks DavidMjps for the suggestion.

1303.1

  • Veröffentlicht: 22. März 2013
  • New: added Polish translation, curtesy Jakub
  • Fixed: an issue in 1303 that ignored headings with the opening tag on the first line and the heading text on a new line. Thanks to richardsng for the quick discovery.