Mercurial > geeqie.yaz
changeset 1734:b92fc3c922ac
scripts for converting wiki documentation to docbook
line wrap: on
line diff
--- a/doc/Makefile.am Sat Nov 21 20:08:51 2009 +0000 +++ b/doc/Makefile.am Sun Nov 22 09:12:22 2009 +0000 @@ -1,55 +1,5 @@ ## Process this file with automake to produce Makefile.in. helpdir = @htmldir@ -help_DATA = \ - collections.html \ - credits.html \ - faq.html \ - gnu_fdl.txt \ - image_management_copy_move.html \ - image_management_delete.html \ - image_management_external_editing.html \ - image_management.html \ - image_management_rename.html \ - image_presentation_fullscreen.html \ - image_presentation.html \ - image_presentation_slideshow.html \ - image_search_finding_duplicates.html \ - image_search.html \ - image_search_search.html \ - index.html \ - introduction.html \ - main_window_file_pane.html \ - main_window_folder_pane.html \ - main_window.html \ - main_window_image_pane.html \ - main_window_layout.html \ - main_window_menus.html \ - main_window_navigation.html \ - main_window_status_bar.html \ - options_advanced.html \ - options_editor_commands.html \ - options_filtering.html \ - options_general.html \ - options_hidden.html \ - options.html \ - options_image.html \ - options_properties.html \ - options_window.html \ - other_windows.html \ - other_windows_image_properties.html \ - other_windows_image_window.html \ - other_windows_pan_view.html \ - printing.html \ - reference_command_line.html \ - reference.html \ - reference_keyboard_shortcuts.html \ - reference_management.html \ - reference_thumbnails.html \ - sidebars_exif.html \ - sidebars.html \ - sidebars_keywords.html \ - sidebars_sort_manager.html \ - style.css -EXTRA_DIST = $(help_DATA) template.html +EXTRA_DIST = docbook2html.sh docbook
--- a/doc/collections.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,468 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Collections - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_search_finding_duplicates.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Collections</p> - </th> - - <th> - <p class="next"><a href="sidebars.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Collections</h1> - - <p>Geeqie provides the ability to build lists of images, regardless of the location of the files on disk.</p> - - <h2>The collection window</h2> - - <p>A collection window displays the contents of a collection. It allows the collection to be modified and access to the images contained in the collection.</p> - - <p>To open a new empty collection window press C or select New collection from the file menu.</p> - - <p>To open an existing collection, press O or select Open collection from the file menu. A dialog will appear requesting the location of the collection file. A window will the open containing the selected collection. Recently opened or saved collections can also be opened by selecting the collection's file name from the Open recent sub menu of the file menu.</p> - - <p>The collection window consists of a pane to display the contents of the collection, and a status bar along the bottom of the window.</p> - - <h3>Icon pane</h3> - - <p>The icon pane displays images contained in the collection as thumbnails in a grid, by default the file names also appear below each thumbnail.</p> - - <p>The Icon pane works exactly like the Icon view mode of the <a href="main_window_file_pane.html">file pane</a> in a main window. But with the addition that the contents of the collection can be organized with drag and drop.</p> - - <p>A <b>context menu</b> is available for the icon pane by right clicking the mouse or pressing the Menu key.</p> - - <p><b>Keyboard shortcuts</b> available in the collection window:</p> - - <div class="shortcuts"> - <table width="80%" border="1" cellpadding="2" cellspacing="0"> - <col width="25%"></col> - <col width="25%"></col> - <col width="50%"></col> - - <thead> - <tr> - <th> - <p>Shortcut</p> - </th> - - <th> - <p>Context menu name</p> - </th> - - <th> - <p>Description</p> - </th> - </tr> - </thead> - - <tr> - <td> - <p><span class="key">Enter</span></p> - </td> - - <td> - <p>View</p> - </td> - - <td> - <p>Opens selected image in main window.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">V</span></p> - </td> - - <td> - <p>View in new window</p> - </td> - - <td> - <p>Opens selected image in a new window.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">A</span></p> - </td> - - <td> - <p>Select all</p> - </td> - - <td> - <p>Selects all images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Shift</span> + <span class="key">A</span></p> - </td> - - <td> - <p>Select none</p> - </td> - - <td> - <p>Clear the image selection.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">1</span> through<br /> - <span class="key">Ctrl</span> + <span class="key">0</span></p> - </td> - - <td> - <p>Edit sub menu</p> - </td> - - <td> - <p>Executes the respective editor command.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">P</span></p> - </td> - - <td> - <p>Properties</p> - </td> - - <td> - <p>Opens a properties window for selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">C</span></p> - </td> - - <td> - <p>Copy</p> - </td> - - <td> - <p>Copy selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">M</span></p> - </td> - - <td> - <p>Move</p> - </td> - - <td> - <p>Move selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">R</span></p> - </td> - - <td> - <p>Rename</p> - </td> - - <td> - <p>Rename selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">D</span></p> - </td> - - <td> - <p><span class="key">Delete</span></p> - </td> - - <td> - <p>Delete selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Delete</span></p> - </td> - - <td> - <p>Remove</p> - </td> - - <td> - <p>Remove selected images from result list.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">L</span></p> - </td> - - <td> - <p>Append from file list</p> - </td> - - <td> - <p>Add contents of main window to collection.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">A</span></p> - </td> - - <td> - <p>Append from collection</p> - </td> - - <td> - <p>Append contents of another collection from a file.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">S</span></p> - </td> - - <td> - <p>Save collection</p> - </td> - - <td> - <p>Save collection to disk, if the collection is new a dialog will appear to select the file name and location.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">S</span></p> - </td> - - <td> - <p>Save collection as</p> - </td> - - <td> - <p>Opens a dialog to select a new file name to use for the collection.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">T</span></p> - </td> - - <td> - <p>Show filename text</p> - </td> - - <td> - <p>Toggle display of text below icons. When set, icon's tooltip will show the full path to the file.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Menu</span></p> - </td> - - <td> </td> - - <td> - <p>Displays the context menu.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">N</span></p> - </td> - - <td> - <p>Sort by name</p> - </td> - - <td> - <p>Sort collection by file name.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">I</span></p> - </td> - - <td> - <p>Sort by number</p> - </td> - - <td> - <p>Sort collection by file name, using natural numerical order</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">D</span></p> - </td> - - <td> - <p>Sort by date</p> - </td> - - <td> - <p>Sort collection by file date.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">B</span></p> - </td> - - <td> - <p>Sort by size</p> - </td> - - <td> - <p>Sort collection by file size.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">P</span></p> - </td> - - <td> - <p>Sort by path</p> - </td> - - <td> - <p>Sort collection by file location (path to file).</p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>Print</p> - </td> - - <td> - <p>Opens a print dialog for selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">W</span></p> - </td> - - <td> </td> - - <td> - <p>Close window.</p> - </td> - </tr> - </table> - </div> - - <p>The <b>selection</b> can be changed using the keyboard and mouse the same as in a <a href="main_window_file_pane.html">file pane</a> of the main window.</p> - - <h3>Status bar</h3> - - <p>The status bar displays the total number of images in the collection, and the number of selected images in parenthesis. A progress bar also displays whenever thumbnails are loading from disk.</p> - - <h3>Drag and Drop</h3> - - <p>Drag and drop can be initialized with the primary or middle mouse buttons. Dragging an image that is selected will include all selected images in the drag. Dragging an image that is not selected will drag only that image.</p> - - <p>Dropping files and folders onto the collection window will add them to the collection, they will be inserted at the location of the drop. A red arrow will indicate the location of the drop as files are dragged over the collection window. When one or more folders are included in the drop list, a menu will appear to select how to handle the contents of the folders.</p> - - <p>To move images within the collection to change their order, initiate a drag for the selected image(s) and then move the mouse to the desired location within the window. A red arrow will appear to assist in determining the destination of the dragged images. Release the drag to move the images to the new location in the list.</p> - - <p class="note"><span class="note_label">Note:</span> 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> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_search_finding_duplicates.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="sidebars.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/credits.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,99 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Credits - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_management.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Credits</p> - </th> - - <th> - <p class="next"><a href="gnu_fdl.txt">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Credits</h1> - - <h2>Authors</h2> - - <p>Geeqie is maintained by The Geeqie Team (Vladimir Nadvornik, Petr Ostadal, Laurent Monin).</p> - <p>This software is a fork of GQview project by John Ellis.</p> - - <p>The ever growing list of contributors and language translators can be found in the README file included with the latest release of the program.<br /> - The Credits can also be viewed by selecting the Credits button located in the About dialog <i>(open Help Menu, select About, click Credits... button)</i>.</p> - - <h2>Copyright</h2> - - <p>Geeqie and this accompanying documentation is copyright © 2008 - 2009 The Geeqie Team and © 2006 John Ellis.</p> - - <h2>License</h2> - - <p>The Geeqie program is released under the “GNU General Public License”, the complete GNU GPL text can be found in the COPYING file included with each Geeqie release.</p> - - <p>This Geeqie documentation is released under the "<a href="gnu_fdl.txt">GNU Free Documentation License</a>".</p> - - <h2>Legal Notice</h2> - <p>Copyright © 2008 - 2009 The Geeqie Team.<br /> - Copyright © 2006 John Ellis.</p> - - <p>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "<a href="gnu_fdl.txt">GNU Free Documentation License</a>".</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_management.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="gnu_fdl.txt">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideCollections.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,234 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideCollections"> + <title> + Collections + </title> + <para> + Geeqie provides the ability to build lists of images, regardless of the location of the files on disk. + </para> + <para/><section id="Thecollectionwindow"><title> + The collection window + </title> + <para> + A collection window displays the contents of a collection. It allows the collection to be modified and access to the images contained in the collection. + </para> + <para> + To open a new empty collection window press C or select New collection from the file menu. + </para> + <para> + To open an existing collection, press O or select Open collection from the file menu. A dialog will appear requesting the location of the collection file. A window will the open containing the selected collection. Recently opened or saved collections can also be opened by selecting the collection's file name from the Open recent sub menu of the file menu. + </para> + <para> + The collection window consists of a pane to display the contents of the collection, and a status bar along the bottom of the window. + </para> + <para/><section id="Iconpane"><title> + Icon pane + </title> + <para> + The icon pane displays images contained in the collection as thumbnails in a grid, by default the file names also appear below each thumbnail. + </para> + <para> + The Icon pane works exactly like the Icon view mode of the <link linkend="GuideMainWindowFilePane">file pane</link> in a main window. But with the addition that the contents of the collection can be organized with drag and drop. + </para> + <para> + A <emphasis role="strong">context menu</emphasis> is available for the icon pane by right clicking the mouse or pressing the Menu key. + </para> + <para> + <emphasis role="strong">Keyboard shortcuts</emphasis> available in the collection window: + </para> + <informaltable><tgroup cols="3"><tbody><row><entry> + Shortcut + </entry><entry> + Context menu name + </entry><entry> + Description + </entry></row> +<row><entry> + Enter + </entry><entry> + View + </entry><entry> + Opens selected image in main window. + </entry></row> +<row><entry> + V + </entry><entry> + View in new window + </entry><entry> + Opens selected image in a new window. + </entry></row> +<row><entry> + Ctrl + A + </entry><entry> + Select all + </entry><entry> + Selects all images. + </entry></row> +<row><entry> + Ctrl + Shift + A + </entry><entry> + Select none + </entry><entry> + Clear the image selection. + </entry></row> +<row><entry> + Ctrl + 1 through<?db2html element="br"?> + Ctrl + 0 + </entry><entry> + Edit sub menu + </entry><entry> + Executes the respective editor command. + </entry></row> +<row><entry> + Ctrl + P + </entry><entry> + Properties + </entry><entry> + Opens a properties window for selected images. + </entry></row> +<row><entry> + Ctrl + C + </entry><entry> + Copy + </entry><entry> + Copy selected images. + </entry></row> +<row><entry> + Ctrl + M + </entry><entry> + Move + </entry><entry> + Move selected images. + </entry></row> +<row><entry> + Ctrl + R + </entry><entry> + Rename + </entry><entry> + Rename selected images. + </entry></row> +<row><entry> + Ctrl + D + </entry><entry> + Delete + </entry><entry> + Delete selected images. + </entry></row> +<row><entry> + Delete + </entry><entry> + Remove + </entry><entry> + Remove selected images from result list. + </entry></row> +<row><entry> + Ctrl + L + </entry><entry> + Append from file list + </entry><entry> + Add contents of main window to collection. + </entry></row> +<row><entry> + A + </entry><entry> + Append from collection + </entry><entry> + Append contents of another collection from a file. + </entry></row> +<row><entry> + S + </entry><entry> + Save collection + </entry><entry> + Save collection to disk, if the collection is new a dialog will appear to select the file name and location. + </entry></row> +<row><entry> + Ctrl + S + </entry><entry> + Save collection as + </entry><entry> + Opens a dialog to select a new file name to use for the collection. + </entry></row> +<row><entry> + Ctrl + T + </entry><entry> + Show filename text + </entry><entry> + Toggle display of text below icons. When set, icon's tooltip will show the full path to the file. + </entry></row> +<row><entry> + Menu + </entry><entry/><entry> + Displays the context menu. + </entry></row> +<row><entry> + N + </entry><entry> + Sort by name + </entry><entry> + Sort collection by file name. + </entry></row> +<row><entry> + I + </entry><entry> + Sort by number + </entry><entry> + Sort collection by file name, using natural numerical order + </entry></row> +<row><entry> + D + </entry><entry> + Sort by date + </entry><entry> + Sort collection by file date. + </entry></row> +<row><entry> + B + </entry><entry> + Sort by size + </entry><entry> + Sort collection by file size. + </entry></row> +<row><entry> + P + </entry><entry> + Sort by path + </entry><entry> + Sort collection by file location (path to file). + </entry></row> +<row><entry/><entry> + Print + </entry><entry> + Opens a print dialog for selected images. + </entry></row> +<row><entry> + Ctrl + W + </entry><entry/><entry> + Close window. + </entry></row> +</tbody></tgroup></informaltable> + <para> + The <emphasis role="strong">selection</emphasis> can be changed using the keyboard and mouse the same as in a <link linkend="GuideMainWindowFilePane">file pane</link> of the main window. + </para> + <para/></section><section id="Statusbar"><title> + Status bar + </title> + <para> + The status bar displays the total number of images in the collection, and the number of selected images in parenthesis. A progress bar also displays whenever thumbnails are loading from disk. + </para> + <para/></section><section id="DragandDrop"><title> + Drag and Drop + </title> + <para> + Drag and drop can be initialized with the primary or middle mouse buttons. Dragging an image that is selected will include all selected images in the drag. Dragging an image that is not selected will drag only that image. + </para> + <para> + Dropping files and folders onto the collection window will add them to the collection, they will be inserted at the location of the drop. A red arrow will indicate the location of the drop as files are dragged over the collection window. When one or more folders are included in the drop list, a menu will appear to select how to handle the contents of the folders. + </para> + <para> + To move images within the collection to change their order, initiate a drag for the selected image(s) and then move the mouse to the desired location within the window. A red arrow will appear to assist in determining the destination of the dragged images. Release the drag to move the images to the new location in the list. + </para> + <para> + 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. + </para> + <para/></section></section></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideCredits.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideCredits"> + <title> + Credits + </title> + <para/><section id="Authors"><title> + Authors + </title> + <para> + Geeqie is maintained by The Geeqie Team (Vladimir Nadvornik, Petr Ostadal, Laurent Monin). + </para> + <para> + This software is a fork of GQview project by John Ellis. + </para> + <para> + The ever growing list of contributors and language translators can be found in the README file included with the latest release of the program.<?db2html element="br"?> + The Credits can also be viewed by selecting the Credits button located in the About dialog <emphasis role="i">(open Help Menu, select About, click Credits... button)</emphasis>. + </para> + <para/></section><section id="Copyright"><title> + Copyright + </title> + <para> + Geeqie and this accompanying documentation is copyright (c) 2008 - 2009 The Geeqie Team and (c) 2006 John Ellis. + </para> + <para/></section><section id="License"><title> + License + </title> + <para> + The Geeqie program is released under the “GNU General Public Licenseâ€, the complete GNU GPL text can be found in the COPYING file included with each Geeqie release. + </para> + <para> + This Geeqie documentation is released under the "[[gnu_fdl.txt GNU Free Documentation License]]". + </para> + <para/></section><section id="LegalNotice"><title> + Legal Notice + </title> + <para> + Copyright (c) 2008 - 2009 The Geeqie Team.<?db2html element="br"?> + Copyright (c) 2006 John Ellis. + </para> + <para> + Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "[[gnu_fdl.txt GNU Free Documentation License]]". + </para> + <para/></section></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideFaq.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,51 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideFaq"> + <title> + Frequently Asked Questions + </title> + <para/><section id="Imageviewing"><title> + Image viewing + </title> + <para/><section id="HowdoIkeepimagessmallerthanthevisibleareafromenlargingwhenthezoomissettofittowindow"><title> + How do I keep images smaller than the visible area from enlarging when the zoom is set to “fit to window†? + </title> + <para> + In the preferences dialog, under the “Image†tab, disable “Allow enlargement of image for zoom to fitâ€. + </para> + <para/></section></section><section id="Commandline"><title> + Command line + </title> + <para/><section id="HowdoIopenanimageinanexistingGeeqieapplication"><title> + How do I open an image in an existing Geeqie application ? + </title> + <para> + Use the “-r†command line option to send commands to an existing Geeqie, for a list of commands supported by the remote switch run: + </para> + <programlisting> +`geeqie --remote-help` +</programlisting> + <para/></section><section id="HowdoIsettheslideshowdelaywhenstartingGeeqieinslideshowfromthecommandline"><title> + How do I set the slide show delay when starting Geeqie in slide show from the command line ? + </title> + <para> + 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: + </para> + <programlisting> +`geeqie -r -d12 -ss` +</programlisting> + <para> + Note that if geeqie is running prior to this command, the slide show should also be stopped prior to changing the delay: + </para> + <programlisting> +`geeqie -r -sS -d12 -ss` +</programlisting> + <para/></section></section><section id="Miscellaneous"><title> + Miscellaneous + </title> + <para/><section id="IwanttobeabletoeditimageswithGeeqie"><title> + I want to be able to edit images with Geeqie + </title> + <para> + Geeqie is an image <emphasis role="i">viewer</emphasis>. There is, and never will be, a plan to add editing features. I recommend gimp for image editing. + </para> + <para/></section></section></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideGnuFdl.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,405 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideGnuFdl"> + <title> + GNU Free Documentation License + </title> + <programlisting> + GNU Free Documentation License + Version 1.2, November 2002 + + + Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document "free" in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The "Document", below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as "you". You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall subject +(or to related matters) and contains nothing that could fall directly +within that overall subject. (Thus, if the Document is in part a +textbook of mathematics, a Secondary Section may not explain any +mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML, PostScript or PDF designed for human modification. Examples of +transparent image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +A section "Entitled XYZ" means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as "Acknowledgements", +"Dedications", "Endorsements", or "History".) To "Preserve the Title" +of such a section when you modify the Document means that it remains a +section "Entitled XYZ" according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has fewer than five), + unless they release you from this requirement. +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section Entitled "History", Preserve its Title, and add + to it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section Entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section all + the substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section to be Entitled "Endorsements" + or to conflict in title with any Invariant Section. +O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled "History" +in the various original documents, forming one section Entitled +"History"; likewise combine any sections Entitled "Acknowledgements", +and any sections Entitled "Dedications". You must delete all sections +Entitled "Endorsements". + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an "aggregate" if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document except +as expressly provided for under this License. Any other attempt to +copy, modify, sublicense or distribute the Document is void, and will +automatically terminate your rights under this License. However, +parties who have received copies, or rights, from you under this +License will not have their licenses terminated so long as such +parties remain in full compliance. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +http://www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.2 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. +</programlisting> + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageManagement.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideImageManagement"> + <title> + Image Management + </title> + <para> + Geeqie includes a set of utilities to copy, move, rename, and delete images. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementCopyMove.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementRename.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementDelete.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagementExternalEditing.xml"/> + + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageManagementCopyMove.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,96 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImageManagementCopyMove"> + <title> + Copy and Move + </title> + <para> + To copy an file in Geeqie press Ctrl + C, to move an file press Ctrl + M. These operations also appear under File in the main menu, and in the context menu of all images and files. + </para> + <para> + The Copy and Move operations and dialogs behave the same in Geeqie, with the only difference being the final result. The remaining text of this page applies equally to the Copy and Move operations, for the remainder of this page these will be referred to as a Copy/Move operation. + </para> + <para> + Initiating a Copy/Move operation will display a dialog to select the destination folder to Copy/Move the selected file, after the destination folder is selected Geeqie will proceed to Copy/Move the images to the destination. If an error occurs or a file exists with the same name as one of the files being Copy/Moved, a dialog will appear prompting how to handle the situation. + </para> + <para/><section id="TheCopyMovedialog"><title> + The Copy/Move dialog + </title> + <para> + This is the dialog that is displayed when initiating a Copy/Move operation. The dialog contains a row of buttons near the top, vertical list of bookmarks along the left side, a vertical list of folders in the current path, a text entry field, and a row of buttons along the bottom. + </para> + <variablelist><varlistentry><term> + Home button + </term><listitem><para> + Activate this button to change the active path to your home folder. + </para></listitem></varlistentry><varlistentry><term> + New Folder button + </term><listitem><para> + Activate this to create a new empty folder as a sub folder of the active path. The new folder will appear in the folder list ready for you to type in the desired name. + </para></listitem></varlistentry><varlistentry><term> + Show Hidden check box + </term><listitem><para> + Enabling this check box will cause hidden folders to appear in the folder list. + </para></listitem></varlistentry><varlistentry><term> + Bookmark list + </term><listitem><para> + This list on the left side of the window allows you to save links to folders that are frequently used. Activating a bookmark will change the active path to that pointed to by the link. To add items to the bookmark list highlight a folder and press Ctrl + B, select “Add bookmark†from the folder's context menu, or drag a folder onto the bookmark list.<?db2html element="br"?> + The bookmark has a context menu that can be displayed by clicking the right mouse button, or pressing the Menu key when a bookmark has the focus. From the context menu you can edit a bookmark, move it up or down in the list, or remove the bookmark from the list. A bookmark can also be moved by pressing Shift + Up or Shift + Down while it has the focus. + </para></listitem></varlistentry><varlistentry><term> + Folder list + </term><listitem><para> + This is the list that displays the folders contained in the active path. To change the active path to a folder displayed in this list double click the primary mouse button or highlight the folder with the keyboard and press Enter or Spacebar. This list has a context menu that allows renaming or bookmarking the selected folder. A folder can also be dragged onto the bookmark list to add a bookmark. + </para></listitem></varlistentry><varlistentry><term> + Path entry + </term><listitem><para> + This text entry displays the active path of the dialog. The path can be directly edited using this entry. Tab completion is supported, and the drop down arrow will display a list of recently selected folders. + </para></listitem></varlistentry><varlistentry><term> + Copy/Move button + </term><listitem><para> + The name of this button will differ depending on the selected operation, activating it will start the operation with the folder displayed in the path entry as the destination. + </para></listitem></varlistentry><varlistentry><term> + Cancel button + </term><listitem><para> + Activate this button to close the dialog, the operation will be aborted. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Theerrordialog"><title> + The error dialog + </title> + <para> + If a problem occurs because Geeqie is unable to Copy or Move a selected file a dialog will appear to notify the user. The dialog will also ask if the operation should continue if one or more files remain to be Copied or Moved. + </para> + <para/></section><section id="Theoverwritedialog"><title> + The overwrite dialog + </title> + <para> + If a file with the same name exists in the selected destination a dialog will appear to notify the user and ask how to resolve the conflict. The dialog will also display the source and destination images. The following possible solutions will be offered: + </para> + <variablelist><varlistentry><term> + Auto rename + </term><listitem><para> + Enabling this check box to have Geeqie select a unique name for the destination file, the proposed new name will appear in the rename entry field. + </para></listitem></varlistentry><varlistentry><term> + Rename + </term><listitem><para> + Enable this check box to manually enter a new name for the file. + </para></listitem></varlistentry><varlistentry><term> + Overwrite + </term><listitem><para> + Activate this will overwrite the existing file, or rename it if one of the rename check boxes are enabled. + </para></listitem></varlistentry><varlistentry><term> + Overwrite all + </term><listitem><para> + Activating this will perform the same operation as the Yes button, however any further file name conflicts will be handled quietly in the same method as is selected for the current file. + </para></listitem></varlistentry><varlistentry><term> + Skip + </term><listitem><para> + This button will skip doing anything to the file in question, and resume the operation with the next file. The source file will remain untouched. + </para></listitem></varlistentry><varlistentry><term> + Skip All + </term><listitem><para> + This will perform the same as the Skip button, however any further file name conflicts will be quietly ignored for all remaining files. + </para></listitem></varlistentry><varlistentry><term> + Cancel + </term><listitem><para> + This will close the dialog and stop the operation, all remaining files will be ignored. + </para></listitem></varlistentry></variablelist> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageManagementDelete.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImageManagementDelete"> + <title> + Delete + </title> + <para> + To delete a file in Geeqie press Ctrl + D, or select Delete from the file menu. Delete is also available in the context menu of all images and files. If <link linkend="GuideOptionsAdvanced">Enable delete key?</link> is enabled in Options, pressing the Delete key can also be used to delete files. + </para> + <para> + The behavior when starting a delete operation depends on the <link linkend="GuideOptionsAdvanced">Confirm file delete?</link> option in Options. If the option is enabled a dialog will appear to confirm the operation, if it is not enabled the files will be deleted without further interaction. In all cases if the file is unable to be deleted you will be notified by a dialog. + </para> + <para/><section id="Confirmdeletedialog"><title> + Confirm delete dialog + </title> + <para> + The dialog that appears when delete confirmation is enabled will show the file or files to be deleted. To delete the file press Enter or activate the Delete button. Pressing Escape or activating the Cancel button will close the dialog and abort the operation. + </para> + <para> + When deleting multiple files, the dialog will include two arrow buttons to step the image preview through the list of files to be deleted. Initially the preview will be blank, activate the right arrow to display the first file. + </para> + <para> + The dialog will also display the status of the <link linkend="GuideOptionsAdvanced">Safe Delete?</link> feature. Use this to determine if a file to be deleted will be immediately lost, or if the file can possibly be recovered from the Safe Delete folder. + </para> + <para> + If a file is unable to be deleted, a dialog will appear to notify you. If multiple files were selected and any remain, the dialog will include a Continue button, activating this button or pressing Enter will delete the remaining files. Pressing Escape or activating the Cancel button will close the dialog and the remaining files will not be deleted. + </para> + <para/></section><section id="SafeDelete"><title> + Safe Delete + </title> + <para> + Geeqie includes a feature to temporarily store deleted files in a selected folder, to use this feature enable <link linkend="GuideOptionsAdvanced">Safe Delete?</link> on the advanced tab of the preferences dialog. + </para> + <para> + Safe Delete includes these options: + </para> + <variablelist><varlistentry><term> + Folder + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The folder to use for temporarily retaining deleted files. + </para> + <variablelist><varlistentry><term> + Maximum size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The maximum amount of disk space to use when storing deleted files, in megabytes. + </para> + <para> + When the total size of the deleted files stored in the Safe Delete folder exceeds the Maximum size, the oldest files are removed from the folder to make space for the new deleted files. + </para> + <para> + Files moved to the Safe Delete folder are prefixed with a six digit number in the format: <literal>nnnnnn_FILENAME</literal> + </para> + <para> + This is used to distinguish which files to remove first when clearing space for new files. The digit counter increments with each deleted file. + </para> + <para> + To clear the contents of the Safe Delete folder, activate the Clear button provided for this purpose on the <link linkend="GuideOptionsAdvanced">Advanced tab?</link> in Options. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageManagementExternalEditing.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImageManagementExternalEditing"><title/> + <para/><section id="ExternalEditing"><title> + External Editing + </title> + <para> + Geeqie provides the ability to execute commands, such as running an image editor on a selected image. In Geeqie these are called the external editing commands. + </para> + <para/></section><section id="ExternalEditors"><title> + External Editors + </title> + <para> + External editors can do anything from running simple operations like symlink to fully featured programs like gimp. + </para> + <para> + Geeqie looks for standard desktop files. + </para> + <para> + <ulink url="http://standards.freedesktop.org/desktop-entry-spec/">http://standards.freedesktop.org/desktop-entry-spec/</ulink> + </para> + <para> + <ulink url="http://standards.freedesktop.org/menu-spec/">http://standards.freedesktop.org/menu-spec/</ulink> + </para> + <para> + It is also possible to add Geeqie-specific editors with the <link linkend="GuideEditorsConfig">Editor configuration dialog?</link> + </para> + <para> + Editors appear in menu Edit / External Editors, unless specified otherwise in the desktop file. + </para> + <para/><section id="Resultdialog"><title> + Result dialog + </title> + <para> + Commands that are set to display their output in a window will show a dialog when the command is executed. + </para> + <para> + The Result dialog will display the command's text output. If the editor command will result in multiple runs of the same command for each file, you can use the Stop button to stop Geeqie from executing the command for remaining files. + </para> + <para> + Once all commands have completed, or if the Stop button was pressed and the pending command has completed, you can use the Close button, or press Escape, to close the Result dialog. The Result dialog can not be closed while a command is still running. + </para> + <para/></section></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageManagementRename.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImageManagementRename"> + <title> + Rename + </title> + <para> + To rename a file in Geeqie press Ctrl + R, or select Rename from the File menu. Rename is also available in the context menu of all images and files. + </para> + <para> + When renaming a file, a dialog will display allowing entry of the new name for the file. The dialog will be different depending on the number of files selected to be renamed. A simple dialog will appear when renaming a single file, however when renaming multiple files the dialog will include a list of the file to be renamed and additional options. + </para> + <para/><section id="Renamesinglefiledialog"><title> + Rename single file dialog + </title> + <para> + The dialog that appears when renaming a single file includes an image of the file, an entry to type the new name of the file, a Rename button, and a Cancel button. Type the new name into the text entry and press Enter or activate the Rename button to rename the file. Press Escape or activate the Cancel button to close the dialog and abort renaming the file. + </para> + <para> + When renaming a file and the new name already exists on the file system a dialog will appear showing the renamed and existing files. To overwrite the existing file press Enter or activate the Overwrite button. Press Escape or activate the Cancel button to close the dialog abort renaming the file. + </para> + <para/></section><section id="Renamemultiplefilesdialog"><title> + Rename multiple files dialog + </title> + <para> + The dialog that appears when renaming multiple files includes the list of files to be renamed, a preview image of the active file, an entry to enter the new file name, an auto rename check box, a Rename button, and a Cancel button. + </para> + <variablelist><varlistentry><term> + Manually enter new file names + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + To manually enter the new name of each file, the active file will be displayed in the image preview and it's original name will be displayed above the text entry. To rename the file type the new name and press Enter or activate the Rename button. When a file is successfully renamed it will be removed from the list and the next one will become the active file. After all files have been renamed, the dialog will close. + </para> + <para> + Files do not have to be renamed in the order that they appear in the list, highlighting a name in the list will make it become the active file. + </para> + <para> + When renaming a file and the new name already exists on the file system a dialog will appear showing the renamed and existing files. To overwrite the existing file press Enter or activate the Overwrite button. Press Escape or activate the Cancel button to return to the original rename dialog, the file that prompted the overwrite dialog will remain active. + </para> + <variablelist><varlistentry><term> + Automatic renaming of multiple files + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + To automatically rename the files in the list, enable the Auto rename check box. The dialog will change to batch mode for numerical naming of files. + </para> + <para> + The file name list will change to include a preview column that will show the resulting name of each file. The text entry will change to three entries; the first represents the text that appears in the new names before the number, the second will be the start number to use when incrementing the file number, and the third represents the text to append to the name after the number. The end text should include the file name extension, therefore batch renaming multiple types of files (those with different extensions) all at once is not recommended. + </para> + <para> + The padding number can be used to change the minimum length of characters to use for the number portion of the new name. When the file number results in fewer characters than the padding size, the result will be padded with leading zeros to fill the remaining space. For example if padding size is 3, a file with the number 24 will appear in the file name as “024â€. + </para> + <para> + The order of the file list can be changed by dragging a name to the desired location within the list. The preview column will update to reflect the new order. + </para> + <para> + When the preview of new names is satisfactory, press Enter or activate the Rename button to rename the files to match the name in the preview column. Press Escape or activate the Cancel button to close the dialog and abort the rename operation. + </para> + <para> + If the resulting new names match any existing files, a warning dialog will notify you. The rename dialog will remain so that you can select a different set of names. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImagePresentation.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideImagePresentation"> + <title> + Image Presentation + </title> + <para> + Geeqie can be used to display a set of images, showing each image for a period of time before changing to the next image. Images can also be set to fill the entire screen. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImagePresentationSlideshow.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImagePresentationFullscreen.xml"/> + + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImagePresentationFullscreen.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,204 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImagePresentationFullscreen"> + <title> + Full Screen + </title> + <para> + Geeqie allows for the image pane to be expanded to fill the entire screen, this is referred to as full screen. + </para> + <para/><section id="Turningonfullscreen"><title> + Turning on full screen + </title> + <para> + Full screen can be activated in a number of ways: + </para> + <itemizedlist spacing="compact"><listitem><para>From the menu bar - open the <emphasis role="strong">View</emphasis> menu and select <emphasis role="strong">Full screen</emphasis>. + </para></listitem><listitem><para>From the keyboard - press the F key to toggle full screen. + </para></listitem><listitem><para>From a context menu - right click an image pane, and select <emphasis role="strong">Full screen</emphasis>. + </para></listitem></itemizedlist> + <para/></section><section id="Turningofffullscreen"><title> + Turning off full screen + </title> + <para> + To return to the normal view: + </para> + <itemizedlist spacing="compact"><listitem><para>From the keyboard - press the F or Esc key to stop full screen. + </para></listitem><listitem><para>From a context menu - right click the image pane, and select <emphasis role="strong">Exit full screen</emphasis>. + </para></listitem><listitem><para>From the menu bar - the menu bar may be visible when using multiple monitors, open the <emphasis role="strong">View</emphasis> menu and select <emphasis role="strong">Full screen</emphasis>. + </para></listitem></itemizedlist> + <para/></section><section id="Configuringfullscreen"><title> + Configuring full screen + </title> + <para> + Full screen behavior and location can be adjusted on the <link linkend="GuideOptionsAdvanced">Advanced tab?</link> of the preferences dialog. + </para> + <variablelist><varlistentry><term> + Size and location + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This can be changed using Full screen size option, this can be used to select the monitor to use in a multiple monitor configuration. + </para> + <variablelist><varlistentry><term> + Smooth image flip in full screen + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This option delays the image change until the next image is entirely decoded into memory, the result is a smoother transition between images. + </para> + <variablelist><varlistentry><term> + Disable screen saver in full screen + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This option will execute <emphasis role="i">xscreensaver-command --deactivate</emphasis> once per minute to avoid the screen saver from activating. + </para> + <para/></section><section id="Navigation"><title> + Navigation + </title> + <para> + The usual image navigation controls are available when in full screen, these are the commands available: + </para> + <informaltable><tgroup cols="3"><tbody><row><entry> + Keyboard + </entry><entry> + Mouse + </entry><entry> + Description + </entry></row> +<row><entry> + F, V, Esc + </entry><entry> + Context menu + </entry><entry> + Turn off full screen. + </entry></row> +<row><entry> + <emphasis role="strong">Image Navigation</emphasis> + </entry></row> +<row><entry> + <ulink url="/wiki/PageDown">PageDown?</ulink> + </entry><entry> + Left Click on image view<?db2html element="br"?> + Mouse Wheel down [<ulink url="/wiki#bottomnote1">(*)</ulink>] + </entry><entry> + Change to next image. + </entry></row> +<row><entry> + <ulink url="/wiki/PageUp">PageUp?</ulink> + </entry><entry> + Middle Click on image view<?db2html element="br"?> + Mouse Wheel up [<ulink url="/wiki#bottomnote1">(*)</ulink>] + </entry><entry> + Change to previous image. + </entry></row> +<row><entry> + Home + </entry><entry/><entry> + Change to first image. + </entry></row> +<row><entry> + End + </entry><entry/><entry> + Change to last image. + </entry></row> +<row><entry> + <emphasis role="strong">Image panning</emphasis> (image has keyboard focus) + </entry></row> +<row><entry> + Arrows + </entry><entry> + Left Drag on image view<?db2html element="br"?> + Shift + Mouse Wheel [<ulink url="/wiki#bottomnote1">(*)</ulink>] + </entry><entry> + Pan image. + </entry></row> +<row><entry> + Shift + Arrows + </entry><entry/><entry> + Pan Image faster. + </entry></row> +<row><entry> + Ctrl + Arrows + </entry><entry/><entry> + Pan to respective edge of image. + </entry></row> +<row><entry> + <ulink url="/wiki/SpaceBar">SpaceBar?</ulink> + </entry><entry/><entry> + Change to next image. + </entry></row> +<row><entry> + Backspace + </entry><entry/><entry> + Change to previous image. + </entry></row> +</tbody></tgroup></informaltable> + <para> + Several other standard controls are also available through the keyboard and context menu: + </para> + <informaltable><tgroup cols="2"><tbody><row><entry> + Function + </entry><entry> + Difference from normal view + </entry></row> +<row><entry> + Copy, Move, Rename + </entry><entry> + same + </entry></row> +<row><entry> + Delete + </entry><entry> + same + </entry></row> +<row><entry> + External edit commands<?db2html element="br"?> + (Ctrl + 1 ... 0, context menu) + </entry><entry> + Full screen will turn off prior to activating the function. + </entry></row> +<row><entry> + Open image properties window<?db2html element="br"?> + (Ctrl + P, context menu) + </entry><entry> + same + </entry></row> +<row><entry> + Image rotation, mirror, and flip + </entry><entry> + same + </entry></row> +<row><entry> + Zoom controls + </entry><entry> + same + </entry></row> +<row><entry> + I + </entry><entry> + Toggle information overlay for full screen: on with histogram, on without histogram, off. + </entry></row> +<row><entry> + K + </entry><entry> + Switch between the different histogram modes: RGB, value, maximum value, red channel, green channel, blue channel. + </entry></row> +<row><entry> + J + </entry><entry> + Toogle between linear and logarithmical histogram. + </entry></row> +<row><entry> + Slide show controls<?db2html element="br"?> + (S, P, context menu) + </entry><entry> + same + </entry></row> +<row><entry> + Quit with Ctrl + Q + </entry><entry> + same + </entry></row> +</tbody></tgroup></informaltable> + <para> + (*) Note: Default Mouse wheel functions can be altered by changing the <link linkend="GuideOptionsAdvanced">Mouse wheel scrolls image?</link> option. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImagePresentationSlideshow.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImagePresentationSlideshow"> + <title> + Slide Show + </title> + <para> + The image pane can be set to automatically change the displayed image after a period of time, in Geeqie this is referred to as a slide show. + </para> + <para/><section id="Startingaslideshow"><title> + Starting a slide show + </title> + <para> + A slide show can be started in a number of ways: + </para> + <itemizedlist spacing="compact"><listitem><para>From the menu bar - open the <emphasis role="strong">View</emphasis> menu and select <emphasis role="strong">Toggle slide show</emphasis> to toggle the slide show on or off . + </para></listitem><listitem><para>From the keyboard - press the S key to toggle the slide show on or off. + </para></listitem><listitem><para>From a context menu - right click an image pane, and select <emphasis role="strong">Start slide show</emphasis>, or <emphasis role="strong">Stop slide show</emphasis>; the text will change depending on the state of the current slide show. + </para></listitem></itemizedlist> + <para/></section><section id="Stoppingaslideshow"><title> + Stopping a slide show + </title> + <para> + An active slide show can be stopped by using the same functions available to start one, as they work like a toggle switch. If slide show repeat is not enabled in the <link linkend="GuideOptionsGeneral">options dialog</link>, the slide show will stop when the last image in the sequence is displayed. + </para> + <para> + Any action that changes the image pane to a new image will stop the active slide show, with the exception of the methods discussed in [<ulink url="/wiki#navigation">Slide show sequence navigation</ulink>]. + </para> + <para/></section><section id="Slideshowstatus"><title> + Slide show status + </title> + <para> + The main window <link linkend="GuideMainWindowStatusBar">status bar</link> can be used to determine when a slide show is active, <emphasis role="strong">Slide show</emphasis> will be displayed next to the file count field. An individual <link linkend="GuideOtherWindowsImageWindow">Image Window</link> can also display a slide show, however the status will not be immediately visible. To determine the slide show status in an image window, open a context menu by right clicking or using the menu key, the slide show menu item will reflect the slide show status; if <emphasis role="strong">Start slide show</emphasis> is displayed, no slide show is active, conversely if <emphasis role="strong">Stop slide show</emphasis> is displayed a slide show is active. + </para> + <para> + When a Slide show is paused, the main window status bar will display <emphasis role="strong">Paused</emphasis> instead of <emphasis role="strong">Slide show</emphasis>. Likewise, the image context menu will display <emphasis role="strong">Pause slide show</emphasis> or <emphasis role="strong">Continue slide show</emphasis>, depending on the current state. + </para> + <para/></section><section id="Pausingaslideshow"><title> + Pausing a slide show + </title> + <para> + An active slide show can be paused in two ways: + </para> + <itemizedlist spacing="compact"><listitem><para>From the keyboard - press the P key while a slide show is active. + </para></listitem><listitem><para>From a context menu - right click the image pane displaying the slide show, and select <emphasis role="strong">Pause slide show</emphasis>, or <emphasis role="strong">Continue slide show</emphasis> depending on the current slide show state. + </para></listitem></itemizedlist> + <para/></section><section id="Selectingtheimagestoincludeinaslideshow"><title> + Selecting the images to include in a slide show + </title> + <para> + When a single image is selected, all images in the current folder are included in the slide show. The sequence will begin with the current image; however if random slide shows are enabled, the sequence will begin with a random image from the list. + </para> + <para> + To only include some images in a slide show, use multiple selection to select the images to include before starting the slide show. + </para> + <para> + An image collection can be used as the list of images, to do this drag an image from a collection window onto the image pane. Starting a slide show will then include the images from that collection. + </para> + <para> + So far, the methods described are for slide shows in a main window, in an <link linkend="GuideOtherWindowsImageWindow">Image Window</link>, the slide show will use all images referenced by that window. + </para> + <para/></section><section id="Recursiveslideshow"><title> + Recursive slide show + </title> + <para> + In the main window, a recursive slide show can be started from a folder's context menu; the folder's right click menu will include two slide show options: + </para> + <itemizedlist spacing="compact"><listitem><para>Slide show: This will start a slide show that includes all images in the selected folder. + </para></listitem><listitem><para>Slide show recursive: The slide show will include all images in the selected folder, and all images in the folders that are contained within the selected folder. + </para></listitem></itemizedlist> + <para/></section><section id="Slideshowsequencenavigation"><title> + Slide show sequence navigation + </title> + <para> + When a slide show is active, functions that normally change the image forward and backward can be used to step through those contained in the slide show. + </para> + <para/></section><section id="Configuringaslideshow"><title> + Configuring a slide show + </title> + <para> + The options that control the behavior of slide shows are located on the <link linkend="GuideOptionsGeneral">General tab</link> of the options dialog. + </para> + <variablelist><varlistentry><term> + Display time + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The delay between each image in the slide show can be adjusted with the Delay before image change option. + </para> + <variablelist><varlistentry><term> + Repeat + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will cause the slide show to loop indefinitely, it will continue with the first image after displaying the last image in the slide show list. + </para> + <variablelist><varlistentry><term> + Random + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will display images randomly selected from the slide show list. Each image from the slide show list will be displayed once. When Repeat is also enabled, the random sequence is changed after each complete cycle of the images. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageSearch.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideImageSearch"> + <title> + Image Search + </title> + <para> + Geeqie provides methods to find an image, and the ability to find duplicate images. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageSearchSearch.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageSearchFindingDuplicates.xml"/> + + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageSearchFindingDuplicates.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,307 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImageSearchFindingDuplicates"> + <title> + Finding Duplicates + </title> + <para> + Geeqie provides a utility to find images that have similar attributes or content. + </para> + <para> + To display a new Find Duplicates Window press D or select Find duplicates from the File menu. + </para> + <para/><section id="Addingfilestobecompared"><title> + Adding files to be compared + </title> + <para> + Add files to be compared using drag and drop. Drop files or folders onto the Find Duplicates window to add them to the list of files to compare. When one or more folders are dropped onto the window a menu will appear allowing you to choose the desired action: + </para> + <variablelist><varlistentry><term> + Add contents + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The contents of dropped folders will added to the window. + </para> + <variablelist><varlistentry><term> + Add contents recursive + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The contents of dropped folders and all sub folders will be added to the window. + </para> + <variablelist><varlistentry><term> + Skip folders + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Ignore folders contained in the drop list. + </para> + <para> + When files are added to the window, the comparison is restarted to include the new files. + </para> + <para/></section><section id="Comparisonmethods"><title> + Comparison methods + </title> + <para> + The attribute to use for two images to match can be selected with the “Compare by:†drop down menu. Each method is explained below: + </para> + <variablelist><varlistentry><term> + Name + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The file name. + </para> + <variablelist><varlistentry><term> + Name case-insensitive + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The file name but ignoring case. + </para> + <variablelist><varlistentry><term> + Size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The file size. + </para> + <variablelist><varlistentry><term> + Date + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The file date. + </para> + <variablelist><varlistentry><term> + Dimensions + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The image dimensions. + </para> + <variablelist><varlistentry><term> + Checksum + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The MD5 file checksum. + </para> + <variablelist><varlistentry><term> + Path + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The complete path to file. + </para> + <variablelist><varlistentry><term> + Similarity (high) + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Very similar image content. + </para> + <variablelist><varlistentry><term> + Similarity + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Similar image content. + </para> + <variablelist><varlistentry><term> + Similarity (low) + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Slightly similar image content. + </para> + <variablelist><varlistentry><term> + Similarity (custom) + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Similar image content, the value to use to consider two images a match is configured in the <link linkend="GuideOptionsAdvanced">Advanced tab?</link> of the preferences dialog by setting the “Custom similarity thresholdâ€. + </para> + <para/></section><section id="Resultslist"><title> + Results list + </title> + <para> + Files that match with the selected comparison method will appear in the list. Matching files are grouped in alternating color. + </para> + <para> + The order of the result list can not be changed, files will appear in the order of the search. When comparing by image content similarity, the matching groups will be sorted by order of rank starting with the files that are most similar. + </para> + <para> + A <emphasis role="strong">context menu</emphasis> is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus. + </para> + <para> + <emphasis role="strong">Keyboard shortcuts</emphasis> available in the results list: + </para> + <informaltable><tgroup cols="3"><tbody><row><entry> + Shortcut + </entry><entry> + Context menu name + </entry><entry> + Description + </entry></row> +<row><entry> + Enter + </entry><entry> + View + </entry><entry> + Opens selected image in main window. + </entry></row> +<row><entry> + V + </entry><entry> + View in new window + </entry><entry> + Opens selected image in a new window. + </entry></row> +<row><entry> + Ctrl + A + </entry><entry> + Select all + </entry><entry> + Selects all images. + </entry></row> +<row><entry> + Ctrl + Shift + A + </entry><entry> + Select none + </entry><entry> + Clear the image selection. + </entry></row> +<row><entry> + 1 + </entry><entry> + Select group 1 duplicates + </entry><entry> + Selects the first image from each match group. + </entry></row> +<row><entry> + 2 + </entry><entry> + Select group 2 duplicates + </entry><entry> + Selects all but the first image from each match group. + </entry></row> +<row><entry> + Ctrl + 1 through<?db2html element="br"?> + Ctrl + 0 + </entry><entry> + Edit sub menu + </entry><entry> + Executes the respective editor command. + </entry></row> +<row><entry> + Ctrl + P + </entry><entry> + Properties + </entry><entry> + Opens a properties window for selected images. + </entry></row> +<row><entry> + C + </entry><entry> + Add to new collection + </entry><entry> + Creates a new collection containing the selected images. + </entry></row> +<row><entry/><entry> + Print + </entry><entry> + Opens a print dialog for selected images. + </entry></row> +<row><entry> + Ctrl + C + </entry><entry> + Copy + </entry><entry> + Copy selected images. + </entry></row> +<row><entry> + Ctrl + M + </entry><entry> + Move + </entry><entry> + Move selected images. + </entry></row> +<row><entry> + Ctrl + R + </entry><entry> + Rename + </entry><entry> + Rename selected images. + </entry></row> +<row><entry> + Ctrl + D + </entry><entry> + Delete + </entry><entry> + Delete selected images. + </entry></row> +<row><entry> + Delete + </entry><entry> + Remove + </entry><entry> + Remove selected images from result list. + </entry></row> +<row><entry> + Ctrl + Delete + </entry><entry> + Clear + </entry><entry> + Cleared the result list. + </entry></row> +<row><entry> + Menu + </entry><entry/><entry> + Displays the context menu. + </entry></row> +<row><entry> + Ctrl + T + </entry><entry/><entry> + Toggle display of thumbnails. + </entry></row> +<row><entry> + Ctrl + W + </entry><entry/><entry> + Close window. + </entry></row> +</tbody></tgroup></informaltable> + <para> + The <emphasis role="strong">selection</emphasis> can be changed using the keyboard and mouse the same as in a <link linkend="GuideMainWindowFilePane">file pane</link> of the main window. + </para> + <para> + The image Dimensions column of the result list will only contain dimension information when comparing by dimensions, or when the data is easily available from memory or has been read from the cache. + </para> + <para/></section><section id="Statusbar"><title> + Status bar + </title> + <para> + Along the bottom of the Find Duplicates window is an area that displays the count of files contained in the window, and the number of files in the result list. + </para> + <para> + The status bar will also display the status of an active compare operation using the progress bar. A compare operation involves 2 or 3 stages, depending on the type of comparison. These are the stages in order: + </para> + <para> + 1) If necessary, extra data is read into memory for the comparison stage, the progress bar will indicate this stage with text that resembles “reading dimensions...â€, “reading checksums...â€, or “reading similarity data...â€.<?db2html element="br"?> + 2) The images are compared using the selected method, the progress bar will indicate this stage with the text “comparing...â€.<?db2html element="br"?> + 3) The results are sorted for display, the progress bar will indicate this stage with the text “sorting...â€. + </para> + <para> + Stage 1 is only used for the Dimensions, Checksum, and Similarity compare methods. + </para> + <para> + If the time to complete a stage will be significant, an estimated time to completion will also be displayed in the progress bar. The estimated time only refers to the current stage, other stages are not included in the estimate. The time estimate is displayed using the format MINUTES:SECONDS. + </para> + <para/></section><section id="Thumbnails"><title> + Thumbnails + </title> + <para> + Thumbnails can be displayed beside each image in the result list by enabling the Thumbnails check box. + </para> + <para/></section><section id="Comparetwofilesets"><title> + Compare two file sets + </title> + <para> + Sometimes it is useful to compare one group of files to another, different group of files. Enable this check box to compare two groups of files. When enabled a second list will appear, files can be added to this list using the same methods for the main list. + </para> + <para> + When comparing two file sets the results list will display matches between the two lists. For each match group, the first file is always from the main group, and the remaining files are always from the second group. + </para> + <para/></section><section id="DragandDrop"><title> + Drag and Drop + </title> + <para> + Drag and drop can be initiated with the primary or middle mouse buttons. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideImageSearchSearch.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,276 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideImageSearchSearch"> + <title> + Search Window + </title> + <para> + Geeqie provides a utility to find one or more images based on various parameters. + </para> + <para> + To display a new Search Window press F3 or select Search from the File menu. + </para> + <para> + To start a search activate the Find button. A search in progress can be stopped by activating the Stop button. + </para> + <para> + The progress of an active search is displayed as a progress bar at the bottom of the window. The progress bar will also display the total files that match the search parameters, and the total number of files searched. + </para> + <para> + When a search is completed, the total number of files found and their total size will be displayed in the status bar. + </para> + <para/><section id="Searchlocation"><title> + Search location + </title> + <para> + One of several locations can be chosen as the source to use in the search. + </para> + <variablelist><varlistentry><term> + Path + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders. + </para> + <variablelist><varlistentry><term> + Comments + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will include all files that have a keyword or comment associated to it. + </para> + <para> + Note: Only keyword and comment associations stored in the user's home folder are included in this search type. + </para> + <variablelist><varlistentry><term> + Results + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will include all files currently listed in the results list, use this to refine a previous search. + </para> + <para/></section><section id="Searchparameters"><title> + Search parameters + </title> + <para> + Each search parameter can be enabled or disabled with the check box to it's left. For a file to be a match, all enabled parameters must be true. + </para> + <variablelist><varlistentry><term> + File name + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will match if the entered text appears within the file name, or if the text exactly matches the file name, depending on the method selected from the drop down menu. The text comparison can be made to be case sensitive by enabling the Match case checkbox. + </para> + <variablelist><varlistentry><term> + File size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will match if the file size on disk is equal to, less than, greater than, or between the entered value, depending on the method selected from the drop down menu. The between test is inclusive, for example a file of size 10 will match if the size parameters are between 10 and 15. + </para> + <variablelist><varlistentry><term> + File date + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will match if the file modification time on disk is equal to, before, after, or between the entered date, depending on the method selected from the drop down menu. The between test is inclusive, for example a file with date of 10/04/2003 will match if the date parameters are between 10/04/2003 and 12/31/2003. + </para> + <para> + For convenience, the button with the down arrow displays a pop up calendar to enter the date. + </para> + <variablelist><varlistentry><term> + Image dimensions + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will match if the image dimensions are equal to, less than, greater than, or between the entered values, depending on the method selected from the drop down menu. The between test is inclusive. + </para> + <para> + The image dimensions test is simple, both width and height must be within the allowed values for a match. + </para> + <variablelist><varlistentry><term> + Image content + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will match if the image contents are similar within the percentage value, inclusive. This uses the same test and data that is used to determine image similarity when <link linkend="GuideImageSearchFindingDuplicates">Finding Duplicates</link>. The entry is for entering the path for the image to use in this test. + </para> + <variablelist><varlistentry><term> + Keywords + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The search will match if the file's associated keywords match all, match any, or exclude the entered keywords, depending on the method selected from the drop down menu. Keywords can be separated with a space, comma, or tab character. + </para> + <para/></section><section id="Resultslist"><title> + Results list + </title> + <para> + Files that match the parameters of the search are shown in the list. By default they are displayed in the order that they are found, to sort the results list by a column activate or click the column title. Activating a column that is already used to sort the list will toggle between increasing and decreasing sort order. + </para> + <para> + A <emphasis role="strong">context menu</emphasis> is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus. + </para> + <para> + <emphasis role="strong">Keyboard shortcuts</emphasis> available in the results list: + </para> + <informaltable><tgroup cols="3"><tbody><row><entry> + Shortcut + </entry><entry> + Context menu name + </entry><entry> + Description + </entry></row> +<row><entry> + Enter + </entry><entry> + View + </entry><entry> + Opens selected image in main window. + </entry></row> +<row><entry> + V + </entry><entry> + View in new window + </entry><entry> + Opens selected image in a new window. + </entry></row> +<row><entry> + Ctrl + A + </entry><entry> + Select all + </entry><entry> + Selects all images. + </entry></row> +<row><entry> + Ctrl + Shift + A + </entry><entry> + Select none + </entry><entry> + Clear the image selection. + </entry></row> +<row><entry> + Ctrl + 1 through<?db2html element="br"?> + Ctrl + 0 + </entry><entry> + Edit sub menu + </entry><entry> + Executes the respective editor command. + </entry></row> +<row><entry> + Ctrl + P + </entry><entry> + Properties + </entry><entry> + Opens a properties window for selected images. + </entry></row> +<row><entry> + C + </entry><entry> + Add to new collection + </entry><entry> + Creates a new collection containing the selected images. + </entry></row> +<row><entry/><entry> + Print + </entry><entry> + Opens a print dialog for selected images. + </entry></row> +<row><entry> + Ctrl + C + </entry><entry> + Copy + </entry><entry> + Copy selected images. + </entry></row> +<row><entry> + Ctrl + M + </entry><entry> + Move + </entry><entry> + Move selected images. + </entry></row> +<row><entry> + Ctrl + R + </entry><entry> + Rename + </entry><entry> + Rename selected images. + </entry></row> +<row><entry> + Ctrl + D + </entry><entry> + Delete + </entry><entry> + Delete selected images. + </entry></row> +<row><entry> + Delete + </entry><entry> + Remove + </entry><entry> + Remove selected images from result list. + </entry></row> +<row><entry> + Ctrl + Delete + </entry><entry> + Clear + </entry><entry> + Cleared the result list. + </entry></row> +<row><entry> + Menu + </entry><entry/><entry> + Displays the context menu. + </entry></row> +<row><entry> + Ctrl + T + </entry><entry/><entry> + Toggle display of thumbnails. + </entry></row> +<row><entry> + Ctrl + W + </entry><entry/><entry> + Close window. + </entry></row> +</tbody></tgroup></informaltable> + <para> + The <emphasis role="strong">selection</emphasis> can be changed using the keyboard and mouse the same as in a <link linkend="GuideMainWindowFilePane">file pane</link> of the main window. + </para> + <para> + The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters. + </para> + <para/></section><section id="Statusbar"><title> + Status bar + </title> + <para> + At the bottom of the search window is an area that includes the following items from left to right: + </para> + <variablelist><varlistentry><term> + Thumbnails + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this check box to display a thumbnail next to each image in the results list. + </para> + <variablelist><varlistentry><term> + File count display + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis. + </para> + <variablelist><varlistentry><term> + Search progress + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + When a search is active, the text “Searching...†will appear here. Two numbers in parenthesis will also be displayed, the first number is the number of files that match the search parameters and the second number is the total number of files that were searched. + </para> + <variablelist><varlistentry><term> + Find + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Activate the find button to start a search with the selected parameters. + </para> + <variablelist><varlistentry><term> + Stop + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Activate the stop button to end a search that is in progress. + </para> + <para/></section><section id="DragandDrop"><title> + Drag and Drop + </title> + <para> + Drag and drop can be initiated with the primary or middle mouse buttons. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideIndex.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="utf-8"?> +<book id="GuideIndex"> + <title> + The Geeqie User Manual + </title> + <para> + This document is a work in progress. If you find any problems or omissions, feel free to fix it directly or report it on geeqie-devel [AT] lists.sourceforge.net. + </para> + <para> + If you are having trouble finding a solution in the manual, try looking in the <link linkend="GuideFaq">FAQ</link>. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideIntroduction.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindow.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOtherWindows.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageManagement.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImageSearch.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideCollections.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideSidebars.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideImagePresentation.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuidePrinting.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptions.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReference.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideFaq.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideCredits.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideGnuFdl.xml"/> + + <para/></book>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideIntroduction.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideIntroduction"> + <para> + Legal Notice + </para> + <para> + Copyright (c) 2008 - 2009 The Geeqie Team.<?db2html element="br"?> + Copyright (c) 2004 John Ellis. + </para> + <para> + Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "<ulink url="/wiki/gnu_fdl">GNU Free Documentation License?</ulink>". + </para> + <title> + Introduction + </title> + <para> + Geeqie is an image viewer that makes navigation of images easy. Images can be viewed full screen, and a slide show function allows automatic changing of the displayed image. + </para> + <para> + Geeqie is an image manager, with complete copy, move, rename, and delete functions available at the press of a button. Find the right image with the search feature. Image collectors can free up space with a function that finds duplicate images. + </para> + <para> + The one thing Geeqie is not, and never will be, is an image editor. However, Geeqie paired with an image editor, such as the Gimp, can be a very powerful combination. + </para> + <para/><section id="BasicFeatures"><title> + Basic Features + </title> + <itemizedlist spacing="compact"><listitem><para>Thumbnail preview + </para></listitem><listitem><para>Full screen + </para></listitem><listitem><para>Slide show + </para></listitem><listitem><para>Image Management + </para></listitem><listitem><para>Image Collections + </para></listitem></itemizedlist> + <para/></section><section id="AdvancedFeatures"><title> + Advanced Features + </title> + <itemizedlist spacing="compact"><listitem><para>Image Search + </para></listitem><listitem><para>Find image duplicates based on image content + </para></listitem><listitem><para>View and edit EXIF, IPTC and XMP data stored in images + </para></listitem><listitem><para>Simple Sort Manager to quickly sort a folder of images into other folders + </para></listitem><listitem><para>Rename images in bulk + </para></listitem><listitem><para>Add XMP keywords to images, and recall those images with the search function + </para></listitem><listitem><para>Very Configurable + </para></listitem></itemizedlist> + <para> + “An application that displays images.†- This was, and still is, the primary goal of Geeqie. Over time image management features have been added, but the core purpose of Geeqie remains the same. + </para> + <para/></section></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindow.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,17 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideMainWindow"> + <title> + Main Window + </title> + <para> + The Geeqie main window is designed for quick and easy navigation of images. The window consists of three regions: the file pane, the folder pane, and the image pane. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindowNavigation.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindowMenus.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindowLayout.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindowFilePane.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindowFolderPane.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindowImagePane.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideMainWindowStatusBar.xml"/> + + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindowFilePane.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,112 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideMainWindowFilePane"> + <title> + File Pane + </title> + <para> + The file pane displays the images contained in the active folder. It has two modes of display, allows multiple selection, and can initiate drag and drop operations. + </para> + <para> + A <emphasis role="strong">context menu</emphasis> can be displayed by clicking the right mouse button on the file pane or pressing the menu key while the file pane has the focus. + </para> + <para/><section id="Listview"><title> + List view + </title> + <para> + This mode can be enabled by selecting “List†from the View menu, pressing Ctrl + L on the keyboard, or unselecting “View as icons†from the context menu. + </para> + <para> + The list view mode displays images in a standard vertical list. Three columns provide the file name, size in bytes, and the time the contents were last modified. + </para> + <para> + <emphasis role="strong">Thumbnails</emphasis> can be displayed next to each file in the list, to toggle thumbnails on or off by selecting “Thumbnails†from the View menu, pressing the T key, clicking the thumbnail button on the tool bar, or selecting “Show thumbnails†from the context menu. + </para> + <para> + <link linkend="GuideOptionsFiltering">Grouped sidecar files</link> are represented by the main file with an expander. Clicking on the expander shows sidecar files. + </para> + <para/></section><section id="Iconview"><title> + Icon view + </title> + <para> + This mode can be enabled by selecting “Icons†from the View menu, pressing Ctrl + I on the keyboard, or selecting “View as icons†from the context menu. + </para> + <para> + The icon view mode displays images as thumbnails in a grid, and by default a file name below each thumbnail. + </para> + <para> + The <emphasis role="strong">file name</emphasis> displayed below each thumbnail can be turned on or off by selecting “Show filename text†from the context menu. + </para> + <para> + <link linkend="GuideOptionsFiltering">Grouped sidecar files</link> are represented by the main file. For accessing sidecars switch to List mode. + </para> + <para/></section><section id="Multipleselection"><title> + Multiple selection + </title> + <para> + It is possible to select more than one image from the file pane. Multiple files can be selected with several methods: + </para> + <para/><section id="Mouse"><title> + Mouse + </title> + <itemizedlist spacing="compact"><listitem><para>Ctrl + Primary mouse button will add or remove the file from the selection. + </para></listitem><listitem><para>Middle mouse button will toggle selection of the file. + </para></listitem><listitem><para>Shift + Primary mouse button will select all images between the clicked and focused image, or it will unselect all those images if the clicked image is already selected. + </para></listitem><listitem><para>Shift + Ctrl + Primary mouse button works as Shift + Primary mouse button, but will not change the selection of files outside the region between the focus and clicked image. + </para></listitem></itemizedlist> + <para/></section><section id="Keyboard"><title> + Keyboard + </title> + <itemizedlist spacing="compact"><listitem><para>Ctrl + Arrows will move the focus without changing the selection. + </para></listitem><listitem><para>Ctrl + Space will toggle selection of the focused image. + </para></listitem><listitem><para>Shift + Arrows will select a region of images. + </para></listitem><listitem><para>Shift + Ctrl + Arrows works as Shift + Arrows, but will not change the selection of files outside the current focus region. + </para></listitem></itemizedlist> + <para> + To select all files press Ctrl + A, or to unselect all image press Ctrl + Shift + A. These operations are also available from the Edit menu as “Select all†and “Select noneâ€. + </para> + <para> + The current number of selected images and their total size will be indicated in the File list section of the <link linkend="GuideMainWindowStatusBar">status bar</link>. + </para> + <para/></section></section><section id="Sorting"><title> + Sorting + </title> + <para> + The order of the images can be changed by clicking the sort area of the status bar or from the context menu. The sort methods are by file name, number, file date, or file size. The number method will sort file names by their natural order, for example files with names of file_10, file_12, and file_9 will appear in order file_9, file_10, and file_12. + </para> + <para> + Selecting the ascending menu item will toggle between increasing and decreasing sort order. + </para> + <para/></section><section id="Contextmenu"><title> + Context menu + </title> + <para> + Right clicking the mouse or pressing the menu key while the file pane has focus will display a menu. The menu functions will perform the same as those that match the window's <link linkend="GuideMainWindowMenus">menu bar</link>, however a few functions are unique to the context menu: + </para> + <variablelist><varlistentry><term> + View in new window + </term><listitem><para> + Opens a new window containing a list of the currently selected images. + </para></listitem></varlistentry><varlistentry><term> + Sort + </term><listitem><para> + Changes the sort order of file pane. + </para></listitem></varlistentry><varlistentry><term> + View as icons + </term><listitem><para> + Toggles between the list and icon view modes. + </para></listitem></varlistentry><varlistentry><term> + Show thumbnails + </term><listitem><para> + Toggles display of thumbnails in the list view display mode. + </para></listitem></varlistentry><varlistentry><term> + Show filename text + </term><listitem><para> + Toggles display of file names in the icon view display mode. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="DragandDrop"><title> + Drag and Drop + </title> + <para> + Drag and drop can be initialized with the primary or middle mouse buttons in the file pane. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindowFolderPane.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideMainWindowFolderPane"> + <title> + Folder pane + </title> + <para> + The folder pane contains the menu bar, tool bar, path entry, and folder list. + </para> + <para/><section id="Menubar"><title> + Menu bar + </title> + <para> + The main menu of the window. The functions available from the main menu are described in the <link linkend="GuideMainWindowMenus">Menus</link> chapter. + </para> + <para/></section><section id="Toolbar"><title> + Tool bar + </title> + <para> + The tool bar includes buttons for often used operations. The tool bar can be hidden or shown by selecting “Hide toolbar†from the view menu. + </para> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Show thumbnails + </term><listitem><para> + This button is active when the file list is in list view mode, and activating it will toggle the display of thumbnails. + </para></listitem></varlistentry><varlistentry><term> + Change to home folder + </term><listitem><para> + Change the main window to display the contents of the user's home folder. + </para></listitem></varlistentry><varlistentry><term> + Refresh file list + </term><listitem><para> + This will check for changes to the active folder and update the window. + </para></listitem></varlistentry><varlistentry><term> + Zoom in + </term><listitem><para> + Increase the image display size. + </para></listitem></varlistentry><varlistentry><term> + Zoom out + </term><listitem><para> + Decrease the image display size. + </para></listitem></varlistentry><varlistentry><term> + Fit image to window + </term><listitem><para> + This will size the image to fit within the image view. + </para></listitem></varlistentry><varlistentry><term> + Set zoom 1:1 + </term><listitem><para> + Restore zoom to the image's original size. + </para></listitem></varlistentry><varlistentry><term> + Configure options + </term><listitem><para> + Displays the <link linkend="GuideOptions">Options window</link>. + </para></listitem></varlistentry><varlistentry><term> + Float controls + </term><listitem><para> + Toggle the folder pane, file pane, and status bar between the main window and a secondary window. + </para></listitem></varlistentry></variablelist> + <para> + The buttons corresponds to selected menu action. It is possible to add other actions by editing the <link linkend="GuideReferenceConfig">Configuration file</link> + </para> + <para/></section><section id="Pathentry"><title> + Path entry + </title> + <para> + This displays the active folder of the window and allows typing a location. + </para> + <para> + 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. + </para> + <para> + Note: Tab completion uses the Tab key, press the Down key to move the focus from the entry. + </para> + <para> + 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. + </para> + <para/></section><section id="Folderlist"><title> + Folder list + </title> + <para> + This displays a list of sub folders contained in the active folder, or a tree that includes all folders in the file system. + </para> + <para> + A <emphasis role="strong">context menu</emphasis> can be displayed by clicking the right mouse button on the folder pane or pressing the menu key while the folder pane has the focus + </para> + <para/></section><section id="Listview"><title> + List view + </title> + <para> + This mode can be enabled by from the View menu, from the context menu, or pressing Ctrl + T. + </para> + <para> + The list view mode displays sub folders contained in the active folder in a standard vertical list. The parent folder can be selected with the folder named “..â€. + </para> + <para/></section><section id="Treeview"><title> + Tree view + </title> + <para> + This mode can be enabled by selecting “Tree†from the View menu, pressing Ctrl + T, or selecting “View as tree†from the context menu. + </para> + <para> + The tree view mode displays all folders in the file system, starting with the root folder and branching out to include sub folders. A folder branch can be expanded or collapsed by clicking the expander next to each folder icon, or by pressing the respective + or - keys when the folder branch has the focus. + </para> + <para/></section><section id="Sorting"><title> + Sorting + </title> + <para> + The order of the folder names will match the order selected for the file pane. Sort order can be changed by clicking the sort area of the status bar or from the context menu of the file pane. + </para> + <para/></section><section id="Contextmenu"><title> + Context menu + </title> + <para> + Right clicking the mouse or pressing the menu key while the folder pane has focus will display a menu. The menu functions will perform the same as those that match the window's <link linkend="GuideMainWindowMenus">menu bar</link>, however a few functions are unique to the context menu: + </para> + <variablelist><varlistentry><term> + Up to parent + </term><listitem><para> + This will change the window to display the contents of the parent folder. + </para></listitem></varlistentry><varlistentry><term> + Slide show + </term><listitem><para> + Start a <link linkend="GuideImagePresentationSlideshow">slide show</link> that contains all images in the selected folder. + </para></listitem></varlistentry><varlistentry><term> + Slide show recursive + </term><listitem><para> + Start a <link linkend="GuideImagePresentationSlideshow">slide show</link> that contains all images in the selected folder, and all images in the sub folders of that folder. + </para></listitem></varlistentry><varlistentry><term> + Find duplicates + </term><listitem><para> + This will open a new <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link> window containing all images in the selected folder. + </para></listitem></varlistentry><varlistentry><term> + Find duplicates recursive + </term><listitem><para> + This will open a new <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link> window containing all image in the selected folder, and all images in the sub folders of that folder. + </para></listitem></varlistentry><varlistentry><term> + New folder + </term><listitem><para> + Creates a new folder that is a sub folder of the selected folder. + </para></listitem></varlistentry><varlistentry><term> + Rename + </term><listitem><para> + Renames the selected folder. + </para></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <variablelist><varlistentry><term> + View as tree + </term><listitem><para> + Toggles between the list and tree modes of the folder pane. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Draganddrop"><title> + Drag and drop + </title> + <para> + Image files can be dropped onto folders displayed in the folder pane. A menu will appear allowing you to select to move or copy the dropped images into the target folder. The list will automatically scroll up or down when the drag pointer is near the respective top or bottom of the list. When in tree mode, hovering over a folder for a brief period of time will expand that folder. + </para> + <para> + The folders can used as a drag source for drag and drop, for example to add images in a folder to a collection window. However drag and drop can not be used to move or copy folders in Geeqie. + </para> + <para> + Using Shift key while dragging is a shortcut to move action. Menu will not appear but move will occur. + </para> + <para> + Using Ctrl key while dragging is a shortcut to copy action. Menu will not appear but copy will occur. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindowImagePane.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,183 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideMainWindowImagePane"> + <title> + Image Pane + </title> + <para> + The image pane is the region of the main window that displays the selected image. The image pane allows adjustment of display size and orientation; it also provides several methods to manipulate the image with the mouse and keyboard. + </para> + <para/><section id="Imagedisplay"><title> + Image display + </title> + <para> + The image is drawn to the screen as it is decoded from disk. The image can be panned and zoomed while it is still loading. Image adjustment operations for rotation, mirror, and flip will delay until the image is completed. The adjustment queue will remember one operation and will retain the most recently requested function, which will be performed once the image has finished loading. + </para> + <para> + The quality of the image, especially when using the zoom feature, is dependent on the settings that are available on the <link linkend="GuideOptionsImage">Image tab</link> of the preferences dialog. + </para> + <para> + To increase the speed of loading the next image when navigating the image list in sequence, enable the <link linkend="GuideOptionsImage">Preload next image</link> option. + </para> + <para/></section><section id="Imagepanningandmanipulation"><title> + Image panning and manipulation + </title> + <para> + When the image size is larger than the image pane, the visible region can be changed with the keyboard or mouse. The keyboard can also be used to adjust the orientation of the image. + </para> + <para/><section id="Keyboard"><title> + Keyboard + </title> + <para> + Use the Arrows to pan the image in the desired direction, to increase the panning speed hold down the Shift + Arrows.<?db2html element="br"?> + Press Ctrl + Arrows to move to the respective edge of the image. The image can only be panned with the keyboard when the image has the focus, indicated by a dotted line surrounding the image pane. + </para> + <informaltable><tgroup cols="3"><tbody><row><entry> + Shortcut + </entry><entry> + Context menu name + </entry><entry> + Description + </entry></row> +<row><entry> + + = + </entry><entry> + Zoom in + </entry><entry> + Zoom in. + </entry></row> +<row><entry> + - + </entry><entry> + Zoom out + </entry><entry> + Zoom out. + </entry></row> +<row><entry> + X [Keypad]* + </entry><entry> + Fit image to window + </entry><entry> + Scale the image to fit the available display area. + </entry></row> +<row><entry> + Z [Keypad]/ + </entry><entry> + Zoom 1:1 + </entry><entry> + Reset the zoom to original image size. + </entry></row> +<row><entry> + ] + </entry><entry> + Rotate clockwise + </entry><entry> + Rotate the image clockwise 90 degrees. + </entry></row> +<row><entry> + [ + </entry><entry> + Rotate counterclockwise + </entry><entry> + Rotate the image counterclockwise 90 degrees. + </entry></row> +<row><entry> + Shift + R + </entry><entry> + Rotate 180 + </entry><entry> + Rotate the image 180 degrees. + </entry></row> +<row><entry> + Shift + M + </entry><entry> + Mirror + </entry><entry> + Flip the image horizontally. + </entry></row> +<row><entry> + Shift + F + </entry><entry> + Flip + </entry><entry> + Flip the image vertically. + </entry></row> +</tbody></tgroup></informaltable> + <para> + Note: The rotation, mirror, and flip functions will not change the image data directly. Depending on the <link linkend="GuideOptionsMetadata">Metadata Options</link>, they just alter the Orientation property in memory, in private metadata file or in the image. The image can be rotated according to the saved metadata with "Apply the orientation to image content" command. + </para> + <para/></section><section id="Mouse"><title> + Mouse + </title> + <para> + 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 [<ulink url="/wiki#bottomnote1">(*)</ulink>]. + </para> + <para> + To scale the image size hold down the Ctrl key and scroll the mouse wheel up to zoom in, or down to zoom out. + </para> + <para/><section id="SmoothScroll"><title> + Smooth Scroll + </title> + <para> + To start the smooth scroll function hold down the Shift key and click the primary mouse button. An icon will appear at the location of the mouse pointer, the mouse can then be positioned to pan the image. The image will pan in the direction of the mouse pointer relative to the icon. The pan speed will increase in proportion to the distance that the pointer is from the center of the icon. To end the smooth scroll function click the primary mouse button within the image pane. + </para> + <para/></section></section></section><section id="Navigation"><title> + Navigation + </title> + <para> + The displayed image can be changed to the next or previous image using the keyboard or mouse. + </para> + <para/><section id="Keyboard1"><title> + Keyboard + </title> + <para> + The <ulink url="/wiki/PageDown">PageDown?</ulink> and <ulink url="/wiki/PageUp">PageUp?</ulink> keys will change the image to the next or previous image, respectively, in the list. The Home and End keys will jump to the first and last image, respectively. When the image has the focus, the <ulink url="/wiki/SpaceBar">SpaceBar?</ulink> and <ulink url="/wiki/BackSpace">BackSpace?</ulink> keys can also be used to change the image. + </para> + <para/></section><section id="Mouse1"><title> + Mouse + </title> + <para> + To change to the next image in the list click the left mouse button, click the middle mouse button to change to the previous image. The mouse wheel can also be used to change the current image [<ulink url="/wiki#bottomnote1">(*)</ulink>]. + </para> + <para/></section></section><section id="Contextmenu"><title> + Context menu + </title> + <para> + Right clicking the mouse or pressing the menu key while the image has the focus will display a menu. The menu functions will perform the same as those that match the window's <link linkend="GuideMainWindowMenus">menu bar</link>, however a few functions are unique to the context menu: + </para> + <variablelist><varlistentry><term> + View in new window + </term><listitem><para> + Opens a new window containing a second copy of the current image. + </para></listitem></varlistentry><varlistentry><term> + Pause slide show, Continue slide show + </term><listitem><para> + Controls the pause state of an active slide show, the text of the menu will change to reflect the action that will be performed. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="DragandDrop"><title> + Drag and Drop + </title> + <para> + Files and folders can be dropped onto the image pane, dropping a file will display the file and dropping a folder will change the main window to display the contents of the folder. When dropping multiple items on the image pane, only the first item in the list will be used, all additional items will be ignored. + </para> + <para> + A drag and drop operation can be initiated from the image pane with the middle mouse button, the dragged item will contain the file path of the displayed image. + </para> + <para/></section><section id="Displayingimagessidebyside"><title> + Displaying images side by side + </title> + <para> + Using View > Split item from the main menu, image pane can be splitted in up to four panes, this allows to display images side by side. You may use drag'n drop to change images in each pane. + </para> + <para> + Connected zoom is possible through the View > Connected zoom menu. Zoom is then applied to all displayed images. + </para> + <para> + Connected scrolling is also possible using Shift and primary mouse button. + </para> + <para> + As a general rule, hotkeys and mouse without shift affects just one image and with shift all images. + </para> + <para> + (*) Note: The mouse wheel behavior for scrolling and image step can be swapped with the Mouse wheel scrolls image option located on the <link linkend="GuideOptionsAdvanced">Advanced tab?</link> of the preferences dialog. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindowLayout.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideMainWindowLayout"> + <title> + Layout + </title> + <para> + The main window consists of four areas, the <link linkend="GuideMainWindowFolderPane">folder pane</link>, <link linkend="GuideMainWindowFilePane">file pane</link>, <link linkend="GuideMainWindowImagePane">image pane</link>, and the <link linkend="GuideMainWindowStatusBar">status bar</link>. The status bar is always at the bottom of the window. The three remaining areas, or panes, can be arranged and sized by the user. + </para> + <para/><section id="Selectingthelocationofeachpane"><title> + Selecting the location of each pane + </title> + <para> + The arrangement of the folder, file, and image pane is selected on the <link linkend="GuideOptionsWindow">Windows tab</link> of the Options window. There are four choices for the layout, the difference is that each has the larger pane in a different location: right, bottom, left, and top. + </para> + <para> + 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. + </para> + <para> + Note: In the options window the file and image panes are labeled similarly, however the folder pane is labeled as tools. + </para> + <para/></section><section id="Changingthesizeofapane"><title> + Changing the size of a pane + </title> + <para> + Between the panes of the main window are two dividers that can be moved with the mouse to adjust the size of each pane. Press and hold the primary button, then move the divider to the desired location and release the button. + </para> + <para/><section id="Folderpane"><title> + Folder pane + </title> + <para> + The <link linkend="GuideMainWindowFolderPane">folder pane</link> contains the menu bar, tool bar, path entry, and folder list. The list can be set to display the sub folders of the active folder or a tree that starts with the root folder and contains all folders in the file system. + </para> + <para/></section><section id="Filepane"><title> + File pane + </title> + <para> + The <link linkend="GuideMainWindowFilePane">file pane</link> lists the images contained in the active folder. The file pane can be set to display as a vertical list or an icon view. + </para> + <para/></section><section id="Imagepane"><title> + Image pane + </title> + <para> + The <link linkend="GuideMainWindowImagePane">image pane</link> is where the active image is displayed. + </para> + <para/></section></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindowMenus.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,442 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideMainWindowMenus"> + <title> + Menus + </title> + <para> + This section describes the functions of each item on the menu bar in the Geeqie main window. + </para> + <para/><section id="FileMenu"><title> + File Menu + </title> + <variablelist><varlistentry><term> + New window + </term><listitem><para> + Opens a new main window, with the initial path set to the current folder. + </para></listitem></varlistentry><varlistentry><term> + New collection + </term><listitem><para> + Opens a new collection window, the new collection will be empty. + </para></listitem></varlistentry><varlistentry><term> + Open collection + </term><listitem><para> + Displays a dialog to open a collection stored on disk, the selected collection will then appear in a new window. + </para></listitem></varlistentry><varlistentry><term> + Open recent + </term><listitem><para> + This menu item lists the recently active collections, selecting an item from the list will open that collection in a new window. The most recent item will appear at the top of the list. Maximum number of entries can be modified through <link linkend="GuideOptionsAdvanced">Open recent list maximum size?</link> option. + </para></listitem></varlistentry><varlistentry><term> + Search… + </term><listitem><para> + Opens a new Search window. + </para></listitem></varlistentry><varlistentry><term> + Find duplicates… + </term><listitem><para> + Opens a new Find Duplicates window. + </para></listitem></varlistentry><varlistentry><term> + Print.. + </term><listitem><para> + Opens a print dialog. + </para></listitem></varlistentry><varlistentry><term> + New folder… + </term><listitem><para> + Creates a new folder in the current path. + </para></listitem></varlistentry><varlistentry><term> + Copy… + </term><listitem><para> + Opens a dialog to select a destination to copy the currently selected files. + </para></listitem></varlistentry><varlistentry><term> + Move… + </term><listitem><para> + Opens a dialog to select a destination to move currently selected files. + </para></listitem></varlistentry><varlistentry><term> + Rename… + </term><listitem><para> + Renames the current file selection. + </para></listitem></varlistentry><varlistentry><term> + Delete… + </term><listitem><para> + Deletes the current file selection. + </para></listitem></varlistentry><varlistentry><term> + Symlink + </term><listitem><para> + Creates a symbolic link. This is implemented via <link linkend="GuideEditors">external editor?</link>. + </para></listitem></varlistentry><varlistentry><term> + Close window + </term><listitem><para> + Closes the window containing the menu, if the window is the last main window Geeqie will quit. + </para></listitem></varlistentry><varlistentry><term> + Quit + </term><listitem><para> + Quits the Geeqie application, if collections or image metadata have been changed but not saved, the user will be prompted for confirmation. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Gomenu"><title> + Go menu + </title> + <variablelist><varlistentry><term> + First Image + </term><listitem><para> + Goes tothe first image. + </para></listitem></varlistentry><varlistentry><term> + Previous Image + </term><listitem><para> + Goes to the previous image. + </para></listitem></varlistentry><varlistentry><term> + Next Image + </term><listitem><para> + Goes to the next image. + </para></listitem></varlistentry><varlistentry><term> + Last Image + </term><listitem><para> + Goes to the last image. Back Goes to the previous folder. Home Goes to home folder. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Selectmenu"><title> + Select menu + </title> + <variablelist><varlistentry><term> + Select all + </term><listitem><para> + Selects all files in the current list + </para></listitem></varlistentry><varlistentry><term> + Select none + </term><listitem><para> + Deselects all files + </para></listitem></varlistentry><varlistentry><term> + Invert Selection + </term><listitem><para> + Inverts current selection + </para></listitem></varlistentry><varlistentry><term> + Copy path + </term><listitem><para> + Copy selected item path to clipboard. + </para></listitem></varlistentry><varlistentry><term> + Show marks + </term><listitem><para> + Displays marks in the file list + </para></listitem></varlistentry><varlistentry><term> + Mark n + </term><listitem><para> + Opens submenu for manipulating mark n + </para></listitem></varlistentry><varlistentry><term> + Mark n / Toggle mark n + </term><listitem><para> + Set or unset mark n on selected files + </para></listitem></varlistentry><varlistentry><term> + Mark n / Set mark n + </term><listitem><para> + Set mark n on selected files + </para></listitem></varlistentry><varlistentry><term> + Mark n / Reset mark n + </term><listitem><para> + Unset mark n on selected files + </para></listitem></varlistentry><varlistentry><term> + Mark n / Select mark n + </term><listitem><para> + Selects all files having mark n set + </para></listitem></varlistentry><varlistentry><term> + Mark n / Add mark n + </term><listitem><para> + Adds files having mark n set to selection + </para></listitem></varlistentry><varlistentry><term> + Mark n / Intersection with mark n + </term><listitem><para> + Intersects current selection and mark n + </para></listitem></varlistentry><varlistentry><term> + Mark n / Unselect mark n + </term><listitem><para> + Removes files having mark n set from current selection + </para></listitem></varlistentry><varlistentry><term> + Mark n / Filter mark n + </term><listitem><para> + Shows only the images that have mark n set. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Editmenu"><title> + Edit menu + </title> + <variablelist><varlistentry><term> + External Editors + </term><listitem><para> + This submenu contains external editors that were found on the system. See <link linkend="GuideEditors">Editors section?</link> for details. + </para></listitem></varlistentry><varlistentry><term> + Orientation + </term><listitem><para> + Adjust image orientation + </para></listitem></varlistentry><varlistentry><term> + Orientation / Rotate clockwise + </term><listitem><para> + Rotates the current image clockwise 90 degrees, does not modify the file on disk. + </para></listitem></varlistentry><varlistentry><term> + Orientation / Rotate counterclockwise + </term><listitem><para> + Rotates the current image counterclockwise 90 degrees, does not modify the file on disk. + </para></listitem></varlistentry><varlistentry><term> + Orientation / Rotate 180 + </term><listitem><para> + Rotates the current image 180 degrees, does not modify the file on disk. + </para></listitem></varlistentry><varlistentry><term> + Orientation / Mirror + </term><listitem><para> + Swaps the left and right sides of the image so that the result is similar to that of looking at the image in a mirror, does not modify the file on disk. + </para></listitem></varlistentry><varlistentry><term> + Orientation / Flip + </term><listitem><para> + Swaps the top and bottom sides of the image, does not modify the file on disk. + </para></listitem></varlistentry><varlistentry><term> + Orientation / Original state + </term><listitem><para> + Removes all effects applied through the Adjust menu, reverting image to its original state. Orientation / Apply the orientation to image content The commands above modifies image metadata only. This commands actually transforms image pixels. See <link linkend="GuideEditors">Editors section?</link> for details. + </para></listitem></varlistentry><varlistentry><term> + Save metadata + </term><listitem><para> + Saves queued metadata changes. Autosave can be configured too. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Preferences + </term><listitem><para> + This submenu contains configuration and maintenance commands + </para></listitem></varlistentry><varlistentry><term> + Preferences / Preferences… + </term><listitem><para> + Opens the <link linkend="GuideOptions">Preferences Dialog</link> for changing of global preferences. + </para></listitem></varlistentry><varlistentry><term> + Preferences / Configure Editors… + </term><listitem><para> + Opens the <link linkend="GuideEditors">Editors Dialog?</link> for changing of global preferences. + </para></listitem></varlistentry><varlistentry><term> + Preferences / Configure This window… + </term><listitem><para> + Opens the <link linkend="GuideWindowOptions">Window Preferences Dialog?</link> for changing of options that can differ for each window. + </para></listitem></varlistentry><varlistentry><term> + Preferences / Thumbnail maintenance + </term><listitem><para> + Opens a dialog with utilities to manage cached thumbnails and keywords data. + </para></listitem></varlistentry><varlistentry><term> + Set as wallpaper + </term><listitem><para> + Renders the current image to the root window (desktop). The resulting image will be tiled to fit the root window if zoom is not set to <emphasis role="i">fit to window</emphasis>; when zoom is set to <emphasis role="i">fit to window</emphasis>, the image will be scaled to fill the root window. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Viewmenu"><title> + View menu + </title> + <variablelist><varlistentry><term> + View in new window + </term><listitem><para> + Opens selected image in its own window + </para></listitem></varlistentry><varlistentry><term> + Pan view + </term><listitem><para> + Opens current folder in Pan view window + </para></listitem></varlistentry><varlistentry><term> + Files and Folders + </term><listitem><para/></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Zoom + </term><listitem><para/></listitem></varlistentry><varlistentry><term> + Zoom in + </term><listitem><para> + Increases the zoom by one increment, resulting in a larger image. + </para></listitem></varlistentry><varlistentry><term> + Zoom out + </term><listitem><para> + Decreases the zoom by one increment, resulting in a smaller image. + </para></listitem></varlistentry><varlistentry><term> + Zoom to fit + </term><listitem><para> + Automatically adjusts the zoom so that the image will fit within the display pane. The effect on images with an original size smaller than the display pane can be changed with the Allow enlargement of image for zoom to fit option located on the <link linkend="GuideOptionsImage">Image tab</link> of the preferences dialog. + </para></listitem></varlistentry><varlistentry><term> + Fit Horizontally + </term><listitem><para> + Adjusts the zoom so image height fit within the display pane. + </para></listitem></varlistentry><varlistentry><term> + Fit Vertically + </term><listitem><para> + Adjusts the zoom so image width fit within the display pane. + </para></listitem></varlistentry><varlistentry><term> + Zoom n:m + </term><listitem><para> + Set zoom to the n:m value. 1:1 is the original size of the image. When n is greater than m, zoom in occurs else zoom out occurs. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Connected zoom + </term><listitem><para> + Actions in this menu are identical to those in Zoom menu, but apply to all images displayed in splitted view. + </para></listitem></varlistentry><varlistentry><term> + Split + </term><listitem><para/></listitem></varlistentry><varlistentry><term> + Horizontal + </term><listitem><para> + Splits main image view in two horizontal panes. + </para></listitem></varlistentry><varlistentry><term> + Vertical + </term><listitem><para> + Splits main image view in two vertical panes. + </para></listitem></varlistentry><varlistentry><term> + Quad + </term><listitem><para> + Splits main image view in four panes. + </para></listitem></varlistentry><varlistentry><term> + Single + </term><listitem><para> + Reverts to normal view mode (one image). + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Thumbnails + </term><listitem><para> + Toggles the display of image thumbnails in the file list, this item is not available when the file list is in icon view mode. A check appears next to this item when thumbnails are enabled. + </para></listitem></varlistentry><varlistentry><term> + List + </term><listitem><para> + Changes the file list to display files in list format. + </para></listitem></varlistentry><varlistentry><term> + Icons + </term><listitem><para> + Changes the file list to display files as icons. + </para></listitem></varlistentry><varlistentry><term> + View Directory as + </term><listitem><para/></listitem></varlistentry><varlistentry><term> + List + </term><listitem><para> + Set the folder view mode to list. + </para></listitem></varlistentry><varlistentry><term> + Tree + </term><listitem><para> + Set the folder view mode to tree. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Image Overlay + </term><listitem><para> + Displays Image Overlay information box (OSD), use twice to add histogram to it. + </para></listitem></varlistentry><varlistentry><term> + Histogram channels + </term><listitem><para> + Switches channels displayed in the histogram (red, green, blue, RGB, value, maximum value). + </para></listitem></varlistentry><varlistentry><term> + Histogram log mode + </term><listitem><para> + Toggles between linear and logarithmical histogram. + </para></listitem></varlistentry><varlistentry><term> + Full screen + </term><listitem><para> + Toggles the full screen window display. + </para></listitem></varlistentry><varlistentry><term> + Float file list + </term><listitem><para> + Toggles the location of the menu bar, tool bar, status bar, and file lists between the main window and a second window. A check appears next to this item when the location is the second window. + </para></listitem></varlistentry><varlistentry><term> + Hide file list + </term><listitem><para> + Toggles visibility of the menu bar, tool bar, status bar, and file lists. + </para></listitem></varlistentry><varlistentry><term> + Hide toolbar + </term><listitem><para> + Toggles visibility of the tool bar. A check appears next to this item when the tool bar is not visible. + </para></listitem></varlistentry><varlistentry><term> + Keywords + </term><listitem><para> + Toggles display of the Keywords sidebar. + </para></listitem></varlistentry><varlistentry><term> + Exif data + </term><listitem><para> + Toggles display of the EXIF sidebar. + </para></listitem></varlistentry><varlistentry><term> + Sort manager + </term><listitem><para> + Toggles display of the Sort Manager sidebar. + </para></listitem></varlistentry><varlistentry><term> + Toggle slideshow + </term><listitem><para> + Begins or ends a slide show, the slide show status is displayed in the status bar. + </para></listitem></varlistentry><varlistentry><term> + Pause slideshow + </term><listitem><para> + Pauses a slide show, the slide show status is displayed in the status bar. + </para></listitem></varlistentry><varlistentry><term> + Refresh + </term><listitem><para> + Updates the contents of the folder and file lists to match what is currently on disk, the current image will also be reread from disk. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Helpmenu"><title> + Help menu + </title> + <variablelist><varlistentry><term> + Contents + </term><listitem><para> + Opens the Geeqie user manual in a new browser window. + </para></listitem></varlistentry><varlistentry><term> + Keyboard shortcuts + </term><listitem><para> + Displays a window listing the default keyboard shortcuts. + </para></listitem></varlistentry><varlistentry><term> + Release notes + </term><listitem><para> + Displays a window containing the release notes for the version of Geeqie in use. + </para></listitem></varlistentry><varlistentry><term> + About + </term><listitem><para> + Opens a window containing the Geeqie version, credits, website, and email contact information. + </para></listitem></varlistentry><varlistentry><term> + Log window + </term><listitem><para> + Opens the log window, mostly used for debugging purposes. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Tearoffmenus"><title> + Tear off menus + </title> + <para> + Menus can be permanently displayed by selecting the dotted line item at the top of each menu category. A tear off menu will behave the same as an ordinary window. To close a tear off menu, select the dotted line item at the top of the menu. + </para> + <para/></section><section id="Keyboardshortcuts"><title> + Keyboard shortcuts + </title> + <para> + The keyboard sequence associated to each menu entry is listed within the main window menu bar. For reference, the complete list of default keyboard shortcuts can be found in section <link linkend="GuideReferenceKeyboardShortcuts">Keyboard Shortcuts</link>. + </para> + <para/></section><section id="Changingthemainwindowmenubarkeyboardshortcuts"><title> + Changing the main window menu bar keyboard shortcuts + </title> + <para> + The keyboard shortcuts associated with the menu bar items can be changed by editing the accels file located in the Geeqie configuration folder <emphasis role="strong">while the Geeqie application is not running</emphasis>: + </para> + <para> + <literal>($HOME)/.geeqie/accels</literal> + </para> + <para> + To change a menu item, first find the line corresponding to the menu item to change. For example the File menu Quit line originally looks like this: + </para> + <para> + <literal>; (gtk_accel_path "&lt;main&gt;/File/Quit" "&lt;Control&gt;q")</literal> + </para> + <para> + To change this menu's keyboard shortcut, first remove the leading semicolon (;), removing the semicolon will tell Geeqie that this menu item has been customized. Then change the keyboard shortcut defined by the text in quotes at the end of the line, be sure to only change the text within the quotes; in this case the text “&lt;control&gt;qâ€. For example changing the shortcut associated with Quit to the Q key will result in this line: + </para> + <para> + <literal>(gtk_accel_path "&lt;main&gt;/File/Quit" "q")</literal> + </para> + <para> + Please note the removed semicolon and the change of “&lt;control&gt;q†to “qâ€, be careful not to change any of the other text on the line or Geeqie may ignore the customization. The keyboard modifiers and their respective text are listed below: + </para> + <informaltable><tgroup cols="2"><tbody><row><entry> + <tablestyle="width:60%"> Key + </entry><entry> + Text to use in accels file + </entry></row> +<row><entry> + <tablestyle="width:60%"> Shift + </entry><entry> + &lt;shift&gt; + </entry></row> +<row><entry> + Ctrl + </entry><entry> + &lt;control&gt; + </entry></row> +<row><entry> + Alt + </entry><entry> + &lt;alt&gt; + </entry></row> +</tbody></tgroup></informaltable> + <para> + Modifiers can be combined, for example in the exit line above, the text would be “&lt;control&gt;&lt;shift&gt;q†to set the exit shortcut to Ctrl + Shift + Q. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindowNavigation.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideMainWindowNavigation"> + <title> + Navigation + </title> + <para/><section id="Movingaroundinthefilesystem"><title> + Moving around in the file system + </title> + <para> + To select the folder containing the desired images for display, change to the image's folder using the folder view. Single clicking a folder with the primary mouse button will change the main window to display that folder's contents. When the folder view is displayed as a list, use the folder named “..†to change to the parent folder (the parent folder is the folder that contains the current folder). + </para> + <para> + To select a folder with the keyboard, move the focus to the desired folder and press the <ulink url="/wiki/SpaceBar">SpaceBar?</ulink> or Enter key. + </para> + <para/></section><section id="Movingaroundwithinafolder"><title> + Moving around within a folder + </title> + <para> + After selecting the desired folder as above, the desired image can be viewed by selecting it from the file list. To select a file for display single click it with the primary mouse button. + </para> + <para> + To select a file with the keyboard, move the focus to the desired file. As you move the focus within the file list the image display will update to match the highlighted file. + </para> + <para/></section><section id="Goinghome"><title> + Going home + </title> + <para> + To change to your home folder, click the Home button in the tool bar. Home folder can be set in window preferences. + </para> + <para/></section><section id="Directpathentry"><title> + Direct path entry + </title> + <para> + The current path is displayed in an entry field above the folder list. 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. + </para> + <para> + 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. + </para> + <para/></section><section id="Steppingthroughimagessequentially"><title> + Stepping through images sequentially + </title> + <para> + To change the displayed image to next or previous one within the same folder, use the respective <ulink url="/wiki/PageDown">PageDown?</ulink> and <ulink url="/wiki/PageUp">PageUp?</ulink> keys. The mouse can also be used to change the image by clicking the image display with the respective primary and middle buttons. + </para> + <para> + To change to beginning or end of the image list, use the respective Home or End keys. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideMainWindowStatusBar.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideMainWindowStatusBar"> + <title> + Status Bar + </title> + <para> + The status bar contains information and details about the contents of the main window. Information displayed includes the progress of generating thumbnails, the number of files in the file list with byte size, the current file selection count including byte size, details about the currently displayed image, and the zoom setting. The current sort preference is also displayed, and can be adjusted from the status bar. + </para> + <para> + The status bar is comprised of five sections, from left to right these are a progress bar, sort method, file list counts, image details, and zoom setting. Each section is described below. + </para> + <para/><section id="ProgressBar"><title> + Progress Bar + </title> + <para> + The Progress bar updates to display the current state of thumbnail generation. When this section contains no text, thumbnail generation is idle. When “Loading thumbs...†is displayed, thumbnails are currently being generated when Geeqie is idle; the progress bar will update to display the percentage of thumbnails that are completed. + </para> + <para/></section><section id="Sortmethod"><title> + Sort method + </title> + <para> + This is the method used to sort image names in the file list. Clicking or activating this field will display a menu to allow selection of the sort method. + </para> + <variablelist><varlistentry><term> + Name + </term><listitem><para> + Images are sorted by file name. + </para></listitem></varlistentry><varlistentry><term> + Number + </term><listitem><para> + Images are sorted by natural numerical order, such that, for example, 9_name.jpg will be listed before 10_name.jpg. + </para></listitem></varlistentry><varlistentry><term> + Date + </term><listitem><para> + Images are sorted by file date on disk. + </para></listitem></varlistentry><varlistentry><term> + Size + </term><listitem><para> + Image are sorted by file size on disk. + </para></listitem></varlistentry><varlistentry><term> + Ascending + </term><listitem><para> + Toggles between increasing and decreasing sort order. A check will appear next to this entry to indicate ascending sort order. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Filelist"><title> + File list + </title> + <para> + This section displays the count of files that appear in the file list, including the total byte size. The number of files selected is displayed in parenthesis, including the total byte size of the selected files. The slide show status is also displayed here; when a slide show is running, “Slideshow†will appear, the text will change to “Paused†when a slide show is in the paused state. + </para> + <para/></section><section id="ImageDetails"><title> + Image Details + </title> + <para> + This section displays the dimensions (width x height) and file byte size of the image that is active in the image pane. When the format of the file in the image pane can not be determined the dimensions will show as “(0 x 0)â€, in addition “(no read permision)†may appear if the file permissions do not allow reading the contents of the file. + </para> + <para/></section><section id="Zoom"><title> + Zoom + </title> + <para> + This section displays the current zoom ratio. A ratio of 1:1 is the image's original size. When the left number is larger the image is displayed larger than original size, when the right number is larger the image is displayed smaller. + </para> + <para> + A tilde (~) appears within the ratio display when the zoom is set to fit the image within the display area. In this zoom mode the ratio is automatically adjusted, and the displayed ratio may not be the actual ratio because the status bar display rounds the actual value to the nearest tenth (0.1). + </para> + <para/></section><section id="Buttons"><title> + Buttons + </title> + <para> + Statusbar buttons corresponds to selected menu action. It is possible to add other actions by editing the <link linkend="GuideReferenceConfig">Configuration file</link> + </para> + <para/><section id="ShowPixelInfo"><title> + Show Pixel Info + </title> + <para> + Shows coordinates and RGB value under cursor. + </para> + <para/></section><section id="EnableColorManagement"><title> + Enable Color Management + </title> + <para> + Enables color profiles. + </para> + <para/></section><section id="SaveMetadata"><title> + Save Metadata + </title> + <para> + Opens dialog for review of metadata changes. + </para> + <para/></section></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptions.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideOptions"> + <title> + Options Explained + </title> + <para> + This chapter attempts to explain in detail the Geeqie preferences dialog. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsGeneral.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsImage.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsWindow.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsKeyboard.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsFiltering.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsMetadata.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsColor.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsBehavior.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsHidden.xml"/> + + <para> + There is another set of options, that can be set independently for each window: + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOptionsLayout.xml"/> + + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsBehavior.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,155 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsBehavior"> + <title> + Advanced Behavior Options + </title> + <para> + This section describes the options presented under the Behavior Tab of the preferences dialog. + </para> + <para/><section id="Delete"><title> + Delete + </title> + <variablelist><varlistentry><term> + Confirm file delete + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Prompts for confirmation before deleting files. + </para> + <variablelist><varlistentry><term> + Enable Delete key + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Disable this to disassociate the delete file function from the Delete key. This option does not effect the Ctrl + D key sequence. May be useful in combination with “confirm file deleteâ€, above, disabled so that accidentally hitting a single key will not result in deleted files. + </para> + <variablelist><varlistentry><term> + Safe Delete + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <para> + Note: Files moved to the Safe Delete folder are prefixed with a six digit number in the format: <literal>nnnnnn_FILENAME</literal><?db2html element="br"?> + This is used by the delete feature to distinguish which files to remove first when clearing space for new files.<?db2html element="br"?> + The digit counter increments with each deleted file. + </para> + <variablelist><varlistentry><term> + Folder + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The location of the folder used by the Safe Delete feature. + </para> + <variablelist><varlistentry><term> + Maximum size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The size to use for the Safe Delete folder, in megabytes. Note that setting this value to 0 (zero) will disable any limit. + </para> + <variablelist><varlistentry><term> + Clear button + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Removes all files contained in the Safe Delete folder. + </para> + <variablelist><varlistentry><term> + View button + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Changes the Geeqie main window to display the contents of the Safe Delete folder. + </para> + <para/></section><section id="Behavior"><title> + Behavior + </title> + <variablelist><varlistentry><term> + Rectangular selection in icon view + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this to change the selection method used when selecting multiple items in an icon view. + </para> + <variablelist><varlistentry><term> + Descend folders in tree view + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view. + </para> + <para> + Note: Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view. + </para> + <variablelist><varlistentry><term> + Show date in directories list view + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this to display directory modification date along its name in the list view + </para> + <variablelist><varlistentry><term> + In place renaming + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + When renaming a single file, this will allow the rename entry to appear directly over the original filename. + </para> + <variablelist><varlistentry><term> + Show "Copy path" menu item + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this option to show a "Copy path" menu item in applicable menus. + </para> + <para> + This allows to copy path to files or directories to the clipboard, names are enclosed with double quotes and separated by space. + </para> + <variablelist><varlistentry><term> + Open recent list maximum size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This is the number of entries saved in the recent open file list. + </para> + <variablelist><varlistentry><term> + Drag'n drop icon size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This is the width and height of the icon generated from image and displayed when doing drap'n drop actions. High resolution screens may require to increase this number. + </para> + <para/></section><section id="Navigation"><title> + Navigation + </title> + <variablelist><varlistentry><term> + Progressive keyboard scrolling + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will cause image panning speed to gradually accelerate when holding down the keyboard arrows. + </para> + <variablelist><varlistentry><term> + Mouse wheel scrolls image + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Home button path + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This defines the path to use for the "Home" button in the main window. By default or when this field is empty, this is the user's directory. + </para> + <variablelist><varlistentry><term> + Use current + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Pressing this button will set the Home button path to the current open directory. + </para> + <para/></section><section id="Miscellaneous"><title> + Miscellaneous + </title> + <variablelist><varlistentry><term> + Custom similarity threshold + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This setting is used by the compare method “similarity (custom)â€, located in the Find Duplicates window. + </para> + <para/></section><section id="Debugging"><title> + Debugging + </title> + <variablelist><varlistentry><term> + Debug level + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This defines the verbosity of debug info sent to console and log window (0 disables the debug output). + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsColor.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsColor"> + <title> + Color management + </title> + <para> + Here one can defined color profiles to use. Color management can be enabled or disabled from menu: View / Color Management. + </para> + <variablelist><varlistentry><term> + Type + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Either input color profile or screen color profile. + </para> + <variablelist><varlistentry><term> + Menu name + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Name of the menu entry corresponding to the color profile. + </para> + <variablelist><varlistentry><term> + File + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Path to the color profile file. + </para> + <para/></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsFiltering.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsFiltering"> + <title> + Filtering Options + </title> + <para> + This section describes the options presented under the Filtering Tab of the preferences dialog. + </para> + <para/><section id="Filters"><title> + Filters + </title> + <variablelist><varlistentry><term> + Show hidden files or folders + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enables the display of hidden files and folders, also known as dot files. + </para> + <variablelist><varlistentry><term> + Show dot directory + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enables the display of the current directory as a dot in the directories views. It may be useful for some drag'n'drop operations. + </para> + <variablelist><varlistentry><term> + Case sensitive sort + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Files and folders are sorted such that upper case letters occur before lower case letters. + </para> + <para> + Enabled result: A, B, C, a, b, c<?db2html element="br"?> + Disabled result: A, a, B, b, C, c + </para> + <variablelist><varlistentry><term> + Disable file filtering + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this to allow Geeqie to list all files, even those that do not contain images. + </para> + <para/></section><section id="Groupingsidecarextensions"><title> + Grouping sidecar extensions + </title> + <para> + 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. It is possible to use wildcards: <literal>%image</literal> expands to list of all files in class image, <literal>%raw</literal> expands to raw files and <literal>%meta</literal> expands to metadata files (see the file class below). + </para> + <para> + Grouped files will appear as one in file views. The group is represented by the first existing extension from the list. For example, it is useful when browsing directories containing two files for the same image (as raw+jpeg files generated by some cameras). + </para> + <para/></section><section id="Filetypes"><title> + File types + </title> + <para> + 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 (.). + </para> + <para> + Note: Unlike all other options in the dialog, filter list changes are applied immediately. + </para> + <variablelist><varlistentry><term> + Add button + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Adds a new blank line to the filter list, change the parameters to match the desired file type. + </para> + <variablelist><varlistentry><term> + Remove button + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Removes the selected line from the filter list. + </para> + <variablelist><varlistentry><term> + Defaults button + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Resets the filter list to the default values, discarding any customizations made by the user. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsGeneral.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,125 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsGeneral"> + <title> + General Options + </title> + <para> + This section describes the options presented under the General Tab of the preferences dialog. + </para> + <para/><section id="Startup"><title> + Startup + </title> + <variablelist><varlistentry><term> + Restore folder on startup + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enabling this will cause Geeqie to initially open to the specified folder. + </para> + <variablelist><varlistentry><term> + Use Current + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Activate this button to change the setting to the current folder. + </para> + <variablelist><varlistentry><term> + Use last path + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + When checked, Geeqie will recall the last path used on startup. + </para> + <para/></section><section id="Thumbnails"><title> + Thumbnails + </title> + <variablelist><varlistentry><term> + Size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Selects the size of the thumbnails displayed throughout Geeqie, dimensions are width by height in pixels. + </para> + <variablelist><varlistentry><term> + Quality + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Selects the method to use when scaling an image down for thumbnails. + </para> + <variablelist><varlistentry><term> + Nearest + </term><listitem><para> + Fastest scaler, but results in poor thumbnail quality. + </para></listitem></varlistentry><varlistentry><term> + Tiles + </term><listitem><para> + Thumbnail results are very close to bilinear, with better speed. + </para></listitem></varlistentry><varlistentry><term> + Bilinear + </term><listitem><para> + High quality results, moderately fast. + </para></listitem></varlistentry><varlistentry><term> + Hyper + </term><listitem><para> + Slowest scaler, sometimes gives better results than bilinear. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Cache thumbnails + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this to save thumbnails to disk, subsequent requests for a thumbnail will be faster. Thumbnails are cached into ($HOME)/.geeqie/thumbnails. Refer to <link linkend="GuideReferenceThumbnails">Thumbnails Reference</link> for details. + </para> + <variablelist><varlistentry><term> + Use shared thumbnail cache + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will use a thumbnail caching method that is compatible with applications that use the standard thumbnail specification. When this option is enabled thumbnails will be stored in ($HOME)/.thumbnails + </para> + <variablelist><varlistentry><term> + Cache thumbnails into .thumbnails + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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 <emphasis role="strong">.thumbnails</emphasis>. When the image source folder cannot be written, Geeqie falls back to saving the thumbnail in the user's home folder. + </para> + <variablelist><varlistentry><term> + Faster jpeg thumbnailing + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will speed up thumbnails generation in some cases, but may reduce the quality + </para> + <variablelist><varlistentry><term> + Use EXIF thumbnails when available + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Use xvpics thumbnails when found + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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 <emphasis role="strong">.xvpics</emphasis>. Enabling this option will allow Geeqie to read thumbnails saved in the xvpics format. + </para> + <para> + Note: Support for xvpics is read only, Geeqie can not generate thumbnails in this format. + </para> + <para/></section><section id="Slideshow"><title> + Slide show + </title> + <variablelist><varlistentry><term> + Delay between image change + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Specifies the delay between images for slide shows, in seconds. + </para> + <variablelist><varlistentry><term> + Random + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + When enabled, slide show images will appear in random order. + </para> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Repeat + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + When enabled, slide shows will continue at the beginning after the last image is displayed. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsHidden.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsHidden"> + <title> + Hidden Options + </title> + <para/><section id="geeqierc"><title> + geeqierc + </title> + <para> + This section describes the options not accessible by the graphical interface, these options exist to maintain behavior of older releases of Geeqie. To change these settings, edit the Geeqie configuration file: + </para> + <para> + <literal>($HOME)/.geeqie/geeqierc</literal> + </para> + <para> + <emphasis role="strong">lazy_image_sync: [true <emphasis role="i">false</emphasis>]</emphasis>: This will suppress the image view from changing when selecting a new folder; the current image will remain displayed until the user manually selects another image. + </para> + <para> + <emphasis role="strong">display_dialogs_under_mouse: [true <emphasis role="i">false</emphasis>]</emphasis>: Enabling this will cause new dialogs to initially position themselves such that they are under the current mouse position. + </para> + <para> + <emphasis role="strong">scroll_reset_method: value</emphasis>: This will set the method used to set the scroll position, or visible region of a new image, value can be: + </para> + <para> + 0: Move to upper left corner.<?db2html element="br"?> + 1: Center image.<?db2html element="br"?> + 2: Maintain same visible region as previous image, if possible. + </para> + <para> + <emphasis role="strong">dither_quality:</emphasis> Set the quality when dithering images on displays with a limited color pallet: + </para> + <para> + 0: No dithering<?db2html element="br"?> + 1: Normal<?db2html element="br"?> + 2: Best + </para> + <para/></section><section id="FindDuplicateswindow"><title> + Find Duplicates window + </title> + <para> + <emphasis role="strong">Ctrl + Shift + [Right Mouse click]</emphasis>: Use this to display a dialog containing the data stored for the clicked image file. This is usually only useful for debugging purposes. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsImage.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,148 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsImage"> + <title> + Image Options + </title> + <para> + This section describes the options presented under the Image Tab of the preferences dialog. + </para> + <para/><section id="Zoom"><title> + Zoom + </title> + <variablelist><varlistentry><term> + Quality + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Selects the method used to scale the size of an image. + </para> + <variablelist><varlistentry><term> + Nearest + </term><listitem><para> + Fastest scaler, but results in poor image quality. + </para></listitem></varlistentry><varlistentry><term> + Tiles + </term><listitem><para> + Results are somewhat close to bilinear, with better speed. + </para></listitem></varlistentry><varlistentry><term> + Bilinear + </term><listitem><para> + High quality results, moderately fast. + </para></listitem></varlistentry><varlistentry><term> + Hyper + </term><listitem><para> + Slowest scaler, sometimes gives better results than bilinear. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Two pass zooming + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enables Geeqie to first display a scaled image using the nearest zoom quality. After image decoding is complete, the image is scaled again using the selected “Zoom (scaling)†method. This allows faster display of an image as it is decoded from the source file. + </para> + <variablelist><varlistentry><term> + Allow enlargement of image for zoom to fit + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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 “Fit to Windowâ€. + </para> + <variablelist><varlistentry><term> + Limit image size when autofitting + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This percentage will affect the size of the image when Fit image to window 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. + </para> + <variablelist><varlistentry><term> + Zoom increment + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image. + </para> + <para/></section><section id="Zoomcontrol"><title> + Zoom control + </title> + <variablelist><varlistentry><term> + When new image is selected + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This controls the behavior of the zoom setting when changing the displayed image. + </para> + <variablelist><varlistentry><term> + Zoom to original size + </term><listitem><para> + The new image is set to it's original size. + </para></listitem></varlistentry><varlistentry><term> + Fit image to window + </term><listitem><para> + The new image's zoom is changed so that the image will fit within the current view area. + </para></listitem></varlistentry><varlistentry><term> + Leave zoom at previous setting + </term><listitem><para> + The zoom setting is unchanged, the new image will be scaled the same as the previous image. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Scrollcontrol"><title> + Scroll control + </title> + <variablelist><varlistentry><term> + Scroll reset method + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This controls the scroll initial position when changing the displayed image. + </para> + <variablelist><varlistentry><term> + Top left + </term><listitem><para> + The new image is displayed from top left corner. + </para></listitem></varlistentry><varlistentry><term> + Center + </term><listitem><para> + The new image is centered + </para></listitem></varlistentry><varlistentry><term> + No change + </term><listitem><para> + The new image is positionned as the previous one, whenever possible. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Appearance"><title> + Appearance + </title> + <variablelist><varlistentry><term> + Custom border color + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this to draw the image background (the area around the image) in the specified color. + </para> + <variablelist><varlistentry><term> + Border color + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Use this color chooser to define the color to use as image background. + </para> + <para> + Note: You may use Limit image size when autofitting option to keep a border around the image in fullscreen mode. + </para> + <para/></section><section id="Convenience"><title> + Convenience + </title> + <variablelist><varlistentry><term> + Refresh on file change + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes. + </para> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Preload next image + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Auto rotate image using EXIF information + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Auto rotates images based on data stored in images that include EXIF data. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsKeyboard.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsKeyboard"> + <title> + Keyboard Options + </title> + <para> + This section describes the hotkey configuration dialog. + </para> + <para/></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsLayout.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsLayout"><title/> + <title> + Window Layout + </title> + <para> + 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. + </para> + <para> + 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. + </para> + <para/></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsMetadata.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,47 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsMetadata"> + <title> + Metadata Options + </title> + <para> + This section describes the metadata writing process and options that influences it. + </para> + <para/><section id="Metadatahandling"><title> + Metadata handling + </title> + <para/><section id="Readalgorithm"><title> + Read algorithm + </title> + <orderedlist spacing="compact"><listitem><para>Read exif, iptc and XMP from the file. + </para></listitem><listitem><para>Now we have "raw" data -> show them in <link linkend="GuideOtherWindowsExif">Exif Window</link>. + </para></listitem><listitem><para>Read XMP sidecar or Geeqie private metadata file, which overrides the XMP read from the file. + </para></listitem><listitem><para>Sync XMP with exif and Iptc, this corresponds to the "reconciliation" as described in [<ulink url="http://www.adobe.com/devnet/xmp/pdfs/XMPSpecificationPart3.pdf">XMP Specification</ulink>] + <itemizedlist spacing="compact"><listitem><para>detect which of Exif and Xmp.exif is newer and copy the data in appropriate direction + </para></listitem><listitem><para>detect which of Iptc and Xmp is newer and copy the data in appropriate direction + </para></listitem></itemizedlist> + </para></listitem><listitem><para>Now we have "processed" data - use them for Info Sidebar (title, keywords, ...), Orientation, Color management, etc. + </para></listitem></orderedlist> + <para/></section><section id="Metadatamodification"><title> + Metadata modification + </title> + <itemizedlist spacing="compact"><listitem><para>Grouped files handling (raw + jpeg): description tags (keywords, comments) are written to all image files in the group (a group contains the same image in various formats, descriptions should be the same), technical tags (exif) are handled separately for each file. + </para></listitem><listitem><para>Modifying the keywords, comment, orientation, etc. does not ask for confirmation, but immediately modifies the metadata in memory and adds the file to "write queue" + </para></listitem><listitem><para>Writing of the queued changes is triggered from the menu or via auto-save. It is possible to review the changes and exclude selected files. + </para></listitem></itemizedlist> + <para/></section><section id="Writealgorithm"><title> + Write algorithm + </title> + <orderedlist spacing="compact"><listitem><para>Exif and IPTC is updated from XMP (for example Exif.Image.Orientation is updated from Xmp.exif.orientation). See XMP and IPTC4XMP specs for the list of corresponding tags. + </para></listitem><listitem><para>Try to write exif, iptc and XMP to the image file + </para></listitem><listitem><para>Try to write XMP sidecar for raw file if previous step was not possible. + </para></listitem><listitem><para>If previous steps were not possible, write XMP metadata to .metadata. + </para></listitem><listitem><para>If previous steps were not possible, write XMP metadata to geeqie private directory. + </para></listitem><listitem><para>After the first successful write attempt delete old metadata files in all possible locations. + </para></listitem></orderedlist> + <para/></section></section><section id="Optionsthatinfluencestheprocess"><title> + Options that influences the process + </title> + <para> + File types with allowed sidecars are listed in the Files tab. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOptionsWindow.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,266 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOptionsWindow"> + <title> + Window Options + </title> + <para> + This section describes the options presented under the Windows Tab of the preferences dialog. + </para> + <para/><section id="State"><title> + State + </title> + <variablelist><varlistentry><term> + Remember window positions + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will maintain windows size and position between Geeqie sessions. + </para> + <variablelist><varlistentry><term> + Remember tool state + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will maintain the tool window state between Geeqie sessions. + </para> + <para/></section><section id="Size"><title> + Size + </title> + <variablelist><varlistentry><term> + Fit window to image when tools are hidden/floating + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The main window will be resized to accommodate each image's size and proportions when the image pane is the only one visible within the window. + </para> + <variablelist><varlistentry><term> + Limit size when auto-sizing window + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This will restrict the maximum size a window can grow to automatically fit an image. The value represents the percentage of the desktop size in width and height. + </para> + <para/></section><section id="FullScreen"><title> + Full Screen + </title> + <variablelist><varlistentry><term> + Location + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Stay above other windows + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Smooth image flip + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + 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. + </para> + <variablelist><varlistentry><term> + Disable screen saver + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This option will execute <emphasis role="i">xscreensaver-command --deactivate</emphasis> once per minute to avoid the screen saver from activating when Geeqie is displayed full screen. + </para> + <para/></section><section id="OverlayScreenDisplay"><title> + Overlay Screen Display + </title> + <variablelist><varlistentry><term> + Always show image overlay at startup + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable this to have the image overlay info displayed by default + </para> + <variablelist><varlistentry><term> + Image overlay template + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Overlay info is customizable through this template + </para> + <para> + Overlay info format string syntax is: <literal>%tag[:max_length][:extra]%</literal> + </para> + <informaltable><tgroup cols="2"><tbody><row><entry> + Tag + </entry><entry> + Replaced by + </entry></row> +<row><entry> + name + </entry><entry> + Filename of the picture + </entry></row> +<row><entry> + collection + </entry><entry> + Name of the collection + </entry></row> +<row><entry> + number + </entry><entry> + Current number of image in the list + </entry></row> +<row><entry> + total + </entry><entry> + Total number of images + </entry></row> +<row><entry> + date + </entry><entry> + File date + </entry></row> +<row><entry> + size + </entry><entry> + File size + </entry></row> +<row><entry> + width + </entry><entry> + Image width + </entry></row> +<row><entry> + height + </entry><entry> + Image height + </entry></row> +<row><entry> + res + </entry><entry> + Image resolution + </entry></row> +<row><entry> + keywords + </entry><entry> + Image keywords from metadata + </entry></row> +<row><entry> + comment + </entry><entry> + Image comment from metadata + </entry></row> +</tbody></tgroup></informaltable> + <para> + To access exif data use the exif name, for example: <literal>%Exif.Photo.DateTimeOriginal%</literal> to get the date of the original shot + </para> + <para> + Pre-formatted exif data is also available: + </para> + <informaltable><tgroup cols="2"><tbody><row><entry> + Tag + </entry><entry> + Replaced by exif data + </entry></row> +<row><entry> + formatted.Camera + </entry><entry> + Camera and sofware name + </entry></row> +<row><entry> + formatted.<ulink url="/wiki/DateTime">DateTime?</ulink> + </entry><entry> + Image Date + </entry></row> +<row><entry> + formatted.<ulink url="/wiki/ShutterSpeed">ShutterSpeed?</ulink> + </entry><entry> + Shutter speed in seconds (ie. 1/60s) + </entry></row> +<row><entry> + formatted.Aperture + </entry><entry> + Aperture (ie. f5.6) + </entry></row> +<row><entry> + formatted.<ulink url="/wiki/ExposureBias">ExposureBias?</ulink> + </entry><entry> + Exposure bias (ie. +0.3) + </entry></row> +<row><entry> + formatted.ISOSpeedRating + </entry><entry> + ISO sensitivity (ie. 100) + </entry></row> +<row><entry> + formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink> + </entry><entry> + Focal length + </entry></row> +<row><entry> + formatted.<ulink url="/wiki/FocalLength">FocalLength?</ulink>35mmFilm + </entry><entry> + Focal length 35mm + </entry></row> +<row><entry> + formatted.<ulink url="/wiki/SubjectDistance">SubjectDistance?</ulink> + </entry><entry> + Subject distance + </entry></row> +<row><entry> + formatted.Flash + </entry><entry> + Flash + </entry></row> +<row><entry> + formatted.Resolution + </entry><entry> + Resolution + </entry></row> +<row><entry> + formatted.<ulink url="/wiki/ColorProfile">ColorProfile?</ulink> + </entry><entry> + Color profile + </entry></row> +</tbody></tgroup></informaltable> + <para> + You can limit the length of displayed data using :number notation: <literal>%formatted.Camera:20%</literal> will truncate the displayed data to 20 characters and will add 3 dots at the end to denote the truncation. + </para> + <para> + If two or more variables are connected with the -sign, it prints available variables with a separator:<?db2html element="br"?> + <literal>%formatted.ShutterSpeed% %formatted.ISOSpeedRating% %formatted.FocalLength%</literal><?db2html element="br"?> + could show:<?db2html element="br"?> + "1/20s - 400 - 80 mm"<?db2html element="br"?> + or<?db2html element="br"?> + "1/200 - 80 mm" if there's no ISO information in the Exif data.<?db2html element="br"?> + </para> + <para> + If a line is empty, it is removed. This allows to add lines that totally disappear when no data is available. + </para> + <para> + 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. + </para> + <para> + Examples: + </para> + <variablelist><varlistentry><term> + <literal>%name:&lt;i&gt;*&lt;/i&gt;\n%</literal> + </term><listitem><para> + name is displayed in italics ended with a newline + </para></listitem></varlistentry><varlistentry><term> + <literal>%size:\n%</literal> + </term><listitem><para> + size is displayed with a newline at end + </para></listitem></varlistentry><varlistentry><term> + <literal>%formatted.ISOSpeedRating:ISO *%</literal> + </term><listitem><para> + ie. "ISO 100" + </para></listitem></varlistentry><varlistentry><term> + <literal>Collection &lt;b&gt;*&lt;/b&gt;\n</literal> + </term><listitem><para> + display collection name in bold prefixed by "Collection " and a newline is appended + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Help button + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Show syntax help + </para> + <variablelist><varlistentry><term> + Defaults button + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Restore default image overlay template + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOtherWindows.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideOtherWindows"> + <title> + Other Windows + </title> + <para> + This section describes the windows available in Geeqie that can be thought of as general purpose, they are not designed for a specific purpose. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOtherWindowsImageWindow.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOtherWindowsImageProperties.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideOtherWindowsPanView.xml"/> + + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOtherWindowsExif.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOtherWindowsExif"> + <title> + Exif Window + </title> + <para> + The Exif window shows Exif, IPTC and XMP metadata that are present in the file. Unlike the other parts of the program, this window shows the "raw" metadata read from the file, without any postprocessing. Other parts of the program combines metadata from various formats and also merges in the sidecars and private metadata files. Thus, this window is ideal for metadata debugging. For normal use look at the Exif panes in the <link linkend="GuideSidebarsInfo">Info Sidebar</link>. + </para> + <para> + It is possible to drag items from the Exif window to the Exif panes in the <link linkend="GuideSidebarsInfo">Info Sidebar</link>. + </para> + <para/></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOtherWindowsImageProperties.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOtherWindowsImageProperties"> + <title> + Image Properties Window + </title> + <para> + The image properties window is a dialog that displays various information about a file. + </para> + <para> + To display a properties window for a an image select Properties from it's context menu, in most windows pressing Ctrl + P will display the properties of the selected images or files. + </para> + <para> + The properties window contains a scaled down image of the file and information about the file under several tabs. If the window contains more than one file, they can be navigated by activating the left and right arrow buttons, or by clicking the primary and middle mouse buttons on the image preview. + </para> + <para/><section id="Imagepreview"><title> + Image preview + </title> + <para> + This displays the contents of the active file. When the window contains more than one file, they can be navigated with the primary and middle mouse buttons. The image display is also a drag source for drag and drop, start the drag operation by pressing the middle mouse button and dragging the file to the desired target. + </para> + <para/></section><section id="Generaltab"><title> + General tab + </title> + <para> + This displays information about the active file. It includes: + </para> + <variablelist><varlistentry><term> + File attributes + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Modification date and time, size, owner, group, and permissions. + </para> + <variablelist><varlistentry><term> + Image attributes + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Dimensions, uncompressed size, file or mime type, and existence of an alpha channel. + </para> + <variablelist><varlistentry><term> + Compress ratio + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The percentage of file size compared to the size of the image when decoded into memory. + </para> + <para/></section><section id="Keywordstab"><title> + Keywords tab + </title> + <para> + The keywords tab contains the same information that is in the Keywords sidebar, please refer to the <link linkend="GuideSidebarsKeywords">Keywords Sidebar?</link> page for details. + </para> + <para/></section><section id="EXIFtab"><title> + EXIF tab + </title> + <para> + The EXIF tab contains the same information that is in the EXIF sidebar, please refer to the <link linkend="GuideSidebarsExif">EXIF Sidebar?</link> page for details. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOtherWindowsImageWindow.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOtherWindowsImageWindow"> + <title> + Image Window + </title> + <para> + An image window is a window that displays only the image. + </para> + <para> + An image window can always be opened from the context menu of all images and files. Keyboard shortcuts exist for most windows that display images or files, however the shortcut can vary dependent on the type of window containing them. + </para> + <para> + The image pane contained in an image window behaves and operates similar to the image pane of a <link linkend="GuideMainWindowImagePane">Main Window</link>. The keyboard shortcuts are the same, and the context menu is the same except “Hide file list†is replaced by “Close windowâ€. The <link linkend="GuideImagePresentationSlideshow">slide show</link> and <link linkend="GuideImagePresentationFullscreen">full screen</link> functions are also available. + </para> + <para/><section id="Navigation"><title> + Navigation + </title> + <para> + When the image window contains a list of images or is linked to a collection, the displayed image can be changed forward or backward in the list with the respective <ulink url="/wiki/PageDown">PageDown?</ulink> and <ulink url="/wiki/PageUp">PageUp?</ulink> keys. In addition, all navigation methods for the mouse and keyboard are similar to that of the image pane of a <link linkend="GuideMainWindowImagePane">Main Window</link>. + </para> + <para/></section><section id="Changingtheimage"><title> + Changing the image + </title> + <para> + To change the contents of an image window, drop the items onto the window with drag and drop. The dropped item can be one or more files, folders, or an image from a collection window: + </para> + <variablelist><varlistentry><term> + One or more <emphasis role="strong">files</emphasis> + </term><listitem><para> + The image window will display the first image; the list of dropped images can be navigated similar to a main window's image pane. + </para></listitem></varlistentry><varlistentry><term> + One or more <emphasis role="strong">folders</emphasis> + </term><listitem><para> + When the dropped list of items includes a folder, a menu will appear allowing to skip the folders, add their contents, or add their contents recursively. After choosing from the menu the requested files will be added to the image window. + </para></listitem></varlistentry><varlistentry><term> + Image from a <emphasis role="strong">collection</emphasis> + </term><listitem><para> + The image window will change to display the image and become linked to the collection containing the image. Images in the collection can then be navigated and viewed from the image window. + </para></listitem></varlistentry></variablelist> + <para> + Changing the image window by dropping a new item onto it will cause the previous list of images or linked collection to be discarded. + </para> + <para> + To update the image display in the event that the source file has changed, press the R key. + </para> + <para/></section><section id="InformationandhistogramOverlay"><title> + Information and histogram Overlay + </title> + <para> + 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. + </para> + <para> + 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. + </para> + <para> + Overlay info is customizable through <link linkend="GuideOptionsAdvanced">Image Overlay Template?</link> option in Advanced tab in Preferences dialog. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideOtherWindowsPanView.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,109 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideOtherWindowsPanView"> + <title> + Pan View Window + </title> + <para> + This window proposes alternative views of the <emphasis role="i">current directory and its children</emphasis>.<?db2html element="br"?> + You can pan the view as you pan an image in normal view mode, using left mouse button and drag. + </para> + <para> + A primary mouse button click on any image will display informations about the image. Secondary mouse button will show a context menu. + </para> + <para> + Note: The pan view recursively visits each folder under the specified folder, so be careful it can eat a lot of ressources. + </para> + <para/><section id="Selectafolder"><title> + Select a folder + </title> + <variablelist><varlistentry><term> + Location + </term><listitem><para> + Set the top folder. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Chooseaviewmode"><title> + Choose a view mode + </title> + <para> + A select box let you choose among different view modes: + </para> + <variablelist><varlistentry><term> + Timeline + </term><listitem><para> + Shows images grouped by date. + </para></listitem></varlistentry><varlistentry><term> + Calendar + </term><listitem><para> + Shows a calendar with the number of images indicated for each day (as dots and number). Left mouse button click will show images in a popup. + </para></listitem></varlistentry><varlistentry><term> + Folders + </term><listitem><para> + Show images grouped by folder. Each box represents a folder. Parent and children folders are shown as boxes enclosing other boxes. + </para></listitem></varlistentry><varlistentry><term> + Folders (flower) + </term><listitem><para> + Show images grouped by folder. Each box represents a folder. Parent folders are linked to children by a line. The top folder is the center of the flower. + </para></listitem></varlistentry><varlistentry><term> + Grid + </term><listitem><para> + All images are shown on a grid. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Howeachimageshouldberepresented"><title> + How each image should be represented + </title> + <para> + Another select box let you choose the representation of each image: + </para> + <variablelist><varlistentry><term> + Dots + </term><listitem><para> + Each image is represented by a dot. + </para></listitem></varlistentry><varlistentry><term> + No images + </term><listitem><para> + Each image is represented by a square box. + </para></listitem></varlistentry><varlistentry><term> + Small thumbnails + </term><listitem><para> + Each image is represented by a small thumbnail. + </para></listitem></varlistentry><varlistentry><term> + Normal thumbnails + </term><listitem><para> + Each image is represented by a normal thumbnail. + </para></listitem></varlistentry><varlistentry><term> + Large thumbnails + </term><listitem><para> + Each image is represented by a large thumbnail. + </para></listitem></varlistentry><varlistentry><term> + 1:10 (10%) + </term><listitem><para> + Each image is represented by reduced image (1/10 of the original's dimensions). + </para></listitem></varlistentry><varlistentry><term> + 1:4 (25%) + </term><listitem><para> + Each image is represented by reduced image (1/4 of the original's dimensions). + </para></listitem></varlistentry><varlistentry><term> + 1:3 (33%) + </term><listitem><para> + Each image is represented by reduced image (1/3 of the original's dimensions). + </para></listitem></varlistentry><varlistentry><term> + 1:2 (50%) + </term><listitem><para> + Each image is represented by reduced image (1/2 of the original's dimensions). + </para></listitem></varlistentry><varlistentry><term> + 1:1 (100%) + </term><listitem><para> + The original image is shown at its normal dimensions. + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Find"><title> + Find + </title> + <para> + At the bottom of the window: + </para> + <variablelist><varlistentry><term> + Find button + </term><listitem><para> + Shows a text field for image search. One can enter a filename or a part of it or a date (yyyy or yyyy-mm or yyyy-mm-dd format, separator can be '/','-',' ','.',','). Pressing Enter key will start the search, pressing it again will move to the next match. Matched file is made visible and details are shown for it. + </para></listitem></varlistentry></variablelist> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuidePrinting.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,235 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuidePrinting"> + <title> + Printing + </title> + <para> + To print an image press Shift + P or select Print from the File menu. + </para> + <para> + The print dialog includes tabs that group related printing options, a preview pane, and a Print and Cancel button. + </para> + <para/><section id="Layouttab"><title> + Layout tab + </title> + <variablelist><varlistentry><term> + Source + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + This selects the group of images to use for print output. + </para> + <variablelist><varlistentry><term> + Image + </term><listitem><para> + The file with the focus. + </para></listitem></varlistentry><varlistentry><term> + Selection + </term><listitem><para> + The files selected in the main window. + </para></listitem></varlistentry><varlistentry><term> + All + </term><listitem><para> + All files listed in the main window. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Layout + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Select one image per page, or a Proof sheet that will print multiple images per page. + </para> + <variablelist><varlistentry><term> + Image size + </term><listitem><para> + When print one image per page, the size of the image in relation to the available print area. + </para></listitem></varlistentry><varlistentry><term> + Proof size + </term><listitem><para> + When printing a Proof sheet, the size of each image in Units (see Paper tab). + </para></listitem></varlistentry></variablelist> + <para/></section><section id="Texttab"><title> + Text tab + </title> + <variablelist><varlistentry><term> + Name + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Include the file name below each image. + </para> + <variablelist><varlistentry><term> + Path + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Include the full path of the file below each image. + </para> + <variablelist><varlistentry><term> + Date + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Include the file date below each image. + </para> + <variablelist><varlistentry><term> + Size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Include the file size below each image. + </para> + <variablelist><varlistentry><term> + Dimensions + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Include the source image's pixel width and height below each image. + </para> + <variablelist><varlistentry><term> + Font size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The font size to use for the text description of each image, in points. + </para> + <para/></section><section id="Papertab"><title> + Paper tab + </title> + <variablelist><varlistentry><term> + Format + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The size of the paper in the printer's paper tray. Many common sizes are provided, however if the paper size is not listed selected the Custom format and enter the paper size in Size below. + </para> + <variablelist><varlistentry><term> + Size + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The size of the selected paper format, in Units (below). These numbers can be changed when the paper Format is Custom. + </para> + <variablelist><varlistentry><term> + Units + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Select the units for Geeqie to use when conveying measurements of length for paper size, margins, and images sizes to the user. + </para> + <variablelist><varlistentry><term> + Orientation + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Select portrait or landscape print output. + </para> + <variablelist><varlistentry><term> + Margins + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + These values specify the size of the paper edges not to be included in the print region, in Units (above). + </para> + <para/></section><section id="Printertab"><title> + Printer tab + </title> + <variablelist><varlistentry><term> + Destination + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Use this to select the destination of the print output. + </para> + <variablelist><varlistentry><term> + Default printer + </term><listitem><para> + Prints to the system default printer. + </para></listitem></varlistentry><varlistentry><term> + Custom printer + </term><listitem><para> + Prints to the printer using the command defined in Custom printer (below). + </para></listitem></varlistentry><varlistentry><term> + Postscript file + </term><listitem><para> + Writes using the postscript format to named File (below). + </para></listitem></varlistentry><varlistentry><term> + Image file + </term><listitem><para> + Writes using the selected File format (below) to named File (below). + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Custom printer + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The command to use when Destination is selected as Custom printer. For convenience, the drop down list includes printers available for use by the printing subsystem. + </para> + <variablelist><varlistentry><term> + File + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The file to use for output when Destination is Postscript file or Image file. + </para> + <variablelist><varlistentry><term> + File format + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The image format to use when Destination is Image file. + </para> + <variablelist><varlistentry><term> + DPI + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Abbreviation for Dots Per Inch. When the Destination is a printer or postscript file, this defines the maximum DPI to use when outputting image data. For example if the Destination printer is only capable of 600 DPI, but the resulting image to print is 1200 DPI, Geeqie will scale the image down to 600 DPI before sending it to the printer. This can greatly reduce the size of a print job when printing Proof Sheets or very large images. + </para> + <para/></section><section id="Preview"><title> + Preview + </title> + <para> + The preview displays a small version of the output that will result with the current settings. The preview will update whenever a setting is changed that will effect the print output. + </para> + <para> + The preview will indicate the number of pages that will be printed, to see a preview of a specific page change to that page by activating the left or right arrow buttons located below the preview. + </para> + <para> + The size of the preview can be changed using the three zoom buttons located below the preview. + </para> + <para> + The preview includes several reference lines that are <emphasis role="i">not included</emphasis> in the final print: + </para> + <variablelist><varlistentry><term> + Reference grid + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Light gray lines that form a grid over the entire page, the spacing between these lines is dependent on the current measurement unit: + </para> + <variablelist><varlistentry><term> + Inch + </term><listitem><para> + 1 inch. + </para></listitem></varlistentry><varlistentry><term> + Points + </term><listitem><para> + 72 points. + </para></listitem></varlistentry><varlistentry><term> + Centimeters or Millimeters + </term><listitem><para> + 1 centimeter. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Margins + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Blue lines along each edge of the page represent the location of the print margins, the non-printable area of the page is also gray. + </para> + <variablelist><varlistentry><term> + Proof sheet grid + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + When the layout is set to Proof sheet, each proof location is indicated with a red rectangle. + </para> + <para/></section><section id="Rememberprintsettings"><title> + Remember print settings + </title> + <para> + Enable this check box to retain the current settings as the default for the print dialog. This option only retains the settings when a print operation is started by activating the print button. In addition, only the settings relevant to the current print operation will be retained. + </para> + <para/></section><section id="Printbutton"><title> + Print button + </title> + <para> + Activate the print button to start the print job, the dialog will change to display the progress as images are sent to the selected print destination. + </para> + <para/></section><section id="Cancelbutton"><title> + Cancel button + </title> + <para> + Activate this button to close the print dialog, no printing will be performed. + </para> + <para/></section></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideReference.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideReference"> + <title> + Reference + </title> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceCommandLine.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceKeyboardShortcuts.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceThumbnails.xml"/> +<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideReferenceManagement.xml"/> + + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideReferenceCommandLine.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,210 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideReferenceCommandLine"> + <title> + Command Line Options + </title> + <para> + These are the command line options available to Geeqie: + </para> + <informaltable><tgroup cols="3"><tbody><row><entry> + Short Option + </entry><entry> + Long Option + </entry><entry> + Description + </entry></row> +<row><entry> + +t + </entry><entry> + --with-tools + </entry><entry> + Show file list, menu, and statusbar. + </entry></row> +<row><entry> + -t + </entry><entry> + --without-tools + </entry><entry> + Hide file list, menu, and statusbar. Window contains image only. + </entry></row> +<row><entry> + -f + </entry><entry> + --fullscreen + </entry><entry> + Start up in fullscreen. + </entry></row> +<row><entry> + -s + </entry><entry> + --slideshow + </entry><entry> + Start up in slideshow mode. + </entry></row> +<row><entry> + -l + </entry><entry> + --list + </entry><entry> + Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection. + </entry></row> +<row><entry> + -r + </entry><entry> + --remote + </entry><entry> + Send command line options to existing Geeqie process. + </entry></row> +<row><entry> + -rh + </entry><entry> + --remote-help + </entry><entry> + List command line options available to --remote. + </entry></row> +<row><entry> + -h + </entry><entry> + --help + </entry><entry> + Display brief command line option list. + </entry></row> +<row><entry> + -v + </entry><entry> + --version + </entry><entry> + Display version of Geeqie. + </entry></row> +<row><entry/><entry> + --debug + </entry><entry> + Enable Debug output to console. + </entry></row> +</tbody></tgroup></informaltable> + <para/><section id="Remotecommands"><title> + Remote commands + </title> + <para> + The --remote command line option will send all entered commands to an existing Geeqie process, a new process will be started if one does not exist. These are the additional commands that can be used with the remote command: + </para> + <informaltable><tgroup cols="3"><tbody><row><entry> + Short Option + </entry><entry> + Long Option + </entry><entry> + Description + </entry></row> +<row><entry> + -n + </entry><entry> + --next + </entry><entry> + Change main window to display next image. + </entry></row> +<row><entry> + -b + </entry><entry> + --back + </entry><entry> + Change main window to display previous image. + </entry></row> +<row><entry/><entry> + --first + </entry><entry> + Change main window to display first image. + </entry></row> +<row><entry/><entry> + --last + </entry><entry> + Change main window to display last image. + </entry></row> +<row><entry> + -f + </entry><entry> + --fullscreen + </entry><entry> + Toggle full screen mode of the main window. + </entry></row> +<row><entry> + -fs + </entry><entry> + --fullscreen-start + </entry><entry> + Start full screen mode for main window. + </entry></row> +<row><entry> + -fS + </entry><entry> + --fullscreen-stop + </entry><entry> + Stop full screen mode for main window. + </entry></row> +<row><entry> + -s + </entry><entry> + --slideshow + </entry><entry> + Toggle slide show for main window. + </entry></row> +<row><entry> + -ss + </entry><entry> + --slideshow-start + </entry><entry> + Start slide show for main window. + </entry></row> +<row><entry> + -sS + </entry><entry> + --slideshow-stop + </entry><entry> + Stop slide show for main window. + </entry></row> +<row><entry> + -sr&lt;folder&gt; + </entry><entry> + --slideshow-recurse&lt;folder&gt; + </entry><entry> + Start recursive slide show for &lt;folder&gt; in main window. + </entry></row> +<row><entry> + -d&lt;n&gt; + </entry><entry> + --delay=&lt;n&gt; + </entry><entry> + Set slide show delay to &lt;n&gt; seconds, range is 0.1 to 3600 + </entry></row> +<row><entry> + +t + </entry><entry> + --tools-show + </entry><entry> + Show tools for main window. + </entry></row> +<row><entry> + -t + </entry><entry> + --tools-hide + </entry><entry> + Hide tools for main window. + </entry></row> +<row><entry> + -q + </entry><entry> + --quit + </entry><entry> + Quit Geeqie. + </entry></row> +<row><entry/><entry> + file:&lt;filename&gt; + </entry><entry> + Change main window to display &lt;filename&gt; + </entry></row> +<row><entry/><entry> + view:&lt;filename&gt; + </entry><entry> + Open new window containing &lt;filename&gt; + </entry></row> +</tbody></tgroup></informaltable> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideReferenceConfig.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideReferenceConfig"><title/> + <para> + ($HOME)/.config/geeqie/geeqierc.xml + </para> + <para> + FIXME: Exiv2 keys, toolbar, statusbar, sidebar + </para> + <para> + geeqie -r --config-load: + </para> + <para/></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideReferenceKeyboardShortcuts.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,517 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideReferenceKeyboardShortcuts"> + <para> + FIXME: do we need this? The list of hotkeys is available in the preferences dialog. + </para> + <title> + Keyboard Shortcuts + </title> + <informaltable><tgroup cols="3"><tbody><row><entry> + Shortcut + </entry><entry> + Mouse + </entry><entry> + Action + </entry></row> +<row><entry> + <emphasis role="strong">Image Navigation</emphasis> + </entry></row> +<row><entry> + <ulink url="/wiki/PageDown">PageDown?</ulink> + </entry><entry> + Left Click on image view<?db2html element="br"?> + Mouse Wheel down [<ulink url="/wiki#bottomnote1">(*)</ulink>] + </entry><entry> + Change to next image. + </entry></row> +<row><entry> + <ulink url="/wiki/PageUp">PageUp?</ulink> + </entry><entry> + Middle Click on image view<?db2html element="br"?> + Mouse Wheel up [<ulink url="/wiki#bottomnote1">(*)</ulink>] + </entry><entry> + Change to previous image. + </entry></row> +<row><entry> + Home + </entry><entry/><entry> + Change to first image. + </entry></row> +<row><entry> + End + </entry><entry/><entry> + Change to last image. + </entry></row> +<row><entry> + <emphasis role="strong">Image panning</emphasis> (image has keyboard focus) + </entry></row> +<row><entry> + Arrows + </entry><entry> + Left Drag on image view<?db2html element="br"?> + Shift + Mouse Wheel [<ulink url="/wiki#bottomnote1">(*)</ulink>] + </entry><entry> + Pan image. + </entry></row> +<row><entry> + Shift + Arrows + </entry><entry/><entry> + Pan Image faster. + </entry></row> +<row><entry> + Ctrl + Arrows + </entry><entry/><entry> + Pan to respective edge of image. + </entry></row> +<row><entry> + Space + </entry><entry/><entry> + Change to next image. + </entry></row> +<row><entry> + Backspace + </entry><entry/><entry> + Change to previous image. + </entry></row> +<row><entry> + <emphasis role="strong">File Menu</emphasis> + </entry></row> +<row><entry> + Ctrl + N + </entry><entry/><entry> + New Window + </entry></row> +<row><entry> + C + </entry><entry/><entry> + Open a new empty collection window. + </entry></row> +<row><entry> + O + </entry><entry/><entry> + Display open collection dialog. + </entry></row> +<row><entry> + F3 + </entry><entry/><entry> + Open new search window. + </entry></row> +<row><entry> + D + </entry><entry/><entry> + Open new Find Duplicates window. + </entry></row> +<row><entry> + Shift + P + </entry><entry/><entry> + Open print dialog. + </entry></row> +<row><entry> + Ctrl + F + </entry><entry/><entry> + Create new folder in current path. + </entry></row> +<row><entry> + Ctrl + C + </entry><entry/><entry> + Copy selected images, opens destination selection dialog. + </entry></row> +<row><entry> + Ctrl + M + </entry><entry/><entry> + Move selected images, opens destination selection dialog. + </entry></row> +<row><entry> + Ctrl + R + </entry><entry/><entry> + Rename selected images, opens rename dialog. + </entry></row> +<row><entry> + Ctrl + DDelete + </entry><entry/><entry> + Delete selected images. + </entry></row> +<row><entry> + Ctrl + W + </entry><entry/><entry> + Close window, Geeqie exits when last window is closed. + </entry></row> +<row><entry> + Ctrl + Q + </entry><entry/><entry> + Quit Geeqie. + </entry></row> +<row><entry> + <emphasis role="strong">Edit Menu</emphasis> + </entry></row> +<row><entry> + Ctrl + 1 ... 0 + </entry><entry/><entry> + Run external edit command on selected images. + </entry></row> +<row><entry> + Ctrl + A + </entry><entry/><entry> + Select all images. + </entry></row> +<row><entry> + Ctrl + Shift + A + </entry><entry/><entry> + Unselect all images. + </entry></row> +<row><entry> + Ctrl + P + </entry><entry/><entry> + Open image properties window. + </entry></row> +<row><entry> + Ctrl + O + </entry><entry/><entry> + Open Geeqie preferences window. + </entry></row> +<row><entry> + ] + </entry><entry/><entry> + Rotate image clockwise 90 degrees. + </entry></row> +<row><entry> + [ + </entry><entry/><entry> + Rotate image counterclockwise 90 degree. + </entry></row> +<row><entry> + Shift + R + </entry><entry/><entry> + Rotate image 180 degrees. + </entry></row> +<row><entry> + Shift + M + </entry><entry/><entry> + Flip image horizontally (mirror). + </entry></row> +<row><entry> + Shift + F + </entry><entry/><entry> + Flip image vertically. + </entry></row> +<row><entry> + <emphasis role="strong">View Menu</emphasis> + </entry></row> +<row><entry> + +, = + </entry><entry> + Ctrl + Mouse Wheel up + </entry><entry> + Zoom image in. + </entry></row> +<row><entry> + - + </entry><entry> + Ctrl + Mouse Wheel down + </entry><entry> + Zoom image out. + </entry></row> +<row><entry> + Z + </entry><entry/><entry> + Reset zoom to original size (1:1). + </entry></row> +<row><entry> + X + </entry><entry/><entry> + Fit image to window size. + </entry></row> +<row><entry> + W + </entry><entry/><entry> + Zoom image to fit window width. + </entry></row> +<row><entry> + H + </entry><entry/><entry> + Zoom image to fit window height. + </entry></row> +<row><entry> + 1 + </entry><entry/><entry> + Set zoom to 1:1 + </entry></row> +<row><entry> + 2 + </entry><entry/><entry> + Set zoom to 2:1 + </entry></row> +<row><entry> + 3 + </entry><entry/><entry> + Set zoom to 3:1 + </entry></row> +<row><entry> + 4 + </entry><entry/><entry> + Set zoom to 4:1 + </entry></row> +<row><entry> + 7 + </entry><entry/><entry> + Set zoom to 1:4 + </entry></row> +<row><entry> + 8 + </entry><entry/><entry> + Set zoom to 1:3 + </entry></row> +<row><entry> + 9 + </entry><entry/><entry> + Set zoom to 1:2 + </entry></row> +<row><entry> + T + </entry><entry/><entry> + Toggle display of thumbnails when in list view. + </entry></row> +<row><entry> + Ctrl + L + </entry><entry/><entry> + Display file list as detailed list view. + </entry></row> +<row><entry> + Ctrl + I + </entry><entry/><entry> + Display file list as icon view. + </entry></row> +<row><entry> + Ctrl + T + </entry><entry/><entry> + Toggle folder display between list and tree views. + </entry></row> +<row><entry> + R + </entry><entry/><entry> + Refresh file list. + </entry></row> +<row><entry> + L + </entry><entry/><entry> + Toggle floating of file display. + </entry></row> +<row><entry> + Ctrl + H + </entry><entry/><entry> + Toggle hiding of file display. + </entry></row> +<row><entry> + Ctrl + E + </entry><entry/><entry> + Toggle EXIF sidebar. + </entry></row> +<row><entry> + Ctrl + S + </entry><entry/><entry> + Toggle Sort Manager sidebar. + </entry></row> +<row><entry> + Ctrl + K + </entry><entry/><entry> + Toggle Keywords sidebar. + </entry></row> +<row><entry> + FV + </entry><entry/><entry> + Toggle full screen. + </entry></row> +<row><entry> + I + </entry><entry/><entry> + Toggle information overlay in full screen. + </entry></row> +<row><entry> + S + </entry><entry/><entry> + Toggle slideshow. + </entry></row> +<row><entry> + P + </entry><entry/><entry> + Toggle pause of slideshow. + </entry></row> +<row><entry> + <-3 class="shortcuts-separator"> <emphasis role="strong">Help Menu</emphasis> + </entry></row> +<row><entry> + F1 + </entry><entry/><entry> + Open User Manual in browser. + </entry></row> +<row><entry> + <-3 class="shortcuts-separator"> <emphasis role="strong">Collection Window</emphasis> + </entry></row> +<row><entry> + Arrows + </entry><entry/><entry> + Move selection. + </entry></row> +<row><entry> + Shift + Arrows + </entry><entry/><entry> + Select multiple images. + </entry></row> +<row><entry> + Ctrl + Arrows + </entry><entry/><entry> + Move focus without changing selection. + </entry></row> +<row><entry> + <ulink url="/wiki/SpaceBar">SpaceBar?</ulink> + </entry><entry/><entry> + Select only image with focus. + </entry></row> +<row><entry> + Ctrl + <ulink url="/wiki/SpaceBar">SpaceBar?</ulink> + </entry><entry/><entry> + Toggle selection of image with focus. + </entry></row> +<row><entry> + Home + </entry><entry/><entry> + Move focus to first image. + </entry></row> +<row><entry> + End + </entry><entry/><entry> + Move focus to last image. + </entry></row> +<row><entry> + Ctrl + A + </entry><entry/><entry> + Select all images. + </entry></row> +<row><entry> + Ctrl + Shift + A + </entry><entry/><entry> + Unselect all images. + </entry></row> +<row><entry> + Delete + </entry><entry/><entry> + Remove selected image from collection, does not delete image from disk. + </entry></row> +<row><entry> + Ctrl + L + </entry><entry/><entry> + Add images from main window's file list. + </entry></row> +<row><entry> + Ctrl + T + </entry><entry/><entry> + Toggle display of icon filenames. + </entry></row> +<row><entry> + N + </entry><entry/><entry> + Sort collection by name. + </entry></row> +<row><entry> + D + </entry><entry/><entry> + Sort collection by file date. + </entry></row> +<row><entry> + B + </entry><entry/><entry> + Sort collection by file size. + </entry></row> +<row><entry> + P + </entry><entry/><entry> + Sort collection by file path. + </entry></row> +<row><entry> + I + </entry><entry/><entry> + Sort collection by natural numerical order. + </entry></row> +<row><entry> + Enter + </entry><entry/><entry> + View image with focus in main window. + </entry></row> +<row><entry> + V + </entry><entry/><entry> + View image with focus in new window. + </entry></row> +<row><entry> + Ctrl + 1 ... 0 + </entry><entry/><entry> + Run external edit command on selected images. + </entry></row> +<row><entry> + S + </entry><entry/><entry> + Save collection. + </entry></row> +<row><entry> + Ctrl + S + </entry><entry/><entry> + Save collection as, opens destination dialog. + </entry></row> +<row><entry> + A + </entry><entry/><entry> + Append to collection, opens append dialog. + </entry></row> +<row><entry> + Ctrl + C + </entry><entry/><entry> + Copy selected images, opens destination selection dialog. + </entry></row> +<row><entry> + Ctrl + M + </entry><entry/><entry> + Move selected images, opens destination selection dialog. + </entry></row> +<row><entry> + Ctrl + R + </entry><entry/><entry> + Rename selected images, opens rename dialog. + </entry></row> +<row><entry> + Ctrl + D + </entry><entry/><entry> + Delete selected images. + </entry></row> +<row><entry> + Ctrl + P + </entry><entry/><entry> + Open image properties window. + </entry></row> +<row><entry> + Ctrl + W + </entry><entry/><entry> + Close collection window. + </entry></row> +<row><entry> + <-3 class="shortcuts-separator"> <emphasis role="strong">Find Duplicates Window</emphasis> (same as Collection Window above, with the following additions) + </entry></row> +<row><entry> + 1 + </entry><entry/><entry> + Select group 1 duplicates. + </entry></row> +<row><entry> + 2 + </entry><entry/><entry> + Select group 2 duplicates. + </entry></row> +<row><entry> + C + </entry><entry/><entry> + Open new collection window and add selected images. + </entry></row> +</tbody></tgroup></informaltable> + <para> + (*) Note: Default Mouse wheel functions can be altered by changing the <link linkend="GuideOptionsAdvanced">Mouse wheel scrolls image?</link> option. + </para> + <para/></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideReferenceManagement.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,163 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideReferenceManagement"> + <title> + Cache and Data Maintenance + </title> + <para> + Thumbnails and other cached data can be maintained from the dialog accessible by selecting Thumbnail maintenance from the Edit menu of the main window. + </para> + <para/><section id="Geeqiethumbnailcache"><title> + Geeqie thumbnail cache + </title> + <para> + The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the <link linkend="GuideImageSearchSearch">search</link> and <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link> utilities. + </para> + <variablelist><varlistentry><term> + Clean up + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated. + </para> + <variablelist><varlistentry><term> + Clear cache + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Removes all thumbnails and data stored in the user's home folder: $HOME/.geeqie/thumbnails. + </para> + <para/></section><section id="Sharedthumbnailcache"><title> + Shared thumbnail cache + </title> + <para> + The utilities listed here operate on the shared thumbnail mechanism. + </para> + <variablelist><varlistentry><term> + Clean up + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated. + </para> + <variablelist><varlistentry><term> + Clear cache + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Removes all thumbnails stored in the user's home folder: $HOME/.thumbnails. + </para> + <para/></section><section id="Createthumbnails"><title> + Create thumbnails + </title> + <para> + This utility will render thumbnails using the current thumbnail caching mechanism, as determined in <link linkend="GuideOptionsGeneral">preferences</link>. + </para> + <variablelist><varlistentry><term> + Render + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Pre-render thumbnails for a specific folder, the utility has the following options: + </para> + <variablelist><varlistentry><term> + Include subfolders + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Enable to include all images contained in the subfolders of folder. + </para> + <variablelist><varlistentry><term> + Store thumbnails local to source images + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The generated thumbnails will be stored local to the source images, if you have the permissions to write to the folder containing the images. + </para> + <para/></section><section id="Metadata"><title> + Metadata + </title> + <para> + This utility operates on the data store for <link linkend="GuideSidebarsKeywords">keywords and comments?</link> located in the user's home folder: $HOME/.geeqie/metadata. + </para> + <variablelist><varlistentry><term> + Clean up + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + Removes keywords and comments for which the source image is no longer present. + </para> + <para/></section><section id="Filelocations"><title> + File locations + </title> + <para> + The various file locations and their use are listed below. <emphasis role="i">&lt;HOME&gt;</emphasis> refers to your home folder and <emphasis role="i">&lt;SOURCE&gt;</emphasis> refers to the folder containing the image. + </para> + <informaltable><tgroup cols="2"><tbody><row><entry> + Folder or File name + </entry><entry> + Description + </entry></row> +<row><entry> + Thumbnails + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.thumbnails + </entry><entry> + Shared thumbnail cache folder. + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie/thumbnails + </entry><entry> + Classic Geeqie thumbnail cache folder. Also used to cache data used for the search and find duplicates utilities to increase the speed for subsequent searches. + </entry></row> +<row><entry> + <emphasis role="i"><SOURCE>/.</emphasis>thumbnails + </entry><entry> + Local thumbnail cache folder. + </entry></row> +<row><entry> + Metadata (keywords and comments) + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie/metadata + </entry><entry> + Metadata stored in user's home folder. + </entry></row> +<row><entry> + <emphasis role="i"><SOURCE></emphasis>/.metadata + </entry><entry> + Metadata stored local to source image. Requires option to be enabled in advanced preferences. + </entry></row> +<row><entry> + Collections + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie/collections + </entry><entry> + Default location for Geeqie collections, collections in this folder will appear in the <link linkend="GuideSidebarsSortManager">sort manager</link> sidebar. + </entry></row> +<row><entry> + Preferences + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie + </entry><entry> + Geeqie preferences folder. + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie/geeqierc + </entry><entry> + Geeqie preferences rc file. + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie/history + </entry><entry> + Historic data such as last several folders visited, bookmarks, and recently used collections. Also contains default print settings. + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie/accels + </entry><entry> + Keyboard shortcut mapping. + </entry></row> +<row><entry> + Safe Delete + </entry></row> +<row><entry> + <emphasis role="i"><HOME></emphasis>/.geeqie/trash + </entry><entry> + Default location of the safe delete folder. + </entry></row> +</tbody></tgroup></informaltable> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideReferenceThumbnails.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideReferenceThumbnails"> + <title> + Thumbnails + </title> + <para> + Note: This page only refers the Geeqie thumbnail caching mechanism, the shared thumbnail cache mechanism is not explained here. + </para> + <para/><section id="Format"><title> + Format + </title> + <para> + Thumbnails are stored in PNG image format. The thumbnail name is the name of the source image with “.png†appended. + </para> + <para> + The modification time (mtime) of the thumbnail is set to match the source file. Thumbnails are regenerated when the timestamps of the thumbnail and source file do not match. + </para> + <para/></section><section id="Location"><title> + Location + </title> + <para> + Thumbnails are stored in: + </para> + <para> + <literal>($HOME)/.geeqie/thumbnails</literal> + </para> + <para> + The directory structure of the thumbnail cache duplicates the location of the source files, for example a source file with the name: + </para> + <para> + <literal>/path/to/image.jpg</literal> + </para> + <para> + will store the thumbnail in: + </para> + <para> + <literal>($HOME)/.geeqie/thumbnails/path/to/image.jpg.png</literal> + </para> + <para> + When thumbnails are to be stored local to the source file, the thumbnail will be placed in: + </para> + <para> + <literal>/path/to/.thumbnails/image.jpg.png</literal> + </para> + <para> + Local thumbnail caching is enabled with the option “Cache thumbnails into .thumbnails†on the <link linkend="GuideOptionsGeneral">General</link> tab of the options dialog. If it is not possible to store the thumbnail local to the source file (usually due to no write permissions), Geeqie will fall back to saving the thumbnail in the user's ($HOME)/.geeqie/thumbnails folder. + </para> + <para/></section><section id="Size"><title> + Size + </title> + <para> + Geeqie allows the following sizes for thumbnails: + </para> + <para> + 24x24, 32x32, 48x48, 64x64, 96x72, 96x96, 129x96, 128x128, 160x120, 160x160, 192x144, 192x192, 256x192, 256x256 + </para> + <para> + The thumbnail is scaled to fit within the preferred size maintaining the aspect ratio. Thumbnails are not cached for images that are equal to or smaller than the preferred thumbnail size. + </para> + <para> + When a cached thumbnail's width and height do not match the preferred size, the thumbnail is regenerated. + </para> + <para/></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideSidebars.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="utf-8"?> +<chapter id="GuideSidebars"> + <title> + Sidebars + </title> + <para> + A sidebar is a panel that appears next to an image, and displays additional information about the image. + </para> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideSidebarsInfo.xml"/> +<listitem><para> + <link linkend="GuideSidebarsExif">EXIF sidebar?</link> - FIXME: obsolete + </para></listitem><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="GuideSidebarsSortManager.xml"/> +<listitem><para> + <link linkend="GuideSidebarsKeywords">Keywords sidebar?</link> - FIXME: obsolete + </para></listitem> + <para/></chapter>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideSidebarsInfo.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideSidebarsInfo"> + <title> + Info Sidebar + </title> + <para> + The Info Sidebar shows various information about the image and can also be used for metadata editing. It consists of panes. Left-clicking on the pane title expands or collapses the pane. Right-clicking on the pane title or on empty space opens a context menu allowing you to add and remove panes, or move them up and down. + </para> + <para/><section id="Panes"><title> + Panes + </title> + <para/><section id="Histogram"><title> + Histogram + </title> + <para> + Right-click to configure + </para> + <para/></section><section id="Textpanes-TitleComment"><title> + Text panes - Title, Comment + </title> + <para> + The text is written to Xmp.dc.title and Xmp.dc.description. It can be changed in the configuration file. + </para> + <para/></section><section id="Keywords"><title> + Keywords + </title> + <para> + FIXME: put <ulink url="/wiki/keywords">keywords?</ulink> here The text is written to Xmp.dc.subject. It can be changed in the configuration file. + </para> + <para/></section><section id="Listpanes-ExifFileinfoCopyrightLocationandGPS"><title> + List panes - Exif, File info, Copyright, Location and GPS + </title> + <para> + The metadata tags are sorted into these main groups - Exif, File info, Copyright, Location and GPS, but it is just a matter of configuration. The item titles support drag and drop and can be dragged freely among these panes, it is also possible to drag new items from Advanced Exif window Right-clicking on an item opens the context menu + </para> + <para> + Add entry + </para> + <variablelist><varlistentry><term> + Key + </term><listitem><para> + Exiv2 or Geeqie (formatted...) key FIXME: list of formatted... tags. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Title + </term><listitem><para> + Title that is shown. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Show only if set + </term><listitem><para> + Show only if the tag exists in the file. + </para></listitem></varlistentry></variablelist> + <variablelist><varlistentry><term> + Editable + </term><listitem><para> + Displays the value as editable. + </para></listitem></varlistentry></variablelist> + <para> + Note: Geeqie internally converts Exif and IPTC metadata to XMP on read and back on write, thus any changes made to Exif and IPTC here will be lost on write. Edit the corresponding XMP instead. An exception are Makernote tags which don't have an equivalent in XMP, but there is another limitation in that Makernote can't be written to an external file (sidecar or Geeqie private file). + </para> + <para> + Show hidden + </para> + <blockquote> + <para> + Shows all entries regardless of "Show only if set". + </para> + </blockquote> + <para/></section><section id="GPSMap"><title> + GPS Map + </title> + <para> + Geeqie must be built with libchamplain. + </para> + <para/></section></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook/GuideSidebarsSortManager.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,108 @@ +<?xml version="1.0" encoding="utf-8"?> +<section id="GuideSidebarsSortManager"> + <title> + Sort Manager Sidebar + </title> + <para> + The Sort Manager sidebar provides a convenient method to quickly sort many files into a set of folders or collections. + </para> + <para> + To toggle display of the Sort Manager press Ctrl + S or select “Sort manager†from the View menu. + </para> + <para> + The mode of the Sort Manager is selected by the drop down list under the sidebar title. The Folder mode allows moving or copying the visible image to a folder, and the Collection mode allows adding the visible image or file selection to a collection. + </para> + <para/><section id="Folderview"><title> + Folder view + </title> + <para> + The Sort Manager folder view consists of a vertical list for bookmarking folders, a section to select the operation to perform, and a set of buttons along the bottom. + </para> + <para> + Clicking or activating an item in the list will copy, move, or link the active image's file to that location. The active image will then change to the next image. + </para> + <para/><section id="Bookmarklist"><title> + Bookmark list + </title> + <para> + This is a list of possible folders to use as a destination for the selected operation. A context menu will appear by right clicking on an item, or pressing the menu key when the item has the focus. + </para> + <para> + Folders can be added to the list by activating the Add button at the bottom of the sidebar, or dragging a folder onto the list. + </para> + <para> + To edit an item select “Properties†from it's context menu. A dialog will appear allowing the Name, Path, and Icon for the item to be changed. Select OK to close the dialog and apply the changes, or Cancel to close the dialog and discard the changes. + </para> + <para> + To change the order of the list, select “Move up†or “Move down†from the item's context menu. To move an item with the keyboard move the focus to that item, then press Shift + Up or Shift + Down to move the item. + </para> + <para> + To remove an item from the list select “Remove†from it's context menu. + </para> + <para/></section><section id="CopyMoveandLink"><title> + Copy, Move, and Link + </title> + <para> + These are the available operations to use on the active image, they should be self explanatory. + </para> + <para/></section><section id="Addbutton"><title> + Add button + </title> + <para> + Activate this button to add a folder to the bookmark list. A dialog will appear to allow selection of the folder to use for the new item. + </para> + <para/></section><section id="Undobutton"><title> + Undo button + </title> + <para> + Activate this button to undo the last copy, move, or link operation. The undo function can only reverse the most recent operation. + </para> + <para/></section></section><section id="Collectionview"><title> + Collection view + </title> + <para> + The Sort Manager collection view consists of a vertical list of collection, a section to determine the current selection, and a set of buttons along the bottom. + </para> + <para> + Clicking or activating an item in the list will add the selected image to that collection. + </para> + <para/><section id="Collectionlist"><title> + Collection list + </title> + <para> + This is the list of collections located in the folder $HOME/.geeqie/collections. Activating a member of this list will result in the current image selection to be added to the collection. If the image already exists within the collection, it will not be added a second time. + </para> + <para> + A new empty collection can be added to the list by activating the Add button at the bottom of the sidebar. + </para> + <para/></section><section id="Choosingtheselectionstyle"><title> + Choosing the selection style + </title> + <para> + The images to add when activating a collection is determined by the selection style: + </para> + <variablelist><varlistentry><term> + Add image + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + The visible image is added to the collection. + </para> + <variablelist><varlistentry><term> + Add selection + </term><listitem><para/></listitem></varlistentry></variablelist> + <para> + All images selected in the file list will be added to the collection. + </para> + <para/></section><section id="Addbutton1"><title> + Add button + </title> + <para> + Activate this button to add a new empty collection to the visible list. A dialog will appear to allow entry of the name to use for the new collection. + </para> + <para/></section><section id="Undobutton1"><title> + Undo button + </title> + <para> + Activate this button to undo the last add operation. The undo function can only reverse the most recent operation. + </para> + <para/></section></section></section>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/docbook2html.sh Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,7 @@ +#!/bin/sh + +mkdir html +#xsltproc --xinclude -o index.html /usr/share/xml/docbook/stylesheet/nwalsh/current/html/docbook.xsl docbook/GuideIndex.xml + +# this requires gnome-doc-utils package +xsltproc --xinclude -o html/GuideIndex.html /usr/share/xml/gnome/xslt/docbook/html/db2html.xsl docbook/GuideIndex.xml \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/download.sh Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,14 @@ +#!/bin/sh + +unset LANG +PAGES=`curl "http://sourceforge.net/apps/trac/geeqie/wiki/TitleIndex" | \ + sed -e "s|>|>\n|g" |grep 'href=.*/geeqie/wiki/Guide'|sed -e 's|.*/wiki/Guide\([a-zA-Z0-9]*\).*|Guide\1|'` + +mkdir wiki + +for p in $PAGES ; do + curl "http://sourceforge.net/apps/trac/geeqie/wiki/$p?format=txt" > wiki/$p +done + + + \ No newline at end of file
--- a/doc/faq.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,106 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Frequently Asked Questions - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="index.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Frequently Asked Questions</p> - </th> - - <th> - <p class="next"><a href="introduction.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Frequently Asked Questions</h1> - - <h2 class="faq">Image viewing</h2> - - <h3 class="faq">How do I keep images smaller than the visible area from enlarging when the zoom is set to “fit to window” ?</h3> - - <p>In the preferences dialog, under the “Image” tab, disable “Allow enlargement of image for zoom to fit”.</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 “-r” command line option to send commands to an existing Geeqie, for a list of commands supported by the remote switch run:</p> - -<pre><code>geeqie --remote-help</code></pre> - - <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><code>geeqie -r -d12 -ss</code></pre> - - <p class="note"><span class="note_label">Note that if geeqie is running prior to this command, the slide show should also be stopped prior to changing the delay:</span></p> - -<pre><code>geeqie -r -sS -d12 -ss</code></pre> - - - <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> - - <hr /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="index.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="introduction.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/gnu_fdl.txt Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,397 +0,0 @@ - GNU Free Documentation License - Version 1.2, November 2002 - - - Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - -0. PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document "free" in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. - -This License is a kind of "copyleft", which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - - -1. APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The "Document", below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as "you". You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. - -A "Modified Version" of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A "Secondary Section" is a named appendix or a front-matter section of -the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall subject -(or to related matters) and contains nothing that could fall directly -within that overall subject. (Thus, if the Document is in part a -textbook of mathematics, a Secondary Section may not explain any -mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The "Invariant Sections" are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. - -The "Cover Texts" are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. - -A "Transparent" copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not "Transparent" is called "Opaque". - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, LaTeX input format, SGML -or XML using a publicly available DTD, and standard-conforming simple -HTML, PostScript or PDF designed for human modification. Examples of -transparent image formats include PNG, XCF and JPG. Opaque formats -include proprietary formats that can be read and edited only by -proprietary word processors, SGML or XML for which the DTD and/or -processing tools are not generally available, and the -machine-generated HTML, PostScript or PDF produced by some word -processors for output purposes only. - -The "Title Page" means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, "Title Page" means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - -A section "Entitled XYZ" means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as "Acknowledgements", -"Dedications", "Endorsements", or "History".) To "Preserve the Title" -of such a section when you modify the Document means that it remains a -section "Entitled XYZ" according to this definition. - -The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. - - -2. VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - - -3. COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. - - -4. MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -A. Use in the Title Page (and on the covers, if any) a title distinct - from that of the Document, and from those of previous versions - (which should, if there were any, be listed in the History section - of the Document). You may use the same title as a previous version - if the original publisher of that version gives permission. -B. List on the Title Page, as authors, one or more persons or entities - responsible for authorship of the modifications in the Modified - Version, together with at least five of the principal authors of the - Document (all of its principal authors, if it has fewer than five), - unless they release you from this requirement. -C. State on the Title page the name of the publisher of the - Modified Version, as the publisher. -D. Preserve all the copyright notices of the Document. -E. Add an appropriate copyright notice for your modifications - adjacent to the other copyright notices. -F. Include, immediately after the copyright notices, a license notice - giving the public permission to use the Modified Version under the - terms of this License, in the form shown in the Addendum below. -G. Preserve in that license notice the full lists of Invariant Sections - and required Cover Texts given in the Document's license notice. -H. Include an unaltered copy of this License. -I. Preserve the section Entitled "History", Preserve its Title, and add - to it an item stating at least the title, year, new authors, and - publisher of the Modified Version as given on the Title Page. If - there is no section Entitled "History" in the Document, create one - stating the title, year, authors, and publisher of the Document as - given on its Title Page, then add an item describing the Modified - Version as stated in the previous sentence. -J. Preserve the network location, if any, given in the Document for - public access to a Transparent copy of the Document, and likewise - the network locations given in the Document for previous versions - it was based on. These may be placed in the "History" section. - You may omit a network location for a work that was published at - least four years before the Document itself, or if the original - publisher of the version it refers to gives permission. -K. For any section Entitled "Acknowledgements" or "Dedications", - Preserve the Title of the section, and preserve in the section all - the substance and tone of each of the contributor acknowledgements - and/or dedications given therein. -L. Preserve all the Invariant Sections of the Document, - unaltered in their text and in their titles. Section numbers - or the equivalent are not considered part of the section titles. -M. Delete any section Entitled "Endorsements". Such a section - may not be included in the Modified Version. -N. Do not retitle any existing section to be Entitled "Endorsements" - or to conflict in title with any Invariant Section. -O. Preserve any Warranty Disclaimers. - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled "Endorsements", provided it contains -nothing but endorsements of your Modified Version by various -parties--for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - - -5. COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections Entitled "History" -in the various original documents, forming one section Entitled -"History"; likewise combine any sections Entitled "Acknowledgements", -and any sections Entitled "Dedications". You must delete all sections -Entitled "Endorsements". - - -6. COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. - -You may extract a single document from such a collection, and distribute -it individually under this License, provided you insert a copy of this -License into the extracted document, and follow this License in all -other respects regarding verbatim copying of that document. - - -7. AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an "aggregate" if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. - - -8. TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. - -If a section in the Document is Entitled "Acknowledgements", -"Dedications", or "History", the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. - - -9. TERMINATION - -You may not copy, modify, sublicense, or distribute the Document except -as expressly provided for under this License. Any other attempt to -copy, modify, sublicense or distribute the Document is void, and will -automatically terminate your rights under this License. However, -parties who have received copies, or rights, from you under this -License will not have their licenses terminated so long as such -parties remain in full compliance. - - -10. FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions -of the GNU Free Documentation License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. See -http://www.gnu.org/copyleft/. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License "or any later version" applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. - - -ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - - Copyright (c) YEAR YOUR NAME. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.2 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. - A copy of the license is included in the section entitled "GNU - Free Documentation License". - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the "with...Texts." line with this: - - with the Invariant Sections being LIST THEIR TITLES, with the - Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software.
--- a/doc/image_management.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,86 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Image Management - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="other_windows_pan_view.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Image Management</p> - </th> - - <th> - <p class="next"><a href="image_management_copy_move.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Image Management</h1> - - <p>Geeqie includes a set of utilities to copy, move, rename, and delete images.</p> - - <div class="submenu"> - <ul> - <li><a href="image_management_copy_move.html">Copy and Move</a></li> - <li><a href="image_management_rename.html">Rename</a></li> - <li><a href="image_management_delete.html">Delete</a></li> - <li><a href="image_management_external_editing.html">External Editing</a></li> - </ul> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="other_windows_pan_view.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_management_copy_move.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_management_copy_move.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,127 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Copy and Move - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Copy and Move – Image Management</p> - </th> - - <th> - <p class="next"><a href="image_management_rename.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Copy and Move</h1> - - <p>To copy an file in Geeqie press <span class="key">Ctrl</span> + <span class="key">C</span>, to move an file press <span class="key">Ctrl</span> + <span class="key">M</span>. These operations also appear under File in the main menu, and in the context menu of all images and files.</p> - - <p>The Copy and Move operations and dialogs behave the same in Geeqie, with the only difference being the final result. The remaining text of this page applies equally to the Copy and Move operations, for the remainder of this page these will be referred to as a Copy/Move operation.</p> - - <p>Initiating a Copy/Move operation will display a dialog to select the destination folder to Copy/Move the selected file, after the destination folder is selected Geeqie will proceed to Copy/Move the images to the destination. If an error occurs or a file exists with the same name as one of the files being Copy/Moved, a dialog will appear prompting how to handle the situation.</p> - - <h2>The Copy/Move dialog</h2> - - <p>This is the dialog that is displayed when initiating a Copy/Move operation. The dialog contains a row of buttons near the top, vertical list of bookmarks along the left side, a vertical list of folders in the current path, a text entry field, and a row of buttons along the bottom.</p> - - <dl class="dialog_desc"> - <dt>Home button</dt><dd>Activate this button to change the active path to your home folder.</dd> - - <dt>New Folder button</dt><dd>Activate this to create a new empty folder as a sub folder of the active path. The new folder will appear in the folder list ready for you to type in the desired name.</dd> - - <dt>Show Hidden check box</dt><dd>Enabling this check box will cause hidden folders to appear in the folder list.</dd> - - <dt>Bookmark list</dt><dd>This list on the left side of the window allows you to save links to folders that are frequently used. Activating a bookmark will change the active path to that pointed to by the link. To add items to the bookmark list highlight a folder and press <span class="key">Ctrl</span> + <span class="key">B</span>, select “Add bookmark” from the folder's context menu, or drag a folder onto the bookmark list.<br />The bookmark has a context menu that can be displayed by clicking the right mouse button, or pressing the Menu key when a bookmark has the focus. From the context menu you can edit a bookmark, move it up or down in the list, or remove the bookmark from the list. A bookmark can also be moved by pressing <span class="key">Shift</span> + <span class="key">Up</span> or <span class="key">Shift</span> + <span class="key">Down</span> while it has the focus.</dd> - - <dt>Folder list</dt><dd>This is the list that displays the folders contained in the active path. To change the active path to a folder displayed in this list double click the primary mouse button or highlight the folder with the keyboard and press <span class="key">Enter</span> or <span class="key">Spacebar</span>. This list has a context menu that allows renaming or bookmarking the selected folder. A folder can also be dragged onto the bookmark list to add a bookmark.</dd> - - <dt>Path entry</dt><dd>This text entry displays the active path of the dialog. The path can be directly edited using this entry. Tab completion is supported, and the drop down arrow will display a list of recently selected folders.</dd> - - <dt>Copy/Move button</dt><dd>The name of this button will differ depending on the selected operation, activating it will start the operation with the folder displayed in the path entry as the destination.</dd> - - <dt>Cancel button</dt><dd>Activate this button to close the dialog, the operation will be aborted.</dd> - </dl> - - <h2>The error dialog</h2> - - <p>If a problem occurs because Geeqie is unable to Copy or Move a selected file a dialog will appear to notify the user. The dialog will also ask if the operation should continue if one or more files remain to be Copied or Moved.</p> - - <h2>The overwrite dialog</h2> - - <p>If a file with the same name exists in the selected destination a dialog will appear to notify the user and ask how to resolve the conflict. The dialog will also display the source and destination images. The following possible solutions will be offered:</p> - - <dl class="dialog_desc"> - <dt>Auto rename</dt><dd>Enabling this check box to have Geeqie select a unique name for the destination file, the proposed new name will appear in the rename entry field.</dd> - - <dt>Rename</dt><dd>Enable this check box to manually enter a new name for the file.</dd> - - <dt>Overwrite</dt><dd>Activate this will overwrite the existing file, or rename it if one of the rename check boxes are enabled.</dd> - - <dt>Overwrite all</dt><dd>Activating this will perform the same operation as the Yes button, however any further file name conflicts will be handled quietly in the same method as is selected for the current file.</dd> - - <dt>Skip</dt><dd>This button will skip doing anything to the file in question, and resume the operation with the next file. The source file will remain untouched.</dd> - - <dt>Skip All</dt><dd>This will perform the same as the Skip button, however any further file name conflicts will be quietly ignored for all remaining files.</dd> - - <dt>Cancel</dt><dd>This will close the dialog and stop the operation, all remaining files will be ignored.</dd> - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_management_rename.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_management_delete.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,114 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Delete - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_rename.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Delete – Image Management</p> - </th> - - <th> - <p class="next"><a href="image_management_external_editing.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Delete</h1> - - <p>To delete a file in Geeqie press <span class="key">Ctrl</span> + <span class="key">D</span>, or select Delete from the file menu. Delete is also available in the context menu of all images and files. If <a href="options_advanced.html" class="option_name">Enable delete key</a> is enabled in Options, pressing the <span class="key">Delete</span> key can also be used to delete files.</p> - - <p>The behavior when starting a delete operation depends on the <a href="options_advanced.html" class="option_name">Confirm file delete</a> option in Options. If the option is enabled a dialog will appear to confirm the operation, if it is not enabled the files will be deleted without further interaction. In all cases if the file is unable to be deleted you will be notified by a dialog.</p> - - <h2>Confirm delete dialog</h2> - - <p>The dialog that appears when delete confirmation is enabled will show the file or files to be deleted. To delete the file press <span class="key">Enter</span> or activate the Delete button. Pressing <span class="key">Escape</span> or activating the Cancel button will close the dialog and abort the operation.</p> - - <p>When deleting multiple files, the dialog will include two arrow buttons to step the image preview through the list of files to be deleted. Initially the preview will be blank, activate the right arrow to display the first file.</p> - - <p>The dialog will also display the status of the <a href="options_advanced.html" class="option_name">Safe Delete</a> feature. Use this to determine if a file to be deleted will be immediately lost, or if the file can possibly be recovered from the Safe Delete folder.</p> - - <p>If a file is unable to be deleted, a dialog will appear to notify you. If multiple files were selected and any remain, the dialog will include a Continue button, activating this button or pressing <span class="key">Enter</span> will delete the remaining files. Pressing <span class="key">Escape</span> or activating the Cancel button will close the dialog and the remaining files will not be deleted.</p> - - <h2>Safe Delete</h2> - - <p>Geeqie includes a feature to temporarily store deleted files in a selected folder, to use this feature enable <a href="options_advanced.html" class="option_name">Safe Delete</a> on the advanced tab of the preferences dialog.</p> - - <p>Safe Delete includes these options:</p> - - <dl class="dialog_desc"> - <dt>Folder</dt> - <dd><p>The folder to use for temporarily retaining deleted files.</p></dd> - - <dt>Maximum size</dt> - <dd><p>The maximum amount of disk space to use when storing deleted files, in megabytes.</p> - - <p>When the total size of the deleted files stored in the Safe Delete folder exceeds the Maximum size, the oldest files are removed from the folder to make space for the new deleted files.</p> - </dd> - </dl> - - <p>Files moved to the Safe Delete folder are prefixed with a six digit number in the format: - <code>nnnnnn_FILENAME</code> - </p> - - <p>This is used to distinguish which files to remove first when clearing space for new files. The digit counter increments with each deleted file.</p> - - <p>To clear the contents of the Safe Delete folder, activate the Clear button provided for this purpose on the <a href="options_advanced.html">Advanced tab</a> in Options.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_rename.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_management_external_editing.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_management_external_editing.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,91 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>External Editing - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_delete.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">External Editing – Image Management</p> - </th> - - <th> - <p class="next"><a href="image_search.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>External Editing</h1> - - <p>Geeqie provides the ability to execute commands, such as running an image editor, on a selected image. In Geeqie these are called the external editing commands.</p> - - <p>These commands are executed by pressing <span class="key">Ctrl</span> and a number key, from the Edit menu, or from the context menu available to all images and files. The keyboards shortcuts are <span class="key">Ctrl</span> + <span class="key">1</span> through <span class="key">Ctrl</span> + <span class="key">9</span>, and <span class="key">Ctrl</span> + <span class="key">0</span>, they correspond respectively to commands 1 through 10 on the <a href="options_editor_commands.html">Editors tab</a> in Options.</p> - - <p>To edit the command list refer to section <a href="options_editor_commands.html">Editor Commands</a>.</p> - - <h2>Result dialog</h2> - - <p>Commands that are set to display the command's output in a window will show a dialog when the command is executed.</p> - - <p>To specify a command to show a dialog begin the command with the %V or %v macros, details for these an all macros are listed on the <a href="options_editor_commands.html">Editors tab</a> in Options.</p> - - <p>The result dialog will display the command's text output. If the editor command will result in multiple runs of the same command for each file, the Stop button will be enabled, activate it to stop Geeqie from executing the command for remaining files.</p> - - <p>Once all commands have completed or if the Stop button was activated and the pending command has completed, the Close button will be enabled, activate it or press <span class="key">Escape</span> to close the result dialog. The result dialog can not be closed while a command is still running.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_delete.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_search.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_management_rename.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,115 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Rename - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_copy_move.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Rename – Image Management</p> - </th> - - <th> - <p class="next"><a href="image_management_delete.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Rename</h1> - - <p>To rename a file in Geeqie press <span class="key">Ctrl</span> + <span class="key">R</span>, or select Rename from the File menu. Rename is also available in the context menu of all images and files.</p> - - <p>When renaming a file, a dialog will display allowing entry of the new name for the file. The dialog will be different depending on the number of files selected to be renamed. A simple dialog will appear when renaming a single file, however when renaming multiple files the dialog will include a list of the file to be renamed and additional options.</p> - - <h2>Rename single file dialog</h2> - - <p>The dialog that appears when renaming a single file includes an image of the file, an entry to type the new name of the file, a Rename button, and a Cancel button. Type the new name into the text entry and press <span class="key">Enter</span> or activate the Rename button to rename the file. Press <span class="key">Escape</span> or activate the Cancel button to close the dialog and abort renaming the file.</p> - - <p>When renaming a file and the new name already exists on the file system a dialog will appear showing the renamed and existing files. To overwrite the existing file press <span class="key">Enter</span> or activate the Overwrite button. Press <span class="key">Escape</span> or activate the Cancel button to close the dialog abort renaming the file.</p> - - <h2>Rename multiple files dialog</h2> - - <p>The dialog that appears when renaming multiple files includes the list of files to be renamed, a preview image of the active file, an entry to enter the new file name, an auto rename check box, a Rename button, and a Cancel button.</p> - - <dl class="dialog_desc"> - <dt>Manually enter new file names</dt> - <dd> - <p>To manually enter the new name of each file, the active file will be displayed in the image preview and it's original name will be displayed above the text entry. To rename the file type the new name and press <span class="key">Enter</span> or activate the Rename button. When a file is successfully renamed it will be removed from the list and the next one will become the active file. After all files have been renamed, the dialog will close.</p> - - <p>Files do not have to be renamed in the order that they appear in the list, highlighting a name in the list will make it become the active file.</p> - - <p>When renaming a file and the new name already exists on the file system a dialog will appear showing the renamed and existing files. To overwrite the existing file press <span class="key">Enter</span> or activate the Overwrite button. Press <span class="key">Escape</span> or activate the Cancel button to return to the original rename dialog, the file that prompted the overwrite dialog will remain active.</p> - </dd> - - <dt>Automatic renaming of multiple files</dt> - <dd> - <p>To automatically rename the files in the list, enable the Auto rename check box. The dialog will change to batch mode for numerical naming of files.</p> - - <p>The file name list will change to include a preview column that will show the resulting name of each file. The text entry will change to three entries; the first represents the text that appears in the new names before the number, the second will be the start number to use when incrementing the file number, and the third represents the text to append to the name after the number. The end text should include the file name extension, therefore batch renaming multiple types of files (those with different extensions) all at once is not recommended.</p> - - <p>The padding number can be used to change the minimum length of characters to use for the number portion of the new name. When the file number results in fewer characters than the padding size, the result will be padded with leading zeros to fill the remaining space. For example if padding size is 3, a file with the number 24 will appear in the file name as “024”.</p> - - <p>The order of the file list can be changed by dragging a name to the desired location within the list. The preview column will update to reflect the new order.</p> - - <p>When the preview of new names is satisfactory, press <span class="key">Enter</span> or activate the Rename button to rename the files to match the name in the preview column. Press <span class="key">Escape</span> or activate the Cancel button to close the dialog and abort the rename operation.</p> - - <p>If the resulting new names match any existing files, a warning dialog will notify you. The rename dialog will remain so that you can select a different set of names.</p> - </dd> - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_copy_move.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_management_delete.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_presentation.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,84 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Image Presentation - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars_keywords.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Image Presentation</p> - </th> - - <th> - <p class="next"><a href="image_presentation_slideshow.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Image Presentation</h1> - - <p>Geeqie can be used to display a set of images, showing each image for a period of time before changing to the next image. Images can also be set to fill the entire screen.</p> - - <div class="submenu"> - <ul> - <li><a href="image_presentation_slideshow.html">Slide show</a></li> - <li><a href="image_presentation_fullscreen.html">Full screen</a></li> - </ul> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars_keywords.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_presentation_slideshow.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_presentation_fullscreen.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,440 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Full Screen - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_presentation_slideshow.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Full Screen – Image Presentation</p> - </th> - - <th> - <p class="next"><a href="printing.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Full Screen</h1> - - <p>Geeqie allows for the image pane to be expanded to fill the entire screen, this is referred to as full screen.</p> - - <h2>Turning on full screen</h2> - - <p>Full screen can be activated in a number of ways:</p> - - <ul> - <li> - <p>From the menu bar - open the <b>View</b> menu and select <b>Full screen</b>.</p> - </li> - - <li> - <p>From the keyboard - press the <span class="key">F</span> key to toggle full screen.</p> - </li> - - <li> - <p>From a context menu - right click an image pane, and select <b>Full screen</b>.</p> - </li> - </ul> - - <h2>Turning off full screen</h2> - - <p>To return to the normal view:</p> - - <ul> - <li> - <p>From the keyboard - press the <span class="key">F</span> or <span class="key">Esc</span> key to stop full screen.</p> - </li> - - <li> - <p>From a context menu - right click the image pane, and select <b>Exit full screen</b>.</p> - </li> - - <li> - <p>From the menu bar - the menu bar may be visible when using multiple monitors, open the <b>View</b> menu and select <b>Full screen</b>.</p> - </li> - </ul> - - <h2>Configuring full screen</h2> - - <p>Full screen behavior and location can be adjusted on the <a href="options_advanced.html">Advanced tab</a> of the preferences dialog.</p> - - <dl class="dialog_desc"> - <dt>Size and location</dt> - <dd><p>This can be changed using <span class="option_name">Full screen size</span> option, this can be used to select the monitor to use in a multiple monitor configuration.</p></dd> - - <dt>Smooth image flip in full screen</dt> - <dd><p>This option delays the image change until the next image is entirely decoded into memory, the result is a smoother transition between images.</p></dd> - - <dt>Disable screen saver in full screen</dt> - <dd><p>This option will execute <i>xscreensaver-command --deactivate</i> once per minute to avoid the screen saver from activating.</p></dd> - </dl> - - <h2>Navigation</h2> - - <p>The usual image navigation controls are available when in full screen, these are the commands available:</p> - - <div class="shortcuts"> - <table width="80%" border="1" cellpadding="4" cellspacing="0"> - <col id="fullscreen_shortcuts_col1" width="33%"></col> - <col id="fullscreen_shortcuts_col2" width="33%"></col> - <col id="fullscreen_shortcuts_col3" width="33%"></col> - - <thead> - <tr> - <td> - <p>Keyboard</p> - </td> - - <td> - <p>Mouse</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - - <tbody> - <tr> - <td> - <p><span class="key">F</span>, <span class="key">V</span>, <span class="key">Esc</span></p> - </td> - - <td> - <p>Context menu</p> - </td> - - <td> - <p>Turn off full screen.</p> - </td> - </tr> - - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Image Navigation</strong></p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">PageDown</span></p> - </td> - - <td> - <p>Left Click on image view<br /> - Mouse Wheel down <a href="#bottomnote1" class="bottomnote">(*)</a></p> - </td> - - <td> - <p>Change to next image.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">PageUp</span></p> - </td> - - <td> - <p>Middle Click on image view<br /> - Mouse Wheel up <a href="#bottomnote1" class="bottomnote">(*)</a></p> - </td> - - <td> - <p>Change to previous image.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Home</span></p> - </td> - - <td> </td> - - <td> - <p>Change to first image.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">End</span></p> - </td> - - <td> </td> - - <td> - <p>Change to last image.</p> - </td> - </tr> - - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Image panning</strong> (image has keyboard focus)</p> - </td> - </tr> - - <tr> - <td> - <p>Arrows</p> - </td> - - <td> - <p>Left Drag on image view<br /> - <span class="key">Shift</span> + Mouse Wheel <a href="#bottomnote1" class="bottomnote">(*)</a></p> - </td> - - <td> - <p>Pan image.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">Arrows</span></p> - </td> - - <td> </td> - - <td> - <p>Pan Image faster.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Arrows</span></p> - </td> - - <td> </td> - - <td> - <p>Pan to respective edge of image.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">SpaceBar</span></p> - </td> - - <td> </td> - - <td> - <p>Change to next image.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Backspace</span></p> - </td> - - <td> </td> - - <td> - <p>Change to previous image.</p> - </td> - </tr> - </tbody> - </table> - </div> - - <p>Several other standard controls are also available through the keyboard and context menu:</p> - - <div class="fullscreen-functions"> - <table width="80%" border="1" cellpadding="4" cellspacing="0" rules="rows"> - <col id="fullscreen_functions_col1" width="50%"></col> - <col id="fullscreen_functions_col2" width="50%"></col> - - <thead> - <tr> - <td> - <p>Function</p> - </td> - - <td> - <p>Difference from normal view</p> - </td> - </tr> - </thead> - - <tbody> - <tr> - <td> - <p>Copy, Move, Rename</p> - </td> - - <td> - <p>same</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Delete</span></p> - </td> - - <td> - <p>same</p> - </td> - </tr> - - <tr> - <td> - <p>External edit commands<br /> - (<span class="key">Ctrl</span> + <span class="key">1</span> ... <span class="key">0</span>, context menu)</p> - </td> - - <td> - <p>Full screen will turn off prior to activating the function.</p> - </td> - </tr> - - <tr> - <td> - <p>Open image properties window<br /> - (<span class="key">Ctrl</span> + <span class="key">P</span>, context menu)</p> - </td> - - <td> - <p>same</p> - </td> - </tr> - - <tr> - <td> - <p>Image rotation, mirror, and flip</p> - </td> - - <td> - <p>same</p> - </td> - </tr> - - <tr> - <td> - <p>Zoom controls</p> - </td> - - <td> - <p>same</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">I</span></p> - </td> - - <td> - <p>Toggle information overlay for full screen: on with histogram, on without histogram, off.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">K</span></p> - </td> - - <td> - <p>Switch between the different histogram modes: RGB, value, maximum value, red channel, green channel, blue channel.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">J</span></p> - </td> - - <td> - <p>Toogle between linear and logarithmical histogram.</p> - </td> - </tr> - - <tr> - <td> - <p>Slide show controls<br /> - (<span class="key">S</span>, <span class="key">P</span>, context menu)</p> - </td> - - <td> - <p>same</p> - </td> - </tr> - - <tr> - <td> - <p>Quit with <span class="key">Ctrl</span> + <span class="key">Q</span></p> - </td> - - <td> - <p>same</p> - </td> - </tr> - </tbody> - </table> - </div> - - <p class="bottomnote"><a id="bottomnote1" name="bottomnote1"></a><span class="note_label">(*) Note:</span> Default Mouse wheel functions can be altered by changing the <a href="options_advanced.html" class="option_name">Mouse wheel scrolls image</a> option.</p> - - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_presentation_slideshow.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="printing.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_presentation_slideshow.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,164 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Slide Show - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_presentation.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Slide Show – Image Presentation</p> - </th> - - <th> - <p class="next"><a href="image_presentation_fullscreen.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Slide Show</h1> - - <p>The image pane can be set to automatically change the displayed image after a period of time, in Geeqie this is referred to as a slide show.</p> - - <h2>Starting a slide show</h2> - - <p>A slide show can be started in a number of ways:</p> - - <ul> - <li> - <p>From the menu bar - open the <b>View</b> menu and select <b>Toggle slide show</b> to toggle the slide show on or off .</p> - </li> - - <li> - <p>From the keyboard - press the <span class="key">S</span> key to toggle the slide show on or off.</p> - </li> - - <li> - <p>From a context menu - right click an image pane, and select <b>Start slide show</b>, or <b>Stop slide show</b>; the text will change depending on the state of the current slide show.</p> - </li> - </ul> - - <h2>Stopping a slide show</h2> - - <p>An active slide show can be stopped by using the same functions available to start one, as they work like a toggle switch. If slide show repeat is not enabled in the <a href="options_general.html">options dialog</a>, the slide show will stop when the last image in the sequence is displayed.</p> - - <p>Any action that changes the image pane to a new image will stop the active slide show, with the exception of the methods discussed in <a href="#navigation">Slide show sequence navigation</a>.</p> - - <h2>Slide show status</h2> - - <p>The main window <a href="main_window_status_bar.html">status bar</a> can be used to determine when a slide show is active, <b>Slide show</b> will be displayed next to the file count field. An individual <a href="other_windows_image_window.html">Image Window</a> can also display a slide show, however the status will not be immediately visible. To determine the slide show status in an image window, open a context menu by right clicking or using the menu key, the slide show menu item will reflect the slide show status; if <b>Start slide show</b> is displayed, no slide show is active, conversely if <b>Stop slide show</b> is displayed a slide show is active.</p> - - <p>When a Slide show is paused, the main window status bar will display <b>Paused</b> instead of <b>Slide show</b>. Likewise, the image context menu will display <b>Pause slide show</b> or <b>Continue slide show</b>, depending on the current state.</p> - - <h2>Pausing a slide show</h2> - - <p>An active slide show can be paused in two ways:</p> - - <ul> - <li> - <p>From the keyboard - press the <span class="key">P</span> key while a slide show is active.</p> - </li> - - <li> - <p>From a context menu - right click the image pane displaying the slide show, and select <b>Pause slide show</b>, or <b>Continue slide show</b> depending on the current slide show state.</p> - </li> - </ul> - - <h2>Selecting the images to include in a slide show</h2> - - <p>When a single image is selected, all images in the current folder are included in the slide show. The sequence will begin with the current image; however if random slide shows are enabled, the sequence will begin with a random image from the list.</p> - - <p>To only include some images in a slide show, use multiple selection to select the images to include before starting the slide show.</p> - - <p>An image collection can be used as the list of images, to do this drag an image from a collection window onto the image pane. Starting a slide show will then include the images from that collection.</p> - - <p>So far, the methods described are for slide shows in a main window, in an <a href="other_windows_image_window.html">Image Window</a>, the slide show will use all images referenced by that window.</p> - - <h2>Recursive slide show</h2> - - <p>In the main window, a recursive slide show can be started from a folder's context menu; the folder's right click menu will include two slide show options:</p> - - <ul> - <li> - <p>Slide show: This will start a slide show that includes all images in the selected folder.</p> - </li> - - <li> - <p>Slide show recursive: The slide show will include all images in the selected folder, and all images in the folders that are contained within the selected folder.</p> - </li> - </ul> - - <h2><a name="navigation" id="navigation"></a>Slide show sequence navigation</h2> - - <p>When a slide show is active, functions that normally change the image forward and backward can be used to step through those contained in the slide show.</p> - - <h2>Configuring a slide show</h2> - - <p>The options that control the behavior of slide shows are located on the <a href="options_general.html">General tab</a> of the options dialog.</p> - - <dl class="dialog_desc"> - <dt>Display time</dt> - <dd><p>The delay between each image in the slide show can be adjusted with the <span class="option_name">Delay before image change</span> option.</p></dd> - - <dt>Repeat</dt> - <dd><p>This will cause the slide show to loop indefinitely, it will continue with the first image after displaying the last image in the slide show list.</p></dd> - - <dt>Random</dt> - <dd><p>This will display images randomly selected from the slide show list. Each image from the slide show list will be displayed once. When Repeat is also enabled, the random sequence is changed after each complete cycle of the images.</p></dd> - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_presentation.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_presentation_fullscreen.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_search.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,84 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Image Search - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_external_editing.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Image Search</p> - </th> - - <th> - <p class="next"><a href="image_search_search.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Image Search</h1> - - <p>Geeqie provides methods to find an image, and the ability to find duplicate images.</p> - - <div class="submenu"> - <ul> - <li><a href="image_search_search.html">Search Window</a></li> - <li><a href="image_search_finding_duplicates.html">Finding Duplicates</a></li> - </ul> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_management_external_editing.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_search_search.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_search_finding_duplicates.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,452 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Finding Duplicates - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_search_search.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Finding Duplicates – Image Search</p> - </th> - - <th> - <p class="next"><a href="collections.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Finding Duplicates</h1> - - <p>Geeqie provides a utility to find images that have similar attributes or content.</p> - - <p>To display a new Find Duplicates Window press D or select Find duplicates from the File menu.</p> - - <h2>Adding files to be compared</h2> - - <p>Add files to be compared using drag and drop. Drop files or folders onto the Find Duplicates window to add them to the list of files to compare. When one or more folders are dropped onto the window a menu will appear allowing you to choose the desired action:</p> - - <dl class="menu_desc"> - <dt>Add contents</dt> - <dd><p>The contents of dropped folders will added to the window.</p></dd> - - <dt>Add contents recursive</dt> - <dd><p>The contents of dropped folders and all sub folders will be added to the window.</p></dd> - - <dt>Skip folders</dt> - <dd><p>Ignore folders contained in the drop list.</p></dd> - - </dl> - - <p>When files are added to the window, the comparison is restarted to include the new files.</p> - - <h2>Comparison methods</h2> - - <p>The attribute to use for two images to match can be selected with the “Compare by:” drop down menu. Each method is explained below:</p> - - <dl class="dialog_desc"> - <dt>Name</dt><dd><p>The file name.</p></dd> - - <dt>Name case-insensitive</dt><dd><p>The file name but ignoring case.</p></dd> - - <dt>Size</dt><dd><p>The file size.</p></dd> - - <dt>Date</dt><dd><p>The file date.</p></dd> - - <dt>Dimensions</dt><dd><p>The image dimensions.</p></dd> - - <dt>Checksum</dt><dd><p>The MD5 file checksum.</p></dd> - - <dt>Path</dt><dd><p>The complete path to file.</p></dd> - - <dt>Similarity (high)</dt><dd><p>Very similar image content.</p></dd> - - <dt>Similarity</dt><dd><p>Similar image content.</p></dd> - - <dt>Similarity (low)</dt><dd><p>Slightly similar image content.</p></dd> - - <dt>Similarity (custom)</dt><dd><p>Similar image content, the value to use to consider two images a match is configured in the <a href="options_advanced.html">Advanced tab</a> of the preferences dialog by setting the “Custom similarity threshold”.</p></dd> - </dl> - - <h2>Results list</h2> - - <p>Files that match with the selected comparison method will appear in the list. Matching files are grouped in alternating color.</p> - - <p>The order of the result list can not be changed, files will appear in the order of the search. When comparing by image content similarity, the matching groups will be sorted by order of rank starting with the files that are most similar.</p> - - <p>A <b>context menu</b> is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.</p> - - <p><b>Keyboard shortcuts</b> available in the results list:</p> - - <div class="shortcuts"> - <table width="80%" border="1" cellpadding="2" cellspacing="0"> - <col id="find_duplicates_shortcuts_col1" width="25%"></col> - <col id="find_duplicates_shortcuts_col2" width="25%"></col> - <col id="find_duplicates_shortcuts_col3" width="50%"></col> - - <thead> - <tr> - <td> - <p>Shortcut</p> - </td> - - <td> - <p>Context menu name</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - - <tbody> - <tr> - <td> - <p><span class="key">Enter</span></p> - </td> - - <td> - <p>View</p> - </td> - - <td> - <p>Opens selected image in main window.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">V</span></p> - </td> - - <td> - <p>View in new window</p> - </td> - - <td> - <p>Opens selected image in a new window.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">A</span></p> - </td> - - <td> - <p>Select all</p> - </td> - - <td> - <p>Selects all images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Shift</span> + <span class="key">A</span></p> - </td> - - <td> - <p>Select none</p> - </td> - - <td> - <p>Clear the image selection.</p> - </td> - </tr> - - <tr> - <td valign="bottom"> - <p><span class="key">1</span></p> - </td> - - <td> - <p>Select group 1 duplicates</p> - </td> - - <td> - <p>Selects the first image from each match group.</p> - </td> - </tr> - - <tr> - <td valign="bottom"> - <p><span class="key">2</span></p> - </td> - - <td> - <p>Select group 2 duplicates</p> - </td> - - <td> - <p>Selects all but the first image from each match group.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">1</span> through<br /> - <span class="key">Ctrl</span> + <span class="key">0</span></p> - </td> - - <td> - <p>Edit sub menu</p> - </td> - - <td> - <p>Executes the respective editor command.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">P</span></p> - </td> - - <td> - <p>Properties</p> - </td> - - <td> - <p>Opens a properties window for selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">C</span></p> - </td> - - <td> - <p>Add to new collection</p> - </td> - - <td> - <p>Creates a new collection containing the selected images.</p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>Print</p> - </td> - - <td> - <p>Opens a print dialog for selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">C</span></p> - </td> - - <td> - <p>Copy</p> - </td> - - <td> - <p>Copy selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">M</span></p> - </td> - - <td> - <p>Move</p> - </td> - - <td> - <p>Move selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">R</span></p> - </td> - - <td> - <p>Rename</p> - </td> - - <td> - <p>Rename selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">D</span></p> - </td> - - <td> - <p><span class="key">Delete</span></p> - </td> - - <td> - <p>Delete selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Delete</span></p> - </td> - - <td> - <p>Remove</p> - </td> - - <td> - <p>Remove selected images from result list.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Delete</span></p> - </td> - - <td> - <p>Clear</p> - </td> - - <td> - <p>Cleared the result list.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Menu</span></p> - </td> - - <td> </td> - - <td> - <p>Displays the context menu.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">T</span></p> - </td> - - <td> </td> - - <td> - <p>Toggle display of thumbnails.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">W</span></p> - </td> - - <td> </td> - - <td> - <p>Close window.</p> - </td> - </tr> - </tbody> - </table> - </div> - - <p>The <b>selection</b> can be changed using the keyboard and mouse the same as in a <a href="main_window_file_pane.html">file pane</a> of the main window.</p> - - <p>The image Dimensions column of the result list will only contain dimension information when comparing by dimensions, or when the data is easily available from memory or has been read from the cache.</p> - - <h2>Status bar</h2> - - <p>Along the bottom of the Find Duplicates window is an area that displays the count of files contained in the window, and the number of files in the result list.</p> - - <p>The status bar will also display the status of an active compare operation using the progress bar. A compare operation involves 2 or 3 stages, depending on the type of comparison. These are the stages in order:</p> - - <p>1) If necessary, extra data is read into memory for the comparison stage, the progress bar will indicate this stage with text that resembles “reading dimensions...”, “reading checksums...”, or “reading similarity data...”.<br /> - 2) The images are compared using the selected method, the progress bar will indicate this stage with the text “comparing...”.<br /> - 3) The results are sorted for display, the progress bar will indicate this stage with the text “sorting...”.</p> - - <p>Stage 1 is only used for the Dimensions, Checksum, and Similarity compare methods.</p> - - <p>If the time to complete a stage will be significant, an estimated time to completion will also be displayed in the progress bar. The estimated time only refers to the current stage, other stages are not included in the estimate. The time estimate is displayed using the format MINUTES:SECONDS.</p> - - <h2>Thumbnails</h2> - - <p>Thumbnails can be displayed beside each image in the result list by enabling the Thumbnails check box.</p> - - <h2>Compare two file sets</h2> - - <p>Sometimes it is useful to compare one group of files to another, different group of files. Enable this check box to compare two groups of files. When enabled a second list will appear, files can be added to this list using the same methods for the main list.</p> - - <p>When comparing two file sets the results list will display matches between the two lists. For each match group, the first file is always from the main group, and the remaining files are always from the second group.</p> - - <h2>Drag and Drop</h2> - - <p>Drag and drop can be initiated with the primary or middle mouse buttons. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_search_search.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="collections.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/image_search_search.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,447 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Search Window - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_search.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Search Window – Image Search</p> - </th> - - <th> - <p class="next"><a href="image_search_finding_duplicates.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Search Window</h1> - - <p>Geeqie provides a utility to find one or more images based on various parameters.</p> - - <p>To display a new Search Window press <span class="key">F3</span> or select Search from the File menu.</p> - - <p>To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.</p> - - <p>The progress of an active search is displayed as a progress bar at the bottom of the window. The progress bar will also display the total files that match the search parameters, and the total number of files searched.</p> - - <p>When a search is completed, the total number of files found and their total size will be displayed in the status bar.</p> - - <h2>Search location</h2> - - <p>One of several locations can be chosen as the source to use in the search.</p> - - <dl class="dialog_desc"> - <dt>Path</dt> - <dd> - <p>The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.</p> - </dd> - - <dt>Comments</dt> - <dd> - <p>The search will include all files that have a keyword or comment associated to it.</p> - <p class="note"><span class="note_label">Note:</span> Only keyword and comment associations stored in the user's home folder are included in this search type.</p> - </dd> - - <dt>Results</dt> - <dd> - <p>The search will include all files currently listed in the results list, use this to refine a previous search.</p> - </dd> - </dl> - - <h2>Search parameters</h2> - - <p>Each search parameter can be enabled or disabled with the check box to it's left. For a file to be a match, all enabled parameters must be true.</p> - - <dl class="dialog_desc"> - <dt>File name</dt> - <dd> - <p>The search will match if the entered text appears within the file name, or if the text exactly matches the file name, depending on the method selected from the drop down menu. The text comparison can be made to be case sensitive by enabling the Match case checkbox.</p> - </dd> - - <dt>File size</dt> - <dd><p>The search will match if the file size on disk is equal to, less than, greater than, or between the entered value, depending on the method selected from the drop down menu. The between test is inclusive, for example a file of size 10 will match if the size parameters are between 10 and 15.</p> - </dd> - - <dt>File date</dt> - <dd> - <p>The search will match if the file modification time on disk is equal to, before, after, or between the entered date, depending on the method selected from the drop down menu. The between test is inclusive, for example a file with date of 10/04/2003 will match if the date parameters are between 10/04/2003 and 12/31/2003.</p> - <p>For convenience, the button with the down arrow displays a pop up calendar to enter the date.</p> - </dd> - - <dt>Image dimensions</dt> - <dd> - <p>The search will match if the image dimensions are equal to, less than, greater than, or between the entered values, depending on the method selected from the drop down menu. The between test is inclusive.</p> - <p>The image dimensions test is simple, both width and height must be within the allowed values for a match.</p> - </dd> - - <dt>Image content</dt> - <dd> - <p>The search will match if the image contents are similar within the percentage value, inclusive. This uses the same test and data that is used to determine image similarity when <a href="image_search_finding_duplicates.html">Finding Duplicates</a>. The entry is for entering the path for the image to use in this test.</p> - </dd> - - <dt>Keywords</dt> - <dd> - <p>The search will match if the file's associated keywords match all, match any, or exclude the entered keywords, depending on the method selected from the drop down menu. Keywords can be separated with a space, comma, or tab character.</p> - </dd> - </dl> - - <h2>Results list</h2> - - <p>Files that match the parameters of the search are shown in the list. By default they are displayed in the order that they are found, to sort the results list by a column activate or click the column title. Activating a column that is already used to sort the list will toggle between increasing and decreasing sort order.</p> - - <p>A <b>context menu</b> is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.</p> - - <p><b>Keyboard shortcuts</b> available in the results list:</p> - - <div class="shortcuts"> - <table width="80%" border="1" cellpadding="2" cellspacing="0"> - <col id="search_shortcuts_col1" width="25%"></col> - <col id="search_shortcuts_col2" width="25%"></col> - <col id="search_shortcuts_col3" width="50%"></col> - - <thead> - <tr> - <td> - <p>Shortcut</p> - </td> - - <td> - <p>Context menu name</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - <tbody> - <tr> - <td> - <p><span class="key">Enter</span></p> - </td> - - <td> - <p>View</p> - </td> - - <td> - <p>Opens selected image in main window.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">V</span></p> - </td> - - <td> - <p>View in new window</p> - </td> - - <td> - <p>Opens selected image in a new window.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">A</span></p> - </td> - - <td> - <p>Select all</p> - </td> - - <td> - <p>Selects all images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Shift</span> + <span class="key">A</span></p> - </td> - - <td> - <p>Select none</p> - </td> - - <td> - <p>Clear the image selection.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">1</span> through<br /> - <span class="key">Ctrl</span> + <span class="key">0</span></p> - </td> - - <td> - <p>Edit sub menu</p> - </td> - - <td> - <p>Executes the respective editor command.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">P</span></p> - </td> - - <td> - <p>Properties</p> - </td> - - <td> - <p>Opens a properties window for selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">C</span></p> - </td> - - <td> - <p>Add to new collection</p> - </td> - - <td> - <p>Creates a new collection containing the selected images.</p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>Print</p> - </td> - - <td> - <p>Opens a print dialog for selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">C</span></p> - </td> - - <td> - <p>Copy</p> - </td> - - <td> - <p>Copy selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">M</span></p> - </td> - - <td> - <p>Move</p> - </td> - - <td> - <p>Move selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">R</span></p> - </td> - - <td> - <p>Rename</p> - </td> - - <td> - <p>Rename selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">D</span></p> - </td> - - <td> - <p><span class="key">Delete</span></p> - </td> - - <td> - <p>Delete selected images.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Delete</span></p> - </td> - - <td> - <p>Remove</p> - </td> - - <td> - <p>Remove selected images from result list.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Delete</span></p> - </td> - - <td> - <p>Clear</p> - </td> - - <td> - <p>Cleared the result list.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Menu</span></p> - </td> - - <td> </td> - - <td> - <p>Displays the context menu.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">T</span></p> - </td> - - <td> </td> - - <td> - <p>Toggle display of thumbnails.</p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">W</span></p> - </td> - - <td> </td> - - <td> - <p>Close window.</p> - </td> - </tr> - </tbody> - </table> - </div> - - <p>The <b>selection</b> can be changed using the keyboard and mouse the same as in a <a href="main_window_file_pane.html">file pane</a> of the main window.</p> - - <p>The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.</p> - - <h2>Status bar</h2> - - <p>At the bottom of the search window is an area that includes the following items from left to right:</p> - - <dl class="dialog_desc"> - <dt>Thumbnails</dt> - <dd> - <p>Enable this check box to display a thumbnail next to each image in the results list.</p> - </dd> - - <dt>File count display</dt> - <dd> - <p>Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.</p> - </dd> - - <dt>Search progress</dt> - <dd> - <p>When a search is active, the text “Searching...” will appear here. Two numbers in parenthesis will also be displayed, the first number is the number of files that match the search parameters and the second number is the total number of files that were searched.</p> - </dd> - - <dt>Find</dt> - <dd> - <p>Activate the find button to start a search with the selected parameters.</p> - </dd> - - <dt>Stop</dt> - <dd> - <p>Activate the stop button to end a search that is in progress.</p> - </dd> - </dl> - - <h2>Drag and Drop</h2> - - <p>Drag and drop can be initiated with the primary or middle mouse buttons. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_search.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_search_finding_duplicates.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/index.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,142 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Contents - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> </th> - - <th> - <p class="navtop_title">Contents</p> - </th> - - <th> - <p class="next"><a href="introduction.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>The Geeqie User Manual</h1> - - <p>If you are having trouble finding a solution in the manual, try looking in the <a href="faq.html">FAQ</a>.</p> - - <div class="menu"> - <ul> - <li><a href="introduction.html">Introduction</a></li> - <li><a href="main_window.html">Main Window</a> - <ul> - <li><a href="main_window_navigation.html">Navigation</a></li> - <li><a href="main_window_menus.html">Menus</a></li> - <li><a href="main_window_layout.html">Layout</a></li> - <li><a href="main_window_file_pane.html">File Pane</a></li> - <li><a href="main_window_folder_pane.html">Folder Pane</a></li> - <li><a href="main_window_image_pane.html">Image Pane</a></li> - <li><a href="main_window_status_bar.html">Status Bar</a></li> - </ul> - </li> - <li><a href="other_windows.html">Other Windows</a> - <ul> - <li><a href="other_windows_image_window.html">Image Window</a></li> - <li><a href="other_windows_image_properties.html">Image Properties Window</a></li> - <li><a href="other_windows_pan_view.html">Pan View Window</a></li> - </ul> - </li> - <li><a href="image_management.html">Image Management</a> - <ul> - <li><a href="image_management_copy_move.html">Copy and Move</a></li> - <li><a href="image_management_rename.html">Rename</a></li> - <li><a href="image_management_delete.html">Delete</a></li> - <li><a href="image_management_external_editing.html">External Editing Commands</a></li> - </ul> - </li> - <li><a href="image_search.html">Image Search</a> - <ul> - <li><a href="image_search_search.html">Search Window</a></li> - <li><a href="image_search_finding_duplicates.html">Finding Duplicate Images</a></li> - </ul> - </li> - <li><a href="collections.html">Collections</a></li> - <li><a href="sidebars.html">Sidebars</a> - <ul> - <li><a href="sidebars_exif.html">EXIF</a></li> - <li><a href="sidebars_sort_manager.html">Sort Manager</a></li> - <li><a href="sidebars_keywords.html">Keywords</a></li> - </ul> - </li> - <li><a href="image_presentation.html">Image Presentation</a> - <ul> - <li><a href="image_presentation_slideshow.html">Slide show</a></li> - <li><a href="image_presentation_fullscreen.html">Full screen</a></li> - </ul> - </li> - <li><a href="printing.html">Printing</a></li> - <li><a href="options.html">Options</a> - <ul> - <li><a href="options_general.html">General Options</a></li> - <li><a href="options_image.html">Image Options</a></li> - <li><a href="options_window.html">Window Options</a></li> - <li><a href="options_filtering.html">Filtering Options</a></li> - <li><a href="options_editor_commands.html">Editor Commands</a></li> - <li><a href="options_properties.html">Properties Options</a></li> - <li><a href="options_advanced.html">Advanced Options</a></li> - <li><a href="options_hidden.html">Hidden Options</a></li> - </ul> - </li> - <li><a href="reference.html">Reference</a> - <ul> - <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> - <li><a href="reference_management.html">Cache and Data Management</a></li> - </ul> - </li> - <li><a href="credits.html">Credits</a></li> - <li><a href="gnu_fdl.txt">GNU Free Documentation License</a></li> - </ul> - </div> - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> </th> - - <th> </th> - - <th> - <p class="next"><a href="introduction.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/introduction.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,146 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Introduction - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="index.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Introduction</p> - </th> - - <th> - <p class="next"><a href="main_window.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <p>Legal Notice</p> - - <p>Copyright © 2008 - 2009 The Geeqie Team.<br /> - Copyright © 2004 John Ellis.</p> - - <p>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "<a href="gnu_fdl.txt">GNU Free Documentation License</a>".</p> - - <h1>Introduction</h1> - - <p>Geeqie is an image viewer, that makes navigation of images easy. Images can be viewed full screen, and a slide show function allows automatic changing of the displayed image.</p> - - <p>Geeqie is an image manager, with complete copy, move, rename, and delete functions available at the press of a button. Find the right image with the search feature. Image collectors can free up space with a function that finds duplicate images.</p> - - <p>The one thing Geeqie is not, and never be, is an image editor. However, Geeqie paired with an image editor, such as the Gimp, can be a very powerful combination.</p> - - <h2>Basic Features</h2> - - <ul> - <li> - <p>Thumbnail preview</p> - </li> - - <li> - <p>Full screen</p> - </li> - - <li> - <p>Slide show</p> - </li> - - <li> - <p>Image Management</p> - </li> - - <li> - <p>Image Collections</p> - </li> - </ul> - - <h2>Advanced Features</h2> - - <ul> - <li> - <p>Image Search</p> - </li> - - <li> - <p>Find image duplicates based on image content</p> - </li> - - <li> - <p>View EXIF data stored in images</p> - </li> - - <li> - <p>Simple Sort Manager to quickly sort a folder of images into other folders</p> - </li> - - <li> - <p>Rename images in bulk</p> - </li> - - <li> - <p>Add keywords to images, and recall those images with the search function</p> - </li> - - <li> - <p>Very Configurable</p> - </li> - </ul> - - <p>“An application that displays images.” - This was, and still is, the primary goal of Geeqie. Over time image management features have been added, but the core purpose of Geeqie remains the same.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="index.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,88 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Main Window - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="introduction.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Main Window</p> - </th> - - <th> - <p class="next"><a href="main_window_navigation.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Main Window</h1> - - <p>The Geeqie main window is designed for quick and easy navigation of images. The window consists of three regions: the file pane, the folder pane, and the image pane.</p> - - <div class="submenu"> - <ul> - <li><a href="main_window_navigation.html">Navigation</a></li> - <li><a href="main_window_menus.html">Menus</a></li> - <li><a href="main_window_layout.html">Layout</a></li> - <li><a href="main_window_file_pane.html">File Pane</a></li> - <li><a href="main_window_folder_pane.html">Folder Pane</a></li> - <li><a href="main_window_image_pane.html">Image Pane</a></li> - <li><a href="main_window_status_bar.html">Status Bar</a></li> - </ul> - </div> - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="introduction.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window_navigation.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window_file_pane.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,176 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>File Pane - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_layout.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">File Pane – Main Window</p> - </th> - - <th> - <p class="next"><a href="main_window_folder_pane.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>File Pane</h1> - - <p>The file pane displays the images contained in the active folder. It has two modes of display, allows multiple selection, and can initiate drag and drop operations.</p> - - <p>A <b>context menu</b> can be displayed by clicking the right mouse button on the file pane or pressing the menu key while the file pane has the focus.</p> - - <h2>List view</h2> - - <p>This mode can be enabled by selecting “List” from the View menu, pressing <span class="key">Ctrl</span> + <span class="key">L</span> on the keyboard, or unselecting “View as icons” from the context menu.</p> - - <p>The list view mode displays images in a standard vertical list. Three columns provide the file name, size in bytes, and the time the contents were last modified.</p> - - <p><b>Thumbnails</b> can be displayed next to each file in the list, to toggle thumbnails on or off by selecting “Thumbnails” from the View menu, pressing the <span class="key">T</span> key, clicking the thumbnail button on the tool bar, or selecting “Show thumbnails” from the context menu.</p> - - <h2>Icon view</h2> - - <p>This mode can be enabled by selecting “Icons” from the View menu, pressing <span class="key">Ctrl</span> + <span class="key">I</span> on the keyboard, or selecting “View as icons” from the context menu.</p> - - <p>The icon view mode displays images as thumbnails in a grid, and by default a file name below each thumbnail.</p> - - <p>The <b>file name</b> displayed below each thumbnail can be turned on or off by selecting “Show filename text” from the context menu.</p> - - <h2>Multiple selection</h2> - - <p>It is possible to select more than one image from the file pane. Multiple files can be selected with several methods:</p> - - <h3>Mouse</h3> - - <ul> - <li> - <p><span class="key">Ctrl</span> + Primary mouse button will add or remove the file from the selection.</p> - </li> - - <li> - <p>Middle mouse button will toggle selection of the file.</p> - </li> - - <li> - <p><span class="key">Shift</span> + Primary mouse button will select all images between the clicked and focused image, or it will unselect all those images if the clicked image is already selected.</p> - </li> - - <li> - <p><span class="key">Shift</span> + <span class="key">Ctrl</span> + Primary mouse button works as <span class="key">Shift</span> + Primary mouse button, but will not change the selection of files outside the region between the focus and clicked image.</p> - </li> - </ul> - - <h3>Keyboard</h3> - - <ul> - <li> - <p><span class="key">Ctrl</span> + <span class="key">Arrows</span> will move the focus without changing the selection.</p> - </li> - - <li> - <p><span class="key">Ctrl</span> + <span class="key">Space</span> will toggle selection of the focused image.</p> - </li> - - <li> - <p><span class="key">Shift</span> + <span class="key">Arrows</span> will select a region of images.</p> - </li> - - <li> - <p><span class="key">Shift</span> + <span class="key">Ctrl</span> + <span class="key">Arrows</span> works as <span class="key">Shift</span> + <span class="key">Arrows</span>, but will not change the selection of files outside the current focus region.</p> - </li> - </ul> - - <p>To select all files press <span class="key">Ctrl</span> + <span class="key">A</span>, or to unselect all image press <span class="key">Ctrl</span> + <span class="key">Shift</span> + <span class="key">A</span>. These operations are also available from the Edit menu as “Select all” and “Select none”.</p> - - <p>The current number of selected images and their total size will be indicated in the File list section of the <a href="main_window_status_bar.html">status bar</a>.</p> - - <h2>Sorting</h2> - - <p>The order of the images can be changed by clicking the sort area of the status bar or from the context menu. The sort methods are by file name, number, file date, or file size. The number method will sort file names by their natural order, for example files with names of file_10, file_12, and file_9 will appear in order file_9, file_10, and file_12.</p> - - <p>Selecting the ascending menu item will toggle between increasing and decreasing sort order.</p> - - <h2>Context menu</h2> - - <p>Right clicking the mouse or pressing the menu key while the file pane has focus will display a menu. The menu functions will perform the same as those that match the window's <a href="main_window_menus.html">menu bar</a>, however a few functions are unique to the context menu:</p> - - <dl class="menu_desc"> - - <dt>View in new window</dt> - <dd>Opens a new window containing a list of the currently selected images.</dd> - - <dt>Sort</dt> - <dd>Changes the sort order of file pane.</dd> - - <dt>View as icons</dt> - <dd>Toggles between the list and icon view modes.</dd> - - <dt>Show thumbnails</dt> - <dd>Toggles display of thumbnails in the list view display mode.</dd> - - <dt>Show filename text</dt> - <dd>Toggles display of file names in the icon view display mode.</dd> - - </dl> - - <h2>Drag and Drop</h2> - - <p>Drag and drop can be initialized with the primary or middle mouse buttons in the file pane. Dragging a file that is selected will include all selected files in the drag. Dragging a file that is not selected will first change the selection to the dragged file, and clear the previous selection.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_layout.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window_folder_pane.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window_folder_pane.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,173 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Folder Pane - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_file_pane.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Folder Pane – Main Window</p> - </th> - - <th> - <p class="next"><a href="main_window_image_pane.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Folder pane</h1> - - <p>The folder pane contains the menu bar, tool bar, path entry, and folder list.</p> - - <h2>Menu bar</h2> - - <p>The main menu of the window. The functions available from the main menu are described in the <a href="main_window_menus.html">Menus</a> chapter.</p> - - <h2>Tool bar</h2> - - <p>The tool bar includes buttons for often used operations. The tool bar can be hidden or shown by selecting “Hide toolbar” from the view menu.</p> - - <p class="note"><span class="note_label">Note:</span> 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> - - <dt>Change to home folder</dt><dd>Change the main window to display the contents of the user's home folder.</dd> - - <dt>Refresh file list</dt><dd>This will check for changes to the active folder and update the window.</dd> - - <dt>Zoom in</dt><dd>Increase the image display size.</dd> - - <dt>Zoom out</dt><dd>Decrease the image display size.</dd> - - <dt>Fit image to window</dt><dd>This will size the image to fit within the image view.</dd> - - <dt>Set zoom 1:1</dt><dd>Restore zoom to the image's original size.</dd> - - <dt>Configure options</dt><dd>Displays the <a href="options.html">Options window</a>.</dd> - - <dt>Float controls</dt><dd>Toggle the folder pane, file pane, and status bar between the main window and a secondary window.</dd> - </dl> - - <h2>Path entry</h2> - - <p>This displays the active folder of the window and allows typing a location.</p> - - <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 <span class="key">Enter</span> key. Tab completion is also available in the path entry.</p> - - <p class="note"><span class="note_label">Note:</span> Tab completion uses the <span class="key">Tab</span> key, press the <span class="key">Down</span> key 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> - - <h2>Folder list</h2> - - <p>This displays a list of sub folders contained in the active folder, or a tree that includes all folders in the file system.</p> - - <p>A <b>context menu</b> can be displayed by clicking the right mouse button on the folder pane or pressing the menu key while the folder pane has the focus</p> - - <h2>List view</h2> - - <p>This mode can be enabled by unselecting “Tree” from the View menu, pressing <span class="key">Ctrl</span> + <span class="key">T</span>, or unselecting “View as tree” from the context menu.</p> - - <p>The list view mode displays sub folders contained in the active folder in a standard vertical list. The parent folder can be selected with the folder named “..”.</p> - - <h2>Tree view</h2> - - <p>This mode can be enabled by selecting “Tree” from the View menu, pressing <span class="key">Ctrl</span> + <span class="key">T</span>, or selecting “View as tree” from the context menu.</p> - - <p>The tree view mode displays all folders in the file system, starting with the root folder and branching out to include sub folders. A folder branch can be expanded or collapsed by clicking the expander next to each folder icon, or by pressing the respective <span class="key">+</span> or <span class="key">-</span> keys when the folder branch has the focus.</p> - - <h2>Sorting</h2> - - <p>The order of the folder names will match the order selected for the file pane. Sort order can be changed by clicking the sort area of the status bar or from the context menu of the file pane.</p> - - <h2>Context menu</h2> - - <p>Right clicking the mouse or pressing the menu key while the folder pane has focus will display a menu. The menu functions will perform the same as those that match the window's <a href="main_window_menus.html">menu bar</a>, however a few functions are unique to the context menu:</p> - - <dl class="menu_desc"> - <dt>Up to parent</dt><dd>This will change the window to display the contents of the parent folder.</dd> - - <dt>Slide show</dt><dd>Start a <a href="image_presentation_slideshow.html">slide show</a> that contains all images in the selected folder.</dd> - - <dt>Slide show recursive</dt><dd>Start a <a href="image_presentation_slideshow.html">slide show</a> that contains all images in the selected folder, and all images in the sub folders of that folder.</dd> - - <dt>Find duplicates</dt><dd>This will open a new <a href="image_search_finding_duplicates.html">find duplicates</a> window containing all images in the selected folder.</dd> - - <dt>Find duplicates recursive</dt><dd>This will open a new <a href="image_search_finding_duplicates.html">find duplicates</a> window containing all image in the selected folder, and all images in the sub folders of that folder.</dd> - - <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. - - <p class="note"><span class="note_label">Note:</span> 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> - - </dl> - - <h2>Drag and drop</h2> - - <p>Image files can be dropped onto folders displayed in the folder pane. A menu will appear allowing you to select to move or copy the dropped images into the target folder. The list will automatically scroll up or down when the drag pointer is near the respective top or bottom of the list. When in tree mode, hovering over a folder for a brief period of time will expand that folder.</p> - - <p>The folders can used as a drag source for drag and drop, for example to add images in a folder to a collection window. However drag and drop can not be used to move or copy folders in Geeqie.</p> - - <p>Using <span class="key">Shift</span> key while dragging is a shortcut to move action. Menu will not appear but move will occur.</p> - <p>Using <span class="key">Ctrl</span> key while dragging is a shortcut to copy action. Menu will not appear but copy will occur.</p> - - <hr /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_file_pane.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window_image_pane.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window_image_pane.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,284 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Image Pane - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_folder_pane.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Image Pane – Main Window</p> - </th> - - <th> - <p class="next"><a href="main_window_status_bar.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Image Pane</h1> - - <p>The image pane is the region of the main window that displays the selected image. The image pane allows adjustment of display size and orientation; it also provides several methods to manipulate the image with the mouse and keyboard.</p> - - <h2>Image display</h2> - - <p>The image is drawn to the screen as it is decoded from disk. The image can be panned and zoomed while it is still loading. Image adjustment operations for rotation, mirror, and flip will delay until the image is completed. The adjustment queue will remember one operation and will retain the most recently requested function, which will be performed once the image has finished loading.</p> - - <p>The quality of the image, especially when using the zoom feature, is dependent on the settings that are available on the <a href="options_image.html">Image tab</a> of the preferences dialog.</p> - - <p>To increase the speed of loading the next image when navigating the image list in sequence, enable the <a href="options_image.html" class="option_name">Preload next image</a> option.</p> - - <h2>Image panning and manipulation</h2> - - <p>When the image size is larger than the image pane, the visible region can be changed with the keyboard or mouse. The keyboard can also be used to adjust the orientation of the image.</p> - - <h3>Keyboard</h3> - <p>Use the <span class="key">Arrows</span> to pan the image in the desired direction, to increase the panning speed hold down the <span class="key">Shift</span> + <span class="key">Arrows</span>.<br />Press <span class="key">Ctrl</span> + <span class="key">Arrows</span> to move to the respective edge of the image. The image can only be panned with the keyboard when the image has the focus, indicated by a dotted line surrounding the image pane.</p> - - <div class="shortcuts"> - <table width="80%" border="1" cellpadding="2" cellspacing="0"> - <col id="image_pane_shortcuts_col1" width="25%"></col> - <col id="image_pane_shortcuts_col2" width="25%"></col> - <col id="image_pane_shortcuts_col3" width="50%"></col> - - <thead> - <tr> - <td> - <p>Shortcut</p> - </td> - - <td> - <p>Context menu name</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - <tbody> - <tr> - <td> - <p><span class="key">+</span></p> - <p><span class="key">=</span></p> - </td> - - <td> - <p>Zoom in</p> - </td> - - <td> - <p>Zoom in.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">-</span></p> - </td> - - <td> - <p>Zoom out</p> - </td> - - <td> - <p>Zoom out.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">X</span></p> - <p>[Keypad] <span class="key">*</span></p> - </td> - - <td> - <p>Fit image to window</p> - </td> - - <td> - <p>Scale the image to fit the available display area.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Z</span></p> - <p>[Keypad] <span class="key">/</span></p> - </td> - - <td> - <p>Zoom 1:1</p> - </td> - - <td> - <p>Reset the zoom to original image size.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">]</span></p> - </td> - - <td> - <p>Adjust > Rotate clockwise</p> - </td> - - <td> - <p>Rotate the image clockwise 90 degrees.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">[</span></p> - </td> - - <td> - <p>Adjust > Rotate counterclockwise</p> - </td> - - <td> - <p>Rotate the image counterclockwise 90 degrees.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">R</span></p> - </td> - - <td> - <p>Adjust > Rotate 180</p> - </td> - - <td> - <p>Rotate the image 180 degrees.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">M</span></p> - </td> - - <td> - <p>Adjust > Mirror</p> - </td> - - <td> - <p>Flip the image horizontally.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">F</span></p> - </td> - - <td> - <p>Adjust > Flip</p> - </td> - - <td> - <p>Flip the image vertically.</p> - </td> - </tr> - </tbody> - </table> - </div> - <p class="note"><span class="note_label">Note:</span> 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 <span class="key">Shift</span> key <a href="#bottomnote1" class="bottomnote">(*)</a>.</p> - - <p>To scale the image size hold down the <span class="key">Ctrl</span> key and scroll the mouse wheel up to zoom in, or down to zoom out.</p> - - <h4>Smooth Scroll</h4> - <p>To start the smooth scroll function hold down the <span class="key">Shift</span> key and click the primary mouse button. An icon will appear at the location of the mouse pointer, the mouse can then be positioned to pan the image. The image will pan in the direction of the mouse pointer relative to the icon. The pan speed will increase in proportion to the distance that the pointer is from the center of the icon. To end the smooth scroll function click the primary mouse button within the image pane.</p> - - <h2>Navigation</h2> - - <p>The displayed image can be changed to the next or previous image using the keyboard or mouse.</p> - - <h3>Keyboard</h3> - <p>The <span class="key">PageDown</span> and <span class="key">PageUp</span> keys will change the image to the next or previous image, respectively, in the list. The <span class="key">Home</span> and <span class="key">End</span> keys will jump to the first and last image, respectively. When the image has the focus, the <span class="key">SpaceBar</span> and <span class="key">BackSpace</span> keys can also be used to change the image.</p> - - <h3>Mouse</h3> - <p>To change to the next image in the list click the left mouse button, click the middle mouse button to change to the previous image. The mouse wheel can also be used to change the current image <a href="#bottomnote1" class="bottomnote">(*)</a>.</p> - - <h2>Context menu</h2> - - <p>Right clicking the mouse or pressing the menu key while the image has the focus will display a menu. The menu functions will perform the same as those that match the window's <a href="main_window_menus.html">menu bar</a>, however a few functions are unique to the context menu:</p> - - <dl class="menu_desc"> - <dt>View in new window</dt><dd>Opens a new window containing a second copy of the current image.</dd> - - <dt>Pause slide show, Continue slide show</dt><dd>Controls the pause state of an active slide show, the text of the menu will change to reflect the action that will be performed.</dd> - </dl> - - <h2>Drag and Drop</h2> - - <p>Files and folders can be dropped onto the image pane, dropping a file will display the file and dropping a folder will change the main window to display the contents of the folder. When dropping multiple items on the image pane, only the first item in the list will be used, all additional items will be ignored.</p> - - <p>A drag and drop operation can be initiated from the image pane with the middle mouse button, the dragged item will contain the file path of the displayed image.</p> - - <h2>Displaying images side by side</h2> - - <p>Using View > Split item from the main menu, image pane can be splitted in up to four panes, this allows to display images side by side. You may use drag'n drop to change images in each pane.</p> - - <p>Connected zoom is possible through the View > Connected zoom menu. Zoom is then applied to all displayed images.</p> - <p>Connected scrolling is also possible using <span class="key">Shift</span> and primary mouse button.</p> - - - - <p class="bottomnote"><a id="bottomnote1" name="bottomnote1"></a><span class="note_label">(*) Note:</span> The mouse wheel behavior for scrolling and image step can be swapped with the <span class="option_name">Mouse wheel scrolls image</span> option located on the <a href="options_advanced.html">Advanced tab</a> of the preferences dialog.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_folder_pane.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window_status_bar.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window_layout.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,101 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Layout - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_menus.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Layout – Main Window</p> - </th> - - <th> - <p class="next"><a href="main_window_file_pane.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Layout</h1> - - <p>The main window consists of four areas, the <a href="main_window_folder_pane.html">folder pane</a>, <a href="main_window_file_pane.html">file pane</a>, <a href="main_window_image_pane.html">image pane</a>, and the <a href="main_window_status_bar.html">status bar</a>. The status bar is always at the bottom of the window. The three remaining areas, or panes, can be arranged and sized by the user.</p> - - <h2>Selecting the location of each pane</h2> - - <p>The arrangement of the folder, file, and image pane is selected on the <a href="options_window.html">Windows tab</a> of the Options window. There are four choices for the layout, the difference is that each has the larger pane in a different location: right, bottom, left, and top.</p> - - <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 class="note"><span class="note_label">Note:</span> 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> - - <p>Between the panes of the main window are two dividers that can be moved with the mouse to adjust the size of each pane. Press and hold the primary button, then move the divider to the desired location and release the button.</p> - - <h3>Folder pane</h3> - - <p>The <a href="main_window_folder_pane.html">folder pane</a> contains the menu bar, tool bar, path entry, and folder list. The list can be set to display the sub folders of the active folder or a tree that starts with the root folder and contains all folders in the file system.</p> - - <h3>File pane</h3> - - <p>The <a href="main_window_file_pane.html">file pane</a> lists the images contained in the active folder. The file pane can be set to display as a vertical list or an icon view.</p> - - <h3>Image pane</h3> - - <p>The <a href="main_window_image_pane.html">image pane</a> is where the active image is displayed.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_menus.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window_file_pane.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window_menus.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,344 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Menus - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_navigation.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Menus – Main Window</p> - </th> - - <th> - <p class="next"><a href="main_window_layout.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Menus</h1> - - <p>This section describes the functions of each item on the menu bar in the Geeqie main window.</p> - - <h2>File Menu</h2> - - <dl class="menu_desc"> - <dt>New window</dt><dd>Opens a new main window, with the initial path set to the current folder.</dd> - - <dt>New collection</dt><dd>Opens a new collection window, the new collection will be empty.</dd> - - <dt>Open collection</dt><dd>Displays a dialog to open a collection stored on disk, the selected collection will then appear in a new window.</dd> - - <dt>Open recent</dt><dd>This menu item lists the recently active collections, selecting an item from the list will open that collection in a new window. The most recent item will appear at the top of the list. Maximum number of entries can be modified through <a href="options_advanced.html" class="option_name">Open recent list maximum size</a> option.</dd> - - <dt>Search...</dt><dd>Opens a new Search window.</dd> - - <dt>Find duplicates...</dt><dd>Opens a new Find Duplicates window.</dd> - - <dt>Pan view</dt><dd>Opens the pan view window.</dd> - - <dt>Print..</dt><dd>Opens a print dialog.</dd> - - <dt>New folder...</dt><dd>Creates a new folder in the current path.</dd> - - <dt>Copy...</dt><dd>Opens a dialog to select a destination to copy the currently selected files.</dd> - - <dt>Move...</dt><dd>Opens a dialog to select a destination to move currently selected files.</dd> - - <dt>Rename...</dt><dd>Renames the current file selection.</dd> - - <dt>Delete...</dt><dd>Deletes the current file selection.</dd> - - <dt>Copy path</dt><dd>Copy selected item path to clipboard. Enabled by <a href="options_advanced.html" class="option_name">Show "Copy path" menu item</a> option.</dd> - - <dt>Close window</dt><dd>Closes the window containing the menu, if the window is the last main window Geeqie will quit.</dd> - - - <dt>Quit</dt><dd>Quits the Geeqie application, if collections have been changed but not saved, the user will be prompted for confirmation.</dd> - </dl> - - <h2>Go menu</h2> - <dl class="menu_desc"> - - <dt>First Image</dt><dd>Goes tothe first image</dd> - <dt>Previous Image</dt><dd>Goes to the previous image</dd> - <dt>Next Image</dt><dd>Goes to the next image</dd> - <dt>Last Image</dt><dd>Goes to the last image</dd> - - </dl> - - <h2>Select menu</h2> - <dl class="menu_desc"> - <dt>Select all</dt><dd>Selects all files in the current list</dd> - <dt>Select none</dt><dd>Deselects all files</dd> - <dt>Invert Selection</dt><dd>Inverts current selection</dd> - <dt>Show marks</dt><dd>Displays marks in the file list</dd> - <dt>Mark n</dt><dd>Opens submenu for manipulating mark n - <dl class="menu_desc_sublevel1"> - <dt>Toggle mark n</dt><dd>Set or unset mark n on selected files</dd> - <dt>Set mark n</dt><dd>Set mark n on selected files</dd> - <dt>Reset mark n</dt><dd>Unset mark n on selected files</dd> - <dt>Select mark n</dt><dd>Selects all files having mark n set</dd> - <dt>Add mark n</dt><dd>Adds files having mark n set to selection</dd> - <dt>Intersection with mark n</dt><dd>Intersects current selection and mark n</dd> - <dt>Unselect mark n</dt><dd>Removes files having mark n set from current selection</dd> - </dl> - </dd> - </dl> - - - <h2>Edit menu</h2> - - <dl class="menu_desc"> - - <dt>in <command name>...</dt><dd>This will execute the external command associated with <command name>, these can be changed edited on the <a href="options_editor_commands.html">Editors tab</a> of the Option dialog.</dd> - - <dt>Adjust</dt><dd> - <dl class="menu_desc_sublevel1"> - <dt>Rotate clockwise</dt><dd>Rotates the current image clockwise 90 degrees, does not modify the file on disk.</dd> - - <dt>Rotate counterclockwise</dt><dd>Rotates the current image counterclockwise 90 degrees, does not modify the file on disk.</dd> - - <dt>Rotate 180</dt><dd>Rotates the current image 180 degrees, does not modify the file on disk.</dd> - - <dt>Mirror</dt><dd>Swaps the left and right sides of the image so that the result is similar to that of looking at the image in a mirror, does not modify the file on disk.</dd> - - <dt>Flip</dt><dd>Swaps the top and bottom sides of the image, does not modify the file on disk.</dd> - - <dt>Toggle grayscale</dt><dd>Shows images converted to grayscale, does not modify files on disk. It is applied to all files until toggled again.</dd> - - <dt>Original state</dt><dd>Removes all effects applied through the Adjust menu, reverting image to its original state.</dd> - - </dl> - </dd> - - <dt>Properties</dt><dd>Opens a Properties Window for the currently selected files.</dd> - - <dt>Preferences...</dt><dd>Opens the <a href="options.html">Preferences Dialog</a> for changing of user preferences.</dd> - - <dt>Thumbnail maintenance</dt><dd>Opens a dialog with utilities to manage cached thumbnails and keywords data.</dd> - - <dt>Set as wallpaper</dt><dd>Renders the current image to the root window (desktop). The resulting image will be tiled to fit the root window if zoom is not set to <em>fit to window</em>; when zoom is set to <em>fit to window</em>, the image will be scaled to fill the root window.</dd> - </dl> - - <h2>View menu</h2> - - <dl class="menu_desc"> - - <dt>View in new window</dt><dd>Opens selected image in its own window</dd> - - <dt>Zoom</dt><dd> - <dl class="menu_desc_sublevel1"> - <dt>Zoom in</dt><dd>Increases the zoom by one increment, resulting in a larger image.</dd> - - <dt>Zoom out</dt><dd>Decreases the zoom by one increment, resulting in a smaller image.</dd> - - <dt>Zoom to fit</dt><dd>Automatically adjusts the zoom so that the image will fit within the display pane. The effect on images with an original size smaller than the display pane can be changed with the <span class="option_name">Allow enlargement of image for zoom to fit</span> option located on the <a href="options_image.html">Image tab</a> of the preferences dialog.</dd> - - <dt>Fit Horizontally</dt><dd>Adjusts the zoom so image height fit within the display pane.</dd> - - <dt>Fit Vertically</dt><dd>Adjusts the zoom so image width fit within the display pane.</dd> - - <dt>Zoom n:m</dt><dd>Set zoom to the n:m value. 1:1 is the original size of the image. When n is greater than m, zoom in occurs else zoom out occurs.</dd> - </dl> - </dd> - - <dt>Connected zoom</dt><dd>Actions in this menu are identical to those in Zoom menu, but apply to all images displayed in splitted view.</dd> - - <dt>Split</dt><dd> - <dl class="menu_desc_sublevel1"> - <dt>Horizontal</dt><dd>Splits main image view in two horizontal panes.</dd> - <dt>Vertical</dt><dd>Splits main image view in two vertical panes.</dd> - <dt>Quad</dt><dd>Splits main image view in four panes.</dd> - <dt>Single</dt><dd>Reverts to normal view mode (one image).</dd> - </dl> - </dd> - - <dt>Thumbnails</dt><dd>Toggles the display of image thumbnails in the file list, this item is not available when the file list is in icon view mode. A check appears next to this item when thumbnails are enabled.</dd> - - <dt>List</dt><dd>Changes the file list to display files in list format.</dd> - - <dt>Icons</dt><dd>Changes the file list to display files as icons.</dd> - - <dt>View Directory as</dt><dd> - <dl class="menu_desc_sublevel1"> - <dt>List</dt><dd>Set the folder view mode to list.</dd> - <dt>Tree</dt><dd>Set the folder view mode to tree.</dd> - </dl> - </dd> - - <dt>Image Overlay</dt><dd>Displays Image Overlay information box (OSD), use twice to add histogram to it.</dd> - <dt>Histogram channels</dt><dd>Switches channels displayed in the histogram (red, green, blue, RGB, value, maximum value).</dd> - <dt>Histogram log mode</dt><dd>Toggles between linear and logarithmical histogram.</dd> - - <dt>Full screen</dt><dd>Toggles the full screen window display.</dd> - - <dt>Float file list</dt><dd>Toggles the location of the menu bar, tool bar, status bar, and file lists between the main window and a second window. A check appears next to this item when the location is the second window.</dd> - - <dt>Hide file list</dt><dd>Toggles visibility of the menu bar, tool bar, status bar, and file lists.</dd> - - <dt>Hide toolbar</dt><dd>Toggles visibility of the tool bar. A check appears next to this item when the tool bar is not visible.</dd> - - <dt>Keywords</dt><dd>Toggles display of the Keywords sidebar.</dd> - - <dt>Exif data</dt><dd>Toggles display of the EXIF sidebar.</dd> - - <dt>Sort manager</dt><dd>Toggles display of the Sort Manager sidebar.</dd> - - <dt>Toggle slideshow</dt><dd>Begins or ends a slide show, the slide show status is displayed in the status bar.</dd> - - <dt>Pause slideshow</dt><dd>Pauses a slide show, the slide show status is displayed in the status bar.</dd> - - <dt>Refresh</dt><dd>Updates the contents of the folder and file lists to match what is currently on disk, the current image will also be reread from disk.</dd> - </dl> - - <h2>Help menu</h2> - - <dl class="menu_desc"> - - <dt>Contents</dt><dd>Opens the Geeqie user manual in a new browser window.</dd> - - <dt>Keyboard shortcuts</dt><dd>Displays a window listing the default keyboard shortcuts.</dd> - - <dt>Release notes</dt><dd>Displays a window containing the release notes for the version of Geeqie in use.</dd> - - <dt>About</dt><dd>Opens a window containing the Geeqie version, credits, website, and email contact information.</dd> - - <dt>Log window</dt><dd>Opens the log window, mostly used for debugging purposes.</dd> - - </dl> - <h2>Tear off menus</h2> - - <p>Menus can be permanently displayed by selecting the dotted line item at the top of each menu category. A tear off menu will behave the same as an ordinary window. To close a tear off menu, select the dotted line item at the top of the menu.</p> - - <h2>Keyboard shortcuts</h2> - - <p>The keyboard sequence associated to each menu entry is listed within the main window menu bar. For reference, the complete list of default keyboard shortcuts can be found in section <a href="reference_keyboard_shortcuts.html">Keyboard Shortcuts</a>.</p> - - <h2>Changing the main window menu bar keyboard shortcuts</h2> - - <p>The keyboard shortcuts associated with the menu bar items can be changed by editing the accels file located in the Geeqie configuration folder <b>while the Geeqie application is not running</b>:</p> - - <p><code>($HOME)/.geeqie/accels</code> - </p> - - <p>To change a menu item, first find the line corresponding to the menu item to change. For example the File menu Quit line originally looks like this:</p> - - <p><code>; (gtk_accel_path "<main>/File/Quit" "<Control>q")</code> - </p> - - <p>To change this menu's keyboard shortcut, first remove the leading semicolon (;), removing the semicolon will tell Geeqie that this menu item has been customized. Then change the keyboard shortcut defined by the text in quotes at the end of the line, be sure to only change the text within the quotes; in this case the text “<control>q”. For example changing the shortcut associated with Quit to the <span class="key">Q</span> key will result in this line:</p> - - <p><code>(gtk_accel_path "<main>/File/Quit" "q")</code> - </p> - - <p>Please note the removed semicolon and the change of “<control>q” to “q”, be careful not to change any of the other text on the line or Geeqie may ignore the customization. The keyboard modifiers and their respective text are listed below:</p> - - <div class="accels_file_syntax"> - <table width="60%" border="0" cellpadding="4" cellspacing="0" rules="rows"> - <col id="accels_file_syntax_col1" width="50%"></col> - <col id="accels_file_syntax_col2" width="50%"></col> - - <thead> - <tr> - <td> - <p>Key</p> - </td> - - <td> - <p>Text to use in accels file</p> - </td> - </tr> - </thead> - - <tbody> - <tr> - <td> - <p><span class="key">Shift</span></p> - </td> - - <td> - <p><shift></p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Ctrl</span></p> - </td> - - <td> - <p><control></p> - </td> - </tr> - - <tr> - <td> - <p><span class="key">Alt</span></p> - </td> - - <td> - <p><alt></p> - </td> - </tr> - </tbody> - </table> - </div> - - <p>Modifiers can be combined, for example in the exit line above, the text would be “<control><shift>q” to set the exit shortcut to <span class="key">Ctrl</span> + <span class="key">Shift</span> + <span class="key">Q</span>.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_navigation.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window_layout.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window_navigation.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,103 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Navigation - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Navigation – Main Window</p> - </th> - - <th> - <p class="next"><a href="main_window_menus.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Navigation</h1> - - <h2>Moving around in the file system</h2> - - <p>To select the folder containing the desired images for display, change to the image's folder using the folder view. Single clicking a folder with the primary mouse button will change the main window to display that folder's contents. When the folder view is displayed as a list, use the folder named “..” to change to the parent folder (the parent folder is the folder that contains the current folder).</p> - - <p>To select a folder with the keyboard, move the focus to the desired folder and press the <span class="key">SpaceBar</span> or <span class="key">Enter</span> key.</p> - - <h2>Moving around within a folder</h2> - - <p>After selecting the desired folder as above, the desired image can be viewed by selecting it from the file list. To select a file for display single click it with the primary mouse button.</p> - - <p>To select a file with the keyboard, move the focus to the desired file. As you move the focus within the file list the image display will update to match the highlighted file.</p> - - <h2>Going home</h2> - - <p>To change to your home folder, click the Home button in the tool bar.</p> - - <h2>Direct path entry</h2> - - <p>The current path is displayed in an entry field above the folder list. 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 <span class="key">Enter</span> key. Tab completion is also available in the path 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> - - <h2>Stepping through images sequentially</h2> - - <p>To change the displayed image to next or previous one within the same folder, use the respective <span class="key">PageDown</span> and <span class="key">PageUp</span> keys. The mouse can also be used to change the image by clicking the image display with the respective primary and middle buttons.</p> - - <p>To change to beginning or end of the image list, use the respective <span class="key">Home</span> or <span class="key">End</span> keys.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="main_window_menus.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/main_window_status_bar.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,109 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Status Bar - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_image_pane.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Status Bar – Main Window</p> - </th> - - <th> - <p class="next"><a href="other_windows.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Status Bar</h1> - - <p>The status bar contains information and details about the contents of the main window. Information displayed includes the progress of generating thumbnails, the number of files in the file list with byte size, the current file selection count including byte size, details about the currently displayed image, and the zoom setting. The current sort preference is also displayed, and can be adjusted from the status bar.</p> - - <p>The status bar is comprised of five sections, from left to right these are a progress bar, sort method, file list counts, image details, and zoom setting. Each section is described below.</p> - - <h2>Progress Bar</h2> - - <p>The Progress bar updates to display the current state of thumbnail generation. When this section contains no text, thumbnail generation is idle. When “Loading thumbs...” is displayed, thumbnails are currently being generated when Geeqie is idle; the progress bar will update to display the percentage of thumbnails that are completed.</p> - - <h2>Sort method</h2> - - <p>This is the method used to sort image names in the file list. Clicking or activating this field will display a menu to allow selection of the sort method.</p> - - <dl class="menu_desc"> - <dt>Name</dt><dd>Images are sorted by file name.</dd> - <dt>Number</dt><dd>Images are sorted by natural numerical order, such that, for example, 9_name.jpg will be listed before 10_name.jpg.</dd> - <dt>Date</dt><dd>Images are sorted by file date on disk.</dd> - <dt>Size</dt><dd>Image are sorted by file size on disk.</dd> - <dt>Ascending</dt><dd>Toggles between increasing and decreasing sort order. A check will appear next to this entry to indicate ascending sort order.</dd> - </dl> - - <h2>File list</h2> - - <p>This section displays the count of files that appear in the file list, including the total byte size. The number of files selected is displayed in parenthesis, including the total byte size of the selected files. The slide show status is also displayed here; when a slide show is running, “Slideshow” will appear, the text will change to “Paused” when a slide show is in the paused state.</p> - - <h2>Image Details</h2> - - <p>This section displays the dimensions (width x height) and file byte size of the image that is active in the image pane. When the format of the file in the image pane can not be determined the dimensions will show as “(0 x 0)”, in addition “(no read permision)” may appear if the file permissions do not allow reading the contents of the file.</p> - - <h2>Zoom</h2> - - <p>This section displays the current zoom ratio. A ratio of 1:1 is the image's original size. When the left number is larger the image is displayed larger than original size, when the right number is larger the image is displayed smaller.</p> - - <p>A tilde (~) appears within the ratio display when the zoom is set to fit the image within the display area. In this zoom mode the ratio is automatically adjusted, and the displayed ratio may not be the actual ratio because the status bar display rounds the actual value to the nearest tenth (0.1).</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_image_pane.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="other_windows.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,90 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="printing.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Options Explained</p> - </th> - - <th> - <p class="next"><a href="options_general.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Options Explained</h1> - - <p>This chapter attempts to explain in detail the Geeqie preferences dialog.</p> - - <div class="submenu"> - <ul> - <li><a href="options_general.html">General Options</a></li> - <li><a href="options_image.html">Image Options</a></li> - <li><a href="options_window.html">Window Options</a></li> - <li><a href="options_filtering.html">Filtering Options</a></li> - <li><a href="options_editor_commands.html">Editor Commands</a></li> - <li><a href="options_properties.html">Properties Options</a></li> - <li><a href="options_advanced.html">Advanced Options</a></li> - <li><a href="options_hidden.html">Hidden Options</a></li> - </ul> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="printing.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_general.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_advanced.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,328 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Advanced Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_properties.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Advanced – Options Explained</p> - </th> - - <th> - <p class="next"><a href="options_hidden.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Advanced Options</h1> - - <p>This section describes the options presented under the Advanced Tab of the preferences dialog.</p> - - <h2>Full Screen</h2> - - <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> - - <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> - - <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> - - <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> - - <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:<i>*</i>\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 <b>*</b>\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"> - <dt>Confirm file delete</dt> - <dd><p>Prompts for confirmation before deleting files.</p></dd> - - <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 <span class="key">Ctrl</span> + <span class="key">D</span> key sequence. May be useful in combination with “confirm file delete”, above, disabled so that accidentally hitting a single key will not result in deleted files.</p></dd> - - <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"><span class="note_label">Note:</span> 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> - - <dt>Folder</dt> - <dd><p>The location of the folder used by the Safe Delete feature.</p></dd> - - <dt>Maximum size</dt> - <dd><p>The size to use for the Safe Delete folder, in megabytes. Note that setting this value to 0 (zero) will disable any limit.</p></dd> - - <dt>Clear button</dt> - <dd><p>Removes all files contained in the Safe Delete folder.</p></dd> - - <dt>View button</dt> - <dd><p>Changes the Geeqie main window to display the contents of the Safe Delete folder.</p></dd> - - </dl> - - <h2>Behavior</h2> - - <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> - - <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"><span class="note_label">Note:</span> Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.</p> - </dd> - - <dt>Show date in directories list view</dt> - <dd><p>Enable this to display directory modification date along its name in the list 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> - - <dt>Show "Copy path" menu item</dt> - <dd><p>Enable this option to show a "Copy path" menu item in applicable menus.</p> - <p>This allows to copy path to files or directories to the clipboard, names are enclosed with double quotes - and separated by space.</p> - </dd> - - <dt>Open recent list maximum size</dt> - <dd><p>This is the number of entries saved in the recent open file list.</p></dd> - - <dt>Drag'n drop icon size</dt> - <dd><p>This is the width and height of the icon generated from image and displayed when doing drap'n drop actions. High resolution screens may require to increase this number.</p></dd> - - </dl> - - <h2>Navigation</h2> - - <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> - - <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 <span class="key">Shift</span> is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down <span class="key">Shift</span> will change the image.</p></dd> - - <dt>Home button path</dt> - <dd><p>This defines the path to use for the "Home" button in the main window. By default or when this field is empty, this is the user's directory.</p></dd> - - <dt>Use current</dt> - <dd><p>Pressing this button will set the <span class="option_name">Home button path</span> to the current open directory.</p></dd> - - </dl> - - <h2>Miscellaneous</h2> - - <dl class="dialog_desc"> - - <dt>Store metadata and cache files in source image's directory</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> - - <dt>Store keywords and comments as XMP tags in images files</dt> - <dd><p>When enabled, Geeqie attempts to store keywords and comments as XMP tags <em>in</em> the image file itself. Obviously, this will modify the concerned files.</p></dd> - - <dt>Custom similarity threshold</dt> - <dd><p>This setting is used by the compare method “similarity (custom)”, located in the Find Duplicates window.</p></dd> - </dl> - - <h2>Image loading and caching</h2> - - <dl class="dialog_desc"> - - <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"><span class="note_label">Note:</span> This setting controls the amount of memory for <em>each</em> image window.</p> - </dd> - - <dt>Decoded image cache size</dt> - <dd><p>This is the cache size in megabytes used by Geeqie to store decoded images.</p></dd> - - <dt>Image read buffer size</dt> - <dd><p>Number of bytes read by Geeqie in one pass, this is for fine tuning, do not modify if you don't know what it does.</p></dd> - - <dt>Image idle loop read count</dt> - <dd><p>This is for fine tuning, do not modify if you don't know what it does.</p></dd> - - </dl> - - <h2>Color profiles</h2> - - <p>Here one can defined color profiles to use.</p> - - <dl class="dialog_desc"> - <dt>Type</dt> - <dd><p>Either input color profile or screen color profile.</p></dd> - <dt>Menu name</dt> - <dd><p>Name of the menu entry corresponding to the color profile.</p></dd> - <dt>File</dt> - <dd><p>Path to the color profile file.</p></dd> - </dl> - - <h2>Debugging</h2> - - <dl class="dialog_desc"> - <dt>Debug level</dt> - <dd><p>This defines the verbosity of debug info sent to console and log window (0 disables the debug output).</p></dd> - </dl> - - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_properties.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_hidden.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_editor_commands.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,188 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Editor Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_filtering.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Editors – Options Explained</p> - </th> - - <th> - <p class="next"><a href="options_properties.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Editor Commands</h1> - - <p>This section describes the options presented under the Editors Tab of the preferences dialog.</p> - - <p>Geeqie includes ten entries that can be used for executing other applications or shell commands with the selected image. These commands are accessible by menu and keyboard shortcuts. The keyboard shortcuts use <span class="key">Ctrl</span> + <span class="key">1</span> through <span class="key">Ctrl</span> + <span class="key">0</span>, which correspond to lines one through ten in the preferences dialog.</p> - - <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> - <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 “<i>command %f</i>”).</p> - - <div class="macro_description"> - <table width="80%" border="0" cellpadding="4" cellspacing="0" rules="rows"> - <col id="macro_description_col1" width="20%"></col> - <col id="macro_description_col2" width="80%"></col> - - <thead> - <tr> - <td> - <p>Macro</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - <tbody> - <tr> - <td> - <p>%f</p> - </td> - - <td> - <p>Inserts list of selected files, may occur only once.</p> - </td> - </tr> - - <tr> - <td> - <p>%p</p> - </td> - - <td> - <p>Command is executed once for each selected file, may occur multiple times.</p> - </td> - </tr> - - <tr> - <td> - <p>%v</p> - </td> - - <td> - <p>Display the result of the command in an output window. Must occur as the first two characters, or immediately after the “%w” macro.</p> - </td> - </tr> - - <tr> - <td> - <p>%V</p> - </td> - - <td> - <p>Like %v above, but when used with %p, only displays output window when multiple files are selected; The output of a single file is suppressed.</p> - </td> - </tr> - - <tr> - <td> - <p>%w</p> - </td> - - <td> - <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> - </dd> - - - <dt>Help button</dt> - <dd><p>Displays reference list of the supported command macros.</p></dd> - - <dt>Defaults button</dt> - <dd><p>Resets all commands to the default settings, discarding any customizations made by the user.</p></dd> - - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_filtering.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_properties.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_filtering.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,120 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Filtering Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_window.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Filtering – Options Explained</p> - </th> - - <th> - <p class="next"><a href="options_editor_commands.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Filtering Options</h1> - - <p>This section describes the options presented under the Filtering Tab of the preferences dialog.</p> - - <h2>Filters</h2> - - <dl class="dialog_desc"> - <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> - <p>Enabled result: A, B, C, a, b, c<br /> - Disabled result: A, a, B, b, C, c</p> - </dd> - - <dt>Disable file filtering</dt> - <dd><p>Enable this to allow Geeqie to list all files, even those that do not contain images.</p></dd> - - </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 <span class="key">Enter</span>; press <span class="key">Escape</span> 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 class="note"><span class="note_label">Note:</span> Unlike all other options in the dialog, filter list changes are applied immediately.</p> - - <dl class="dialog_desc"> - - <dt>Add button</dt> - <dd><p>Adds a new blank line to the filter list, change the parameters to match the desired file type.</p></dd> - - <dt>Remove button</dt> - <dd><p>Removes the selected line from the filter list.</p></dd> - - <dt>Defaults button</dt> - <dd><p>Resets the filter list to the default values, discarding any customizations made by the user.</p></dd> - - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_window.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_editor_commands.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_general.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,141 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>General Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">General – Options Explained</p> - </th> - - <th> - <p class="next"><a href="options_image.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>General Options</h1> - - <p>This section describes the options presented under the General Tab of the preferences dialog.</p> - - <h2>Startup</h2> - - <dl class="dialog_desc"> - <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> - - <dt>Use last path</dt> - <dd><p>When checked, Geeqie will recall the last path used on startup.</p></dd> - </dl> - - - <h2>Thumbnails</h2> - - <dl class="dialog_desc"> - <dt>Size</dt> - <dd><p>Selects the size of the thumbnails displayed throughout Geeqie, dimensions are width by height in pixels.</p></dd> - - <dt>Quality</dt> - <dd><p>Selects the method to use when scaling an image down for thumbnails.</p> - <dl> - <dt>Nearest</dt><dd>Fastest scaler, but results in poor thumbnail quality.</dd> - <dt>Tiles</dt><dd>Thumbnail results are very close to bilinear, with better speed.</dd> - <dt>Bilinear</dt><dd>High quality results, moderately fast.</dd> - <dt>Hyper</dt><dd>Slowest scaler, sometimes gives better results than bilinear.</dd> - </dl> - </dd> - - <dt>Cache thumbnails</dt> - <dd><p>Enable this to save thumbnails to disk, subsequent requests for a thumbnail will be faster. Thumbnails are cached into ($HOME)/.geeqie/thumbnails. Refer to <a href="reference_thumbnails.html">Thumbnails Reference</a> for details.</p></dd> - - <dt>Use shared thumbnail cache</dt> - <dd><p>This will use a thumbnail caching method that is compatible with applications that use the standard thumbnail specification. When this option is enabled thumbnails will be stored in ($HOME)/.thumbnails</p></dd> - - <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> - </dl> - - <h2>Slide show</h2> - - <dl class="dialog_desc"> - <dt>Delay between image change</dt> - <dd><p>Specifies the delay between images for slide shows, in seconds.</p></dd> - - <dt>Random</dt> - <dd><p>When enabled, slide show images will appear in random order.</p> - <p class="note"><span class="note_label">Note:</span> 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> - - <dt>Repeat</dt> - <dd><p>When enabled, slide shows will continue at the beginning after the last image is displayed.</p></dd> - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_image.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_hidden.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Hidden options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_advanced.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Hidden – Options Explained</p> - </th> - - <th> - <p class="next"><a href="reference.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Hidden Options</h1> - - <h2>geeqierc</h2> - - <p>This section describes the options not accessible by the graphical interface, these options exist to maintain behavior of older releases of Geeqie. To change these settings, edit the Geeqie configuration file:</p> - - <p> - <code> -($HOME)/.geeqie/geeqierc -</code> -</p> - - <p><b>lazy_image_sync: [true | <em>false</em>]</b>: This will suppress the image view from changing when selecting a new folder; the current image will remain displayed until the user manually selects another image.</p> - - <p><b>display_dialogs_under_mouse: [true | <em>false</em>]</b>: Enabling this will cause new dialogs to initially position themselves such that they are under the current mouse position.</p> - - <p><b>scroll_reset_method: value</b>: This will set the method used to set the scroll position, or visible region of a new image, value can be:</p> - - <p>0: Move to upper left corner.<br /> - 1: Center image.<br /> - 2: Maintain same visible region as previous image, if possible.</p> - - <p><b>dither_quality:</b> Set the quality when dithering images on displays with a limited color pallet:</p> - - <p>0: No dithering<br /> - 1: Normal<br /> - 2: Best</p> - - <h2>Find Duplicates window</h2> - - <p><b><span class="key">Ctrl</span> + <span class="key">Shift</span> + [Right Mouse click]</b>: Use this to display a dialog containing the data stored for the clicked image file. This is usually only useful for debugging purposes.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_advanced.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="reference.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_image.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,161 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Image Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_general.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Image – Options Explaned</p> - </th> - - <th> - <p class="next"><a href="options_window.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Image Options</h1> - - <p>This section describes the options presented under the Image Tab of the preferences dialog.</p> - - <h2>Zoom</h2> - - <dl class="dialog_desc"> - <dt>Quality</dt> - <dd><p>Selects the method used to scale the size of an image.</p> - - <dl> - <dt>Nearest</dt><dd>Fastest scaler, but results in poor image quality.</dd> - <dt>Tiles</dt><dd>Results are somewhat close to bilinear, with better speed.</dd> - <dt>Bilinear</dt><dd>High quality results, moderately fast.</dd> - <dt>Hyper</dt><dd>Slowest scaler, sometimes gives better results than bilinear.</dd> - </dl> - </dd> - - <dt>Two pass zooming</dt> - <dd><p>Enables Geeqie to first display a scaled image using the nearest zoom quality. After image decoding is complete, the image is scaled again using the selected “Zoom (scaling)” method. This allows faster display of an image as it is decoded from the source file.</p></dd> - - <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 “Fit to Window”.</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> - - </dl> - - <h2>Zoom control</h2> - - <dl class="dialog_desc"> - <dt>When new image is selected</dt> - <dd><p>This controls the behavior of the zoom setting when changing the displayed image.</p> - - <dl> - <dt>Zoom to original size</dt><dd>The new image is set to it's original size.</dd> - <dt>Fit image to window</dt><dd>The new image's zoom is changed so that the image will fit within the current view area.</dd> - <dt>Leave zoom at previous setting</dt><dd>The zoom setting is unchanged, the new image will be scaled the same as the previous image.</dd> - </dl> - </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>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> - - <dl class="dialog_desc"> - <dt>Refresh on file change</dt> - <dd><p>Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.</p> - <p class="note"><span class="note_label">Note:</span> 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> - </dd> - - <dt>Preload next image</dt> - <dd><p>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> - <p class="note"><span class="note_label">Note:</span> 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> - - <dt>Auto rotate image using EXIF information</dt> - <dd><p>Auto rotates images based on data stored in images that include EXIF data.</p></dd> - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_general.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_window.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_properties.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,91 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Properties Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_editor_commands.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Properties – Options explained</p> - </th> - - <th> - <p class="next"><a href="options_advanced.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Properties options</h1> - - <h2>Exif</h2> - - <p>Here is defined what is shown or not in the image properties dialog.</p> - - <p>Each row corresponds to related exif data, three options are possible for each:</p> - - <dl class="dialog_desc"> - <dt>Never</dt> - <dd><p>Label and value will never appear even if value is available from exif data.</p></dd> - <dt>If set</dt> - <dd><p>Label and value will only appear if value is available from exif data.</p></dd> - <dt>Always</dt> - <dd><p>Label will always appear, valude will be displayed when available.</p></dd> - </dl> - - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_editor_commands.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_advanced.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/options_window.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,103 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Window Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_image.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Window – Options Explained</p> - </th> - - <th> - <p class="next"><a href="options_filtering.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Window Options</h1> - - <p>This section describes the options presented under the Windows Tab of the preferences dialog.</p> - - <h2>State</h2> - - <dl class="dialog_desc"> - <dt>Remember window positions</dt> - <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> - </dl> - - <h2>Size</h2> - - <dl class="dialog_desc"> - - <dt>Fit window to image when tools are hidden/floating</dt> - <dd><p>The main window will be resized to accommodate each image's size and proportions when the image pane is the only one visible within the window.</p></dd> - - <dt>Limit size when auto-sizing window</dt> - <dd><p>This will restrict the maximum size a window can grow to automatically fit an image. The value represents the percentage of the desktop size in width and height.</p></dd> - </dl> - - <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.</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" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_image.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options_filtering.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/other_windows.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,86 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Other Windows - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_status_bar.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Other Windows</p> - </th> - - <th> - <p class="next"><a href="other_windows_image_window.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Other Windows</h1> - - <p>This section describes the windows available in Geeqie that can be thought of as general purpose, they are not designed for a specific purpose.</p> - - <div class="submenu"> - <ul> - <li><a href="other_windows_image_window.html">Image Window</a></li> - <li><a href="other_windows_image_properties.html">Image Properties Window</a></li> - <li><a href="other_windows_pan_view.html">Pan View Window</a></li> - - </ul> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="main_window_status_bar.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="other_windows_image_window.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/other_windows_image_properties.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,107 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Image Properties Window - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="other_windows_image_window.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Image Properties – Other Windows</p> - </th> - - <th> - <p class="next"><a href="other_windows_pan_view.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Image Properties Window</h1> - - <p>The image properties window is a dialog that displays various information about a file.</p> - - <p>To display a properties window for a an image select Properties from it's context menu, in most windows pressing <span class="key">Ctrl</span> + <span class="key">P</span> will display the properties of the selected images or files.</p> - - <p>The properties window contains a scaled down image of the file and information about the file under several tabs. If the window contains more than one file, they can be navigated by activating the left and right arrow buttons, or by clicking the primary and middle mouse buttons on the image preview.</p> - - <h2>Image preview</h2> - - <p>This displays the contents of the active file. When the window contains more than one file, they can be navigated with the primary and middle mouse buttons. The image display is also a drag source for drag and drop, start the drag operation by pressing the middle mouse button and dragging the file to the desired target.</p> - - <h2>General tab</h2> - - <p>This displays information about the active file. It includes:</p> - - <dl> - <dt>File attributes</dt> - <dd><p>Modification date and time, size, owner, group, and permissions.</p></dd> - - <dt>Image attributes</dt> - <dd><p>Dimensions, uncompressed size, file or mime type, and existence of an alpha channel.</p></dd> - - <dt>Compress ratio</dt><dd><p>The percentage of file size compared to the size of the image when decoded into memory.</p></dd> - </dl> - - <h2>Keywords tab</h2> - - <p>The keywords tab contains the same information that is in the Keywords sidebar, please refer to the <a href="sidebars_keywords.html">Keywords Sidebar</a> page for details.</p> - - <h2>EXIF tab</h2> - - <p>The EXIF tab contains the same information that is in the EXIF sidebar, please refer to the <a href="sidebars_exif.html">EXIF Sidebar</a> page for details.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="other_windows_image_window.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="other_windows_pan_view.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/other_windows_image_window.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,110 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Image Window - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="other_windows.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Image Window – Other Windows</p> - </th> - - <th> - <p class="next"><a href="other_windows_image_properties.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Image Window</h1> - - <p>An image window is a window that displays only the image.</p> - - <p>An image window can always be opened from the context menu of all images and files. Keyboard shortcuts exist for most windows that display images or files, however the shortcut can vary dependent on the type of window containing them.</p> - - <p>The image pane contained in an image window behaves and operates similar to the image pane of a <a href="main_window_image_pane.html">Main Window</a>. The keyboard shortcuts are the same, and the context menu is the same except “Hide file list” is replaced by “Close window”. The <a href="image_presentation_slideshow.html">slide show</a> and <a href="image_presentation_fullscreen.html">full screen</a> functions are also available.</p> - - <h2>Navigation</h2> - - <p>When the image window contains a list of images or is linked to a collection, the displayed image can be changed forward or backward in the list with the respective <span class="key">PageDown</span> and <span class="key">PageUp</span> keys. In addition, all navigation methods for the mouse and keyboard are similar to that of the image pane of a <a href="main_window_image_pane.html">Main Window</a>.</p> - - <h2>Changing the image</h2> - - <p>To change the contents of an image window, drop the items onto the window with drag and drop. The dropped item can be one or more files, folders, or an image from a collection window:</p> - - <dl> - <dt>One or more <strong>files</strong></dt> - <dd>The image window will display the first image; the list of dropped images can be navigated similar to a main window's image pane.</dd> - - <dt>One or more <strong>folders</strong></dt> - <dd>When the dropped list of items includes a folder, a menu will appear allowing to skip the folders, add their contents, or add their contents recursively. After choosing from the menu the requested files will be added to the image window.</dd> - - <dt>Image from a <strong>collection</strong></dt> - <dd>The image window will change to display the image and become linked to the collection containing the image. Images in the collection can then be navigated and viewed from the image window.</dd> - </dl> - - <p>Changing the image window by dropping a new item onto it will cause the previous list of images or linked collection to be discarded.</p> - - <p>To update the image display in the event that the source file has changed, press the <span class="key">R</span> key.</p> - - <h2>Information and histogram Overlay</h2> - - <p>A small overlay can be turned on and off by pressing the <span class="key">I</span> 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 <span class="key">I</span> key is pressed twice, <span class="key">K</span> key will modify the data displayed, and <span class="key">J</span> 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" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="previous.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="other_windows_image_properties.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/other_windows_pan_view.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,118 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Pan View - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="other_windows_image_properties.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Pan View – Other Windows</p> - </th> - - <th> - <p class="next"><a href="image_management.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Pan View Window</h1> - - <p>This window proposes alternative views of the <em>current directory and its children</em>.<br /> - You can pan the view as you pan an image in normal view mode, using left mouse button and drag.</p> - <p>A primary mouse button click on any image will display informations about the image. Secondary mouse button will show a context menu.</p> - - <p class="note"><span class="note_label">Note:</span> The pan view recursively visits each folder under the specified folder, so be careful it can eat a lot of ressources.</p> - - - <h2>Select a folder</h2> - <dl class="dialog_desc"> - <dt>Location</dt><dd>Set the top folder.</dd> - </dl> - - <h2>Choose a view mode</h2> - <p>A select box let you choose among different view modes:</p> - <dl class="dialog_desc"> - <dt>Timeline</dt><dd>Shows images grouped by date.</dd> - <dt>Calendar</dt><dd>Shows a calendar with the number of images indicated for each day (as dots and number). Left mouse button click will show images in a popup.</dd> - <dt>Folders</dt><dd>Show images grouped by folder. Each box represents a folder. Parent and children folders are shown as boxes enclosing other boxes.</dd> - <dt>Folders (flower)</dt><dd>Show images grouped by folder. Each box represents a folder. Parent folders are linked to children by a line. The top folder is the center of the flower.</dd> - <dt>Grid</dt><dd>All images are shown on a grid.</dd> - </dl> - - <h2>How each image should be represented</h2> - <p>Another select box let you choose the representation of each image:</p> - <dl class="dialog_desc"> - <dt>Dots</dt><dd>Each image is represented by a dot.</dd> - <dt>No images</dt><dd>Each image is represented by a square box.</dd> - <dt>Small thumbnails</dt><dd>Each image is represented by a small thumbnail.</dd> - <dt>Normal thumbnails</dt><dd>Each image is represented by a normal thumbnail.</dd> - <dt>Large thumbnails</dt><dd>Each image is represented by a large thumbnail.</dd> - <dt>1:10 (10%)</dt><dd>Each image is represented by reduced image (1/10 of the original's dimensions).</dd> - <dt>1:4 (25%)</dt><dd>Each image is represented by reduced image (1/4 of the original's dimensions).</dd> - <dt>1:3 (33%)</dt><dd>Each image is represented by reduced image (1/3 of the original's dimensions).</dd> - <dt>1:2 (50%)</dt><dd>Each image is represented by reduced image (1/2 of the original's dimensions).</dd> - <dt>1:1 (100%)</dt><dd>The original image is shown at its normal dimensions.</dd> - </dl> - - <h2>Find</h2> - <p>At the bottom of the window:</p> - <dl class="dialog_desc"> - <dt>Find button</dt><dd>Shows a text field for image search. One can enter a filename or a part of it or a date (yyyy or yyyy-mm or yyyy-mm-dd format, separator can be '/','-',' ','.',','). Pressing <span class="key">Enter</span> key will start the search, pressing it again will move to the next match. Matched file is made visible and details are shown for it.</dd> - </dl> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="other_windows_image_properties.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_management.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/printing.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,197 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Printing - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_presentation_fullscreen.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Printing</p> - </th> - - <th> - <p class="next"><a href="options.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Printing</h1> - - <p>To print an image press <span class="key">Shift</span> + <span class="key">P</span> or select Print from the File menu.</p> - - <p>The print dialog includes tabs that group related printing options, a preview pane, and a Print and Cancel button.</p> - - <h2>Layout tab</h2> - - <dl class="dialog_desc"> - <dt>Source</dt> - <dd> - <p>This selects the group of images to use for print output.</p> - <dl> - <dt>Image</dt><dd>The file with the focus.</dd> - <dt>Selection</dt><dd>The files selected in the main window.</dd> - <dt>All</dt><dd>All files listed in the main window.</dd> - </dl> - </dd> - - <dt>Layout</dt> - <dd><p>Select one image per page, or a Proof sheet that will print multiple images per page.</p> - <dl> - <dt>Image size</dt><dd>When print one image per page, the size of the image in relation to the available print area.</dd> - <dt>Proof size</dt><dd>When printing a Proof sheet, the size of each image in Units (see Paper tab).</dd> - </dl> - </dd> - </dl> - - <h2>Text tab</h2> - - <dl class="dialog_desc"> - <dt>Name</dt><dd><p>Include the file name below each image.</p></dd> - - <dt>Path</dt><dd><p>Include the full path of the file below each image.</p></dd> - - <dt>Date</dt><dd><p>Include the file date below each image.</p></dd> - - <dt>Size</dt><dd><p>Include the file size below each image.</p></dd> - - <dt>Dimensions</dt><dd><p>Include the source image's pixel width and height below each image.</p></dd> - - <dt>Font size</dt><dd><p>The font size to use for the text description of each image, in points.</p></dd> - </dl> - - <h2>Paper tab</h2> - - <dl class="dialog_desc"> - <dt>Format</dt><dd><p>The size of the paper in the printer's paper tray. Many common sizes are provided, however if the paper size is not listed selected the Custom format and enter the paper size in Size below.</p></dd> - - <dt>Size</dt><dd><p>The size of the selected paper format, in Units (below). These numbers can be changed when the paper Format is Custom.</p></dd> - - <dt>Units</dt><dd><p>Select the units for Geeqie to use when conveying measurements of length for paper size, margins, and images sizes to the user.</p></dd> - - <dt>Orientation</dt><dd><p>Select portrait or landscape print output.</p></dd> - - <dt>Margins</dt><dd><p>These values specify the size of the paper edges not to be included in the print region, in Units (above).</p></dd> - </dl> - - <h2>Printer tab</h2> - - <dl class="dialog_desc"> - <dt>Destination</dt> - <dd><p>Use this to select the destination of the print output.</p> - <dl> - <dt>Default printer</dt><dd>Prints to the system default printer.</dd> - <dt>Custom printer</dt><dd>Prints to the printer using the command defined in Custom printer (below).</dd> - <dt>Postscript file</dt><dd>Writes using the postscript format to named File (below).</dd> - <dt>Image file</dt><dd>Writes using the selected File format (below) to named File (below).</dd> - </dl> - </dd> - - <dt>Custom printer</dt> - <dd><p>The command to use when Destination is selected as Custom printer. For convenience, the drop down list includes printers available for use by the printing subsystem.</p></dd> - - <dt>File</dt> - <dd><p>The file to use for output when Destination is Postscript file or Image file.</p></dd> - - <dt>File format</dt> - <dd><p>The image format to use when Destination is Image file.</p></dd> - - <dt>DPI</dt> - <dd><p>Abbreviation for Dots Per Inch. When the Destination is a printer or postscript file, this defines the maximum DPI to use when outputting image data. For example if the Destination printer is only capable of 600 DPI, but the resulting image to print is 1200 DPI, Geeqie will scale the image down to 600 DPI before sending it to the printer. This can greatly reduce the size of a print job when printing Proof Sheets or very large images.</p></dd> - </dl> - - <h2>Preview</h2> - - <p>The preview displays a small version of the output that will result with the current settings. The preview will update whenever a setting is changed that will effect the print output.</p> - - <p>The preview will indicate the number of pages that will be printed, to see a preview of a specific page change to that page by activating the left or right arrow buttons located below the preview.</p> - - <p>The size of the preview can be changed using the three zoom buttons located below the preview.</p> - - <p>The preview includes several reference lines that are <i>not included</i> in the final print:</p> - - <dl class="dialog_desc"> - <dt>Reference grid</dt> - <dd><p>Light gray lines that form a grid over the entire page, the spacing between these lines is dependent on the current measurement unit:</p> - <dl> - <dt>Inch</dt><dd>1 inch.</dd> - <dt>Points</dt><dd>72 points.</dd> - <dt>Centimeters or Millimeters</dt><dd>1 centimeter.</dd> - </dl> - </dd> - - <dt>Margins</dt> - <dd><p>Blue lines along each edge of the page represent the location of the print margins, the non-printable area of the page is also gray.</p></dd> - - <dt>Proof sheet grid</dt> - <dd><p>When the layout is set to Proof sheet, each proof location is indicated with a red rectangle.</p></dd> - - </dl> - - <h2>Remember print settings</h2> - - <p>Enable this check box to retain the current settings as the default for the print dialog. This option only retains the settings when a print operation is started by activating the print button. In addition, only the settings relevant to the current print operation will be retained.</p> - - <h2>Print button</h2> - - <p>Activate the print button to start the print job, the dialog will change to display the progress as images are sent to the selected print destination.</p> - - <h2>Cancel button</h2> - - <p>Activate this button to close the print dialog, no printing will be performed.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="image_presentation_fullscreen.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="options.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/reference.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,84 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Reference - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_hidden.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Reference</p> - </th> - - <th> - <p class="next"><a href="reference_command_line.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Reference</h1> - - <div class="submenu"> - <ul> - <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> - <li><a href="reference_management.html">Cache and Data Management</a></li> - </ul> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="options_hidden.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="reference_command_line.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/reference_command_line.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,500 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Command Line Options - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Command Line Options – Reference</p> - </th> - - <th> - <p class="next"><a href="reference_keyboard_shortcuts.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Command Line Options</h1> - - <p>These are the command line options available to Geeqie:</p> - - <div class="command_line_options"> - <table width="80%" border="1" cellpadding="4" cellspacing="0"> - <col id="command_line_options_col1" width="20%"></col> - <col id="command_line_options_col2" width="30%"></col> - <col id="command_line_options_col3" width="50%"></col> - - <thead> - <tr> - <td> - <p>Short Option</p> - </td> - - <td> - <p>Long Option</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - <tbody> - <tr> - <td> - <p>+t</p> - </td> - - <td> - <p>--with-tools</p> - </td> - - <td> - <p>Show file list, menu, and statusbar.</p> - </td> - </tr> - - <tr> - <td> - <p>-t</p> - </td> - - <td> - <p>--without-tools</p> - </td> - - <td> - <p>Hide file list, menu, and statusbar. Window contains image only.</p> - </td> - </tr> - - <tr> - <td> - <p>-f</p> - </td> - - <td> - <p>--fullscreen</p> - </td> - - <td> - <p>Start up in fullscreen.</p> - </td> - </tr> - - <tr> - <td> - <p>-s</p> - </td> - - <td> - <p>--slideshow</p> - </td> - - <td> - <p>Start up in slideshow mode.</p> - </td> - </tr> - - <tr> - <td> - <p>-l</p> - </td> - - <td> - <p>--list</p> - </td> - - <td> - <p>Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection.</p> - </td> - </tr> - - <tr> - <td> - <p>-r</p> - </td> - - <td> - <p>--remote</p> - </td> - - <td> - <p>Send command line options to existing Geeqie process.</p> - </td> - </tr> - - <tr> - <td> - <p>-rh</p> - </td> - - <td> - <p>--remote-help</p> - </td> - - <td> - <p>List command line options available to --remote.</p> - </td> - </tr> - - <tr> - <td> - <p>-h</p> - </td> - - <td> - <p>--help</p> - </td> - - <td> - <p>Display brief command line option list.</p> - </td> - </tr> - - <tr> - <td> - <p>-v</p> - </td> - - <td> - <p>--version</p> - </td> - - <td> - <p>Display version of Geeqie.</p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>--debug</p> - </td> - - <td> - <p>Enable Debug output to console.</p> - </td> - </tr> - </tbody> - </table> - </div> - - <h2>Remote commands</h2> - - <p>The --remote command line option will send all entered commands to an existing Geeqie process, a new process will be started if one does not exist. These are the additional commands that can be used with the remote command:</p> - - <div class="remote_commands"> - <table width="80%" border="1" cellpadding="4" cellspacing="0"> - <col id="remote_commands_col1" width="20%"></col> - <col id="remote_commands_col2" width="30%"></col> - <col id="remote_commands_col3" width="50%"></col> - - <thead> - <tr> - <td> - <p>Short Option</p> - </td> - - <td> - <p>Long Option</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - - <tbody> - <tr> - <td> - <p>-n</p> - </td> - - <td> - <p>--next</p> - </td> - - <td> - <p>Change main window to display next image.</p> - </td> - </tr> - - <tr> - <td> - <p>-b</p> - </td> - - <td> - <p>--back</p> - </td> - - <td> - <p>Change main window to display previous image.</p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>--first</p> - </td> - - <td> - <p>Change main window to display first image.</p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>--last</p> - </td> - - <td> - <p>Change main window to display last image.</p> - </td> - </tr> - - <tr> - <td> - <p>-f</p> - </td> - - <td> - <p>--fullscreen</p> - </td> - - <td> - <p>Toggle full screen mode of the main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-fs</p> - </td> - - <td> - <p>--fullscreen-start</p> - </td> - - <td> - <p>Start full screen mode for main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-fS</p> - </td> - - <td> - <p>--fullscreen-stop</p> - </td> - - <td> - <p>Stop full screen mode for main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-s</p> - </td> - - <td> - <p>--slideshow</p> - </td> - - <td> - <p>Toggle slide show for main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-ss</p> - </td> - - <td> - <p>--slideshow-start</p> - </td> - - <td> - <p>Start slide show for main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-sS</p> - </td> - - <td> - <p>--slideshow-stop</p> - </td> - - <td> - <p>Stop slide show for main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-sr<folder></p> - </td> - - <td> - <p>--slideshow-recurse<folder></p> - </td> - - <td> - <p>Start recursive slide show for <folder> in main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-d<n></p> - </td> - - <td> - <p>--delay=<n></p> - </td> - - <td> - <p>Set slide show delay to <n> seconds, range is 0.1 to 3600</p> - </td> - </tr> - - <tr> - <td> - <p>+t</p> - </td> - - <td> - <p>--tools-show</p> - </td> - - <td> - <p>Show tools for main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-t</p> - </td> - - <td> - <p>--tools-hide</p> - </td> - - <td> - <p>Hide tools for main window.</p> - </td> - </tr> - - <tr> - <td> - <p>-q</p> - </td> - - <td> - <p>--quit</p> - </td> - - <td> - <p>Quit Geeqie.</p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>file:<filename></p> - </td> - - <td> - <p>Change main window to display <filename></p> - </td> - </tr> - - <tr> - <td> </td> - - <td> - <p>view:<filename></p> - </td> - - <td> - <p>Open new window containing <filename></p> - </td> - </tr> - </tbody> - </table> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="reference_keyboard_shortcuts.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/reference_keyboard_shortcuts.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,985 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Keyboard Shortcuts - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_command_line.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Keyboard Shortcuts – Reference</p> - </th> - - <th> - <p class="next"><a href="reference_thumbnails.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Keyboard Shortcuts</h1> - - <div class="shortcuts"> - <table width="90%" border="1" cellpadding="2" cellspacing="0"> - <col id="keyboard_shortcuts_col1" width="33%"></col> - <col id="keyboard_shortcuts_col2" width="33%"></col> - <col id="keyboard_shortcuts_col3" width="33%"></col> - - <thead> - <tr> - <th> - <p>Shortcut</p> - </th> - <th> - <p>Mouse</p> - </th> - <th> - <p>Action</p> - </th> - </tr> - </thead> - - <tbody> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Image Navigation</strong></p> - </td> - </tr> - <tr> - <td> - <p><span class="key">PageDown</span></p> - </td> - <td> - <p>Left Click on image view<br /> - Mouse Wheel down <a href="#bottomnote1" class="bottomnote">(*)</a></p> - </td> - <td> - <p>Change to next image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">PageUp</span></p> - </td> - <td> - <p>Middle Click on image view<br /> - Mouse Wheel up <a href="#bottomnote1" class="bottomnote">(*)</a></p> - </td> - <td> - <p>Change to previous image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Home</span></p> - </td> - <td> </td> - <td> - <p>Change to first image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">End</span></p> - </td> - <td> </td> - <td> - <p>Change to last image.</p> - </td> - </tr> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Image panning</strong> (image has keyboard focus)</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Arrows</span></p> - </td> - <td> - <p>Left Drag on image view<br /> - <span class="key">Shift</span> + Mouse Wheel <a href="#bottomnote1" class="bottomnote">(*)</a></p> - </td> - <td> - <p>Pan image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">Arrows</span></p> - </td> - <td> </td> - <td> - <p>Pan Image faster.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Arrows</span></p> - </td> - <td> </td> - <td> - <p>Pan to respective edge of image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Space</span></p> - </td> - <td> </td> - <td> - <p>Change to next image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Backspace</span></p> - </td> - <td> </td> - <td> - <p>Change to previous image.</p> - </td> - </tr> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>File Menu</strong></p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">N</span></p> - </td> - <td> </td> - <td> - <p>New Window</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">C</span></p> - </td> - <td> </td> - <td> - <p>Open a new empty collection window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">O</span></p> - </td> - <td> </td> - <td> - <p>Display open collection dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">F3</span></p> - </td> - <td> </td> - <td> - <p>Open new search window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">D</span></p> - </td> - <td> </td> - <td> - <p>Open new Find Duplicates window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">P</span></p> - </td> - <td> </td> - <td> - <p>Open print dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">F</span></p> - </td> - <td> </td> - <td> - <p>Create new folder in current path.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">C</span></p> - </td> - <td> </td> - <td> - <p>Copy selected images, opens destination selection dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">M</span></p> - </td> - <td> </td> - <td> - <p>Move selected images, opens destination selection dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">R</span></p> - </td> - <td> </td> - <td> - <p>Rename selected images, opens rename dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">D</span></p> - <p><span class="key">Delete</span></p> - </td> - <td> </td> - <td> - <p>Delete selected images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">W</span></p> - </td> - <td> </td> - <td> - <p>Close window, Geeqie exits when last window is closed.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Q</span></p> - </td> - <td> </td> - <td> - <p>Quit Geeqie.</p> - </td> - </tr> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Edit Menu</strong></p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">1</span> ... <span class="key">0</span></p> - </td> - <td> </td> - <td> - <p>Run external edit command on selected images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">A</span></p> - </td> - <td> </td> - <td> - <p>Select all images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Shift</span> + <span class="key">A</span></p> - </td> - <td> </td> - <td> - <p>Unselect all images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">P</span></p> - </td> - <td> </td> - <td> - <p>Open image properties window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">O</span></p> - </td> - <td> </td> - <td> - <p>Open Geeqie preferences window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">]</span></p> - </td> - <td> </td> - <td> - <p>Rotate image clockwise 90 degrees.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">[</span></p> - </td> - <td> </td> - <td> - <p>Rotate image counterclockwise 90 degree.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">R</span></p> - </td> - <td> </td> - <td> - <p>Rotate image 180 degrees.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">M</span></p> - </td> - <td> </td> - <td> - <p>Flip image horizontally (mirror).</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">F</span></p> - </td> - <td> </td> - <td> - <p>Flip image vertically.</p> - </td> - </tr> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>View Menu</strong></p> - </td> - </tr> - <tr> - <td> - <p><span class="key">+</span>, <span class="key">=</span></p> - </td> - <td> - <p><span class="key">Ctrl</span> + Mouse Wheel up</p> - </td> - <td> - <p>Zoom image in.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">-</span></p> - </td> - <td> - <p><span class="key">Ctrl</span> + Mouse Wheel down</p> - </td> - <td> - <p>Zoom image out.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Z</span></p> - </td> - <td> </td> - <td> - <p>Reset zoom to original size (1:1).</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">X</span></p> - </td> - <td> </td> - <td> - <p>Fit image to window size.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">W</span></p> - </td> - <td> </td> - <td> - <p>Zoom image to fit window width.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">H</span></p> - </td> - <td> </td> - <td> - <p>Zoom image to fit window height.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">1</span></p> - </td> - <td> </td> - <td> - <p>Set zoom to 1:1</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">2</span></p> - </td> - <td> </td> - <td> - <p>Set zoom to 2:1</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">3</span></p> - </td> - <td> </td> - <td> - <p>Set zoom to 3:1</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">4</span></p> - </td> - <td> </td> - <td> - <p>Set zoom to 4:1</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">7</span></p> - </td> - <td> </td> - <td> - <p>Set zoom to 1:4</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">8</span></p> - </td> - <td> </td> - <td> - <p>Set zoom to 1:3</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">9</span></p> - </td> - <td> </td> - <td> - <p>Set zoom to 1:2</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">T</span></p> - </td> - <td> </td> - <td> - <p>Toggle display of thumbnails when in list view.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">L</span></p> - </td> - <td> </td> - <td> - <p>Display file list as detailed list view.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">I</span></p> - </td> - <td> </td> - <td> - <p>Display file list as icon view.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">T</span></p> - </td> - <td> </td> - <td> - <p>Toggle folder display between list and tree views.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">R</span></p> - </td> - <td> </td> - <td> - <p>Refresh file list.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">L</span></p> - </td> - <td> </td> - <td> - <p>Toggle floating of file display.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">H</span></p> - </td> - <td> </td> - <td> - <p>Toggle hiding of file display.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">E</span></p> - </td> - <td> </td> - <td> - <p>Toggle EXIF sidebar.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">S</span></p> - </td> - <td> </td> - <td> - <p>Toggle Sort Manager sidebar.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">K</span></p> - </td> - <td> </td> - <td> - <p>Toggle Keywords sidebar.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">F</span></p> - <p><span class="key">V</span></p> - </td> - <td> </td> - <td> - <p>Toggle full screen.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">I</span></p> - </td> - <td> </td> - <td> - <p>Toggle information overlay in full screen.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">S</span></p> - </td> - <td> </td> - <td> - <p>Toggle slideshow.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">P</span></p> - </td> - <td> </td> - <td> - <p>Toggle pause of slideshow.</p> - </td> - </tr> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Help Menu</strong></p> - </td> - </tr> - <tr> - <td> - <p><span class="key">F1</span></p> - </td> - <td> </td> - <td> - <p>Open User Manual in browser.</p> - </td> - </tr> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Collection Window</strong></p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Arrows</span></p> - </td> - <td> </td> - <td> - <p>Move selection.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Shift</span> + <span class="key">Arrows</span></p> - </td> - <td> </td> - <td> - <p>Select multiple images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Arrows</span></p> - </td> - <td> </td> - <td> - <p>Move focus without changing selection.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">SpaceBar</span></p> - </td> - <td> </td> - <td> - <p>Select only image with focus.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">SpaceBar</span></p> - </td> - <td> </td> - <td> - <p>Toggle selection of image with focus.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Home</span></p> - </td> - <td> </td> - <td> - <p>Move focus to first image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">End</span></p> - </td> - <td> </td> - <td> - <p>Move focus to last image.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">A</span></p> - </td> - <td> </td> - <td> - <p>Select all images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">Shift</span> + <span class="key">A</span></p> - </td> - <td> </td> - <td> - <p>Unselect all images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Delete</span></p> - </td> - <td> </td> - <td> - <p>Remove selected image from collection, does not delete image from disk.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">L</span></p> - </td> - <td> </td> - <td> - <p>Add images from main window's file list.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">T</span></p> - </td> - <td> </td> - <td> - <p>Toggle display of icon filenames.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">N</span></p> - </td> - <td> </td> - <td> - <p>Sort collection by name.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">D</span></p> - </td> - <td> </td> - <td> - <p>Sort collection by file date.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">B</span></p> - </td> - <td> </td> - <td> - <p>Sort collection by file size.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">P</span></p> - </td> - <td> </td> - <td> - <p>Sort collection by file path.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">I</span></p> - </td> - <td> </td> - <td> - <p>Sort collection by natural numerical order.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Enter</span></p> - </td> - <td> </td> - <td> - <p>View image with focus in main window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">V</span></p> - </td> - <td> </td> - <td> - <p>View image with focus in new window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">1</span> ... <span class="key">0</span></p> - </td> - <td> </td> - <td> - <p>Run external edit command on selected images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">S</span></p> - </td> - <td> </td> - <td> - <p>Save collection.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">S</span></p> - </td> - <td> </td> - <td> - <p>Save collection as, opens destination dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">A</span></p> - </td> - <td> </td> - <td> - <p>Append to collection, opens append dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">C</span></p> - </td> - <td> </td> - <td> - <p>Copy selected images, opens destination selection dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">M</span></p> - </td> - <td> </td> - <td> - <p>Move selected images, opens destination selection dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">R</span></p> - </td> - <td> </td> - <td> - <p>Rename selected images, opens rename dialog.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">D</span></p> - </td> - <td> </td> - <td> - <p>Delete selected images.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">P</span></p> - </td> - <td> </td> - <td> - <p>Open image properties window.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">Ctrl</span> + <span class="key">W</span></p> - </td> - <td> </td> - <td> - <p>Close collection window.</p> - </td> - </tr> - <tr> - <td colspan="3" class="shortcuts-separator"> - <p><strong>Find Duplicates Window</strong> (same as Collection Window above, with the following additions)</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">1</span></p> - </td> - <td> </td> - <td> - <p>Select group 1 duplicates.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">2</span></p> - </td> - <td> </td> - <td> - <p>Select group 2 duplicates.</p> - </td> - </tr> - <tr> - <td> - <p><span class="key">C</span></p> - </td> - <td> </td> - <td> - <p>Open new collection window and add selected images.</p> - </td> - </tr> - </tbody> - </table> - </div> - - <p class="bottomnote"><a id="bottomnote1" name="bottomnote1"></a><span class="note_label">(*) Note:</span> Default Mouse wheel functions can be altered by changing the <a href="options_advanced.html" class="option_name">Mouse wheel scrolls image</a> option.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_command_line.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="reference_thumbnails.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/reference_management.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,292 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Cache and Data Management - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_thumbnails.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Cache and Data Management – Reference</p> - </th> - - <th> - <p class="next"><a href="credits.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Cache and Data Maintenance</h1> - - <p>Thumbnails and other cached data can be maintained from the dialog accessible by selecting Thumbnail maintenance from the Edit menu of the main window.</p> - - <h2>Geeqie thumbnail cache</h2> - - <p>The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the <a href="image_search_search.html">search</a> and <a href="image_search_finding_duplicates.html">find duplicates</a> utilities.</p> - - <dl class="dialog_desc"> - <dt>Clean up</dt> - <dd><p>Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated.</p></dd> - - <dt>Clear cache</dt> - <dd><p>Removes all thumbnails and data stored in the user's home folder: $HOME/.geeqie/thumbnails.</p></dd> - </dl> - - <h2>Shared thumbnail cache</h2> - - <p>The utilities listed here operate on the shared thumbnail mechanism.</p> - - <dl class="dialog_desc"> - <dt>Clean up</dt> - <dd><p>Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated.</p></dd> - - <dt>Clear cache</dt> - <dd><p>Removes all thumbnails stored in the user's home folder: $HOME/.thumbnails.</p></dd> - </dl> - <h2>Create thumbnails</h2> - - <p>This utility will render thumbnails using the current thumbnail caching mechanism, as determined in <a href="options_general.html">preferences</a>.</p> - - <dl class="dialog_desc"> - - <dt>Render</dt> - <dd><p>Pre-render thumbnails for a specific folder, the utility has the following options:</p></dd> - - <dt>Include subfolders</dt> - <dd><p>Enable to include all images contained in the subfolders of folder.</p></dd> - - <dt>Store thumbnails local to source images</dt> - <dd><p>The generated thumbnails will be stored local to the source images, if you have the permissions to write to the folder containing the images.</p></dd> - - </dl> - - <h2>Metadata</h2> - - <p>This utility operates on the data store for <a href="sidebars_keywords.html">keywords and comments</a> located in the user's home folder: $HOME/.geeqie/metadata.</p> - - <dl class="dialog_desc"> - <dt>Clean up</dt> - <dd><p>Removes keywords and comments for which the source image is no longer present.</p></dd> - </dl> - - <h2>File locations</h2> - - <p>The various file locations and their use are listed below. <i><HOME></i> refers to your home folder and <i><SOURCE></i> refers to the folder containing the image.</p> - - <div class="file_locations"> - <table width="80%" border="1" cellpadding="4" cellspacing="0"> - <col id="file_locations_col1" width="50%"></col> - <col id="file_locations_col2" width="50%"></col> - - <thead> - <tr> - <td> - <p>Folder or File name</p> - </td> - - <td> - <p>Description</p> - </td> - </tr> - </thead> - - <tbody> - <tr> - <td colspan="2" class="file_locations_subtitle"> - <p>Thumbnails</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.thumbnails</p> - </td> - - <td> - <p>Shared thumbnail cache folder.</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie/thumbnails</p> - </td> - - <td> - <p>Classic Geeqie thumbnail cache folder. Also used to cache data used for the search and find duplicates utilities to increase the speed for subsequent searches.</p> - </td> - </tr> - - <tr> - <td> - <p><em><SOURCE>/.</em>thumbnails - </p> - </td> - - <td> - <p>Local thumbnail cache folder.</p> - </td> - </tr> - - <tr> - <td colspan="2" class="file_locations_subtitle"> - <p>Metadata (keywords and comments)</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie/metadata</p> - </td> - - <td> - <p>Metadata stored in user's home folder.</p> - </td> - </tr> - - <tr> - <td> - <p><em><SOURCE></em>/.metadata</p> - </td> - - <td> - <p>Metadata stored local to source image. Requires option to be enabled in advanced preferences.</p> - </td> - </tr> - - <tr> - <td colspan="2" class="file_locations_subtitle"> - <p>Collections</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie/collections</p> - </td> - - <td> - <p>Default location for Geeqie collections, collections in this folder will appear in the <a href="sidebars_sort_manager.html">sort manager</a> sidebar.</p> - </td> - </tr> - - <tr> - <td colspan="2" class="file_locations_subtitle"> - <p>Preferences</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie</p> - </td> - - <td> - <p>Geeqie preferences folder.</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie/geeqierc</p> - </td> - - <td> - <p>Geeqie preferences rc file.</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie/history</p> - </td> - - <td> - <p>Historic data such as last several folders visited, bookmarks, and recently used collections. Also contains default print settings.</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie/accels</p> - </td> - - <td> - <p>Keyboard shortcut mapping.</p> - </td> - </tr> - - <tr> - <td colspan="2" class="file_locations_subtitle"> - <p>Safe Delete</p> - </td> - </tr> - - <tr> - <td> - <p><em><HOME></em>/.geeqie/trash</p> - </td> - - <td> - <p>Default location of the safe delete folder.</p> - </td> - </tr> - </tbody> - </table> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_thumbnails.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="credits.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/reference_thumbnails.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,113 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Thumbnails - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_keyboard_shortcuts.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Thumbnails – Reference</p> - </th> - - <th> - <p class="next"><a href="reference_management.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Thumbnails</h1> - - <p>Note: This page only refers the Geeqie thumbnail caching mechanism, the shared thumbnail cache mechanism is not explained here.</p> - - <h2>Format</h2> - - <p>Thumbnails are stored in PNG image format. The thumbnail name is the name of the source image with “.png” appended.</p> - - <p>The modification time (mtime) of the thumbnail is set to match the source file. Thumbnails are regenerated when the timestamps of the thumbnail and source file do not match.</p> - - <h2>Location</h2> - - <p>Thumbnails are stored in:</p> - - <p><code>($HOME)/.geeqie/thumbnails</code></p> - - <p>The directory structure of the thumbnail cache duplicates the location of the source files, for example a source file with the name:</p> - - <p><code>/path/to/image.jpg</code></p> - - <p>will store the thumbnail in:</p> - - <p><code>($HOME)/.geeqie/thumbnails/path/to/image.jpg.png</code></p> - - <p>When thumbnails are to be stored local to the source file, the thumbnail will be placed in:</p> - - <p><code>/path/to/.thumbnails/image.jpg.png</code></p> - - <p>Local thumbnail caching is enabled with the option “Cache thumbnails into .thumbnails” on the <a href="options_general.html">General</a> tab of the options dialog. If it is not possible to store the thumbnail local to the source file (usually due to no write permissions), Geeqie will fall back to saving the thumbnail in the user's ($HOME)/.geeqie/thumbnails folder.</p> - - <h2>Size</h2> - - <p>Geeqie allows the following sizes for thumbnails:</p> - - <p>24x24, 32x32, 48x48, 64x64, 96x72, 96x96, 129x96, 128x128, 160x120, 160x160, 192x144, 192x192, 256x192, 256x256</p> - - <p>The thumbnail is scaled to fit within the preferred size maintaining the aspect ratio. Thumbnails are not cached for images that are equal to or smaller than the preferred thumbnail size.</p> - - <p>When a cached thumbnail's width and height do not match the preferred size, the thumbnail is regenerated.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="reference_keyboard_shortcuts.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="reference_management.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/sidebars.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,85 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Sidebars - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="collections.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Sidebars</p> - </th> - - <th> - <p class="next"><a href="sidebars_exif.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Sidebars</h1> - - <p>A sidebar is a panel that appears next to an image, and displays additional information about the image.</p> - - <div class="submenu"> - <ul> - <li><a href="sidebars_exif.html">EXIF sidebar</a></li> - <li><a href="sidebars_sort_manager.html">Sort Manager sidebar</a></li> - <li><a href="sidebars_keywords.html">Keywords sidebar</a></li> - </ul> - </div> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="collections.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="sidebars_exif.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/sidebars_exif.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,97 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>EXIF Sidebar - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">EXIF – Sidebars</p> - </th> - - <th> - <p class="next"><a href="sidebars_sort_manager.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>EXIF Sidebar</h1> - - <p>The EXIF sidebar displays EXIF data that is embedded in an image. The sidebar has two choices of data display, standard and advanced.</p> - - <p>To toggle display of the The EXIF sidebar press <span class="key">Ctrl</span> + <span class="key">E</span> or select “Exif data” from the View menu.</p> - - <p><b>EXIF</b>: Stands for “Exchangeable image file format”, it is the common format used to store additional information into the JPEG and TIFF file formats. EXIF is the standard for saving the settings used when taking a photo with a digital camera, however other imaging devices and some software also use the EXIF format to store settings in the image file.</p> - - <p>The EXIF parser in Geeqie conforms to version 2.2 of the EXIF specification. In addition, manufacturer extensions to the format are not supported, this includes the proprietary data stored in the MakerNote Tag.</p> - - <h2>Standard view</h2> - - <p>The standard view of the EXIF sidebar displays information that is common to most cameras, data is displayed in the standard format for each attribute.</p> - - <h2>Advanced view</h2> - - <p>The advanced view displays all tags that are present in the image. Unlike the standard view, data is displayed in raw format.</p> - - <h2>Customizing the standard view</h2> - - <p>Additional information can be added to the standard view. To add custom EXIF tags to the standard view, switch to the advanced view. The first column of each row in the advanced view is a check box, enabling the check box will result in the corresponding tag to appear in the standard view. Customized tags are displayed in the order that they are added.</p> - - <p>To remove customized tags from the standard view, use the checkbox displayed next to the tag (or tags) you want to remove. Or you may switch to the advanced view and disable the check box here.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="sidebars_sort_manager.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/sidebars_keywords.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,124 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Keywords Sidebar - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars_sort_manager.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Keywords – Sidebar</p> - </th> - - <th> - <p class="next"><a href="image_presentation.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Keywords Sidebar</h1> - - <p>The Keywords sidebar displays keywords and comments for the active image, and provides functions for editing them.</p> - - <p>To toggle display of the Keywords sidebar press <span class="key">Ctrl</span> + <span class="key">K</span> or select “Keywords” from the View menu.</p> - - <p><b>Keywords</b> are single words that are associated to an image. They can be used to classify, group, or describe; the uses for keywords are only limited by your imagination. Images associated to one or more keywords can be found using the <a href="image_search_search.html">Search window</a>.</p> - - <p><b>Comments</b> is an area to associate a textual description to an image.</p> - - <p>The sidebar is comprised of three sections: Keywords, Comments and a button bar.</p> - - <h2>Keywords</h2> - - <p>The keywords panel consists of two fields. The left field is a text entry that allows direct typing of one or more keywords. The right field is a list of favorite or often used keywords that can be associated with the active image by filling the check box next to the keyword.</p> - - <p>The <b>text entry</b> allows typing keywords to associate them with the active image. Keywords entered here can be separated by a space, tab, or comma; creating a new line by pressing <span class="key">Enter</span> will also separate keywords.</p> - - <p>The <b>favorite keywords</b> list allows quick selection of commonly used keywords. <span class="key">A</span> keyword is enabled when the check box next to it is filled. The text entry will update as words from the list are selected. To edit the favorite keywords list activate the favorites button at the bottom of the sidebar.</p> - - <h2>Comments</h2> - - <p>This text entry allows entering text to be associated with the active image.</p> - - <h2>The buttons</h2> - - <p class="note"><span class="note_label">Note:</span> 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="dialog_desc"> - - <dt>Edit favorite keywords list</dt> - <dd><p>Activate this button to display a dialog to edit the favorite keywords list. For details on the dialog refer to the section titled Favorite Keywords Dialog, below.</p></dd> - - <dt>Add keywords to selected files</dt> - <dd><p>This button will be active when more than one image is selected. Activate this button to add all keywords currently displayed to the selected list of files.</p></dd> - - <dt>Add keywords to selected files, replacing existing ones</dt> - <dd><p>This button will be active when more than one image is selected. Activate this button to replace all keywords in the selected files with the ones that are currently displayed. All previously existing keywords for those files will be lost.</p></dd> - - <dt>Save comment now</dt> - <dd><p>Saving of changes to keywords and comments are slightly delayed to reduce writes to disk. If the changes have not yet been written to disk this button will be active, activating it will immediately save the changes.</p></dd> - - </dl> - - <h2>Favorite Keywords Dialog</h2> - - <p>This dialog allows editing of the favorite keywords list that is displayed in the Keywords sidebar. Activating the Add button will create a new blank item at the current position in the list, the new item will immediately change to the editing state to allow entry of the new keyword. Activating the Remove button will remove the selected keyword from the list. To edit a row highlight it then click it or press <span class="key">Enter</span> on the keyboard.</p> - - <p>Activate OK to save the changes and close the dialog, Cancel will discard the changes and close the dialog.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars_sort_manager.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="image_presentation.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/sidebars_sort_manager.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,143 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Sort Manager - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars_exif.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Sort Manager – Sidebars</p> - </th> - - <th> - <p class="next"><a href="sidebars_keywords.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <h1>Sort Manager Sidebar</h1> - - <p>The Sort Manager sidebar provides a convenient method to quickly sort many files into a set of folders or collections.</p> - - <p>To toggle display of the Sort Manager press <span class="key">Ctrl</span> + <span class="key">S</span> or select “Sort manager” from the View menu.</p> - - <p>The mode of the Sort Manager is selected by the drop down list under the sidebar title. The Folder mode allows moving or copying the visible image to a folder, and the Collection mode allows adding the visible image or file selection to a collection.</p> - - <h2>Folder view</h2> - - <p>The Sort Manager folder view consists of a vertical list for bookmarking folders, a section to select the operation to perform, and a set of buttons along the bottom.</p> - - <p>Clicking or activating an item in the list will copy, move, or link the active image's file to that location. The active image will then change to the next image.</p> - - <h3>Bookmark list</h3> - - <p>This is a list of possible folders to use as a destination for the selected operation. A context menu will appear by right clicking on an item, or pressing the menu key when the item has the focus.</p> - - <p>Folders can be added to the list by activating the Add button at the bottom of the sidebar, or dragging a folder onto the list.</p> - - <p>To edit an item select “Properties” from it's context menu. A dialog will appear allowing the Name, Path, and Icon for the item to be changed. Select OK to close the dialog and apply the changes, or Cancel to close the dialog and discard the changes.</p> - - <p>To change the order of the list, select “Move up” or “Move down” from the item's context menu. To move an item with the keyboard move the focus to that item, then press <span class="key">Shift</span> + <span class="key">Up</span> or <span class="key">Shift</span> + <span class="key">Down</span> to move the item.</p> - - <p>To remove an item from the list select “Remove” from it's context menu.</p> - - <h3>Copy, Move, and Link</h3> - - <p>These are the available operations to use on the active image, they should be self explanatory.</p> - - <h3>Add button</h3> - - <p>Activate this button to add a folder to the bookmark list. A dialog will appear to allow selection of the folder to use for the new item.</p> - - <h3>Undo button</h3> - - <p>Activate this button to undo the last copy, move, or link operation. The undo function can only reverse the most recent operation.</p> - - <h2>Collection view</h2> - - <p>The Sort Manager collection view consists of a vertical list of collection, a section to determine the current selection, and a set of buttons along the bottom.</p> - - <p>Clicking or activating an item in the list will add the selected image to that collection.</p> - - <h3>Collection list</h3> - - <p>This is the list of collections located in the folder $HOME/.geeqie/collections. Activating a member of this list will result in the current image selection to be added to the collection. If the image already exists within the collection, it will not be added a second time.</p> - - <p>A new empty collection can be added to the list by activating the Add button at the bottom of the sidebar.</p> - - <h3>Choosing the selection style</h3> - - <p>The images to add when activating a collection is determined by the selection style:</p> - - <dl class="dialog_desc"> - <dt>Add image</dt> - <dd><p>The visible image is added to the collection.</p></dd> - - <dt>Add selection</dt> - <dd><p>All images selected in the file list will be added to the collection.</p></dd> - </dl> - - <h3>Add button</h3> - - <p>Activate this button to add a new empty collection to the visible list. A dialog will appear to allow entry of the name to use for the new collection.</p> - - <h3>Undo button</h3> - - <p>Activate this button to undo the last add operation. The undo function can only reverse the most recent operation.</p> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="sidebars_exif.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="sidebars_keywords.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- a/doc/style.css Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,251 +0,0 @@ -/* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */ - -/* common */ -body { - margin: 2em; - padding: 0; - color: #000; - background-color: #eee; - font-family: "Trebuchet MS", Verdana, "Lucida Grande", Tahoma, Helvetica, Sans-Serif; -} - -table { - page-break-before: always; -} - -a:hover { - background-color: white; -} - -a.bottomnote { - text-decoration: none; - color: black; -} - -.option_name { - font-variant: small-caps; - font-size: 90%; - font-weight: bold; -} - -dt { - font-weight: bold; -} - -/* Previous + Next */ -p.previous { - text-align: left; -} -p.navtop_title { - text-align: center; - font-weight:bold; -} -p.navbottom_title { - text-align: center; -} - -p.next { - text-align: right; -} - -div.navtop { - text-align: center; -} - -div.navbottom { - text-align: center; -} - -/* Headings */ -h1 { - margin-top: 1.3em; - margin-bottom: 1.3em; - color: #820303; - background: #effefe; -} - -h2 { - margin-top: 1em; - margin-bottom: 1em; - color: #5A0202; - background: #f6fefe; -} - -h3 { - margin-top: 0.7em; - margin-bottom: 0.7em; - color: #270101; - background: #f8fefe; -} - -hr#bottomseparator { - margin-top: 6em; -} - -div.bottomspacer { - margin-bottom: 5em; -} - -div.footer { - text-align: right; -} - -/* menu descriptions */ -dl.menu_desc { - margin-left: 2em; -} -.menu_desc dt { - font-weight: bold; - padding: 0.1em; - border-left: 1px solid gray; - border-bottom: 1px solid gray; - display: inline; - vertical-align: top; -} -.menu_desc dd { - margin-top: 0.3em; - margin-bottom: 0.3em; - font-size: small; -} - -.menu_desc dd dl { - margin-top: 0.7em; - margin-bottom: 0.7em; -} - -.menu_desc dd dl dd { - font-size: small; -} - -/* dialog descriptions */ -dl.dialog_desc { - margin-left: 2em; - margin-bottom: 1em; -} -.dialog_desc dt { - display: inline; - padding-left: 0.1em; - padding-right: 0.1em; - font-weight: bold; - margin-top: 0.3em; - border: 1px solid white; -} -.dialog_desc dd { - margin-bottom: 0.7em; -} -.dialog_desc dd dl { - font-size: 90%; - margin-bottom: 1em; -} - -thead { - font-weight: bold; -} - -/* note */ -p.note { - font-style: italic; -} -.note em { - font-weight: bold; -} - -/* bottom page note */ -p.bottomnote { - margin-top: 5em; - font-style: italic; - font-size: 90%; -} -.bottomnote em { - font-weight: bold; -} - -span.note_label { - font-weight: bold; -} - -code { - margin-left: 0.3em; - padding: 0.1em; - background: white; -} - -.submenu li { - margin: 0.4em; - list-style-type: circle; -} - -.examples dt { - border: 0; -} - -/* shortcuts tables */ -div.shortcuts { - text-align: center; -} -.shortcuts p { - margin: 0.1em; -} -td.shortcuts-separator { - background-color: white; - font-size: 95%; -} -.shortcuts td+td+td { - text-align: left; -} - - -/* image_presentation_fullscreen.html */ -div.fullscreen-functions { - text-align: center; -} -.fullscreen-functions p { - margin: 0.1em; -} - -/* index.html */ -.menu ul { - font-size: 110%; - font-weight: bold; - margin: 1em; - list-style-type: disc; -} -.menu ul li { - margin: 0.4em; -} -.menu ul li ul { - font-size: 90%; - font-weight: normal; - list-style-type: circle; -} - -/* reference_command_line.html */ -.command_line_options p { - margin: 0.1em; -} -.remote_commands p { - margin: 0.1em; -} - -/* reference_management.html */ -.file_locations_subtitle { - font-weight: bold; - background-color: white; - text-align: center; -} -.file_locations p { - margin: 0.1em; -} - -/* Keyboard key style */ -.key { - border:0.2em solid; - border-color:#ddd #bbb #bbb #ddd; - background:#f2f2f2; - padding:0em 0.4em; - margin: 0; - font-size:0.8em; - white-space:nowrap; - font-weight:normal; - font-style:normal; -}
--- a/doc/style_print.css Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,59 +0,0 @@ -body { - background: transparent; - font-size: 12pt; -} - -div.navtop { - display: none; -} - -div.navbottom { - display: none; -} - -a { - color: black; - background: transparent; - text-decoration: underline; -} - -a.bottomnote { - text-decoration: none; -} - -a.bottomnote:link:after, a.bottomnote:visited:after { - text-decoration: none; - content: ""; -} - -a:link:after, a:visited:after { - content: " (" attr(href) ") "; - font-size: 90%; -} - - -/* -a[href^="/"]:after { - content: " (http://www.example.com" attr(href) ") "; -} -*/ - -h1 { - background: transparent; - border-bottom: 1px dotted gray; -} - -h2 { - background: transparent; - border-bottom: 1px dotted gray; -} - -h3 { - background: transparent; - border-bottom: 1px dotted gray; -} - -.dialog_desc dt { - border: 1px dotted gray; -} -
--- a/doc/template.html Sat Nov 21 20:08:51 2009 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,73 +0,0 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - -<html xmlns="http://www.w3.org/1999/xhtml"> -<head> - <meta http-equiv="CONTENT-TYPE" content="text/html; charset=iso-8859-1" /> - - <title>Chapter - Geeqie User Manual</title> - <link rel="stylesheet" type="text/css" href="style.css" media="all" /> - <link rel="stylesheet" type="text/css" href="style_screen.css" media="screen" /> - <link rel="stylesheet" type="text/css" href="style_print.css" media="print" /> -</head> - -<body lang="en-US" dir="ltr" xml:lang="en-US"> - <div class="navtop"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navtop_col1" width="33%"></col> - <col id="navtop_col2" width="33%"></col> - <col id="navtop_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="previous.html">Previous</a> - </p> - </th> - - <th> - <p class="navtop_title">Chapter – Subchapter</p> - </th> - - <th> - <p class="next"><a href="next.html">Next</a> - </p> - </th> - </tr> - </table> - </div> - - <hr /> - - <hr id="bottomseparator" /> - - <div class="navbottom"> - <table width="100%" border="0" cellpadding="4" cellspacing="0"> - <col id="navbottom_col1" width="33%"></col> - <col id="navbottom_col2" width="33%"></col> - <col id="navbottom_col3" width="33%"></col> - - <tr> - <th> - <p class="previous"><a href="previous.html">Previous</a> - </p> - </th> - - <th> - <p class="navbottom_title"><a href="index.html">Contents</a> - </p> - </th> - - <th> - <p class="next"><a href="next.html">Next</a> - </p> - </th> - </tr> - - </table> - </div> - - <div class="footer">Geeqie User Manual</div> - <div class="bottomspacer"> </div> -</body> -</html>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook.py Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,171 @@ +#!/usr/bin/python +# +# This script converts trac wiki to docbook +# wiki pages must be in wiki/ directory and their names must start with "Guide" +# the first page is named GuideIndex +# output is written to docbook/ directory +# +# based on the following scripts: +# +# http://trac-hacks.org/wiki/Page2DocbookPlugin +# http://trac.edgewall.org/attachment/wiki/TracWiki/trac_wiki2html.py +# +# see the links above for a list of requirements + + +import sys +import os +from trac.test import EnvironmentStub, Mock, MockPerm +from trac.mimeview import Context +from trac.wiki.formatter import HtmlFormatter +from trac.wiki.model import WikiPage +from trac.web.href import Href + +import urllib +from tidy import parseString +import libxml2 +import libxslt +import re + +datadir = os.getcwd() + "/wiki2docbook" + + +xhtml2dbXsl = u"""<?xml version="1.0"?> +<xsl:stylesheet version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + + <xsl:import href=\"file:///""" + urllib.pathname2url(datadir + '/html2db/html2db.xsl') + """\" /> + <xsl:output method="xml" indent="no" encoding="utf-8"/> + <xsl:param name="document-root" select="'__top_element__'"/> +</xsl:stylesheet> +""" + +normalizedHeadingsXsl = u"""<?xml version="1.0"?> +<xsl:stylesheet version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> + + <xsl:import href=\"file:///""" + urllib.pathname2url(datadir + '/headingsNormalizer/headingsNormalizer.xsl') + """\" /> + <xsl:output method="xml" indent="no" encoding="utf-8"/> + <xsl:param name="defaultTopHeading" select="FIXME"/> +</xsl:stylesheet> +""" + +normalizedHeadingsXsl_xmldoc = libxml2.parseDoc(normalizedHeadingsXsl) +normalizedHeadingsXsl_xsldoc = libxslt.parseStylesheetDoc(normalizedHeadingsXsl_xmldoc) + +xhtml2dbXsl_xmldoc = libxml2.parseDoc(xhtml2dbXsl) +xhtml2dbXsl_xsldoc = libxslt.parseStylesheetDoc(xhtml2dbXsl_xmldoc) + +def html2docbook(html): + + options = dict(output_xhtml=1, add_xml_decl=1, indent=1, tidy_mark=0, input_encoding='utf8', output_encoding='utf8', doctype='auto', wrap=0, char_encoding='utf8') + xhtml = parseString(html.encode("utf-8"), **options) + + xhtml_xmldoc = libxml2.parseDoc(str(xhtml)) + + xhtml2_xmldoc = normalizedHeadingsXsl_xsldoc.applyStylesheet(xhtml_xmldoc, None) + + nhstring = normalizedHeadingsXsl_xsldoc.saveResultToString(xhtml2_xmldoc) + + docbook_xmldoc = xhtml2dbXsl_xsldoc.applyStylesheet(xhtml2_xmldoc, None) + + dbstring = xhtml2dbXsl_xsldoc.saveResultToString(docbook_xmldoc) + + xhtml_xmldoc.freeDoc() + xhtml2_xmldoc.freeDoc() + docbook_xmldoc.freeDoc() + return dbstring.decode('utf-8') + + +text = {} #wiki text +depth = {} #document depth, 0 for index, leaf documents have depth 1 or 2 +parent = {}#parent document (if depth > 0) +inner = {} #defined for documents that are parents + +#top element indexed by depth +top_element = [ 'book', 'chapter', 'section', 'section', 'section', 'section', 'section', 'section', 'section', 'section' ] + +env = EnvironmentStub() +req = Mock(href=Href('/'), abs_href=Href('http://www.example.com/'), + authname='anonymous', perm=MockPerm(), args={}) +context = Context.from_request(req, 'wiki') + + +def read_file(name): + text[name] = file("wiki/" + name).read().decode('utf-8') + page = WikiPage(env) + page.name = name + page.text = '--' + page.save('', '', '::1', 0) + + +def read_index(): + index_name = "GuideIndex" + read_file(index_name) + index_text = text[index_name] + depth[index_name] = 0 + inner[index_name] = 1 + + stack = [ index_name , '', '', '' ] + + for line in index_text.splitlines() : + match = re.match('^( *)\* \[wiki:(Guide[a-zA-Z0-9]*)', line) + if match: + name = match.group(2) + d = len(match.group(1)) / 2 + if (d > 0): + depth[name] = d + parent[name] = stack[d - 1] + inner[stack[d - 1]] = 1 + stack[d] = name + read_file(name) + +# exclude links with depth > 1 from wiki text, they will be included indirectly +def filter_out_indirect(text): + out = "" + for line in text.splitlines() : + match = re.match('^( *)\* \[wiki:(Guide[a-zA-Z0-9]*)', line) + d = 1 + if match: + d = len(match.group(1)) / 2 + if (d == 1): + out = out + line + "\n" + return out + +def process_pages(): + for name in text.keys(): + txt = text[name] + + if name in inner: + txt = filter_out_indirect(txt) + + html = HtmlFormatter(env, context, txt).generate() + + html = html.replace("/wiki/Guide", "#Guide") + + top = top_element[depth[name]] + db = html2docbook(html) + + if name in inner: + # replace list items with XIncludes, FIXME: this is ugly + r = re.compile('<itemizedlist[^>]*>') + db = r.sub(r'', db); + + r = re.compile('</itemizedlist>') + db = r.sub(r'', db); + + r = re.compile('<listitem>\s*<para>\s*<link\s*linkend="(Guide[a-zA-Z0-9]*)">[^<]*</link>\s*</para>\s*</listitem>') + db = r.sub(r'<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="\1.xml"/>\n', db); + + + db = db.replace("<__top_element__>", "<" + top + " id=\"" + name + "\">") + db = db.replace("</__top_element__>", "</" + top + ">") + + open("docbook/" + name + ".xml", "w").write(db.encode('utf-8')) + + +read_index() +process_pages() + + +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/headingsNormalizer.about.txt Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,8 @@ +Credits: Filipe Correia + +This stylesheet can be applied to xhtml documents. It ensures one one +h1 element exists per document. If the input document has only one h1 +element it just copies all nodes to the output, otherwise it adds a +new top level (h1) heading and depromotes every existing heading to a +lower level (ie, h1s turn into h2s, h2s turn into h3s, etc). +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/headingsNormalizer/headingsNormalizer.xsl Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,90 @@ +<?xml version="1.0" encoding="UTF-8"?> +<xsl:stylesheet version="1.0" + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:xhtml="http://www.w3.org/1999/xhtml" + xmlns="http://www.w3.org/1999/xhtml"> + <xsl:output method="xml" indent="yes"/> + + <!-- + This stylesheet can be applied to xhtml documents. It ensures one one + h1 element exists per document. If the input document has only one h1 + element it just copies all nodes to the output, otherwise it adds a + new top level (h1) heading and depromotes every existing heading to a + lower level (ie, h1s turn into h2s, h2s turn into h3s, etc). + --> + + <xsl:param name="defaultHeading" select="'Chapter'"/> + + <xsl:template match="xhtml:html" mode="addtoplevelheading"> + <html> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </html> + </xsl:template> + + <xsl:template match="xhtml:body" mode="addtoplevelheading"> + <body><h1><xsl:value-of select="$defaultTopHeading"/></h1> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </body> + </xsl:template> + + <xsl:template match="xhtml:h1" mode="addtoplevelheading"> + <h2> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </h2> + </xsl:template> + + <xsl:template match="xhtml:h2" mode="addtoplevelheading"> + <h3> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </h3> + </xsl:template> + + <xsl:template match="xhtml:h3" mode="addtoplevelheading"> + <h4> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </h4> + </xsl:template> + + <xsl:template match="xhtml:h4" mode="addtoplevelheading"> + <h5> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </h5> + </xsl:template> + + <xsl:template match="xhtml:h5" mode="addtoplevelheading"> + <h6> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </h6> + </xsl:template> + + <xsl:template match="xhtml:h6" mode="addtoplevelheading"> + <section> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </section> + </xsl:template> + + <xsl:template match="@*|node()|text()|comment()|processing-instruction()" priority="-1" mode="addtoplevelheading"> + <xsl:copy> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </xsl:copy> + </xsl:template> + + <xsl:template match="img[@alt]" priority="-1"> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" /> + </xsl:template> + + <xsl:template match="@*|node()|text()|comment()|processing-instruction()" priority="-1"> + <xsl:choose> + <xsl:when test="count(//*[local-name()='h1'])=1"> + <xsl:copy> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" /> + </xsl:copy> + </xsl:when> + <xsl:otherwise> + <xsl:copy> + <xsl:apply-templates select="@*|node()|text()|comment()|processing-instruction()" mode="addtoplevelheading"/> + </xsl:copy> + </xsl:otherwise> + </xsl:choose> + </xsl:template> +</xsl:stylesheet>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db.about.txt Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,5 @@ +Credits: Oliver Steele +http://osteele.com/projects/ +http://osteele.com/software/xslt/html2db/ + +html2db.xsl converts an XHTML source document into a Docbook output document. It provides features for customizing the generation of the output, so that the output can be tuned by annotating the source, rather than hand-editing the output. This makes it useful in a processing pipeline where the source documents are maintained in HTML, although it can be used as a one-time conversion tool too.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/LICENSE.txt Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,133 @@ +Preamble +-------- +The intent of this document is to state the conditions under which a +Package may be copied, such that the Copyright Holder maintains some +semblance of artistic control over the development of the package, +while giving the users of the package the right to use and distribute +the Package in a more-or-less customary fashion, plus the right to +make reasonable modifications. + +Definitions +----------- +"Package" refers to the collection of files distributed by the +Copyright Holder, and derivatives of that collection of files created +through textual modification. + +"Standard Version" refers to such a Package if it has not been +modified, or has been modified in accordance with the wishes of the +Copyright Holder as specified below. + +"Copyright Holder" is whoever is named in the copyright or copyrights +for the package. + +"You" is you, if you're thinking about copying or distributing this +Package. + +"Reasonable copying fee" is whatever you can justify on the basis of +media cost, duplication charges, time of people involved, and so +on. (You will not be required to justify it to the Copyright Holder, +but only to the computing community at large as a market that must +bear the fee.) + +"Freely Available" means that no fee is charged for the item itself, +though there may be fees involved in handling the item. It also means +that recipients of the item may redistribute it under the same +conditions they received it. + + +You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that +you duplicate all of the original copyright notices and associated +disclaimers. + + +You may apply bug fixes, portability fixes and other modifications +derived from the Public Domain or from the Copyright Holder. A Package +modified in such a way shall still be considered the Standard Version. + + +You may otherwise modify your copy of this Package in any way, +provided that you insert a prominent notice in each changed file +stating how and when you changed that file, and provided that you do +at least ONE of the following: + +- place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or + an equivalent medium, or placing the modifications on a major + archive site such as uunet.uu.net, or by allowing the Copyright + Holder to include your modifications in the Standard Version of the + Package. +- use the modified Package only within your corporation or + organization. +- rename any non-standard executables so the names do not conflict + with standard executables, which must also be provided, and provide + a separate manual page for each non-standard executable that clearly + documents how it differs from the Standard Version. +- make other distribution arrangements with the Copyright Holder. + + +You may distribute the programs of this Package in object code or +executable form, provided that you do at least ONE of the following: + +- distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on + where to get the Standard Version. +- accompany the distribution with the machine-readable source of the + Package with your modifications. +- give non-standard executables non-standard names, and clearly + document the differences in manual pages (or equivalent), together + with instructions on where to get the Standard Version. +- make other distribution arrangements with the Copyright Holder. + + +You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this +Package. You may not charge a fee for this Package itself. However, +you may distribute this Package in aggregate with other (possibly +commercial) programs as part of a larger (possibly commercial) +software distribution provided that you do not advertise this Package +as a product of your own. You may embed this Package's interpreter +within an executable of yours (by linking); this shall be construed as +a mere form of aggregation, provided that the complete Standard +Version of the interpreter is so embedded. + + +The scripts and library files supplied as input to or produced as +output from the programs of this Package do not automatically fall +under the copyright of this Package, but belong to whomever generated +them, and may be sold commercially, and may be aggregated with this +Package. If such scripts or library files are aggregated with this +Package via the so-called "undump" or "unexec" methods of producing a +binary executable image, then distribution of such an image shall +neither be construed as a distribution of this Package nor shall it +fall under the restrictions of Paragraphs 3 and 4, provided that you +do not represent such an executable image as a Standard Version of +this Package. + + +C subroutines (or comparably compiled subroutines in other languages) +supplied by you and linked into this Package in order to emulate +subroutines and variables of the language defined by this Package +shall not be considered part of this Package, but are the equivalent +of input as in Paragraph 6, provided these subroutines do not change +the language in any way that would cause it to fail the regression +tests for the language. + + +Aggregation of this Package with a commercial distribution is always +permitted provided that the use of this Package is embedded; that is, +when no overt attempt is made to make this Package's interfaces +visible to the end user of the commercial distribution. Such use shall +not be construed as a distribution of this Package. + + +The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written +permission. + + +THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s02.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,10 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Features</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="index.html" title="html2db.xsl"><link rel="next" href="ar01s03.html" title="Requirements"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Features</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="index.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s03.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N10040"></a>Features</h2></div></div><div></div></div><div class="variablelist"><dl><dt><span class="term">XSLT implementation</span></dt><dd><p>This tool is designed to be embedded within an XSLT processing +pipeline. <tt class="literal">html2html.xslt</tt> can be used in a custom +stylesheet or integrated into a larger system. See <a href="ar01s08.html#embedding" title="Overriding the built-in templates">Overriding</a>.</p></dd><dt><span class="term">Customizable</span></dt><dd><p>The output can be customized by the means of additonal markup in +the XHMTL source. See the section on <a href="ar01s08.html" title="Customization">customization</a>.</p></dd><dt><span class="term">Creates outline structure</span></dt><dd><p><tt class="literal">h1</tt>, <tt class="literal">h2</tt>, etc. are turned into nested +<tt class="literal">section</tt> and <tt class="literal">title</tt> elements (as opposed to +bridge heads).</p></dd><dt><span class="term">Accepts a wide variety of XHTML</span></dt><dd><p>In particular, <tt class="literal">html2db.xsl</tt> automatically wraps <a name="N10075" class="indexterm"></a><i class="glossterm">naked item +text</i> (text that is not enclosed in a <tt class="literal"><p></tt>) +inside a table cell or list item. Naked text is a common property of +XHTML documents, but needs to be clothed to create valid +Docbook.<sup>[<a href="#ftn.N1007F" name="N1007F">1</a>]</sup></p></dd></dl></div><p></p><div class="footnotes"><br><hr align="left" width="100"><div class="footnote"><p><sup>[<a href="#N1007F" name="ftn.N1007F">1</a>] </sup>This feature is limited. See <a href="ar01s07.html#implicit-blocks" title="Implicit Blocks">Implicit Blocks</a>.)</p></div></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="index.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s03.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">html2db.xsl </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Requirements</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s03.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,3 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Requirements</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s02.html" title="Features"><link rel="next" href="ar01s04.html" title="License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Requirements</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s02.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s04.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N10087"></a>Requirements</h2></div></div><div></div></div><div class="itemizedlist"><ul type="disc" compact="compact"><li><p>Java: JRE or JDK 1.3 or greater.</p></li><li><p>Xalan 2.5.0.</p></li><li><p>Familiarity with installing and running JAR files.</p></li></ul></div><p><tt class="literal">html2db.xsl</tt> might work with earlier versions of Java and Xalan, and +it might work with other XSLT processors such as Saxon and +xsltproc.</p><p></p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s02.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s04.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Features </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> License</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s04.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,1 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>License</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s03.html" title="Requirements"><link rel="next" href="ar01s05.html" title="Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">License</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s03.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s05.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N1009A"></a>License</h2></div></div><div></div></div><p>This software is released under the Open Source <a href="http://www.opensource.org/licenses/artistic-license.php" target="_top">Artistic License</a>.</p><p></p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s03.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s05.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Requirements </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Installation</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s05.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,1 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Installation</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s04.html" title="License"><link rel="next" href="ar01s06.html" title="Usage"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Installation</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s04.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s06.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N100A4"></a>Installation</h2></div></div><div></div></div><div class="itemizedlist"><ul type="disc" compact="compact"><li><p>Install JRE 1.3 or higher.</p></li><li><p>Install Xalan, if necessary.</p></li><li><p>Download <tt class="literal">html2db-1.zip</tt> from <a href="http://osteele.com/sources/html2db.zip" target="_top">http://osteele.com/sources/html2db-1.zip</a>.</p></li><li><p>Unzip <tt class="literal">html2db-1.zip</tt>.</p></li></ul></div><p></p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s04.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s06.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">License </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Usage</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s06.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,9 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Usage</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s05.html" title="Installation"><link rel="next" href="ar01s07.html" title="Specification"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Usage</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s05.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s07.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N100C0"></a>Usage</h2></div></div><div></div></div><p>Use Xalan to process an XHTML source file into a Docbook file:</p><div class="informalexample"><table border="0" bgcolor="#E0E0E0"><tr><td><pre class="programlisting"> +java org.apache.xalan.xslt.Process -XSL html2dbk.xsl -IN doc.html > doc.xml +</pre></td></tr></table></div><p>See <a href="index.src.html" target="_top"><tt class="literal">index.src.html</tt></a> for an +example of an input file.</p><p>If your source files are in HTML, not XHTML, you may find the <a href="http://tidy.sourceforge.net/" target="_top">Tidy</a> tool useful. This is a +tool that converts from HTML to XHTML, and can be added to the front +of your processing pipeline.</p><p>(If you need to process HTML and you don't know or can't figure out +from context what a processing pipeline is, <tt class="literal">html2db.xsl</tt> is probably not +the right tool for you, and you should look for a local XML or Java +guru or for a commercially supported product.)</p><p></p></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s05.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s07.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Installation </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Specification</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s07.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,73 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Specification</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s06.html" title="Usage"><link rel="next" href="ar01s08.html" title="Customization"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Specification</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s06.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s08.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N100DB"></a>Specification</h2></div></div><div></div></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N100DF"></a>XHTML Elements</h3></div></div><div></div></div><p><tt class="literal">code/i</tt> stands for "an <tt class="literal">i</tt> element +immediately within a <tt class="literal">code</tt> element". This notation is +from XPath.</p><p>XHTML elements must be in the XHTML Transitional namespace, +<tt class="literal">http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd</tt>.</p><div class="informaltable"><table border="1"><colgroup><col><col><col></colgroup><thead><tr><th>XHTML</th><th>Docbook</th><th>Notes</th></tr></thead><tbody><tr><td><tt class="literal">b</tt>, <tt class="literal">i</tt>, <tt class="literal">em</tt>, <tt class="literal">strong</tt></td><td><tt class="literal">emphasis</tt></td><td>The <tt class="literal">role</tt> attribute is the original tag name</td></tr><tr><td><tt class="literal">dfn</tt></td><td><tt class="literal">glossitem</tt>, and also <tt class="literal">primary</tt><tt class="literal">indexterm</tt></td><td class="auto-generated"> </td></tr><tr><td><tt class="literal">code/i</tt>, <tt class="literal">tt/i</tt>, <tt class="literal">pre/i</tt></td><td><tt class="literal">replaceable</tt></td><td>In practice, <tt class="literal">i</tt> within a monospace content is usually used to mean replaceable text. If you're using it for emphasis, use <tt class="literal">em</tt> instead.</td></tr><tr><td><tt class="literal">pre</tt>, <tt class="literal">body/code</tt></td><td><tt class="literal">programlisting</tt></td><td class="auto-generated"> </td></tr><tr><td><tt class="literal">img</tt></td><td><tt class="literal">inlinemediaobject/imageobject/imagedata</tt></td><td>In an inline context.</td></tr><tr><td><tt class="literal">img</tt></td><td><tt class="literal">[informal]figure/mediaobject/imageobject/imagedata</tt></td><td>If it has a <tt class="literal">title</tt> attribute or <tt class="literal">db:title</tt> it's wrapped in a <tt class="literal">figure</tt>. Otherwise it's wrapped in an <tt class="literal">informalfigure</tt>.</td></tr><tr><td><tt class="literal">table</tt></td><td><tt class="literal">[informal]table</tt></td><td>XHTML <tt class="literal">table</tt> becomes Docbook <tt class="literal">table</tt> if it has a <tt class="literal">summary</tt> attribute; <tt class="literal">informaltable</tt> otherwise.</td></tr><tr><td><tt class="literal">ul</tt></td><td><tt class="literal">itemizedlist</tt></td><td>But see the processing instruction <a href="ar01s08.html#simplelist">below</a>.</td></tr></tbody></table></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1017E"></a>Links</h3></div></div><div></div></div><div class="table"><a name="N10181"></a><p class="title"><b>Table 1. Link Translation</b></p><table summary="Link Translation" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>XHTML</th><th>Docbook</th><th>Notes</th></tr></thead><tbody><tr><td><tt class="literal"><a name="<i class="replaceable"><tt>name</tt></i>"></tt></td><td><tt class="literal"><anchor id="{$anchor-id-prefix}<i class="replaceable"><tt>name</tt></i>"></tt></td><td>An anchor within a <tt class="literal">h<i class="replaceable"><tt>n</tt></i></tt> element is attached to the enclosing <tt class="literal">section</tt> as an <tt class="literal">id</tt> attribute instead.</td></tr><tr><td><tt class="literal"><a href="#<i class="replaceable"><tt>name</tt></i>"></tt></td><td><tt class="literal"><link linkend="{$anchor-id-prefix}<i class="replaceable"><tt>name</tt></i>"></tt></td><td class="auto-generated"> </td></tr><tr><td><tt class="literal"><a href="<i class="replaceable"><tt>url</tt></i>"></tt></td><td><tt class="literal"><ulink url="<i class="replaceable"><tt>name</tt></i>"></tt></td><td class="auto-generated"> </td></tr><tr><td><tt class="literal"><a name="mailto:<i class="replaceable"><tt>address</tt></i>"></tt></td><td><tt class="literal"><email><i class="replaceable"><tt>address</tt></i></email></tt></td><td class="auto-generated"> </td></tr></tbody></table></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="tables"></a>Tables</h3></div></div><div></div></div><p>XHTML <tt class="literal">table</tt> support is minimal. <tt class="literal">html2db.xsl</tt> changes the +element names and counts the columns (this is necessary to get table +footnotes to span all the columns), but it does not attempt to deal +with tables in their full generality.</p><p>An XHTML <tt class="literal">table</tt> with a <tt class="literal">summary</tt> attribute +generates a <tt class="literal">table</tt>, whose <tt class="literal">title</tt> is the value +of that summary. An XHTML <tt class="literal">table</tt> without a +<tt class="literal">summary</tt> generates an <tt class="literal">informaltable</tt>.</p><p>Any <tt class="literal">tr</tt>s that contain <tt class="literal">th</tt>s are pulled to +the top of the table, and placed inside a <tt class="literal">thead</tt>. Other +<tt class="literal">tr</tt>s are placed inside a <tt class="literal">tbody</tt>. This matches +the commanon XHTML <tt class="literal">table</tt> pattern, where the first row is +a header row.</p><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="implicit-blocks"></a>Implicit Blocks</h3></div></div><div></div></div><p>XHTML allows <tt class="literal">li</tt>, <tt class="literal">dd</tt>, and <tt class="literal">td</tt> +elements to contain either inline text (for instance, +<tt class="literal"><li>a list item</li></tt>) or block structure +(<tt class="literal"><li><p>a block</p></li></tt>). The +corresponding Docbook elements require block structure, such as +<tt class="literal">para</tt>.</p><p><tt class="literal">html2db.xsl</tt> provides limited support for wrapping naked text in +these positions in <tt class="literal">para</tt> elements. If a list item or +table cell item directly contains text, all text up to the position of +the first element (or all text, if there is no element) is wrapped in +<tt class="literal">para</tt>. This handles the simple case of an item that +directly contains text, and also the case of an item that contains +text followed by blocks such as paragraphs.</p><p>Note that this algorithm is easily confused. It doesn't +distinguish between block and inline XHTML elements, so it will only +wrap the first word in <tt class="literal"><li>some <b>bold</b> +text</li></tt>, leading to badly formatted output. Twhe +workaround is to wrap troublesome content in explicit +<tt class="literal"><p></tt> tags.</p><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="docbook-elements"></a>Docbook Elements</h3></div></div><div></div></div><p>Elements from the Docbook namespace are passed through as is. +There are two ways to include a Docbook element in your XHTML +source:</p><div class="variablelist"><dl><dt><span class="term">Global prefix</span></dt><dd><p>A <a name="N10241" class="indexterm"></a><i class="glossterm">fake Docbook namespace</i><sup>[<a href="#ftn.N10247" name="N10247">2</a>]</sup> + +declaration may be added to the document root element. Anywhere in +the document, the prefix from this namespace declaration may be used +to include a Docbook element. This is useful if a document contains +many Docbook elements, such as <tt class="literal">footnote</tt> or +<tt class="literal">glossterm</tt>, interspersed with XHTML. (In this case it may +be more convenient to allow these elements in the XHMTL namespace and +add a customization layer that translates them to docbook elements, +however. See <a href="ar01s08.html" title="Customization">Customization</a>.)</p><div class="informalexample"><table border="0" bgcolor="#E0E0E0"><tr><td><pre class="programlisting"> +<html xmlns="http://www.w3.org/1999/xhtml" + xmlns:db="urn:docbook"> + ... + <p>Some text<db:footnote>and a footnote</db:footnote>.</p> +</pre></td></tr></table></div></dd><dt><span class="term">Local namespace</span></dt><dd><p>A Docbook element may be introduced along with a prefix-less +namespace declaration. This is useful for embedding a Docbook +document fragment (a hierarchy of elements that all use Docbook tags) +within of a XHTML document.</p><div class="informalexample"><table border="0" bgcolor="#E0E0E0"><tr><td><pre class="programlisting"> + ... + <articleinfo xmlns="urn:docbook"> + <author> + <firstname>...</firstname> + ... +</pre></td></tr></table></div></dd></dl></div><p>The source to <a href="index.src.html" target="_top">this document</a> +illustrates both of these techniques.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Both these techniques will cause your document to be +invalid as XHTML. In order to validate an XHTML document that +contains Docbook elements, you will need to create a custom schema. +Technically, you then ought to place your document in a different +namespace, but this will cause <tt class="literal">html2db.xsl</tt> not to recognize it!</p></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N10275"></a>Output Processing Instructions</h3></div></div><div></div></div><p><tt class="literal">html2db.xsl</tt> adds a few of processing instructions to the output file. +The Docbook XSL stylesheets ignore these, but if you write a +customization layer for Docbook XSL, you can use the information in +these processing instructions to customize the HTML output. This can +be used, for example, to set the <tt class="literal">a</tt> <tt class="literal">onclick</tt> +and <tt class="literal">target</tt> attributes in the HTML files that Docbook XSL +creates to the same values they had in the input document.</p><div class="variablelist"><dl><dt><span class="term"><tt class="literal"><?html2db attribute="<i class="replaceable"><tt>name</tt></i>" value="<i class="replaceable"><tt>value</tt></i>"?></tt></span></dt><dd><p>Placed inside a link element to capture the value of the <tt class="literal">a</tt> <tt class="literal">target</tt> and <tt class="literal">onclick</tt> attributes. <i class="replaceable"><tt>name</tt></i> is the name of the attribute (<tt class="literal">target</tt> or <tt class="literal">onclick</tt>), and <i class="replaceable"><tt>value</tt></i> is its value, with <tt class="literal">"</tt> and <tt class="literal">\</tt> replaced by <tt class="literal">\"</tt> and <tt class="literal">\\</tt>, respectively.</p></dd><dt><span class="term"><tt class="literal"><?html2db element="br"?></tt></span></dt><dd><p>Represents the location of an XHTML <tt class="literal">br</tt> element in the +source document.</p></dd></dl></div><p>You can also include <tt class="literal"><?db2html?></tt> processing +instructions in the HTML source document, and they will be copied +through to the Docbook output file unchanged (as will all other +processing instructions).</p><p></p></div><div class="footnotes"><br><hr align="left" width="100"><div class="footnote"><p><sup>[<a href="#N10247" name="ftn.N10247">2</a>] </sup>The fake +Docbook namespace is <tt class="literal">urn:docbook</tt>. Docbook doesn't really +have a namespace, and if it did, it wouldn't be this one. See <a href="ar01s10.html#docbook-namespace" title="The Docbook Namespace">Docbook namespace</a> for a discussion of +this issue.</p></div></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s06.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s08.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Usage </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Customization</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s08.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,22 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Customization</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s07.html" title="Specification"><link rel="next" href="ar01s09.html" title="FAQ"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Customization</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s07.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s09.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="customization"></a>Customization</h2></div></div><div></div></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N102C9"></a>XSLT Parameters</h3></div></div><div></div></div><div class="variablelist"><dl><dt><span class="term"><tt class="literal"><xsl:param name="anchor-id-prefix" select="''/></tt></span></dt><dd><p>Prefixed to every id generated from <tt class="literal"><a name=></tt> + and <tt class="literal"><a href="#"></tt>. This is useful to avoid + collisions between multiple documents that are compiled into the + same book. For instance, if a number of XHTML sources are assembled + into chapters of a book, you style each source file with a prefix of + <tt class="literal"><i class="replaceable"><tt>docid</tt></i>.</tt> where <i class="replaceable"><tt>docid</tt></i> is a unique id + for each source file.</p></dd><dt><span class="term"><tt class="literal"><xsl:param name="document-root" select="'article'"/></tt></span></dt><dd><p>The default document root. This can be overridden by + <tt class="literal"><?html2db class="<i class="replaceable"><tt>name</tt></i>"></tt> within the + document itself, and defaults to <tt class="literal">article</tt>.</p></dd></dl></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="processing-instructions"></a>Processing instructions</h3></div></div><div></div></div><p>Use the <tt class="literal"><?html2db?></tt> processing instruction to +customize the transformation of the XHTML source to Docbook:</p><div class="informaltable"><table border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Processing instruction</th><th>Content</th><th>Effect</th></tr></thead><tbody><tr><td><tt class="literal"><?html2db class="<i class="replaceable"><tt>xxx</tt></i>"?></tt></td><td><tt class="literal">body</tt></td><td>Sets the output document root to <i class="replaceable"><tt>xxx</tt></i>. Useful for +translating to <tt class="literal">prefix</tt>, <tt class="literal">appendix</tt>, or <tt class="literal">chapter</tt>; the default is +<i class="replaceable"><tt>$document-root</tt></i>.</td></tr><tr><td><a name="simplelist"></a><tt class="literal"><?html2db class="simplelist"?></tt></td><td><tt class="literal">ul</tt></td><td>Creates a vertical <tt class="literal">simplelist</tt>.<sup>[<a href="#ftn.N10330" name="N10330">a</a>]</sup></td></tr><tr><td><tt class="literal"><?html2db rowsep="1"?></tt></td><td><tt class="literal">[informal]table</tt></td><td>Sets the <tt class="literal">rowsep</tt> attribute on the generated <tt class="literal">table</tt>.<sup>[<a href="#ftn.N10349" name="N10349">b</a>]</sup></td></tr></tbody><tbody class="footnotes"><tr><td colspan="3"><div class="footnote"><p><sup>[<a href="#N10330" name="ftn.N10330">a</a>] </sup>Note that the +current implementation simply checks for the presence of <span class="em">any</span> +<tt class="literal">html2db</tt> processing instruction.</p></div><div class="footnote"><p><sup>[<a href="#N10349" name="ftn.N10349">b</a>] </sup>Note that the current implementation simply checks for the presence of <span class="em">any</span> <tt class="literal">html2db</tt> processing instruction that begins with <tt class="literal">rowsep</tt>, and assumes the vlaue is <tt class="literal">1</tt>.</p></div></td></tr></tbody></table></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="embedding"></a>Overriding the built-in templates</h3></div></div><div></div></div><p>For cases where the previous techniques don't allow for enough +customization, you can override the builtin templates. You will need +to know XSLT in order to do this, and you will need to write a new +stylesheet that uses the <tt class="literal">xsl:import</tt> element to import +<tt class="literal">html2db.xsl</tt>.</p><p>The <a href="examples.xsl" target="_top"><tt class="literal">example.xsl</tt></a> stylesheet +is an example customization layer. It recognizes the <tt class="literal"><div +class="abstract"></tt> and <tt class="literal"><p class="note"></tt> +classes in the <a href="index.src.html" target="_top">source</a> for this document, +and generates the corresponding Docbook elements.</p><p></p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s07.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s09.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Specification </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> FAQ</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s09.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,36 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>FAQ</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s08.html" title="Customization"><link rel="next" href="ar01s10.html" title="Implementation Notes"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">FAQ</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s08.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s10.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N10378"></a>FAQ</h2></div></div><div></div></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1037C"></a>Why generate Docbook?</h3></div></div><div></div></div><p>The primary reason to use Docbook as an <span class="em">output</span> format is +to take advantage of the Docbook XSL stylesheets. These are a +well-designed, well-documented set of XSL stylesheets that provide a +variety of publishing features that would be difficult to recreate +from scratch for HTML:</p><div class="itemizedlist"><ul type="disc" compact="compact"><li><p>Automatic Table-of-Contents generation</p></li><li><p>Automatic part, chapter, and section numbering.</p></li><li><p>Creation of single-page, multi-page, PDF, and WinHelp files from the same source document.</p></li><li><p>Navigation headers, footers, and metadata for multi-page HTML +documents.</p></li><li><p>Link resolution and link target text insertion across multiple pages and numbered targets.</p></li><li><p>Figure, example, and table numbering, and tables of these.</p></li><li><p>Index and glossary tools.</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1039D"></a>Why write in XHTML?</h3></div></div><div></div></div><p>Given that Docbook is so great, why not write in it?</p><p>Where there are not legacy concerns, Docbook is probably a better +choice for structured or technical documentation.</p><p>Where the only legacy concern is the documents themselves, and not +the tools and skill sets of documentation contributors, you should +consider using an (X)HMTL convertor to perform a one-time conversion +of your documentation source into Docbook, and then switching +development to the result files. You can use this stylesheet to +perform this conversion, or evaluate other tools, many of which are +probably appropriate for this purpose.</p><p>Often there are other legacy concerns: the availability of cheap +(including free) and usable HTML editors and editing modes; and the +fact that it's easier to teach people XHTML than Docbook. If either +of this is an issue in your organization, you may want to maintain +documentation sources in XHTML instead of Docbook</p><p>For example, at <a href="http://www.laszlosystems.com/" target="_top">Laszlo</a>, +most developers contribute directly to the documentation. Requiring +that developers learn Docbook, or that they wait on the doc team to +get content into the docs, would discourage this.</p><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N103AF"></a>Why not use an existing convertor?</h3></div></div><div></div></div><p>This isn't the first (X)HTML to Docbook convertor. Why not use one +of the exisitng ones?</p><p>Each HTML to Docbook convertors that I could find had at least some +of the following limitations, some of which stemmed from their +intended use as one-time-only convertors for legacy documents:</p><div class="itemizedlist"><ul type="disc" compact="compact"><li><p>Many only operated on a subset of HTML, and relied upon hand +editing of the output to clean up mistakes. This made them impossible +to use as part of a processing pipeline, where the source is +<span class="em">maintained</span> in XHTML.</p></li><li><p>There was no way to customize the output, except by (1) hand +editing, or (2) writing a post-processing stylesheet, which didn't +have access to the information in the XHTML source document.</p></li><li><p>Many of them were difficult or impossible to customize and +extend. They were closed-source, or written in Java or Perl (which I +find to be a difficult languages to use for customizing this kind of +thing) and embedded in a larger system.</p></li><li><p>They didn't take full advantage of the Docbook tag set and content +model to represent document structure. For instance, they didn't +generate nested <tt class="literal">section</tt> elements to represent +<tt class="literal">h1</tt> <tt class="literal">h2</tt> sequences, or <tt class="literal">table</tt> to +represent tables with <tt class="literal">summary</tt> attributes.</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N103D8"></a>I got this error. What does it mean?</h3></div></div><div></div></div><div class="variablelist"><dl><dt><span class="term">Q. <tt class="literal">Fatal Error! The element type "br" must be terminated by the matching end-tag "</br>". +</tt></span></dt><dd><p>A. Your document is HTML, not <span class="em">X</span>HTML. You need to fix it, or run it through Tidy first.</p></dd><dt><span class="term">Q. My output document is empty except for the <tt class="literal"><?xml version="1.0" encoding="UTF-8"?></tt> line.</span></dt><dd><p>A. The document is missing a namespace declaration. See the <a href="index.src.html" target="_top">example</a> for an example.</p></dd><dt><span class="term">Q. Some of the headers and document sections are repeated multiple times.</span></dt><dd><p>A. The document has out-of-sequence headers, such as <tt class="literal">h1</tt> followed by <tt class="literal">h3</tt> (instead of <tt class="literal">h2</tt>). This won't work.</p></dd><dt><span class="term">Q. <tt class="literal">Fatal Error! The prefix "db" for element "db:footnote" is not bound.</tt></span></dt><dd><p>A. You haven't declared the <tt class="literal">db</tt> namespace prefix. See the <a href="index.src.html" target="_top">example</a> for an example.</p></dd></dl></div><p></p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s08.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="ar01s10.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%">Customization </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> Implementation Notes</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/ar01s10.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,45 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Implementation Notes</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="up" href="index.html" title="html2db.xsl"><link rel="previous" href="ar01s09.html" title="FAQ"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Implementation Notes</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="ar01s09.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> </td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N10414"></a>Implementation Notes</h2></div></div><div></div></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N10418"></a>Bugs</h3></div></div><div></div></div><div class="itemizedlist"><ul type="disc" compact="compact"><li><p>Improperly sequenced <tt class="literal">h<i class="replaceable"><tt>n</tt></i></tt> (for example +<tt class="literal">h1</tt> followed by <tt class="literal">h3</tt>, instead of +<tt class="literal">h2</tt>) will result in duplicate text.</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1042F"></a>Limitations</h3></div></div><div></div></div><div class="itemizedlist"><ul type="disc" compact="compact"><li><p>The <tt class="literal">id</tt> attribute is only preserved for certain +elements (at least <tt class="literal">h<i class="replaceable"><tt>n</tt></i></tt>, images, paragraphs, and +tables). It ought to be preserved for all of them.</p></li><li><p>Only the <a href="ar01s07.html#tables" title="Tables">very simplest</a> table format is +implemented.</p></li><li><p>Always uses compact lists.</p></li><li><p>The string matching for <tt class="literal"><?html2b +class="<i class="replaceable"><tt>classname</tt></i>"?></tt> requires an exact match +(spaces and all).</p></li><li><p>The <a href="ar01s07.html#implicit-blocks" title="Implicit Blocks">implicit blocks</a> code is easily +confused, as documented in that section. This is +easy to fix now that I understand the difference between block and +inline elements (I didn't when I was implementing this), but I +probably won't do so until I run into the problem again.</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1045A"></a>Wishlist</h3></div></div><div></div></div><div class="itemizedlist"><ul type="disc" compact="compact"><li><p>Allow <tt class="literal"><html2db attribute-name="<i class="replaceable"><tt>name</tt></i>" +value="<i class="replaceable"><tt>value</tt></i>"?></tt> at any position, to set arbitrary +Docbook attributes on the generated element.</p></li><li><p>Use different technique from the <a href="ar01s07.html#docbook-elements" title="Docbook Elements">fake +namespace prefix</a> to name Docbook elements in the source, that +preserves the XHTML validity of the source file. For example, an +option transform <tt class="literal"><div class="db:footnote"></tt> into +<tt class="literal"><footnote></tt>, or to use a processing attribute +(<tt class="literal"><div><?html2db classname="footnote"?></tt>).</p></li><li><p>Parse DC metadata from XHTML <tt class="literal">html/head/meta</tt>.</p></li><li><p>Add an option to use <tt class="literal">html/head/title</tt> instead of +<tt class="literal">html/body/h1[1]</tt> for top title.</p></li><li><p>Allow an <tt class="literal">id</tt> on every element.</p></li><li><p>Add an option to translate the XHTML <tt class="literal">class</tt> into a +Docbook <tt class="literal">role</tt>.</p></li><li><p>Preserve more of the whitespace from the source document especially within lists and tables in order to make it easier to debug the output document.</p></li></ul></div><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N1049D"></a>Design Notes</h3></div></div><div></div></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="docbook-namespace"></a>The Docbook Namespace</h4></div></div><div></div></div><p><tt class="literal">html2db.xsl</tt> accepts elements in the "Docbook namespace" in XHTML +source. This namespace is <tt class="literal">urn:docbook</tt>.</p><p>This isn't technically correct. Docbook doesn't really have a +namespace, and if it did, it wouldn't be this one. <a href="http://www.faqs.org/rfcs/rfc3151.html" target="_top">RFC 3151</a> suggests +<tt class="literal">urn:publicid:-:OASIS:DTD+DocBook+XML+V4.1.2:EN</tt> as the +Docbook namespace.</p><p>There two problems with the RFC 3151 namespace. First, it's long +and hard to remember. Second, it's limited to Docbook v4.1.2 +but <tt class="literal">html2db.xsl</tt> works with other versions of Docbook too, which would +presumably have other namespaces. I think it's more useful to +<span class="em">under</span>specify the Docbook version in the spec for this tool. +Docbook itself underspecifies the version completely, by avoiding a +namespace at all, but when mixing Docbook and XHTML elements I find it +useful to be <span class="em">more</span> specific than that.</p><p></p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N104C3"></a>History</h3></div></div><div></div></div><p>The original version of <tt class="literal">html2db.xsl</tt> was written by <a href="http://osteele.com" target="_top">Oliver Steele</a>, as part of the <a href="http://laszlosystems.com" target="_top">Laszlo Systems, Inc.</a> documentation +effort. We had a set of custom stylesheets that formatted and added +linking information to programming-language elements such as +<tt class="literal">classname</tt> and <tt class="literal">tagname</tt>, and added +Table-of-Contents to chapter documentation and numbers examples.</p><p>As the documentation set grew, the doc team (John Sundman) +requested features such as inter-chapter navigation, callouts, and +index and glossary elements. I was able to beat all of these back +except for navigation, which seemed critical. After a few days trying +to implement this, I decided it would be simpler to convert the subset +of XHTML that we used into a subset of Docbook, and use the latter to +add navigation. (Once this was done, the other features came for +free.)</p><p>During my August 2004 "sabbatical", I factored the general html2db +code out from the Laszlo-specific code, refactored and otherwise +cleaned it up, and wrote this documentation.</p><p></p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="N104DE"></a>Credits</h3></div></div><div></div></div><p><tt class="literal">html2db.xsl</tt> was written by <a href="http://osteele.com" target="_top">Oliver Steele</a>, as part of the <a href="http://laszlosystems.com" target="_top">Laszlo Systems, Inc.</a> documentation effort.</p><p></p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="ar01s09.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="index.html">Up</a></td><td align="right" width="40%"> </td></tr><tr><td valign="top" align="left" width="40%">FAQ </td><td align="center" width="20%"><a accesskey="h" href="index.html">Home</a></td><td valign="top" align="right" width="40%"> </td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/build.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,160 @@ +<!-- This build file won't work on your machine. It uses too many +absolute pathnames. I'm including it in case it's useful to you +as a starting point --> +<project default="build"> + <taskdef resource="net/sf/antcontrib/antcontrib.properties"/> + <property file="build.properties"/> + + <path id="saxon.processor.classpath"> + <pathelement path="${saxon.location}" /> + <pathelement path="${xercesImpl.dir}/xercesImpl.jar"/> + <pathelement path="${docbook-xsl}/extensions/saxon651.jar" /> + </path> + + <path id="classpath.fop"> + <pathelement path="${fop.dir}/fop.jar"/> + <pathelement path="${xerces.dir}/xerces.jar"/> + <pathelement path="${fop.dir}/batik.jar"/> + <pathelement path="${fop.dir}/avalon-framework-cvs-20020806.jar"/> + </path> + + <xmlcatalog id="commonDTDs"> + <dtd publicId="-//W3C//DTD XHTML 1.0 Transitional//EN" + location="${dtds}/xhtml1-transitional.dtd"/> + </xmlcatalog> + + <target name="db"> + <!-- The output depends on these, but the style task doesn't know this, + so delete them manually --> + <outofdate> + <sourcefiles> + <fileset dir="." includes="html2db.xsl,html2db-common.xsl,html2db-utils.xsl"/> + </sourcefiles> + <targetfiles path="index.xml"/> + <sequential> + <delete file="index.xml"/> + </sequential> + </outofdate> + <style style="example.xsl" + in="index.src.html" + out="index.xml"> + <xmlcatalog refid="commonDTDs"/> + </style> + </target> + + <target name="saxon"> + <java classname="com.icl.saxon.StyleSheet" + fork="yes" + failonerror="true"> + <classpath refid="saxon.processor.classpath" /> + <!--jvmarg value="-Djavax.xml.parsers.DocumentBuilderFactory=org.apache.xerces.jaxp.DocumentBuilderFactoryImpl"/> + <jvmarg value="-Djavax.xml.parsers.SAXParserFactory=org.apache.xerces.jaxp.SAXParserFactoryImpl"/> + <jvmarg value="-Dorg.apache.xerces.xni.parser.XMLParserConfiguration=org.apache.xerces.parsers.XIncludeParserConfiguration"/--> + <arg line="-o index.xml"/> + <arg line="index.src.html"/> + <arg line="example.xsl"/> + </java> + </target> + + <target name="just-html"> + <style style="${docbook}/html/docbook.xsl" + in="index.xml" + out="index.html"> + <param name="shade.verbatim" expression="1"/> + <param name="make.valid.html" expression="1"/> + </style> + </target> + + <target name="html" depends="db,just-html"/> + + <target name="chunk" depends="db"> + <mkdir dir="docs"/> + <style style="${docbook}/html/chunk.xsl" + in="index.xml" + out="docs/index.html"> + <param name="shade.verbatim" expression="1"/> + </style> + </target> + + <target name="pdf" depends="db"> + <style style="${docbook}/fo/docbook.xsl" + in="index.xml" + out="index.fo"> + <param name="shade.verbatim" expression="1"/> + <param name="fop.extensions" expression="1"/> + </style> + <outofdate> + <sourcefiles> + <fileset dir="." includes="index.fo"/> + </sourcefiles> + <targetfiles> + <fileset dir="." includes="html2db.pdf"/> + </targetfiles> + <sequential> + <java classname="org.apache.fop.apps.Fop" + fork="yes" + failonerror="true"> + <classpath refid="classpath.fop"/> + <arg line="-fo index.fo"/> + <arg line="-pdf html2db.pdf"/> + </java> + </sequential> + </outofdate> + </target> + + <target name="docs" depends="html,chunk,pdf"/> + + <target name="zip" depends="docs"> + <zip destfile="build/html2db.zip"> + <!-- html2db source --> + <fileset dir="." includes="*.xsl,index.src.html"/> + <fileset dir="." includes="*.xsl,index.src.html,LICENSE.txt"/> + <!-- build source --> + <fileset dir="." includes="build.xml,tidy.properties"/> + <!-- generated docs --> + <fileset dir="." includes="index.xml,index.html,html2db.pdf"/> + <fileset dir="docs"/> + </zip> + </target> + + <target name="build" depends="zip"/> + + <target name="sitedocs" depends="chunk"> + <exec executable="tidy"> + <arg line="-config tidy.properties -o build/index.html docs/index.html"/> + </exec> + <mkdir dir="build/sitedocs"/> + <style style="extract-toc.xsl" + in="build/index.html" + out="build/sitedocs/index.html"> + <xmlcatalog refid="commonDTDs"/> + </style> + <copy todir="build/sitedocs"> + <fileset dir="docs" includes="*" excludes="index.html"/> + </copy> + </target> + + <target name="stage" depends="zip,sitedocs"> + <property file="build.properties"/> + <echo message="${docbook}"/> + <echo message="${htdocs}"/> + <copy file="build/html2db.zip" todir="${htdocs}/sources"/> + <copy todir="${htdocs}/software/xslt/html2db"> + <fileset dir="." includes="*.xsl,index.src.html,build.xml"/> + <fileset dir="." includes="index.xml,html2db.pdf"/> + <fileset dir="build/sitedocs"/> + </copy> + <copy tofile="${htdocs}/software/xslt/html2db/onepage.html" + file="index.html"/> + </target> + + <target name="clean"> + <delete> + <fileset dir="." includes="index.fo"/> + <fileset dir="." includes="index.xml,index.html,index.fo,html2db.pdf"/> + <fileset dir="build"/> + <fileset dir="docs"/> + </delete> + </target> + +</project>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/example.xsl Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Copyright 2004 by Laszlo Systems, Inc. + Released under the Artistic License. + Written by Oliver Steele. + http://osteele.com/sources/xslt/htm2db/ + + This is an minimal embedding stylesheet. Make a copy of + this file and customize it with parameter definitions and + template overrides to customize the transformation. + See example.xsl for an example. + --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:h="http://www.w3.org/1999/xhtml" + exclude-result-prefixes="h" + version="1.0"> + + <xsl:import href="html2db.xsl"/> + + <xsl:template match="h:div[@class='abstract']"> + <abstract> + <xsl:apply-templates/> + </abstract> + </xsl:template> + + <xsl:template match="h:p[@class='note']"> + <note> + <para> + <xsl:apply-templates/> + </para> + </note> + </xsl:template> + + <xsl:template match="h:pre[@class='example']"> + <informalexample> + <xsl:apply-imports/> + </informalexample> + </xsl:template> + +</xsl:stylesheet>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/extract-section.xsl Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,16 @@ +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:h="http://www.w3.org/1999/xhtml" + version="1.0"> + + <xsl:output method="html"/> + + <xsl:template match="/"> + <xsl:apply-templates select="h:html/h:body//h:div[@class='section']"/> + </xsl:template> + + <xsl:template match="@*|node()"> + <xsl:copy> + <xsl:apply-templates select="@*|node()"/> + </xsl:copy> + </xsl:template> +</xsl:stylesheet>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/extract-toc.xsl Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,36 @@ +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:xalanredirect="org.apache.xalan.xslt.extensions.Redirect" + exclude-result-prefixes="" + extension-element-prefixes="xalanredirect" + xmlns:h="http://www.w3.org/1999/xhtml" + version="1.0"> + + <xsl:output method="html"/> + + <xsl:template match="/"> + <xsl:apply-templates select="h:html/h:body/*"/> + </xsl:template> + + <xsl:template match="h:div[@class='toc']"> + <xalanredirect:write file="categories.html"> + <xsl:apply-templates/> + </xalanredirect:write> + </xsl:template> + + <xsl:template match="h:div[@class='toc']//text()[string(.)='Table of Contents']"> + <xsl:value-of select="/h:html/h:head/h:title/text()"/> + </xsl:template> + + <xsl:template match="@*|node()"> + <xsl:copy> + <xsl:apply-templates select="@*|node()"/> + </xsl:copy> + </xsl:template> + + <xsl:template match="h:a[string()='']"> + <xsl:copy> + <xsl:apply-templates select="@*|node()"/> + <xsl:text> </xsl:text> + </xsl:copy> + </xsl:template> +</xsl:stylesheet>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/html2db-utils.xsl Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Copyright 2004 by Laszlo Systems, Inc. + Released under the Artistic License. + Written by Oliver Steele. + http://osteele.com/sources/xslt/htm2db/ + + Utility functions + --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exslt="http://exslt.org/common" + xmlns:math="http://exslt.org/math" + xmlns:xalan="http://xml.apache.org/xalan" + xmlns:html2db="urn:html2db" + xmlns:db="urn:docbook" + xmlns:h="http://www.w3.org/1999/xhtml" + exclude-result-prefixes="db exslt h html2db math xalan" + extension-element-prefixes="html2db" + version="1.0"> + + <!-- Wrap with ", and backslash " and \ --> + <xsl:template name="quote"> + <xsl:param name="str" select="string(.)"/> + <xsl:param name="lquo" select="'"'"/> + <xsl:param name="rquo" select="'"'"/> + <!-- first " --> + <xsl:variable name="qpos" select="string-length(substring-before($str, '"'))"/> + <!-- first \ --> + <xsl:variable name="bspos" select="string-length(substring-before($str, '\\'))"/> + <!-- first " or \ --> + <xsl:variable name="pos"> + <xsl:choose> + <xsl:when test="$qpos=0"><xsl:value-of select="$bspos"/></xsl:when> + <xsl:when test="$bspos=0"><xsl:value-of select="$qpos"/></xsl:when> + <xsl:when test="$qpos<$bspos"> + <xsl:value-of select="$qpos"/> + </xsl:when> + <xsl:when test="$bspos"> + <xsl:value-of select="$bspos"/> + </xsl:when> + </xsl:choose> + </xsl:variable> + <xsl:value-of select="$lquo"/> + <xsl:choose> + <xsl:when test="$pos!=0"> + <xsl:value-of select="substring($str, 1, $pos)"/> + <xsl:text>\</xsl:text> + <xsl:value-of select="substring($str, $pos + 1, 1)"/> + <xsl:call-template name="quote"> + <xsl:with-param name="str" select="substring($str, $pos + 2)"/> + <xsl:with-param name="lquo" select="''"/> + <xsl:with-param name="rquo" select="''"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$str"/> + </xsl:otherwise> + </xsl:choose> + <xsl:value-of select="$rquo"/> + </xsl:template> + +</xsl:stylesheet>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/html2db.xsl Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,565 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- Copyright 2004 by Laszlo Systems, Inc. + Released under the Artistic License. + Written by Oliver Steele. + Version 1.0.1 + http://osteele.com/sources/xslt/htm2db/ + --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns:exslt="http://exslt.org/common" + xmlns:java="http://xml.apache.org/xalan/java" + xmlns:math="http://exslt.org/math" + xmlns:db="urn:docbook" + xmlns:h="http://www.w3.org/1999/xhtml" + exclude-result-prefixes="exslt java math db h" + version="1.0"> + + <!-- Prefixed to every id generated from <a name=> and <a href="#"> --> + <xsl:param name="anchor-id-prefix" select="''"/> + + <!-- Default document root; can be overridden by <?html2db class=> --> + <xsl:param name="document-root" select="'article'"/> + + <xsl:include href="html2db-utils.xsl"/> + + <!-- + Default templates + --> + + <!-- pass docbook elements through unchanged; just strip the prefix + --> + <xsl:template match="db:*"> + <xsl:element name="{local-name()}"> + <xsl:for-each select="@*"> + <xsl:attribute name="{name()}"> + <xsl:value-of select="."/> + </xsl:attribute> + </xsl:for-each> + <xsl:apply-templates/> + </xsl:element> + </xsl:template> + + <xsl:template match="@id"> + <xsl:copy/> + </xsl:template> + + <!-- copy processing instructions, too --> + <xsl:template match="processing-instruction()"> + <xsl:copy/> + </xsl:template> + + <!-- except for html2db instructions --> + <xsl:template match="processing-instruction('html2db')"/> + + <!-- Warn about any html elements that don't match a more + specific template. Copy them too, since it's often + easier to find them in the output. --> + <xsl:template match="h:*"> + <xsl:message terminate="no"> + Unknown element <xsl:value-of select="name()"/> + </xsl:message> + <xsl:copy> + <xsl:apply-templates/> + </xsl:copy> + </xsl:template> + + <!-- + Root element and body + --> + + <!-- ignore everything except the body --> + <xsl:template match="/"> + <xsl:apply-templates select="//h:body"/> + </xsl:template> + + <xsl:template match="h:body"> + <xsl:variable name="class-pi" + select="processing-instruction('html2db')[starts-with(string(), 'class="')][1]"/> + <xsl:variable name="class"> + <xsl:choose> + <xsl:when test="count($class-pi)!=0"> + <xsl:value-of select="substring-before(substring-after(string($class-pi[0]), 'class="'), '"')"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$document-root"/> + </xsl:otherwise> + </xsl:choose> + </xsl:variable> + + <!-- Warn if there are any text nodes outside a para, etc. See + the note at the naked text template for why this is a + warning. --> + <xsl:if test="text()[normalize-space() != '']"> + <xsl:message terminate="no"> + Text must be inside a <p> tag. + </xsl:message> + </xsl:if> + + <xsl:element name="{$class}"> + <xsl:apply-templates select="@id"/> + <xsl:call-template name="section-content"> + <xsl:with-param name="level" select="1"/> + <xsl:with-param name="nodes" select="//h:body/node()|//h:body/text()"/> + </xsl:call-template> + </xsl:element> + </xsl:template> + + <!-- + Section and section title processing + --> + + <!-- + Nest elements that *follow* an h1, h2, etc. into <section> elements + such that the <h1> content is the section's <title>. + --> + <xsl:template name="section-content"> + <xsl:param name="level"/> + <xsl:param name="nodes"/> + <xsl:param name="h1" select="concat('h', $level)"/> + <xsl:param name="h2" select="concat('h', $level+1)"/> + <xsl:param name="h2-position" select="count(exslt:node-set($nodes)[1]/following-sibling::*[local-name()=$h2])"/> + + <!-- copy up to first h2 --> + <xsl:apply-templates select="exslt:node-set($nodes)[ + count(following-sibling::*[local-name()=$h2])=$h2-position + ]"/> + + <!-- if section is empty, add an empty para so it will validate --> + <xsl:if test="not(exslt:node-set($nodes)/h:para[ + count(following-sibling::*[local-name()=$h2])=$h2-position + ])"> + <para/> + </xsl:if> + + <!-- subsections --> + <xsl:for-each select="exslt:node-set($nodes)[local-name()=$h2]"> + <section> + <xsl:variable name="mynodes" select="exslt:node-set($nodes)[ + count(following-sibling::*[local-name()=$h2])= + count(current()/following-sibling::*[local-name()=$h2])]"/> + <xsl:for-each select="exslt:node-set($mynodes)[local-name()=$h2]"> + <xsl:choose> + <xsl:when test="@id"> + <xsl:apply-templates select="@id"/> + </xsl:when> + <xsl:when test="h:a/@name"> + <xsl:attribute name="id"> + <xsl:value-of select="concat($anchor-id-prefix, h:a/@name)"/> + </xsl:attribute> + </xsl:when> + </xsl:choose> + </xsl:for-each> + <xsl:call-template name="section-content"> + <xsl:with-param name="level" select="$level+1"/> + <xsl:with-param name="nodes" select="exslt:node-set($nodes)[ + count(following-sibling::*[local-name()=$h2])= + count(current()/following-sibling::*[local-name()=$h2])]"/> + </xsl:call-template> + </section> + </xsl:for-each> + </xsl:template> + + <!-- + Remove anchors from hn titles. section-content attaches these as ids + to the section (after mutilating them as described in the docs). + --> + <xsl:template match="h:h1|h:h2|h:h3|h:h4|h:h5|h:h6"> + <title> + <xsl:apply-templates mode="skip-anchors" select="node()"/> + </title> + </xsl:template> + + <xsl:template mode="skip-anchors" match="h:a[@name]"> + <xsl:apply-templates/> + </xsl:template> + + <xsl:template mode="skip-anchors" match="node()"> + <xsl:apply-templates select="."/> + </xsl:template> + + <!-- + Inline elements + --> + <xsl:template match="h:b|h:i|h:em|h:strong"> + <emphasis role="{local-name()}"> + <xsl:apply-templates/> + </emphasis> + </xsl:template> + + <xsl:template match="h:dfn"> + <indexterm significance="preferred"> + <primary><xsl:apply-templates/></primary> + </indexterm> + <glossterm><xsl:apply-templates/></glossterm> + </xsl:template> + + <xsl:template match="h:var"> + <replaceable><xsl:apply-templates/></replaceable> + </xsl:template> + + <!-- + Inline elements in code + --> + <xsl:template match="h:code/h:i|h:tt/h:i|h:pre/h:i"> + <replaceable> + <xsl:apply-templates/> + </replaceable> + </xsl:template> + + <xsl:template match="h:code|h:tt"> + <literal> + <xsl:if test="@class"> + <xsl:attribute name="role"><xsl:value-of select="@class"/></xsl:attribute> + </xsl:if> + <xsl:apply-templates/> + </literal> + </xsl:template> + + <!-- For now, everything that doesn't have a specific match in inline + processing mode is matched against the default processing mode. --> + <xsl:template mode="inline" match="*"> + <xsl:apply-templates select="."/> + </xsl:template> + + <!-- + Block elements + --> + <xsl:template match="h:p"> + <para> + <xsl:apply-templates select="@id"/> + <xsl:apply-templates mode="inline"/> + </para> + </xsl:template> + + <!-- Wrap naked text nodes in a <para> so that they'll process more + correctly. The h:body also warns about these, because even + this preprocessing step isn't guaranteed to fix them. This is + because "Some <i>italic</i> text" will be preprocessed into + "<para>Some </para> <emphasis>italic</emphasis><para> + text</para>" instead of "<para>Some <emphasis>italic</emphasis> + text</para>". Getting this right would require more work than + just maintaining the source documents. --> + <xsl:template match="h:body/text()[normalize-space()!= '']"> + <!-- add an invalid tag to make it easy to find this in + the generated file --> + <naked-text> + <para> + <xsl:apply-templates/> + </para> + </naked-text> + </xsl:template> + + <xsl:template match="h:body/h:code|h:pre"> + <programlisting> + <xsl:apply-templates/> + </programlisting> + </xsl:template> + + <xsl:template match="h:blockquote"> + <blockquote> + <xsl:apply-templates mode="item" select="."/> + </blockquote> + </xsl:template> + + <!-- + Images + --> + <xsl:template name="imageobject"> + <imageobject> + <imagedata fileref="{@src}"> + <xsl:apply-templates select="@width|@height"/> + </imagedata> + </imageobject> + </xsl:template> + + <xsl:template match="h:img/@width"> + <xsl:copy/> + </xsl:template> + + <xsl:template match="h:img"> + <xsl:param name="informal"> + <xsl:if test="not(@title) and not(db:title)">informal</xsl:if> + </xsl:param> + <xsl:element name="{$informal}figure"> + <xsl:apply-templates select="@id"/> + <xsl:choose> + <xsl:when test="@title"> + <title><xsl:value-of select="@title"/></title> + </xsl:when> + <xsl:otherwise> + <xsl:apply-templates select="db:title"/> + </xsl:otherwise> + </xsl:choose> + <mediaobject> + <xsl:call-template name="imageobject"/> + <xsl:if test="@alt and normalize-space(@alt)!=''"> + <caption> + <para> + <xsl:value-of select="@alt"/> + </para> + </caption> + </xsl:if> + </mediaobject> + </xsl:element> + </xsl:template> + + <xsl:template mode="inline" match="h:img"> + <inlinemediaobject> + <xsl:apply-templates select="@id"/> + <xsl:call-template name="imageobject"/> + </inlinemediaobject> + </xsl:template> + + <!-- + links + --> + + <!-- anchors --> + <xsl:template match="h:a[@name]"> + <anchor id="{$anchor-id-prefix}{@name}"/> + <xsl:apply-templates/> + </xsl:template> + + <!-- internal link --> + <xsl:template match="h:a[starts-with(@href, '#')]"> + <link linkend="{$anchor-id-prefix}{substring-after(@href, '#')}"> + <xsl:apply-templates select="@*"/> + <xsl:apply-templates/> + </link> + </xsl:template> + + <!-- external link --> + <xsl:template match="h:a"> + <ulink url="{@href}"> + <xsl:apply-templates select="@*"/> + <xsl:apply-templates/> + </ulink> + </xsl:template> + + <!-- email --> + <xsl:template match="h:a[starts-with(@href, 'mailto:')]"> + <email> + <xsl:apply-templates select="@*"/> + <xsl:value-of select="substring-after(@href, 'mailto:')"/> + </email> + </xsl:template> + + <!-- link attributes --> + + <xsl:template match="h:a/@*"/> + + <xsl:template match="h:a/@id"> + <xsl:apply-templates select="@id"/> + </xsl:template> + + <xsl:template match="h:a/@target|h:a/@link"> + <xsl:processing-instruction name="db2html"> + <xsl:text>attribute name="</xsl:text> + <xsl:value-of select="name()"/> + <xsl:text>" value=</xsl:text> + <xsl:call-template name="quote"/> + </xsl:processing-instruction> + </xsl:template> + + <!-- + lists + --> + + <xsl:template match="h:dl"> + <variablelist> + <xsl:apply-templates select="db:*"/> + <xsl:apply-templates select="h:dt"/> + </variablelist> + </xsl:template> + + <xsl:template match="h:dt"> + <xsl:variable name="item-number" select="count(preceding-sibling::h:dt)+1"/> + <varlistentry> + <term> + <xsl:apply-templates/> + </term> + <listitem> + <!-- Select the dd that follows this dt without an intervening dd --> + <xsl:apply-templates mode="item" + select="following-sibling::h:dd[ + count(preceding-sibling::h:dt)=$item-number + ]"/> + <!-- If there is no such dd, then insert an empty para --> + <xsl:if test="count(following-sibling::h:dd[ + count(preceding-sibling::h:dt)=$item-number + ])=0"> + <para/> + </xsl:if> + </listitem> + </varlistentry> + </xsl:template> + + <xsl:template mode="item" match="*[count(h:p) = 0]"> + <para> + <xsl:apply-templates/> + </para> + </xsl:template> + + <xsl:template mode="nonblank-nodes" match="node()"> + <xsl:element name="{local-name()}"/> + </xsl:template> + + <xsl:template mode="nonblank-nodes" match="text()[normalize-space()='']"/> + + <xsl:template mode="nonblank-nodes" match="text()"> + <text/> + </xsl:template> + + <xsl:template mode="item" match="*"> + <!-- Test whether the first non-blank node is not a p --> + <xsl:param name="nonblank-nodes"> + <xsl:apply-templates mode="nonblank-nodes"/> + </xsl:param> + + <xsl:param name="tested" select=" + count(exslt:node-set($nonblank-nodes)/*) != 0 and + local-name(exslt:node-set($nonblank-nodes)/*[1]) != 'p'"/> + + <xsl:param name="n1" select="count(*[1]/following::h:p)"/> + <xsl:param name="n2" select="count(text()[1]/following::h:p)"/> + + <xsl:param name="n"> + <xsl:if test="$tested"> + <xsl:value-of select="java:java.lang.Math.max($n1, $n2)"/> + </xsl:if> + </xsl:param> + + <xsl:if test="false()"> + <nodeset tested="{$tested}" count="{count(exslt:node-set($nonblank-nodes)/*)}"> + <xsl:for-each select="exslt:node-set($nonblank-nodes)/*"> + <element name="{local-name()}"/> + </xsl:for-each> + </nodeset> + </xsl:if> + + <!-- Wrap everything before the first p into a para --> + <xsl:if test="$tested"> + <para> + <xsl:apply-templates select=" + node()[count(following::h:p)=$n] | + text()[count(following::h:p)=$n]"/> + </para> + </xsl:if> + <xsl:apply-templates select=" + node()[count(following::h:p)!=$n] | + text()[count(following::h:p)!=$n]"/> + </xsl:template> + + <xsl:template match="h:ol"> + <orderedlist spacing="compact"> + <xsl:for-each select="h:li"> + <listitem> + <xsl:apply-templates mode="item" select="."/> + </listitem> + </xsl:for-each> + </orderedlist> + </xsl:template> + + <xsl:template match="h:ul"> + <itemizedlist spacing="compact"> + <xsl:for-each select="h:li"> + <listitem> + <xsl:apply-templates mode="item" select="."/> + </listitem> + </xsl:for-each> + </itemizedlist> + </xsl:template> + + <xsl:template match="h:ul[processing-instruction('html2db')]"> + <simplelist> + <xsl:for-each select="h:li"> + <member type="vert"> + <xsl:apply-templates mode="item" select="."/> + </member> + </xsl:for-each> + </simplelist> + </xsl:template> + + <!-- + ignored markup + --> + <xsl:template match="h:br"> + <xsl:processing-instruction name="db2html"> + <xsl:text>element="</xsl:text> + <xsl:value-of select="local-name()"/> + <xsl:text>"</xsl:text> + </xsl:processing-instruction> + </xsl:template> + + <xsl:template match="h:span|h:div"> + <xsl:apply-templates select="*|node()|text()"/> + </xsl:template> + + <!-- + Utility functions and templates for tables + --> + <xsl:template mode="count-columns" match="h:tr"> + <n> + <xsl:value-of select="count(h:td)"/> + </n> + </xsl:template> + + <!-- tables --> + <xsl:template match="h:table"> + <xsl:param name="informal"> + <xsl:if test="not(@summary)">informal</xsl:if> + </xsl:param> + <xsl:param name="colcounts"> + <xsl:apply-templates mode="count-columns" select=".//h:tr"/> + </xsl:param> + <xsl:param name="cols" select="math:max(exslt:node-set($colcounts)/n)"/> + <xsl:param name="sorted"> + <xsl:for-each select="exslt:node-set($colcounts)/n"> + <xsl:sort order="descending" data-type="number"/> + <n><xsl:value-of select="."/></n> + </xsl:for-each> + </xsl:param> + <xsl:element name="{$informal}table"> + <xsl:apply-templates select="@id"/> + <xsl:if test="processing-instruction('html2db')[starts-with(., 'rowsep')]"> + <xsl:attribute name="rowsep">1</xsl:attribute> + </xsl:if> + <xsl:apply-templates select="processing-instruction()"/> + <xsl:if test="@summary"> + <title><xsl:value-of select="@summary"/></title> + </xsl:if> + <tgroup cols="{$cols}"> + <xsl:if test=".//h:tr/h:th"> + <thead> + <xsl:for-each select=".//h:tr[count(h:th)!=0]"> + <row> + <xsl:apply-templates select="@id"/> + <xsl:for-each select="h:td|h:th"> + <entry> + <xsl:apply-templates select="@id"/> + <xsl:apply-templates/> + </entry> + </xsl:for-each> + </row> + <xsl:text> </xsl:text> <!-- cr --> + </xsl:for-each> + </thead> + </xsl:if> + <tbody> + <xsl:for-each select=".//h:tr[count(h:th)=0]"> + <row> + <xsl:apply-templates select="@id"/> + <xsl:for-each select="h:td|h:th"> + <entry> + <xsl:apply-templates select="@id"/> + <xsl:apply-templates/> + </entry> + </xsl:for-each> + </row> + <xsl:text> </xsl:text> <!-- cr --> + </xsl:for-each> + </tbody> + </tgroup> + </xsl:element> + </xsl:template> +</xsl:stylesheet>
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/index.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,12 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>html2db.xsl</title><meta content="DocBook XSL Stylesheets V1.65.1" name="generator"><link rel="home" href="index.html" title="html2db.xsl"><link rel="next" href="ar01s02.html" title="Features"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">html2db.xsl</th></tr><tr><td align="left" width="20%"> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="ar01s02.html">Next</a></td></tr></table><hr></div><div class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="N10001"></a>html2db.xsl</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Oliver</span> <span class="surname">Steele</span></h3></div></div><div><div class="revhistory"><table summary="Revision history" width="100%" border="1"><tr><th colspan="2" valign="top" align="left"><b>Revision History</b></th></tr><tr><td align="left">Revision 1</td><td align="left">2004-07-30</td></tr><tr><td align="left">Revision 1.0.1</td><td align="left">2004-08-01</td></tr><tr><td colspan="2" align="left"><p>Editorial changes to the + readme.</p></td></tr></table></div></div></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="index.html#N10020">Overview</a></span></dt><dt><span class="section"><a href="ar01s02.html">Features</a></span></dt><dt><span class="section"><a href="ar01s03.html">Requirements</a></span></dt><dt><span class="section"><a href="ar01s04.html">License</a></span></dt><dt><span class="section"><a href="ar01s05.html">Installation</a></span></dt><dt><span class="section"><a href="ar01s06.html">Usage</a></span></dt><dt><span class="section"><a href="ar01s07.html">Specification</a></span></dt><dd><dl><dt><span class="section"><a href="ar01s07.html#N100DF">XHTML Elements</a></span></dt><dt><span class="section"><a href="ar01s07.html#N1017E">Links</a></span></dt><dt><span class="section"><a href="ar01s07.html#tables">Tables</a></span></dt><dt><span class="section"><a href="ar01s07.html#implicit-blocks">Implicit Blocks</a></span></dt><dt><span class="section"><a href="ar01s07.html#docbook-elements">Docbook Elements</a></span></dt><dt><span class="section"><a href="ar01s07.html#N10275">Output Processing Instructions</a></span></dt></dl></dd><dt><span class="section"><a href="ar01s08.html">Customization</a></span></dt><dd><dl><dt><span class="section"><a href="ar01s08.html#N102C9">XSLT Parameters</a></span></dt><dt><span class="section"><a href="ar01s08.html#processing-instructions">Processing instructions</a></span></dt><dt><span class="section"><a href="ar01s08.html#embedding">Overriding the built-in templates</a></span></dt></dl></dd><dt><span class="section"><a href="ar01s09.html">FAQ</a></span></dt><dd><dl><dt><span class="section"><a href="ar01s09.html#N1037C">Why generate Docbook?</a></span></dt><dt><span class="section"><a href="ar01s09.html#N1039D">Why write in XHTML?</a></span></dt><dt><span class="section"><a href="ar01s09.html#N103AF">Why not use an existing convertor?</a></span></dt><dt><span class="section"><a href="ar01s09.html#N103D8">I got this error. What does it mean?</a></span></dt></dl></dd><dt><span class="section"><a href="ar01s10.html">Implementation Notes</a></span></dt><dd><dl><dt><span class="section"><a href="ar01s10.html#N10418">Bugs</a></span></dt><dt><span class="section"><a href="ar01s10.html#N1042F">Limitations</a></span></dt><dt><span class="section"><a href="ar01s10.html#N1045A">Wishlist</a></span></dt><dt><span class="section"><a href="ar01s10.html#N1049D">Design Notes</a></span></dt><dt><span class="section"><a href="ar01s10.html#N104C3">History</a></span></dt><dt><span class="section"><a href="ar01s10.html#N104DE">Credits</a></span></dt></dl></dd></dl></div><p></p><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="N10020"></a>Overview</h2></div></div><div></div></div><p><tt class="literal">html2db.xsl</tt> converts an XHTML source document into a Docbook output +document. It provides features for customizing the generation of the +output, so that the output can be tuned by annotating +the source, rather than hand-editing the output. This makes it useful +in a processing pipeline where the source documents are maintained in +HTML, although it can be used as a one-time conversion tool +too.</p><p>This document is an example of <tt class="literal">html2db.xsl</tt> used in conjunction with +the Docbook XSL stylesheets. The <a href="index.src.html" target="_top">source +file</a> is an XHTML file with some embedded Docbook elements and +processing instructions. <tt class="literal">html2db.xsl</tt> compiles it into a <a href="index.xml" target="_top">Docbook document</a>, which can be used to generate +this output file (which includes a Table of Contents), a <a href="docs/index.html" target="_top">chunked HTML file</a>, a <a href="html2db.pdf" target="_top">PDF</a>, or other formats.</p><p></p></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="ar01s02.html">Next</a></td></tr><tr><td valign="top" align="left" width="40%"> </td><td align="center" width="20%"> </td><td valign="top" align="right" width="40%"> Features</td></tr></table></div></body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/index.src.html Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,620 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" +"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [ +<!ENTITY html2db "<code>html2db.xsl</code>"> +]> +<html xmlns:x="http://www.w3.org/1999/xhtml" + xmlns:db="urn:docbook"> +<head> +<title>This title is ignored</title> +</head> +<body> + +<h1>html2db.xsl</h1> + +<!-- The xmlns attribute escapes into the Docbook namespace --> +<articleinfo xmlns="urn:docbook"> + <author> + <firstname>Oliver</firstname> + <surname>Steele</surname> + </author> + <revhistory> + <revision> + <revnumber>1</revnumber> + <date>2004-07-30</date> + </revision> + <revision> + <revnumber>1.0.1</revnumber> + <date>2004-08-01</date> + <revdescription><para>Editorial changes to the + readme.</para></revdescription> + </revision> + </revhistory> + <date>2004-07-30</date> +</articleinfo> + +<h2>Overview</h2> + +<p>&html2db; converts an XHTML source document into a Docbook output +document. It provides features for customizing the generation of the +output, so that the output can be tuned by annotating +the source, rather than hand-editing the output. This makes it useful +in a processing pipeline where the source documents are maintained in +HTML, although it can be used as a one-time conversion tool +too.</p> + +<p>This document is an example of &html2db; used in conjunction with +the Docbook XSL stylesheets. The <a href="index.src.html">source +file</a> is an XHTML file with some embedded Docbook elements and +processing instructions. &html2db; compiles it into a <a +href="index.xml">Docbook document</a>, which can be used to generate +this output file (which includes a Table of Contents), a <a +href="docs/index.html">chunked HTML file</a>, a <a +href="html2db.pdf">PDF</a>, or other formats.</p> + +<h2>Features</h2> +<dl> +<dt>XSLT implementation</dt> +<dd>This tool is designed to be embedded within an XSLT processing +pipeline. <code>html2html.xslt</code> can be used in a custom +stylesheet or integrated into a larger system. See <a +href="#embedding">Overriding</a>.</dd> + +<dt>Customizable</dt> +<dd>The output can be customized by the means of additonal markup in +the XHMTL source. See the section on <a +href="#customization">customization</a>.</dd> + +<dt>Creates outline structure</dt> +<dd><code>h1</code>, <code>h2</code>, etc. are turned into nested +<code>section</code> and <code>title</code> elements (as opposed to +bridge heads).</dd> + +<dt>Accepts a wide variety of XHTML</dt> +<dd>In particular, &html2db; automatically wraps <dfn>naked item +text</dfn> (text that is not enclosed in a <code><p></code>) +inside a table cell or list item. Naked text is a common property of +XHTML documents, but needs to be clothed to create valid +Docbook.<db:footnote><p>This feature is limited. See <a +href="#implicit-blocks">Implicit Blocks</a>.)</p></db:footnote></dd> + +</dl> + +<h2>Requirements</h2> +<ul> +<li>Java: JRE or JDK 1.3 or greater.</li> +<li>Xalan 2.5.0.</li> +<li>Familiarity with installing and running JAR files.</li> +</ul> + +<p>&html2db; might work with earlier versions of Java and Xalan, and +it might work with other XSLT processors such as Saxon and +xsltproc.</p> + +<h2>License</h2> +<p>This software is released under the Open Source <a href="http://www.opensource.org/licenses/artistic-license.php">Artistic License</a>.</p> + +<h2>Installation</h2> +<ul> +<li>Install JRE 1.3 or higher.</li> +<li>Install Xalan, if necessary.</li> +<li>Download <code>html2db-1.zip</code> from <a href="http://osteele.com/sources/html2db.zip">http://osteele.com/sources/html2db-1.zip</a>.</li> +<li>Unzip <code>html2db-1.zip</code>.</li> +</ul> + +<h2>Usage</h2> +<p>Use Xalan to process an XHTML source file into a Docbook file:</p> + +<pre class="example"> +java org.apache.xalan.xslt.Process -XSL html2dbk.xsl -IN doc.html > doc.xml +</pre> + +<p>See <a href="index.src.html"><code>index.src.html</code></a> for an +example of an input file.</p> + +<p>If your source files are in HTML, not XHTML, you may find the <a +href="http://tidy.sourceforge.net/">Tidy</a> tool useful. This is a +tool that converts from HTML to XHTML, and can be added to the front +of your processing pipeline.</p> + +<p>(If you need to process HTML and you don't know or can't figure out +from context what a processing pipeline is, &html2db; is probably not +the right tool for you, and you should look for a local XML or Java +guru or for a commercially supported product.)</p> + +<h2>Specification</h2> + +<h3>XHTML Elements</h3> +<p><code>code/i</code> stands for "an <code>i</code> element +immediately within a <code>code</code> element". This notation is +from XPath.</p> + +<p>XHTML elements must be in the XHTML Transitional namespace, +<code>http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd</code>.</p> + +<table> +<tr> +<th>XHTML</th> +<th>Docbook</th> +<th>Notes</th> +</tr> + +<tr> +<td><code>b</code>, <code>i</code>, <code>em</code>, <code>strong</code></td> +<td><code>emphasis</code></td> +<td>The <code>role</code> attribute is the original tag name</td> +</tr> + +<tr> +<td><code>dfn</code></td> +<td><code>glossitem</code>, and also <code>primary</code> <code>indexterm</code></td> +</tr> + +<tr> +<td><code>code/i</code>, <code>tt/i</code>, <code>pre/i</code></td> +<td><code>replaceable</code></td> +<td>In practice, <code>i</code> within a monospace content is usually used to mean replaceable text. If you're using it for emphasis, use <code>em</code> instead.</td> +</tr> + +<tr> +<td><code>pre</code>, <code>body/code</code></td> +<td><code>programlisting</code></td> +</tr> + +<tr> +<td><code>img</code></td> +<td><code>inlinemediaobject/imageobject/imagedata</code></td> +<td>In an inline context.</td> +</tr> + +<tr> +<td><code>img</code></td> +<td><code>[informal]figure/mediaobject/imageobject/imagedata</code></td> +<td>If it has a <code>title</code> attribute or <code>db:title</code> it's wrapped in a <code>figure</code>. Otherwise it's wrapped in an <code>informalfigure</code>.</td> +</tr> + +<tr> +<td><code>table</code></td> +<td><code>[informal]table</code></td> +<td>XHTML <code>table</code> becomes Docbook <code>table</code> if it has a <code>summary</code> attribute; <code>informaltable</code> otherwise.</td> +</tr> + +<tr> +<td><code>ul</code></td> +<td><code>itemizedlist</code></td> +<td>But see the processing instruction <a href="#simplelist">below</a>.</td> +</tr> +</table> + + + +<h3>Links</h3> +<table summary="Link Translation"> +<tr> +<th>XHTML</th> +<th>Docbook</th> +<th>Notes</th> +</tr> + +<tr> +<td><code><a name="<var>name</var>"></code></td> +<td><code><anchor id="{$anchor-id-prefix}<var>name</var>"></code></td> +<td>An anchor within a <code>h<var>n</var></code> element is attached to the enclosing <code>section</code> as an <code>id</code> attribute instead.</td> +</tr> + +<tr> +<td><code><a href="#<var>name</var>"></code></td> +<td><code><link linkend="{$anchor-id-prefix}<var>name</var>"></code></td> +</tr> + +<tr> +<td><code><a href="<var>url</var>"></code></td> +<td><code><ulink url="<var>name</var>"></code></td> +</tr> + +<tr> +<td><code><a name="mailto:<var>address</var>"></code></td> +<td><code><email><var>address</var></email></code></td> +</tr> + +</table> + +<h3 id="tables">Tables</h3> + +<p>XHTML <code>table</code> support is minimal. &html2db; changes the +element names and counts the columns (this is necessary to get table +footnotes to span all the columns), but it does not attempt to deal +with tables in their full generality.</p> + +<p>An XHTML <code>table</code> with a <code>summary</code> attribute +generates a <code>table</code>, whose <code>title</code> is the value +of that summary. An XHTML <code>table</code> without a +<code>summary</code> generates an <code>informaltable</code>.</p> + +<p>Any <code>tr</code>s that contain <code>th</code>s are pulled to +the top of the table, and placed inside a <code>thead</code>. Other +<code>tr</code>s are placed inside a <code>tbody</code>. This matches +the commanon XHTML <code>table</code> pattern, where the first row is +a header row.</p> + +<h3 id="implicit-blocks">Implicit Blocks</h3> +<p>XHTML allows <code>li</code>, <code>dd</code>, and <code>td</code> +elements to contain either inline text (for instance, +<code><li>a list item</li></code>) or block structure +(<code><li><p>a block</p></li></code>). The +corresponding Docbook elements require block structure, such as +<code>para</code>.</p> + +<p>&html2db; provides limited support for wrapping naked text in +these positions in <code>para</code> elements. If a list item or +table cell item directly contains text, all text up to the position of +the first element (or all text, if there is no element) is wrapped in +<code>para</code>. This handles the simple case of an item that +directly contains text, and also the case of an item that contains +text followed by blocks such as paragraphs.</p> + +<p>Note that this algorithm is easily confused. It doesn't +distinguish between block and inline XHTML elements, so it will only +wrap the first word in <code><li>some <b>bold</b> +text</li></code>, leading to badly formatted output. Twhe +workaround is to wrap troublesome content in explicit +<code><p></code> tags.</p> + +<h3 id="docbook-elements">Docbook Elements</h3> + +<p>Elements from the Docbook namespace are passed through as is. +There are two ways to include a Docbook element in your XHTML +source:</p> + +<dl> +<dt>Global prefix</dt> +<dd><p>A <dfn>fake Docbook namespace</dfn><db:footnote><p>The fake +Docbook namespace is <code>urn:docbook</code>. Docbook doesn't really +have a namespace, and if it did, it wouldn't be this one. See <a +href="#docbook-namespace">Docbook namespace</a> for a discussion of +this issue.</p></db:footnote> + +declaration may be added to the document root element. Anywhere in +the document, the prefix from this namespace declaration may be used +to include a Docbook element. This is useful if a document contains +many Docbook elements, such as <code>footnote</code> or +<code>glossterm</code>, interspersed with XHTML. (In this case it may +be more convenient to allow these elements in the XHMTL namespace and +add a customization layer that translates them to docbook elements, +however. See <a href="#customization">Customization</a>.)</p> + +<pre class="example"><![CDATA[ +<html xmlns="http://www.w3.org/1999/xhtml" + xmlns:db="urn:docbook"> + ... + <p>Some text<db:footnote>and a footnote</db:footnote>.</p> +]]></pre></dd> + +<dt>Local namespace</dt> +<dd><p>A Docbook element may be introduced along with a prefix-less +namespace declaration. This is useful for embedding a Docbook +document fragment (a hierarchy of elements that all use Docbook tags) +within of a XHTML document.</p> + +<pre class="example"><![CDATA[ + ... + <articleinfo xmlns="urn:docbook"> + <author> + <firstname>...</firstname> + ... +]]></pre></dd> +</dl> + +<p>The source to <a href="index.src.html">this document</a> +illustrates both of these techniques.</p> + +<p class="note">Both these techniques will cause your document to be +invalid as XHTML. In order to validate an XHTML document that +contains Docbook elements, you will need to create a custom schema. +Technically, you then ought to place your document in a different +namespace, but this will cause &html2db; not to recognize it!</p> + + +<h3>Output Processing Instructions</h3> + +<p>&html2db; adds a few of processing instructions to the output file. +The Docbook XSL stylesheets ignore these, but if you write a +customization layer for Docbook XSL, you can use the information in +these processing instructions to customize the HTML output. This can +be used, for example, to set the <code>a</code> <code>onclick</code> +and <code>target</code> attributes in the HTML files that Docbook XSL +creates to the same values they had in the input document.</p> + +<dl> +<dt><code><?html2db attribute="<var>name</var>" value="<var>value</var>"?></code></dt> +<dd>Placed inside a link element to capture the value of the <code>a</code> <code>target</code> and <code>onclick</code> attributes. <var>name</var> is the name of the attribute (<code>target</code> or <code>onclick</code>), and <var>value</var> is its value, with <code>"</code> and <code>\</code> replaced by <code>\"</code> and <code>\\</code>, respectively.</dd> + +<dt><code><?html2db element="br"?></code></dt> +<dd>Represents the location of an XHTML <code>br</code> element in the +source document.</dd> + +</dl> + +<p>You can also include <code><?db2html?></code> processing +instructions in the HTML source document, and they will be copied +through to the Docbook output file unchanged (as will all other +processing instructions).</p> + + +<h2 id="customization">Customization</h2> +<h3>XSLT Parameters</h3> +<dl> + <dt><code><xsl:param name="anchor-id-prefix" select="''/></code></dt> + <dd>Prefixed to every id generated from <code><a name=></code> + and <code><a href="#"></code>. This is useful to avoid + collisions between multiple documents that are compiled into the + same book. For instance, if a number of XHTML sources are assembled + into chapters of a book, you style each source file with a prefix of + <code><var>docid</var>.</code> where <var>docid</var> is a unique id + for each source file.</dd> + + <dt><code><xsl:param name="document-root" select="'article'"/></code></dt> + <dd>The default document root. This can be overridden by + <code><?html2db class="<var>name</var>"></code> within the + document itself, and defaults to <code>article</code>.</dd> +</dl> + +<h3 id="processing-instructions">Processing instructions</h3> +<p>Use the <code><?html2db?></code> processing instruction to +customize the transformation of the XHTML source to Docbook:</p> + +<table> +<tr> +<th>Processing instruction</th> +<th>Content</th> +<th>Effect</th> +</tr> + +<tr> +<td><code><?html2db class="<var>xxx</var>"?></code></td> +<td><code>body</code></td> +<td>Sets the output document root to <var>xxx</var>. Useful for +translating to <code>prefix</code>, <code>appendix</code>, or <code>chapter</code>; the default is +<var>$document-root</var>.</td> +</tr> + +<tr id="simplelist"> +<td><code><?html2db class="simplelist"?></code></td> +<td><code>ul</code></td> +<td>Creates a vertical <code>simplelist</code>.<db:footnote><db:para>Note that the +current implementation simply checks for the presence of <em>any</em> +<code>html2db</code> processing instruction.</db:para></db:footnote></td> +</tr> + + +<tr> +<td><code><?html2db rowsep="1"?></code></td> +<td><code>[informal]table</code></td> +<td>Sets the <code>rowsep</code> attribute on the generated <code>table</code>.<db:footnote><db:para>Note that the current implementation simply checks for the presence of <em>any</em> <code>html2db</code> processing instruction that begins with <code>rowsep</code>, and assumes the vlaue is <code>1</code>.</db:para></db:footnote></td> +</tr> +</table> + +<h3 id="embedding">Overriding the built-in templates</h3> +<p>For cases where the previous techniques don't allow for enough +customization, you can override the builtin templates. You will need +to know XSLT in order to do this, and you will need to write a new +stylesheet that uses the <code>xsl:import</code> element to import +<code>html2db.xsl</code>.</p> + +<p>The <a href="examples.xsl"><code>example.xsl</code></a> stylesheet +is an example customization layer. It recognizes the <code><div +class="abstract"></code> and <code><p class="note"></code> +classes in the <a href="index.src.html">source</a> for this document, +and generates the corresponding Docbook elements.</p> + + +<h2>FAQ</h2> +<h3>Why generate Docbook?</h3> +<p>The primary reason to use Docbook as an <em>output</em> format is +to take advantage of the Docbook XSL stylesheets. These are a +well-designed, well-documented set of XSL stylesheets that provide a +variety of publishing features that would be difficult to recreate +from scratch for HTML:</p> + +<ul> +<li>Automatic Table-of-Contents generation</li> +<li>Automatic part, chapter, and section numbering.</li> +<li>Creation of single-page, multi-page, PDF, and WinHelp files from the same source document.</li> +<li>Navigation headers, footers, and metadata for multi-page HTML +documents.</li> +<li>Link resolution and link target text insertion across multiple pages and numbered targets.</li> +<li>Figure, example, and table numbering, and tables of these.</li> +<li>Index and glossary tools.</li> +</ul> + +<h3>Why write in XHTML?</h3> + +<p>Given that Docbook is so great, why not write in it?</p> + +<p>Where there are not legacy concerns, Docbook is probably a better +choice for structured or technical documentation.</p> + +<p>Where the only legacy concern is the documents themselves, and not +the tools and skill sets of documentation contributors, you should +consider using an (X)HMTL convertor to perform a one-time conversion +of your documentation source into Docbook, and then switching +development to the result files. You can use this stylesheet to +perform this conversion, or evaluate other tools, many of which are +probably appropriate for this purpose.</p> + +<p>Often there are other legacy concerns: the availability of cheap +(including free) and usable HTML editors and editing modes; and the +fact that it's easier to teach people XHTML than Docbook. If either +of this is an issue in your organization, you may want to maintain +documentation sources in XHTML instead of Docbook</p> + +<p>For example, at <a href="http://www.laszlosystems.com/">Laszlo</a>, +most developers contribute directly to the documentation. Requiring +that developers learn Docbook, or that they wait on the doc team to +get content into the docs, would discourage this.</p> + +<h3>Why not use an existing convertor?</h3> + +<p>This isn't the first (X)HTML to Docbook convertor. Why not use one +of the exisitng ones?</p> + +<p>Each HTML to Docbook convertors that I could find had at least some +of the following limitations, some of which stemmed from their +intended use as one-time-only convertors for legacy documents:</p> + +<ul> +<li>Many only operated on a subset of HTML, and relied upon hand +editing of the output to clean up mistakes. This made them impossible +to use as part of a processing pipeline, where the source is +<em>maintained</em> in XHTML.</li> + +<li>There was no way to customize the output, except by (1) hand +editing, or (2) writing a post-processing stylesheet, which didn't +have access to the information in the XHTML source document.</li> + +<li>Many of them were difficult or impossible to customize and +extend. They were closed-source, or written in Java or Perl (which I +find to be a difficult languages to use for customizing this kind of +thing) and embedded in a larger system.</li> + +<li>They didn't take full advantage of the Docbook tag set and content +model to represent document structure. For instance, they didn't +generate nested <code>section</code> elements to represent +<code>h1</code> <code>h2</code> sequences, or <code>table</code> to +represent tables with <code>summary</code> attributes.</li> +</ul> + +<h3>I got this error. What does it mean?</h3> +<dl> +<dt>Q. <code>Fatal Error! The element type "br" must be terminated by the matching end-tag "</br>". +</code></dt> +<dd>A. Your document is HTML, not <em>X</em>HTML. You need to fix it, or run it through Tidy first.</dd> + +<dt>Q. My output document is empty except for the <code><?xml version="1.0" encoding="UTF-8"?></code> line.</dt> +<dd>A. The document is missing a namespace declaration. See the <a href="index.src.html">example</a> for an example.</dd> + +<dt>Q. Some of the headers and document sections are repeated multiple times.</dt> +<dd>A. The document has out-of-sequence headers, such as <code>h1</code> followed by <code>h3</code> (instead of <code>h2</code>). This won't work.</dd> + +<dt>Q. <code>Fatal Error! The prefix "db" for element "db:footnote" is not bound.</code></dt> +<dd>A. You haven't declared the <code>db</code> namespace prefix. See the <a href="index.src.html">example</a> for an example.</dd> + +</dl> + + +<h2>Implementation Notes</h2> + +<h3>Bugs</h3> +<ul> +<li>Improperly sequenced <code>h<var>n</var></code> (for example +<code>h1</code> followed by <code>h3</code>, instead of +<code>h2</code>) will result in duplicate text.</li> +</ul> + + +<h3>Limitations</h3> +<ul> +<li>The <code>id</code> attribute is only preserved for certain +elements (at least <code>h<var>n</var></code>, images, paragraphs, and +tables). It ought to be preserved for all of them.</li> +<li>Only the <a href="#tables">very simplest</a> table format is +implemented.</li> +<li>Always uses compact lists.</li> +<li>The string matching for <code><?html2b +class="<var>classname</var>"?></code> requires an exact match +(spaces and all).</li> +<li>The <a href="#implicit-blocks">implicit blocks</a> code is easily +confused, as documented in that section. This is +easy to fix now that I understand the difference between block and +inline elements (I didn't when I was implementing this), but I +probably won't do so until I run into the problem again.</li> + +</ul> + + + + +<h3>Wishlist</h3> +<ul> +<li>Allow <code><html2db attribute-name="<var>name</var>" +value="<var>value</var>"?></code> at any position, to set arbitrary +Docbook attributes on the generated element.</li> + +<li>Use different technique from the <a href="#docbook-elements">fake +namespace prefix</a> to name Docbook elements in the source, that +preserves the XHTML validity of the source file. For example, an +option transform <code><div class="db:footnote"></code> into +<code><footnote></code>, or to use a processing attribute +(<code><div><?html2db classname="footnote"?></code>).</li> + +<li>Parse DC metadata from XHTML <code>html/head/meta</code>.</li> + +<li>Add an option to use <code>html/head/title</code> instead of +<code>html/body/h1[1]</code> for top title.</li> + +<li>Allow an <code>id</code> on every element.</li> + +<li>Add an option to translate the XHTML <code>class</code> into a +Docbook <code>role</code>.</li> + +<li>Preserve more of the whitespace from the source document &emdash; especially within lists and tables &emdash; in order to make it easier to debug the output document.</li> + +<h3>Support</h3> +<p>This is a work in progress. It serves my needs, but doesn't +attempt to be much more general than that. If you run into anything +it can't handle, please send a note, or better yet, a patch, to <a +href="mailto:steele@osteele.com">steele@osteele.com</a>. I can't +promise to address problems (I have a day job too), but knowing what +people have run into will help my prioritize my work when I do have +time to work on this.</p> + + +</ul> + + +<h3>Design Notes</h3> +<h4 id="docbook-namespace">The Docbook Namespace</h4> +<p>&html2db; accepts elements in the "Docbook namespace" in XHTML +source. This namespace is <code>urn:docbook</code>.</p> + +<p>This isn't technically correct. Docbook doesn't really have a +namespace, and if it did, it wouldn't be this one. <a +href="http://www.faqs.org/rfcs/rfc3151.html">RFC 3151</a> suggests +<code>urn:publicid:-:OASIS:DTD+DocBook+XML+V4.1.2:EN</code> as the +Docbook namespace.</p> + +<p>There two problems with the RFC 3151 namespace. First, it's long +and hard to remember. Second, it's limited to Docbook v4.1.2 &emdash; +but &html2db; works with other versions of Docbook too, which would +presumably have other namespaces. I think it's more useful to +<em>under</em>specify the Docbook version in the spec for this tool. +Docbook itself underspecifies the version completely, by avoiding a +namespace at all, but when mixing Docbook and XHTML elements I find it +useful to be <em>more</em> specific than that.</p> + +<h3>History</h3> +<p>The original version of &html2db; was written by <a +href="http://osteele.com">Oliver Steele</a>, as part of the <a +href="http://laszlosystems.com">Laszlo Systems, Inc.</a> documentation +effort. We had a set of custom stylesheets that formatted and added +linking information to programming-language elements such as +<code>classname</code> and <code>tagname</code>, and added +Table-of-Contents to chapter documentation and numbers examples.</p> + +<p>As the documentation set grew, the doc team (John Sundman) +requested features such as inter-chapter navigation, callouts, and +index and glossary elements. I was able to beat all of these back +except for navigation, which seemed critical. After a few days trying +to implement this, I decided it would be simpler to convert the subset +of XHTML that we used into a subset of Docbook, and use the latter to +add navigation. (Once this was done, the other features came for +free.)</p> + +<p>During my August 2004 "sabbatical", I factored the general html2db +code out from the Laszlo-specific code, refactored and otherwise +cleaned it up, and wrote this documentation.</p> + +<h3>Credits</h3> +<p>&html2db; was written by <a href="http://osteele.com">Oliver Steele</a>, as part of the <a href="http://laszlosystems.com">Laszlo Systems, Inc.</a> documentation effort.</p> + +</body> +</html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/wiki2docbook/html2db/index.xml Sun Nov 22 09:12:22 2009 +0000 @@ -0,0 +1,410 @@ +<?xml version="1.0" encoding="UTF-8"?> +<article> + +<title>html2db.xsl</title> + + +<articleinfo> + <author> + <firstname>Oliver</firstname> + <surname>Steele</surname> + </author> + <revhistory> + <revision> + <revnumber>1</revnumber> + <date>2004-07-30</date> + </revision> + <revision> + <revnumber>1.0.1</revnumber> + <date>2004-08-01</date> + <revdescription><para>Editorial changes to the + readme.</para></revdescription> + </revision> + </revhistory> + <date>2004-07-30</date> +</articleinfo> + +<para/><section><title>Overview</title> + +<para><literal>html2db.xsl</literal> converts an XHTML source document into a Docbook output +document. It provides features for customizing the generation of the +output, so that the output can be tuned by annotating +the source, rather than hand-editing the output. This makes it useful +in a processing pipeline where the source documents are maintained in +HTML, although it can be used as a one-time conversion tool +too.</para> + +<para>This document is an example of <literal>html2db.xsl</literal> used in conjunction with +the Docbook XSL stylesheets. The <ulink url="index.src.html">source +file</ulink> is an XHTML file with some embedded Docbook elements and +processing instructions. <literal>html2db.xsl</literal> compiles it into a <ulink url="index.xml">Docbook document</ulink>, which can be used to generate +this output file (which includes a Table of Contents), a <ulink url="docs/index.html">chunked HTML file</ulink>, a <ulink url="html2db.pdf">PDF</ulink>, or other formats.</para> + +<para/></section><section><title>Features</title> +<variablelist><varlistentry><term>XSLT implementation</term><listitem><para>This tool is designed to be embedded within an XSLT processing +pipeline. <literal>html2html.xslt</literal> can be used in a custom +stylesheet or integrated into a larger system. See <link linkend="embedding">Overriding</link>.</para></listitem></varlistentry><varlistentry><term>Customizable</term><listitem><para>The output can be customized by the means of additonal markup in +the XHMTL source. See the section on <link linkend="customization">customization</link>.</para></listitem></varlistentry><varlistentry><term>Creates outline structure</term><listitem><para><literal>h1</literal>, <literal>h2</literal>, etc. are turned into nested +<literal>section</literal> and <literal>title</literal> elements (as opposed to +bridge heads).</para></listitem></varlistentry><varlistentry><term>Accepts a wide variety of XHTML</term><listitem><para>In particular, <literal>html2db.xsl</literal> automatically wraps <indexterm significance="preferred"><primary>naked item +text</primary></indexterm><glossterm>naked item +text</glossterm> (text that is not enclosed in a <literal><p></literal>) +inside a table cell or list item. Naked text is a common property of +XHTML documents, but needs to be clothed to create valid +Docbook.<footnote><para>This feature is limited. See <link linkend="implicit-blocks">Implicit Blocks</link>.)</para></footnote></para></listitem></varlistentry></variablelist> + +<para/></section><section><title>Requirements</title> +<itemizedlist spacing="compact"><listitem><para>Java: JRE or JDK 1.3 or greater.</para></listitem><listitem><para>Xalan 2.5.0.</para></listitem><listitem><para>Familiarity with installing and running JAR files.</para></listitem></itemizedlist> + +<para><literal>html2db.xsl</literal> might work with earlier versions of Java and Xalan, and +it might work with other XSLT processors such as Saxon and +xsltproc.</para> + +<para/></section><section><title>License</title> +<para>This software is released under the Open Source <ulink url="http://www.opensource.org/licenses/artistic-license.php">Artistic License</ulink>.</para> + +<para/></section><section><title>Installation</title> +<itemizedlist spacing="compact"><listitem><para>Install JRE 1.3 or higher.</para></listitem><listitem><para>Install Xalan, if necessary.</para></listitem><listitem><para>Download <literal>html2db-1.zip</literal> from <ulink url="http://osteele.com/sources/html2db.zip">http://osteele.com/sources/html2db-1.zip</ulink>.</para></listitem><listitem><para>Unzip <literal>html2db-1.zip</literal>.</para></listitem></itemizedlist> + +<para/></section><section><title>Usage</title> +<para>Use Xalan to process an XHTML source file into a Docbook file:</para> + +<informalexample><programlisting> +java org.apache.xalan.xslt.Process -XSL html2dbk.xsl -IN doc.html > doc.xml +</programlisting></informalexample> + +<para>See <ulink url="index.src.html"><literal>index.src.html</literal></ulink> for an +example of an input file.</para> + +<para>If your source files are in HTML, not XHTML, you may find the <ulink url="http://tidy.sourceforge.net/">Tidy</ulink> tool useful. This is a +tool that converts from HTML to XHTML, and can be added to the front +of your processing pipeline.</para> + +<para>(If you need to process HTML and you don't know or can't figure out +from context what a processing pipeline is, <literal>html2db.xsl</literal> is probably not +the right tool for you, and you should look for a local XML or Java +guru or for a commercially supported product.)</para> + +<para/></section><section><title>Specification</title> + +<para/><section><title>XHTML Elements</title> +<para><literal>code/i</literal> stands for "an <literal>i</literal> element +immediately within a <literal>code</literal> element". This notation is +from XPath.</para> + +<para>XHTML elements must be in the XHTML Transitional namespace, +<literal>http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd</literal>.</para> + +<informaltable><tgroup cols="3"><thead><row><entry>XHTML</entry><entry>Docbook</entry><entry>Notes</entry></row> +</thead><tbody><row><entry><literal>b</literal>, <literal>i</literal>, <literal>em</literal>, <literal>strong</literal></entry><entry><literal>emphasis</literal></entry><entry>The <literal>role</literal> attribute is the original tag name</entry></row> +<row><entry><literal>dfn</literal></entry><entry><literal>glossitem</literal>, and also <literal>primary</literal> <literal>indexterm</literal></entry></row> +<row><entry><literal>code/i</literal>, <literal>tt/i</literal>, <literal>pre/i</literal></entry><entry><literal>replaceable</literal></entry><entry>In practice, <literal>i</literal> within a monospace content is usually used to mean replaceable text. If you're using it for emphasis, use <literal>em</literal> instead.</entry></row> +<row><entry><literal>pre</literal>, <literal>body/code</literal></entry><entry><literal>programlisting</literal></entry></row> +<row><entry><literal>img</literal></entry><entry><literal>inlinemediaobject/imageobject/imagedata</literal></entry><entry>In an inline context.</entry></row> +<row><entry><literal>img</literal></entry><entry><literal>[informal]figure/mediaobject/imageobject/imagedata</literal></entry><entry>If it has a <literal>title</literal> attribute or <literal>db:title</literal> it's wrapped in a <literal>figure</literal>. Otherwise it's wrapped in an <literal>informalfigure</literal>.</entry></row> +<row><entry><literal>table</literal></entry><entry><literal>[informal]table</literal></entry><entry>XHTML <literal>table</literal> becomes Docbook <literal>table</literal> if it has a <literal>summary</literal> attribute; <literal>informaltable</literal> otherwise.</entry></row> +<row><entry><literal>ul</literal></entry><entry><literal>itemizedlist</literal></entry><entry>But see the processing instruction <link linkend="simplelist">below</link>.</entry></row> +</tbody></tgroup></informaltable> + + + +<para/></section><section><title>Links</title> +<table><title>Link Translation</title><tgroup cols="3"><thead><row><entry>XHTML</entry><entry>Docbook</entry><entry>Notes</entry></row> +</thead><tbody><row><entry><literal><a name="<replaceable>name</replaceable>"></literal></entry><entry><literal><anchor id="{$anchor-id-prefix}<replaceable>name</replaceable>"></literal></entry><entry>An anchor within a <literal>h<replaceable>n</replaceable></literal> element is attached to the enclosing <literal>section</literal> as an <literal>id</literal> attribute instead.</entry></row> +<row><entry><literal><a href="#<replaceable>name</replaceable>"></literal></entry><entry><literal><link linkend="{$anchor-id-prefix}<replaceable>name</replaceable>"></literal></entry></row> +<row><entry><literal><a href="<replaceable>url</replaceable>"></literal></entry><entry><literal><ulink url="<replaceable>name</replaceable>"></literal></entry></row> +<row><entry><literal><a name="mailto:<replaceable>address</replaceable>"></literal></entry><entry><literal><email><replaceable>address</replaceable></email></literal></entry></row> +</tbody></tgroup></table> + +<para/></section><section id="tables"><title>Tables</title> + +<para>XHTML <literal>table</literal> support is minimal. <literal>html2db.xsl</literal> changes the +element names and counts the columns (this is necessary to get table +footnotes to span all the columns), but it does not attempt to deal +with tables in their full generality.</para> + +<para>An XHTML <literal>table</literal> with a <literal>summary</literal> attribute +generates a <literal>table</literal>, whose <literal>title</literal> is the value +of that summary. An XHTML <literal>table</literal> without a +<literal>summary</literal> generates an <literal>informaltable</literal>.</para> + +<para>Any <literal>tr</literal>s that contain <literal>th</literal>s are pulled to +the top of the table, and placed inside a <literal>thead</literal>. Other +<literal>tr</literal>s are placed inside a <literal>tbody</literal>. This matches +the commanon XHTML <literal>table</literal> pattern, where the first row is +a header row.</para> + +<para/></section><section id="implicit-blocks"><title>Implicit Blocks</title> +<para>XHTML allows <literal>li</literal>, <literal>dd</literal>, and <literal>td</literal> +elements to contain either inline text (for instance, +<literal><li>a list item</li></literal>) or block structure +(<literal><li><p>a block</p></li></literal>). The +corresponding Docbook elements require block structure, such as +<literal>para</literal>.</para> + +<para><literal>html2db.xsl</literal> provides limited support for wrapping naked text in +these positions in <literal>para</literal> elements. If a list item or +table cell item directly contains text, all text up to the position of +the first element (or all text, if there is no element) is wrapped in +<literal>para</literal>. This handles the simple case of an item that +directly contains text, and also the case of an item that contains +text followed by blocks such as paragraphs.</para> + +<para>Note that this algorithm is easily confused. It doesn't +distinguish between block and inline XHTML elements, so it will only +wrap the first word in <literal><li>some <b>bold</b> +text</li></literal>, leading to badly formatted output. Twhe +workaround is to wrap troublesome content in explicit +<literal><p></literal> tags.</para> + +<para/></section><section id="docbook-elements"><title>Docbook Elements</title> + +<para>Elements from the Docbook namespace are passed through as is. +There are two ways to include a Docbook element in your XHTML +source:</para> + +<variablelist><varlistentry><term>Global prefix</term><listitem><para>A <indexterm significance="preferred"><primary>fake Docbook namespace</primary></indexterm><glossterm>fake Docbook namespace</glossterm><footnote><para>The fake +Docbook namespace is <literal>urn:docbook</literal>. Docbook doesn't really +have a namespace, and if it did, it wouldn't be this one. See <link linkend="docbook-namespace">Docbook namespace</link> for a discussion of +this issue.</para></footnote> + +declaration may be added to the document root element. Anywhere in +the document, the prefix from this namespace declaration may be used +to include a Docbook element. This is useful if a document contains +many Docbook elements, such as <literal>footnote</literal> or +<literal>glossterm</literal>, interspersed with XHTML. (In this case it may +be more convenient to allow these elements in the XHMTL namespace and +add a customization layer that translates them to docbook elements, +however. See <link linkend="customization">Customization</link>.)</para> + +<informalexample><programlisting> +<html xmlns="http://www.w3.org/1999/xhtml" + xmlns:db="urn:docbook"> + ... + <p>Some text<db:footnote>and a footnote</db:footnote>.</p> +</programlisting></informalexample></listitem></varlistentry><varlistentry><term>Local namespace</term><listitem><para>A Docbook element may be introduced along with a prefix-less +namespace declaration. This is useful for embedding a Docbook +document fragment (a hierarchy of elements that all use Docbook tags) +within of a XHTML document.</para> + +<informalexample><programlisting> + ... + <articleinfo xmlns="urn:docbook"> + <author> + <firstname>...</firstname> + ... +</programlisting></informalexample></listitem></varlistentry></variablelist> + +<para>The source to <ulink url="index.src.html">this document</ulink> +illustrates both of these techniques.</para> + +<note><para>Both these techniques will cause your document to be +invalid as XHTML. In order to validate an XHTML document that +contains Docbook elements, you will need to create a custom schema. +Technically, you then ought to place your document in a different +namespace, but this will cause <literal>html2db.xsl</literal> not to recognize it!</para></note> + + +<para/></section><section><title>Output Processing Instructions</title> + +<para><literal>html2db.xsl</literal> adds a few of processing instructions to the output file. +The Docbook XSL stylesheets ignore these, but if you write a +customization layer for Docbook XSL, you can use the information in +these processing instructions to customize the HTML output. This can +be used, for example, to set the <literal>a</literal> <literal>onclick</literal> +and <literal>target</literal> attributes in the HTML files that Docbook XSL +creates to the same values they had in the input document.</para> + +<variablelist><varlistentry><term><literal><?html2db attribute="<replaceable>name</replaceable>" value="<replaceable>value</replaceable>"?></literal></term><listitem><para>Placed inside a link element to capture the value of the <literal>a</literal> <literal>target</literal> and <literal>onclick</literal> attributes. <replaceable>name</replaceable> is the name of the attribute (<literal>target</literal> or <literal>onclick</literal>), and <replaceable>value</replaceable> is its value, with <literal>"</literal> and <literal>\</literal> replaced by <literal>\"</literal> and <literal>\\</literal>, respectively.</para></listitem></varlistentry><varlistentry><term><literal><?html2db element="br"?></literal></term><listitem><para>Represents the location of an XHTML <literal>br</literal> element in the +source document.</para></listitem></varlistentry></variablelist> + +<para>You can also include <literal><?db2html?></literal> processing +instructions in the HTML source document, and they will be copied +through to the Docbook output file unchanged (as will all other +processing instructions).</para> + + +<para/></section></section><section id="customization"><title>Customization</title> +<para/><section><title>XSLT Parameters</title> +<variablelist><varlistentry><term><literal><xsl:param name="anchor-id-prefix" select="''/></literal></term><listitem><para>Prefixed to every id generated from <literal><a name=></literal> + and <literal><a href="#"></literal>. This is useful to avoid + collisions between multiple documents that are compiled into the + same book. For instance, if a number of XHTML sources are assembled + into chapters of a book, you style each source file with a prefix of + <literal><replaceable>docid</replaceable>.</literal> where <replaceable>docid</replaceable> is a unique id + for each source file.</para></listitem></varlistentry><varlistentry><term><literal><xsl:param name="document-root" select="'article'"/></literal></term><listitem><para>The default document root. This can be overridden by + <literal><?html2db class="<replaceable>name</replaceable>"></literal> within the + document itself, and defaults to <literal>article</literal>.</para></listitem></varlistentry></variablelist> + +<para/></section><section id="processing-instructions"><title>Processing instructions</title> +<para>Use the <literal><?html2db?></literal> processing instruction to +customize the transformation of the XHTML source to Docbook:</para> + +<informaltable><tgroup cols="3"><thead><row><entry>Processing instruction</entry><entry>Content</entry><entry>Effect</entry></row> +</thead><tbody><row><entry><literal><?html2db class="<replaceable>xxx</replaceable>"?></literal></entry><entry><literal>body</literal></entry><entry>Sets the output document root to <replaceable>xxx</replaceable>. Useful for +translating to <literal>prefix</literal>, <literal>appendix</literal>, or <literal>chapter</literal>; the default is +<replaceable>$document-root</replaceable>.</entry></row> +<row id="simplelist"><entry><literal><?html2db class="simplelist"?></literal></entry><entry><literal>ul</literal></entry><entry>Creates a vertical <literal>simplelist</literal>.<footnote><para>Note that the +current implementation simply checks for the presence of <emphasis role="em">any</emphasis> +<literal>html2db</literal> processing instruction.</para></footnote></entry></row> +<row><entry><literal><?html2db rowsep="1"?></literal></entry><entry><literal>[informal]table</literal></entry><entry>Sets the <literal>rowsep</literal> attribute on the generated <literal>table</literal>.<footnote><para>Note that the current implementation simply checks for the presence of <emphasis role="em">any</emphasis> <literal>html2db</literal> processing instruction that begins with <literal>rowsep</literal>, and assumes the vlaue is <literal>1</literal>.</para></footnote></entry></row> +</tbody></tgroup></informaltable> + +<para/></section><section id="embedding"><title>Overriding the built-in templates</title> +<para>For cases where the previous techniques don't allow for enough +customization, you can override the builtin templates. You will need +to know XSLT in order to do this, and you will need to write a new +stylesheet that uses the <literal>xsl:import</literal> element to import +<literal>html2db.xsl</literal>.</para> + +<para>The <ulink url="examples.xsl"><literal>example.xsl</literal></ulink> stylesheet +is an example customization layer. It recognizes the <literal><div +class="abstract"></literal> and <literal><p class="note"></literal> +classes in the <ulink url="index.src.html">source</ulink> for this document, +and generates the corresponding Docbook elements.</para> + + +<para/></section></section><section><title>FAQ</title> +<para/><section><title>Why generate Docbook?</title> +<para>The primary reason to use Docbook as an <emphasis role="em">output</emphasis> format is +to take advantage of the Docbook XSL stylesheets. These are a +well-designed, well-documented set of XSL stylesheets that provide a +variety of publishing features that would be difficult to recreate +from scratch for HTML:</para> + +<itemizedlist spacing="compact"><listitem><para>Automatic Table-of-Contents generation</para></listitem><listitem><para>Automatic part, chapter, and section numbering.</para></listitem><listitem><para>Creation of single-page, multi-page, PDF, and WinHelp files from the same source document.</para></listitem><listitem><para>Navigation headers, footers, and metadata for multi-page HTML +documents.</para></listitem><listitem><para>Link resolution and link target text insertion across multiple pages and numbered targets.</para></listitem><listitem><para>Figure, example, and table numbering, and tables of these.</para></listitem><listitem><para>Index and glossary tools.</para></listitem></itemizedlist> + +<para/></section><section><title>Why write in XHTML?</title> + +<para>Given that Docbook is so great, why not write in it?</para> + +<para>Where there are not legacy concerns, Docbook is probably a better +choice for structured or technical documentation.</para> + +<para>Where the only legacy concern is the documents themselves, and not +the tools and skill sets of documentation contributors, you should +consider using an (X)HMTL convertor to perform a one-time conversion +of your documentation source into Docbook, and then switching +development to the result files. You can use this stylesheet to +perform this conversion, or evaluate other tools, many of which are +probably appropriate for this purpose.</para> + +<para>Often there are other legacy concerns: the availability of cheap +(including free) and usable HTML editors and editing modes; and the +fact that it's easier to teach people XHTML than Docbook. If either +of this is an issue in your organization, you may want to maintain +documentation sources in XHTML instead of Docbook</para> + +<para>For example, at <ulink url="http://www.laszlosystems.com/">Laszlo</ulink>, +most developers contribute directly to the documentation. Requiring +that developers learn Docbook, or that they wait on the doc team to +get content into the docs, would discourage this.</para> + +<para/></section><section><title>Why not use an existing convertor?</title> + +<para>This isn't the first (X)HTML to Docbook convertor. Why not use one +of the exisitng ones?</para> + +<para>Each HTML to Docbook convertors that I could find had at least some +of the following limitations, some of which stemmed from their +intended use as one-time-only convertors for legacy documents:</para> + +<itemizedlist spacing="compact"><listitem><para>Many only operated on a subset of HTML, and relied upon hand +editing of the output to clean up mistakes. This made them impossible +to use as part of a processing pipeline, where the source is +<emphasis role="em">maintained</emphasis> in XHTML.</para></listitem><listitem><para>There was no way to customize the output, except by (1) hand +editing, or (2) writing a post-processing stylesheet, which didn't +have access to the information in the XHTML source document.</para></listitem><listitem><para>Many of them were difficult or impossible to customize and +extend. They were closed-source, or written in Java or Perl (which I +find to be a difficult languages to use for customizing this kind of +thing) and embedded in a larger system.</para></listitem><listitem><para>They didn't take full advantage of the Docbook tag set and content +model to represent document structure. For instance, they didn't +generate nested <literal>section</literal> elements to represent +<literal>h1</literal> <literal>h2</literal> sequences, or <literal>table</literal> to +represent tables with <literal>summary</literal> attributes.</para></listitem></itemizedlist> + +<para/></section><section><title>I got this error. What does it mean?</title> +<variablelist><varlistentry><term>Q. <literal>Fatal Error! The element type "br" must be terminated by the matching end-tag "</br>". +</literal></term><listitem><para>A. Your document is HTML, not <emphasis role="em">X</emphasis>HTML. You need to fix it, or run it through Tidy first.</para></listitem></varlistentry><varlistentry><term>Q. My output document is empty except for the <literal><?xml version="1.0" encoding="UTF-8"?></literal> line.</term><listitem><para>A. The document is missing a namespace declaration. See the <ulink url="index.src.html">example</ulink> for an example.</para></listitem></varlistentry><varlistentry><term>Q. Some of the headers and document sections are repeated multiple times.</term><listitem><para>A. The document has out-of-sequence headers, such as <literal>h1</literal> followed by <literal>h3</literal> (instead of <literal>h2</literal>). This won't work.</para></listitem></varlistentry><varlistentry><term>Q. <literal>Fatal Error! The prefix "db" for element "db:footnote" is not bound.</literal></term><listitem><para>A. You haven't declared the <literal>db</literal> namespace prefix. See the <ulink url="index.src.html">example</ulink> for an example.</para></listitem></varlistentry></variablelist> + + +<para/></section></section><section><title>Implementation Notes</title> + +<para/><section><title>Bugs</title> +<itemizedlist spacing="compact"><listitem><para>Improperly sequenced <literal>h<replaceable>n</replaceable></literal> (for example +<literal>h1</literal> followed by <literal>h3</literal>, instead of +<literal>h2</literal>) will result in duplicate text.</para></listitem></itemizedlist> + + +<para/></section><section><title>Limitations</title> +<itemizedlist spacing="compact"><listitem><para>The <literal>id</literal> attribute is only preserved for certain +elements (at least <literal>h<replaceable>n</replaceable></literal>, images, paragraphs, and +tables). It ought to be preserved for all of them.</para></listitem><listitem><para>Only the <link linkend="tables">very simplest</link> table format is +implemented.</para></listitem><listitem><para>Always uses compact lists.</para></listitem><listitem><para>The string matching for <literal><?html2b +class="<replaceable>classname</replaceable>"?></literal> requires an exact match +(spaces and all).</para></listitem><listitem><para>The <link linkend="implicit-blocks">implicit blocks</link> code is easily +confused, as documented in that section. This is +easy to fix now that I understand the difference between block and +inline elements (I didn't when I was implementing this), but I +probably won't do so until I run into the problem again.</para></listitem></itemizedlist> + + + + +<para/></section><section><title>Wishlist</title> +<itemizedlist spacing="compact"><listitem><para>Allow <literal><html2db attribute-name="<replaceable>name</replaceable>" +value="<replaceable>value</replaceable>"?></literal> at any position, to set arbitrary +Docbook attributes on the generated element.</para></listitem><listitem><para>Use different technique from the <link linkend="docbook-elements">fake +namespace prefix</link> to name Docbook elements in the source, that +preserves the XHTML validity of the source file. For example, an +option transform <literal><div class="db:footnote"></literal> into +<literal><footnote></literal>, or to use a processing attribute +(<literal><div><?html2db classname="footnote"?></literal>).</para></listitem><listitem><para>Parse DC metadata from XHTML <literal>html/head/meta</literal>.</para></listitem><listitem><para>Add an option to use <literal>html/head/title</literal> instead of +<literal>html/body/h1[1]</literal> for top title.</para></listitem><listitem><para>Allow an <literal>id</literal> on every element.</para></listitem><listitem><para>Add an option to translate the XHTML <literal>class</literal> into a +Docbook <literal>role</literal>.</para></listitem><listitem><para>Preserve more of the whitespace from the source document especially within lists and tables in order to make it easier to debug the output document.</para></listitem></itemizedlist> + + +<para/></section><section><title>Design Notes</title> +<para/><section id="docbook-namespace"><title>The Docbook Namespace</title> +<para><literal>html2db.xsl</literal> accepts elements in the "Docbook namespace" in XHTML +source. This namespace is <literal>urn:docbook</literal>.</para> + +<para>This isn't technically correct. Docbook doesn't really have a +namespace, and if it did, it wouldn't be this one. <ulink url="http://www.faqs.org/rfcs/rfc3151.html">RFC 3151</ulink> suggests +<literal>urn:publicid:-:OASIS:DTD+DocBook+XML+V4.1.2:EN</literal> as the +Docbook namespace.</para> + +<para>There two problems with the RFC 3151 namespace. First, it's long +and hard to remember. Second, it's limited to Docbook v4.1.2 +but <literal>html2db.xsl</literal> works with other versions of Docbook too, which would +presumably have other namespaces. I think it's more useful to +<emphasis role="em">under</emphasis>specify the Docbook version in the spec for this tool. +Docbook itself underspecifies the version completely, by avoiding a +namespace at all, but when mixing Docbook and XHTML elements I find it +useful to be <emphasis role="em">more</emphasis> specific than that.</para> + +<para/></section></section><section><title>History</title> +<para>The original version of <literal>html2db.xsl</literal> was written by <ulink url="http://osteele.com">Oliver Steele</ulink>, as part of the <ulink url="http://laszlosystems.com">Laszlo Systems, Inc.</ulink> documentation +effort. We had a set of custom stylesheets that formatted and added +linking information to programming-language elements such as +<literal>classname</literal> and <literal>tagname</literal>, and added +Table-of-Contents to chapter documentation and numbers examples.</para> + +<para>As the documentation set grew, the doc team (John Sundman) +requested features such as inter-chapter navigation, callouts, and +index and glossary elements. I was able to beat all of these back +except for navigation, which seemed critical. After a few days trying +to implement this, I decided it would be simpler to convert the subset +of XHTML that we used into a subset of Docbook, and use the latter to +add navigation. (Once this was done, the other features came for +free.)</para> + +<para>During my August 2004 "sabbatical", I factored the general html2db +code out from the Laszlo-specific code, refactored and otherwise +cleaned it up, and wrote this documentation.</para> + +<para/></section><section><title>Credits</title> +<para><literal>html2db.xsl</literal> was written by <ulink url="http://osteele.com">Oliver Steele</ulink>, as part of the <ulink url="http://laszlosystems.com">Laszlo Systems, Inc.</ulink> documentation effort.</para> + +<para/></section></section></article> \ No newline at end of file