Diff for /loncom/interface/lonprintout.pm between versions 1.568.2.5 and 1.569

version 1.568.2.5, 2010/05/11 12:22:10 version 1.569, 2010/01/12 10:40:01
Line 306  sub set_font_size { Line 306  sub set_font_size {
   
     my ($text) = @_;      my ($text) = @_;
   
     # There appear to be cases where the font directive is empty.. in which      $text =~ s/\\begin{document}/\\begin{document}{\\$font_size/;
     # case the first substituion would  insert a spurious \ oh happy day.  
     # as this has been the cause of much mystery and hair pulling _sigh_  
   
     if ($font_size ne '') {  
   
         $text =~ s/\\begin{document}/\\begin{document}{\\$font_size/;  
     }  
     $text =~ s/\\end{document}/}\\end{document}/;      $text =~ s/\\end{document}/}\\end{document}/;
     return $text;      return $text;
   
   
 }  }
   
 # include_pdf - PDF files are included into the   # include_pdf - PDF files are included into the 
Line 499  sub printf_style_subst { Line 494  sub printf_style_subst {
 #     %a    - Assignment name.  #     %a    - Assignment name.
 #     %c    - Course name.  #     %c    - Course name.
 #     %n    - Student name.  #     %n    - Student name.
   #     %s    - The section if it is supplied.
 #  #
 sub format_page_header {  sub format_page_header {
     my ($width, $format, $assignment, $course, $student) = @_;      my ($width, $format, $assignment, $course, $student, $section) = @_;
   
   
   
     $width = &recalcto_mm($width); # Get width in mm.      $width = &recalcto_mm($width); # Get width in mm.
     my $chars_per_line = int($width/2);   # Character/textline.      my $chars_per_line = int($width/1.6);   # Character/textline.
   
     #  Default format?      #  Default format?
   
Line 520  sub format_page_header { Line 518  sub format_page_header {
  # - Allow the assignment to be 2 lines (wrapped).   # - Allow the assignment to be 2 lines (wrapped).
  #   #
   
         my $firstline = "$student $course";  
         if (length($firstline) > $chars_per_line) {  
             my $lastchar = $chars_per_line - length($student) - 1;  
             if ($lastchar > 0) {  
                 $course = substr($course, 0, $lastchar);  
             } else {            # Nothing left of course:  
                 $course = '';  
             }  
         }  
         if (length($assignment) > $chars_per_line) {  
             $assignment = substr($assignment, 0, $chars_per_line);  
         }  
   
         $format =  "\\textbf{$student} $course \\hfill \\thepage \\\\ \\textit{$assignment}";   my $name_length    = int($chars_per_line *3 /4);
    my $sec_length     = int($chars_per_line / 5);
   
    $format  = "%$name_length".'n';
   
    if ($section) {
       $format .=  ' - Sec: '."%$sec_length".'s';
    }
   
    $format .= '\\\\%c \\\\ %a';
           
   
     } else {  
         # An open question is how to handle long user formatted page headers...  
         # A possible future is to support e.g. %na so that the user can control  
         # the truncation of the elements that can appear in the header.  
         #  
         $format =  &printf_style_subst("a", $format, $assignment);  
         $format =  &printf_style_subst("c", $format, $course);  
         $format =  &printf_style_subst("n", $format, $student);  
   
         # If the user put %'s in the format string, they  must be escaped  
         # to \% else LaTeX will think they are comments and terminate  
         # the line.. which is bad!!!  
     }      }
       # An open question is how to handle long user formatted page headers...
       # A possible future is to support e.g. %na so that the user can control
       # the truncation of the elements that can appear in the header.
       #
       $format =  &printf_style_subst("a", $format, $assignment);
       $format =  &printf_style_subst("c", $format, $course);
       $format =  &printf_style_subst("n", $format, $student);
       $format =  &printf_style_subst("s", $format, $section);
       
       
       # If the user put %'s in the format string, they  must be escaped
       # to \% else LaTeX will think they are comments and terminate
       # the line.. which is bad!!!
           
       # If the user has role author, $course and $assignment are empty so
       # there is '\\ \\ ' in the page header. That's cause a error in LaTeX
       if($format =~ /\\\\\s\\\\\s/) {
           #TODO find sensible caption for page header
           my $testPrintout = '\\\\'.&mt('Construction Space').' \\\\'.&mt('Test-Printout ');
           $format =~ s/\\\\\s\\\\\s/$testPrintout/;
       }
       #
       #  We're going to trust LaTeX to break lines appropriately, but
       #  we'll truncate anything that's more than 3 lines worth of
       # text.  This is also assuming (which will probably end badly)
       # nobody's going to embed LaTeX control sequences in the title
       # header or rather that those control sequences won't get broken
       # by the stuff below.
       #
       my $total_length = 3*$chars_per_line;
       if (length($format) > $total_length) {
    $format = substr($format, 0, $total_length);
       }
   
   
     return $format;      return $format;
       
 }  }
   
 #  #
Line 1245  sub get_course { Line 1265  sub get_course {
     my $courseidinfo;      my $courseidinfo;
     if (defined($env{'request.course.id'})) {      if (defined($env{'request.course.id'})) {
  $courseidinfo = &Apache::lonxml::latex_special_symbols(&unescape($env{'course.'.$env{'request.course.id'}.'.description'}),'header');   $courseidinfo = &Apache::lonxml::latex_special_symbols(&unescape($env{'course.'.$env{'request.course.id'}.'.description'}),'header');
    my $sec = $env{'request.course.sec'};
       
     }      }
     return $courseidinfo;      return $courseidinfo;
 }  }
Line 1267  sub page_format_transformation { Line 1289  sub page_format_transformation {
   
     my $name = &get_name();      my $name = &get_name();
     my $courseidinfo = &get_course();      my $courseidinfo = &get_course();
     if (defined($courseidinfo)) { $courseidinfo=' - '.$courseidinfo }  
     my $header_text  = $parmhash{'print_header_format'};      my $header_text  = $parmhash{'print_header_format'};
     $header_text     = &format_page_header($textwidth, $header_text, $assignment,      $header_text     = &format_page_header($textwidth, $header_text, $assignment,
    $courseidinfo, $name);     $courseidinfo, $name);
Line 1288  sub page_format_transformation { Line 1309  sub page_format_transformation {
     $text =~ s/\\pagestyle{fancy}\\rhead{}\\chead{}\s*\\begin{document}/\\textheight = $textheight\\oddsidemargin = $evenoffset\n\\evensidemargin = $evenoffset $topmargintoinsert\\textwidth= $textwidth\\newlength{\\minipagewidth}\n\\setlength{\\minipagewidth}{\\textwidth\/\$number_of_columns-0\.2cm}\\renewcommand{\\ref}{\\keephidden\}\\pagestyle{fancy}\\rhead{}\\chead{}\\usepackage{booktabs}\\begin{document}\\voffset=-0\.8cm\n\\setcounter{page}{1}  \\vskip 5 mm\n /;      $text =~ s/\\pagestyle{fancy}\\rhead{}\\chead{}\s*\\begin{document}/\\textheight = $textheight\\oddsidemargin = $evenoffset\n\\evensidemargin = $evenoffset $topmargintoinsert\\textwidth= $textwidth\\newlength{\\minipagewidth}\n\\setlength{\\minipagewidth}{\\textwidth\/\$number_of_columns-0\.2cm}\\renewcommand{\\ref}{\\keephidden\}\\pagestyle{fancy}\\rhead{}\\chead{}\\usepackage{booktabs}\\begin{document}\\voffset=-0\.8cm\n\\setcounter{page}{1}  \\vskip 5 mm\n /;
  }   }
  if ($papersize eq 'a4') {   if ($papersize eq 'a4') {
             my $papersize_text;      $text =~ s/(\\begin{document})/$1\\special{papersize=210mm,297mm}/;
             if ($perm{'pav'}) {  
                 $papersize_text = '\\special{papersize=210mm,297mm}';  
             } else {  
                 $papersize_text = '\special{papersize=210mm,297mm}';  
             }  
             $text =~ s/(\\begin{document})/$1$papersize_text/;  
  }   }
     }      }
     if ($tableofcontents eq 'yes') {$text=~s/(\\setcounter\{page\}\{1\})/$1 \\tableofcontents\\newpage /;}      if ($tableofcontents eq 'yes') {$text=~s/(\\setcounter\{page\}\{1\})/$1 \\tableofcontents\\newpage /;}
Line 1566  sub print_page_in_course { Line 1581  sub print_page_in_course {
   
     $form{'grade_target'}  = 'tex';      $form{'grade_target'}  = 'tex';
     $form{'textwidth'}    = &get_textwidth($helper, $LaTeXwidth);      $form{'textwidth'}    = &get_textwidth($helper, $LaTeXwidth);
     $form{'pdfFormFields'} = 'no';      $form{'pdfFormFiels'} = $pdfFormFields; # 
     $form{'showallfoils'} = $helper->{'VARS'}->{'showallfoils'};          $form{'showallfoils'} = $helper->{'VARS'}->{'showallfoils'};    
           
     $form{'problem_split'}=$parmhash{'problem_stream_switch'};      $form{'problem_split'}=$parmhash{'problem_stream_switch'};
Line 1742  sub recently_generated { Line 1757  sub recently_generated {
 #  #
 #  #
 # use Data::Dumper;  # use Data::Dumper;
 #sub dump_helper_vars {  # sub dump_helper_vars {
 #    my ($helper) = @_;  #    my ($helper) = @_;
 #    my $helpervars = Dumper($helper->{'VARS'});  #    my $helpervars = Dumper($helper->{'VARS'});
 #    &Apache::lonnet::logthis("Dump of helper vars:\n $helpervars");  #    &Apache::lonnet::logthis("Dump of helper vars:\n $helpervars");
Line 1757  sub get_page_breaks  { Line 1772  sub get_page_breaks  {
     }      }
     return %page_breaks;      return %page_breaks;
 }  }
   # 
   #   Returns text to insert for any extra vskip prior to the resource.
   #   Parameters:
   #     helper   - Reference to the helper object driving the printout.
   #     resource - Identifies the resource about to be printed.
   #
   #   This is done as follows:
   #    POSSIBLE_RESOURCES has the list of possible resources.
   #    EXTRASPACE         has the list of extra space values.
   #    
   #    The resource is found in the POSSIBLE_RESOURCES to get the index
   #    of the EXTRASPACE value.
   #
   #   In order to speed this up for lengthy printouts, the first time,
   #   POSSIBLE_RESOURCES is turned into a look up hash and
   #   EXTRASPACE is turned into an array.
   #
   
   
   my %possible_resources;
   my @extraspace;
   my $skips_loaded       = 0;
   
   #  Function to load the skips hash and array
   
   sub load_skips {
   
       my ($helper)  = @_;
   
       #  If this is the first time, unrap the resources and extra spaces:
   
       if (!$skips_loaded) {
    @extraspace = (split(/\|\|\|/, $helper->{'VARS'}->{'EXTRASPACE'}));
    my @resource_list = (split(/\|\|\|/, $helper->{'VARS'}->{'POSSIBLE_RESOURCES'}));
    my $i = 0;
    foreach my $resource (@resource_list) {
       $possible_resources{$resource} = $i;
       $i++;
    }
    $skips_loaded = 1;
       }
   }
   
   sub get_extra_vspaces {
       my ($helper, $resource) = @_;
   
       &load_skips($helper);
   
       #  Lookup the resource in the possible resources hash.. that is the index
       # into the extraspace array that gives us either an empty string or
       # the number of mm to skip:
   
       my $index = $possible_resources{$resource};
       my $skip  = $extraspace[$index];
   
       my $result = '';
       if ($skip ne '') {
    $result = '\vskip '.$skip.' mm';
       }
       return $result;
   
   
   }
   
   #
   #  The resource chooser part of the helper needs more than just
   #  the value of the extraspaces var to recover the value into a text
   #  field option.  This sub produces the required format for the saved var:
   #  specifically 
   #    ||| separated fields of the form resourcename=value
   #
   #  Parameters:
   #    $helper     - Refers to the helper we are configuring
   #  Implicit input:
   #     $helper->{'VARS'}->{'EXTRASPACE'}  - the spaces helper var has the text field
   #                                          value.
   #     $helper->{'VARS'}->{'POSSIBLE_RESOURCES'}  - has the list of resources. |||
   #                                          separated of course.
   #  Implicit outputs:
   #     $env{'form.extrapsace'}
   #
   sub set_form_extraspace {
       my ($helper) = @_;
   
       # the most convenient way to do this is to drive from the skips arrays/hash.
       # may not be the fastest, but this is once per print request so it's not so
       # speed critical:
   
       &load_skips($helper);
   
       my $result = '';
   
       foreach my $resource (keys(%possible_resources)) {
    my $vskip = $extraspace[$possible_resources{$resource}];
    $result  .= $resource .'=' . $vskip . '|||';
       }
   
       $env{'form.extraspace'}  = $result;
       return $result;
       
   }
   
 #  Output a sequence (recursively if neeed)  #  Output a sequence (recursively if neeed)
 #  from construction space.  #  from construction space.
Line 1928  ENDPART Line 2044  ENDPART
     # indexed by symb and contains 1's for each break.      # indexed by symb and contains 1's for each break.
   
     $env{'form.pagebreaks'}  = $helper->{'VARS'}->{'FINISHPAGE'};      $env{'form.pagebreaks'}  = $helper->{'VARS'}->{'FINISHPAGE'};
       &set_form_extraspace($helper);
     $env{'form.lastprinttype'} = $helper->{'VARS'}->{'PRINT_TYPE'};       $env{'form.lastprinttype'} = $helper->{'VARS'}->{'PRINT_TYPE'}; 
     &Apache::loncommon::store_course_settings('print',      &Apache::loncommon::store_course_settings('print',
       {'pagebreaks'    => 'scalar',        {'pagebreaks'    => 'scalar',
          'extraspace'    => 'scalar',
        'lastprinttype' => 'scalar'});         'lastprinttype' => 'scalar'});
   
     my %page_breaks  = &get_page_breaks($helper);      my %page_breaks  = &get_page_breaks($helper);
   
     my $format_from_helper = $helper->{'VARS'}->{'FORMAT'};      my $format_from_helper = $helper->{'VARS'}->{'FORMAT'};
Line 1957  ENDPART Line 2074  ENDPART
     my %form;      my %form;
     $form{'grade_target'} = 'tex';      $form{'grade_target'} = 'tex';
     $form{'textwidth'}    = &get_textwidth($helper, $LaTeXwidth);      $form{'textwidth'}    = &get_textwidth($helper, $LaTeXwidth);
     $form{'pdfFormFields'} = 'no';      $form{'pdfFormFields'} = $pdfFormFields;
   
     # If form.showallfoils is set, then request all foils be shown:      # If form.showallfoils is set, then request all foils be shown:
     # privilege will be enforced both by not allowing the       # privilege will be enforced both by not allowing the 
Line 2196  ENDPART Line 2313  ENDPART
     $result.="\\newpage\n";      $result.="\\newpage\n";
  }   }
     }      }
       $result .= &get_extra_vspaces($helper, $master_seq[$i]);
     my ($sequence,$middle_thingy,$urlp)=&Apache::lonnet::decode_symb($master_seq[$i]);      my ($sequence,$middle_thingy,$urlp)=&Apache::lonnet::decode_symb($master_seq[$i]);
     $urlp=&Apache::lonnet::clutter($urlp);      $urlp=&Apache::lonnet::clutter($urlp);
     $form{'symb'}=$master_seq[$i];      $form{'symb'}=$master_seq[$i];
Line 2267  ENDPART Line 2385  ENDPART
  if (($selectionmade == 4) and ($assignment ne $prevassignment)) {   if (($selectionmade == 4) and ($assignment ne $prevassignment)) {
     my $name = &get_name();      my $name = &get_name();
     my $courseidinfo = &get_course();      my $courseidinfo = &get_course();
     if (defined($courseidinfo)) { $courseidinfo=' - '.$courseidinfo }  
     $prevassignment=$assignment;      $prevassignment=$assignment;
     my $header_text = $parmhash{'print_header_format'};      my $header_text = $parmhash{'print_header_format'};
     $header_text    = &format_page_header($textwidth, $header_text,      $header_text    = &format_page_header($textwidth, $header_text,
Line 2798  sub print_resources { Line 2915  sub print_resources {
  $current_output.= "\\newpage\n";   $current_output.= "\\newpage\n";
     }      }
  }   }
    $current_output .= &get_extra_vspaces($helper, $curresline);
  $i++;   $i++;
   
  if ( !($type eq 'problems' &&    if ( !($type eq 'problems' && 
Line 2890  sub print_resources { Line 3008  sub print_resources {
   
   
     my $courseidinfo = &get_course();      my $courseidinfo = &get_course();
     if (defined($courseidinfo)) { $courseidinfo=' - '.$courseidinfo }  
     if ($usersection ne '') {$courseidinfo.=' - Sec. '.$usersection}  
     my $currentassignment=&Apache::lonxml::latex_special_symbols($helper->{VARS}->{'assignment'},'header');      my $currentassignment=&Apache::lonxml::latex_special_symbols($helper->{VARS}->{'assignment'},'header');
     my $header_line =      my $header_line =
  &format_page_header($LaTeXwidth, $parmhash{'print_header_format'},   &format_page_header($LaTeXwidth, $parmhash{'print_header_format'},
     $currentassignment, $courseidinfo, $fullname);      $currentassignment, $courseidinfo, $fullname, $usersection);
     my $header_start = ($columns_in_format == 1) ? '\lhead'      my $header_start = ($columns_in_format == 1) ? '\lhead'
                                          : '\fancyhead[LO]';                                           : '\fancyhead[LO]';
     $header_line = $header_start.'{'.$header_line.'}';      $header_line = $header_start.'{'.$header_line.'}';
Line 3047  sub printHelper { Line 3163  sub printHelper {
     $helper->declareVar('PRINT_TYPE');      $helper->declareVar('PRINT_TYPE');
     $helper->declareVar("showallfoils");      $helper->declareVar("showallfoils");
     $helper->declareVar("STUDENTS");      $helper->declareVar("STUDENTS");
       $helper->declareVar("EXTRASPACE");
   
         
   
   
     #  The page breaks can get loaded initially from the course environment:      #  The page breaks and extra spaces
       #  can get loaded initially from the course environment:
     # But we only do this in the initial state so that they are allowed to change.      # But we only do this in the initial state so that they are allowed to change.
     #      #
   
     # $helper->{VARS}->{FINISHPAGE} = '';  
           
     &Apache::loncommon::restore_course_settings('print',      &Apache::loncommon::restore_course_settings('print',
  {'pagebreaks'  => 'scalar',   {'pagebreaks'  => 'scalar',
    'extraspace'  => 'scalar',
          'lastprinttype' => 'scalar'});           'lastprinttype' => 'scalar'});
           
     # This will persistently load in the data we want from the      # This will persistently load in the data we want from the
Line 3069  sub printHelper { Line 3186  sub printHelper {
  if (!defined ($env{"form.CURRENT_STATE"})) {   if (!defined ($env{"form.CURRENT_STATE"})) {
           
     $helper->{VARS}->{FINISHPAGE} = $env{'form.pagebreaks'};      $helper->{VARS}->{FINISHPAGE} = $env{'form.pagebreaks'};
       $helper->{VARS}->{EXTRASPACE} = $env{'form.extraspace'};
  } else {   } else {
     my $state = $env{"form.CURRENT_STATE"};      my $state = $env{"form.CURRENT_STATE"};
     if ($state eq "START") {      if ($state eq "START") {
  $helper->{VARS}->{FINISHPAGE} = $env{'form.pagebreaks'};   $helper->{VARS}->{FINISHPAGE} = $env{'form.pagebreaks'};
    $helper->{VARS}->{EXTRASPACE} = $env{'form.extraspace'};
     }      }
  }   }
   
Line 3191  sub printHelper { Line 3310  sub printHelper {
     if ($perm{'pav'}) {      if ($perm{'pav'}) {
  $start_new_option =    $start_new_option = 
     "<option text='".&mt('Start new page<br />before selected').      "<option text='".&mt('Start new page<br />before selected').
     "' variable='FINISHPAGE' />";      "' variable='FINISHPAGE' />".
       "<option text='".&mt('Extra space(mm)<br />before selected').
       "' variable='EXTRASPACE' type='text' />" .
       "<option " .
       "' variable='POSSIBLE_RESOURCES' type='hidden' />";
   
     }      }
   
     # If not construction space user can print the components of a page:      # If not construction space user can print the components of a page:
Line 3369  ALL_PROBLEMS Line 3493  ALL_PROBLEMS
   'multichoice="1" addstatus="1" closeallpages="1"',    'multichoice="1" addstatus="1" closeallpages="1"',
   'RESOURCES',     'RESOURCES', 
   'PRINT_FORMATTING',    'PRINT_FORMATTING',
   $map,    '',
   $isProblem, '', $symbFilter,    $isProblem, '', $symbFilter,
   $start_new_option);    $start_new_option);
  $resource_selector .=  <<RESOURCE_SELECTOR;   $resource_selector .=  <<RESOURCE_SELECTOR;
Line 4018  sub render { Line 4142  sub render {
     my $PaperType=&mt('Paper type');      my $PaperType=&mt('Paper type');
     my $landscape=&mt('Landscape');      my $landscape=&mt('Landscape');
     my $portrait=&mt('Portrait');      my $portrait=&mt('Portrait');
       my $pdfFormLabel=&mt('PDF-Formfields');
       my $with=&mt('with Formfields');
       my $without=&mt('without Formfields');
           
   
     $result.='<h3>'.&mt('Layout Options').'</h3>'      $result.='<h3>'.&mt('Layout Options').'</h3>'
Line 4026  sub render { Line 4153  sub render {
             .'<th>'.$PageLayout.'</th>'              .'<th>'.$PageLayout.'</th>'
             .'<th>'.$NumberOfColumns.'</th>'              .'<th>'.$NumberOfColumns.'</th>'
             .'<th>'.$PaperType.'</th>'              .'<th>'.$PaperType.'</th>'
               .'<th>'.$pdfFormLabel.'</th>'
             .&Apache::loncommon::end_data_table_header_row()              .&Apache::loncommon::end_data_table_header_row()
             .&Apache::loncommon::start_data_table_row()              .&Apache::loncommon::start_data_table_row()
     .'<td>'      .'<td>'
Line 4065  sub render { Line 4193  sub render {
     }      }
     $result .= <<HTML;      $result .= <<HTML;
         </select>          </select>
         <hidden name="${var}.pdfFormFields" value="no" />      </td>
       <td align='center'>
           <select name='${var}.pdfFormFields'>
               <option selected="selected" value="no">$without</option>
               <option value="yes">$with</option>
           </select>
     </td>      </td>
 HTML  HTML
     $result.=&Apache::loncommon::end_data_table_row()      $result.=&Apache::loncommon::end_data_table_row()

Removed from v.1.568.2.5  
changed lines
  Added in v.1.569


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