doc/docbook/GuideOptionsFiltering.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideOptionsFiltering">
   3   <title id="titleGuideOptionsFiltering">File Filters Options</title>
   4   <para>This section describes the options presented under the File Filters Tab of the preferences dialogue.</para>
   5   <para />
   6   <section id="Filters">
   7     <title>Filters</title>
   8     <variablelist>
   9       <varlistentry>
  10         <term>
  11           <guilabel>Show hidden files or folders</guilabel>
  12         </term>
  13         <listitem>
  14           <para>Enables the display of hidden files and folders, also known as dot files.</para>
  15         </listitem>
  16       </varlistentry>
  17       <varlistentry>
  18         <term>
  19           <guilabel>Show parent folder</guilabel>
  20         </term>
  21         <listitem>
  22           <para>Enables the display of the parent folder as a double dot in the directories views.</para>
  23         </listitem>
  24       </varlistentry>
  25       <varlistentry>
  26         <term>
  27           <guilabel>Case sensitive sort</guilabel>
  28         </term>
  29         <listitem>
  30           <para>Files and folders are sorted such that upper case letters occur before lower case letters.</para>
  31           <para>
  32             Enabled result: A, B, C, a, b, c
  33             <para />
  34             Disabled result: A, a, B, b, C, c
  35           </para>
  36         </listitem>
  37       </varlistentry>
  38       <varlistentry>
  39         <term>
  40           <guilabel>Natural sort order</guilabel>
  41         </term>
  42         <listitem>
  43           <para>Files and folders are sorted with the dot '.' treated as a special case, so the order is e.g. "event.c" "event.h" "eventgenerator.c". Also, files containing numbers are sorted as "file1" "file5" "file10".</para>
  44           <note>If this option is selected and a standard numerical sort is required and the files are in a single folder, a workaround is to put the files in a temporary collection and select Sort By Path</note>
  45         </listitem>
  46       </varlistentry>
  47       <varlistentry>
  48         <term>
  49           <guilabel>Disable file extension checks</guilabel>
  50         </term>
  51         <listitem>
  52           <para>During rename operations, allows files to be renamed to a different extension with no warning issued.</para>
  53         </listitem>
  54       </varlistentry>
  55       <varlistentry>
  56         <term>
  57           <guilabel>Disable file filtering</guilabel>
  58         </term>
  59         <listitem>
  60           <para>Enable this to allow Geeqie to list all files, even those that do not contain images.</para>
  61         </listitem>
  62       </varlistentry>
  63     </variablelist>
  64     <para />
  65   </section>
  66   <section id="Groupingsidecarextensions">
  67     <title>Grouping sidecar extensions</title>
  68     <para>This field defines which extensions will lead to file grouping. Grouped files will appear as a single entry in file views. This is useful, for example, when browsing directories containing two files for the same image (such as raw+jpeg files generated by some cameras).</para>
  69     <para>The group is represented by the first extension in the list for which a file exists.</para>
  70     <para>
  71       Each extension should include the starting dot and should be separated by a semi-colon from following entries. It is possible to use wild-cards corresponding to entries in the
  72       <emphasis>File Types Class</emphasis>
  73       below:
  74       <variablelist>
  75         <varlistentry>
  76           <term>
  77             <literal>%unknown</literal>
  78           </term>
  79           <listitem>
  80             expands to all files listed in class
  81             <emphasis>Unknown</emphasis>
  82             ,
  83           </listitem>
  84         </varlistentry>
  85         <varlistentry>
  86           <term>
  87             <literal>%image</literal>
  88           </term>
  89           <listitem>
  90             expands to all files listed in class
  91             <emphasis>Image</emphasis>
  92             ,
  93           </listitem>
  94         </varlistentry>
  95         <varlistentry>
  96           <term>
  97             <literal>%raw</literal>
  98           </term>
  99           <listitem>
 100             expands to all files listed in class
 101             <emphasis>RAW Image</emphasis>
 102           </listitem>
 103         </varlistentry>
 104         <varlistentry>
 105           <term>
 106             <literal>%meta</literal>
 107           </term>
 108           <listitem>
 109             expands to all files listed in class
 110             <emphasis>Metadata</emphasis>
 111           </listitem>
 112         </varlistentry>
 113       </variablelist>
 114     </para>
 115     <para />
 116     <para />
 117   </section>
 118   <section id="Filetypes">
 119     <title>File types</title>
 120     <para>
 121       This list contains the image formats that are understood by Geeqie. To disable a specific file type from being displayed, uncheck it's corresponding check-box. 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
 122       <keycap>Enter</keycap>
 123       ; press
 124       <keycap>Escape</keycap>
 125       to cancel an active edit.
 126     </para>
 127     <note>
 128       <para>Unlike all other options in the dialogue, filter list changes are applied immediately.</para>
 129     </note>
 130     <para>
 131       The table consists of:
 132       <variablelist>
 133         <varlistentry>
 134           <term>
 135             <guilabel>Enabled</guilabel>
 136           </term>
 137           <listitem>
 138             Whether or not the filter is used.
 139           </listitem>
 140         </varlistentry>
 141         <varlistentry>
 142           <term>
 143             <guilabel>Filter</guilabel>
 144           </term>
 145           <listitem>
 146             List of extensions this filter applies to, separated by a
 147             <code>;</code>
 148             . Each extension must be preceded by a dot.
 149           </listitem>
 150         </varlistentry>
 151         <varlistentry>
 152           <term>
 153             <guilabel>Description</guilabel>
 154           </term>
 155           <listitem>Brief description. This is not used elsewhere.</listitem>
 156         </varlistentry>
 157         <varlistentry>
 158           <term>
 159             <guilabel>Class</guilabel>
 160           </term>
 161           <listitem>
 162             This may be used to define sets of file types, for use in the
 163             <emphasis>Grouping</emphasis>
 164             function described above. The drop-down list has 7 entries:
 165             <itemizedlist>
 166               <listitem>Unknown</listitem>
 167               <listitem>Image</listitem>
 168               <listitem>RAW Image</listitem>
 169               <listitem>Metadata</listitem>
 170               <listitem>Video</listitem>
 171               <listitem>Collection</listitem>
 172               <listitem>Document</listitem>
 173               <listitem>Archive (.zip, .rar etc.)</listitem>
 174             </itemizedlist>
 175           </listitem>
 176         </varlistentry>
 177         <varlistentry>
 178           <term>
 179             <guilabel>Writable</guilabel>
 180           </term>
 181           <listitem>If this option is checked, Geeqie will try to write metadata to the image file itself. This, and the following option, are mutually exclusive.</listitem>
 182         </varlistentry>
 183         <varlistentry>
 184           <term>
 185             <guilabel>Sidecar is allowed</guilabel>
 186           </term>
 187           <listitem>If this option is checked, Geeqie will try to write metadata to a sidecar file associated with the image. This, and the previous option, are mutually exclusive.</listitem>
 188         </varlistentry>
 189       </variablelist>
 190     </para>
 191     <variablelist>
 192       <varlistentry>
 193         <term>
 194           <guibutton>
 195             <guiicon>
 196               <inlinegraphic fileref="list-add.png" />
 197             </guiicon>
 198             Add
 199           </guibutton>
 200         </term>
 201         <listitem>Adds a new blank line to the filter list, change the parameters to match the desired file type.</listitem>
 202       </varlistentry>
 203     </variablelist>
 204     <variablelist>
 205       <varlistentry>
 206         <term>
 207           <guibutton>
 208             <guiicon>
 209               <inlinegraphic fileref="list-remove.png" />
 210             </guiicon>
 211             Remove
 212           </guibutton>
 213         </term>
 214         <listitem>Removes the selected line from the filter list.</listitem>
 215       </varlistentry>
 216     </variablelist>
 217     <variablelist>
 218       <varlistentry>
 219         <term>
 220           <guibutton>Defaults</guibutton>
 221         </term>
 222         <listitem>Resets the filter list to the default values, discarding any customizations made by the user.</listitem>
 223       </varlistentry>
 224     </variablelist>
 225     <variablelist>
 226       <varlistentry>
 227         <term>
 228           <guibutton>Column Sorting</guibutton>
 229         </term>
 230         <listitem>Columns other than Filter can be sorted in ascending or descending order by clicking on the column header.</listitem>
 231       </varlistentry>
 232     </variablelist>
 233     <variablelist>
 234       <varlistentry>
 235         <term>
 236           <guibutton>Filter Search</guibutton>
 237         </term>
 238         <listitem>A search of the file extensions listed in the Filter column can be initiated either by typing <code>Ctrl + F</code> or by pressing any alpha-numeric key when the File Types table has focus.</listitem>
 239       </varlistentry>
 240     </variablelist>
 241   </section>
 242 </section>