 |
Zusammenfassung | Wandelt eine Tabelle in einem Thema in durchsuchbare Einträge um, die Mitglieder mit + erwähnen können, inklusive Links und Onebox-Vorschauen. |
 |
Repository | Discourse Mentionables |
 |
Installationsanleitung | Plugins auf einer selbst gehosteten Discourse-Seite installieren |
 |
Sponsoring | Bitte erwäge, die laufende Entwicklung zu unterstützen, um sicherzustellen, dass diese Plugins gewartet werden und mit der aktuellen Discourse-Version funktionieren. |
Gib deiner Community einen gemeinsamen Wortschatz für die Dinge, über die sie spricht: Bücher, Produkte, Projekte, Orte, Hilfsangebote oder alles andere mit einer URL. Mitglieder geben + und einen Teil eines Namens ein, wählen einen Vorschlag und erhalten einen lesbaren Link, ohne sich die Adresse merken zu müssen.
Funktionen
- Starte nur mit URLs. Der Importer ruft Namen ab und generiert Slugs; füge deine eigenen Namen und Slugs als optionale Überschreibungen hinzu.
- Suche beim Schreiben. Tippe
+oder nutze die Symbolleistenschaltfläche im Composer, um deinen Katalog zu durchsuchen. Funktioniert sowohl im Markdown- als auch im Rich-Text-Composer. - Lesbare Inline-Links. Erwähnungen erscheinen als kompakte Pills mit dem Anzeigenamen des Eintrags, während ein stabiler Slug im Markdown des Beitrags verwendet wird.
- Native Oneboxes. Setze eine Erwähnung auf eine eigene Zeile, um eine Onebox mit den vorhandenen Layouts und unterstützten Zielen von Discourse anzuzeigen.
- Desktop-Vorschauen. Bewege den Mauszeiger über eine Inline-Pill oder fokussiere sie per Tastatur, um eine schwebende Vorschau mit dem Link Originalseite öffnen anzuzeigen. Normale Klicks öffnen das Ziel.
- Ein Katalog, den deine Admins in Discourse bearbeiten können. Importiere aus einer Markdown-Tabelle im Eröffnungsbeitrag eines Themas. Weder ein Google-Konto noch API-Zugangsdaten sind erforderlich.
- Eine Tabellen-Schaltfläche für Admins. Füge eine leere Mentionables-Tabelle aus der Symbolleiste des Composers ein und fülle dann deine Einträge aus.
Das Aussehen der Onebox hängt vom Ziel und der normalen Onebox-Unterstützung von Discourse ab. Nicht unterstützte Ziele bleiben normale Links. Schwebende Karten erfordern eine Anmeldung; Gäste können weiterhin den Ziel-Link verfolgen. Erwähnungen in Codeblöcken werden ignoriert, und Erwähnungen in Listen und Zitaten bleiben inline.
Basis-Mentionables und die Pro-Erweiterung
Basis-Mentionables ist das Basis-Plugin. Pro ist ein optionales Begleit-Plugin, das zusätzlich installiert wird; Pro enthält die Basis-Funktionen über diese Abhängigkeit.
| Funktion | Basis-Mentionables | Mit Pro-Erweiterung |
|---|---|---|
| Import einer Markdown-Tabelle aus dem Eröffnungsbeitrag eines Themas | Ja | Ja |
| Quellthema in einer eingeschränkten Kategorie halten | Ja | Ja |
| Nur für Admins verfügbare Composer-Schaltfläche zum Einfügen eines Tabellen-Gerüsts | Ja | Ja, einschließlich Icon-Spalten |
Suche mit + in Markdown- und Rich-Text-Composern |
Ja | Ja |
| Inline-Erwähnungs-Pills und eigenständige native Oneboxes | Ja | Ja |
| Schwebende Vorschauen bei Desktop-Hover oder Tastaturfokus | Ja | Ja, im Standard-Hover-Modus |
| Import aus Google Sheets unter Verwendung eines Service-Accounts | — | Ja |
| Auswahl zwischen Themen-Tabellen und Google Sheets | Nur Themen-Tabellen | Ja |
| Automatische Synchronisierung alle 12 Stunden | — | Optional, standardmäßig deaktiviert |
| Import optionaler Icon-Namen und HTML-Farben | — | Ja, aus beiden Quellen |
| Öffnen schwebender Vorschauen per Klick oder Tipp, einschließlich Touch-Geräten | — | Optional |
Die Spalten icon und icon_colour in Pro fügen ein farbiges Icon vor dem Namen der Erwähnung ein. Verwende zum Beispiel book und #2563eb für ein Handbuch. Wenn mentionables_pro_click_to_preview aktiviert ist, öffnet ein Klick oder Tipp auf eine Pill deren Vorschau; der Link Originalseite öffnen in der Vorschau führt dich zum Ziel.
Die Pro-Erweiterung steht meinen monatlichen GitHub-Sponsoren zur Verfügung. Sponsere mich hier, um Zugang zu Pro zu erhalten
Schnelle Einrichtung
-
Installiere das Basis-Plugin mithilfe der oben genannten Installationsanleitung. Baue Discourse nach der Installation neu.
-
Erstelle ein Thema für deinen Katalog. Verwende als Admin Mentionables-Tabelle einfügen in der Symbolleiste des Composers oder füge diese Tabelle in den Eröffnungsbeitrag ein:
| name | url | slug | image_url | | ------------------ | ----------------------------------- | ------------------ | --------- | | Getting started | https://example.com/getting-started | getting-started | | | Community handbook | https://example.com/handbook | community-handbook | | | Events calendar | https://example.com/events | events-calendar | | -
Ersetze die Beispiel-URLs durch deine eigenen, speichere den Beitrag und setze
mentionables_topic_idauf die numerische ID dieses Themas. Haltementionables_enabledaktiviert. Bei Pro-Installationen sollte für diese Einrichtungtopic_tableinmentionables_sourceausgewählt sein. -
Öffne Admin → Plugins → Mentionables, klicke auf Import starten und dann auf Aktualisieren, um den Bericht zu prüfen. Der Hintergrund-Job-Worker muss laufen.
-
Lade deinen Browser neu, öffne einen Composer und tippe
+, um deine Einträge auszuprobieren.
Verwende kleine Buchstaben für die Spaltennamen. Nur url ist erforderlich, beginnend mit http:// oder https://. Zeilen mit nur einer URL rufen einen Namen vom Ziel ab und generieren einen Slug. Du kannst name, slug oder beides angeben, um diese Standardwerte zu überschreiben, wobei du diese Optionen innerhalb einer Tabelle mischen kannst. Wenn kein Titel verfügbar ist, wird die URL zum Anzeigenamen. Bestehende URLs behalten ihre Slugs, wenn die Quelle sie weglässt. image_url und description sind optional.
Der Importer liest die erste nicht zitierte Tabelle mit einer url-Spalte im Eröffnungsbeitrag. Antworten, zitierte Tabellen und Codebeispiele in Codeblöcken werden ignoriert. Quellthemen müssen reguläre, nicht gelöschte Themen sein, keine persönlichen Nachrichten.
Privatsphäre der Quelle und Aktualisierung deines Katalogs
Du kannst das Quellthema in der Kategorie Staff oder in einer anderen eingeschränkten Kategorie halten, damit nur vertrauenswürdige Personen es pflegen können. Die importierten Namen, URLs und Bilder stehen allen zur Verfügung, die Mentionables verwenden. Die Einschränkung des Themas macht den importierten Katalog nicht privat. Halte vertrauliche Informationen aus der Tabelle heraus.
Jeder Import synchronisiert anhand der URL: übereinstimmende URLs werden aktualisiert, neue URLs erstellen Datensätze, und aus der Quelle entfernte URLs löschen Datensätze. Die vollständige Quelle muss gültig sein; doppelte URLs oder Slugs, ungültige Zeilen, Abruffehler und eine leere Quelle lassen den Katalog unverändert. Verwende Alle löschen für eine bewusste Löschung. Quellthemen und Tabellenkalkulationen (Spreadsheets) werden niemals geändert. Die optionale Einstellung mentionables_pro_sync_enabled in Pro führt denselben Import alle 12 Stunden aus. Lade den Browser nach dem Import neu. Vorhandene Beiträge werden nicht automatisch neu gerendert (Rebake), und das explizite Ändern eines Slugs kann frühere +slug-Referenzen brechen.
Einstellungen und weitere Informationen
| Einstellung | Zweck |
|---|---|
mentionables_enabled |
Aktiviert oder deaktiviert Mentionables. |
mentionables_topic_id |
Thema, das die Quelltabelle in seinem Eröffnungsbeitrag enthält. |
mentionables_autocomplete_limit |
Maximale Anzahl an Vorschlägen; Standardwert ist fünf. |
mentionables_onebox_fallback |
Ruft fehlende Bilder/Beschreibungen ebenfalls ab, wenn ein Name angegeben wird; standardmäßig deaktiviert. |
Siehe das README für die vollständige Einrichtungsanleitung, das Importverhalten und Fehlerbehebung. Die Screenshots verwenden Beispieldaten aus den Test-Fixtures des Plugins.
