Geeqie provides the ability to build lists of images, regardless of the location of the files on disk.
-
-
The collection window
-
-
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.
-
-
To open a new empty collection window press C or select New collection from the file menu.
-
-
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.
-
-
The collection window consists of a pane to display the contents of the collection, and a status bar along the bottom of the window.
-
-
Icon pane
-
-
The icon pane displays images contained in the collection as thumbnails in a grid, by default the file names also appear below each thumbnail.
-
-
The Icon pane works exactly like the Icon view mode of the file pane in a main window. But with the addition that the contents of the collection can be organized with drag and drop.
-
-
A context menu is available for the icon pane by right clicking the mouse or pressing the Menu key.
-
-
Keyboard shortcuts available in the collection window:
-
-
-
-
-
-
-
-
-
-
-
Shortcut
-
-
-
-
Context menu name
-
-
-
-
Description
-
-
-
-
-
-
-
Enter
-
-
-
-
View
-
-
-
-
Opens selected image in main window.
-
-
-
-
-
-
V
-
-
-
-
View in new window
-
-
-
-
Opens selected image in a new window.
-
-
-
-
-
-
Ctrl + A
-
-
-
-
Select all
-
-
-
-
Selects all images.
-
-
-
-
-
-
Ctrl + Shift + A
-
-
-
-
Select none
-
-
-
-
Clear the image selection.
-
-
-
-
-
-
Ctrl + 1 through
- Ctrl + 0
-
-
-
-
Edit sub menu
-
-
-
-
Executes the respective editor command.
-
-
-
-
-
-
Ctrl + P
-
-
-
-
Properties
-
-
-
-
Opens a properties window for selected images.
-
-
-
-
-
-
Ctrl + C
-
-
-
-
Copy
-
-
-
-
Copy selected images.
-
-
-
-
-
-
Ctrl + M
-
-
-
-
Move
-
-
-
-
Move selected images.
-
-
-
-
-
-
Ctrl + R
-
-
-
-
Rename
-
-
-
-
Rename selected images.
-
-
-
-
-
-
Ctrl + D
-
-
-
-
Delete
-
-
-
-
Delete selected images.
-
-
-
-
-
-
Delete
-
-
-
-
Remove
-
-
-
-
Remove selected images from result list.
-
-
-
-
-
-
Ctrl + L
-
-
-
-
Append from file list
-
-
-
-
Add contents of main window to collection.
-
-
-
-
-
-
A
-
-
-
-
Append from collection
-
-
-
-
Append contents of another collection from a file.
-
-
-
-
-
-
S
-
-
-
-
Save collection
-
-
-
-
Save collection to disk, if the collection is new a dialog will appear to select the file name and location.
-
-
-
-
-
-
Ctrl + S
-
-
-
-
Save collection as
-
-
-
-
Opens a dialog to select a new file name to use for the collection.
-
-
-
-
-
-
Ctrl + T
-
-
-
-
Show filename text
-
-
-
-
Toggle display of text below icons. When set, icon's tooltip will show the full path to the file.
-
-
-
-
-
-
Menu
-
-
-
-
-
-
Displays the context menu.
-
-
-
-
-
-
N
-
-
-
-
Sort by name
-
-
-
-
Sort collection by file name.
-
-
-
-
-
-
I
-
-
-
-
Sort by number
-
-
-
-
Sort collection by file name, using natural numerical order
-
-
-
-
-
-
D
-
-
-
-
Sort by date
-
-
-
-
Sort collection by file date.
-
-
-
-
-
-
B
-
-
-
-
Sort by size
-
-
-
-
Sort collection by file size.
-
-
-
-
-
-
P
-
-
-
-
Sort by path
-
-
-
-
Sort collection by file location (path to file).
-
-
-
-
-
-
-
-
Print
-
-
-
-
Opens a print dialog for selected images.
-
-
-
-
-
-
Ctrl + W
-
-
-
-
-
-
Close window.
-
-
-
-
-
-
The selection can be changed using the keyboard and mouse the same as in a file pane of the main window.
-
-
Status bar
-
-
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.
-
-
Drag and Drop
-
-
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.
-
-
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.
-
-
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.
-
-
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.
Geeqie is maintained by The Geeqie Team (Vladimir Nadvornik, Petr Ostadal, Laurent Monin).
-
This software is a fork of GQview project by John Ellis.
-
-
The ever growing list of contributors and language translators can be found in the README file included with the latest release of the program.
- The Credits can also be viewed by selecting the Credits button located in the About dialog (open Help Menu, select About, click Credits... button).
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.
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".
-
-
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideCollections.xml
--- /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 @@
+
+
+
+ Collections
+
+
+ Geeqie provides the ability to build lists of images, regardless of the location of the files on disk.
+
+
+ The collection window
+
+
+ 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.
+
+
+ To open a new empty collection window press C or select New collection from the file menu.
+
+
+ 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.
+
+
+ The collection window consists of a pane to display the contents of the collection, and a status bar along the bottom of the window.
+
+
+ Icon pane
+
+
+ The icon pane displays images contained in the collection as thumbnails in a grid, by default the file names also appear below each thumbnail.
+
+
+ The Icon pane works exactly like the Icon view mode of the file pane in a main window. But with the addition that the contents of the collection can be organized with drag and drop.
+
+
+ A context menu is available for the icon pane by right clicking the mouse or pressing the Menu key.
+
+
+ Keyboard shortcuts available in the collection window:
+
+
+ Shortcut
+
+ Context menu name
+
+ Description
+
+
+ Enter
+
+ View
+
+ Opens selected image in main window.
+
+
+ V
+
+ View in new window
+
+ Opens selected image in a new window.
+
+
+ Ctrl + A
+
+ Select all
+
+ Selects all images.
+
+
+ Ctrl + Shift + A
+
+ Select none
+
+ Clear the image selection.
+
+
+ Ctrl + 1 through
+ Ctrl + 0
+
+ Edit sub menu
+
+ Executes the respective editor command.
+
+
+ Ctrl + P
+
+ Properties
+
+ Opens a properties window for selected images.
+
+
+ Ctrl + C
+
+ Copy
+
+ Copy selected images.
+
+
+ Ctrl + M
+
+ Move
+
+ Move selected images.
+
+
+ Ctrl + R
+
+ Rename
+
+ Rename selected images.
+
+
+ Ctrl + D
+
+ Delete
+
+ Delete selected images.
+
+
+ Delete
+
+ Remove
+
+ Remove selected images from result list.
+
+
+ Ctrl + L
+
+ Append from file list
+
+ Add contents of main window to collection.
+
+
+ A
+
+ Append from collection
+
+ Append contents of another collection from a file.
+
+
+ S
+
+ Save collection
+
+ Save collection to disk, if the collection is new a dialog will appear to select the file name and location.
+
+
+ Ctrl + S
+
+ Save collection as
+
+ Opens a dialog to select a new file name to use for the collection.
+
+
+ Ctrl + T
+
+ Show filename text
+
+ Toggle display of text below icons. When set, icon's tooltip will show the full path to the file.
+
+
+ Menu
+
+ Displays the context menu.
+
+
+ N
+
+ Sort by name
+
+ Sort collection by file name.
+
+
+ I
+
+ Sort by number
+
+ Sort collection by file name, using natural numerical order
+
+
+ D
+
+ Sort by date
+
+ Sort collection by file date.
+
+
+ B
+
+ Sort by size
+
+ Sort collection by file size.
+
+
+ P
+
+ Sort by path
+
+ Sort collection by file location (path to file).
+
+
+ Print
+
+ Opens a print dialog for selected images.
+
+
+ Ctrl + W
+
+ Close window.
+
+
+
+ The selection can be changed using the keyboard and mouse the same as in a file pane of the main window.
+
+
+ Status bar
+
+
+ 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.
+
+
+ Drag and Drop
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideCredits.xml
--- /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 @@
+
+
+
+ Credits
+
+
+ Authors
+
+
+ Geeqie is maintained by The Geeqie Team (Vladimir Nadvornik, Petr Ostadal, Laurent Monin).
+
+
+ This software is a fork of GQview project by John Ellis.
+
+
+ The ever growing list of contributors and language translators can be found in the README file included with the latest release of the program.
+ The Credits can also be viewed by selecting the Credits button located in the About dialog (open Help Menu, select About, click Credits... button).
+
+
+ Copyright
+
+
+ Geeqie and this accompanying documentation is copyright (c) 2008 - 2009 The Geeqie Team and (c) 2006 John Ellis.
+
+
+ License
+
+
+ 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.
+
+
+ This Geeqie documentation is released under the "[[gnu_fdl.txt GNU Free Documentation License]]".
+
+
+ Legal Notice
+
+
+ Copyright (c) 2008 - 2009 The Geeqie Team.
+ Copyright (c) 2006 John Ellis.
+
+
+ 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]]".
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideFaq.xml
--- /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 @@
+
+
+
+ Frequently Asked Questions
+
+
+ Image viewing
+
+
+ How do I keep images smaller than the visible area from enlarging when the zoom is set to “fit to window” ?
+
+
+ In the preferences dialog, under the “Image” tab, disable “Allow enlargement of image for zoom to fit”.
+
+
+ Command line
+
+
+ How do I open an image in an existing Geeqie application ?
+
+
+ Use the “-r” command line option to send commands to an existing Geeqie, for a list of commands supported by the remote switch run:
+
+
+`geeqie --remote-help`
+
+
+ How do I set the slide show delay when starting Geeqie in slide show from the command line ?
+
+
+ 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:
+
+
+`geeqie -r -d12 -ss`
+
+
+ Note that if geeqie is running prior to this command, the slide show should also be stopped prior to changing the delay:
+
+
+`geeqie -r -sS -d12 -ss`
+
+
+ Miscellaneous
+
+
+ I want to be able to edit images with Geeqie
+
+
+ Geeqie is an image viewer. There is, and never will be, a plan to add editing features. I recommend gimp for image editing.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideGnuFdl.xml
--- /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 @@
+
+
+
+ GNU Free Documentation License
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageManagement.xml
--- /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 @@
+
+
+
+ Image Management
+
+
+ Geeqie includes a set of utilities to copy, move, rename, and delete images.
+
+
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageManagementCopyMove.xml
--- /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 @@
+
+
+
+ Copy and Move
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
+ The Copy/Move dialog
+
+
+ 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.
+
+
+ Home button
+
+ Activate this button to change the active path to your home folder.
+
+ New Folder button
+
+ 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.
+
+ Show Hidden check box
+
+ Enabling this check box will cause hidden folders to appear in the folder list.
+
+ Bookmark list
+
+ 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.
+ 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.
+
+ Folder list
+
+ 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.
+
+ Path entry
+
+ 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.
+
+ Copy/Move button
+
+ 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.
+
+ Cancel button
+
+ Activate this button to close the dialog, the operation will be aborted.
+
+
+ The error dialog
+
+
+ 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.
+
+
+ The overwrite dialog
+
+
+ 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:
+
+
+ Auto rename
+
+ 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.
+
+ Rename
+
+ Enable this check box to manually enter a new name for the file.
+
+ Overwrite
+
+ Activate this will overwrite the existing file, or rename it if one of the rename check boxes are enabled.
+
+ Overwrite all
+
+ 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.
+
+ Skip
+
+ 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.
+
+ Skip All
+
+ This will perform the same as the Skip button, however any further file name conflicts will be quietly ignored for all remaining files.
+
+ Cancel
+
+ This will close the dialog and stop the operation, all remaining files will be ignored.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageManagementDelete.xml
--- /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 @@
+
+
+
+ Delete
+
+
+ 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 Enable delete key? is enabled in Options, pressing the Delete key can also be used to delete files.
+
+
+ The behavior when starting a delete operation depends on the Confirm file delete? 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.
+
+
+ Confirm delete dialog
+
+
+ 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.
+
+
+ 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.
+
+
+ The dialog will also display the status of the Safe Delete? 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.
+
+
+ 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.
+
+
+ Safe Delete
+
+
+ Geeqie includes a feature to temporarily store deleted files in a selected folder, to use this feature enable Safe Delete? on the advanced tab of the preferences dialog.
+
+
+ Safe Delete includes these options:
+
+
+ Folder
+
+
+ The folder to use for temporarily retaining deleted files.
+
+
+ Maximum size
+
+
+ The maximum amount of disk space to use when storing deleted files, in megabytes.
+
+
+ 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.
+
+
+ Files moved to the Safe Delete folder are prefixed with a six digit number in the format: nnnnnn_FILENAME
+
+
+ This is used to distinguish which files to remove first when clearing space for new files. The digit counter increments with each deleted file.
+
+
+ To clear the contents of the Safe Delete folder, activate the Clear button provided for this purpose on the Advanced tab? in Options.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageManagementExternalEditing.xml
--- /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 @@
+
+
+
+ External Editing
+
+
+ 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.
+
+
+ External Editors
+
+
+ External editors can do anything from running simple operations like symlink to fully featured programs like gimp.
+
+
+ Geeqie looks for standard desktop files.
+
+
+ http://standards.freedesktop.org/desktop-entry-spec/
+
+
+ http://standards.freedesktop.org/menu-spec/
+
+
+ It is also possible to add Geeqie-specific editors with the Editor configuration dialog?
+
+
+ Editors appear in menu Edit / External Editors, unless specified otherwise in the desktop file.
+
+
+ Result dialog
+
+
+ Commands that are set to display their output in a window will show a dialog when the command is executed.
+
+
+ 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.
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageManagementRename.xml
--- /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 @@
+
+
+
+ Rename
+
+
+ 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.
+
+
+ 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.
+
+
+ Rename single file dialog
+
+
+ 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.
+
+
+ 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.
+
+
+ Rename multiple files dialog
+
+
+ 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.
+
+
+ Manually enter new file names
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
+ Automatic renaming of multiple files
+
+
+ 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.
+
+
+ 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.
+
+
+ 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”.
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImagePresentation.xml
--- /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 @@
+
+
+
+ Image Presentation
+
+
+ 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.
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImagePresentationFullscreen.xml
--- /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 @@
+
+
+
+ Full Screen
+
+
+ Geeqie allows for the image pane to be expanded to fill the entire screen, this is referred to as full screen.
+
+
+ Turning on full screen
+
+
+ Full screen can be activated in a number of ways:
+
+ From the menu bar - open the View menu and select Full screen.
+ From the keyboard - press the F key to toggle full screen.
+ From a context menu - right click an image pane, and select Full screen.
+
+
+ Turning off full screen
+
+
+ To return to the normal view:
+
+ From the keyboard - press the F or Esc key to stop full screen.
+ From a context menu - right click the image pane, and select Exit full screen.
+ From the menu bar - the menu bar may be visible when using multiple monitors, open the View menu and select Full screen.
+
+
+ Configuring full screen
+
+
+ Full screen behavior and location can be adjusted on the Advanced tab? of the preferences dialog.
+
+
+ Size and location
+
+
+ This can be changed using Full screen size option, this can be used to select the monitor to use in a multiple monitor configuration.
+
+
+ Smooth image flip in full screen
+
+
+ This option delays the image change until the next image is entirely decoded into memory, the result is a smoother transition between images.
+
+
+ Disable screen saver in full screen
+
+
+ This option will execute xscreensaver-command --deactivate once per minute to avoid the screen saver from activating.
+
+
+ Navigation
+
+
+ The usual image navigation controls are available when in full screen, these are the commands available:
+
+
+ Keyboard
+
+ Mouse
+
+ Description
+
+
+ F, V, Esc
+
+ Context menu
+
+ Turn off full screen.
+
+
+ Image Navigation
+
+
+ PageDown?
+
+ Left Click on image view
+ Mouse Wheel down [(*)]
+
+ Change to next image.
+
+
+ PageUp?
+
+ Middle Click on image view
+ Mouse Wheel up [(*)]
+
+ Change to previous image.
+
+
+ Home
+
+ Change to first image.
+
+
+ End
+
+ Change to last image.
+
+
+ Image panning (image has keyboard focus)
+
+
+ Arrows
+
+ Left Drag on image view
+ Shift + Mouse Wheel [(*)]
+
+ Pan image.
+
+
+ Shift + Arrows
+
+ Pan Image faster.
+
+
+ Ctrl + Arrows
+
+ Pan to respective edge of image.
+
+
+ SpaceBar?
+
+ Change to next image.
+
+
+ Backspace
+
+ Change to previous image.
+
+
+
+ Several other standard controls are also available through the keyboard and context menu:
+
+
+ Function
+
+ Difference from normal view
+
+
+ Copy, Move, Rename
+
+ same
+
+
+ Delete
+
+ same
+
+
+ External edit commands
+ (Ctrl + 1 ... 0, context menu)
+
+ Full screen will turn off prior to activating the function.
+
+
+ Open image properties window
+ (Ctrl + P, context menu)
+
+ same
+
+
+ Image rotation, mirror, and flip
+
+ same
+
+
+ Zoom controls
+
+ same
+
+
+ I
+
+ Toggle information overlay for full screen: on with histogram, on without histogram, off.
+
+
+ K
+
+ Switch between the different histogram modes: RGB, value, maximum value, red channel, green channel, blue channel.
+
+
+ J
+
+ Toogle between linear and logarithmical histogram.
+
+
+ Slide show controls
+ (S, P, context menu)
+
+ same
+
+
+ Quit with Ctrl + Q
+
+ same
+
+
+
+ (*) Note: Default Mouse wheel functions can be altered by changing the Mouse wheel scrolls image? option.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImagePresentationSlideshow.xml
--- /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 @@
+
+
+
+ Slide Show
+
+
+ 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.
+
+
+ Starting a slide show
+
+
+ A slide show can be started in a number of ways:
+
+ From the menu bar - open the View menu and select Toggle slide show to toggle the slide show on or off .
+ From the keyboard - press the S key to toggle the slide show on or off.
+ From a context menu - right click an image pane, and select Start slide show, or Stop slide show; the text will change depending on the state of the current slide show.
+
+
+ Stopping a slide show
+
+
+ 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 options dialog, the slide show will stop when the last image in the sequence is displayed.
+
+
+ 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 [Slide show sequence navigation].
+
+
+ Slide show status
+
+
+ The main window status bar can be used to determine when a slide show is active, Slide show will be displayed next to the file count field. An individual Image Window 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 Start slide show is displayed, no slide show is active, conversely if Stop slide show is displayed a slide show is active.
+
+
+ When a Slide show is paused, the main window status bar will display Paused instead of Slide show. Likewise, the image context menu will display Pause slide show or Continue slide show, depending on the current state.
+
+
+ Pausing a slide show
+
+
+ An active slide show can be paused in two ways:
+
+ From the keyboard - press the P key while a slide show is active.
+ From a context menu - right click the image pane displaying the slide show, and select Pause slide show, or Continue slide show depending on the current slide show state.
+
+
+ Selecting the images to include in a slide show
+
+
+ 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.
+
+
+ To only include some images in a slide show, use multiple selection to select the images to include before starting the slide show.
+
+
+ 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.
+
+
+ So far, the methods described are for slide shows in a main window, in an Image Window, the slide show will use all images referenced by that window.
+
+
+ Recursive slide show
+
+
+ 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:
+
+ Slide show: This will start a slide show that includes all images in the selected folder.
+ 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.
+
+
+ Slide show sequence navigation
+
+
+ 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.
+
+
+ Configuring a slide show
+
+
+ The options that control the behavior of slide shows are located on the General tab of the options dialog.
+
+
+ Display time
+
+
+ The delay between each image in the slide show can be adjusted with the Delay before image change option.
+
+
+ Repeat
+
+
+ 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.
+
+
+ Random
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageSearch.xml
--- /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 @@
+
+
+
+ Image Search
+
+
+ Geeqie provides methods to find an image, and the ability to find duplicate images.
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageSearchFindingDuplicates.xml
--- /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 @@
+
+
+
+ Finding Duplicates
+
+
+ Geeqie provides a utility to find images that have similar attributes or content.
+
+
+ To display a new Find Duplicates Window press D or select Find duplicates from the File menu.
+
+
+ Adding files to be compared
+
+
+ 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:
+
+
+ Add contents
+
+
+ The contents of dropped folders will added to the window.
+
+
+ Add contents recursive
+
+
+ The contents of dropped folders and all sub folders will be added to the window.
+
+
+ Skip folders
+
+
+ Ignore folders contained in the drop list.
+
+
+ When files are added to the window, the comparison is restarted to include the new files.
+
+
+ Comparison methods
+
+
+ The attribute to use for two images to match can be selected with the “Compare by:” drop down menu. Each method is explained below:
+
+
+ Name
+
+
+ The file name.
+
+
+ Name case-insensitive
+
+
+ The file name but ignoring case.
+
+
+ Size
+
+
+ The file size.
+
+
+ Date
+
+
+ The file date.
+
+
+ Dimensions
+
+
+ The image dimensions.
+
+
+ Checksum
+
+
+ The MD5 file checksum.
+
+
+ Path
+
+
+ The complete path to file.
+
+
+ Similarity (high)
+
+
+ Very similar image content.
+
+
+ Similarity
+
+
+ Similar image content.
+
+
+ Similarity (low)
+
+
+ Slightly similar image content.
+
+
+ Similarity (custom)
+
+
+ Similar image content, the value to use to consider two images a match is configured in the Advanced tab? of the preferences dialog by setting the “Custom similarity threshold”.
+
+
+ Results list
+
+
+ Files that match with the selected comparison method will appear in the list. Matching files are grouped in alternating color.
+
+
+ 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.
+
+
+ A context menu is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.
+
+
+ Keyboard shortcuts available in the results list:
+
+
+ Shortcut
+
+ Context menu name
+
+ Description
+
+
+ Enter
+
+ View
+
+ Opens selected image in main window.
+
+
+ V
+
+ View in new window
+
+ Opens selected image in a new window.
+
+
+ Ctrl + A
+
+ Select all
+
+ Selects all images.
+
+
+ Ctrl + Shift + A
+
+ Select none
+
+ Clear the image selection.
+
+
+ 1
+
+ Select group 1 duplicates
+
+ Selects the first image from each match group.
+
+
+ 2
+
+ Select group 2 duplicates
+
+ Selects all but the first image from each match group.
+
+
+ Ctrl + 1 through
+ Ctrl + 0
+
+ Edit sub menu
+
+ Executes the respective editor command.
+
+
+ Ctrl + P
+
+ Properties
+
+ Opens a properties window for selected images.
+
+
+ C
+
+ Add to new collection
+
+ Creates a new collection containing the selected images.
+
+
+ Print
+
+ Opens a print dialog for selected images.
+
+
+ Ctrl + C
+
+ Copy
+
+ Copy selected images.
+
+
+ Ctrl + M
+
+ Move
+
+ Move selected images.
+
+
+ Ctrl + R
+
+ Rename
+
+ Rename selected images.
+
+
+ Ctrl + D
+
+ Delete
+
+ Delete selected images.
+
+
+ Delete
+
+ Remove
+
+ Remove selected images from result list.
+
+
+ Ctrl + Delete
+
+ Clear
+
+ Cleared the result list.
+
+
+ Menu
+
+ Displays the context menu.
+
+
+ Ctrl + T
+
+ Toggle display of thumbnails.
+
+
+ Ctrl + W
+
+ Close window.
+
+
+
+ The selection can be changed using the keyboard and mouse the same as in a file pane of the main window.
+
+
+ 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.
+
+
+ Status bar
+
+
+ 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.
+
+
+ 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:
+
+
+ 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...”.
+ 2) The images are compared using the selected method, the progress bar will indicate this stage with the text “comparing...”.
+ 3) The results are sorted for display, the progress bar will indicate this stage with the text “sorting...”.
+
+
+ Stage 1 is only used for the Dimensions, Checksum, and Similarity compare methods.
+
+
+ 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.
+
+
+ Thumbnails
+
+
+ Thumbnails can be displayed beside each image in the result list by enabling the Thumbnails check box.
+
+
+ Compare two file sets
+
+
+ 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.
+
+
+ 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.
+
+
+ Drag and Drop
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideImageSearchSearch.xml
--- /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 @@
+
+
+
+ Search Window
+
+
+ Geeqie provides a utility to find one or more images based on various parameters.
+
+
+ To display a new Search Window press F3 or select Search from the File menu.
+
+
+ To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.
+
+
+ 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.
+
+
+ When a search is completed, the total number of files found and their total size will be displayed in the status bar.
+
+
+ Search location
+
+
+ One of several locations can be chosen as the source to use in the search.
+
+
+ Path
+
+
+ The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.
+
+
+ Comments
+
+
+ The search will include all files that have a keyword or comment associated to it.
+
+
+ Note: Only keyword and comment associations stored in the user's home folder are included in this search type.
+
+
+ Results
+
+
+ The search will include all files currently listed in the results list, use this to refine a previous search.
+
+
+ Search parameters
+
+
+ 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.
+
+
+ File name
+
+
+ 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.
+
+
+ File size
+
+
+ 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.
+
+
+ File date
+
+
+ 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.
+
+
+ For convenience, the button with the down arrow displays a pop up calendar to enter the date.
+
+
+ Image dimensions
+
+
+ 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.
+
+
+ The image dimensions test is simple, both width and height must be within the allowed values for a match.
+
+
+ Image content
+
+
+ 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 Finding Duplicates. The entry is for entering the path for the image to use in this test.
+
+
+ Keywords
+
+
+ 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.
+
+
+ Results list
+
+
+ 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.
+
+
+ A context menu is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.
+
+
+ Keyboard shortcuts available in the results list:
+
+
+ Shortcut
+
+ Context menu name
+
+ Description
+
+
+ Enter
+
+ View
+
+ Opens selected image in main window.
+
+
+ V
+
+ View in new window
+
+ Opens selected image in a new window.
+
+
+ Ctrl + A
+
+ Select all
+
+ Selects all images.
+
+
+ Ctrl + Shift + A
+
+ Select none
+
+ Clear the image selection.
+
+
+ Ctrl + 1 through
+ Ctrl + 0
+
+ Edit sub menu
+
+ Executes the respective editor command.
+
+
+ Ctrl + P
+
+ Properties
+
+ Opens a properties window for selected images.
+
+
+ C
+
+ Add to new collection
+
+ Creates a new collection containing the selected images.
+
+
+ Print
+
+ Opens a print dialog for selected images.
+
+
+ Ctrl + C
+
+ Copy
+
+ Copy selected images.
+
+
+ Ctrl + M
+
+ Move
+
+ Move selected images.
+
+
+ Ctrl + R
+
+ Rename
+
+ Rename selected images.
+
+
+ Ctrl + D
+
+ Delete
+
+ Delete selected images.
+
+
+ Delete
+
+ Remove
+
+ Remove selected images from result list.
+
+
+ Ctrl + Delete
+
+ Clear
+
+ Cleared the result list.
+
+
+ Menu
+
+ Displays the context menu.
+
+
+ Ctrl + T
+
+ Toggle display of thumbnails.
+
+
+ Ctrl + W
+
+ Close window.
+
+
+
+ The selection can be changed using the keyboard and mouse the same as in a file pane of the main window.
+
+
+ The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.
+
+
+ Status bar
+
+
+ At the bottom of the search window is an area that includes the following items from left to right:
+
+
+ Thumbnails
+
+
+ Enable this check box to display a thumbnail next to each image in the results list.
+
+
+ File count display
+
+
+ Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.
+
+
+ Search progress
+
+
+ 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.
+
+
+ Find
+
+
+ Activate the find button to start a search with the selected parameters.
+
+
+ Stop
+
+
+ Activate the stop button to end a search that is in progress.
+
+
+ Drag and Drop
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideIndex.xml
--- /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 @@
+
+
+
+ The Geeqie User Manual
+
+
+ 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.
+
+
+ If you are having trouble finding a solution in the manual, try looking in the FAQ.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideIntroduction.xml
--- /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 @@
+
+
+
+ Legal Notice
+
+
+ Copyright (c) 2008 - 2009 The Geeqie Team.
+ Copyright (c) 2004 John Ellis.
+
+
+ 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?".
+
+
+ Introduction
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
+ Basic Features
+
+ Thumbnail preview
+ Full screen
+ Slide show
+ Image Management
+ Image Collections
+
+
+ Advanced Features
+
+ Image Search
+ Find image duplicates based on image content
+ View and edit EXIF, IPTC and XMP data stored in images
+ Simple Sort Manager to quickly sort a folder of images into other folders
+ Rename images in bulk
+ Add XMP keywords to images, and recall those images with the search function
+ Very Configurable
+
+
+ “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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindow.xml
--- /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 @@
+
+
+
+ Main Window
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindowFilePane.xml
--- /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 @@
+
+
+
+ File Pane
+
+
+ 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.
+
+
+ A context menu 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.
+
+
+ List view
+
+
+ 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.
+
+
+ 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.
+
+
+ Thumbnails 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.
+
+
+ Grouped sidecar files are represented by the main file with an expander. Clicking on the expander shows sidecar files.
+
+
+ Icon view
+
+
+ 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.
+
+
+ The icon view mode displays images as thumbnails in a grid, and by default a file name below each thumbnail.
+
+
+ The file name displayed below each thumbnail can be turned on or off by selecting “Show filename text” from the context menu.
+
+
+ Grouped sidecar files are represented by the main file. For accessing sidecars switch to List mode.
+
+
+ Multiple selection
+
+
+ It is possible to select more than one image from the file pane. Multiple files can be selected with several methods:
+
+
+ Mouse
+
+ Ctrl + Primary mouse button will add or remove the file from the selection.
+ Middle mouse button will toggle selection of the file.
+ 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.
+ 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.
+
+
+ Keyboard
+
+ Ctrl + Arrows will move the focus without changing the selection.
+ Ctrl + Space will toggle selection of the focused image.
+ Shift + Arrows will select a region of images.
+ Shift + Ctrl + Arrows works as Shift + Arrows, but will not change the selection of files outside the current focus region.
+
+
+ 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”.
+
+
+ The current number of selected images and their total size will be indicated in the File list section of the status bar.
+
+
+ Sorting
+
+
+ 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.
+
+
+ Selecting the ascending menu item will toggle between increasing and decreasing sort order.
+
+
+ Context menu
+
+
+ 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 menu bar, however a few functions are unique to the context menu:
+
+
+ View in new window
+
+ Opens a new window containing a list of the currently selected images.
+
+ Sort
+
+ Changes the sort order of file pane.
+
+ View as icons
+
+ Toggles between the list and icon view modes.
+
+ Show thumbnails
+
+ Toggles display of thumbnails in the list view display mode.
+
+ Show filename text
+
+ Toggles display of file names in the icon view display mode.
+
+
+ Drag and Drop
+
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindowFolderPane.xml
--- /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 @@
+
+
+
+ Folder pane
+
+
+ The folder pane contains the menu bar, tool bar, path entry, and folder list.
+
+
+ Menu bar
+
+
+ The main menu of the window. The functions available from the main menu are described in the Menus chapter.
+
+
+ Tool bar
+
+
+ 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.
+
+
+ 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.
+
+
+ Show thumbnails
+
+ This button is active when the file list is in list view mode, and activating it will toggle the display of thumbnails.
+
+ Change to home folder
+
+ Change the main window to display the contents of the user's home folder.
+
+ Refresh file list
+
+ This will check for changes to the active folder and update the window.
+
+ Zoom in
+
+ Increase the image display size.
+
+ Zoom out
+
+ Decrease the image display size.
+
+ Fit image to window
+
+ This will size the image to fit within the image view.
+
+ Set zoom 1:1
+
+ Restore zoom to the image's original size.
+
+ Configure options
+
+ Displays the Options window.
+
+ Float controls
+
+ Toggle the folder pane, file pane, and status bar between the main window and a secondary window.
+
+
+ The buttons corresponds to selected menu action. It is possible to add other actions by editing the Configuration file
+
+
+ Path entry
+
+
+ This displays the active folder of the window and allows typing a location.
+
+
+ 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.
+
+
+ Note: Tab completion uses the Tab key, press the Down key to move the focus from the entry.
+
+
+ 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.
+
+
+ Folder list
+
+
+ This displays a list of sub folders contained in the active folder, or a tree that includes all folders in the file system.
+
+
+ A context menu 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
+
+
+ List view
+
+
+ This mode can be enabled by from the View menu, from the context menu, or pressing Ctrl + T.
+
+
+ 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 “..”.
+
+
+ Tree view
+
+
+ This mode can be enabled by selecting “Tree” from the View menu, pressing Ctrl + T, or selecting “View as tree” from the context menu.
+
+
+ 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.
+
+
+ Sorting
+
+
+ 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.
+
+
+ Context menu
+
+
+ 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 menu bar, however a few functions are unique to the context menu:
+
+
+ Up to parent
+
+ This will change the window to display the contents of the parent folder.
+
+ Slide show
+
+ Start a slide show that contains all images in the selected folder.
+
+ Slide show recursive
+
+ Start a slide show that contains all images in the selected folder, and all images in the sub folders of that folder.
+
+ Find duplicates
+
+ This will open a new find duplicates window containing all images in the selected folder.
+
+ Find duplicates recursive
+
+ This will open a new find duplicates window containing all image in the selected folder, and all images in the sub folders of that folder.
+
+ New folder
+
+ Creates a new folder that is a sub folder of the selected folder.
+
+ Rename
+
+ Renames the selected folder.
+
+
+ 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.
+
+
+ View as tree
+
+ Toggles between the list and tree modes of the folder pane.
+
+
+ Drag and drop
+
+
+ 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.
+
+
+ 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.
+
+
+ Using Shift key while dragging is a shortcut to move action. Menu will not appear but move will occur.
+
+
+ Using Ctrl key while dragging is a shortcut to copy action. Menu will not appear but copy will occur.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindowImagePane.xml
--- /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 @@
+
+
+
+ Image Pane
+
+
+ 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.
+
+
+ Image display
+
+
+ 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.
+
+
+ The quality of the image, especially when using the zoom feature, is dependent on the settings that are available on the Image tab of the preferences dialog.
+
+
+ To increase the speed of loading the next image when navigating the image list in sequence, enable the Preload next image option.
+
+
+ Image panning and manipulation
+
+
+ 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.
+
+
+ Keyboard
+
+
+ Use the Arrows to pan the image in the desired direction, to increase the panning speed hold down the Shift + Arrows.
+ 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.
+
+
+ Shortcut
+
+ Context menu name
+
+ Description
+
+
+ + =
+
+ Zoom in
+
+ Zoom in.
+
+
+ -
+
+ Zoom out
+
+ Zoom out.
+
+
+ X [Keypad]*
+
+ Fit image to window
+
+ Scale the image to fit the available display area.
+
+
+ Z [Keypad]/
+
+ Zoom 1:1
+
+ Reset the zoom to original image size.
+
+
+ ]
+
+ Rotate clockwise
+
+ Rotate the image clockwise 90 degrees.
+
+
+ [
+
+ Rotate counterclockwise
+
+ Rotate the image counterclockwise 90 degrees.
+
+
+ Shift + R
+
+ Rotate 180
+
+ Rotate the image 180 degrees.
+
+
+ Shift + M
+
+ Mirror
+
+ Flip the image horizontally.
+
+
+ Shift + F
+
+ Flip
+
+ Flip the image vertically.
+
+
+
+ Note: The rotation, mirror, and flip functions will not change the image data directly. Depending on the Metadata Options, 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.
+
+
+ Mouse
+
+
+ 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 [(*)].
+
+
+ To scale the image size hold down the Ctrl key and scroll the mouse wheel up to zoom in, or down to zoom out.
+
+
+ Smooth Scroll
+
+
+ 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.
+
+
+ Navigation
+
+
+ The displayed image can be changed to the next or previous image using the keyboard or mouse.
+
+
+ Keyboard
+
+
+ The PageDown? and PageUp? 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 SpaceBar? and BackSpace? keys can also be used to change the image.
+
+
+ Mouse
+
+
+ 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 [(*)].
+
+
+ Context menu
+
+
+ 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 menu bar, however a few functions are unique to the context menu:
+
+
+ View in new window
+
+ Opens a new window containing a second copy of the current image.
+
+ Pause slide show, Continue slide show
+
+ Controls the pause state of an active slide show, the text of the menu will change to reflect the action that will be performed.
+
+
+ Drag and Drop
+
+
+ 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.
+
+
+ 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.
+
+
+ Displaying images side by side
+
+
+ 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.
+
+
+ Connected zoom is possible through the View > Connected zoom menu. Zoom is then applied to all displayed images.
+
+
+ Connected scrolling is also possible using Shift and primary mouse button.
+
+
+ As a general rule, hotkeys and mouse without shift affects just one image and with shift all images.
+
+
+ (*) Note: The mouse wheel behavior for scrolling and image step can be swapped with the Mouse wheel scrolls image option located on the Advanced tab? of the preferences dialog.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindowLayout.xml
--- /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 @@
+
+
+
+ Layout
+
+
+ The main window consists of four areas, the folder pane, file pane, image pane, and the status bar. 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.
+
+
+ Selecting the location of each pane
+
+
+ The arrangement of the folder, file, and image pane is selected on the Windows tab 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.
+
+
+ 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.
+
+
+ Note: In the options window the file and image panes are labeled similarly, however the folder pane is labeled as tools.
+
+
+ Changing the size of a pane
+
+
+ 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.
+
+
+ Folder pane
+
+
+ The folder pane 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.
+
+
+ File pane
+
+
+ The file pane lists the images contained in the active folder. The file pane can be set to display as a vertical list or an icon view.
+
+
+ Image pane
+
+
+ The image pane is where the active image is displayed.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindowMenus.xml
--- /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 @@
+
+
+
+ Menus
+
+
+ This section describes the functions of each item on the menu bar in the Geeqie main window.
+
+
+ File Menu
+
+
+ New window
+
+ Opens a new main window, with the initial path set to the current folder.
+
+ New collection
+
+ Opens a new collection window, the new collection will be empty.
+
+ Open collection
+
+ Displays a dialog to open a collection stored on disk, the selected collection will then appear in a new window.
+
+ Open recent
+
+ 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 Open recent list maximum size? option.
+
+ Search…
+
+ Opens a new Search window.
+
+ Find duplicates…
+
+ Opens a new Find Duplicates window.
+
+ Print..
+
+ Opens a print dialog.
+
+ New folder…
+
+ Creates a new folder in the current path.
+
+ Copy…
+
+ Opens a dialog to select a destination to copy the currently selected files.
+
+ Move…
+
+ Opens a dialog to select a destination to move currently selected files.
+
+ Rename…
+
+ Renames the current file selection.
+
+ Delete…
+
+ Deletes the current file selection.
+
+ Symlink
+
+ Creates a symbolic link. This is implemented via external editor?.
+
+ Close window
+
+ Closes the window containing the menu, if the window is the last main window Geeqie will quit.
+
+ Quit
+
+ Quits the Geeqie application, if collections or image metadata have been changed but not saved, the user will be prompted for confirmation.
+
+
+ Go menu
+
+
+ First Image
+
+ Goes tothe first image.
+
+ Previous Image
+
+ Goes to the previous image.
+
+ Next Image
+
+ Goes to the next image.
+
+ Last Image
+
+ Goes to the last image. Back Goes to the previous folder. Home Goes to home folder.
+
+
+ Select menu
+
+
+ Select all
+
+ Selects all files in the current list
+
+ Select none
+
+ Deselects all files
+
+ Invert Selection
+
+ Inverts current selection
+
+ Copy path
+
+ Copy selected item path to clipboard.
+
+ Show marks
+
+ Displays marks in the file list
+
+ Mark n
+
+ Opens submenu for manipulating mark n
+
+ Mark n / Toggle mark n
+
+ Set or unset mark n on selected files
+
+ Mark n / Set mark n
+
+ Set mark n on selected files
+
+ Mark n / Reset mark n
+
+ Unset mark n on selected files
+
+ Mark n / Select mark n
+
+ Selects all files having mark n set
+
+ Mark n / Add mark n
+
+ Adds files having mark n set to selection
+
+ Mark n / Intersection with mark n
+
+ Intersects current selection and mark n
+
+ Mark n / Unselect mark n
+
+ Removes files having mark n set from current selection
+
+ Mark n / Filter mark n
+
+ Shows only the images that have mark n set.
+
+
+ Edit menu
+
+
+ External Editors
+
+ This submenu contains external editors that were found on the system. See Editors section? for details.
+
+ Orientation
+
+ Adjust image orientation
+
+ Orientation / Rotate clockwise
+
+ Rotates the current image clockwise 90 degrees, does not modify the file on disk.
+
+ Orientation / Rotate counterclockwise
+
+ Rotates the current image counterclockwise 90 degrees, does not modify the file on disk.
+
+ Orientation / Rotate 180
+
+ Rotates the current image 180 degrees, does not modify the file on disk.
+
+ Orientation / Mirror
+
+ 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.
+
+ Orientation / Flip
+
+ Swaps the top and bottom sides of the image, does not modify the file on disk.
+
+ Orientation / Original state
+
+ 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 Editors section? for details.
+
+ Save metadata
+
+ Saves queued metadata changes. Autosave can be configured too.
+
+
+ Preferences
+
+ This submenu contains configuration and maintenance commands
+
+ Preferences / Preferences…
+
+ Opens the Preferences Dialog for changing of global preferences.
+
+ Preferences / Configure Editors…
+
+ Opens the Editors Dialog? for changing of global preferences.
+
+ Preferences / Configure This window…
+
+ Opens the Window Preferences Dialog? for changing of options that can differ for each window.
+
+ Preferences / Thumbnail maintenance
+
+ Opens a dialog with utilities to manage cached thumbnails and keywords data.
+
+ Set as wallpaper
+
+ 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 fit to window; when zoom is set to fit to window, the image will be scaled to fill the root window.
+
+
+ View menu
+
+
+ View in new window
+
+ Opens selected image in its own window
+
+ Pan view
+
+ Opens current folder in Pan view window
+
+ Files and Folders
+
+
+ Zoom
+
+ Zoom in
+
+ Increases the zoom by one increment, resulting in a larger image.
+
+ Zoom out
+
+ Decreases the zoom by one increment, resulting in a smaller image.
+
+ Zoom to fit
+
+ 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 Image tab of the preferences dialog.
+
+ Fit Horizontally
+
+ Adjusts the zoom so image height fit within the display pane.
+
+ Fit Vertically
+
+ Adjusts the zoom so image width fit within the display pane.
+
+ Zoom n:m
+
+ 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.
+
+
+ Connected zoom
+
+ Actions in this menu are identical to those in Zoom menu, but apply to all images displayed in splitted view.
+
+ Split
+
+ Horizontal
+
+ Splits main image view in two horizontal panes.
+
+ Vertical
+
+ Splits main image view in two vertical panes.
+
+ Quad
+
+ Splits main image view in four panes.
+
+ Single
+
+ Reverts to normal view mode (one image).
+
+
+ Thumbnails
+
+ 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.
+
+ List
+
+ Changes the file list to display files in list format.
+
+ Icons
+
+ Changes the file list to display files as icons.
+
+ View Directory as
+
+ List
+
+ Set the folder view mode to list.
+
+ Tree
+
+ Set the folder view mode to tree.
+
+
+ Image Overlay
+
+ Displays Image Overlay information box (OSD), use twice to add histogram to it.
+
+ Histogram channels
+
+ Switches channels displayed in the histogram (red, green, blue, RGB, value, maximum value).
+
+ Histogram log mode
+
+ Toggles between linear and logarithmical histogram.
+
+ Full screen
+
+ Toggles the full screen window display.
+
+ Float file list
+
+ 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.
+
+ Hide file list
+
+ Toggles visibility of the menu bar, tool bar, status bar, and file lists.
+
+ Hide toolbar
+
+ Toggles visibility of the tool bar. A check appears next to this item when the tool bar is not visible.
+
+ Keywords
+
+ Toggles display of the Keywords sidebar.
+
+ Exif data
+
+ Toggles display of the EXIF sidebar.
+
+ Sort manager
+
+ Toggles display of the Sort Manager sidebar.
+
+ Toggle slideshow
+
+ Begins or ends a slide show, the slide show status is displayed in the status bar.
+
+ Pause slideshow
+
+ Pauses a slide show, the slide show status is displayed in the status bar.
+
+ Refresh
+
+ 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.
+
+
+ Help menu
+
+
+ Contents
+
+ Opens the Geeqie user manual in a new browser window.
+
+ Keyboard shortcuts
+
+ Displays a window listing the default keyboard shortcuts.
+
+ Release notes
+
+ Displays a window containing the release notes for the version of Geeqie in use.
+
+ About
+
+ Opens a window containing the Geeqie version, credits, website, and email contact information.
+
+ Log window
+
+ Opens the log window, mostly used for debugging purposes.
+
+
+ Tear off menus
+
+
+ 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.
+
+
+ Keyboard shortcuts
+
+
+ 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 Keyboard Shortcuts.
+
+
+ Changing the main window menu bar keyboard shortcuts
+
+
+ The keyboard shortcuts associated with the menu bar items can be changed by editing the accels file located in the Geeqie configuration folder while the Geeqie application is not running:
+
+
+ ($HOME)/.geeqie/accels
+
+
+ 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:
+
+
+ ; (gtk_accel_path "<main>/File/Quit" "<Control>q")
+
+
+ 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 Q key will result in this line:
+
+
+ (gtk_accel_path "<main>/File/Quit" "q")
+
+
+ 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:
+
+
+ <tablestyle="width:60%"> Key
+
+ Text to use in accels file
+
+
+ <tablestyle="width:60%"> Shift
+
+ <shift>
+
+
+ Ctrl
+
+ <control>
+
+
+ Alt
+
+ <alt>
+
+
+
+ Modifiers can be combined, for example in the exit line above, the text would be “<control><shift>q” to set the exit shortcut to Ctrl + Shift + Q.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindowNavigation.xml
--- /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 @@
+
+
+
+ Navigation
+
+
+ Moving around in the file system
+
+
+ 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).
+
+
+ To select a folder with the keyboard, move the focus to the desired folder and press the SpaceBar? or Enter key.
+
+
+ Moving around within a folder
+
+
+ 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.
+
+
+ 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.
+
+
+ Going home
+
+
+ To change to your home folder, click the Home button in the tool bar. Home folder can be set in window preferences.
+
+
+ Direct path entry
+
+
+ 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.
+
+
+ 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.
+
+
+ Stepping through images sequentially
+
+
+ To change the displayed image to next or previous one within the same folder, use the respective PageDown? and PageUp? keys. The mouse can also be used to change the image by clicking the image display with the respective primary and middle buttons.
+
+
+ To change to beginning or end of the image list, use the respective Home or End keys.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideMainWindowStatusBar.xml
--- /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 @@
+
+
+
+ Status Bar
+
+
+ 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.
+
+
+ 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.
+
+
+ Progress Bar
+
+
+ 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.
+
+
+ Sort method
+
+
+ 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.
+
+
+ Name
+
+ Images are sorted by file name.
+
+ Number
+
+ Images are sorted by natural numerical order, such that, for example, 9_name.jpg will be listed before 10_name.jpg.
+
+ Date
+
+ Images are sorted by file date on disk.
+
+ Size
+
+ Image are sorted by file size on disk.
+
+ Ascending
+
+ Toggles between increasing and decreasing sort order. A check will appear next to this entry to indicate ascending sort order.
+
+
+ File list
+
+
+ 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.
+
+
+ Image Details
+
+
+ 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.
+
+
+ Zoom
+
+
+ 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.
+
+
+ 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).
+
+
+ Buttons
+
+
+ Statusbar buttons corresponds to selected menu action. It is possible to add other actions by editing the Configuration file
+
+
+ Show Pixel Info
+
+
+ Shows coordinates and RGB value under cursor.
+
+
+ Enable Color Management
+
+
+ Enables color profiles.
+
+
+ Save Metadata
+
+
+ Opens dialog for review of metadata changes.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptions.xml
--- /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 @@
+
+
+
+ Options Explained
+
+
+ This chapter attempts to explain in detail the Geeqie preferences dialog.
+
+
+
+
+
+
+
+
+
+
+
+
+ There is another set of options, that can be set independently for each window:
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsBehavior.xml
--- /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 @@
+
+
+
+ Advanced Behavior Options
+
+
+ This section describes the options presented under the Behavior Tab of the preferences dialog.
+
+
+ Delete
+
+
+ Confirm file delete
+
+
+ Prompts for confirmation before deleting files.
+
+
+ Enable Delete key
+
+
+ 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.
+
+
+ Safe Delete
+
+
+ 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.
+
+
+ Note: Files moved to the Safe Delete folder are prefixed with a six digit number in the format: nnnnnn_FILENAME
+ This is used by the delete feature to distinguish which files to remove first when clearing space for new files.
+ The digit counter increments with each deleted file.
+
+
+ Folder
+
+
+ The location of the folder used by the Safe Delete feature.
+
+
+ Maximum size
+
+
+ The size to use for the Safe Delete folder, in megabytes. Note that setting this value to 0 (zero) will disable any limit.
+
+
+ Clear button
+
+
+ Removes all files contained in the Safe Delete folder.
+
+
+ View button
+
+
+ Changes the Geeqie main window to display the contents of the Safe Delete folder.
+
+
+ Behavior
+
+
+ Rectangular selection in icon view
+
+
+ Enable this to change the selection method used when selecting multiple items in an icon view.
+
+
+ Descend folders in tree view
+
+
+ This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.
+
+
+ Note: Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.
+
+
+ Show date in directories list view
+
+
+ Enable this to display directory modification date along its name in the list view
+
+
+ In place renaming
+
+
+ When renaming a single file, this will allow the rename entry to appear directly over the original filename.
+
+
+ Show "Copy path" menu item
+
+
+ Enable this option to show a "Copy path" menu item in applicable menus.
+
+
+ This allows to copy path to files or directories to the clipboard, names are enclosed with double quotes and separated by space.
+
+
+ Open recent list maximum size
+
+
+ This is the number of entries saved in the recent open file list.
+
+
+ Drag'n drop icon size
+
+
+ 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.
+
+
+ Navigation
+
+
+ Progressive keyboard scrolling
+
+
+ This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.
+
+
+ Mouse wheel scrolls image
+
+
+ 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.
+
+
+ Home button path
+
+
+ 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.
+
+
+ Use current
+
+
+ Pressing this button will set the Home button path to the current open directory.
+
+
+ Miscellaneous
+
+
+ Custom similarity threshold
+
+
+ This setting is used by the compare method “similarity (custom)”, located in the Find Duplicates window.
+
+
+ Debugging
+
+
+ Debug level
+
+
+ This defines the verbosity of debug info sent to console and log window (0 disables the debug output).
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsColor.xml
--- /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 @@
+
+
+
+ Color management
+
+
+ Here one can defined color profiles to use. Color management can be enabled or disabled from menu: View / Color Management.
+
+
+ Type
+
+
+ Either input color profile or screen color profile.
+
+
+ Menu name
+
+
+ Name of the menu entry corresponding to the color profile.
+
+
+ File
+
+
+ Path to the color profile file.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsFiltering.xml
--- /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 @@
+
+
+
+ Filtering Options
+
+
+ This section describes the options presented under the Filtering Tab of the preferences dialog.
+
+
+ Filters
+
+
+ Show hidden files or folders
+
+
+ Enables the display of hidden files and folders, also known as dot files.
+
+
+ Show dot directory
+
+
+ Enables the display of the current directory as a dot in the directories views. It may be useful for some drag'n'drop operations.
+
+
+ Case sensitive sort
+
+
+ Files and folders are sorted such that upper case letters occur before lower case letters.
+
+
+ Enabled result: A, B, C, a, b, c
+ Disabled result: A, a, B, b, C, c
+
+
+ Disable file filtering
+
+
+ Enable this to allow Geeqie to list all files, even those that do not contain images.
+
+
+ Grouping sidecar extensions
+
+
+ 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: %image expands to list of all files in class image, %raw expands to raw files and %meta expands to metadata files (see the file class below).
+
+
+ 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).
+
+
+ File types
+
+
+ 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 (.).
+
+
+ Note: Unlike all other options in the dialog, filter list changes are applied immediately.
+
+
+ Add button
+
+
+ Adds a new blank line to the filter list, change the parameters to match the desired file type.
+
+
+ Remove button
+
+
+ Removes the selected line from the filter list.
+
+
+ Defaults button
+
+
+ Resets the filter list to the default values, discarding any customizations made by the user.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsGeneral.xml
--- /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 @@
+
+
+
+ General Options
+
+
+ This section describes the options presented under the General Tab of the preferences dialog.
+
+
+ Startup
+
+
+ Restore folder on startup
+
+
+ Enabling this will cause Geeqie to initially open to the specified folder.
+
+
+ Use Current
+
+
+ Activate this button to change the setting to the current folder.
+
+
+ Use last path
+
+
+ When checked, Geeqie will recall the last path used on startup.
+
+
+ Thumbnails
+
+
+ Size
+
+
+ Selects the size of the thumbnails displayed throughout Geeqie, dimensions are width by height in pixels.
+
+
+ Quality
+
+
+ Selects the method to use when scaling an image down for thumbnails.
+
+
+ Nearest
+
+ Fastest scaler, but results in poor thumbnail quality.
+
+ Tiles
+
+ Thumbnail results are very close to bilinear, with better speed.
+
+ Bilinear
+
+ High quality results, moderately fast.
+
+ Hyper
+
+ Slowest scaler, sometimes gives better results than bilinear.
+
+
+ Cache thumbnails
+
+
+ Enable this to save thumbnails to disk, subsequent requests for a thumbnail will be faster. Thumbnails are cached into ($HOME)/.geeqie/thumbnails. Refer to Thumbnails Reference for details.
+
+
+ Use shared thumbnail cache
+
+
+ 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
+
+
+ Cache thumbnails into .thumbnails
+
+
+ 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 .thumbnails. When the image source folder cannot be written, Geeqie falls back to saving the thumbnail in the user's home folder.
+
+
+ Faster jpeg thumbnailing
+
+
+ This will speed up thumbnails generation in some cases, but may reduce the quality
+
+
+ Use EXIF thumbnails when available
+
+
+ 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.
+
+
+ Use xvpics thumbnails when found
+
+
+ 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 .xvpics. Enabling this option will allow Geeqie to read thumbnails saved in the xvpics format.
+
+
+ Note: Support for xvpics is read only, Geeqie can not generate thumbnails in this format.
+
+
+ Slide show
+
+
+ Delay between image change
+
+
+ Specifies the delay between images for slide shows, in seconds.
+
+
+ Random
+
+
+ When enabled, slide show images will appear in random order.
+
+
+ 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.
+
+
+ Repeat
+
+
+ When enabled, slide shows will continue at the beginning after the last image is displayed.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsHidden.xml
--- /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 @@
+
+
+
+ Hidden Options
+
+
+ geeqierc
+
+
+ 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:
+
+
+ ($HOME)/.geeqie/geeqierc
+
+
+ lazy_image_sync: [true false]: 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.
+
+
+ display_dialogs_under_mouse: [true false]: Enabling this will cause new dialogs to initially position themselves such that they are under the current mouse position.
+
+
+ scroll_reset_method: value: This will set the method used to set the scroll position, or visible region of a new image, value can be:
+
+
+ 0: Move to upper left corner.
+ 1: Center image.
+ 2: Maintain same visible region as previous image, if possible.
+
+
+ dither_quality: Set the quality when dithering images on displays with a limited color pallet:
+
+
+ 0: No dithering
+ 1: Normal
+ 2: Best
+
+
+ Find Duplicates window
+
+
+ Ctrl + Shift + [Right Mouse click]: Use this to display a dialog containing the data stored for the clicked image file. This is usually only useful for debugging purposes.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsImage.xml
--- /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 @@
+
+
+
+ Image Options
+
+
+ This section describes the options presented under the Image Tab of the preferences dialog.
+
+
+ Zoom
+
+
+ Quality
+
+
+ Selects the method used to scale the size of an image.
+
+
+ Nearest
+
+ Fastest scaler, but results in poor image quality.
+
+ Tiles
+
+ Results are somewhat close to bilinear, with better speed.
+
+ Bilinear
+
+ High quality results, moderately fast.
+
+ Hyper
+
+ Slowest scaler, sometimes gives better results than bilinear.
+
+
+ Two pass zooming
+
+
+ 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.
+
+
+ Allow enlargement of image for zoom to fit
+
+
+ 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”.
+
+
+ Limit image size when autofitting
+
+
+ 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.
+
+
+ Zoom increment
+
+
+ Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image.
+
+
+ Zoom control
+
+
+ When new image is selected
+
+
+ This controls the behavior of the zoom setting when changing the displayed image.
+
+
+ Zoom to original size
+
+ The new image is set to it's original size.
+
+ Fit image to window
+
+ The new image's zoom is changed so that the image will fit within the current view area.
+
+ Leave zoom at previous setting
+
+ The zoom setting is unchanged, the new image will be scaled the same as the previous image.
+
+
+ Scroll control
+
+
+ Scroll reset method
+
+
+ This controls the scroll initial position when changing the displayed image.
+
+
+ Top left
+
+ The new image is displayed from top left corner.
+
+ Center
+
+ The new image is centered
+
+ No change
+
+ The new image is positionned as the previous one, whenever possible.
+
+
+ Appearance
+
+
+ Custom border color
+
+
+ Enable this to draw the image background (the area around the image) in the specified color.
+
+
+ Border color
+
+
+ Use this color chooser to define the color to use as image background.
+
+
+ Note: You may use Limit image size when autofitting option to keep a border around the image in fullscreen mode.
+
+
+ Convenience
+
+
+ Refresh on file change
+
+
+ Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.
+
+
+ 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.
+
+
+ Preload next image
+
+
+ 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.
+
+
+ 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.
+
+
+ Auto rotate image using EXIF information
+
+
+ Auto rotates images based on data stored in images that include EXIF data.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsKeyboard.xml
--- /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 @@
+
+
+
+ Keyboard Options
+
+
+ This section describes the hotkey configuration dialog.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsLayout.xml
--- /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 @@
+
+
+
+ Window Layout
+
+
+ The Geeqie main window consists of three main panes, their position and order can be changed here. The first four selections represent the basic layout of the main window. The numbers within each selection represent the order of the pane content.
+
+
+ The order of the content can be changed by dragging the Tools, Files, or Image with the mouse to the desired location within the list.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsMetadata.xml
--- /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 @@
+
+
+
+ Metadata Options
+
+
+ This section describes the metadata writing process and options that influences it.
+
+
+ Metadata handling
+
+
+ Read algorithm
+
+ Read exif, iptc and XMP from the file.
+ Now we have "raw" data -> show them in Exif Window.
+ Read XMP sidecar or Geeqie private metadata file, which overrides the XMP read from the file.
+ Sync XMP with exif and Iptc, this corresponds to the "reconciliation" as described in [XMP Specification]
+ detect which of Exif and Xmp.exif is newer and copy the data in appropriate direction
+ detect which of Iptc and Xmp is newer and copy the data in appropriate direction
+
+ Now we have "processed" data - use them for Info Sidebar (title, keywords, ...), Orientation, Color management, etc.
+
+
+ Metadata modification
+
+ 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.
+ 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"
+ 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.
+
+
+ Write algorithm
+
+ 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.
+ Try to write exif, iptc and XMP to the image file
+ Try to write XMP sidecar for raw file if previous step was not possible.
+ If previous steps were not possible, write XMP metadata to .metadata.
+ If previous steps were not possible, write XMP metadata to geeqie private directory.
+ After the first successful write attempt delete old metadata files in all possible locations.
+
+
+ Options that influences the process
+
+
+ File types with allowed sidecars are listed in the Files tab.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOptionsWindow.xml
--- /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 @@
+
+
+
+ Window Options
+
+
+ This section describes the options presented under the Windows Tab of the preferences dialog.
+
+
+ State
+
+
+ Remember window positions
+
+
+ This will maintain windows size and position between Geeqie sessions.
+
+
+ Remember tool state
+
+
+ This will maintain the tool window state between Geeqie sessions.
+
+
+ Size
+
+
+ Fit window to image when tools are hidden/floating
+
+
+ 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.
+
+
+ Limit size when auto-sizing window
+
+
+ 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.
+
+
+ Full Screen
+
+
+ Location
+
+
+ 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.
+
+
+ Stay above other windows
+
+
+ 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.
+
+
+ Smooth image flip
+
+
+ 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.
+
+
+ Disable screen saver
+
+
+ This option will execute xscreensaver-command --deactivate once per minute to avoid the screen saver from activating when Geeqie is displayed full screen.
+
+
+ Overlay Screen Display
+
+
+ Always show image overlay at startup
+
+
+ Enable this to have the image overlay info displayed by default
+
+
+ Image overlay template
+
+
+ Overlay info is customizable through this template
+
+
+ Overlay info format string syntax is: %tag[:max_length][:extra]%
+
+
+ Tag
+
+ Replaced by
+
+
+ name
+
+ Filename of the picture
+
+
+ collection
+
+ Name of the collection
+
+
+ number
+
+ Current number of image in the list
+
+
+ total
+
+ Total number of images
+
+
+ date
+
+ File date
+
+
+ size
+
+ File size
+
+
+ width
+
+ Image width
+
+
+ height
+
+ Image height
+
+
+ res
+
+ Image resolution
+
+
+ keywords
+
+ Image keywords from metadata
+
+
+ comment
+
+ Image comment from metadata
+
+
+
+ To access exif data use the exif name, for example: %Exif.Photo.DateTimeOriginal% to get the date of the original shot
+
+
+ Pre-formatted exif data is also available:
+
+
+ Tag
+
+ Replaced by exif data
+
+
+ formatted.Camera
+
+ Camera and sofware name
+
+
+ formatted.DateTime?
+
+ Image Date
+
+
+ formatted.ShutterSpeed?
+
+ Shutter speed in seconds (ie. 1/60s)
+
+
+ formatted.Aperture
+
+ Aperture (ie. f5.6)
+
+
+ formatted.ExposureBias?
+
+ Exposure bias (ie. +0.3)
+
+
+ formatted.ISOSpeedRating
+
+ ISO sensitivity (ie. 100)
+
+
+ formatted.FocalLength?
+
+ Focal length
+
+
+ formatted.FocalLength?35mmFilm
+
+ Focal length 35mm
+
+
+ formatted.SubjectDistance?
+
+ Subject distance
+
+
+ formatted.Flash
+
+ Flash
+
+
+ formatted.Resolution
+
+ Resolution
+
+
+ formatted.ColorProfile?
+
+ Color profile
+
+
+
+ You can limit the length of displayed data using :number notation: %formatted.Camera:20% will truncate the displayed data to 20 characters and will add 3 dots at the end to denote the truncation.
+
+
+ If two or more variables are connected with the -sign, it prints available variables with a separator:
+ %formatted.ShutterSpeed% %formatted.ISOSpeedRating% %formatted.FocalLength%
+ could show:
+ "1/20s - 400 - 80 mm"
+ or
+ "1/200 - 80 mm" if there's no ISO information in the Exif data.
+
+
+ If a line is empty, it is removed. This allows to add lines that totally disappear when no data is available.
+
+
+ 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.
+
+
+ Examples:
+
+
+ %name:<i>*</i>\n%
+
+ name is displayed in italics ended with a newline
+
+ %size:\n%
+
+ size is displayed with a newline at end
+
+ %formatted.ISOSpeedRating:ISO *%
+
+ ie. "ISO 100"
+
+ Collection <b>*</b>\n
+
+ display collection name in bold prefixed by "Collection " and a newline is appended
+
+
+ Help button
+
+
+ Show syntax help
+
+
+ Defaults button
+
+
+ Restore default image overlay template
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOtherWindows.xml
--- /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 @@
+
+
+
+ Other Windows
+
+
+ This section describes the windows available in Geeqie that can be thought of as general purpose, they are not designed for a specific purpose.
+
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOtherWindowsExif.xml
--- /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 @@
+
+
+
+ Exif Window
+
+
+ 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 Info Sidebar.
+
+
+ It is possible to drag items from the Exif window to the Exif panes in the Info Sidebar.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOtherWindowsImageProperties.xml
--- /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 @@
+
+
+
+ Image Properties Window
+
+
+ The image properties window is a dialog that displays various information about a file.
+
+
+ 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.
+
+
+ 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.
+
+
+ Image preview
+
+
+ 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.
+
+
+ General tab
+
+
+ This displays information about the active file. It includes:
+
+
+ File attributes
+
+
+ Modification date and time, size, owner, group, and permissions.
+
+
+ Image attributes
+
+
+ Dimensions, uncompressed size, file or mime type, and existence of an alpha channel.
+
+
+ Compress ratio
+
+
+ The percentage of file size compared to the size of the image when decoded into memory.
+
+
+ Keywords tab
+
+
+ The keywords tab contains the same information that is in the Keywords sidebar, please refer to the Keywords Sidebar? page for details.
+
+
+ EXIF tab
+
+
+ The EXIF tab contains the same information that is in the EXIF sidebar, please refer to the EXIF Sidebar? page for details.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOtherWindowsImageWindow.xml
--- /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 @@
+
+
+
+ Image Window
+
+
+ An image window is a window that displays only the image.
+
+
+ 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.
+
+
+ The image pane contained in an image window behaves and operates similar to the image pane of a Main Window. The keyboard shortcuts are the same, and the context menu is the same except “Hide file list” is replaced by “Close window”. The slide show and full screen functions are also available.
+
+
+ Navigation
+
+
+ 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 PageDown? and PageUp? keys. In addition, all navigation methods for the mouse and keyboard are similar to that of the image pane of a Main Window.
+
+
+ Changing the image
+
+
+ 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:
+
+
+ One or more files
+
+ The image window will display the first image; the list of dropped images can be navigated similar to a main window's image pane.
+
+ One or more folders
+
+ 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.
+
+ Image from a collection
+
+ 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.
+
+
+ Changing the image window by dropping a new item onto it will cause the previous list of images or linked collection to be discarded.
+
+
+ To update the image display in the event that the source file has changed, press the R key.
+
+
+ Information and histogram Overlay
+
+
+ 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.
+
+
+ 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.
+
+
+ Overlay info is customizable through Image Overlay Template? option in Advanced tab in Preferences dialog.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideOtherWindowsPanView.xml
--- /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 @@
+
+
+
+ Pan View Window
+
+
+ This window proposes alternative views of the current directory and its children.
+ You can pan the view as you pan an image in normal view mode, using left mouse button and drag.
+
+
+ A primary mouse button click on any image will display informations about the image. Secondary mouse button will show a context menu.
+
+
+ Note: The pan view recursively visits each folder under the specified folder, so be careful it can eat a lot of ressources.
+
+
+ Select a folder
+
+
+ Location
+
+ Set the top folder.
+
+
+ Choose a view mode
+
+
+ A select box let you choose among different view modes:
+
+
+ Timeline
+
+ Shows images grouped by date.
+
+ Calendar
+
+ 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.
+
+ Folders
+
+ Show images grouped by folder. Each box represents a folder. Parent and children folders are shown as boxes enclosing other boxes.
+
+ Folders (flower)
+
+ 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.
+
+ Grid
+
+ All images are shown on a grid.
+
+
+ How each image should be represented
+
+
+ Another select box let you choose the representation of each image:
+
+
+ Dots
+
+ Each image is represented by a dot.
+
+ No images
+
+ Each image is represented by a square box.
+
+ Small thumbnails
+
+ Each image is represented by a small thumbnail.
+
+ Normal thumbnails
+
+ Each image is represented by a normal thumbnail.
+
+ Large thumbnails
+
+ Each image is represented by a large thumbnail.
+
+ 1:10 (10%)
+
+ Each image is represented by reduced image (1/10 of the original's dimensions).
+
+ 1:4 (25%)
+
+ Each image is represented by reduced image (1/4 of the original's dimensions).
+
+ 1:3 (33%)
+
+ Each image is represented by reduced image (1/3 of the original's dimensions).
+
+ 1:2 (50%)
+
+ Each image is represented by reduced image (1/2 of the original's dimensions).
+
+ 1:1 (100%)
+
+ The original image is shown at its normal dimensions.
+
+
+ Find
+
+
+ At the bottom of the window:
+
+
+ Find button
+
+ 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.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuidePrinting.xml
--- /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 @@
+
+
+
+ Printing
+
+
+ To print an image press Shift + P or select Print from the File menu.
+
+
+ The print dialog includes tabs that group related printing options, a preview pane, and a Print and Cancel button.
+
+
+ Layout tab
+
+
+ Source
+
+
+ This selects the group of images to use for print output.
+
+
+ Image
+
+ The file with the focus.
+
+ Selection
+
+ The files selected in the main window.
+
+ All
+
+ All files listed in the main window.
+
+
+ Layout
+
+
+ Select one image per page, or a Proof sheet that will print multiple images per page.
+
+
+ Image size
+
+ When print one image per page, the size of the image in relation to the available print area.
+
+ Proof size
+
+ When printing a Proof sheet, the size of each image in Units (see Paper tab).
+
+
+ Text tab
+
+
+ Name
+
+
+ Include the file name below each image.
+
+
+ Path
+
+
+ Include the full path of the file below each image.
+
+
+ Date
+
+
+ Include the file date below each image.
+
+
+ Size
+
+
+ Include the file size below each image.
+
+
+ Dimensions
+
+
+ Include the source image's pixel width and height below each image.
+
+
+ Font size
+
+
+ The font size to use for the text description of each image, in points.
+
+
+ Paper tab
+
+
+ Format
+
+
+ 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.
+
+
+ Size
+
+
+ The size of the selected paper format, in Units (below). These numbers can be changed when the paper Format is Custom.
+
+
+ Units
+
+
+ Select the units for Geeqie to use when conveying measurements of length for paper size, margins, and images sizes to the user.
+
+
+ Orientation
+
+
+ Select portrait or landscape print output.
+
+
+ Margins
+
+
+ These values specify the size of the paper edges not to be included in the print region, in Units (above).
+
+
+ Printer tab
+
+
+ Destination
+
+
+ Use this to select the destination of the print output.
+
+
+ Default printer
+
+ Prints to the system default printer.
+
+ Custom printer
+
+ Prints to the printer using the command defined in Custom printer (below).
+
+ Postscript file
+
+ Writes using the postscript format to named File (below).
+
+ Image file
+
+ Writes using the selected File format (below) to named File (below).
+
+
+ Custom printer
+
+
+ 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.
+
+
+ File
+
+
+ The file to use for output when Destination is Postscript file or Image file.
+
+
+ File format
+
+
+ The image format to use when Destination is Image file.
+
+
+ DPI
+
+
+ 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.
+
+
+ Preview
+
+
+ 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.
+
+
+ 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.
+
+
+ The size of the preview can be changed using the three zoom buttons located below the preview.
+
+
+ The preview includes several reference lines that are not included in the final print:
+
+
+ Reference grid
+
+
+ Light gray lines that form a grid over the entire page, the spacing between these lines is dependent on the current measurement unit:
+
+
+ Inch
+
+ 1 inch.
+
+ Points
+
+ 72 points.
+
+ Centimeters or Millimeters
+
+ 1 centimeter.
+
+
+ Margins
+
+
+ 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.
+
+
+ Proof sheet grid
+
+
+ When the layout is set to Proof sheet, each proof location is indicated with a red rectangle.
+
+
+ Remember print settings
+
+
+ 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.
+
+
+ Print button
+
+
+ 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.
+
+
+ Cancel button
+
+
+ Activate this button to close the print dialog, no printing will be performed.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideReference.xml
--- /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 @@
+
+
+
+ Reference
+
+
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideReferenceCommandLine.xml
--- /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 @@
+
+
+
+ Command Line Options
+
+
+ These are the command line options available to Geeqie:
+
+
+ Short Option
+
+ Long Option
+
+ Description
+
+
+ +t
+
+ --with-tools
+
+ Show file list, menu, and statusbar.
+
+
+ -t
+
+ --without-tools
+
+ Hide file list, menu, and statusbar. Window contains image only.
+
+
+ -f
+
+ --fullscreen
+
+ Start up in fullscreen.
+
+
+ -s
+
+ --slideshow
+
+ Start up in slideshow mode.
+
+
+ -l
+
+ --list
+
+ Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection.
+
+
+ -r
+
+ --remote
+
+ Send command line options to existing Geeqie process.
+
+
+ -rh
+
+ --remote-help
+
+ List command line options available to --remote.
+
+
+ -h
+
+ --help
+
+ Display brief command line option list.
+
+
+ -v
+
+ --version
+
+ Display version of Geeqie.
+
+
+ --debug
+
+ Enable Debug output to console.
+
+
+
+ Remote commands
+
+
+ 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:
+
+
+ Short Option
+
+ Long Option
+
+ Description
+
+
+ -n
+
+ --next
+
+ Change main window to display next image.
+
+
+ -b
+
+ --back
+
+ Change main window to display previous image.
+
+
+ --first
+
+ Change main window to display first image.
+
+
+ --last
+
+ Change main window to display last image.
+
+
+ -f
+
+ --fullscreen
+
+ Toggle full screen mode of the main window.
+
+
+ -fs
+
+ --fullscreen-start
+
+ Start full screen mode for main window.
+
+
+ -fS
+
+ --fullscreen-stop
+
+ Stop full screen mode for main window.
+
+
+ -s
+
+ --slideshow
+
+ Toggle slide show for main window.
+
+
+ -ss
+
+ --slideshow-start
+
+ Start slide show for main window.
+
+
+ -sS
+
+ --slideshow-stop
+
+ Stop slide show for main window.
+
+
+ -sr<folder>
+
+ --slideshow-recurse<folder>
+
+ Start recursive slide show for <folder> in main window.
+
+
+ -d<n>
+
+ --delay=<n>
+
+ Set slide show delay to <n> seconds, range is 0.1 to 3600
+
+
+ +t
+
+ --tools-show
+
+ Show tools for main window.
+
+
+ -t
+
+ --tools-hide
+
+ Hide tools for main window.
+
+
+ -q
+
+ --quit
+
+ Quit Geeqie.
+
+
+ file:<filename>
+
+ Change main window to display <filename>
+
+
+ view:<filename>
+
+ Open new window containing <filename>
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideReferenceConfig.xml
--- /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 @@
+
+
+
+ ($HOME)/.config/geeqie/geeqierc.xml
+
+
+ FIXME: Exiv2 keys, toolbar, statusbar, sidebar
+
+
+ geeqie -r --config-load:
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideReferenceKeyboardShortcuts.xml
--- /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 @@
+
+
+
+ FIXME: do we need this? The list of hotkeys is available in the preferences dialog.
+
+
+ Keyboard Shortcuts
+
+
+ Shortcut
+
+ Mouse
+
+ Action
+
+
+ Image Navigation
+
+
+ PageDown?
+
+ Left Click on image view
+ Mouse Wheel down [(*)]
+
+ Change to next image.
+
+
+ PageUp?
+
+ Middle Click on image view
+ Mouse Wheel up [(*)]
+
+ Change to previous image.
+
+
+ Home
+
+ Change to first image.
+
+
+ End
+
+ Change to last image.
+
+
+ Image panning (image has keyboard focus)
+
+
+ Arrows
+
+ Left Drag on image view
+ Shift + Mouse Wheel [(*)]
+
+ Pan image.
+
+
+ Shift + Arrows
+
+ Pan Image faster.
+
+
+ Ctrl + Arrows
+
+ Pan to respective edge of image.
+
+
+ Space
+
+ Change to next image.
+
+
+ Backspace
+
+ Change to previous image.
+
+
+ File Menu
+
+
+ Ctrl + N
+
+ New Window
+
+
+ C
+
+ Open a new empty collection window.
+
+
+ O
+
+ Display open collection dialog.
+
+
+ F3
+
+ Open new search window.
+
+
+ D
+
+ Open new Find Duplicates window.
+
+
+ Shift + P
+
+ Open print dialog.
+
+
+ Ctrl + F
+
+ Create new folder in current path.
+
+
+ Ctrl + C
+
+ Copy selected images, opens destination selection dialog.
+
+
+ Ctrl + M
+
+ Move selected images, opens destination selection dialog.
+
+
+ Ctrl + R
+
+ Rename selected images, opens rename dialog.
+
+
+ Ctrl + DDelete
+
+ Delete selected images.
+
+
+ Ctrl + W
+
+ Close window, Geeqie exits when last window is closed.
+
+
+ Ctrl + Q
+
+ Quit Geeqie.
+
+
+ Edit Menu
+
+
+ Ctrl + 1 ... 0
+
+ Run external edit command on selected images.
+
+
+ Ctrl + A
+
+ Select all images.
+
+
+ Ctrl + Shift + A
+
+ Unselect all images.
+
+
+ Ctrl + P
+
+ Open image properties window.
+
+
+ Ctrl + O
+
+ Open Geeqie preferences window.
+
+
+ ]
+
+ Rotate image clockwise 90 degrees.
+
+
+ [
+
+ Rotate image counterclockwise 90 degree.
+
+
+ Shift + R
+
+ Rotate image 180 degrees.
+
+
+ Shift + M
+
+ Flip image horizontally (mirror).
+
+
+ Shift + F
+
+ Flip image vertically.
+
+
+ View Menu
+
+
+ +, =
+
+ Ctrl + Mouse Wheel up
+
+ Zoom image in.
+
+
+ -
+
+ Ctrl + Mouse Wheel down
+
+ Zoom image out.
+
+
+ Z
+
+ Reset zoom to original size (1:1).
+
+
+ X
+
+ Fit image to window size.
+
+
+ W
+
+ Zoom image to fit window width.
+
+
+ H
+
+ Zoom image to fit window height.
+
+
+ 1
+
+ Set zoom to 1:1
+
+
+ 2
+
+ Set zoom to 2:1
+
+
+ 3
+
+ Set zoom to 3:1
+
+
+ 4
+
+ Set zoom to 4:1
+
+
+ 7
+
+ Set zoom to 1:4
+
+
+ 8
+
+ Set zoom to 1:3
+
+
+ 9
+
+ Set zoom to 1:2
+
+
+ T
+
+ Toggle display of thumbnails when in list view.
+
+
+ Ctrl + L
+
+ Display file list as detailed list view.
+
+
+ Ctrl + I
+
+ Display file list as icon view.
+
+
+ Ctrl + T
+
+ Toggle folder display between list and tree views.
+
+
+ R
+
+ Refresh file list.
+
+
+ L
+
+ Toggle floating of file display.
+
+
+ Ctrl + H
+
+ Toggle hiding of file display.
+
+
+ Ctrl + E
+
+ Toggle EXIF sidebar.
+
+
+ Ctrl + S
+
+ Toggle Sort Manager sidebar.
+
+
+ Ctrl + K
+
+ Toggle Keywords sidebar.
+
+
+ FV
+
+ Toggle full screen.
+
+
+ I
+
+ Toggle information overlay in full screen.
+
+
+ S
+
+ Toggle slideshow.
+
+
+ P
+
+ Toggle pause of slideshow.
+
+
+ <-3 class="shortcuts-separator"> Help Menu
+
+
+ F1
+
+ Open User Manual in browser.
+
+
+ <-3 class="shortcuts-separator"> Collection Window
+
+
+ Arrows
+
+ Move selection.
+
+
+ Shift + Arrows
+
+ Select multiple images.
+
+
+ Ctrl + Arrows
+
+ Move focus without changing selection.
+
+
+ SpaceBar?
+
+ Select only image with focus.
+
+
+ Ctrl + SpaceBar?
+
+ Toggle selection of image with focus.
+
+
+ Home
+
+ Move focus to first image.
+
+
+ End
+
+ Move focus to last image.
+
+
+ Ctrl + A
+
+ Select all images.
+
+
+ Ctrl + Shift + A
+
+ Unselect all images.
+
+
+ Delete
+
+ Remove selected image from collection, does not delete image from disk.
+
+
+ Ctrl + L
+
+ Add images from main window's file list.
+
+
+ Ctrl + T
+
+ Toggle display of icon filenames.
+
+
+ N
+
+ Sort collection by name.
+
+
+ D
+
+ Sort collection by file date.
+
+
+ B
+
+ Sort collection by file size.
+
+
+ P
+
+ Sort collection by file path.
+
+
+ I
+
+ Sort collection by natural numerical order.
+
+
+ Enter
+
+ View image with focus in main window.
+
+
+ V
+
+ View image with focus in new window.
+
+
+ Ctrl + 1 ... 0
+
+ Run external edit command on selected images.
+
+
+ S
+
+ Save collection.
+
+
+ Ctrl + S
+
+ Save collection as, opens destination dialog.
+
+
+ A
+
+ Append to collection, opens append dialog.
+
+
+ Ctrl + C
+
+ Copy selected images, opens destination selection dialog.
+
+
+ Ctrl + M
+
+ Move selected images, opens destination selection dialog.
+
+
+ Ctrl + R
+
+ Rename selected images, opens rename dialog.
+
+
+ Ctrl + D
+
+ Delete selected images.
+
+
+ Ctrl + P
+
+ Open image properties window.
+
+
+ Ctrl + W
+
+ Close collection window.
+
+
+ <-3 class="shortcuts-separator"> Find Duplicates Window (same as Collection Window above, with the following additions)
+
+
+ 1
+
+ Select group 1 duplicates.
+
+
+ 2
+
+ Select group 2 duplicates.
+
+
+ C
+
+ Open new collection window and add selected images.
+
+
+
+ (*) Note: Default Mouse wheel functions can be altered by changing the Mouse wheel scrolls image? option.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideReferenceManagement.xml
--- /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 @@
+
+
+
+ Cache and Data Maintenance
+
+
+ Thumbnails and other cached data can be maintained from the dialog accessible by selecting Thumbnail maintenance from the Edit menu of the main window.
+
+
+ Geeqie thumbnail cache
+
+
+ The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the search and find duplicates utilities.
+
+
+ Clean up
+
+
+ Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated.
+
+
+ Clear cache
+
+
+ Removes all thumbnails and data stored in the user's home folder: $HOME/.geeqie/thumbnails.
+
+
+ Shared thumbnail cache
+
+
+ The utilities listed here operate on the shared thumbnail mechanism.
+
+
+ Clean up
+
+
+ Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated.
+
+
+ Clear cache
+
+
+ Removes all thumbnails stored in the user's home folder: $HOME/.thumbnails.
+
+
+ Create thumbnails
+
+
+ This utility will render thumbnails using the current thumbnail caching mechanism, as determined in preferences.
+
+
+ Render
+
+
+ Pre-render thumbnails for a specific folder, the utility has the following options:
+
+
+ Include subfolders
+
+
+ Enable to include all images contained in the subfolders of folder.
+
+
+ Store thumbnails local to source images
+
+
+ The generated thumbnails will be stored local to the source images, if you have the permissions to write to the folder containing the images.
+
+
+ Metadata
+
+
+ This utility operates on the data store for keywords and comments? located in the user's home folder: $HOME/.geeqie/metadata.
+
+
+ Clean up
+
+
+ Removes keywords and comments for which the source image is no longer present.
+
+
+ File locations
+
+
+ The various file locations and their use are listed below. <HOME> refers to your home folder and <SOURCE> refers to the folder containing the image.
+
+
+ Folder or File name
+
+ Description
+
+
+ Thumbnails
+
+
+ <HOME>/.thumbnails
+
+ Shared thumbnail cache folder.
+
+
+ <HOME>/.geeqie/thumbnails
+
+ 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.
+
+
+ <SOURCE>/.thumbnails
+
+ Local thumbnail cache folder.
+
+
+ Metadata (keywords and comments)
+
+
+ <HOME>/.geeqie/metadata
+
+ Metadata stored in user's home folder.
+
+
+ <SOURCE>/.metadata
+
+ Metadata stored local to source image. Requires option to be enabled in advanced preferences.
+
+
+ Collections
+
+
+ <HOME>/.geeqie/collections
+
+ Default location for Geeqie collections, collections in this folder will appear in the sort manager sidebar.
+
+
+ Preferences
+
+
+ <HOME>/.geeqie
+
+ Geeqie preferences folder.
+
+
+ <HOME>/.geeqie/geeqierc
+
+ Geeqie preferences rc file.
+
+
+ <HOME>/.geeqie/history
+
+ Historic data such as last several folders visited, bookmarks, and recently used collections. Also contains default print settings.
+
+
+ <HOME>/.geeqie/accels
+
+ Keyboard shortcut mapping.
+
+
+ Safe Delete
+
+
+ <HOME>/.geeqie/trash
+
+ Default location of the safe delete folder.
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideReferenceThumbnails.xml
--- /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 @@
+
+
+
+ Thumbnails
+
+
+ Note: This page only refers the Geeqie thumbnail caching mechanism, the shared thumbnail cache mechanism is not explained here.
+
+
+ Format
+
+
+ Thumbnails are stored in PNG image format. The thumbnail name is the name of the source image with “.png” appended.
+
+
+ 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.
+
+
+ Location
+
+
+ Thumbnails are stored in:
+
+
+ ($HOME)/.geeqie/thumbnails
+
+
+ The directory structure of the thumbnail cache duplicates the location of the source files, for example a source file with the name:
+
+
+ /path/to/image.jpg
+
+
+ will store the thumbnail in:
+
+
+ ($HOME)/.geeqie/thumbnails/path/to/image.jpg.png
+
+
+ When thumbnails are to be stored local to the source file, the thumbnail will be placed in:
+
+
+ /path/to/.thumbnails/image.jpg.png
+
+
+ Local thumbnail caching is enabled with the option “Cache thumbnails into .thumbnails” on the General 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.
+
+
+ Size
+
+
+ Geeqie allows the following sizes for thumbnails:
+
+
+ 24x24, 32x32, 48x48, 64x64, 96x72, 96x96, 129x96, 128x128, 160x120, 160x160, 192x144, 192x192, 256x192, 256x256
+
+
+ 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.
+
+
+ When a cached thumbnail's width and height do not match the preferred size, the thumbnail is regenerated.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideSidebars.xml
--- /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 @@
+
+
+
+ Sidebars
+
+
+ A sidebar is a panel that appears next to an image, and displays additional information about the image.
+
+
+
+ EXIF sidebar? - FIXME: obsolete
+
+
+ Keywords sidebar? - FIXME: obsolete
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideSidebarsInfo.xml
--- /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 @@
+
+
+
+ Info Sidebar
+
+
+ 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.
+
+
+ Panes
+
+
+ Histogram
+
+
+ Right-click to configure
+
+
+ Text panes - Title, Comment
+
+
+ The text is written to Xmp.dc.title and Xmp.dc.description. It can be changed in the configuration file.
+
+
+ Keywords
+
+
+ FIXME: put keywords? here The text is written to Xmp.dc.subject. It can be changed in the configuration file.
+
+
+ List panes - Exif, File info, Copyright, Location and GPS
+
+
+ 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
+
+
+ Add entry
+
+
+ Key
+
+ Exiv2 or Geeqie (formatted...) key FIXME: list of formatted... tags.
+
+
+ Title
+
+ Title that is shown.
+
+
+ Show only if set
+
+ Show only if the tag exists in the file.
+
+
+ Editable
+
+ Displays the value as editable.
+
+
+ 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).
+
+
+ Show hidden
+
+
+
+ Shows all entries regardless of "Show only if set".
+
+
+
+ GPS Map
+
+
+ Geeqie must be built with libchamplain.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook/GuideSidebarsSortManager.xml
--- /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 @@
+
+
+
+ Sort Manager Sidebar
+
+
+ The Sort Manager sidebar provides a convenient method to quickly sort many files into a set of folders or collections.
+
+
+ To toggle display of the Sort Manager press Ctrl + S or select “Sort manager” from the View menu.
+
+
+ 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.
+
+
+ Folder view
+
+
+ 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.
+
+
+ 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.
+
+
+ Bookmark list
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
+ 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.
+
+
+ To remove an item from the list select “Remove” from it's context menu.
+
+
+ Copy, Move, and Link
+
+
+ These are the available operations to use on the active image, they should be self explanatory.
+
+
+ Add button
+
+
+ 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.
+
+
+ Undo button
+
+
+ Activate this button to undo the last copy, move, or link operation. The undo function can only reverse the most recent operation.
+
+
+ Collection view
+
+
+ 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.
+
+
+ Clicking or activating an item in the list will add the selected image to that collection.
+
+
+ Collection list
+
+
+ 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.
+
+
+ A new empty collection can be added to the list by activating the Add button at the bottom of the sidebar.
+
+
+ Choosing the selection style
+
+
+ The images to add when activating a collection is determined by the selection style:
+
+
+ Add image
+
+
+ The visible image is added to the collection.
+
+
+ Add selection
+
+
+ All images selected in the file list will be added to the collection.
+
+
+ Add button
+
+
+ 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.
+
+
+ Undo button
+
+
+ Activate this button to undo the last add operation. The undo function can only reverse the most recent operation.
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/docbook2html.sh
--- /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
diff -r 9f3b7a089caf -r 2ae81598b254 doc/download.sh
--- /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
diff -r 9f3b7a089caf -r 2ae81598b254 doc/faq.html
--- 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 @@
-
-
-
-
-
-
-
- Frequently Asked Questions - Geeqie User Manual
-
-
-
-
-
-
-
How do I keep images smaller than the visible area from enlarging when the zoom is set to “fit to window” ?
-
-
In the preferences dialog, under the “Image” tab, disable “Allow enlargement of image for zoom to fit”.
-
-
Command line
-
-
How do I open an image in an existing Geeqie application ?
-
-
Use the “-r” command line option to send commands to an existing Geeqie, for a list of commands supported by the remote switch run:
-
-
geeqie --remote-help
-
-
How do I set the slide show delay when starting Geeqie in slide show from the command line ?
-
-
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:
-
-
geeqie -r -d12 -ss
-
-
Note that if geeqie is running prior to this command, the slide show should also be stopped prior to changing the delay:
-
-
geeqie -r -sS -d12 -ss
-
-
-
Miscellaneous
-
-
I want to be able to edit images with Geeqie
-
-
Geeqie is an image viewer. There is, and never will be, a plan to add editing features. I recommend gimp for image editing.
-
-
diff -r 9f3b7a089caf -r 2ae81598b254 doc/gnu_fdl.txt
--- 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.
diff -r 9f3b7a089caf -r 2ae81598b254 doc/image_management.html
--- 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 @@
-
-
-
-
-
-
-
- Image Management - Geeqie User Manual
-
-
-
-
-
-
-
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.
-
-
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.
-
-
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.
-
-
The Copy/Move dialog
-
-
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.
-
-
-
Home button
Activate this button to change the active path to your home folder.
-
-
New Folder button
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.
-
-
Show Hidden check box
Enabling this check box will cause hidden folders to appear in the folder list.
-
-
Bookmark list
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. 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.
-
-
Folder list
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.
-
-
Path entry
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.
-
-
Copy/Move button
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.
-
-
Cancel button
Activate this button to close the dialog, the operation will be aborted.
-
-
-
The error dialog
-
-
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.
-
-
The overwrite dialog
-
-
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:
-
-
-
Auto rename
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.
-
-
Rename
Enable this check box to manually enter a new name for the file.
-
-
Overwrite
Activate this will overwrite the existing file, or rename it if one of the rename check boxes are enabled.
-
-
Overwrite all
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.
-
-
Skip
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.
-
-
Skip All
This will perform the same as the Skip button, however any further file name conflicts will be quietly ignored for all remaining files.
-
-
Cancel
This will close the dialog and stop the operation, all remaining files will be ignored.
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 Enable delete key is enabled in Options, pressing the Delete key can also be used to delete files.
-
-
The behavior when starting a delete operation depends on the Confirm file delete 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.
-
-
Confirm delete dialog
-
-
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.
-
-
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.
-
-
The dialog will also display the status of the Safe Delete 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.
-
-
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.
-
-
Safe Delete
-
-
Geeqie includes a feature to temporarily store deleted files in a selected folder, to use this feature enable Safe Delete on the advanced tab of the preferences dialog.
-
-
Safe Delete includes these options:
-
-
-
Folder
-
The folder to use for temporarily retaining deleted files.
-
-
Maximum size
-
The maximum amount of disk space to use when storing deleted files, in megabytes.
-
-
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.
-
-
-
-
Files moved to the Safe Delete folder are prefixed with a six digit number in the format:
- nnnnnn_FILENAME
-
-
-
This is used to distinguish which files to remove first when clearing space for new files. The digit counter increments with each deleted file.
-
-
To clear the contents of the Safe Delete folder, activate the Clear button provided for this purpose on the Advanced tab in Options.
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.
-
-
These commands are executed by pressing Ctrl and a number key, from the Edit menu, or from the context menu available to all images and files. The keyboards shortcuts are Ctrl + 1 through Ctrl + 9, and Ctrl + 0, they correspond respectively to commands 1 through 10 on the Editors tab in Options.
Commands that are set to display the command's output in a window will show a dialog when the command is executed.
-
-
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 Editors tab in Options.
-
-
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.
-
-
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 Escape to close the result dialog. The result dialog can not be closed while a command is still running.
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.
-
-
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.
-
-
Rename single file dialog
-
-
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.
-
-
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.
-
-
Rename multiple files dialog
-
-
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.
-
-
-
Manually enter new file names
-
-
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.
-
-
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.
-
-
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.
-
-
-
Automatic renaming of multiple files
-
-
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.
-
-
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.
-
-
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”.
-
-
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.
-
-
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.
-
-
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.
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.
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.
-
-
Starting a slide show
-
-
A slide show can be started in a number of ways:
-
-
-
-
From the menu bar - open the View menu and select Toggle slide show to toggle the slide show on or off .
-
-
-
-
From the keyboard - press the S key to toggle the slide show on or off.
-
-
-
-
From a context menu - right click an image pane, and select Start slide show, or Stop slide show; the text will change depending on the state of the current slide show.
-
-
-
-
Stopping a slide show
-
-
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 options dialog, the slide show will stop when the last image in the sequence is displayed.
-
-
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 Slide show sequence navigation.
-
-
Slide show status
-
-
The main window status bar can be used to determine when a slide show is active, Slide show will be displayed next to the file count field. An individual Image Window 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 Start slide show is displayed, no slide show is active, conversely if Stop slide show is displayed a slide show is active.
-
-
When a Slide show is paused, the main window status bar will display Paused instead of Slide show. Likewise, the image context menu will display Pause slide show or Continue slide show, depending on the current state.
-
-
Pausing a slide show
-
-
An active slide show can be paused in two ways:
-
-
-
-
From the keyboard - press the P key while a slide show is active.
-
-
-
-
From a context menu - right click the image pane displaying the slide show, and select Pause slide show, or Continue slide show depending on the current slide show state.
-
-
-
-
Selecting the images to include in a slide show
-
-
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.
-
-
To only include some images in a slide show, use multiple selection to select the images to include before starting the slide show.
-
-
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.
-
-
So far, the methods described are for slide shows in a main window, in an Image Window, the slide show will use all images referenced by that window.
-
-
Recursive slide show
-
-
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:
-
-
-
-
Slide show: This will start a slide show that includes all images in the selected folder.
-
-
-
-
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.
-
-
-
-
Slide show sequence navigation
-
-
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.
-
-
Configuring a slide show
-
-
The options that control the behavior of slide shows are located on the General tab of the options dialog.
-
-
-
Display time
-
The delay between each image in the slide show can be adjusted with the Delay before image change option.
-
-
Repeat
-
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.
-
-
Random
-
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.
Geeqie provides a utility to find images that have similar attributes or content.
-
-
To display a new Find Duplicates Window press D or select Find duplicates from the File menu.
-
-
Adding files to be compared
-
-
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:
-
-
-
Add contents
-
The contents of dropped folders will added to the window.
-
-
Add contents recursive
-
The contents of dropped folders and all sub folders will be added to the window.
-
-
Skip folders
-
Ignore folders contained in the drop list.
-
-
-
-
When files are added to the window, the comparison is restarted to include the new files.
-
-
Comparison methods
-
-
The attribute to use for two images to match can be selected with the “Compare by:” drop down menu. Each method is explained below:
-
-
-
Name
The file name.
-
-
Name case-insensitive
The file name but ignoring case.
-
-
Size
The file size.
-
-
Date
The file date.
-
-
Dimensions
The image dimensions.
-
-
Checksum
The MD5 file checksum.
-
-
Path
The complete path to file.
-
-
Similarity (high)
Very similar image content.
-
-
Similarity
Similar image content.
-
-
Similarity (low)
Slightly similar image content.
-
-
Similarity (custom)
Similar image content, the value to use to consider two images a match is configured in the Advanced tab of the preferences dialog by setting the “Custom similarity threshold”.
-
-
-
Results list
-
-
Files that match with the selected comparison method will appear in the list. Matching files are grouped in alternating color.
-
-
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.
-
-
A context menu is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.
-
-
Keyboard shortcuts available in the results list:
-
-
-
-
-
-
-
-
-
-
-
Shortcut
-
-
-
-
Context menu name
-
-
-
-
Description
-
-
-
-
-
-
-
-
Enter
-
-
-
-
View
-
-
-
-
Opens selected image in main window.
-
-
-
-
-
-
V
-
-
-
-
View in new window
-
-
-
-
Opens selected image in a new window.
-
-
-
-
-
-
Ctrl + A
-
-
-
-
Select all
-
-
-
-
Selects all images.
-
-
-
-
-
-
Ctrl + Shift + A
-
-
-
-
Select none
-
-
-
-
Clear the image selection.
-
-
-
-
-
-
1
-
-
-
-
Select group 1 duplicates
-
-
-
-
Selects the first image from each match group.
-
-
-
-
-
-
2
-
-
-
-
Select group 2 duplicates
-
-
-
-
Selects all but the first image from each match group.
-
-
-
-
-
-
Ctrl + 1 through
- Ctrl + 0
-
-
-
-
Edit sub menu
-
-
-
-
Executes the respective editor command.
-
-
-
-
-
-
Ctrl + P
-
-
-
-
Properties
-
-
-
-
Opens a properties window for selected images.
-
-
-
-
-
-
C
-
-
-
-
Add to new collection
-
-
-
-
Creates a new collection containing the selected images.
-
-
-
-
-
-
-
-
Print
-
-
-
-
Opens a print dialog for selected images.
-
-
-
-
-
-
Ctrl + C
-
-
-
-
Copy
-
-
-
-
Copy selected images.
-
-
-
-
-
-
Ctrl + M
-
-
-
-
Move
-
-
-
-
Move selected images.
-
-
-
-
-
-
Ctrl + R
-
-
-
-
Rename
-
-
-
-
Rename selected images.
-
-
-
-
-
-
Ctrl + D
-
-
-
-
Delete
-
-
-
-
Delete selected images.
-
-
-
-
-
-
Delete
-
-
-
-
Remove
-
-
-
-
Remove selected images from result list.
-
-
-
-
-
-
Ctrl + Delete
-
-
-
-
Clear
-
-
-
-
Cleared the result list.
-
-
-
-
-
-
Menu
-
-
-
-
-
-
Displays the context menu.
-
-
-
-
-
-
Ctrl + T
-
-
-
-
-
-
Toggle display of thumbnails.
-
-
-
-
-
-
Ctrl + W
-
-
-
-
-
-
Close window.
-
-
-
-
-
-
-
The selection can be changed using the keyboard and mouse the same as in a file pane of the main window.
-
-
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.
-
-
Status bar
-
-
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.
-
-
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:
-
-
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...”.
- 2) The images are compared using the selected method, the progress bar will indicate this stage with the text “comparing...”.
- 3) The results are sorted for display, the progress bar will indicate this stage with the text “sorting...”.
-
-
Stage 1 is only used for the Dimensions, Checksum, and Similarity compare methods.
-
-
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.
-
-
Thumbnails
-
-
Thumbnails can be displayed beside each image in the result list by enabling the Thumbnails check box.
-
-
Compare two file sets
-
-
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.
-
-
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.
-
-
Drag and Drop
-
-
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.
Geeqie provides a utility to find one or more images based on various parameters.
-
-
To display a new Search Window press F3 or select Search from the File menu.
-
-
To start a search activate the Find button. A search in progress can be stopped by activating the Stop button.
-
-
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.
-
-
When a search is completed, the total number of files found and their total size will be displayed in the status bar.
-
-
Search location
-
-
One of several locations can be chosen as the source to use in the search.
-
-
-
Path
-
-
The search will include files located in the selected folder, enable the Recurse check box to include the contents of all sub folders.
-
-
-
Comments
-
-
The search will include all files that have a keyword or comment associated to it.
-
Note: Only keyword and comment associations stored in the user's home folder are included in this search type.
-
-
-
Results
-
-
The search will include all files currently listed in the results list, use this to refine a previous search.
-
-
-
-
Search parameters
-
-
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.
-
-
-
File name
-
-
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.
-
-
-
File size
-
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.
-
-
-
File date
-
-
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.
-
For convenience, the button with the down arrow displays a pop up calendar to enter the date.
-
-
-
Image dimensions
-
-
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.
-
The image dimensions test is simple, both width and height must be within the allowed values for a match.
-
-
-
Image content
-
-
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 Finding Duplicates. The entry is for entering the path for the image to use in this test.
-
-
-
Keywords
-
-
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.
-
-
-
-
Results list
-
-
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.
-
-
A context menu is available for the result list by right clicking the mouse or pressing the Menu key when a row has the focus.
-
-
Keyboard shortcuts available in the results list:
-
-
-
-
-
-
-
-
-
-
-
Shortcut
-
-
-
-
Context menu name
-
-
-
-
Description
-
-
-
-
-
-
-
Enter
-
-
-
-
View
-
-
-
-
Opens selected image in main window.
-
-
-
-
-
-
V
-
-
-
-
View in new window
-
-
-
-
Opens selected image in a new window.
-
-
-
-
-
-
Ctrl + A
-
-
-
-
Select all
-
-
-
-
Selects all images.
-
-
-
-
-
-
Ctrl + Shift + A
-
-
-
-
Select none
-
-
-
-
Clear the image selection.
-
-
-
-
-
-
Ctrl + 1 through
- Ctrl + 0
-
-
-
-
Edit sub menu
-
-
-
-
Executes the respective editor command.
-
-
-
-
-
-
Ctrl + P
-
-
-
-
Properties
-
-
-
-
Opens a properties window for selected images.
-
-
-
-
-
-
C
-
-
-
-
Add to new collection
-
-
-
-
Creates a new collection containing the selected images.
-
-
-
-
-
-
-
-
Print
-
-
-
-
Opens a print dialog for selected images.
-
-
-
-
-
-
Ctrl + C
-
-
-
-
Copy
-
-
-
-
Copy selected images.
-
-
-
-
-
-
Ctrl + M
-
-
-
-
Move
-
-
-
-
Move selected images.
-
-
-
-
-
-
Ctrl + R
-
-
-
-
Rename
-
-
-
-
Rename selected images.
-
-
-
-
-
-
Ctrl + D
-
-
-
-
Delete
-
-
-
-
Delete selected images.
-
-
-
-
-
-
Delete
-
-
-
-
Remove
-
-
-
-
Remove selected images from result list.
-
-
-
-
-
-
Ctrl + Delete
-
-
-
-
Clear
-
-
-
-
Cleared the result list.
-
-
-
-
-
-
Menu
-
-
-
-
-
-
Displays the context menu.
-
-
-
-
-
-
Ctrl + T
-
-
-
-
-
-
Toggle display of thumbnails.
-
-
-
-
-
-
Ctrl + W
-
-
-
-
-
-
Close window.
-
-
-
-
-
-
-
The selection can be changed using the keyboard and mouse the same as in a file pane of the main window.
-
-
The image Dimensions column of the result list will only contain dimension information when dimensions are included in the search parameters.
-
-
Status bar
-
-
At the bottom of the search window is an area that includes the following items from left to right:
-
-
-
Thumbnails
-
-
Enable this check box to display a thumbnail next to each image in the results list.
-
-
-
File count display
-
-
Displays the total count of files in the results list, and their size on disk. The count of selected files will appear in parenthesis.
-
-
-
Search progress
-
-
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.
-
-
-
Find
-
-
Activate the find button to start a search with the selected parameters.
-
-
-
Stop
-
-
Activate the stop button to end a search that is in progress.
-
-
-
-
Drag and Drop
-
-
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.
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".
-
-
Introduction
-
-
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.
-
-
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.
-
-
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.
-
-
Basic Features
-
-
-
-
Thumbnail preview
-
-
-
-
Full screen
-
-
-
-
Slide show
-
-
-
-
Image Management
-
-
-
-
Image Collections
-
-
-
-
Advanced Features
-
-
-
-
Image Search
-
-
-
-
Find image duplicates based on image content
-
-
-
-
View EXIF data stored in images
-
-
-
-
Simple Sort Manager to quickly sort a folder of images into other folders
-
-
-
-
Rename images in bulk
-
-
-
-
Add keywords to images, and recall those images with the search function
-
-
-
-
Very Configurable
-
-
-
-
“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.
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.
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.
-
-
A context menu 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.
-
-
List view
-
-
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.
-
-
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.
-
-
Thumbnails 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.
-
-
Icon view
-
-
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.
-
-
The icon view mode displays images as thumbnails in a grid, and by default a file name below each thumbnail.
-
-
The file name displayed below each thumbnail can be turned on or off by selecting “Show filename text” from the context menu.
-
-
Multiple selection
-
-
It is possible to select more than one image from the file pane. Multiple files can be selected with several methods:
-
-
Mouse
-
-
-
-
Ctrl + Primary mouse button will add or remove the file from the selection.
-
-
-
-
Middle mouse button will toggle selection of the file.
-
-
-
-
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.
-
-
-
-
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.
-
-
-
-
Keyboard
-
-
-
-
Ctrl + Arrows will move the focus without changing the selection.
-
-
-
-
Ctrl + Space will toggle selection of the focused image.
-
-
-
-
Shift + Arrows will select a region of images.
-
-
-
-
Shift + Ctrl + Arrows works as Shift + Arrows, but will not change the selection of files outside the current focus region.
-
-
-
-
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”.
-
-
The current number of selected images and their total size will be indicated in the File list section of the status bar.
-
-
Sorting
-
-
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.
-
-
Selecting the ascending menu item will toggle between increasing and decreasing sort order.
-
-
Context menu
-
-
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 menu bar, however a few functions are unique to the context menu:
-
-
-
-
View in new window
-
Opens a new window containing a list of the currently selected images.
-
-
Sort
-
Changes the sort order of file pane.
-
-
View as icons
-
Toggles between the list and icon view modes.
-
-
Show thumbnails
-
Toggles display of thumbnails in the list view display mode.
-
-
Show filename text
-
Toggles display of file names in the icon view display mode.
-
-
-
-
Drag and Drop
-
-
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.
Toggle the folder pane, file pane, and status bar between the main window and a secondary window.
-
-
-
Path entry
-
-
This displays the active folder of the window and allows typing a location.
-
-
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.
-
-
Note: Tab completion uses the Tab key, press the Down key to move the focus from the entry.
-
-
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.
-
-
Folder list
-
-
This displays a list of sub folders contained in the active folder, or a tree that includes all folders in the file system.
-
-
A context menu 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
-
-
List view
-
-
This mode can be enabled by unselecting “Tree” from the View menu, pressing Ctrl + T, or unselecting “View as tree” from the context menu.
-
-
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 “..”.
-
-
Tree view
-
-
This mode can be enabled by selecting “Tree” from the View menu, pressing Ctrl + T, or selecting “View as tree” from the context menu.
-
-
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.
-
-
Sorting
-
-
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.
-
-
Context menu
-
-
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 menu bar, however a few functions are unique to the context menu:
-
-
-
Up to parent
This will change the window to display the contents of the parent folder.
-
-
Slide show
Start a slide show that contains all images in the selected folder.
-
-
Slide show recursive
Start a slide show that contains all images in the selected folder, and all images in the sub folders of that folder.
-
-
Find duplicates
This will open a new find duplicates window containing all images in the selected folder.
-
-
Find duplicates recursive
This will open a new find duplicates window containing all image in the selected folder, and all images in the sub folders of that folder.
-
-
New folder
Creates a new folder that is a sub folder of the selected folder.
-
-
Rename
Renames the selected folder.
-
-
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.
-
-
View as tree
Toggles between the list and tree modes of the folder pane.
-
-
-
-
Drag and drop
-
-
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.
-
-
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.
-
-
Using Shift key while dragging is a shortcut to move action. Menu will not appear but move will occur.
-
Using Ctrl key while dragging is a shortcut to copy action. Menu will not appear but copy will occur.
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.
-
-
Image display
-
-
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.
-
-
The quality of the image, especially when using the zoom feature, is dependent on the settings that are available on the Image tab of the preferences dialog.
-
-
To increase the speed of loading the next image when navigating the image list in sequence, enable the Preload next image option.
-
-
Image panning and manipulation
-
-
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.
-
-
Keyboard
-
Use the Arrows to pan the image in the desired direction, to increase the panning speed hold down the Shift + Arrows. 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.
-
-
-
-
-
-
-
-
-
-
-
Shortcut
-
-
-
-
Context menu name
-
-
-
-
Description
-
-
-
-
-
-
-
+
-
=
-
-
-
-
Zoom in
-
-
-
-
Zoom in.
-
-
-
-
-
-
-
-
-
-
Zoom out
-
-
-
-
Zoom out.
-
-
-
-
-
X
-
[Keypad] *
-
-
-
-
Fit image to window
-
-
-
-
Scale the image to fit the available display area.
-
-
-
-
-
Z
-
[Keypad] /
-
-
-
-
Zoom 1:1
-
-
-
-
Reset the zoom to original image size.
-
-
-
-
-
]
-
-
-
-
Adjust > Rotate clockwise
-
-
-
-
Rotate the image clockwise 90 degrees.
-
-
-
-
-
[
-
-
-
-
Adjust > Rotate counterclockwise
-
-
-
-
Rotate the image counterclockwise 90 degrees.
-
-
-
-
-
Shift + R
-
-
-
-
Adjust > Rotate 180
-
-
-
-
Rotate the image 180 degrees.
-
-
-
-
-
Shift + M
-
-
-
-
Adjust > Mirror
-
-
-
-
Flip the image horizontally.
-
-
-
-
-
Shift + F
-
-
-
-
Adjust > Flip
-
-
-
-
Flip the image vertically.
-
-
-
-
-
-
Note: The rotation, mirror, and flip functions will not change the image file on disk.
-
-
Mouse
-
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 (*).
-
-
To scale the image size hold down the Ctrl key and scroll the mouse wheel up to zoom in, or down to zoom out.
-
-
Smooth Scroll
-
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.
-
-
Navigation
-
-
The displayed image can be changed to the next or previous image using the keyboard or mouse.
-
-
Keyboard
-
The PageDown and PageUp 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 SpaceBar and BackSpace keys can also be used to change the image.
-
-
Mouse
-
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 (*).
-
-
Context menu
-
-
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 menu bar, however a few functions are unique to the context menu:
-
-
-
View in new window
Opens a new window containing a second copy of the current image.
-
-
Pause slide show, Continue slide show
Controls the pause state of an active slide show, the text of the menu will change to reflect the action that will be performed.
-
-
-
Drag and Drop
-
-
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.
-
-
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.
-
-
Displaying images side by side
-
-
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.
-
-
Connected zoom is possible through the View > Connected zoom menu. Zoom is then applied to all displayed images.
-
Connected scrolling is also possible using Shift and primary mouse button.
-
-
-
-
(*) Note: The mouse wheel behavior for scrolling and image step can be swapped with the Mouse wheel scrolls image option located on the Advanced tab of the preferences dialog.
The main window consists of four areas, the folder pane, file pane, image pane, and the status bar. 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.
-
-
Selecting the location of each pane
-
-
The arrangement of the folder, file, and image pane is selected on the Windows tab 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.
-
-
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.
-
-
Note: In the options window the file and image panes are labeled similarly, however the folder pane is labeled as tools.
-
-
Changing the size of a pane
-
-
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.
-
-
Folder pane
-
-
The folder pane 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.
-
-
File pane
-
-
The file pane lists the images contained in the active folder. The file pane can be set to display as a vertical list or an icon view.
-
-
Image pane
-
-
The image pane is where the active image is displayed.
This section describes the functions of each item on the menu bar in the Geeqie main window.
-
-
File Menu
-
-
-
New window
Opens a new main window, with the initial path set to the current folder.
-
-
New collection
Opens a new collection window, the new collection will be empty.
-
-
Open collection
Displays a dialog to open a collection stored on disk, the selected collection will then appear in a new window.
-
-
Open recent
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 Open recent list maximum size option.
-
-
Search...
Opens a new Search window.
-
-
Find duplicates...
Opens a new Find Duplicates window.
-
-
Pan view
Opens the pan view window.
-
-
Print..
Opens a print dialog.
-
-
New folder...
Creates a new folder in the current path.
-
-
Copy...
Opens a dialog to select a destination to copy the currently selected files.
-
-
Move...
Opens a dialog to select a destination to move currently selected files.
Closes the window containing the menu, if the window is the last main window Geeqie will quit.
-
-
-
Quit
Quits the Geeqie application, if collections have been changed but not saved, the user will be prompted for confirmation.
-
-
-
Go menu
-
-
-
First Image
Goes tothe first image
-
Previous Image
Goes to the previous image
-
Next Image
Goes to the next image
-
Last Image
Goes to the last image
-
-
-
-
Select menu
-
-
Select all
Selects all files in the current list
-
Select none
Deselects all files
-
Invert Selection
Inverts current selection
-
Show marks
Displays marks in the file list
-
Mark n
Opens submenu for manipulating mark n
-
-
Toggle mark n
Set or unset mark n on selected files
-
Set mark n
Set mark n on selected files
-
Reset mark n
Unset mark n on selected files
-
Select mark n
Selects all files having mark n set
-
Add mark n
Adds files having mark n set to selection
-
Intersection with mark n
Intersects current selection and mark n
-
Unselect mark n
Removes files having mark n set from current selection
-
-
-
-
-
-
Edit menu
-
-
-
-
in <command name>...
This will execute the external command associated with <command name>, these can be changed edited on the Editors tab of the Option dialog.
-
-
Adjust
-
-
Rotate clockwise
Rotates the current image clockwise 90 degrees, does not modify the file on disk.
-
-
Rotate counterclockwise
Rotates the current image counterclockwise 90 degrees, does not modify the file on disk.
-
-
Rotate 180
Rotates the current image 180 degrees, does not modify the file on disk.
-
-
Mirror
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.
-
-
Flip
Swaps the top and bottom sides of the image, does not modify the file on disk.
-
-
Toggle grayscale
Shows images converted to grayscale, does not modify files on disk. It is applied to all files until toggled again.
-
-
Original state
Removes all effects applied through the Adjust menu, reverting image to its original state.
-
-
-
-
-
Properties
Opens a Properties Window for the currently selected files.
Opens a dialog with utilities to manage cached thumbnails and keywords data.
-
-
Set as wallpaper
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 fit to window; when zoom is set to fit to window, the image will be scaled to fill the root window.
-
-
-
View menu
-
-
-
-
View in new window
Opens selected image in its own window
-
-
Zoom
-
-
Zoom in
Increases the zoom by one increment, resulting in a larger image.
-
-
Zoom out
Decreases the zoom by one increment, resulting in a smaller image.
-
-
Zoom to fit
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 Image tab of the preferences dialog.
-
-
Fit Horizontally
Adjusts the zoom so image height fit within the display pane.
-
-
Fit Vertically
Adjusts the zoom so image width fit within the display pane.
-
-
Zoom n:m
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.
-
-
-
-
Connected zoom
Actions in this menu are identical to those in Zoom menu, but apply to all images displayed in splitted view.
-
-
Split
-
-
Horizontal
Splits main image view in two horizontal panes.
-
Vertical
Splits main image view in two vertical panes.
-
Quad
Splits main image view in four panes.
-
Single
Reverts to normal view mode (one image).
-
-
-
-
Thumbnails
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.
-
-
List
Changes the file list to display files in list format.
-
-
Icons
Changes the file list to display files as icons.
-
-
View Directory as
-
-
List
Set the folder view mode to list.
-
Tree
Set the folder view mode to tree.
-
-
-
-
Image Overlay
Displays Image Overlay information box (OSD), use twice to add histogram to it.
-
Histogram channels
Switches channels displayed in the histogram (red, green, blue, RGB, value, maximum value).
-
Histogram log mode
Toggles between linear and logarithmical histogram.
-
-
Full screen
Toggles the full screen window display.
-
-
Float file list
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.
-
-
Hide file list
Toggles visibility of the menu bar, tool bar, status bar, and file lists.
-
-
Hide toolbar
Toggles visibility of the tool bar. A check appears next to this item when the tool bar is not visible.
-
-
Keywords
Toggles display of the Keywords sidebar.
-
-
Exif data
Toggles display of the EXIF sidebar.
-
-
Sort manager
Toggles display of the Sort Manager sidebar.
-
-
Toggle slideshow
Begins or ends a slide show, the slide show status is displayed in the status bar.
-
-
Pause slideshow
Pauses a slide show, the slide show status is displayed in the status bar.
-
-
Refresh
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.
-
-
-
Help menu
-
-
-
-
Contents
Opens the Geeqie user manual in a new browser window.
-
-
Keyboard shortcuts
Displays a window listing the default keyboard shortcuts.
-
-
Release notes
Displays a window containing the release notes for the version of Geeqie in use.
-
-
About
Opens a window containing the Geeqie version, credits, website, and email contact information.
-
-
Log window
Opens the log window, mostly used for debugging purposes.
-
-
-
Tear off menus
-
-
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.
-
-
Keyboard shortcuts
-
-
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 Keyboard Shortcuts.
-
-
Changing the main window menu bar keyboard shortcuts
-
-
The keyboard shortcuts associated with the menu bar items can be changed by editing the accels file located in the Geeqie configuration folder while the Geeqie application is not running:
-
-
($HOME)/.geeqie/accels
-
-
-
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:
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 Q key will result in this line:
-
-
(gtk_accel_path "<main>/File/Quit" "q")
-
-
-
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:
-
-
-
-
-
-
-
-
-
-
Key
-
-
-
-
Text to use in accels file
-
-
-
-
-
-
-
-
Shift
-
-
-
-
<shift>
-
-
-
-
-
-
Ctrl
-
-
-
-
<control>
-
-
-
-
-
-
Alt
-
-
-
-
<alt>
-
-
-
-
-
-
-
Modifiers can be combined, for example in the exit line above, the text would be “<control><shift>q” to set the exit shortcut to Ctrl + Shift + Q.
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).
-
-
To select a folder with the keyboard, move the focus to the desired folder and press the SpaceBar or Enter key.
-
-
Moving around within a folder
-
-
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.
-
-
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.
-
-
Going home
-
-
To change to your home folder, click the Home button in the tool bar.
-
-
Direct path entry
-
-
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.
-
-
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.
-
-
Stepping through images sequentially
-
-
To change the displayed image to next or previous one within the same folder, use the respective PageDown and PageUp keys. The mouse can also be used to change the image by clicking the image display with the respective primary and middle buttons.
-
-
To change to beginning or end of the image list, use the respective Home or End keys.
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.
-
-
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.
-
-
Progress Bar
-
-
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.
-
-
Sort method
-
-
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.
-
-
-
Name
Images are sorted by file name.
-
Number
Images are sorted by natural numerical order, such that, for example, 9_name.jpg will be listed before 10_name.jpg.
-
Date
Images are sorted by file date on disk.
-
Size
Image are sorted by file size on disk.
-
Ascending
Toggles between increasing and decreasing sort order. A check will appear next to this entry to indicate ascending sort order.
-
-
-
File list
-
-
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.
-
-
Image Details
-
-
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.
-
-
Zoom
-
-
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.
-
-
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).
This section describes the options presented under the Advanced Tab of the preferences dialog.
-
-
Full Screen
-
-
-
Location
-
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.
-
-
Stay above other windows
-
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.
-
-
Smooth image flip
-
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.
-
-
Disable screen saver
-
This option will execute xscreensaver-command --deactivate once per minute to avoid the screen saver from activating when Geeqie is displayed full screen.
-
-
-
-
Overlay Screen Display
-
-
-
Always show image overlay at startup
-
Enable this to have the image overlay info displayed by default
-
-
Image overlay template
-
Overlay info is customizable through this template
-
Overlay info format string syntax is: %tag[:max_length][:extra]%
-
-
-
-
-
-
Tag
Replaced by
-
name
Filename of the picture
-
collection
Name of the collection
-
number
Current number of image in the list
-
total
Total number of images
-
date
File date
-
size
File size
-
width
Image width
-
height
Image height
-
res
Image resolution
-
keywords
Image keywords from metadata
-
comment
Image comment from metadata
-
-
-
-
To access exif data use the exif name, for example: %Exif.Photo.DateTimeOriginal% to get the date of the original shot
-
-
Pre-formatted exif data is also available:
-
-
-
-
-
Tag
Replaced by exif data
-
-
formatted.Camera
Camera and sofware name
-
formatted.DateTime
Image Date
-
formatted.ShutterSpeed
Shutter speed in seconds (ie. 1/60s)
-
formatted.Aperture
Aperture (ie. f5.6)
-
formatted.ExposureBias
Exposure bias (ie. +0.3)
-
formatted.ISOSpeedRating
ISO sensitivity (ie. 100)
-
formatted.FocalLength
Focal length
-
formatted.FocalLength35mmFilm
Focal length 35mm
-
formatted.SubjectDistance
Subject distance
-
formatted.Flash
Flash
-
formatted.Resolution
Resolution
-
formatted.ColorProfile
Color profile
-
-
-
-
- You can limit the length of displayed data using :number notation:
- %formatted.Camera:20% will truncate the displayed data to 20 characters
- and will add 3 dots at the end to denote the truncation.
-
-
- If two or more variables are connected with the |-sign, it prints available
- variables with a separator:
- %formatted.ShutterSpeed%|%formatted.ISOSpeedRating%|%formatted.FocalLength%
- could show:
- "1/20s - 400 - 80 mm"
- or
- "1/200 - 80 mm" if there's no ISO information in the Exif data.
-
-
-
- If a line is empty, it is removed.
- This allows to add lines that totally disappear when no data is available.
-
-
-
- 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.
-
-
-
Examples:
-
-
%name:<i>*</i>\n%
name is displayed in italics ended with a newline
-
%size:\n%
size is displayed with a newline at end
-
%formatted.ISOSpeedRating:ISO *%
ie. "ISO 100"
-
Collection <b>*</b>\n
display collection name in bold prefixed by "Collection " and a newline is appended
-
-
-
-
-
Help button
-
Show syntax help
-
-
Defaults button
-
Restore default image overlay template
-
-
-
-
-
-
Delete
-
-
-
Confirm file delete
-
Prompts for confirmation before deleting files.
-
-
Enable Delete key
-
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.
-
-
Safe Delete
-
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.
-
Note: Files moved to the Safe Delete folder are prefixed with a six digit number in the format: nnnnnn_FILENAME
- This is used by the delete feature to distinguish which files to remove first when clearing space for new files.
- The digit counter increments with each deleted file.
-
-
Folder
-
The location of the folder used by the Safe Delete feature.
-
-
Maximum size
-
The size to use for the Safe Delete folder, in megabytes. Note that setting this value to 0 (zero) will disable any limit.
-
-
Clear button
-
Removes all files contained in the Safe Delete folder.
-
-
View button
-
Changes the Geeqie main window to display the contents of the Safe Delete folder.
-
-
-
-
Behavior
-
-
-
Rectangular selection in icon view
-
Enable this to change the selection method used when selecting multiple items in an icon view.
-
-
Descend folders in tree view
-
-
This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.
-
Note: Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.
-
-
-
Show date in directories list view
-
Enable this to display directory modification date along its name in the list view
-
-
In place renaming
-
When renaming a single file, this will allow the rename entry to appear directly over the original filename.
-
-
Show "Copy path" menu item
-
Enable this option to show a "Copy path" menu item in applicable menus.
-
This allows to copy path to files or directories to the clipboard, names are enclosed with double quotes
- and separated by space.
-
-
-
Open recent list maximum size
-
This is the number of entries saved in the recent open file list.
-
-
Drag'n drop icon size
-
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.
-
-
-
-
Navigation
-
-
-
Progressive keyboard scrolling
-
This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.
-
-
Mouse wheel scrolls image
-
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.
-
-
Home button path
-
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.
-
-
Use current
-
Pressing this button will set the Home button path to the current open directory.
-
-
-
-
Miscellaneous
-
-
-
-
Store metadata and cache files in source image's directory
-
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 ".metadata". When the image source folder cannot be written, Geeqie falls back to saving the medata in "$HOME/.geeqie/metadata".
-
-
Store keywords and comments as XMP tags in images files
-
When enabled, Geeqie attempts to store keywords and comments as XMP tags in the image file itself. Obviously, this will modify the concerned files.
-
-
Custom similarity threshold
-
This setting is used by the compare method “similarity (custom)”, located in the Find Duplicates window.
-
-
-
Image loading and caching
-
-
-
-
Offscreen cache size
-
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.
-
Note: This setting controls the amount of memory for each image window.
-
-
-
Decoded image cache size
-
This is the cache size in megabytes used by Geeqie to store decoded images.
-
-
Image read buffer size
-
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.
-
-
Image idle loop read count
-
This is for fine tuning, do not modify if you don't know what it does.
-
-
-
-
Color profiles
-
-
Here one can defined color profiles to use.
-
-
-
Type
-
Either input color profile or screen color profile.
-
Menu name
-
Name of the menu entry corresponding to the color profile.
-
File
-
Path to the color profile file.
-
-
-
Debugging
-
-
-
Debug level
-
This defines the verbosity of debug info sent to console and log window (0 disables the debug output).
This section describes the options presented under the Editors Tab of the preferences dialog.
-
-
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 Ctrl + 1 through Ctrl + 0, which correspond to lines one through ten in the preferences dialog.
-
-
-
Menu name
-
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 Command Line field.
-
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.
-
-
-
-
Command Line
-
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 “command %f”).
-
-
-
-
-
-
-
-
-
-
Macro
-
-
-
-
Description
-
-
-
-
-
-
-
%f
-
-
-
-
Inserts list of selected files, may occur only once.
-
-
-
-
-
-
%p
-
-
-
-
Command is executed once for each selected file, may occur multiple times.
-
-
-
-
-
-
%v
-
-
-
-
Display the result of the command in an output window. Must occur as the first two characters, or immediately after the “%w” macro.
-
-
-
-
-
-
%V
-
-
-
-
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.
-
-
-
-
-
-
%w
-
-
-
-
Prevent full screen from deactivating when command is executed. Must occur as the first two characters.
-
-
-
-
-
%%
-
-
-
-
This will be replaced by one '%'. This is the way to escape '%'.
-
-
-
-
-
%d
-
-
-
-
This only makes sense for external commands like copy or move as this is replaced by the destination.
-
-
-
-
-
-
-
-
-
-
Help button
-
Displays reference list of the supported command macros.
-
-
Defaults button
-
Resets all commands to the default settings, discarding any customizations made by the user.
This section describes the options presented under the Filtering Tab of the preferences dialog.
-
-
Filters
-
-
-
Show hidden files or folders
-
Enables the display of hidden files and folders, also known as dot files.
-
-
Show dot directory
-
Enables the display of the current directory as a dot in the directories views. It may be useful for some drag'n'drop operations.
-
-
Case sensitive sort
-
Files and folders are sorted such that upper case letters occur before lower case letters.
-
Enabled result: A, B, C, a, b, c
- Disabled result: A, a, B, b, C, c
-
-
-
Disable file filtering
-
Enable this to allow Geeqie to list all files, even those that do not contain images.
-
-
-
-
Grouping sidecar extensions
-
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.
-
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).
-
-
File types
-
-
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 (.).
-
-
Note: Unlike all other options in the dialog, filter list changes are applied immediately.
-
-
-
-
Add button
-
Adds a new blank line to the filter list, change the parameters to match the desired file type.
-
-
Remove button
-
Removes the selected line from the filter list.
-
-
Defaults button
-
Resets the filter list to the default values, discarding any customizations made by the user.
This section describes the options presented under the General Tab of the preferences dialog.
-
-
Startup
-
-
-
Restore folder on startup
-
Enabling this will cause Geeqie to initially open to the specified folder.
-
-
Use Current
-
Activate this button to change the setting to the current folder.
-
-
Use last path
-
When checked, Geeqie will recall the last path used on startup.
-
-
-
-
Thumbnails
-
-
-
Size
-
Selects the size of the thumbnails displayed throughout Geeqie, dimensions are width by height in pixels.
-
-
Quality
-
Selects the method to use when scaling an image down for thumbnails.
-
-
Nearest
Fastest scaler, but results in poor thumbnail quality.
-
Tiles
Thumbnail results are very close to bilinear, with better speed.
-
Bilinear
High quality results, moderately fast.
-
Hyper
Slowest scaler, sometimes gives better results than bilinear.
-
-
-
-
Cache thumbnails
-
Enable this to save thumbnails to disk, subsequent requests for a thumbnail will be faster. Thumbnails are cached into ($HOME)/.geeqie/thumbnails. Refer to Thumbnails Reference for details.
-
-
Use shared thumbnail cache
-
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
-
-
Cache thumbnails into .thumbnails
-
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 .thumbnails. When the image source folder cannot be written, Geeqie falls back to saving the thumbnail in the user's home folder.
-
-
Faster jpeg thumbnailing
-
This will speed up thumbnails generation in some cases, but may reduce the quality
-
-
Use EXIF thumbnails when available
-
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.
-
-
Use xvpics thumbnails when found
-
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 .xvpics. Enabling this option will allow Geeqie to read thumbnails saved in the xvpics format.
-
Note: Support for xvpics is read only, Geeqie can not generate thumbnails in this format.
-
-
-
Slide show
-
-
-
Delay between image change
-
Specifies the delay between images for slide shows, in seconds.
-
-
Random
-
When enabled, slide show images will appear in random order.
-
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.
-
-
Repeat
-
When enabled, slide shows will continue at the beginning after the last image is displayed.
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:
-
-
-
-($HOME)/.geeqie/geeqierc
-
-
-
-
lazy_image_sync: [true | false]: 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.
-
-
display_dialogs_under_mouse: [true | false]: Enabling this will cause new dialogs to initially position themselves such that they are under the current mouse position.
-
-
scroll_reset_method: value: This will set the method used to set the scroll position, or visible region of a new image, value can be:
-
-
0: Move to upper left corner.
- 1: Center image.
- 2: Maintain same visible region as previous image, if possible.
-
-
dither_quality: Set the quality when dithering images on displays with a limited color pallet:
-
-
0: No dithering
- 1: Normal
- 2: Best
-
-
Find Duplicates window
-
-
Ctrl + Shift + [Right Mouse click]: Use this to display a dialog containing the data stored for the clicked image file. This is usually only useful for debugging purposes.
This section describes the options presented under the Image Tab of the preferences dialog.
-
-
Zoom
-
-
-
Quality
-
Selects the method used to scale the size of an image.
-
-
-
Nearest
Fastest scaler, but results in poor image quality.
-
Tiles
Results are somewhat close to bilinear, with better speed.
-
Bilinear
High quality results, moderately fast.
-
Hyper
Slowest scaler, sometimes gives better results than bilinear.
-
-
-
-
Two pass zooming
-
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.
-
-
Allow enlargement of image for zoom to fit
-
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”.
-
-
Limit image size when autofitting
-
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.
-
-
-
Zoom increment
-
Adjusts the step size when zooming in or out on an image. This value corresponds to the percentage of the original image.
-
-
-
-
Zoom control
-
-
-
When new image is selected
-
This controls the behavior of the zoom setting when changing the displayed image.
-
-
-
Zoom to original size
The new image is set to it's original size.
-
Fit image to window
The new image's zoom is changed so that the image will fit within the current view area.
-
Leave zoom at previous setting
The zoom setting is unchanged, the new image will be scaled the same as the previous image.
-
-
-
-
-
Scroll control
-
-
-
Scroll reset method
-
This controls the scroll initial position when changing the displayed image.
-
-
-
Top left
The new image is displayed from top left corner.
-
Center
The new image is centered
-
No change
The new image is positionned as the previous one, whenever possible.
-
-
-
-
-
Appearance
-
-
-
Custom border color
-
Enable this to draw the image background (the area around the image) in the specified color.
-
Border color
-
Use this color chooser to define the color to use as image background.
-
-
-
Note: You may use Limit image size when autofitting option to keep a border around the image in fullscreen mode.
-
-
Convenience
-
-
-
Refresh on file change
-
Geeqie will monitor currently active images and folders for changes in their modification time, and update the display if it changes.
-
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.
-
-
-
Preload next image
-
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.
-
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.
-
-
Auto rotate image using EXIF information
-
Auto rotates images based on data stored in images that include EXIF data.
This section describes the options presented under the Windows Tab of the preferences dialog.
-
-
State
-
-
-
Remember window positions
-
This will maintain windows size and position between Geeqie sessions.
-
-
Remember tool state
-
This will maintain the tool window state between Geeqie sessions.
-
-
-
Size
-
-
-
-
Fit window to image when tools are hidden/floating
-
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.
-
-
Limit size when auto-sizing window
-
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.
-
-
-
Window Layout
-
-
The Geeqie main window consists of three main panes, their position and order can be changed here. The first four selections represent the basic layout of the main window. The numbers within each selection represent the order of the pane content.
-
The order of the content can be changed by dragging the Tools, Files, or Image with the mouse to the desired location within the list.
The image properties window is a dialog that displays various information about a file.
-
-
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.
-
-
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.
-
-
Image preview
-
-
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.
-
-
General tab
-
-
This displays information about the active file. It includes:
-
-
-
File attributes
-
Modification date and time, size, owner, group, and permissions.
-
-
Image attributes
-
Dimensions, uncompressed size, file or mime type, and existence of an alpha channel.
-
-
Compress ratio
The percentage of file size compared to the size of the image when decoded into memory.
-
-
-
Keywords tab
-
-
The keywords tab contains the same information that is in the Keywords sidebar, please refer to the Keywords Sidebar page for details.
-
-
EXIF tab
-
-
The EXIF tab contains the same information that is in the EXIF sidebar, please refer to the EXIF Sidebar page for details.
An image window is a window that displays only the image.
-
-
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.
-
-
The image pane contained in an image window behaves and operates similar to the image pane of a Main Window. The keyboard shortcuts are the same, and the context menu is the same except “Hide file list” is replaced by “Close window”. The slide show and full screen functions are also available.
-
-
Navigation
-
-
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 PageDown and PageUp keys. In addition, all navigation methods for the mouse and keyboard are similar to that of the image pane of a Main Window.
-
-
Changing the image
-
-
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:
-
-
-
One or more files
-
The image window will display the first image; the list of dropped images can be navigated similar to a main window's image pane.
-
-
One or more folders
-
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.
-
-
Image from a collection
-
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.
-
-
-
Changing the image window by dropping a new item onto it will cause the previous list of images or linked collection to be discarded.
-
-
To update the image display in the event that the source file has changed, press the R key.
-
-
Information and histogram Overlay
-
-
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.
-
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.
-
Overlay info is customizable through Image Overlay Template option in Advanced tab in Preferences dialog.
This window proposes alternative views of the current directory and its children.
- You can pan the view as you pan an image in normal view mode, using left mouse button and drag.
-
A primary mouse button click on any image will display informations about the image. Secondary mouse button will show a context menu.
-
-
Note: The pan view recursively visits each folder under the specified folder, so be careful it can eat a lot of ressources.
-
-
-
Select a folder
-
-
Location
Set the top folder.
-
-
-
Choose a view mode
-
A select box let you choose among different view modes:
-
-
Timeline
Shows images grouped by date.
-
Calendar
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.
-
Folders
Show images grouped by folder. Each box represents a folder. Parent and children folders are shown as boxes enclosing other boxes.
-
Folders (flower)
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.
-
Grid
All images are shown on a grid.
-
-
-
How each image should be represented
-
Another select box let you choose the representation of each image:
-
-
Dots
Each image is represented by a dot.
-
No images
Each image is represented by a square box.
-
Small thumbnails
Each image is represented by a small thumbnail.
-
Normal thumbnails
Each image is represented by a normal thumbnail.
-
Large thumbnails
Each image is represented by a large thumbnail.
-
1:10 (10%)
Each image is represented by reduced image (1/10 of the original's dimensions).
-
1:4 (25%)
Each image is represented by reduced image (1/4 of the original's dimensions).
-
1:3 (33%)
Each image is represented by reduced image (1/3 of the original's dimensions).
-
1:2 (50%)
Each image is represented by reduced image (1/2 of the original's dimensions).
-
1:1 (100%)
The original image is shown at its normal dimensions.
-
-
-
Find
-
At the bottom of the window:
-
-
Find button
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.
To print an image press Shift + P or select Print from the File menu.
-
-
The print dialog includes tabs that group related printing options, a preview pane, and a Print and Cancel button.
-
-
Layout tab
-
-
-
Source
-
-
This selects the group of images to use for print output.
-
-
Image
The file with the focus.
-
Selection
The files selected in the main window.
-
All
All files listed in the main window.
-
-
-
-
Layout
-
Select one image per page, or a Proof sheet that will print multiple images per page.
-
-
Image size
When print one image per page, the size of the image in relation to the available print area.
-
Proof size
When printing a Proof sheet, the size of each image in Units (see Paper tab).
-
-
-
-
-
Text tab
-
-
-
Name
Include the file name below each image.
-
-
Path
Include the full path of the file below each image.
-
-
Date
Include the file date below each image.
-
-
Size
Include the file size below each image.
-
-
Dimensions
Include the source image's pixel width and height below each image.
-
-
Font size
The font size to use for the text description of each image, in points.
-
-
-
Paper tab
-
-
-
Format
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.
-
-
Size
The size of the selected paper format, in Units (below). These numbers can be changed when the paper Format is Custom.
-
-
Units
Select the units for Geeqie to use when conveying measurements of length for paper size, margins, and images sizes to the user.
-
-
Orientation
Select portrait or landscape print output.
-
-
Margins
These values specify the size of the paper edges not to be included in the print region, in Units (above).
-
-
-
Printer tab
-
-
-
Destination
-
Use this to select the destination of the print output.
-
-
Default printer
Prints to the system default printer.
-
Custom printer
Prints to the printer using the command defined in Custom printer (below).
-
Postscript file
Writes using the postscript format to named File (below).
-
Image file
Writes using the selected File format (below) to named File (below).
-
-
-
-
Custom printer
-
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.
-
-
File
-
The file to use for output when Destination is Postscript file or Image file.
-
-
File format
-
The image format to use when Destination is Image file.
-
-
DPI
-
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.
-
-
-
Preview
-
-
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.
-
-
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.
-
-
The size of the preview can be changed using the three zoom buttons located below the preview.
-
-
The preview includes several reference lines that are not included in the final print:
-
-
-
Reference grid
-
Light gray lines that form a grid over the entire page, the spacing between these lines is dependent on the current measurement unit:
-
-
Inch
1 inch.
-
Points
72 points.
-
Centimeters or Millimeters
1 centimeter.
-
-
-
-
Margins
-
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.
-
-
Proof sheet grid
-
When the layout is set to Proof sheet, each proof location is indicated with a red rectangle.
-
-
-
-
Remember print settings
-
-
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.
-
-
Print button
-
-
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.
-
-
Cancel button
-
-
Activate this button to close the print dialog, no printing will be performed.
These are the command line options available to Geeqie:
-
-
-
-
-
-
-
-
-
-
-
Short Option
-
-
-
-
Long Option
-
-
-
-
Description
-
-
-
-
-
-
-
+t
-
-
-
-
--with-tools
-
-
-
-
Show file list, menu, and statusbar.
-
-
-
-
-
-
-t
-
-
-
-
--without-tools
-
-
-
-
Hide file list, menu, and statusbar. Window contains image only.
-
-
-
-
-
-
-f
-
-
-
-
--fullscreen
-
-
-
-
Start up in fullscreen.
-
-
-
-
-
-
-s
-
-
-
-
--slideshow
-
-
-
-
Start up in slideshow mode.
-
-
-
-
-
-
-l
-
-
-
-
--list
-
-
-
-
Open collection window containing images specified on the command line. Any collections on the command line will also be appended to this collection.
-
-
-
-
-
-
-r
-
-
-
-
--remote
-
-
-
-
Send command line options to existing Geeqie process.
-
-
-
-
-
-
-rh
-
-
-
-
--remote-help
-
-
-
-
List command line options available to --remote.
-
-
-
-
-
-
-h
-
-
-
-
--help
-
-
-
-
Display brief command line option list.
-
-
-
-
-
-
-v
-
-
-
-
--version
-
-
-
-
Display version of Geeqie.
-
-
-
-
-
-
-
-
--debug
-
-
-
-
Enable Debug output to console.
-
-
-
-
-
-
-
Remote commands
-
-
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:
-
-
-
-
-
-
-
-
-
-
-
Short Option
-
-
-
-
Long Option
-
-
-
-
Description
-
-
-
-
-
-
-
-
-n
-
-
-
-
--next
-
-
-
-
Change main window to display next image.
-
-
-
-
-
-
-b
-
-
-
-
--back
-
-
-
-
Change main window to display previous image.
-
-
-
-
-
-
-
-
--first
-
-
-
-
Change main window to display first image.
-
-
-
-
-
-
-
-
--last
-
-
-
-
Change main window to display last image.
-
-
-
-
-
-
-f
-
-
-
-
--fullscreen
-
-
-
-
Toggle full screen mode of the main window.
-
-
-
-
-
-
-fs
-
-
-
-
--fullscreen-start
-
-
-
-
Start full screen mode for main window.
-
-
-
-
-
-
-fS
-
-
-
-
--fullscreen-stop
-
-
-
-
Stop full screen mode for main window.
-
-
-
-
-
-
-s
-
-
-
-
--slideshow
-
-
-
-
Toggle slide show for main window.
-
-
-
-
-
-
-ss
-
-
-
-
--slideshow-start
-
-
-
-
Start slide show for main window.
-
-
-
-
-
-
-sS
-
-
-
-
--slideshow-stop
-
-
-
-
Stop slide show for main window.
-
-
-
-
-
-
-sr<folder>
-
-
-
-
--slideshow-recurse<folder>
-
-
-
-
Start recursive slide show for <folder> in main window.
-
-
-
-
-
-
-d<n>
-
-
-
-
--delay=<n>
-
-
-
-
Set slide show delay to <n> seconds, range is 0.1 to 3600
Thumbnails and other cached data can be maintained from the dialog accessible by selecting Thumbnail maintenance from the Edit menu of the main window.
-
-
Geeqie thumbnail cache
-
-
The utilities listed here operate on the Geeqie caching mechanism. This also includes the data cached for the search and find duplicates utilities.
-
-
-
Clean up
-
Removes thumbnails and data for which the source image is no longer present, or has been modified since the thumbnail was generated.
-
-
Clear cache
-
Removes all thumbnails and data stored in the user's home folder: $HOME/.geeqie/thumbnails.
-
-
-
Shared thumbnail cache
-
-
The utilities listed here operate on the shared thumbnail mechanism.
-
-
-
Clean up
-
Removes thumbnails for which the source image is no longer present, or has been modified since the thumbnail was generated.
-
-
Clear cache
-
Removes all thumbnails stored in the user's home folder: $HOME/.thumbnails.
-
-
Create thumbnails
-
-
This utility will render thumbnails using the current thumbnail caching mechanism, as determined in preferences.
-
-
-
-
Render
-
Pre-render thumbnails for a specific folder, the utility has the following options:
-
-
Include subfolders
-
Enable to include all images contained in the subfolders of folder.
-
-
Store thumbnails local to source images
-
The generated thumbnails will be stored local to the source images, if you have the permissions to write to the folder containing the images.
-
-
-
-
Metadata
-
-
This utility operates on the data store for keywords and comments located in the user's home folder: $HOME/.geeqie/metadata.
-
-
-
Clean up
-
Removes keywords and comments for which the source image is no longer present.
-
-
-
File locations
-
-
The various file locations and their use are listed below. <HOME> refers to your home folder and <SOURCE> refers to the folder containing the image.
-
-
-
-
-
-
-
-
-
-
Folder or File name
-
-
-
-
Description
-
-
-
-
-
-
-
-
Thumbnails
-
-
-
-
-
-
<HOME>/.thumbnails
-
-
-
-
Shared thumbnail cache folder.
-
-
-
-
-
-
<HOME>/.geeqie/thumbnails
-
-
-
-
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.
-
-
-
-
-
-
<SOURCE>/.thumbnails
-
-
-
-
-
Local thumbnail cache folder.
-
-
-
-
-
-
Metadata (keywords and comments)
-
-
-
-
-
-
<HOME>/.geeqie/metadata
-
-
-
-
Metadata stored in user's home folder.
-
-
-
-
-
-
<SOURCE>/.metadata
-
-
-
-
Metadata stored local to source image. Requires option to be enabled in advanced preferences.
-
-
-
-
-
-
Collections
-
-
-
-
-
-
<HOME>/.geeqie/collections
-
-
-
-
Default location for Geeqie collections, collections in this folder will appear in the sort manager sidebar.
-
-
-
-
-
-
Preferences
-
-
-
-
-
-
<HOME>/.geeqie
-
-
-
-
Geeqie preferences folder.
-
-
-
-
-
-
<HOME>/.geeqie/geeqierc
-
-
-
-
Geeqie preferences rc file.
-
-
-
-
-
-
<HOME>/.geeqie/history
-
-
-
-
Historic data such as last several folders visited, bookmarks, and recently used collections. Also contains default print settings.
Note: This page only refers the Geeqie thumbnail caching mechanism, the shared thumbnail cache mechanism is not explained here.
-
-
Format
-
-
Thumbnails are stored in PNG image format. The thumbnail name is the name of the source image with “.png” appended.
-
-
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.
-
-
Location
-
-
Thumbnails are stored in:
-
-
($HOME)/.geeqie/thumbnails
-
-
The directory structure of the thumbnail cache duplicates the location of the source files, for example a source file with the name:
-
-
/path/to/image.jpg
-
-
will store the thumbnail in:
-
-
($HOME)/.geeqie/thumbnails/path/to/image.jpg.png
-
-
When thumbnails are to be stored local to the source file, the thumbnail will be placed in:
-
-
/path/to/.thumbnails/image.jpg.png
-
-
Local thumbnail caching is enabled with the option “Cache thumbnails into .thumbnails” on the General 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.
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.
-
-
When a cached thumbnail's width and height do not match the preferred size, the thumbnail is regenerated.
The EXIF sidebar displays EXIF data that is embedded in an image. The sidebar has two choices of data display, standard and advanced.
-
-
To toggle display of the The EXIF sidebar press Ctrl + E or select “Exif data” from the View menu.
-
-
EXIF: 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.
-
-
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.
-
-
Standard view
-
-
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.
-
-
Advanced view
-
-
The advanced view displays all tags that are present in the image. Unlike the standard view, data is displayed in raw format.
-
-
Customizing the standard view
-
-
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.
-
-
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.
The Keywords sidebar displays keywords and comments for the active image, and provides functions for editing them.
-
-
To toggle display of the Keywords sidebar press Ctrl + K or select “Keywords” from the View menu.
-
-
Keywords 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 Search window.
-
-
Comments is an area to associate a textual description to an image.
-
-
The sidebar is comprised of three sections: Keywords, Comments and a button bar.
-
-
Keywords
-
-
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.
-
-
The text entry 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 Enter will also separate keywords.
-
-
The favorite keywords list allows quick selection of commonly used keywords. A 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.
-
-
Comments
-
-
This text entry allows entering text to be associated with the active image.
-
-
The buttons
-
-
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.
-
-
-
-
-
Edit favorite keywords list
-
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.
-
-
Add keywords to selected files
-
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.
-
-
Add keywords to selected files, replacing existing ones
-
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.
-
-
Save comment now
-
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.
-
-
-
-
Favorite Keywords Dialog
-
-
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 Enter on the keyboard.
-
-
Activate OK to save the changes and close the dialog, Cancel will discard the changes and close the dialog.
The Sort Manager sidebar provides a convenient method to quickly sort many files into a set of folders or collections.
-
-
To toggle display of the Sort Manager press Ctrl + S or select “Sort manager” from the View menu.
-
-
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.
-
-
Folder view
-
-
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.
-
-
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.
-
-
Bookmark list
-
-
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.
-
-
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.
-
-
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.
-
-
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.
-
-
To remove an item from the list select “Remove” from it's context menu.
-
-
Copy, Move, and Link
-
-
These are the available operations to use on the active image, they should be self explanatory.
-
-
Add button
-
-
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.
-
-
Undo button
-
-
Activate this button to undo the last copy, move, or link operation. The undo function can only reverse the most recent operation.
-
-
Collection view
-
-
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.
-
-
Clicking or activating an item in the list will add the selected image to that collection.
-
-
Collection list
-
-
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.
-
-
A new empty collection can be added to the list by activating the Add button at the bottom of the sidebar.
-
-
Choosing the selection style
-
-
The images to add when activating a collection is determined by the selection style:
-
-
-
Add image
-
The visible image is added to the collection.
-
-
Add selection
-
All images selected in the file list will be added to the collection.
-
-
-
Add button
-
-
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.
-
-
Undo button
-
-
Activate this button to undo the last add operation. The undo function can only reverse the most recent operation.
-
-
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook.py
--- /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"""
+
+
+
+
+
+
+"""
+
+normalizedHeadingsXsl = u"""
+
+
+
+
+
+
+"""
+
+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(']*>')
+ db = r.sub(r'', db);
+
+ r = re.compile('')
+ db = r.sub(r'', db);
+
+ r = re.compile('\s*\s*[^<]*\s*\s*')
+ db = r.sub(r'\n', db);
+
+
+ db = db.replace("<__top_element__>", "<" + top + " id=\"" + name + "\">")
+ db = db.replace("", "")
+
+ open("docbook/" + name + ".xml", "w").write(db.encode('utf-8'))
+
+
+read_index()
+process_pages()
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/headingsNormalizer.about.txt
--- /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).
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/headingsNormalizer/headingsNormalizer.xsl
--- /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 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db.about.txt
--- /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.
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/LICENSE.txt
--- /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
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s02.html
--- /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 @@
+Features
This tool is designed to be embedded within an XSLT processing
+pipeline. html2html.xslt can be used in a custom
+stylesheet or integrated into a larger system. See Overriding.
Customizable
The output can be customized by the means of additonal markup in
+the XHMTL source. See the section on customization.
Creates outline structure
h1, h2, etc. are turned into nested
+section and title elements (as opposed to
+bridge heads).
Accepts a wide variety of XHTML
In particular, html2db.xsl automatically wraps naked item
+text (text that is not enclosed in a <p>)
+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.[1]
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s03.html
--- /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 @@
+Requirements
Familiarity with installing and running JAR files.
html2db.xsl might work with earlier versions of Java and Xalan, and
+it might work with other XSLT processors such as Saxon and
+xsltproc.
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s04.html
--- /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 @@
+License
This software is released under the Open Source Artistic License.
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s05.html
--- /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 @@
+Installation
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s06.html
--- /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 @@
+Usage
If your source files are in HTML, not XHTML, you may find the Tidy tool useful. This is a
+tool that converts from HTML to XHTML, and can be added to the front
+of your processing pipeline.
(If you need to process HTML and you don't know or can't figure out
+from context what a processing pipeline is, html2db.xsl 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.)
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s07.html
--- /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 @@
+Specification
An anchor within a hn element is attached to the enclosing section as an id attribute instead.
<a href="#name">
<link linkend="{$anchor-id-prefix}name">
<a href="url">
<ulink url="name">
<a name="mailto:address">
<email>address</email>
Tables
XHTML table support is minimal. html2db.xsl 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.
An XHTML table with a summary attribute
+generates a table, whose title is the value
+of that summary. An XHTML table without a
+summary generates an informaltable.
Any trs that contain ths are pulled to
+the top of the table, and placed inside a thead. Other
+trs are placed inside a tbody. This matches
+the commanon XHTML table pattern, where the first row is
+a header row.
Implicit Blocks
XHTML allows li, dd, and td
+elements to contain either inline text (for instance,
+<li>a list item</li>) or block structure
+(<li><p>a block</p></li>). The
+corresponding Docbook elements require block structure, such as
+para.
html2db.xsl provides limited support for wrapping naked text in
+these positions in para 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
+para. 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.
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 <li>some <b>bold</b>
+text</li>, leading to badly formatted output. Twhe
+workaround is to wrap troublesome content in explicit
+<p> tags.
Docbook Elements
Elements from the Docbook namespace are passed through as is.
+There are two ways to include a Docbook element in your XHTML
+source:
Global prefix
A fake Docbook namespace[2]
+
+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 footnote or
+glossterm, 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 Customization.)
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.
The source to this document
+illustrates both of these techniques.
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.xsl not to recognize it!
Output Processing Instructions
html2db.xsl 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 aonclick
+and target attributes in the HTML files that Docbook XSL
+creates to the same values they had in the input document.
<?html2db attribute="name" value="value"?>
Placed inside a link element to capture the value of the atarget and onclick attributes. name is the name of the attribute (target or onclick), and value is its value, with " and \ replaced by \" and \\, respectively.
<?html2db element="br"?>
Represents the location of an XHTML br element in the
+source document.
You can also include <?db2html?> 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).
[2] The fake
+Docbook namespace is urn:docbook. Docbook doesn't really
+have a namespace, and if it did, it wouldn't be this one. See Docbook namespace for a discussion of
+this issue.
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s08.html
--- /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 @@
+Customization
Prefixed to every id generated from <a name=>
+ and <a href="#">. 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
+ docid. where docid is a unique id
+ for each source file.
Sets the rowsep attribute on the generated table.[b]
[a] Note that the
+current implementation simply checks for the presence of any
+html2db processing instruction.
[b] Note that the current implementation simply checks for the presence of anyhtml2db processing instruction that begins with rowsep, and assumes the vlaue is 1.
Overriding the built-in templates
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 xsl:import element to import
+html2db.xsl.
The example.xsl stylesheet
+is an example customization layer. It recognizes the <div
+class="abstract"> and <p class="note">
+classes in the source for this document,
+and generates the corresponding Docbook elements.
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s09.html
--- /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 @@
+FAQ
The primary reason to use Docbook as an output 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:
Automatic Table-of-Contents generation
Automatic part, chapter, and section numbering.
Creation of single-page, multi-page, PDF, and WinHelp files from the same source document.
Navigation headers, footers, and metadata for multi-page HTML
+documents.
Link resolution and link target text insertion across multiple pages and numbered targets.
Figure, example, and table numbering, and tables of these.
Index and glossary tools.
Why write in XHTML?
Given that Docbook is so great, why not write in it?
Where there are not legacy concerns, Docbook is probably a better
+choice for structured or technical documentation.
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.
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
For example, at Laszlo,
+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.
Why not use an existing convertor?
This isn't the first (X)HTML to Docbook convertor. Why not use one
+of the exisitng ones?
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:
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
+maintained in XHTML.
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.
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.
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 section elements to represent
+h1h2 sequences, or table to
+represent tables with summary attributes.
I got this error. What does it mean?
Q. Fatal Error! The element type "br" must be terminated by the matching end-tag "</br>".
+
A. Your document is HTML, not XHTML. You need to fix it, or run it through Tidy first.
Q. My output document is empty except for the <?xml version="1.0" encoding="UTF-8"?> line.
A. The document is missing a namespace declaration. See the example for an example.
Q. Some of the headers and document sections are repeated multiple times.
A. The document has out-of-sequence headers, such as h1 followed by h3 (instead of h2). This won't work.
Q. Fatal Error! The prefix "db" for element "db:footnote" is not bound.
A. You haven't declared the db namespace prefix. See the example for an example.
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/ar01s10.html
--- /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 @@
+Implementation Notes
Improperly sequenced hn (for example
+h1 followed by h3, instead of
+h2) will result in duplicate text.
Limitations
The id attribute is only preserved for certain
+elements (at least hn, images, paragraphs, and
+tables). It ought to be preserved for all of them.
Only the very simplest table format is
+implemented.
Always uses compact lists.
The string matching for <?html2b
+class="classname"?> requires an exact match
+(spaces and all).
The implicit blocks 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.
Wishlist
Allow <html2db attribute-name="name"
+value="value"?> at any position, to set arbitrary
+Docbook attributes on the generated element.
Use different technique from the fake
+namespace prefix to name Docbook elements in the source, that
+preserves the XHTML validity of the source file. For example, an
+option transform <div class="db:footnote"> into
+<footnote>, or to use a processing attribute
+(<div><?html2db classname="footnote"?>).
Parse DC metadata from XHTML html/head/meta.
Add an option to use html/head/title instead of
+html/body/h1[1] for top title.
Allow an id on every element.
Add an option to translate the XHTML class into a
+Docbook role.
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.
Design Notes
The Docbook Namespace
html2db.xsl accepts elements in the "Docbook namespace" in XHTML
+source. This namespace is urn:docbook.
This isn't technically correct. Docbook doesn't really have a
+namespace, and if it did, it wouldn't be this one. RFC 3151 suggests
+urn:publicid:-:OASIS:DTD+DocBook+XML+V4.1.2:EN as the
+Docbook namespace.
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 html2db.xsl works with other versions of Docbook too, which would
+presumably have other namespaces. I think it's more useful to
+underspecify 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 more specific than that.
History
The original version of html2db.xsl was written by Oliver Steele, as part of the Laszlo Systems, Inc. documentation
+effort. We had a set of custom stylesheets that formatted and added
+linking information to programming-language elements such as
+classname and tagname, and added
+Table-of-Contents to chapter documentation and numbers examples.
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.)
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.
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.
This document is an example of html2db.xsl used in conjunction with
+the Docbook XSL stylesheets. The source
+file is an XHTML file with some embedded Docbook elements and
+processing instructions. html2db.xsl compiles it into a Docbook document, which can be used to generate
+this output file (which includes a Table of Contents), a chunked HTML file, a PDF, or other formats.
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/index.src.html
--- /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 @@
+html2db.xsl">
+]>
+
+
+This title is ignored
+
+
+
+
&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.
+
+
This document is an example of &html2db; used in conjunction with
+the Docbook XSL stylesheets. The source
+file is an XHTML file with some embedded Docbook elements and
+processing instructions. &html2db; compiles it into a Docbook document, which can be used to generate
+this output file (which includes a Table of Contents), a chunked HTML file, a PDF, or other formats.
+
+
Features
+
+
XSLT implementation
+
This tool is designed to be embedded within an XSLT processing
+pipeline. html2html.xslt can be used in a custom
+stylesheet or integrated into a larger system. See Overriding.
+
+
Customizable
+
The output can be customized by the means of additonal markup in
+the XHMTL source. See the section on customization.
+
+
Creates outline structure
+
h1, h2, etc. are turned into nested
+section and title elements (as opposed to
+bridge heads).
+
+
Accepts a wide variety of XHTML
+
In particular, &html2db; automatically wraps naked item
+text (text that is not enclosed in a <p>)
+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.
If your source files are in HTML, not XHTML, you may find the Tidy tool useful. This is a
+tool that converts from HTML to XHTML, and can be added to the front
+of your processing pipeline.
+
+
(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.)
+
+
Specification
+
+
XHTML Elements
+
code/i stands for "an i element
+immediately within a code element". This notation is
+from XPath.
+
+
XHTML elements must be in the XHTML Transitional namespace,
+http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd.
+
+
+
+
XHTML
+
Docbook
+
Notes
+
+
+
+
b, i, em, strong
+
emphasis
+
The role attribute is the original tag name
+
+
+
+
dfn
+
glossitem, and also primaryindexterm
+
+
+
+
code/i, tt/i, pre/i
+
replaceable
+
In practice, i within a monospace content is usually used to mean replaceable text. If you're using it for emphasis, use em instead.
An anchor within a hn element is attached to the enclosing section as an id attribute instead.
+
+
+
+
<a href="#name">
+
<link linkend="{$anchor-id-prefix}name">
+
+
+
+
<a href="url">
+
<ulink url="name">
+
+
+
+
<a name="mailto:address">
+
<email>address</email>
+
+
+
+
+
Tables
+
+
XHTML table 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.
+
+
An XHTML table with a summary attribute
+generates a table, whose title is the value
+of that summary. An XHTML table without a
+summary generates an informaltable.
+
+
Any trs that contain ths are pulled to
+the top of the table, and placed inside a thead. Other
+trs are placed inside a tbody. This matches
+the commanon XHTML table pattern, where the first row is
+a header row.
+
+
Implicit Blocks
+
XHTML allows li, dd, and td
+elements to contain either inline text (for instance,
+<li>a list item</li>) or block structure
+(<li><p>a block</p></li>). The
+corresponding Docbook elements require block structure, such as
+para.
+
+
&html2db; provides limited support for wrapping naked text in
+these positions in para 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
+para. 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.
+
+
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 <li>some <b>bold</b>
+text</li>, leading to badly formatted output. Twhe
+workaround is to wrap troublesome content in explicit
+<p> tags.
+
+
Docbook Elements
+
+
Elements from the Docbook namespace are passed through as is.
+There are two ways to include a Docbook element in your XHTML
+source:
+
+
+
Global prefix
+
A fake Docbook namespace
The fake
+Docbook namespace is urn:docbook. Docbook doesn't really
+have a namespace, and if it did, it wouldn't be this one. See Docbook namespace for a discussion of
+this issue.
+
+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 footnote or
+glossterm, 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 Customization.)
+
+
+ ...
+
Some textand a footnote.
+]]>
+
+
Local namespace
+
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.
+
+
+
+ ...
+ ...
+]]>
+
+
+
The source to this document
+illustrates both of these techniques.
+
+
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!
+
+
+
Output Processing Instructions
+
+
&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 aonclick
+and target attributes in the HTML files that Docbook XSL
+creates to the same values they had in the input document.
+
+
+
<?html2db attribute="name" value="value"?>
+
Placed inside a link element to capture the value of the atarget and onclick attributes. name is the name of the attribute (target or onclick), and value is its value, with " and \ replaced by \" and \\, respectively.
+
+
<?html2db element="br"?>
+
Represents the location of an XHTML br element in the
+source document.
+
+
+
+
You can also include <?db2html?> 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).
+
+
+
Customization
+
XSLT Parameters
+
+
<xsl:param name="anchor-id-prefix" select="''/>
+
Prefixed to every id generated from <a name=>
+ and <a href="#">. 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
+ docid. where docid is a unique id
+ for each source file.
The default document root. This can be overridden by
+ <?html2db class="name"> within the
+ document itself, and defaults to article.
+
+
+
Processing instructions
+
Use the <?html2db?> processing instruction to
+customize the transformation of the XHTML source to Docbook:
+
+
+
+
Processing instruction
+
Content
+
Effect
+
+
+
+
<?html2db class="xxx"?>
+
body
+
Sets the output document root to xxx. Useful for
+translating to prefix, appendix, or chapter; the default is
+$document-root.
+
+
+
+
<?html2db class="simplelist"?>
+
ul
+
Creates a vertical simplelist.Note that the
+current implementation simply checks for the presence of any
+html2db processing instruction.
+
+
+
+
+
<?html2db rowsep="1"?>
+
[informal]table
+
Sets the rowsep attribute on the generated table.Note that the current implementation simply checks for the presence of anyhtml2db processing instruction that begins with rowsep, and assumes the vlaue is 1.
+
+
+
+
Overriding the built-in templates
+
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 xsl:import element to import
+html2db.xsl.
+
+
The example.xsl stylesheet
+is an example customization layer. It recognizes the <div
+class="abstract"> and <p class="note">
+classes in the source for this document,
+and generates the corresponding Docbook elements.
+
+
+
FAQ
+
Why generate Docbook?
+
The primary reason to use Docbook as an output 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:
+
+
+
Automatic Table-of-Contents generation
+
Automatic part, chapter, and section numbering.
+
Creation of single-page, multi-page, PDF, and WinHelp files from the same source document.
+
Navigation headers, footers, and metadata for multi-page HTML
+documents.
+
Link resolution and link target text insertion across multiple pages and numbered targets.
+
Figure, example, and table numbering, and tables of these.
+
Index and glossary tools.
+
+
+
Why write in XHTML?
+
+
Given that Docbook is so great, why not write in it?
+
+
Where there are not legacy concerns, Docbook is probably a better
+choice for structured or technical documentation.
+
+
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.
+
+
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
+
+
For example, at Laszlo,
+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.
+
+
Why not use an existing convertor?
+
+
This isn't the first (X)HTML to Docbook convertor. Why not use one
+of the exisitng ones?
+
+
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:
+
+
+
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
+maintained in XHTML.
+
+
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.
+
+
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.
+
+
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 section elements to represent
+h1h2 sequences, or table to
+represent tables with summary attributes.
+
+
+
I got this error. What does it mean?
+
+
Q. Fatal Error! The element type "br" must be terminated by the matching end-tag "</br>".
+
+
A. Your document is HTML, not XHTML. You need to fix it, or run it through Tidy first.
+
+
Q. My output document is empty except for the <?xml version="1.0" encoding="UTF-8"?> line.
+
A. The document is missing a namespace declaration. See the example for an example.
+
+
Q. Some of the headers and document sections are repeated multiple times.
+
A. The document has out-of-sequence headers, such as h1 followed by h3 (instead of h2). This won't work.
+
+
Q. Fatal Error! The prefix "db" for element "db:footnote" is not bound.
+
A. You haven't declared the db namespace prefix. See the example for an example.
+
+
+
+
+
Implementation Notes
+
+
Bugs
+
+
Improperly sequenced hn (for example
+h1 followed by h3, instead of
+h2) will result in duplicate text.
+
+
+
+
Limitations
+
+
The id attribute is only preserved for certain
+elements (at least hn, images, paragraphs, and
+tables). It ought to be preserved for all of them.
+
Only the very simplest table format is
+implemented.
+
Always uses compact lists.
+
The string matching for <?html2b
+class="classname"?> requires an exact match
+(spaces and all).
+
The implicit blocks 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.
+
+
+
+
+
+
+
Wishlist
+
+
Allow <html2db attribute-name="name"
+value="value"?> at any position, to set arbitrary
+Docbook attributes on the generated element.
+
+
Use different technique from the fake
+namespace prefix to name Docbook elements in the source, that
+preserves the XHTML validity of the source file. For example, an
+option transform <div class="db:footnote"> into
+<footnote>, or to use a processing attribute
+(<div><?html2db classname="footnote"?>).
+
+
Parse DC metadata from XHTML html/head/meta.
+
+
Add an option to use html/head/title instead of
+html/body/h1[1] for top title.
+
+
Allow an id on every element.
+
+
Add an option to translate the XHTML class into a
+Docbook role.
+
+
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.
+
+
Support
+
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 steele@osteele.com. 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.
+
+
+
+
+
+
Design Notes
+
The Docbook Namespace
+
&html2db; accepts elements in the "Docbook namespace" in XHTML
+source. This namespace is urn:docbook.
+
+
This isn't technically correct. Docbook doesn't really have a
+namespace, and if it did, it wouldn't be this one. RFC 3151 suggests
+urn:publicid:-:OASIS:DTD+DocBook+XML+V4.1.2:EN as the
+Docbook namespace.
+
+
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
+underspecify 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 more specific than that.
+
+
History
+
The original version of &html2db; was written by Oliver Steele, as part of the Laszlo Systems, Inc. documentation
+effort. We had a set of custom stylesheets that formatted and added
+linking information to programming-language elements such as
+classname and tagname, and added
+Table-of-Contents to chapter documentation and numbers examples.
+
+
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.)
+
+
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.
+
+
+
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/index.xml
--- /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 @@
+
+
+
+html2db.xsl
+
+
+
+
+ Oliver
+ Steele
+
+
+
+ 1
+ 2004-07-30
+
+
+ 1.0.1
+ 2004-08-01
+ Editorial changes to the
+ readme.
+
+
+ 2004-07-30
+
+
+Overview
+
+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.
+
+This document is an example of html2db.xsl used in conjunction with
+the Docbook XSL stylesheets. The source
+file is an XHTML file with some embedded Docbook elements and
+processing instructions. html2db.xsl compiles it into a Docbook document, which can be used to generate
+this output file (which includes a Table of Contents), a chunked HTML file, a PDF, or other formats.
+
+Features
+XSLT implementationThis tool is designed to be embedded within an XSLT processing
+pipeline. html2html.xslt can be used in a custom
+stylesheet or integrated into a larger system. See Overriding.CustomizableThe output can be customized by the means of additonal markup in
+the XHMTL source. See the section on customization.Creates outline structureh1, h2, etc. are turned into nested
+section and title elements (as opposed to
+bridge heads).Accepts a wide variety of XHTMLIn particular, html2db.xsl automatically wraps naked item
+textnaked item
+text (text that is not enclosed in a <p>)
+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.This feature is limited. See Implicit Blocks.)
+
+Requirements
+Java: JRE or JDK 1.3 or greater.Xalan 2.5.0.Familiarity with installing and running JAR files.
+
+html2db.xsl might work with earlier versions of Java and Xalan, and
+it might work with other XSLT processors such as Saxon and
+xsltproc.
+
+License
+This software is released under the Open Source Artistic License.
+
+Installation
+Install JRE 1.3 or higher.Install Xalan, if necessary.Download html2db-1.zip from http://osteele.com/sources/html2db-1.zip.Unzip html2db-1.zip.
+
+Usage
+Use Xalan to process an XHTML source file into a Docbook file:
+
+
+java org.apache.xalan.xslt.Process -XSL html2dbk.xsl -IN doc.html > doc.xml
+
+
+See index.src.html for an
+example of an input file.
+
+If your source files are in HTML, not XHTML, you may find the Tidy tool useful. This is a
+tool that converts from HTML to XHTML, and can be added to the front
+of your processing pipeline.
+
+(If you need to process HTML and you don't know or can't figure out
+from context what a processing pipeline is, html2db.xsl 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.)
+
+Specification
+
+XHTML Elements
+code/i stands for "an i element
+immediately within a code element". This notation is
+from XPath.
+
+XHTML elements must be in the XHTML Transitional namespace,
+http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd.
+
+XHTMLDocbookNotes
+b, i, em, strongemphasisThe role attribute is the original tag name
+dfnglossitem, and also primaryindexterm
+code/i, tt/i, pre/ireplaceableIn practice, i within a monospace content is usually used to mean replaceable text. If you're using it for emphasis, use em instead.
+pre, body/codeprogramlisting
+imginlinemediaobject/imageobject/imagedataIn an inline context.
+img[informal]figure/mediaobject/imageobject/imagedataIf it has a title attribute or db:title it's wrapped in a figure. Otherwise it's wrapped in an informalfigure.
+table[informal]tableXHTML table becomes Docbook table if it has a summary attribute; informaltable otherwise.
+ulitemizedlistBut see the processing instruction below.
+
+
+
+
+Links
+
Link TranslationXHTMLDocbookNotes
+<a name="name"><anchor id="{$anchor-id-prefix}name">An anchor within a hn element is attached to the enclosing section as an id attribute instead.
+<a href="#name"><link linkend="{$anchor-id-prefix}name">
+<a href="url"><ulink url="name">
+<a name="mailto:address"><email>address</email>
+
+
+Tables
+
+XHTML table support is minimal. html2db.xsl 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.
+
+An XHTML table with a summary attribute
+generates a table, whose title is the value
+of that summary. An XHTML table without a
+summary generates an informaltable.
+
+Any trs that contain ths are pulled to
+the top of the table, and placed inside a thead. Other
+trs are placed inside a tbody. This matches
+the commanon XHTML table pattern, where the first row is
+a header row.
+
+Implicit Blocks
+XHTML allows li, dd, and td
+elements to contain either inline text (for instance,
+<li>a list item</li>) or block structure
+(<li><p>a block</p></li>). The
+corresponding Docbook elements require block structure, such as
+para.
+
+html2db.xsl provides limited support for wrapping naked text in
+these positions in para 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
+para. 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.
+
+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 <li>some <b>bold</b>
+text</li>, leading to badly formatted output. Twhe
+workaround is to wrap troublesome content in explicit
+<p> tags.
+
+Docbook Elements
+
+Elements from the Docbook namespace are passed through as is.
+There are two ways to include a Docbook element in your XHTML
+source:
+
+Global prefixA fake Docbook namespacefake Docbook namespaceThe fake
+Docbook namespace is urn:docbook. Docbook doesn't really
+have a namespace, and if it did, it wouldn't be this one. See Docbook namespace for a discussion of
+this issue.
+
+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 footnote or
+glossterm, 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 Customization.)
+
+
+<html xmlns="http://www.w3.org/1999/xhtml"
+ xmlns:db="urn:docbook">
+ ...
+ <p>Some text<db:footnote>and a footnote</db:footnote>.</p>
+Local namespaceA 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.
+
+
+ ...
+ <articleinfo xmlns="urn:docbook">
+ <author>
+ <firstname>...</firstname>
+ ...
+
+
+The source to this document
+illustrates both of these techniques.
+
+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.xsl not to recognize it!
+
+
+Output Processing Instructions
+
+html2db.xsl 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 aonclick
+and target attributes in the HTML files that Docbook XSL
+creates to the same values they had in the input document.
+
+<?html2db attribute="name" value="value"?>Placed inside a link element to capture the value of the atarget and onclick attributes. name is the name of the attribute (target or onclick), and value is its value, with " and \ replaced by \" and \\, respectively.<?html2db element="br"?>Represents the location of an XHTML br element in the
+source document.
+
+You can also include <?db2html?> 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).
+
+
+Customization
+XSLT Parameters
+<xsl:param name="anchor-id-prefix" select="''/>Prefixed to every id generated from <a name=>
+ and <a href="#">. 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
+ docid. where docid is a unique id
+ for each source file.<xsl:param name="document-root" select="'article'"/>The default document root. This can be overridden by
+ <?html2db class="name"> within the
+ document itself, and defaults to article.
+
+Processing instructions
+Use the <?html2db?> processing instruction to
+customize the transformation of the XHTML source to Docbook:
+
+Processing instructionContentEffect
+<?html2db class="xxx"?>bodySets the output document root to xxx. Useful for
+translating to prefix, appendix, or chapter; the default is
+$document-root.
+<?html2db class="simplelist"?>ulCreates a vertical simplelist.Note that the
+current implementation simply checks for the presence of any
+html2db processing instruction.
+<?html2db rowsep="1"?>[informal]tableSets the rowsep attribute on the generated table.Note that the current implementation simply checks for the presence of anyhtml2db processing instruction that begins with rowsep, and assumes the vlaue is 1.
+
+
+Overriding the built-in templates
+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 xsl:import element to import
+html2db.xsl.
+
+The example.xsl stylesheet
+is an example customization layer. It recognizes the <div
+class="abstract"> and <p class="note">
+classes in the source for this document,
+and generates the corresponding Docbook elements.
+
+
+FAQ
+Why generate Docbook?
+The primary reason to use Docbook as an output 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:
+
+Automatic Table-of-Contents generationAutomatic part, chapter, and section numbering.Creation of single-page, multi-page, PDF, and WinHelp files from the same source document.Navigation headers, footers, and metadata for multi-page HTML
+documents.Link resolution and link target text insertion across multiple pages and numbered targets.Figure, example, and table numbering, and tables of these.Index and glossary tools.
+
+Why write in XHTML?
+
+Given that Docbook is so great, why not write in it?
+
+Where there are not legacy concerns, Docbook is probably a better
+choice for structured or technical documentation.
+
+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.
+
+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
+
+For example, at Laszlo,
+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.
+
+Why not use an existing convertor?
+
+This isn't the first (X)HTML to Docbook convertor. Why not use one
+of the exisitng ones?
+
+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:
+
+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
+maintained in XHTML.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.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.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 section elements to represent
+h1h2 sequences, or table to
+represent tables with summary attributes.
+
+I got this error. What does it mean?
+Q. Fatal Error! The element type "br" must be terminated by the matching end-tag "</br>".
+A. Your document is HTML, not XHTML. You need to fix it, or run it through Tidy first.Q. My output document is empty except for the <?xml version="1.0" encoding="UTF-8"?> line.A. The document is missing a namespace declaration. See the example for an example.Q. Some of the headers and document sections are repeated multiple times.A. The document has out-of-sequence headers, such as h1 followed by h3 (instead of h2). This won't work.Q. Fatal Error! The prefix "db" for element "db:footnote" is not bound.A. You haven't declared the db namespace prefix. See the example for an example.
+
+
+Implementation Notes
+
+Bugs
+Improperly sequenced hn (for example
+h1 followed by h3, instead of
+h2) will result in duplicate text.
+
+
+Limitations
+The id attribute is only preserved for certain
+elements (at least hn, images, paragraphs, and
+tables). It ought to be preserved for all of them.Only the very simplest table format is
+implemented.Always uses compact lists.The string matching for <?html2b
+class="classname"?> requires an exact match
+(spaces and all).The implicit blocks 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.
+
+
+
+
+Wishlist
+Allow <html2db attribute-name="name"
+value="value"?> at any position, to set arbitrary
+Docbook attributes on the generated element.Use different technique from the fake
+namespace prefix to name Docbook elements in the source, that
+preserves the XHTML validity of the source file. For example, an
+option transform <div class="db:footnote"> into
+<footnote>, or to use a processing attribute
+(<div><?html2db classname="footnote"?>).Parse DC metadata from XHTML html/head/meta.Add an option to use html/head/title instead of
+html/body/h1[1] for top title.Allow an id on every element.Add an option to translate the XHTML class into a
+Docbook role.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.
+
+
+Design Notes
+The Docbook Namespace
+html2db.xsl accepts elements in the "Docbook namespace" in XHTML
+source. This namespace is urn:docbook.
+
+This isn't technically correct. Docbook doesn't really have a
+namespace, and if it did, it wouldn't be this one. RFC 3151 suggests
+urn:publicid:-:OASIS:DTD+DocBook+XML+V4.1.2:EN as the
+Docbook namespace.
+
+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 html2db.xsl works with other versions of Docbook too, which would
+presumably have other namespaces. I think it's more useful to
+underspecify 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 more specific than that.
+
+History
+The original version of html2db.xsl was written by Oliver Steele, as part of the Laszlo Systems, Inc. documentation
+effort. We had a set of custom stylesheets that formatted and added
+linking information to programming-language elements such as
+classname and tagname, and added
+Table-of-Contents to chapter documentation and numbers examples.
+
+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.)
+
+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.
+
+Credits
+html2db.xsl was written by Oliver Steele, as part of the Laszlo Systems, Inc. documentation effort.
+
+
\ No newline at end of file
diff -r 9f3b7a089caf -r 2ae81598b254 doc/wiki2docbook/html2db/tidy.properties
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/wiki2docbook/html2db/tidy.properties Sun Nov 22 09:12:22 2009 +0000
@@ -0,0 +1,3 @@
+output-xhtml: true
+show-warnings: no
+quiet: yes