Revision: 15532
Author: baranowb
Date: Mon Nov 29 01:04:34 2010
Log: Update Issue 1616
xxx
http://code.google.com/p/mobicents/source/detail?r=15532

Modified:
/trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Setup.xml

=======================================
--- /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml Tue Jul 6 00:46:08 2010 +++ /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml Mon Nov 29 01:04:34 2010
@@ -10,47 +10,47 @@


        <important>
-               <para>Be
-                       aware, &THIS.PLATFORM; &THIS.APPLICATION;
-                       is subject to changes as it is under active development!
+               <para>
+                       &THIS.PLATFORM; &THIS.APPLICATION;
+                       is subject to changes as it is under active development.
                </para>
        </important>
        <para>&THIS.PLATFORM; &THIS.APPLICATION;
-               <acronym>TCAP</acronym>
-               builds abstraction layer over protocol definition.
-               It introduces simplified
-               <acronym>API</acronym>
+               TCAP
+               builds an abstraction layer over the protocol definition.
+               It introduces a simplified
+               API
                in favor of
-               <acronym>JAIN TCAP</acronym>
+               JAIN TCAP.

                <!-- is this correct use of "in favor" ? -->
        </para>
        <para>
                All interactions are handled by
-               <acronym>TCAP</acronym>
-               Dialog. Dialog agregates local and remote transactions into 
single
+               TCAP
+               Dialog. Dialog aggregates local and remote transactions into a 
single
                reference.
-               It maintains state associated with both ends and supervises 
proper
+ It maintains the state associated with both ends and supervises the proper
                encoding and content of exchanged primitives.
-               Diagram below depicts logical structure of
-               <acronym>TCAP</acronym>
-               and application using it:
+  </para>
+  <para>
+               The diagram below depicts the logical structure of
+               TCAP
+               and the application using it:
        </para>
-       <mediaobject id="ss7_design_tcap_overview_1">
-               <imageobject>
-                       <imagedata width="300px" align="center"
-                               fileref="images/ss7-tcap-design-overview1.png" 
format="PNG" />
-               </imageobject>
-               <caption>
-                       <para>&THIS.PLATFORM; &THIS.APPLICATION;
-                               TCAP Dialog
-                       </para>
-               </caption>
-       </mediaobject>
+  <figure>
+    <title>&THIS.PLATFORM; &THIS.APPLICATION; TCAP Dialog</title>
+    <mediaobject id="ss7_design_tcap_overview_1">
+      <imageobject>
+        <imagedata width="300px" align="center"
+          fileref="images/ss7-tcap-design-overview1.png" format="PNG" />
+      </imageobject>
+    </mediaobject>
+  </figure>
        <note>
                <para>
-                       TC and TR layers are explained in ITU-T Q.77X 
specifications. This
-                       <acronym>API</acronym>
+                       The TC and TR layers are explained in ITU-T Q.77X 
specifications. This
+                       API
                        does not expose those layers directly.
                </para>
        </note>
=======================================
--- /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Tue Jul 6 00:46:08 2010 +++ /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Mon Nov 29 01:04:34 2010
@@ -11,58 +11,101 @@
                to &THIS.PLATFORM;  &THIS.APPLICATION;
        </title>
        <!-- POssibly this should go into abstract ? -->
- <important><para>For better understanding of this chapter please read ITU-T Q.771 to Q.774.</para> </important> - <para><acronym>TCAP</acronym> supports the exchange of non-circuit related data between - applications across the <acronym>SS7</acronym> network using the <acronym>SCCP</acronym> connectionless + <important><para>For a better understanding of this chapter please read ITU-T Q.771 to Q.774.</para> </important>
+               <para>TCAP supports the exchange of non-circuit related data 
between
+                       applications across the SS& network, using the SCCP 
connectionless
                        service. Queries and responses sent between SSPs and 
SCPs are carried
- in TCAP messages. For example, an SSP sends a <acronym>TCAP</acronym> query to determine
+                       in TCAP messages.
+    </para>
+    <para>For example, an SSP sends a TCAP query to determine
                        the routing number associated with a dialed 800/888 
number and to
- check the personal identification number (<acronym>PIN</acronym>) of a calling card - user. In mobile networks (IS-41 and <acronym>GSM</acronym>), <acronym>TCAP</acronym> carries Mobile - Application Part (<acronym>MAP</acronym>) messages sent between mobile switches and
+                       check the personal identification number (PIN) of a 
calling card
+                       user. In mobile networks (IS-41 and GSM), TCAP carries 
Mobile
+                       Application Part (MAP) messages sent between mobile 
switches and
                        databases to support user authentication, equipment 
identification,
                        and roaming.</para>
                        <para>
- <acronym>TCAP</acronym> messages and parameters are refered as <literal>primitives</literal>. Primitives are exchanged
-                               within logical entity called dialog. There are 
two types of dialogs:
-                               <itemizedlist>
-                                       <listitem>
- <para>Unstructured - short lived, it is created only to deliver single message (<literal>Unstructured primitive</literal>), after delivery dialog is invalidated. </para>
-                                       </listitem>
-                                       <listitem>
- <para>Structured - long lived, it is created when exchange starts and lives until it is terminated. </para>
-                                       </listitem>
-                               </itemizedlist>
-                       </para>
+ TCAP messages and parameters are refered as <literal>primitives</literal>. Primitives are exchanged
+                               within logical entities called dialogs. There 
are two types of dialogs:
+      </para>
+                               <variablelist>
+          <varlistentry>
+            <term>Unstructured</term>
+            <listitem>
+ <para>Short lived. It is created only to deliver a single message (<literal>Unstructured primitive</literal>), after the delivery dialog is invalidated. </para>
+            </listitem>
+          </varlistentry>
+                                       <varlistentry>
+            <term>Structured</term>
+            <listitem>
+ <para>Long lived. It is created when the exchange starts and lives until it is terminated. </para>
+            </listitem>
+          </varlistentry>
+                               </variablelist>
                        <para>
-                               <acronym>TCAP</acronym> defines following 
message types:
+                               TCAP defines the following message types:
                        </para>
-                       <itemizedlist>
-                               <listitem>
- <para>Unstructured - creates Unstructured dialog. Unstructured dialog is invalidated once this message is either sent or consumed. It is meant for messages which dont require answer or interaction.</para>
-                               </listitem>
-                               <listitem>
- <para>Begin - message sent to begin Structured dialog, it carries context information for dialog being created</para>
-                               </listitem>
-                               <listitem>
-                                       <para>Continue - continues Structured 
dialog</para>
-                               </listitem>
-                               <listitem>
-                                       <para>End - ends Structured dialog in 
graceful way</para>
-                               </listitem>
-                               <listitem>
-                                       <para>Abort - aborts Structured 
dialog</para>
-                               </listitem>
-                       </itemizedlist>
- <para><acronym>TCAP</acronym> messages convey two types of information:</para>
-                       <itemizedlist>
-                               <listitem>
- <para>components - elements which carry information on requested operation, their status and result.</para>
-                               </listitem>
-                               <listitem>
- <para>dialog related - dialog context(application context name) and application specific information(user information)</para>
-                               </listitem>
-                       </itemizedlist>
+                       <variablelist>
+        <varlistentry>
+          <term>Unstructured</term>
+          <listitem>
+            <para>
+ Creates an Unstructured dialog. An Unstructured dialog is invalidated once this message is either sent or consumed. It is meant for messages that don't require an answer or interaction.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>Begin</term>
+          <listitem>
+            <para>
+ Message sent to begin Structured dialog. It carries context information for the dialog being created.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>Continue</term>
+          <listitem>
+            <para>
+            Continues a Structured dialog.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>End</term>
+          <listitem>
+            <para>
+            Ends a Structured dialog in a graceful way.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>Abort</term>
+          <listitem>
+            <para>
+            Aborts the Structured dialog.
+            </para>
+          </listitem>
+        </varlistentry>
+                       </variablelist>
+                       <para>TCAP messages convey two types of 
information:</para>
+                       <variablelist>
+        <varlistentry>
+          <term>components</term>
+          <listitem>
+            <para>
+ Elements that carry information on the requested operation, their status and result.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>dialog related</term>
+          <listitem>
+            <para>
+ Dialog context (application context name) and application specific information (user information).
+            </para>
+          </listitem>
+        </varlistentry>
+                       </variablelist>


 </chapter>
=======================================
--- /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml Thu Oct 7 08:08:23 2010 +++ /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml Mon Nov 29 01:04:34 2010
@@ -15,10 +15,10 @@
                        <para>
                                <literal>TCAPDialog</literal>
                                is a class representing two
-                               <acronym>TCAP</acronym>
-                               transactions(remote and local transaction form 
logical dialog).
-                               Messages(primitives) are exchanged by means of 
this class. It is
-                               defined by following interface:
+                               TCAP
+                               transactions (remote and local transaction form 
logical dialog).
+                               Messages (primitives) are exchanged by means of 
this class. It is
+                               defined by the following interface:
                        </para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api.tc.dialog;
@@ -186,46 +186,43 @@
                        </programlisting>
                        <important>
                                <para>
-                                       <literal>Application Context</literal>
-                                       and
+                                       <literal>Application Context</literal>,
                                        <literal>User Information</literal>
-                                       and negotiation process is described 
Q.771.
+                                       and negotiation process is described in 
Q.771.
                                        <literal>Application Context</literal>
                                        and
                                        <literal>User Information</literal>
-                                       are user specific and identify 
capabilities of peer establishing
+                                       are user specific and identify the 
capabilities of peer establishing
                                        dialog.
                                </para>
                        </important>
                        <para>
-                               Each dialog has associated state machine which 
it follows.
-                               There are two
-                               types of dialogs, hence two machines are 
defined:
+                               Each dialog has an associated state machine 
that it follows.
+                               As there are two
+                               types of dialogs, two machines are defined:
                        </para>
-                       <mediaobject id="ss7_design_tcap_fsm_1">
-                               <imageobject>
-                                       <imagedata width="300px" align="center"
-                                               fileref="images/ss7-tcap-dialog-fsm1.png" 
format="PNG" />
-                               </imageobject>
-                               <caption>
-                                       <para>TCAP Structured Dialog FSM
-                                       </para>
-                               </caption>
-                       </mediaobject>
-                       <mediaobject id="ss7_design_tcap_fsm_2">
-                               <imageobject>
-                                       <imagedata width="300px" align="center"
-                                               fileref="images/ss7-tcap-dialog-fsm2.png" 
format="PNG" />
-                               </imageobject>
-                               <caption>
-                                       <para>TCAP Unstructured Dialog FSM
-                                       </para>
-                               </caption>
-                       </mediaobject>
+      <figure>
+        <title>TCAP Structured Dialog FSM</title>
+        <mediaobject id="ss7_design_tcap_fsm_1">
+          <imageobject>
+            <imagedata width="300px" align="center"
+              fileref="images/ss7-tcap-dialog-fsm1.png" format="PNG" />
+          </imageobject>
+        </mediaobject>
+      </figure>
+      <figure>
+        <title>TCAP Unstructured Dialog FSM</title>
+        <mediaobject id="ss7_design_tcap_fsm_2">
+          <imageobject>
+            <imagedata width="300px" align="center"
+              fileref="images/ss7-tcap-dialog-fsm2.png" format="PNG" />
+          </imageobject>
+        </mediaobject>
+      </figure>
                        <para>Each
-                               dialog has associated separate invoke id space. 
This space includes
-                               all integer numbers from set of 
&lt;-128,127&gt;. Invoke id is
-                               reference number for operation related 
components, please refer to
+                               dialog has an associated separate invoke ID 
space. This space includes
+ all integer numbers from the set of &lt;-128,127&gt;. The invoke ID is a
+                               reference number for the operation related 
components. Please refer to
                                <xref linkend="operations" />
                                for more details.
                        </para>
@@ -236,29 +233,29 @@
                        <note>
                                <para>
                                        In
-                                       <acronym>TCAP</acronym>
-                                       operation primitives are also refered as
+                                       TCAP,
+                                       operation primitives are also referred 
to as
                                        <literal>Components</literal>
                                        .
                                </para>
                        </note>
-                       <para>Operation pritmitives are sent as part of 
messages. Each
-                               primitive is scheduled in dialog and sent once 
user request message
-                               to be sent.
+                       <para>Operation primitives are sent as a part of 
messages. Each
+                               primitive is scheduled in dialog and sent once 
the user request message
+                               is sent.
                        </para>
-                       <para>There are following primitives defined: </para>
+                       <para>The following primitives are defined: </para>
                        <variablelist>
                                <varlistentry>
                                        <term>Invoke</term>
                                        <listitem>
                                                <para>
-                                                       This element indicates 
that peer request some operation to be
+                                                       This element indicates 
that an operation's peer request is to be
                                                        invoked.
-                                                       <acronym>TCAP</acronym>
-                                                       user populates it with 
specific to user
-                                                       
<literal>OperationCode</literal>
+                                                       The TCAP
+                                                       user populates it with 
user specific
+                                                       OperationCodes
                                                        and
-                                                       
<literal>Parameter</literal>
+                                                       Parameters
                                                        .
                                                </para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
@@ -328,14 +325,14 @@
                                        <term>ReturnResult</term>
                                        <listitem>
                                                <para>
-                                                       This element indicates 
partial result of
+                                                       This element indicates 
a partial result of
                                                        
<literal>Invoke</literal>
                                                        .
-                                                       <acronym>TCAP</acronym>
-                                                       user populates it with 
specific to user
-                                                       
<literal>OperationCode</literal>
+                                                       The TCAP
+                                                       user populates it with 
user specific
+                                                       OperationCodes
                                                        and
-                                                       
<literal>Parameter</literal>
+                                                       Parameters
                                                        .
                                                </para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
@@ -359,16 +356,16 @@
                                        <term>ReturnResultLast</term>
                                        <listitem>
                                                <para>
-                                                       This element indicates 
final result of
+                                                       This element indicates 
the final result of
                                                        
<literal>Invoke</literal>
-                                                       . After this element is 
consumed
+                                                       . After this element is 
consumed, the
                                                        
<literal>InvokeId</literal>
                                                        associated with its 
operation is set free.
-                                                       <acronym>TCAP</acronym>
-                                                       user populates it with 
specific to user
-                                                       
<literal>OperationCode</literal>
+                                                       The TCAP
+                                                       user populates it with 
user specific
+                                                       OperationCodes
                                                        and
-                                                       
<literal>Parameter</literal>
+                                                       Parameters
                                                        .
                                                </para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
@@ -392,11 +389,11 @@
                                        <term>Reject</term>
                                        <listitem>
                                                <para>
-                                                       This element indicates 
that peer rejected
+                                                       This element indicates 
that the peer rejected
                                                        
<literal>Invoke</literal>
-                                                       . It contains
+                                                       . It contains the
                                                        
<literal>Problem</literal>
-                                                       which indiactes cause 
of rejection.
+                                                       which indicates the 
cause of the rejection.
                                                </para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.asn.comp;
@@ -415,9 +412,9 @@
                                </varlistentry>
                        </variablelist>
                        <para>
-                               Listed primitives can be scheduled to send with 
dialog
+                               All listed primitives can be scheduled to send 
with the dialog
                                <literal>sendComponent</literal>
-                               method. As such each extends super interface 
for components:
+                               method. Each extends the super interface for 
components:
                        </para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.asn.comp;
@@ -436,8 +433,8 @@
 }]]>
                        </programlisting>
                        <para>
-                               Additionaly &THIS.APPLICATION;
-                               <acronym>TCAP</acronym>
+                               &THIS.APPLICATION;
+                               TCAP
                                defines elements to convey user specific 
information inside
                                operation primitives:
                        </para>
@@ -445,7 +442,7 @@
                                <varlistentry>
                                        <term>OperationCode</term>
                                        <listitem>
-                                               <para>contains information on 
user specific operation - identifies
+                                               <para>Contains information on 
user specific operation. It identifies
                                                        this operation by code in 
user context.</para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
 import org.mobicents.protocols.asn.Tag;
@@ -468,7 +465,7 @@
                                        <term>Parameter</term>
                                        <listitem>
                                                <para>
-                                                       container for user 
specific (encoded) parameter/s. Its content
+                                                       Container for user 
specific (encoded) parameter/s. Its content
                                                        should be decoded in 
context to user context and
                                                        
<literal>OperationCode</literal>
                                                        value.
@@ -588,7 +585,7 @@
                                        <term>Problem</term>
                                        <listitem>
                                                <para>
-                                                       contains information on 
problem which occurred. It is part of
+                                                       Contains information on 
the problem that occurred. It is part of the
                                                        
<literal>Reject</literal>
                                                        component.
                                                </para>
@@ -622,7 +619,7 @@
                                        </listitem>
                                </varlistentry>
                        </variablelist>
-                       <para> Operation primitives are created by factory 
defined as
+                       <para>Operation primitives are created by the factory 
defined as
                                follows: </para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api;
@@ -660,33 +657,30 @@
                </section>
                <section>
                        <title>Dialog primitives</title>
-                       <para>Dialog primitives are in other words messages 
exchanged.
-                               Primitives are passed to dialog object which 
forms proper message
-                               from following:</para>
+                       <para>Dialog primitives are exchanged messages.
+ Primitives are passed to the dialog object that forms the proper message
+                               from:</para>
                        <itemizedlist>
                                <listitem>
-                                       <para>primitive and information passed in 
it</para>
+                                       <para>The primitive and information passed in 
it.</para>
                                </listitem>
                                <listitem>
-                                       <para>components scheduled in 
dialog</para>
+                                       <para>The components scheduled in the 
dialog.</para>
                                </listitem>
                        </itemizedlist>
-                       <para>Message formed by dialog, can be logicaly 
depicted as follows:
+                       <para>The message formed by dialog can be logicaly 
depicted as follows:
                        </para>
-                       <mediaobject id="ss7_design_tcap_dialog_message1">
-                               <imageobject>
-                                       <imagedata width="300px" align="center"
-                                               
fileref="images/ss7-tcap-design-dialog-message1.png" format="PNG" />
-                               </imageobject>
-                               <caption>
-                                       <para>
-                                               <acronym>TCAP</acronym>
-                                               message structure
-                                       </para>
-                               </caption>
-                       </mediaobject>
-
-                       <para>Each component eligible for passing to dialog is 
a child of
+      <figure>
+        <title>TCAP message structure</title>
+        <mediaobject id="ss7_design_tcap_dialog_message1">
+          <imageobject>
+            <imagedata width="300px" align="center"
+ fileref="images/ss7-tcap-design-dialog-message1.png" format="PNG" />
+          </imageobject>
+        </mediaobject>
+      </figure>
+
+ <para>Each component eligible for passing to the dialog is a child of the
                                following interface: </para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api.tc.dialog.events;
@@ -707,8 +701,8 @@

 }]]>
                        </programlisting>
-                       <para>Each component eligible for passing as indication 
to listener
-                               is a child of following interface: </para>
+ <para>Each component eligible for passing as an indication to the listener
+                               is a child of the following interface: </para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api.tc.dialog.events;

@@ -734,15 +728,15 @@
        public Byte getQos();
 }]]>
                        </programlisting>
-                       <para><acronym>TCAP</acronym>
-                               defines primitives :
+                       <para>TCAP
+                               defines the following primitives:
                        </para>
                        <variablelist>
                                <varlistentry>
                                        <term>TCBegin</term>
                                        <listitem>
                                                <para>
-                                                       Exchanged as initial 
message in structured dialog. Starts
+                                                       Exchanged as the 
initial message in a structured dialog. Starts the
                                                        negotiation of
                                                        <literal>Application Context 
Name</literal>
                                                        and
@@ -827,8 +821,8 @@
                                <varlistentry>
                                        <term>TCContinue</term>
                                        <listitem>
-                                               <para>Exchanged as intermediate 
message until dialog reaches its
-                                                       end. Its interface defined as 
follows:</para>
+ <para>Exchanged as an intermediate message until the dialog reaches its
+                                                       end. Its interface is defined 
as follows:</para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api.tc.dialog.events;

@@ -901,7 +895,7 @@
                                <varlistentry>
                                        <term>TCEnd</term>
                                        <listitem>
-                                               <para>Sent to terminate 
dialog(and two transactions associated
+                                               <para>Sent to terminate the 
dialog (and two transactions associated
                                                        with it). Its interface is 
defined as follows:</para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api.tc.dialog.events;
@@ -972,7 +966,7 @@
                                <varlistentry>
                                        <term>TCUserAbort</term>
                                        <listitem>
-                                               <para>Sent to abort dialog 
beeing created or ongoign one. Its
+                                               <para>Sent to abort the dialog 
being created, or an ongoing one. Its
                                                        interface is defined as 
follows:</para>
                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
 import org.mobicents.protocols.ss7.tcap.asn.ApplicationContextName;
@@ -1039,8 +1033,8 @@
                                <varlistentry>
                                        <term>TCPAbort</term>
                                        <listitem>
-                                               <para>Sent to abort dialog 
beeing created or ongoign one. It is
-                                                       sent by provider, it 
indicates problem on transport or stack
+                                               <para>Sent to abort the dialog 
being created or an ongoing one. It is
+ sent by the provider, and indicates the problem on the transport or stack
                                                        layer. Its interface is 
defined as follows:</para>

                                                <programlisting language="Java" 
role="JAVA"><![CDATA[
@@ -1155,8 +1149,8 @@
                                        </listitem>
                                </varlistentry>
                        </variablelist>
-                       <para>Dialog primitives are created(as components) by 
means of
-                               factory. Factory is defined in following 
way:</para>
+                       <para>Dialog primitives are created (as components) by 
means of a
+                               factory. The factory is defined as 
follows:</para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api;

@@ -1192,26 +1186,24 @@
                <section>
                        <title>Stack</title>
                        <para>
-                               <acronym>TCAP</acronym>
-                               is part of
-                               <acronym>SS7</acronym>
-                               protocol stack. AS such it relies on
-                               <acronym>SCCP</acronym>
-                               as means of transport. To create
-                               <acronym>TCAP</acronym>
-                               stack you require properly configured
-                               <acronym>SCCP</acronym>
-                               layer.
+                               TCAP
+                               is part of the
+                               SS7
+                               protocol stack. It relies on
+                               SCCP
+                               as a means of transport. To create the
+                               TCAP
+                               stack, the SCCP layer must be properly 
configured.
                                Please refer to
                                <xref linkend="tcap_configuration" />
                                for details.
                        </para>
                        <para>&THIS.PLATFORM;
-                               <acronym>TCAP</acronym>
-                               is defined by provider and
+                               TCAP
+                               is defined by the provider and
                                <literal>stack</literal>
                                interfaces.
-                               Interfaces are defined as follows:
+                               The interfaces are defined as follows:
                        </para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api;
@@ -1277,9 +1269,9 @@
        public void removeTCListener(TCListener lst);
 }]]>
                                </programlisting>
-                       <para>Provider allows user to access stack facitlities, 
create
-                               dialogs and register as listener for incoming 
messages. Listener
-                               declares set of callbacks methods.
+                       <para>The provider allows the user to access stack 
facilities, create
+ dialogs and register as the listener for incoming messages. The listener
+                               declares a set of callbacks methods.
                                It is defined as follows: </para>
                        <programlisting language="Java" role="JAVA"><![CDATA[
 package org.mobicents.protocols.ss7.tcap.api;
@@ -1357,16 +1349,14 @@
        <section id="tcap_configuration">
                <title>Configuration</title>
                <para>
-                       <acronym>TCAP</acronym>
-                       layer does not require any config. However it requires 
properly set
-                       <acronym>SCCP</acronym>
- and its sublayers. Please refer to <literal>SCCP User Guide</literal> for supported configuration options.
+                       The TCAP
+ layer does not require any configuration. However, it requires SCCP and its sublayers to be properly set. Please refer to the <literal>SCCP User Guide</literal> for supported configuration options.
                </para>
                <section>
                        <title>Dependencies</title>
                        <para>
-                               <acronym>TCAP</acronym>
-                               depends on following:
+                               TCAP
+                               depends on the following:
                        </para>
                        <itemizedlist>
                                <listitem>
=======================================
--- /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Setup.xml Thu Oct 7 08:08:23 2010 +++ /trunk/protocols/ss7/tcap/docs/sources/src/main/resources/en-US/Chapter-Setup.xml Mon Nov 29 01:04:34 2010
@@ -10,13 +10,13 @@

        <section id="preinstall_requirements_and_prerequisites">
                <title>Pre-Install Requirements and Prerequisites</title>
- <para>Ensure that the following requirements have been met before continuing with the install.</para> + <para>Ensure that the following requirements have been met before continuing with the installation process.</para>
                <section id="hardware_requirements">
                        <title>Hardware Requirements</title>
- <para>The Stack doesn't change the &THIS.PLATFORM; Hardware Requirements, however it requires <acronym>SS7</acronym> card.</para> + <para>The Stack doesn't change the &THIS.PLATFORM; Hardware Requirements. However, it requires an <acronym>SS7</acronym> card.</para>
                        <note>
                                <!-- Is this proper statement ? -->
- <para>Desired is high performance machine to process voice and data channels.</para> + <para>A high performance machine is desired to process voice and data channels.</para>
                        </note>
                </section>
                <section id="software_prerequisites">
@@ -52,15 +52,15 @@
                                <step>
                                    <title>Downloading the source code</title>
                                    <important>
- <para>Subversion is used to manage its source code. Instructions for using Subversion, including install, can be found at <ulink url="http://svnbook.red-bean.com"; /></para> + <para>Subversion is used to manage the source code. Instructions for using Subversion, including installation, can be found at <ulink url="http://svnbook.red-bean.com"; /></para>
                                    </important>
- <para>Use SVN to checkout a specific release source, the base URL is &THIS.RELEASE_SOURCE_CODE_URL;, then add the specific release version, lets consider &THIS.VERSION;.</para> + <para>Use SVN to checkout a specific release source. The base URL is &THIS.RELEASE_SOURCE_CODE_URL;. Then add the specific release version, for example &THIS.VERSION;.</para> <programlisting>[usr]$ svn co &THIS.RELEASE_SOURCE_CODE_URL;/&THIS.VERSION; &THIS.APPLICATION.DIRNAME;-&THIS.VERSION;</programlisting>
                                </step>
                                <step>
                                    <title>Building the source code</title>
                                    <important>
- <para>Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including install, can be found at <ulink url="http://maven.apache.org"; /></para> + <para>Maven 2.0.9 (or higher) is used to build the release. Instructions for using Maven2, including installation, can be found at <ulink url="http://maven.apache.org"; /></para>
                                    </important>
                                    <para>Use Maven to build the 
binaries.</para>
                                    <programlisting>
@@ -74,7 +74,7 @@

                <section id="trunk_source_building">
                        <title>Development Trunk Source Building</title>
- <para>Similar process as for <xref linkend="release_source_building"/>, the only change is the SVN source code URL, which is &THIS.TRUNK_SOURCE_CODE_URL;.</para> + <para>A similar process as <xref linkend="release_source_building"/>. The only change is the SVN source code URL, which is &THIS.TRUNK_SOURCE_CODE_URL;.</para>
                </section>

        </section>

Reply via email to