Editorial changes and added the logo and the favicon

docs/source/application.rst

@@ -645,36 +645,37 @@ The meanings of the elements in the request message:
 
 Glossary
 --------
+.. glossary::
 
-Administration Console:
-The Administration Console allows you to manage the partnerships, check the message histories, check the healthiess, and configure some of the properties.
+  Administration Console
+    The Administration Console allows you to manage the partnerships, check the message histories, check the healthiess, and configure some of the properties.
 
-AS2:
-Applicability Statement 2 is a draft standard from the Internet Engineering Task Force for securely exchanging business documents over the Internet.
+  AS2
+    Applicability Statement 2 is a draft standard from the Internet Engineering Task Force for securely exchanging business documents over the Internet.
 
-ebXML:
-Electronic Business XML. A international standard for electronic B2B messaging and process made by OASIS.
+  ebXML
+    Electronic Business XML. A international standard for electronic B2B messaging and process made by OASIS.
 
-ebMS:
-The messaging standard, in the ebXML standard suite.
+  ebMS
+    The messaging standard, in the ebXML standard suite.
 
-MDN:
-Message Dispensation Notification, the acknowledgement message in the AS2 protocol.
+  MDN
+    Message Dispensation Notification, the acknowledgement message in the AS2 protocol.
 
-Plugin:
-Corvus is a messaging gateway framework. Each plugin is an extension of such framework to handle a communication protocol. Currently, two protocols are supported, namely, ebMS and AS2.
+  Plugin
+    Corvus is a messaging gateway framework. Each plugin is an extension of such framework to handle a communication protocol. Currently, two protocols are supported, namely, ebMS and AS2.
 
-Partnership:
-A simplex communication channel, which abstracts the technical parameters of the channel. Since it is simplex, in a typical two-way commnunication, two partnerships should be created. One is for sending, another one is for receiving.
+  Partnership
+    A simplex communication channel, which abstracts the technical parameters of the channel. Since it is simplex, in a typical two-way commnunication, two partnerships should be created. One is for sending, another one is for receiving.
 
-SOAP:
-SOAP stands for Simple Object Access Protocol, which is a simple XML-based protocol to let applications exchange information over HTTP.
+  SOAP
+    SOAP stands for Simple Object Access Protocol, which is a simple XML-based protocol to let applications exchange information over HTTP.
 
-Web Service:
-Web services are web-based enterprise applications that use open, XML-based standards and transport protocols to exchange data with calling clients.
+  Web Service
+    Web services are web-based enterprise applications that use open, XML-based standards and transport protocols to exchange data with calling clients.
 
-URL:
-Universal Resource Locator.
+  URL
+    Universal Resource Locator.
 
 References
 ----------

docs/source/conf.py

@@ -421,3 +421,6 @@
 # If false, no index is generated.
 #
 # epub_use_index = True
+
+html_logo = '_static/images/corvus-logo-slant.gif'
+html_favicon = '_static/images/cecid_icon.ico'

docs/source/configuration.rst

@@ -80,7 +80,7 @@ Hermes 2 Core System properties
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 You can modify the following information either through the web admin interface or by manipulating the XML configuration files directly.
 
-The configuration files are stored in :file:`{[Webapps Location]}/corvus/WEB-INF/classes/hk/hku/cecid/piazza/corvus/core/conf` (where :file:`{[Webapps Location]}` is the Web application repository of the application server).
+The configuration files are stored in :file:`{<WEBAPPS_LOCATION>}/corvus/WEB-INF/classes/hk/hku/cecid/piazza/corvus/core/conf` (where :file:`{<WEBAPPS_LOCATION>}` is the Web application repository of the application server).
 
 +----------------------------------------------------------------------+----------------------------------------+
 | Tasks                                                                | Responsible configuration file         |
@@ -295,7 +295,7 @@ Hermes2 Plugins properties
 
 AS2 Plugin
 ^^^^^^^^^^
-In the directory :file:`{<Hermes 2 Plugins Location>}/hk.hku.cecid.edi.as2/conf/hk/hku/cecid/edi/as2/conf`, there are some configuration files for Hermes 2's AS2 plug-in. Which configuration file you should edit depends on your configuration task:
+In the directory :file:`{<HERMES_2_PLUGINS_LOCATION>}/hk.hku.cecid.edi.as2/conf/hk/hku/cecid/edi/as2/conf`, there are some configuration files for Hermes 2's AS2 plug-in. Which configuration file you should edit depends on your configuration task:
 
 
 +----------------------------------------------------+----------------------------------------+
@@ -523,7 +523,7 @@ Outgoing Repository:
 +-------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
 
 
-Original Message Repository (It is a temporary message repository used when Hermes 2 is composing or receiving AS2 messages):
+Original Message Repository (which is a temporary message repository used when Hermes 2 is composing or receiving AS2 messages):
 
 
 .. code-block:: xml
@@ -553,7 +553,7 @@ Original Message Repository (It is a temporary message repository used when Herm
 
 ebMS Plugin
 ^^^^^^^^^^^
-In the directory :file:`{<Hermes 2 Plugins Location>}/hk.hku.cecid.ebms/conf/hk/hku/cecid/ebms/spa/conf`, there are some configuration files for Hermes 2's AS2 plug-in. Which configuration file you should edit depends on your configuration task:
+In the directory :file:`{<HERMES_2_PLUGINS_LOCATION>}/hk.hku.cecid.ebms/conf/hk/hku/cecid/ebms/spa/conf`, there are some configuration files for Hermes 2's AS2 plug-in. Which configuration file you should edit depends on your configuration task:
 
 +------------------------------------------------------------------+----------------------------------------+
 | Tasks                                                            | Responsible configuration file         |

docs/source/index.rst

@@ -1,9 +1,8 @@
 .. hermes-docs documentation master file, created by sphinx-quickstart on Thu Nov 24 11:02:00 2016.  You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.  
+
 Hermes Messaging Gateway
 ========================
 
-.. image:: _static/images/corvus-logo-slant.gif
-
 Introduction
 ------------
 Each day, millions of documents and information, such as purchase orders and invoices are exchanged between business partners. When it comes to machine-to-machine document exchange, the existence of boundary between organizations is a hurdle that needs to be overcome.

docs/source/installation.rst

@@ -33,7 +33,7 @@ Prerequisite
 ^^^^^^^^^^^^^^^^^
 1. Java 2 SDK version 5.0 or above 
 #. A security patch, Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files, is also required for the java cryptography extension. 
-#. Tomcat 5.5 or above with port :literal:`8080`, :file:`{TOMCAT_HOME}` is used for referring to the home directory of tomcat in the remaining parts of document.  
+#. Tomcat 5.5 or above with port :literal:`8080`, :file:`{<TOMCAT_HOME>}` is used for referring to the home directory of tomcat in the remaining parts of document.  
 
    **Note:**  To access the admin page, you will need to have a Tomcat user with an admin role.  One way is to define the user in :file:`tomcat-users.xml`.  Please refer to the Realm Configuration section in the Tomcat documentation for more details.
 
@@ -50,9 +50,9 @@ Prerequisite
 
 #. One of the following database installed on any server:
 
-  * PostgreSQL 8.0 or later, :file:`{POSTGRES_HOME}` is referring to the home directory of PostgreSQL in the remaining parts of the document.
-  * MySQL 5.0 or later, :file:`{MYSQL_HOME}` is referring to the home directory of MySQL in the remaining parts of the document.
-  * Oracle 9i or later, :file:`{ORACLE_HOME}` is referring to the home directory of Oracle in the remaining parts of the document.
+  * PostgreSQL 8.0 or later, :file:`{<POSTGRES_HOME>}` is referring to the home directory of PostgreSQL in the remaining parts of the document.
+  * MySQL 5.0 or later, :file:`{<MYSQL_HOME>}` is referring to the home directory of MySQL in the remaining parts of the document.
+  * Oracle 9i or later, :file:`{<ORACLE_HOME>}` is referring to the home directory of Oracle in the remaining parts of the document.
 
 Step 1 – Environment setup
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -69,8 +69,8 @@ Postgres
 #. Create database user with username :literal:`corvus` and password :literal:`corvus`.
 
    i. Open a command prompt
-   #. Go to :file:`{POSTGRES_HOME}/bin`
-   #. Type :samp:`createuser -A -d -P -U {<postgres_admin>}` where :samp:`{<postgres_admin>}` representing the name of administrator / super-user in PostgreSQL database. This value is :literal:`postgres` if not specified. It may require super user or Postgres owner to execute in Linux.
+   #. Go to :file:`{<POSTGRES_HOME>}/bin`
+   #. Type :samp:`createuser -A -d -P -U {<PROTGRES_ADMIN>}` where :samp:`{<PROTGRES_ADMIN>}` representing the name of administrator / super-user in PostgreSQL database. This value is :literal:`postgres` if not specified. It may require super user or Postgres owner to execute in Linux.
    #. Create a user named :literal:`corvus`
    #. Enter the password :literal:`corvus`
    #. Enter the password again for confirmation
@@ -80,7 +80,7 @@ Postgres
 #. Create two databases named :literal:`as2` and :literal:`ebms` with :literal:`corvus` user
 
   i. Open a command prompt
-  #. Go to :file:`POSTGRES_HOME/bin`
+  #. Go to :file:`<POSTGRES_HOME>/bin`
   #. Type :samp:`createdb –U corvus –W as2`
   #. Enter the password :literal:`corvus`
   #. Repeat 2.3 - 2.4 for the :literal:`ebms` database.
@@ -91,8 +91,8 @@ MySQL
 1. Create two database named :literal:`as2` and :literal:`ebms` with username :literal:`corvus` and password :literal:`corvus`.
 
   i. Open a command prompt
-  #. Go to :file:`MYSQL_HOME/bin`
-  #. Type :samp:`mysql –u {<mysql_admin>} -p` where :samp:`{<mysql_admin>}` representing the name of administrator / super-user in mySQL database. This is *root* by default. It may require super user or mySQL owner to execute in Linux.
+  #. Go to :file:`<MYSQL_HOME>/bin`
+  #. Type :samp:`mysql –u {<MYSQL_ADMIN>} -p` where :samp:`{<MYSQL_ADMIN>}` representing the name of administrator / super-user in mySQL database. This is *root* by default. It may require super user or mySQL owner to execute in Linux.
   #. Enter the command below to create the :literal:`as2` database. Notice that specifying collate to :literal:`latin1_general_cs` is essential.
 
      .. code-block:: sql
@@ -161,7 +161,7 @@ Step 3 – Hermes 2 Deployment
      Setting descriptions:
 
      +-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-     | Database URL      | The URL address of the database server located. Port number may attached to the address as the format :samp:`{<host_address>}:{<port>}` where :samp:`{<host_address>}` is the address of the database server and :samp:`{<port>}` is the port number of the database server address |
+     | Database URL      | The URL address of the database server located. Port number may attached to the address as the format :samp:`{<HOST_ADDRESS>}:{<PORT>}` where :samp:`{<HOST_ADDRESS>}` is the address of the database server and :samp:`{<PORT>}` is the port number of the database server address |
      +-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | Database Name/SID | For Postgres and MySQL, please specify the name of the database. For Oracle, please specify the Oracle System ID (SID)                                                                                                                                                              |
      +-------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -194,7 +194,7 @@ Step 3 – Hermes 2 Deployment
      Setting descriptions:
 
      +---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-     | Database URL        | The URL address of the database server located. Port number may attached to the address as the format :samp:`{<host_address>}:{<port>}` where :samp:`{<host_address>}` is the address of the database server and :samp:`{<port>}` is the port number of the database server address |
+     | Database URL        | The URL address of the database server located. Port number may attached to the address as the format :samp:`{<HOST_ADDRESS>}:{<PORT>}` where :samp:`{<HOST_ADDRESS>}` is the address of the database server and :samp:`{<PORT>}` is the port number of the database server address |
      +---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
      | Database Name / SID | For Postgres and MySQL, please specify the name of the database. For Oracle, please specify the Oracle System ID (SID)                                                                                                                                                              |
      +---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+