--- loncom/interface/loncommon.pm 2006/03/04 21:32:30 1.305 +++ loncom/interface/loncommon.pm 2006/03/16 21:34:03 1.310 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # a pile of common routines # -# $Id: loncommon.pm,v 1.305 2006/03/04 21:32:30 www Exp $ +# $Id: loncommon.pm,v 1.310 2006/03/16 21:34:03 albertel Exp $ # # Copyright Michigan State University Board of Trustees # @@ -2737,6 +2737,10 @@ Inputs: =item * $forcereg, if page should register as content page (relevant for text interface only) +=item * $customtitle, overrides the $title in some way ???? + +=item * $notopbar, if true, keep the 'what is this' info but remove the + navigational links =back Returns: A uniform header for LON-CAPA web pages. @@ -2747,7 +2751,8 @@ other decorations will be returned. =cut sub bodytag { - my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,$notopbar)=@_; + my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle, + $notopbar)=@_; $title=&mt($title); $function = &get_users_function() if (!$function); my $img=&designparm($function.'.img',$domain); @@ -2931,7 +2936,7 @@ ENDBODY =back -=head1 HTTP Helpers +=head1 HTML Helpers =over 4 @@ -2939,14 +2944,10 @@ ENDBODY Returns a uniform footer for LON-CAPA web pages. -Inputs: - -=over 4 +Inputs: none =back -Returns: A uniform footer for LON-CAPA web pages. - =cut sub endbodytag { @@ -2955,10 +2956,125 @@ sub endbodytag { return $endbodytag; } +=pod + +=over 4 + +=item * &headtag() + +Returns a uniform footer for LON-CAPA web pages. + +Inputs: $title - optional title for the head + $head_extra - optional extra HTML to put inside the + +=back + +=cut + +sub headtag { + my ($title,$head_extra) = @_; + + my $result = + ''. + &Apache::lonxml::fontsettings(). + &Apache::lonhtmlcommon::htmlareaheaders(); + + if (!defined($title)) { + $title = 'The LearningOnline Network with CAPA'; + } + + $result .= ''.&mt($title).''.$head_extra; + + return $result; +} + +=pod + +=over 4 + +=item * &endheadtag() + +Returns a uniform for LON-CAPA web pages. + +Inputs: none + +=back + +=cut + +sub endheadtag { + return ''; +} + +=pod + +=over 4 + +=item * &head() + +Returns a uniform complete .. section for LON-CAPA web pages. + +Inputs: $title - optional title for the page + $head_extra - optional extra HTML to put inside the +=back + +=cut + +sub head { + my ($title,$head_extra) = @_; + return &headtag($title,$head_extra).&endheadtag(); +} + +=pod + +=over 4 + +=item * &start_page() + +Returns a complete .. section for LON-CAPA web pages. + +Inputs: $title - optional title for the page + $head_extra - optional extra HTML to incude inside the + %args - additional optional args supported are: + only_body -> is true will set &bodytag() onlybodytag arg on + no_nav_bar -> is true will set &bodytag() notopbar arg on + +=back + +=cut + +sub start_page { + my ($title,$head_extra,$args) = @_; + return + &Apache::lonxml::xmlbegin(). + &headtag($title,$head_extra).&endheadtag(). + &bodytag($title,undef,undef,$args->{'only_body'},undef,undef,undef, + $args->{'no_nav_bar'}); +} + +=pod + +=over 4 + +=item * &head() + +Returns a complete section for LON-CAPA web pages. + +Inputs: None + +=back + +=cut + +sub end_page { + return &endbodytag."\n"; +} ############################################### =pod +=over 4 + =item get_users_function Used by &bodytag to determine the current users primary role.