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