--- loncom/interface/lonsearchcat.pm 2002/03/08 18:36:00 1.117
+++ loncom/interface/lonsearchcat.pm 2002/06/20 14:31:31 1.124
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Search Catalog
#
-# $Id: lonsearchcat.pm,v 1.117 2002/03/08 18:36:00 matthew Exp $
+# $Id: lonsearchcat.pm,v 1.124 2002/06/20 14:31:31 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -31,10 +31,42 @@
# 10/12,10/14,10/15,10/16,11/28,11/29,12/10,12/12,12/16 Scott Harrison
# YEAR=2002
# 1/17 Scott Harrison
+# 6/17 Matthew Hall
#
-###
+###############################################################################
+###############################################################################
+
+=pod
+
+=head1 NAME
+
+lonsearchcat
+
+=head1 SYNOPSIS
+
+Search interface to LON-CAPAs digital library
+
+=head1 DESCRIPTION
+
+This module enables searching for a distributed browseable catalog.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+lonsearchcat presents the user with an interface to search the LON-CAPA
+digital library. lonsearchcat also initiates the execution of a search
+by sending the search parameters to LON-CAPA servers. The progress of
+search (on a server basis) is displayed to the user in a seperate window.
+
+=head1 Internals
+
+=over 4
+
+=cut
###############################################################################
+###############################################################################
+
## ##
## ORGANIZATION OF THIS PERL MODULE ##
## ##
@@ -60,62 +92,117 @@ use Apache::loncommon();
# ---------------------------------------- variables used throughout the module
+######################################################################
+######################################################################
+
+=pod
+
+=item Global variables
+
+=over 4
+
+=item %hostdomains
+
+matches host name to host domain
+
+=item %hostips
+
+matches host name to host ip
+
+=item %hitcount
+
+stores number of hits per host
+
+=item $closebutton
+
+button that closes the search window
+
+=item $importbutton
+
+button to take the selecte results and go to group sorting
+
+=item %hash
+
+The ubiquitous database hash
+
+=item $diropendb
+
+The full path to the (temporary) search database file. This is set and
+used in &handler() and is also used in &output_results().
+
+=back
+
+=cut
+
+######################################################################
+######################################################################
+
# -- information holders
my %hostdomains; # matches host name to host domain
-my %hostips; # matches host name to host ip
-my %hitcount; # stores number of hits per host
+my %hostips; # matches host name to host ip
+my %hitcount; # stores number of hits per host
# -- dynamically rendered interface components
-my $closebutton; # button that closes the search window
+my $closebutton; # button that closes the search window
my $importbutton; # button to take the selected results and go to group sorting
# -- miscellaneous variables
-my $scrout; # string that holds portions of the screen output
my $yourself; # allows for quickly limiting to oneself
-my %hash;
+my %hash; # database hash
# ------------------------------------------ choices for different output views
# Detailed Citation View ---> sub detailed_citation_view
# Summary View ---> sub summary_view
# Fielded Format ---> sub fielded_format_view
# XML/SGML ---> sub xml_sgml_view
-my $basicviewselect=<Search Catalog
+
+ +$closebutton + + + + +
+ + + +ENDDOCUMENT + return $scrout; +} +###################################################################### +###################################################################### + +=pod + +=item &advanced_search_form() + +Returns a scalar which holds html for the advanced search form. -# ----------------------------- Else, begin building search interface to output - $scrout=''; # building a part of screen output +=cut + +###################################################################### +###################################################################### + +sub advanced_search_form{ + my ($closebutton,$hidden) = @_; + my $scrout=<<"ENDHEADER"; + + +