The following is a summary of the discussion on the module versioning under the thread : Framework and module version information

  1. Having a version information page for each module.
  2. Having the sahana version and the current module version in the footer.
  3. Having the about.inc in the project root which contains the sahana version information.
  4. Having an about.inc for each module in the module directory for module version information.
  5. Making the framework automatically generate the about page for sahana and each module automatically using the about.inc if available.
  6. Including module version functionality in the 0.6 release branch itself
  7. Inlcuding the module version functionality in the next release 0.7

\\Please add more

about.inc

The about.inc contains meta information of the sahana system for each module and the overall system itself. The about.inc in the project root will cover the details of the entire system where as about.inc files in each module will have details on that specific module.

These details would include the following.

  • Module version
  • Date of release / last modification
  • Author / Authors if applicable
  • License if applicable

The following shows the structure and content of the top level about.inc file

<?php
global $about;
/**
 * This is the sahana about page information file. 
 * The about page will be generated using the information provided below.
 */
 
$about['version'] = '0.6.2.2';
$about['release'] = 'RC1';
$about['release_info'] = 'Release Candidate 1';
$about['release_date'] = '1-June-2008';
 
?>


The following code shows the structure and content of a module about.inc file

<?php
global $about;
/**
 * This is the sahana about page information file. 
 * The about page will be generated using the information provided below.
 */
 
$about['version'] = 'xxxx';
$about['authors'] = 'AAAAA, AAAAA, AAAAA';
$about['license'] = 'LGPL';
$about['release_date'] = '1-June-2008';
 
?>

An about page for the module will be automatically generated by the framework and included in the menu using the about.inc of the module if it is available and syntactically correct.


Navigation
  • Navigate