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