#数字 を Redmine のチケットへのリンクに変換します。 API アクセスキーが設定されている場合は、チケットの名前を自動で付加します。 また、メッセージの内容を Redmine に投稿するためのリンクを各メッセージに付加します。
config/filter_intra.yml に以下を記述します
- name: redmine_ticket_link
また部屋の設定画面からRedmineのルートURL、APIアクセスキー、チケットを作成するプロジェクトを指定できます。 APIアクセスキーはRedmineの”個人設定 > API アクセスキー”から確認できます。
ソースコードをハイライトします。 記法は
例えば,
ruby::
puts "Hello World!"
と記述することで、2行目がハイライトして表示されます。
また、Graphviz の dot 記法もサポートしています。
graphviz::
digraph{A->B->C->A}
のように、 graphviz:: に続けて dot 記法を記述することで 簡単なグラフを描画することができます。
メッセージ中の :絵文字名: を画像として展開します。
config/filter_intra.yml に以下を記述します
- name: emoji_filter
展開される画像は、環境変数 AS_EMOJI_URL_ROOT を使用して $AS_EMOJI_URL_ROOT/絵文字名.png として展開されます。
AsakusaSatellite に同梱する場合は以下の手順で画像ファイルを配備します。
上記のように設定した場合、メッセージ中に :xxx: と記述した場合 http(s)://as.root.url/emoji/xxx.png を展開して表示します。
動作確認が目的の場合は以下の2つの URL を指定できます。
上記 URL を指定した場合、メッセージ中に :smile: と記述した場合、http://www.emoji-cheat-sheet.com/graphics/emojis/smile.png と展開され、以下のように画像を表示します。
ルールベースでメッセージの変換を定義し、画像として展開します。
- name: emoticon_filter
rule.yml は yaml 形式でキーにメッセージの変換対象、値に変換後に表示するファイル名を記述します。
例えば、rule.yml に
- (test): test.gif
と記述した場合は <AS_ROOT>/public/emoticons/test.gif に画像ファイルを保存し、メッセージ中に (test) と記述することで画像が展開されます。
AsakusaSatellite は Twitter の OAuth を用いて認証を行いますが、 本プラグインを有効にすると、ローカルのユーザリストを用いた認証に切り替えます。
<AS_ROOT>/config/settings.yml に以下を記述します。 本設定を行うことにより、Twitter の OAuth による認証は無効になり、 ローカル認証が有効になります。
login_link: "localauth"
次に、ユーザリストにユーザを追加します。 ユーザリストは以下のファイルです。
<AS_ROOT>/plugins/as_localauth_plugin/config/users.yml
内容は以下の形式です。
testuser1:
screen_name: Test User1
password: b444ac06613fc8d63795be9ad0beaf55011936ac
profile_image_url: http://example.com/test1_user.png
ユーザリストは YAML 形式で記述します。
testuser1 の部分 にはユーザ ID を記述します。
screen_name はユーザの表示名を記述します。
password にはパスワードの SHA-1 ハッシュを記述します。 SHA-1 ハッシュの生成は、以下のコマンドで行うことができます。
$ ruby <AS_ROOT>/plugins/as_localauth_plugin/script/gen_sha1 <PASSWORD>
profile_image_url にはユーザのアイコンの URL を記述します。 データ URI スキームも指定することもできます。 testuser2 の例を参考にしてください。
AsakusaSatellite の認証を Redmine の API アクセスキーによる認証に切り替えます。
<AS_ROOT>/config/settings.yml に以下を記述します。
login_link : "redmineauth"
login_link_redmine: "Redmine の URL"
- RedmineのAPIアクセスキー
- AsakusaSatellite で使用するユーザ名
- AsakusaSatellite で使用する画像の URL
このプラグインで認証されたユーザは、ユーザ ID として Redmine のユーザの メールアドレス が保存されます。 したがって、private に設定された部屋にこのプラグインで認証されたユーザを追加する場合は、Redmine のユーザの メールアドレス を指定する必要があります。