.. _glossary:

==========
 Glossary
==========

.. glossary::

   data type

     In the context of |project|, "data type" refers to abstract
     specifications denoted using an `Interface Definition Language
     <http://en.wikipedia.org/wiki/Interface_description_language>`_. These
     specifications are used to generate concrete implementations for
     multiple programming languages.

   package

     In the context of |project|, "package" refers to a named
     container, or namespace, the contents of which consists of
     sub-packages and :term:`data types <data type>`.

     Packages are used to organize |project| :term:`data types <data
     type>` into semantic categories such as :ref:`vision
     <package-rst-vision>` or :ref:`audition
     <package-rst-audition>`. For a list of all packages, see
     :ref:`data-types`.

   sandbox

     In |project|, "sandbox" refers to the :file:`proto/sandbox`
     directory and the contained data definitions which are considered
     experimental. Such definitions are generally subject to change,
     removal or deprecation without further notice. In addition,
     promotion to the :term:`stable` area is possible.

     The :term:`data types <data type>` which are currently contained
     in this category are listed in :ref:`data-types-sandbox`.

   stable

     In |project|, "stable" refers to the :file:`proto/stable`
     directory and the contained data definitions which are considered
     ready for production use. These definitions can only depend on
     other stable definition and are subject to slow and careful
     modification and sometimes deprecation.

     The :term:`data types <data type>` which are currently contained
     in this category are listed in :ref:`data-types-stable`.

   deprecated

     In |project|, "deprecated" refers to the :file:`proto/deprecated`
     directory and the contained data definitions which are considered
     flawed in some capacity or unnecessary and should not be used.

     The :term:`data types <data type>` which are currently contained
     in this category are listed in :ref:`data-types-deprecated`.