(非推奨)テーマやプラグインからDiscourseのテンプレートを上書きする

理想的には、Discourse をテーマやプラグインでカスタマイズする際、CSS、JavaScript プラグイン API、またはプラグインアウトレットを使用すべきです。これらがあなたのユースケースに当てはまらない場合は、Discourse コアへの PR を開くか、Meta の Development トピックを開始してください。カスタマイズを容易にするための新しいアウトレットや API の追加について、いつでも議論に喜んで応じます。

他のすべての選択肢が尽きた場合、テンプレートオーバーライドに頼る必要があるかもしれません。このテクニックにより、テーマ/プラグインから任意の Ember コンポーネントまたはルートのテンプレート全体をオーバーライドできます。

:rotating_light: これは Discourse をカスタマイズする推奨されない方法です。 Discourse コアの日々の変更は、最終的にあなたのテンプレートオーバーライドと競合し、フォーラムのレンダリング時に深刻なエラーを引き起こす可能性があります。

このアプローチを採用する場合は、リグレッションを検出するための十分な自動テストと QA プロセスを持っていることを確認してください。テンプレートオーバーライドを含むテーマ/プラグインを配布する場合は、フォーラム管理者があなたのテーマ/プラグインが抱える安定性のリスクを理解していることを確認してください。

:rotating_light: :rotating_light: :rotating_light: 2023年10月更新: 新しい機能について、Discourse はますます Ember の .gjs ファイル形式で作成されたコンポーネントの使用に移行しています。これらのコンポーネントのテンプレートはインラインで定義されており、テーマ/プラグインによってオーバーライドすることはできません。

今後、すべてのテンプレートカスタマイズは Plugin Outlets を使用して行うべきです。

近いうちにこれが壊れることは理解しているが、とにかくドキュメントを見せて

コンポーネントテンプレートのオーバーライド

Ember コンポーネントのテンプレート(つまり、Discourse コアの components/* 配下のすべて)をオーバーライドするには、テーマ/プラグイン内で同じ名前の .hbs ファイルを作成する必要があります。例えば、Discourse コアの badge-button コンポーネントのテンプレートをオーバーライドするには、テーマ/プラグイン内の以下の場所にテンプレートファイルを作成します:

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

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

コアのコンポーネントが「同置(colocated)」テンプレートを持っていた場合でも、オーバーライドは常に /templates ディレクトリ内にネストされていなければなりません。

ルートテンプレートのオーバーライド

ルートテンプレート(つまり、templates/* 配下のコンポーネント以外のすべてのテンプレート)のオーバーライドは、コンポーネントと同様の方法で機能します。テーマ/プラグイン内で同じ名前のテンプレートを作成します。例えば、コアの discovery.hbs をオーバーライドするには、次のようなファイルを作成します:

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

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

複数のテーマ/プラグイン間の相互作用

複数のインストールされたテーマ/プラグインが同じテンプレートをオーバーライドする場合、「勝者」となるのは、以下のリストの中で最も低い番号のランキングを持つものです:

  1. テーマのオーバーライド(最も大きいテーマの ‘id’ が勝つ)
  2. プラグインのオーバーライド(アルファベット順で最も新しいプラグイン名が勝つ)
  3. コア

この優先順位により、テーマからプラグインのテンプレートをオーバーライドすることもできます。技術的には、他のテーマからテーマのテンプレートを、または他のプラグインからプラグインのテンプレートをオーバーライドすることもできますが、プラグイン名とテーマ ID への依存関係により、動作が予測しにくい場合があります。

これはどのように機能するのか?

Discourse は DiscourseTemplateMap クラス内でテンプレートを組み立て、優先順位付けを行います。同置コンポーネントテンプレートの場合、その情報はアプリ初期化中に使用され、コアのテンプレート関連付けが置き換えられます。その他のすべてのテンプレートについては、マップが実行時のリゾルバーによって使用され、正しいテンプレートを取得するために使用されます。


このドキュメントはバージョン管理されています - 変更提案は github で。

「いいね!」 17

モバイルテンプレートについてはどうですか?コアのテンプレートを書き直すためのディレクトリ構造は何ですか?

それは全く同じように機能するはずです。コアテンプレートの名前を一致させます。したがって、/mobile がある場合は、オーバーライドに含めてください。

モバイルの login.hbs テンプレートを書き直そうとしていますが、うまくいきません Imgur: The magic of the Internet

スクリーンショットでは、完全なパスが表示されていないように見えます。テキストとしてここに貼り付けていただけますか。

themeroot/javascripts/mobile/modal/login.hbs

パスにdiscourse/templatesがありません

したがって、この場合は{theme}/javascripts/discourse/templates/mobile/modal/login.hbsになります。

「いいね!」 2

これはまだ当てはまりますか?

多くのコードを上書きする機能が削除されるのは少し残念です。

Widget システムをある程度置き換えるのは理にかなっていますが、これにより複数のレベルで既存のコードにフックすることができ、次のようなことを可能にする巧妙な方法で小さなブロックのみを対象とすることで、多くの破壊的変更のリスクを軽減できました。

  • 機能を追加する
  • 他のものを邪魔しない。

たとえば、Discourse Journal から 2 つの重要な機能を削除しなければなりませんでした。これはウィジェットのきめ細かなオーバーライドに基づいていたためですが、Glimmer でそれらを再作成する唯一の方法は、テンプレートのオーバーライドのペア (.gjs ファイルの変更を試みるものを含む) を介して行うことでしたが、これはサポートされなくなったようです。

たとえこれがサポートされていたとしても、ウィジェットフレームワークの下よりも大きなコードのストレッチをオーバーライドすることになり、コアの変更がオーバーライドと競合するリスクが増加します。

これはプラットフォームの拡張性にとって健全ではありません。

何かできることはありますか?

「いいね!」 7

ええ、わかります。ウィジェットの拡張性APIには良い点もありました。

しかし、その一方で、ウィジェットベースのUIのコア部分を少しでも変更するのが非常に困難でした。なぜなら、人々がどのようなランダムなメソッドやデコレーションを導入しているかわからなかったからです。そのため、ウィジェットのカスタマイズは比較的安定しているように見えました。コアの実装に触れるのが怖すぎたのです。

今後のための私たちの解決策は、Wrapper Plugin Outlets です。これらは、テーマやプラグインがテンプレートの非常に小さなチャンクを独自のインプリメンテーションでオプションでオーバーライドできるようにします。

例えば、Chatがどのように条件付きでホームロゴをオーバーライドしているか を見てください。カスタムコンポーネント で。これは、既存のウィジェットベースのヘッダーと、新しいGlimmerベースのヘッダー(近日公開予定!:tm:)の両方で機能します。

私たちは、さまざまな場所に新しいラッパーアウトレットを追加するPRを一般的に受け入れています。特定のユースケースについて不明な点がある場合は、お気軽に詳細を添えて#devトピックを開いてください!

「いいね!」 10

わかりました、それは前進するための方法のようですね。ありがとうございます。

その影響を消化し、それに沿った戦略に調整する必要があります。

ご回答に感謝します!

「いいね!」 6