--- loncom/xml/londefdef.pm 2008/10/27 19:15:35 1.395 +++ loncom/xml/londefdef.pm 2010/08/20 21:20:24 1.403.4.2 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Tags Default Definition Module # -# $Id: londefdef.pm,v 1.395 2008/10/27 19:15:35 raeburn Exp $ +# $Id: londefdef.pm,v 1.403.4.2 2010/08/20 21:20:24 raeburn Exp $ # # # Copyright Michigan State University Board of Trustees @@ -42,6 +42,7 @@ package Apache::londefdef; use Apache::lonnet; use strict; use Apache::lonxml; +use Apache::lontable; use Apache::File(); use Image::Magick; use Apache::lonmenu(); @@ -58,20 +59,7 @@ BEGIN { } -# -# Dumps all elements of the table structure. -# Need this 'cause evidently when given an array, Data::Dumper only seems -# to dump element 0. -# -#sub debug_dump_table { -# my $lastrow = $#Apache::londefdef::table; -# &Apache::lonnet::logthis("Dumping table: Last row index: $lastrow"); -# my $row; -# for ($row =0; $row <= $lastrow; $row++ ) { -# my $text = Dumper($Apache::londefdef::table[$row]); -# &Apache::lonnet::logthis("table [ $row ]".$text); -# } -#} + sub initialize_londefdef { $Apache::londefdef::TD_redirection=0; @Apache::londefdef::table = (); @@ -188,41 +176,8 @@ sub start_html { if ($target eq 'web' || $target eq 'edit' || $target eq 'webgrade' ) { # start_body() takes care of emitting the } elsif ($target eq 'tex') { - $currentstring .= - '\documentclass[letterpaper,twoside]{article}\raggedbottom'; - if (($env{'form.latex_type'}=~'batchmode') || - (!$env{'request.role.adv'})) {$currentstring .='\batchmode';} - $currentstring .= '\newcommand{\keephidden}[1]{}'. - '\renewcommand{\deg}{$^{\circ}$}'. - '\usepackage{multirow}'. - '\usepackage{longtable}'. - '\usepackage{textcomp}'. - '\usepackage{makeidx}'. - '\usepackage[dvips]{graphicx}'. - '\usepackage{wrapfig}'. - '\usepackage{picins}'. - '\usepackage[T1]{fontenc}'."\n". - '\usepackage{lmodern}'."\n". - '\usepackage[postscript]{ucs}'."\n". - '\usepackage[utf8x]{inputenc}'."\n". - '\usepackage{pifont}' ."\n". - '\usepackage{latexsym}'."\n". - '\usepackage{epsfig}'. - '\usepackage{calc}'. - '\usepackage{amsmath}'. - '\usepackage{amssymb}'. - '\usepackage{amsfonts}'. - '\usepackage{amsthm}'. - '\usepackage{amscd}'; - - if($env{'form.pdfFormFields'} eq 'yes') { - $currentstring .= '\usepackage{hyperref}'. - '\usepackage{eforms}'. - '\usepackage{tabularx}'; - } - $currentstring .= '\newenvironment{choicelist}{\begin{list}{}{\setlength{\rightmargin}{0in}\setlength{\leftmargin}{0.13in}\setlength{\topsep}{0.05in}\setlength{\itemsep}{0.022in}\setlength{\parsep}{0in}\setlength{\belowdisplayskip}{0.04in}\setlength{\abovedisplayskip}{0.05in}\setlength{\abovedisplayshortskip}{-0.04in}\setlength{\belowdisplayshortskip}{0.04in}}}{\end{list}}'. - '\renewenvironment{theindex}{\begin{list}{}{{\vskip 1mm \noindent \large\textbf{Index}} \newline \setlength{\rightmargin}{0in}\setlength{\leftmargin}{0.13in}\setlength{\topsep}{0.01in}\setlength{\itemsep}{0.1in}\setlength{\parsep}{-0.02in}\setlength{\belowdisplayskip}{0.01in}\setlength{\abovedisplayskip}{0.01in}\setlength{\abovedisplayshortskip}{-0.04in}\setlength{\belowdisplayshortskip}{0.01in}}}{\end{list}}'; + $currentstring .= &latex_header(); } return $currentstring; } @@ -597,19 +552,24 @@ sub start_body { } $currentstring.=&Apache::lonxml::message_location(); } elsif ($target eq 'tex') { - $currentstring = '\begin{document}'; + $currentstring = ''; # '\begin{document}' is in header. } return $currentstring; } sub edit_controls { + my ($nochgview) = @_; my $result .= '
-
+
'; + unless ($nochgview) { + $result .= '
'. &Apache::lonxml::renderingoptions().' -
+
'; + } + $result .= '

'; @@ -1657,6 +1617,26 @@ sub start_a { my $href=&Apache::lonxml::get_param('href',$parstack,$safeeval, undef,1); $currentstring=&Apache::lonenc::encrypt_ref($token,{'href'=>$href}); + if ($href =~ /\S/) { + if ($href !~ m{^https?://}) { + my $url=&Apache::lonnet::hreflocation('',$env{'request.filename'}); + my $linkurl; + if ($href =~ m{^/uploaded/}) { + $linkurl = $href; + } elsif ($href =~ m{^[^/]}) { + my $path = $url; + $path =~ s{[^/]*$}{}; + $linkurl = $path.$href; + } + if ($linkurl =~ m{^/uploaded/}) { + if (!&Apache::lonnet::allowed('bre',$linkurl)) { + if (&Apache::lonnet::is_on_map($url)) { + &Apache::lonxml::extlink($linkurl); + } + } + } + } + } } return $currentstring; } @@ -2018,7 +1998,8 @@ sub end_dd { # only way I could think of to allow

in # bodies # -#list of supported attributes: border,width,TeXwidth +#list of supported attributes: border,width,TeXwidth,TeXtheme +# align sub start_table { my ($target,$token,$tagstack,$parstack,$parser,$safeeval) = @_; my $textwidth = ''; @@ -2026,6 +2007,70 @@ sub start_table { if ($target eq 'web' || $target eq 'webgrade') { $currentstring .= $token->[4]; } elsif ($target eq 'tex') { + &disable_para(); # Can't have paras in a table. + + + # New table code: + + # Get the parameters that we can do something about: + + my $border = &Apache::lonxml::get_param('border', $parstack, $safeeval, undef, 0); + my $width = &Apache::lonxml::get_param('TeXwidth', $parstack, $safeeval, undef, 0); + my $theme = &Apache::lonxml::get_param('TeXtheme', $parstack, $safeeval, undef, 0); + my $align = &Apache::lonxml::get_param('align', $parstack, $safeeval, undef, 0); + my $cell_border = &Apache::lonxml::get_param('rules', $parstack, $safeeval, undef, 0); + + # The only thing that needs any figuring out is the width.. and then only if it is + # a percent. If not it's assumed to be some valid TeX measurement unit e.g. 3.0cm + # + + my $table = new Apache::lontable(); + if ((defined $border) && ($border > 0)) { + # &Apache::lonnet::logthis("Turning on table borders: $border"); + $table->table_border(1); + if ($cell_border ne 'none') { + $table->cell_border(1); # html specs that border turns on both...unless rules='none'. + } + } + # Only all or nothing for cell borders for now: + + if ((defined $cell_border) && ($cell_border ne 'none')) { + # &Apache::lonnet::logthis("Turning on cell borders: $cell_border"); + $table->cell_border(1); + } + if (defined $theme) { + $table->theme($theme); + } + if (defined $align) { + $table->alignment($align); + } + + # Missing width is most of page width + + if (!(defined $width)) { + $width = '70%'; + } + + # If a percentage, need to calculate what this means in terms of + # page width: + + if ($width =~ /%$/) { + my $textwidth = &recalc($env{'form.textwidth'}); # Page width in mm. + $width =~ s/%//; + $width = $width * $textwidth / 100.0; + $width .= " mm"; + $table->width($width); + } + + push(@Apache::londefdef::table, $table); + $currentstring.=' \keephidden{NEW TABLE ENTRY}'; + + #-------------------------------------------------------- + # Old table code here. + #-------------------------------------------------------- + + + if (0) { push(@Apache::londefdef::table, {}); $Apache::londefdef::table[-1]{'row_number'} = -1; #maximum table's width (default coincides with text line length) @@ -2100,7 +2145,7 @@ sub start_table { $Apache::londefdef::table[-1]{'content'}=[]; $Apache::londefdef::table[-1]{'align'}=[]; $currentstring.=' \keephidden{NEW TABLE ENTRY}'; - + } } return $currentstring; @@ -2112,6 +2157,20 @@ sub end_table { if ($target eq 'web' || $target eq 'webgrade') { $currentstring = $token->[2]; } elsif ($target eq 'tex') { + + + # New table code: + + my $table = pop(@Apache::londefdef::table); + my $t = $table->generate(); + $currentstring = $t->generate_string(); + &enable_para(); + #-------------------------------------------------------------- + # Old table code: + #-------------------------------------------------------------- + + if (0) { + my $border = &Apache::lonxml::get_param('border',$parstack,$safeeval); my $inmemory = ''; my $output = ''; @@ -2524,6 +2583,8 @@ sub end_table { pop @Apache::londefdef::table; undef @Apache::londefdef::table; } + } + &enable_para(); } } return $currentstring; @@ -2536,6 +2597,19 @@ sub start_tr { if ($target eq 'web' || $target eq 'webgrade') { $currentstring = $token->[4]; } elsif ($target eq 'tex') { + + my $align = &Apache::lonxml::get_param('align', $parstack, $safeeval, undef, 1); + $Apache::londefdef::table[-1]->start_row(); + + if ($align ne '') { + $Apache::londefdef::table[-1]->configure_row({default_halign => $align}); + } + + #--------------------------------------------------------------- + # Old table code. + #--------------------------------------------------------------- + + if (0) { $Apache::londefdef::table[-1]{'row_number'}++; my $alignchar=&Apache::lonxml::get_param('align',$parstack,$safeeval,undef,1); if ($alignchar ne '') { @@ -2554,6 +2628,7 @@ sub start_tr { push @ {$Apache::londefdef::table[-1]{'minlen'}}, []; push @ {$Apache::londefdef::table[-1]{'maxlen'}}, []; push @ {$Apache::londefdef::table[-1]{'content'}}, []; + } } return $currentstring; } @@ -2564,6 +2639,19 @@ sub end_tr { if ($target eq 'web' || $target eq 'webgrade') { $currentstring .= $token->[2]; } elsif ($target eq 'tex') { + + # In case the user is missing a or tag: + + if ($Apache::londefdef::TD_redirection) { + &end_td_tex($parstack,$parser,$safeeval); + } + $Apache::londefdef::table[-1]->end_row(); + + #----------------------------------------------- + # Old table code + #----------------------------------------------- + + if (0) { if ($Apache::londefdef::TD_redirection) { &end_td_tex($parstack,$parser,$safeeval); } @@ -2572,7 +2660,7 @@ sub end_tr { if ($Apache::londefdef::table[-1]{'prior_columns'} > $Apache::londefdef::table[-1]{'counter_columns'}) { $Apache::londefdef::table[-1]{'counter_columns'} = $Apache::londefdef::table[-1]{'prior_columns'}; } - + } } @@ -2608,9 +2696,50 @@ sub tag_check { } return ''; } + +# +# Factor out cell configuration hash generation: +# + +sub cell_config_hash { + my ($align, $rowspan, $colspan) = @_; + my %config; + if ($align ne '') { + $config{'halign'} = $align; + } + if ($colspan ne "") { + $config{'colspan'} = $colspan; + } + if ($rowspan ne '') { + $config{'rowspan'} = $rowspan; + } + return \%config; +} sub start_td_tex { my ($parstack,$parser,$safeeval) = @_; + + # At this stage, an empty cell is created with the + # appropriate rowspan/colspan and alignment + # attributes, but empty of text. end_td_tex will + # fetch the contents from the recursive parse and + # fill the cell with them: + my $align = &Apache::lonxml::get_param('align', $parstack, $safeeval, undef, 1); + my $rowspan = &Apache::lonxml::get_param('rowspan', $parstack, $safeeval, undef, 1); + my $colspan = &Apache::lonxml::get_param('colspan', $parstack, $safeeval, undef, 1); + + my $config = &cell_config_hash($align, $rowspan, $colspan); + + my $table = $Apache::londefdef::table[-1]; + $table->add_cell('', $config); + + + #------------------------------------------------ + # Old table code. + #------------------------------------------------ + + if (0) { + my $alignchar = substr(&Apache::lonxml::get_param('align',$parstack,$safeeval,undef,1),0,1); if ($alignchar eq '') { $alignchar = $Apache::londefdef::table[-1]{'rows'}[-1]; @@ -2623,11 +2752,22 @@ sub start_td_tex { $current_length=~/(\d+\.?\d*)/; push @ {$Apache::londefdef::table[-1]{'TeXlen'}[$Apache::londefdef::table[-1]{'row_number'}] },$1; } + } &Apache::lonxml::startredirection(); return ''; } sub end_td_tex { + + my $text = &Apache::lonxml::endredirection(); + my $table = $Apache::londefdef::table[-1]; + $table->append_cell_text($text); + + #------------------------------------------------- + # Old table code + #------------------------------------------------- + + if (0) { my ($parstack,$parser,$safeeval) = @_; my $current_row = $Apache::londefdef::table[-1]{'row_number'}; my $current_column = $Apache::londefdef::table[-1]{'counter_columns'}; @@ -2792,7 +2932,7 @@ sub end_td_tex { } - + } return ''; } @@ -2841,6 +2981,24 @@ sub tagg_check { sub start_th_tex { my ($parstack,$parser,$safeeval) = @_; + + my $alignment = &Apache::lonxml::get_param('align', $parstack, $safeeval, undef,1); + my $rowspan = &Apache::lonxml::get_param('rowspan', $parstack, $safeeval, undef, 1); + my $colspan = &Apache::lonxml::get_param('colspan', $parstack, $safeeval, undef, 1); + + my $config = cell_config_hash($alignment, $rowspan, $colspan); + my $table = $Apache::londefdef::table[-1]; + $table->add_cell('\textbf{', $config); + + #------------------------------------------------------------------------------------- + # + # Old table code. + # + #-------------------------------------------------------------------------------------- + + if (0) { + + my $alignchar = substr(&Apache::lonxml::get_param('align',$parstack,$safeeval,undef,1),0,1); if ($alignchar eq '') { $alignchar = $Apache::londefdef::table[-1]{'rows'}[-1]; @@ -2853,12 +3011,26 @@ sub start_th_tex { $current_length=~/(\d+\.?\d*)/; push @ {$Apache::londefdef::table[-1]{'TeXlen'}[$Apache::londefdef::table[-1]{'row_number'}] },$1; } + } + + # Accept xml until the tag. + &Apache::lonxml::startredirection(); return ''; } sub end_th_tex { my ($parstack,$parser,$safeeval) = @_; + + my $table = $Apache::londefdef::table[-1]; + my $text = &Apache::lonxml::endredirection(); + $table->append_cell_text($text.'}'); + + #----------------------------------------------------------------------------- + # Old table code: + #----------------------------------------------------------------------------- + + if (0) { my $current_row = $Apache::londefdef::table[-1]{'row_number'}; my $data=&Apache::lonxml::endredirection(); my $TeXwidth=&Apache::lonxml::get_param('TeXwidth',$parstack,$safeeval,undef,0); @@ -2923,6 +3095,7 @@ sub end_th_tex { #make data bold $data='\textbf{'.$data.'}'; push @ {$Apache::londefdef::table[-1]{'content'}[-1] },$data; + } return''; } @@ -3082,21 +3255,28 @@ sub start_img { ['','bottom','middle','top','left','right'],$token,5); $currentstring .=&Apache::edit::select_arg('TeXwrap:', 'TeXwrap', ['', 'none','parbox', 'parpic', 'wrapfigure'], $token, 2); + my $alt= &Apache::lonxml::get_param('alt',$parstack,$safeeval); + my $enc= &Apache::lonxml::get_param('encrypturl',$parstack,$safeeval); + $currentstring .=&Apache::edit::select_arg('Encrypt URL:','encrypturl', ['no','yes'], $token, 2); + if (($alt=~/\S/) && (lc($enc) eq 'yes')) { + $currentstring.='
'.&mt('Warning: the description "[_1]" will be available, even for encrypted URL',$alt).'
'; + } $currentstring .=&Apache::edit::end_row().&Apache::edit::start_spanning_row(); my $src= &Apache::lonxml::get_param('src',$parstack,$safeeval); - my $alt= &Apache::lonxml::get_param('alt',$parstack,$safeeval); my $width= &Apache::lonxml::get_param('width',$parstack,$safeeval); my $height= &Apache::lonxml::get_param('height',$parstack,$safeeval); if ($token->[2]{'src'}=~/\$/) { - $currentstring.='Variable image source'; - } else { + $currentstring.=&mt('Variable image source'); + } elsif ($token->[2]{'src'}=~/\S/) { $currentstring .= ''.$alt.''s.). -# Sample usage: -# if (is_inside_of($tagstack "table")) { -# # I'm in a table.... -# } + sub is_inside_of { my ($tagstack, $tag) = @_; my @stack = @$tagstack; @@ -4661,5 +4797,168 @@ sub is_inside_of { } +# +# This sub provides the typical LaTeX prefix matter for tex output: +# +sub latex_header { + my ($mode) = @_; + my $currentstring = ''; + + $currentstring .= + "\n% &Apache::lonxml::londefdef \n" . + '\documentclass[letterpaper,twoside]{article}\raggedbottom'; + if (($env{'form.latex_type'}=~'batchmode') || + (!$env{'request.role.adv'}) || + ($mode eq 'batchmode')) {$currentstring .='\batchmode';} + $currentstring .= '\newcommand{\keephidden}[1]{}'. + '\renewcommand{\deg}{$^{\circ}$}'. + '\usepackage{multirow}'. + '\usepackage{longtable}'. + '\usepackage{textcomp}'. + '\usepackage{makeidx}'. + '\usepackage[dvips]{graphicx}'. + '\usepackage{wrapfig}'. + '\usepackage{picins}'. + '\usepackage[T1]{fontenc}'."\n". + '\usepackage{lmodern}'."\n". + '\usepackage[postscript]{ucs}'."\n". + '\usepackage[utf8x]{inputenc}'."\n". + '\usepackage{pifont}' ."\n". + '\usepackage{latexsym}'."\n". + '\usepackage{epsfig}'. + "\\usepackage{xtab}\n". + "\\usepackage{tabularx}\n". + "\\usepackage{booktabs}\n". + "\\usepackage{array}\n". + "\\usepackage{colortbl}\n". + "\\usepackage{xcolor}\n". + '\usepackage{calc}'. + '\usepackage{amsmath}'. + '\usepackage{amssymb}'. + '\usepackage{amsfonts}'. + '\usepackage{amsthm}'. + '\usepackage{amscd}' + .'\usepackage{picins}\usepackage{calc}'."\n". # From lonprintout.pm + '\usepackage[T1]{fontenc}'."\n". + '\usepackage{lmodern}'."\n". + '\usepackage[postscript]{ucs}'."\n". + '\usepackage[utf8x]{inputenc}'."\n". + '\usepackage{pifont}' . "\n"; + + if($env{'form.pdfFormFields'} eq 'yes') { + $currentstring .= '\usepackage{hyperref}'. + '\usepackage{eforms}'. + '\usepackage{tabularx}'; + } + + $currentstring .= '\newenvironment{choicelist}{\begin{list}{}{\setlength{\rightmargin}{0in}\setlength{\leftmargin}{0.13in}\setlength{\topsep}{0.05in}\setlength{\itemsep}{0.022in}\setlength{\parsep}{0in}\setlength{\belowdisplayskip}{0.04in}\setlength{\abovedisplayskip}{0.05in}\setlength{\abovedisplayshortskip}{-0.04in}\setlength{\belowdisplayshortskip}{0.04in}}}{\end{list}}'. + '\renewenvironment{theindex}{\begin{list}{}{{\vskip 1mm \noindent \large\textbf{Index}} \newline \setlength{\rightmargin}{0in}\setlength{\leftmargin}{0.13in}\setlength{\topsep}{0.01in}\setlength{\itemsep}{0.1in}\setlength{\parsep}{-0.02in}\setlength{\belowdisplayskip}{0.01in}\setlength{\abovedisplayskip}{0.01in}\setlength{\abovedisplayshortskip}{-0.04in}\setlength{\belowdisplayshortskip}{0.01in}}}{\end{list}}'; + $currentstring .= '\begin{document}'; + + return $currentstring; + +} + +=pod + +=head1 NAME + +Apache::londefdef.pm + +=head1 SYNOPSIS + +Tags Default Definition Module + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + + +=head1 NOTABLE SUBROUTINES + +=over + +=item start_hideweboutput() + +=item end_hideweboutput() + +=item image_replication() + +=item resize_image() + + Get correct sizing parameter for an image given + it's initial ht. and wid. This allows sizing of + images that are generated on-the-fly (e.g. gnuplot) + as well as serving as a utility for image_size. + + Parameter: + height_param + width_param - Initial picture dimensions. + scaling - A scale factor. + parstack, - the current stack of tag attributes + from the xml parser + safeeval, - pointer to the safespace + depth, - from what level in the stack to look for attributes + (assumes -1 if unspecified) + cis - look for attrubutes case insensitively + (assumes false) + + Returns: + height, width - new dimensions. + +=item image_size() + +=item image_width() + +=item image_height() + +=item get_eps_image() + +=item eps_generation() + +=item file_path() + +=item recalc() + + Converts a measurement in to mm from any of + the other valid LaTeX units of measure. + If the units of measure are missing from the + parameter, it is assumed to be in and returned + with mm units of measure + +=item LATEX_length() + +=item align_latex_image() + + Wrap image 'stuff' inside of the LaTeX required to implement + alignment: + align_tex_image(align, latex_rendering, image) + Where: + align - The HTML alignment specification. + latex_rendering - rendering hint for latex. + image - The LaTeX needed to insert the image itsef. + width,height - dimensions of the image. + Returns: + The 1/2 wrapped image and the stuff required to close the + wrappage. This allows e.g. randomlabel to insert more stuff + into the closure. + + +=item is_inside_of($tagstack, $tag) + This sub returns true if the current state of Xml processing is inside of the tag. + Parameters: + tagstack - The tagstack from the parser. + tag - The tag (without the <>'s.). + Sample usage: + if (is_inside_of($tagstack "table")) { + I'm in a table.... + } + + + +=back + +=cut + + 1; __END__