<!--
* 
*
*  ProLinga-Doc
*
*  Copyright (C) 2002-2008 Xobas Software.
*  All rights reserved.
*  
*  This file is part of ProLinga-Doc.
*
*  ProLinga-Doc is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  ProLinga-Doc is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with ProLinga-Doc.  If not, see <http://www.gnu.org/licenses/>.
*
*  More information is available at the following addresses:
*
*  Website     : http://www.prolinga.org
*
*  Email       : prolinga-list@prolinga.org
*
*
-->
<refentry id="obj_system">
  <refmeta>
    <refentrytitle>System Object</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>System</refname>
    <refpurpose>System wide environment settings.</refpurpose>
  </refnamediv>

  <refsect1 id="obj_system_introduction">
    <title>Introduction</title>
    <para>
      A single entry document that holds system-wide values.
    </para>
  </refsect1>

  <refsect1 id="obj_system_properties">
    <title>Properties</title>

    <table frame='all' pgwide='1'>
      <title>System Object Properties</title>
      <tgroup cols='4' align='left' colsep='1' rowsep='1'>
        <thead>
          <row>
            <entry>Name</entry>
            <entry>Details</entry>
            <entry>Possible Values</entry>
            <entry>Default Value</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>TrueValue</entry>
            <entry>Value returned as boolean True value.</entry>
            <entry>*</entry>
            <entry>True</entry>
          </row>
          <row>
            <entry>FalseValue</entry>
            <entry>Value returned as boolean False value.</entry>
            <entry>*</entry>
            <entry>False</entry>
          </row>
          <row>
            <entry>Description</entry>
            <entry>Description to be used in lists.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>DetailDescription</entry>
            <entry>Detailed description.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>Modified</entry>
            <entry>Modification date-time stamp in ISO 8601 format.</entry>
            <entry><replaceable>ccyy-mm-dd</replaceable>T<replaceable>hh:mm:ss</replaceable></entry>
            <entry><replaceable>date stamp</replaceable></entry>
          </row>
        </tbody>
      </tgroup>
    </table>

  </refsect1>

  <refsect1 id="obj_system_example">
    <title>Example</title>
<programlisting><![CDATA[
<Object Application="Administrator" Type="System" Name="System">
  <System>
     <TrueValue>True</TrueValue>
     <FalseValue>False</FalseValue>
     <Description>System</Description>
     <DetailDescription>Global System Settings.</DetailDescription>
     <Modified>2007-06-17T14:14:23</Modified>
  </System>
</Object>
]]></programlisting>
  </refsect1>

</refentry>

