WikiExporter - Revision history

Conversion script: link fix

2006-01-22T02:33:52Z

link fix

← Older revision		Revision as of 02:33, 22 January 2006
Line 1:		Line 1:
	I've written a bunch of little scripts that, together, make it so you can save to and load from an [http://www.oddmuse.org/cgi-bin/wiki OddMuse] wiki.		I've written a bunch of little scripts that, together, make it so you can save to and load from an [http://www.oddmuse.org/cgi-bin/wiki [[OddMuse]]] wiki.

	It renders out both Inkscape .svg and .png versions of the data.		It renders out both Inkscape .svg and .png versions of the data.
Line 28:		Line 28:
	The file details the username and wiki URL for svg2oddmuse.sh.		The file details the username and wiki URL for svg2oddmuse.sh.

	The [http://www.emacswiki.org/cw/InkscapeToOddmuse full description of how it works] is on [http://communitywiki.org/ CommunityWiki.]		The [http://www.emacswiki.org/cw/InkscapeToOddmuse full description of how it works] is on [http://communitywiki.org/ [[CommunityWiki]].]

	Next, I intend to write code to ''read'' Inkscape SVG from the wiki as well.		Next, I intend to write code to ''read'' Inkscape SVG from the wiki as well.

	The process is kind of hacky; I imagine that when one of the ExtensionArchitectureProposals is chosen and implemented, it'll be a lot nicer.		The process is kind of hacky; I imagine that when one of the [[ExtensionArchitectureProposals]] is chosen and implemented, it'll be a lot nicer.

	'''Drawing Area?'''		'''Drawing Area?'''
Line 40:		Line 40:
	The relevant code looks like this:		The relevant code looks like this:

	inkscape --file="$INK_SVG" --export-png="$DOCBASE/$DOCNAME.png" --export-area "0:0:595.28:841.89" > /dev/null		inkscape --file="$[[INK_SVG]]" --export-png="$DOCBASE/$DOCNAME.png" --export-area "0:0:595.28:841.89" > /dev/null

	I tried removing the --export-area, and all I got were tiny little 123 byte files.		I tried removing the --export-area, and all I got were tiny little 123 byte files.

LionKimbro: * Two way now-- Can both save to wiki, and load back from wiki.

2005-02-15T07:06:28Z

* Two way now-- Can both save to wiki, and load back from wiki.

← Older revision		Revision as of 07:06, 15 February 2005
Line 1:		Line 1:
	I've written ~~4 files~~ that, together, make it so you can save to an [http://www.oddmuse.org/cgi-bin/wiki OddMuse] wiki.		I've written a bunch of little scripts that, together, make it so you can save to and load from an [http://www.oddmuse.org/cgi-bin/wiki OddMuse] wiki.

			It renders out both Inkscape .svg and .png versions of the data.

			You can load from the wiki, make a few edits, hit "Ctrl-S," and the edited document is sent back to the wiki.

			It's fun!

			----

	(I believe that means it should work for ''this'' wiki, as well, though I haven't tried it.)		(I believe that means it should work for ''this'' wiki, as well, though I haven't tried it.)

LionKimbro: * will probably work on this wiki..!

2005-02-13T10:20:43Z

* will probably work on *this* wiki..!

← Older revision		Revision as of 10:20, 13 February 2005
Line 1:		Line 1:
	I've written 4 files that, together, make it so you can save to an [http://www.oddmuse.org/cgi-bin/wiki OddMuse] wiki.		I've written 4 files that, together, make it so you can save to an [http://www.oddmuse.org/cgi-bin/wiki OddMuse] wiki.

			(I believe that means it should work for ''this'' wiki, as well, though I haven't tried it.)

	Basically, it goes like this:		Basically, it goes like this:

LionKimbro: * questions about CLI export area control, bitmap conversion to data URLs

2005-02-13T10:19:24Z

* questions about CLI export area control, bitmap conversion to data URLs

← Older revision		Revision as of 10:19, 13 February 2005
Line 21:		Line 21:

	Next, I intend to write code to ''read'' Inkscape SVG from the wiki as well.		Next, I intend to write code to ''read'' Inkscape SVG from the wiki as well.

			The process is kind of hacky; I imagine that when one of the ExtensionArchitectureProposals is chosen and implemented, it'll be a lot nicer.

			'''Drawing Area?'''

			Right now, I've hard coded it to export the ''page.''

			The relevant code looks like this:

			inkscape --file="$INK_SVG" --export-png="$DOCBASE/$DOCNAME.png" --export-area "0:0:595.28:841.89" > /dev/null

			I tried removing the --export-area, and all I got were tiny little 123 byte files.

			Ideally, my code would send off only the ''drawing,'' not the whole page.

			Questions:
			* Does the CLI interface support this in version 0.40? (Maybe I'm just missing it.)
			* Is there a way I can easily get the information from the SVG? (Maybe I'm just missing it.)

			'''Bitmaps to data URLs?'''

			I saw in the examples, that a PNG was turned into a binary64 encoded data URL.

			I haven't written the code to locate PNG references, and replace them with data URLs.

			But, this is something that I think should be done with it.

			Question:
			* Is there a way to turn PNG images into data: URLs ''within Inkscape?''
			* From the CLI?

LionKimbro: *success! summary, how it works

2005-02-13T10:09:57Z

*success! summary, how it works

← Older revision		Revision as of 10:09, 13 February 2005
Line 1:		Line 1:
	~~These are LionKimbro~~'~~s notes on developing a~~ wiki ~~exporter~~.		I've written 4 files that, together, make it so you can save to an [http://www.oddmuse.org/cgi-bin/wiki OddMuse] wiki.

	~~Date~~: ~~2004-02-12~~		Basically, it goes like this:
	Inkscape version~~: 0~~.40		* A script is called from Inkscape when the user saves,
	~~Target: Oddmuse~~		* the script reads the SVG document to figure out what directory it was saved to,
			* the script reads it to figure out what filename was used as well,
			* information about the target wiki is read from the directory the SVG was saved to,
			* the Inkscape SVG is uploaded to the wiki,
			* and a PNG version is uploaded to the wiki as well.

	~~That is, a system so that you can load from and save to a wiki~~.		This all requires 4 files:
			* odd_output.inx -- Inkscape extension definition
			* svg2oddmuse.sh -- coordinates most everything
			* svgattrs.py -- scans the SVG file for <svg ...> attributes
			* wikiupload.py -- oddmuse upload script

	The wiki ~~targetted by this exporter is Oddmuse. We have [http://www~~.~~oddmuse.org/cgi-bin/oddmuse/Automatic_Posting_and_Uploading#wikiupload an upload script for it~~.]		Furthermore, the user creates a custom file, "notes.txt".
			The file details the username and wiki URL for svg2oddmuse.sh.

	~~I imagine~~ it ~~should be possible to use the Wiki XML-RPC interfaces as well, in the future, though they are usually turned off~~.		The [http://www.emacswiki.org/cw/InkscapeToOddmuse full description of how it works] is on [http://communitywiki.org/ CommunityWiki.]

	~~'''odd_output.inx'''~~		Next, I intend to write code to ''read'' Inkscape SVG from the wiki as well.

	~~This file goes in: /usr/share/inkscape/extensions~~

	~~<inkscape-extension>~~
	~~<name>Oddwiki Output</name>~~
	~~<id>org.inkscape.output.odd</id>~~
	~~<dependency type="executable" location="extensions">svg2oddmuse.sh</dependency>~~
	~~<output>~~
	~~<extension>.odd</extension>~~
	~~<mimetype>image/x-svgz</mimetype>~~
	~~<filetypename>Oddmuse Wiki POST (*.odd)</filetypename>~~
	~~<filetypetooltip>Oddmuse Wiki proxy (SVG~~, ~~PNG of Drawing)</filetypetooltip>~~
	~~<dataloss>FALSE</dataloss>~~
	~~</output>~~
	~~<script>~~
	~~<command reldir="extensions">svg2oddmuse.sh</command>~~
	~~<helper_extension>org.inkscape.output.svg.inkscape</helper_extension>~~
	~~</script>~~
	~~</inkscape-extension>~~

	~~'''What data am~~ I ~~receiving from Inkscape?'''~~

	~~To see what you're getting from Inkscape, create the following script, and call it: '''svg2oddmuse.sh'''~~

	~~#!/bin/bash~~
	~~echo "hello, world" > /tmp/eraseme.txt~~
	~~echo "invocation: $@"~~
	~~echo~~
	~~echo "$1:"~~
	~~cat "$1"~~
	~~echo "- - - - - - - - - - - - - - - - - - - - - - - - - - - -"~~
	~~env~~

	~~It appears that no environment variables are being set. The first (and only) argument is the location of a file in /tmp that contains the Inkscape SVG data.~~

	~~'''Now what?'''~~

	~~The strategy is this:~~

	* create a directory, representing the wiki
	* place a file in the directory, "oddmuse.txt", representing necessary details about the wiki
	* when the user saves a file to the directory (.odd extension,) do the following:
	** push the SVG to the wiki
	** render a PNG, and push the PNG to ~~the wiki~~
	** perhaps append the name of the wikipage containing the SVG to ~~a page on the wiki~~

	~~We don~~'~~t have command-line access (bash argument, environment variable) to the filename or~~
	~~directory it was saved in. But we CAN get this data from the Inkscape SVG.~~

	~~The <svg> element has attributes:~~
	* "sodipodi:docbase" -- path up to the save location
	* "sodpodi:docname" -- filaname, including extension (".odd", in this case)


	~~== Inkscape Export process ==~~

	* User hits "Save" in "Save As" dialog
	* Inkscape writes a file with a random name to /tmp
	* Inkscape calls export bash script, with /tmp file as only argument
	* Whatever bash outputs to /dev/stdout, Inkscape records to the file chosen by the user.

	~~== Inkscape SVG Attributes ==~~

	~~Here~~'~~s a Python script that outputs <svg> attributes:~~

	''~~'svgattrs.py''':~~

	~~#!/usr/bin/python2.3~~
	~~"""Expose Inkscape SVG attributes.~~

	~~Read an~~ Inkscape SVG from ~~stdin.~~
	~~Output attributes to~~ the ~~"<svg>" element to stdout.~~
	~~"""~~

	~~import sys~~
	~~import xml.sax~~


	~~class InkscapeSvgHandler(xml.sax.ContentHandler):~~

	~~"""Print attributes to svg element."""~~

	~~def startElement(self, name, attrs):~~
	~~if name == "svg":~~
	~~for (k,v) in attrs.items():~~
	~~print k + " " + v~~


	~~if __name__ == "__main__":~~
	~~parser = xml.sax.make_parser()~~
	~~parser.setContentHandler(InkscapeSvgHandler())~~
	~~parser.parse(sys.stdin)~~
	~~sys.exit(0)~~

	~~You can use it like so:~~

	~~DOCNAME=`cat "$1" \| ./svgattrs.py \| grep -e "^sodipodi:docname" \| cut -d" " -f2`~~
	~~DOCBASE=`cat "$1" \| ./svgattrs~~.~~py \| grep -e "^sodipodi:docbase" \| cut -d" " -f2`~~

LionKimbro: * docpath -> docbase

2005-02-12T23:32:54Z

* docpath -> docbase

← Older revision		Revision as of 23:32, 12 February 2005
Line 109:		Line 109:

	DOCNAME=`cat "$1" \| ./svgattrs.py \| grep -e "^sodipodi:docname" \| cut -d" " -f2`		DOCNAME=`cat "$1" \| ./svgattrs.py \| grep -e "^sodipodi:docname" \| cut -d" " -f2`
	~~DOCPATH~~=`cat "$1" \| ./svgattrs.py \| grep -e "^sodipodi:~~docpath~~" \| cut -d" " -f2`		DOCBASE=`cat "$1" \| ./svgattrs.py \| grep -e "^sodipodi:docbase" \| cut -d" " -f2`

LionKimbro: *Python script for getting the exported file's name & path

2005-02-12T22:37:57Z

*Python script for getting the exported file's name & path

← Older revision		Revision as of 22:37, 12 February 2005
Line 72:		Line 72:
	* Inkscape calls export bash script, with /tmp file as only argument		* Inkscape calls export bash script, with /tmp file as only argument
	* Whatever bash outputs to /dev/stdout, Inkscape records to the file chosen by the user.		* Whatever bash outputs to /dev/stdout, Inkscape records to the file chosen by the user.

			== Inkscape SVG Attributes ==

			Here's a Python script that outputs <svg> attributes:

			'''svgattrs.py''':

			#!/usr/bin/python2.3
			"""Expose Inkscape SVG attributes.

			Read an Inkscape SVG from stdin.
			Output attributes to the "<svg>" element to stdout.
			"""

			import sys
			import xml.sax


			class InkscapeSvgHandler(xml.sax.ContentHandler):

			"""Print attributes to svg element."""

			def startElement(self, name, attrs):
			if name == "svg":
			for (k,v) in attrs.items():
			print k + " " + v


			if __name__ == "__main__":
			parser = xml.sax.make_parser()
			parser.setContentHandler(InkscapeSvgHandler())
			parser.parse(sys.stdin)
			sys.exit(0)

			You can use it like so:

			DOCNAME=`cat "$1" \| ./svgattrs.py \| grep -e "^sodipodi:docname" \| cut -d" " -f2`
			DOCPATH=`cat "$1" \| ./svgattrs.py \| grep -e "^sodipodi:docpath" \| cut -d" " -f2`

LionKimbro: * SVG element

2005-02-12T21:04:57Z

* SVG element

← Older revision		Revision as of 21:04, 12 February 2005
Line 61:		Line 61:
	directory it was saved in. But we CAN get this data from the Inkscape SVG.		directory it was saved in. But we CAN get this data from the Inkscape SVG.

	The ~~document~~ has attributes:		The <svg> element has attributes:
	* "sodipodi:docbase" -- path up to the save location		* "sodipodi:docbase" -- path up to the save location
	* "sodpodi:docname" -- filaname, including extension (".odd", in this case)		* "sodpodi:docname" -- filaname, including extension (".odd", in this case)

LionKimbro: * getting path and filename from Inkscape SVG

2005-02-12T21:03:04Z

* getting path and filename from Inkscape SVG

New page

These are LionKimbro's notes on developing a wiki exporter.

Date: 2004-02-12
Inkscape version: 0.40
Target: Oddmuse

That is, a system so that you can load from and save to a wiki.

The wiki targetted by this exporter is Oddmuse. We have [http://www.oddmuse.org/cgi-bin/oddmuse/Automatic_Posting_and_Uploading#wikiupload an upload script for it.]

I imagine it should be possible to use the Wiki XML-RPC interfaces as well, in the future, though they are usually turned off.

'''odd_output.inx'''

This file goes in: /usr/share/inkscape/extensions

<inkscape-extension>
<name>Oddwiki Output</name>
<id>org.inkscape.output.odd</id>
<dependency type="executable" location="extensions">svg2oddmuse.sh</dependency>
<output>
<extension>.odd</extension>
<mimetype>image/x-svgz</mimetype>
<filetypename>Oddmuse Wiki POST (*.odd)</filetypename>
<filetypetooltip>Oddmuse Wiki proxy (SVG, PNG of Drawing)</filetypetooltip>
<dataloss>FALSE</dataloss>
</output>
<script>
<command reldir="extensions">svg2oddmuse.sh</command>
<helper_extension>org.inkscape.output.svg.inkscape</helper_extension>
</script>
</inkscape-extension>

'''What data am I receiving from Inkscape?'''

To see what you're getting from Inkscape, create the following script, and call it: '''svg2oddmuse.sh'''

#!/bin/bash
echo "hello, world" > /tmp/eraseme.txt
echo "invocation: $@"
echo
echo "$1:"
cat "$1"
echo "- - - - - - - - - - - - - - - - - - - - - - - - - - - -"
env

It appears that no environment variables are being set. The first (and only) argument is the location of a file in /tmp that contains the Inkscape SVG data.

'''Now what?'''

The strategy is this:

* create a directory, representing the wiki
* place a file in the directory, "oddmuse.txt", representing necessary details about the wiki
* when the user saves a file to the directory (.odd extension,) do the following:
** push the SVG to the wiki
** render a PNG, and push the PNG to the wiki
** perhaps append the name of the wikipage containing the SVG to a page on the wiki

We don't have command-line access (bash argument, environment variable) to the filename or
directory it was saved in. But we CAN get this data from the Inkscape SVG.

The document has attributes:
* "sodipodi:docbase" -- path up to the save location
* "sodpodi:docname" -- filaname, including extension (".odd", in this case)

== Inkscape Export process ==

* User hits "Save" in "Save As" dialog
* Inkscape writes a file with a random name to /tmp
* Inkscape calls export bash script, with /tmp file as only argument
* Whatever bash outputs to /dev/stdout, Inkscape records to the file chosen by the user.