source: trunk/documents/UserDoc/DocBookUsersGuides/ForToolkitDeveloper/xml/Introduction/introduction.xml @ 1222

<!-- ******************************************************** -->
<!--                                                          -->
<!--  [History]                                               -->
<!--    Converted to DocBook: Katsuya Amako, Nov-2006         -->
<!--                                                          -->
<!-- ******************************************************** -->


<!-- ******************* Section (Level#1) ****************** -->
<sect1 id="sect.scope">
<title>
Scope of this manual
</title>

<para>
The User's Guide for Toolkit Developers provides detailed information about 
the design of Geant4 classes as well as the information required to extend 
the current functionality of the Geant4 toolkit.  This manual is designed
to:  

<itemizedlist spacing="compact">
  <listitem><para>
    provide a repository of information for those who want to 
    understand or refer to the detailed design of the toolkit, and
  </para></listitem>
  <listitem><para>
    provide details and procedures for extending the functionality
    of the toolkit so that experienced users may contribute code 
    which is consistent with the overall design of Geant4.
  </para></listitem>
</itemizedlist>
</para>

<para>
This manual is intended for developers and experienced users of Geant4.  
It is assumed that the reader is already familiar with functionality of 
the Geant4 toolkit as explained in the ``User's Guide For Application 
Developers", and also has a working knowledge of programming using C++. 
A knowledge of object-oriented analysis and design will also be useful
in understanding this manual.  It is also useful to consult the 
``Software Reference Manual'' which provides a list of Geant4 classes
and their major methods. 
</para>

<para>
Detailed discussions of the physics included in Geant4 are provided in
the ``Physics Reference Manual''.
</para>
</sect1>


<!-- ******************* Section (Level#1) ****************** -->
<sect1 id="sect.howToUseMan">
<title>
How to use this manual
</title>

<para>
<emphasis role="bold">Part I</emphasis>: 
to understand the goal of the software design of Geant4, it 
is useful to begin by reading the User Requirements Document referred to 
in the next section.
</para>

<para>
<emphasis role="bold">Part II</emphasis>: 
``Design and Function of the Geant4 Categories'' provides 
detailed information about the design of each class category and the classes 
in it.  Before considering an extension of one of the toolkit categories, a 
detailed understanding of that category is required.
</para>

<para>
<emphasis role="bold">Part III</emphasis>: 
``Extending Toolkit Functionality'' explains in some detail 
how to extend the functionality of Geant4.  Most of the class categories
are covered and some, which are especially useful to most users, are
covered in greater detail.
</para>

<para>
It is not necessary to understand the entire manual before adding
a new functionality.  To add a new physics process, for example, only the
following items must be read and understood: 

<itemizedlist spacing="compact">
  <listitem><para>
    the design principle described in the ``Physics processes'' 
    chapter of Part II  </para></listitem>
  <listitem><para>
    techniques explained in the ``Physics processes'' chapter 
    of Part III.
  </para></listitem>
</itemizedlist>
</para>

</sect1>

<!-- ******************* Section (Level#1) ****************** -->
<sect1 id="sect.userReqDoc">
<title>
User Requirements Document
</title>

<para>
At the beginning of Geant4 development, a set of user requirements was 
collected in order to inform the object-oriented analysis and design of
the toolkit.  The User Requirements Document follows the PSS-05 software 
engineering standards and is available at
</para>
<para>
<ulink url="http://cern.ch/geant4/OOAandD/URD.pdf">
http://cern.ch/geant4/OOAandD/URD.pdf .
</ulink>
</para>

<para>
This document provides a general description of the main capabilities and 
constraints of the toolkit.  It also defines three types of users 
characterized by their level of interaction with the system.  Specific 
requirements are also listed and classified.
</para>

<!-- ******* Bridgehead ******* -->
<bridgehead role="revisionHistory" renderas='sect4'>
[Status of this chapter]
</bridgehead>

<para>
<simplelist type="var">
  <member>
    24.06.05 - re-organized and re-written by D.H. Wright 
  </member>
</simplelist>
</para>

   
</sect1>