Revision: 15529
Author: baranowb
Date: Mon Nov 29 00:58:02 2010
Log: Update Issue 1616
http://code.google.com/p/mobicents/source/detail?r=15529

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

=======================================
--- /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml Mon Jul 12 05:50:26 2010 +++ /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml Mon Nov 29 00:58:02 2010
@@ -10,21 +10,13 @@


        <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>
        <note>
                <para>
-                       <acronym>SS7</acronym>
-                       design allows
-                       <acronym>ISUP</acronym>
-                       to be used on top of
-                       <acronym>SCCP</acronym>,
-                       however currently &THIS.PLATFORM;
-                       <acronym>ISUP</acronym>
-                       does not support this use case.
+ SS7 design allows ISUP to be used on top of SCCP. However, &THIS.PLATFORM; ISUP does not currently support this use case.
                </para>
        </note>

@@ -35,48 +27,49 @@
                                </para>
        </note>
        <para>
-               <acronym>ISUP</acronym>
-               specification declares only messages and parameters to pass
+               The ISUP
+               specification only declares messages and parameters to pass
                information about trunks and circuits setup.
-                       &THIS.PLATFORM;
-               <acronym>ISUP</acronym>
-               introduces notion of transactions. Transaction groups messages
+               &THIS.PLATFORM;
+               ISUP
+               introduces the notion of transaction. Transaction groups 
messages
                which
-               logically belong to single interaction (like associating 
circuit to
+               logically belong to a single interaction (like associating 
circuit to
                call or releasing circuit).
-               Server transaction is used as reference for
-               incoming request. It
-               provides means of sending answer back to
+  </para>
+  <para>
+               Server transaction is used as a reference for
+               incoming requests. It
+               provides the means for sending answers back to the
                originating peer.
-               Client transaction is used as reference for outgoing
+  </para>
+  <para>
+               Client transaction is used as a reference for outgoing
                requests. It
-               provides means of sending request to remote peer. Also
-               incoming answers will be delivered on client transaction which 
sent
+               provides the means for sending requests to a remote peer.
+    Incoming answers will be delivered on the client transaction that sent
                it.
        </para>
        <para>
-               Depending on type of action and messages involved, life time of
+               Depending on the type of action and messages involved, the life 
time of a
                transaction
-               varies. Diagram below depicts transaction scope:
+               varies. The diagram below depicts transaction scope:
        </para>
-       <mediaobject id="ss7_design_isup_transactions_1">
-               <imageobject>
-                       <imagedata width="300px" align="center"
- fileref="images/ss7-isup-design-transaction-overview1.png" format="PNG" />
-               </imageobject>
-               <caption>
-                       <para>
-                               <acronym>ISUP</acronym>
-                               transactions overview
-                       </para>
-               </caption>
-       </mediaobject>
-       <note>
-               <para>Depending on transaction state machine messages #2 and #3 
may
+  <figure>
+    <title>ISUP transactions overview</title>
+    <mediaobject id="ss7_design_isup_transactions_1">
+      <imageobject>
+        <imagedata width="300px" align="center"
+ fileref="images/ss7-isup-design-transaction-overview1.png" format="PNG" />
+      </imageobject>
+    </mediaobject>
+       </figure>
+  <note>
+               <para>Depending on the transaction state machine, messages #2 
and #3 may
                        not be present.</para>
        </note>
        <para>
-               Following transactions types are defined by &THIS.PLATFORM;
+               The following transaction types are defined by &THIS.PLATFORM;
                <acronym>ISUP</acronym>
                :
                <table frame="all" pgwide="1">
@@ -145,8 +138,8 @@

        </para>
        <para>
- Transactions are either terminated on receiving or sending final response or when - certain time elapses without answer. In both cases stack user is notified that transaction is no longer valid. + Transactions are terminated after sending or receiving the final response or when + a certain amount of time elapses without an answer. In both cases, the stack user is notified that the transaction is no longer valid.
        </para>
 </chapter>

=======================================
--- /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Mon Jul 12 05:50:26 2010 +++ /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Mon Nov 29 00:58:02 2010
@@ -8,39 +8,18 @@
 <chapter id="introduction">

        <title>Introduction
-               to &THIS.PLATFORM;  &THIS.APPLICATION;
+               to &THIS.PLATFORM; &THIS.APPLICATION;
        </title>
        <para>
-               The
-               <acronym>ISDN</acronym>
-               User Part (
-               <acronym>ISUP</acronym>
-               ) is a protocol used to set-up,
-               manage, and release trunk
-               circuits voice
-               carry voice and data between
-               terminating line exchanges
-               (e.g., between a
-               calling party and a
+ The ISDN User Part (ISUP) is a protocol used to set-up, manage, and release trunk circuits and + carry voice data between terminating line exchanges (for example, between a calling party and a
                called party).
-               <acronym>ISUP</acronym>
-               is used for both
-               <acronym>ISDN</acronym>
-               and non-
-               <acronym>ISDN</acronym>
-               calls.
-               However, calls which originate and terminate at the same switch
-               do not
-               use
-               <acronym>ISUP</acronym>
-               signaling.
+  </para>
+  <para>
+ ISUP is used for both ISDN and non-ISDN calls. However, calls that originate and terminate at the same switch do not use ISUP signaling.
        </para>
        <para>
-               <acronym>ISUP</acronym>
-               is defined in
-               <acronym>ITU-T</acronym>
-               <literal>Q.763</literal>
-               specification.
+               ISUP is defined in ITU-T <literal>Q.763</literal> specification.
        </para>
        <para>ISUP supercedes TUP (Telephony User Part) as the standard for
                call control between telephone exchanges.</para>
=======================================
--- /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml Thu Oct 7 09:46:29 2010 +++ /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml Mon Nov 29 00:58:02 2010
@@ -11,15 +11,12 @@

        <section>
                <title>API</title>
-               <para> &THIS.PLATFORM; &THIS.APPLICATION;
-                       <acronym>API</acronym>
-                       is transaction oriented. Transaction are used to 
exchanged messages
-                       which contain parameter with some trunk specific 
information.
+ <para>The &THIS.PLATFORM; &THIS.APPLICATION; API is transaction oriented. Transactions are used to exchanged messages that contain parameters with some trunk specific information.
                </para>
-               <para>Below are listed interface with short explanation.</para>
+               <para>Some interfaces are listed below, with a short 
explanation.</para>
                <section>
-                       <title>Transaction </title>
-                       <para>Common part of transactions is defined as 
follows:</para>
+                       <title>Transaction</title>
+                       <para>The common part of transactions is defined as 
follows:</para>
                        <programlisting language="Java" role="JAVA">
 package org.mobicents.protocols.ss7.isup;

@@ -55,12 +52,12 @@
 }
                        </programlisting>
                        <para>
-                               Above interface declares
+                               The above interface declares the
                                <literal>getTransactionKey</literal>
-                               method. It returns transaction key which is 
unique for certain
+                               method. It returns a transaction key which is 
unique for a certain
                                transaction.
                        </para>
-                       <para>Client transaction is defined as follows: </para>
+                       <para>The client transaction is defined as 
follows:</para>
                        <programlisting language="Java" role="JAVA">
 package org.mobicents.protocols.ss7.isup;

@@ -80,7 +77,7 @@
        public ISUPClientTransactionState getState();
 }
                        </programlisting>
-                       <para>Server transaction is defined accordingly to its 
role:</para>
+                       <para>The server transaction is defined accordingly to its 
role:</para>
                        <programlisting language="Java" role="JAVA">
 package org.mobicents.protocols.ss7.isup;

@@ -109,22 +106,26 @@
                </section>
                <section>
                        <title>Factories</title>
-                       <para>
-                               <acronym>ISUP</acronym>
-                               stack declares separate factories for messages 
and their parameters.
-                               However both interfaces are too big to have any 
use if mentioned in
-                               documentation.
-                               Please refer to source for details.
-                       </para>
-
+      <note>
+        <para>
+          The ISUP
+ stack declares separate factories for messages and their parameters. + However, both interfaces are too big to have any use if mentioned in
+          documentation.
+          Please refer to the source for details.
+        </para>
+      </note>
                </section>
                <section>
                        <title>Stack</title>
                        <para>
-                               <acronym>ISUP</acronym>
+                               The ISUP
                                stack relies on
-                               <acronym>MTP</acronym>
-                               to provide transport. Stack interface is 
defined as follows:
+                               MTP
+                               to provide transport.
+      </para>
+      <para>
+      The stack interface is defined as follows:
                        </para>
                        <programlisting language="Java" role="JAVA">
 package org.mobicents.protocols.ss7.isup;
@@ -139,9 +140,9 @@
 }
                        </programlisting>
                        <para>
-                               Stack declares provider which allows user to 
access stack
+                               Stack declares the provider that allows the 
user to access stack
                                facilities,
-                               send messages statelesly and register listener. 
Provider
+                               send messages statelesly and register a 
listener. The provider
                                is defined
                                as follows:
                        </para>
@@ -191,9 +192,9 @@
 }
                        </programlisting>
                        <para>
-                               Provider allows to register listener. Listener 
contains set of call
+ The provider allows for a listener to be registered. A listener contains a set of call
                                backs useful for
-                               <acronym>ISUP</acronym>
+                               the ISUP
                                user. It is defined as follows:
                        </para>
                        <programlisting language="Java" role="JAVA">
@@ -253,10 +254,10 @@
                <section>
                        <title>Messages</title>
                        <para>Each
-                               messsage defines different setters and getters 
- since each message
-                               type has different set of parameters. However 
all messages defined
+                               messsage defines different setters and getters, 
as each message
+                               type has a different set of parameters. 
However, all messages defined
                                by &THIS.PLATFORM; &THIS.APPLICATION;
-                               have common part:
+                               have a common part:
                        </para>
                        <programlisting language="Java" role="JAVA">
 package org.mobicents.protocols.ss7.isup.message;
@@ -323,8 +324,8 @@
        <section>
                <title>Configuration</title>
                <para>
-                       <acronym>ISUP</acronym>
- stack depends on MTP to provide transport. Please refer to MTP documentation for configuration options supported. Below is list of ISUP specific configuration properties:
+                       The ISUP
+ stack relies on MTP to provide transport. Please refer to the MTP documentation for the configuration options that are supported. Below is a list of ISUP specific configuration properties:
                </para>
                <table frame="all" pgwide="1">
                        <title>ISUP Configuration Properties</title>
@@ -345,8 +346,8 @@
                                        <row>
                                                
<entry>isup.client.timeout</entry>
                                                <entry>
-                                                       Value of timeout in 
milisecond. It controls timeout of client
-                                                       transaction. This value 
must be lower than
+                                                       Value of timeout in 
milliseconds. It controls the timeout of client
+                                                       transactions. This 
value must be lower than
                                                        
<literal>isup.general.timeout</literal>
                                                </entry>
                                                <entry>java.lang.Long</entry>
@@ -355,7 +356,7 @@
                                        <row>
                                                
<entry>isup.general.timeout</entry>
                                                <entry>
- Value of timeout in millisecond. It controls how long transaction object lingers in stack before its released - in case no action is performed. + Value of timeout in milliseconds. It controls how long a transaction object lingers in the stack before it is released if no action is performed.
                                                </entry>
                                                <entry>java.lang.Long</entry>
                                                <entry>120.000</entry>
@@ -364,7 +365,7 @@
                                </tbody>
                        </tgroup>
                        <note>
- <para>Note that ISUP requires M3UA MTP provider. Configuration parameters must include configuration for it. Refer to example.</para> + <para>ISUP requires M3UA MTP provider. Configuration parameters must include configuration for it. Refer to example.</para>
                        </note>
                </table>
        </section>
=======================================
--- /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Setup.xml Thu Oct 7 09:46:29 2010 +++ /trunk/protocols/ss7/isup/docs/sources/src/main/resources/en-US/Chapter-Setup.xml Mon Nov 29 00:58:02 2010
@@ -16,7 +16,7 @@
<para>The Stack doesn't change the &THIS.PLATFORM; Hardware Requirements, however it requires <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">
@@ -37,7 +37,7 @@
        </section>

        <section id="source_code">
-               <title>&THIS.PLATFORM;  &THIS.APPLICATION; Source Code</title>
+               <title>&THIS.PLATFORM; &THIS.APPLICATION; Source Code</title>
                <para></para>

                <section id="release_source_building">

Reply via email to