doc/docbook/GuideOptionsFiltering.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideOptionsFiltering">
   3   <title id="titleGuideOptionsFiltering">Files Options</title>
   4   <para>This section describes the options presented under the Files 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         </listitem>
  45       </varlistentry>
  46       <varlistentry>
  47         <term>
  48           <guilabel>Disable file extension checks</guilabel>
  49         </term>
  50         <listitem>
  51           <para>During rename operations, allows files to be renamed to a different extension with no warning issued.</para>
  52         </listitem>
  53       </varlistentry>
  54       <varlistentry>
  55         <term>
  56           <guilabel>Disable file filtering</guilabel>
  57         </term>
  58         <listitem>
  59           <para>Enable this to allow Geeqie to list all files, even those that do not contain images.</para>
  60         </listitem>
  61       </varlistentry>
  62     </variablelist>
  63     <para />
  64   </section>
  65   <section id="Groupingsidecarextensions">
  66     <title>Grouping sidecar extensions</title>
  67     <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>
  68     <para>The group is represented by the first extension in the list for which a file exists.</para>
  69     <para>
  70       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
  71       <emphasis>File Types Class</emphasis>
  72       below:
  73       <variablelist>
  74         <varlistentry>
  75           <term>
  76             <literal>%unknown</literal>
  77           </term>
  78           <listitem>
  79             expands to all files listed in class
  80             <emphasis>Unknown</emphasis>
  81             ,
  82           </listitem>
  83         </varlistentry>
  84         <varlistentry>
  85           <term>
  86             <literal>%image</literal>
  87           </term>
  88           <listitem>
  89             expands to all files listed in class
  90             <emphasis>Image</emphasis>
  91             ,
  92           </listitem>
  93         </varlistentry>
  94         <varlistentry>
  95           <term>
  96             <literal>%raw</literal>
  97           </term>
  98           <listitem>
  99             expands to all files listed in class
 100             <emphasis>RAW Image</emphasis>
 101           </listitem>
 102         </varlistentry>
 103         <varlistentry>
 104           <term>
 105             <literal>%meta</literal>
 106           </term>
 107           <listitem>
 108             expands to all files listed in class
 109             <emphasis>Metadata</emphasis>
 110           </listitem>
 111         </varlistentry>
 112       </variablelist>
 113     </para>
 114     <para />
 115     <para />
 116   </section>
 117   <section id="Filetypes">
 118     <title>File types</title>
 119     <para>
 120       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
 121       <keycap>Enter</keycap>
 122       ; press
 123       <keycap>Escape</keycap>
 124       to cancel an active edit.
 125     </para>
 126     <note>
 127       <para>Unlike all other options in the dialogue, filter list changes are applied immediately.</para>
 128     </note>
 129     <para>
 130       The table consists of:
 131       <variablelist>
 132         <varlistentry>
 133           <term>
 134             <guilabel>Filter</guilabel>
 135           </term>
 136           <listitem>
 137             List of extensions this filter applies to, separated by a
 138             <code>;</code>
 139             . Each extension must be preceded by a dot.
 140           </listitem>
 141         </varlistentry>
 142         <varlistentry>
 143           <term>
 144             <guilabel>Description</guilabel>
 145           </term>
 146           <listitem>Brief description. This is not used elsewhere.</listitem>
 147         </varlistentry>
 148         <varlistentry>
 149           <term>
 150             <guilabel>Class</guilabel>
 151           </term>
 152           <listitem>
 153             This may be used to define sets of file types, for use in the
 154             <emphasis>Grouping</emphasis>
 155             function described above. The drop-down list has 7 entries:
 156             <itemizedlist>
 157               <listitem>Unknown</listitem>
 158               <listitem>Image</listitem>
 159               <listitem>RAW Image</listitem>
 160               <listitem>Metadata</listitem>
 161               <listitem>Video</listitem>
 162               <listitem>Collection</listitem>
 163               <listitem>Document</listitem>
 164               <listitem>Archive (.zip, .rar etc.)</listitem>
 165             </itemizedlist>
 166           </listitem>
 167         </varlistentry>
 168         <varlistentry>
 169           <term>
 170             <guilabel>Writable</guilabel>
 171           </term>
 172           <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>
 173         </varlistentry>
 174         <varlistentry>
 175           <term>
 176             <guilabel>Sidecar is allowed</guilabel>
 177           </term>
 178           <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>
 179         </varlistentry>
 180       </variablelist>
 181     </para>
 182     <variablelist>
 183       <varlistentry>
 184         <term>
 185           <guibutton>
 186             <guiicon>
 187               <inlinegraphic fileref="list-add.png" />
 188             </guiicon>
 189             Add
 190           </guibutton>
 191         </term>
 192         <listitem>Adds a new blank line to the filter list, change the parameters to match the desired file type.</listitem>
 193       </varlistentry>
 194     </variablelist>
 195     <variablelist>
 196       <varlistentry>
 197         <term>
 198           <guibutton>
 199             <guiicon>
 200               <inlinegraphic fileref="list-remove.png" />
 201             </guiicon>
 202             Remove
 203           </guibutton>
 204         </term>
 205         <listitem>Removes the selected line from the filter list.</listitem>
 206       </varlistentry>
 207     </variablelist>
 208     <variablelist>
 209       <varlistentry>
 210         <term>
 211           <guibutton>Defaults</guibutton>
 212         </term>
 213         <listitem>Resets the filter list to the default values, discarding any customizations made by the user.</listitem>
 214       </varlistentry>
 215     </variablelist>
 216     <variablelist>
 217       <varlistentry>
 218         <term>
 219           <guibutton>Column Sorting</guibutton>
 220         </term>
 221         <listitem>Columns other than Filter can be sorted in ascending or descending order by clicking on the column header.</listitem>
 222       </varlistentry>
 223     </variablelist>
 224     <variablelist>
 225       <varlistentry>
 226         <term>
 227           <guibutton>Filter Search</guibutton>
 228         </term>
 229         <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>
 230       </varlistentry>
 231     </variablelist>
 232   </section>
 233 </section>