Annotation of loncom/homework/edit.pm, revision 1.39

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

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