Merge lp:~o-scholder/zim/pyzim-refactor into lp:~jaap.karssenberg/zim/pyzim-refactor

[Olivier Scholder]

Hi Jaap,
Yes my mistake. Sorry. I hope I merge into the right branch now.

I hope you think the tweak is useful. I myself often need wide plots and needed it absolutely.

regards

Olivier

[Jaap Karssenberg (jaap.karssenberg)]

Looks very useful indeed - will merge it. Thanks!

Only wondering about the default - maybe it make sense to not set a default (or make it a preference) and without default simply let R decide the size ?

Btw. thinking about a way to automatically scale all images to window size in the page view, but will be later improvement.

[Olivier Scholder (o-scholder)]

according to:
http://stat.ethz.ch/R-manual/R-devel/library/grDevices/html/png.html
480px is the default size for R.

I guess taking the 480px from the preference is for sure a good idea. So
that everybody can set to the value they like and work with it.

For the resizing, the problem is that each images are not created
on-the-fly by zim. They are converted into picture only once they are
edited. This will makes the auto-resizing to the screen size difficult. We
can implement that in the image module, but the problem with plots is that
they are usually made for a specific width/height ratio and thus automatic
resizing might become annoying.

For the image we have in the source (the saved txt files):

{{PATH-to-myimage.png?width=320}}

we can easily let the user write something like:

{{PATH-to-myimage.png?width=50%}}

and calculate the size of the image on the fly.

what do you think?

2013/12/3 Jaap Karssenberg <email address hidden>

> Looks very useful indeed - will merge it. Thanks!
>
> Only wondering about the default - maybe it make sense to not set a
> default (or make it a preference) and without default simply let R decide
> the size ?
>
> Btw. thinking about a way to automatically scale all images to window size
> in the page view, but will be later improvement.
> --
> https://code.launchpad.net/~o-scholder/zim/pyzim-refactor/+merge/197506
> You are the owner of lp:~o-scholder/zim/pyzim-refactor.
>

Unmerged revisions

683. By Olivier Scholder on 2013-12-03

Add size tweak for GNU-R plugin

=== modified file 'data/manual/Plugins/GNU_R_Plot_Editor.txt'
--- data/manual/Plugins/GNU_R_Plot_Editor.txt	2013-04-13 11:09:42 +0000
+++ data/manual/Plugins/GNU_R_Plot_Editor.txt	2013-12-03 12:08:29 +0000
@@ -39,6 +39,17 @@
 title(main="Maunga Whau Volcano", sub = "col=terrain.colors(100)", font.main=4)
 '''
 
+===== Plot size =====
+
+This plugin will generate an image which is exactly 480x480 pixels. You can tweak the produced image size by incerting a comment in your script:
+
+'''
+# WIDTH = 960
+# HEIGHT = 480
+plot(c(0,1),c(100,328))
+'''
+
+You can define only one of the two variable and the other will be set to the default value of 480 pixels. The line should start with the comment sign '#'. Spaces between words are not important.
 
 ===== Features Available =====
 

=== modified file 'data/templates/plugins/gnu_r_editor.r'
--- data/templates/plugins/gnu_r_editor.r	2012-05-17 17:14:44 +0000
+++ data/templates/plugins/gnu_r_editor.r	2013-12-03 12:08:29 +0000
@@ -1,3 +1,3 @@
-png("[% png_fname %]")
+png("[% png_fname %]",width=[% r_width %], height=[% r_height %])
 [% gnu_r_plot_script %]
 dev.off()

=== modified file 'zim/plugins/gnu_r_ploteditor.py'
--- zim/plugins/gnu_r_ploteditor.py	2013-08-17 22:45:02 +0000
+++ zim/plugins/gnu_r_ploteditor.py	2013-12-03 12:08:29 +0000
@@ -15,6 +15,7 @@
 #
 
 import glob
+import re
 
 from zim.plugins.base.imagegenerator import ImageGeneratorPlugin, ImageGeneratorClass
 from zim.fs import File, TmpFile
@@ -72,9 +73,22 @@
 		pngfile = File(plotscriptfile.path[:-2] + '.png')
 
 		plot_script = "".join(text)
+		
+		plot_width = 480 # default image width (px)
+		plot_height = 480 # default image height (px)
+
+		# LOOK for image size in comments of the script
+		r=re.search(r"^#\s*WIDTH\s*=\s*([0-9]+)$",plot_script,re.M)
+		if r:
+			plot_width=int(r.group(1))
+		r=re.search(r"^#\s*HEIGHT\s*=\s*([0-9]+)$",plot_script,re.M)
+		if r:
+			plot_height=int(r.group(1))
 
 		template_vars = {
 			'gnu_r_plot_script': plot_script,
+			'r_width': plot_width,
+			'r_height': plot_height,
 			'png_fname': pngfile.path.replace('\\', '/'),
 				# Even on windows, GNU R expects unix path seperator
 		}