Fix #333 Renaming file extensions
[geeqie.git] / doc / docbook / GuideOptionsFiltering.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideOptionsFiltering">
3     <title>
4       Filtering Options
5     </title>
6     <para>
7       This section describes the options presented under the Filtering Tab of the preferences dialog.
8     </para>
9     <para/><section id="Filters"><title>
10       Filters
11     </title>
12     <variablelist><varlistentry><term>
13         Show hidden files or folders
14       </term><listitem><para>
15       Enables the display of hidden files and folders, also known as dot files.
16     </para></listitem></varlistentry></variablelist>
17
18     <variablelist><varlistentry><term>
19         Show parent folder
20       </term><listitem><para>
21       Enables the display of the parent folder as a double dot in the directories views.
22     </para></listitem></varlistentry></variablelist>
23
24     <variablelist><varlistentry><term>
25         Case sensitive sort
26       </term><listitem><para>
27       Files and folders are sorted such that upper case letters occur before lower case letters.
28     </para><para>
29       Enabled result: A, B, C, a, b, c<?db2html element="br"?>
30       Disabled result: A, a, B, b, C, c
31     </para></listitem></varlistentry></variablelist>
32
33     <variablelist><varlistentry><term>
34         Disable file extension checks
35       </term><listitem><para>
36       During rename operations, allows files to be renamed to a different extension with no warning issued.
37     </para></listitem></varlistentry></variablelist>
38
39     <variablelist><varlistentry><term>
40         Disable file filtering
41       </term><listitem><para>
42       Enable this to allow Geeqie to list all files, even those that do not contain images.
43     </para></listitem></varlistentry></variablelist>
44
45     <para/></section><section id="Groupingsidecarextensions"><title>
46       Grouping sidecar extensions
47     </title>
48     <para>
49       This field defines which extensions will lead to file grouping. Each extension should be separated by a semi-colon and should include the starting dot. It is possible to use wildcards: <literal>%image</literal> expands to list of all files in class image, <literal>%raw</literal> expands to raw files and <literal>%meta</literal> expands to metadata files (see the file class below).
50     </para>
51     <para>
52       Grouped files will appear as one in file views. The group is represented by the first existing extension from the list. For example, it is useful when browsing directories containing two files for the same image (as raw+jpeg files generated by some cameras).
53     </para>
54     <para/></section><section id="Filetypes"><title>
55       File types
56     </title>
57     <para>
58       This list contains the image formats that are understood by Geeqie. To disable a specific file type from being displayed, uncheck it's corresponding checkbox. Filters can be edited by first selecting the line containing the item to be changed, then clicking the filter or description field, making any changes, then pressing Enter; press Escape to cancel an active edit. The format for the filter field is a semicolon (;) seperated list of extensions, extensions must include the period (.).
59     </para>
60     <para>
61       Note: Unlike all other options in the dialog, filter list changes are applied immediately.
62     </para>
63     <variablelist><varlistentry><term>
64         Add button
65       </term><listitem><para/></listitem></varlistentry></variablelist>
66     <para>
67       Adds a new blank line to the filter list, change the parameters to match the desired file type.
68     </para>
69     <variablelist><varlistentry><term>
70         Remove button
71       </term><listitem><para/></listitem></varlistentry></variablelist>
72     <para>
73       Removes the selected line from the filter list.
74     </para>
75     <variablelist><varlistentry><term>
76         Defaults button
77       </term><listitem><para/></listitem></varlistentry></variablelist>
78     <para>
79       Resets the filter list to the default values, discarding any customizations made by the user.
80     </para>
81   <para/></section></section>