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-Workflowの色々なコンテンツ画面へ遷移するURL

このCookbookでは、IM-Workflowの色々なコンテンツ画面へ遷移するURLをご紹介いたします。 独自で作成した画面やViewCreator、BloomMakerなど、IM-Workflow …

IM-Workflowで案件の参照権限を付与する方法

IM-Workflowで申請者や承認者以外で、案件を参照する方法をご紹介いたします。 申請者や承認者以外で、案件を参照する方法は、下記の2つの方法があります。設定方法や参照するための仕様が異なるため、 …

no image

IM-BloomMaker TreeViewの作成方法

このCookBookでは、intra-mart Accel Platform 2020 Summer から利用可能になったコンテンツ種別「Bulma」で TreeViewのような動きをするサンプルの作 …

IM-BloomMaker のアクション「複数選択組織検索ダイアログを表示する」の使い方

このCookBookでは、「複数選択組織検索ダイアログを表示する」アクションの使用方法について紹介します。 「複数選択組織検索ダイアログを表示する」アクションは、共通マスタから取得した組織情報をダイア …

no image

IM-BloomMaker 異なるコンテンツ間でアクションをコピーする方法

この CookBook では intra-mart Accel Platform 2021 Winter から利用可能になったアクションの複製機能を使用して、異なるコンテンツ間でアクションをコピーする …