GNOME.org
 

[gthumb] added docs for the editing tools, and minor formatting fixes

commit fd098168fac21553360908b20cf104295f28b6a7
Author: Michael J. Chudobiak <mjc avtechpulse com>
Date:   Fri Jun 25 08:51:09 2010 -0400

    added docs for the editing tools, and minor formatting fixes

 help/C/attributes.page          |    2 +-
 help/C/batch-scripts.page       |    2 +-
 help/C/browser.page             |    6 ++--
 help/C/edit-colors.page         |   43 +++++++++++++++++++++++++++++++++++++++
 help/C/edit-redeye.page         |   25 ++++++++++++++++++++++
 help/C/edit-resize-crop.page    |   34 ++++++++++++++++++++++++++++++
 help/C/edit-rotate.page         |   41 +++++++++++++++++++++++++++++++++++++
 help/C/edit-save-undo-redo.page |   25 ++++++++++++++++++++++
 help/C/index.page               |    2 +-
 help/C/introduction.page        |   18 ++++++++--------
 help/C/thumbnail-pane.page      |    2 +-
 help/C/thumbnails.page          |   14 ++++++------
 help/Makefile.am                |    7 +++++-
 13 files changed, 197 insertions(+), 24 deletions(-)
---
diff --git a/help/C/attributes.page b/help/C/attributes.page
index e9674f1..f94b2a9 100644
--- a/help/C/attributes.page
+++ b/help/C/attributes.page
@@ -4,7 +4,7 @@ id="gthumb-attributes">
     <link type="guide" xref="index#reference" />
   </info>
   <title>Attribute Codes</title>
-  <p>gThumb stores many different attributes for each file.
+  <p><app>gThumb</app> stores many different attributes for each file.
   Extensions may add more. The list below is a summary of some of
   the more common attributes:</p>
   <list>
diff --git a/help/C/batch-scripts.page b/help/C/batch-scripts.page
index 216c428..7404799 100644
--- a/help/C/batch-scripts.page
+++ b/help/C/batch-scripts.page
@@ -4,7 +4,7 @@ id="gthumb-batch-scripts">
     <link type="guide" xref="index#batch" />
   </info>
   <title>User-Defined Scripts</title>
-  <p>To define a script (a command-line sequence that gThumb will
+  <p>To define a script (a command-line sequence that <app>gThumb</app> will
   execute on your files), click the <gui>Tools</gui> button on the main toolbar, 
   and select <guiseq><gui>Tools</gui><gui>Personalize</gui></guiseq>.</p>
   <p>TODO: further documentation is need here.</p>
diff --git a/help/C/browser.page b/help/C/browser.page
index 800f4e0..3e62015 100644
--- a/help/C/browser.page
+++ b/help/C/browser.page
@@ -4,18 +4,18 @@ id="gthumb-browser-view">
     <link type="guide" xref="index#files" />
   </info>
   <title>Browsing Your Files</title>
-  <p>When you start gThumb the following window is displayed:</p>
+  <p>When you start <app>gThumb</app> the following window is displayed:</p>
   <figure>
     <title>The main window</title>
     <media type="image" mime="image/png"
     src="figures/main-win.png" />
   </figure>
-  <p>The gThumb browser contains the following elements:</p>
+  <p>The <app>gThumb</app> browser contains the following elements:</p>
   <terms>
     <item>
       <title>Menubar</title>
       <p>The menus on the menubar contain all of the commands that
-      you can use in gThumb</p>
+      you can use in <app>gThumb</app></p>
     </item>
     <item>
       <title>Toolbar</title>
diff --git a/help/C/edit-colors.page b/help/C/edit-colors.page
new file mode 100644
index 0000000..f16c23b
--- /dev/null
+++ b/help/C/edit-colors.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/"; type="topic"
+id="gthumb-edit-colors">
+  <info>
+    <link type="guide" xref="index#editing" />
+  </info>
+  <title>Color Adjustments</title>
+  <p>
+  <media type="image" mime="image/png"
+  src="figures/palette.png" />To access the editing tools, open an
+  image and then click the 
+  <gui>Edit File</gui> toolbar button (the palette icon).</p>
+
+  <p>Several tools are provided to manipulate the colors in
+  images.</p>
+  <terms>
+    <item>
+      <title><gui>Enhance Colors</gui></title>
+      <p>This tool provides automatic white balance correction. No
+      user adjustments are required.</p>
+    </item>
+    <item>
+      <title><gui>Adjust Colors</gui></title>
+      <p>This tool provides manual color adjustments. Adjustments
+      to the gamma, brightness, contrast, saturation, and the
+      cyan/red, magenta/green, and yellow/blue color balances
+      may be made.</p>
+    </item>
+    <item>
+      <title><gui>Equalize</gui></title>
+      <p>This tool provides automatic histogram equalization. No
+      user adjustments are required.</p>
+    </item>
+    <item>
+      <title><gui>Desaturate</gui></title>
+      <p>This tool converts the image colors into shades of grey.
+      (This does not change this image storage format.)</p>
+    </item>
+    <item>
+      <title><gui>Negative</gui></title>
+      <p>This tool inverts the color levels, providing an image negative.</p>
+    </item>
+  </terms>
+</page>
diff --git a/help/C/edit-redeye.page b/help/C/edit-redeye.page
new file mode 100644
index 0000000..230f370
--- /dev/null
+++ b/help/C/edit-redeye.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/"; type="topic"
+id="gthumb-edit-red-eye">
+  <info>
+    <link type="guide" xref="index#editing" />
+  </info>
+  <title>Red Eye Removal</title>
+  <p>
+  <media type="image" mime="image/png"
+  src="figures/palette.png" />To access the editing tools, open an
+  image and then click the 
+  <gui>Edit File</gui> toolbar button (the palette icon).</p>
+
+  <p><app>gThumb</app> provides a <gui>Red Eye Removal</gui> tool.
+  To remove a red eye, position the mouse pointer over the red eye
+  and click on it. <app>gThumb</app> will attempt to remove the red region
+  and replace it with a more natural-looking gray region. If the results
+  do not look correct, press <key>Escape</key> and click on the <gui>Undo</gui>
+  item.</p>
+  <p>This tool works best when there is a high color contrast between the
+  red eye and the surrounding facial area. It does not work well for
+  "orange eye" sometimes seen in photos of children, or if the surrounding
+  skin has a reddish tinge. This tool could use improvement - if you
+  are fiendishly clever, love matrix algebra and open source software, please
+  <link href="http://live.gnome.org/gthumb/development";>submit a patch!</link></p>
+</page>
diff --git a/help/C/edit-resize-crop.page b/help/C/edit-resize-crop.page
new file mode 100644
index 0000000..cad8e37
--- /dev/null
+++ b/help/C/edit-resize-crop.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/"; type="topic"
+id="gthumb-edit-resize-crop">
+  <info>
+    <link type="guide" xref="index#editing" />
+  </info>
+  <title>Resizing and Cropping</title>
+  <p>
+  <media type="image" mime="image/png"
+  src="figures/palette.png" />To access the editing tools, open an
+  image and then click the 
+  <gui>Edit File</gui> toolbar button (the palette icon).</p>
+
+  <p>Two tools are provided to resize and crop images.</p>
+  <terms>
+    <item>
+      <title><gui>Resize</gui></title>
+      <p>This allows you to resize the image. The image may be scaled
+      to a certain physical size, or to a certain percentage of the
+      original size. The aspect ratio may be locked to a specific
+      value, or freely adjusted.</p>
+    </item>
+    <item>
+      <title><gui>Crop</gui></title>
+      <p>This allows you to crop the image. Click and drag the mouse
+      over the desired area of the image. The area may be locked to a
+      specific aspect ratio, or it may be freely adjusted. A rule-of-thirds
+      grid or golden-sections grid may be superimposed over the image
+      for composition guidance.</p>
+    </item>
+  </terms>
+
+  <p><app>gThumb</app> also offers a batch-mode tool for resizing multiple
+  images simultaneously. See <link xref="gthumb-batch-resize"/>.</p>
+</page>
diff --git a/help/C/edit-rotate.page b/help/C/edit-rotate.page
new file mode 100644
index 0000000..47cfa39
--- /dev/null
+++ b/help/C/edit-rotate.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/"; type="topic"
+id="gthumb-edit-rotate">
+  <info>
+    <link type="guide" xref="index#editing" />
+  </info>
+  <title>Rotations and Flips</title>
+  <p>
+  <media type="image" mime="image/png"
+  src="figures/palette.png" />To access the editing tools, open an
+  image and then click the 
+  <gui>Edit File</gui> toolbar button (the palette icon).</p>
+
+  <p>Several tools are provided to manipulate the orientation of
+  images.</p>
+  <terms>
+    <item>
+      <title><gui>Mirror</gui></title>
+      <p>This flips the image horizontally. The left and right sides
+      are swapped.</p>
+    </item>
+    <item>
+      <title><gui>Flip</gui></title>
+      <p>This flips the image vertically. The top and bottom
+      are swapped.</p>
+    </item>
+    <item>
+      <title><gui>Rotate Right</gui></title>
+      <p>This rotates the image clockwise.</p>
+    </item>
+    <item>
+      <title><gui>Rotate Left</gui></title>
+      <p>This rotates the image counter-clockwise.</p>
+    </item>
+  </terms>
+
+  <p>The rotations offered in the edit mode act on the image in memory.
+  They are not direct file operations. For jpeg images, these means they
+  are not lossless operations - the image will degrade slightly when it
+  it is re-encoded and saved. However, <app>gThumb</app> does provide
+  lossless rotation tools. See <link xref="gthumb-batch-rotate"/>.</p>
+</page>
diff --git a/help/C/edit-save-undo-redo.page b/help/C/edit-save-undo-redo.page
new file mode 100644
index 0000000..effba56
--- /dev/null
+++ b/help/C/edit-save-undo-redo.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/"; type="topic"
+id="gthumb-edit-save-undo-redo">
+  <info>
+    <link type="guide" xref="index#editing" />
+  </info>
+  <title>File Save, Undo, Redo</title>
+  <p>
+  <media type="image" mime="image/png"
+  src="figures/palette.png" />To access the editing tools, open an
+  image and then click the 
+  <gui>Edit File</gui> toolbar button (the palette icon).</p>
+  <p>Multiple changes may be made to an image before saving it. 
+  <gui>Undo</gui> and 
+  <gui>Redo</gui> buttons are provided, and may be used up until the
+  file is saved.</p>
+  <p>A modified image may be saved by pressing 
+  <gui>Save</gui>. To save the modified image to a new location
+  instead, leaving the original image unchanged, used 
+  <gui>Save As</gui>.</p>
+  <p>If you exit the editing mode (by pressing 
+  <key>Esc</key>or the 
+  <gui>View the Folders</gui> toolbar button), or navigate away from
+  the current image, you will be prompted to save or discard your
+  changes.</p>
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index 4e93ee5..7d889a1 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -15,7 +15,7 @@
 		<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
 	</info>
 
-	<title>gThumb Help</title>
+	<title><app>gThumb</app> Help</title>
 
     <section id="welcome" style="2column">
         <title>Welcome</title>
diff --git a/help/C/introduction.page b/help/C/introduction.page
index 913500c..40bd463 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -4,27 +4,27 @@ id="gthumb-introduction">
     <link type="guide" xref="index#welcome" />
   </info>
   <title>Introduction</title>
-  <p>gThumb is an image viewer and browser written for the GNOME
+  <p><app>gThumb</app> is an image viewer and browser written for the GNOME
   environment. It lets you browse your hard disk, showing you
   thumbnails of image files and view single images of many
   different formats.</p>
-  <p>gThumb supports the most common graphics formats, including
-  JPEG, GIF, TIF, and PNG. gThumb will also display other less
+  <p><app>gThumb</app> supports the most common graphics formats, including
+  JPEG, GIF, TIF, and PNG. <app>gThumb</app> will also display other less
   common image types if the supporting libraries are installed,
   including TGA, ICO, BMP, XPM, and others.</p>
   <p>Some support for RAW image types is included, especially if
   the dcraw program is installed on your system.</p>
-  <p>gThumb not only lets you view image files but has many other
+  <p><app>gThumb</app> not only lets you view image files but has many other
   features such as adding comments to images, organizing images
   into catalogs, printing images, slideshows, setting your desktop
   background, and more.</p>
-  <p>gThumb includes a tool to import photos from attached cameras
+  <p><app>gThumb</app> includes a tool to import photos from attached cameras
   and memory card readers.</p>
-  <p>gThumb can read EXIF, XMP, and IPTC metadata that is commonly
+  <p><app>gThumb</app> can read EXIF, XMP, and IPTC metadata that is commonly
   embedded in files.</p>
-  <p>gThumb provides a systems of extensions (or plug-ins), to
-  allow users to extend the functionality of gThumb.</p>
-  <p>More information about these extensions, and about gThumb
+  <p><app>gThumb</app> provides a systems of extensions (or plug-ins), to
+  allow users to extend the functionality of <app>gThumb</app>.</p>
+  <p>More information about these extensions, and about <app>gThumb</app>
   generally, is available at 
   <link href="http://live.gnome.org/gthumb";>
   http://live.gnome.org/gthumb</link>.</p>
diff --git a/help/C/thumbnail-pane.page b/help/C/thumbnail-pane.page
index 70c659a..72f54d6 100644
--- a/help/C/thumbnail-pane.page
+++ b/help/C/thumbnail-pane.page
@@ -4,7 +4,7 @@ id="gthumb-thumbnail-pane">
     <link type="guide" xref="index#files" />
   </info>
   <title>Thumbnail Pane</title>
-  <p>When an image has been opened in the gThumb viewer, the user
+  <p>When an image has been opened in the <app>gThumb</app> viewer, the user
   has the option of enabling or disabling a thumbnail pane, which
   shows the other images in the folder as thumbnails. This feature
   can be toggled with the 
diff --git a/help/C/thumbnails.page b/help/C/thumbnails.page
index 76e32ae..c4fe37b 100644
--- a/help/C/thumbnails.page
+++ b/help/C/thumbnails.page
@@ -16,25 +16,25 @@ id="gthumb-thumbnails">
   movies, audio), but this can be made more or less
   restrictive.</p>
   <p>The thumbnails may be generated by a number of different
-  methods. gThumb will first check for existing thumbnails in the
+  methods. <app>gThumb</app> will first check for existing thumbnails in the
   system cache.</p>
   <p>If no cached thumbnail is found, and an image file contains an
   embedded thumbnail (jpeg files generated by digital cameras
-  normally do), gThumb will attempt to use that. gThumb will
+  normally do), <app>gThumb</app> will attempt to use that. <app>gThumb</app> will
   confirm that the aspect ratio of the thumbnail is similar to that
   of the main image, and ignore thumbnails that do not appear to
   match the main image.</p>
-  <p>If that doesn't work, gThumb will attempt to load the entire
+  <p>If that doesn't work, <app>gThumb</app> will attempt to load the entire
   file and generate a scaled-down thumbnail.</p>
-  <p>Lastly, gThumb will use any system-defined scripts for
+  <p>Lastly, <app>gThumb</app> will use any system-defined scripts for
   thumbnailing particular media types. For example, some systems
-  may use mplayer or totem or other movie viewers to generate movie
+  may use <app>mplayer</app> or <app>totem</app> or other movie viewers to generate movie
   thumbnails.</p>
-  <p>gThumb will save thumbnails to a system cache, to share them
+  <p><app>gThumb</app> will save thumbnails to a system cache, to share them
   with other applications. By default, Gnome systems prune cached
   thumbnails when they are older than 180 days, or when the
   thumbnail cache exceeds 512 MB. Technically-inclined users can
-  explore these settings with gconf-editor. See the
+  explore these settings with <app>gconf-editor</app>. See the
   /desktop/gnome/thumbnail_cache/maximum_age and
   /desktop/gnome/thumbnail_cache/maximum_size keys in particular.
   Certain applications (like F-Spot) may automatically increase
diff --git a/help/Makefile.am b/help/Makefile.am
index b7173a7..e62b778 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -25,7 +25,12 @@ DOC_PAGES = \
 	batch-scripts.page \
 	thumbnails.page \
 	thumbnail-pane.page \
-	rename-series.page
+	rename-series.page \
+	edit-save-undo-redo.page \
+	edit-colors.page \
+	edit-rotate.page \
+	edit-resize-crop.page \
+	edit-redeye.page
 	
 DOC_LINGUAS = de el es fr oc sl sv zh_CN
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]