#!/usr/bin/perl

##############################################
##############################################
# SCRIPT NAME:  Page_Documentation.cgi
# FUNCTION:     Simple script to list links to 
# relevant documentation
##############################################
	
# MINE: Molecular INformation Explorer
# Copyright 2000 Dawn Field.  All rights reserved.
# The CGI-PERL scripts belonging to MINE
# may be used and modified freely, but I do
# request that this copyright notice remain attached
# to this file/source code.  If you make modifications
# please do not distribute unless
# you fully document the modifications.



	
use  CGI;
require "CGI-MINE.pl";

        #################
        # START EACH MINE CGI SCRIPT
        #################
	# this redirects the error messages to the user's screen
	# and is useful for debugging CGI scripts!
	open (STDERR, ">&STDOUT");         # print errors to screen
	$| = 1;                            # flush the print buffer continuously
	# make a new query object using CGI.pm module
	$query = new CGI;
	# print the required header and start the web page
	print $query->header;   
	print $query->start_html('MINE');
	# Each time a script is invoked for the first time (or $action undef),
	# log the visit in the custom MINE server log (see CGI-MINE.pl)
	# (put this after the header incase an error message is printed)
	# check value of $action
	$action = $query->param('action');
	if ($action eq undef) {&log();}



	#######
	# START THE WEBPAGE
	#######
	# print the MINE menu
	&menu;
	# start the basic gray table used for formatting MINE pages
	&table_top();
	# put the main title of your page here
	print "<b><i><font size=+2>Documentation</font></i></b><p><p>";
	print "To learn about the MINE code, how to run a MINE database, and why Perl was used for this project see: 
<a href=\"Page_MINE_FAQ.cgi\">The MINE FAQ</a>";
       print "<P>For instructions and lots of \"How do I...\" examples 
on how to use MINE to view, explore and data-mine sequences\"
see: <a href=\"MINE_manual.html\">The MINE User's Manual</a><P>";

	# end table
	&table_bottom();



        # PRINT BOTTOM OF EACH WEB PAGE
        # if $show_source is set to 1 show a link
        # at the bottom of each script to the source
        # code - pass the name of this script to the
        # function in CGI-MINE.pl
        if ($show_source) {
                $script_name = $query->script_name();
                &source ($script_name);
        }	# ATTACH the MINE copywrite
	&mine_cp;
	print $query->end_html;
        #################
        # END WEBPAGE
        #################






#####################
# FUNCTIONS
#####################