Merge lp:~blue119/zim/pyzim into lp:~jaap.karssenberg/zim/pyzim

[YPWang]

I added a ditaa plugin for pyzim that providing to covert ASCII art to roper bitmap graphics. Could it can merge to ML ? thanks.

[Oliver Joos (oliver-joos)]

Hoi Chris,

Good News für aafigure-User,
bad News für Mitglieder vo lp:aafigure:
http://ditaa.org

+++ Oliver

Am Sonntag, den 11.03.2012, 02:18 +0000 schrieb YPWang:
> YPWang has proposed merging lp:~blue119/zim/pyzim into lp:zim.
>
> Requested reviews:
> Jaap Karssenberg (jaap.karssenberg)
>
> I added a ditaa plugin for pyzim that providing to covert ASCII art to
> roper bitmap graphics. Could it can merge to ML ? thanks.
> --
> https://code.launchpad.net/~blue119/zim/pyzim/+merge/96906

[Oliver Joos (oliver-joos)]

Ooops!! My previous message was mis-addressed!

Here I'd like to add: I am very happy about the new plugin for Ditaa!
I did not know it yet. As a member of team lp:aafigure I planned a
similar plugin for aafigure. Now we'll see if we still do that, or we
try to enhance Ditaa with aafigure features, or both.

Anyway, great that Zim soon is able to render ASCII art!
thanks to blue119!
+++ Oliver

Am Sonntag, den 11.03.2012, 02:18 +0000 schrieb YPWang:
> YPWang has proposed merging lp:~blue119/zim/pyzim into lp:zim.
>
> Requested reviews:
> Jaap Karssenberg (jaap.karssenberg)
>
> For more details, see:
> https://code.launchpad.net/~blue119/zim/pyzim/+merge/96906
>
> I added a ditaa plugin for pyzim that providing to covert ASCII art to roper bitmap graphics. Could it can merge to ML ? thanks.
> Unterschiede zwischen Dateien-Anlage (review-diff.txt)
> === added directory 'data/manual/Plugins/Ditaa_Editor'
> === added file 'data/manual/Plugins/Ditaa_Editor.txt'
> --- data/manual/Plugins/Ditaa_Editor.txt 1970-01-01 00:00:00 +0000
> +++ data/manual/Plugins/Ditaa_Editor.txt 2012-03-11 02:17:18 +0000
> @@ -0,0 +1,29 @@
> +Content-Type: text/x-zim-wiki
> +Wiki-Format: zim 0.4
> +Creation-Date: 2012-03-11T09:47:20+08:00
> +
> +====== Ditaa Editor ======
> +Created Sunday 11 March 2012
> +
> +ditaa is a small command-line utility written in Java, that can convert diagrams drawn using ascii art ('drawings' that contain characters that resemble lines like | / - ), into proper bitmap graphics. This is best illustrated by the following example -- which also illustrates the benefits of using ditaa in comparison to other methods :)
> +
> +===== Example =====
> +'''
> ++--------+ +-------+ +-------+
> +| | --+ ditaa +--> | |
> +| Text | +-------+ |diagram|
> +|Document| |!magic!| | |
> +| {d}| | | | |
> ++---+----+ +-------+ +-------+
> + : ^
> + | Lots of work |
> + +-------------------------+
> +'''
> +
> +
> +After conversion using ditaa, the above file becomes:
> +{{./ditaa.png?type=ditaa}}
> +ditaa interprets ascci art as a series of open and closed shapes, but it also uses special markup syntax to increase the possibilities of shapes and symbols that can be rendered.
> +ditaa is open source and free software (free as in free speech), since it is released under the GPL license.
> +
> +See http://ditaa.sourceforge.net/ for more information about gnuplot
>
> === added file 'data/manual/Plugins/Ditaa_Editor/ditaa.dia'
> --- data/manual/Plugins/Ditaa_Editor/ditaa.dia 1970-01-01 00:00:00 +0000
> +++ data/manual/Plugins/Ditaa_Editor/ditaa.dia 2012-03-11 02:17:18 +0000
> @@ -0,0 +1,9 @@
> + +--------+ +-------+ +-------+
> + | | --+ ditaa +--> | |
> + | Text | +-------+ |diagram|
> + |Document| |!magic!| | |
> + | {d}| | | | |
> + +---+----+ +-------+ +-------+
> + : ^
> + | Lots of work |
> + +-------------------------+
> \ No newline at end of file
>
> === added file 'data/manual/Plugins/Ditaa_Editor/ditaa.png'
> B...

=== added directory 'data/manual/Plugins/Ditaa_Editor'
=== added file 'data/manual/Plugins/Ditaa_Editor.txt'
--- data/manual/Plugins/Ditaa_Editor.txt	1970-01-01 00:00:00 +0000
+++ data/manual/Plugins/Ditaa_Editor.txt	2012-03-11 02:17:18 +0000
@@ -0,0 +1,29 @@
+Content-Type: text/x-zim-wiki
+Wiki-Format: zim 0.4
+Creation-Date: 2012-03-11T09:47:20+08:00
+
+====== Ditaa Editor ======
+Created Sunday 11 March 2012
+
+ditaa is a small command-line utility written in Java, that can convert diagrams drawn using ascii art ('drawings' that contain characters that resemble lines like | / - ), into proper bitmap graphics. This is best illustrated by the following example -- which also illustrates the benefits of using ditaa in comparison to other methods :)
+
+===== Example =====
+'''
++--------+   +-------+    +-------+
+|        | --+ ditaa +--> |       |
+|  Text  |   +-------+    |diagram|
+|Document|   |!magic!|    |       |
+|     {d}|   |       |    |       |
++---+----+   +-------+    +-------+
+    :                         ^
+    |       Lots of work      |
+    +-------------------------+
+'''
+
+
+After conversion using ditaa, the above file becomes:
+{{./ditaa.png?type=ditaa}}
+ditaa interprets ascci art as a series of open and closed shapes, but it also uses special markup syntax to increase the possibilities of shapes and symbols that can be rendered.
+ditaa is open source and free software (free as in free speech), since it is released under the GPL license.
+
+See  http://ditaa.sourceforge.net/ for more information about gnuplot

=== added file 'data/manual/Plugins/Ditaa_Editor/ditaa.dia'
--- data/manual/Plugins/Ditaa_Editor/ditaa.dia	1970-01-01 00:00:00 +0000
+++ data/manual/Plugins/Ditaa_Editor/ditaa.dia	2012-03-11 02:17:18 +0000
@@ -0,0 +1,9 @@
+    +--------+   +-------+    +-------+
+    |        | --+ ditaa +--> |       |
+    |  Text  |   +-------+    |diagram|
+    |Document|   |!magic!|    |       |
+    |     {d}|   |       |    |       |
+    +---+----+   +-------+    +-------+
+        :                         ^
+        |       Lots of work      |
+        +-------------------------+
\ No newline at end of file

=== added file 'data/manual/Plugins/Ditaa_Editor/ditaa.png'
Binary files data/manual/Plugins/Ditaa_Editor/ditaa.png	1970-01-01 00:00:00 +0000 and data/manual/Plugins/Ditaa_Editor/ditaa.png	2012-03-11 02:17:18 +0000 differ
=== added file 'zim/plugins/ditaaeditor.py'
--- zim/plugins/ditaaeditor.py	1970-01-01 00:00:00 +0000
+++ zim/plugins/ditaaeditor.py	2012-03-11 02:17:18 +0000
@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+#
+# ditaaeditor.py
+#
+# This is a plugin for Zim, which allows coverting ASCII art into proper bitmap 
+# graphics.
+#
+#
+# Author: Yao-Po Wang <[e-mail]>
+# Date: 2012-03-11
+# Copyright (c) 2012, released under the GNU GPL v2 or higher
+#
+#
+
+import gtk
+
+from zim.fs import File, TmpFile
+from zim.plugins import PluginClass
+from zim.config import data_file
+from zim.applications import Application, ApplicationError
+from zim.gui.imagegeneratordialog import ImageGeneratorClass, ImageGeneratorDialog
+from zim.gui.widgets import populate_popup_add_separator
+
+# TODO put these commands in preferences
+dotcmd = ('ditaa')
+
+ui_xml = '''
+<ui>
+	<menubar name='menubar'>
+		<menu action='insert_menu'>
+			<placeholder name='plugin_items'>
+				<menuitem action='insert_ditaa'/>
+			</placeholder>
+		</menu>
+	</menubar>
+</ui>
+'''
+
+ui_actions = (
+	# name, stock id, label, accelerator, tooltip, read only
+	('insert_ditaa', None, _('Ditaa...'), '', _('Insert ditaa'), False),
+		# T: menu item for insert diagram plugin
+)
+
+
+class InsertDitaaPlugin(PluginClass):
+
+	plugin_info = {
+		'name': _('Insert Ditaa'), # T: plugin name
+		'description': _('''\
+This plugin provides a diagram editor for zim based on Ditaa.
+
+This is a core plugin shipping with zim.
+'''), # T: plugin description
+        'help': ':Plugins:Ditaa Editor',
+		'author': 'Yao-Po Wang',
+	}
+
+	@classmethod
+	def check_dependencies(klass):
+		has_dotcmd = Application(dotcmd).tryexec()
+		return has_dotcmd, [("Ditaa", has_dotcmd, True)]
+
+	def __init__(self, ui):
+		PluginClass.__init__(self, ui)
+		if self.ui.ui_type == 'gtk':
+			self.ui.add_actions(ui_actions, self)
+			self.ui.add_ui(ui_xml, self)
+			self.register_image_generator_plugin('diagram')
+
+	def insert_ditaa(self):
+		dialog = InsertDitaaDialog.unique(self, self.ui)
+		dialog.show_all()
+
+	def edit_object(self, buffer, iter, image):
+		dialog = InsertDitaaDialog(self.ui, image=image)
+		dialog.show_all()
+
+	def do_populate_popup(self, menu, buffer, iter, image):
+		populate_popup_add_separator(prepend=True)
+
+		item = gtk.MenuItem(_('_Edit Ditaa')) # T: menu item in context menu
+		item.connect('activate',
+			lambda o: self.edit_object(buffer, iter, image))
+		menu.prepend(item)
+
+
+
+class InsertDitaaDialog(ImageGeneratorDialog):
+
+	def __init__(self, ui, image=None):
+		generator = DitaaGenerator()
+		ImageGeneratorDialog.__init__(self, ui, _('Insert Ditaa'), # T: dialog title
+            generator, image, help=':Plugins:Ditaa Editor' )
+
+
+class DitaaGenerator(ImageGeneratorClass):
+
+	uses_log_file = False
+
+	type = 'ditaa'
+	scriptname = 'ditaa.dia'
+	imagename = 'ditaa.png'
+
+	def __init__(self):
+		self.dotfile = TmpFile(self.scriptname)
+		self.dotfile.touch()
+		self.pngfile = File(self.dotfile.path[:-4] + '.png') # len('.dot') == 4
+
+	def generate_image(self, text):
+		if isinstance(text, basestring):
+			text = text.splitlines(True)
+
+		# Write to tmp file
+		self.dotfile.writelines(text)
+
+		# Call GraphViz
+		try:
+			dot = Application(dotcmd)
+			dot.run((self.dotfile, '-o', self.pngfile))
+		except ApplicationError:
+			return None, None # Sorry, no log
+		else:
+			return self.pngfile, None
+
+	def cleanup(self):
+		self.dotfile.remove()
+		self.pngfile.remove()
+