MSL/Conjure - Documentation

Max <[email protected]> Tue, 30 Sep 2008 07:37:06 +0200
Newsgroups gmane.comp.video.graphicsmagick.bugs
Message-ID <20080930053706.GA8538@studiernix>
Hi there,
I added missing elements and attributes as far as they made sense to me.
I also added an example for composite since it's not that
straightforward to use.

I would like to make a new example for the image element since the one
in the documentation is not even valid XML!
The only problem: I couldn't figure out what it is supposed to do.
Any ideas?

BTW: The scripts in the doc folder use /usr/bin/sed but my sed is in
/bin/sed (and I don't think that's very exotic).
Of course ln can help here but I suggest to assume that
sed is always in $PATH ...

I'm using MSL mainly because I have to composite several image, resize
them and apply filters afterwards.
The code is generated by XSLT.
I couldn't figure out how to this in the shell with one command (and
even if I would have this oneliner would probably be unreadable).
And starting one process for every step is a huge overhead.
Perhaps one paragraph about the use cases and advantages of MSL would be
helpful.

Cheers
Max

On Mon, 22 Sep 2008, Bob Friesenhahn wrote:

> Documentation is surely an issue.  The other is that anything which  
> seems like "programming" seems to be bad for many users.  This likely  
> explains why ImageMagick has been focusing so much for the past few  
> years on supporting exotic command line incantations which substitute  
> for simple "programming".  However, the exotic command lines are  
> actually more difficult to understand.
>
> Yes, that is the right place.  Your help is certainly appreciated.
>
> If you are a Unix user (or possibly a Cygwin user) then if you are lucky 
> doing a 'make' in the doc tree should generate updated html and manual 
> pages.  If you are unluckly, 'sed' will core dump or some other bad thing 
> will happen.  Look at the top of convert.imdoc for a syntax summary of 
> the XML style formatting used in the documenation.

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/

_______________________________________________
Graphicsmagick-bugs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/graphicsmagick-bugs
conjure.imdoc.diff (text/x-diff, 2.5 KB)
Index: conjure.imdoc
===================================================================
RCS file: /GraphicsMagick/doc/gmdocs/conjure.imdoc,v
retrieving revision 1.4
diff -u -r1.4 conjure.imdoc
--- conjure.imdoc	8 Aug 2008 21:14:38 -0000	1.4
+++ conjure.imdoc	30 Sep 2008 05:24:15 -0000
@@ -134,6 +134,7 @@
 
 <dl>
 <dt><image></dt>
+<dd>background, color, id, size</dd>
 <dd>
 Define a new image object.  <s></image></s> destroys it. Because of
 this, if you wish to reference multiple "subimages" (aka pages or
@@ -193,6 +194,7 @@
 
 
 <dt><read></dt>
+    <dd>filename</dd>
 <dd>
 Read a new image from a disk file.
 </dd>
@@ -211,6 +213,7 @@
 </pre>
 </dd>
 <dt><write></dt>
+    <dd>filename</dd>
 <dd>Write the image(s) to disk, either as
 a single multiple-image file or multiple ones if necessary.
 </dd>
@@ -245,22 +248,56 @@
     <dd>geometry, height, width, x, y</dd>
 <dt><crop></dt>
     <dd>geometry, height, width, x, y</dd>
+<dt><composite></dt>
+    <dd>compose, geometry, gravity, image, x, y</dd>
+<dd>
+<pre>
+    <?xml version="1.0" encoding="UTF-8"?>
+    <group>
+        <image id="image_01">
+            <read filename="cloud3.gif"/>
+            <resize geometry="250x90"/>
+        </image>
+        <image id="image_02">
+            <read filename="cloud4.gif"/>
+            <resize geometry="190x100"/>
+        </image>
+        <image>
+            <read filename="background.jpg"/>
+            <composite image="image_01" geometry="+740+470"/>
+            <composite image="image_02" geometry="+390+415"/>
+        </image>
+        <write filename="result.png"/>
+    </group>
+</pre>
+</dd>
 <dt><despeckle></dt>
 <dt><emboss></dt>
     <dd>radius, sigma</dd>
 <dt><enhance></dt>
 <dt><equalize></dt>
+<dt><edge></dt>
+    <dd>radius</dd>
 <dt><flip></dt>
 <dt><flop></dt>
 <dt><frame></dt>
     <dd>fill, geometry, height, width, x, y, inner, outer</dd>
+<dt><flatten></dt>
 <dt><get></dt>
     <dd>height, width</dd>
+<dt><gamma></dt>
+    <dd>red, green, blue</dd>
 <dt><image></dt>
     <dd>background, color, id, size</dd>
+<dt><implode></dt>
+    <dd>amount</dd>
 <dt><magnify></dt>
 <dt><minify></dt>
+<dt><medianfilter></dt>
+    <dd>radius</dd>
 <dt><normalize></dt>
+<dt><oilpaint></dt>
+    <dd>radius</dd>
 <dt><print></dt>
     <dd>output</dd>
 <dt><read></dt>
@@ -270,6 +307,8 @@
     <dd>geometry, x, y</dd>
 <dt><rotate></dt>
     <dd>degrees</dd>
+<dt><reducenoise></dt>
+    <dd>radius</dd>
 <dt><sample></dt>
     <dd>geometry, height, width</dd>
 <dt><scale></dt>