Annotation of loncom/interface/lonhelpmenu.pm, revision 1.37
1.1 raeburn 1: # The LearningOnline Network with CAPA
2: # generate frame-based help system
3: #
1.37 ! bisitz 4: # $Id: lonhelpmenu.pm,v 1.37 2009/02/13 16:45:00 bisitz Exp $
! 5: #
1.1 raeburn 6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
28:
29: package Apache::lonhelpmenu;
30:
31: use strict;
32: use lib qw(/home/httpd/lib/perl);
33: use Apache::Constants qw(:common);
34: use Apache::loncommon();
1.18 raeburn 35: use Apache::lonlocal;
1.20 albertel 36: use Apache::lonnet;
1.25 www 37: use lib '/home/httpd/lib/perl/';
38: use LONCAPA;
1.1 raeburn 39:
1.2 albertel 40: sub handler {
41: my ($r) = @_;
1.29 albertel 42: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','faq','bug','topic','component_help','origurl','stayonpage']);
1.2 albertel 43: &Apache::loncommon::content_type($r,'text/html');
1.1 raeburn 44: $r->send_http_header;
45:
46: if ($r->header_only) {
47: return OK;
48: }
1.20 albertel 49: my $faq = $env{'form.faq'};
50: my $bug = $env{'form.bug'};
51: my $topic = $env{'form.topic'};
52: my $component_help = $env{'form.component_help'};
53: my $origurl = $env{'form.origurl'};
54: my $stayOnPage = $env{'form.stayonpage'};
1.1 raeburn 55: my $component_url = $component_help;
56: if ($component_url) {
57: $component_url = '/adm/help/'.$component_url.'.hlp';
58: }
59: my $bugurl = $Apache::lonnet::perlvar{'BugzillaHost'};
60: $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl;
61: if ($bug) {
62: $bugurl .= '&component='.$bug;
63: }
64: my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'};
65: my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'};
1.20 albertel 66: if ($env{'form.page'} eq 'banner') {
1.29 albertel 67: &display_help_banner($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
1.20 albertel 68: } elsif ($env{'form.page'} eq 'body') {
1.29 albertel 69: &display_help_mainpage($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);
1.1 raeburn 70: }
71: return OK;
72: }
73:
74: sub display_help_banner {
1.29 albertel 75: my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
1.14 albertel 76: my $location=&Apache::loncommon::lonhttpdurl("/adm");
1.17 raeburn 77: my $scripttag = '';
78: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.25 www 79: my $displayurl = &escape($origurl);
1.17 raeburn 80: $scripttag = (<<"SCRIPT_ONE");
81: <script>
82: function gohelpdesk() {
83: var actiontype = null;
84: try {
85: actiontype = parent.bodyframe.document.logproblem.action.value;
86: }
87: catch(error) {
1.29 albertel 88: parent.bodyframe.location = "/adm/support?origurl=$displayurl";
1.17 raeburn 89: return;
90: }
91: if (actiontype) {
92: var loc = parent.bodyframe.location.href;
93: if (loc.indexOf("/adm/support") > -1) {
94: if (parent.bodyframe.document.logproblem.action.value == "process") {
95: if (validmail(parent.bodyframe.document.logproblem.email) == false) {
96: alert("The e-mail address you entered: "+parent.bodyframe.document.logproblem.email.value+" is not a valid e-mail address.");
97: return;
98: }
99: parent.bodyframe.document.logproblem.submit();
100: return;
101: }
102: }
1.29 albertel 103: parent.bodyframe.location = "/adm/support?origurl=$displayurl";
1.17 raeburn 104: return;
105: }
106: }
107: SCRIPT_ONE
108: $scripttag .= (<<'SCRIPT_TWO');
109: function validmail(field) {
110: var str = field.value;
111: if (window.RegExp) {
112: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
1.22 albertel 113: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
1.17 raeburn 114: var reg1 = new RegExp(reg1str);
115: var reg2 = new RegExp(reg2str);
116: if (!reg1.test(str) && reg2.test(str)) {
117: return true;
118: }
119: return false;
120: }
121: else
122: {
1.8 raeburn 123:
1.17 raeburn 124: if(str.indexOf("@") >= 0) {
125: return true;
126: }
127: return false;
128: }
129: }
130: </script>
131: SCRIPT_TWO
132: }
1.22 albertel 133:
1.24 albertel 134: my %body_layout =
135: ('rightmargin' => "0",
136: 'leftmargin' => "0",
137: 'marginwidth' => "0",
138: 'topmargin' => "1",
139: 'marginheight' => "1");
1.22 albertel 140: my $start_page =
141: &Apache::loncommon::start_page('',$scripttag,
1.29 albertel 142: {'add_entries' => \%body_layout,
1.22 albertel 143: 'only_body' => 1,});
144: $r->print($start_page);
145:
1.32 albertel 146: my $width = ($stayOnPage) ? '95%' : '600';
1.27 albertel 147: $r->print('<table id="LC_helpmenu" width="'.$width.'">');
148:
1.31 albertel 149: my $general_help = &Apache::loncommon::general_help();
1.8 raeburn 150: $r->print(<<END);
1.1 raeburn 151: <tr height="50">
152: <td width='5'> </td>
153: <td>
1.27 albertel 154: <fieldset><legend><img src="$location/lonIcons/minilogo.gif" height='20' width='29' valign='bottom' /> LON-CAPA help/support</legend>
1.26 albertel 155: <table id="LC_helpmenu_links">
156: <tr>
1.33 raeburn 157: <td><span class="LC_nobreak"><a href="/adm/help/$general_help.hlp" target="bodyframe">
1.36 raeburn 158: <img src="$location/help/help.png" border="0" alt="(General help)" valign="middle" /> General Help</a> </span></td>
1.1 raeburn 159: END
1.21 www 160: if ($component_url) {
1.33 raeburn 161: $r->print("<td><span class=\"LC_nobreak\"><a href=\"$component_url\" target=\"bodyframe\">".
1.35 raeburn 162: '<img src="'.$location.'/help/help.png" border="0" alt="(Topic help)" valign="middle" /> '.$topic.'</a> </span></td>');
1.1 raeburn 163: }
1.11 raeburn 164: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 165: $r->print('
1.33 raeburn 166: <td><span class="LC_nobreak"> <a href="javascript:gohelpdesk()"><img src="'.$location.'/lonIcons/helpdesk.gif" border="0" alt="(Ask helpdesk)" valign="middle" /> Ask helpdesk</a> </span></td>');
1.1 raeburn 167: }
1.20 albertel 168: if ($faq && $env{'user.adv'}) {
1.15 raeburn 169: $r->print(<<END);
1.33 raeburn 170: <td><span class="LC_nobreak"> <a href="$faqbaseurl/fom/cache/$faq.html" target="bodyframe"><img src="$location/lonMisc/smallFAQ.gif" border="0" alt="(FAQ)" valign="middle" /> FAQ</a> </span>
1.1 raeburn 171: </td>
1.7 albertel 172: END
173: }
1.20 albertel 174: if ($env{'user.adv'}) {
1.15 raeburn 175: $r->print(<<END);
1.33 raeburn 176: <td><span class="LC_nobreak" <b><a href="$bugurl" target="bodyframe"><img src="$location/lonMisc/smallBug.gif" border="0" alt="(Report a bug)" valign="middle" /> Report a bug</a> </b></span></td>
1.1 raeburn 177: END
178: }
1.8 raeburn 179: if ($stayOnPage) {
180: $r->print(<<END);
1.33 raeburn 181: <td><span class="LC_nobreak"> <a href="$origurl" target="_top"><img src="$location/lonIcons/move_up.gif" border="0" alt="(Return to last location)" valign="middle" /> Return to last location</a> </span></td>
1.8 raeburn 182: END
183: } else {
184: $r->print(<<END);
1.33 raeburn 185: <td><span class="LC_nobreak" <a href="javascript:window.close()" target="_top"><img src="$location/lonIcons/closepage.gif" border="0" alt="(Close window)" valign="bottom" /> Close</a> </span></td>
1.8 raeburn 186: END
187: }
1.1 raeburn 188: $r->print(<<END);
189: </tr>
190: </table>
191: </fieldset>
192: </td>
1.33 raeburn 193: <td width='100%'> </td>
1.1 raeburn 194: </tr>
195: <tr height='5'>
196: <td colspan='3' height='5'> </td>
197: </tr>
198: </table>
199: END
1.22 albertel 200: $r->print(&Apache::loncommon::end_page());
1.1 raeburn 201: }
202:
203: sub display_help_mainpage {
1.29 albertel 204: my ($r,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;
1.22 albertel 205:
1.8 raeburn 206: my %lt =&Apache::lonlocal::texthash(
207: 'topp' => 'Topic Page',
208: 'chen' => 'Choose an entry below to go directly to a relevant help page',
209: 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
210: 'vthp' => 'Visit the help page for ',
211: 'disp' => 'Display the page in the inline help system that covers this topic.',
212: 'crac' => 'Create an account for yourself in the LON-CAPA Bugzilla tracking system, if you wish to report bugs you have encountered in the LON-CAPA software, or if you have suggestions for improvements in LON-CAPA.',
1.21 www 213: 'inhs' => 'Topical help system for',
1.8 raeburn 214: 'cont' => 'Contact the LON-CAPA support team',
215: 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
1.18 raeburn 216: 'stuq' => 'Questions about course content should not be directed to the support team, but instead should be sent to the course instructor',
1.8 raeburn 217: 'faqo' => 'FAQ-O-Matic Help system',
218: 'tfaq' => 'The FAQ-O-Matic is a compendium of answers provided to common questions asked by users of LON-CAPA over the past couple of years.',
219: 'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system',
220: 'crea' => 'Create an account for yourself in the LON-CAPA Bugzilla tracking system, if you wish to report bugs you have encountered in the LON-CAPA software,or if you have suggestions for improvements in LON-CAPA.',
221: 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
222: );
1.22 albertel 223:
1.24 albertel 224: my %body_layout =
225: ('topmargin' => "0",
226: 'marginheight' => "0");
1.22 albertel 227: my $start_page =
228: &Apache::loncommon::start_page('Help Content',undef,
1.29 albertel 229: {'add_entries' => \%body_layout,
1.22 albertel 230: 'only_body' => 1,});
231: $r->print($start_page);
1.30 www 232: $r->print('<b>'.$lt{'chen'});
1.11 raeburn 233: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.8 raeburn 234: $r->print(', '.$lt{'orto'});
1.1 raeburn 235: } else {
236: $r->print(".");
237: }
1.30 www 238: $r->print('</b>');
1.1 raeburn 239: if ($topic) {
1.20 albertel 240: if ( ($component_url) || ($env{'user.adv'}) ) {
1.1 raeburn 241: if ($component_url) {
242: $r->print("
243: <ul>
1.8 raeburn 244: <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li>
1.1 raeburn 245: </ul>
1.8 raeburn 246: <p>$lt{'disp'}</p>
1.1 raeburn 247: ");
248: }
249: }
250: }
1.11 raeburn 251: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 252: $r->print("
253: <ul>
1.29 albertel 254: <li><a href=\"/adm/support?origurl=".&escape($origurl)."\">$lt{'cont'}</a></li>
1.1 raeburn 255: </ul>
1.18 raeburn 256: <p>$lt{'suhr'}");
1.20 albertel 257: unless ($env{'user.adv'}) {
1.18 raeburn 258: $r->print('<br /><b>'.&mt('Note').'</b>: '.$lt{'stuq'}.'. '.&mt('This can be done using the').' <a href="/adm/communicate" target="_top">'.&mt('COM').'</a> '.&mt('button, or the FDBK button when viewing a content page.'));
259: }
260: $r->print("</p>");
1.1 raeburn 261: }
1.20 albertel 262: if ($faqbaseurl && $env{'user.adv'}) {
1.1 raeburn 263: if (!defined($faq) ||$faq eq '') {
264: $faq = '1';
265: }
266: $r->print("
1.11 raeburn 267: <ul>
1.8 raeburn 268: <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li>
1.1 raeburn 269: </ul>
1.8 raeburn 270: <p>$lt{'tfaq'}</p>
1.1 raeburn 271: ");
272: }
1.20 albertel 273: if ($bugurl && $env{'user.adv'}) {
1.1 raeburn 274: $bugurl .= '?'.$bug;
275: $r->print("
276: <ul>
1.8 raeburn 277: <li><a href=\"$bugurl\">$lt{'lbug'}</a></li>
1.1 raeburn 278: </ul>
1.8 raeburn 279: <p>$lt{'crea'} $lt{'suim'}</p>
1.1 raeburn 280: ");
281: }
1.22 albertel 282: $r->print(&Apache::loncommon::end_page());
1.1 raeburn 283: }
284:
285: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonhelpmenu.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface