From: joey Date: Thu, 23 Aug 2007 21:19:21 +0000 (+0000) Subject: rename tex to teximg X-Git-Tag: 2.6~19 X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/commitdiff_plain/8c31a01efa05c4fb821e1364b8792b89852619a3?hp=27d029113faf479464db289a71b98cbf5e672793 rename tex to teximg --- diff --git a/IkiWiki/Plugin/tex.pm b/IkiWiki/Plugin/tex.pm deleted file mode 100644 index 7a95697b9..000000000 --- a/IkiWiki/Plugin/tex.pm +++ /dev/null @@ -1,181 +0,0 @@ -#!/usr/bin/perl -# Licensed under GPL v2 or greater -# (c) 2007 Patrick Winnertz - -package IkiWiki::Plugin::tex; -use warnings; -use strict; -use Digest::MD5 qw(md5_hex); -use File::Temp qw(tempdir); -use URI::Escape qw(uri_escape); -use IkiWiki 2.00; - -sub import { #{{{ - hook(type => "preprocess", id => "tex", call => \&preprocess); -} #}}} - -sub preprocess (@) { #{{{ - my %params = @_; - - my $height = $params{height}; - if (! defined $height || ! length $height) { - $height = 12; - } - else { - $height =~ s#(\d+)#$1#; - } - - my $code = $params{code}; - if (! defined $code && ! length $code) { - return "[[tex ".gettext("missing tex code"). "]]"; - } - - if (check($code)) { - return create($code, check_height($height), \%params); - } - else { - return "[[tex ".gettext("code includes disallowed latex commands"). "]]"; - } -} #}}} - -sub check_height ($) { #{{{ - # Since latex doesn't support unlimited scaling this function - # returns the closest supported size. - my $height =shift; - - my @allowed=(8,9,10,11,12,14,17,20); - - my $ret; - my $fit; - foreach my $val (@allowed) { - my $f = abs($val - $height); - if (! defined($fit) || $f < $fit ) { - $ret=$val; - $fit=$f; - } - } - return $ret; -} #}}} - -sub create ($$$) { #{{{ - # This function calls the image generating function and returns - # the for the generated image. - my $code = shift; - my $height = shift; - my $params = shift; - - if (! defined($height) and not length($height) ) { - $height = 12; - } - - my $digest = md5_hex($code, $height); - - my $teximgdir = "/teximages"; - my $imglink = "$teximgdir/$digest.png"; - my $imglog = "$teximgdir/$digest.log"; - will_render($params->{destpage}, $imglink); - will_render($params->{destpage}, $imglog); - - my $imgurl; - my $logurl; - if (! $params->{preview}) { - $imgurl = urlto($imglink, $params->{destpage}); - $logurl = urlto($imglog, $params->{destpage}); - } - else { - $imgurl="$config{url}/$teximgdir/$digest.png"; - $logurl="$config{url}/$teximgdir/$digest.log"; - } - - if (-e "$config{destdir}/$imglink" || - gen_image($code, $height, $digest, $teximgdir)) { - return qq{}.uri_escape($code).qq{}; - } - else { - return qq{[[tex }.gettext("failed to generate image from code")."]]"; - } -} #}}} - -sub gen_image ($$$$) { #{{{ - # Actually creates the image. - my $code = shift; - my $height = shift; - my $digest = shift; - my $imagedir = shift; - - #TODO This should move into the setup file. - my $tex = '\documentclass['.$height.'pt]{scrartcl}'; - $tex .= '\usepackage[version=3]{mhchem}'; - $tex .= '\usepackage{amsmath}'; - $tex .= '\usepackage{amsfonts}'; - $tex .= '\usepackage{amssymb}'; - $tex .= '\pagestyle{empty}'; - $tex .= '\begin{document}'; - $tex .= '$$'.$code.'$$'; - $tex .= '\end{document}'; - - my $tmp = eval { create_tmp_dir($digest) }; - if (! $@ && - writefile("$digest.tex", $tmp, $tex) && - system("cd $tmp; latex --interaction=nonstopmode $tmp/$digest.tex > /dev/null") == 0 && - system("dvips -E $tmp/$digest.dvi -o $tmp/$digest.ps 2> $tmp/$digest.log") == 0 && - # ensure destination directory exists - writefile("$imagedir/$digest.png", $config{destdir}, "") && - system("convert -density 120 -trim -transparent \"#FFFFFF\" $tmp/$digest.ps $config{destdir}/$imagedir/$digest.png > $tmp/$digest.log") == 0) { - return 1; - } - else { - # store failure log - my $log; - { - open(my $f, '<', "$tmp/$digest.log"); - local $/=undef; - $log = <$f>; - close($f); - } - writefile("$digest.log", "$config{destdir}/$imagedir", $log); - - return 0; - } -} #}}} - -sub create_tmp_dir ($) { #{{{ - # Create a temp directory, it will be removed when ikiwiki exits. - my $base = shift; - - my $template = $base.".XXXXXXXXXX"; - my $tmpdir = tempdir($template, TMPDIR => 1, CLEANUP => 1); - return $tmpdir; -} #}}} - -sub check ($) { #{{{ - # Check if the code is ok - my $code = shift; - - my @badthings = ( - qr/\$\$/, - qr/\\include/, - qr/\\includegraphic/, - qr/\\usepackage/, - qr/\\newcommand/, - qr/\\renewcommand/, - qr/\\def/, - qr/\\input/, - qr/\\open/, - qr/\\loop/, - qr/\\errorstopmode/, - qr/\\scrollmode/, - qr/\\batchmode/, - qr/\\read/, - qr/\\write/, - ); - - foreach my $thing (@badthings) { - if ($code =~ m/$thing/ ) { - return 0; - } - } - return 1; -} #}}} - -1 diff --git a/IkiWiki/Plugin/teximg.pm b/IkiWiki/Plugin/teximg.pm new file mode 100644 index 000000000..1993249eb --- /dev/null +++ b/IkiWiki/Plugin/teximg.pm @@ -0,0 +1,183 @@ +#!/usr/bin/perl +# Licensed under GPL v2 or greater +# (c) 2007 Patrick Winnertz + +package IkiWiki::Plugin::teximg; +use warnings; +use strict; +use Digest::MD5 qw(md5_hex); +use File::Temp qw(tempdir); +use URI::Escape qw(uri_escape); +use IkiWiki 2.00; + +sub import { #{{{ + hook(type => "preprocess", id => "teximg", call => \&preprocess); +} #}}} + +sub preprocess (@) { #{{{ + my %params = @_; + + my $height = $params{height}; + if (! defined $height || ! length $height) { + $height = 12; + } + else { + $height =~ s#(\d+)#$1#; + } + + my $code = $params{code}; + if (! defined $code && ! length $code) { + return "[[teximg ".gettext("missing tex code"). "]]"; + } + + if (check($code)) { + return create($code, check_height($height), \%params); + } + else { + return "[[teximg ".gettext("code includes disallowed latex commands"). "]]"; + } +} #}}} + +sub check_height ($) { #{{{ + # Since latex doesn't support unlimited scaling this function + # returns the closest supported size. + my $height =shift; + + my @allowed=(8,9,10,11,12,14,17,20); + + my $ret; + my $fit; + foreach my $val (@allowed) { + my $f = abs($val - $height); + if (! defined($fit) || $f < $fit ) { + $ret=$val; + $fit=$f; + } + } + return $ret; +} #}}} + +sub create ($$$) { #{{{ + # This function calls the image generating function and returns + # the for the generated image. + my $code = shift; + my $height = shift; + my $params = shift; + + if (! defined($height) and not length($height) ) { + $height = 12; + } + + my $digest = md5_hex($code, $height); + + my $teximgdir = "/teximag"; + my $imglink = "$teximgdir/$digest.png"; + my $imglog = "$teximgdir/$digest.log"; + will_render($params->{destpage}, $imglink); + will_render($params->{destpage}, $imglog); + + my $imgurl; + my $logurl; + if (! $params->{preview}) { + $imgurl = urlto($imglink, $params->{destpage}); + $logurl = urlto($imglog, $params->{destpage}); + } + else { + $imgurl="$config{url}/$teximgdir/$digest.png"; + $logurl="$config{url}/$teximgdir/$digest.log"; + } + + if (-e "$config{destdir}/$imglink" || + gen_image($code, $height, $digest, $teximgdir)) { + return qq{} + .(exists $params{alt} ? $params{alt} : uri_escape($code)) + .qq{}; + } + else { + return qq{[[teximg }.gettext("failed to generate image from code")."]]"; + } +} #}}} + +sub gen_image ($$$$) { #{{{ + # Actually creates the image. + my $code = shift; + my $height = shift; + my $digest = shift; + my $imagedir = shift; + + #TODO This should move into the setup file. + my $tex = '\documentclass['.$height.'pt]{scrartcl}'; + $tex .= '\usepackage[version=3]{mhchem}'; + $tex .= '\usepackage{amsmath}'; + $tex .= '\usepackage{amsfonts}'; + $tex .= '\usepackage{amssymb}'; + $tex .= '\pagestyle{empty}'; + $tex .= '\begin{document}'; + $tex .= '$$'.$code.'$$'; + $tex .= '\end{document}'; + + my $tmp = eval { create_tmp_dir($digest) }; + if (! $@ && + writefile("$digest.tex", $tmp, $tex) && + system("cd $tmp; latex --interaction=nonstopmode $tmp/$digest.tex > /dev/null") == 0 && + system("dvips -E $tmp/$digest.dvi -o $tmp/$digest.ps 2> $tmp/$digest.log") == 0 && + # ensure destination directory exists + writefile("$imagedir/$digest.png", $config{destdir}, "") && + system("convert -density 120 -trim -transparent \"#FFFFFF\" $tmp/$digest.ps $config{destdir}/$imagedir/$digest.png > $tmp/$digest.log") == 0) { + return 1; + } + else { + # store failure log + my $log; + { + open(my $f, '<', "$tmp/$digest.log"); + local $/=undef; + $log = <$f>; + close($f); + } + writefile("$digest.log", "$config{destdir}/$imagedir", $log); + + return 0; + } +} #}}} + +sub create_tmp_dir ($) { #{{{ + # Create a temp directory, it will be removed when ikiwiki exits. + my $base = shift; + + my $template = $base.".XXXXXXXXXX"; + my $tmpdir = tempdir($template, TMPDIR => 1, CLEANUP => 1); + return $tmpdir; +} #}}} + +sub check ($) { #{{{ + # Check if the code is ok + my $code = shift; + + my @badthings = ( + qr/\$\$/, + qr/\\include/, + qr/\\includegraphic/, + qr/\\usepackage/, + qr/\\newcommand/, + qr/\\renewcommand/, + qr/\\def/, + qr/\\input/, + qr/\\open/, + qr/\\loop/, + qr/\\errorstopmode/, + qr/\\scrollmode/, + qr/\\batchmode/, + qr/\\read/, + qr/\\write/, + ); + + foreach my $thing (@badthings) { + if ($code =~ m/$thing/ ) { + return 0; + } + } + return 1; +} #}}} + +1 diff --git a/debian/changelog b/debian/changelog index b057e7c56..1ff492a48 100644 --- a/debian/changelog +++ b/debian/changelog @@ -46,7 +46,7 @@ ikiwiki (2.6) UNRELEASED; urgency=low * Add proper Homepage field to Debian package (needs uber-new dpkg). * Add monotone support, contributed by William Uther. * Avoid ugly gettext messages if LANG is empty. Closes: #439035 - * Added tex plugin to generate images from latex code. + * Added teximg plugin to generate images from latex code. Contributed by Patrick Winnertz as a GSoC project. * Call the formbuilder hook for the edit page. * Call decode_form_utf8 before running formbuilder_setup hooks. diff --git a/doc/plugins/tex.mdwn b/doc/plugins/tex.mdwn deleted file mode 100644 index 52f90f6ab..000000000 --- a/doc/plugins/tex.mdwn +++ /dev/null @@ -1,25 +0,0 @@ -[[template id=plugin name=tex author="[[PatrickWinnertz]]"]] -[[tag type/chrome type/slow]] - -This plugin renders LaTeX formulas into images, which are rendered automatically when you save this site. - -Scaling of this images is of course also possible, possible heights are: - - 8,9,10,11,12,14,17,20 - -But is also work if you pic e.g. another height. The best fitting height is then used to generate the image. - -#Here are some examples how to use this plugin: - - [[tex code="\ce{[Cu(NH3)3]^{2+}}"]] - [[tex code="\frac{1}{2}"]] - [[tex code="E = - \frac{Z^2 \cdot \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]] - -in order to scale this images use height=x: - - [[tex code="\ce{[Cu(NH3)3]^{2+}}" height="17"]] - [[tex code="\ce{[Cu(NH3)3]^{2+}}" height="8"]] - -If no height is choosen the default height 12 is used. - -See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images. \ No newline at end of file diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn new file mode 100644 index 000000000..5c35aa2e8 --- /dev/null +++ b/doc/plugins/teximg.mdwn @@ -0,0 +1,25 @@ +[[template id=plugin name=teximg author="[[PatrickWinnertz]]"]] +[[tag type/chrome type/slow]] + +This plugin renders LaTeX formulas into images. + +## examples + + \[[teximg code="\ce{[Cu(NH3)3]^{2+}}"]] + \[[teximg code="\frac{1}{2}"]] + \[[teximg code="E = - \frac{Z^2 \cdot \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]] + +To scale the image, use height=x: + + \[[teximg code="\ce{[Cu(NH3)3]^{2+}}" height="17"]] + \[[teximg code="\ce{[Cu(NH3)3]^{2+}}" height="8"]] + +If no height is choosen the default height 12 is used. Valid heights are: 8, 9, +10, 11, 12, 14, 17, 20. If another height is entered, the closest available +height is used. + +To add an alt text to the image, use alt="text": + + \[[teximg code="\frac{1}{2}" alt="1/2"]] + +See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images. diff --git a/doc/todo/latex.mdwn b/doc/todo/latex.mdwn index cedf7cbd5..8822bd30b 100644 --- a/doc/todo/latex.mdwn +++ b/doc/todo/latex.mdwn @@ -167,13 +167,16 @@ Okay, the last version of the tex plugin for ikiwiki can be downloaded [here](ht > fixed a bug (the first time it was run, it tried to write the png file > before the teximages/ directory existed) and checked the result in. > -> Can you please flesh out [[plugins/tex]] with +> Can you please flesh out [[plugins/teximg]] with > whatever documentation people who know tex will expect to see? Okay, I'll fill this up today I think with information about the plugin Done. Is that docu fine with you? +>> Perhaps add some documentation about the kind of tex code that can be +>> used, or a link to some documentation so people who don't know latex +>> well can figure this out? > Also, please review my changes. In particular, I changed the @badthings > array to use qr//, which is much clearer, but it needs to be tested that