Import Geant4 9.6.0 source tree

examples/extended/.README

@@ -3,81 +3,60 @@ $Id$
 ///\file "extended/.README"
 ///\brief Geant4 Extended Examples README page
 
-/*! \page README_extended Geant4 Extended Examples
+/*! \page README_extended Extended Examples
 
 The set of "extended" examples is covering various 
 use-cases and may require some additional libraries besides of Geant4. 
 
+<i> The HTML documentation for extended examples is still work in progres.
+Webified README pages are not yet available for all examples. </i>
+
 \section ext_s1 Extended level examples:
 
-- analysis
+- \link Examples_analysis analysis \endlink
    - Histogramming through the AIDA interface
-- biasing
-   - Examples of event biasing, scoring and reverse-MC-
-- common
+- \link Examples_biasing biasing \endlink
+   - Examples of event biasing, scoring and reverse-MC- 
+- \link Examples_common common \endlink
    - A set of common classes which can be reused in other examples demonstrating
      just a particular feature  
-- electromagnetic
+- \link Examples_electromagnetic electromagnetic \endlink
    - Specific EM physics simulation with histogramming
-- errorpropagation
+- \link Exampleerrorpropagation errorpropagation \endlink
    - Use of the error propagation utility (Geant4e)
-- eventgenerator
-   - Applications using interface to HepMC
-- exoticphysics
+- \link Examples_eventgenerator eventgenerator \endlink
+   - Applications demonstrating various ways of primary event generation:
+     using Geant4 particle gun, Geant4 general particle source,
+     using interface to HepMC, Pythia
+- \link Examples_exoticphysics exoticphysics \endlink
    - Exotic simulation applications (classical magnetic monopole, etc...)
-- field
+- \link Examples_field field \endlink
    - Specific simulation setups in magnetic field
-- g3tog3
+- \link Examples_g3tog4 g3tog3 \endlink
    - Examples of usage of the g3tog4 converter tool
-- geometry
-   - Specific geometry examples and tools: OLAP tool for detection
-     of overlapping geometries
-- hadronic
+- \link Examples_geometry geometry \endlink
+   - Specific geometry examples and tools, OLAP tool for detection of overlapping geometries, 
+- \link Examples_hadronic hadronic \endlink
    - Specific hadronic physics simulation with histogramming
-- medical
+- \link Examples_medical medical \endlink
    - Specific examples for medical physics applications
-- optical
+- \link Examples_optical optical \endlink
    - Examples of generic optical processes simulation setups
-- parallel
+- \link Examples_parallel parallel \endlink
    - Examples of event-level parallelism in Geant4 using the
      TOP-C distribution, and MPI technique
-- parameterisations
-   - Examples for fast shower parameterisations according to specific models
-- persistency
+- \link Examples_parameterisations parameterisations \endlink
+   - Examples for fast shower parameterisations according to specific models 
+     (gflash)
+- \link Examples_persistency persistency \endlink
    - Persistency of geometry (GDML or ASCII) and simulation output
-- radioactivedecay
+- \link Examples_radioactivedecay radioactivedecay \endlink
    - Examples to simulate the decays of radioactive isotopes and
      induced radioactivity resulted from nuclear interactions
-- runAndEvent
+- \link Examples_runAndEvent runAndEvent \endlink 
    - Examples to demonstrate how to connect the information between
      primary particles and hits and utilize user-information classes
-- visualization
+- \link Examples_visualization visualization \endlink 
    - Specific visualization features and graphical customisations
 
-<hr>
-
-\section ext_s2 Common classes for extended examples:
-
-In order to reduce code duplication and to reduce the number of variants of 
-the code of same kind, we define a set of common classes which
-can be reused in "feature" examples demonstrating just a particular feature.
-This module is going to be enhanced in future. Currently it provides 
-the following sets of classes:
-
-- \ref extended_common_analysis :
-  ExG4HbookAnalysisManager - the analysis manager class for HBOOK
-
-- \ref extended_common_detectorConstruction :
-  two simple detector construction classes with a messenger
-
-- \ref extended_common_physicsList :
-  ExG4PhysicsList00 - physics list with geantino and chargedgeantino only
-
-- \ref extended_common_primaryGenerator :
-  two simple primary generator classes (with G4ParticleGun and
-  G4ParticleGeneralSource)
-
-- \ref extended_common_userActions :
-  event action and run action classes with messengers
-
 */