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.
  • 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.
  • Unterstützung für <!--nextpage-->.
  • Customizer Unterstützung.

Anforderungen

  • WordPress Version: >= 3.2
  • PHP Version: >= 5.2.4

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

14. Oktober 2019
The articles written with the classic editor works however with gutenberg the anchors do not function.
27. September 2019
The plugin creates issues with WP Review and WP Review Pro by MyThemeShop. The developer said this is a special use case and has no plans to fix it. If you use WP Review Pro by MyThemeShop, try for an alternative.
6. September 2019
a good plugin and seo friendly
23. August 2019
I was looking for a way to create a table of contents and affix it to the sidebar, this one i think is the only free plugin which let you do this! Thank you to the developers!
11. August 2019
Kudos for a workhorse plug-in with a lot of features that's easy to use. Being one of those people without enough time to be brief, adding a TOC to my longer blogs makes me happy - and users too. That I can use global settings so the plug-in determines if a blog is long enough is terrific. I thought through the settings once and haven't had to tweak them since - going on two years.
Lies alle 69 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 6 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

1.7 05/09/2018

  • NEU: Führt den ez_toc_shortcode Filter ein.
  • OPTIMIERUNG: Korrigiere Hinweise wegen verspäteter Berechtigungsprüfung. props unixtam
  • OPTIMIERUNG: Verbesserte Berechtigungsprüfung zur Unterstützung des TOC-Widgets.
  • OPTIMIERUNG: Präfixe für ein paar CSS-Klassen, um Kollisionen mit Themes und anderen Plugins zu vermeiden.
  • OPTIMIERUNG: Vermeide potenzielle PHP-Nachrichten im Admin-Bereich, wenn du den Beitrag speicherst, indem du nach Nonce suchst, bevor du ihn validierst.
  • OPTIMIERUNG: Die Benutzung des Shortcodes überschreibt nun die globalen Optionen.
  • OPTIMIERUNG: Das Ergebnis von is_eligible() wird nun in the_content() zwischengespeichert.
  • OPTIMIERUNG: Refaktor um das WP_Post-Objekt intern zu übergeben vs. auf es über den $wp_query->post zu beziehen, der möglicherweise nicht in allen Fällen existiert.
  • OPTIMIERUNG: Benutze pre_replace() um ein oder mehrere Leerzeichen durch einen Unterstrich zu ersetzen.
  • OPTIMIERUNG:Der Code-Filter ez_toc_url_anchor_target gibt den ursprünglichen Titel zurück.
  • OPTIMIERUNG: &nbsp; durch ein Leerzeichen ersetzt.
  • OPTIMIERUNG: Kleinere Verbesserungen in der Erzeugung der Seiten-URL.
  • OPTIMIERUNG: TOC-Liste in ein Navigationselement eingebunden.
  • OPTIMIERUNG: Plugin Initialisierung mit dem plugins_loaded hook.
  • OPTIMIERUNG: Header-Minimum ist jetzt 1.
  • FEHLER: Die Header-Optionen des Beitrags sollten benutzt werden um das Inhaltsverzeichnis zu erstellen, nicht die Header Optionen der globalen Einstellungen.
  • FEHLER: Werte der Escape-Felder nicht verdoppeln.
  • FEHLER: Sicherstellen, dass der Gebrauch von Apostroph / Hochkomma in der Funktion „Überschriften ausschließen“ funktioniert.
  • ANDERES: CSS aktualisiert, um die neu festgelegten Klassen aufzunehmen.
  • DEV: Unbenutzten, auskommentierten Code entfernen.

1.6.1 03/16/2018

  • OPTIMIERUNG: Die Änderung, die vorgenommen wurde, um über den Filter ez_toc_title HTML zu ermöglichen, wird rückgängig gemacht, da sie unerwünschte Nebenwirkungen verursacht.
  • FEHLER: Stellt sicher, dass der Smooth Scroll Offset (Versatz des sanften Bildlaufs) als ganze Zahl interpretiert wird.

1.6 03/15/2018

  • NEU: Füge px Option als Schriftgrößen-Einheit hinzu.
  • NEU: Füge Optionen für Schriftgrößen- und Schriftstärken beim Titel hinzu.
  • NEU: Füge Versatz-Optionen für den mobilen sanften Bildlauf hinzu.
  • OPTIMIERUNG: Ändere den Standard für die Schriftgrößeneinheit von px auf %, um den Werten der Standard-Optionen zu entsprechen.
  • OPTIMIERUNG: Korrigiere den CSS-Selektor, so dass der Außenabstand zwischen Titel und TOC-Elementen korrekt angewendet wird.
  • OPTIMIERUNG: Beachtet HTML das über ez_toc_title Filter hinzugefügt wird.
  • OPTIMIERUNG: Stelle sicher, dass der ezTOC-Inhaltsfilter nicht angewendet wird, wenn der the_content Filter ausgeführt wird.
  • OPTIMIERUNG: Das Javascript nur in die Warteschlange stellen, wenn die Seite für ein TOC berechtigt ist.
  • OPTIMIERUNG: Aktualisiere icomoon CSS, um unnötige CSS-Selektoren zu entfernen, zu Vermeidung möglicher Konflikte.
  • OPTIMIERUNG: Der Smooth Scroll Offset (Versatzt des sanften Bildlaufs) muss bei der Definition der Eigenschaft offset_top beim Fixieren des Widgets berücksichtigt werden.
  • ANDERE: Aktualisiere die minimierte CSS-Datei des Frontends.
  • ANDERE: Aktualisiere die minimierte Javascript-Datei des Frontends.
  • DEV: phpDOC Korrekturen.

1.5 02/20/2018

  • FEHLER: Korrigiere den CSS Selektor um die Link-Farbe besser anzusteuern.
  • ANDERES: Aktualisiere die WayPoints-Bibliothek.
  • DEV: Füge ein paar @todo’s hinzu.

1.4 01/29/2018

  • OPTIMIEREN: Ändere die Textdomäne von ez_toc auf easy-table-of-contents.
  • OPTIMIERUNG: Benenne die Übersetzungsdateien mit der richtigen Text-Domäne um.
  • FEHLER: Stelle sicher, dass die Seiten-Header verarbeitet werden, um den Header-Link in der Seite hinzuzufügen, wenn du die Shortcodes verwendest.
  • FEHLER: Füge dem Domain-Pfad im Plugin-Header einen Schrägstrich hinzu.
  • I18N: Aktualisiere die POT Datei.
  • I18N: Aktualisiere die niederländische (nl_NL) Übersetzung.

1.3 12/18/2017

  • FUNKTION: Unterstützung für den Shortcode [ez-toc] hinzufügen.
  • NEU: Für die Abwärtskompatibilität mit „Table of Content Plus“ registriere den Shortcode [toc].
  • NEU: Introduce the ez_toc_extract_headings_content filter.
  • OPTIMIERE: Aktualisiere den getestet-auf und erforderlichen Readme-Header-Text.
  • OPTIMIERE: Zeige das Widget nicht auf den 404-, Archiv-, Such- und Beitragsseiten.
  • I18N: Die nl_NL Übersetzung hinzufügen.

1.2 04/29/2016

  • OPTIMIERUNG: Die Schriftart aus dem Styling des TOC-Titel Headers entfernt.
  • OPTIMIERUNG: Übergebe den raw-Titel an den Filter ez_toc_title.
  • FEHLER: A jQuery 1.12 für WordPress 4.5 behoben.

1.1 02/24/2016

  • FUNKTION: Option hinzugefügt, um den Header durch einen alternativen Header-Text im Inhaltsverzeichnis zu ersetzen.
  • NEU: ez_toc_filter eingeführt.
  • NEU: EzTOC_Option::textarea() zum Rendern von Textareas eingeführt.
  • NEU: Array_search_deep() zur rekursiven Suche in einem Array eingeführt.
  • OPTIMIERT: Führe Inhaltsverzeichnis-Header über wp_kses_post() aus.
  • OPTIMIERE: Escape URL.
  • OPTIMIERE: Zähle ausgeschlossene Überschriften nur einmal statt mehrmals.
  • OPTIMIERE: Escape‘ übersetzte Zeichenfolge vor dem Rendern.
  • OPTIMIERE: Verwende wp_unslash() anstelle von stripslashes().
  • OPTIMIERE: Escape‘ übersetzte Zeichenfolge.
  • FEHLER: Korrigiere die Logik des restrict Pfades.
  • ANDERES: Readme optimieren.
  • I18N: POT-Datei hinzufügen.
  • I18N: Füge eine niederländische Übersetzung hinzu.
  • DEV: Aktualisiere .gitignore, um PO-Dateien zu erlauben.
  • DEV: phpDoc Korrektur.

1.0 09/08/2015

  • Erstveröffentlichung.
    • Complete Refactor und Umstrukturierung des ursprünglichen Codes für ein besseres Design und eine Funktionstrennung, um die Codebasis viel einfacher pflegen und erweitern zu können.
    • Aktualisiere alle Bibliotheken von Drittanbietern.
    • Bessere Nutzung der WordPress Einstellungs-API.
    • Verkleinerte CSS- und JS-Dateien werden standardmäßig verwendet. Die Benutzung von SCRIPT_DEBUG verwendet die nicht minimierten Versionen.
    • Füge bedeutende Quantitäten von phpDoc für Entwickler hinzu.
    • Viele Hooks hinzugefügt, um die Einbindungen von Drittanbietern zu ermöglichen.
    • Das Widget kann an der Seite fixiert werden, so dass es immer sichtbar ist.
    • Das Widget hebt den Inhaltsbereiche hervor, der derzeit im Browser sichtbar ist.
    • Das Widget erzeugt nun auch ein Inhaltsverzeichnis mit dem Output von Drittanbieter-Shortcodes.
    • Verwende wpColorPicker anstelle von farbtastic.
    • Entferne alle Shortcodes.
    • Pro Beitrag werden die Optionen in der Beitrags-Meta gespeichert und nicht per Shortcode festgelegt.