[gimp-help-2] Add the Weave artistic filter

[RyoTa SimaMoto <rsimamoto src gnome org>]

commit ca7e47e481025e29df6e491a4325e44856b0d262
Author: SimaMoto,RyÅ?Ta <rsimamoto src gnome org>
Date:   Wed Apr 21 22:08:36 2010 +0900

    Add the Weave artistic filter

 images/C/filters/examples/artistic-taj-weave.jpg   |  Bin 0 -> 23349 bytes
 .../filters/examples/artistic-weave-as-lattice.jpg |  Bin 0 -> 28410 bytes
 images/C/filters/options-artistic-weave.png        |  Bin 0 -> 1695 bytes
 src/filters/artistic/weave.xml                     |  180 ++++++++++++++++++++
 4 files changed, 180 insertions(+), 0 deletions(-)
---
diff --git a/images/C/filters/examples/artistic-taj-weave.jpg b/images/C/filters/examples/artistic-taj-weave.jpg
new file mode 100644
index 0000000..44d7aa5
Binary files /dev/null and b/images/C/filters/examples/artistic-taj-weave.jpg differ
diff --git a/images/C/filters/examples/artistic-weave-as-lattice.jpg b/images/C/filters/examples/artistic-weave-as-lattice.jpg
new file mode 100644
index 0000000..6f691ab
Binary files /dev/null and b/images/C/filters/examples/artistic-weave-as-lattice.jpg differ
diff --git a/images/C/filters/options-artistic-weave.png b/images/C/filters/options-artistic-weave.png
new file mode 100644
index 0000000..d83be8e
Binary files /dev/null and b/images/C/filters/options-artistic-weave.png differ
diff --git a/src/filters/artistic/weave.xml b/src/filters/artistic/weave.xml
new file mode 100644
index 0000000..c1b7daf
--- /dev/null
+++ b/src/filters/artistic/weave.xml
@@ -0,0 +1,180 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+                       "http://www.docbook.org/xml/4.3/docbookx.dtd";>
+<!-- section history:
+  2010-02-23 liangtai: created initial version
+-->
+<sect2 id="script-fu-weave">
+  <title>Weave</title>
+
+  <indexterm>
+    <primary>Filters</primary>
+    <secondary>Artistic</secondary>
+    <tertiary>Weave</tertiary>
+  </indexterm>
+  <indexterm>
+    <primary>Weave</primary>
+  </indexterm>
+
+  <sect3>
+    <title>Overview</title>
+    <figure>
+      <title>Example of Weave</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="JPG"
+            fileref="images/filters/examples/artistic-taj-weave.jpg"/>
+        </imageobject>
+        <caption>
+          <para>Filter <quote>Weave</quote> applied</para>
+        </caption>
+      </mediaobject>
+    </figure>
+    <para>
+      The <guimenuitem>Weave</guimenuitem> command is a Script-Fu script
+      which creates a new layer filled with a weave effect and adds it to
+      the image as an overlay or bump map.  The result of the image looks
+      as if it were printed over woven ribbons of paper, thin wooden sheet,
+      or stripped bamboo.  If the image is in indexed colors, this menu
+      entry is grayed out and unavailable.
+    </para>
+    <para>
+      This filter adds a <quote>Multiply</quote> mode layer upon the layer
+      where you activate this command.
+      The weave texture is rendered in gray levels.
+    </para>
+  </sect3>
+
+  <sect3>
+    <title>Activate the filter</title>
+    <para>
+      This filter is found in the image window menu under
+      <menuchoice>
+        <guimenu>Filters</guimenu>
+        <guisubmenu>Artistic</guisubmenu>
+        <guimenuitem>Weave...</guimenuitem>
+      </menuchoice>.
+    </para>
+  </sect3>
+
+  <sect3>
+    <title>Options</title>
+    <figure>
+      <title><quote>Weave</quote> filter options</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="PNG"
+            fileref="images/filters/options-artistic-weave.png"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+    <para>
+      For to make coarse mesh texture, increase the ribbon spacing and/or
+      decrease the ribbon width.
+    </para>
+    <para>
+      For to strain ribbons hard, decrease the shadow depth.
+    </para>
+    <variablelist>
+      <varlistentry>
+        <term>Ribbon width</term>
+        <listitem>
+          <para>
+            With this option you can set the tape width in pixel between
+            0.0 and 256.0.  In default, 30.0 pixels is set.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Ribbon spacing</term>
+        <listitem>
+          <para>
+            With this option you can set the distance to the neighboring
+            ribbon or the size of black square hole in pixel between 0.0
+            and 256.0.  In default, 10.0 pixels is set.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Shadow darkness</term>
+        <listitem>
+          <para>
+            With this option you can set the darkness at crossings of lower
+            ribbon in percentage.  Lower value shows ribbons thinner.  75.0
+            percent is the default value.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Shadow depth</term>
+        <listitem>
+          <para>
+            With this option you can set the bent strength of ribbons in
+            percentage.  Higher value shows ribbons more wavy, lower value
+            for flat surface.  The actual effect is limited by the
+            <guilabel>Shadow darkness</guilabel>.
+            75.0 percent is the default value.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Thread length</term>
+        <listitem>
+          <para>
+            With this option you can set the regularity of stripe texture.
+            If this value is shorter than the summary of the ribbon width
+            and twice of the ribbon spacing, the surface of ribbon becomes
+            speckled.  Set this value in pixel on range between 0.0 to
+            256.0.  The default value is 200.0.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Thread density</term>
+        <listitem>
+          <para>
+            % 50.0 0-100
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Thread intensity</term>
+        <listitem>
+          <para>
+            % 100.0 0-100
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </sect3>
+
+  <sect3>
+    <title>Another usage</title>
+    <figure>
+      <title>Adding a lattice using <quote>Weave</quote> texture</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata format="JPG"
+            fileref="images/filters/examples/artistic-weave-as-lattice.jpg"/>
+        </imageobject>
+        <caption>
+          <para>
+            Narrower the ribbon width, wider the ribbon spacing, and
+            filled with the <quote>Wood #1</quote> pattern.
+          </para>
+        </caption>
+      </mediaobject>
+    </figure>
+    <para>
+      This texture can be a lattice that you can see the original image
+      through its mesh holes.  Add a layer over the original image for the
+      lattice, and apply this filter.  Select a black regular square in the
+      texture layer by clicking with the By Color Select Tool, then delete
+      black squares in selection on the texture layer to be chink holes.
+      Reverse the selection, and add layer mask to the lattice layer from
+      the reversed selection.  Activate the upper layer so that you can
+      fill the lattice surface with a pattern, then drag and drop your
+      favorite pattern over the image window.
+    </para>
+  </sect3>
+</sect2>