Inkscape Wiki - User contributions [en]

FindMatch

2008-12-17T21:14:23Z

Aussie:

Find Match tries to match the last path selected against all the path in the document.

The algorithm first checks that the number of node points are the same. Then checks that the node commands match. If the commands match it will then do a correlation against the point positions. This allows the match to catch even those paths that have been scaled, rotated or flipped. The correlation threshold allows the match to be tuned. A 1.0 will match only those paths that haven't been transformed. There is also a check box to match on color or not.

Please leave comments and suggestions.

The Find Match inx file
----
<pre>
<inkscape-extension>
<_name>Find Match</_name>
<id>org.find_match</id>
<dependency type="executable" location="extensions">findmatch.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="foundLayer" type="string" _gui-text="Name of layer to put found objects on?">Found</param>
<param name="threshold" type="float" min="0.0" max="1.0" _gui-text="Correlation Threshold">0.8</param>
<param name="matchcolor" type="boolean" _gui-text="Colors should match">true</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">findmatch.py</command>
</script>
</inkscape-extension>

</pre>
----

The python file for Find Match
----
<pre>
#!/usr/bin/env python

'''
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
'''
import sys
sys.path.append('/usr/share/inkscape/extensions')

# We will use the inkex module with the predefined Effect base class.
import inkex
from simplestyle import *
from simplepath import *
from math import sqrt

color_props_fill=('fill:','stop-color:','flood-color:','lighting-color:')
color_props_stroke=('stroke:',)
color_props = color_props_fill + color_props_stroke

def correlation(xList,yList):
#print yList
n = len(xList)
sumX = 0
sumXX = 0
sumY = 0
sumYY = 0
sumXY = 0
for i in range(0,n):
X = xList[i]
sumX += X
sumXX += X*X
Y = yList[i]
sumY += Y
sumYY += Y*Y
sumXY += X*Y
corrnum = (n * sumXY)-(sumX * sumY)
corrden = sqrt( (n * sumXX) - (sumX * sumX) ) * sqrt( (n * sumYY) - (sumY * sumY) )
corr = corrnum/corrden
return corr

def pathMatch(rPath,cPath):
n = len(rPath)
for i in range(0,n):
rNode = rPath[i]
cNode = cPath[i]
[rCmd,rPoints] = rNode
[cCmd,cPoints] = cNode
if rCmd != cCmd:
#print "not match"
return 0
#print "Command Match"
return 1

def pathPullPoints(rPath,cPath):
n = len(rPath)
rPointList = []
cPointList = []
for i in range(0,n):
rNode = rPath[i]
cNode = cPath[i]
[rCmd,rPoints] = rNode
[cCmd,cPoints] = cNode
rPointList.extend(rPoints)
cPointList.extend(cPoints)
return [rPointList,cPointList]

def getLayer(svg, layerName):
for g in svg.xpath('//svg:g', namespaces=inkex.NSS):
if (g.get(inkex.addNS('groupmode', 'inkscape')) == 'layer'
and (g.get(inkex.addNS('label', 'inkscape'))
== layerName)):
return g
# Create a new layer.
newLayer = inkex.etree.SubElement(svg, 'g')
newLayer.set(inkex.addNS('label', 'inkscape'), layerName)
newLayer.set(inkex.addNS('groupmode', 'inkscape'), 'layer')
return newLayer

def compareColors(refNode, compNode):
pass

def getColor(node):
col = {}
if node.attrib.has_key('style'):
style=node.get('style') # fixme: this will break for presentation attributes!
if style!='':
#inkex.debug('old style:'+style)
styles=style.split(';')
for i in range(len(styles)):
for c in range(len(color_props)):
if styles[i].startswith(color_props[c]):
#print "col num %d" % c
#print styles[i][len(color_props[c]):]
col[c] = styles[i][len(color_props[c]):]
return col

def colorMatch(rNode,cNode):
rCol = getColor(rNode)
#print rCol
cCol = getColor(cNode)
#print cCol
if (rCol == cCol):
return 1
return 0

class FindMatch(inkex.Effect):
"""
Inkscape effect extension.
Searches for paths that match and places them on the named layer.
"""
def __init__(self):
"""
Constructor.
Defines the "--what" option of a script.
"""
# Call the base class constructor.
inkex.Effect.__init__(self)

self.OptionParser.add_option('-f', '--foundLayer', action = 'store',
type = 'string', dest = 'foundLayer', default = 'Found',
help = 'Name of layer to put found objects on?')

self.OptionParser.add_option("-t", "--threshold",
action="store", type="float",
dest="threshold", default = 0.8,
help="threshold for correlation match")
self.OptionParser.add_option("--matchcolor",
action="store", type="inkbool",
dest="matchcolor", default=True,
help="If True, colors will be matched")

def effect(self):
"""
Effect behaviour.
Search for all paths that match the selected path
"""
foundLayer = self.options.foundLayer
matchcolor = self.options.matchcolor

# Get access to main SVG document element
svg = self.document.getroot()

# get the layer where the found paths will be moved to
layer = getLayer(svg, foundLayer)

# get a list of all path nodes
pathNodes = self.document.xpath('//svg:path',namespaces=inkex.NSS)

# setup stderr so that we can print to it for debugging
saveout = sys.stdout

sys.stdout = sys.stderr

rPathLen = 0
rPathList = []
rPathNode = None

if len(self.selected) == 0:
print "Nothing Selected"
sys.stdout = saveout
return

for id, node in self.selected.iteritems():
#print dir(node)
if node.tag == inkex.addNS('path','svg'):
#print node.attrib['d']
rPathList = parsePath(node.attrib['d'])
rPathLen = len(rPathList)
rPathNode = node
#print rPathLen
#print rPathList

for cPathNode in pathNodes:
cPathList = parsePath(cPathNode.attrib['d'])
cPathLen = len(cPathList)
#print cPathLen
#print cPathList
if rPathLen == cPathLen:
#print " Found %d in %s" % (rPathLen,cPathNode)

#print matchcolor
colorMatchFlag = (colorMatch(rPathNode,cPathNode) == 1) or not matchcolor
pathMatchFlag = pathMatch(rPathList,cPathList)==1

if pathMatchFlag and colorMatchFlag:
[rList,cList] = pathPullPoints(rPathList,cPathList)
corVal = correlation(rList,cList)
#print "The correlation was %g" % corVal
if (corVal > 0.80):
layer.append(cPathNode)

#print
#print 'This message will be logged instead of displayed'
sys.stdout = saveout

# Create effect instance and apply it.
effect = FindMatch()
effect.affect()

</pre>

FindMatch

2008-12-17T21:14:02Z

Aussie:

Find Match tries to match the last path selected against all the path in the document.

The algorithm first checks that the number of mode points are the same. Then checks that the node commands match. If the commands match it will then do a correlation against the point positions. This allows the match to catch even those paths that have been scaled, rotated or flipped. The correlation threshold allows the match to be tuned. A 1.0 will match only those paths that haven't been transformed. There is also a check box to match on color or not.

Please leave comments and suggestions.

The Find Match inx file
----
<pre>
<inkscape-extension>
<_name>Find Match</_name>
<id>org.find_match</id>
<dependency type="executable" location="extensions">findmatch.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="foundLayer" type="string" _gui-text="Name of layer to put found objects on?">Found</param>
<param name="threshold" type="float" min="0.0" max="1.0" _gui-text="Correlation Threshold">0.8</param>
<param name="matchcolor" type="boolean" _gui-text="Colors should match">true</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">findmatch.py</command>
</script>
</inkscape-extension>

</pre>
----

The python file for Find Match
----
<pre>
#!/usr/bin/env python

'''
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
'''
import sys
sys.path.append('/usr/share/inkscape/extensions')

# We will use the inkex module with the predefined Effect base class.
import inkex
from simplestyle import *
from simplepath import *
from math import sqrt

color_props_fill=('fill:','stop-color:','flood-color:','lighting-color:')
color_props_stroke=('stroke:',)
color_props = color_props_fill + color_props_stroke

def correlation(xList,yList):
#print yList
n = len(xList)
sumX = 0
sumXX = 0
sumY = 0
sumYY = 0
sumXY = 0
for i in range(0,n):
X = xList[i]
sumX += X
sumXX += X*X
Y = yList[i]
sumY += Y
sumYY += Y*Y
sumXY += X*Y
corrnum = (n * sumXY)-(sumX * sumY)
corrden = sqrt( (n * sumXX) - (sumX * sumX) ) * sqrt( (n * sumYY) - (sumY * sumY) )
corr = corrnum/corrden
return corr

def pathMatch(rPath,cPath):
n = len(rPath)
for i in range(0,n):
rNode = rPath[i]
cNode = cPath[i]
[rCmd,rPoints] = rNode
[cCmd,cPoints] = cNode
if rCmd != cCmd:
#print "not match"
return 0
#print "Command Match"
return 1

def pathPullPoints(rPath,cPath):
n = len(rPath)
rPointList = []
cPointList = []
for i in range(0,n):
rNode = rPath[i]
cNode = cPath[i]
[rCmd,rPoints] = rNode
[cCmd,cPoints] = cNode
rPointList.extend(rPoints)
cPointList.extend(cPoints)
return [rPointList,cPointList]

def getLayer(svg, layerName):
for g in svg.xpath('//svg:g', namespaces=inkex.NSS):
if (g.get(inkex.addNS('groupmode', 'inkscape')) == 'layer'
and (g.get(inkex.addNS('label', 'inkscape'))
== layerName)):
return g
# Create a new layer.
newLayer = inkex.etree.SubElement(svg, 'g')
newLayer.set(inkex.addNS('label', 'inkscape'), layerName)
newLayer.set(inkex.addNS('groupmode', 'inkscape'), 'layer')
return newLayer

def compareColors(refNode, compNode):
pass

def getColor(node):
col = {}
if node.attrib.has_key('style'):
style=node.get('style') # fixme: this will break for presentation attributes!
if style!='':
#inkex.debug('old style:'+style)
styles=style.split(';')
for i in range(len(styles)):
for c in range(len(color_props)):
if styles[i].startswith(color_props[c]):
#print "col num %d" % c
#print styles[i][len(color_props[c]):]
col[c] = styles[i][len(color_props[c]):]
return col

def colorMatch(rNode,cNode):
rCol = getColor(rNode)
#print rCol
cCol = getColor(cNode)
#print cCol
if (rCol == cCol):
return 1
return 0

class FindMatch(inkex.Effect):
"""
Inkscape effect extension.
Searches for paths that match and places them on the named layer.
"""
def __init__(self):
"""
Constructor.
Defines the "--what" option of a script.
"""
# Call the base class constructor.
inkex.Effect.__init__(self)

self.OptionParser.add_option('-f', '--foundLayer', action = 'store',
type = 'string', dest = 'foundLayer', default = 'Found',
help = 'Name of layer to put found objects on?')

self.OptionParser.add_option("-t", "--threshold",
action="store", type="float",
dest="threshold", default = 0.8,
help="threshold for correlation match")
self.OptionParser.add_option("--matchcolor",
action="store", type="inkbool",
dest="matchcolor", default=True,
help="If True, colors will be matched")

def effect(self):
"""
Effect behaviour.
Search for all paths that match the selected path
"""
foundLayer = self.options.foundLayer
matchcolor = self.options.matchcolor

# Get access to main SVG document element
svg = self.document.getroot()

# get the layer where the found paths will be moved to
layer = getLayer(svg, foundLayer)

# get a list of all path nodes
pathNodes = self.document.xpath('//svg:path',namespaces=inkex.NSS)

# setup stderr so that we can print to it for debugging
saveout = sys.stdout

sys.stdout = sys.stderr

rPathLen = 0
rPathList = []
rPathNode = None

if len(self.selected) == 0:
print "Nothing Selected"
sys.stdout = saveout
return

for id, node in self.selected.iteritems():
#print dir(node)
if node.tag == inkex.addNS('path','svg'):
#print node.attrib['d']
rPathList = parsePath(node.attrib['d'])
rPathLen = len(rPathList)
rPathNode = node
#print rPathLen
#print rPathList

for cPathNode in pathNodes:
cPathList = parsePath(cPathNode.attrib['d'])
cPathLen = len(cPathList)
#print cPathLen
#print cPathList
if rPathLen == cPathLen:
#print " Found %d in %s" % (rPathLen,cPathNode)

#print matchcolor
colorMatchFlag = (colorMatch(rPathNode,cPathNode) == 1) or not matchcolor
pathMatchFlag = pathMatch(rPathList,cPathList)==1

if pathMatchFlag and colorMatchFlag:
[rList,cList] = pathPullPoints(rPathList,cPathList)
corVal = correlation(rList,cList)
#print "The correlation was %g" % corVal
if (corVal > 0.80):
layer.append(cPathNode)

#print
#print 'This message will be logged instead of displayed'
sys.stdout = saveout

# Create effect instance and apply it.
effect = FindMatch()
effect.affect()

</pre>

FindMatch

2008-12-17T21:07:23Z

Aussie:

The Find Match inx file
----
<pre>
<inkscape-extension>
<_name>Find Match</_name>
<id>org.find_match</id>
<dependency type="executable" location="extensions">findmatch.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="foundLayer" type="string" _gui-text="Name of layer to put found objects on?">Found</param>
<param name="threshold" type="float" min="0.0" max="1.0" _gui-text="Correlation Threshold">0.8</param>
<param name="matchcolor" type="boolean" _gui-text="Colors should match">true</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">findmatch.py</command>
</script>
</inkscape-extension>

</pre>
----

The python file for Find Match
----
<pre>
#!/usr/bin/env python

'''
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
'''
import sys
sys.path.append('/usr/share/inkscape/extensions')

# We will use the inkex module with the predefined Effect base class.
import inkex
from simplestyle import *
from simplepath import *
from math import sqrt

color_props_fill=('fill:','stop-color:','flood-color:','lighting-color:')
color_props_stroke=('stroke:',)
color_props = color_props_fill + color_props_stroke

def correlation(xList,yList):
#print yList
n = len(xList)
sumX = 0
sumXX = 0
sumY = 0
sumYY = 0
sumXY = 0
for i in range(0,n):
X = xList[i]
sumX += X
sumXX += X*X
Y = yList[i]
sumY += Y
sumYY += Y*Y
sumXY += X*Y
corrnum = (n * sumXY)-(sumX * sumY)
corrden = sqrt( (n * sumXX) - (sumX * sumX) ) * sqrt( (n * sumYY) - (sumY * sumY) )
corr = corrnum/corrden
return corr

def pathMatch(rPath,cPath):
n = len(rPath)
for i in range(0,n):
rNode = rPath[i]
cNode = cPath[i]
[rCmd,rPoints] = rNode
[cCmd,cPoints] = cNode
if rCmd != cCmd:
#print "not match"
return 0
#print "Command Match"
return 1

def pathPullPoints(rPath,cPath):
n = len(rPath)
rPointList = []
cPointList = []
for i in range(0,n):
rNode = rPath[i]
cNode = cPath[i]
[rCmd,rPoints] = rNode
[cCmd,cPoints] = cNode
rPointList.extend(rPoints)
cPointList.extend(cPoints)
return [rPointList,cPointList]

def getLayer(svg, layerName):
for g in svg.xpath('//svg:g', namespaces=inkex.NSS):
if (g.get(inkex.addNS('groupmode', 'inkscape')) == 'layer'
and (g.get(inkex.addNS('label', 'inkscape'))
== layerName)):
return g
# Create a new layer.
newLayer = inkex.etree.SubElement(svg, 'g')
newLayer.set(inkex.addNS('label', 'inkscape'), layerName)
newLayer.set(inkex.addNS('groupmode', 'inkscape'), 'layer')
return newLayer

def compareColors(refNode, compNode):
pass

def getColor(node):
col = {}
if node.attrib.has_key('style'):
style=node.get('style') # fixme: this will break for presentation attributes!
if style!='':
#inkex.debug('old style:'+style)
styles=style.split(';')
for i in range(len(styles)):
for c in range(len(color_props)):
if styles[i].startswith(color_props[c]):
#print "col num %d" % c
#print styles[i][len(color_props[c]):]
col[c] = styles[i][len(color_props[c]):]
return col

def colorMatch(rNode,cNode):
rCol = getColor(rNode)
#print rCol
cCol = getColor(cNode)
#print cCol
if (rCol == cCol):
return 1
return 0

class FindMatch(inkex.Effect):
"""
Inkscape effect extension.
Searches for paths that match and places them on the named layer.
"""
def __init__(self):
"""
Constructor.
Defines the "--what" option of a script.
"""
# Call the base class constructor.
inkex.Effect.__init__(self)

self.OptionParser.add_option('-f', '--foundLayer', action = 'store',
type = 'string', dest = 'foundLayer', default = 'Found',
help = 'Name of layer to put found objects on?')

self.OptionParser.add_option("-t", "--threshold",
action="store", type="float",
dest="threshold", default = 0.8,
help="threshold for correlation match")
self.OptionParser.add_option("--matchcolor",
action="store", type="inkbool",
dest="matchcolor", default=True,
help="If True, colors will be matched")

def effect(self):
"""
Effect behaviour.
Search for all paths that match the selected path
"""
foundLayer = self.options.foundLayer
matchcolor = self.options.matchcolor

# Get access to main SVG document element
svg = self.document.getroot()

# get the layer where the found paths will be moved to
layer = getLayer(svg, foundLayer)

# get a list of all path nodes
pathNodes = self.document.xpath('//svg:path',namespaces=inkex.NSS)

# setup stderr so that we can print to it for debugging
saveout = sys.stdout

sys.stdout = sys.stderr

rPathLen = 0
rPathList = []
rPathNode = None

if len(self.selected) == 0:
print "Nothing Selected"
sys.stdout = saveout
return

for id, node in self.selected.iteritems():
#print dir(node)
if node.tag == inkex.addNS('path','svg'):
#print node.attrib['d']
rPathList = parsePath(node.attrib['d'])
rPathLen = len(rPathList)
rPathNode = node
#print rPathLen
#print rPathList

for cPathNode in pathNodes:
cPathList = parsePath(cPathNode.attrib['d'])
cPathLen = len(cPathList)
#print cPathLen
#print cPathList
if rPathLen == cPathLen:
#print " Found %d in %s" % (rPathLen,cPathNode)

#print matchcolor
colorMatchFlag = (colorMatch(rPathNode,cPathNode) == 1) or not matchcolor
pathMatchFlag = pathMatch(rPathList,cPathList)==1

if pathMatchFlag and colorMatchFlag:
[rList,cList] = pathPullPoints(rPathList,cPathList)
corVal = correlation(rList,cList)
#print "The correlation was %g" % corVal
if (corVal > 0.80):
layer.append(cPathNode)

#print
#print 'This message will be logged instead of displayed'
sys.stdout = saveout

# Create effect instance and apply it.
effect = FindMatch()
effect.affect()

</pre>

FindMatch

2008-12-17T21:05:57Z

Aussie:

FindMatch

2008-12-17T21:04:48Z

Aussie:

The Find Match inx file

----
<nowiki>

<inkscape-extension>
<_name>Find Match</_name>
<id>org.find_match</id>
<dependency type="executable" location="extensions">findmatch.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="foundLayer" type="string" _gui-text="Name of layer to put found objects on?">Found</param>
<param name="threshold" type="float" min="0.0" max="1.0" _gui-text="Correlation Threshold">0.8</param>
<param name="matchcolor" type="boolean" _gui-text="Colors should match">true</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">findmatch.py</command>
</script>
</inkscape-extension>

</nowiki>

----

FindMatch

2008-12-17T21:03:17Z

Aussie:

The Find Match inx file

----
<source>

<inkscape-extension>
<_name>Find Match</_name>
<id>org.find_match</id>
<dependency type="executable" location="extensions">findmatch.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="foundLayer" type="string" _gui-text="Name of layer to put found objects on?">Found</param>
<param name="threshold" type="float" min="0.0" max="1.0" _gui-text="Correlation Threshold">0.8</param>
<param name="matchcolor" type="boolean" _gui-text="Colors should match">true</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">findmatch.py</command>
</script>
</inkscape-extension>

</source>

----

FindMatch

2008-12-17T21:02:33Z

Aussie:

The Find Match inx file

----
<source >
<inkscape-extension>
<_name>Find Match</_name>
<id>org.find_match</id>
<dependency type="executable" location="extensions">findmatch.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="foundLayer" type="string" _gui-text="Name of layer to put found objects on?">Found</param>
<param name="threshold" type="float" min="0.0" max="1.0" _gui-text="Correlation Threshold">0.8</param>
<param name="matchcolor" type="boolean" _gui-text="Colors should match">true</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">findmatch.py</command>
</script>
</inkscape-extension></source>

----

FindMatch

2008-12-17T21:00:39Z

Aussie: FindMatch Extension

The Find Match inx file

----
<nowiki><inkscape-extension>
<_name>Find Match</_name>
<id>org.find_match</id>
<dependency type="executable" location="extensions">findmatch.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="foundLayer" type="string" _gui-text="Name of layer to put found objects on?">Found</param>
<param name="threshold" type="float" min="0.0" max="1.0" _gui-text="Correlation Threshold">0.8</param>
<param name="matchcolor" type="boolean" _gui-text="Colors should match">true</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">findmatch.py</command>
</script>
</inkscape-extension></nowiki>

----

Extension repository

2008-12-17T20:58:17Z

Aussie: /* Extensions */

It would be very useful to have a central Internet repository for Inkscape extensions, similarly as Firefox has. This way, Inkscape could update installed extensions from the web site, with no need for the user to know if an extension is updated.

== Extensions ==

'''What extensions are there? We can start listing them here:'''
* [http://www.ekips.org/comp/inkscape/ Inkscape Effects] - Aaron Spikes set of extensions is now included in Inkscape.
* [[ExtrudeEffect]] - extrude polygons to "3d", also make "string art"
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeCalendarShellScript InkscapeCalendarShellScript] - Create Calendars sucks or is impracticable if you do not have something that automatizes the process of to put the days organized in blocks of months to you. To format manually is easy, but this extension can help you on this too [Bash script, works for win32 with cygwin].
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeAreaCuter InkscapeAreaCutter] - For Webdesigners, layout for sites, slice area into .png images. util! (pt_BR)
* [http://julvitard.free.fr/eqtexsvg/ EQTeXSVG] - EQTeXSVG is an extension for Inkscape used to convert an inline LATEX equation into SVG path using Python.
* [http://www.kono.cis.iwate-u.ac.jp/~arakit/inkscape/inklatex.html InkLaTeX] Insert LaTeX text or equations into Inkscape.
* [http://www.iki.fi/pav/software/textext/ TexText] Embed re-editable LaTeX objects in SVG drawings.
* [http://math.univ-lille1.fr/~barraud/Inkscape/pathdeform/ PathDeform] - Here is an Inkscape extension whose purpose is to bend a path according to another one. Note: it was added to Inkscape 0.45 as "Pattern along Path".
* [http://www.inkbar.lineaire.net/ InkBar] - This is an Inkscape extension whose purpose is to draw EAN13 bar code.
* [http://technoargia.free.fr/swftools/ SWF output] - A little extension to save as Swf from Inkscape.
* [http://www.colivre.coop.br/Aurium/Puff Puff] - Fluffs elements! :-D
* [http://www.colivre.coop.br/Aurium/InkSudoku Sudoku Generator] - Generates Sudoku square with the solution ''(in a small square if you want)''.
* [[CalligraphedOutlineFill]] - helps to fill in the inside area of shapes drawn with the Calligraphy tool
* [http://edlab.die.unipd.it/Site4.html SlotStar] - helps to draw the star of slot of a winding of an electrical machine
* [http://richard.henwood.googlepages.com/inkscapelatexextension inkscapeLatexExtension] - Extract text in an inkscape drawing to a latex picture environment.
* [http://saws.googlecode.com s.a.w.s] - export the svg Inkscape file in valid xhtml / css files.
* [http://www.colivre.coop.br/Aurium/InkscapeGenerator Generator] - replace text and data to automatic generate files done for usage (like PDF, PS, JPG, etc...), based in a SVG template and a data file.
* [http://code.google.com/p/inkscape2tikz/ TikZ exporter] - Export SVG paths as TikZ/PGF code for use with LaTeX.
* [[FindMatch]] - Looks for paths that match the selected path and places all matches on the same layer.

'''For Programmers:'''
* [http://www.colivre.coop.br/bin/view/Aurium/RubyInk RubyInk] - Inkscape extension with Ruby
* [http://www.colivre.coop.br/bin/view/Aurium/InkBash Ink-Bash] - <nowiki>ShellScript</nowiki> Forever!
* [http://www.colivre.coop.br/bin/view/Aurium/InkMoz InkMoz] - the Bridge from Inkscape to Mozilla (Inkscape extension with Javascript and more)

== The Repository Specification ==

A website where programmers can publish their extensions, users can search by that, and an update program can access this updates.

=== The Website ===

Must Have:
* '''User Registration''': to allow upload, votes and comments
* '''Extension Validation''': when published, it is public, but the user must be notified that was not validated (the code must be viewed by an validator user). The software updater do not update non-validated versions.
** '''Validation Feedback''': the validator user must write why the extension was not validated.
** '''Extension Deletion''': the validator user can delete an extension or version when he found a malicious code. The upload user must be marked as a malicious user and the account must be blocked.
* '''Extension Search''': with filter, by any available data.
* '''User Votes and Comments for Extensions''': The user can vote and/or comment an extension version.
* '''Extension Bug-Traker''': today, third part extensions are in simple web-pages. The site may have a Bug-Traker to help all little scripts.
* '''User Extensions Requests''': a lot of users have ideas. Here is a good place for programers see and make that alive.
* '''Host a cool page for the extension''': allow introduction text, documenbtation, screenshots, examples, and '''i18n'''!
* '''Help the l10n of this extensions''': with a web interface, like pootle and provide the l10n file for the updater program.
* '''Provide Version Control''': A SVN account will be cool, but web uploads (by web-forms) can be transparently SVN commits.

=== The Extension Meta-Data ===

''The data in INX file and more some, like the O.S. and Inkscape version compatibility...''

The INX file will define the meta-data settable by that. If some extension uses multiples INX files to have more than one option in the menu, all INX files must be read to set the meta-data. The meta-data will be cached in a database to help the search. The DB only need the meta-data of the last validated version and the last non-validated (if that is newer).

=== The Update Program ===

* '''Search for New Extensions''': when the user request
* '''Update Extensions''': search for updates and install that
* '''Help the Code Validation''': for advanced users. Show the extension code and the diff if is that an update.
* '''Help the User Bug-Reporting''': that is not working! The user must say now! ''(When the Update Program be part of the Inkscape, the error window can have a button to submit a bug-report)''
* '''Must test the extension dependencies''': the user must know what is needed to install before try to use.

== Name Proposal ==

Propose a name for the Inkscape Extension Repository:

* '''The Factory'''
* '''Extension Factory'''
* '''INX Factory'''

''Why Factory? Because it is not only a repository. ;-)''

[[Category:Developer Documentation]]
[[Category:Extensions]]

Extension repository

2008-12-17T20:57:27Z

Aussie: /* Extensions */

It would be very useful to have a central Internet repository for Inkscape extensions, similarly as Firefox has. This way, Inkscape could update installed extensions from the web site, with no need for the user to know if an extension is updated.

== Extensions ==

'''What extensions are there? We can start listing them here:'''
* [http://www.ekips.org/comp/inkscape/ Inkscape Effects] - Aaron Spikes set of extensions is now included in Inkscape.
* [[ExtrudeEffect]] - extrude polygons to "3d", also make "string art"
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeCalendarShellScript InkscapeCalendarShellScript] - Create Calendars sucks or is impracticable if you do not have something that automatizes the process of to put the days organized in blocks of months to you. To format manually is easy, but this extension can help you on this too [Bash script, works for win32 with cygwin].
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeAreaCuter InkscapeAreaCutter] - For Webdesigners, layout for sites, slice area into .png images. util! (pt_BR)
* [http://julvitard.free.fr/eqtexsvg/ EQTeXSVG] - EQTeXSVG is an extension for Inkscape used to convert an inline LATEX equation into SVG path using Python.
* [http://www.kono.cis.iwate-u.ac.jp/~arakit/inkscape/inklatex.html InkLaTeX] Insert LaTeX text or equations into Inkscape.
* [http://www.iki.fi/pav/software/textext/ TexText] Embed re-editable LaTeX objects in SVG drawings.
* [http://math.univ-lille1.fr/~barraud/Inkscape/pathdeform/ PathDeform] - Here is an Inkscape extension whose purpose is to bend a path according to another one. Note: it was added to Inkscape 0.45 as "Pattern along Path".
* [http://www.inkbar.lineaire.net/ InkBar] - This is an Inkscape extension whose purpose is to draw EAN13 bar code.
* [http://technoargia.free.fr/swftools/ SWF output] - A little extension to save as Swf from Inkscape.
* [http://www.colivre.coop.br/Aurium/Puff Puff] - Fluffs elements! :-D
* [http://www.colivre.coop.br/Aurium/InkSudoku Sudoku Generator] - Generates Sudoku square with the solution ''(in a small square if you want)''.
* [[CalligraphedOutlineFill]] - helps to fill in the inside area of shapes drawn with the Calligraphy tool
* [http://edlab.die.unipd.it/Site4.html SlotStar] - helps to draw the star of slot of a winding of an electrical machine
* [http://richard.henwood.googlepages.com/inkscapelatexextension inkscapeLatexExtension] - Extract text in an inkscape drawing to a latex picture environment.
* [http://saws.googlecode.com s.a.w.s] - export the svg Inkscape file in valid xhtml / css files.
* [http://www.colivre.coop.br/Aurium/InkscapeGenerator Generator] - replace text and data to automatic generate files done for usage (like PDF, PS, JPG, etc...), based in a SVG template and a data file.
* [http://code.google.com/p/inkscape2tikz/ TikZ exporter] - Export SVG paths as TikZ/PGF code for use with LaTeX.
* FindMatch - Looks for paths that match the selected path and places all matches on the same layer.

'''For Programmers:'''
* [http://www.colivre.coop.br/bin/view/Aurium/RubyInk RubyInk] - Inkscape extension with Ruby
* [http://www.colivre.coop.br/bin/view/Aurium/InkBash Ink-Bash] - <nowiki>ShellScript</nowiki> Forever!
* [http://www.colivre.coop.br/bin/view/Aurium/InkMoz InkMoz] - the Bridge from Inkscape to Mozilla (Inkscape extension with Javascript and more)

== The Repository Specification ==

A website where programmers can publish their extensions, users can search by that, and an update program can access this updates.

=== The Website ===

Must Have:
* '''User Registration''': to allow upload, votes and comments
* '''Extension Validation''': when published, it is public, but the user must be notified that was not validated (the code must be viewed by an validator user). The software updater do not update non-validated versions.
** '''Validation Feedback''': the validator user must write why the extension was not validated.
** '''Extension Deletion''': the validator user can delete an extension or version when he found a malicious code. The upload user must be marked as a malicious user and the account must be blocked.
* '''Extension Search''': with filter, by any available data.
* '''User Votes and Comments for Extensions''': The user can vote and/or comment an extension version.
* '''Extension Bug-Traker''': today, third part extensions are in simple web-pages. The site may have a Bug-Traker to help all little scripts.
* '''User Extensions Requests''': a lot of users have ideas. Here is a good place for programers see and make that alive.
* '''Host a cool page for the extension''': allow introduction text, documenbtation, screenshots, examples, and '''i18n'''!
* '''Help the l10n of this extensions''': with a web interface, like pootle and provide the l10n file for the updater program.
* '''Provide Version Control''': A SVN account will be cool, but web uploads (by web-forms) can be transparently SVN commits.

=== The Extension Meta-Data ===

''The data in INX file and more some, like the O.S. and Inkscape version compatibility...''

The INX file will define the meta-data settable by that. If some extension uses multiples INX files to have more than one option in the menu, all INX files must be read to set the meta-data. The meta-data will be cached in a database to help the search. The DB only need the meta-data of the last validated version and the last non-validated (if that is newer).

=== The Update Program ===

* '''Search for New Extensions''': when the user request
* '''Update Extensions''': search for updates and install that
* '''Help the Code Validation''': for advanced users. Show the extension code and the diff if is that an update.
* '''Help the User Bug-Reporting''': that is not working! The user must say now! ''(When the Update Program be part of the Inkscape, the error window can have a button to submit a bug-report)''
* '''Must test the extension dependencies''': the user must know what is needed to install before try to use.

== Name Proposal ==

Propose a name for the Inkscape Extension Repository:

* '''The Factory'''
* '''Extension Factory'''
* '''INX Factory'''

''Why Factory? Because it is not only a repository. ;-)''

[[Category:Developer Documentation]]
[[Category:Extensions]]