doc/docbook/GuideMainWindowFolderPane.xml

   1 <?xml version="1.0" encoding="utf-8"?>\r
   2 <section id="GuideMainWindowFolderPane">\r
   3   <title id="titleGuideMainWindowFolderPane">Folder pane</title>\r
   4   <para>The folder pane contains the menu bar, tool bar, path entry, and folder list.</para>\r
   5   <para />\r
   6   <section id="Menubar">\r
   7     <title>Menu bar</title>\r
   8     <para>\r
   9       The main menu of the window. The functions available from the main menu are described in the\r
  10       <link linkend="GuideMainWindowMenus">Menus</link>\r
  11       chapter.\r
  12     </para>\r
  13     <para />\r
  14   </section>\r
  15   <section id="Toolbar">\r
  16     <title>Tool bar</title>\r
  17     <para>\r
  18       The tool bar includes buttons for often used operations. The tool bar can be hidden or shown by selecting\r
  19       <emphasis role="bold">Hide toolbar</emphasis>\r
  20       from the\r
  21       <emphasis role="bold">View</emphasis>\r
  22       menu.\r
  23     </para>\r
  24     <table frame="all">\r
  25       <tgroup cols="3" rowsep="1" colsep="1">\r
  26         <thead rowsep="1" colsep="1">\r
  27           <row>\r
  28             <entry>Icon</entry>\r
  29             <entry>Tooltip</entry>\r
  30             <entry>Description</entry>\r
  31           </row>\r
  32         </thead>\r
  33         <tbody>\r
  34           <row>\r
  35             <entry>\r
  36               <guiicon>\r
  37                 <inlinegraphic fileref="icon_thumb.png" />\r
  38               </guiicon>\r
  39             </entry>\r
  40             <entry>Show thumbnails</entry>\r
  41             <entry>\r
  42               <para>This button is active when the file list is in list view mode, and activating it will toggle the display of thumbnails.</para>\r
  43             </entry>\r
  44           </row>\r
  45           <row>\r
  46             <entry>\r
  47               <guiicon>\r
  48                 <inlinegraphic fileref="go-previous.png" />\r
  49               </guiicon>\r
  50             </entry>\r
  51             <entry>Back</entry>\r
  52             <entry>\r
  53               <para>Move back in folder history</para>\r
  54             </entry>\r
  55           </row>\r
  56           <row>\r
  57             <entry>\r
  58               <guiicon>\r
  59                 <inlinegraphic fileref="go-up.png" />\r
  60               </guiicon>\r
  61             </entry>\r
  62             <entry>Up</entry>\r
  63             <entry>\r
  64               <para>Move up one folder</para>\r
  65             </entry>\r
  66           </row>\r
  67           <row>\r
  68             <entry>\r
  69               <guiicon>\r
  70                 <inlinegraphic fileref="user-home.png" />\r
  71               </guiicon>\r
  72             </entry>\r
  73             <entry>Home</entry>\r
  74             <entry>\r
  75               <para>Change the main window to display the contents of the user's home folder</para>\r
  76             </entry>\r
  77           </row>\r
  78           <row>\r
  79             <entry>\r
  80               <guiicon>\r
  81                 <inlinegraphic fileref="view-refresh.png" />\r
  82               </guiicon>\r
  83             </entry>\r
  84             <entry>Refresh folder display</entry>\r
  85             <entry>\r
  86               <para>Refresh the contents of the file pane</para>\r
  87             </entry>\r
  88           </row>\r
  89           <row>\r
  90             <entry>\r
  91               <guiicon>\r
  92                 <inlinegraphic fileref="zoom-in.png" />\r
  93               </guiicon>\r
  94             </entry>\r
  95             <entry>Zoom in</entry>\r
  96             <entry>\r
  97               <para>Increase the image display size.</para>\r
  98             </entry>\r
  99           </row>\r
 100           <row>\r
 101             <entry>\r
 102               <guiicon>\r
 103                 <inlinegraphic fileref="zoom-out.png" />\r
 104               </guiicon>\r
 105             </entry>\r
 106             <entry>Zoom out</entry>\r
 107             <entry>\r
 108               <para>Decrease the image display size.</para>\r
 109             </entry>\r
 110           </row>\r
 111           <row>\r
 112             <entry>\r
 113               <guiicon>\r
 114                 <inlinegraphic fileref="zoom-fit-best.png" />\r
 115               </guiicon>\r
 116             </entry>\r
 117             <entry>Zoom to fit</entry>\r
 118             <entry>\r
 119               <para>This will size the image to fit within the window</para>\r
 120             </entry>\r
 121           </row>\r
 122           <row>\r
 123             <entry>\r
 124               <guiicon>\r
 125                 <inlinegraphic fileref="zoom-original.png" />\r
 126               </guiicon>\r
 127             </entry>\r
 128             <entry>Zoom 1:1</entry>\r
 129             <entry>\r
 130               <para>Restore zoom to the image's original size.</para>\r
 131             </entry>\r
 132           </row>\r
 133           <row>\r
 134             <entry>\r
 135               <guiicon>\r
 136                 <inlinegraphic fileref="preferences-desktop.png" />\r
 137               </guiicon>\r
 138             </entry>\r
 139             <entry>Preferences</entry>\r
 140             <entry>\r
 141               <para>\r
 142                 Displays the\r
 143                 <link linkend="GuideOptions">Preferences window</link>\r
 144                 .\r
 145               </para>\r
 146             </entry>\r
 147           </row>\r
 148           <row>\r
 149             <entry>\r
 150               <guiicon>\r
 151                 <inlinegraphic fileref="icon_float.png" />\r
 152               </guiicon>\r
 153             </entry>\r
 154             <entry>Float file list</entry>\r
 155             <entry>\r
 156               <para>Toggle the folder pane, file pane, and status bar between the main window and a secondary window.</para>\r
 157             </entry>\r
 158           </row>\r
 159         </tbody>\r
 160       </tgroup>\r
 161     </table>\r
 162     <para />\r
 163   </section>\r
 164   <section id="Pathentry">\r
 165     <title>Path entry</title>\r
 166     <para>This displays the active folder of the window and allows typing a location.</para>\r
 167     <para>\r
 168       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\r
 169       <code>Enter</code>\r
 170       key. Tab completion is also available in the path entry.\r
 171     </para>\r
 172     <note>\r
 173       <para>\r
 174         Tab completion uses the\r
 175         <keycode>Tab</keycode>\r
 176         key, press the\r
 177         <keycode>Down</keycode>\r
 178         key to move the focus from the entry.\r
 179       </para>\r
 180     </note>\r
 181     <para>Next to the path entry is a button with a down arrow, clicking this will display a drop down list containing the most recent locations viewed. The list is ordered such that the most recent location is at the top. Selecting a location from the drop down list will change the window to display the location.</para>\r
 182     <para>An Internet URL may be typed or drag-and-dropped into this field. The file will be downloaded to a temporary file and displayed.</para>\r
 183     <para />\r
 184   </section>\r
 185   <section id="Folderlist">\r
 186     <title>Folder list</title>\r
 187     <para>This pane consists of two sections: a folder pane and a shortcuts pane. The shortcuts pane may be hidden or revealed simply by moving the vertical divider to or from the extreme left.</para>\r
 188     <section id="folders">\r
 189       <title>Folders</title>\r
 190       <para>This displays a list of sub folders contained in the active folder, or a tree that includes all folders in the file system.</para>\r
 191       <para>\r
 192         A\r
 193         <emphasis role="strong">context menu</emphasis>\r
 194         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\r
 195       </para>\r
 196     </section>\r
 197     <section id="Shortcutslist">\r
 198       <title>Shortcuts</title>\r
 199       <para>This is a list of shortcuts (bookmarks) to commonly used folders, images and collections. A context menu will appear by right clicking on an item, or pressing the menu key when the item has the focus.</para>\r
 200       <para>Folders or images can be added to the list by activating the Add button at the bottom of the pane, or dragging a folder or image onto the list.</para>\r
 201       <para>\r
 202         Collections may be added by opening the\r
 203         <menuchoice>\r
 204           <shortcut>\r
 205             <keycombo>\r
 206               <keycap>O</keycap>\r
 207             </keycombo>\r
 208           </shortcut>\r
 209           <guimenu>File</guimenu>\r
 210           <guimenuitem>Open collection...</guimenuitem>\r
 211         </menuchoice>\r
 212         dialog and dragging a collection onto the list.\r
 213       </para>\r
 214       <para>\r
 215         To edit an item select\r
 216         <emphasis role="bold">Properties</emphasis>\r
 217         from its 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.\r
 218       </para>\r
 219       <para>\r
 220         To change the order of the list, select\r
 221         <emphasis role="bold">Move up</emphasis>\r
 222         or\r
 223         <emphasis role="bold">Move down</emphasis>\r
 224         from the item's context menu. To move an item with the keyboard move the focus to that item, then press\r
 225         <keycombo>\r
 226           <keycap>Shift</keycap>\r
 227           <keycap>Up</keycap>\r
 228         </keycombo>\r
 229         or\r
 230         <keycombo>\r
 231           <keycap>Shift</keycap>\r
 232           <keycap>Down</keycap>\r
 233         </keycombo>\r
 234         to move the item.\r
 235       </para>\r
 236       <para>\r
 237         To remove an item from the list select\r
 238         <emphasis role="bold">Remove</emphasis>\r
 239         from it's context menu.\r
 240       </para>\r
 241       <para />\r
 242     </section>\r
 243   </section>\r
 244   <section id="Listview">\r
 245     <title>List view</title>\r
 246     <para>\r
 247       This mode can be enabled by from the\r
 248       <emphasis role="bold">View</emphasis>\r
 249       menu, from the context menu, or pressing\r
 250       <code>Ctrl + T</code>\r
 251       .\r
 252     </para>\r
 253     <para>The list view mode displays sub folders contained in the active folder in a standard vertical list. The parent folder can be selected with the folder named “..”.</para>\r
 254     <para />\r
 255   </section>\r
 256   <section id="Treeview">\r
 257     <title>Tree view</title>\r
 258     <para>\r
 259       This mode can be enabled by selecting\r
 260       <emphasis role="bold">Tree</emphasis>\r
 261       from the View menu, pressing\r
 262       <code>Ctrl + T</code>\r
 263       , or selecting\r
 264       <emphasis role="bold">View as tree</emphasis>\r
 265       from the context menu.\r
 266     </para>\r
 267     <para>\r
 268       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\r
 269       <code>+</code>\r
 270       or\r
 271       <code>-</code>\r
 272       keys when the folder branch has the focus.\r
 273     </para>\r
 274     <para />\r
 275   </section>\r
 276   <section id="Sorting">\r
 277     <title>Sorting</title>\r
 278     <para>The order of the folder names will match the order selected for the file pane. Sort order can be changed by clicking the sort area of the status bar or from the context menu of the file pane.</para>\r
 279     <para />\r
 280   </section>\r
 281   <section id="Contextmenu">\r
 282     <title>Context menu</title>\r
 283     <para>\r
 284       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\r
 285       <link linkend="GuideMainWindowMenus">menu bar</link>\r
 286       , however a few functions are unique to the context menu:\r
 287     </para>\r
 288     <table frame="all">\r
 289       <tgroup cols="3" rowsep="1" colsep="1">\r
 290         <thead rowsep="1" colsep="1">\r
 291           <row>\r
 292             <entry>Icon</entry>\r
 293             <entry>Text</entry>\r
 294             <entry>Description</entry>\r
 295           </row>\r
 296         </thead>\r
 297         <tbody>\r
 298           <row>\r
 299             <entry>\r
 300               <guiicon>\r
 301                 <inlinegraphic fileref="go-up.png" />\r
 302               </guiicon>\r
 303             </entry>\r
 304             <entry>Up to parent</entry>\r
 305             <entry>\r
 306               <para>This will change the window to display the contents of the parent folder.</para>\r
 307             </entry>\r
 308           </row>\r
 309           <row>\r
 310             <entry />\r
 311             <entry>Slide show</entry>\r
 312             <entry>\r
 313               <para>\r
 314                 Start a\r
 315                 <link linkend="GuideImagePresentationSlideshow">slide show</link>\r
 316                 that contains all images in the selected folder.\r
 317               </para>\r
 318             </entry>\r
 319           </row>\r
 320           <row>\r
 321             <entry />\r
 322             <entry>Slide show recursive</entry>\r
 323             <entry>\r
 324               <para>\r
 325                 Start a\r
 326                 <link linkend="GuideImagePresentationSlideshow">slide show</link>\r
 327                 that contains all images in the selected folder, and all images in the sub folders of that folder.\r
 328               </para>\r
 329             </entry>\r
 330           </row>\r
 331           <row>\r
 332             <entry>\r
 333               <guiicon>\r
 334                 <inlinegraphic fileref="edit-find.png" />\r
 335               </guiicon>\r
 336             </entry>\r
 337             <entry>Find duplicates</entry>\r
 338             <entry>\r
 339               <para>\r
 340                 This will open a new\r
 341                 <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link>\r
 342                 window containing all images in the selected folder.\r
 343               </para>\r
 344             </entry>\r
 345           </row>\r
 346           <row>\r
 347             <entry>\r
 348               <guiicon>\r
 349                 <inlinegraphic fileref="edit-find.png" />\r
 350               </guiicon>\r
 351             </entry>\r
 352             <entry>Find duplicates recursive</entry>\r
 353             <entry>\r
 354               <para>\r
 355                 This will open a new\r
 356                 <link linkend="GuideImageSearchFindingDuplicates">find duplicates</link>\r
 357                 window containing all image in the selected folder, and all images in the sub folders of that folder.\r
 358               </para>\r
 359             </entry>\r
 360           </row>\r
 361           <row>\r
 362             <entry />\r
 363             <entry>New folder</entry>\r
 364             <entry>\r
 365               <para>Creates a new folder that is a sub folder of the selected folder.</para>\r
 366             </entry>\r
 367           </row>\r
 368           <row>\r
 369             <entry />\r
 370             <entry>Rename</entry>\r
 371             <entry>\r
 372               <para>Renames the selected folder.</para>\r
 373               <warning>\r
 374                 <emphasis role="bold">Warning:</emphasis>\r
 375                 Renaming a folder will not update metadata, such as keywords, or cached thumbnails for images contained in that folder, the data will be lost.\r
 376               </warning>\r
 377             </entry>\r
 378           </row>\r
 379           <row>\r
 380             <entry>\r
 381               <guiicon>\r
 382                 <inlinegraphic fileref="edit-delete.png" />\r
 383               </guiicon>\r
 384             </entry>\r
 385             <entry>Delete</entry>\r
 386             <entry>\r
 387               <para>Delete file or folder</para>\r
 388             </entry>\r
 389           </row>\r
 390           <row>\r
 391             <entry />\r
 392             <entry>Copy path</entry>\r
 393             <entry>\r
 394               <para>\r
 395                 Copy selected item-path(s) to clipboard\r
 396                 <footnote id='ref1'>\r
 397                   The clipboard used is selected\r
 398                   <link linkend="Behaviour">here.</link>\r
 399                 </footnote>\r
 400                 . Each data item copied will be enclosed in quotes.\r
 401               </para>\r
 402             </entry>\r
 403           </row>\r
 404           <row>\r
 405             <entry />\r
 406             <entry>Copy path unquoted</entry>\r
 407             <entry>\r
 408               <para>Copy selected item-path(s) to clipboard. The data will not be enclosed in quotes.</para>\r
 409             </entry>\r
 410           </row>\r
 411           <row>\r
 412             <entry />\r
 413             <entry>View as list</entry>\r
 414             <entry>\r
 415               <para>Switches to list tree mode of the folder pane.</para>\r
 416             </entry>\r
 417           </row>\r
 418           <row>\r
 419             <entry />\r
 420             <entry>View as tree</entry>\r
 421             <entry>\r
 422               <para>Switches to tree mode of the folder pane.</para>\r
 423             </entry>\r
 424           </row>\r
 425           <row>\r
 426             <entry />\r
 427             <entry>Show hidden files</entry>\r
 428             <entry>\r
 429               <para>Switches to list tree mode of the folder pane.</para>\r
 430             </entry>\r
 431           </row>\r
 432           <row>\r
 433             <entry>\r
 434               <guiicon>\r
 435                 <inlinegraphic fileref="view-refresh.png" />\r
 436               </guiicon>\r
 437             </entry>\r
 438             <entry>Refresh</entry>\r
 439             <entry>\r
 440               <para>Switches to tree mode of the folder pane.</para>\r
 441             </entry>\r
 442           </row>\r
 443         </tbody>\r
 444       </tgroup>\r
 445     </table>\r
 446     <para />\r
 447   </section>\r
 448   <section id="Draganddrop">\r
 449     <title>Drag and drop</title>\r
 450     <para>Image files can be dropped onto folders displayed in the folder pane. A menu will appear allowing you to select to move or copy the dropped images into the target folder. The list will automatically scroll up or down when the drag pointer is near the respective top or bottom of the list. When in tree mode, hovering over a folder for a brief period of time will expand that folder.</para>\r
 451     <para>The folders can used as a drag source for drag and drop, for example to add images in a folder to a collection window. However drag and drop can not be used to move or copy folders in Geeqie.</para>\r
 452     <para>\r
 453       Using\r
 454       <code>Shift</code>\r
 455       key while dragging is a shortcut to move action. Menu will not appear but move will occur.\r
 456     </para>\r
 457     <para>\r
 458       Using\r
 459       <code>Ctrl</code>\r
 460       key while dragging is a shortcut to copy action. Menu will not appear but copy will occur.\r
 461     </para>\r
 462     <para />\r
 463   </section>\r
 464 </section>\r