Easy Table of Contents

Beschreibung

Ein benutzerfreundliches, auf Funktionen ausgerichtetes Plugin, mit dem du ein Inhaltsverzeichnis in deine Beiträge, Seiten und individuellen Beitragsarten einfügen kannst.

Funktionen

  • Generiere automatisch ein Inhaltsverzeichnis für deine Beiträge, Seiten und individuellen Beitragstypen, indem deren Inhalte auf Header/Überschriften untersucht werden.
  • Unterstützt das <!--nextpage-->-Tag.
  • Supports the Rank Math plugin.
  • Works with the Classic Editor, Gutenberg, Divi, Elementor, WPBakery Page Builder and Visual Composer page editors.
  • Optional für Seiten und/oder Beiträge zu aktivieren. Individuelle Beitragsarten werden unterstützt, solange ihr Inhalt mit dem Template-Tag the_content() ausgegeben wird.
  • Optional kann das Inhaltsverzeichnis automatisch in die Seite eingefügt werden, wählbar nach aktiviertem Beitragstyp.
  • Bietet viele leicht verständliche Optionen zur Konfiguration, wann und wo das Inhaltsverzeichnis eingefügt werden soll.
  • Es stehen zahlreiche Optionen zur Verfügung, um das Erscheinungsbild des eingefügten Inhaltsverzeichnisses zu konfigurieren, das schließt auch mehrere eingebaute Themes ein. Wenn die bereitgestellten Themes nicht deinen Anforderungen entsprechen, kannst du deine eigenen erstellen, indem du eigene Farben für Rand, Hintergrund und Linkfarbe wählst.
  • Mehrere Zähler-Formate stehen zur Auswahl; keine, dezimal, numerisch und römisch.
  • Wähle zwischen hierarchischer und nicht hierarchischer Darstellung des Inhaltsverzeichnisses. Dies bedeutet, dass Überschriften mit geringerer Prioriät in Überschriften mit höherer Priorität verschachtelt werden.
  • Der Benutzer kann das Inhaltsverzeichnis optional ausblenden. Du hast die volle Kontrolle über diese Funktion. Es kann deaktiviert werden und du kannst wählen, ob es standardmäßig ausgeblendet werden soll.
  • Unterstütz den sanften Bildlauf (smooth scrolling).
  • Aktiviere oder deaktiviere das Inhaltsverzeichnis selektiv auf Post-zu-Post-Basis.
  • Wähle aus, aus welchen Überschriften das Inhaltsverzeichnis generiert werden soll. Auch dies kann auf Post-zu-Post-Basis festgelegt werden.
  • Schließe Header global und auf Post-zu-Post-Basis einfach aus.
  • Wenn du das Inhaltsverzeichnis nicht in den Beitrag einfügen möchtest, kannst du das mitgelieferte Widget verwenden und das Inhaltsverzeichnis in der Seitenleiste deines Themes platzieren.
  • Das Widget unterstützt das Fixieren oder Festsetzen auf der Seite, so dass es immer sichtbar ist, wenn du die Seite nach unten bewegst. HINWEIS: Dies ist eine erweiterte Option, da jedes Thema unterschiedlich ist, benötigst du möglicherweise Unterstützung von deinem Theme-Entwickler, um zu erfahren, was der richtige Element-Bezeichner in den Einstellungen ist, um diese Funktion zu aktivieren.
  • Das Widget hebt die aktuell auf der Seite sichtbaren Abschnitte automatisch hervor. Die Farbe der Hervorhebung ist konfigurierbar.
  • Entwicklerfreundlich mit vielen Action-Hooks und Filtern verfügbar. Weitere können auf Anfrage unter Github hinzugefügt werden. Pull-Anfragen sind willkommen.

Live-Beispiele

Hier sind Links zu Dokumentationsseiten für mehrere der Premium-Templates für das Connections Business Directory Plugin, die das in diesem Plugin enthaltene Widget verwenden:

Entwicklungsschritte

  • Fragment-Caching für eine verbesserte Leistung.
  • Improve SEO by adding options to add nofollow to TOC link and wrap TOC nav in noindex tag.
  • Improve accessibility.
  • Add Bullet and Arrow options for list counter style.

Würdigung

Easy Table Contents ist ein Fork des ausgezeichneten Table of Contents Plus Plugins von Michael Tran.

Screenshots

  • Der Abschnitt allgemeine Einstellungen.
  • Der Design-Abschnitt der Einstellungen.
  • Der Bereich erweiterte Einstellungen.

Installation

Verwendung der WordPress Plugin-Suche

  1. Navigiere zur der Neu hinzufügen Unterseite der Plugin-Admin-Seite.
  2. Suche nach easy table of contents.
  3. Das Plugin sollte zu oberst in den Suchergebnissen aufgeführt werden.
  4. Klicke auf den Jetzt installieren Link.
  5. Zuletzt klicke den Plugin aktivieren Link.

Hochladen in WordPress Admin

  1. Lade das
    Plugin-Zip herunter
    und speichere es auf deinem Computer.
  2. Navigiere zur der Neu hinzufügen Unterseite der Plugin-Admin-Seite.
  3. Klicke den Upload Link.
  4. Wähle die „Easy Table of Contents“-Zip-Datei, die du eben auf deinem Computer gespeichert hast, aus.
  5. Drücke den Jetzt installieren Button.
  6. Zuletzt klicke den Plugin aktivieren Link.

Mit FTP

  1. Lade das
    Plugin-Zip herunter
    und speichere es auf deinem Computer.
  2. Entpacke die Easy Table of Contents zip Datei.
  3. Erstelle einen neuen Ordner mit dem Namen easy-table-of-contents im ../wp-content/plugins/ Verzeichnis.
  4. Lade die Dateien aus dem in Schritt 2 extrahierten Ordner hoch.
  5. Aktiviere das Plugin auf der Plugins-Admin-Seite.

FAQ

Ok, ich habe es installiert… was mache ich als nächstes?

Dein erster Stopp sollte die Admin-Seite für die Inhaltsverzeichnis-Einstellungen sein. Diese findest du unter dem Menüpunkt Einstellungen.

Die erste und einzige Entscheidung, die du treffen musst, ist, dass du entscheidest, für welche Beitragsarten du die Unterstützung für das Inhaltsverzeichnis aktivieren möchtest. Standardmäßig ist es der Seiten-Inhaltstyp. Wenn auf Seiten der einzige Ort ist, an dem du die Verwendung des Inhaltsverzeichnisses planst, hast du auf der Seite Einstellungen nichts zu tun. Um die Dinge einfach zu halten, empfehle ich, an dieser Stelle keine der anderen Einstellungen zu ändern. Viele der anderen Einstellungen steuern, wann und wo das Inhaltsverzeichnis eingefügt wird, und das Ändern dieser Einstellungen kann dazu führen, dass es nicht angezeigt wird, was den Einstieg etwas erschwert. Nachdem du dich damit vertraut gemacht hast, wie das funktioniert…. dann tweak dich weg 🙂

Achte darauf, dass du die Wie werden die Inhaltsverzeichnisse erstellt? FAQ liest, damit du weißt, wie das Inhaltsverzeichnis automatisch generiert wird. Nachdem du die Seitenüberschriften eingerichtet hast, oder vorher, so oder so….. Scrolle auf der Seite nach unten zu der Metabox „Table of Contents„, aktiviere die Option Inhaltsverzeichnis einfügen. und aktualisiere und/oder veröffentliche deine Seite. Das Inhaltsverzeichnis sollte automatisch oben auf der Seite angezeigt werden.

Wie werden die Inhaltsverzeichnisse erstellt?

Das Inhaltsverzeichnis wird aus den Überschriften einer Seite generiert. Überschriften/header bekommen diese <h1>,<h2>,<h3>,<h4>,<h5>,<h6> HTML Tags. Wenn du den visuellen Beitrags-Editor von WordPress benutzt, werden diese Header-Tags in den Beitrag eingefügt, wenn du eine der Optionen Heading n aus dem Dropdown-Menü für Formatierungen auswählst. Jeder Header, der auf der Seite gefunden wird, wird ein Element des Inhaltsverzeichnis. Hier ist ein Beispiel, das ein Inhaltsverzeichnis mit den sechs Elementen erstellt.

<h1>Item 1</h1>
<h1>Item 2</h1>
<h1>Item 3</h1>
<h1>Item 4</h1>
<h1>Item 5</h1>
<h1>Item 6</h1>

Du kannst auch ein „verschachteltes“ Inhaltsverzeichnis erstellen. Das ist schwer zu erklären, also werde ich den Aufbau an dem vorherigen Beispiel veranschaulichen. In diesem Beispiel wird ein Inhaltsverzeichnis mit den gleichen sechs Elementen erstellt, aber jetzt haben die ersten drei jeweils ein untergeordnetes Element. Die Einrückung ist nicht notwendig, sie wurde nur zur Veranschaulichung hinzugefügt.

<h1>Item 1</h1>
    <h2>Item 1.1 -- Level 2</h2>
<h1>Item 2</h1>
    <h2>Item 2.1 -- Level 2</h2>
<h1>Item 3</h1>
    <h2>Item 3.1 -- Level 2</h2>
<h1>Item 4</h1>
<h1>Item 5</h1>
<h1>Item 6</h1>

Du bist nicht auf ein einziges verschachteltes Element beschränkt. Du kannst so viele hinzufügen, wie du brauchst. Du kannst sogar mehrere verschachtelte Ebenen erstellen…

<h1>Item 1</h1>
    <h2>Item 1.1 -- Level 2</h2>
        <h3>Item 1.1.1 -- Level 3</h3>
        <h3>Item 1.1.2 -- Level 3</h3>
        <h3>Item 1.1.3 -- Level 3</h3>
    <h2>Item 1.2 -- Level 2</h2>
      <h3>Item 1.2.1 -- Level 3</h3>
      <h3>Item 1.2.2 -- Level 3</h3>
      <h3>Item 1.2.3 -- Level 3</h3>
    <h2>Item 1.3 -- Level 2</h2>
<h1>Item 2</h1>
    <h2>Item 2.1 -- Level 2</h2>
    <h2>Item 2.2 -- Level 2</h2>
<h1>Item 3</h1>
    <h2>Item 3.1 -- Level 2</h2>
    <h2>Item 3.2 -- Level 2</h2>
<h1>Item 4</h1>
<h1>Item 5</h1>
<h1>Item 6</h1>

Du kannst bei Bedarf 6 Ebenen tief verschachteln. Ich hoffe, dies hilft dir zu verstehen, wie du dein eigenes automatisch generiertes Inhaltsverzeichnis auf deinen Seiten erstellen kannst!

Rezensionen

1. September 2020
Thanks for the plugin. I’ve a big request for you: 1) Add the ability to change the color of the text in the numbers of the table of contents (without changing the text of the heading). EXAMPLE in the table of content: Numbers in green color, headings in orange color. Thanks!!
4. September 2020
Wonderful plugin with many features and settings! I really love it and will it use on every long post/page. But the documentation could be better. The description of how one can select to display the TOC on a page per page basis is hidden in the FAQs. (Scrolling to the end of the page, tick the checkbox for "Insert table of contents" AND save/publish the page. – Just to preview the page did not work for me and made me believe that the checkbox did not work.) From the reviews, I can see that I am not alone struggling with the functionality. People are hunting for a shortcode ([ez-toc]) in the SVN repository or de-install the plugin frustrated. This is a pity, as the plugin is really great!
4. August 2020
Terrific plugin, too bad I had to dig and hunt for the shortcode to display it. It is [ez-toc] Author mentions "it is not officially supported". Yet, I do not want to "auto" anything on pages with a ton of content - this can completely ruin the site. Thank you to the author for this amazing plugin, and please make the shortcode known to all.
20. Juli 2020
Without the ability to manually insert the table of contents, I am uninstalling this plugin. I am sorry if I am missing something.
Lies alle 100 Rezensionen

Mitwirkende & Entwickler

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

Mitwirkende

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

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

Interessiert an der Entwicklung?

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

Änderungsprotokoll

2.0.11 05/01/2020

  • COMPATIBILITY: Add support for the Uncode theme.
  • COMPATIBILITY: Do not run on WooCommerce pages.
  • DEV: Correct typo in phpDoc.

2.0.10 04/20/2020

  • TWEAK: Add trailing span to heading, to prepare for # option and to fix duplicate heading title matching.
  • TWEAK: Add second heading search/replace function to search for heading in content with heading html entities decoded. May help Beaver Builder users as it seems like it does not encode HTML entities as WP core does.

2.0.9 04/08/2020

  • TWEAK: AMP/Caching plugins seems to break anchors with colons and periods even though they are valid characters for the id attribute in HTML5.
  • TWEAK: Replace multiple underscores with a single underscore.
  • DEV: Update the UWS library which fixes the deprecation notice for PHP 7.4.
  • DEV: Add phpcs.xml.dist.
  • DEV: Strict type checks.
  • DEV: Inline doc updates.

2.0.8 04/03/2020

  • TWEAK: Convert <br /> tags in headings to a space.
  • TWEAK: Add additional widget classes.
  • TWEAK: Improve the sanitization of the excluded headings field post setting.
  • TWEAK: Minor optimization of creating the matching pattern for excluding headings for improved performance.
  • COMPATIBILITY: Exclude Create by Mediavine from heading eligibility.
  • BUG: Ensure excluded headings are removed from the headings array.
  • BUG: Ensure empty headings are removed from the headings array.

2.0.7 04/02/2020

  • NEW: Exclude any HTML nodes with the class of .ez-toc-exclude-headings.
  • TWEAK: Change smooth scroll selector from 'body a' to 'a.ez-toc-link'.
  • TWEAK: Declare JS variables.
  • TWEAK: Support unicode characters for the id attribute. Permitted by HTML5.
  • TWEAK: Move the in-page anchor/span to before the heading text to account for long headings where it line wraps.
  • TWEAK: Slight rework to ezTOC widget container classes logic.
  • TWEAK: Cache bust the JS to make dev easier.
  • TWEAK: JavaScript cleanup.
  • TWEAK: URI Encode the id attribute to deal with reserved characters in JavaScript. Technically not necessary for the id attribute but needed to work with the jQuery smoothScroll library.
  • COMPATIBILITY: Reintroduce filter to exclude Ultimate Addons for VC Composer Tabs from heading eligibility.
  • BUG: Correct array iteration logic when processing headings.
  • BUG: Tighten matching for headings in excluded HTML nodes. The loose matching was excluding far too many headings.
  • BUG: Use esc_attr() instead of esc_url() for the anchor href because valid id attribute characters would cause it to return an empty href which cause a nonworking link.

2.0.6 03/30/2020

  • BUG: Ensure minified files are current.

2.0.5 03/27/2020

  • BUG: Prevent possible „strpos(): Empty needle in“ warnings when excluding nodes from TOC eligibility.

2.0.4 03/16/2020

  • NEW: Introduce the ez_toc_container_class filter.
  • TWEAK: Slight rework to ezTOC container classes logic.
  • BUG: sprintf() was eating % in the TOC heading item.
  • BUG: Do not insert TOC at top of post if before first heading option is selected even if first heading can not be found. Some page builders cause the TOC to insert twice or on blog pages.

2.0.3 03/12/2020

  • TWEAK: Slightly tighten heading matching, last update made it a little too loose.
  • BUG: Correct logic required to place TOC before first heading which is required for the more lax heading matching required for page builders.

2.0.2 03/12/2020

  • COMPATIBILITY: Remove filter to exclude Ultimate Addons for VC Composer Tabs from heading eligibility.
  • COMPATIBILITY: Add additional filters to improve Elementor compatibility.
  • TWEAK: Loosen heading matching when doing find/replace to insert in page links. Excluding the opening heading tag to allow matching heading where page builders dynamically add classes and id which break heading matching during find/replace.

2.0.1 03/09/2020

  • COMPATIBILITY: Exclude the WordPress Related Posts plugin nodes.
  • COMPATIBILITY: Exclude a couple Atomic Block plugin nodes.
  • COMPATIBILITY: Exclude JetPack Related Posts from heading eligibility.
  • COMPATIBILITY: Exclude Ultimate Addons for VC Composer Tabs from heading eligibility.
  • COMPATIBILITY: Exclude WP Product Reviews from heading eligibility.
  • TWEAK: Prevent possible „strpos(): Empty needle in“ warnings when excluding nodes from TOC eligibility.

2.0 02/01/2020

  • NEW: Major rewrite of all code and processing logic to make it faster and more reliable.
  • NEW: Support for the