Revision: 15534
Author: baranowb
Date: Mon Nov 29 01:05:22 2010
Log: Update Issue 1616
asn docs
http://code.google.com/p/mobicents/source/detail?r=15534

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

=======================================
--- /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml Sun Jul 11 06:01:09 2010 +++ /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml Mon Nov 29 01:05:22 2010
@@ -8,23 +8,15 @@

        <title>Design Overview</title>
        <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;
-               has been designed as simple library which enables user to 
encode and
-               decode streams according to ASN rules. It provides user with 
tools to
-               process primitives and build more complex object according to
-               definition in ASN.
+       <para>
+ &THIS.PLATFORM; &THIS.APPLICATION; has been designed as a simple library that enables the user to encode and decode streams according to ASN rules. It provides the user with the tools to process primitives and build more complex objects as defined in ASN.
        </para>
        <note>
-               <para>&THIS.PLATFORM; &THIS.APPLICATION;
-                       does not provide
-                       <literal>ASN compiler</literal>
-                       . It sole purpose is to avoid costly processing and 
allow user to
-                       implement desired functionality in optimal way.
+ <para>&THIS.PLATFORM; &THIS.APPLICATION; does not provide an <literal>ASN compiler</literal>. Its sole purpose is to avoid costly processing and allow the user to implement the desired functionality in the optimal way.
                </para>
        </note>

=======================================
--- /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Sun Jul 11 06:01:09 2010 +++ /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Mon Nov 29 01:05:22 2010
@@ -7,22 +7,12 @@

 <chapter id="introduction">

-       <title>Introduction
-               to &THIS.PLATFORM;  &THIS.APPLICATION;
-       </title>
+       <title>Introduction to &THIS.PLATFORM; &THIS.APPLICATION;</title>
        <para>
-               <literal> Abstract Syntax Notation One (ASN.1)</literal>
-               is standard for describing data structures in telecommunication 
and
-               computer networking world.
-               <literal>ASN.1</literal>
-               provides a set of formal rules for describing the structure of
-               objects.
-               Specification describe abstract objects, that are independent
-               of machine-specific encoding techniques.
+ Abstract Syntax Notation One (ASN.1) is the standard for describing data structures in telecommunication and computer networking world. ASN.1 provides a set of formal rules for describing the structure of objects. The specification describes abstract objects that are independent of machine-specific encoding techniques.
        </para>
        <para>
-               <literal>ASN</literal>
-               defined data can be encoded using on of encoding rules:
+  ASN defined data can be encoded using one of these encoding rules:
        </para>
        <itemizedlist>
                <listitem>
@@ -45,43 +35,49 @@
                </listitem>
        </itemizedlist>
        <para>
-               ASN.1 together with specific ASN.1 encoding rules facilitates 
the
-               exchange of structured data especially between application 
programs
-               over networks by describing data structures in a way that is
-               independent of machine architecture and implementation language.
+ ASN.1, together with specific ASN.1 encoding rules, facilitates the exchange of structured data between application programs over networks by describing data structures in a way that is independent of machine architecture and implementation language.
        </para>
        <para>
-               <literal>ASN</literal>
-               encoded data looks logicaly as follows:
+  ASN encoded data looks logically as follows:
        </para>
-       <mediaobject id="asn_encoding">
-               <imageobject>
-                       <imagedata width="300px" align="center"
-                               fileref="images/asn-general-encoding.png" 
format="PNG" />
-               </imageobject>
-               <caption>
-                       <para>ASN encoding logical overview
-                       </para>
-               </caption>
-       </mediaobject>
-       <para>Encoded data structure contains three elements:
-       </para>
-       <itemizedlist>
-               <listitem>
-                       <para>Tag - unique value, which identifies type of 
data. Tag carries
-                               some additional info - like complexity 
indicator and context
-                               indicator.
- Actual tag value is unique for single ASN definition(aside some basic tag
-                               values which are defined in ASN 
specification)</para>
-               </listitem>
-               <listitem>
-                       <para>Length - indicates length of current data structure 
</para>
-               </listitem>
-               <listitem>
-                       <para>Payload - depending on definition this can be 
simple value -
-                               like integer or it can carry another ASN 
encoded data structure.
-                       </para>
-               </listitem>
-
-       </itemizedlist>
+  <figure>
+    <title>ASN encoding logical overview</title>
+    <mediaobject id="asn_encoding">
+      <imageobject>
+        <imagedata width="300px" align="center"
+          fileref="images/asn-general-encoding.png" format="PNG" />
+      </imageobject>
+    </mediaobject>
+  </figure>
+       <para>Encoded data structure contains three elements:</para>
+  <variablelist>
+    <varlistentry>
+      <term>Tag</term>
+      <listitem>
+        <para>
+        Unique value, which identifies the type of data.
+        </para>
+        <para>
+ Tag carries some additional info (such as the complexity and context indicators). The actual Tag value is unique for a single ASN definition (aside from some basic tag values which are defined in the ASN specification).
+        </para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term>Length</term>
+      <listitem>
+        <para>
+        Indicates the length of the current data structure.
+        </para>
+      </listitem>
+    </varlistentry>
+    <varlistentry>
+      <term>Payload</term>
+      <listitem>
+        <para>
+ Depending on the definition, this can be a simple value (like an integer), or it can carry another ASN encoded data structure.
+        </para>
+      </listitem>
+    </varlistentry>
+  </variablelist>
+
 </chapter>
=======================================
--- /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml Sun Jul 11 06:01:09 2010 +++ /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Protocol.xml Mon Nov 29 01:05:22 2010
@@ -10,9 +10,7 @@

        <section>
                <title>Supported encoding rules</title>
-               <para>&THIS.PLATFORM; &THIS.APPLICATION;
-                       supports following encoding rules:
-               </para>
+ <para>&THIS.PLATFORM; &THIS.APPLICATION; supports following the encoding rules:</para>
                <itemizedlist>
                        <listitem>
                                <para>BER</para>
@@ -20,46 +18,48 @@
                </itemizedlist>
        </section>
        <section>
-               <title>
-                       API
-               </title>
-               <para>&THIS.PLATFORM; &THIS.APPLICATION;
-                       is stream oriented. User accesses
-                       <literal>ASN</literal>
-                       primitives by means of stream objects capable of proper 
decoding and
-                       encoding.
+               <title>API</title>
+               <para>
+ &THIS.PLATFORM; &THIS.APPLICATION; is stream oriented. The user accesses ASN primitives by means of stream objects capable of proper decoding and encoding.
                </para>

-               <para>Following classes deserve explanation:</para>
-               <itemizedlist>
-                       <listitem>
-                               <para>
-                                       
<literal>org.mobicents.protocols.asn.Tag</literal>
-                                       - this class defines static values 
which are part of header(Tag).
-                                       Example value are tag value for 
Integer, BitString, etc.
-                               </para>
-                       </listitem>
-                       <listitem>
-                               <para>
-                                       
<literal>org.mobicents.protocols.asn.BERStatics</literal>
-                                       - this class defines some static values 
which are specific for BER
-                                       encoding - like real encoding 
schemes(NR1,NR2...).
-                               </para>
-                       </listitem>
-                       <listitem>
-                               <para>
-                                       
<literal>org.mobicents.protocols.asn.External</literal>
-                                       - this is special class which is used to 
represent "External" type.
-                                       Its special ASN type to say "anything" 
can be used.
-                               </para>
-                       </listitem>
-                       <listitem>
-                               <para> Input and output stream - simpel classes 
which are core of
-                                       this library. They allow to read/write chunks 
of data.</para>
-                       </listitem>
-
-               </itemizedlist>
-
+               <para>The following classes deserve explanation:</para>
+    <variablelist>
+      <varlistentry>
+        <term><literal>org.mobicents.protocols.asn.Tag</literal></term>
+        <listitem>
+          <para>
+ This class defines static values that are part of header(Tag). Example values are tag values for Integer, BitString, etc.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+ <term><literal>org.mobicents.protocols.asn.BERStatics</literal></term>
+        <listitem>
+          <para>
+          This class defines some static values that are specific for BER
+                                       encoding, such as real encoding 
schemes(NR1,NR2...).
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+ <term><literal>org.mobicents.protocols.asn.External</literal></term>
+        <listitem>
+          <para>
+ This is a special class that is used to represent the "External" type.
+                                       It is a special ASN type where 
"anything" can be used.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Input and Output stream</term>
+        <listitem>
+          <para>
+ Simple classes that are the core of this library. They allow for chunks of data to be read/written.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
        </section>
        <section>
                <title>Examples</title>
@@ -89,7 +89,7 @@
 output.writeReal(-3145.156d, BERStatics.REAL_NR1);
                </programlisting>
                <para>
-                       Complex example how to decode some constructed data 
structure:
+                       Complex example - how to decode some constructed data 
structure:
                </para>
                <programlisting lang="JAVA" role="JAVA">

=======================================
--- /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Setup.xml Sun Jul 11 06:01:09 2010 +++ /trunk/protocols/asn/docs/sources/src/main/resources/en-US/Chapter-Setup.xml Mon Nov 29 01:05:22 2010
@@ -8,7 +8,7 @@

        <title>Setup</title>

-       <section id="preinstall_requirements_and_prerequisites">
+<!--        <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>
                <section id="hardware_requirements">
@@ -20,7 +20,7 @@
                        <title>Software Prerequisites</title>
                        <para>There are no specific software 
requirements.</para>
                </section>
-       </section>
+ </section>--><!--Note: The preinstall requirements section is not needed, as the Library doesn't change any of the standard requirements.-->

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

Reply via email to