svnno****@sourc*****
svnno****@sourc*****
2009年 4月 14日 (火) 01:55:00 JST
Revision: 3266 http://svn.sourceforge.jp/view?root=jiemamy&view=rev&rev=3266 Author: daisuke_m Date: 2009-04-14 01:55:00 +0900 (Tue, 14 Apr 2009) Log Message: ----------- ディレクトリ構成改善。 Modified Paths: -------------- metis/documents/trunk/README.txt metis/documents/trunk/build.xml Added Paths: ----------- metis/documents/trunk/src/docbook/api-quickstart/ metis/documents/trunk/src/docbook/api-quickstart/api-quickstart.xml metis/documents/trunk/src/docbook/common/ metis/documents/trunk/src/docbook/common/chapter_finish.xml metis/documents/trunk/src/docbook/common/section_api_conditions.xml metis/documents/trunk/src/docbook/common/section_bendpoint.xml metis/documents/trunk/src/docbook/common/section_column_addremove.xml metis/documents/trunk/src/docbook/common/section_database_import.xml metis/documents/trunk/src/docbook/common/section_dialog_db_dialect.xml metis/documents/trunk/src/docbook/common/section_dialog_db_schema.xml metis/documents/trunk/src/docbook/common/section_discharge.xml metis/documents/trunk/src/docbook/common/section_editor_conditions.xml metis/documents/trunk/src/docbook/common/section_editor_openclose.xml metis/documents/trunk/src/docbook/common/section_editor_save.xml metis/documents/trunk/src/docbook/common/section_fk_addremove.xml metis/documents/trunk/src/docbook/common/section_install.xml metis/documents/trunk/src/docbook/common/section_license1.xml metis/documents/trunk/src/docbook/common/section_license2.xml metis/documents/trunk/src/docbook/common/section_memo_addremove.xml metis/documents/trunk/src/docbook/common/section_sql_export.xml metis/documents/trunk/src/docbook/common/section_table_addremove.xml metis/documents/trunk/src/docbook/common/section_table_edit.xml metis/documents/trunk/src/docbook/common/section_table_movesize.xml metis/documents/trunk/src/docbook/common/section_view_addremove.xml metis/documents/trunk/src/docbook/dev-process/ metis/documents/trunk/src/docbook/dev-process/dev-process.xml metis/documents/trunk/src/docbook/editor-quickstart/ metis/documents/trunk/src/docbook/editor-quickstart/editor-quickstart.xml metis/documents/trunk/src/docbook/editor-reference/ metis/documents/trunk/src/docbook/editor-reference/editor-reference.xml Removed Paths: ------------- metis/documents/trunk/src/docbook/userguide/ -------------- next part -------------- Modified: metis/documents/trunk/README.txt =================================================================== --- metis/documents/trunk/README.txt 2009-04-13 16:43:09 UTC (rev 3265) +++ metis/documents/trunk/README.txt 2009-04-13 16:55:00 UTC (rev 3266) @@ -17,8 +17,9 @@ ■ドキュメントの生成 -src/docbook/userguide内にdocbook形式のソースを配置してあります。 -この状態でAntを引数なしで起動することにより target/userguide 内に各種フォーマットのドキュメントが生成されます。 +src/docbook/(editor-quickstart|editor-reference|dev-process|api-quickstart)内にdocbook形式のソースを配置してあります。 +この状態でAntを引数なしで起動することにより target/(editor-quickstart|editor-reference|dev-process|api-quickstart) 内に +各種フォーマットのドキュメントが生成されます。 ■プロジェクト構成 @@ -29,15 +30,17 @@ ProjectRoot +- src | +- docbook - | | +- userguide - | | +- 各種ドキュメントのソース + | | +- (editor-quickstart|editor-reference|dev-process|api-quickstart) + | | | +- 各種ドキュメントのソース + | | +- common + | | +- 各種ドキュメント共通のソース(includeして使う) | +- images | | +- 画像リソース | +- test | +- java | +- ドキュメント内で使用するソースコード + target - +- userguide + +- (editor-quickstart|editor-reference|dev-process|api-quickstart) +- html | +- 複数ページHTML形式ドキュメント +- htmlsingle @@ -47,7 +50,7 @@ ■ドキュメント記述方法 -src/docbook/userguide 内のXMLを編集します。 +src/docbook/(editor-quickstart|editor-reference|dev-process|api-quickstart) 内のXMLを編集します。 現在のところ、quickstart 及び editor-reference の2つのドキュメントが定義されていますが、 新たなドキュメントを追加する際は、build.xmlを編集する必要があります。 Modified: metis/documents/trunk/build.xml =================================================================== --- metis/documents/trunk/build.xml 2009-04-13 16:43:09 UTC (rev 3265) +++ metis/documents/trunk/build.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -85,19 +85,19 @@ <!-- ======================================================================== --> <target name="build" depends="build-conf, extract-codes" description="--> Build all documentation"> <ant antfile="${dbf.basedir}/build-docbook.xml" target="all"> - <property name="docbook.dir" value="userguide"/> + <property name="docbook.dir" value="editor-quickstart"/> <property name="docbook.file" value="editor-quickstart"/> </ant> <ant antfile="${dbf.basedir}/build-docbook.xml" target="all"> - <property name="docbook.dir" value="userguide"/> + <property name="docbook.dir" value="editor-reference"/> <property name="docbook.file" value="editor-reference"/> </ant> <ant antfile="${dbf.basedir}/build-docbook.xml" target="all"> - <property name="docbook.dir" value="userguide"/> + <property name="docbook.dir" value="dev-process"/> <property name="docbook.file" value="dev-process"/> </ant> <ant antfile="${dbf.basedir}/build-docbook.xml" target="all"> - <property name="docbook.dir" value="userguide"/> + <property name="docbook.dir" value="api-quickstart"/> <property name="docbook.file" value="api-quickstart"/> </ant> </target> Copied: metis/documents/trunk/src/docbook/api-quickstart/api-quickstart.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/api-quickstart.xml) =================================================================== --- metis/documents/trunk/src/docbook/api-quickstart/api-quickstart.xml (rev 0) +++ metis/documents/trunk/src/docbook/api-quickstart/api-quickstart.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,156 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> +<book lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>Jiemamy API クイックスタートガイド</title> + <titleabbrev>APIクイックスタート</titleabbrev> + <bookinfo> + <mediaobject> + <imageobject> + <imagedata fileref="images/jiemamy_logo.png"/> + </imageobject> + </mediaobject> + <copyright> + <year>2009</year> + <holder>Jiemamy Project and the Others</holder> + </copyright> + <abstract> + <title>概要</title> + <para>Jiemamy APIの基礎的な使用方法を、実例に沿いながら説明します。</para> + </abstract> + <productname>Jiemamy</productname> + <releaseinfo>version 0.2</releaseinfo> + </bookinfo> + + <toc/> + + <preface> + <title>まえがき</title> + <para>このチュートリアルでは、簡単なJiemamyモデルの操作を通じて、Jiemamy APIの基本的な使い方を簡潔に紹介します。 +このチュートリアルを終了すれば、Jiemamy APIを利用したJiemamyモデル編集に関する基本的な知識が身に付きます。 + +このチュートリアルを完了するのに要する時間は約(TODO)分です。 + </para> + <xi:include href="../common/section_license1.xml" /> + <xi:include href="../common/section_license2.xml" /> + </preface> + + <chapter id="intro"> + <title>はじめに</title> + <section> + <title>概要</title> + <para>Jiemamyは、Webアプリケーションの開発に伴うデータベーススナップショット(スキーマと初期データ等)の管理スイートを提供します。 +GUIエディタによるER図の管理を通じてDBの状態・履歴を管理し、データベースのリファクタリングなどをサポートします。 + </para> + </section> + <xi:include href="../common/section_discharge.xml" /> + <xi:include href="../common/section_api_conditions.xml" /> + </chapter> + + <chapter id="basic"> + <title>Jiemamyの基本型</title> + <para>(TODO)</para> + <section> + <title>Jiemamyコンテキスト</title> + <para>Jiemamyの使用を開始する際には、Jiemamyクラスのインスタンスが必要となります。このインスタンスはJiemamyコンテキストと呼ばれ、 +Jiemamyのインスタンス空間を表します。Jiemamyモデルは、必ずいずれかのインスタンス空間に属し、異なったインスタンス空間に属しているモデル同士が +関連(親子関係や参照関係)を持つことができません。 + </para> + <para>Jiemamyコンテキストは、以下のように取得します。</para> + <example> + <title>Jiemamyコンテキストの取得</title> + <xi:include href="../../../target/codes/newJiemamy.xml" /> + </example> + <para>このメソッドを呼び出した結果、毎回異なったコンテキストのインスタンスが生成されます。</para> + </section> + <section> + <title>Jiemamyファクトリ</title> + <para>Jiemamyのモデルインスタンス等、新しいJiemamy関係のインスタンスは JiemamyFactory から取得します。 + </para> + <para>Jiemamyファクトリは、コンテキストから以下のように取得します。</para> + <example> + <title>Jiemamyファクトリの取得</title> + <xi:include href="../../../target/codes/getFactory.xml" /> + </example> + <para>ファクトリは、様々なJiemamyモデルのインスタンスを生成します。テーブルやカラム等はJiemamyFactory#newModel(Class)メソッドを +使用して取得します。以下の例では、テーブルを新規に作成しています。 + </para> + <example> + <title>新しいモデルインスタンスの取得</title> + <xi:include href="../../../target/codes/newTable.xml" /> + </example> + <para>Jiemamyのインスタンスは、一部の例外を除いて new 演算子によって取得しません。ほとんどのインスタンスは、このファクトリから取得します。 +java.lang.Classを鋳型情報として、インスタンスを鋳造するイメージです。 + </para> + <para>また、データ型だけは特殊で、JiemamyFactory#newDataType(DataTypeMold)メソッドを使用します。DataType型のインスタンスは +java.lang.Classだけでは生成にあたっての情報が足りないため、代りにDataTypeMold(データ型の鋳型)を使用します。データ型については、Dialect +(SQL方言)に依存する為、DataTypeMoldはDialectから取得する必要があります。この件については後述しますが、簡単にDataTypeの生成例だけを +以下に示します。 + </para> + <example> + <title>新しいDataTypeインスタンスの取得</title> + <xi:include href="../../../target/codes/newDataType.xml" /> + </example> + </section> + <section> + <title>ルートモデル</title> + <para>JiemamyファクトリからはRootModelを取得する事ができます。RootModelは、Jiemamyモデルの根となるモデルであり、全ての有効なモデルは +このモデルから辿ることができます。 + </para> + <example> + <title>ルートモデルの取得</title> + <xi:include href="../../../target/codes/getRootModel.xml" /> + </example> + </section> + </chapter> + + <chapter id="dialect"> + <title>Dialect(SQL方言)</title> + <para>(TODO)</para> + </chapter> + + <chapter id="buildModel"> + <title>Jiemamyのモデル構築</title> + <para>(TODO)</para> + <section> + <title>簡単なテーブルを作る</title> + <para>(TODO)</para> + <example> + <title>簡単なテーブルを含むモデルの構築</title> + <xi:include href="../../../target/codes/simpleTable.xml" /> + </example> + <para>このように、Jiemamyモデルは、主に以下のような手順を繰り返して構築していきます。</para> + <procedure> + <step><para>JiemamyFactoryから新しいモデルインスタンスを取得する。</para></step> + <step><para>モデルのプロパティにsetter等を使って値を設定する。この値はさらにJiemamyFactoryで生成するものかもしれません。</para></step> + <step><para>1で生成したモデルを、親となるモデルにsetter等を使って設定する。</para></step> + </procedure> + </section> + </chapter> + + <chapter id="serialize"> + <title>シリアライズ・デシリアライズ</title> + <para>作成したモデルは、シリアライザを使用して、XML形式で保存することができます。このXML形式はJiemamy Model Editorが利用するXML形式と +同一です。</para> + <para>シリアライズ・デシリアライズは、JiemamySerializerを使用して行うことができ、このインスタンスはJiemamy#getSerializer()メソッドで +取得する事ができます。</para> + <para>シリアライズの例を以下に示します。ここではRootModelを第二引数に与えた出力ストリームに出力しています。</para> + <example> + <title>シリアライズ</title> + <xi:include href="../../../target/codes/serialize.xml" /> + </example> + <para>また、シリアライズによって出力したXMLは、下記の例のようにデシリアライズし、RootModelを得ることができます。</para> + <example> + <title>デシリアライズ</title> + <xi:include href="../../../target/codes/deserialize.xml" /> + </example> + </chapter> + + <chapter id="compose"> + <title>インポート・エクスポート</title> + <para>作成したモデルは、インポータ・エクスポータを使用して、(TODO)</para> + </chapter> + + <xi:include href="../common/chapter_finish.xml" /> + +</book> Property changes on: metis/documents/trunk/src/docbook/api-quickstart/api-quickstart.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/chapter_finish.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/chapter_finish.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/chapter_finish.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/chapter_finish.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="finish" lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>おわりに</title> + <section> + <title>サポートが必要な場合</title> + <para>配布ドキュメントやWebサイト上で解決できない問題に遭遇した場合は、以下のメーリングリストに質問を投稿することができます。</para> + <para>Jiemamy-usersメーリングリスト: jiema****@lists*****</para> + <para>質問を投稿する際は、以下のページを参考に投稿内容を検討してください。早期解決に繋がります。</para> + <para>技術系メーリングリストで質問するときのパターン・ランゲージ -- 「問題の解決」から「情報の共有」に至るために +<uri>http://www.hyuki.com/writing/techask.html</uri> + </para> + </section> + <section> + <title>プログラム・ドキュメントにミスを発見した場合</title> + <para>プログラム・ドキュメント等にミスを発見した際も、上記メーリングリストに投稿してください。</para> + </section> +</chapter> Property changes on: metis/documents/trunk/src/docbook/common/chapter_finish.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_api_conditions.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_api_conditions.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_api_conditions.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_api_conditions.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>前提条件</title> + <para>Jiemamyを初めて使用する場合は、システムに次のソフトウェアをインストールしておく必要があります。下記ソフトウェアのインストールに関しては、 +Web上の各種リソースを参照して下さい。 + </para> + <itemizedlist> + <listitem> + <para><application>Java 2 Platform Standard Edition (J2SE)</application> 5.0 以降</para> + </listitem> + </itemizedlist> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_api_conditions.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_bendpoint.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/section_bendpoint.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_bendpoint.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_bendpoint.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>ベンドポイント</title> + <para>コネクションを選択した時に現れるハンドル(図中の青で示したハンドル)をドラッグすることにより、ベンドポイントを作成することができます。 +また、既に作成したベンドポイントのハンドル(図中の赤で示したハンドル)をドラッグすることにより、ベンドポイントの移動ができます。 +さらに、ベンドポイントのハンドルを、その左右のベンドポイントの延長線上に配置することにより、ベンドポイントの削除ができます。 + </para> + <figure> + <title>コネクションのハンドル</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/basic_handle_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_bendpoint.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_column_addremove.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_column_addremove.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_column_addremove.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_column_addremove.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>カラムの追加と削除</title> + <para>テーブル編集ダイアログの「カラム(C)」タブで「追加(A)」をクリックすると、最下段にカラムを追加することができます。 +また、上部のリストでカラムを選択し、「挿入(I)」をクリックすると、選択している位置(選択したカラムの1つ上)にカラムを挿入することができます。 + </para> + <para>上部のリストでカラムを選択し、「削除(R)」をクリックすると、選択したカラムを削除することができます。</para> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_column_addremove.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_database_import.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_database_import.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_database_import.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_database_import.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>データベース・インポート</title> + <para>既存のデータベースからJiemamyに、スキーマをインポートすることができます。</para> + <procedure> + <step> + <para>右クリックで表示されるコンテキストメニューから「インポート(I)」>「Database Importer」を選択します。</para> + <figure> + <title>Database Importerの選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/databaseImporter_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>ポップアップしたウィザードで、まず「データベース種別(D)」にてインポート元のDBの種類(SQL方言)を設定します。</para> + <figure> + <title>DBインポートウィザード</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/databaseImporter_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>「追加(A)」ボタンをクリックし、JDBCドライバを含むjarファイルを選択します。ドライバの動作にあたって複数のjarが必要な場合は、 +このステップを繰り返します。 + </para> + </step> + <step> + <para>ドライバjarに含まれるDriverクラスが「JDBCドライバクラス(C)」に表示されるので、適切なドライバクラスを選択します。</para> + </step> + <step> + <para>「接続URI(I)」に、データベース接続URIを設定します。</para> + </step> + <step> + <para>「接続ユーザ名(U)」と「接続パスワード(P)」に、接続アカウントを設定します。</para> + </step> + <step> + <para>「スキーマ名(S)」とにスキーマ名を設定します。空欄でも構いません。</para> + </step> + <step> + <para>以上を設定の上、「接続テスト(T)」ボタンをクリックし、結果のダイアログを確認します。</para> + <figure> + <title>接続に成功した場合</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/databaseImporter_03.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <figure> + <title>接続に失敗した場合の一例(この例は、PostgreSQLで、パスワードが異なる場合)</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/databaseImporter_04.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>接続できることを確認したら、Finishボタンをクリックします。</para> + </step> + <step> + <para>インポートにはしばらく時間がかかる可能性があります。完了し次第、完了した旨のダイアログが表示されます。</para> + </step> + </procedure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_database_import.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_dialog_db_dialect.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_dialog_db_dialect.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_dialog_db_dialect.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_dialog_db_dialect.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>DBの選択</title> + <para>新しいJiemamyモデルファイルを開いたら、まずこれからモデリングするスキーマを適用するデータベースを選択します。 +データベース情報編集ダイアログのデータベースの項目を変更し、OKボタンをクリックします。 + </para> + <figure> + <title>データベースの選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/rootEdit_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_dialog_db_dialect.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_dialog_db_schema.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_dialog_db_schema.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_dialog_db_schema.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_dialog_db_schema.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>スキーマ名の設定</title> + <para>必要であれば、データベースのスキーマ名を設定することができます。 +データベース情報編集ダイアログのスキーマ名入力欄にスキマー名を入力し、OKボタンをクリックします。 + </para> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_dialog_db_schema.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_discharge.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_discharge.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_discharge.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_discharge.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>免責事項</title> + <para>理由の如何を問わず、Jiemamy(以下、「本ソフトウェア」と呼ぶ。)のインストールに起因して +生じた損害または損失に対して、Jiemamy Project及びその関係者(以下、「甲」と呼ぶ。)は一切の責任を負いません。 + </para> + <para>甲は、本ソフトウェアおよびそのドキュメント類に関して一切の保証を行いません。 +甲は、本ソフトウェアにバグがないこと、これが正常に動作すること、またはユーザ(以下、「乙」と呼ぶ。)の +期待通りに動作することを保証していません。 + </para> + <para>甲は、乙がご使用になるソフトウェア・プログラム(本ソフトウェアを含むがこれに限定されない)の +使用または使用不能に起因する、逸失利益、職務の中断、データの損失を含む(但しこれらに限定されない)、 +特別、派生的、間接的又は類似した損害やその他いかなる損害において、あらかじめ甲がそのような損害の +可能性について知らされていた場合であっても、一切の責任を負いません。 + </para> + <important> + <para>ソフトウェアの性格上、JiemamyからDBに対して操作を行うことがありますが、最悪の場合、 +その際にDBのデータを破壊してしまう可能性もあります。Jiemamyの利用に先立っては、必ず +データのバックアップをお取りください。 + </para> + </important> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_discharge.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_editor_conditions.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_editor_conditions.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_editor_conditions.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_editor_conditions.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>前提条件</title> + <para>Jiemamyを初めて使用する場合は、システムに次のソフトウェアをインストールしておく必要があります。下記ソフトウェアのインストールに関しては、 +Web上の各種リソースを参照して下さい。 + </para> + <itemizedlist> + <listitem> + <para><application>Java 2 Platform Standard Edition (J2SE)</application> 5.0 以降</para> + </listitem> + <listitem> + <para><application>Eclipse 3.3</application> (Europa)以降</para> + </listitem> + </itemizedlist> + <note> + <para>以上は、Jiemamy Model Editorの動作環境です。Jiemamyを使用して作るプロジェクトに関しては、Javaのバージョンの制限はありません。 +Jiemamyは工夫次第で、Javaプロジェクト以外にも適用できる可能性があります。 + </para> + </note> + <para>また、Jiemamy Eclipse Model Editorの動作にあたっては、下記のEclipseプラグインが必要となります。インストールに関しては後述します。 + </para> + <itemizedlist> + <listitem> + <para>Eclipse Graphical Editing Framework (GEF) 3.2 以降</para> + </listitem> + </itemizedlist> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_editor_conditions.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_editor_openclose.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_editor_openclose.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_editor_openclose.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_editor_openclose.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <title>エディタの起動と終了</title> + <para>新しくJiemamyモデルファイルを作成する場合は、File > New > Other より、Jiemamy ER Diagram を選択し、Nextボタンをクリックします。 +次の画面でファイル名を入力します。拡張子は .jer でなければなりません。 + </para> + <figure> + <title>新規Jiemamyモデルファイルの作成</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/open_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <tip> + <para>ファイルの拡張子を省略した場合は、自動的に .jer を補完します。</para> + </tip> + <note> + <para>Eclipseは、プロジェクトがなければファイルを作成することができません。1つもプロジェクトが無い場合は、新規にプロジェクトを作成してください。 + </para> + </note> + <para>既存のJiemamyモデルファイルを開く場合は、Package Explorer, Navigator, Project Explorer 等より、ファイルをダブルクリックする +ことにより、エディタを開く事ができます。 + </para> + <figure> + <title>既存Jiemamyモデルファイルを開く</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/open_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_editor_openclose.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_editor_save.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_editor_save.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_editor_save.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_editor_save.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <title>保存</title> + <para>エディタで開いて編集を行ったファイルは、ツールバーのSaveアイコンをクリックすることにより、保存できます。編集されたファイルは、タブに表示された +ファイル名の前にアスタリスク(*)でマークがつきます。マークのないファイルは保存することができません。 + </para> + <figure> + <title>Saveアイコン</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/save_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <figure> + <title>編集マーク</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/save_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_editor_save.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_fk_addremove.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_fk_addremove.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_fk_addremove.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_fk_addremove.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>外部キーの追加と削除</title> + <procedure> + <step><para>外部キーの追加は、まずパレットの「コネクション」カテゴリから「外部キー」を選択します。</para></step> + <step><para>その状態で、まず制約を受けるテーブルをクリックします。</para></step> + <step><para>続いて、参照されるテーブルをクリックします。</para></step> + </procedure> + <para>以上で、ダイアグラム上に外部キーが1つ作成されます。</para> + <tip> + <para>外部キーは、自分自身のテーブルを参照することも可能です。2回続けて同じテーブルをクリックすることにより、このような外部キーも +作成することができます。 + </para> + </tip> + <figure> + <title>パレット</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/palette.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>外部キーの削除は、削除したい外部キーを選択し、右クリックで表示されるコンテキストメニューから「Delete」を選択します。 +メニュー選択の代りに、<keycap>DEL</keycap>キーで削除を行うこともできます。 + </para> + <tip> + <para>複数のコネクションを同時に選択し、全てを同時に削除することも可能です。</para> + </tip> + <figure> + <title>コンテキストメニュー</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/basic_delete.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_fk_addremove.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_install.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_install.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_install.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_install.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section> + <title>インストール</title> + <para>まず、Jiemamy Model Editorのインストールを行います。</para> + <para>Eclipseのメニューバーより、Help > Software Updates > Find and install... をクリックし、ウィザードの +Search for new features to install を選択し、Next をクリックします。 + </para> + <figure> + <title>メニューバーより Find and Install...を選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <figure> + <title>ウィザードの Search for new features to install を選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>ウィザードの2ページ目において、Jiemamy Eclipseプラグイン配布サイトの登録を行います。New Remote Siteボタンをクリックし、 +Nameに任意の名称("Jiemamy Update Site" を推奨)を、URLに<uri>http://eclipse.jiemamy.org/release/</uri>を入力し、 +OKボタンをクリックします。 + </para> + <figure> + <title>New Remote Siteボタンをクリック</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_03.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <figure> + <title>Jiemamy Eclipseプラグイン配布サイトの登録</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_04.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>Jiemamy Eclipse Model Editorの動作には、Eclipse Graphical Editing Framework (GEF) 3.2 以降が必要となります。 +GEFは、EclipseのプラグインとしてEclipse公式サイト(Europa Discovery Site)にて配布されていますので、ここで同時にインストールを行います。 +既にGEFがインストールされている場合は、Europa Discovery Siteを選択する必要はありません。 + </para> + <para>たった今登録した Jiemamy Update Site 及び Europa Discovery Site にチェックが入っていることを確認し、Finishボタンをクリックします。 + プログレスバーの進行が完了すると次の画面に進みます。ツリーから Jiemamy Eclipse Model Editor Feature A.B.C.YYYYMMDDhhmm + 及び、使用予定のデータベースのDialectを選択します。このチュートリアルでは MySQL を使用します。Dialectは必要に応じて複数 + インストールすることも可能です。GEFをインストールする場合は、Graphical Editing Framework にもチェックを入れます。 + 選択が完了したら、Nextボタンをクリックします。 + </para> + <figure> + <title>インストールするプラグインの選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_05.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>ライセンス許諾(Apache License Version 2.0)に同意の上、I accept the terms in the licese agreements を選択し、 +Nextボタンをクリックします。 + </para> + <figure> + <title>ライセンス許諾への同意</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_06.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>インストール先を確認し(通常、デフォルトのままで構いません)、Finishボタンをクリックします。</para> + <figure> + <title>インストール先の確認</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_07.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>インストールするプラグインの確認がありますので、Install Allボタンをクリックします。</para> + <figure> + <title>インストールするプラグインの確認</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_08.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>プログレスバーの進行が完了すると、Eclipseの再起動を促されます。YesボタンをクリックしてEclipseの再起動を行います。 +以上でJiemamy Eclipse Model Editorのインストールは完了です。メニューバーから Help > About Eclipse Platform を選択し、 +AboutダイアログにJiemamyのロゴが表示されていれば、インストール成功です。 + </para> + <figure> + <title>再起動確認</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_09.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <figure> + <title>インストールの成否確認</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/intro_10.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_install.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_license1.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_license1.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_license1.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_license1.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="section-license1" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>このドキュメントのライセンス</title> + + <para>Copyright © 2006-2007 Jiemamy Project and the Others.</para> + + <para>Licensed under the Apache License, Version 2.0 (the "License") you + may not use this file except in compliance with the License. You may + obtain a copy of the License at + <uri>http://www.apache.org/licenses/LICENSE-2.0</uri></para> + + <para>Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an "AS IS" + BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing permissions + and limitations under the License.</para> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_license1.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_license2.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_license2.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_license2.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_license2.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="section-license2" lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>その他ライセンス</title> + + <para>このドキュメントは、IPAフォント(バージョン 002.03)を使用しています。</para> + + <para>IPAフォントは、一般利用者向けIPAフォント使用許諾契約に基づき、PDFに埋め込まれた形で再配布されています。 + <uri>http://ossipedia.ipa.go.jp/ipafont/</uri></para> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_license2.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_memo_addremove.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/section_memo_addremove.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_memo_addremove.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_memo_addremove.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>メモの追加と削除</title> + <procedure> + <step><para>メモの追加は、まずパレットの「その他」カテゴリから「メモ」を選択します。</para></step> + <step><para>その状態で、ダイアグラム上をクリックします。</para></step> + </procedure> + <para>以上で、ダイアグラム上にメモが1つ作成されます。</para> + <tip> + <para>ダイアグラムをクリックした場合、デフォルトサイズ(必要に応じてサイズが自動調整される)のノードが作成されます。 +ダイアグラムをドラッグした場合は、ドラッグしたサイズでテーブルが生成されます。この場合、手動でサイズ調整しない限り、カラムが隠れてしまう場合があります。 + </para> + </tip> + <figure> + <title>パレット</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/palette.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>メモの削除は、削除したいメモを選択し、右クリックで表示されるコンテキストメニューから「Delete」を選択します。 +メニュー選択の代りに、<keycap>DEL</keycap>キーで削除を行うこともできます。 + </para> + <tip> + <para>複数のノードを同時に選択し、全てを同時に削除することも可能です。</para> + </tip> + <figure> + <title>コンテキストメニュー</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/basic_delete.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_memo_addremove.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_sql_export.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_sql_export.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_sql_export.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_sql_export.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>SQL・エクスポート</title> + <para>Jiemamyで作成したモデルは、SQLとしてエクスポートすることができます。</para> + <procedure> + <step> + <para>右クリックで表示されるコンテキストメニューから「エクスポート(E)」>「SQL Exporter」を選択します。</para> + <figure> + <title>SQL Exporterの選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/sqlExporter_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>ポップアップしたウィザードで、出力するSQLファイルのパスを指定します。「参照(B)」ボタンで保存先を指定することもできます。 +また、指定したファイルが既に存在したら上書きを行いますが、出力を中止したい場合は「存在したら上書きする」のチェックを外して下さい。 + </para> + <para>このページの設定が終わればFinishボタンでSQLファイルのエクスポートを完了します。さらに細かい出力設定を行う場合は、 +「Next >」ボタンをクリックします。 + </para> + <figure> + <title>出力ファイルのパスを設定</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/sqlExporter_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>次のページでは、さらに出力の設定を行うことができます。CREATE文に先立ってDROP文も出力したい場合は「DROP文を出力する」に +チェックを入れて下さい。CREATE SCHEMA文を出力したい場合は、「CREATE SCHEMA文を出力する」にチェックを入れて下さい。 + </para> + <para>CREATE TABLE文の後に、登録したデータセットのINSERT文を出力したい場合は、「出力するデータセット」にて該当するデータセットを +選択してください。</para> + <figure> + <title>細かい出力設定</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/sqlExporter_03.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>Finishボタンをクリックすることにより、SQLの出力を行うことができます。完了し次第、完了した旨のダイアログが表示されます。</para> + </step> + </procedure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_sql_export.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_table_addremove.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_table_addremove.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_table_addremove.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_table_addremove.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>テーブルの追加と削除</title> + <procedure> + <step><para>テーブルの追加は、まずパレットの「エンティティ」カテゴリから「テーブル」を選択します。</para></step> + <step><para>その状態で、ダイアグラム上をクリックします。</para></step> + </procedure> + <para>以上で、ダイアグラム上にテーブルが1つ作成されます。</para> + <tip> + <para>ダイアグラムをクリックした場合、デフォルトサイズ(必要に応じてサイズが自動調整される)のノードが作成されます。 +ダイアグラムをドラッグした場合は、ドラッグしたサイズでテーブルが生成されます。この場合、手動でサイズ調整しない限り、カラムが隠れてしまう場合があります。 + </para> + </tip> + <figure> + <title>パレット</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/palette.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>テーブルの削除は、削除したいテーブルを選択し、右クリックで表示されるコンテキストメニューから「Delete」を選択します。 +メニュー選択の代りに、<keycap>DEL</keycap>キーで削除を行うこともできます。 + </para> + <tip> + <para>複数のノードを同時に選択し、全てを同時に削除することも可能です。</para> + </tip> + <figure> + <title>コンテキストメニュー</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/basic_delete.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_table_addremove.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_table_edit.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_table_edit.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_table_edit.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_table_edit.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>テーブルの編集</title> + <procedure> + <step><para>テーブルをダブルクリック、またはコンテキストメニューから「プロパティ(P)」を選択することにより、テーブル編集ダイアログが開きます。</para></step> + <step><para>タブ上部のテーブル情報編集エリアで、テーブル名等の編集を行います。</para></step> + </procedure> + <tip> + <para>テーブルが選択された状態で、再びそのテーブルをクリックすると、ダイアログを開かずに、テーブル名をその場で編集することができます。</para> + <figure> + <title>テーブル名の直接編集</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/tableEdit_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </tip> + <para>テーブル編集ダイアログの最上段で、テーブルの基本情報を設定することができます。ここに、テーブルの物理名や論理名を入力し、また、 +表示色の調整を行うことができます。 + </para> + <para>一番右にある「無効」チェックボックスをONにすると、エクスポーターがこのテーブルを無視するようになります。</para> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_table_edit.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_table_movesize.xml (from rev 3263, metis/documents/trunk/src/docbook/userguide/section_table_movesize.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_table_movesize.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_table_movesize.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>テーブルの移動とサイズ調整</title> + <para>ノードをドラッグ&ドロップすることにより、位置を移動することができます。また、ノードを選択した時、縁に8カ所配置されているハンドルを +ドラッグすることにより、ノードのサイズを変更することができます。 + </para> + <figure> + <title>ノードのハンドル</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/basic_handle_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <tip> + <para>手動でノードのサイズを変更した場合は、カラム数に応じてサイズが自動調整されなくなります。一度手動調整したノードを自動調整に戻すには、 +コンテキストメニューから「サイズ調整(Z)」>「サイズを自動調整(S)」を選択します。 + </para> + </tip> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_table_movesize.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/common/section_view_addremove.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/section_view_addremove.xml) =================================================================== --- metis/documents/trunk/src/docbook/common/section_view_addremove.xml (rev 0) +++ metis/documents/trunk/src/docbook/common/section_view_addremove.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>ビューの追加と削除</title> + <procedure> + <step><para>ビューの追加は、まずパレットの「エンティティ」カテゴリから「ビュー」を選択します。</para></step> + <step><para>その状態で、ダイアグラム上をクリックします。</para></step> + </procedure> + <para>以上で、ダイアグラム上にビューが1つ作成されます。</para> + <tip> + <para>ダイアグラムをクリックした場合、デフォルトサイズ(必要に応じてサイズが自動調整される)のノードが作成されます。 +ダイアグラムをドラッグした場合は、ドラッグしたサイズでテーブルが生成されます。この場合、手動でサイズ調整しない限り、カラムが隠れてしまう場合があります。 + </para> + </tip> + <figure> + <title>パレット</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/palette.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>ビューの削除は、削除したいビューを選択し、右クリックで表示されるコンテキストメニューから「Delete」を選択します。 +メニュー選択の代りに、<keycap>DEL</keycap>キーで削除を行うこともできます。 + </para> + <tip> + <para>複数のノードを同時に選択し、全てを同時に削除することも可能です。</para> + </tip> + <figure> + <title>コンテキストメニュー</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/basic_delete.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> +</section> Property changes on: metis/documents/trunk/src/docbook/common/section_view_addremove.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/dev-process/dev-process.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/dev-process.xml) =================================================================== --- metis/documents/trunk/src/docbook/dev-process/dev-process.xml (rev 0) +++ metis/documents/trunk/src/docbook/dev-process/dev-process.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,120 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> +<book lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>Jiemamy 開発プロセスガイド</title> + <titleabbrev>開発プロセスガイド</titleabbrev> + <bookinfo> + <mediaobject> + <imageobject> + <imagedata fileref="images/jiemamy_logo.png"/> + </imageobject> + </mediaobject> + <copyright> + <year>2009</year> + <holder>Jiemamy Project and the Others</holder> + </copyright> + <abstract> + <title>概要</title> + <para>Jiemamyプロジェクトが考える、Jiemamyをアプリケーション開発に適用する方法論を紹介します。</para> + </abstract> + <productname>Jiemamy</productname> + <releaseinfo>version 0.2</releaseinfo> + </bookinfo> + + <toc/> + + <preface> + <title>まえがき</title> + <para>このチュートリアルでは、(TODO) + </para> + <xi:include href="../common/section_license1.xml" /> + <xi:include href="../common/section_license2.xml" /> + </preface> + + <chapter id="intro"> + <title>はじめに</title> + <para>皆さんが関わっているWebアプリケーションプロジェクト。大抵はCVS, Subversion, Git, Mercurial等による構成管理が行われていると思います。 +このソフトウェアをチェックアウトしてから、ビルド・デプロイ等の手順を踏んで起動にこぎ着けるまで、どのようなステップがありますか? +設定ファイルを環境に合わせて整備し、DBをインストールし、このSQKを流して…。 + </para> + <para>この、プロジェクトのビルド手順を標準化し、コマンドを1つ叩くだけで「今すぐ利用可能な状態」を作れるようにしよう、という試みの一つが +Apache Mavenプロジェクトです。我々は、このビルド手法を「スマートビルド」と呼んでいますが、データベース(DB)の構築に関しては、理想的なスマートビルドを +行う事が困難である感じました。 + </para> + <para>開発中にDBのスキーマが変更になる際、どのような手続きを踏みますか? DB管理者と相談し、ER図を更新し、初期DBの初期化SQLを更新し、 +前バージョンのDBからの移行スクリプトを書き…。 + </para> + <para>このように、DBの管理・変更には大きなコストがかかります。</para> + <para>Jiemamyは、このDB構成の管理手順を標準化・補助することにより、DB状態の適切な管理を実現します。また、それにより、 +DBに対するリファクタリングや移行作業を簡潔に行うことができます。 + </para> + </chapter> + + <chapter id="configurationManagement"> + <title>構成管理</title> + <section> + <title>構成管理の重要性</title> + <para>システム開発を行う上で、構成管理の必要性はもはや言うまでもないのですが、今一度、この構成管理の目的を挙げてみます。 +下記の他にも数多くの構成管理によるメリットはあると思いますが…。 + </para> + <itemizedlist> + <listitem><para>必要なファイル群をセットでまとめて入手できるようにする</para></listitem> + <listitem><para>プロジェクトの過去の状態をいつでも呼び出せるようにする</para></listitem> + <listitem><para>誰がどこをどの様に変更したのかを記録する</para></listitem> + </itemizedlist> + <para>ここでは、上に挙げた1つ目及び2つ目の役割について考えてみます。</para> + </section> + <section> + <title>管理の対象</title> + <para>構成管理の主な対象はファイルとなりますが、どのようなファイルを構成管理すべきでしょうか。</para> + <para>プロジェクトによっては、テストコードはコミットしない、データファイル・設定ファイルはコミットしない、ドキュメントやDBのCREATE文はファイルサーバに +置いて管理する、などの不思議なルールがまかり通っています。果たして、これらのファイルを構成管理下に置かないメリットはあるのでしょうか。 +我々は、そのデメリットの方が大きいと考えています。 + </para> + <itemizedlist> + <listitem><para>テストを誰しもが実行できなくなる</para></listitem> + <listitem><para>初めて開発環境を整える際に、既存メンバーの手を煩わせることになる</para></listitem> + <listitem><para>過去のドキュメント・DBの状態を呼び戻せなくなる</para></listitem> + </itemizedlist> + <para>その他にも色々なデメリットがあると思います。対して、これらのファイルを構成管理したがらない人が主張するのは「関係ないファイルを置きたくない」 +「置いても管理できない」等でしょう。ドキュメントは果たして「関係ないファイル」なのか。構成管理システム下に置かない事で「管理できるようになる」のか。 +今一度考えて頂きたいところです。 + </para> + <para>構成管理の理想的な運用目的は、「コンパイルできる状態のソースコードを維持」することではなく、 +「<emphasis>正常に動作する状態のシステム</emphasis>を維持管理する」ことです。この視点で考えると、例えばDBの初期化スクリプト(SQL文など)を +構成管理しなかった場合、ソースコードについては過去の状態が呼び出せたとしても、それに依存するDBの状況が再現できません。当時のDBは、どのような +テーブルがあるべきだったのか。恐らくその点は、誰も管理していないと思います。つまり、昔の状態のアプリケーションを、もはや正常に動かす事ができないのです。 + </para> + <para>以上の理由により、我々は、<emphasis>ソースコードだけではなく、プログラムの動作に必要なファイルだけではなく、そのプロジェクトにまつわる +全てのファイル</emphasis>を構成管理すべきだと主張します。 + </para> + </section> + <section> + <title>初期データも管理項目の一つ</title> + <para>以上のように、アプリケーションの過去の状況を呼び出す為には、アプリケーションのソースコードだけではなく、データベースのスキーマも管理する +必要があることはお分かり頂けたかと思います。さらにもう一歩踏み込むと、例えば、初回ログインの為のアカウント情報や、デフォルトの設定情報など、 +テーブルはあったとしても空であっては正常に動作しないアプリケーションも多く存在します。 + </para> + <para>従って、スキーマと同様、「初期データ」(初期状態でテーブルにINSERTされているべきデータ)も構成管理項目となります。</para> + </section> + </chapter> + + <chapter id="before"> + <title>Jiemamyを使用せず、DBの構成管理を行うケース</title> + <para>(TODO)</para> + </chapter> + + <chapter id="changeDatabase"> + <title>データベースの変更が発生した場合</title> + <para>(TODO)</para> + </chapter> + + <chapter id="after"> + <title>Jiemamyを使用して、DBの構成管理を行うケース</title> + <para>(TODO)</para> + </chapter> + + <xi:include href="../common/chapter_finish.xml" /> + +</book> Property changes on: metis/documents/trunk/src/docbook/dev-process/dev-process.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/editor-quickstart/editor-quickstart.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/editor-quickstart.xml) =================================================================== --- metis/documents/trunk/src/docbook/editor-quickstart/editor-quickstart.xml (rev 0) +++ metis/documents/trunk/src/docbook/editor-quickstart/editor-quickstart.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,285 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> +<book lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>Jiemamy クイックスタートガイド</title> + <titleabbrev>クイックスタート</titleabbrev> + <bookinfo> + <mediaobject> + <imageobject> + <imagedata fileref="images/jiemamy_logo.png"/> + </imageobject> + </mediaobject> + <copyright> + <year>2009</year> + <holder>Jiemamy Project and the Others</holder> + </copyright> + <abstract> + <title>概要</title> + <para>Jiemamy Eclipse Model Editorの基礎的な使用方法を説明し、実例に沿いながら操作をしてみます。</para> + </abstract> + <productname>Jiemamy Eclipse Model Editor</productname> + <releaseinfo>version 0.2.0</releaseinfo> + </bookinfo> + + <toc/> + + <preface> + <title>まえがき</title> + <para>Jiemamyにようこそ。</para> + <para>このチュートリアルでは、簡単なER図の作成を通じて、Jiemamyの基本的な使い方を簡潔に紹介します。 +このチュートリアルを終了すれば、Jiemamy Eclipse Model Editorを利用したJiemamyモデル編集に関する基本的な知識が身に付きます。 + +このチュートリアルを完了するのに要する時間は約(TODO)分です。 + +このチュートリアルを終了したら、Jiemamy Eclipse Model Editorリファレンスに進む事ができます。 + </para> + <xi:include href="../common/section_license1.xml" /> + <xi:include href="../common/section_license2.xml" /> + </preface> + + <chapter id="intro"> + <title>はじめに</title> + <section> + <title>概要</title> + <para>Jiemamyは、Webアプリケーションの開発に伴うデータベーススナップショット(スキーマと初期データ等)の管理スイートを提供します。 +GUIエディタによるER図の管理を通じてDBの状態・履歴を管理し、データベースのリファクタリングなどをサポートします。 + </para> + </section> + <xi:include href="../common/section_discharge.xml" /> + <xi:include href="../common/section_editor_conditions.xml" /> + <xi:include href="../common/section_install.xml" /> + </chapter> + + <chapter id="basic"> + <title>エディタの基本操作</title> + <xi:include href="../common/section_editor_openclose.xml"/> + <xi:include href="../common/section_editor_save.xml"/> + <section> + <title>DBの選択</title> + <para>新しいJiemamyモデルファイルを開いたら、まずこれからモデリングするスキーマを適用するデータベースを選択します。このチュートリアルでは +MySQLを使用します。エディタの背景を右クリックし、メニューからプロパティ(P)を選択します。 + </para> + <figure> + <title>エディタを右クリックしたメニューからプロパティ(P)を選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/rootEdit_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>ポップアップしたダイアログのデータベースの項目を org.jiemamy.dialect.mysql.MySqlDialect に変更し、OKボタンをクリックします。</para> + <figure> + <title>データベースの選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/rootEdit_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </section> + </chapter> + + <chapter id="diagram"> + <title>ダイアグラム</title> + <section> + <title>エンティティ</title> + <para>テーブルとビューをあわせて、エンティティと呼びます。エンティティはダイアグラム上で矩形のノードとしてあらわされます。 +エンティティ名の左側に T のマークがあるものがテーブル、V のマークがあるものがビューを表します。デフォルトの色は下図の通りです。 + </para> + <note> + <para>ノードの色は変更できますので、色でエンティティの種類を確実に判断することはできません。</para> + </note> + <figure> + <title>エンティティノード</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/diagram_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>矩形の最上段がエンティティ種別マークとエンティティ名、罫線を挟んでその下側がカラム名とデータ型のリストになります。</para> + <note> + <para>現行のバージョンでは、ビューのカラムは表示されません。</para> + </note> + <para>テーブルにおいて、主キーに設定されたカラムは、そのカラム名とデータ型にアンダーラインがつきます。</para> + </section> + <section> + <title>リレーション</title> + <para>外部キーの関係は、ダイアグラム上でコネクションとしてあらわされます。制約を受けるテーブルから参照されるテーブルに向けての +矢印がリレーションです。 + </para> + <figure> + <title>リレーション</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/diagram_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>コネクションの上にはラベルが表示され、1行目が外部キー名(無名の場合は表示されません)、2行目以降が「制約を受けるカラムの名前 -> +参照されるカラムの名前」のフォーマットで対応関係が表示されます。 + </para> + </section> + <section> + <title>メモ</title> + <para>ダイアグラム上にメモを記述することができます。メモは下図のように角丸矩形のノードで表示されます。</para> + <figure> + <title>メモ</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/diagram_03.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </section> + <!-- + <section> + <title>メモ・コネクション</title> + <para>メモと、その他のノードを接続する説明用のコネクションは、(TODO)</para> + </section> + --> + </chapter> + + <chapter id="edit-table"> + <title>基本操作1 テーブル</title> + <para>この章では、テーブルの操作を解説します。</para> + <xi:include href="../common/section_table_addremove.xml"/> + <xi:include href="../common/section_table_movesize.xml"/> + <section> + <title>テーブルの編集</title> + <para>テーブルをダブルクリック、またはコンテキストメニューから「プロパティ(P)」を選択することにより、テーブル編集ダイアログが開きます。</para> + <para>このダイアログでは、テーブルに関する全ての情報を編集することができます。最上段の「テーブル名(N)」欄で、テーブル名を指定します。</para> + <figure> + <title>テーブル編集ダイアログ</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/tableEdit_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </section> + <xi:include href="../common/section_column_addremove.xml"/> + <section> + <title>カラムの編集</title> + <para>上部のリストで選択したカラムは、下部の「カラム情報」で編集を行う事ができます。以下に、代表的な項目を説明します。</para> + <itemizedlist> + <listitem><para>「カラム名(M)」 -- カラムの物理名を設定します。</para></listitem> + <listitem><para>「データ型(T)」 -- カラムのデータ型を設定します。設定したデータベースにより、選択肢が変化します。</para></listitem> + <listitem><para>データ型オプション -- データ型によって、右側に「サイズ」等の追加のコントロールが表示される場合があります。</para></listitem> + <listitem><para>「主キー(P)」 -- このカラムを主キーカラムとする場合にチェックします。</para></listitem> + <listitem><para>「NOT NULL(N)」 -- このカラムにNOT NULL制約を付加する場合にチェックします。</para></listitem> + </itemizedlist> + <para>編集が終わり、変更を適用する場合はOKを、適用しない場合はCancelをクリックし、ダイアログを終了します。</para> + </section> + </chapter> + + <chapter id="edit-fk"> + <title>基本操作2 外部キー</title> + <xi:include href="../common/section_fk_addremove.xml" /> + <section> + <title>外部キーの編集</title> + <para>外部キーをダブルクリック、またはコンテキストメニューから「プロパティ(P)」を選択することにより、外部キー編集ダイアログが開きます。</para> + <para>このダイアログでは、外部キーに関する全ての情報を編集することができます。最下段の「マッピング」、参照元カラムと参照先カラムの +対応関係(マッピング)を設定します。 + </para> + <figure> + <title>外部キー編集ダイアログ</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/foreignKeyEdit_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </section> + <xi:include href="../common/section_bendpoint.xml"/> + </chapter> + + <chapter id="compose"> + <title>インポートとエクスポート</title> + <para>外部のリソースからJiemamyモデルに情報の取り込みを行うことをインポート、Jiemamyモデルを別の形に変換して出力することをエクスポートと呼びます。 +また、インポートやエクスポートを行う拡張ロジックを、それぞれインポータ・エクスポータと呼びます。 + </para> + <para>ここでは、DatabaseImporter及びSqlExporterの説明を行います。その他のインポータ・エクスポータについては、それぞれのドキュメントを +参照してください。 + </para> + <xi:include href="../common/section_database_import.xml" /> + <xi:include href="../common/section_sql_export.xml" /> + </chapter> + + <chapter id="caseStudy"> + <title>ケース・スタディ</title> + <para>ここでは、Jiemamyでダイアグラムを作成し、SQLにエクスポートするまでを、順を追って説明します。</para> + <para>(TODO)</para> + </chapter> + + <xi:include href="../common/chapter_finish.xml" /> + + <chapter id="docbook-sample"> + <title>docbook syntax samples</title> + <para>以下、docbook記法のサンプル。リリースまでには消す。</para> + <section> + <title>sample</title> + <para>You must include at least one chapter in your book.</para> + <para>Here is another paragraph.</para> + + <important> + <para>This is some really important text.</para> + </important> + <caution> + <para>Liberal use of <code>new</code> in loops can cause performance issues!</para> + </caution> + <warning> + <para>warning!</para> + </warning> + <tip> + <para>Look both ways before crossing the street!</para> + </tip> + <note> + <para>note!</para> + </note> + <example> + <title>Example 1</title> + <programlisting> +String something = "Something"; + </programlisting> + </example> + </section> + + <section> + <title>simplelist</title> + <simplelist type="inline"> + <member>Apples</member> + <member>Oranges</member> + <member>Bananas</member> + <member>Grapefruit</member> + <member>Black Beans</member> + </simplelist> + </section> + + <section> + <title>itemizedlist</title> + <itemizedlist> + <listitem><para>Apples - my favorite fruit.</para></listitem> + <listitem><para>Oranges - yummy, but sticky.</para></listitem> + <listitem><para>Bananas - they ripen too quickly!</para></listitem> + <listitem><para>Grapefruit - great when eaten in halves.</para></listitem> + <listitem><para>Black Beans - go well with rice.</para></listitem> + </itemizedlist> + </section> + + <section> + <title>orderedlist</title> + <orderedlist numeration="arabic"> + <listitem><para>Wake up.</para></listitem> + <listitem><para>Eat Breakfast.</para></listitem> + <listitem><para>Take a shower.</para></listitem> + <listitem><para>Contemplate my navel.</para></listitem> + <listitem><para>Go to Sleep.</para></listitem> + </orderedlist> + </section> + + <section> + <title>variablelist</title> + <variablelist> + <varlistentry> + <term>Black Beans</term> + <listitem><para>My favorite black bean recipe is black bean +soup, but they also go well with rice.</para></listitem> + </varlistentry> + <varlistentry> + <term>Apples</term> + <term>Bananas</term> + <listitem><para>You can eat them straight, but they also go +well in salads and in desserts.</para></listitem> + </varlistentry> + </variablelist> + </section> + </chapter> +</book> Property changes on: metis/documents/trunk/src/docbook/editor-quickstart/editor-quickstart.xml ___________________________________________________________________ Added: svn:mime-type + text/plain Copied: metis/documents/trunk/src/docbook/editor-reference/editor-reference.xml (from rev 3265, metis/documents/trunk/src/docbook/userguide/editor-reference.xml) =================================================================== --- metis/documents/trunk/src/docbook/editor-reference/editor-reference.xml (rev 0) +++ metis/documents/trunk/src/docbook/editor-reference/editor-reference.xml 2009-04-13 16:55:00 UTC (rev 3266) @@ -0,0 +1,464 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> +<book lang="ja" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>Jiemamy Eclipse Model Editor +リファレンスマニュアル</title> + <titleabbrev>エディタリファレンス</titleabbrev> + <bookinfo> + <releaseinfo>version 0.2.0</releaseinfo> + <productname>Jiemamy Eclipse Model Editor</productname> + <copyright> + <year>2009</year> + <holder>Jiemamy Project and Others</holder> + </copyright> + <mediaobject> + <imageobject> + <imagedata fileref="images/jiemamy_logo.png"/> + </imageobject> + </mediaobject> + <abstract> + <title>概要</title> + <para>Jiemamy Eclipse Model Editorの各機能を網羅的に解説します。</para> + </abstract> + </bookinfo> + + <toc/> + + <preface> + <title>まえがき</title> + <para>(TODO)</para> + <para>このマニュアルでは、Jiemamy Eclipse Model Editorの各機能を列挙し、それぞれに関して簡単な実例を +挙げながら解説します。 + </para> + <xi:include href="../common/section_license1.xml" /> + <xi:include href="../common/section_license2.xml" /> + </preface> + + <chapter id="intro"> + <title>はじめに</title> + <section> + <title>概要</title> + <para>Jiemamyは、Webアプリケーションの開発に伴うデータベーススナップショット(スキーマと初期データ等)の管理スイートを提供します。 +GUIエディタによるER図の管理を通じてDBの状態・履歴を管理し、データベースのリファクタリングなどをサポートします。 + </para> + </section> + <xi:include href="../common/section_discharge.xml" /> + <xi:include href="../common/section_editor_conditions.xml" /> + <xi:include href="../common/section_install.xml" /> + </chapter> + + <chapter id="basic"> + <title>エディタの基本操作</title> + <xi:include href="../common/section_editor_openclose.xml"/> + <xi:include href="../common/section_editor_save.xml"/> + </chapter> + + <chapter id="editDatabase"> + <title>データベース基本情報編集ダイアログ</title> + <para>ダイアグラムの背景を選択し、右クリックしたメニューから「プロパティ(P)」を選択することにより、データベース情報編集ダイアログを開く事ができます。 +このダイアログでは、データベース・スキーマに関する全体的な設定や、ドメイン・データセット等の設定を行うことができます。 + </para> + <figure> + <title>エディタを右クリックしたメニューからプロパティ(P)を選択</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/rootEdit_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <xi:include href="../common/section_dialog_db_schema.xml"/> + <xi:include href="../common/section_dialog_db_dialect.xml"/> + <section> + <title>ドメイン情報の設定</title> + <para>ドメインとは、既存の型に対してサイズ等のオプション及び制約を付与した、ユーザ定義のデータ型です。ドメインを定義して使用することにより、 +特定のドメインの仕様が変更になった際、そのドメインを使用する全てのカラムの型が同時に変更されます。 + </para> + <para>例えば、ある「名前」を表すカラムに対して使用する目的でNAMEというドメインを"CHAR(32) NOT NULL"で定義していて、いくつかのカラムでこの +NAME型を使用していたとします。この時、SQLの出力に際しては"CHAR(32) NOT NULL"が出力されます。ここで、「名前」に関する仕様変更があり、 +型について"VARCHAR(64)"を使用することになった場合、ドメイン定義を "VARCHAR(64)" に変更します。これにより、以後のSQLの出力に際して +全てのNAMEが "VARCHAR(64)" で出力されるようになります。 + </para> + <section> + <title>ドメインの追加・編集・削除</title> + <procedure> + <step> + <para>データベース基本情報編集ダイアログを開き、「ドメイン(O)」タブを選択します。</para> + </step> + <step> + <para>タブの上部には、現在設定されているドメインの一覧が表示されています。その直下にある「追加(A)」ボタンをクリックします。</para> + <figure> + <title>「追加(A)」ボタンをクリックした直後</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/domain_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>最下段に新しいドメインが追加され、「ドメイン情報」部分にドメイン名やデータ型など、必要な設定を行います。</para> + <tip> + <para>「追加(A)」ではなく「挿入(I)」をクリックすることにより、現在の選択位置に新規作成を行うことができます。また、削除ボタンの右側に +ある「▲」「▼」ボタンで、順番を入れ替えることができます。 + </para> + </tip> + </step> + <step> + <para>ドメインの一覧から行を選択することにより、「ドメイン情報」が切り替わり、設定の編集を行うことができます。</para> + </step> + <step> + <para>また、ここで「削除(R)」ボタンをクリックすると、現在選択されているドメインが削除されます。</para> + <warning> + <para>この時、既にどこかから参照されていたドメインだった場合、それらの型は、ドメインに設定されていた型に展開されます。</para> + </warning> + </step> + <step> + <para>最後に、ダイアログの「OK」ボタンをクリックすることにより、この設定が保存されます。</para> + </step> + </procedure> + </section> + <section> + <title>ドメインの設定</title> + <para>(TODO)</para> + </section> + </section> + <section> + <title>データセット情報の設定</title> + <section> + <title>データセットの追加・編集・削除</title> + <procedure> + <step> + <para>データベース基本情報編集ダイアログを開き、「データセット(T)」タブを選択します。</para> + </step> + <step> + <para>タブの上部には、現在設定されているデータベースの一覧が表示されています。その直下にある「追加(A)」ボタンをクリックします。</para> + <figure> + <title>「追加(A)」ボタンをクリックした直後</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/dataSet_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>最下段に新しいデータセットが追加され、「データセット情報」部分にデータセット名を入力します。</para> + <para>データセット名の右側の「編集」ボタンをクリックすることにより、実際のデータ編集ダイアログが開きます。データ編集ダイアログについては +次項で説明します。 + </para> + <tip> + <para>「追加(A)」ではなく「挿入(I)」をクリックすることにより、現在の選択位置に新規作成を行うことができます。また、削除ボタンの右側に +ある「▲」「▼」ボタンで、順番を入れ替えることができます。 + </para> + </tip> + </step> + <step> + <para>データセットの一覧から行を選択することにより、「データセット情報」が切り替わり、設定の編集を行うことができます。</para> + </step> + <step> + <para>また、ここで「削除(R)」ボタンをクリックすると、現在選択されているデータセットが削除されます。</para> + </step> + <step> + <para>最後に、ダイアログの「OK」ボタンをクリックすることにより、この設定が保存されます。</para> + </step> + </procedure> + </section> + <section> + <title>データセットのデータ編集</title> + <procedure> + <step> + <para>最初、データ編集ダイアログには何も表示されていません。</para> + <figure> + <title>初期状態のデータ編集ダイアログ</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/dataSet_02.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>表示エリアを右クリックしたメニューから「追加(A)」を選択することにより、INSERT対象のテーブルを追加することができます。テーブルを選択し、 +「OK」ボタンをクリックします。 + </para> + <figure> + <title>右クリックにより、コンテキストメニューを表示する</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/dataSet_03.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <figure> + <title>テーブル選択ダイアログ</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/dataSet_04.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>選択したテーブルタブが追加されます。</para> + <figure> + <title>タブが追加されたのデータ編集ダイアログ</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/dataSet_05.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + <step> + <para>右クリックしたメニューから「削除(D)」を選択することにより、現在表示されているタブのテーブルに関するデータを削除することができます。</para> + </step> + <step> + <para>現在のバージョンでは、JiemamyのUIから行の追加・削除を行う事はできません。行の追加・削除をする場合は、一度データを +CSV形式のファイルにエクスポートし、編集した後、インポートし直します。「CSVエクスポート(E)」ボタンをクリックして、エクスポートを行います。 + </para> + <tip> + <para>Windowsでは、ここで出力ファイルの拡張子を適切に選択することにより、その拡張子に関連付けられたアプリケーションで、 +ファイルをスムーズに開くことができます。 + </para> + <figure> + <title>エクスポート完了時に現れるダイアログ(Windowsのみ)</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/dataSet_06.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </tip> + </step> + <step> + <para>テキストエディタやMicrosoft Excel等でCSVファイルを編集し、保存します。</para> + </step> + <step> + <para>「CSVインポート(I)」ボタンをクリックして、インポートを行います。</para> + </step> + <step> + <para>既存のデータはその場で編集することができます。</para> + <figure> + <title>その場で編集</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/dataSet_07.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + </step> + </procedure> + </section> + </section> + <section> + <title>その他情報の設定</title> + <section> + <title>開始スクリプト・終了スクリプト</title> + <para>SQL出力の際、その全体のSQLの前後に、自由文を挿入することがきでます。手書きのSQLできめ細かな設定を追加で行いたい場合に便利です。</para> + </section> + <section> + <title>説明</title> + <para>このファイル全体に関する説明を、コメントとして記述することができます。</para> + </section> + </section> + </chapter> + + <chapter id="editTable"> + <title>テーブル編集ダイアログ</title> + <section> + <title>テーブル情報の設定</title> + <xi:include href="../common/section_table_addremove.xml"/> + <xi:include href="../common/section_table_movesize.xml"/> + <xi:include href="../common/section_table_edit.xml"/> + </section> + <section> + <title>カラム情報の設定</title> + <xi:include href="../common/section_column_addremove.xml"/> + <section> + <title>カラムの設定</title> + <para>上部のリストで選択したカラムは、下部の「カラム情報」で編集を行う事ができます。以下に、各項目の説明は以下の通りです。</para> + <itemizedlist> + <listitem><para>「カラム名(M)」 -- カラムの物理名を設定します。</para></listitem> + <listitem><para>「論理名(L)」 -- カラムの論理名を設定します。</para></listitem> + <listitem><para>「データ型(T)」 -- カラムのデータ型を設定します。設定したデータベースにより、選択肢が変化します。</para></listitem> + <listitem><para>データ型オプション -- データ型によって、右側に「サイズ」等の追加のコントロールが表示される場合があります。</para></listitem> + <listitem><para>「主キー(P)」 -- このカラムを主キーカラムとする場合にチェックします。</para></listitem> + <listitem><para>「NOT NULL(N)」 -- このカラムにNOT NULL制約を付加する場合にチェックします。</para></listitem> + <listitem><para>「無効(G)」 -- このカラムを、エクスポーターが無視するようになります。</para></listitem> + <listitem><para>「制約名(M)」 -- チェック制約式(K)に設定するチェック制約の名前を設定します。</para></listitem> + <listitem><para>「チェック制約式(K)」 -- このカラムに対するチェック制約を記述します。</para></listitem> + <listitem><para>「デフォルト値(F)」 -- このカラムに対するデフォルト値を設定します。</para></listitem> + <listitem><para>「説明(D)」 -- このカラムに対する説明文(コメント)を記述します。</para></listitem> + </itemizedlist> + <para>編集が終わり、変更を適用する場合はOKを、適用しない場合はCancelをクリックし、ダイアログを終了します。</para> + </section> + </section> + <section> + <title>キー制約情報の設定</title> + <section> + <title>キー制約の追加・削除</title> + <para>(TODO)</para> + </section> + <section> + <title>キー制約の設定</title> + <para>(TODO)</para> + </section> + </section> + <section> + <title>チェック制約情報の設定</title> + <section> + <title>チェック制約の追加・削除</title> + <para>(TODO)</para> + </section> + <section> + <title>チェック制約の設定</title> + <para>(TODO)</para> + </section> + </section> + <section> + <title>インデックス情報の設定</title> + <section> + <title>インデックスの追加・削除</title> + <para>(TODO)</para> + </section> + <section> + <title>インデックスの設定</title> + <para>(TODO)</para> + </section> + </section> + <section> + <title>その他情報の設定</title> + <section> + <title>開始スクリプト・終了スクリプト</title> + <para>SQL出力の際、そのテーブル定義SQLの前後に、自由文を挿入することがきでます。手書きのSQLできめ細かな設定を追加で行いたい場合に便利です。</para> + </section> + <section> + <title>説明</title> + <para>このテーブルに関する説明を、コメントとして記述することができます。</para> + </section> + </section> + </chapter> + + <chapter id="editView"> + <title>ビュー編集ダイアログ</title> + <section> + <title>ビュー情報の設定</title> + <xi:include href="../common/section_view_addremove.xml" /> + <section> + <title>ビューの編集</title> + <para>(TODO)</para> + </section> + <section> + <title>ビューの移動</title> + <para>ビューは、テーブルと同様にドラッグ&ドロップにより、表示位置やサイズを調整することができます。</para> + </section> + </section> + <section> + <title>ビュー定義情報の設定</title> + <para>(TODO)</para> + </section> + <section> + <title>その他情報の設定</title> + <section> + <title>開始スクリプト・終了スクリプト</title> + <para>SQL出力の際、そのビュー定義SQLの前後に、自由文を挿入することがきでます。手書きのSQLできめ細かな設定を追加で行いたい場合に便利です。</para> + </section> + <section> + <title>説明</title> + <para>このビューに関する説明を、コメントとして記述することができます。</para> + </section> + </section> + </chapter> + + <chapter id="editForeignKey"> + <title>外部キー編集ダイアログ</title> + <xi:include href="../common/section_fk_addremove.xml" /> + <section> + <title>外部キーの編集</title> + <para>外部キーをダブルクリック、またはコンテキストメニューから「プロパティ(P)」を選択することにより、外部キー編集ダイアログが開きます。</para> + <para>このダイアログでは、外部キーに関する全ての情報を編集することができます。最下段の「マッピング」、参照元カラムと参照先カラムの +対応関係(マッピング)を設定します。 + </para> + <figure> + <title>外部キー編集ダイアログ</title> + <screenshot> + <mediaobject><imageobject><imagedata fileref="images/foreignKeyEdit_01.png"></imagedata></imageobject></mediaobject> + </screenshot> + </figure> + <para>(TODO)</para> + </section> + <xi:include href="../common/section_bendpoint.xml"/> + </chapter> + + <chapter id="editMemo"> + <title>メモ編集ダイアログ</title> + <xi:include href="../common/section_memo_addremove.xml" /> + <section> + <title>メモの編集</title> + <para>(TODO)</para> + </section> + <section> + <title>メモの移動</title> + <para>メモは、テーブルと同様にドラッグ&ドロップにより、表示位置やサイズを調整することができます。</para> + </section> + </chapter> + + <chapter id="layout"> + <title>ダイアグラムのレイアウト</title> + <section> + <title>表示位置の調整</title> + <para>(TODO)</para> + </section> + <section> + <title>サイズの調整</title> + <para>(TODO)</para> + </section> + <section> + <title>自動レイアウト</title> + <para>(TODO)</para> + </section> + <section> + <title>表示モード・表示レベル</title> + <para>(TODO)</para> + </section> + <section> + <title>コネクションルータ</title> + <para>(TODO)</para> + </section> + <section> + <title>拡大・縮小</title> + <para>(TODO)</para> + </section> + <section> + <title>色の変更</title> + <para>(TODO)</para> + </section> + </chapter> + + <chapter id="compose"> + <title>インポート・エクスポート</title> + <para>外部のリソースからJiemamyモデルに情報の取り込みを行うことをインポート、Jiemamyモデルを別の形に変換して出力することをエクスポートと呼びます。 +また、インポートやエクスポートを行う拡張ロジックを、それぞれインポータ・エクスポータと呼びます。 + </para> + <para>Jiemamyは拡張により、様々なインポートやエクスポートができるように設計されています。Jiemamyが標準で提供しているインポータは +DatabaseImporter(実際のDBからスキーマを読み込むインポータ)、エクスポータはSqlExporter(JiemamyモデルをSQLに変換して出力する)です。 +その他、JPA (Java Persistence API)のエンティティクラスからテーブル情報を読み出したり、逆にJiemamyモデルからJPAエンティティクラスを生成したり、 +また、JiemamyモデルよりDB仕様書を出力する等のインポータ・エクスポータの開発が進んでいます。 + </para> + <para>ここでは、DatabaseImporter及びSqlExporterの説明を行います。その他のインポータ・エクスポータについては、それぞれのドキュメントを +参照してください。 + </para> + <xi:include href="../common/section_database_import.xml" /> + <xi:include href="../common/section_sql_export.xml" /> + </chapter> + + <chapter id="graphic"> + <title>ダイアグラムを画像として保存</title> + <para>(TODO)</para> + </chapter> + + <chapter id="xmlFile"> + <title>出力XMLファイル形式</title> + <para>Jiemamyが出力するXMLは、出来る限りの可読性を確保するよう考慮されています。モデルエディタを使用せず、内容を見ながら直接編集 +することも可能です。また、Subversion等の構成管理を行った際のマージも行いやすい構成です。 + </para> + <para>このXMLは、XML Schemaによる制約を定義してありますので、そのサポートを受けられるXMLエディタを使用して編集することをお勧めします。</para> + <para>XMLのルート要素は <jiemamy>であり、その子要素として、大きく分けて以下の5つのセクションがあります。</para> + <itemizedlist> + <listitem><para>DB基本情報セクション - SQL方言(dialect), スキーマ名(schemaName)等、モデル全体のプロパティ要素が定義されている。</para></listitem> + <listitem><para>ドメイン定義セクション - domains要素内にdomain要素が0~複数定義されている。</para></listitem> + <listitem><para>エンティティ定義セクション - entities要素内に、table要素やview要素が0~複数定義されている。</para></listitem> + <listitem><para>データセット定義セクション - dataSets要素内にdataSet要素が0~複数定義されている。</para></listitem> + <listitem><para>拡張定義セクション - 拡張による自由記述のセクション。JiemamyView拡張による、ER図の位置サイズ情報等が定義されている。</para></listitem> + </itemizedlist> + <para>その他、table要素内にはattribute要素があり、その中にカラムや外部キー等の情報が定義されています。作成したデータのXMLを +観察することにより、大まかな定義方法は把握できるはずです。 + </para> + </chapter> + + <xi:include href="../common/chapter_finish.xml" /> + +</book> Property changes on: metis/documents/trunk/src/docbook/editor-reference/editor-reference.xml ___________________________________________________________________ Added: svn:mime-type + text/plain