Use gdk_rectangle_intersect() in pan-view
[geeqie.git] / doc / docbook / GuideCollections.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <section id="GuideCollections">\r
3   <title id="titleGuideCollections">Collections</title>\r
4   <para>Geeqie provides the ability to build lists of images, regardless of the location of the files on disk.</para>\r
5   <para>A collection window displays the contents of a collection. It allows the collection to be modified and access to the images contained in the collection.</para>\r
6   <para>\r
7     To open a new empty collection window select\r
8     <menuchoice>\r
9       <shortcut>\r
10         <keycombo>\r
11           <keycap>C</keycap>\r
12         </keycombo>\r
13       </shortcut>\r
14       <guimenu>File</guimenu>\r
15       <guimenuitem>New collection</guimenuitem>\r
16     </menuchoice>\r
17     .\r
18   </para>\r
19   <para>\r
20     To open an existing collection, select\r
21     <menuchoice>\r
22       <shortcut>\r
23         <keycombo>\r
24           <keycap>O</keycap>\r
25         </keycombo>\r
26       </shortcut>\r
27       <guimenu>File</guimenu>\r
28       <guimenuitem>Open collection</guimenuitem>\r
29     </menuchoice>\r
30     . 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.\r
31   </para>\r
32   <para>\r
33     To delete or rename a collection, select\r
34     <menuchoice>\r
35       <shortcut>\r
36         <keycombo>\r
37           <keycap>O</keycap>\r
38         </keycombo>\r
39       </shortcut>\r
40       <guimenu>File</guimenu>\r
41       <guimenuitem>Open collection</guimenuitem>\r
42     </menuchoice>\r
43     , right-click on the collection you wish to delete or rename, and then select\r
44     <emphasis role="strong">Delete</emphasis>\r
45     or\r
46     <emphasis role="strong">Rename</emphasis>\r
47     .\r
48   </para>\r
49   <para>The collection window consists of a pane to display the contents of the collection, and a status bar along the bottom of the window.</para>\r
50   <para />\r
51   <section id="Iconpane">\r
52     <title>Icon pane</title>\r
53     <para>The icon pane displays images contained in the collection as thumbnails in a grid, by default the file names also appear below each thumbnail.</para>\r
54     <para>\r
55       The Icon pane works exactly like the Icon view mode of the\r
56       <link linkend="GuideMainWindowFilePane" endterm="titleGuideMainWindowFilePane" />\r
57       in a main window, but with the addition that the contents of the collection can be organized with drag and drop.\r
58     </para>\r
59     <para>\r
60       A\r
61       <emphasis role="strong">context menu</emphasis>\r
62       is available for the icon pane by right clicking the mouse or pressing the Menu key.\r
63     </para>\r
64     <para>\r
65       <link linkend="GuideReferenceKeyboardShortcuts" endterm="titleGuideReferenceKeyboardShortcuts" />\r
66       are available in the collection window:\r
67     </para>\r
68     <para>\r
69       The\r
70       <emphasis role="strong">selection</emphasis>\r
71       can be changed using the keyboard and mouse the same as in a\r
72       <link linkend="GuideMainWindowFilePane" endterm="titleGuideMainWindowFilePane" />\r
73       of the main window.\r
74     </para>\r
75     <para />\r
76   </section>\r
77   <section id="Statusbar">\r
78     <title>Status bar</title>\r
79     <para>The status bar displays the total number of images in the collection, and the number of selected images in parenthesis. A progress bar also displays whenever thumbnails are loading from disk.</para>\r
80     <para />\r
81   </section>\r
82   <section id="DragandDrop">\r
83     <title>Drag and Drop</title>\r
84     <para>Drag and drop can be initialized with the primary or middle mouse buttons. Dragging an image that is selected will include all selected images in the drag. Dragging an image that is not selected will drag only that image.</para>\r
85     <para>Dropping files and folders onto the collection window will add them to the collection, they will be inserted at the location of the drop. A red arrow will indicate the location of the drop as files are dragged over the collection window. When one or more folders are included in the drop list, a menu will appear to select how to handle the contents of the folders.</para>\r
86     <para>To move images within the collection to change their order, initiate a drag for the selected image(s) and then move the mouse to the desired location within the window. A red arrow will appear to assist in determining the destination of the dragged images. Release the drag to move the images to the new location in the list.</para>\r
87     <note>\r
88       <para>\r
89         When renaming or moving files within Geeqie, the contents of collections located in the\r
90         <link linkend="GuideReferenceConfig">collections folder</link>\r
91         will automatically update to the new name or location.\r
92       </para>\r
93     </note>\r
94     <para />\r
95   </section>\r
96   <section id="AppendImages">\r
97     <title>Append Images</title>\r
98     <para>Right-click menu items permit images to be appended from either another collection or from the currently selected folder.</para>\r
99     <para />\r
100   </section>\r
101   <section id="RandomizedSort">\r
102     <title>Randomized Sort</title>\r
103     <para>\r
104       Right-click menu item\r
105       <emphasis role="strong">Sort</emphasis>\r
106       , in addition to the standard sort methods, permits images to be randomly arranged.\r
107     </para>\r
108     <para />\r
109   </section>\r
110 </section>\r