.. _`Preface`:

#######
Preface
#######


.. TO BE REFINED AFTER ALL OTHER EDITING DONE


About the Deployment Guide
**************************

The *Vortex OpenSplice Deployment Guide* is intended to provide a complete
reference on how to configure the OpenSplice service and tune it as required.

The *Deployment Guide* is included with the Vortex OpenSplice Documentation Set.

The *Deployment Guide* is intended to be used after reading and following the
instructions in the *Vortex OpenSplice Getting Started Guide*.

Intended Audience
*****************

The *Deployment Guide* is intended to be used by anyone who wishes to use and
configure Vortex OpenSplice.

Organisation
************

The :ref:`Overview <Overview>` gives a general description of the
Vortex OpenSplice architecture.

This is followed by :ref:`Service Descriptions <Service Descriptions>`, which
explain how Vortex OpenSplice provides integration of real-time DDS and the
non-/near-real-time enterprise DBMS domains.

The :ref:`Tools <Tools>` section introduces the OpenSplice system management tools.

Full details of the configuration elements and attributes of all
Vortex OpenSplice services are given in the :ref:`Configuration <Configuration>`
section.


Conventions
***********

The icons shown below are used in ADLINK product documentation
to help readers to quickly identify information relevant to their
specific use of Vortex OpenSplice.


 ========= ==================================================================
 *Icon*    *Meaning*
 ========= ==================================================================
 |caution| Item of special significance or where caution needs to be taken.
 |info|    Item contains helpful hint or special information.
 |windows| Information applies to Windows (*e.g.* XP, 2003, Windows 7) only.
 |unix|    Information applies to Unix-based systems (*e.g.* Solaris) only.
 |linux|   Information applies to Linux-based systems (*e.g.* Ubuntu) only.
 |c|       C language specific.
 |cpp|     C++ language specific.
 |csharp|  C# language specific.
 |java|    Java language specific.
 ========= ==================================================================




.. |caution| image:: ./images/icon-caution.*
            :height: 6mm
.. |info|   image:: ./images/icon-info.*
            :height: 6mm
.. |windows| image:: ./images/icon-windows.*
            :height: 6mm
.. |unix| image:: ./images/icon-unix.*
            :height: 6mm
.. |linux| image:: ./images/icon-linux.*
            :height: 6mm
.. |c| image:: ./images/icon-c.*
            :height: 6mm
.. |cpp| image:: ./images/icon-cpp.*
            :height: 6mm
.. |csharp| image:: ./images/icon-csharp.*
            :height: 6mm
.. |java| image:: ./images/icon-java.*
            :height: 6mm


