root/tPod/trunk/README

********************************************************************************
本プログラムは、「Rinza公衆使用許諾契約書　第1.0版」に基づいて提供されています。
「Rinza公衆許諾契約書　第1.0版」は、パッケージ内の"LICENSE"ファイル、および次に
示すURLにおいて参照することができます：
 　　　　　　 http://www.tyzoh.jp/rinza/licenses/LICENSE-1.0.txt
本プログラムにおけるオリジナル・プログラムの初期開発者は、日本ユニシス株式会社で
あり、その著作権は日本ユニシス株式会社が所有しています（The Original Program is
copyrighted (C) 2005 by Nihon Unisys, Ltd. with all rights reserved.）。

本プログラムは現状有姿にて提供されるものとし、明示・黙示を問わず、プログラムの
瑕疵の不存在、商業的な使用可能性、使用目的に対する適合性を含め、いかなる保証も
なしに提供されるものです。
また、日本ユニシス株式会社をはじめとするRinzaソフトウェアの開発に携わっている
団体および個人は、本プログラムの使用によって発生するいかなる損害に対しても一切の
責任を負わないものとします。

なお，上記の”本プログラム”および”オリジナル・プログラム”の定義については、
「Rinza公衆使用許諾契約書　第1.0版」を参照ください。
********************************************************************************

                             Rinza tacoPot
                             ==============
■ tacoPot について
tacoPot はキーワード付けによる検索を提供するエンジンです。
検索対象に任意のキーワードをつけることで、利用者視点での意味づけ/分類といった folksonomy が行え、検索性能と利便性が高まります。

■ 主な機能
-- 0.8 の追加機能
   JSP版UIをAjaxでのUIに変更
   tPodから名称をtacoPotに変更
   
-- 以前からある機能
・ JSP 版 UI
・ Polling（他ファイルシステムのファイルを監視して自動登録）
・ tacoPot-WebDav (WebDav インタフェース） 
・ SOAP/XML （SOAP/XML で tacoPot にアクセス）
・ SSDB 新バージョン対応(limit/offset 等）
・ SSDB 対応
　Rinza RDF Repository 以外に SSDB をリポジトリとして使用できるようになりました。
　（SSDB の動作環境が Linux 用のため、SSDB 版 tacoPot も Linux のみ対応となります）
・ キーワード付け
　利用者が好きなようにキーワードを付け、それを基にした検索を行うことができます。
　キーワードはワンクリックで選択することが可能です。
・ 自動キーワード抽出（5.2 の追加機能）
　テキストファイルのキーワードを自動的に抽出します。
・ コメントづけ（0.5.2 の追加機能）
　利用者が自由にコメントをつけられます。
・ URL 登録（0.5.2 の追加機能）
　ファイルだけではなく URL を登録できるようになりました（ただし全文検索の対象外です）。
・ 全文検索連携
　全文検索エンジンと連携し、キーワード検索だけではなく全文検索も行えるようになります。
・ アクセスコントロール
　検索結果にアクセス制限を掛けることができます。
・サマリ表示（0.5.2 の追加機能）
　 画像縮小表示、コメントサマリ、キーワードサマリを表示できるようになりました。

■ 次期バージョンでの開発アイテム（予定）
・Google 連携
・大規模対応

■ リリース日時
2007年9月
バージョン名
0.8 tacoPotに名称変更

2007年6月
バージョン名
0.7.1 tPodの最終バージョン

■ 配布内容

tacoPot-0.8.zip

このファイルを任意のディレクトリで展開すると次のような構成となります。
├─config
├─doc
├─lib
├─src
│  └─jp
│      └─tyzoh
│          └─rinza
│              └─folksonomy
│                  ├─tacopot
│                  ├─tacopotclient
│                  ├─tool
│                  ├─search
│                  └─common
└─servlet
    ├─WEB-INF
    │  ├─lib
    │  │  └─classes
    │  ├─jsp
    │  ├─tags
    │  ├─xsl
    │  └─classes
    │      └─jp
    │          └─tyzoh
    │              └─rinza
    │                  └─folksonomy
    │                      ├─tacopot
    │                      ├─search
    │                      └─common
    ├─icon
    ├─files
    └─guide.files

直下の makefile, application.properties などが編集対象となります。
後述の「インストール方法」をご覧ください。

■ 動作環境
・OS（下記いずれか）
 Windows 2000, XP
 Linux(FedoraCore4 以降で動作確認済み）

・MW
Apache （無くても可）
Tomcat （5以降で動作確認済み）
Rinza RDF Repository もしくは SSDB（svn から最新版（rev 220 以降）を落としてください）

・AP
namazu（無くても可）
mecab（無くても可）

・DB
- Rinza RDF Repository を使う場合は PostgreSQL もしくは MySQL
（DB は Rinza RDF Repository 経由で使用しますので、Rinza RDF Repository がすでに稼動している場合は不要です。）
- SSDB を使う場合は BerkeleyDB

■ 環境設定
０．Apache/Tomcat および Rinza RDF Repository / SSDB の設定
Apache/Tomcat とも、特別な設定は不要です。下記ディレクトリからダウンロードし導入してください。
Apache - http://www.apache.jp/misc/download.html
Tomcat - http://jakarta.apache.org/site/downloads/downloads_tomcat.html
servlet が動作することが確認できていれば問題ありません。
なお、Basic 認証/Digest認証/クライアント認証、いずれでも動作確認が行えており、クライアント認証を用いる場合は、クライアント証明書の CommonName をユーザ名として扱うようにしています（tacoPot の利用者はログイン手続きが不要になります）。

- Rinza を使う場合 
Rinza も特別な設定は不要です。
Rinza - http://dev.tyzoh.jp/trac/rdf-repo/
よりダウンロードして導入してください。すでに稼動している Rinza RDF Repository があれば、そちらを流用することも可能です。

- SSDB を使う場合
SSDB も特別な設定は不要です。
SSDB - http://dev.tyzoh.jp/trac/semi-structured-db/
よりダウンロードして導入してください。すでに稼動している SSDB があれば、そちらを流用することも可能です。

１．全文検索エンジンの設定
全文検索エンジンとして namazu に対応しています。
下記 URL から namazu をダウンロードし、適宜導入してください（無くてもキーワード検索は可能です）。
http://www.namazu.org/#download
2.0.14 以降で動作確認をしております（セキュリティホール等の問題もありますし、最新の office ドキュメント等を検索対象にする場合はできるだけ最新版 2.0.16 をお使いください）

２．tacoPot が管理する ファイルを保存するディレクトリが必要です。
任意のディレクトリを作成してください。

３．zip を展開したディレクトリにある application.properties に 1. および 2. の設定を反映させます。
次の記述にしたがって application.properties を編集してください。

-----  application.properties（一部抜粋） 開始 -----
#tacoPot のファイルを保管するディレクトリ
#podDirectory=/var/lib/tacoPot/files/
#podDirectory=c:\\tacoPot

#全文検索エンジンのパス（*）
command=/var/lib/tacoPot/namazu.sh
#command=c:\\namazu\\bin\\namazu.exe -l

#全文検索エンジンのインデックス生成プログラムのパス(*)
index=sh /var/lib/tacoPot/mknmz.sh
#index=c:\\namazu\\bin\\mknmz.bat c:\\tacoPot -O

#全文検索エンジンの「インデックス」ディレクトリ
indexDirectory=/var/lib/tacoPot/index/
#indexDirectory=c:\\\\tacoPotIndex\\\\

#Windows は指定なし、Linux 系は euc-jp
#encodeType=euc-jp
#encodeType=UTF-8

#検索結果をインライン表示するか否か
#inline=false

#イメージの縮小表示サイズ。どちらかが 0 のときは縮小表示なし
#thumbWidth=40
#thumbHeight=40

#キーワードのサマリーの表示桁（文字数）。0 のときはサマリ表示なし。
#keywordSummarySize=60

#コメントのサマリーの表示桁（文字数）。0 のときはサマリ表示なし。
#commentSummarySize=60

#利用するリポジトリ
# Rinza 利用の場合はこちら
#repository = jp.tyzoh.rinza.folksonomy.tacopot.Rinza
# SSDB 利用の場合はこちら
repository = jp.tyzoh.rinza.folksonomy.tacopot.SSDB

# Connector
# Rinza RDF Repository のサーバ IP アドレス（Rinza を使わない場合は指定不要）
connector.agent.address=localhost
# Rinza RDF Repository のエンコードタイプ（Rinza を使わない場合は指定不要）
connector.encoding=Shift_JIS
-----  application.properties 終了 -----

*）tomcat の実行時の文字コードと異なると検索に失敗することがあります。
次のようなシェルを書いて回避することができます（LANG が euc-jp の場合）。
--namazu.sh start--
export LANG=ja_JP.eucJP
namazu -l $1 /var/lib/tacoPot/index
--namazu.sh end--

mknmz.sh
--namazu.sh start--
export LANG=ja_JP.eucJP
mknmz /var/lib/tacoPot/files -O /var/lib/tacoPot/index
--namazu.sh end--

４．自動キーワード抽出ライブラリの入手
自動抽出を行なわない場合でもコンパイルのために、ライブラリが必要となります。
0.6.1 からはパッケージに含まれていますのでこのまま利用が可能ですが、最新版
の適用をお勧めします。

・最新版の適用方法　－ここから－
http://dev.tyzoh.jp/trac/folksonomy から
最新版をダウンロード、もしくは svn によりチェックアウトし、
(autoKeywod)/trunk/src/jp/tyzoh/rinza/folksonomy/keyword
および
(autoKeywod)/trunk/src/jp/tyzoh/rinza/folksonomy/analyze
を tacoPot の
(tacoPot)/trunk/src/jp/tyzoh/rinza/folksonomy
以下にコピーしてください。
・最新版の適用方法　－ここまで－

また、自動抽出を行なう場合は、形態素解析エンジンとして MeCab をダウンロードしてください。
http://mecab.sourceforge.jp/
0.93 で動作確認をしております。

-----  application.properties（一部抜粋） 開始 -----
#キーワード自動抽出候補の数。0 のときはキーワード抽出なし。
autoKeywordSize=10
#analyzer = jp.tyzoh.rinza.folksonomy.keyword.Mecab
#mecab のパス
analyzer.command =/var/lib/tacoPot/mecab.sh
#analyzer.command = c:\\mecab\\bin\\mecab.exe
#searcher = jp.tyzoh.rinza.folksonomy.searcher.Namazu
-----  application.properties 終了 -----

■ インストール方法
☆0.8 以前の機能を主として使いたい方

zip を展開すると lib ディレクトリがあります。
commons-fileupload-1.0.jar  - http://jakarta.apache.org/site/downloads/downloads_commons-fileupload.cgi
servlet-api.jar             - tomcat の common/lib からコピーしてください
rinza-rdf.jar               - （Rinza を使う場合）http://www.tyzoh.jp/rinza-family/RDFRepository.html
log4j-1.2.8.jar             - http://www.ingrid.org/jajakarta/log4j/
をダウンロードし、lib ディレクトリに保存してください（rinza-rdf.jar は同梱されていますが最新版のダウンロードをお勧めします）。<

SSDB を使う場合は JNI による API およびライブラリ libssdbJNI.so （FedoraCore6 で動作確認済み）が必要となります。
libssdbJNI.so は利便性を考え lib ディレクトリに入れてありますが、最新版の導入をお勧めします。
最新版は http://dev.tyzoh.jp/trac/semi-structured-db/ から導入します。
<ssdb のインストールディレクトリ>/src/JNI/jp/tyzoh/ssdb/*.java 
を
<tacopot のインストールディレクトリ>/src/jp/tyzoh/ssdb/*.java
にコピーしてください。
libssdbJNI.so は tacoPot/web サーバが稼動する linux マシンに配置し、LD_LIBRARY_PATHを通してください（tomcat から LD_LIBRARY_PATH が見えている必要があります）。

makefile を適宜環境（javac のパスなど）に合わせて修正し実行するか、makefile をご
覧頂き即した形で javac を実行してください。
お使いの環境に応じて後述する application.properties を編集してください。
serv.bat を利用して、servlet ディレクトリにおいて tacoPot.war を作成し配置します（tomcat ディレクトリなど適宜書き換えてお使いください）。
（linux の方はお手数ですが、内容ご覧の上、手動で作成・展開をお願いいたします）。
javax.activation.jar を用いて mime type を判別しています。mime.types を activation.jar が参照するディレクトリ（JAVAHOME/lib 等）などに配置してください。

☆0.8 以降の機能を主として使いたい方
doc ディレクトリの HOWTO-BUILD.txt をご覧ください。
polling 機能をお使いの方はあわせて README.polling もご覧ください。

■ 実行
tacoPot はサーブレットとして動作します。
ブラウザからサーバにアクセスしてください。
http://<サーバー名>/tacoPot
とすると tacoPot へのリンクが表示されますので、これをクリックすると
ログイン画面となります。
http://<サーバー名>/tacoPot/admin.html を用いてユーザ登録/削除ができます。
アカウント名「root」は特別な権限（すべてのファイルに対してアクセスがで
きます）をもちます。デフォルトでは登録されないので、まずはアカウント名
「root」のユーザを admin.html から設定してください。

polling 機能をお使いの方は README.polling もご覧ください。

■ 利用方法
servlet/guide.html をご覧ください。

以上