 |
概要 | Discourse Templates は、繰り返し使用するためのコンテンツテンプレートを作成するためのプラグインです。テンプレートは特殊なカテゴリに保存されたトピックとして保持され、必要に応じて編集や議論を行うことができます。 |
 |
インストールガイド | このプラグインは Discourse コアにバンドルされています。プラグインを個別にインストールする必要はありません。 |
このプラグインは Discourse Canned Replies のほぼ新しいバージョンですが、より柔軟性があり、テンプレートの保存方法が異なります。
機能
このプラグインは、1つ以上のカテゴリを使用してテンプレートを保存し、後で使用できるようにします。これらのカテゴリ内の各トピックの最初の投稿が、返信のテンプレートとして使用されます。
このアプローチにより、discourse-canned-replies で利用可能だった機能よりもはるかに多くの機能が提供されます。各テンプレートには編集履歴があり、関連するタグを付与でき、必要に応じて後続の投稿を使用してテンプレートのコンテンツについて議論することができます。
表示されるトピックのみがテンプレートとして使用されるため、非公開リストやアーカイブされたトピックはリストされません。
プラグインはまた、カテゴリのセキュリティ設定を活用して、どのユーザーがテンプレートを使用できるかを確認します。ユーザーがカテゴリ内のトピックを読むことができる場合、コンポーザーで「テンプレートを挿入」するオプションが利用可能になります。ユーザーは、アクセス権を持つカテゴリ内のテンプレート/トピックのみを表示できます。
複数の親カテゴリや/およびサブカテゴリを使用して、異なるユーザーグループに異なるセットのテンプレートを提供したり、テンプレートを整理したりすることができます。
非公開テンプレート
プラグインは非公開テンプレートもサポートしています。非公開テンプレートは、テンプレートとしてタグ付けされたプライベートメッセージです。これらのメッセージは、メッセージの作成者に対してのみテンプレートとして利用可能です。
アーカイブされたメッセージはテンプレートとしてリストされません。
すべての非公開テンプレートは以下で見つけることができます：
/u/{USER-NAME}/messages/tags/{PRIVATE-TEMPLATE-TAG}
設定：
discourse templates enabled: プラグインを有効化しますdiscourse templates categories: テンプレートを保存するために使用されるカテゴリ。これらのカテゴリおよびそのサブカテゴリ内の各トピックはテンプレートとして使用され、元のカテゴリでそれらを表示できるユーザーに利用可能になります。discourse templates enable private templates: 非公開テンプレートの使用を有効化します。discourse templates groups allowed private templates: 非公開テンプレートを使用できるユーザーグループ。
スタッフメンバーは常に許可されます。
discourse templates private templates tags: プライベートメッセージをテンプレートとしてマークするために使用されるタグ。
使用方法
プラグインをインストールした後、少なくとも1つのカテゴリを作成してテンプレートを保存する必要があります。
このカテゴリのトピックを読むアクセス権を持つすべてのユーザーが、コンポーザーでプラグイン機能を使用できることに注意してください。
Make new topics wikis by defaultを有効にしてください。
その後、プラグイン設定でカテゴリを指定します。
それだけです。あとは、指定されたカテゴリにいくつかのトピックを作成するだけで、それらがテンプレートとして使用可能になります。
必要に応じて、サブカテゴリを作成してテンプレートをよりよく整理したり、複数のユーザーグループに異なる返信セットを提供したりすることができます。
テンプレートを挿入するには、まず返信コンポーザーを開き、エクストラボタンをクリックしてから、「テンプレートを挿入」オプションを選択します。
希望するテンプレートを選択し、テキストまたはタグで検索して「貼り付け」アイコンをクリックします。
キーボードショートカット
PCでは Ctrl+Shift+I、Macでは ⌘+Shift+I を使用してテンプレートを挿入できます。
非公開テンプレート
動作させるには、以下の Discourse 設定を設定する必要があります：
tagging enabled: 有効である必要があります。enable personal messages: 非スタッフユーザーにも機能を利用可能にしたい場合は有効にする必要があります。pm tags allowed for groups: プライベートテンプレートを使用するグループにプライベートメッセージにタグを付けることを許可する必要があります。
非公開テンプレートを使用するには、まず設定でそれを有効にし、使用できるユーザーグループを割り当て、少なくとも1つのタグをPMをテンプレートとしてマークするために割り当てる必要があります。
パーソナルテンプレートを作成するには、ユーザーは以下を行う必要があります：
- プラグイン設定で構成されたタグのいずれかでタグ付けされた、自分自身への暗号化されていないパーソナルメッセージを送信します。メッセージの作成者のみがそれを非公開テンプレートとして表示します。
事前入力変数
プラグインはテンプレート内で以下の変数をサポートしています：
my_usernamemy_nametopic_titletopic_urloriginal_poster_usernameoriginal_poster_namereply_to_usernamereply_to_namelast_poster_usernamereply_to_or_last_poster_username.
上記すべての変数はフォールバックテキストをサポートしており、フォールバックが指定されていない場合、または変数が置換できない場合は変数が削除されます。
タイトルと本文の両方で変数置換がサポートされています。
例：
%{reply_to_username,fallback:there} さん、
...
よろしくお願いします、
%{my_name}
reply_to_username が利用できない場合、テンプレートは以下のようになります：
こんにちは、
...
よろしくお願いします、
Arpit Jalan
discourse-canned-replies からの移行
既存の定型文をテンプレートに移行するための rake タスクがあります：
rake "discourse-templates:migrate-from-canned-replies"
Meta で 47 の定型文を移行するために数秒しかかからなかったため、膨大な数の定型文がない限り、安全に使用できるはずです。
TODO
コンポーザー以外の場所への機能拡張
テンプレートソースとして複数の親カテゴリの使用を許可