Dokeos

This message describes the top code section of any Dokeos page and is helpfull for people who want to add code to the software.

Every php code file should start with this:

<?php
/*
 *	DOKEOS - elearning and course management software
 *
 *	For a full list of contributors, see documentation/credits.html
 *  
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *  See "documentation/licence.html" more details.
 * 
 *	Contact address: Dokeos, 8 Faneuil Hall Marketplace, 3rd Floor, Boston, Massachusetts 02109, United States
 *	Mail: support@dokeos.com
 */

/**
*	@package dokeos.survey
* 	@author John Doe
* 	@version $Id$
*/

The <?php tag indicates that after this we are in PHP code. The first section contains some general information: name, link to the credits file, licence and link to the licence file, Dokeos contact information The second section contains information about the php file:

• @package: the package it belongs to (in this example the survey package)
• @author: the main author of the script (there can be multiple authors). If you feel that you have changed the script significantly you can add your name to this author tag. For the author tag we propose the following syntax:

Firstname Lastname <e-mail>, Institution or company

Both e-mail and Institution are optional example:

John Doe <john.doe@dokeos.com>, Dokeos.com

• @version: The version information. If you create a new script ou only have to put $Id$. This will be replaced by a string that looks more or less like this

$Id: blank.php 10223 2006-11-27 14:45:59Z pcool $