Annotation of loncom/interface/lonhelpmenu.pm, revision 1.25
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.25 ! www 35: use lib '/home/httpd/lib/perl/';
! 36: use LONCAPA;
1.1 raeburn 37:
1.2 albertel 38: sub handler {
39: my ($r) = @_;
1.8 raeburn 40: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['page','color','function','faq','bug','topic','component_help','origurl','stayonpage']);
1.2 albertel 41: &Apache::loncommon::content_type($r,'text/html');
1.1 raeburn 42: $r->send_http_header;
43:
44: if ($r->header_only) {
45: return OK;
46: }
1.20 albertel 47: my $color = $env{'form.color'};
48: my $faq = $env{'form.faq'};
49: my $bug = $env{'form.bug'};
50: my $topic = $env{'form.topic'};
51: my $function = $env{'form.function'};
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.8 raeburn 67: &display_help_banner($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage);
1.20 albertel 68: } elsif ($env{'form.page'} eq 'body') {
1.3 albertel 69: &display_help_mainpage($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail);
1.1 raeburn 70: }
71: return OK;
72: }
73:
74: sub display_help_banner {
1.8 raeburn 75: my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail,$stayOnPage) = @_;
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/^[^\@]+\@[^\@]+$/) {
1.25 ! www 87: my $displayurl = &escape($origurl);
1.17 raeburn 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 = "(@.*@)|(\\.\\.)|(@\\.)|(\\.@)|(^\\.)";
1.22 albertel 121: var reg2str = "^.+\\@(\\[?)[a-zA-Z0-9\\-\\.]+\\.([a-zA-Z]{2,3}|[0-9]{1,3})(\\]?)$"; //"
1.17 raeburn 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.22 albertel 141:
1.24 albertel 142: my %body_layout =
143: ('rightmargin' => "0",
144: 'leftmargin' => "0",
145: 'marginwidth' => "0",
146: 'topmargin' => "1",
147: 'marginheight' => "1");
1.22 albertel 148: my $start_page =
149: &Apache::loncommon::start_page('',$scripttag,
150: {'function' => $function,
1.24 albertel 151: 'add_entries' => \%body_layout,
1.22 albertel 152: 'only_body' => 1,});
153: $r->print($start_page);
154:
1.8 raeburn 155: if ($stayOnPage) {
156: $r->print('<table width="700" border="0" cellspacing="0" cellpadding="0" height="55">');
157: } else {
158: $r->print('<table width="600" border="0" cellspacing="0" cellpadding="0" height="55">');
159: }
160: $r->print(<<END);
1.1 raeburn 161: <tr height="50">
162: <td width='5'> </td>
163: <td>
1.12 albertel 164: <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 165: <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#000000">
166: <tr>
167: <td>
168: <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#000000">
169: <tr>
170: <td>
171: <table width="100%" border="0" cellpadding="0" cellspacing="0" bgcolor="#ffffff">
172: <tr>
173: <td>
174: <table width="100%" border="0" cellpadding="0" cellspacing="1" bgcolor="#ffffff">
175: <tr bgcolor="$tablecolor">
176: END
1.21 www 177: if ($component_url) {
178: $r->print("<td align=\"center\"><b><a href=\"$component_url\" target=\"bodyframe\">".
179: '<img src="'.$location.'/help/gif/smallHelp.gif" border="0" alt="(Topic help)" valign="middle" /> Topic help</a></b> </td>');
1.1 raeburn 180: }
1.11 raeburn 181: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 182: $r->print('
1.17 raeburn 183: <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 184: }
1.20 albertel 185: if ($faq && $env{'user.adv'}) {
1.15 raeburn 186: $r->print(<<END);
1.1 raeburn 187: <td align="center">
1.13 albertel 188: <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 189: </td>
1.7 albertel 190: END
191: }
1.20 albertel 192: if ($env{'user.adv'}) {
1.15 raeburn 193: $r->print(<<END);
1.13 albertel 194: <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 195: END
196: }
1.8 raeburn 197: if ($stayOnPage) {
198: $r->print(<<END);
1.13 albertel 199: <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 200: END
201: } else {
202: $r->print(<<END);
1.13 albertel 203: <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 204: END
205: }
1.1 raeburn 206: $r->print(<<END);
207: </tr>
208: </table>
209: </td>
210: </tr>
211: </table>
212: </td>
213: </tr>
214: </table>
215: </td>
216: </tr>
217: </table>
218: </fieldset>
219: </td>
220: <td width='5'> </td>
221: </tr>
222: <tr height='5'>
223: <td colspan='3' height='5'> </td>
224: </tr>
225: </table>
226: END
1.22 albertel 227: $r->print(&Apache::loncommon::end_page());
1.1 raeburn 228: }
229:
230: sub display_help_mainpage {
231: my ($r,$color,$function,$faq,$bug,$topic,$component_url,$origurl,$bugurl,$faqbaseurl,$requestmail) = @_;
1.22 albertel 232:
1.8 raeburn 233: my %lt =&Apache::lonlocal::texthash(
234: 'topp' => 'Topic Page',
235: 'chen' => 'Choose an entry below to go directly to a relevant help page',
236: 'orto' => 'or to submit a help request to the LON-CAPA support staff at your institution.',
237: 'vthp' => 'Visit the help page for ',
238: 'disp' => 'Display the page in the inline help system that covers this topic.',
239: '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 240: 'inhs' => 'Topical help system for',
241: 'noto' => 'There is no specific topical help item for',
1.8 raeburn 242: 'coth' => 'Consult the inline help system for this topic.',
243: 'cont' => 'Contact the LON-CAPA support team',
244: 'suhr' => 'Submit a help request to the team responsible for LON-CAPA support at this institution.',
1.18 raeburn 245: '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 246: 'faqo' => 'FAQ-O-Matic Help system',
247: '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.',
248: 'lbug' => 'LON-CAPA Bugzilla bug/feature request tracking system',
249: '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.',
250: 'suim' => ' Suggested improvements may include additional functionality, improved usability, or changes to wording used in LON-CAPA pages, including the embedded help system.'
251: );
1.22 albertel 252:
1.24 albertel 253: my %body_layout =
254: ('topmargin' => "0",
255: 'marginheight' => "0");
1.22 albertel 256: my $start_page =
257: &Apache::loncommon::start_page('Help Content',undef,
258: {'function' => $function,
1.24 albertel 259: 'add_entries' => \%body_layout,
1.22 albertel 260: 'only_body' => 1,});
261: $r->print($start_page);
1.8 raeburn 262: $r->print($lt{'chen'});
1.11 raeburn 263: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.8 raeburn 264: $r->print(', '.$lt{'orto'});
1.1 raeburn 265: } else {
266: $r->print(".");
267: }
268: if ($topic) {
1.20 albertel 269: if ( ($component_url) || ($env{'user.adv'}) ) {
1.1 raeburn 270: if ($component_url) {
271: $r->print("
272: <ul>
1.8 raeburn 273: <li><a href=\"$component_url\">$lt{'vthp'} $topic</a></li>
1.1 raeburn 274: </ul>
1.8 raeburn 275: <p>$lt{'disp'}</p>
1.1 raeburn 276: ");
1.20 albertel 277: } elsif ($env{'user.adv'}) {
1.1 raeburn 278: $r->print("
279: <ul>
1.21 www 280: <li><td align=\"center\"> <a href=\"/adm/help/nohelptopic.html\">$lt{'noto'} $topic</a></li></ul>
1.8 raeburn 281: <p>$lt{'coth'}</p>");
1.1 raeburn 282: }
283: }
284: }
1.11 raeburn 285: if ($requestmail =~ m/^[^\@]+\@[^\@]+$/) {
1.1 raeburn 286: $r->print("
287: <ul>
1.25 ! www 288: <li><a href=\"/adm/support?origurl=".&escape($origurl)."&function=$function\">$lt{'cont'}</a></li>
1.1 raeburn 289: </ul>
1.18 raeburn 290: <p>$lt{'suhr'}");
1.20 albertel 291: unless ($env{'user.adv'}) {
1.18 raeburn 292: $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.'));
293: }
294: $r->print("</p>");
1.1 raeburn 295: }
1.20 albertel 296: if ($faqbaseurl && $env{'user.adv'}) {
1.1 raeburn 297: if (!defined($faq) ||$faq eq '') {
298: $faq = '1';
299: }
300: $r->print("
1.11 raeburn 301: <ul>
1.8 raeburn 302: <li><a href=\"$faqbaseurl/fom/cache/$faq.html\">$lt{'faqo'}</a></li>
1.1 raeburn 303: </ul>
1.8 raeburn 304: <p>$lt{'tfaq'}</p>
1.1 raeburn 305: ");
306: }
1.20 albertel 307: if ($bugurl && $env{'user.adv'}) {
1.1 raeburn 308: $bugurl .= '?'.$bug;
309: $r->print("
310: <ul>
1.8 raeburn 311: <li><a href=\"$bugurl\">$lt{'lbug'}</a></li>
1.1 raeburn 312: </ul>
1.8 raeburn 313: <p>$lt{'crea'} $lt{'suim'}</p>
1.1 raeburn 314: ");
315: }
1.22 albertel 316: $r->print(&Apache::loncommon::end_page());
1.1 raeburn 317: }
318:
319: 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