GNOME.org
 

[gimp-help-2] More changes to the tools docs

commit 13fb6e33b182ce7384e4e5aab0ab0f3be00e1706
Author: Ulf-D. Ehlert <ulfehlert svn gnome org>
Date:   Sat Mar 13 19:06:16 2010 +0100

    More changes to the tools docs
    
    * Add menu screenshot and a short overview section for Other tools.
    * Rename Other tools: toolbox/tool-foo.xml -> toolbox/foo.xml.
    * Rename about-common-brush-options.xml to about-common-paint-options.xml.
    * Re-enable help-ids "gimp-toolbox-default-colors" and
      "gimp-toolbox-swap-colors" (move the id from <anchor> to <varlistentry>).
    * Rename "Main Toolbox" to "Toolbox".
    * Remove zombie: src/menus/tools-introduction.xml.
    * Misc changes like adding <acronym> tags etc.

 images/C/toolbox/other-tools.png                   |  Bin 0 -> 6360 bytes
 src/concepts/setup.xml                             |    3 -
 src/concepts/toolbox.xml                           |   20 +++---
 src/menus/tools-introduction.xml                   |   30 ---------
 src/toolbox/about-common-painting-options.xml      |    2 +-
 .../{tool-color-picker.xml => color-picker.xml}    |    2 +-
 src/toolbox/color/curves.xml                       |    4 +-
 src/toolbox/intro.xml                              |   65 +++++++++++---------
 src/toolbox/{tool-measure.xml => measure.xml}      |    0
 src/toolbox/other-tools.xml                        |   57 ++++++++++++++++--
 src/toolbox/paint/about-common-brush-options.xml   |   13 ----
 src/toolbox/paint/about-common-paint-options.xml   |   12 ++++
 src/toolbox/paint/airbrush.xml                     |    2 +-
 src/toolbox/paint/blend.xml                        |    2 +-
 src/toolbox/paint/clone.xml                        |    2 +-
 src/toolbox/paint/convolve.xml                     |    2 +-
 src/toolbox/paint/dodge-burn.xml                   |    2 +-
 src/toolbox/paint/eraser.xml                       |    2 +-
 src/toolbox/paint/heal.xml                         |    2 +-
 src/toolbox/paint/ink.xml                          |    2 +-
 src/toolbox/paint/paintbrush.xml                   |    2 +-
 src/toolbox/paint/pencil.xml                       |    2 +-
 src/toolbox/paint/perspective-clone.xml            |    2 +-
 src/toolbox/paint/smudge.xml                       |    2 +-
 src/toolbox/{tool-path.xml => path.xml}            |    0
 src/toolbox/{tool-text.xml => text.xml}            |    0
 src/toolbox/toolbox-color-area.xml                 |    7 +-
 src/toolbox/{tool-zoom.xml => zoom.xml}            |    0
 src/using/paths.xml                                |    2 +-
 29 files changed, 128 insertions(+), 113 deletions(-)
---
diff --git a/images/C/toolbox/other-tools.png b/images/C/toolbox/other-tools.png
new file mode 100644
index 0000000..69fb127
Binary files /dev/null and b/images/C/toolbox/other-tools.png differ
diff --git a/src/concepts/setup.xml b/src/concepts/setup.xml
index 1ec1dad..cf4d03b 100644
--- a/src/concepts/setup.xml
+++ b/src/concepts/setup.xml
@@ -34,9 +34,6 @@
 
   <sect2>
     <title>Finally . . . </title>
-    <!-- TODO: "Tip of the Day" is no longer displayed automatically, is it?
-         (ude 2009-06-29)
-    -->
     <para>
       Just a couple of suggestions before you start, though:
       First, <acronym>GIMP</acronym> provides tips you can read at any time
diff --git a/src/concepts/toolbox.xml b/src/concepts/toolbox.xml
index ab13b6d..3b7b2f4 100644
--- a/src/concepts/toolbox.xml
+++ b/src/concepts/toolbox.xml
@@ -13,7 +13,7 @@
   2005-09-03: Addition en;fr at file end
 -->
 <sect2 id="gimp-concepts-toolbox">
-  <title>The Main Toolbox</title>
+  <title>The Toolbox</title>
   <indexterm>
     <primary>Toolbox</primary>
     <secondary>Introduction</secondary>
@@ -29,20 +29,18 @@
     </mediaobject>
   </figure>
   <para>
-    The Main Toolbox is the heart of <acronym>GIMP</acronym>. If you close it,
-    you quit <acronym>GIMP</acronym>.
-    Here is a quick tour of what you will find there.
+    The Toolbox is the heart of <acronym>GIMP</acronym>. If you close it, you
+    quit <acronym>GIMP</acronym>. Here is a quick tour of what you will find
+    there.
   </para>
   <tip>
     <para>
       In the Toolbox, as in most parts of <acronym>GIMP</acronym>, moving the
-      mouse over
-      something and letting it rest for a moment, usually displays
-      a <quote>tooltip</quote> that describes the thing. Short cut keys
-      are also frequently shown in the tooltip.
-      In many cases, you can hover the mouse over an item and press
-      the <keycap>F1</keycap> key to get help about the thing that is
-      underneath the mouse.
+      mouse over something and letting it rest for a moment, usually displays
+      a <quote>tooltip</quote> that describes the thing. Short cut keys are
+      also frequently shown in the tooltip. In many cases, you can hover the
+      mouse over an item and press the <keycap>F1</keycap> key to get help
+      about the thing that is underneath the mouse.
     </para>
   </tip>
   <orderedlist>
diff --git a/src/toolbox/about-common-painting-options.xml b/src/toolbox/about-common-painting-options.xml
index b80d8ef..386edd1 100644
--- a/src/toolbox/about-common-painting-options.xml
+++ b/src/toolbox/about-common-painting-options.xml
@@ -3,7 +3,7 @@
                       "http://www.docbook.org/xml/4.3/docbookx.dtd";>
 <!--
   This file is meant to be included by the brush tools files:
-      src/toolbox/tool-{pencil,paintbrush,ink}.xml.
+      src/toolbox/paint/{pencil,paintbrush,ink}.xml.
 -->
 <note>
   <para>
diff --git a/src/toolbox/tool-color-picker.xml b/src/toolbox/color-picker.xml
similarity index 99%
rename from src/toolbox/tool-color-picker.xml
rename to src/toolbox/color-picker.xml
index efaec1d..7cafad2 100644
--- a/src/toolbox/tool-color-picker.xml
+++ b/src/toolbox/color-picker.xml
@@ -32,7 +32,7 @@
   </indexterm>
 
   <figure>
-    <title>Eye dropper</title>
+    <title>The Color Picker in the toolbox (eye dropper icon)</title>
     <mediaobject>
       <imageobject>
         <imagedata format="PNG"
diff --git a/src/toolbox/color/curves.xml b/src/toolbox/color/curves.xml
index 6a299e3..93ad98a 100644
--- a/src/toolbox/color/curves.xml
+++ b/src/toolbox/color/curves.xml
@@ -150,8 +150,8 @@
                   <emphasis>Dark</emphasis> means
                   <emphasis>very transparent</emphasis>.
                   <emphasis>Light</emphasis> means <emphasis>very
-                  opaque</emphasis>. Your image or active layer must have 
-						an Alpha channel for this option to be enabled.
+                  opaque</emphasis>. Your image or active layer must have
+                  an Alpha channel for this option to be enabled.
                 </para>
               </listitem>
             </varlistentry>
diff --git a/src/toolbox/intro.xml b/src/toolbox/intro.xml
index bb68f2d..df49277 100644
--- a/src/toolbox/intro.xml
+++ b/src/toolbox/intro.xml
@@ -18,30 +18,35 @@
   </indexterm>
 
   <para>
-    The <acronym>GIMP</acronym>
-    provides a comprehensive toolbox in order to quickly perform basic tasks
-    such as making selections or drawing paths. The many tools contained
-    within The <acronym>GIMP</acronym>'s toolbox are discussed in detail here.
+    <acronym>GIMP</acronym> provides a comprehensive toolbox in order to
+    quickly perform basic tasks such as making selections or drawing paths.
+    The many tools contained within <acronym>GIMP</acronym>'s toolbox are
+    discussed in detail here.
   </para>
   <para>
-    (In case you're curious, in GIMP lingo a "tool" is a way of acting on an
-    image that requires access to its display, either to let you indicate what
-    you want to do by moving the pointer around inside the display, or to show
-    you interactively the results of changes that you have made. But if you
-    want to think of a tool as a saw, and an image as a piece of wood, it
-    probably won't do you a great deal of harm.)
+    (In case you're curious, in <acronym>GIMP</acronym> lingo a "tool" is a
+    way of acting on an image that requires access to its display, either to
+    let you indicate what you want to do by moving the pointer around inside
+    the display, or to show you interactively the results of changes that you
+    have made. But if you want to think of a tool as a saw, and an image as a
+    piece of wood, it probably won't do you a great deal of harm.)
   </para>
+  <note>
+    <para>
+      See <link linkend="gimp-concepts-toolbox">Main Windows: The
+      Toolbox</link> for an overview of the toolbox and its components.
+    </para>
+  </note>
   <para>
-    GIMP has a diverse assortment of tools that let you perform a large
-    variety of tasks. The tools can be thought of as falling into five
-    categories: <emphasis>Selection tools</emphasis>,
-    which specify or modify the portion of the image that will be affected
-    by subsequent actions; <emphasis>Paint tools</emphasis>,
-    which alter the colors in some part of the image;
-    <emphasis>Transform tools</emphasis>, which alter the geometry of the
-    image; <emphasis>Color tools</emphasis>, which alter the distribution of
-    colors across the entire image; and <emphasis>Other tools</emphasis>,
-    which don't fall into the other four categories.
+    <acronym>GIMP</acronym> has a diverse assortment of tools that let you
+    perform a large variety of tasks. The tools can be thought of as falling
+    into five categories: <emphasis>Selection tools</emphasis>, which specify
+    or modify the portion of the image that will be affected by subsequent
+    actions; <emphasis>Paint tools</emphasis>, which alter the colors in some
+    part of the image; <emphasis>Transform tools</emphasis>, which alter the
+    geometry of the image; <emphasis>Color tools</emphasis>, which alter the
+    distribution of colors across the entire image; and <emphasis>Other
+    tools</emphasis>, which don't fall into the other four categories.
   </para>
   <para>
     Most tools can be activated by clicking on an icon in the Toolbox.
@@ -60,16 +65,16 @@
     accelerator key.
   </para>
   <para>
-    In the default setup, created when GIMP is first installed, not all tools
-    show icons in the Toolbox: the Color tools are omitted. You can customize
-    the set of tools that are shown in the Toolbox using the
-    <link linkend="gimp-tools-dialog">Tools dialog</link>.
-    There are two reasons you might want to do this: first, if you only
-    rarely use a tool, it might be easier to find the tools you want if the
-    distracting icon is removed; second, if you use the Color tools a lot, you
-    might find it convenient to have icons for them easily available. In any
-    case, regardless of the Toolbox, you can always access any tool at any
-    time using the <guimenu>Tools</guimenu> menu from an image menubar.
+    In the default setup, created when <acronym>GIMP</acronym> is first
+    installed, not all tools show icons in the Toolbox: the Color tools are
+    omitted. You can customize the set of tools that are shown in the Toolbox
+    using the <link linkend="gimp-tools-dialog">Tools dialog</link>. There are
+    two reasons you might want to do this: first, if you only rarely use a
+    tool, it might be easier to find the tools you want if the distracting
+    icon is removed; second, if you use the Color tools a lot, you might find
+    it convenient to have icons for them easily available. In any case,
+    regardless of the Toolbox, you can always access any tool at any time
+    using the <guimenu>Tools</guimenu> menu from an image menubar.
   </para>
   <para>
     The shape of the cursor changes when it is inside an image, to one that
diff --git a/src/toolbox/tool-measure.xml b/src/toolbox/measure.xml
similarity index 100%
rename from src/toolbox/tool-measure.xml
rename to src/toolbox/measure.xml
diff --git a/src/toolbox/other-tools.xml b/src/toolbox/other-tools.xml
index 32c57fc..762898e 100644
--- a/src/toolbox/other-tools.xml
+++ b/src/toolbox/other-tools.xml
@@ -2,6 +2,7 @@
 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                        "http://www.docbook.org/xml/4.3/docbookx.dtd";>
 <!-- section history:
+  2010-03-13 ude: added overview & menu screenshot
   2010-02-18 ude: added GEGL Operations
   2007-06-03 kost: added 'no'
   2005-08-17 axel.wernicke relocated blend to paint tools
@@ -9,10 +10,56 @@
 -->
 <sect1 xmlns:xi="http://www.w3.org/2001/XInclude"; id="gimp-tools-other">
   <title>Other</title>
-  <xi:include href="tool-path.xml"/>
-  <xi:include href="tool-color-picker.xml"/>
-  <xi:include href="tool-zoom.xml"/>
-  <xi:include href="tool-measure.xml"/>
-  <xi:include href="tool-text.xml"/>
+
+  <indexterm>
+    <primary>Tools</primary>
+    <secondary>Miscellaneous</secondary>
+  </indexterm>
+
+  <sect2 id="gimp-tools-other-overview">
+    <title>Overview</title>
+
+    <figure>
+      <title>Other Tools in the Tools Menu</title>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="images/toolbox/other-tools.png" format="PNG"/>
+        </imageobject>
+      </mediaobject>
+    </figure>
+    <para>
+      <quote>Other</quote> tools are simply those tools which don't belong to
+      any main group of tools. You will find here, for example, the important
+      and powerful <link linkend="gimp-tool-path">Path</link> tool as well as
+      useful helper tools like the
+      <link linkend="gimp-tool-color-picker">Color Picker</link>:
+    </para>
+    <itemizedlist>
+      <listitem>
+        <para><xref linkend="gimp-tool-path"/></para>
+      </listitem>
+      <listitem>
+        <para><xref linkend="gimp-tool-color-picker"/></para>
+      </listitem>
+      <listitem>
+        <para><xref linkend="gimp-tool-zoom"/></para>
+      </listitem>
+      <listitem>
+        <para><xref linkend="gimp-tool-measure"/></para>
+      </listitem>
+      <listitem>
+        <para><xref linkend="gimp-tool-text"/></para>
+      </listitem>
+      <listitem>
+        <para><xref linkend="gimp-tool-gegl"/></para>
+      </listitem>
+    </itemizedlist>
+  </sect2>
+
+  <xi:include href="path.xml"/>
+  <xi:include href="color-picker.xml"/>
+  <xi:include href="zoom.xml"/>
+  <xi:include href="measure.xml"/>
+  <xi:include href="text.xml"/>
   <xi:include href="gegl-operation.xml"/>
 </sect1>
diff --git a/src/toolbox/paint/about-common-paint-options.xml b/src/toolbox/paint/about-common-paint-options.xml
new file mode 100644
index 0000000..c264956
--- /dev/null
+++ b/src/toolbox/paint/about-common-paint-options.xml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE simpara 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 paint tools files:
+  src/toolbox/paint/*.xml
+-->
+<simpara>
+  See the <link linkend="gimp-tools-paint-options">Common Paint Tool
+  Options</link> for a description of tool options that apply to many or all
+  paint tools.
+</simpara>
diff --git a/src/toolbox/paint/airbrush.xml b/src/toolbox/paint/airbrush.xml
index 0f3d4b4..5c50b84 100644
--- a/src/toolbox/paint/airbrush.xml
+++ b/src/toolbox/paint/airbrush.xml
@@ -116,7 +116,7 @@
           Apply Jitter; Use color from gradient
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/blend.xml b/src/toolbox/paint/blend.xml
index 06172a9..359238e 100644
--- a/src/toolbox/paint/blend.xml
+++ b/src/toolbox/paint/blend.xml
@@ -144,7 +144,7 @@
       <varlistentry>
         <term>Mode; Opacity</term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/clone.xml b/src/toolbox/paint/clone.xml
index 0b1737c..298c526 100644
--- a/src/toolbox/paint/clone.xml
+++ b/src/toolbox/paint/clone.xml
@@ -171,7 +171,7 @@
           Hard Edges
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/convolve.xml b/src/toolbox/paint/convolve.xml
index 19c3b8a..d25451e 100644
--- a/src/toolbox/paint/convolve.xml
+++ b/src/toolbox/paint/convolve.xml
@@ -144,7 +144,7 @@
           Hard Edges
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/dodge-burn.xml b/src/toolbox/paint/dodge-burn.xml
index 5743c8b..5a2c0b6 100644
--- a/src/toolbox/paint/dodge-burn.xml
+++ b/src/toolbox/paint/dodge-burn.xml
@@ -119,7 +119,7 @@
           Jitter, Hard edges
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/eraser.xml b/src/toolbox/paint/eraser.xml
index a4792bf..b25c8ef 100644
--- a/src/toolbox/paint/eraser.xml
+++ b/src/toolbox/paint/eraser.xml
@@ -187,7 +187,7 @@
           Brush; Scale; Brush Dynamics; Fade Out; Apply Jitter; Incremental
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/heal.xml b/src/toolbox/paint/heal.xml
index 377a743..7b8e69e 100644
--- a/src/toolbox/paint/heal.xml
+++ b/src/toolbox/paint/heal.xml
@@ -138,7 +138,7 @@
           Hard Edges
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/ink.xml b/src/toolbox/paint/ink.xml
index 0a10147..186a83f 100644
--- a/src/toolbox/paint/ink.xml
+++ b/src/toolbox/paint/ink.xml
@@ -102,7 +102,7 @@
       <varlistentry>
         <term>Mode; Opacity</term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/paintbrush.xml b/src/toolbox/paint/paintbrush.xml
index ec45be2..8618e25 100644
--- a/src/toolbox/paint/paintbrush.xml
+++ b/src/toolbox/paint/paintbrush.xml
@@ -111,7 +111,7 @@
           Jitter; Incremental; Use Color from Gradient
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
     </variablelist>
diff --git a/src/toolbox/paint/pencil.xml b/src/toolbox/paint/pencil.xml
index 4427a3f..12eab4b 100644
--- a/src/toolbox/paint/pencil.xml
+++ b/src/toolbox/paint/pencil.xml
@@ -132,7 +132,7 @@
           Jitter; Incremental; Use Color from Gradient
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
     </variablelist>
diff --git a/src/toolbox/paint/perspective-clone.xml b/src/toolbox/paint/perspective-clone.xml
index c41cbda..fdae5a6 100644
--- a/src/toolbox/paint/perspective-clone.xml
+++ b/src/toolbox/paint/perspective-clone.xml
@@ -128,7 +128,7 @@
           Hard Edge
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
       <varlistentry>
diff --git a/src/toolbox/paint/smudge.xml b/src/toolbox/paint/smudge.xml
index 00ed96f..fbcd456 100644
--- a/src/toolbox/paint/smudge.xml
+++ b/src/toolbox/paint/smudge.xml
@@ -123,7 +123,7 @@
           edges; Rate
         </term>
         <listitem>
-          <xi:include href="about-common-brush-options.xml"/>
+          <xi:include href="about-common-paint-options.xml"/>
         </listitem>
       </varlistentry>
     </variablelist>
diff --git a/src/toolbox/tool-path.xml b/src/toolbox/path.xml
similarity index 100%
rename from src/toolbox/tool-path.xml
rename to src/toolbox/path.xml
diff --git a/src/toolbox/tool-text.xml b/src/toolbox/text.xml
similarity index 100%
rename from src/toolbox/tool-text.xml
rename to src/toolbox/text.xml
diff --git a/src/toolbox/toolbox-color-area.xml b/src/toolbox/toolbox-color-area.xml
index 10b5fd8..87454a6 100644
--- a/src/toolbox/toolbox-color-area.xml
+++ b/src/toolbox/toolbox-color-area.xml
@@ -29,6 +29,7 @@
     <indexterm>
       <primary>Background color</primary>
     </indexterm>
+
     <figure>
       <title>Color area in the Toolbox Palette</title>
       <mediaobject>
@@ -50,10 +51,9 @@
           </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
+      <varlistentry id="gimp-toolbox-default-colors">
         <term>Default colors</term>
         <listitem>
-          <anchor id="gimp-toolbox-default-colors"/>
           <para>
             Clicking on this small symbol resets the Foreground and Background
             colors to black and white, respectively. Pressing the
@@ -61,10 +61,9 @@
           </para>
         </listitem>
       </varlistentry>
-      <varlistentry>
+      <varlistentry id="gimp-toolbox-swap-colors">
         <term>Swap FG/BG colors</term>
         <listitem>
-          <anchor id="gimp-toolbox-swap-colors"/>
           <para>
             Clicking on the small curved line with two arrowheads causes
             the Foreground and Background colors to be swapped. Pressing the
diff --git a/src/toolbox/tool-zoom.xml b/src/toolbox/zoom.xml
similarity index 100%
rename from src/toolbox/tool-zoom.xml
rename to src/toolbox/zoom.xml
diff --git a/src/using/paths.xml b/src/using/paths.xml
index ba29d54..f260b74 100644
--- a/src/using/paths.xml
+++ b/src/using/paths.xml
@@ -35,7 +35,7 @@
     create a path, and then stroke the path.
   </para>
   <para>
-    In <acronym>GIMP</acronym>, the term <quote>Stroke path</quote>, means to
+    In <acronym>GIMP</acronym>, the term <quote>Stroke path</quote> means to
     apply a specific style to the path (color, width, pattern... ).
   </para>
   <para>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]