update document

git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/stigmata/trunk@135 acee48c3-7b26-0410-bdac-b3d0e5314bbc

diff --git a/pom.xml b/pom.xml
index fc1f094..2e1687e 100755 (executable)
--- a/pom.xml
+++ b/pom.xml
@@ -192,6 +192,9 @@ The bug is that resource file is copied to target/classes directory, too.
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>jxr-maven-plugin</artifactId>
+        <configuration>
+          <javadocDir>site/apidocs</javadocDir>
+        </configuration>
       </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>

diff --git a/src/site/apt/tutorial.apt b/src/site/apt/tutorial.apt
new file mode 100755 (executable)
index 0000000..662d15d
--- /dev/null
+++ b/src/site/apt/tutorial.apt
@@ -0,0 +1,97 @@
+ ----
+ Tutorial
+ ----
+ Haruaki Tamada
+ ----
+ 2007-06-11
+ ----
+
+{Tutorial}
+
+ *{{{#Maven2}Maven2}}
+
+ *{{{#Download and Install}Download and Install}}
+
+ *{{{#Install}Install}}
+
+ *{{{#Launch}Launch}}
+
+ *{{{#Extract}Extract}}
+
+ *{{{#Compare}Compare}}
+
+ *{{{#Analysis}Analysis}}
+
+*{{Maven2}}
+
+ First, compilation environment of stigmata is adopted
+{{{http://maven.apache.org/}Maven2}}.  If you want to compile this
+product, you must install Maven2 into your machine.
+
+ For more details, see
+{{{http://maven.apache.org/download.html#installation}Installation
+instruction of Maven2}}
+
+*{{Download and Install}}
+
+ You can download stigmata from
+{{{https://sourceforge.jp/projects/stigmata/files/}sourceforge.jp}}.
+Click the name of stigmata latest version of binary archive.
+
+ Next, extract downloaded archive, and obtain stigmata-x.x.x directory.
+Installation is finished.
+
+*{{Launch stigmata}}
+
+ Double clicked stigmata-x.x.x.jar, then launch stigmata.
+
+[images/launch.png] download page
+
+*{{Extract}}
+
+ First, you choose target jar file(s) for extracting birthmarks.
+Next, you must select birthmark types, and push down <extract> button.
+Then you can see the extraction result of selected birthmarks from
+specified files in the new tab pane.
+
+[images/extraction.png] Birthmark extraction procedure
+
+[images/extractionresult.png] The result of extraction
+
+*{{Compare}}
+
+ First, you choose target files for comparing programs with
+birthmarks.  You must specify target jar file(s) into target selection
+pane.  Next, you must select birthmark types, and push down <compare>
+button.  Then you can see the comparison result of programs by
+selected birthmarks in the new tab pane.
+
+ You can also select comparison method from round robin, guessed
+comparison pair by its name, specified comparison pair, and filtering
+the result of round robin comparison method.
+
+ [[Round robin]] All combination pairs are shown.
+
+ [[Guessed pair]] Guessed pairs by its name.
+
+ [[Specified pair]] Result pairs are specified by user.  You must
+ point name mapping file.
+
+ [[Filtering round robin]] Filtering the result of round robin
+ comparison pairs by certain method.
+
+ []
+
+[images/compare.png] Birthmark comparison procedure
+
+[images/comparisonresult.png] The result of comparison by round robin
+
+[images/comparisonresult2.png] The result of comparison by guessed pair
+
+*{{Analysis}}
+
+ Some analysis methods are implemented.  Typical method is distance
+calculation among classes by their similarities using MDS
+(Multi-Dimensional Scaling).
+
+[images/mdsmapping.png] MDS analysis

diff --git a/src/site/resources/images/compare.png b/src/site/resources/images/compare.png
new file mode 100755 (executable)
index 0000000..aced01d
Binary files /dev/null and b/src/site/resources/images/compare.png differ

diff --git a/src/site/resources/images/comparisonresult.png b/src/site/resources/images/comparisonresult.png
new file mode 100755 (executable)
index 0000000..9a2d4c5
Binary files /dev/null and b/src/site/resources/images/comparisonresult.png differ

diff --git a/src/site/resources/images/comparisonresult2.png b/src/site/resources/images/comparisonresult2.png
new file mode 100755 (executable)
index 0000000..45df4b7
Binary files /dev/null and b/src/site/resources/images/comparisonresult2.png differ

diff --git a/src/site/resources/images/extraction.png b/src/site/resources/images/extraction.png
new file mode 100755 (executable)
index 0000000..303b222
Binary files /dev/null and b/src/site/resources/images/extraction.png differ

diff --git a/src/site/resources/images/extractionresult.png b/src/site/resources/images/extractionresult.png
new file mode 100755 (executable)
index 0000000..9eb6672
Binary files /dev/null and b/src/site/resources/images/extractionresult.png differ

diff --git a/src/site/resources/images/launch.png b/src/site/resources/images/launch.png
new file mode 100755 (executable)
index 0000000..cf16928
Binary files /dev/null and b/src/site/resources/images/launch.png differ

diff --git a/src/site/resources/images/launch_stigmata.png b/src/site/resources/images/launch_stigmata.png
new file mode 100755 (executable)
index 0000000..f06c313
Binary files /dev/null and b/src/site/resources/images/launch_stigmata.png differ

diff --git a/src/site/resources/images/mdsmapping.png b/src/site/resources/images/mdsmapping.png
new file mode 100755 (executable)
index 0000000..aabf56d
Binary files /dev/null and b/src/site/resources/images/mdsmapping.png differ

diff --git a/src/site/site.xml b/src/site/site.xml
index 2fd5c35..9a02775 100755 (executable)
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -35,6 +35,7 @@
 
     <menu name="Stigmata">
       <item name="Introduction"        href="index.html"/>
+      <item name="Tutorial"            href="tutorial.html"/>
       <item name="Download"            href="download.html" />
       <item name="Definition"          href="definition.html" />
       <item name="DTD"                 href="dtd.html" />