Annotation of loncom/homework/edit.pm, revision 1.34
1.1 albertel 1: # The LearningOnline Network with CAPA
2: # edit mode helpers
1.25 albertel 3: #
1.34 ! harris41 4: # $Id: edit.pm,v 1.33 2002/03/28 22:03:21 albertel Exp $
1.25 albertel 5: #
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: #
1.1 albertel 28: # 3/20 Guy
1.27 matthew 29: # 01/10/02 Matthew
1.29 matthew 30: # 03/06/02 Matthew
1.1 albertel 31: package Apache::edit;
32:
33: use strict;
1.32 albertel 34: use Apache::lonnet();
35: use HTML::Entities();
1.1 albertel 36:
1.10 albertel 37: # Global Vars
38: # default list of colors to use in editing
39: @Apache::edit::colorlist=('#ffffff','#ff0000','#00ff00','#0000ff','#0ff000','#000ff0','#f0000f');
40: # depth of nesting of edit
41: $Apache::edit::colordepth=0;
42:
43: sub initialize_edit {
44: $Apache::edit::colordepth=0;
45: }
46:
1.1 albertel 47: sub tag_start {
1.9 albertel 48: my ($target,$token,$description) = @_;
1.1 albertel 49: my $result='';
1.5 albertel 50: if ($target eq "edit") {
1.4 albertel 51: my $tag=$token->[1];
1.22 albertel 52: if (!$description) {
53: $description=&Apache::lonxml::description($token);
54: if (!$description) { $description="<$tag>"; }
55: }
1.10 albertel 56: $result.= &start_table($token)."<tr><td>$description</td>
1.14 albertel 57: <td>Delete".
1.8 albertel 58: &deletelist($target,$token)
59: ."</td>
1.4 albertel 60: <td>".
1.27 matthew 61: &insertlist($target,$token).&end_row().&start_spanning_row();
62: #<td>".
1.22 albertel 63: # &movebuttons($target,$token).
64: # "</tr><tr><td colspan=\"3\">\n";
1.4 albertel 65: }
1.1 albertel 66: return $result;
67: }
68:
69: sub tag_end {
1.9 albertel 70: my ($target,$token,$description) = @_;
1.1 albertel 71: my $result='';
1.4 albertel 72: if ($target eq 'edit') {
73: my $tag=$token->[1];
1.9 albertel 74: if (!defined($description)) {
1.14 albertel 75: $result.="</td></tr><tr><td></$tag></td><td colspan=\"2\"> </td>";
1.9 albertel 76: } else {
1.14 albertel 77: if ($description ne '') { $result.="</td></tr><tr><td>$description</td><td colspan=\"2\"> </td>"; }
1.9 albertel 78: }
1.12 albertel 79: $result.="</tr>".&end_table()."\n";
1.4 albertel 80: }
81: return $result;
82: }
1.1 albertel 83:
1.10 albertel 84: sub start_table {
85: my ($token)=@_;
86: my $tag = $token->[1];
87: my $tagnum;
88: foreach my $namespace (reverse @Apache::lonxml::namespace) {
1.23 albertel 89: my $testtag=$namespace.'::'.$tag;
1.10 albertel 90: $tagnum=$Apache::lonxml::insertlist{"$testtag.num"};
91: if (defined($tagnum)) { last; }
92: }
93: if (!defined ($tagnum)) { $tagnum=$Apache::lonxml::insertlist{"$tag.num"}; }
94: my $color = $Apache::lonxml::insertlist{"$tagnum.color"};
95: if (!defined($color)) {
96: $color = $Apache::edit::colorlist[$Apache::edit::colordepth];
97: }
98: $Apache::edit::colordepth++;
1.12 albertel 99: my $result="<table bgcolor=\"$color\" width=\"100%\" border=\"5\">";
1.10 albertel 100: return $result;
101: }
102:
103: sub end_table {
104: $Apache::edit::colordepth--;
105: my $result="</table>";
106: return $result;
107: }
108:
1.27 matthew 109: sub start_spanning_row { return '<tr><td colspan="3">';}
110: sub start_row { return '<tr><td>'; }
111: sub end_row { return '</td></tr>'; }
112:
1.22 albertel 113: sub movebuttons {
114: my ($target,$token) = @_;
115: my $result='<input type="submit" name="moveup.'.
116: $Apache::lonxml::curdepth.'" value="Move Up" />';
117: $result.='<input type="submit" name="movedown.'.
118: $Apache::lonxml::curdepth.'" value="Move Down" />';
119: return $result;
120: }
121:
1.8 albertel 122: sub deletelist {
123: my ($target,$token) = @_;
124: my $result = "<select name=\"delete_$Apache::lonxml::curdepth\">
1.14 albertel 125: <option></option>
126: <option>Yes</option>
1.8 albertel 127: </select>";
128: return $result;
129: }
130:
1.14 albertel 131: sub handle_delete {
132: if (!$ENV{"form.delete_$Apache::lonxml::curdepth"}) { return ''; }
133: my ($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
134: my $result=0;
135: if ($space) {
136: my $sub1="$space\:\:delete_$token->[1]";
137: {
138: no strict 'refs';
139: if (defined &$sub1) {
140: $result=&$sub1($target,$token,$tagstack,$parstack,$parser,$safeeval,$style);
141: }
142: }
143: }
144: if (!$result) {
145: my $endtag='/'.$token->[1];
146: my $bodytext=&Apache::lonxml::get_all_text($endtag,$$parser[$#$parser]);
147: $$parser['-1']->get_token();
148: &Apache::lonxml::debug("Deleting :$bodytext: for $token->[1]");
149: &Apache::lonxml::end_tag($tagstack,$parstack,$token);
150: }
151: return 1;
152: }
153:
1.7 albertel 154: sub get_insert_list {
1.6 albertel 155: my ($token) = @_;
156: my $result='';
1.7 albertel 157: my @tagnums= ();
158: #&Apache::lonxml::debug("keys ".join("\n",sort(keys(%Apache::lonxml::insertlist))));
1.6 albertel 159: if ($Apache::lonxml::insertlist{"$token->[1].which"}) {
1.7 albertel 160: push (@tagnums, @{ $Apache::lonxml::insertlist{"$token->[1].which"} });
161: }
162: foreach my $namespace (@Apache::lonxml::namespace) {
163: if ($Apache::lonxml::insertlist{"$namespace".'::'."$token->[1].which"}) {
164: push (@tagnums, @{ $Apache::lonxml::insertlist{"$namespace".'::'."$token->[1].which"} });
1.6 albertel 165: }
166: }
1.7 albertel 167: if (@tagnums) {
1.33 albertel 168: my %options;
1.7 albertel 169: foreach my $tagnum (@tagnums) {
1.33 albertel 170: my $descrip=$Apache::lonxml::insertlist{"$tagnum.description"};
171: $options{$descrip} ="<option value=\"$tagnum\">".$descrip."</option>\n";
1.5 albertel 172: }
1.33 albertel 173: foreach my $option (sort(keys(%options))) { $result.=$options{$option}; }
1.5 albertel 174: if ($result) { $result='<option selected="on"></option>'.$result; }
175: }
176: return $result;
177: }
178:
1.4 albertel 179: sub insertlist {
1.8 albertel 180: my ($target,$token) = @_;
1.4 albertel 181: my $result;
182: if ($target eq 'edit') {
1.5 albertel 183: my $optionlist= &get_insert_list($token);
184: if ($optionlist) {
185: $result = "Insert:
1.4 albertel 186: <select name=\"insert_$Apache::lonxml::curdepth\">
1.5 albertel 187: $optionlist
1.4 albertel 188: </select>"
1.11 albertel 189: } else {
190: $result=" ";
1.6 albertel 191: }
192: }
193: return $result;
194: }
195:
1.7 albertel 196: sub handle_insert {
1.15 albertel 197: if ($ENV{"form.insert_$Apache::lonxml::curdepth"} eq '') { return ''; }
1.6 albertel 198: my $result;
199: my $tagnum = $ENV{"form.insert_$Apache::lonxml::curdepth"};
200: my $func=$Apache::lonxml::insertlist{"$tagnum.function"};
201: if ($func eq 'default') {
202: my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
1.7 albertel 203: my $namespace;
204: if ($newtag =~ /::/) { ($namespace,$newtag) = split(/::/,$newtag); }
1.6 albertel 205: $result.="\n<$newtag>\n</$newtag>";
206: } else {
1.15 albertel 207: if (defined(&$func)) {
208: {
209: no strict 'refs';
210: $result.=&$func();
211: }
212: } else {
213: my $newtag=$Apache::lonxml::insertlist{"$tagnum.tag"};
214: &Apache::lonxml::error("Unable to insert tag $newtag, $func was not defined.");
1.5 albertel 215: }
216: }
217: return $result;
1.16 albertel 218: }
219:
220: sub insert_responseparam {
221: return '
222: <responseparam />';
1.5 albertel 223: }
224:
1.24 albertel 225: sub insert_formularesponse {
226: return '
227: <formularesponse answer="" samples="">
228: <textline />
229: <hintgroup>
230: </hintgroup>
231: </formularesponse>';
232: }
233:
1.15 albertel 234: sub insert_numericalresponse {
235: return '
236: <numericalresponse answer="">
237: <textline />
238: <hintgroup>
239: </hintgroup>
240: </numericalresponse>';
241: }
242:
1.18 albertel 243: sub insert_stringresponse {
244: return '
245: <stringresponse answer="" type="">
246: <textline />
247: <hintgroup>
248: </hintgroup>
249: </stringresponse>';
250: }
251:
1.7 albertel 252: sub insert_optionresponse {
253: return '
254: <optionresponse max="10">
255: <foilgroup options="">
256: </foilgroup>
1.14 albertel 257: <hintgroup>
258: </hintgroup>
1.7 albertel 259: </optionresponse>';
1.1 albertel 260: }
261:
1.23 albertel 262: sub insert_radiobuttonresponse {
263: return '
264: <radiobuttonresponse max="10">
265: <foilgroup>
266: </foilgroup>
267: <hintgroup>
268: </hintgroup>
269: </radiobuttonresponse>';
270: }
271:
1.21 albertel 272: sub insert_displayduedate { return '<displayduedate />'; }
273: sub insert_displaytitle { return '<displaytitle />'; }
1.22 albertel 274: sub insert_hintpart {
275: return '
276: <hintpart on="default">
277: <startouttext/>
278: <endouttext />
279: </hintpart>';
280: }
281:
282: sub insert_numericalhint {
283: return '
284: <numericalhint>
285: </numericalhint>';
286: }
1.21 albertel 287:
1.23 albertel 288: sub insert_startouttext {
289: return "<startouttext />\n<endouttext />";
290: }
291:
292: sub insert_script {
293: return "\n<script type=\"loncapa/perl\">\n</script>";
294: }
295:
1.25 albertel 296: sub textarea_sizes {
297: my ($data)=@_;
298: my $count=0;
299: my $maxlength=-1;
1.26 harris41 300: foreach (split ("\n", $$data)) { $count++;
1.25 albertel 301: if (length($_) > $maxlength) { $maxlength = length($_); }
1.26 harris41 302: }
1.25 albertel 303: my $rows = $count;
304: my $cols = $maxlength;
305: return ($rows,$cols);
306: }
307:
1.32 albertel 308: sub editline {
1.31 matthew 309: my ($tag,$data,$description,$size)=@_;
1.32 albertel 310: $data=&HTML::Entities::encode($data);
1.31 matthew 311: if ($description) { $description="<br />".$description."<br />"; }
312: my $result = <<"END";
313: $description
314: <input type="text" name="homework_edit_$Apache::lonxml::curdepth"
315: value="$data" size="$size" />
316: END
317: return $result;
318: }
319:
1.2 albertel 320: sub editfield {
1.5 albertel 321: my ($tag,$data,$description,$minwidth,$minheight)=@_;
1.22 albertel 322:
1.25 albertel 323: my ($rows,$cols)=&textarea_sizes(\$data);
324: if ($cols > 80) { $cols = 80; }
325: if ($cols < $minwidth ) { $cols = $minwidth; }
326: if ($rows < $minheight) { $rows = $minheight; }
327: if ($description) { $description="<br />".$description."<br />"; }
1.32 albertel 328: return $description."\n".' <textarea rows="'.$rows.
329: '" cols="'.$cols.'" name="homework_edit_'.$Apache::lonxml::curdepth.'">'.
330: &HTML::Entities::encode($data).'</textarea>'."\n";
1.2 albertel 331: }
332:
333: sub modifiedfield {
334: my ($token) = @_;
1.3 albertel 335: my $result;
336: # foreach my $envkey (sort keys %ENV) {
337: # &Apache::lonxml::debug("$envkey ---- $ENV{$envkey}");
338: # }
339: # &Apache::lonxml::debug("I want homework_edit_$Apache::lonxml::curdepth");
340: # &Apache::lonxml::debug($ENV{"form.homework_edit_$Apache::lonxml::curdepth"});
341: $result=$ENV{"form.homework_edit_$Apache::lonxml::curdepth"};
342: return $result;
1.2 albertel 343: }
344:
1.15 albertel 345: # Returns a 1 if the token has been modified and you should rebuild the tag
1.12 albertel 346: # side-effects, will modify the $token if new values are found
347: sub get_new_args {
348: my ($token,$parstack,$safeeval,@args)=@_;
349: my $rebuild=0;
350: foreach my $arg (@args) {
1.20 albertel 351: #just want the string that it was set to
352: my $value=$token->[2]->{$arg};
1.12 albertel 353: my $newvalue=$ENV{"form.$Apache::lonxml::curdepth.$arg"};
354: &Apache::lonxml::debug(" for:$arg: cur is :$value: new is :$newvalue:");
355: if ($value ne $newvalue) {
356: $token->[2]->{$arg}=$newvalue;
357: $rebuild=1;
358: }
359: }
360: return $rebuild;
361: }
362:
1.15 albertel 363: # looks for /> on start tags
1.12 albertel 364: sub rebuild_tag {
365: my ($token) = @_;
366: my $result;
367: if ($token->[0] eq 'S') {
368: $result = '<'.$token->[1];
369: while (my ($key,$val)= each(%{$token->[2]})) {
1.20 albertel 370: $val=~s:^\s+|\s+$::g;
1.17 albertel 371: $val=~s:"::g; #"
1.12 albertel 372: &Apache::lonxml::debug("setting :$key: to :$val:");
373: $result.=' '.$key.'="'.$val.'"';
374: }
1.15 albertel 375: if ($token->[4] =~ m:/>$:) {
376: $result.=' />';
377: } else {
378: $result.='>';
379: }
1.12 albertel 380: } elsif ( $token->[0] eq 'E' ) {
381: $result = '</'.$token->[1].'>';
382: }
383: return $result;
384: }
1.13 albertel 385:
386: sub text_arg {
387: my ($description,$name,$token,$size) = @_;
388: my $result;
389: if (!defined $size) { $size=20; }
390: my $arg=$token->[2]{$name};
391: $result=$description.'<input name="'."$Apache::lonxml::curdepth.$name".
392: '" type="text" value="'.$arg.'" size="'.$size.'" />';
393: return $result;
394: }
395:
396: sub select_arg {
397: my ($description,$name,$list,$token) = @_;
398: my $result;
399: my $optionlist="";
400: my $selected=$token->[2]{$name};
401: foreach my $option (@$list) {
402: if ( $selected eq $option ) {
403: $optionlist.="<option selected=\"on\">$option</option>\n";
404: } else {
405: $optionlist.="<option>$option</option>\n";
406: }
407: }
408: $result.=$description.'<select name="'."$Apache::lonxml::curdepth.$name".'">
409: '.$optionlist.'
1.27 matthew 410: </select>';
1.13 albertel 411: return $result;
412: }
413:
1.19 albertel 414: sub select_or_text_arg {
415: my ($description,$name,$list,$token,$size) = @_;
416: my $result;
417: my $optionlist="";
418: my $found=0;
419: my $selected=$token->[2]{$name};
420: foreach my $option (@$list) {
421: if ( $selected eq $option ) {
422: $optionlist.="<option selected=\"on\">$option</option>\n";
423: $found=1;
424: } else {
425: $optionlist.="<option>$option</option>\n";
426: }
427: }
428: $optionlist.="<option value=\"TYPEDINVALUE\">Type in value</option>\n";
429: if ($found) {
430: $result.=$description.'<select name="'."$Apache::lonxml::curdepth.$name".'">
431: '.$optionlist.'
1.27 matthew 432: </select>';
1.19 albertel 433: } else {
434: $result.=&text_arg($description,$name,$token,$size);
435: }
436: return $result;
437: }
1.29 matthew 438:
439: #----------------------------------------------------- browse
440: sub browse {
441: # insert a link to call up the filesystem browser (lonindexer)
1.30 matthew 442: $_ = shift;
1.29 matthew 443: my $form = 'lonhomework';
1.30 matthew 444: my $element = &Apache::lonnet::escape("$Apache::lonxml::curdepth.$_");
1.29 matthew 445: my $result = <<"ENDBUTTON";
446: <a href=\"javascript:openbrowser('$form','$element')\"\>Browse</a>
447: ENDBUTTON
448: return $result;
449: }
450:
1.30 matthew 451: #----------------------------------------------------- browse
452: sub search {
453: # insert a link to call up the filesystem browser (lonindexer)
454: $_ = shift;
455: my $form = 'lonhomework';
456: my $element = &Apache::lonnet::escape("$Apache::lonxml::curdepth.$_");
457: my $result = <<"ENDBUTTON";
458: <a href=\"javascript:opensearcher('$form','$element')\"\>Search</a>
459: ENDBUTTON
460: return $result;
461: }
462:
463:
1.1 albertel 464: 1;
465: __END__
1.26 harris41 466:
467: =head1 NAME
468:
469: Apache::edit - edit mode helpers
470:
471: =head1 SYNOPSIS
472:
473: Invoked by many homework and xml related modules.
474:
475: &Apache::edit::SUBROUTINENAME(ARGUMENTS);
476:
477: =head1 INTRODUCTION
478:
479: This module outputs HTML syntax helpful for the rendering of edit
480: mode interfaces.
481:
482: This is part of the LearningOnline Network with CAPA project
483: described at http://www.lon-capa.org.
484:
485: =head1 HANDLER SUBROUTINE
486:
487: There is no handler subroutine.
488:
489: =head1 OTHER SUBROUTINES
490:
491: =over 4
492:
493: =item *
494:
495: initialize_edit() : initialize edit (set colordepth to zero)
496:
497: =item *
498:
499: tag_start($target,$token,$description) : provide deletion and insertion lists
500: for the manipulation of a start tag; return a scalar string
501:
502: =item *
503:
504: tag_end($target,$token,$description) : ending syntax corresponding to
505: &tag_start. return a scalar string.
506:
507: =item *
508:
509: start_table($token) : start table; update colordepth; return scalar string.
510:
511: =item *
512:
513: end_table() : reduce color depth; end table; return scalar string
1.27 matthew 514:
515: =item *
516:
517: start_spanning_row() : start a new table row spanning the 'edit' environment.
518:
519: =item *
520:
521: start_row() : start a new table row and element.
522:
523: =item *
524:
525: end_row() : end current table element and row.
1.26 harris41 526:
527: =item *
528:
529: movebuttons($target,$token) : move-up and move-down buttons; return scalar
530: string
531:
532: =item *
533:
534: deletelist($target,$token) : provide a yes option in an HTML select element;
535: return scalar string
536:
537: =item *
538:
539: handle_delete($space,$target,$token,$tagstack,$parstack,$parser,$safeeval,
540: $style) : respond to a user delete request by passing relevant stack
541: and array information to various rendering functions; return a scalar string
542:
543: =item *
544:
545: get_insert_list($token) : provide an insertion list based on possibilities
546: from lonxml; return a scalar string
547:
548: =item *
549:
550: insertlist($target,$token) : api that uses get_insert_list;
551: return a scalar string
552:
553: =item *
554:
555: handleinsert($token) : provide an insertion list based on possibilities
556: from lonxml; return a scalar string
557:
558: =item *
559:
560: get_insert_list($token) : provide an insertion list based on possibilities
561: from lonxml; return a scalar string
1.29 matthew 562:
563: =item *
564: browse($elementname) : provide a link which will open up the filesystem
565: browser (lonindexer) and, once a file is selected, place the result in
1.30 matthew 566: the form element $elementname.
567:
568: =item *
569: search($elementname) : provide a link which will open up the filesystem
570: searcher (lonsearchcat) and, once a file is selected, place the result in
1.29 matthew 571: the form element $elementname.
1.31 matthew 572:
1.34 ! harris41 573: =item *
1.32 albertel 574: editline(tag,data,description,size): Provide a <input type="text" ../> for
1.31 matthew 575: single-line text entry. This is to be used for text enclosed by tags, not
576: arguements/parameters associated with a tag.
1.26 harris41 577:
578: =back
579:
580: incomplete...
581:
582: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to edit.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / homework