doc/docbook/GuideOptionsFiltering.xml

   1 <?xml version="1.0" encoding="utf-8"?>\r
   2 <section id="GuideOptionsFiltering">\r
   3   <title id="titleGuideOptionsFiltering">Files Options</title>\r
   4   <para>This section describes the options presented under the Files Tab of the preferences dialogue.</para>\r
   5   <para />\r
   6   <section id="Filters">\r
   7     <title>Filters</title>\r
   8     <variablelist>\r
   9       <varlistentry>\r
  10         <term>\r
  11           <guilabel>Show hidden files or folders</guilabel>\r
  12         </term>\r
  13         <listitem>\r
  14           <para>Enables the display of hidden files and folders, also known as dot files.</para>\r
  15         </listitem>\r
  16       </varlistentry>\r
  17       <varlistentry>\r
  18         <term>\r
  19           <guilabel>Show parent folder</guilabel>\r
  20         </term>\r
  21         <listitem>\r
  22           <para>Enables the display of the parent folder as a double dot in the directories views.</para>\r
  23         </listitem>\r
  24       </varlistentry>\r
  25       <varlistentry>\r
  26         <term>\r
  27           <guilabel>Case sensitive sort</guilabel>\r
  28         </term>\r
  29         <listitem>\r
  30           <para>Files and folders are sorted such that upper case letters occur before lower case letters.</para>\r
  31           <para>\r
  32             Enabled result: A, B, C, a, b, c\r
  33             <para />\r
  34             Disabled result: A, a, B, b, C, c\r
  35           </para>\r
  36         </listitem>\r
  37       </varlistentry>\r
  38       <varlistentry>\r
  39         <term>\r
  40           <guilabel>Disable file extension checks</guilabel>\r
  41         </term>\r
  42         <listitem>\r
  43           <para>During rename operations, allows files to be renamed to a different extension with no warning issued.</para>\r
  44         </listitem>\r
  45       </varlistentry>\r
  46       <varlistentry>\r
  47         <term>\r
  48           <guilabel>Disable file filtering</guilabel>\r
  49         </term>\r
  50         <listitem>\r
  51           <para>Enable this to allow Geeqie to list all files, even those that do not contain images.</para>\r
  52         </listitem>\r
  53       </varlistentry>\r
  54     </variablelist>\r
  55     <para />\r
  56   </section>\r
  57   <section id="Groupingsidecarextensions">\r
  58     <title>Grouping sidecar extensions</title>\r
  59     <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>\r
  60     <para>The group is represented by the first extension in the list for which a file exists.</para>\r
  61     <para>\r
  62       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\r
  63       <emphasis>File Types Class</emphasis>\r
  64       below:\r
  65       <variablelist>\r
  66         <varlistentry>\r
  67           <term>\r
  68             <literal>%unknown</literal>\r
  69           </term>\r
  70           <listitem>\r
  71             expands to all files listed in class\r
  72             <emphasis>Unknown</emphasis>\r
  73             ,\r
  74           </listitem>\r
  75         </varlistentry>\r
  76         <varlistentry>\r
  77           <term>\r
  78             <literal>%image</literal>\r
  79           </term>\r
  80           <listitem>\r
  81             expands to all files listed in class\r
  82             <emphasis>Image</emphasis>\r
  83             ,\r
  84           </listitem>\r
  85         </varlistentry>\r
  86         <varlistentry>\r
  87           <term>\r
  88             <literal>%raw</literal>\r
  89           </term>\r
  90           <listitem>\r
  91             expands to all files listed in class\r
  92             <emphasis>RAW Image</emphasis>\r
  93           </listitem>\r
  94         </varlistentry>\r
  95         <varlistentry>\r
  96           <term>\r
  97             <literal>%meta</literal>\r
  98           </term>\r
  99           <listitem>\r
 100             expands to all files listed in class\r
 101             <emphasis>Metadata</emphasis>\r
 102           </listitem>\r
 103         </varlistentry>\r
 104       </variablelist>\r
 105     </para>\r
 106     <para />\r
 107     <para />\r
 108   </section>\r
 109   <section id="Filetypes">\r
 110     <title>File types</title>\r
 111     <para>\r
 112       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\r
 113       <keycap>Enter</keycap>\r
 114       ; press\r
 115       <keycap>Escape</keycap>\r
 116       to cancel an active edit.\r
 117     </para>\r
 118     <note>\r
 119       <para>Unlike all other options in the dialogue, filter list changes are applied immediately.</para>\r
 120     </note>\r
 121     <para>\r
 122       The table consists of:\r
 123       <variablelist>\r
 124         <varlistentry>\r
 125           <term>\r
 126             <guilabel>Filter</guilabel>\r
 127           </term>\r
 128           <listitem>\r
 129             List of extensions this filter applies to, separated by a\r
 130             <code>;</code>\r
 131             . Each extension must be preceded by a dot.\r
 132           </listitem>\r
 133         </varlistentry>\r
 134         <varlistentry>\r
 135           <term>\r
 136             <guilabel>Description</guilabel>\r
 137           </term>\r
 138           <listitem>Brief description. This is not used elsewhere.</listitem>\r
 139         </varlistentry>\r
 140         <varlistentry>\r
 141           <term>\r
 142             <guilabel>Class</guilabel>\r
 143           </term>\r
 144           <listitem>\r
 145             This may be used to define sets of file types, for use in the\r
 146             <emphasis>Grouping</emphasis>\r
 147             function described above. The drop-down list has 4 entries:\r
 148             <itemizedlist>\r
 149               <listitem>Unknown</listitem>\r
 150               <listitem>Image</listitem>\r
 151               <listitem>RAW Image</listitem>\r
 152               <listitem>Metadata</listitem>\r
 153             </itemizedlist>\r
 154           </listitem>\r
 155         </varlistentry>\r
 156         <varlistentry>\r
 157           <term>\r
 158             <guilabel>Writable</guilabel>\r
 159           </term>\r
 160           <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>\r
 161         </varlistentry>\r
 162         <varlistentry>\r
 163           <term>\r
 164             <guilabel>Sidecar is allowed</guilabel>\r
 165           </term>\r
 166           <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>\r
 167         </varlistentry>\r
 168       </variablelist>\r
 169     </para>\r
 170     <variablelist>\r
 171       <varlistentry>\r
 172         <term>\r
 173           <guibutton>\r
 174             <guiicon>\r
 175               <inlinegraphic fileref="list-add.png" />\r
 176             </guiicon>\r
 177             Add\r
 178           </guibutton>\r
 179         </term>\r
 180         <listitem>Adds a new blank line to the filter list, change the parameters to match the desired file type.</listitem>\r
 181       </varlistentry>\r
 182     </variablelist>\r
 183     <variablelist>\r
 184       <varlistentry>\r
 185         <term>\r
 186           <guibutton>\r
 187             <guiicon>\r
 188               <inlinegraphic fileref="list-remove.png" />\r
 189             </guiicon>\r
 190             Remove\r
 191           </guibutton>\r
 192         </term>\r
 193         <listitem>Removes the selected line from the filter list.</listitem>\r
 194       </varlistentry>\r
 195     </variablelist>\r
 196     <variablelist>\r
 197       <varlistentry>\r
 198         <term>\r
 199           <guibutton>Defaults</guibutton>\r
 200         </term>\r
 201         <listitem>Resets the filter list to the default values, discarding any customizations made by the user.</listitem>\r
 202       </varlistentry>\r
 203     </variablelist>\r
 204   </section>\r
 205 </section>\r