svnno****@sourc*****
svnno****@sourc*****
2009年 4月 14日 (火) 01:43:09 JST
Revision: 3265
http://svn.sourceforge.jp/view?root=jiemamy&view=rev&rev=3265
Author: daisuke_m
Date: 2009-04-14 01:43:09 +0900 (Tue, 14 Apr 2009)
Log Message:
-----------
ドキュメント追加。
Modified Paths:
--------------
metis/documents/trunk/src/docbook/userguide/api-quickstart.xml
metis/documents/trunk/src/docbook/userguide/dev-process.xml
metis/documents/trunk/src/docbook/userguide/editor-quickstart.xml
metis/documents/trunk/src/docbook/userguide/editor-reference.xml
Added Paths:
-----------
metis/documents/trunk/src/docbook/userguide/chapter_finish.xml
metis/documents/trunk/src/docbook/userguide/section_bendpoint.xml
metis/documents/trunk/src/docbook/userguide/section_memo_addremove.xml
metis/documents/trunk/src/docbook/userguide/section_view_addremove.xml
-------------- next part --------------
Modified: metis/documents/trunk/src/docbook/userguide/api-quickstart.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/api-quickstart.xml 2009-04-13 15:54:17 UTC (rev 3264)
+++ metis/documents/trunk/src/docbook/userguide/api-quickstart.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -151,20 +151,6 @@
<para>作成したモデルは、インポータ・エクスポータを使用して、(TODO)</para>
</chapter>
- <chapter id="finish">
- <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>
+ <xi:include href="chapter_finish.xml" />
+
</book>
Added: metis/documents/trunk/src/docbook/userguide/chapter_finish.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/chapter_finish.xml (rev 0)
+++ metis/documents/trunk/src/docbook/userguide/chapter_finish.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -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/userguide/chapter_finish.xml
___________________________________________________________________
Added: svn:mime-type
+ text/plain
Modified: metis/documents/trunk/src/docbook/userguide/dev-process.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/dev-process.xml 2009-04-13 15:54:17 UTC (rev 3264)
+++ metis/documents/trunk/src/docbook/userguide/dev-process.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -93,12 +93,10 @@
<section>
<title>初期データも管理項目の一つ</title>
<para>以上のように、アプリケーションの過去の状況を呼び出す為には、アプリケーションのソースコードだけではなく、データベースのスキーマも管理する
-必要があることはお分かり頂けたかと思います。さらにもう一歩踏み込むと、「初期データ」つまり、初期状態でテーブルにINSERTされているべきデータも
-同じように構成管理項目となります。
+必要があることはお分かり頂けたかと思います。さらにもう一歩踏み込むと、例えば、初回ログインの為のアカウント情報や、デフォルトの設定情報など、
+テーブルはあったとしても空であっては正常に動作しないアプリケーションも多く存在します。
</para>
- <para>例えば、初回ログインの為のアカウント情報や、デフォルトの設定情報など、テーブルはあったとしても空であっては正常に動作しない
-アプリケーションも多く存在します。
- </para>
+ <para>従って、スキーマと同様、「初期データ」（初期状態でテーブルにINSERTされているべきデータ）も構成管理項目となります。</para>
</section>
</chapter>
@@ -108,7 +106,7 @@
</chapter>
<chapter id="changeDatabase">
- <title>データベースの変更が発生しました</title>
+ <title>データベースの変更が発生した場合</title>
<para>(TODO)</para>
</chapter>
@@ -117,20 +115,6 @@
<para>(TODO)</para>
</chapter>
- <chapter id="finish">
- <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>
+ <xi:include href="chapter_finish.xml" />
+
</book>
Modified: metis/documents/trunk/src/docbook/userguide/editor-quickstart.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/editor-quickstart.xml 2009-04-13 15:54:17 UTC (rev 3264)
+++ metis/documents/trunk/src/docbook/userguide/editor-quickstart.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -178,19 +178,7 @@
</screenshot>
</figure>
</section>
- <section>
- <title>ベンドポイント</title>
- <para>コネクションを選択した時に現れるハンドル（図中の青で示したハンドル）をドラッグすることにより、ベンドポイントを作成することができます。
-また、既に作成したベンドポイントのハンドル（図中の赤で示したハンドル）をドラッグすることにより、ベンドポイントの移動ができます。
-さらに、ベンドポイントのハンドルを、その左右のベンドポイントの延長線上に配置することにより、ベンドポイントの削除ができます。
- </para>
- <figure>
- <title>コネクションのハンドル</title>
- <screenshot>
- <mediaobject><imageobject><imagedata fileref="images/basic_handle_02.png"></imagedata></imageobject></mediaobject>
- </screenshot>
- </figure>
- </section>
+ <xi:include href="section_bendpoint.xml"/>
</chapter>
<chapter id="compose">
@@ -198,12 +186,7 @@
<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>ここでは、DatabaseImporter及びSqlExporterの説明を行います。その他のインポータ・エクスポータについては、それぞれのドキュメントを
参照してください。
</para>
<xi:include href="section_database_import.xml" />
@@ -216,22 +199,7 @@
<para>(TODO)</para>
</chapter>
- <chapter id="finish">
- <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>
+ <xi:include href="chapter_finish.xml" />
<chapter id="docbook-sample">
<title>docbook syntax samples</title>
Modified: metis/documents/trunk/src/docbook/userguide/editor-reference.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/editor-reference.xml 2009-04-13 15:54:17 UTC (rev 3264)
+++ metis/documents/trunk/src/docbook/userguide/editor-reference.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -237,7 +237,7 @@
<title>その他情報の設定</title>
<section>
<title>開始スクリプト・終了スクリプト</title>
- <para>SQL出力の際、そのSQLの前後に、自由文を挿入することがきでます。手書きのSQLできめ細かな設定を追加で行いたい場合に便利です。</para>
+ <para>SQL出力の際、その全体のSQLの前後に、自由文を挿入することがきでます。手書きのSQLできめ細かな設定を追加で行いたい場合に便利です。</para>
</section>
<section>
<title>説明</title>
@@ -279,7 +279,7 @@
<section>
<title>キー制約情報の設定</title>
<section>
- <title>キー制約の追加・編集・削除</title>
+ <title>キー制約の追加・削除</title>
<para>(TODO)</para>
</section>
<section>
@@ -290,7 +290,7 @@
<section>
<title>チェック制約情報の設定</title>
<section>
- <title>チェック制約の追加・編集・削除</title>
+ <title>チェック制約の追加・削除</title>
<para>(TODO)</para>
</section>
<section>
@@ -301,7 +301,7 @@
<section>
<title>インデックス情報の設定</title>
<section>
- <title>インデックスの追加・編集・削除</title>
+ <title>インデックスの追加・削除</title>
<para>(TODO)</para>
</section>
<section>
@@ -313,11 +313,11 @@
<title>その他情報の設定</title>
<section>
<title>開始スクリプト・終了スクリプト</title>
- <para>(TODO)</para>
+ <para>SQL出力の際、そのテーブル定義SQLの前後に、自由文を挿入することがきでます。手書きのSQLできめ細かな設定を追加で行いたい場合に便利です。</para>
</section>
<section>
<title>説明</title>
- <para>(TODO)</para>
+ <para>このテーブルに関する説明を、コメントとして記述することができます。</para>
</section>
</section>
</chapter>
@@ -326,32 +326,29 @@
<title>ビュー編集ダイアログ</title>
<section>
<title>ビュー情報の設定</title>
+ <xi:include href="section_view_addremove.xml" />
<section>
- <title>ビューの追加・編集・削除</title>
+ <title>ビューの編集</title>
<para>(TODO)</para>
</section>
<section>
<title>ビューの移動</title>
<para>ビューは、テーブルと同様にドラッグ＆ドロップにより、表示位置やサイズを調整することができます。</para>
</section>
- <section>
- <title>ビューの設定</title>
- <para>(TODO)</para>
- </section>
</section>
<section>
- <title>定義情報の設定</title>
+ <title>ビュー定義情報の設定</title>
<para>(TODO)</para>
</section>
<section>
<title>その他情報の設定</title>
<section>
<title>開始スクリプト・終了スクリプト</title>
- <para>(TODO)</para>
+ <para>SQL出力の際、そのビュー定義SQLの前後に、自由文を挿入することがきでます。手書きのSQLできめ細かな設定を追加で行いたい場合に便利です。</para>
</section>
<section>
<title>説明</title>
- <para>(TODO)</para>
+ <para>このビューに関する説明を、コメントとして記述することができます。</para>
</section>
</section>
</chapter>
@@ -373,21 +370,19 @@
</figure>
<para>(TODO)</para>
</section>
- <section>
- <title>ベンドポイント</title>
- <para>(TODO)</para>
- </section>
+ <xi:include href="section_bendpoint.xml"/>
</chapter>
<chapter id="editMemo">
<title>メモ編集ダイアログ</title>
+ <xi:include href="section_memo_addremove.xml" />
<section>
- <title>メモの追加・編集・削除</title>
+ <title>メモの編集</title>
<para>(TODO)</para>
</section>
<section>
<title>メモの移動</title>
- <para>メモは、ドラッグ＆ドロップにより、表示位置を調整・移動することができます。</para>
+ <para>メモは、テーブルと同様にドラッグ＆ドロップにより、表示位置やサイズを調整することができます。</para>
</section>
</chapter>
@@ -425,21 +420,45 @@
<chapter id="compose">
<title>インポート・エクスポート</title>
- <para>(TODO)</para>
+ <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="section_database_import.xml" />
+ <xi:include href="section_sql_export.xml" />
</chapter>
- <chapter id="xmlFile">
- <title>出力XMLファイル形式</title>
- <para>(TODO)</para>
- </chapter>
-
<chapter id="graphic">
<title>ダイアグラムを画像として保存</title>
<para>(TODO)</para>
</chapter>
- <chapter id="finish">
- <title>おわりに</title>
- <para>(TODO)</para>
+ <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="chapter_finish.xml" />
+
</book>
Added: metis/documents/trunk/src/docbook/userguide/section_bendpoint.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/section_bendpoint.xml (rev 0)
+++ metis/documents/trunk/src/docbook/userguide/section_bendpoint.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -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/userguide/section_bendpoint.xml
___________________________________________________________________
Added: svn:mime-type
+ text/plain
Added: metis/documents/trunk/src/docbook/userguide/section_memo_addremove.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/section_memo_addremove.xml (rev 0)
+++ metis/documents/trunk/src/docbook/userguide/section_memo_addremove.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -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/userguide/section_memo_addremove.xml
___________________________________________________________________
Added: svn:mime-type
+ text/plain
Added: metis/documents/trunk/src/docbook/userguide/section_view_addremove.xml
===================================================================
--- metis/documents/trunk/src/docbook/userguide/section_view_addremove.xml (rev 0)
+++ metis/documents/trunk/src/docbook/userguide/section_view_addremove.xml 2009-04-13 16:43:09 UTC (rev 3265)
@@ -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/userguide/section_view_addremove.xml
___________________________________________________________________
Added: svn:mime-type
+ text/plain