SimpleTOC – Inhaltsverzeichnis Block

Beschreibung

Füge einen Inhaltsverzeichnisblog zu seinen Artikeln und Seiten hinzu. Das Verzeichnis ist eine verschachtelte Liste mit Links zu allen gefundenen Überschriften in dem Artikel oder Seite. Um es zu nutzen, füge einfach einen Block hinzu und suche nach „SimpleTOC“ oder nur „TOC“.

Die maximale Tiefe des Inhaltsverzeichnisses kann neben vielen anderen Optionen in der Seitenleiste der Blöcke konfiguriert werden. Du kannst die Überschrift „Inhaltsverzeichnis“ ausblenden und deine eigene hinzufügen, indem du einen normalen Überschriftenblock verwendest.

SimpleTOC ist Open-Source und wird auf GitHub entwickelt. Wenn du einen Fehler findest oder eine Idee für ein Feature hast, bitte mach bei der Entwicklung mit und erzeuge einen „pull request“.

Erstelle eine neue WordPress-Instanz, auf der das SimpleTOC-Plug-in bereits installiert ist.

Funktionen

  • Für Gutenberg entwickelt.
  • Ohne Konfiguration: Einfach den SimpleTOC Block zum Artikel hinzufügen und das war’s.
  • Minimale und gültige HTML-Ausgabe.
  • Es wird kein JavaScript oder CSS hinzugefügt. Außer, du aktivierst das Akkordeon-Menü.
  • Style SimpleTOC mit Gutenbergs nativen Gruppenstil-Optionen.
  • Übernimmt den Stil deines Themes.
  • Smooth scrolling effect über CSS.
  • Optionale ARIA Label und Navigationsrollenattribute.
  • Übersetzt in verschiedene Sprachen. Inklusive Deutsch, Chinesisch (Taiwanesisch), Niederländisch, Brasilianisch-Portugiesisch, Französisch, Spanisch und Lettisch.

Konfiguration

  • Administratoren können globale Einstellungen verwenden, um die individuellen Blockeinstellungen zu ersetzen.
  • Füge Hintergrund und Textfarbe über Gutenberg Gruppen hinzu.
  • Native Unterstützung für weite und volle Breite.
  • Steuern Sie die maximale Tiefe der Überschriften.
  • Wähle zwischen einer geordneten, aufzählenden HTML-Liste. Oder rücke die Liste ein.
  • Wähle eine Überschriftsebene aus oder verwandle sie in einen Absatz.
  • Deaktiviere die H2 Überschrift des Inhaltsverzeichnisses und füge deine eigene hinzu.

Kompatibilität

  • Unterstützung für GeneratePress und Rank Math.
  • Funktioniert populären AMP Plug-ins.

Danksagungen

Dieses Plug-In ist ein Fork von pdewouters und benutzt Code von Easy-Table-of-Contents

Vielen Dank an Tom J Nowell und Sally CJ, die mir beide sehr bei meinen Fragen drüben bei wordpress.stackexchange.com geholfen haben

Danke an Quintus Valerius Soranus für die Erfindung des Inhaltsverzeichnisses 100 BC.

Screenshots

  • SimpleTOC-Block im Gutenberg-Editor
  • SimpleTOC im Beitrag
  • Simple aber mächtig. Passe jedes Inhaltsverzeichnis so an, wie du möchtest.
  • Steuern Sie die maximale Tiefe der Überschriften.
  • SimpleTOC gestylt mit Gutenbergs nativen Gruppenstilen.
  • Erweiterte Funktionen von SimpleTOC
  • Gutenberg Überschriften-Block: Einen eigenen Anker setzen
  • SimpleTOC versteckt im Akkordeon-Menü.
  • SimpleTOC globale Einstellungen

Blöcke

Dieses Plugin unterstützt 1 Block.

  • SimpleTOC Adds a Table of Contents.

Installation

SimpleTOC kann über das Plugin-Menü innerhalb der WordPress-Administration gefunden und installiert werden (Plugins -> Installieren). Alternativ kann SimpleTOC auch von WordPress.org heruntergeladen und manuell installiert werden…

Füge einen Block in Gutenberg hinzu und suche nach „SimpleTOC“ oder nur „TOC“. Bitte speichere deinen Beitrag bevor du den Block nutzen kannst.

FAQ

Konfiguration globaler Einstellungen in SimpleTOC.

SimpleTOC ermöglicht es dir, globale Einstellungen für deine WordPress-Website zu konfigurieren. Diese Einstellungen können global durchgesetzt werden und überschreiben mögliche Block-Level-Konfigurationen. Um auf diese Einstellungen zuzugreifen, navigiere zum SimpleTOC-Bereich der WordPress-Einstellungen.

Wie füge ich eine Hintergrundfarbe zu SimpleTOC mit Gutenberg Gruppen hinzu?

Markiere den Block und wähle im Kontextmenü „gruppieren“. Wende „Hintergrundfarbe“, „Linkfarbe“ und „Textfarbe“ auf diese Gruppe an. SimpleTOC wird diese Stile erben. Du möchtest diese gestylte SimpleTOC-Gruppe das nächste Mal verwenden, wenn Du einen Beitrag schreibst? Wandele sie in einen wiederverwendbaren Block um.

Wie kann man eine einzelne Überschrift aus dem TOC ausschließen?

Wenn du wirklich eine einzelne Überschrift aus dem Inhaltsverzeichnis ausblenden willst, dann füge die CSS-Klasse „simpletoc-hidden“ zu einem Überschriftenblock hinzu. Du findest dieses Feld an der gleichen Stelle wie das HTML-Ankerfeld: In der Seitenleiste Block > Erweitert. Überlege dir aber zuerst, warum du eine bestimmte Überschrift ausblenden möchtest. Vielleicht möchtest du alle Überschriften einer bestimmten Tiefenstufe entfernen. Dann gibt es dafür eine Option in den Blockoptionen in Gutenberg. Wenn du der Meinung bist, dass diese Überschrift nicht Teil des Inhaltsverzeichnisses sein sollte, wird sie vielleicht im Beitrag selbst nicht benötigt?

Ich würde gerne meine SimpleTOC-Einstellungen als Standard speichern. Ist das möglich?

Du kannst deinen konfigurierten SimpleTOC-Block in einen wiederverwendbaren Block in Gutenberg umwandeln. Er behält seine Einstellungen. Auf diese Weise kannst du deine gewünschten Einstellungen für jeden neuen Beitrag verwenden, indem du den wiederverwendbaren Block hinzufügst.

Wie fügt man einen div-Tag-Wrapper zum TOC hinzu?

Wenn du eine benutzerdefinierte Klasse zum SimpleTOC-Block unter „Erweitert“ hinzufügst und dann „Zusätzliche CSS-Klassen“, wird ein div-Element mit dieser Klasse um die HTML-Ausgabe herum platziert.

Wie kann man Entwicklern erlauben, bestimmte Überschriften programmatisch auszuschließen?

Verwende den Filter „simpletoc_excluded_blocks“. Dieser Code schließt unter anderem Überschriftenblöcke aus, die sich innerhalb eines Spaltenblocks befinden:

Beispiel:

add_filter( 'simpletoc_excluded_blocks', function ( array $blocks ) {
    $blocks[] = 'core/column';

    return $blocks;
} );

Wie kann ich die Farbe des Akkordeon-Menüs ändern?

Das heavy plus Zeichen, das ich verwendet habe, kann nicht ohne Hacks mit css eingefärbt werden. Aber Du kannst das Symbol in etwas anderes ändern und die Farbe des neuen Symbols ändern.

.simpletoc-collapsible::after {
    content: "✖";
    color: #e94c89;
}

Wie ändere ich die TOC-Überschrift ‚Inhaltsverzeichnis‘ in etwas anderes?

Ich sehe im Moment keine einfache Lösung. SimpleTOC ist nur ein Block, der in Ihrem Beitrag platziert werden kann. Wenn es ein Plugin gäbe, das Blöcke zu jedem Beitrag hinzufügt, dann wäre das die Lösung. Ich denke, dies sollte ein weiteres separates Plugin sein, um den Code von SimpleTOC sauber und … nun ja, einfach zu halten.

Rezensionen

24. September 2023 1 Antwort
I tested 8-10 table of contents plugins for keyboard and screen reader accessibility and this plugin was by far the best. There was one issue with the accordion that caused a problem for screen reader users, so I opened a support forum thread and the developer released a fix within a few hours. Wow! This plugin is easy to use, has great HTML markup, and it's refreshing to find a developer who takes accessibility seriously. I'd give it 10 stars if I could. Don't even look for another table of contents plugin.
4. August 2023 1 Antwort
using the plugin in the sidebr of a singular block template. works easy, perfect and causes no design issues. besides it does not bother me with anything like "buy the pro if you want that the plugin does what you need"... thank you for this.
5. April 2023 1 Antwort
Creating and maintaining a plugin requires a significant amount of effort and dedication. It is not a task that can be undertaken by everyone, as it requires an individual with a genuine interest and energy to deliver a product that evolves from being good enough to becoming a perfect product. We encountered some challenges while using your plugin, but we were pleased to discover that the issue was addressed before we could even report it. We would like to express our sincere appreciation for your active development efforts, which have resulted in the release of version 6.0.2.
Alle 56 Rezensionen lesen

Mitwirkende & Entwickler

„SimpleTOC – Inhaltsverzeichnis Block“ ist Open-Source-Software. Folgende Menschen haben an diesem Plugin mitgewirkt:

Mitwirkende

„SimpleTOC – Inhaltsverzeichnis Block“ wurde in 16 Sprachen übersetzt. Danke an die Übersetzerinnen und Übersetzer für ihre Mitwirkung.

Übersetze „SimpleTOC – Inhaltsverzeichnis Block“ in deine Sprache.

Interessiert an der Entwicklung?

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

Änderungsprotokoll

6.0.10

  • Aira-hidden Attribute zum Icon im Akkordion hinzugefügt. Danke Alex Stine!

6.0.9

  • ARIA-Zugänglichkeitsbeschriftungen für das Akkordeon hinzugefügt. Danke, Amber Hinds!
  • Fixed: Caching des Akkordion JavaScript. Danke jghitchcock!
  • Korrekte ARIA control Attribute hinzugefügt.

6.0.5

  • Kompatibilität mit WordPress 6.3