tris/recoll
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc

Browse Source
This commit is contained in:
Jean-Francois Dockes 2019-03-19 14:21:48 +01:00
parent 2606d78b18
commit 4330ea85aa
2 changed files with 159 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
src/doc/user/usermanual.html
View File

@ -9713,21 +9713,87 @@ for i in range(nres):
</div> </div>
</div> </div>
</div> </div>
<p><code class="filename">mimeconf</code> specifies how <p>The main purpose of the <code class=
the different MIME types are handled for indexing, and "filename">mimeconf</code> file is to specify how the
which icons are displayed in the <span class= different MIME types are handled for indexing. This is
"command"><strong>recoll</strong></span> result done in the <code class="literal">[index]</code> section,
lists.</p> which should not be modified casually. See the comments
<p>Changing the parameters in the [index] section is in the file.</p>
probably not a good idea except if you are a <span class= <p>The file also contains other definitions which affect
"application">Recoll</span> developer.</p> the query language and the GUI, and which, in retrospect,
<p>The [icons] section allows you to change the icons should have been stored elsewhere.</p>
which are displayed by <span class= <p>The <code class="literal">[icons]</code> section
"command"><strong>recoll</strong></span> in the result allows you to change the icons which are displayed by the
lists (the values are the basenames of the png images <span class="command"><strong>recoll</strong></span> GUI
inside the <code class="filename">iconsdir</code> in the result lists (the values are the basenames of the
directory (specified in <code class= <code class="literal">png</code> images inside the
<code class="filename">iconsdir</code> directory (which
is itself defined in <code class=
"filename">recoll.conf</code>).</p> "filename">recoll.conf</code>).</p>
<p>The <code class="literal">[categories]</code> section
defines the groupings of MIME types into <code class=
"literal">categories</code> as used when adding an
<code class="literal">rclcat</code> clause to a <a class=
"link" href="#RCL.SEARCH.LANG" title=
"3.6.&nbsp;The query language">query language</a> query.
<code class="literal">rclcat</code> clauses are also used
by the default <code class="literal">guifilters</code>
buttons in the GUI (see next).</p>
<p>The filter controls appear at the top of the
<span class="command"><strong>recoll</strong></span> GUI,
either as checkboxes just above the result list, or as a
dropbox in the tool area.</p>
<p>By default, they are labeled: <code class=
"literal">media</code>, <code class=
"literal">message</code>, <code class=
"literal">other</code>, <code class=
"literal">presentation</code>, <code class=
"literal">spreadsheet</code> and <code class=
"literal">text</code>, and each maps to a document
category. This is determined in the <code class=
"literal">[guifilters]</code> section, where each control
is defined by a variable naming a query language
fragment.</p>
<p>A simple exemple will hopefully make things
clearer.</p>
<pre class="programlisting">[guifilters]
Big Books = dir:"~/My Books" size&gt;10K
My Docs = dir:"~/My Documents"
Small Books = dir:"~/My Books" size&lt;10K
System Docs = dir:/usr/share/doc
</pre>
<p>The above definition would create four filter
checkboxes, labelled <code class="literal">Big
Books</code>, <code class="literal">My Docs</code>,
etc.</p>
<p>The text after the equal sign must be a valid query
language fragment, and, when the button is checked, it
will be combined with the rest of the query with an AND
conjunction.</p>
<p>Any name text before a colon character will be erased
in the display, but used for sorting. You can use this to
display the checkboxes in any order you like. For
exemple, the following would do exactly the same as
above, but ordering the checkboxes in the reverse
order.</p>
<pre class="programlisting">[guifilters]
d:Big Books = dir:"~/My Books" size&gt;10K
c:My Docs = dir:"~/My Documents"
b:Small Books = dir:"~/My Books" size&lt;10K
a:System Docs = dir:/usr/share/doc
</pre>
<p>As you may have guessed, The default <code class=
"literal">[guifilters]</code> section looks like:</p>
<pre class="programlisting">[guifilters]
text = rclcat:text
spreadsheet = rclcat:spreadsheet
presentation = rclcat:presentation
media = rclcat:media
message = rclcat:message
other = rclcat:other
</pre>
</div> </div>
<div class="sect2"> <div class="sect2">
<div class="titlepage"> <div class="titlepage">

90
src/doc/user/usermanual.xml
View File

@ -6544,22 +6544,90 @@ for i in range(nres):
<sect2 id="RCL.INSTALL.CONFIG.MIMECONF"> <sect2 id="RCL.INSTALL.CONFIG.MIMECONF">
<title>The mimeconf file</title> <title>The mimeconf file</title>
<para><filename>mimeconf</filename> specifies how the <para>The main purpose of the <filename>mimeconf</filename> file is
different MIME types are handled for indexing, and which icons to specify how the different MIME types are handled for
are displayed in the <command>recoll</command> result lists.</para> indexing. This is done in the <literal>[index]</literal>
section, which should not be modified casually. See the comments in
the file.</para>
<para>Changing the parameters in the [index] section is <para>The file also contains other definitions which affect the
probably not a good idea except if you are a &RCL; query language and the GUI, and which, in retrospect, should have
developer.</para> been stored elsewhere.</para>
<para>The [icons] section allows you to change the icons which <para>The <literal>[icons]</literal> section allows you to change
are displayed by <command>recoll</command> in the result the icons which are displayed by the <command>recoll</command> GUI
lists (the values are the basenames of the png images inside in the result lists (the values are the basenames of the
the <filename>iconsdir</filename> directory (specified in <literal>png</literal> images inside the
<filename>recoll.conf</filename>).</para> <filename>iconsdir</filename> directory (which is itself defined
in <filename>recoll.conf</filename>).</para>
<para>The <literal>[categories]</literal> section defines the
groupings of MIME types into <literal>categories</literal> as used
when adding an <literal>rclcat</literal> clause to a
<link linkend="RCL.SEARCH.LANG">query language</link>
query. <literal>rclcat</literal> clauses are also used by the
default <literal>guifilters</literal> buttons in the GUI (see
next).</para>
<para>The filter controls appear at the top of the
<command>recoll</command> GUI, either as checkboxes just above the
result list, or as a dropbox in the tool area.</para>
<para>By default, they are labeled: <literal>media</literal>,
<literal>message</literal>, <literal>other</literal>,
<literal>presentation</literal>, <literal>spreadsheet</literal> and
<literal>text</literal>, and each maps to a document category. This
is determined in the <literal>[guifilters]</literal> section, where
each control is defined by a variable naming a query language
fragment.</para>
<para>A simple exemple will hopefully make things clearer.</para>
<programlisting>[guifilters]
Big Books = dir:"~/My Books" size&gt;10K
My Docs = dir:"~/My Documents"
Small Books = dir:"~/My Books" size&lt;10K
System Docs = dir:/usr/share/doc
</programlisting>
<para>The above definition would create four filter checkboxes,
labelled <literal>Big Books</literal>, <literal>My Docs</literal>,
etc.</para>
<para>The text after the equal sign must be a valid query language
fragment, and, when the button is checked, it will be combined with
the rest of the query with an AND conjunction.</para>
<para>Any name text before a colon character will be erased in the
display, but used for sorting. You can use this to display the
checkboxes in any order you like. For exemple, the following would
do exactly the same as above, but ordering the checkboxes in the
reverse order.</para>
<programlisting>[guifilters]
d:Big Books = dir:"~/My Books" size&gt;10K
c:My Docs = dir:"~/My Documents"
b:Small Books = dir:"~/My Books" size&lt;10K
a:System Docs = dir:/usr/share/doc
</programlisting>
<para>As you may have guessed, The default
<literal>[guifilters]</literal> section looks like:</para>
<programlisting>[guifilters]
text = rclcat:text
spreadsheet = rclcat:spreadsheet
presentation = rclcat:presentation
media = rclcat:media
message = rclcat:message
other = rclcat:other
</programlisting>
</sect2> </sect2>
<sect2 id="RCL.INSTALL.CONFIG.MIMEVIEW"> <sect2 id="RCL.INSTALL.CONFIG.MIMEVIEW">
<title>The mimeview file</title> <title>The mimeview file</title>