Fixed docs

orionsprint · Jun 18, 2012 · 22e9722 · 22e9722
1 parent 5154a76
commit 22e9722
Show file tree

Hide file tree

Showing 55 changed files with 3,316 additions and 793 deletions.
diff --git a/docs/jdocbook-jbcp/pom.xml b/docs/jdocbook-jbcp/pom.xml
@@ -1,13 +1,12 @@
-
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
 	<parent>
-		<artifactId>mobicents-ussd-gateway-docs</artifactId>
 		<groupId>org.mobicents.ussd</groupId>
+		<artifactId>docs-parent</artifactId>
 		<version>1.0.0-SNAPSHOT</version>
 	</parent>
 
-	<artifactId>mobicents-ussd-gateway-docs-jdocbook-jbcp</artifactId>
+	<artifactId>docs-jdocbook-jbcp</artifactId>
 
 	<modelVersion>4.0.0</modelVersion>
 
@@ -59,7 +58,7 @@
 							<artifactItems>								
 								<artifactItem>
 									<groupId>${pom.groupId}</groupId>
-									<artifactId>mobicents-ussd-gateway-docs-sources-jbcp</artifactId>
+									<artifactId>docs-sources-jbcp</artifactId>
 									<version>${pom.version}</version>
 									<type>jar</type>
 									<overWrite>true</overWrite>
@@ -73,19 +72,29 @@
 			<plugin>
 				<groupId>org.jboss.maven.plugins</groupId>
 				<artifactId>maven-jdocbook-plugin</artifactId>
-				<version>2.2.0</version>
+				<version>2.3.0</version>
 				<extensions>true</extensions>
 				<dependencies>
 					<dependency>
-						<groupId>org.jboss</groupId>
-						<artifactId>jbossorg-docbook-xslt</artifactId>
-						<version>1.1.0</version>
+						<groupId>org.mobicents.jdocbook</groupId>
+						<artifactId>telestax-xslt-ns</artifactId>
+						<version>1.0.0.FINAL</version>
 					</dependency>
 					<dependency>
-						<groupId>org.jboss</groupId>
-						<artifactId>jbossorg-jdocbook-style</artifactId>
-						<version>1.1.0</version>
+						<groupId>org.mobicents.jdocbook</groupId>
+						<artifactId>telestax-community-style</artifactId>
 						<type>jdocbook-style</type>
+						<version>1.0.0.FINAL</version>
+					</dependency>
+					<dependency>
+						<groupId>xml-resolver</groupId>
+						<artifactId>xml-resolver</artifactId>
+						<version>1.1</version>
+					</dependency>
+					<dependency>
+						<groupId>saxon</groupId>
+						<artifactId>saxon</artifactId>
+						<version>6.5.3</version>
 					</dependency>
 				</dependencies>
 				<configuration>					

diff --git a/docs/jdocbook-mobicents/pom.xml b/docs/jdocbook-mobicents/pom.xml
@@ -1,13 +1,12 @@
-
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
 	<parent>
-		<artifactId>mobicents-ussd-gateway-docs</artifactId>
 		<groupId>org.mobicents.ussd</groupId>
+		<artifactId>docs-parent</artifactId>
 		<version>1.0.0-SNAPSHOT</version>
 	</parent>
 
-	<artifactId>mobicents-ussd-gateway-docs-jdocbook-mobicents</artifactId>
+	<artifactId>docs-jdocbook-mobicents</artifactId>
 
 	<modelVersion>4.0.0</modelVersion>
 
@@ -58,7 +57,7 @@
 							<artifactItems>								
 								<artifactItem>
 									<groupId>${pom.groupId}</groupId>
-									<artifactId>mobicents-ussd-gateway-docs-sources-mobicents</artifactId>
+									<artifactId>docs-sources-mobicents</artifactId>
 									<version>${pom.version}</version>
 									<type>jar</type>
 									<overWrite>true</overWrite>
@@ -72,19 +71,29 @@
 			<plugin>
 				<groupId>org.jboss.maven.plugins</groupId>
 				<artifactId>maven-jdocbook-plugin</artifactId>
-				<version>2.2.0</version>
+				<version>2.3.0</version>
 				<extensions>true</extensions>
 				<dependencies>
 					<dependency>
-						<groupId>org.jboss</groupId>
-						<artifactId>jbossorg-docbook-xslt</artifactId>
-						<version>1.1.0</version>
+						<groupId>org.mobicents.jdocbook</groupId>
+						<artifactId>telestax-xslt-ns</artifactId>
+						<version>1.0.0.FINAL</version>
 					</dependency>
 					<dependency>
-						<groupId>org.jboss</groupId>
-						<artifactId>jbossorg-jdocbook-style</artifactId>
-						<version>1.1.0</version>
+						<groupId>org.mobicents.jdocbook</groupId>
+						<artifactId>telestax-community-style</artifactId>
 						<type>jdocbook-style</type>
+						<version>1.0.0.FINAL</version>
+					</dependency>
+					<dependency>
+						<groupId>xml-resolver</groupId>
+						<artifactId>xml-resolver</artifactId>
+						<version>1.1</version>
+					</dependency>
+					<dependency>
+						<groupId>saxon</groupId>
+						<artifactId>saxon</artifactId>
+						<version>6.5.3</version>
 					</dependency>
 				</dependencies>
 				<configuration>					

diff --git a/docs/pom.xml b/docs/pom.xml
@@ -5,12 +5,11 @@
 
 	<parent>
 		<groupId>org.mobicents.ussd</groupId>
-		<artifactId>ussdgateway</artifactId>
+		<artifactId>parent</artifactId>
 		<version>1.0.0-SNAPSHOT</version>
 	</parent>
 
-	<artifactId>mobicents-ussd-gateway-docs</artifactId>
-	<groupId>org.mobicents.applications.ussd.doc</groupId>
+	<artifactId>docs-parent</artifactId>
 
 	<packaging>pom</packaging>
 

diff --git a/docs/sources-jbcp/pom.xml b/docs/sources-jbcp/pom.xml
@@ -1,15 +1,14 @@
-
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
 	<modelVersion>4.0.0</modelVersion>
 
 	<parent>
-		<artifactId>mobicents-ussd-gateway-docs</artifactId>
 		<groupId>org.mobicents.ussd</groupId>
+		<artifactId>docs-parent</artifactId>
 		<version>1.0.0-SNAPSHOT</version>
 	</parent>
 
-	<artifactId>mobicents-ussd-gateway-docs-sources-jbcp</artifactId>
+	<artifactId>docs-sources-jbcp</artifactId>
 
 	<properties>
 		<THIS.PLATFORM>JBoss Communications</THIS.PLATFORM>
@@ -44,7 +43,7 @@
 							<artifactItems>
 								<artifactItem>
 									<groupId>${pom.groupId}</groupId>
-									<artifactId>mobicents-ussd-gateway-docs-sources</artifactId>
+									<artifactId>docs-sources</artifactId>
 									<version>${pom.version}</version>
 									<type>jar</type>
 									<overWrite>true</overWrite>

diff --git a/docs/sources-mobicents/pom.xml b/docs/sources-mobicents/pom.xml
@@ -1,25 +1,23 @@
-
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
 	<modelVersion>4.0.0</modelVersion>
 
 	<parent>
-		<artifactId>mobicents-ussd-gateway-docs</artifactId>
 		<groupId>org.mobicents.ussd</groupId>
+		<artifactId>docs-parent</artifactId>
 		<version>1.0.0-SNAPSHOT</version>
 	</parent>
 
-	<artifactId>mobicents-ussd-gateway-docs-sources-mobicents</artifactId>	
+	<artifactId>docs-sources-mobicents</artifactId>	
 
 	<properties>
 		<THIS.PLATFORM>Mobicents</THIS.PLATFORM>
 		<JEE.PLATFORM>JBoss Application Server</JEE.PLATFORM>
-		<THIS.ISSUE_TRACKER_URL>http://code.google.com/p/mobicents/issues/list</THIS.ISSUE_TRACKER_URL>
-		<THIS.RELEASE_SOURCE_CODE_URL>http://mobicents.googlecode.com/svn/tags/applications/${docs.application.dirname}</THIS.RELEASE_SOURCE_CODE_URL>
-		<THIS.TRUNK_SOURCE_CODE_URL>https://mobicents.googlecode.com/svn/trunk/applications/${docs.application.dirname}</THIS.TRUNK_SOURCE_CODE_URL>
-		<author.email.amit>abhayani (at) gmail.com</author.email.amit>
+		<THIS.ISSUE_TRACKER_URL>http://code.google.com/p/ussdgateway/issues/list</THIS.ISSUE_TRACKER_URL>
+		<THIS.RELEASE_SOURCE_CODE_URL>http://code.google.com/p/ussdgateway/source/browse/</THIS.RELEASE_SOURCE_CODE_URL>
+		<THIS.TRUNK_SOURCE_CODE_URL>https://code.google.com/p/ussdgateway/</THIS.TRUNK_SOURCE_CODE_URL>
+		<author.email.amit>amit.bhayani (at) gmail.com</author.email.amit>
 		<author.email.bartosz>baranowb (at) gmail.com</author.email.bartosz>
-		<author.email.oleg>oleg.kulikoff (at) gmail.com</author.email.oleg>	
 	</properties>
 
 	<build>
@@ -44,7 +42,7 @@
 							<artifactItems>
 								<artifactItem>
 									<groupId>${pom.groupId}</groupId>
-									<artifactId>mobicents-ussd-gateway-docs-sources</artifactId>
+									<artifactId>docs-sources</artifactId>
 									<version>${pom.version}</version>
 									<type>jar</type>
 									<overWrite>true</overWrite>

diff --git a/docs/sources/pom.xml b/docs/sources/pom.xml
@@ -4,12 +4,12 @@
 	<modelVersion>4.0.0</modelVersion>
 
 	<parent>
-		<artifactId>mobicents-ussd-gateway-docs</artifactId>
 		<groupId>org.mobicents.ussd</groupId>
+		<artifactId>docs-parent</artifactId>
 		<version>1.0.0-SNAPSHOT</version>
 	</parent>
 
-	<artifactId>mobicents-ussd-gateway-docs-sources</artifactId>
+	<artifactId>docs-sources</artifactId>
 
 	<properties>
 

diff --git a/docs/sources/src/main/resources/en-US/Application_User_Guide.ent b/docs/sources/src/main/resources/en-US/Application_User_Guide.ent
@@ -11,11 +11,10 @@ If this final separator is missing, then the documentation will be wrong. -->
 <!ENTITY THIS.PLATFORM "${THIS.PLATFORM}">
 <!ENTITY JEE.PLATFORM "${JEE.PLATFORM}">
 <!ENTITY BOOK_ID "${docs.bookid}_Application_User_Guide">
-<!ENTITY YEAR "2010">
-<!ENTITY HOLDER "Red Hat Inc">
+<!ENTITY YEAR "2012">
+<!ENTITY HOLDER "TeleStax Inc">
 <!ENTITY AUTHOR.EMAIL.AMIT "${author.email.amit}">
 <!ENTITY AUTHOR.EMAIL.BARTOSZ "${author.email.bartosz}">
-<!ENTITY AUTHOR.EMAIL.OLEG "${author.email.oleg}">
 <!ENTITY THIS.JBOSS.DROOLS.DOCUMENTATION "${docs.drools.documentation}">
 <!ENTITY THIS.JBOSS.GUVNOR.DOCUMENTATION "${docs.guvnor.documentation}">
 <!ENTITY THIS.APPLICATION "${docs.application.name}">

diff --git a/docs/sources/src/main/resources/en-US/Application_User_Guide.xml b/docs/sources/src/main/resources/en-US/Application_User_Guide.xml
@@ -20,7 +20,8 @@
 		href="Chapter-Design_Overview.xml" />
 	<xi:include
 		xmlns:xi="http://www.w3.org/2001/XInclude"
-		href="Chapter-Source_Code_Overview.xml" />
+		href="Chapter-HTTP_Architecture.xml" />
+
 		<!-- Uncomment in case its needed. -->	
 		<!--  
 	<xi:include

diff --git a/docs/sources/src/main/resources/en-US/Author_Group.xml b/docs/sources/src/main/resources/en-US/Author_Group.xml
@@ -5,18 +5,11 @@
 	<author>
 		<firstname>Amit</firstname>
 		<surname>Bhayani</surname>
-		<email>&AUTHOR_EMAIL_AMIT;</email>
+		<email>&AUTHOR.EMAIL.AMIT;</email>
 	</author>
 	<author>
 		<firstname>Bartosz</firstname>
 		<surname>Baranowski</surname>
-		<email>&AUTHOR_EMAIL_BARTOSZ;</email>
+		<email>&AUTHOR.EMAIL.BARTOSZ;</email>
 	</author>
-	<!-- 
-	<author>
-		<firstname>Oleg</firstname>
-		<surname>Kulikov</surname>
-		<email>&AUTHOR_EMAIL_OLEG;</email>
-	</author>
-	 -->
 </authorgroup>

diff --git a/docs/sources/src/main/resources/en-US/Book_Info.xml b/docs/sources/src/main/resources/en-US/Book_Info.xml
@@ -1,10 +1,9 @@
 <?xml version='1.0'?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [<!ENTITY % BOOK_ENTITIES SYSTEM "Application_User_Guide.ent">%BOOK_ENTITIES;]>
-<bookinfo
-	id="&BOOK_ID;">
-	<title>&THIS.PLATFORM; JAIN SLEE &THIS.APPLICATION; Application User Guide</title>
-	<subtitle></subtitle>
-	<productname>&THIS.PLATFORM; JAIN SLEE &THIS.APPLICATION; Application</productname>
+<bookinfo id="&BOOK_ID;">
+	<title>&THIS.PLATFORM; &THIS.APPLICATION;</title>
+	<subtitle>User Guide</subtitle>
+	<productname>&THIS.PLATFORM; &THIS.APPLICATION;</productname>
 	<productnumber>&THIS.VERSION;</productnumber>
 	<edition>3.0</edition>
 	<pubsnumber>1</pubsnumber>
@@ -28,7 +27,7 @@
 	-->
 	<copyright>
 		<year>&YEAR;</year>
-		<holder>Red Hat, Inc.</holder>
+		<holder>TeleStax, Inc.</holder>
 	</copyright>
 	<!-- FIXME this include is throwing compile errors
 	<xi:include

diff --git a/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml b/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
@@ -5,29 +5,8 @@
 
 	<title>Design Overview</title>
 
-	<para>&THIS.APPLICATION; Application is  JAIN SLEE 1.1 Application. It is capable of forwarding <acronym>USSD</acronym> messages to desired peer.
-	Application can be divided into logical modules:
-	</para>
-	<variablelist>
-		<varlistentry>
-			<term>rules</term>
-			<listitem>
-				<para>this module is responsible for configuration. Based on user defined rules file, it chooses peer and means of establishing session with it.</para>
-			</listitem>
-		</varlistentry>
-		<varlistentry>
-			<term>jmx</term>
-			<listitem>
-				<para>this module is responsible only for managing and exposing rules engine to <acronym>SLEE</acronym> Service</para>
-			</listitem>
-		</varlistentry>
-		<varlistentry>
-			<term><acronym>SLEE</acronym></term>
-			<listitem>
-				<para>this module is consumer of rules. Based on rules output, it is responsible for relying <acronym>USSD</acronym> messages between originator and consumer peer.</para>
-			</listitem>
-		</varlistentry>
-	</variablelist>
+	<para>&THIS.APPLICATION; is  JAIN SLEE 1.1 Application. It is capable of forwarding <acronym>USSD</acronym> messages to desired peer.</para>
+
 	<para>Following diagram depicts top design overview:</para>
 	<mediaobject>
 		<imageobject>
@@ -40,41 +19,13 @@
 			</para>
 		</caption>
 	</mediaobject>
-	<para><acronym>SLEE</acronym> Service consists of two basic elements: parent and children <acronym>SBB</acronym>s. Parent <acronym>SBB</acronym> is root <acronym>SBB</acronym> in &THIS.APPLICATION; Application service.
-	Children serve logic to proxy <acronym>USSD</acronym> data to desired peer by means of specific protocol.
-	</para>
-	<para>Overview of relation is depicted on diagram below:</para>
-	<mediaobject>
-		<imageobject>
-			<imagedata width="300px" align="center"
-			fileref="images/ussd-application-design-service-relation.png" format="PNG" />
-		</imageobject>
-		<caption>
-			<para>&THIS.APPLICATION;
-				Design Service SBB relation overview
-			</para>
-		</caption>
-	</mediaobject>
+
 	<para>
-	Parent receives initial <acronym>USSD</acronym> message within <acronym>MAP</acronym> message. It consults configured rules to make decision on fate of received message.
-	Subsequent messages are handled by children. Flow for both operations is depicted on diagram below:</para>
-	 <mediaobject>
-		<imageobject>
-			<imagedata width="300px" align="center"
-			fileref="images/ussd-application-design-service-flow.png" format="PNG" />
-		</imageobject>
-		<caption>
-			<para>&THIS.APPLICATION;
-				SBB Flow diagram
-			</para>
-		</caption>
-	</mediaobject>
+		&THIS.APPLICATION; provides Load Balancing and Fault Tolerance of applications. Two 3rd Party Application Servers can be paired to provide Fault-Tolerance on the Gateway and GSM Network level.
+	</para>
 	<important>
 		<para>Currently gateway supports following protocols for proxying:</para>
 		<itemizedlist>
-			<listitem>
-				<para><acronym>SIP</acronym></para>
-			</listitem>
 			<listitem>
 				<para><acronym>HTTP</acronym></para>
 			</listitem>