--- loncom/interface/lonstatistics.pm 2006/05/01 05:39:44 1.130
+++ loncom/interface/lonstatistics.pm 2008/11/20 14:37:24 1.144
@@ -1,6 +1,6 @@
# The LearningOnline Network with CAPA
#
-# $Id: lonstatistics.pm,v 1.130 2006/05/01 05:39:44 raeburn Exp $
+# $Id: lonstatistics.pm,v 1.144 2008/11/20 14:37:24 jms Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -28,19 +28,7 @@
#
###
-=pod
-
-=head1 NAME
-lonstatistics
-
-=head1 SYNOPSIS
-
-Main handler for statistics and chart.
-
-=over 4
-
-=cut
package Apache::lonstatistics;
@@ -63,6 +51,7 @@ use Apache::loncoursedata;
use Apache::lonhtmlcommon;
use Apache::lonmysql;
use Apache::lonlocal;
+use Apache::longroup;
use Time::HiRes;
#
# Statistics Packages
@@ -75,34 +64,8 @@ use Apache::lonpercentage;
use Apache::lonstudentsubmissions();
use Apache::lonsurveyreports();
use Apache::longradinganalysis();
+use LONCAPA;
-#######################################################
-#######################################################
-
-=pod
-
-=item Package Variables
-
-=item @FullClasslist The full classlist
-
-=item @Students The students we are concerned with for this invocation
-
-=item @Sections The sections available in this class
-
-=item @Groups The groups available in the class
-
-=item $curr_student The student currently being examined
-
-=item $prev_student The student previous in the classlist
-
-=item $next_student The student next in the classlist
-
-=over
-
-=cut
-
-#######################################################
-#######################################################
#
# Classlist variables
#
@@ -110,43 +73,7 @@ my $curr_student;
my $prev_student;
my $next_student;
-#######################################################
-#######################################################
-
-=pod
-
-=item &clear_classlist_variables()
-
-undef the following package variables:
-
-=over
-
-=item @FullClasslist
-
-=item @Students
-
-=item @Sections
-
-=item @Groups
-
-=item %StudentData
-=item @StudentDataOrder
-
-=item @SelectedStudentData
-
-=item $curr_student
-
-=item $prev_student
-
-=item $next_student
-
-=back
-
-=cut
-
-#######################################################
-#######################################################
sub clear_classlist_variables {
undef(@FullClasslist);
undef(@Students);
@@ -159,45 +86,7 @@ sub clear_classlist_variables {
undef($next_student);
}
-#######################################################
-#######################################################
-
-=pod
-
-=item &PrepareClasslist()
-
-Build up the classlist information. The classlist information is kept in
-the following package variables:
-
-=over
-
-=item @FullClasslist
-
-=item @Students
-
-=item @Sections
-
-=item @Groups
-
-=item %StudentData
-
-=item @SelectedStudentData
-
-=item $curr_student
-
-=item $prev_student
-
-=item $next_student
-
-=back
-
-$curr_student, $prev_student, and $next_student may not be defined, depending
-upon the calling context.
-=cut
-
-#######################################################
-#######################################################
sub PrepareClasslist {
my %Sections;
&clear_classlist_variables();
@@ -230,12 +119,13 @@ sub PrepareClasslist {
$enrollment_status = $env{'form.Status'} if (exists($env{'form.Status'}));
#
# Get groupmembership
- my (%curr_groups,$classgroups,$studentgroups);
- my $numgroups = &Apache::loncommon::coursegroups(\%curr_groups,$cdom,$cnum);
- if ($numgroups) {
+ my ($classgroups,$studentgroups);
+ my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
+ if (%curr_groups) {
($classgroups,$studentgroups) =
- &Apache::loncoursedata::get_group_memberships($classlist,
- $cdom,$cnum);
+ &Apache::loncoursedata::get_group_memberships($classlist,
+ $field_names,
+ $cdom,$cnum);
}
my $now = time;
@@ -281,18 +171,18 @@ sub PrepareClasslist {
($enrollment_status eq 'Any'))
){
my $groupcheck = 0;
- if (grep/^all$/,@selected_groups) {
- push (@Students,$studenthash);
+ if (grep(/^all$/,@selected_groups)) {
+ push(@Students,$studenthash);
last;
- } elsif (grep/^none$/,@selected_groups) {
+ } elsif (grep(/^none$/,@selected_groups)) {
if ($studenthash->{'groups'} eq 'none') {
- push (@Students,$studenthash);
+ push(@Students,$studenthash);
last;
}
} else {
foreach my $group (@selected_groups) {
- if (grep/^$group$/,@studentsgroups) {
- push (@Students,$studenthash);
+ if (grep(/^$group$/,@studentsgroups)) {
+ push(@Students,$studenthash);
$groupcheck = 1;
last;
}
@@ -309,7 +199,11 @@ sub PrepareClasslist {
if ($env{'request.course.sec'} !~ /^\s*$/) {
@Sections = ($env{'request.course.sec'});
} else {
- @Sections = sort {$a cmp $b} keys(%Sections);
+ @Sections = sort {
+ if ($a == $a && $b == $b ) { return $a <=> $b; }
+ return $a cmp $b;
+ } keys(%Sections);
+
unshift(@Sections,'all'); # Put 'all' at the front of the list
}
# Sort the groups
@@ -367,19 +261,7 @@ sub PrepareClasslist {
return;
}
-#######################################################
-#######################################################
-=pod
-
-=item get_selected_sections
-
-Returns an array of the selected sections
-
-=cut
-
-#######################################################
-#######################################################
sub get_selected_sections {
my @selected_sections =
&Apache::loncommon::get_env_multiple('form.Section');
@@ -397,19 +279,7 @@ sub get_selected_sections {
return @selected_sections;
}
-#######################################################
-#######################################################
-
-=pod
-
-=item get_selected_groups
-
-Returns an array of the selected groups
-
-=cut
-
-#######################################################
-#######################################################
+
sub get_selected_groups {
my @selected_groups =
&Apache::loncommon::get_env_multiple('form.Group');
@@ -423,21 +293,8 @@ sub get_selected_groups {
return @selected_groups;
}
-=pod
-
-=item §ion_and_enrollment_description
-
-Returns a string describing the currently selected section(s), group(s) and
-enrollment status.
-
-Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized')
- 'plaintext' is used for example in Excel spreadsheets.
-Returns: scalar description string.
-=cut
-#######################################################
-#######################################################
sub section_and_enrollment_description {
my ($mode) = @_;
if (! defined($mode)) { $mode = 'localized'; }
@@ -445,25 +302,25 @@ sub section_and_enrollment_description {
my @groups = &Apache::lonstatistics::get_selected_groups();
my $description;
if ($mode eq 'localized') {
- $description = &mt('Unable to determine section, groups and enrollment');
+ $description = &mt('Unable to determine section, groups and access status');
} elsif ($mode eq 'plaintext') {
- $description = 'Unable to determine section, groups and enrollment';
+ $description = 'Unable to determine section, groups and access status';
} else {
$description = 'Bad parameter passed to lonstatistics::section_and_enrollment_description';
&Apache::lonnet::logthis($description);
}
$description = §ion_or_group_text($mode,'section',@sections).
- ' '.§ion_or_group_text($mode,'group',@groups);
+ ' '.§ion_or_group_text($mode,'group',@groups);
if ($mode eq 'localized') {
- $description .= &mt(' [_1] enrollment status.',$env{'form.Status'});
+ $description .= ' '.&mt($env{'form.Status'}.' access status.');
} elsif ($mode eq 'plaintext') {
- $description .= ' '.$env{'form.Status'}.' enrollment status.';
+ $description .= ' '.$env{'form.Status'}.' access status.';
}
return $description;
}
-#######################################################
-#######################################################
+
+
sub section_or_group_text {
my ($mode,$type,@items) = @_;
@@ -481,21 +338,21 @@ sub section_or_group_text {
);
if (scalar(@items) == 1 && $items[0] ne 'all') {
if ($mode eq 'localized') {
- $text = &mt('[_1] [_2].',$phrases{$type}{single},$items[0]);
+ $text = &mt($phrases{$type}{single}.' [_1].',$items[0]);
} elsif ($mode eq 'plaintext') {
$text = $phrases{$type}{single}.' '.$items[0].'.';
}
} elsif (scalar(@items) && $items[0] eq 'all') {
if ($mode eq 'localized') {
- $text = &mt('[_1].',$phrases{$type}{all});
+ $text = &mt($phrases{$type}{all}.'.');
} elsif ($mode eq 'plaintext') {
$text = $phrases{$type}{all}.'.';
}
} elsif (scalar(@items)) {
my $lastitem = pop(@items);
if ($mode eq 'localized') {
- $text = &mt('[_1] [_2] and [_3].',$phrases{$type}{plural},
+ $text = &mt($phrases{$type}{plural}.' [_1] and [_2].',
join(', ',@items),$lastitem);
} elsif ($mode eq 'plaintext') {
$text = $phrases{$type}{plural}.' '.join(', ',@items).' and '.
@@ -506,16 +363,6 @@ sub section_or_group_text {
}
-=pod
-
-=item get_students
-
-Returns a list of the selected students
-
-=cut
-
-#######################################################
-#######################################################
sub get_students {
if (! @Students) {
&PrepareClasslist()
@@ -523,84 +370,26 @@ sub get_students {
return @Students;
}
-#######################################################
-#######################################################
-
-=pod
-
-=item ¤t_student()
-Returns a pointer to a hash containing data about the currently
-selected student.
-
-=cut
-#######################################################
-#######################################################
sub current_student {
return $curr_student;
}
-#######################################################
-#######################################################
-
-=pod
-
-=item &previous_student()
-
-Returns a pointer to a hash containing data about the student prior
-in the list of students. Or something.
-=cut
-#######################################################
-#######################################################
sub previous_student {
return $prev_student;
}
-#######################################################
-#######################################################
-
-=pod
-=item &next_student()
-Returns a pointer to a hash containing data about the next student
-to be viewed.
-
-=cut
-
-#######################################################
-#######################################################
sub next_student {
return $next_student;
}
-##############################################
-##############################################
-
-=pod
-
-=item &StudentDataSelect($elementname,$status,$numvisible,$selected)
-
-Returns html for a selection box allowing the user to choose one (or more)
-of the fields of student data available (fullname, username, id, section, etc)
-
-=over 4
-
-=item $elementname The name of the HTML form element
-=item $status 'multiple' or 'single' selection box
-
-=item $numvisible The number of options to be visible
-
-=back
-=cut
-
-##############################################
-##############################################
sub StudentDataSelect {
my ($elementname,$status,$numvisible)=@_;
if ($numvisible < 1) {
@@ -640,22 +429,8 @@ sub StudentDataSelect {
return $Str;
}
-#######################################################
-#######################################################
-
-=pod
-=item &get_selected_maps($elementname)
-Input: Name of the <select> form element used to specify the maps.
-
-Returns: Array of symbs of selected maps or the description 'all'.
- If form.$elementname does not exist, 'all' is returned.
-
-=cut
-
-#######################################################
-#######################################################
sub get_selected_maps {
my ($elementname) = @_;
my @selected_maps =
@@ -671,25 +446,8 @@ sub get_selected_maps {
}
-#######################################################
-#######################################################
-
-=pod
-
-=item &selected_sequences_with_assessments
-
-Retrieve the sequences which were selected by the user to show.
-
-Input: $mode: scalar. Either 'selected' or 'all'. If not specified,
- 'selected' is used.
-
-Returns: an array containing a navmap object and navmap resources,
- or an array containing a scalar with an error message.
-=cut
-#######################################################
-#######################################################
sub selected_sequences_with_assessments {
my ($mode) = @_;
$mode = 'selected' if (! defined($mode));
@@ -700,8 +458,13 @@ sub selected_sequences_with_assessments
#
my @sequences = $navmap->retrieveResources(undef,
sub { shift->is_map(); },1,0,1);
+ my $toplevelseq = $navmap->getById('0.0');
+ if (!grep(/^\Q$toplevelseq\E$/,@sequences)) {
+ unshift(@sequences,$toplevelseq);
+ }
+
my @sequences_with_assessments;
- for my $sequence ($navmap->getById('0.0'), @sequences) {
+ foreach my $sequence (@sequences) {
if ($navmap->hasResource($sequence,sub { shift->is_problem(); },0,1)){
push(@sequences_with_assessments,$sequence);
}
@@ -724,31 +487,7 @@ sub selected_sequences_with_assessments
return $navmap,@sequences_to_show;
}
-##############################################
-##############################################
-=pod
-
-=item &map_select($elementname,$status,$numvisible,$restriction)
-
-Returns html for a selection box allowing the user to choose one (or more)
-of the sequences in the course. The values of the sequences are the symbs.
-If the top sequence is selected, the value 'top' will result.
-
-=over 4
-
-=item $elementname The name of the HTML form element
-
-=item $status 'multiple' or 'single' selection box
-
-=item $numvisible The number of options to be visible
-
-=back
-
-=cut
-
-##############################################
-##############################################
sub map_select {
my ($elementname,$status,$numvisible)=@_;
if ($numvisible < 1) {
@@ -795,31 +534,7 @@ sub map_select {
return $form;
}
-##############################################
-##############################################
-
-=pod
-
-=item &SectionSelect($elementname,$status,$numvisible)
-Returns html for a selection box allowing the user to choose one (or more)
-of the sections in the course.
-
-Uses the package variables @Sections
-=over 4
-
-=item $elementname The name of the HTML form element
-
-=item $status 'multiple' or 'single' selection box
-
-=item $numvisible The number of options to be visible
-
-=back
-
-=cut
-
-##############################################
-##############################################
sub SectionSelect {
my ($elementname,$status,$numvisible)=@_;
if ($numvisible < 1) {
@@ -854,31 +569,7 @@ sub SectionSelect {
return $Str;
}
-##############################################
-##############################################
-
-=pod
-
-=item &GroupSelect($elementname,$status,$numvisible)
-
-Returns html for a selection box allowing the user to choose one (or more)
-of the groups in the course.
-
-Uses the package variables @Groups
-=over 4
-
-=item $elementname The name of the HTML form element
-
-=item $status 'multiple' or 'single' selection box
-
-=item $numvisible The number of options to be visible
-
-=back
-
-=cut
-
-##############################################
-##############################################
+
sub GroupSelect {
my ($elementname,$status,$numvisible)=@_;
if ($numvisible < 1) {
@@ -913,8 +604,8 @@ sub GroupSelect {
}
-##################################################
-##################################################
+
+
sub DisplayClasslist {
my ($r)=@_;
&Apache::lonhtmlcommon::add_breadcrumb
@@ -922,12 +613,12 @@ sub DisplayClasslist {
#
# Output some of the standard interface components
my $Str;
- $Str .= &Apache::lonhtmlcommon::breadcrumbs(undef,'Select One Student');
+ $Str .= &Apache::lonhtmlcommon::breadcrumbs('Select One Student');
$Str .= '<p><table cellspacing="5">'."\n";
$Str .= '<tr>';
$Str .= '<th align="center"><b>'.&mt('Sections').'</b></th>';
$Str .= '<th align="center"><b>'.&mt('Groups').'</b></th>';
- $Str .= '<th align="center"><b>'.&mt('Enrollment Status').'</b></th>';
+ $Str .= '<th align="center"><b>'.&mt('Access Status').'</b></th>';
$Str .= '</tr>'.$/;
$Str .= '<tr>';
$Str .= '<td>'.
@@ -953,46 +644,55 @@ sub DisplayClasslist {
my @selected_sections = &get_selected_sections();
if (! @Students) {
if ($selected_sections[0] eq 'all') {
- if (lc($env{'form.Status'}) eq 'any') {
- $Str .= '<h2>'.
- &mt('There are no students in the course.').
- '</h2>';
- } elsif (lc($env{'form.Status'}) eq 'active') {
- $Str .= '<h2>'.
+ if (lc($env{'form.Status'}) eq 'active') {
+ $Str .= '<p class="LC_info">'.
&mt('There are no currently enrolled students in the course.').
- '</h2>';
+ '</p>';
} elsif (lc($env{'form.Status'}) eq 'expired') {
- $Str .= '<h2>'.
+ $Str .= '<p class="LC_info">'.
&mt('There are no previously enrolled students in the course.').
- '</h2>';
+ '</p>';
+ } elsif (lc($env{'form.Status'}) eq 'future') {
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students with future access in the course.').
+ '</p>';
+ } else { # 'any' and any others
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students in the course.').
+ '</p>';
}
} else {
- my $sections;
- if (lc($env{'form.Status'}) eq 'any') {
- $Str .= '<h2>'.
- &mt('There are no students in the selected sections.').
- '</h2>';
- } elsif (lc($env{'form.Status'}) eq 'active') {
- $Str .= '<h2>'.
+ if (lc($env{'form.Status'}) eq 'active') {
+ $Str .= '<p class="LC_info">'.
&mt('There are no currently enrolled students in the selected sections.').
- '</h2>';
+ '</p>';
} elsif (lc($env{'form.Status'}) eq 'expired') {
- $Str .= '<h2>'.
+ $Str .= '<p class="LC_info">'.
&mt('There are no previously enrolled students in the selected sections.').
- '</h2>';
+ '</p>';
+ } elsif (lc($env{'form.Status'}) eq 'future') {
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students with future access in the selected sections.').
+ '</p>';
+ } else { # 'any' and any others
+ $Str .= '<p class="LC_info">'.
+ &mt('There are no students in the selected sections.').
+ '</p>';
}
}
- $Str.= '<a href="/adm/statistics?reportSelected=student_assessment">'.
- &mt('Click here to return to the chart').'</a>';
+ $Str.= '<p>'
+ .'<a href="/adm/statistics?reportSelected=student_assessment">'
+ .&mt('Return to the chart').'</a>'
+ .'</p>';
$r->print($Str);
$r->rflush();
return;
}
- # "Click" is asinine but it is probably not my place to change the world.
- $Str .= '<h2>Click on a students name or username to view their chart</h2>';
- $Str .= '<table border="0"><tr><td bgcolor="#777777">'."\n";
- $Str .= '<table border="0" cellpadding="3"><tr bgcolor="#e6ffff">'."\n";
+ $Str .= '<h2>'.&mt('Select One Student').'</h2>'
+ .'<p>'.&mt("Click on a student's name or username to view their chart").'</p>'
+ .&Apache::loncommon::start_data_table()
+ .&Apache::loncommon::start_data_table_header_row();
foreach my $field (@Fields) {
$Str .= '<th><a href="/adm/statistics?'.
'reportSelected=student_assessment&'.
@@ -1000,26 +700,20 @@ sub DisplayClasslist {
'sort='.$field.'">'.&mt($field).
'</a></th>';
}
- $Str .= '</tr>'."\n";
+ $Str .= &Apache::loncommon::end_data_table_header_row();
#
- my $alternate = 0;
foreach my $student (@Students) { # @Students is a package variable
my $sname = $student->{'username'}.':'.$student->{'domain'};
- if($alternate) {
- $Str .= '<tr bgcolor="#ffffe6">';
- } else {
- $Str .= '<tr bgcolor="#ffffc6">';
- }
- $alternate = ($alternate + 1) % 2;
+ $Str .= &Apache::loncommon::start_data_table_row();
#
foreach my $field (@Fields) {
$Str .= '<td>';
if ($field eq 'fullname' || $field eq 'username') {
$Str .= '<a href="/adm/statistics?reportSelected=';
- $Str .= &Apache::lonnet::escape('student_assessment');
- $Str .= '&sort='.&Apache::lonnet::escape($env{'form.sort'});
+ $Str .= &escape('student_assessment');
+ $Str .= '&sort='.&escape($env{'form.sort'});
$Str .= '&SelectedStudent=';
- $Str .= &Apache::lonnet::escape($sname).'">';
+ $Str .= &escape($sname).'">';
$Str .= $student->{$field}.' ';
$Str .= '</a>';
} elsif ($field eq 'status') {
@@ -1029,9 +723,9 @@ sub DisplayClasslist {
}
$Str .= '</td>';
}
- $Str .= "</tr>\n";
+ $Str .= &Apache::loncommon::end_data_table_row();
}
- $Str .= '</table></td></tr></table>'."\n";
+ $Str .= &Apache::loncommon::end_data_table();
#
$r->print($Str);
$r->rflush();
@@ -1039,8 +733,8 @@ sub DisplayClasslist {
return;
}
-##############################################
-##############################################
+
+
sub CreateMainMenu {
#
# Define menu data
@@ -1103,8 +797,8 @@ sub CreateMainMenu {
return $Str;
}
-##############################################
-##############################################
+
+
sub handler {
my $r=shift;
my $c = $r->connection();
@@ -1163,19 +857,19 @@ ENDSTYLE
bug=>'Statistics and Charts'});
if (! exists($env{'form.reportSelected'}) ||
$env{'form.reportSelected'} eq '') {
- $r->print(&Apache::lonhtmlcommon::breadcrumbs
- (undef,&mt('Statistics Main Page')).
+ $r->print(&Apache::lonhtmlcommon::breadcrumbs('Statistics Main Page').
&CreateMainMenu());
} else {
#
if (! &Apache::lonmysql::verify_sql_connection()) {
my $serveradmin = $r->dir_config('lonAdmEMail');
- $r->print('<h2><font color="Red">'.
+ $r->print('<h2 class="LC_error">'.
&mt('Unable to connect to database!').
- '</font></h2>');
- $r->print('<p>'.
- &mt('Please notify the server administrator ').
- '<b>'.$serveradmin.'</b></p>');
+ '</h2>');
+ $r->print('<p>'
+ .&mt('Please notify the server administrator [_1]',
+ ,'<b>'.$serveradmin.'</b>')
+ .'</p>');
$r->print('<p>'.
&mt('Course Statistics and Charts cannot be '.
'retrieved until the database is restarted. '.
@@ -1257,17 +951,227 @@ ENDSTYLE
1;
-#######################################################
-#######################################################
+__END__
=pod
+=head1 NAME
+
+lonstatistics
+
+=head1 SYNOPSIS
+
+Main handler for statistics and chart.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+
+=head1 PACKAGE VARIABLES
+
+=over
+
+=item @FullClasslist The full classlist
+
+=item @Students The students we are concerned with for this invocation
+
+=item @Sections The sections available in this class
+
+=item @Groups The groups available in the class
+
+=item $curr_student The student currently being examined
+
+=item $prev_student The student previous in the classlist
+
+=item $next_student The student next in the classlist
+
=back
-=cut
+=head1 SUBROUTINES
-#######################################################
-#######################################################
+=over
-__END__
+=item &clear_classlist_variables()
+
+undef the following package variables:
+
+=over 4
+
+=item * @FullClasslist
+
+=item * @Students
+
+=item * @Sections
+
+=item * @Groups
+
+=item * %StudentData
+
+=item * @StudentDataOrder
+
+=item * @SelectedStudentData
+
+=item * $curr_student
+
+=item * $prev_student
+
+=item * $next_student
+
+=back
+
+=item &PrepareClasslist()
+
+Build up the classlist information. The classlist information is kept in
+the following package variables:
+
+=over 4
+
+=item * @FullClasslist
+
+=item * @Students
+
+=item * @Sections
+
+=item * @Groups
+
+=item * %StudentData
+
+=item * @SelectedStudentData
+
+=item * $curr_student
+
+=item * $prev_student
+
+=item * $next_student
+
+=back
+
+$curr_student, $prev_student, and $next_student may not be defined, depending
+upon the calling context.
+
+=item get_selected_sections()
+
+Returns an array of the selected sections
+
+=item get_selected_groups()
+
+Returns an array of the selected groups
+
+=item §ion_and_enrollment_description()
+
+Returns a string describing the currently selected section(s), group(s) and
+access status.
+
+Inputs: mode = 'plaintext' or 'localized' (defaults to 'localized')
+ 'plaintext' is used for example in Excel spreadsheets.
+Returns: scalar description string.
+
+=item section_or_group_text()
+
+=item get_students()
+
+Returns a list of the selected students
+
+=item ¤t_student()
+
+Returns a pointer to a hash containing data about the currently
+selected student.
+
+=item &previous_student()
+
+Returns a pointer to a hash containing data about the student prior
+in the list of students. Or something.
+
+=item &next_student()
+
+Returns a pointer to a hash containing data about the next student
+to be viewed.
+
+=item &StudentDataSelect($elementname,$status,$numvisible,$selected)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the fields of student data available (fullname, username, id, section, etc)
+
+=over 4
+
+=item * $elementname The name of the HTML form element
+
+=item * $status 'multiple' or 'single' selection box
+
+=item * $numvisible The number of options to be visible
+
+=back
+
+=item &get_selected_maps($elementname)
+
+Input: Name of the <select> form element used to specify the maps.
+
+Returns: Array of symbs of selected maps or the description 'all'.
+ If form.$elementname does not exist, 'all' is returned.
+
+=item &selected_sequences_with_assessments()
+
+Retrieve the sequences which were selected by the user to show.
+
+Input: $mode: scalar. Either 'selected' or 'all'. If not specified,
+ 'selected' is used.
+
+Returns: an array containing a navmap object and navmap resources,
+ or an array containing a scalar with an error message.
+
+=item &map_select($elementname,$status,$numvisible,$restriction)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the sequences in the course. The values of the sequences are the symbs.
+If the top sequence is selected, the value 'top' will result.
+
+=over 4
+
+=item * $elementname The name of the HTML form element
+
+=item * $status 'multiple' or 'single' selection box
+
+=item * $numvisible The number of options to be visible
+
+=back
+
+=item &SectionSelect($elementname,$status,$numvisible)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the sections in the course.
+
+Uses the package variables @Sections
+
+=over 4
+
+=item * $elementname The name of the HTML form element
+
+=item * $status 'multiple' or 'single' selection box
+
+=item * $numvisible The number of options to be visible
+
+=back
+
+=item &GroupSelect($elementname,$status,$numvisible)
+
+Returns html for a selection box allowing the user to choose one (or more)
+of the groups in the course.
+
+Uses the package variables @Groups
+
+=over 4
+
+=item * $elementname The name of the HTML form element
+
+=item * $status 'multiple' or 'single' selection box
+
+=item * $numvisible The number of options to be visible
+
+=back
+
+=item CreateMainMenu()
+
+=back
+
+=cut