Skip to content

Commit

Permalink
added several documents
Browse files Browse the repository at this point in the history
  • Loading branch information
t-morita committed Mar 13, 2016
1 parent 79e7489 commit 8ebb6b6
Show file tree
Hide file tree
Showing 91 changed files with 1,715 additions and 10 deletions.
73 changes: 73 additions & 0 deletions docs/source/class_editor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
=================
クラスエディタ
=================

.. contents:: コンテンツ
:depth: 2

クラスエディタでは,RDFSクラスの階層関係およびRDFSクラスの属性編集を行うことができる.図1にクラスエディタのスクリーンショットを示す

.. figure:: figures/class_editor.png
:scale: 50 %
:alt: 図1: クラスエディタ
:align: center

図1: クラスエディタ

------------------------------------------------
クラスエディタのポップアップメニュー
------------------------------------------------

クラスエディタ内で,右クリックするとポップアップメニューが表示される.ポップアップメニューは,ノードを選択している場合としていない場合で表示内容が異なる.ポップアップメニューは,以下のとおり.

.. figure:: figures/popup_menu_selected_class_editor.png
:scale: 50 %
:alt: ノードが選択されていない状態
:align: center

ノードが選択されていない状態

.. figure:: figures/popup_menu_selected_class_editor.png
:scale: 50 %
:alt: ノードが選択された状態
:align: center

ノードが選択された状態

クラスの挿入
接続モード
クラスからRDFへ変換
RDFSクラスからRDFリソースへ変換する.
クラスからプロパティへ変換
RDFSクラスからRDFSプロパティへ変換する.
コピー
カット
ペースト
削除
アトリビュートダイアログを表示

------------------------------------------------
クラスエディタの属性編集
------------------------------------------------
クラスエディタ内のRDFSクラスを選択すると,RDFSクラスの属性がアトリビュートダイアログに表示される(図2から図4).アトリビュートダイアログ左側のリストから「基本」,「ラベル」,「コメント」,「インスタンス」,「上位クラス」項目を選択し,RDFSクラスの属性の編集を行う.「基本」では,リソースタイプおよびURI を編集することができる(図2).リソースタイプで選択できる項目は,「設定」ダイアログのクラスクラスリストから追加および削除を行うことができる.「ラベル」では,rdfs:label プロパティの編集を行うことができる.「コメント」では,rdfs:commentの編集を行うことができる.ラベルとコメントの編集方法は,RDFリソースと同様である.「インスタンス」には選択したRDFSクラスのインスタンスのリストが表示される(図3).リスト中の項目をクリックすると対応するRDFエディタ内のRDFリソースにジャンプし,そのRDFリソースの属性がアトリビュートダイアログに表示される.「上位クラス」には,選択したRDFSクラスの上位クラスのリストが表示される(図4).

.. figure:: figures/attribute_dialog_rdfs_class_basic.png
:scale: 50 %
:alt: 図2: アトリビュートダイアログ(RDFSクラスの基本)
:align: center

図2: アトリビュートダイアログ(RDFSクラスの基本)

.. figure:: figures/attribute_dialog_rdfs_class_instance.png
:scale: 50 %
:alt: 図3: アトリビュートダイアログ(RDFSクラスのインスタンス)
:align: center

図3: アトリビュートダイアログ(RDFSクラスのインスタンス)

.. figure:: figures/attribute_dialog_rdfs_class_upper_class.png
:scale: 50 %
:alt: 図4: アトリビュートダイアログ(RDFSクラスの上位クラス)
:align: center

図4: アトリビュートダイアログ(RDFSクラスの上位クラス)
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down
89 changes: 89 additions & 0 deletions docs/source/config_dialog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
=====================
設定ダイアログ
=====================

.. contents:: コンテンツ
:depth: 2

設定ダイアログでは,基本,ディレクトリ,プロキシ,メタクラス,レイアウト,レンダリングについて設定を行うことができる.

------------------------
基本
------------------------

設定ダイアログの「基本」タブ(図1)では,言語,UI 言語,出力エンコーディング,フォント,ベースURI,ログファイルの設定ができる.言語はラベル表示を行う際に優先して表示する言語を設定できる.UI 言語は,メニューなどに表示する言語を設定できる.言語は,ja(日本語),en(英語),zh(中国語)を選択できる.出力エンコーディングは,エクスポート時にRDF(S)文書を保存するファイルエンコーディングを設定する.フォントは,各エディタ内のノード内の文字列を表示する際のフォントを設定する.ベースURI には,エクスポート時の初期の名前空間URI を設定する.ログファイルには,MR\ :sup:`3` \使用中の各種ログを保存するファイルを設定する.

.. figure:: figures/config_dialog_basic.png
:scale: 50 %
:alt: 図1:設定ダイアログ: 基本
:align: center

図1:設定ダイアログ: 基本

------------------------
ディレクトリ
------------------------

設定ダイアログの「ディレクトリ」タブ(図2)では,作業ディレクトリ,プラグインディレクトリ,リソースディレクトリを設定ができる.作業ディレクトリには,インポートダイアログにおいて,RDF(S)文書を含むフォルダを選択する際に最初に開くフォルダを設定する.プラグインディレクトリには, MR\ :sup:`3` \のプラグインが保存されているフォルダを設定する.リソースディレクトリは, MR\ :sup:`3` \のプロパティファイル(メニューなどに表示する言語ごとの設定ファイル)が保存されているフォルダを設定する.

.. figure:: figures/config_dialog_directory.png
:scale: 50 %
:alt: 図2: 設定ダイアログ: ディレクトリ
:align: center

図2: 設定ダイアログ: ディレクトリ

------------------------
プロキシ
------------------------

設定ダイアログの「プロキシ」タブ(図3)では,プロキシサーバを利用している場合に,プロキシサーバのホスト名とポート番号の設定を行うことができる.インポートダイアログからURI を指定して,RDF(S)文書をインポートする場合に設定が必要となる場合がある.

.. figure:: figures/config_dialog_proxy.png
:scale: 50 %
:alt: 図3: 設定ダイアログ: プロキシ
:align: center

図3: 設定ダイアログ: プロキシ

------------------------
メタクラス
------------------------

設定ダイアログの「メタクラス」タブ(図4)では,「クラスクラス」および「プロパティクラス」の設定をすることができる.「クラスクラス」に設定したクラスをrdf:typeプロパティの値とするリソースを, MR\ :sup:`3` \はクラスとして認識し,クラスエディタにインポートすることができる.同様に,「プロパティクラス」に設定したクラスをrdf:type プロパティの値とするリソースを, MR\ :sup:`3` \はプロパティとして認識し,プロパティエディタにインポートすることができる.

初期状態では,「クラスクラス」にはrdfs:Class が設定されている.また,「プロパティクラス」には,rdf:Property が設定されている.owl:Class やowl:ObjectProperty をタイプとするリソースを,クラスまたはプロパティとしてMR\ :sup:`3` \にインポートしたい場合には,図4の「Class Class」タブまたは「Property Class」タブで設定を行う

.. figure:: figures/config_dialog_metaclass.png
:scale: 50 %
:alt: 図4: 設定ダイアログ: メタクラス
:align: center

図4: 設定ダイアログ: メタクラス

------------------------
レイアウト
------------------------

設定ダイアログの「レイアウト」タブ(図5)では,各エディタ内のデータグラフのレイアウト方法を設定する.

.. figure:: figures/config_dialog_layout.png
:scale: 50 %
:alt: 図5:設定ダイアログ: レイアウト
:align: center

図5:設定ダイアログ: レイアウト

------------------------
レンダリング
------------------------
設定ダイアログの「レンダリング」タブ(図6)では,RDFリソース,RDFリテラル,RDFSクラス,RDFSプロパティの各ノードの色や,ノード選択時の色,エディタウィンドウの背景職をカスタマイズすることができる.「ノードに色をつける」チェックボックスのチェックをはずすと,すべてのノードが無色となる.「アンチエイリアス」チェックボックスにチェックをいれると各ノードの縁が滑らかに表示される.

.. figure:: figures/config_dialog_rendering.png
:scale: 50 %
:alt: 図6: 設定ダイアログ: レンダリング
:align: center

図6: 設定ダイアログ: レンダリング


31 changes: 31 additions & 0 deletions docs/source/export_dialog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
===============================
エクスポートダイアログ
===============================
エクスポートダイアログでは, MR\ :sup:`3` \ で構築したRDF(S) データグラフをRDF/XML, N3, N-Triple, Turtle 形式でRDF(S) 文書にエクスポートすることができる.図1にエクスポートダイアログのスクリーンショットを示す.また,以下ではエクスポートダイアログの各部分(図1内の1 から8)について説明する.

.. figure:: figures/export_dialog.png
:scale: 50 %
:alt: 図1: エクスポートダイアログ
:align: center

図1: エクスポートダイアログ

#. 構文
RDF(S) 文書としてエクスポートしたい構文(RDF/XML,N-Triple,Turtle,N3 など)を選択する.
#. データタイプ
各チェックボックスでチェックされたエディタ内のデータグラフをRDF(S) 文書にエクスポートする.(例:クラスとプロパティにチェックをつけた場合,クラスエディタとプロパティエディタ内のデータグラフをRDF(S) 文書にエクスポートする.)
#. オプション
「Encode(UTF-8)」チェックボックスにチェックをいれた場合,エクスポート時にURI の規則を定めるRFC3986 に基づいて,各要素のURI 文字列に含まれる非予約文字データをURLエンコードする.「Selected」チェックボックスにチェックをいれた場合,範囲選択されているサブデータグラフをエクスポートする.「Abbrev」チェックボックスにチェックをいれた場合,省略表記方法でエクスポートする.「XMLbase」チェックボックスにチェックをいれると,XMLBase 宣言がRDF(S) 文書内に追加される.
#. ファイル
設定した条件(構文,データタイプ,オプション)で,RDF(S) 文書にエクスポートする.
#. 画像
「3. データタイプ」の「RDF」,「クラス」,「プロパティ」チェックボックスのうちどれか1 つを選択し,「画像」ボタンを押すと,選択されたエディタのデータグラフをpng 形式でファイルに保存することができる.
#. 再読み込み
設定した条件で最新のデータグラフを「8. ソース表示」に表示する.
#. 取消し
エクスポートを中止し,エクスポートダイアログを閉じる.
#. ソース表示
エクスポートされるRDF(S) 文書の内容が表示される.



Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/bottom_up_step5.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/bottom_up_step6.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/bottom_up_step7.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/bottom_up_step8.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/class_editor.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/config_dialog_basic.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/config_dialog_directory.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/config_dialog_layout.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/config_dialog_metaclass.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/config_dialog_proxy.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/config_dialog_rendering.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/export_dialog.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/figures/function_overview.png
Binary file added docs/source/figures/import_dialog.png
Binary file added docs/source/figures/import_rdf.png
Binary file added docs/source/figures/make_rdfs_class.png
Binary file added docs/source/figures/make_rdfs_property.png
Binary file added docs/source/figures/namespace_table.png
Binary file added docs/source/figures/popup_menu_class_editor.png
Binary file added docs/source/figures/popup_menu_rdf_editor.png
Binary file added docs/source/figures/property_editor.png
Binary file added docs/source/figures/rdf_editor.png
Binary file added docs/source/figures/rdfs_replace_after.png
Binary file added docs/source/figures/rdfs_replace_before.png
Binary file added docs/source/figures/remove_dialog.png
Binary file added docs/source/figures/remove_rdfs_class.png
Binary file added docs/source/figures/remove_rdfs_property.png
Binary file added docs/source/figures/rename_rdf_property.png
Binary file added docs/source/figures/rename_rdf_resource_type.png
Binary file added docs/source/figures/rename_rdfs_class.png
Binary file added docs/source/figures/rename_rdfs_property.png
Binary file added docs/source/figures/resource_search_dialog.png
Binary file added docs/source/figures/screenshot_of_mr3.png
Binary file added docs/source/figures/sw_paradigm.png
Binary file added docs/source/figures/system_overview_of_mr3.png
Binary file added docs/source/figures/top_down_step1.png
Binary file added docs/source/figures/top_down_step10-1.png
Binary file added docs/source/figures/top_down_step10-2.png
Binary file added docs/source/figures/top_down_step11-1.png
Binary file added docs/source/figures/top_down_step11-2.png
Binary file added docs/source/figures/top_down_step12.png
Binary file added docs/source/figures/top_down_step2.png
Binary file added docs/source/figures/top_down_step3.png
Binary file added docs/source/figures/top_down_step4.png
Binary file added docs/source/figures/top_down_step5.png
Binary file added docs/source/figures/top_down_step6.png
Binary file added docs/source/figures/top_down_step7.png
Binary file added docs/source/figures/top_down_step8-1.png
Binary file added docs/source/figures/top_down_step8-2.png
32 changes: 32 additions & 0 deletions docs/source/implementation_overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
============
実装の概要
============

RDF(S)コンテンツ構築支援ツールの設計を基に,RDF(S)コンテンツ構築支援ツールMR\ :sup:`3` \ (Meta-Model Management based on RDFs Revision Reflection) の実装を行った.図1にMR\ :sup:`3` \の実装アーキテクチャを示す.MR\ :sup:`3` \はGUIコンポーネントとしてJava Swingを用いて,Java言語で実装を行った. MR\ :sup:`3` \は,RDFおよびRDFSデータグラフを視覚化するためにJGraphライブラリを用いている.図1のグラフィカルモデラの実装にはJGraphを用いている.また,MR\ :sup:`3` \は,セマンティックWeb コンテンツ(RDF,RDFS,OWLコンテンツ)のインポート,編集,エクスポートを行うために,Jena: A Semantic Web Frameworkを用いている.図1のパーサとジェネレータの実装にはJena APIを用いている.他のセマンティックWebアプリケーションと連携を行うことができるように, MR\ :sup:`3` \はプラグイン機構を備えている.MR\ :sup:`3` \はプラグイン開発のために主に2 種類のAPI を提供している.一つは,MR\ :sup:`3` \のデータグラフをJenaのモデルオブジェクトに変換するAPIであり,もう一つは,JenaのモデルオブジェクトをMR\ :sup:`3` \のデータグラフに変換するAPIである.これらのAPIを用いることで, MR\ :sup:`3` \で構築したRDFおよびRDFSコンテンツを別のセマンティックWeb アプリケーションに入力することや,逆に他のセマンティックWeb アプリケーションの出力をMR\ :sup:`3` \に入力することが可能となる.将来的には,RDFコンテンツとRDFSコンテンツ間の整合性管理に関するAPIも提供することを考えている.

.. figure:: figures/implementation_architecture_of_mr3.png
:scale: 50 %
:alt: 図1: MR\ :sup:`3` \の実装アーキテクチャ
:align: center

図1: MR\ :sup:`3` \の実装アーキテクチャ

図2にMR\ :sup:`3` \のシステム構成を示す. MR\ :sup:`3` \は,パーサモジュール,ジェネレータモジュール,RDF(S)コンテンツ管理モジュール,プラグイン,ユーザインタフェースから構成される.ユーザインタフェースには,プラグインインタフェースおよびグラフィカルモデラがあり,ユーザはグラフィカルモデラを介して,RDFおよびRDFSコンテンツを視覚的に編集することができる.また,ユーザは,プラグインインタフェースより,プラグインの機能にアクセスすることができる. MR\ :sup:`3` \の入力と出力はRDF(S)文書である.パーサはRDF(S)文書を解析して,Jena のモデルオブジェクトに変換し,その後,RDF(S)コンテンツ管理を行うことができるようにMR\ :sup:`3` \の内部データに変換する.ジェネレータは, MR\ :sup:`3` \の内部データをJena のモデルオブジェクトに変換し,その後,RDF(S)文書に変換する

.. figure:: figures/system_overview_of_mr3.png
:scale: 50 %
:alt: 図2: MR\ :sup:`3` \のシステム構成
:align: center

図2: MR\ :sup:`3` \のシステム構成

図3にMR\ :sup:`3` \のグラフィカルモデラのスクリーンショットを示す.グラフィカルモデラは,RDFエディタ,クラスエディタ,プロパティエディタ,アトリビュートダイアログ,名前空間テーブル,削除ダイアログ,リソース検索ダイアログ,インポートダイアログ,エクスポートダイアログ,設定ダイアログから構成される.

.. figure:: figures/screenshot_of_mr3.png
:scale: 50 %
:alt: 図3: MR\ :sup:`3` \のグラフィカルモデラのスクリーンショットs
:align: center

図3: MR\ :sup:`3` \のグラフィカルモデラのスクリーンショット


42 changes: 42 additions & 0 deletions docs/source/import_dialog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
=====================
インポートダイアログ
=====================
インポートダイアログでは,RDF/XML, N3, N-Triple, Turtle 形式で記述されたRDF(S)文書をMR\ :sup:`3` \にインポートすることができる.図1にインポートダイアログのスクリーンショットを示す.また,以下ではインポートダイアログの各部分(図1内の1 から13)について説明する.

.. figure:: figures/import_dialog.png
:scale: 50 %
:alt: 図1: インポートダイアログ
:align: center

図1: インポートダイアログ

#. コンテナリスト
RDF,N3, N-Triple,Turtle 形式で記述されたRDF(S) 文書が保存されたフォルダまたはURI のリストを表示する.
#. フォルダ追加
「1. コンテナリスト」にフォルダを追加する.
#. URI 追加
「1. コンテナリスト」にURI を追加する.
#. 削除
「1. コンテナリスト」内の選択したフォルダまたはURI を削除する.
#. 構文
インポートしたいRDF(S) 文書の構文(RDF/XML, N3, N-Triple, Turtle) を選択する.
#. データタイプ
インポートしたい文書のタイプ(RDF, RDFS, OWL) を選択する.
#. インポート方法
編集中のRDF(S) コンテンツにインポートしたいRDF(S) 文書の内容をマージするか,または,編集中のRDF(S) コンテンツをインポートしたいRDF(S) 文書の内容に置換するかを選択する.
#. 検索
「検索」テキストフィールドに入力したキーワードによって,「9. インポートファイル」内に表示されているファイルを絞り込む.
#. インポートファイル
「1. コンテナリスト」内で選択されたフォルダ内のファイル一覧を表示する.
#. 拡張子
拡張子によって,「9. インポートファイル」内に表示されているファイルを絞り込む.
#. 再読み込み
「1. コンテナリスト」で選択されているフォルダの内容を再読込し,最新のファイル一覧を「9. インポートファイル」に表示する.
#. インポート
設定した条件(構文,データタイプ,インポート方法,インポートファイル)でRDF(S) 文書をMR\ :sup:`3` \ にインポートする.
#. 取消し
インポートを中止し,インポートダイアログを閉じる.




0 comments on commit 8ebb6b6

Please sign in to comment.