GNOME.org
 

[gimp-help] Update Ripple filter. Create about-common-features.xml and indexterm for Abyss Policy

commit 3601712150ba3ccb6eb6a89af6611fec8ee44377
Author: Julien Hardelin <jhardlin orange fr>
Date:   Thu Dec 27 08:33:01 2018 +0100

    Update Ripple filter. Create about-common-features.xml and indexterm for Abyss Policy

 images/C/filters/distort/ripple-dialog.png         | Bin 0 -> 29297 bytes
 images/C/filters/distort/ripple.png                | Bin 33579 -> 0 bytes
 .../C/filters/examples/distort/ripple-ex-ampl.png  | Bin 0 -> 6617 bytes
 .../C/filters/examples/distort/ripple-ex-angle.png | Bin 0 -> 9508 bytes
 .../C/filters/examples/distort/ripple-ex-black.png | Bin 0 -> 7994 bytes
 .../filters/examples/distort/ripple-ex-default.png | Bin 0 -> 5451 bytes
 .../C/filters/examples/distort/ripple-ex-orig.png  | Bin 0 -> 808 bytes
 .../filters/examples/distort/ripple-ex-period.png  | Bin 0 -> 5006 bytes
 .../C/filters/examples/distort/ripple-ex-phase.png | Bin 0 -> 5947 bytes
 src/filters/about-common-features.xml              |  11 ++
 src/filters/distort/ripple.xml                     | 188 +++++++++++++--------
 src/toolbox/transform/warp-transform.xml           |   1 +
 12 files changed, 134 insertions(+), 66 deletions(-)
---
diff --git a/images/C/filters/distort/ripple-dialog.png b/images/C/filters/distort/ripple-dialog.png
new file mode 100644
index 000000000..0bdbed5ab
Binary files /dev/null and b/images/C/filters/distort/ripple-dialog.png differ
diff --git a/images/C/filters/examples/distort/ripple-ex-ampl.png 
b/images/C/filters/examples/distort/ripple-ex-ampl.png
new file mode 100644
index 000000000..3ec458b78
Binary files /dev/null and b/images/C/filters/examples/distort/ripple-ex-ampl.png differ
diff --git a/images/C/filters/examples/distort/ripple-ex-angle.png 
b/images/C/filters/examples/distort/ripple-ex-angle.png
new file mode 100644
index 000000000..d196206dd
Binary files /dev/null and b/images/C/filters/examples/distort/ripple-ex-angle.png differ
diff --git a/images/C/filters/examples/distort/ripple-ex-black.png 
b/images/C/filters/examples/distort/ripple-ex-black.png
new file mode 100644
index 000000000..372f43ffe
Binary files /dev/null and b/images/C/filters/examples/distort/ripple-ex-black.png differ
diff --git a/images/C/filters/examples/distort/ripple-ex-default.png 
b/images/C/filters/examples/distort/ripple-ex-default.png
new file mode 100644
index 000000000..e26fab5da
Binary files /dev/null and b/images/C/filters/examples/distort/ripple-ex-default.png differ
diff --git a/images/C/filters/examples/distort/ripple-ex-orig.png 
b/images/C/filters/examples/distort/ripple-ex-orig.png
new file mode 100644
index 000000000..352acd4bd
Binary files /dev/null and b/images/C/filters/examples/distort/ripple-ex-orig.png differ
diff --git a/images/C/filters/examples/distort/ripple-ex-period.png 
b/images/C/filters/examples/distort/ripple-ex-period.png
new file mode 100644
index 000000000..380896c5d
Binary files /dev/null and b/images/C/filters/examples/distort/ripple-ex-period.png differ
diff --git a/images/C/filters/examples/distort/ripple-ex-phase.png 
b/images/C/filters/examples/distort/ripple-ex-phase.png
new file mode 100644
index 000000000..48c126069
Binary files /dev/null and b/images/C/filters/examples/distort/ripple-ex-phase.png differ
diff --git a/src/filters/about-common-features.xml b/src/filters/about-common-features.xml
new file mode 100644
index 000000000..c56db7f5e
--- /dev/null
+++ b/src/filters/about-common-features.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE note PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+                      "http://www.docbook.org/xml/4.3/docbookx.dtd";>
+<!--
+  This file is meant to be included by the GEGL filters files
+-->
+<note>
+  <para>
+    These options are described in <xref linkend="gimp-filters-common"/>.
+  </para>
+</note>
\ No newline at end of file
diff --git a/src/filters/distort/ripple.xml b/src/filters/distort/ripple.xml
index d293ffe61..afa8f2c0d 100644
--- a/src/filters/distort/ripple.xml
+++ b/src/filters/distort/ripple.xml
@@ -2,12 +2,9 @@
 <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                        "http://www.docbook.org/xml/4.3/docbookx.dtd";>
 <!-- section history:
-  2007-08-14 Added Spanish translation by AntI
-  2007-04-24 KoSt: added 'no'
-  2005-12-07 replaced <simplesect> by <sect3> by lexa
-  050910 de added by axel.wernicke
+  2018-12-26 j.h: update to v2.10
 -->
-<sect2 id="gimp-filter-ripple">
+<sect2 xmlns:xi="http://www.w3.org/2001/XInclude"; id="gimp-filter-ripple">
   <title>Ripple</title>
 
   <indexterm>
@@ -67,87 +64,129 @@
       <mediaobject>
         <imageobject>
           <imagedata format="PNG"
-            fileref="images/filters/distort/ripple.png"/>
+            fileref="images/filters/distort/ripple-dialog.png"/>
         </imageobject>
       </mediaobject>
     </figure>
     <variablelist>
       <varlistentry>
-        <term>Preview</term>
+        <term>Presets, Preview, Split view</term>
         <listitem>
-          <para>
-            The result of your settings will appear in the Preview without
-            affecting the image until you click on <guibutton>OK</guibutton>.
-          </para>
+          <xi:include href="../about-common-features.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>Options</term>
+        <term>Original images for examples</term>
         <listitem>
-          <variablelist>
-            <varlistentry>
-              <term><guilabel>Antialiasing</guilabel></term>
-              <listitem>
-                <para>
-                  This improves the scaled look the image borders may have.
-                </para>
-              </listitem>
-            </varlistentry>
-            <varlistentry>
-              <term><guilabel>Retain tileability</guilabel></term>
-              <listitem>
-                <para>
-                  This preserves the seamless properties if your image is a tile pattern.
-                </para>
-              </listitem>
-            </varlistentry>
-          </variablelist>
+          <mediaobject>
+            <imageobject>
+              <imagedata format="PNG"
+                fileref="images/filters/examples/distort/ripple-ex-orig.png"/>
+            </imageobject>
+            <caption>
+              Origin
+            </caption>
+          </mediaobject>
+          <mediaobject>
+            <imageobject>
+              <imagedata format="PNG"
+              fileref="images/filters/examples/distort/ripple-ex-default.png"/>
+            </imageobject>
+            <caption>
+              <para>
+                Ripple applied with default options
+              </para>
+            </caption>
+          </mediaobject>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>Orientation</term>
+        <term>Amplitude</term>
         <listitem>
           <para>
-            That's the <guilabel>Horizontal</guilabel> or
-            <guilabel>Vertical</guilabel> direction of waves.
+            It is related to wave height (0-200 pixels).
           </para>
+          <mediaobject>
+            <imageobject>
+              <imagedata format="PNG"
+                fileref="images/filters/examples/distort/ripple-ex-ampl.png"/>
+            </imageobject>
+            <caption>
+              <para>
+                Amplitude = 25
+              </para>
+            </caption>
+          </mediaobject>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>Edges</term>
+        <term>Period</term>
         <listitem>
           <para>
-            Because ripples cause pixel displacement, some pixels may be
-            missing on the image sides:
+            It is related to wavelength (0-200 pixels)
           </para>
-          <itemizedlist>
-            <listitem>
+          <mediaobject>
+            <imageobject>
+              <imagedata format="PNG"
+              fileref="images/filters/examples/distort/ripple-ex-periode.png"/>
+            </imageobject>
+            <caption>
               <para>
-                With <guilabel>Wrap</guilabel>, pixels going out one side
-                will come back on the other side, replacing so the missing
-                pixels.
+                Period = 110
               </para>
-            </listitem>
-            <listitem>
+            </caption>
+          </mediaobject>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Phase shift</term>
+        <listitem>
+          <para>
+            Wave is moved
+          </para>
+          <mediaobject>
+            <imageobject>
+              <imagedata format="PNG"
+                fileref="images/filters/examples/distort/ripple-ex-phase.png"/>
+            </imageobject>
+            <caption>
               <para>
-                With <guilabel>Smear</guilabel>, the adjacent pixels will
-                spread out to replace the mixing pixels.
+                Phase shift = 0.400
               </para>
-            </listitem>
-            <listitem>
+            </caption>
+          </mediaobject>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Angle</term>
+        <listitem>
+          <para>
+            Warps wave
+          </para>
+          <mediaobject>
+            <imageobject>
+              <imagedata format="PNG"
+                fileref="images/filters/examples/distort/ripple-ex-angle.png"/>
+            </imageobject>
+            <caption>
               <para>
-                With <guilabel>Blank</guilabel>, the missing pixels will be
-                replaced by black pixels, if the layer does not have an
-                Alpha channel. If an Alpha channel exists in the layer,
-                transparent pixels replace the missing pixels after applying
-                this option.
+                  Angle = -40°
               </para>
-            </listitem>
-          </itemizedlist>
+            </caption>
+          </mediaobject>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>Resampling methods</term>
+        <listitem>
+          <para>
+            These interpolation methods are described in 
+            <xref linkend="gimp-tool-interpolation-methods"/>.
+          </para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>Wave Type</term>
+        <term>Wave type</term>
         <listitem>
           <para>
             Choose how the wave should look like:
@@ -158,6 +197,11 @@
                 <guilabel>Sawtooth</guilabel>
               </para>
             </listitem>
+            <listitem>
+              <para>
+                <guilabel>Triangle</guilabel>
+              </para>
+            </listitem>
             <listitem>
               <para>
                 <guilabel>Sine</guilabel>
@@ -167,30 +211,42 @@
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>Period</term>
+        <term>Abyss policy</term>
         <listitem>
           <para>
-            It is related to wavelength (0-200 pixels)
+            Because ripples cause pixel displacement, some pixels may be
+            missing on the image sides:
+          </para>
+          <mediaobject>
+            <imageobject>
+              <imagedata format="PNG"
+                fileref="images/filters/examples/distort/ripple-ex-black.png"/>
+            </imageobject>
+            <caption>
+              <para>
+                  Abyss policy = Black
+              </para>
+            </caption>
+          </mediaobject>
+          <para>
+            Abyss policy (border management) is treated with 
+              <xref linkend="abyss-policy"/>.
           </para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>Amplitude</term>
+        <term>Tileable</term>
         <listitem>
           <para>
-            It is related to wave height (0-200 pixels).
+            This preserves the seamless properties if your image is a tile 
+            pattern.
           </para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>Phase shift</term>
+        <term>Use the selection as input, Use the entire layer as input</term>
         <listitem>
-          <para>
-            It is angle to delay the wave (0-360 degree). 
-            Appling this filter again with the same setting
-            but Phase shift differs by 180 brings the once processed image
-            back to become almost similar to the first original image.
-          </para>
+          <xi:include href="../about-common-features.xml"/>
         </listitem>
       </varlistentry>
     </variablelist>
diff --git a/src/toolbox/transform/warp-transform.xml b/src/toolbox/transform/warp-transform.xml
index 5d589fbcb..a70090225 100644
--- a/src/toolbox/transform/warp-transform.xml
+++ b/src/toolbox/transform/warp-transform.xml
@@ -227,6 +227,7 @@
       <varlistentry id="abyss-policy">
         <term>Abyss policy</term>
         <listitem>
+          <indexterm><primary>Abyss Policy</primary></indexterm>
           <para>
             <quote>Abyss</quote> is a term used by GIMP developers for 
             <quote>data outside the input buffer</quote>. The warp tool moves
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]