[BACK]Return to loncommon.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/loncommon.pm between versions 1.47 and 1.48

version 1.47, 2002/07/22 14:25:40 version 1.48, 2002/08/01 16:48:21
Line 439  END Line 439  END
   
 =pod  =pod
   
 =item help_open_topic($topic, $stayOnPage, $width, $height)  =item help_open_topic($topic, $text, $stayOnPage, $width, $height)
   
 Returns a string corresponding to an HTML link to the given help $topic, where $topic corresponds to the name of a .tex file in /home/httpd/html/adm/help/tex, with underscores replaced by spaces.  Returns a string corresponding to an HTML link to the given help $topic, where $topic corresponds to the name of a .tex file in /home/httpd/html/adm/help/tex, with underscores replaced by spaces.
   
   $text will optionally be linked to the same topic, allowing you to link text in addition to the graphic. If you do not want to link text, but wish to specify one of the later parameters, pass an empty string.
   
 $stayOnPage is a value that will be interpreted as a boolean. If true, the link will not open a new window. If false, the link will open a new window using Javascript. (Default is false.)  $stayOnPage is a value that will be interpreted as a boolean. If true, the link will not open a new window. If false, the link will open a new window using Javascript. (Default is false.)
   
 $width and $height are optional numerical parameters that will override the width and height of the popped up window, which may be useful for certain help topics with big pictures included.  $width and $height are optional numerical parameters that will override the width and height of the popped up window, which may be useful for certain help topics with big pictures included.
Line 450  $width and $height are optional numerica Line 452  $width and $height are optional numerica
 =cut  =cut
   
 sub help_open_topic {  sub help_open_topic {
     my ($topic, $stayOnPage, $width, $height) = @_;      my ($topic, $text, $stayOnPage, $width, $height) = @_;
       $text = "" if (not defined $text);
     $stayOnPage = 0 if (not defined $stayOnPage);      $stayOnPage = 0 if (not defined $stayOnPage);
     $width = 350 if (not defined $width);      $width = 350 if (not defined $width);
     $height = 400 if (not defined $height);      $height = 400 if (not defined $height);
     my $filename = $topic;      my $filename = $topic;
     $filename =~ s/ /_/g;      $filename =~ s/ /_/g;
   
     my $template;      my $template = "";
       my $link;
   
     if (!$stayOnPage)      if (!$stayOnPage)
     {      {
         $template = <<"ENDTEMPLATE";   $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height'))";
 <a href="javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,s  
 crollbars=1,width=$width,height=$height'))"><image  
   src="/adm/help/gif/smallHelp.gif"  
   border="0" alt="(Help: $topic)"></a>  
 ENDTEMPLATE  
     }      }
     else      else
     {      {
         $template = <<"ENDTEMPLATE";   $link = "/adm/help/${filename}.hlp";
 <a href="/adm/help/${filename}.hlp"><image      }
   src="/adm/help/gif/smallHelp.gif"  
   border="0" alt="(Help: $topic)"></a>      # Add the text
 ENDTEMPLATE      if ($text ne "")
       {
    $template .= "<a href=\"$link\">$text</a> ";
     }      }
   
       # Add the graphic
       $template .= <<"ENDTEMPLATE";
   <a href="$link"><image src="/adm/help/gif/smallHelp.gif" border="0" alt="(Help: $topic)"></a>
   ENDTEMPLATE
   
     return $template;      return $template;
   
 }  }
Removed from v.1.47  
changed lines
  Added in v.1.48

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>