Annotation of loncom/interface/lonhelpmenu.pm, revision 1.21
1.1 raeburn 1: # The LearningOnline Network with CAPA
2: # generate frame-based help system
3: #
4: # Copyright Michigan State University Board of Trustees
5: #
6: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
7: #
8: # LON-CAPA is free software; you can redistribute it and/or modify
9: # it under the terms of the GNU General Public License as published by
10: # the Free Software Foundation; either version 2 of the License, or
11: # (at your option) any later version.
12: #
13: # LON-CAPA is distributed in the hope that it will be useful,
14: # but WITHOUT ANY WARRANTY; without even the implied warranty of
15: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16: # GNU General Public License for more details.
17: #
18: # You should have received a copy of the GNU General Public License
19: # along with LON-CAPA; if not, write to the Free Software
20: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21: #
22: # /home/httpd/html/adm/gpl.txt
23: #
24: # http://www.lon-capa.org/
25: #
26:
27: package Apache::lonhelpmenu;
28:
29: use strict;
30: use lib qw(/home/httpd/lib/perl);
31: use Apache::Constants qw(:common);
32: use Apache::loncommon();
1.18 raeburn 33: use Apache::lonlocal;
1.20 albertel 34: use Apache::lonnet;
1.1 raeburn 35:
1.2 albertel 36: sub handler {
37: my ($r) = @_;
1.8 raeburn 38: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','color','function','faq','bug','topic','component_help','origurl','stayonpage']);
1.2 albertel 39: &Apache::loncommon::content_type($r,'text/html');
1.1 raeburn 40: $r->send_http_header;
41:
42: if ($r->header_only) {
43: return OK;
44: }
1.20 albertel 45: my $color = $env{'form.color'};
46: my $faq = $env{'form.faq'};
47: my $bug = $env{'form.bug'};
48: my $topic = $env{'form.topic'};
49: my $function = $env{'form.function'};
50: my $component_help = $env{'form.component_help'};
51: my $origurl = $env{'form.origurl'};
52: my $stayOnPage = $env{'form.stayonpage'};
1.1 raeburn 53: my $component_url = $component_help;
54: if ($component_url) {
55: $component_url = '/adm/help/'.$component_url.'.hlp';
56: }
57: my $bugurl = $Apache::lonnet::perlvar{'BugzillaHost'};
58: $bugurl .= 'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.$origurl;
59: if ($bug) {
60: $bugurl .= '&component='.$bug;
61: }
62: my $faqbaseurl = $Apache::lonnet::perlvar{'FAQHost'};
63: my $requestmail = $Apache::lonnet::perlvar{'lonSupportEMail'};
1.20 albertel 64: if ($env{'form.page'} eq 'banner') {
1.8 raeburn 65: &display_help_banner($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
1.20 albertel 66: } elsif ($env{'form.page'} eq 'body') {
1.3 albertel 67: &display_help_mainpage($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);
1.1 raeburn 68: }
69: return OK;
70: }
71:
72: sub display_help_banner {
1.8 raeburn 73: my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
1.1 raeburn 74: my $bodytag = &Apache::loncommon::bodytag('',$function,'rightmargin="0" leftmargin="0" marginwidth="0" topmargin="1" marginheight="1"',1);
1.5 albertel 75: $bodytag=~s/[\n\r]/ /g;
1.1 raeburn 76: my $fontcolor = &Apache::loncommon::designparm($function.'.font');
77: my $alinkcolor = &Apache::loncommon::designparm($function.'.alink');
78: my $vlinkcolor = &Apache::loncommon::designparm($function.'.vlink');
79: my $pagecolor = &Apache::loncommon::designparm($function.'.pgbg');
80: my $tablecolor = &Apache::loncommon::designparm($function.'.tabbg');
1.14 albertel 81: my $location=&Apache::loncommon::lonhttpdurl("/adm");
1.8 raeburn 82: if (($tablecolor eq '') || ($tablecolor eq '#FFFFFF')) {
1.17 raeburn 83: $tablecolor = '#EEEE99';
1.8 raeburn 84: }
1.17 raeburn 85: my $scripttag = '';
86: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
87: my $displayurl = &Apache::lonnet::escape($origurl);
88: $scripttag = (<<"SCRIPT_ONE");
89: <script>
90: function gohelpdesk() {
91: var actiontype = null;
92: try {
93: actiontype = parent.bodyframe.document.logproblem.action.value;
94: }
95: catch(error) {
96: parent.bodyframe.location = "/adm/support?origurl=$displayurl&function=$function";
97: return;
98: }
99: if (actiontype) {
100: var loc = parent.bodyframe.location.href;
101: if (loc.indexOf("/adm/support") > -1) {
102: if (parent.bodyframe.document.logproblem.action.value == "process") {
103: if (validmail(parent.bodyframe.document.logproblem.email) == false) {
104: alert("The e-mail address you entered: "+parent.bodyframe.document.logproblem.email.value+" is not a valid e-mail address.");
105: return;
106: }
107: parent.bodyframe.document.logproblem.submit();
108: return;
109: }
110: }
111: parent.bodyframe.location = "/adm/support?origurl=$displayurl&function=$function";
112: return;
113: }
114: }
115: SCRIPT_ONE
116: $scripttag .= (<<'SCRIPT_TWO');
117: function validmail(field) {
118: var str = field.value;
119: if (window.RegExp) {
120: var reg1str = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
121: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$";
122: var reg1 = new RegExp(reg1str);
123: var reg2 = new RegExp(reg2str);
124: if (!reg1.test(str) && reg2.test(str)) {
125: return true;
126: }
127: return false;
128: }
129: else
130: {
1.8 raeburn 131:
1.17 raeburn 132: if(str.indexOf("@") >= 0) {
133: return true;
134: }
135: return false;
136: }
137: }
138: </script>
139: SCRIPT_TWO
140: }
1.19 albertel 141: my $html=&Apache::lonxml::xmlbegin();
1.1 raeburn 142: $r->print(<<END);
1.19 albertel 143: $html
1.1 raeburn 144: <head>
145: <title>Help Banner</title>
146: <style type="text/css">
147: <!--
148: a:link {text-decoration: none; color: $fontcolor; }
149: a:visited {text-decoration: none; color: $fontcolor; }
150: a:active {text-decoration: none; color: $fontcolor; }
151: a:hover {text-decoration: underline; color: $vlinkcolor; }
152: -->
153: </style>
1.17 raeburn 154: $scripttag
1.1 raeburn 155: </head>
156: $bodytag
1.8 raeburn 157: END
158: if ($stayOnPage) {
159: $r->print('<table width="700" border="0" cellspacing="0" cellpadding="0" height="55">');
160: } else {
161: $r->print('<table width="600" border="0" cellspacing="0" cellpadding="0" height="55">');
162: }
163: $r->print(<<END);
1.1 raeburn 164: <tr height="50">
165: <td width='5'> </td>
166: <td>
1.12 albertel 167: <fieldset><legend><img src="$location/lonIcons/minilogo.gif" height='20' width='29' valign='bottom' /> <b><font size="+1">LON-CAPA help/support</font></b></legend>
1.1 raeburn 168: <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#000000">
169: <tr>
170: <td>
171: <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#000000">
172: <tr>
173: <td>
174: <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#ffffff">
175: <tr>
176: <td>
177: <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#ffffff">
178: <tr bgcolor="$tablecolor">
179: END
1.21 ! www 180: if ($component_url) {
! 181: $r->print("<td align=\"center\"><b><a href=\"$component_url\" target=\"bodyframe\">".
! 182: '<img src="'.$location.'/help/gif/smallHelp.gif" border="0" alt="(Topic help)" valign="middle" /> Topic help</a></b> </td>');
1.1 raeburn 183: }
1.11 raeburn 184: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 185: $r->print('
1.17 raeburn 186: <td align="center"> <b><a href="javascript:gohelpdesk()"><img src="'.$location.'/lonIcons/helpdesk.gif" border="0" alt="(Ask helpdesk)" valign="middle" /> Ask helpdesk</a></b> </td>');
1.1 raeburn 187: }
1.20 albertel 188: if ($faq && $env{'user.adv'}) {
1.15 raeburn 189: $r->print(<<END);
1.1 raeburn 190: <td align="center">
1.13 albertel 191: <b><a href="$faqbaseurl/fom/cache/$faq.html" target="bodyframe"><img src="$location/lonMisc/smallFAQ.gif" border="0" alt="(FAQ)" valign="middle" /> FAQ</a></b>
1.1 raeburn 192: </td>
1.7 albertel 193: END
194: }
1.20 albertel 195: if ($env{'user.adv'}) {
1.15 raeburn 196: $r->print(<<END);
1.13 albertel 197: <td align="center"> <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></td>
1.1 raeburn 198: END
199: }
1.8 raeburn 200: if ($stayOnPage) {
201: $r->print(<<END);
1.13 albertel 202: <td align="center"> <b><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></b> </td>
1.8 raeburn 203: END
204: } else {
205: $r->print(<<END);
1.13 albertel 206: <td align="center"> <b><a href="javascript:window.close()" target="_top"><img src="$location/lonIcons/closepage.gif" border="0" alt="(Close window)" valign="bottom" /> Close</a></b> </td>
1.8 raeburn 207: END
208: }
1.1 raeburn 209: $r->print(<<END);
210: </tr>
211: </table>
212: </td>
213: </tr>
214: </table>
215: </td>
216: </tr>
217: </table>
218: </td>
219: </tr>
220: </table>
221: </fieldset>
222: </td>
223: <td width='5'> </td>
224: </tr>
225: <tr height='5'>
226: <td colspan='3' height='5'> </td>
227: </tr>
228: </table>
229: </body>
230: </html>
231: END
232: }
233:
234: sub display_help_mainpage {
235: my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;
236: my $bodytag = &Apache::loncommon::bodytag('',$function,'topmargin="0" marginheight="0"',1);
1.4 albertel 237: $bodytag=~s/[\n\r]/ /g;
1.8 raeburn 238: my %lt =&Apache::lonlocal::texthash(
239: 'heco' => 'Help Content',
240: 'topp' => 'Topic Page',
241: 'chen' => 'Choose an entry below to go directly to a relevant help page',
242: 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
243: 'vthp' => 'Visit the help page for ',
244: 'disp' => 'Display the page in the inline help system that covers this topic.',
245: '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 246: 'inhs' => 'Topical help system for',
! 247: 'noto' => 'There is no specific topical help item for',
1.8 raeburn 248: 'coth' => 'Consult the inline help system for this topic.',
249: 'cont' => 'Contact the LON-CAPA support team',
250: 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
1.18 raeburn 251: '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 252: 'faqo' => 'FAQ-O-Matic Help system',
253: '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.',
254: 'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system',
255: '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.',
256: 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
257: );
1.19 albertel 258: my $html=&Apache::lonxml::xmlbegin();
1.1 raeburn 259: $r->print(<<END);
1.19 albertel 260: $html
1.1 raeburn 261: <head>
1.8 raeburn 262: <title>$lt{'heco'}</title>
1.1 raeburn 263: </head>
264: $bodytag
265: END
1.8 raeburn 266: $r->print($lt{'chen'});
1.11 raeburn 267: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.8 raeburn 268: $r->print(', '.$lt{'orto'});
1.1 raeburn 269: } else {
270: $r->print(".");
271: }
272: if ($topic) {
1.20 albertel 273: if ( ($component_url) || ($env{'user.adv'}) ) {
1.1 raeburn 274: if ($component_url) {
275: $r->print("
276: <ul>
1.8 raeburn 277: <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li>
1.1 raeburn 278: </ul>
1.8 raeburn 279: <p>$lt{'disp'}</p>
1.1 raeburn 280: ");
1.20 albertel 281: } elsif ($env{'user.adv'}) {
1.1 raeburn 282: $r->print("
283: <ul>
1.21 ! www 284: <li><td align=\"center\"> <a href=\"/adm/help/nohelptopic.html\">$lt{'noto'} $topic</a></li></ul>
1.8 raeburn 285: <p>$lt{'coth'}</p>");
1.1 raeburn 286: }
287: }
288: }
1.11 raeburn 289: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 290: $r->print("
291: <ul>
1.9 raeburn 292: <li><a href=\"/adm/support?origurl=".&Apache::lonnet::escape($origurl)."&function=$function\">$lt{'cont'}</a></li>
1.1 raeburn 293: </ul>
1.18 raeburn 294: <p>$lt{'suhr'}");
1.20 albertel 295: unless ($env{'user.adv'}) {
1.18 raeburn 296: $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.'));
297: }
298: $r->print("</p>");
1.1 raeburn 299: }
1.20 albertel 300: if ($faqbaseurl && $env{'user.adv'}) {
1.1 raeburn 301: if (!defined($faq) ||$faq eq '') {
302: $faq = '1';
303: }
304: $r->print("
1.11 raeburn 305: <ul>
1.8 raeburn 306: <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li>
1.1 raeburn 307: </ul>
1.8 raeburn 308: <p>$lt{'tfaq'}</p>
1.1 raeburn 309: ");
310: }
1.20 albertel 311: if ($bugurl && $env{'user.adv'}) {
1.1 raeburn 312: $bugurl .= '?'.$bug;
313: $r->print("
314: <ul>
1.8 raeburn 315: <li><a href=\"$bugurl\">$lt{'lbug'}</a></li>
1.1 raeburn 316: </ul>
1.8 raeburn 317: <p>$lt{'crea'} $lt{'suim'}</p>
1.1 raeburn 318: ");
319: }
320: $r->print(<<END);
321: </body>
322: </html>
323: END
324: }
325:
326: 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