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

  • 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ü.
  • Für Gutenberg entwickelt.
  • Style SimpleTOC mit Gutenbergs nativen Gruppenstil-Optionen.
  • Übernimmt den Stil deines Themes.
  • Übersetzt in verschiedene Sprachen. Inklusive Deutsch, Chinesisch (Taiwanesisch), Niederländisch, Brasilianisch-Portugiesisch, Französisch, Spanisch und Lettisch.

Konfiguration

  • 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ü.

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

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 dem SimpleTOC-Block unter „Erweitert“ und dann „Zusätzliche CSS-Klasse(n)“ eine benutzerdefinierte Klasse hinzufügst, wird ein Div mit dieser Klasse um die HTML-Ausgabe gewickelt. Du kannst dies auch mit einem Filter erzwingen.

Beispiel:

add_filter( 'simpletoc_wrapper_enabled', '__return_true' );

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

27. November 2022
I'm not a code and I can't judge of the real optimization of this plugin but it is simple to use and clean. Much appreciated.
7. November 2022 1 Antwort
I like the plugin a lot. It's simple. It works pretty well and has a few configurations but not too many. Thanks for it! I am using it to learn Wordpress blocks development, which coming from PHP I think it's quite a challenge. Blocks change the development weight from PHP to JS/React a lot!
31. Oktober 2022
The beauty of SimpleTOC is that you can add it to longer posts that need a Table of Contents, with the ability to choose which Heading levels should be shown and other options. Nothing fancy ... and that's what I like about this plug-in. Thanks / Danke to Mark.
23. Oktober 2022 1 Antwort
A great plugin allowing a Table of Contents to be created with minimal input. A great follow-up service too. Marc was extremely helpful and reviewed my query within minutes of posting. He guided me through what I needed to do, and he was able to update me on my query. Super service.
14. September 2022 1 Antwort
This is a fantastic plugin. It's much simpler and more lightweight than any of the other options I came across. It also makes an awesome learning tool for someone dipping their toes into custom block creation. It was great to be able to look at the code and think wow, this totally makes sense!
Alle 47 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

5.0.50

  • Fix: Identifier ‚i‘ has already been declared
  • Fix: SimpleTOC wird den Benutzer nicht mehr über geänderte Inhalte im Editor benachrichtigen. Dazu habe ich die entsprechende Option in den Einstellungen entfernt
  • Fix: Kleinere Änderungen am Akkordeon CSS.

5.0.45

  • Feature: Option zum Anzeigen der Überschrift von SimpleTOC als Absatz.
  • Fix: Abstände nach unten am Akkordion-Menü hinzugefügt.

5.0.43

  • Kompatibilität mit WordPress 6.1
  • SimpleTOC in einem Akkordeon-Menü ausblenden. Fügt minimales JavaScript und CSS-Stile hinzu, falls aktiviert
  • Feature: Option zum Ändern der SimpleTOC-Blocküberschriftenebene.
  • Das Akkordeon-Menü kann nun mehrfach hinzugefügt werden.
  • Fix: Akkordeon-Styling im Gutenberg-Editor.
  • Fix: Kleinere Bugfixes an der Gestaltung des Akkordeon.
  • Fix: JavaScript und CSS für das Akkordeon-Menü mit Hilfe von Standardmethoden hinzugefügt.

5.0.36

  • Feature: Erstelle eine neue WordPress-Instanz, auf der das SimpleTOC-Plug-in bereits installiert ist.
  • Fix: Besserer Umgang mit der simpletoc-hidden Klasse um Überschriften zu verstecken. Danke blronaldhuereca!

5.0.34

  • Feature: Verschieben der Listensteuerungen in die Symbolleiste und Neuanordnung der Einstellungen, damit sie in die Blockreihenfolge passen.
  • Feature: Filter für Entwickler, um das Inhaltsverzeichnis mit einem div-Tag einzuschließen. Vielen Dank, rafaucau!
  • Fix: Kleinere Anpassungen der Lokalisierung.

5.0.31

  • Feature: Filter für Entwickler, um bestimmte Blöcke auszuschließen. Siehe FAQ für Details. Danke rafaucau!
  • Feature: Leichtere Entwicklung mit @wordpress/env zum Starten einer Entwicklungsumgebung. Danke rafaucau!

5.0.28

  • Feature: Ändern Sie die TOC-Überschrift in den Blockoptionen. Dank an Philipp Stracker!

5.0.17

  • Feature: Unterstützung für angepasste Sprungmarken in den Überschriften. Danke Matthias Altmann!