[gimp-help/screenshot_update_21028: 224/229] Update Spyrogimp documentation and images




commit 7de3f8bfaeea30bc0a1702740ac68843f13fb2b8
Author: Jacob Boerema <jgboerema gmail com>
Date:   Sat May 28 16:12:45 2022 -0400

    Update Spyrogimp documentation and images
    
    Images by Andre Klapper.
    
    Improved text in a few places and added info for the previously
    missing Visual tab.

 images/C/filters/render/spyrogimp.png   | Bin 14869 -> 52467 bytes
 images/C/filters/render/spyrogimp1.png  | Bin 17548 -> 48055 bytes
 images/C/filters/render/spyrogimp1a.png | Bin 0 -> 51472 bytes
 images/C/filters/render/spyrogimp2.png  | Bin 11559 -> 42473 bytes
 images/C/filters/render/spyrogimp3.png  | Bin 9377 -> 36298 bytes
 src/filters/render/spyrogimp.xml        | 144 ++++++++++++++++++++++----------
 6 files changed, 102 insertions(+), 42 deletions(-)
---
diff --git a/images/C/filters/render/spyrogimp.png b/images/C/filters/render/spyrogimp.png
index 207e6e2f0..2802bb551 100644
Binary files a/images/C/filters/render/spyrogimp.png and b/images/C/filters/render/spyrogimp.png differ
diff --git a/images/C/filters/render/spyrogimp1.png b/images/C/filters/render/spyrogimp1.png
index c517688c9..f6ef39c40 100644
Binary files a/images/C/filters/render/spyrogimp1.png and b/images/C/filters/render/spyrogimp1.png differ
diff --git a/images/C/filters/render/spyrogimp1a.png b/images/C/filters/render/spyrogimp1a.png
new file mode 100644
index 000000000..5c105e081
Binary files /dev/null and b/images/C/filters/render/spyrogimp1a.png differ
diff --git a/images/C/filters/render/spyrogimp2.png b/images/C/filters/render/spyrogimp2.png
index d7574db85..c645e59a9 100644
Binary files a/images/C/filters/render/spyrogimp2.png and b/images/C/filters/render/spyrogimp2.png differ
diff --git a/images/C/filters/render/spyrogimp3.png b/images/C/filters/render/spyrogimp3.png
index 5ff65ddb5..b20237ffa 100644
Binary files a/images/C/filters/render/spyrogimp3.png and b/images/C/filters/render/spyrogimp3.png differ
diff --git a/src/filters/render/spyrogimp.xml b/src/filters/render/spyrogimp.xml
index 664918295..10a874f85 100644
--- a/src/filters/render/spyrogimp.xml
+++ b/src/filters/render/spyrogimp.xml
@@ -34,7 +34,7 @@
       layer.
     </para>
     <para>
-      It reproduces curves drawn by Spirograph© toys. Here is an example 
+      It reproduces curves drawn by Spirograph© toys. Here is an example
       from Wikipedia showing what gears and holes are:
       <mediaobject>
         <imageobject>
@@ -43,7 +43,7 @@
         </imageobject>
         <caption>
           <para>
-            <emphasis>Moving gear</emphasis> is inside <emphasis>fixed 
+            <emphasis>Moving gear</emphasis> is inside <emphasis>fixed
               gear</emphasis> and only one <emphasis>hole</emphasis> is used.
           </para>
         </caption>
@@ -54,7 +54,7 @@
   <sect3>
     <title>Activating the filter</title>
     <para>
-      This filter is found in the image window menu under
+      This filter is found in the menu under
       <menuchoice>
         <guimenu>Filters</guimenu>
         <guisubmenu>Render</guisubmenu>
@@ -67,13 +67,14 @@
     <title>Selection and Tool</title>
     <para>
       Much of the behavior of the plugin is determined by options set outside
-      of the plugin, such as the current selection, or settings for gimp
-      tools. These settings can be changed while the plugin is running.
+      of the plugin, such as the current selection, or the settings of
+      <acronym>GIMP</acronym>'s tools. These settings can be changed while the
+      plugin is running.
     </para>
     <note>
       <para>
         In contrast to options within the plugin, changing the current selection
-        or tool settings will not redraw the pattern. To draw the change, click
+        or tool settings will not redraw the pattern. To show the changes, click
         the <guibutton>Redraw</guibutton> button at the bottom of the plugin.
       </para>
     </note>
@@ -81,9 +82,9 @@
     <sect4>
       <title>The Current Selection</title>
       <para>
-        As in most plugins, the current selection determines the area where the 
-        pattern will be rendered. Typically, this would be a rectangular 
-        selection. There is however, an additional way the selection can be 
+        As in most plugins, the current selection determines the area where the
+        pattern will be rendered. Typically, this would be a rectangular
+        selection. There is however, an additional way the selection can be
         used.
       </para>
       <para>
@@ -102,12 +103,12 @@
     <sect4>
       <title>Tool Settings</title>
       <para>
-        Spyrogimp uses gimp tools to perform the drawing.
-        All the settings with which the drawings are done are taken from the chosen tool.
-        For example, if you choose to use the 
-        <guimenuitem>Pencil</guimenuitem> tool (by choosing it from the 
-        <guilabel>Tool</guilabel> menu)then all the settings of the Gimp Pencil 
-        tool will be used for drawing. You can change any of the tool settings 
+        Spyrogimp uses <acronym>GIMP</acronym>'s tools to perform the drawing.
+        All the settings with which the drawings are done are taken from the
+        chosen tool. For example, if you want to use the
+        <guimenuitem>Pencil</guimenuitem> tool (by choosing it from the
+        <guilabel>Tool</guilabel> menu), then all the settings of this tool
+        will be used for drawing. You can change any of the tool settings
         while the plugin is running, and press the <guibutton>Redraw</guibutton>
         button to see how the pattern looks.
       </para>
@@ -116,7 +117,7 @@
     <sect4>
       <title>Gradient Settings</title>
       <para>
-        When using the <guilabel>long gradient</guilabel> mode, some settings 
+        When using the <guilabel>long gradient</guilabel> mode, some settings
         from the gradient tool are used.
       </para>
     </sect4>
@@ -141,9 +142,9 @@
     </figure>
     <note>
       <para>
-        This filter has been totally reimplemented since gimp
-        2.10.10 . If you are using an older version of gimp, your dialog will
-        look different.
+        This filter has been totally reimplemented since <acronym>GIMP</acronym>
+        2.10.10. If you are using an older version of <acronym>GIMP</acronym>,
+        your dialog will look different.
       </para>
     </note>
     <sect4>
@@ -159,16 +160,16 @@
               physical models for drawing them, using either gears or springs.
               Spyrograph and Epitrochoid curves are obtained by using two gears
               - a fixed gear, and a moving gear.
-              A <guimenuitem>Spyrograph</guimenuitem> pattern is obtained when 
+              A <guimenuitem>Spyrograph</guimenuitem> pattern is obtained when
               the moving gear is rotated inside the fixed gear.
-              When the moving gear is outside the fixed gear, an 
+              When the moving gear is outside the fixed gear, an
               <guimenuitem>Epitrochoid</guimenuitem> pattern is generated.
-              The <guimenuitem>Sine</guimenuitem> curve uses the fixed gear, but 
-              instead of a moving gear, there is a spring that moves 
+              The <guimenuitem>Sine</guimenuitem> curve uses the fixed gear, but
+              instead of a moving gear, there is a spring that moves
               perpendicular to the fixed gear's edge.
-              The <guimenuitem>Lissajous</guimenuitem> curve is generated by two springs - that move on
-              the x and y axis - it does not use the fixed ring at all, and thus is not affected by
-              changing it.
+              The <guimenuitem>Lissajous</guimenuitem> curve is generated by two
+              springs, which move on the x and y axis. It does not use the
+              fixed ring at all, and thus is not affected by changing it.
             </para>
             <figure>
               <title>
@@ -192,9 +193,10 @@
           <term>Tool</term>
           <listitem>
             <para>
-              The gimp tool with which to draw the pattern. The first tool is named
-              <guimenuitem>Preview</guimenuitem> and its purpose is to draw quickly, rather than
-              beautifully - so the pattern can be previewed. The other available tools are:
+              The <acronym>GIMP</acronym> tool with which to draw the pattern.
+              The first tool is named <guimenuitem>Preview</guimenuitem> and
+              its purpose is to draw quickly, rather than beautifully - so the
+              pattern can be previewed. The other available tools are:
               <guimenuitem>PaintBrush</guimenuitem>, <guimenuitem>Pencil</guimenuitem>,
               <guimenuitem>AirBrush</guimenuitem>, <guimenuitem>Stroke</guimenuitem>,
               <guimenuitem>Ink</guimenuitem>, and <guimenuitem>MyPaintBrush</guimenuitem>.
@@ -257,10 +259,12 @@
         </mediaobject>
       </figure>
       <para>
-        Specify pattern using either the <guilabel>Gears</guilabel> or <guilabel>Toy Kit</guilabel> tabs.
-        The pattern is specified only by the active tab. Toy Kit is similar to Gears,
-        but it uses gears and hole numbers which are found in toy kits.
-        If you follow the instructions from the toy kit manuals, you should obtain similar results.
+        Specify a pattern using the <guilabel>Gears</guilabel>, <guilabel>Toy Kit</guilabel>
+        or <guilabel>Visual</guilabel> tabs.
+        The pattern is based only on the settings of the active tab. Toy Kit is
+        similar to Gears, but it uses gears and hole numbers which are found in
+        toy kits. If you follow the instructions from the toy kit manuals, you
+        should obtain similar results.
       </para>
       <variablelist>
         <varlistentry>
@@ -294,8 +298,9 @@
 
       <para>
         The <guilabel>Toy Kit</guilabel> tab also has <guilabel>Fixed Gear Teeth</guilabel>
-        and <guilabel>Moving Gear Teeth</guilabel> options, however, these are menus
-        which limited to gear sizes that are provided with toy kits for drawing Spyrographs.
+        and <guilabel>Moving Gear Teeth</guilabel> options. In this case,
+        however, they are limited to gear sizes that are provided with toy kits
+        for drawing Spyrographs.
       </para>
       <variablelist>
         <varlistentry>
@@ -330,7 +335,61 @@
         </mediaobject>
       </figure>
 
-       <para>
+      <figure>
+        <title>
+          <quote>Spyrogimp</quote> filter options (Curve Pattern)
+        </title>
+        <mediaobject>
+          <imageobject>
+            <imagedata format="PNG" fileref="images/filters/render/spyrogimp1a.png"/>
+          </imageobject>
+          <caption>
+            <para>
+              The <guilabel>Visual</guilabel> tab is shown in the middle on the right side.
+            </para>
+          </caption>
+        </mediaobject>
+      </figure>
+      <para>
+        The <guilabel>Visual</guilabel> tab creates more rounded, flower petal
+        like patterns. It has the following settings:
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term>Flower Petals</term>
+          <listitem>
+            <para>
+              The number of flower petals to draw.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>Petal Skip</term>
+          <listitem>
+            <para>
+              The number of petals to skip.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>Hole radius (%)</term>
+          <listitem>
+            <para>
+              The size of the hole.
+            </para>
+          </listitem>
+        </varlistentry>
+        <varlistentry>
+          <term>Width (%)</term>
+          <listitem>
+            <para>
+              The width of the drawing.
+            </para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+
+      <para>
          Below the tabs there is an additional option.
        </para>
       <variablelist>
@@ -552,8 +611,8 @@
           <listitem>
             <para>
               If you change the settings of a tool, change color, or change the selection
-              (i.e., any settings outside of the plugin that effect the pattern),
-              press this to preview how the pattern looks.
+              (i.e., any settings outside of the plugin that affect the pattern),
+              press this to update the preview to see how the pattern looks.
             </para>
           </listitem>
         </varlistentry>
@@ -561,7 +620,7 @@
           <term>Reset</term>
           <listitem>
             <para>
-              Resets the dialog to its default options.
+              Resets the dialog to its default settings.
             </para>
           </listitem>
         </varlistentry>
@@ -591,9 +650,10 @@
               If unchecked, the layer is deleted, and the pattern is redrawn on the active layer.
             </para>
             <para>
-              One reason to not keep the layer, is that by using specific paint application modes,
-              redrawing the pattern on the active layer can interact with it in interesting ways, that
-              produce a different pattern had it been drawn on a new layer.
+              One reason not to keep the layer, is that by using specific paint
+              modes, redrawing the pattern on the active layer can give
+              interesting results. This can produce a different pattern than
+              when it been drawn on a new layer.
             </para>
           </listitem>
         </varlistentry>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]