changeset 1110:7cd49c6dc302

Reformatting: notes, advanced options page and more.
author zas_
date Mon, 10 Nov 2008 10:26:51 +0000
parents ba2bbc862da7
children 2b1121de1a66
files doc/collections.html doc/faq.html doc/image_search_search.html doc/main_window_folder_pane.html doc/main_window_image_pane.html doc/main_window_layout.html doc/options_advanced.html doc/options_filtering.html doc/options_general.html doc/options_image.html doc/reference.html doc/style.css
diffstat 12 files changed, 93 insertions(+), 91 deletions(-) [+]
line wrap: on
line diff
--- a/doc/collections.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/collections.html	Mon Nov 10 10:26:51 2008 +0000
@@ -459,7 +459,7 @@
   <br />
   </p>
 
-  <p>Note: When renaming or moving files within Geeqie, the contents of collections located in the folder ($HOME)/.geeqie/collections will automatically update to the new name or location.</p>
+  <p class="note">Note: When renaming or moving files within Geeqie, the contents of collections located in the folder ($HOME)/.geeqie/collections will automatically update to the new name or location.</p>
 
   <p><br />
   <br />
--- a/doc/faq.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/faq.html	Mon Nov 10 10:26:51 2008 +0000
@@ -41,73 +41,43 @@
 
   <h1>Frequently Asked Questions</h1>
 
-  <p><span class="gq-faq-5">1. Image viewing</span>
-  </p>
+  <h2 class="faq">Image viewing</h2>
 
-  <p>1.1 How do I keep images smaller than the visible area from enlarging when the zoom is set to &ldquo;fit to window&rdquo; ?</p>
+  <h3 class="faq">How do I keep images smaller than the visible area from enlarging when the zoom is set to &ldquo;fit to window&rdquo; ?</h3>
 
   <p>In the preferences dialog, under the &ldquo;Image&rdquo; tab, disable &ldquo;Allow enlargement of image for zoom to fit&rdquo;.</p>
 
-  <p><br />
-  <br />
-  </p>
-
-  <p><br />
-  <br />
-  </p>
-
-  <p><span class="gq-faq-5">9. Command line</span>
-  </p>
-
-  <p>9.1 How do I open an image in an existing Geeqie application ?</p>
+  <h2 class="faq">Command line</h2>
+ 
+  <h3 class="faq">How do I open an image in an existing Geeqie application ?</h3>
 
   <p>Use the &ldquo;-r&rdquo; command line option to send commands to an existing Geeqie, for a list of commands supported by the remote switch run:</p>
 
-  <pre class="gq-faq-9">
+<code>
 geeqie --remote-help
-</pre>
+</code>
 
-  <p><br />
-  <br />
-  </p>
-
-  <p>9.2 How do I set the slide show delay when starting Geeqie in slide show from the command line ?</p>
+  <h3 class="faq">How do I set the slide show delay when starting Geeqie in slide show from the command line ?</h3>
 
   <p>The delay can not be set when used with the standard -s command line switch, as -s uses the delay stored in the configuration file. For this use the remote command -ss to start the slide show after setting the delay with -d, the order of the command line is important, for example a 12 second slide show delay:</p>
 
-  <pre class="gq-faq-9">
+<code>
 geeqie -r -d12 -ss
-</pre>
+</code>
 
-  <p><br />
-  <br />
-  </p>
+  <p class="note">Note that if geeqie is running prior to this command, the slide show should also be stopped prior to changing the delay:</p>
 
-  <p>Note that if geeqie is running prior to this command, the slide show should also be stopped prior to changing the delay:</p>
-
-  <pre class="gq-faq-9">
+  <code>
 geeqie -r -sS -d12 -ss
-</pre>
-
-  <p><br />
-  <br />
-  </p>
+</code>
 
-  <p><br />
-  <br />
-  </p>
-
-  <p><span class="gq-faq-5">10. Miscellaneous</span>
-  </p>
-
-  <p>10.1 I want to be able to edit images with Geeqie</p>
+ 
+  <h2 class="faq">Miscellaneous</h2>
+ 
+  <h3 class="faq">I want to be able to edit images with Geeqie</h3>
 
   <p>Geeqie is an image <i>viewer</i>. There is, and never will be, a plan to add editing features. I recommend gimp for image editing.</p>
 
-  <p><br />
-  <br />
-  </p>
-
   <hr />
 
   <div class="navbottom">
--- a/doc/image_search_search.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/image_search_search.html	Mon Nov 10 10:26:51 2008 +0000
@@ -71,7 +71,7 @@
   <dt>Comments</dt>
   <dd>
   <p>The search will include all files that have a keyword or comment associated to it.</p>
-  <p>Note: Only keyword and comment associations stored in the user's home folder are included in this search type.</p>
+  <p class="note">Note: Only keyword and comment associations stored in the user's home folder are included in this search type.</p>
   </dd>
 
   <dt>Results</dt>
--- a/doc/main_window_folder_pane.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/main_window_folder_pane.html	Mon Nov 10 10:26:51 2008 +0000
@@ -51,7 +51,7 @@
  
   <p>The tool bar includes buttons for often used operations. The tool bar can be hidden or shown by selecting &ldquo;Hide toolbar&rdquo; from the view menu.</p>
 
-  <p>Note: These buttons are only displayed as an icon, the text below refers to the tool tip that appears by hovering the mouse over each button.</p>
+  <p class="note">Note: These buttons are only displayed as an icon, the text below refers to the tool tip that appears by hovering the mouse over each button.</p>
 
   <dl class="menu_desc">
   <dt>Show thumbnails</dt><dd>This button is active when the file list is in list view mode, and activating it will toggle the display of thumbnails.</dd>
@@ -79,7 +79,7 @@
 
   <p>A folder or file can be typed into the entry to quickly change to a desired location or image, the main window will update after pressing the Enter key. Tab completion is also available in the path entry.</p>
 
-  <p>Note: Tab completion uses the tab key, press the down arrow to move the focus from the entry.</p>
+  <p class="note">Note: Tab completion uses the tab key, press the down arrow to move the focus from the entry.</p>
 
   <p>Next to the path entry is a button with a down arrow, clicking this will display a drop down list containing the most recent locations viewed. The list is ordered such that the most recent location is at the top. Selecting a location from the drop down list will change the window to display the location.</p>
 
@@ -122,9 +122,9 @@
 
   <dt>New folder</dt><dd>Creates a new folder that is a sub folder of the selected folder.</dd>
 
-  <dt>Rename</dt><dd>Renames the selected folder.</dd>
+  <dt>Rename</dt><dd>Renames the selected folder.
 
-  <p>Note: Renaming a folder will not update metadata, such as keywords, or cached thumbnails for images contained in that folder, the data will be lost.</dd>
+  <p class="note">Note: Renaming a folder will not update metadata, such as keywords, or cached thumbnails for images contained in that folder, the data will be lost.</p></dd>
 
   <dt>View as tree</dt><dd>Toggles between the list and tree modes of the folder pane.</dd>
 
--- a/doc/main_window_image_pane.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/main_window_image_pane.html	Mon Nov 10 10:26:51 2008 +0000
@@ -70,7 +70,7 @@
 
   <p>To rotate the image clockwise 90 degrees press the &ldquo;]&rdquo; key, to rotate counterclockwise 90 degrees press the &ldquo;[&ldquo; key. To rotate the image 180 degrees use [Shift] + [R], the image can also be flipped horizontally or vertically with the respective [Shift] + [M] (mirror) and [Shift] + [F] (flip) keys.</p>
 
-  <p>Note: The rotation, mirror, and flip functions will not change the image file on disk.</p>
+  <p class="note">Note: The rotation, mirror, and flip functions will not change the image file on disk.</p>
 
   <h3>Mouse</h3>
   <p>Press the primary mouse button on the image and hold it, then move the mouse to pan the image in the desired direction. Releasing the mouse button will stop the panning operation. The mouse wheel can also be used to scroll the image when holding down the [Shift] key (*).</p>
--- a/doc/main_window_layout.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/main_window_layout.html	Mon Nov 10 10:26:51 2008 +0000
@@ -49,7 +49,7 @@
 
   <p>The order in which the panes are filled is determined by the three row list located below the layout selection. The three numbered rows correspond to the three numbered regions of the selected layout, to change the order of the list drag a row to the desired location within the list. To drag a row move the mouse over the selected row, press and hold the primary mouse button, then drag the row to the desired location and release the button.</p>
 
-  <p>Note: In the options window the file and image panes are labeled similarly, however the folder pane is labeled as tools.</p>
+  <p class="note">Note: In the options window the file and image panes are labeled similarly, however the folder pane is labeled as tools.</p>
 
   <h2>Changing the size of a pane</h2>
 
--- a/doc/options_advanced.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/options_advanced.html	Mon Nov 10 10:26:51 2008 +0000
@@ -49,13 +49,20 @@
 
   <h2>Full Screen</h2>
 
-  <p><b>Location</b>: Selects the location and position of the full screen window. 'Determined by window manager' will leave the window placement up to the window manager. 'Active screen' places the window on the same screen as the Geeqie main window. 'Active monitor' does the same, but limits the full screen window size to the monitor containing the main window. The remaining choices are dependent on the multiple monitor configuration.</p>
+  <dl class="dialog_desc">
+  <dt>Location</dt>
+  <dd><p>Selects the location and position of the full screen window. 'Determined by window manager' will leave the window placement up to the window manager. 'Active screen' places the window on the same screen as the Geeqie main window. 'Active monitor' does the same, but limits the full screen window size to the monitor containing the main window. The remaining choices are dependent on the multiple monitor configuration.</p></dd>
 
-  <p><b>Stay above other windows:</b> Enable this to have Geeqie ask the window manager to keep the full screen window above other windows. Note that the window manager may ignore the request. This option is not relevant when the full screen location is determined by the window manager.</p>
+  <dt>Stay above other windows</dt>
+  <dd><p>Enable this to have Geeqie ask the window manager to keep the full screen window above other windows. Note that the window manager may ignore the request. This option is not relevant when the full screen location is determined by the window manager.</p></dd>
 
-  <p><b>Smooth image flip</b>: This option delays the image change in full screen until the next image is entirely decoded into memory, the result is a smoother transition between images.</p>
+  <dt>Smooth image flip</dt>
+  <dd><p>This option delays the image change in full screen until the next image is entirely decoded into memory, the result is a smoother transition between images.</p></dd>
 
-  <p><b>Disable screen saver</b>: 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>
+  <dt>Disable screen saver</dt>
+  <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>
 
   <p><br />
   <br />
@@ -63,39 +70,52 @@
 
   <h2>Delete</h2>
 
-  <p><b>Confirm file delete</b>: Prompts for confirmation before deleting files.</p>
-
-  <p><b>Enable Delete key</b>: Disable this to disassociate the delete file function from the Delete key. This option does not effect the [Control] + D key sequence. May be useful in combination with &ldquo;confirm file delete&rdquo;, above, disabled so that accidentally hitting a single key will not result in deleted files.</p>
+  <dl class="dialog_desc">
+  <dt>Confirm file delete</dt>
+  <dd><p>Prompts for confirmation before deleting files.</p></dd>
 
-  <p><b>Safe Delete</b>: Moves deleted files to a temporary folder, for easy retrieval of deleted files. Files in the temporary folder are retained until the maximum size is reached, at which point deleting additional files will result in the removal of the oldest files to reclaim the space needed for the new files.</p>
+  <dt>Enable Delete key</dt>
+  <dd><p>Disable this to disassociate the delete file function from the Delete key. This option does not effect the [Control] + D key sequence. May be useful in combination with &ldquo;confirm file delete&rdquo;, above, disabled so that accidentally hitting a single key will not result in deleted files.</p></dd>
 
-  <p><i>Note:</i> Files moved to the Safe Delete folder are prefixed with a six digit number in the format:</p>
-
-  <p>nnnnnn_FILENAME</p>
+  <dt>Safe Delete</dt>
+  <dd><p>Moves deleted files to a temporary folder, for easy retrieval of deleted files. Files in the temporary folder are retained until the maximum size is reached, at which point deleting additional files will result in the removal of the oldest files to reclaim the space needed for the new files.</p>
+  <p class="note">Note: Files moved to the Safe Delete folder are prefixed with a six digit number in the format: <code>nnnnnn_FILENAME</code><br />
+  This is used by the delete feature to distinguish which files to remove first when clearing space for new files.<br />
+  The digit counter increments with each deleted file.</p></dd>
 
-  <p>This is used by the delete feature to distinguish which files to remove first when clearing space for new files. The digit counter increments with each deleted file.</p>
+  <dt>Folder</dt>
+  <dd><p>The location of the folder used by the Safe Delete feature.</p></dd>
 
-  <p><b>Folder</b>: The location of the folder used by the Safe Delete feature.</p>
+  <dt>Maximum size</dt>
+  <dd><p>The size to use for the Safe Delete folder, in megabytes.</p></dd>
 
-  <p><b>Maximum size</b>: The size to use for the Safe Delete folder, in megabytes.</p>
+  <dt>Clear button</dt>
+  <dd><p>Removes all files contained in the Safe Delete folder.</p></dd>
 
-  <p><b>Clear</b> button: Removes all files contained in the Safe Delete folder.</p>
-
-  <p><b>View</b> button: Changes the Geeqie main window to display the contents of the Safe Delete folder.</p>
-
+  <dt>View button</dt>
+  <dd><p>Changes the Geeqie main window to display the contents of the Safe Delete folder.</p></dd>
+  
+  </dl>
+  
   <p><br />
   <br />
   </p>
 
   <h2>Behavior</h2>
 
-  <p><b>Rectangular selection in icon view:</b> Enable this to change the selection method used when selecting multiple items in an icon view.</p>
-
-  <p><b>Descend folders in tree view</b>: This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.</p>
+  <dl class="dialog_desc">
+  <dt>Rectangular selection in icon view</dt>
+  <dd><p> Enable this to change the selection method used when selecting multiple items in an icon view.</p></dd>
 
-  <p><i>Note:</i> Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.</p>
+  <dt>Descend folders in tree view</dt>
+  <dd>
+  <p>This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.</p>
+  <p class="note">Note: Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.</p>
+  </dd>
+  <dt>In place renaming</dt>
+  <dd><p>When renaming a single file, this will allow the rename entry to appear directly over the original filename.</p></dd>
 
-  <p><b>In place renaming</b>: When renaming a single file, this will allow the rename entry to appear directly over the original filename.</p>
+  </dl>
 
   <p><br />
   <br />
@@ -103,9 +123,13 @@
 
   <h2>Navigation</h2>
 
-  <p><b>Progressive keyboard scrolling</b>: This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.</p>
+  <dl class="dialog_desc">
+  <dt>Progressive keyboard scrolling</dt>
+  <dd><p>This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.</p></dd>
 
-  <p><b>Mouse wheel scrolls image</b>: The default is for the mouse wheel to change the image, and to scroll the image when shift is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down shift will change the image.</p>
+  <dt>Mouse wheel scrolls image</dt>
+  <dd><p>The default is for the mouse wheel to change the image, and to scroll the image when shift is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down shift will change the image.</p></dd>
+  </dl>
 
   <p><br />
   <br />
@@ -113,14 +137,20 @@
 
   <h2>Miscellaneous</h2>
 
-  <p><b>Store keywords and comments local to source images:</b> When enabled, Geeqie attempts to store metadata such as keywords closer to the source image. The resulting location is the source image's folder, in a sub folder with the name "<b>.metadata"</b>. When the image source folder cannot be written, Geeqie falls back to saving the medata in "$HOME/.geeqie/metadata".</p>
+  <dl class="dialog_desc">
 
-  <p><b>Custom similarity threshold</b>: This setting is used by the compare method &ldquo;similarity (custom)&rdquo;, located in the Find Duplicates window.</p>
+  <dt>Store keywords and comments local to source images</dt>
+  <dd><p> When enabled, Geeqie attempts to store metadata such as keywords closer to the source image. The resulting location is the source image's folder, in a sub folder with the name "<em>.metadata"</em>. When the image source folder cannot be written, Geeqie falls back to saving the medata in "$HOME/.geeqie/metadata".</p></dd>
 
-  <p><b>Offscreen cache size</b>: Geeqie only renders the visible portion of an image. To reduce rendering the same area frequently when panning an image, some memory is used to retain the recently rendered image data. This value controls the maximum amount of memory to use.</p>
+  <dt>Custom similarity threshold</dt>
+  <dd><p>This setting is used by the compare method &ldquo;similarity (custom)&rdquo;, located in the Find Duplicates window.</p></dd>
 
-  <p><i>Note:</i> This setting controls the amount of memory <span class="gq-advanced-13">for <u>each</u> image window.</span></p>
+  <dt>Offscreen cache size</dt>
+  <dd><p>Geeqie only renders the visible portion of an image. To reduce rendering the same area frequently when panning an image, some memory is used to retain the recently rendered image data. This value controls the maximum amount of memory to use.</p>
+  <p class="note">Note: This setting controls the amount of memory for <em>each</em> image window.</p>
+  </dd>
 
+  </dl>
   <p><br />
   <br />
   </p>
--- a/doc/options_filtering.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/options_filtering.html	Mon Nov 10 10:26:51 2008 +0000
@@ -66,7 +66,7 @@
 
   <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>
 
-  <p><i>Note:</i> Unlike all other options in the dialog, filter list changes are applied immediately.</p>
+  <p class="note">Note: Unlike all other options in the dialog, filter list changes are applied immediately.</p>
 
   <p><b>Add</b> button: Adds a new blank line to the filter list, change the parameters to match the desired file type.</p>
 
--- a/doc/options_general.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/options_general.html	Mon Nov 10 10:26:51 2008 +0000
@@ -91,7 +91,7 @@
           <dl>
             <dd>
               <dl>
-                <dd class="gq-general-7"><i>Note:</i> Support for xvpics is read only, Geeqie can not generate thumbnails in this format.</dd>
+                <dd class="gq-general-7"><p class="note">Note: Support for xvpics is read only, Geeqie can not generate thumbnails in this format.</p></dd>
               </dl>
             </dd>
           </dl>
@@ -117,7 +117,7 @@
           <dl>
             <dd>
               <dl>
-                <dd class="gq-general-7"><i>Note:</i> Random images are displayed such that each image appears once per cycle of all images. When the slide show repeat option is enabled, the image order is randomized after completing each cycle.</dd>
+                <dd class="gq-general-7"><p class="note">Note: Random images are displayed such that each image appears once per cycle of all images. When the slide show repeat option is enabled, the image order is randomized after completing each cycle.</p></dd>
               </dl>
             </dd>
           </dl>
--- a/doc/options_image.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/options_image.html	Mon Nov 10 10:26:51 2008 +0000
@@ -90,7 +90,7 @@
 
   <p><b>Refresh on file change</b>: Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.</p>
 
-  <p><i>Note:</i> Disable this if the system will not go into sleep mode due to occasional disk activity from the time check, or if Geeqie updates too often for folders with continuously changing content.</p>
+  <p class="note">Note: Disable this if the system will not go into sleep mode due to occasional disk activity from the time check, or if Geeqie updates too often for folders with continuously changing content.</p>
 
   <p><b>Preload next image</b>: Enabling this option will cause Geeqie to read the next logical image from disk when idle, it will also retain the previously viewed image in memory. By reading the nearest images into memory, time to display the next image is reduced.</p>
 
@@ -101,7 +101,7 @@
           <dl>
             <dd>
               <dl>
-                <dd class="gq-image-12"><span class="gq-image-8"><i>Note:</i> This option will increase Geeqie memory requirements, and may cause performance issues with very large images.</span> If the use of Geeqie results in the system noticeably swapping memory to disk, try disabling this feature.</dd>
+                <dd class="gq-image-12"><p class="note">Note: This option will increase Geeqie memory requirements, and may cause performance issues with very large images. If the use of Geeqie results in the system noticeably swapping memory to disk, try disabling this feature.</p></dd>
               </dl>
             </dd>
           </dl>
--- a/doc/reference.html	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/reference.html	Mon Nov 10 10:26:51 2008 +0000
@@ -43,7 +43,7 @@
 
   <div class="submenu">
     <ul>
-      <li><a href="reference_command_line.html">Command Line</a> Options</li>
+      <li><a href="reference_command_line.html">Command Line Options</a></li>
       <li><a href="reference_keyboard_shortcuts.html">Keyboard Shortcuts</a></li>
       <li><a href="reference_thumbnails.html">Thumbnails</a></li>
     </ul>
--- a/doc/style.css	Sun Nov 09 21:53:33 2008 +0000
+++ b/doc/style.css	Mon Nov 10 10:26:51 2008 +0000
@@ -23,7 +23,9 @@
  .file_locations_subtitle { font-weight: bold}
  
  span.option_name { font-style: italic }
-
+ 
+ p.note { font-style: italic }
+ .note em { font-weight: bold }
 
 /* collections.html */
  div.gq-collections-4 {text-align: center}