Difference between revisions of "Script Documentation"

From GGBN Wiki
Jump to: navigation, search
(List of all Configuration scripts)
(Replaced content with "A complete script and code documentation is included in the DNA Module package and has been done with phpDocumentor. Category:DNA_Module")
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
List of all scripts
+
A complete script and code documentation is included in the DNA Module package and has been done with phpDocumentor.
  
=Package "Configuration"=
 
==Connection to database, SMTP==
 
The parameters for connecting the DNA database, logo path and smtp are recorded in xml files (see Package "load") and will be defined first during installation process (see "First steps").
 
 
==List of all Configuration scripts ==
 
{|
 
|-
 
! Script Name !! Description !! Remarks !! included in
 
|-
 
| change.php || Change password || -- || --
 
|-
 
| ChangesAccepted.php || Message for user after editing data successfully  || -- || all scripts with editing functions
 
|-
 
| configuration.php || Start page of package || -- || --
 
|-
 
| connection.php || Edit Database connection ||  same script (edit_connection.php) also used by "First steps"  || --
 
|-
 
| Errorreport.php || Error message for user || -- || all scripts with sql queries
 
|-
 
| generalsettings.php || ? || -- || --
 
|-
 
| head.php || Call function for connecting the database, call array_item || ? || all scripts)
 
|-
 
| index.php || ? || -- || --
 
|-
 
| new_user.php || Adding new user || ? || during "First steps" and in usermanagement.php
 
|-
 
| settings.php || ? || ? || ?
 
|-
 
| start.inc.php || basic functions for all scripts || -- || head.php (and thereby in all scripts
 
|-
 
| usermanagement.php || Editing, deleting and adding users and their rights || -- || --
 
|}
 
 
[[Category:DNA_Module]]
 
[[Category:DNA_Module]]

Latest revision as of 17:53, 9 February 2012

A complete script and code documentation is included in the DNA Module package and has been done with phpDocumentor.