CookBook

IMBox に投稿種別を追加する方法(Markdown)

投稿日:

このCookBookでは、IMBoxに投稿種別を追加する方法について紹介しています。
以下のドキュメントを参照することで、IMBox に投稿種別を追加することができます。
IMBox プログラミングガイド - メッセージ種別追加プログラム

この CookBook では、投稿したメッセージを Markdown として解釈し HTML に変換し表示する投稿種別を追加します。
Markdown の解析には以下のライブラリを用います。
chjj/marked
Markdown の解析結果から script タグ等をサニタイズ際には以下のライブラリを用います。
cure53/DOMPurify

Markdown ではなく textile の投稿種別については以下を参照してください。
IMBox に投稿種別を追加する方法(textile)

完成イメージ


1. 投稿種別に「メッセージ(Markdown)」を選択します。
2. メッセージを入力します。
3. 投稿します。

完成サンプル

以下の完成サンプルをダウンロードしてご活用ください。

e builder プロジェクト : im_cookbook_129456.zip
imm ファイル : im_cookbook_129456-1.0.0.imm

ローカル環境で表示させる場合は、以下のURLにアクセスしてください。
http://localhost:8080/imart/imbox
なおベースURLである以下の部分は、環境に合わせて適宜変更してください。
http://localhost:8080/imart

レシピ

  1. imbox-message-config を作成します。
  2. 投稿処理を作成します。
  3. タイムライン表示画面を作成します。
  4. marked を配置します。
  5. DOMPurify を配置します。

1. imbox-message-config を作成します。

src/main/conf/imbox-message-config/imbox-message-config_im_cookbook_129456.xml

行数 説明
12 メッセージ種別名称を設定します。
13 投稿欄表示用のファイルパスを設定します。
14 タイムライン表示用のファイルパスを設定します。

2. 投稿処理を作成します。

src/main/jssp/src/im_cookbook_129456/message_type/views/type_markdown.js

src/main/jssp/src/im_cookbook_129456/message_type/views/type_markdown.html

行数 説明
32 メッセージを取得します。
55 メッセージをアトリビュートで受け取るため本属性は使用しません。そのためダミーのデータを設定します。
60 アトリビュートを JSON に変換します。

3. タイムライン表示画面を作成します。

src/main/jssp/src/im_cookbook_129456/message_type/views/markdown_timeline.js

行数 説明
11 送信されたメッセージを取得します。
src/main/jssp/src/im_cookbook_129456/message_type/views/markdown_timeline.html

行数 説明
19 メッセージを取得します。
20~29 メッセージをパースし html に変換します。その際、いくつかのクラスにスタイルを追加するために文字列の置換を行います。
30 変換後の html をサニタイズします。
32 変換後の html を表示します。

4. marked を配置します。

以下から marked をダウンロードし、marked-master/lib/marked.js を Web サーバの %CONTEXT_PATH%/csjs/libs/marked/lib/marked.js に配置します。
chjj/marked

5. DOMPurify を配置します。

以下から DOMPurify をダウンロードし、DOMPurify-master/dist/purify.min.js を Web サーバの %CONTEXT_PATH%/csjs/libs/DOMPurify/dist/purify.min.js に配置します。
cure53/DOMPurify

まとめ

この CookBook では、Markdown を入力できるメッセージ種別を追加する方法を紹介しました。
お客様の用途にあわせて是非ご活用ください。

-CookBook

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

IM-FormaDesignerで作成したフォーム内で、外部連携を利用して最も簡単に値を渡す方法(単一アイテム編)

このCookBookでは、IM-FormaDesignerで作成したフォーム画面の中で、アイテムからアイテムへ値を渡す方法について紹介します。 今回は例として、文字列と数値の値を同時にアイテムからアイ …

no image

差戻し先ノードの処理対象者を再展開するフローを作成する方法

このCookBookでは、差戻し先ノードの処理対象者を再展開するフローを作成する方法について紹介しています。 IM-Workflowの仕様として、差戻し先ノードではそのノードを以前に処理した人のみが再 …

IM-Wiki

Wiki機能の活用例

このCookbookでは、intra-mart Accel Platform 2018 Springから利用可能なWiki機能(IM-Wiki)の活用例について紹介します。 今回の記事では実際にWik …

no image

IM-LogicDesignerで、Redmineカスタムクエリのチケット一覧を取得する方法

このCookBookでは、IM-LogicDesignerを使用してRedmineのチケット (issues) 一覧を取得する方法を紹介します。 Redmineは、外部からチケット一覧を取得するための …

no image

e Builder から Payara を起動する方法

この CookBook では、e Builder から Payara を起動する方法について紹介しています。 レシピ External Tools を表示します。 Program を追加します。 Pr …

まだデータがありません。

RSSRSSRSSRSS