doc/docbook/GuideImagePresentationSlideshow.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideImagePresentationSlideshow">
   3   <title id="titleGuideImagePresentationSlideshow">Slide Show</title>
   4   <para>The image pane can be set to automatically change the displayed image after a period of time, in Geeqie this is referred to as a slide show.</para>
   5   <para />
   6   <section id="Startingaslideshow">
   7     <title>Starting a slide show</title>
   8     <para>A slide show can be started in a number of ways:</para>
   9     <itemizedlist spacing="compact">
  10       <listitem>
  11         <para>
  12           From the keyboard or mouse
  13           <menuchoice>
  14             <shortcut>
  15               <keycombo>
  16                 <keycap>S</keycap>
  17               </keycombo>
  18             </shortcut>
  19             <guimenu>View</guimenu>
  20             <guimenuitem>Toggle slide show</guimenuitem>
  21           </menuchoice>
  22         </para>
  23       </listitem>
  24       <listitem>
  25         <para>
  26           From a context menu - right click an image pane, and select
  27           <emphasis role="strong">Start slide show</emphasis>
  28           , or
  29           <emphasis role="strong">Stop slide show</emphasis>
  30           ; the text will change depending on the state of the current slide show.
  31         </para>
  32       </listitem>
  33     </itemizedlist>
  34     <para />
  35   </section>
  36   <section id="Stoppingaslideshow">
  37     <title>Stopping a slide show</title>
  38     <para>
  39       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
  40       <link linkend="GuideOptionsGeneral">Preferences dialog</link>
  41       , the slide show will stop when the last image in the sequence is displayed.
  42     </para>
  43     <para>
  44       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
  45       <link linkend="Slideshowsequencenavigation">Slide show sequence navigation</link>
  46       .
  47     </para>
  48     <para />
  49   </section>
  50   <section id="Slideshowstatus">
  51     <title>Slide show status</title>
  52     <para>
  53       The main window
  54       <link linkend="GuideMainWindowStatusBar">status bar</link>
  55       can be used to determine when a slide show is active,
  56       <emphasis role="strong">Slide show</emphasis>
  57       will be displayed next to the file count field. An individual
  58       <link linkend="GuideOtherWindowsImageWindow">Image Window</link>
  59       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
  60       <emphasis role="strong">Start slide show</emphasis>
  61       is displayed, no slide show is active, conversely if
  62       <emphasis role="strong">Stop slide show</emphasis>
  63       is displayed a slide show is active.
  64     </para>
  65     <para>
  66       When a Slide show is paused, the main window status bar will display
  67       <emphasis role="strong">Paused</emphasis>
  68       instead of
  69       <emphasis role="strong">Slide show</emphasis>
  70       . Likewise, the image context menu will display
  71       <emphasis role="strong">Pause slide show</emphasis>
  72       or
  73       <emphasis role="strong">Continue slide show</emphasis>
  74       , depending on the current state.
  75     </para>
  76     <para />
  77   </section>
  78   <section id="Pausingaslideshow">
  79     <title>Pausing a slide show</title>
  80     <para>An active slide show can be paused in two ways:</para>
  81     <itemizedlist spacing="compact">
  82       <listitem>
  83         <para>
  84           From the keyboard - press the
  85           <keycap>P</keycap>
  86           key while a slide show is active.
  87         </para>
  88       </listitem>
  89       <listitem>
  90         <para>
  91           From a context menu - right click the image pane displaying the slide show, and select
  92           <emphasis role="strong">Pause slide show</emphasis>
  93           , or
  94           <emphasis role="strong">Continue slide show</emphasis>
  95           depending on the current slide show state.
  96         </para>
  97       </listitem>
  98     </itemizedlist>
  99     <para />
 100   </section>
 101   <section id="Selectingtheimagestoincludeinaslideshow">
 102     <title>Selecting the images to include in a slide show</title>
 103     <para>When a single image is selected, all images in the current folder are included in the slide show. The sequence will begin with the current image; however if random slide shows are enabled, the sequence will begin with a random image from the list.</para>
 104     <para>To only include some images in a slide show, use multiple selection to select the images to include before starting the slide show.</para>
 105     <para>An image collection can be used as the list of images, to do this drag an image from a collection window onto the image pane. Starting a slide show will then include the images from that collection.</para>
 106     <para>
 107       So far, the methods described are for slide shows in a main window, in an
 108       <link linkend="GuideOtherWindowsImageWindow">Image Window</link>
 109       , the slide show will use all images referenced by that window.
 110     </para>
 111     <para />
 112   </section>
 113   <section id="Recursiveslideshow">
 114     <title>Recursive slide show</title>
 115     <para>In the main window, a recursive slide show can be started from a folder's context menu; the folder's right click menu will include two slide show options:</para>
 116     <itemizedlist spacing="compact">
 117       <listitem>
 118         <para>Slide show: This will start a slide show that includes all images in the selected folder.</para>
 119       </listitem>
 120       <listitem>
 121         <para>Slide show recursive: The slide show will include all images in the selected folder, and all images in the folders that are contained within the selected folder.</para>
 122       </listitem>
 123     </itemizedlist>
 124     <para />
 125   </section>
 126   <section id="Slideshowsequencenavigation">
 127     <title>Slide show sequence navigation</title>
 128     <para>When a slide show is active, functions that normally change the image forward and backward can be used to step through those contained in the slide show.</para>
 129     <para />
 130   </section>
 131   <section id="Configuringaslideshow">
 132     <title>Configuring a slide show</title>
 133     <para>
 134       The options that control the behavior of slide shows are located on the
 135       <link linkend="Slideshow">General tab</link>
 136       of the options dialog.
 137     </para>
 138   </section>
 139 </section>