public inbox for [email protected]  
help / color / mirror / Atom feed
From: Greg Smith <[email protected]>
To: [email protected]
Subject: Re: Documentation and explanatory diagrams
Date: Mon, 13 Jun 2011 10:35:41 -0400
Message-ID: <[email protected]> (raw)
In-Reply-To: <1307972167.2862.518.camel@core2>
References: <[email protected]>
	<1307972167.2862.518.camel@core2>

On 06/13/2011 09:36 AM, Rafael Martinez wrote:
> It refers among other things to Inkscape [2]. This program generates SVG
> diagrams and is not so difficult to use. One of the good things with
> Inkscape is that it works with a standard format so we are not bound to
> a specific program or non standard format.
>    

I've been staying out of this discussion so far because I truly hate 
dia, and was waiting for others to decide against it too.  Inkscape 
saving to SVG is a much more reasonable choice.  I just created a 
drawing, saved it, then modified it a bit.  The spurious diff from the 
GUI was quite small:  three lines of junk with the filename change and 
some windowing metadata.  And the new material added showed in a pretty 
readable diff as I would hope too.  Original file and diff attached as 
samples.

The main issue I've seen with SVG is that it doesn't render the same way 
in every program.  The attached drawing1.svg shows up in Inkscape with a 
text box and the word "stuff" in the middle.  But if I open it in the 
standard desktop viewer on my Linux system, "Eye of GNOME", or in 
OpenOffice Draw, it shows a black box where the text is supposed to be.  
(OpenOffice Draw can read some SVG files, but it can't save in that 
format.  Improving OOO support for SVG on import and export is a high 
priority feature for the project though:  
http://wiki.services.openoffice.org/wiki/SVG_Import_Filter , 
http://graphics.openoffice.org/svg/svg.htm )

I think that any SVG diagram might need to have QA that includes opening 
it in more than one program, to confirm the file isn't using a fuzzy 
feature in the standard that renders differently.  Maybe we don't care, 
and the fact that it renders correctly in whatever tool is used to 
generate the docs is all that matters.  But SVG is as good candidate for 
a storage format as we're likely to find.  I've been trying to find an 
open replacement for the sort of diagrams I used to draw all the time in 
Visio in the late 90's, and tools like Inkscape using SVG have finally 
started to look good enough for me to consider using seriously in the 
last two years.  OpenOffice completely sorting out their issues with the 
format is really the last blocker for my own purposes--it becomes much 
easier for me to justify making these when I can easily pull them in and 
out of presentation slides--but that may not be relevant to the 
community documentation efforts the way it is to my personal work.

-- 
Greg Smith   2ndQuadrant US    [email protected]   Baltimore, MD
PostgreSQL Training, Services, and 24x7 Support  www.2ndQuadrant.us




Attachments:

  [text/x-patch] inkscape.diff (1.5K, 2-inkscape.diff)
  download | inline diff:
--- drawing1.svg	2011-06-13 09:48:39.063194750 -0400
+++ drawing2.svg	2011-06-13 09:49:14.239174007 -0400
@@ -14,7 +14,7 @@
    id="svg2"
    version="1.1"
    inkscape:version="0.47 r22583"
-   sodipodi:docname="New document 1">
+   sodipodi:docname="drawing1.svg">
   <defs
      id="defs4">
     <inkscape:perspective
@@ -39,9 +39,9 @@
      inkscape:current-layer="layer1"
      showgrid="false"
      inkscape:window-width="967"
-     inkscape:window-height="651"
+     inkscape:window-height="897"
      inkscape:window-x="140"
-     inkscape:window-y="1202"
+     inkscape:window-y="956"
      inkscape:window-maximized="0" />
   <metadata
      id="metadata7">
@@ -76,5 +76,22 @@
            height="100"
            x="191.42857"
            y="269.50504" /></flowRegion><flowPara
-         id="flowPara2824">stuff</flowPara></flowRoot>  </g>
+         id="flowPara2824">more stuff</flowPara></flowRoot>    <rect
+       style="fill:#0000ff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       id="rect2847"
+       width="488.57144"
+       height="242.85715"
+       x="108.57143"
+       y="569.50507" />
+    <text
+       xml:space="preserve"
+       style="font-size:40px;font-style:normal;font-weight:normal;fill:#000000;fill-opacity:1;stroke:none;font-family:Bitstream Vera Sans"
+       x="274.28571"
+       y="718.07648"
+       id="text2849"><tspan
+         sodipodi:role="line"
+         id="tspan2851"
+         x="274.28571"
+         y="718.07648">second box</tspan></text>
+  </g>
 </svg>


  [image/svg+xml] drawing1.svg (2.5K, 3-drawing1.svg)
  download | view image

view thread (114+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected]
  Subject: Re: Documentation and explanatory diagrams
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox