#!/usr/bin/perl

##############################################
##############################################
# SCRIPT NAME:  Page_MINE.cgi
# FUNCTION:     Display MINE manual
##############################################
	

# 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";


$| = 1; #flush the buffer
open (STDERR, ">&STDOUT");      # this redirects the error messages to the users
        	                        # screen.  Useful for debugging!!

$query = new CGI;
print $query->header;   
print $query->start_html('MINE'); # put title in here


# Each time a script is invoked for the first time, log the visit in the custom MINE server log (see CGI-MINE.pl)
$action = $query->param('action');
if ($action eq undef) {&log();}

# print the MINE menu
&menu;


if (!-e "MINE_Customization_File") {
	&table_top();
	print "<P><P><B>NOTE:</b> You are currently using the \"MINE_Customization_File.default\" file.  You should copy this
	file to \"MINE_Customization_File\" and customize the global variables found within it to suit your database.
	Go to the <a href=\"Page_MINE.cgi#customizing mine once installed\">FAQ</a>, if you need help setting up this file.";
	&table_bottom();
}

print "</center>";
print "<P><P><b><i><font size=+2>MINE FAQ</font></i></b><p>";



############
# FUNCTION call to read the manual page into this web page
###########

&read_manual_page();



# PRINT THE LINK TO SOURCE CODE
# make a url link to the source code for this script
$source = "<font=\"blue\"><i><a href=\"Page_MINE_source\">source</a></i></font>";
print "<p> See the source code for this script:  $source";

# ATTACH the MINE copywrite
&mine_cp;


# FINISH off the body of the html page
print $query->end_html;




sub read_manual_page {

# this is the name I chose for making a web doc out of the pod documentation
# found in the CGI-MINE.pl file

# in this file should be the results of pod2html CGI-MINE.pl > MINE_pod.html
# make sure the permission of MINE_pod.html is 644 (readable!)

my $file = "MINE_pod.html";
	if (-e $file) {
        	open (IN, "$file") || die "can't open the archive file";
        	while ($line = <IN>) {
		        $all_entries .= $line;
        	}
        	close (IN);
        	# print the manual file to screen
        	print "$all_entries";
	}  # end if (-e $file)
}  # end sub read manual page