技術情報
かんたん機能追加
・ホームページをプラグインとして追加する方法
公開ドキュメント
・JavaDoc API
・設計書ダウンロード
・ファイル、ディレクトリ構造
開発
(1)使用する技術・製品の概要
(2)Eclipseで開発を行う
(3)コンパイルを行う
(4)「Hello World!」プラグインを作成する方法
(5)データベースに接続する方法
(6)セッション情報を取得する方法
(7)テンポラリディレクトリを取得する方法
(8)IDを採番する方法
(9)バッチ処理の実装
(10)ヘルプ機能の実装
(11)メイン>インフォメーションへメッセージ表示
(12)任意のサイトからログインする方法
(13)メイン画面にポートレットを表示する方法
その他
・H2 Database Engineに関する技術・製品の概要

ホームページをプラグインとして追加する方法

-- 2011.07.20 GroupSession Version3.5.0 --

はじめに

GroupSessionでは、ホームページ、ブログなどをプラグインとして追加することができます。

※以下の内容はGroupSession Version3に対する情報となります。


作業の手順

新規プラグインの作成手順を説明します。


手順1 プラグインIDを決める

プラグインIDとは、GroupSessionからプラグインを識別するために使用する名前です。

使用する文字は必ず半角英数字、文字数は10文字以内にしてください。

日本語や記号・半角カナなどを使用、または10文字を超えると、追加したプラグインが

認識できない場合があります。


ここでは例としてGroupSessionのサイトをプラグインとして追加するので

プラグインIDは「gssite」とします。


手順2 メニューアイコン用画像を作成する

メニューアイコンには3つの画像が必要です。

ファイル名は下記の固定ファイル名、画像のサイズは全て100px × 30pxで作成してください。

  サンプル画像 固定ファイル名 説明
メニューアイコン menu_icon.gif menu_icon.gif ヘッダのメニューに
表示される画像
オンマウス時アイコン menu_icon_on.gif menu_icon_on.gif アイコンにマウスを
乗せた時に表示される画像
クリック時アイコン menu_icon_click.gif menu_icon_click.gif アイコンをクリック
した時に表示される画像

メニューアイコンのひな形をダウンロードできます。

アイコン作成時の素材としてご利用ください。

→ ひな形のダウンロード(gif形式)

→ ひな形のダウンロード(psd形式)


手順3 プラグイン設定ファイルを作成する

プラグイン設定ファイルを作成します。

内容は下記の様に記述し、ファイル名は固定で「plugin.xml」としてください。

赤字の部分をプラグイン情報に合わせて書き替えます。

plugin.xml

<?xml version="1.0" encoding="Shift_jis" ?>

 

<plugin>

 

<!-- プラグインID -->

<!-- 手順1で決めたプラグインIDを記述します -->

<id>gssite</id>

 

<!-- 名称 -->

<!-- プラグインの名称を記述します -->

<name>GSサイト</name>

 

<!-- 説明 -->

<!-- プラグインの説明を記述します -->

<description>GroupSessionのサイトです。</description>

 

<!-- トップメニューの情報を記述する 記述しない場合はメニューに表示しない -->

<topmenu-info>

<!-- メニューへの表示/非表示 -->

<!-- プラグインをメニューへ表示する場合は「true」と記述します -->

<view>true</view>

<!-- メニューアイコンクリック時にフレーム内に表示するURLを記述します -->

<url>http://www.gs.sjts.co.jp/v4/index.html</url>

</topmenu-info>

 

</plugin>

※1行目の記述には文字コードの設定部分があります。

<?xml version="1.0" encoding="Shift_jis" ?>

上記の様にShift_jisとした場合、設定ファイルを保存する時の文字コードは必ずShift_jisに設定してください。

設定ファイル1行目に記述した文字コードと、ファイル自体の文字コードが異なる場合、

追加したプラグインが認識できない、またはプラグインが正常に動作しない場合があります。


手順4 作成したファイルを各ディレクトリに配置する

手順2、3で作成したファイルを、GroupSessionをインストールしたgsession3ディレクトリの中に

配置します。

Windowsでインストールガイドに従ってGroupSessionをインストールした場合

C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\gsession3

となります。



手順2で作成したメニューアイコン用画像を配置します

C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\gsession3

にプラグインディレクトリを作成します。

ディレクトリ名は手順1で決めたプラグインIDと同じにします。

ここでは「gssite」になります。


C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\gsession3\gssite

に画像用ディレクトリを作成します。

ディレクトリ名は固定で「images」としてください。


C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\gsession3\gssite\images

に手順2で作成したメニューアイコン用画像をコピーします。


下記の様な階層構造になります。


ディレクトリgsession3

ディレクトリgssite (手順1で決めたプラグインID)

ディレクトリimages

ファイルmenu_icon.gif

ファイルmenu_icon_on.gif

ファイルmenu_icon_click.gif


手順3で作成したプラグイン設定ファイルを配置します

C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\gsession3\WEB-INF\plugin

にプラグインディレクトリを作成します。

ディレクトリ名は手順1で決めたプラグインIDと同じにします。

ここでは「gssite」になります。


C:\Program Files\Apache Software Foundation\Tomcat 6.0\webapps\gsession3\WEB-INF\plugin\gssite

に手順3で作成したプラグイン設定ファイルをコピーします。


下記の様な階層構造になります。


ディレクトリgsession3

ディレクトリWEB-INF

ディレクトリplugin

ディレクトリgssite (手順1で決めたプラグインID)

ファイルplugin.xml


手順5 tomcatを再起動して動作を確認する

tomcatを再起動することで設定が反映されます。


手順2で作成したプラグインアイコンがメニューに追加されます。

プラグインアイコンをクリックすると、手順3で設定したURLのページがフレーム内に表示されます。

プラグイン追加完了後



メイン > 個人設定 > メニュー項目の設定にもプラグインが追加されるので、表示順の設定も可能です。

メニュー項目の設定


サンプルをダウンロード

手順2〜4で作成するファイルとディレクトリ構成のサンプルを、こちらからダウンロードできます。

→ サンプルをダウンロード


1) zipファイルを解凍後、「plugin_sample」ディレクトリの下に「gsession3」ディレクトリができます。

2) GroupSessionをインストールしたgsession3ディレクトリに、
   解凍後の「gsession3」ディレクトリを上書きします。

3) tomcatを再起動すると上記の「GSサイト」プラグインが追加されます。


[ご利用にあたって] [個人情報保護方針] [特定商取引法に基づく表示] [リンク] [会社概要]
Copyright 日本トータルシステム株式会社