You are viewing a plain text version of this content. The canonical link for it is here.
Posted to hise-commits@incubator.apache.org by rr...@apache.org on 2010/01/27 14:06:19 UTC
svn commit: r903645 - in /incubator/hise/site:
author/src/documentation/content/xdocs/ publish/
Author: rr
Date: Wed Jan 27 14:06:18 2010
New Revision: 903645
URL: http://svn.apache.org/viewvc?rev=903645&view=rev
Log:
HISE-10: Added User Guide and Developer Guide
Added:
incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml (with props)
incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xml
- copied unchanged from r881258, incubator/hise/site/author/src/documentation/content/xdocs/dev-guide.xml
incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml (with props)
incubator/hise/site/publish/developer-guide.xhtml (with props)
incubator/hise/site/publish/user-guide.xhtml (with props)
Removed:
incubator/hise/site/author/src/documentation/content/xdocs/dev-guide.xml
Modified:
incubator/hise/site/author/src/documentation/content/xdocs/site.xml
incubator/hise/site/publish/contributing.html
incubator/hise/site/publish/contributors.html
incubator/hise/site/publish/download.html
incubator/hise/site/publish/index.html
incubator/hise/site/publish/linkmap.html
incubator/hise/site/publish/road-map.html
incubator/hise/site/publish/status.html
Added: incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml?rev=903645&view=auto
==============================================================================
--- incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml (added)
+++ incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml Wed Jan 27 14:06:18 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3365061"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">1.0.21-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3365109">Index</a></span></dt><dt><span class="chapter"><a href="#id3365143">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3365109"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class
="title"><a id="id3365143"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
+ A quick introduction to compiling and running:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ install oracle XE and create hise user with hise password (easiest way is via http://localhost:8980/apex/apex)
+ </p></li><li class="listitem"><p>
+ mvn clean install
+ </p></li><li class="listitem"><p>
+ enter hise-web, run mvn jetty:run, enter http://localhost:8080/ - it will show published WS Services and operations
+ </p></li><li class="listitem"><p>
+ run soapui 3.5-beta1 and run tests from project hise-web/soapui-tests/hise-soapui-project.xml
+ </p></li></ul></div><p>
+
+ Each time you do mvn jetty:run, whole DB is erased.
+ </p><p>
+ I prefer to use default configuration as Oracle instead of in memory
+ DB, because it's better for monitoring and shows more errors.
+ On Debian like systems, you can easily install oracle-xe package.
+ But you can modify data source in /hise-test-example/src/main/resources/hise-ds.xml.
+ There exists a configuration for H2 Database, which is commented out.
+ </p><p>
+ HISE has two types of tests:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ unit tests - those test a single module, for example DAO
+ </p></li><li class="listitem"><p>
+ integration tests - SoapUI test scenarios for a single use case
+ </p></li></ul></div><p>
+ </p></div></div></body></html>
Propchange: incubator/hise/site/author/src/documentation/content/xdocs/developer-guide.xhtml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/hise/site/author/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/incubator/hise/site/author/src/documentation/content/xdocs/site.xml?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/author/src/documentation/content/xdocs/site.xml (original)
+++ incubator/hise/site/author/src/documentation/content/xdocs/site.xml Wed Jan 27 14:06:18 2010
@@ -46,8 +46,8 @@
<index label="Status" href="status.html" description="Status"/>
</main>
<docs label="Documentation">
- <index label="User Guide" href="user-guide.html" description="User Guide"/>
- <index label="Developer Guide" href="dev-guide.html" description="Developer Guide"/>
+ <index label="User Guide" href="user-guide.xhtml" description="User Guide"/>
+ <index label="Developer Guide" href="developer-guide.xhtml" description="Developer Guide"/>
</docs>
<contrib label="Contributing">
<index label="Mailing Lists" href="contributing.html" description="Mailing Lists"/>
Added: incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml?rev=903645&view=auto
==============================================================================
--- incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml (added)
+++ incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml Wed Jan 27 14:06:18 2010
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3612283"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">1.0.21-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3612330">Index</a></span></dt><dt><span class="chapter"><a href="#id3612364">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3612330"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3612364"></a>Chapter 1
. Quick Introduction</h2></div></div></div><p>
+ In order to have something running, you need to do following steps:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>Copy example files from examples/claims-approval into WEB-INF directory</p></li><li class="listitem"><p>Start your application server</p></li><li class="listitem"><p>Enter hise URL into your browser. For Tomcat, this will be http://localhost:8080/hise.
+ There will be a list of services exposed by HISE. It will contain approve operation from example task.
+ </p></li></ul></div><p>
+ </p></div></div></body></html>
Propchange: incubator/hise/site/author/src/documentation/content/xdocs/user-guide.xhtml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/hise/site/publish/contributing.html
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/contributing.html?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/publish/contributing.html (original)
+++ incubator/hise/site/publish/contributing.html Wed Jan 27 14:06:18 2010
@@ -105,10 +105,10 @@
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="user-guide.html" title="User Guide">User Guide</a>
+<a href="user-guide.xhtml" title="User Guide">User Guide</a>
</div>
<div class="menuitem">
-<a href="dev-guide.html" title="Developer Guide">Developer Guide</a>
+<a href="developer-guide.xhtml" title="Developer Guide">Developer Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_selected_1.3', 'skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Contributing</div>
Modified: incubator/hise/site/publish/contributors.html
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/contributors.html?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/publish/contributors.html (original)
+++ incubator/hise/site/publish/contributors.html Wed Jan 27 14:06:18 2010
@@ -105,10 +105,10 @@
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="user-guide.html" title="User Guide">User Guide</a>
+<a href="user-guide.xhtml" title="User Guide">User Guide</a>
</div>
<div class="menuitem">
-<a href="dev-guide.html" title="Developer Guide">Developer Guide</a>
+<a href="developer-guide.xhtml" title="Developer Guide">Developer Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_selected_1.3', 'skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Contributing</div>
Added: incubator/hise/site/publish/developer-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/developer-guide.xhtml?rev=903645&view=auto
==============================================================================
--- incubator/hise/site/publish/developer-guide.xhtml (added)
+++ incubator/hise/site/publish/developer-guide.xhtml Wed Jan 27 14:06:18 2010
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE Developer Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE Developer Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3365061"></a>Apache HISE Developer Guide</h1></div><div><p class="releaseinfo">1.0.21-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3365109">Index</a></span></dt><dt><span class="chapter"><a href="#id3365143">1. Compiling, Running & Testing</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3365109"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Compiling, Running & Testing"><div class="titlepage"><div><div><h2 class
="title"><a id="id3365143"></a>Chapter 1. Compiling, Running & Testing</h2></div></div></div><p>
+ A quick introduction to compiling and running:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ install oracle XE and create hise user with hise password (easiest way is via http://localhost:8980/apex/apex)
+ </p></li><li class="listitem"><p>
+ mvn clean install
+ </p></li><li class="listitem"><p>
+ enter hise-web, run mvn jetty:run, enter http://localhost:8080/ - it will show published WS Services and operations
+ </p></li><li class="listitem"><p>
+ run soapui 3.5-beta1 and run tests from project hise-web/soapui-tests/hise-soapui-project.xml
+ </p></li></ul></div><p>
+
+ Each time you do mvn jetty:run, whole DB is erased.
+ </p><p>
+ I prefer to use default configuration as Oracle instead of in memory
+ DB, because it's better for monitoring and shows more errors.
+ On Debian like systems, you can easily install oracle-xe package.
+ But you can modify data source in /hise-test-example/src/main/resources/hise-ds.xml.
+ There exists a configuration for H2 Database, which is commented out.
+ </p><p>
+ HISE has two types of tests:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ unit tests - those test a single module, for example DAO
+ </p></li><li class="listitem"><p>
+ integration tests - SoapUI test scenarios for a single use case
+ </p></li></ul></div><p>
+ </p></div></div></body></html>
Propchange: incubator/hise/site/publish/developer-guide.xhtml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: incubator/hise/site/publish/download.html
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/download.html?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/publish/download.html (original)
+++ incubator/hise/site/publish/download.html Wed Jan 27 14:06:18 2010
@@ -105,10 +105,10 @@
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="user-guide.html" title="User Guide">User Guide</a>
+<a href="user-guide.xhtml" title="User Guide">User Guide</a>
</div>
<div class="menuitem">
-<a href="dev-guide.html" title="Developer Guide">Developer Guide</a>
+<a href="developer-guide.xhtml" title="Developer Guide">Developer Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title" class="menutitle">Contributing</div>
Modified: incubator/hise/site/publish/index.html
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/index.html?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/publish/index.html (original)
+++ incubator/hise/site/publish/index.html Wed Jan 27 14:06:18 2010
@@ -105,10 +105,10 @@
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="user-guide.html" title="User Guide">User Guide</a>
+<a href="user-guide.xhtml" title="User Guide">User Guide</a>
</div>
<div class="menuitem">
-<a href="dev-guide.html" title="Developer Guide">Developer Guide</a>
+<a href="developer-guide.xhtml" title="Developer Guide">Developer Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title" class="menutitle">Contributing</div>
Modified: incubator/hise/site/publish/linkmap.html
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/linkmap.html?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/publish/linkmap.html (original)
+++ incubator/hise/site/publish/linkmap.html Wed Jan 27 14:06:18 2010
@@ -105,10 +105,10 @@
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="user-guide.html" title="User Guide">User Guide</a>
+<a href="user-guide.xhtml" title="User Guide">User Guide</a>
</div>
<div class="menuitem">
-<a href="dev-guide.html" title="Developer Guide">Developer Guide</a>
+<a href="developer-guide.xhtml" title="Developer Guide">Developer Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title" class="menutitle">Contributing</div>
@@ -212,12 +212,12 @@
<ul>
<li>
-<a href="user-guide.html">User Guide</a> ___________________ <em>index</em> : User Guide</li>
+<a href="user-guide.xhtml">User Guide</a> ___________________ <em>index</em> : User Guide</li>
</ul>
<ul>
<li>
-<a href="dev-guide.html">Developer Guide</a> ___________________ <em>index</em> : Developer Guide</li>
+<a href="developer-guide.xhtml">Developer Guide</a> ___________________ <em>index</em> : Developer Guide</li>
</ul>
</ul>
Modified: incubator/hise/site/publish/road-map.html
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/road-map.html?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/publish/road-map.html (original)
+++ incubator/hise/site/publish/road-map.html Wed Jan 27 14:06:18 2010
@@ -105,10 +105,10 @@
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="user-guide.html" title="User Guide">User Guide</a>
+<a href="user-guide.xhtml" title="User Guide">User Guide</a>
</div>
<div class="menuitem">
-<a href="dev-guide.html" title="Developer Guide">Developer Guide</a>
+<a href="developer-guide.xhtml" title="Developer Guide">Developer Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title" class="menutitle">Contributing</div>
Modified: incubator/hise/site/publish/status.html
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/status.html?rev=903645&r1=903644&r2=903645&view=diff
==============================================================================
--- incubator/hise/site/publish/status.html (original)
+++ incubator/hise/site/publish/status.html Wed Jan 27 14:06:18 2010
@@ -105,10 +105,10 @@
<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Documentation</div>
<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a href="user-guide.html" title="User Guide">User Guide</a>
+<a href="user-guide.xhtml" title="User Guide">User Guide</a>
</div>
<div class="menuitem">
-<a href="dev-guide.html" title="Developer Guide">Developer Guide</a>
+<a href="developer-guide.xhtml" title="Developer Guide">Developer Guide</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.3', 'skin/')" id="menu_1.3Title" class="menutitle">Contributing</div>
Added: incubator/hise/site/publish/user-guide.xhtml
URL: http://svn.apache.org/viewvc/incubator/hise/site/publish/user-guide.xhtml?rev=903645&view=auto
==============================================================================
--- incubator/hise/site/publish/user-guide.xhtml (added)
+++ incubator/hise/site/publish/user-guide.xhtml Wed Jan 27 14:06:18 2010
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Apache HISE User Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="Apache HISE User Guide"><div class="titlepage"><div><div><h1 class="title"><a id="id3612283"></a>Apache HISE User Guide</h1></div><div><p class="releaseinfo">1.0.21-SNAPSHOT</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="index"><a href="#id3612330">Index</a></span></dt><dt><span class="chapter"><a href="#id3612364">1. Quick Introduction</a></span></dt></dl></div><div class="index" title="Index"><div class="titlepage"><div><div><h2 class="title"><a id="id3612330"></a>Index</h2></div></div></div><div class="index"></div></div><div class="chapter" title="Chapter 1. Quick Introduction"><div class="titlepage"><div><div><h2 class="title"><a id="id3612364"></a>Chapter 1
. Quick Introduction</h2></div></div></div><p>
+ In order to have something running, you need to do following steps:
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Download HISE distribution</p></li><li class="listitem"><p>Then you need to unzip HISE WAR contents into your application server directory (like Apache Tomcat). Name it hise.</p></li><li class="listitem"><p>Copy example files from examples/claims-approval into WEB-INF directory</p></li><li class="listitem"><p>Start your application server</p></li><li class="listitem"><p>Enter hise URL into your browser. For Tomcat, this will be http://localhost:8080/hise.
+ There will be a list of services exposed by HISE. It will contain approve operation from example task.
+ </p></li></ul></div><p>
+ </p></div></div></body></html>
Propchange: incubator/hise/site/publish/user-guide.xhtml
------------------------------------------------------------------------------
svn:eol-style = native