Author: damitha
Date: Mon Sep 17 09:08:44 2007
New Revision: 576497
URL: http://svn.apache.org/viewvc?rev=576497&view=rev
Log:
adding html documentation
Added:
webservices/savan/trunk/c/xdocs/docs/index.html
webservices/savan/trunk/c/xdocs/docs/installationguide.html
webservices/savan/trunk/c/xdocs/docs/savanc_manual.html
Added: webservices/savan/trunk/c/xdocs/docs/index.html
URL:
http://svn.apache.org/viewvc/webservices/savan/trunk/c/xdocs/docs/index.html?rev=576497&view=auto
==============================================================================
--- webservices/savan/trunk/c/xdocs/docs/index.html (added)
+++ webservices/savan/trunk/c/xdocs/docs/index.html Mon Sep 17 09:08:44 2007
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+ <title>Documentation</title>
+</head>
+
+<body>
+<h1>Apache Savan/C Documentation</h1>
+
+<h2>Getting Started</h2>
+<ul>
+ <li><a href="installationguide.html">Installation Guide</a></li>
+</ul>
+
+<h2>Manual</h2>
+<ul>
+ <li><a href="savanc_manual.html">Savan/C Manual</a></li>
+</ul>
+
+<h2>Additional References</h2>
+<ul>
+ <li><a href="http://ws.apache.org/axis2/c/index.html";>Apache
+ Axis2/C</a></li>
+ <li><a href="http://ws.apache.org/axis2/c/docs/om_tutorial.html";>AXIOM
+ Tutorial</a></li>
+ <li><a href="http://ws.apache.org/axis2/c/coding_conventions.html";>Coding
+ Conventions in Axis2/C</a></li>
+</ul>
+</body>
+</html>
Added: webservices/savan/trunk/c/xdocs/docs/installationguide.html
URL:
http://svn.apache.org/viewvc/webservices/savan/trunk/c/xdocs/docs/installationguide.html?rev=576497&view=auto
==============================================================================
--- webservices/savan/trunk/c/xdocs/docs/installationguide.html (added)
+++ webservices/savan/trunk/c/xdocs/docs/installationguide.html Mon Sep 17
09:08:44 2007
@@ -0,0 +1,159 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";>
+<html>
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+ <title>Installation Guide</title>
+</head>
+
+<body>
+<h1>Apache Savan/C Installation Guide</h1>
+
+<p>This document guides you on how to install Savan/C with Axis2/C, and
+run the server and client samples on Linux and Microsoft Windows operating
+systems.</p>
+
+<p>This release comes in two forms, source and binary. This document covers
+both forms.</p>
+
+<p>Please send your feedback to the developer mailing list: <a
+href="mailto:[EMAIL PROTECTED]">[EMAIL PROTECTED]</a>
+(Subscription details are available on the <a
+href="http://ws.apache.org/sandesha/savan/c";>Savan site</a>.) Please
+remember to prefix the subject with [Axis2].</p>
+
+<h2>Contents</h2>
+<ul>
+ <li><a href="#linux">Installing and Running on Linux</a>
+ <ul>
+ <li><a href="#linux_source">Using the Source Release</a></li>
+ <li><a href="#linux_binary">Using the Binary Release</a></li>
+ </ul>
+ </li>
+ <li><a href="#win">Installing and Running on Microsoft Windows (win32)</a>
+ <ul>
+ <li><a href="#win_source">Using the Source Release</a></li>
+ <li><a href="#win_binary">Using the Binary Release</a></li>
+ </ul>
+ </li>
+</ul>
+<a id="linux"></a>
+
+<h2>1. Installing and Running on Linux</h2>
+
+<p>This can be done using binary or source distributions. (<a
+href="http://ws.apache.org/savan/c/download.cgi";>Download</a> the two
+distributions)</p>
+
+<a id="linux_source"></a>
+
+<h3>1.1. Installing Savan/C Source Release on Linux</h3>
+
+<p>This version of Savan/C depends on Axis2/C 1.0. <a
href="http://ws.apache.org/axis2/c/download.cgi";>Download Axis2/C</a> from and
+install. /p>
+<ol>
+ <li> Download Savan source distribution</li>
+ <li> Extract the source distribution and go to extracted directory</li>
+ <li> Run configure with AXIS2 include path.
+ <pre>./configure --prefix=<axis2c_deploy_path>
--enable-static=no --with-axis2=<axis2c_deploy_path>
--enable-filtering=no/yes</pre>
+ </li>
+ <li>Run make and make install</li>
+</ol>
+
+This will install the Savan/C as a module in Axis2/C in
<axis2c_deploy_path>/modules folder. The module
+folder contains the Savan/C libraries and the module.xml file.
+
+
+<a id="linux_binary"></a>
+
+<h3>1.2. Installing Savan/C Binary Release on Linux</h3>
+
+<p>Savan/C binary distribution for Linux has the following folder structure.
</p>
+<pre>
+ Savan
+ |
+ + - modules/savan (savan module library and module.xml file)
+ + - docs
+ |
+ + - samples
+ |
+ + - source files of samples in folders
+ + - services (Contain Subscription Manager service and sample data
source services)
+ |
+ + - include ( header files)
+ + - bin
+ + - bin/samples/savan ( sample executables)
+</pre>
+<p>
+ To deploy Savan/C in Axis2/C running environment copy the modules/savan
into <axis2c_deploy_path>/modules folder.
+ Do the necessary changes to the <axis2c_deploy_path>/axis2.xml to
run Savan/C(Refer to the sample <deploy_path>/axis2.xml
+ for help).
+</p>
+<a id="win"></a>
+
+<h2>2. Installing and Running on Microsoft Windows</h2>
+
+<p>This too can be done using binary or source distributions. (<a
+href="http://ws.apache.org/savan/c/download.cgi";>Download</a> the two
+distributions.)</p>
+
+<a id="win_source"></a>
+
+<h3>2.1. Installing Savan/C Source Release on Windows</h3>
+<ol>
+ <li> You need to have unziped Axis2/C 1.0 release binary to some
folder.</li>
+ <li> On your cmd.exe cd to <savan src>\build\win32 <br/>
+ Edit configure.in file with your binary locations. <br/>
+ </li>
+ <li> To set necessary environment variables on command line run
vcvars32.bat file. </li>
+ <li> Run nmake dist command on command line. This will build the Savan/C
binary and samples to a directory savan in <savan src>\build\savan. </li>
+</ol>
+
+<a id="bin_binaries"></a>
+
+<h3>2. 2. Installing Savan/C Binary Release on Windows</h3>
+
+<p>Savan/C binary distribution will have following directory structure. </p>
+<pre>
+ Savan
+ |
+ + - Savan (savan module dll and module.xml file)
+ |
+ + - samples
+ |
+ + - bin
+ |
+ + - source files of samples in folders
+ |
+ + - include ( header files)
+
+ </pre>
+ <ol>
+ <li> Copy Savan directory ( containing savan dll and module.xml ) to
<AXIS2C_HOME>\modules directory.</li>
+ <li> Copy axis2.xml file in Savan directory to <AXIS2C_HOME> </li>
+ </ol>
+ <p>
+ Now you should be able to run the samples.
+ </p>
+
+<h3>Notes</h3>
+<ol>
+<li>
+ Savan/C has a persistent storage mechanism for storing subscriber
information and data source information.
+ This is implemented using Sqlite embeded database<br/>
+ If you use Axis2/C Apache2 module instead of simple_axis2_server make
+ sure that Apache2 user can access the sqlite database file savan_db.
<br/>
+
+</li>
+<li>
+ Savan/C module is installed into
<axis2c_deploy_path>/modules/savanc directory. The installed module
contain
+ libsavan.so, module.xml. The sample clients are installed into
<axis2c_deploy_path>/bin/samples/savan
+ directory. Sample services are installed into
<axis2c_deploy_path>/services directory.
+
+</li>
+</ol>
+
+</body>
+</html>
Added: webservices/savan/trunk/c/xdocs/docs/savanc_manual.html
URL:
http://svn.apache.org/viewvc/webservices/savan/trunk/c/xdocs/docs/savanc_manual.html?rev=576497&view=auto
==============================================================================
--- webservices/savan/trunk/c/xdocs/docs/savanc_manual.html (added)
+++ webservices/savan/trunk/c/xdocs/docs/savanc_manual.html Mon Sep 17 09:08:44
2007
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml";>
+<head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>README</title>
+</head>
+
+<body>
+<h1>Engaging Savan/C Module</h1>
+<p>
+ Install Savan module into <axis2 deploy folder>/modules folder.
+</p>
+<p>
+In the services xml file for the service which require Savan enabled
+add the entry
+ <module ref="Savan"/>
+If you need all services in the engine Savan enabled add the above entry into
+axis2.xml.
+</p>
+<p>
+You can use samples in the samples folder for testing.
+</p>
+
+<h2>Known Issues</h2>
+
+Please keep in mind the following when using Savan/C with Axis2/C.
+<ol>
+<li>
+</ol>
+</body>
+</html>
