(nicht empfohlen) Überschreiben von Discourse-Templates aus einem Theme oder Plugin

Idealerweise sollten Sie beim Anpassen von Discourse über Themes oder Plugins CSS, die JavaScript-Plugin-API oder Plugin-Outlets verwenden. Wenn keine dieser Optionen für Ihren Anwendungsfall geeignet ist, können Sie gerne einen PR für den Discourse-Kern einreichen oder hier auf Meta ein #dev-Thema starten. Wir freuen uns immer über Gespräche darüber, wie neue Outlets/APIs hinzugefügt werden können, 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, die gesamte Vorlage einer beliebigen Ember-Komponente oder Route aus Ihrem Theme/Plugin zu überschreiben.

:rotating_light: Dies ist keine empfohlene Methode zur Anpassung von Discourse. Tägliche Änderungen im Discourse-Kern werden Ihre Template-Überschreibung früher oder später konfliktreich machen und möglicherweise katastrophale Fehler beim Rendern des Forums verursachen.

Wenn Sie sich für diesen Ansatz entscheiden, stellen Sie sicher, dass Sie über ausreichende automatisierte Test- und QA-Prozesse verfügen, um Regressionen zu erkennen. Wenn Sie ein Theme/Plugin mit Template-Überschreibungen verteilen, stellen Sie bitte sicher, dass Forum-Administratoren über die Stabilitätsrisiken informiert sind, die Ihr Theme/Plugin mit sich bringt.

:rotating_light: :rotating_light: :rotating_light: Update Oktober 2023: Für neue Funktionen bewegt sich Discourse zunehmend in Richtung der Verwendung von Komponenten, die im .gjs-Dateiformat von Ember erstellt wurden. Vorlagen für diese Komponenten werden inline definiert und können von Themes/Plugins nicht überschrieben werden.

Zukünftig sollten alle Template-Anpassungen über Plugin-Outlets erfolgen.

Ich verstehe, dass dies in naher Zukunft nicht mehr funktionieren wird, zeige mir die Dokumentation trotzdem

Überschreiben von Komponentenvorlagen

Um eine Ember-Komponentenvorlage zu überschreiben (d. h. alles unter components/* im Discourse-Kern), sollten Sie eine gleichnamige .hbs-Datei in Ihrem Theme/Plugin erstellen. Um beispielsweise die Vorlage für die badge-button-Komponente im Discourse-Kern zu überschreiben, erstellen Sie eine Vorlagendatei in Ihrem Theme/Plugin an folgendem Speicherort:

:art: {theme}/javascripts/discourse/templates/components/badge-button.hbs

:electric_plug: {plugin}/assets/javascripts/discourse/templates/components/badge-button.hbs

Die Überschreibung muss immer im /templates-Verzeichnis verschachtelt sein, auch wenn die Kernkomponente eine ‘colocated’-Vorlage hat.

Überschreiben von Routenvorlagen

Das Überschreiben von Routenvorlagen (d. h. alle Nicht-Komponentenvorlagen unter templates/*) funktioniert auf die gleiche Weise wie bei Komponenten. Erstellen Sie eine gleichnamige Vorlage in Ihrem Theme/Plugin. Um beispielsweise discovery.hbs im Kern zu überschreiben, erstellen Sie eine Datei wie:

:art: {theme}/javascripts/discourse/templates/discovery.hbs

:electric_plug: {plugin}/assets/javascripts/discourse/templates/discovery.hbs

Interaktion zwischen mehreren Themes / Plugins

Wenn mehrere installierte Themes/Plugins dieselbe Vorlage überschreiben, gewinnt diejenige mit der niedrigsten Rangnummer in dieser Liste:

  1. Theme-Überschreibungen (höhere Theme-ID gewinnt)
  2. Plugin-Überschreibungen (alphabetisch späterer Plugin-Name gewinnt)
  3. Kern

Diese Priorität bedeutet auch, dass Sie Plugin-Vorlagen aus Themes überschreiben können. Technisch können Sie auch Theme-Vorlagen aus anderen Themes und Plugin-Vorlagen aus anderen Plugins überschreiben, aber das Verhalten kann aufgrund der Abhängigkeit vom Plugin-Namen und der Theme-ID überraschend sein.

Wie funktioniert das?

Discourse sammelt und priorisiert Vorlagen in der Klasse DiscourseTemplateMap. Für colocated-Komponentenvorlagen wird diese Information während der App-Initialisierung verwendet, um die Kernvorlagenassoziationen zu ersetzen. Für alle anderen Vorlagen wird die Karte von dem Resolver zur Laufzeit verwendet, um die richtige Vorlage abzurufen.


Dieses Dokument ist versionskontrolliert – schlagen Sie Änderungen auf GitHub vor.

17 „Gefällt mir“

Und was ist mit mobilen Vorlagen? Wie ist die Verzeichnisstruktur, um Vorlagen aus dem Kern neu zu schreiben?

Es sollte genau gleich funktionieren – Sie passen den Namen der Kernvorlage an. Wenn sie also /mobile enthält, fügen Sie dies in Ihre Überschreibung ein.

Ich versuche, die mobile login.hbs-Vorlage neu zu schreiben, und es funktioniert nicht Imgur: The magic of the Internet, liege ich mit dem Pfad richtig?

Der vollständige Pfad ist in Ihrem Screenshot, soweit ich sehen kann, nicht sichtbar. Bitte fügen Sie ihn hier als Text ein.

themeroot/javascripts/mobile/modal/login.hbs

Sie haben discourse/templates in Ihrem Pfad vergessen

In Ihrem Fall wäre das also {theme}/javascripts/discourse/templates/mobile/modal/login.hbs

2 „Gefällt mir“

Ist das immer noch der Fall?

Ich bin etwas traurig, dass die Möglichkeit, viel Code zu überschreiben, entfernt wird.

Es ist sinnvoll, das maßgeschneiderte Widget-System bis zu einem gewissen Grad zu ersetzen, aber das gab uns die Möglichkeit, auf mehreren Ebenen in bestehenden Code einzugreifen, wodurch das Risiko von Breaking Changes erheblich reduziert wurde, da wir uns auf kleine Blöcke auf clevere Weise konzentrieren konnten, die es uns ermöglichten:

  • Funktionen hinzuzufügen
  • nichts anderes zu stören.

Ich musste zum Beispiel gerade ZWEI wesentliche Funktionen aus Discourse Journal entfernen, die auf feingranularen Überschreibungen von Widgets basierten, da die einzige Möglichkeit, sie in Glimmer neu zu erstellen, über ein Paar Template-Überschreibungen erfolgte (einschließlich des Versuchs, eine .gjs-Datei zu ändern), was anscheinend nicht mehr unterstützt wird.

Selbst wenn dies unterstützt würde, müssten wir größere Codeabschnitte überschreiben als im Widget-Framework, mit einem damit verbundenen erhöhten Risiko, dass Kernänderungen mit den Überschreibungen in Konflikt geraten.

Das ist nicht gut für die Erweiterbarkeit der Plattform.

Kann man etwas dagegen tun?

7 „Gefällt mir“

Ja, ich verstehe dich – es gab einige nette Dinge an den erweiterbaren Widget-APIs.

Aber die Kehrseite ist, dass es für uns unglaublich schwierig war, IRGENDWELCHE der Widget-basierten Benutzeroberflächen im Kern zu ändern, da wir keine Ahnung hatten, welche zufälligen Methoden/Dekorationen Leute möglicherweise einführen. Deshalb schienen Widget-Anpassungen relativ stabil zu sein – wir hatten zu viel Angst, die Kernimplementierungen anzufassen.

Unsere Lösung dafür für die Zukunft sind Wrapper Plugin Outlets. Diese ermöglichen es Themes und Plugins, optional sehr kleine Vorlagenteile mit ihrer eigenen Implementierung zu überschreiben.

Sehen Sie zum Beispiel, wie Chat bedingt das Home-Logo überschreibt mit einer benutzerdefinierten Komponente. Das funktioniert für das bestehende Widget-basierte Header und den neuen Glimmer-basierten Header (bald verfügbar! :tm:).

Wir sind generell bereit, PRs zu akzeptieren, um neue Wrapper-Outlets an verschiedenen Stellen hinzuzufügen. Wenn Sie sich bei einem bestimmten Anwendungsfall unsicher sind, können Sie gerne ein #dev-Thema mit Details eröffnen!

10 „Gefällt mir“

OK, das klingt nach einem gangbaren Weg, danke.

Ich muss die Auswirkungen davon verdauen und meine Strategie entsprechend anpassen.

Ich schätze die Antwort!

6 „Gefällt mir“