 |
Zusammenfassung | DiscoTOC ermöglicht es Ihnen, mit einem Klick ein interaktives Inhaltsverzeichnis für Ihre Themen zu erstellen! |
 |
Vorschau | Vorschau im Discourse Theme Creator |
 |
Repository-Link | https://github.com/discourse/DiscoTOC |
 |
Neu bei Discourse-Themes? | Einsteiger-Guide zur Nutzung von Discourse-Themes |
Dieses Theme-Komponent installieren
Beispiele
Desktop
Mobile
Funktionen
toc = Inhaltsverzeichnis
-
Erstellt automatisch das gesamte Inhaltsverzeichnis über einen Button im Composer-Zahnradmenü
-
Das Inhaltsverzeichnis ist immer auf dem Bildschirm sichtbar – es scrollt mit dem Inhalt wie das Topic-Progress-Widget
-
Während Sie an Abschnitten im Thema vorbeiscrollen, wird das aktive Element im Inhaltsverzeichnis hervorgehoben (blaue Markierung)
-
Jeder Eintrag im Inhaltsverzeichnis verlinkt auf den Anchor der Überschrift, sodass Sie auch von einem anderen Thema oder Beitrag aus auf einen bestimmten Abschnitt verlinken können
-
Ein Klick auf einen beliebigen Link im Inhaltsverzeichnis weist den Browser an, zum relevanten Abschnitt zu navigieren (Smooth-Scrolling)
-
In Themen mit Antworten ermöglicht ein Inhalt / Timeline-Button den Wechsel zwischen dem Inhaltsverzeichnis und der normalen Topic-Timeline. Die Auswahl wird im Browser gespeichert
-
Kompatibel mit dem Discourse Docs-Plugin
-
Optionale Unterstützung für Inhaltsverzeichnisse in Antworten, nicht nur im ersten Beitrag
-
RTL-Unterstützung
Wie funktioniert es?
Kurz gesagt: Es sucht nach Überschriften in Themen, die für ein Inhaltsverzeichnis markiert sind (über den Composer-Button). Wenn das aktuelle Thema markiert ist, werden alle Überschriften extrahiert und in das Inhaltsverzeichnis eingefügt (nach Überschriftenebenen verschachtelt) – das bedeutet, dass Ihr Markdown syntaktisch korrekt sein muss.
# Überschrift 1
## Überschrift 2
### Überschrift 3
#### Überschrift 4
##### Überschrift 5
Sie können frei zwischen den Überschriftenebenen hin- und herspringen, aber die Reihenfolge muss korrekt sein
# Überschrift 2
## Überschrift 3
## Überschrift 3
### Überschrift 4
## Überschrift 3
# Überschrift 2
usw...
Ein paar Dinge, die Sie über die kompatiblen Überschriften wissen sollten:
h1bish5sind enthalten.h6ist nicht enthalten- Überschriften innerhalb von Zitaten werden ignoriert, sodass Zitate das Inhaltsverzeichnis nicht verschmutzen
- Das Inhaltsverzeichnis erscheint nur, wenn der Beitrag mindestens so viele Überschriften hat, wie in der Einstellung TOC min heading definiert sind (standardmäßig 3)
Wie funktionieren die Links im Inhaltsverzeichnis?
Jede Überschrift in einem gerenderten Beitrag erhält einen Anchor in der Form p-<post id>-<heading slug>-<number> — das ist das Ziel hinter einer Überschrift. DiscoTOC verlinkt auf diese Anchors, anstatt eigene zu erfinden.
Da diese Anchors die Position der Überschrift im Beitrag enthalten, ändern sie sich, wenn Sie Überschriften umordnen oder umbenennen. Wenn Sie von anderswo auf Abschnitte verlinken, können Sie stabile benannte Anchors über der Überschrift hinzufügen:
<div><a name="my-section"></a></div>
## Mein Abschnitt
Verlinken Sie dann auf /t/ihr-topic-slug/1234#my-section. Discourse erlaubt <a name="..."> in Beiträgen. DiscoTOC’s eigene Einträge verwenden weiterhin die Core-Überschriften-Anchors, aber Ihre eigenen funktionieren unabhängig von Bearbeitungen weiter.
Einstellungen
| Name | Beschreibung |
|---|---|
| minimum trust level to create TOC | Die erforderliche Vertrauensstufe, um den TOC-Button im Composer zu sehen |
| composer toc text | Text, der oben im Composer erscheint, um anzuzeigen, dass das Thema ein Inhaltsverzeichnis haben wird |
| auto TOC categories | Kategorien automatisch aktivieren |
| auto TOC tags | TOC automatisch für Themen mit diesen Tags aktivieren |
| enable TOC for replies | Ermöglicht TOC für Antworten. TOCs für Antworten werden nicht von den Einstellungen auto TOC tags und auto TOC categories beeinflusst und müssen manuell eingefügt werden |
| TOC min heading | Mindestanzahl an Überschriften in einem Thema, damit das Inhaltsverzeichnis angezeigt wird |
composer toc text ist das, was in der Composer-Vorschau erscheint, um anzuzeigen, dass ein Inhaltsverzeichnis generiert wird:
Übersetzungen
| Übersetzung | Standard |
|---|---|
| table_of_contents | Inhaltsverzeichnis |
| insert_table_of_contents | Inhaltsverzeichnis einfügen |
| jump_bottom | Zum Ende springen |
| toggle_toc.show_timeline | Timeline |
| toggle_toc.show_toc | Inhalt |
table_of_contents: "Inhaltsverzeichnis"
Dies wird für den Button verwendet, der das Inhaltsverzeichnis auf Mobilgeräten öffnet
insert_table_of_contents: "Inhaltsverzeichnis einfügen"
Dies wird als Text für den TOC-Button im Composer-Zahnradmenü verwendet
toggle_toc.show_toc: "Inhalt"
toggle_toc.show_timeline: "Timeline"
Diese beschriften den Button, der zwischen dem Inhaltsverzeichnis und der Topic-Timeline wechselt
Wie erstelle ich ein Inhaltsverzeichnis?
- Schreiben Sie ein Thema mit syntaktisch korrekten Überschriften
- Klicken Sie auf den TOC-Button im Composer-Zahnradmenü. Standardmäßig erscheint er nur im ersten Beitrag eines Themas; aktivieren Sie die Einstellung enable TOC for replies, um ihn auch in Antworten zu verwenden
- Profit.
Was passiert mit dem Topic-Progress-Widget, wenn ein Thema ein Inhaltsverzeichnis hat?
Es gibt nicht genug Platz, um beide gleichzeitig anzuzeigen. Daher ist das Topic-Progress-Widget in einem Thema mit TOC, während Sie sich im ersten Beitrag befinden, ausgeblendet, und Sie sehen stattdessen das Inhaltsverzeichnis. Sobald Sie über den ersten Beitrag hinaus scrollen, wird das Inhaltsverzeichnis durch das reguläre Topic-Progress-Widget ersetzt, während Sie Antworten lesen. (Wenn enable TOC for replies aktiviert ist, zeigt eine Antwort mit eigenem TOC diese anstelle des Widgets.)
In Themen mit mehr als einem Beitrag ermöglicht ein Inhalt / Timeline-Button den Wechsel zwischen den beiden, und die Präferenz wird im Browser des Benutzers gespeichert.
Auf schmalen Bildschirmen öffnet sich das Inhaltsverzeichnis als Overlay über einen Button im Topic-Progress-Bereich.
Gibt es Nachteile bei der Verwendung dieser Komponente?
Fast alles passiert clientseitig, sodass Sie die Komponente jederzeit entfernen können und Ihre Beiträge werden so gerendert wie zuvor. Das einzige, was Ihren Inhalt berührt, ist der Composer-Button: Er wrappt den Beitrag in einen <div data-theme-toc="true">-Marker, wodurch die Komponente weiß, dass der Beitrag ein TOC haben soll. Wenn Sie die Komponente deinstallieren, bleibt dieser Wrapper im Beitrag, hat aber keine sichtbare Auswirkung.
Einschränkungen
h6-Überschriften und Überschriften innerhalb von Zitaten sind nicht im Inhaltsverzeichnis enthalten.
Danksagung
Dies begann als harter Fork von Greg Frankos tocify.js-Bibliothek und wurde seitdem als native Ember-Komponenten neu geschrieben. Es gibt keine externen Abhängigkeiten oder Anfragen.
Ein großer Dank an @erlend_sh für viel wertvolles Feedback und an @david für seine Hilfe bei den Übersetzungen.
Danke!
