Discourse プラグインの開発 - パート 2 - プラグインアウトレットへの接続

前のチュートリアル: Developing Discourse Plugins - Part 1 - Create a basic plugin


始めましょう: テンプレート

Discourse のクライアントアプリケーションは、Ember.js という JavaScript フレームワークを使用して記述されています。Ember は、HTML を生成するために テンプレート を使用します。そのリンク先にはテンプレート言語の素晴らしい入門記事がありますので、必ず詳しく読んでください。

問題: Discourse ユーザーインターフェースへの要素の追加

多くのプラグインは、Discourse の Web インターフェースに要素を追加し、拡張する必要があります。これを行うためのメカニズムとして、Handlebars テンプレート内の「プラグインアウトレット」を提供しています。

Discourse のテンプレートを見て回ると、以下のようなマークアップをよく見かけるでしょう。

<PluginOutlet @name="edit-topic" />

これは「edit-topic」という名前のプラグインアウトレットを宣言しています。これはテンプレート内の拡張ポイントであり、プラグイン作成者が独自のマークアップを追加するために活用できます。

プラグインを作成する際は、変更したい Discourse のテンプレート(.gjs ファイル)内に <PluginOutlet /> がないか探してください。もし存在しない場合は、私たちに拡張を依頼してください。適切なユースケースがあれば、喜んで追加します。より簡単かつ迅速に対応できるよう、GitHub でプルリクエストを提出してください!

:exclamation: プラグインアウトレットが存在する場所を確認したい場合は、POSIX 準拠のシェルで以下のコマンドを実行できます。

git grep -A 1 "<PluginOutlet" -- "*.gjs"

また、Discourse 開発者ツールバーを有効にすることで、Discourse サイト上でプラグインアウトレットを表示することもできます。Discourse フォーラムのブラウザコンソールで enableDevTools() と入力し、ページの左側に表示されるプラグアイコンをクリックしてください。

プラグインアウトレットへの接続

追加したいプラグインアウトレットが見つかったら、そのための connector(コネクタ)を作成する必要があります。コネクタとは、ファイルパスに connectors/<アウトレット名> が含まれる .gjs コンポーネントです。

例えば、Discourse テンプレートに以下がある場合:

<PluginOutlet @name="evil-trout" />

connectors/evil-trout ディレクトリ内に作成する任意の .gjs ファイルが自動的に追加されます。したがって、以下のファイルを作成した場合:

plugins/hello/assets/javascripts/discourse/connectors/evil-trout/hello.gjs

内容が以下であれば:

<template>
  <b>Hello World</b>
</template>

Discourse はそのテンプレートの該当箇所に <b>Hello World</b> を挿入します。

ファイル名を hello.gjs としましたが、ファイル名(ディレクトリ名ではなく)は重要ではありません。ただし、すべてのプラグイン間で一意である必要があります。何を拡張するかを説明する名前にすると、将来的なデバッグが容易になります。

トラブルシューティング

  • コネクタの名前を再確認し、プラグイン名と完全に一致しているか確認してください。

詳細情報


シリーズの続き

パート 1: プラグインの基礎
パート 2: このトピック
パート 3: サイト設定
パート 4: git のセットアップ
パート 5: 管理インターフェース
パート 6: 受入テスト
パート 7: プラグインを公開する


このドキュメントはバージョン管理されています。変更の提案は GitHub でおこなってください。

「いいね!」 38

Is there a list of plugin outlets?

More specifically I would like to know if one could modify the “create topic” template?

「いいね!」 1

In what way? Add new fields to the composer area (like the tagging plugin does)?

Yes, that’s what I am searching for.

I’d take a look at the tagging plugin then. It might have all you want!

「いいね!」 2

@eviltrout is there a way to output directly to JSON.
basically creating a new API endpoint?

Ahhhhhhhh. new to this whole “ruby fad” :smiley:
I have a partial solution that i’ll detail in:

Hi Robin,

The plugin-outlet-locations plugin seems to declare all the connectors with a register_asset line in plugin.rb. Starting here: discourse-plugin-outlet-locations/plugin.rb at master · Mittineague/discourse-plugin-outlet-locations · GitHub

Is that a necessary step?

Nope - that’s not necessary. All .es6 and .hbs files are loaded automatically in plugins.

「いいね!」 4

I am still trying to figure out how plugins in Discourse work and I could use a little help.

I would like to modify the timeline scroll bar (in the right side of each topic). Actually, what I need to do is add some stuff (image/banner) below the scroll bar.
What template should I edit? Is there an existing plugin-outlet for that?

Thank you,
Ilias

2018-4-28 work for me!

1. Plugin Outlet name

2. Code

3. Result

「いいね!」 7

This guide is great! I had my plugin showing in the /admin/plugins quite easily.

I was wondering though, how do you delete items from a template?

For privacy reasons, I wanted to delete the export to csv button in the /admin/users/list/active as well as the show emails button. But I didn’t find a plugin outlet connector for those parts of the UI.

I was trying to overwrite the following templates

/users-list-show.hbs
/users-list.hbs

with my plugin outlet.

But creating these files
/var/www/discourse/plugins/[my-plugin]/assets/javascripts/admin/templates/users-list-show.hbs
/var/www/discourse/plugins/[my-plugin]/assets/javascripts/admin/templates/users-list.hbs
and making changes to them didnt seem to work. Even after deleting the /var/www/discourse/tmp folder and restarting the server.

Is this the correct way to delete those buttons from the UI? Using css display: none; isn’t an option.

I feel like I am missing something really simple, any ideas?

Not a direct technical answer to your question but why would you want to do that?

Only the admins can do this. They usually have full control of the server most likely anyway and could read the database, so hiding a button is a bit futile: emails will also show up in the Email logs and on your mail service logs. I’m afraid site admins are going to see a lot of email addresses!

Admins have full control, they see everything (except passwords presumably), so this is normal.

If you are an admin, get used to the responsibility which comes with knowing all of this!

My concern was that moderators can access some things in the admin dashboard.
They can navigate to the ‘users’ tab and see the Export and the Show Emails buttons
image

We don’t want our moderators to be able to grab bulk emails like this.
I understand that the emails are visible on users profiles, but we didn’t want an easy way to get this information.

So I was trying to create a plugin that hides these buttons.

Could be wrong, but this suggests it’s not an issue … have you Impersonated a Mod?

Yes, the screenshot I took was from impersonating a mod.

We have a similar setup as the link you provided (Moderators ability to see emails inconsistent).

I’m not requesting the Discourse team makes any changes though, this isn’t an issue with Discourse.

I am trying customize Discourse for our situation. I was hoping that using a plugin outlet and referencing the files within that plugin was the right way to overwrite a template in Discourse. I just wasn’t able to successfully overwrite these files:

/users-list-show.hbs
/users-list.hbs

My changes never showed up. So I thought this plugin outlet topic could help

「いいね!」 1

Perhaps someone else can chime in, but I’ve always seen Outlets as additive. You may need an override technique instead (via javascript/Ember). I’m still learning this myself :).

「いいね!」 2

I’m thinking that if overriding a template is the goal that it might be better to do this with a theme instead of a plugin.

I was thinking that as well, but I didn’t want a user to swap their theme and be able to get different functionality. So I figured a plugin outlet would do the trick

I think you can probably hide those with CSS.

「いいね!」 2