modified mrcube_user_manual.rst

mr-3 · May 6, 2016 · 9768f6d · 9768f6d
1 parent 221ad83
commit 9768f6d
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 22 deletions.
diff --git a/docs/source/figures/about_dialog.png b/docs/source/figures/about_dialog.png
diff --git a/docs/source/figures/export_dialog.png b/docs/source/figures/export_dialog.png
diff --git a/docs/source/figures/export_dialog_org.png b/docs/source/figures/export_dialog_org.png
diff --git a/docs/source/figures/import_dialog.png b/docs/source/figures/import_dialog.png
diff --git a/docs/source/figures/import_dialog_org.png b/docs/source/figures/import_dialog_org.png
diff --git a/docs/source/figures/log_console.png b/docs/source/figures/log_console.png
diff --git a/docs/source/figures/mrcube_figures.pptx b/docs/source/figures/mrcube_figures.pptx
diff --git a/docs/source/figures/plugin_dialog.png b/docs/source/figures/plugin_dialog.png
diff --git a/docs/source/figures/project_info_dialog.png b/docs/source/figures/project_info_dialog.png
diff --git a/docs/source/figures/validator_dialog.png b/docs/source/figures/validator_dialog.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,18 +6,14 @@
 MR\ :sup:`3` \ドキュメント
 ==========================
 
-http://mrcube.org/documentation/?lang=ja から移行中です．
-
-TODOセクションに，今後修正すべき箇所を列挙しています．
-
 .. toctree::
    :caption: ユーザドキュメント
 
    about
    install
    rdf_and_rdfs_contents_management
    mrcube_functions
-   mrcube_implementation
+   mrcube_user_manual
    tutorial
 
 .. toctree::

diff --git a/docs/source/mrcube_implementation.rst → docs/source/mrcube_user_manual.rst b/docs/source/mrcube_implementation.rst → docs/source/mrcube_user_manual.rst
@@ -573,7 +573,7 @@ RDFエディタ内のRDFリテラルを選択すると，アトリビュート
 基本
 ~~~~
 
-設定ダイアログの「基本」タブ（ :numref:`config-basic` ）では，言語，UI 言語，出力エンコーディング，フォント，ベースURI，ログファイルの設定ができる．言語はラベル表示を行う際に優先して表示する言語を設定できる．UI 言語は，メニューなどに表示する言語を設定できる．言語は，ja（日本語），en（英語），zh（中国語）を選択できる．出力エンコーディングは，エクスポート時にRDF(S)文書を保存するファイルエンコーディングを設定する．フォントは，各エディタ内のノード内の文字列を表示する際のフォントを設定する．ベースURI には，エクスポート時の初期の名前空間URI を設定する．ログファイルには，MR\ :sup:`3` \使用中の各種ログを保存するファイルを設定する．
+設定ダイアログの「基本」項目（ :numref:`config-basic` ）では，言語，UI 言語，出力エンコーディング，フォント，ベースURI，ログファイルの設定ができる．言語はラベル表示を行う際に優先して表示する言語を設定できる．UI 言語は，メニューなどに表示する言語を設定できる．言語は，ja（日本語），en（英語），zh（中国語）を選択できる．出力エンコーディングは，エクスポート時にRDF(S)文書を保存するファイルエンコーディングを設定する．フォントは，各エディタ内のノード内の文字列を表示する際のフォントを設定する．ベースURI には，エクスポート時の初期の名前空間URI を設定する．ログファイルには，MR\ :sup:`3` \使用中の各種ログを保存するファイルを設定する．
 
 .. _config-basic:
 
@@ -587,7 +587,7 @@ RDFエディタ内のRDFリテラルを選択すると，アトリビュート
 ディレクトリ
 ~~~~~~~~~~~~
 
-設定ダイアログの「ディレクトリ」タブ（ :numref:`config-directory` ）では，作業ディレクトリ，プラグインディレクトリ，リソースディレクトリを設定ができる．作業ディレクトリには，インポートダイアログにおいて，RDF(S)文書を含むフォルダを選択する際に最初に開くフォルダを設定する．プラグインディレクトリには， MR\ :sup:`3` \のプラグインが保存されているフォルダを設定する．リソースディレクトリは， MR\ :sup:`3` \のプロパティファイル（メニューなどに表示する言語ごとの設定ファイル）が保存されているフォルダを設定する．
+設定ダイアログの「ディレクトリ」項目（ :numref:`config-directory` ）では，作業ディレクトリ，プラグインディレクトリ，リソースディレクトリを設定ができる．作業ディレクトリには，インポートダイアログにおいて，RDF(S)文書を含むフォルダを選択する際に最初に開くフォルダを設定する．プラグインディレクトリには， MR\ :sup:`3` \のプラグインが保存されているフォルダを設定する．リソースディレクトリは， MR\ :sup:`3` \のプロパティファイル（メニューなどに表示する言語ごとの設定ファイル）が保存されているフォルダを設定する．
 
 .. _config-directory:
 .. figure:: figures/config_dialog_directory.png
@@ -600,7 +600,7 @@ RDFエディタ内のRDFリテラルを選択すると，アトリビュート
 プロキシ
 ~~~~~~~~
 
-設定ダイアログの「プロキシ」タブ（ :numref:`config-proxy` ）では，プロキシサーバを利用している場合に，プロキシサーバのホスト名とポート番号の設定を行うことができる．インポートダイアログからURI を指定して，RDF(S)文書をインポートする場合に設定が必要となる場合がある．   
+設定ダイアログの「プロキシ」項目（ :numref:`config-proxy` ）では，プロキシサーバを利用している場合に，プロキシサーバのホスト名とポート番号の設定を行うことができる．インポートダイアログからURI を指定して，RDF(S)文書をインポートする場合に設定が必要となる場合がある．   
 
 .. _config-proxy:
 .. figure:: figures/config_dialog_proxy.png
@@ -613,7 +613,7 @@ RDFエディタ内のRDFリテラルを選択すると，アトリビュート
 メタクラス
 ~~~~~~~~~~
 
-設定ダイアログの「メタクラス」タブ（ :numref:`config-metaclass` ）では，「クラスクラス」および「プロパティクラス」の設定をすることができる．「クラスクラス」に設定したクラスをrdf:typeプロパティの値とするリソースを， MR\ :sup:`3` \はクラスとして認識し，クラスエディタにインポートすることができる．同様に，「プロパティクラス」に設定したクラスをrdf:type プロパティの値とするリソースを， MR\ :sup:`3` \はプロパティとして認識し，プロパティエディタにインポートすることができる．
+設定ダイアログの「メタクラス」項目（ :numref:`config-metaclass` ）では，「クラスクラス」および「プロパティクラス」の設定をすることができる．「クラスクラス」に設定したクラスをrdf:typeプロパティの値とするリソースを， MR\ :sup:`3` \はクラスとして認識し，クラスエディタにインポートすることができる．同様に，「プロパティクラス」に設定したクラスをrdf:type プロパティの値とするリソースを， MR\ :sup:`3` \はプロパティとして認識し，プロパティエディタにインポートすることができる．
 
 初期状態では，「クラスクラス」にはrdfs:Class が設定されている．また，「プロパティクラス」には，rdf:Property が設定されている．owl:Class やowl:ObjectProperty をタイプとするリソースを，クラスまたはプロパティとしてMR\ :sup:`3` \にインポートしたい場合には， :numref:`config-metaclass` の「Class Class」タブまたは「Property Class」タブで設定を行う
 
@@ -628,7 +628,7 @@ RDFエディタ内のRDFリテラルを選択すると，アトリビュート
 レイアウト
 ~~~~~~~~~~
 
-設定ダイアログの「レイアウト」タブ（ :numref:`config-layout` ）では，各エディタ内のデータグラフのレイアウト方法を設定する．
+設定ダイアログの「レイアウト」項目（ :numref:`config-layout` ）では，各エディタ内のデータグラフのレイアウト方法を設定する．
 
 .. _config-layout:
 .. figure:: figures/config_dialog_layout.png
@@ -640,7 +640,7 @@ RDFエディタ内のRDFリテラルを選択すると，アトリビュート
 
 レンダリング
 ~~~~~~~~~~~~
-設定ダイアログの「レンダリング」タブ（ :numref:`config-rendering` ）では，RDFリソース，RDFリテラル，RDFSクラス，RDFSプロパティの各ノードの色や，ノード選択時の色，エディタウィンドウの背景職をカスタマイズすることができる．「ノードに色をつける」チェックボックスのチェックをはずすと，すべてのノードが無色となる．「アンチエイリアス」チェックボックスにチェックをいれると各ノードの縁が滑らかに表示される．
+設定ダイアログの「レンダリング」項目（ :numref:`config-rendering` ）では，RDFリソース，RDFリテラル，RDFSクラス，RDFSプロパティの各ノードの色や，ノード選択時の色，エディタウィンドウの背景職をカスタマイズすることができる．「ノードに色をつける」チェックボックスのチェックをはずすと，すべてのノードが無色となる．「アンチエイリアス」チェックボックスにチェックをいれると各ノードの縁が滑らかに表示される．
 
 .. _config-rendering:
 .. figure:: figures/config_dialog_rendering.png
@@ -650,20 +650,77 @@ RDFエディタ内のRDFリテラルを選択すると，アトリビュート
 
    設定ダイアログ: レンダリング    
 
-整合性検証ダイアログ
---------------------
 
-プラグイン管理ダイアログ
-------------------------
+拡張機能
+---------
+「ツール」メニューの「拡張機能」を選択すると，:numref:`plugin-dialog` に示すダイアログが表示される．
+「拡張機能」には，設定ダイアログの「ディレクトリ」項目のプラグインディレクトリに指定したディレクトリに含まれる
+jarファイルを読み込んで，プラグインリストを表示する．プラグインを選択すると，説明が画面下部に表示され，
+「実行」ボタンを押すと，プラグインが実行される．プラグイン作成方法については，:doc:`plugin_development` 参照いただきたい．
 
-プロジェクト情報表示ダイアログ
-------------------------------
 
-ログコンソール
---------------
+.. _plugin-dialog:
+.. figure:: figures/plugin_dialog.png
+   :scale: 80 %
+   :alt:  拡張機能
+   :align: center
+
+   拡張機能
+
+整合性検証
+-----------
+「ツール」メニューの「整合性検証」を選択すると，:numref:`validator-dialog` に示すダイアログが表示される．
+「整合性検証」では，Jenaの `org.apache.jena.reasoner.ValidityReport <https://jena.apache.org/documentation/javadoc/jena/org/apache/jena/reasoner/ValidityReport.html>`_ を利用し，リテラルのデータ型がプロパティの値域の定義に基いて定義されているかどうかなどを検証することができる．
+
+
+.. _validator-dialog:
+.. figure:: figures/validator_dialog.png
+   :scale: 80 %
+   :alt:  整合性検証
+   :align: center
+
+   整合性検証
+
+プロジェクト情報
+------------------
+「ツール」メニューの「プロジェクト情報」を選択すると，:numref:`project-info-dialog` に示すダイアログが表示される．
+「プロジェクト情報」には，現在のプロジェクト名，インポート時間，モデルのリソース数，モデルのリテラル数，モデルのステートメント数，
+クラス数，プロパティ数，すべてのリソース数，すべてのリテラル数，すべてのステートメント数が表示される．
+
+.. _project-info-dialog:
+.. figure:: figures/project_info_dialog.png
+   :scale: 80 %
+   :alt: プロジェクト情報
+   :align: center
+
+   プロジェクト情報
+
+
+ログ・コンソール
+-----------------
+「ツール」メニューの「ログ・コンソールを表示」を選択すると，:numref:`log-console` に示すダイアログが表示される．
+ログ・コンソールには，標準出力と標準エラー出力への出力結果が確認できる．
+
+
+.. _log-console:
+.. figure:: figures/log_console.png
+   :scale: 80 %
+   :alt: ログ・コンソール
+   :align: center
+
+   ログ・コンソール
 
 MR3について
 -----------
+「ヘルプ」メニューの「MR3について」を選択すると，:numref:`about-mr3` に示すダイアログが表示される．
+
+.. _about-mr3:
+.. figure:: figures/about_dialog.png
+   :scale: 80 %
+   :alt: MR3について
+   :align: center
+
+   MR3について
 
 メニュー，ツールバー，ショートカットキー
 ----------------------------------------
@@ -830,6 +887,3 @@ Ctrl-X
 Ctrl-V
     コピーまたは，カットされたノードをエディタにペーストする
 
-TODO
------
-整合性検証，プラグイン管理，プロジェクト情報表示，ログコンソール，MR3についてのダイアログの説明を追加する．