概要

  • バージョン0.43から,各ツールのREADME.txtの内容を,各パネル上部の「説明」ボタンで閲覧できるようになりました.
  • これに伴って,各ツールのREADME.txt作成のためのフォーマット,ならびに基本的な作成方法について説明します.

README.txtの構成

次の3つから構成されています.

  • ツールの使い方
  • 作者とライセンス情報
  • モジュール開発者向け情報

処理ツール用README.txtの作成

ツールの使い方

  1. [(日本語ツール名(英語ツール名(ID=ツールのID)))の使い方] という記述を入れて下さい.
  2. ツールの処理内容について説明して下さい
  3. ツールが用意した入力用GUI(ボタン,テキストフォームなど)について,その使い方を説明して下さい
  4. その他,使い方に関する説明があれば書いて下さい.

作者とライセンス情報

  1. [作者とライセンス情報]という記述を入れて下さい.
  2. 作者:[作者名]
    • 必要であれば作者名を書いて下さい.個人名でなく団体名等でもかまいません.
  3. 参考文献
    • 既発表文献があれば,書誌情報を書いて下さい.
  4. 本モジュールの利用許諾について,TETDMサイト(http://tetdm.jp/)内のTETDM利用許諾書(http://tetdm.jp/pukiwiki/index.php?plugin=attach&refer=TETDM統合環境&openfile=license.txt)の内容をそのまま適用します.
    • ライセンスに関する追加事項がなければ,上記をそのまま挿入して下さい.

モジュール開発者向け情報

  1. TETDM統合環境上で,処理ツール「ソース表示(SourceRead(ID=99999))」を利用して,作成した処理モジュールを選択して下さい.
  2. 「README」ボタンを押して表示される下記項目を全てコピー&ペーストして下さい.
    • [README.txt for MINING MODULE] : [モジュール名]
    • 処理内容の説明(メソッドminingOperations内のcase文の説明):
    • 出力データの説明(引数の型情報を追加して下さい):
    • クラス情報:
    • フォーカス型変数の利用:
    • フォーカス情報による処理連動フラグ(連動実行):
    • オプションによる可視化連動(連動要請):
    • オプションによる処理連動(連動要請):
    • データ取得による処理連動(連動要請):
  3. 上記の各項目について「なし」と表示されたものを除いて,説明を追加して下さい.

可視化ツール用README.txtの作成

ツールの使い方

  1. [(日本語ツール名(英語ツール名(ID=ツールのID)))の使い方] という記述を入れて下さい.
  2. ツールの可視化内容について説明して下さい
  3. 可視化ツール上で可能な操作(オブジェクトのタッチ,クリック,ドラッグなど)について,説明して下さい
  4. その他,使い方に関する説明があれば書いて下さい.

作者とライセンス情報

  1. [作者とライセンス情報]という記述を入れて下さい.
  2. 作者:[作者名]
    • 必要であれば作者名を書いて下さい.個人名でなく団体名等でもかまいません.
  3. 参考文献
    • 既発表文献があれば,書誌情報を書いて下さい.
  4. 本モジュールの利用許諾について,TETDMサイト(http://tetdm.jp/)内のTETDM利用許諾書(http://tetdm.jp/pukiwiki/index.php?plugin=attach&refer=TETDM統合環境&openfile=license.txt)の内容をそのまま適用します.
    • ライセンスに関する追加事項がなければ,上記をそのまま挿入して下さい.

モジュール開発者向け情報

  1. TETDM統合環境上で,処理ツール「ソース表示(SourceRead(ID=99999))」を利用して,作成した可視化モジュールを選択して下さい.
  2. 「README」ボタンを押して表示される下記項目を全てコピー&ペーストして下さい.
    • [README.txt for VISUALIZATION MODULE] : [モジュール名]
    • 可視化内容の説明(メソッドdisplayOperations内のcase文の説明):
    • 処理モジュールから受け取れる入力データ:
    • クラス情報:
    • フォーカス型変数の利用:
    • フォーカス情報による可視化連動(連動要請):
    • フォーカス情報による処理連動(連動要請):
    • オプションによる可視化連動(連動要請):
    • オプションによる処理連動(連動要請):
  3. 上記の各項目について「なし」と表示されたものを除いて,説明を追加して下さい.

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2012-12-18 (火) 23:38:40 (3527d)