Skip to content

Commit

Permalink
update documents ver.2019.05_1
Browse files Browse the repository at this point in the history
  • Loading branch information
t-morita committed May 26, 2019
1 parent 763d4d0 commit 31306ea
Show file tree
Hide file tree
Showing 14 changed files with 64 additions and 37 deletions.
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@
# built documents.
#
# The short X.Y version.
version = u'2019.03_1'
version = u'2019.05_1'
# The full version, including alpha/beta/rc tags.
release = u'2019.03_1'
release = u'2019.05_1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -297,7 +297,7 @@
# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = u'MRCube 2019.03_1 ドキュメント'
epub_title = u'MRCube 2019.05_1 ドキュメント'
epub_author = author
epub_publisher = author
epub_copyright = copyright
Expand Down
Binary file modified docs/source/figures/about_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/figures/config_dialog_basic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/figures/config_dialog_directory.png
Binary file not shown.
Binary file modified docs/source/figures/config_dialog_layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/figures/config_dialog_metaclass.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/figures/config_dialog_proxy.png
Binary file not shown.
Binary file modified docs/source/figures/config_dialog_rendering.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/figures/screenshot_of_mr3.png
Loading
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/sparql_query_dialog.png
Loading
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/toolbar/history_management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 6 additions & 5 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
------------

MR\ :sup:`3` \は,Java言語で実装されています.実行するには,JRE (Java Runtime Environment) 11または,それ以上が必要です.
ver. 2019.03_1 では,JRE11が組み込まれているため,別途JREをインストールする必要はありません.
ver. 2019.05_1 では,JRE11が組み込まれているため,別途JREをインストールする必要はありません.

動作確認は,以下の環境で行っています.

* MS Windows 10 + java version "11.0.2" 2019-01-15 LTS
* Mac OS 10.14.3 +java version "11.0.2" 2019-01-15 LTS
* MS Windows 10 + openjdk version "11.0.3" 2019-04-16
* Mac OS 10.14.3 + openjdk version "11.0.3" 2019-04-16

インストール方法
-------------------
#. `ダウンロードページ <https://sf.net/projects/mr3/>`_ から以下のファイルをダウンロードしてください.
* Windowsの場合は, **mrcube-2019.03_1_win.zip**
* macosの場合は, **mrcube-2019.03_1_mac.zip**
* Windowsの場合は, **mrcube-2019.05_1_win.zip**
* macosの場合は, **mrcube-2019.05_1_mac.zip**
#. 圧縮ファイルを展開し,binフォルダの中にある **mrcube.bat** (Windowsの場合) または **mrcube** (macosの場合)を実行すると MR\ :sup:`3` \が起動します.

アンインストール方法
Expand All @@ -33,5 +33,6 @@ MR\ :sup:`3` \は,以下のライブラリを使用しています.

* `JGraph <http://www.jgraph.com/>`_ (`License <https://github.com/jgraph/legacy-jgraph5/blob/master/LICENSE>`_)
* `Apache Jena <https://jena.apache.org/>`_ (`License <http://www.apache.org/licenses/LICENSE-2.0>`_)
* `Apache Batik SVG Toolkit <https://xmlgraphics.apache.org/batik/>`_ (`License <https://xmlgraphics.apache.org/batik/license.html>`_)
* `Drawing Graphs with VGJ <http://www.eng.auburn.edu/department/cse/research/graph_drawing/graph_drawing.html>`_ (`License <http://www.eng.auburn.edu/department/cse/research/graph_drawing/COPYING>`_)
* `Material Design icons by Google <https://github.com/google/material-design-icons>`_ (`License <https://www.apache.org/licenses/LICENSE-2.0.txt>`_)
84 changes: 55 additions & 29 deletions docs/source/user_manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -512,11 +512,11 @@ RDFエディタ内のRDFリテラルを選択すると,属性ダイアログ

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

基本
~~~~
設定ダイアログの「基本」項目( :numref:`config-basic` )では,言語,UI 言語ベースURI,ログファイルの設定ができる.言語はラベル表示を行う際に優先して表示する言語を設定できる.UI 言語は,メニューなどに表示する言語を設定できる.言語は,ja(日本語),en(英語),zh(中国語)を選択できる.ベースURI には,エクスポート時の初期の名前空間URI を設定する.ログファイルには,MR\ :sup:`3` \使用中の各種ログを保存するファイルを設定する.
設定ダイアログの「基本」項目( :numref:`config-basic` )では,「言語」,「UI 言語」,「ベースURI」,「作業ディレクトリ」,「プロキシ」の設定ができる.「言語」はラベル表示を行う際に優先して表示する言語を設定できる.「UI 言語」は,メニューなどに表示する言語を設定できる.言語は,ja(日本語),en(英語),zh(中国語)を選択できる.ベースURI には,エクスポート時の初期の名前空間URI を設定する.「作業ディレクトリ」には,インポートダイアログにおいて,RDF(S)文書を含むフォルダを選択する際に最初に開くフォルダを設定する.「プロキシ」では,プロキシサーバを利用している場合に,プロキシサーバのホスト名とポート番号の設定を行うことができる.URI を指定して,RDF(S)文書をインポートする場合に設定が必要となる場合がある.

.. _config-basic:

Expand All @@ -527,30 +527,6 @@ RDFエディタ内のRDFリテラルを選択すると,属性ダイアログ

設定ダイアログ: 基本

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

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

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

プロキシ
~~~~~~~~
設定ダイアログの「プロキシ」項目( :numref:`config-proxy` )では,プロキシサーバを利用している場合に,プロキシサーバのホスト名とポート番号の設定を行うことができる.URI を指定して,RDF(S)文書をインポートする場合に設定が必要となる場合がある.

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

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

メタクラス
~~~~~~~~~~
設定ダイアログの「メタクラス」項目( :numref:`config-metaclass` )では,「クラスクラス」および「プロパティクラス」の設定をすることができる.「クラスクラス」に設定したクラスをrdf:typeプロパティの値とするリソースを, MR\ :sup:`3` \はクラスとして認識し,クラスエディタにインポートすることができる.同様に,「プロパティクラス」に設定したクラスをrdf:type プロパティの値とするリソースを, MR\ :sup:`3` \はプロパティとして認識し,プロパティエディタにインポートすることができる.
Expand Down Expand Up @@ -578,6 +554,18 @@ RDFエディタ内のRDFリテラルを選択すると,属性ダイアログ
設定ダイアログ: レイアウト


レンダリング
~~~~~~~~~~~~~~~~~~~~~~
設定ダイアログの「レンダリング」項目( :numref:`config-rendering` )では,各エディタ内のデータグラフの構成要素(RDFリソース,RDFプロパティ,RDFリテラル,クラス,プロパティ,エディタ)についての色(文字表示色,背景色,背景選択色,線色,線選択色)を設定することができる.「白黒にする」チェックボックスにチェックをつけると全ての色と白黒に変更する.「アンチエイリアス」にチェックをつけると,ジャギー(ピクセルのギザギザ)を目立たなくさせることができる.「初期設定の色に戻す」ボタンを押すと,全ての要素の色を初期値に戻すことができる.

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

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

RDFソースコードビューア
---------------------------------------
「ツール」メニューの「RDFソースコードビューア」を選択すると, :numref:`rdf-source-code-viewer` に示すウィンドウが表示される.「RDFソースコードビューア」では,各エディタで構築したRDFモデルを指定した構文で出力することができる. **Turtle, JSONLD, XML, N-Triples** のいずれから構文は選択できる.
Expand All @@ -591,6 +579,19 @@ RDFソースコードビューア
RDFソースコードビューア


SPARQLクエリダイアログ
---------------------------------------
「ツール」メニューの「SPARQLクエリダイアログ」を選択すると,:numref:`sparql-query-dialog` に示すダイアログが表示される.
「SPARQLクエリダイアログ」では,SPARQLのSELECTクエリを「SPARQLクエリ」テキストエリアに記入し,「クエリ実行」ボタンを押すと,「クエリ実行結果」に指定した変数の検索結果が表示される.リソースまたはリテラルを選択すると,各グラフ上の対応するリソースまたはリテラルが選択される.

.. _sparql-query-dialog:
.. figure:: figures/sparql_query_dialog.png
:scale: 50 %
:alt: SPARQLクエリダイアログ
:align: center

SPARQLクエリダイアログ

整合性検証
-----------
「ツール」メニューの「整合性検証」を選択すると,:numref:`validator-dialog` に示すダイアログが表示される.
Expand Down Expand Up @@ -618,13 +619,25 @@ RDFソースコードビューア

プロジェクト情報

履歴管理
-----------------
「ツール」メニューの「履歴管理」を選択すると,:numref:`history-management-dialog` に示すダイアログが表示される.
「履歴管理」では,各エディタ上で行った操作履歴が表示され,復元したい履歴を選択し,「履歴を開く」ボタンを押すと,選択した時点の状態に各エディタの状態を復元することができる.

.. _history-management-dialog:
.. figure:: figures/history_management_dialog.png
:scale: 50 %
:alt: 履歴管理
:align: center

履歴管理


ログ・コンソール
-----------------
「ツール」メニューの「ログ・コンソールを表示」を選択すると,:numref:`log-console` に示すダイアログが表示される.
ログ・コンソールには,標準出力と標準エラー出力への出力結果が確認できる.


.. _log-console:
.. figure:: figures/log_console.png
:scale: 50 %
Expand Down Expand Up @@ -659,6 +672,12 @@ MR^3について
RDFファイル(Turtle, XML, JSONLD, N-Triples形式)またはMR\ :sup:`3` \のプロジェクトファイルを保存する.
名前をつけて保存
RDFファイル(Turtle, XML, JSONLD, N-Triples形式)またはMR\ :sup:`3` \のプロジェクトファイルを別名で保存する.
グラフを画像として保存 -> RDFグラフを画像として保存
RDFグラフをSVG, JPEG, PNGのいずれかの形式で画像ファイルとして保存する.
グラフを画像として保存 -> クラスグラフを画像として保存
クラスグラフをSVG, JPEG, PNGのいずれかの形式で画像ファイルとして保存する.
グラフを画像として保存 -> プロパティグラフを画像として保存
プロパティグラフをSVG, JPEG, PNGのいずれかの形式で画像ファイルとして保存する.
終了
プログラムを終了する.

Expand Down Expand Up @@ -713,10 +732,14 @@ RDFソースコードビューア
RDFソースコードを表示するダイアログが表示される
検索
リソース検索ダイアログが表示される
SPARQLクエリダイアログ
SPARQLのSELECTクエリにより検索を行うためのダイアログが表示される
整合性検証
整合性検証ダイアログを表示する
プロジェクト情報
プロジェクト情報ダイアログを表示する
履歴管理
履歴管理ダイアログを表示する
ログ・コンソール
MR\ :sup:`3` \の標準出力・標準エラー出力を表示するウィンドウを表示する.主にデバッグ用.
オプション
Expand Down Expand Up @@ -750,7 +773,8 @@ MR^3 マニュアル
.. figure:: figures/toolbar/cpr.png, クラス,プロパティ,RDFエディタを表示する
.. figure:: figures/toolbar/cr.png, クラス,RDFエディタを表示する
.. figure:: figures/toolbar/pr.png, プロパティ,RDFエディタを表示する
.. figure:: figures/toolbar/code.png, RDFソースコードを表示する
.. figure:: figures/toolbar/code.png, RDFソースコードビューアを表示する
.. figure:: figures/toolbar/history_management.png, 履歴管理ダイアログを表示する
.. figure:: figures/toolbar/accept.png, 整合性を検証する
.. figure:: figures/toolbar/information.png, プロジェクトの情報を表示する
.. figure:: figures/toolbar/log_console.png, ログコンソールを表示する
Expand Down Expand Up @@ -782,8 +806,10 @@ Windowsの場合には「Ctrl」を,macosの場合には「Command」をショ
Ctrl + 3 | Command + 3, ウィンドウ再配置(プロパティエディタとRDFエディタ)を実行
Ctrl + R | Command + R, RDFソースコードビューアを表示する.
Ctrl + F | Command + F, リソース検索ダイアログを表示する.
Ctrl + Shift + V | Command + Shift + V, 整合性検証を実行する.
Ctrl + Shift + F | Command + Shift + F, SPARQLクエリダイアログを表示する.
Ctrl + Shift + V | Command + Shift + V, 整合性検証ダイアログを表示する.
Ctrl + Shift + M | Command + Shift + M, プロジェクト情報を表示する.
Ctrl + Shift + H | Command + Shift + H, 履歴管理ダイアログを表示する.
Ctrl + Shift + L | Command + Shift + L, ログ・コンソールを表示する.
Ctrl + Shift + O | Command + Shift + O, オプションダイアログを表示する.
F1, MR\ :sup:`3` \についてを表示する.
Expand Down

0 comments on commit 31306ea

Please sign in to comment.