Revision: 1220
          http://geeqie.svn.sourceforge.net/geeqie/?rev=1220&view=rev
Author:   zas_
Date:     2008-11-10 23:05:50 +0000 (Mon, 10 Nov 2008)

Log Message:
-----------
Update documentation a bit: General, Image, Windows, Filtering, Editors and a 
part of Advanced (Image Overlay) options.

Modified Paths:
--------------
    trunk/doc/options_advanced.html
    trunk/doc/options_editor_commands.html
    trunk/doc/options_filtering.html
    trunk/doc/options_general.html
    trunk/doc/options_image.html
    trunk/doc/options_window.html
    trunk/doc/other_windows_image_window.html
    trunk/doc/style.css

Modified: trunk/doc/options_advanced.html
===================================================================
--- trunk/doc/options_advanced.html     2008-11-10 21:33:38 UTC (rev 1219)
+++ trunk/doc/options_advanced.html     2008-11-10 23:05:50 UTC (rev 1220)
@@ -57,7 +57,108 @@
   <dd><p>This option will execute <i>xscreensaver-command --deactivate</i> 
once per minute to avoid the screen saver from activating when Geeqie is 
displayed full screen.</p></dd>
   
   </dl>
+  
+  <h2>Overlay Screen Display</h2>
 
+  <dl class="dialog_desc">
+  <dt>Always show image overlay at startup</dt>
+  <dd><p>Enable this to have the image overlay info displayed by 
default</p></dd>
+
+  <dt>Image overlay template</dt>
+  <dd><p>Overlay info is customizable through this template</p>
+<p>Overlay info format string syntax is: 
<code>%tag[:max_length][:extra]%</code></p>
+
+<div class="overlay_tags">
+<table width="60%" border="1" cellpadding="2" cellspacing="0">
+<col id="overlay_tags_col1" width="30%"></col>
+<col id="overlay_tags_col2" width="70%"></col>
+<tr><th>Tag</th><th>Replaced by</th></tr>
+<tr><td>%name%</td><td>Filename of the picture</td></tr>
+<tr><td>%collection%</td><td>Name of the collection</td></tr>
+<tr><td>%number%</td><td>Current number of image in the list</td></tr>
+<tr><td>%total%</td><td>Total number of images</td></tr>
+<tr><td>%date%</td><td>File date</td></tr>
+<tr><td>%size%</td><td>File size</td></tr>
+<tr><td>%width%</td><td>Image width</td></tr>
+<tr><td>%height%</td><td>Image height</td></tr>
+<tr><td>%res%</td><td>Image resolution</td></tr>
+<tr><td>%keywords%</td><td>Image keywords from metadata</td></tr>
+<tr><td>%comment%</td><td>Image comment from metadata</td></tr>
+</table>
+</div>
+
+<p>To access exif data use the exif name, for example: 
<code>%Exif.Photo.DateTimeOriginal%</code> to get the date of the original 
shot</p>
+
+<p>Pre-formatted exif data is also available:</p>
+<div class="overlay_exif">
+<table width="60%" border="1" cellpadding="2" cellspacing="0">
+<col id="overlay_exif_col1" width="30%"></col>
+<col id="overlay_exif_col2" width="70%"></col>
+<tr><th>Tag</th><th>Replaced by exif data</th></tr>
+
+<tr><td>formatted.Camera</td><td>Camera and sofware name</td></tr>
+<tr><td>formatted.DateTime</td><td>Image Date</td></tr>
+<tr><td>formatted.ShutterSpeed</td><td>Shutter speed in seconds (ie. 
1/60s)</td></tr>
+<tr><td>formatted.Aperture</td><td>Aperture (ie. f5.6)</td></tr>
+<tr><td>formatted.ExposureBias</td><td>Exposure bias (ie. +0.3)</td></tr>
+<tr><td>formatted.ISOSpeedRating</td><td>ISO sensitivity (ie. 100)</td></tr>
+<tr><td>formatted.FocalLength</td><td>Focal length</td></tr>
+<tr><td>formatted.FocalLength35mmFilm</td><td>Focal length 35mm</td></tr>
+<tr><td>formatted.SubjectDistance</td><td>Subject distance</td></tr>
+<tr><td>formatted.Flash</td><td>Flash</td></tr>
+<tr><td>formatted.Resolution</td><td>Resolution</td></tr>
+<tr><td>formatted.ColorProfile</td><td>Color profile</td></tr>
+</table>
+</div>
+
+<p>
+  You can limit the length of displayed data using :number notation:
+  <code>%formatted.Camera:20%</code> will truncate the displayed data to 20 
characters
+  and will add 3 dots at the end to denote the truncation.</p>
+
+<p>
+  If two or more variables are connected with the |-sign, it prints available
+  variables with a separator:<br />
+  
<code>%formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%</code><br
 />
+  could show:<br />
+    "1/20s - 400 - 80 mm"<br />
+  or<br />
+    "1/200 - 80 mm" if there's no ISO information in the Exif data.<br />
+</p>
+
+<p>
+  If a line is empty, it is removed.
+  This allows to add lines that totally disappear when no data is available.
+</p>
+
+<p>
+  Extra string uses special character '*' to mark the position of the data.
+  If no '*' is present, then extra string is just appended to data.
+  Any "\n" is replaced by a newline on display.
+  Pango mark up is accepted in left and right parts.
+  If data is empty, nothing will be displayed.
+</p>
+
+<p>Examples:</p>
+  <dl class="examples">
+  <dt><code>%name:&lt;i&gt;*&lt;/i&gt;\n%</code></dt><dd>name is displayed in 
italics ended with a newline</dd>
+  <dt><code>%size:\n%</code></dt><dd>size is displayed with a newline at 
end</dd>
+  <dt><code>%formatted.ISOSpeedRating:ISO *%</code></dt><dd>ie. "ISO 100"</dd>
+  <dt><code>Collection &lt;b&gt;*&lt;/b&gt;\n</code></dt><dd>display 
collection name in bold prefixed by "Collection " and a newline is appended</dd>
+  </dl>
+  
+  </dd>
+  
+  <dt>Help button</dt>
+  <dd><p>Show syntax help</p></dd>
+
+  <dt>Defaults button</dt>
+  <dd><p>Restore default image overlay template</p></dd> 
+  
+  </dl>
+
+  
+
   <h2>Delete</h2>
 
   <dl class="dialog_desc">

Modified: trunk/doc/options_editor_commands.html
===================================================================
--- trunk/doc/options_editor_commands.html      2008-11-10 21:33:38 UTC (rev 
1219)
+++ trunk/doc/options_editor_commands.html      2008-11-10 23:05:50 UTC (rev 
1220)
@@ -45,12 +45,14 @@
 
   <dl class="dialog_desc">
   <dt>Menu name</dt>
-  <dd><p>This field is used to represent the command in the menus of Geeqie, 
it is intended to describe the application or function that results from 
executing the command in the <em>Command Line</em> field.</p></dd>
+  <dd><p>This field is used to represent the command in the menus of Geeqie, 
it is intended to describe the application or function that results from 
executing the command in the <em>Command Line</em> field.</p>
+  <p>External command Copy/Move/Rename/Delete/New Folder allows to specify 
commands to use for these operations. When set, internal operations will be 
disabled and these commands used instead.</p>
+  </dd>
 
  
   <dt>Command Line</dt>
   <dd><p>This field is the command to execute. Several macros are available to 
position image file names within the command. If no macro is specified, the 
behavior will be to append the filenames onto the end of the command (the 
result will be the same as &ldquo;<i>command %f</i>&rdquo;).</p>
-
+  
   <div class="macro_description">
        <table width="80%" border="0" cellpadding="4" cellspacing="0" 
rules="rows">
        <col id="macro_description_col1" width="20%"></col>
@@ -117,6 +119,25 @@
                 <p>Prevent full screen from deactivating when command is 
executed. Must occur as the first two characters.</p>
               </td>
             </tr>
+           <tr>
+              <td>
+                <p>%%</p>
+              </td>
+
+              <td>
+                <p>This will be replaced by one '%'. This is the way to escape 
'%'.</p>
+              </td>
+            </tr>
+           <tr>
+              <td>
+                <p>%d</p>
+              </td>
+
+              <td>
+                <p>This only makes sense for external commands like copy or 
move as this is replaced by the destination.</p>
+              </td>
+            </tr>
+
          </tbody>
           </table>
   </div>

Modified: trunk/doc/options_filtering.html
===================================================================
--- trunk/doc/options_filtering.html    2008-11-10 21:33:38 UTC (rev 1219)
+++ trunk/doc/options_filtering.html    2008-11-10 23:05:50 UTC (rev 1220)
@@ -44,8 +44,11 @@
   <h2>Filters</h2>
 
   <dl class="dialog_desc">
-  <dt>Show entries that begin with a dot</dt>
+  <dt>Show hidden files or folders</dt>
   <dd><p>Enables the display of hidden files and folders, also known as dot 
files.</p></dd>
+ 
+  <dt>Show dot directory</dt>
+  <dd><p>Enables the display of the current directory as a dot in the 
directories views. It may be useful for some drag'n'drop operations.</p></dd>
 
   <dt>Case sensitive sort</dt>
   <dd><p>Files and folders are sorted such that upper case letters occur 
before lower case letters.</p>
@@ -58,6 +61,10 @@
 
   </dl>
   
+  <h2>Grouping sidecar extensions</h2>
+  <p>This field defines which extensions will lead to file grouping. Each 
extension should be separated by a semi-colon and should include the starting 
dot.</p>
+  <p>Grouped files will appear as one in file views. For example, it is useful 
when browsing directories containing two files for the same image (as raw+jpeg 
files generated by some cameras).</p>
+
   <h2>File types</h2>
 
   <p>This list contains the image formats that are understood by Geeqie. To 
disable a specific file type from being displayed, uncheck it's corresponding 
checkbox. Filters can be edited by first selecting the line containing the item 
to be changed, then clicking the filter or description field, making any 
changes, then pressing enter; press escape to cancel an active edit. The format 
for the filter field is a semicolon (;) seperated list of extensions, 
extensions must include the period (.).</p>

Modified: trunk/doc/options_general.html
===================================================================
--- trunk/doc/options_general.html      2008-11-10 21:33:38 UTC (rev 1219)
+++ trunk/doc/options_general.html      2008-11-10 23:05:50 UTC (rev 1220)
@@ -44,12 +44,16 @@
   <h2>Startup</h2>
 
   <dl class="dialog_desc">
-  <dt>Change to folder</dt>
+  <dt>Restore folder on startup</dt>
   <dd><p>Enabling this will cause Geeqie to initially open to the specified 
folder.</p></dd>
 
   <dt>Use Current</dt>
   <dd><p>Activate this button to change the setting to the current 
folder.</p></dd>
-   </dl>
+  
+  <dt>Use last path</dt>
+  <dd><p>When checked, Geeqie will recall the last path used on 
startup.</p></dd>
+  </dl>
+
  
   <h2>Thumbnails</h2>
 
@@ -76,6 +80,12 @@
   <dt>Cache thumbnails into .thumbnails</dt>
   <dd><p>When enabled, Geeqie attempts to store cached thumbnails closer to 
the source image. This way multiple users can benefit from a single cache, 
thereby reducing wasted disk space. The resulting location is the source 
image's folder, in a sub folder with the name <b>.thumbnails</b>. When the 
image source folder cannot be written, Geeqie falls back to saving the 
thumbnail in the user's home folder.</p></dd>
 
+  <dt>Faster jpeg thumbnailing</dt>
+  <dd><p>This will speed up thumbnails generation in some cases, but may 
reduce the quality</p></dd>
+
+  <dt>Use EXIF thumbnails when available</dt>
+  <dd><p>Geeqie will extract thumbnail from EXIF data if available instead of 
generating one. This will speed up thumbnails generation but EXIF thumbnail may 
be not in sync with the image if it was modified by a tool which didn't take 
care of the thumbnail data.</p></dd>
+
   <dt>Use xvpics thumbnails when found</dt>
   <dd><p>xvpics is a common thumbnail caching format used by several 
applications. Thumbnails are stored locally to the source image in a sub folder 
with the name <b>.xvpics</b>. Enabling this option will allow Geeqie to read 
thumbnails saved in the xvpics format.</p>
   <p class="note"><span class="note_label">Note:</span> Support for xvpics is 
read only, Geeqie can not generate thumbnails in this format.</p></dd>

Modified: trunk/doc/options_image.html
===================================================================
--- trunk/doc/options_image.html        2008-11-10 21:33:38 UTC (rev 1219)
+++ trunk/doc/options_image.html        2008-11-10 23:05:50 UTC (rev 1220)
@@ -61,6 +61,10 @@
   <dt>Allow enlargement of image for zoom to fit</dt>
   <dd><p>Enable this to allow Geeqie to increase the image size for images 
that are smaller than the current view area when the zoom is set to &ldquo;Fit 
to Window&rdquo;.</p></dd>
 
+  <dt>Limit image size when autofitting</dt>
+  <dd><p>This percentage will affect the size of the image when <span 
class="option_name">Fit image to window</span> is set, instead of using 100% of 
the window, it will use the specified percentage. It allows to keep a border 
around the image (values lower than 100%) or to auto zoom the image (values 
greater than 100%). It affects fullscreen mode too.</p></dd>
+
+
   <dt>Zoom increment</dt>
   <dd><p>Adjusts the step size when zooming in or out on an image. This value 
corresponds to the percentage of the original image.</p></dd>
 
@@ -80,12 +84,30 @@
   </dd>
   </dl>
 
+   <h2>Scroll control</h2>
+
+  <dl class="dialog_desc">
+  <dt>Scroll reset method</dt>
+  <dd><p>This controls the scroll initial position when changing the displayed 
image.</p>
+
+  <dl>
+  <dt>Top left</dt><dd>The new image is displayed from top left corner.</dd>
+  <dt>Center</dt><dd>The new image is centered</dd>
+  <dt>No change</dt><dd>The new image is positionned as the previous one, 
whenever possible.</dd>
+  </dl>
+  </dd>
+  </dl>
+
   <h2>Appearance</h2>
 
   <dl class="dialog_desc">
-  <dt>Black background</dt>
-  <dd><p>Enable this to draw the image background (the area around the image) 
in black.</p></dd>
+  <dt>Custom border color</dt>
+  <dd><p>Enable this to draw the image background (the area around the image) 
in the specified color.</p></dd>
+ <dt>Border color</dt>
+  <dd><p>Use this color chooser to define the color to use as image 
background.</p></dd>
+
   </dl>
+  <p class="note"><span class="note_label">Note:</span> You may use <span 
class="option_name">Limit image size when autofitting</span> option to keep a 
border around the image in fullscreen mode.</p>
 
   <h2>Convenience</h2>
 

Modified: trunk/doc/options_window.html
===================================================================
--- trunk/doc/options_window.html       2008-11-10 21:33:38 UTC (rev 1219)
+++ trunk/doc/options_window.html       2008-11-10 23:05:50 UTC (rev 1220)
@@ -45,7 +45,7 @@
 
   <dl class="dialog_desc">
   <dt>Remember window positions</dt>
-  <dd><p>This will maintain the main window size and position between Geeqie 
sessions.</p></dd>
+  <dd><p>This will maintain windows size and position between Geeqie 
sessions.</p></dd>
 
   <dt>Remember tool state</dt>
   <dd><p>This will maintain the tool window state between Geeqie 
sessions.</p></dd>
@@ -64,7 +64,8 @@
 
   <h2>Window Layout</h2>
 
-  <p>The Geeqie main window consists of three main panes, their position and 
order can be changed here. The first four selections represent the basic layout 
of the main window. The numbers within each selection represent the order of 
the pane content. The order of the content can be changed by dragging the 
Tools, Files, or Image with the mouse to the desired location within the 
list.</p>
+  <p>The Geeqie main window consists of three main panes, their position and 
order can be changed here. The first four selections represent the basic layout 
of the main window. The numbers within each selection represent the order of 
the pane content.</p>
+  <p>The order of the content can be changed by dragging the Tools, Files, or 
Image with the mouse to the desired location within the list.</p>
 
   <hr id="bottomseparator" />
 

Modified: trunk/doc/other_windows_image_window.html
===================================================================
--- trunk/doc/other_windows_image_window.html   2008-11-10 21:33:38 UTC (rev 
1219)
+++ trunk/doc/other_windows_image_window.html   2008-11-10 23:05:50 UTC (rev 
1220)
@@ -68,9 +68,11 @@
 
   <p>To update the image display in the event that the source file has 
changed, press the R key.</p>
 
-  <h2>Information Overlay</h2>
+  <h2>Information and histogram Overlay</h2>
 
   <p>A small overlay can be turned on and off by pressing the I key. This 
overlay displays the image file name, dimensions, file date, and file size. The 
count of the current image and of all images contained by the window are also 
displayed in parenthesis. When the window is linked to a collection, the 
collection title will also appear in the overlay in italics above the file 
name.</p>
+  <p>An histogram is displayed if I key is pressed twice, K key will modify 
the data displayed, and J key will toggle linear or logarithmic histogram.</p>
+  <p>Overlay info is customizable through <a href="options_advanced.html" 
class="option_name">Image Overlay Template</a> option in Advanced tab in 
Preferences dialog.</p>
 
   <hr id="bottomseparator" />
 

Modified: trunk/doc/style.css
===================================================================
--- trunk/doc/style.css 2008-11-10 21:33:38 UTC (rev 1219)
+++ trunk/doc/style.css 2008-11-10 23:05:50 UTC (rev 1220)
@@ -157,6 +157,10 @@
        list-style-type: circle;
 }
 
+.examples dt {
+       border: 0;
+}
+
 /* collections.html */
 div.collections-shortcuts {
        text-align: center;


This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Geeqie-svn mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geeqie-svn

Reply via email to