Script Documentation: Difference between revisions

From GGBN Wiki
Jump to navigation Jump to search
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"
 
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 || different style for different user groups/rights || --
|-
| connection.php || Frame script for editing database connection ||  included script (edit/edit_connection.php) also used by "First steps"  || --
|-
| Errorreport.php || Error message for user || -- || all scripts with sql queries
|-
| generalsettings.php || Defining general settings || for administrators and members of group "Management" only, recorded in xml-files || --
|-
| head.php || calling main functions || Call function for connecting the database, call array_item || all scripts)
|-
| index.php || redirection to configuration.php || -- || --
|-
| new_user.php || Adding new user || -- || during "First steps" and in usermanagement.php
|-
| settings.php || Defining user settings || for all users, recorded in database || --
|-
| 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 16:53, 9 February 2012

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