Fix #245: Zoom settings on status bar
[geeqie.git] / doc / docbook / GuideMainWindowStatusBar.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <section id="GuideMainWindowStatusBar">\r
3   <title id="titleGuideMainWindowStatusBar">Status Bar</title>\r
4   <para>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.</para>\r
5   <para>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.</para>\r
6   <para />\r
7   <section id="ProgressBar">\r
8     <title>Progress Bar</title>\r
9     <para>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.</para>\r
10     <para />\r
11   </section>\r
12   <section id="Sortmethod">\r
13     <title>Sort method</title>\r
14     <para>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.</para>\r
15     <variablelist>\r
16       <varlistentry>\r
17         <term>\r
18           <guilabel>Name</guilabel>\r
19         </term>\r
20         <listitem>\r
21           <para>Images are sorted by file name.</para>\r
22         </listitem>\r
23       </varlistentry>\r
24       <varlistentry>\r
25         <term>\r
26           <guilabel>Number</guilabel>\r
27         </term>\r
28         <listitem>\r
29           <para>Images are sorted by natural numerical order, such that, for example, 9_name.jpg will be listed before 10_name.jpg.</para>\r
30         </listitem>\r
31       </varlistentry>\r
32       <varlistentry>\r
33         <term>\r
34           <guilabel>Date</guilabel>\r
35         </term>\r
36         <listitem>\r
37           <para>Images are sorted by file modification date.</para>\r
38         </listitem>\r
39       </varlistentry>\r
40       <varlistentry>\r
41         <term>\r
42           <guilabel>File Creation Date</guilabel>\r
43         </term>\r
44         <listitem>\r
45           <para>Images are sorted by file creation date.</para>\r
46         </listitem>\r
47       </varlistentry>\r
48       <varlistentry>\r
49         <term>\r
50           <guilabel>Exif Date</guilabel>\r
51         </term>\r
52         <listitem>\r
53           <para>Images are sorted by file Exif date.</para>\r
54         </listitem>\r
55       </varlistentry>\r
56       <varlistentry>\r
57         <term>\r
58           <guilabel>Size</guilabel>\r
59         </term>\r
60         <listitem>\r
61           <para>Image are sorted by file size on disk.</para>\r
62         </listitem>\r
63       </varlistentry>\r
64       <varlistentry>\r
65         <term>\r
66           <guilabel>Ascending</guilabel>\r
67         </term>\r
68         <listitem>\r
69           <para>Toggles between increasing and decreasing sort order. A check will appear next to this entry to indicate ascending sort order.</para>\r
70         </listitem>\r
71       </varlistentry>\r
72     </variablelist>\r
73     <para />\r
74   </section>\r
75   <section id="Filelist">\r
76     <title>File list</title>\r
77     <para>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.</para>\r
78     <para />\r
79   </section>\r
80   <section id="ImageDetails">\r
81     <title>Image Details</title>\r
82     <para>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.</para>\r
83     <para />\r
84   </section>\r
85   <section id="Buttons">\r
86     <title>Buttons</title>\r
87     <para>Statusbar buttons corresponds to selected menu action.</para>\r
88     <para />\r
89     <section id="Zoom">\r
90       <title>Zoom</title>\r
91       <para>The button label 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.</para>\r
92       <para>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).</para>\r
93       <para />\r
94       <para>Clicking this button permits control of the behavior of the zoom and scroll settings used when changing the displayed image.</para>\r
95       <variablelist>\r
96         <varlistentry>\r
97           <term>\r
98             <guilabel>Zoom to original size</guilabel>\r
99           </term>\r
100           <listitem>\r
101             <para>The new image is set to its original size.</para>\r
102           </listitem>\r
103         </varlistentry>\r
104         <varlistentry>\r
105           <term>\r
106             <guilabel>Fit image to window</guilabel>\r
107           </term>\r
108           <listitem>\r
109             <para>The new image's zoom is changed so that the image will fit within the current view area.</para>\r
110           </listitem>\r
111         </varlistentry>\r
112         <varlistentry>\r
113           <term>\r
114             <guilabel>Leave zoom at previous setting</guilabel>\r
115           </term>\r
116           <listitem>\r
117             <para>The zoom setting is unchanged, the new image will be scaled the same as the previous image.</para>\r
118           </listitem>\r
119         </varlistentry>\r
120       </variablelist>\r
121       <variablelist>\r
122         <varlistentry>\r
123           <term>\r
124             <guilabel>Scroll to top left corner</guilabel>\r
125           </term>\r
126           <listitem>\r
127             <para>The new image is displayed from top left corner.</para>\r
128           </listitem>\r
129         </varlistentry>\r
130         <varlistentry>\r
131           <term>\r
132             <guilabel>Scroll to image center</guilabel>\r
133           </term>\r
134           <listitem>\r
135             <para>The new image is centered</para>\r
136           </listitem>\r
137         </varlistentry>\r
138         <varlistentry>\r
139           <term>\r
140             <guilabel>Keep the region from previous iamge</guilabel>\r
141           </term>\r
142           <listitem>\r
143             <para>The new image is positioned as the previous one, whenever possible.</para>\r
144           </listitem>\r
145         </varlistentry>\r
146       </variablelist>\r
147     </section>\r
148     <section id="ExifRotate">\r
149       <title>Exif rotate</title>\r
150       <para>\r
151         <guiicon>\r
152           <inlinegraphic fileref="gtk-color-picker.png" />\r
153         </guiicon>\r
154         Toggles the auto-rotation of images if they have Exif orientation data.\r
155         Refer also to the\r
156         <link linkend="HowdotheExifauto-rotationcommandswork">FAQ</link>\r
157         .\r
158       </para>\r
159       <para />\r
160     </section>\r
161     <section id="ShowPixelInfo">\r
162       <title>Show Pixel Info</title>\r
163       <para>\r
164         <guiicon>\r
165           <inlinegraphic fileref="gtk-color-picker.png" />\r
166         </guiicon>\r
167         Shows coordinates and RGB value under cursor.\r
168       </para>\r
169       <para />\r
170     </section>\r
171     <section id="EnableColorManagement">\r
172       <title>Enable Color Management</title>\r
173       <para>\r
174         <guiicon>\r
175           <inlinegraphic fileref="gtk-select-color.png" />\r
176         </guiicon>\r
177         Enables color profiles.\r
178       </para>\r
179       <para />\r
180     </section>\r
181     <section id="SaveMetadata">\r
182       <title>Save Metadata</title>\r
183       <para>\r
184         <guiicon>\r
185           <inlinegraphic fileref="document-save.png" />\r
186         </guiicon>\r
187         Opens dialog for review and saving of metadata changes.\r
188       </para>\r
189       <para />\r
190     </section>\r
191   </section>\r
192 </section>\r