Idealerweise sollten Sie bei der Anpassung von Discourse über Themes/Plugins CSS, die JavaScript Plugin API oder Plugin Outlets verwenden. Wenn keine dieser Methoden für Ihren Anwendungsfall funktioniert, können Sie gerne einen PR für den Discourse-Kern öffnen oder hier auf Meta ein #dev-Thema starten. Wir diskutieren gerne die Hinzufügung neuer Outlets/APIs, um die Anpassung zu erleichtern.
Wenn Sie alle anderen Optionen ausgeschöpft haben, müssen Sie möglicherweise auf Template-Überschreibungen zurückgreifen. Diese Technik ermöglicht es Ihnen, das gesamte Template jeder Ember Component oder Route aus Ihrem Theme/Plugin zu überschreiben.
Dies ist keine empfohlene Methode zur Anpassung von Discourse. Tägliche Änderungen im Discourse-Kern werden irgendwann mit Ihrer Template-Überschreibung in Konflikt geraten und potenziell katastrophale Fehler bei der Darstellung des Forums verursachen.
Wenn Sie sich für diesen Ansatz entscheiden, stellen Sie sicher, dass Sie über ausreichende automatisierte Tests und QA-Prozesse verfügen, um Regressionen zu erkennen. Wenn Sie ein Theme/Plugin mit Template-Überschreibungen vertreiben, stellen Sie bitte sicher, dass die Forum-Administratoren sich der Stabilitätsrisiken bewusst sind, die Ihr Theme/Plugin mit sich bringt.
.gjs-Dateiformat von Ember erstellt wurden. Vorlagen für diese Komponenten sind inline definiert und können nicht von Themes/Plugins überschrieben werden.Zukünftig sollten alle Template-Anpassungen über Plugin Outlets erfolgen.
Ich verstehe, dass dies in naher Zukunft fehlschlagen wird, zeigen Sie mir trotzdem die Dokumentation
Überschreiben von Komponenten-Templates
Um ein Ember Component-Template zu überschreiben (d. h. alles unter components/* im Discourse-Kern), sollten Sie eine gleichnamige .hbs-Datei in Ihrem Theme/Plugin erstellen. Um beispielsweise das Template für die Komponente badge-button im Discourse-Kern zu überschreiben, würden Sie eine Template-Datei an folgendem Ort in Ihrem Theme/Plugin erstellen:
{theme}/javascripts/discourse/templates/components/badge-button.hbs
{plugin}/assets/javascripts/discourse/templates/components/badge-button.hbs
Die Überschreibung muss immer im Verzeichnis /templates verschachtelt sein, auch wenn die Kernkomponente ein „kolokalisiertes“ Template hat.
Überschreiben von Routen-Templates
Das Überschreiben von Routen-Templates (d. h. alle Nicht-Komponenten-Templates unter templates/*) funktioniert genauso wie bei Komponenten. Erstellen Sie eine gleichnamige Vorlage in Ihrem Theme/Plugin. Um beispielsweise discovery.hbs im Kern zu überschreiben, würden Sie eine Datei wie diese erstellen:
{theme}/javascripts/discourse/templates/discovery.hbs
{plugin}/assets/javascripts/discourse/templates/discovery.hbs
Überschreiben von „Raw“-Templates (.hbr)
Discourse’s „Raw“-Template-System wird bald durch reguläre Ember-Komponenten ersetzt. Vorerst funktioniert das Überschreiben von Raw-Templates jedoch genauso wie bei Ember-Templates. Um beispielsweise topic-list-item.hbr im Kern zu überschreiben, könnten Sie eine Datei wie diese erstellen:
{theme}/javascripts/discourse/templates/list/topic-list-item.hbr
{plugin}/assets/javascripts/discourse/templates/list/topic-list-item.hbr
Interaktion zwischen mehreren Themes / Plugins
Wenn mehrere installierte Themes/Plugins dasselbe Template überschreiben, gewinnt dasjenige mit der niedrigsten Nummer in dieser Liste:
- Theme-Überschreibungen (höchste Theme-‘id’ gewinnt)
- Plugin-Überschreibungen (neuester alphabetischer Plugin-Name gewinnt)
- Kern
Diese Priorität bedeutet auch, dass Sie Plugin-Templates von Themes überschreiben können. Technisch gesehen können Sie auch Theme-Templates von anderen Themes und Plugin-Templates von anderen Plugins überschreiben, aber das Verhalten kann aufgrund der Abhängigkeit vom Plugin-Namen und der Theme-ID überraschend sein.
Wie funktioniert das?
Discourse setzt Templates in der Klasse DiscourseTemplateMap zusammen und priorisiert sie. Für kolokalisierte Komponenten-Templates werden diese Informationen während der App-Initialisierung verwendet, um die Kern-Template-Zuordnungen zu ersetzen. Für alle anderen Templates wird die Map von dem Resolver zur Laufzeit verwendet, um das korrekte Template abzurufen.
:small: Dieses Dokument ist versionskontrolliert – schlagen Sie Änderungen auf github vor.
).