[BACK]Return to structuretags.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / homework

Diff for /loncom/homework/structuretags.pm between versions 1.490 and 1.497.2.4

version 1.490, 2011/07/04 13:01:57 version 1.497.2.4, 2011/12/14 11:56:08
Line 69  BEGIN { Line 69  BEGIN {
     &Apache::lonxml::register('Apache::structuretags',('block','languageblock','translated','instructorcomment','while','randomlist','problem','library','web','tex','part','preduedate','postanswerdate','solved','notsolved','problemtype','startpartmarker','startouttext','endpartmarker','endouttext','simpleeditbutton','definetag'));      &Apache::lonxml::register('Apache::structuretags',('block','languageblock','translated','instructorcomment','while','randomlist','problem','library','web','tex','part','preduedate','postanswerdate','solved','notsolved','problemtype','startpartmarker','startouttext','endpartmarker','endouttext','simpleeditbutton','definetag'));
 }  }
   
   
   #---------------------------------------------------------------------------------
   # 
   #  This section of code deals with hyphenation management.
   #  We must do three things:
   #  - keep track fo the desired languages to alter the header.
   #  - provide hyphenation selection as needed by each language that appears in the
   #    text.
   #  - Provide the header text needed to make available the desired hyphenations.
   #
   #
   
   # Hash whose keys are the languages encountered in the document/resource.
   #
   
   my %languages_required;
   ##
   #   Given a language selection as input returns a chunk of LaTeX that
   #   selects the required hyphenator.
   #
   #  @param language - the language being selected.
   #  @return string
   #  @retval The LaTeX needed to select the hyphenation appropriate to the language. 
   #   
   sub select_hyphenation {
       my $language  = shift;
   
       $language = &Apache::loncommon::latex_language($language); # Translate -> latex language.
   
       # If there is no latex language there's not much we can do:
   
       if ($language) {
    &require_language($language);
    my $babel_hyphenation = "\\select_language{$language}";
   
    return $babel_hyphenation;
       } else {
    return '';
       }
   }
   ##
   #  Clears the set of languages required by the document being rendered.
   #
   sub clear_required_languages {
       %languages_required = ();
   }
   ##
   # Allows an external client of this module to register a need for a language:
   #
   # @param LaTeX language required:
   #
   sub require_language {
       my $language = shift;
   
       $languages_required{$language} = 1;
   }
   
   ##
   # Provides the header for babel that indicates the languages
   # the document requires.
   # @return string
   # @retval \usepackage[lang1,lang2...]{babel}
   # @retval ''   if there are no languages_required.
   sub languages_header {
   
       my $header    ='';
       my @languages = keys(%languages_required);
   
       # Only generate the header if there are languages:
   
       if (scalar @languages) {
    my $language_list = join(',', (@languages));
    $header  = '\usepackage['.$language_list."]{babel}\n";
       }
   
       return $header;
   }
   
   #----------------------------------------------------------------------------------
   
 sub start_web {  sub start_web {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
     if ($target ne 'edit' && $target ne 'modified') {      if ($target ne 'edit' && $target ne 'modified') {
Line 129  sub homework_js { Line 209  sub homework_js {
  <<'JS';   <<'JS';
 <script type="text/javascript">  <script type="text/javascript">
 // <![CDATA[  // <![CDATA[
 function setSubmittedPart (part) {  function setSubmittedPart (part,prefix) {
    this.document.lonhomework.submitted.value="part_"+part;      if (typeof(prefix) == 'undefined') {
           this.document.lonhomework.submitted.value="part_"+part;
       } else {
           for (var i=0;i<this.document.lonhomework.elements.length;i++) {
               if (this.document.lonhomework.elements[i].name == prefix+'submitted') {
                   this.document.lonhomework.elements[i].value="part_"+part;
               }
           }
       }
 }  }
   
 function image_response_click (which, e) {  function image_response_click (which, e) {
Line 164  function setmode(form,probmode) { Line 252  function setmode(form,probmode) {
 ENDSCRIPT  ENDSCRIPT
 }  }
   
 sub file_delchk_js {  
     my $delfilewarn = &mt('You have indicated you wish to remove some files previously included in your submission.').'\\n'.  
                       &mt('Continue submission with these files removed?');  
     return <<"ENDSCRIPT";  
 <script type="text/javascript">  
 // <![CDATA[  
 function file_deletion_check(formname) {  
     var elemnum = formname.elements.length;  
     if (elemnum == 0) {  
         return true;  
     }  
     var str = new RegExp("^HWFILE.+_delete\$");  
     var delboxes = new Array();  
     for (var i=0; i<formname.elements.length; i++) {  
         var id = formname.elements[i].id;  
         if (id != '') {  
             if (str.test(id)) {  
                 if (formname.elements[i].type == 'checkbox') {  
                     if (formname.elements[i].checked) {  
                         delboxes.push(id);  
                     }  
                 }  
             }  
         }  
     }  
     if (delboxes.length > 0) {  
         if (confirm("$delfilewarn")) {  
             return true;  
         } else {  
             for (var j=0; j<delboxes.length; j++) {  
                 formname.elements[delboxes[j]].checked = false;  
             }  
             return false;  
         }  
     } else {  
         return true;  
     }  
 }  
 // ]]>  
 </script>  
 ENDSCRIPT  
 }  
   
 sub page_start {  sub page_start {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$name,      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$name,
  $extra_head)=@_;   $extra_head)=@_;
Line 232  sub page_start { Line 277  sub page_start {
         $extra_head .= &Apache::lonhtmlcommon::htmlareaselectactive(\%textarea_args);          $extra_head .= &Apache::lonhtmlcommon::htmlareaselectactive(\%textarea_args);
     }      }
     my $is_task = ($env{'request.uri'} =~ /\.task$/);      my $is_task = ($env{'request.uri'} =~ /\.task$/);
       my $needs_upload;
       my ($symb)= &Apache::lonnet::whichuser();
       my ($map,$resid,$resurl)=&Apache::lonnet::decode_symb($symb);
     if ($is_task) {      if ($is_task) {
         $extra_head .= &file_delchk_js();          $extra_head .= &Apache::lonhtmlcommon::file_submissionchk_js();
       } else {
           if (&Apache::lonnet::EXT("resource.$Apache::inputtags::part.uploadedfiletypes") ne '') {
               unless ($env{'request.state'} eq 'construct') {
                   my $navmap = Apache::lonnavmaps::navmap->new();
                   if (ref($navmap)) {
                       my $mapres = $navmap->getResourceByUrl($map);
                       my $is_page;
                       if (ref($mapres)) {
                           $is_page = $mapres->is_page();
                       }
                       unless ($is_page) {
                           $needs_upload = 1;
                       }
                   }
               }
           } else {
               unless ($env{'request.state'} eq 'construct') {
                   my $navmap = Apache::lonnavmaps::navmap->new();
                   if (ref($navmap)) {
                       my $mapres = $navmap->getResourceByUrl($map);
                       my $is_page;
                       if (ref($mapres)) {
                           $is_page = $mapres->is_page();
                       }
                       unless ($is_page) {
                           my $res = $navmap->getBySymb($symb);
                           if (ref($res)) {
                               my $partlist = $res->parts();
                               if (ref($partlist) eq 'ARRAY') {
                                   foreach my $part (@{$partlist}) {
                                       my @types = $res->responseType($part);
                                       my @ids = $res->responseIds($part);
                                       for (my $i=0; $i < scalar(@ids); $i++) {
                                           if ($types[$i] eq 'essay') {
                                               my $partid = $part.'_'.$ids[$i];
                                               if (&Apache::lonnet::EXT("resource.$partid.uploadedfiletypes") ne '') {
                                                   $needs_upload = 1;
                                                   last;
                                               }
                                           }
                                       }
                                   }
                               } 
                           }
                       }
                   }
               }
           }
           if ($needs_upload) {
               $extra_head .= &Apache::lonhtmlcommon::file_submissionchk_js();
           }
     }      }
   
     my %body_args;      my %body_args;
Line 264  sub page_start { Line 363  sub page_start {
         &Apache::lonhtmlcommon::clear_breadcrumbs();          &Apache::lonhtmlcommon::clear_breadcrumbs();
         &Apache::lonhtmlcommon::add_breadcrumb({          &Apache::lonhtmlcommon::add_breadcrumb({
             'text'  => 'Construction Space',              'text'  => 'Construction Space',
             'href'  => &Apache::loncommon::authorspace(),              'href'  => &Apache::loncommon::authorspace($env{'request.uri'}),
         });          });
         # breadcrumbs (and tools) will be created           # breadcrumbs (and tools) will be created 
         # in start_page->bodytag->innerregister          # in start_page->bodytag->innerregister
Line 316  sub page_start { Line 415  sub page_start {
     if (!defined($found{'body'}) && $env{'request.state'} ne 'construct') {      if (!defined($found{'body'}) && $env{'request.state'} ne 'construct') {
  $page_start .= &Apache::lonxml::message_location();   $page_start .= &Apache::lonxml::message_location();
     }      }
       
     my $form_tag_start;      my $form_tag_start;
     if (!defined($found{'form'})) {      if (!defined($found{'form'})) {
  $form_tag_start='<form name="lonhomework" enctype="multipart/form-data" method="post" action="';   $form_tag_start='<form name="lonhomework" enctype="multipart/form-data" method="post" action="';
Line 327  sub page_start { Line 425  sub page_start {
  if ($target eq 'edit') {   if ($target eq 'edit') {
     $form_tag_start.=&Apache::edit::form_change_detection();      $form_tag_start.=&Apache::edit::form_change_detection();
  }   }
         if ($is_task) {          my ($symb,$courseid,$udom,$uname)=&Apache::lonnet::whichuser();
             $form_tag_start .= ' onsubmit="return file_deletion_check(this);"';          my ($path,$multiresp) = 
               &Apache::loncommon::get_turnedin_filepath($symb,$uname,$udom);
           if (($is_task) || ($needs_upload)) {
               $form_tag_start .= ' onsubmit="return file_submission_check(this,'."'$path','$multiresp'".');"';
         }          }
  $form_tag_start.='>'."\n";   $form_tag_start.='>'."\n";
   
Line 1290  sub end_problem { Line 1391  sub end_problem {
  } else {   } else {
     $frontmatter.= $begin_doc.$toc_line;      $frontmatter.= $begin_doc.$toc_line;
     if ($Apache::lonhomework::type eq 'exam' and $allow_print_points==1) {       if ($Apache::lonhomework::type eq 'exam' and $allow_print_points==1) { 
  $frontmatter .= '\fbox{\textit{'.$weight.' pt}}';   $frontmatter .= '\fbox{\textit{'.&mt('[quant,_1,pt,pt]',$weight ).'}}';
     }      }
  }   }
     } else {      } else {
Line 1300  sub end_problem { Line 1401  sub end_problem {
     if (not $env{'request.symb'} =~ m/\.page_/) {      if (not $env{'request.symb'} =~ m/\.page_/) {
  $frontmatter .= $begin_doc.$toc_line;   $frontmatter .= $begin_doc.$toc_line;
  if (($Apache::lonhomework::type eq 'exam') and ($allow_print_points==1)) {    if (($Apache::lonhomework::type eq 'exam') and ($allow_print_points==1)) { 
     $frontmatter .= '\fbox{\textit{'.$weight.' pt}}';      $frontmatter .= '\fbox{\textit{'.&mt('[quant,_1,pt,pt]',$weight ).'}}';
  }   }
     } else {      } else {
  $frontmatter .= '\vskip 1mm \\\\\\\\'.$startminipage;   $frontmatter .= '\vskip 1mm \\\\\\\\'.$startminipage;
Line 1518  sub end_block { Line 1619  sub end_block {
     }      }
     return $result;      return $result;
 }  }
   #
   #  <languageblock [include='lang1,lang2...'] [exclude='lang1,lang2...']>
   #  ...
   #  </languageblock>
   #
   #   This declares the intent to provide content that can be rendered in the
   #   set of languages in the include specificatino but not in the exclude
   #   specification.  If a currently preferred language is in the include list
   #   the content in the <languageblock>...</languageblock> is rendered
   #   If the currently preferred language is in the exclude list,
   #   the content in the <languageblock>..></languageblock is not rendered.
   #
   #   Pathalogical case handling:
   #     - Include specified, without the preferred language but exclude  specified
   #       also without the preferred langauge results in rendering the block.
   #     - Exclude specified without include and excluden not containing a 
   #       preferred language renders the block.
   #     - Include and exclude both specifying the preferred language does not
   #       render the block.
   #     - If neither include/exclude is specified, the block gets rendered.
   #
   #  This tag has no effect when target is in {edit, modified}
   #
 sub start_languageblock {  sub start_languageblock {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   
     my $result;      my $result = '';
   
     if ($target eq 'web' || $target eq 'grade'   || $target eq 'answer' ||      if ($target eq 'web' || $target eq 'grade'   || $target eq 'answer' ||
  $target eq 'tex' || $target eq 'analyze' || $target eq 'webgrade') {   $target eq 'tex' || $target eq 'analyze' || $target eq 'webgrade') {
  my $include = $token->[2]->{'include'};   my $include = $token->[2]->{'include'};
  my $exclude = $token->[2]->{'exclude'};   my $exclude = $token->[2]->{'exclude'};
         my @preferred_languages=&Apache::lonlocal::preferred_languages();          my @preferred_languages=&Apache::lonlocal::preferred_languages();
 # This should not even happen, since we should at least have the server language  
         if (!$preferred_languages[0]) { $preferred_languages[0]='en'; }          # This should not even happen, since we should at least have the server language
 # Now loop over all languages in order of preference  
           if (!$preferred_languages[0]) { 
       $preferred_languages[0]='en'; 
    }
   
           # Now loop over all languages in order of preference
   
    my $render;
         foreach my $preferred_language (@preferred_languages) {          foreach my $preferred_language (@preferred_languages) {
 # If the languageblock has no arguments, show the contents  
            $result=1;      # If neither include/nor exlude is present the block is going
       # to get rendered.
   
            my $found=0;             my $found=0;
 # Do we have an include argument?             $render=1;
   
      #  If include is specified,  don't render the block
      #  unless the preferred language is included in the set.
   
    if ($include) {     if ($include) {
 # If include is specified, by default, don't render the block                $render=0;
               $result=0;  
               foreach my $included_language (split(/\,/,$include)) {                foreach my $included_language (split(/\,/,$include)) {
 # ... but if my preferred language is included, render it  
                  if ($included_language eq $preferred_language) {                   if ($included_language eq $preferred_language) {
                     $result=1;                       $render=1; 
                     $found=1;                       $found=1; 
       last; # Only need to find the first.
                  }                   }
               }                }
    }     }
 # Do we have an exclude argument?             # Do we have an exclude argument?
      # If so, and one of the languages matches a preferred language
      # inhibit rendering the block.  Note that in the pathalogical case the
      # author has specified a preferred language in both the include and exclude
      # attribte exclude is preferred.  
   
            if ($exclude) {             if ($exclude) {
               $result=1;                $render=1;
               foreach my $excluded_language (split(/\,/,$exclude)) {                foreach my $excluded_language (split(/\,/,$exclude)) {
                  if ($excluded_language eq $preferred_language) {                   if ($excluded_language eq $preferred_language) {
                     $result=0;                      $render=0;
                     $found=1;                      $found=1;
       last; # Only need to find the first.
                  }                   }
               }                }
    }     }
            if ($found) { last; }             if ($found) { 
          last; # Done on any match of include or exclude.
      }
         }          }
  if ( ! $result ) {   # If $render not true skip the entire block until </languageblock>
    #
   
    if ( ! $render ) {
     my $skip=&Apache::lonxml::get_all_text("/languageblock",$parser,      my $skip=&Apache::lonxml::get_all_text("/languageblock",$parser,
    $style);     $style);
     &Apache::lonxml::debug("skipping ahead :$skip: $$parser[-1]");      &Apache::lonxml::debug("skipping ahead :$skip: $$parser[-1]");
  }   }
  $result='';   # If $render is true, we've not skipped the contents of the <languageglock>
    # and the normal loncapa processing flow will render it as a matter of course.
   
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result .=&Apache::edit::tag_start($target,$token);   $result .=&Apache::edit::tag_start($target,$token);
  $result .=&Apache::edit::text_arg(&mt('Include Language:'),'include',   $result .=&Apache::edit::text_arg(&mt('Include Language:'),'include',
Line 1590  sub end_languageblock { Line 1738  sub end_languageblock {
     }      }
     return $result;      return $result;
 }  }
   #  languagblock specific tags:
 {  {
     my %available_texts;      # For chunks of a resource that has translations, this hash contains
       # the translations available indexed by language name.
       #
   
       my %available_texts;       
   
       # <translated> starts a block of a resource that has multiple translations.
       # See the <lang> tag as well.
       # When </translated> is encountered if there is a translation for the 
       # currently preferred language, that is rendered inthe web/tex/webgrade
       # targets.  Otherwise, the default text is rendered.
       #
       # Note that <lang> is only registered for the duration of the 
       #  <translated>...</translated> block 
       #
       # Pathalogical case handling:
       #   - If there is no <lang> that specifies a 'default' and there is no
       #     translation that matches a preferred language, nothing is rendered.
       #   - Nested <translated>...</translated> might be linguistically supported by
       #     XML due to the stack nature of tag registration(?) however the rendered
       #     output will be incorrect because there is only one %available_texts
       #     has and end_translated clears it.
       #   - Material outside of a <lang>...</lang> block within the
       #     <translated>...<translated> block won't render either e.g.:
       #    <translated>
       #      The following will be in your preferred langauge:
       #      <lang which='en'>
       #         This section in english
       #      </lang>
       #      <lang which='sgeiso'>
       #         Hier es ist auf Deutsch.
       #      </lang>
       #      <lang which='sfriso'>
       #         En Francais
       #      </lang>
       #    </translated>
       #
       #    The introductory text prior to the first <lang> tag is not rendered.
       #
     sub start_translated {      sub start_translated {
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  &Apache::lonxml::register('Apache::structuretags',('lang'));   &Apache::lonxml::register('Apache::structuretags',('lang'));
Line 1611  sub end_languageblock { Line 1797  sub end_languageblock {
     my @possibilities = keys(%available_texts);      my @possibilities = keys(%available_texts);
     my $which =       my $which = 
  &Apache::loncommon::languages(\@possibilities) || 'default';   &Apache::loncommon::languages(\@possibilities) || 'default';
     $result = $available_texts{$which};      if ($target eq 'tex') {
    $result = &select_hyphenation($which);
       }
       $result .= $available_texts{$which};
  }   }
  undef(%available_texts);   undef(%available_texts);
  &Apache::lonxml::deregister('Apache::structuretags',('lang'));   &Apache::lonxml::deregister('Apache::structuretags',('lang'));
  return $result;   return $result;
     }      }
   
       # <lang [which='language-name'] [other='lang1,lang2...']>  
       #  Specifies that the block contained within it is a translation 
       #  for a specific language specified by the 'which' attribute. The
       #   'other' attribute can be used by itself or in conjunction with
       #   which to specify this tag _may_ be used as a translation for some
       #   list of languages. e.g.:  <lang which='senisoUS' other='senisoCA,senisoAU,seniso'>
       #   specifying that the block provides a translation for US (primary)
       #   Canadian, Australian and UK Englush.
       #   
       # Comment: this seems a bit silly why not just support a list of languages
       #           e.g. <lang which='l1,l2...'> and ditch the other attribute?
       #
       #  Effect:
       #    The material within the <lang>..</lang> block is stored in the
       #    specified set of $available_texts hash entries, the appropriate one
       #    is selected at </translated> time.
       #
       #  Pathalogical case handling:
       #    If a language occurs multiple times within a <translated> block,
       #    only the last one is rendered e.g.:
       #
       #    <translated>
       #       <lang which='senisoUS', other='senisoCA,senisoAU,seniso'>
       #          Red green color blindness is quite common affecting about 7.8% of 
       #          the male population, but onloy about .65% of the female population.
       #       </lang>
       #          Red green colour blindness is quite common affecting about 7.8% of 
       #          the male population, but onloy about .65% of the female population.
       #       <lang which='seniso', other='senisoCA,senisoAU'>
       #     </translated>
       #
       #    renders the correct spelling of color (colour) for people who have specified
       #    a preferred language that is one of the British Commonwealth languages
       #    even though those are also listed as valid selections for the US english
       #    <lang> block.
       #
     sub start_lang {      sub start_lang {
  my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;   my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
  if ($target eq 'web' || $target eq 'grade'   || $target eq 'answer' ||   if ($target eq 'web' || $target eq 'grade'   || $target eq 'answer' ||
Line 1649  sub end_languageblock { Line 1873  sub end_languageblock {
  }   }
  return '';   return '';
     }      }
 }  } # end langauge block specific tags.
   
   
 sub start_instructorcomment {  sub start_instructorcomment {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
Line 1991  sub start_part { Line 2216  sub start_part {
  $allow_print_points=0;   $allow_print_points=0;
     }      }
     if (($Apache::lonhomework::type eq 'exam') && ($allow_print_points)) {       if (($Apache::lonhomework::type eq 'exam') && ($allow_print_points)) { 
  $result .= '\vskip 10mm\fbox{\textit{'.$weight.' pt}}';   $result .= '\vskip 10mm\fbox{\textit{'.&mt('[quant,_1,pt,pt]',$weight ).'}}';
   
     }      }
  } elsif ($target eq 'web') {   } elsif ($target eq 'web') {
Removed from v.1.490  
changed lines
  Added in v.1.497.2.4

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