[Nms-cgi-devel] Proposed programs' header skeleton

[Olivier D. <dr...@sh...>]

I'd like to make a proposition for the header of each scripts.

<<<<<<
#!/usr/bin/perl -wT

########################################################
# Program information ##################################
########################################################
# ProgramName.pl v1.2.3.4.5.6...
#
# This program is licensed in the same way as Perl
# itself. You are free to choose between the GNU Public
# License <http://www.gnu.org/licenses/gpl.html>  or
# the Artistic License
# <http://www.perl.com/pub/a/language/misc/Artistic.html>
#
# For a list of changes see CHANGELOG
# 
# For help on configuration or installation see README
########################################################
# DO NOT CHANGE! #######################################
########################################################
#
use strict;
use ...;
.
.
.
#
########################################################
# Configuration ########################################
########################################################
# Modify these to your own settings. You might have to
# contact your system administrator if you do not run
# your own web server. If the purpose of these
# parameters seems unclear, please see the README file.
#
my $param   = "stuff";    # Will be used for stuff
my $baseurl = "/var/www"; # Server's web documents directory
my ...;
.
.
.
#
########################################################
# Main program #########################################
########################################################
# From now on, you should not have to change anything in
# order for the program to work. If the program does not
# work, review your configuration above or contact your
# system administrator.
#

*code*
>>>>>>

Let me know what you think. The only thing I feel uncomfortable with is
the license declaration which I took from the FAQ. The rest, I think
would look much better than we have right now. I intend to implement
those changes myself if everyone agrees with them.

-Oli


-- 
+----------------------------------------------+
| Olivier Dragon        dr...@sh... |
| Software Engineering II, McMaster University |
+----------------------------------------------+