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

make ssearch a combobox

Browse Source
This commit is contained in:
dockes 2006-04-27 09:23:10 +00:00
parent 42ce501ce1
commit e3332fcfa5
6 changed files with 203 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
src/doc/user/usermanual.sgml
View File

@ -24,7 +24,7 @@
Dockes</holder> Dockes</holder>
</copyright> </copyright>
<releaseinfo>$Id: usermanual.sgml,v 1.12 2006-04-08 14:00:14 dockes Exp $</releaseinfo> <releaseinfo>$Id: usermanual.sgml,v 1.13 2006-04-27 09:23:10 dockes Exp $</releaseinfo>
<abstract> <abstract>
<para>This document introduces full text search notions <para>This document introduces full text search notions
@ -247,6 +247,26 @@
<para>The index data directory only contains data that will be <para>The index data directory only contains data that will be
rebuilt by an index run, so that it can be destroyed safely.</para> rebuilt by an index run, so that it can be destroyed safely.</para>
<sect2 id="rcl.indexing.storage.security">
<title>Security aspects</title>
<para>The &RCL; index does not hold copies of the indexed
documents. But it does hold enough data to allow for an almost
complete reconstruction. If confidential data is indexed,
access to the database directory should be restricted. </para>
<para>As of version 1.4, &RCL; will create the configuration
directory with a mode of 0700 (access by owner only). As the
index directory is by default a subdirectory of the
configuration directory, this should result in appropriate
protection. </para>
<para>If you use another setup, you should think of the kind
of protection you need for your index, and set the directory
access modes appropriately.</para>
</sect2>
</sect1> </sect1>
<sect1 id="rcl.indexing.config"> <sect1 id="rcl.indexing.config">
@ -354,6 +374,12 @@
(<literal>*</literal>, <literal>?</literal> , (<literal>*</literal>, <literal>?</literal> ,
<literal>[]</literal>). </para> <literal>[]</literal>). </para>
<para>&RCL; remembers the last few searches that you
performed. You can use the simple search text entry widget (a
combobox) to recall them (click on the thing at the right of the
text field). Please note, however, that only the search texts
are remembered, not the mode (all/any/filename).</para>
<para>You can use the <guilabel>Tools</guilabel> / <guilabel>Advanced <para>You can use the <guilabel>Tools</guilabel> / <guilabel>Advanced
search</guilabel> dialog for more complex searches.</para> search</guilabel> dialog for more complex searches.</para>
@ -413,6 +439,35 @@
</sect1> </sect1>
<sect1 id="rcl.search.multidb">
<title>Multiple databases</title>
<para>Your &RCL; configuration always defines a main index. This
is what gets updated, for example, when you execute
<command>recollindex</command>. </para>
<para>You can use the <link
linkend="rcl.search.custom.extradb">search configuration
tool</link> to define additional databases to be searched. These
databases can be made active or inactive at any moment.</para>
<para>The typical use of this feature is for a system
administrator to set up a central index, that you may choose to
search, or not, in addition to your personal data. Of course,
there are other possibilities.</para>
<para>The main index (defined by your personal configuration) is
always active.</para>
<para>The list of searchable databases may also be defined by
the <literal>RECOLL_EXTRA_DBS</literal> environment
variable. This should hold a colon-separated list of index
directories, ie:
<screen>export RECOLL_EXTRA_DBS=/some/place/xapiandb:/some/other/db</screen>
</para>
</sect1>
<sect1 id="rcl.search.history"> <sect1 id="rcl.search.history">
<title>Document history</title> <title>Document history</title>
@ -444,6 +499,35 @@
</sect1> </sect1>
<sect1 id="rcl.search.resultlist">
<title>Additional result list functionality</title>
<para>Apart from the preview and edit links, you can display a
popup menu by right-clicking over a paragraph in the result
list. This menu has the following entries:</para>
<itemizedlist>
<listitem><para><guilabel>Preview</guilabel></para></listitem>
<listitem><para><guilabel>Edit</guilabel></para></listitem>
<listitem><para><guilabel>Copy File Name</guilabel></para></listitem>
<listitem><para><guilabel>Copy Url</guilabel></para></listitem>
<listitem><para><guilabel>More like this</guilabel></para></listitem>
</itemizedlist>
<para>The <guilabel>Preview</guilabel> and
<guilabel>Edit</guilabel> entries do the same thing as the
corresponding links. The two following entries will copy either
an url or the file path to the clipboard, for pasting into
another application.</para>
<para>The <guilabel>More like this</guilabel> entry will select
a number of relevant term from the current document and enter
them into the simple search field. You can then start a simple
search, with a good chance of finding documents related to the
current result.</para>
</sect1>
<sect1 id="rcl.search.tips"> <sect1 id="rcl.search.tips">
<title>Search tips, shortcuts</title> <title>Search tips, shortcuts</title>
@ -466,6 +550,28 @@
search dialog to the same effect.</para> search dialog to the same effect.</para>
</formalpara> </formalpara>
<formalpara><title>Term completion</title>
<para>Typing <keycap>^TAB</keycap> (Control+Tab) in the simple
search entry field while entering a word will either complete
the current word if its beginning matches a unique term in the
index, or open a window to propose a list of completions</para>
</formalpara>
<formalpara><title>Picking up new terms for search from displayed
documents</title>
<para>Double-clicking on a word in the result list or in a
preview window will copy it to the simple search entry field.</para>
</formalpara>
<formalpara><title>Finding related documents</title>
<para>Selecting the <guilabel>More like this</guilabel> entry
in the result list paragraph right-click menu will select a
set of "interesting" terms from the current result, and insert
them into the simple search entry field. You can then possibly
edit the list and start a search to find documents which may
be apparented to the current result.</para>
</formalpara>
<formalpara><title>Query explanation</title> <formalpara><title>Query explanation</title>
<para>You can get an exact description of what the query <para>You can get an exact description of what the query
looked for, including stem expansion, and boolean operators looked for, including stem expansion, and boolean operators
@ -486,11 +592,13 @@
<para>Entering <keycap>^Q</keycap> almost anywhere will <para>Entering <keycap>^Q</keycap> almost anywhere will
close the application.</para> close the application.</para>
</formalpara> </formalpara>
<formalpara><title>Closing previews</title> <formalpara><title>Closing previews</title>
<para>Entering <keycap>^W</keycap> in a preview tab will <para>Entering <keycap>^W</keycap> in a preview tab will
close it (and, for the last tab, close the preview close it (and, for the last tab, close the preview
window).</para> window).</para>
</formalpara> </formalpara>
</sect1> </sect1>
<sect1 id="rcl.search.custom"> <sect1 id="rcl.search.custom">
@ -504,7 +612,8 @@
interface itself, and with the parameters used for searching and interface itself, and with the parameters used for searching and
returning results.</para> returning results.</para>
<para>User interface parameters:</para> <formalpara><title>User interface parameters:</title>
<para>
<itemizedlist> <itemizedlist>
<listitem><para><guilabel>Number of results in a result <listitem><para><guilabel>Number of results in a result
@ -524,15 +633,28 @@
manual. You can enter a simple name if the command is in your manual. You can enter a simple name if the command is in your
PATH, or browse for a full pathname.</para> PATH, or browse for a full pathname.</para>
</listitem> </listitem>
<listitem><para><guilabel>Show document type icons in result <listitem><para><guilabel>Show document type icons in result
list</guilabel>: icons in the result list can be turned list</guilabel>: icons in the result list can be turned
off. They take quite a lot of space and convey relatively off. They take quite a lot of space and convey relatively
little useful information.</para> little useful information.</para>
</listitem> </listitem>
<listitem><para><guilabel>Auto-start simple search on
whitespace entry</guilabel>: if this is checked, a search will
be executed each time you enter a space in the simple search
input field. This lets you look at the result list as you
enter new terms. This is off by default, you may like it or
not...</para>
</listitem>
</itemizedlist> </itemizedlist>
</para>
</formalpara>
<para>Search parameters:</para>
<formalpara><title>Search parameters:</title>
<para>
<itemizedlist> <itemizedlist>
<listitem><para><guilabel>Stemming language</guilabel>: <listitem><para><guilabel>Stemming language</guilabel>:
stemming obviously depends on the document's language. This stemming obviously depends on the document's language. This
@ -560,6 +682,28 @@
within the document itself.</para> within the document itself.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para>
</formalpara>
<formalpara id="rcl.search.custom.extradb"><title>Extra
databases:</title>
<para></para>
</formalpara>
<para>This panel will let you browse for additional databases
that you may want to search. Extra databases are designated by
their database directory (ie:
<filename>/home/someothergui/.recoll/xapiandb</filename>,
<filename>/usr/local/recollglobal/xapiandb</filename>).</para>
<para>Once entered, the databases will appear in the
<guilabel>All extra databases</guilabel> list, and you can
chose which ones you want to use at any moment by tranferring
them to/from the <guilabel>Active extra databases</guilabel>
list.</para>
<para>Your main database (the one the current configuration
indexes to), is always implicitely active. If this is not
desirable, you can set up your configuration so that it indexes,
for example, an empty directory.</para>
</sect1> </sect1>
@ -577,7 +721,7 @@
<para>At the very least, you will need to download and install the <para>At the very least, you will need to download and install the
<ulink url="http://www.xapian.org">xapian core package</ulink> <ulink url="http://www.xapian.org">xapian core package</ulink>
(&RCL; currently uses version 0.9.2), and the <ulink (&RCL; development currently uses version 0.9.5), and the <ulink
url="http://www.trolltech.com/products/qt/index.html">qt url="http://www.trolltech.com/products/qt/index.html">qt
runtime and development packages</ulink> (&RCL; development runtime and development packages</ulink> (&RCL; development
currently uses version 3.3.5, but any 3.3 version is currently uses version 3.3.5, but any 3.3 version is

11
src/qtgui/guiutils.cpp
View File

@ -1,5 +1,5 @@
#ifndef lint #ifndef lint
static char rcsid[] = "@(#$Id: guiutils.cpp,v 1.9 2006-04-18 08:53:28 dockes Exp $ (C) 2005 Jean-Francois Dockes"; static char rcsid[] = "@(#$Id: guiutils.cpp,v 1.10 2006-04-27 09:23:10 dockes Exp $ (C) 2005 Jean-Francois Dockes";
#endif #endif
/* /*
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -141,6 +141,15 @@ void rwSettings(bool writing)
SETTING_RW(prefs.queryReplaceAbstract, SETTING_RW(prefs.queryReplaceAbstract,
"/Recoll/prefs/query/replaceAbstract", Bool, false); "/Recoll/prefs/query/replaceAbstract", Bool, false);
// Ssearch combobox history list
if (writing) {
settings.writeEntry("/Recoll/prefs/query/ssearchHistory",
prefs.ssearchHistory);
} else {
prefs.ssearchHistory =
settings.readListEntry("/Recoll/prefs/query/ssearchHistory");
}
// The extra databases settings. These are stored as a list of // The extra databases settings. These are stored as a list of
// xapian directory names, encoded in base64 to avoid any // xapian directory names, encoded in base64 to avoid any
// binary/charset conversion issues. There are 2 lists for all // binary/charset conversion issues. There are 2 lists for all

5
src/qtgui/guiutils.h
View File

@ -17,7 +17,7 @@
#ifndef _GUIUTILS_H_INCLUDED_ #ifndef _GUIUTILS_H_INCLUDED_
#define _GUIUTILS_H_INCLUDED_ #define _GUIUTILS_H_INCLUDED_
/* /*
* @(#$Id: guiutils.h,v 1.5 2006-04-18 08:53:28 dockes Exp $ (C) 2005 Jean-Francois Dockes * @(#$Id: guiutils.h,v 1.6 2006-04-27 09:23:10 dockes Exp $ (C) 2005 Jean-Francois Dockes
* jean-francois.dockes@wanadoo.fr * jean-francois.dockes@wanadoo.fr
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -39,6 +39,7 @@
#include <string> #include <string>
#include <list> #include <list>
#include <qstring.h> #include <qstring.h>
#include <qstringlist.h>
#ifndef NO_NAMESPACES #ifndef NO_NAMESPACES
using std::string; using std::string;
@ -67,6 +68,8 @@ class PrefsPack {
// to the qt settings file to avoid any bin string/ charset conv issues // to the qt settings file to avoid any bin string/ charset conv issues
list<string> allExtraDbs; list<string> allExtraDbs;
list<string> activeExtraDbs; list<string> activeExtraDbs;
// Textual history of simple searches (this is just the combobox list)
QStringList ssearchHistory;
PrefsPack() : PrefsPack() :
showicons(true), showicons(true),

14
src/qtgui/rclmain.cpp
View File

@ -1,5 +1,5 @@
#ifndef lint #ifndef lint
static char rcsid[] = "@(#$Id: rclmain.cpp,v 1.26 2006-04-27 06:12:10 dockes Exp $ (C) 2005 J.F.Dockes"; static char rcsid[] = "@(#$Id: rclmain.cpp,v 1.27 2006-04-27 09:23:10 dockes Exp $ (C) 2005 J.F.Dockes";
#endif #endif
/* /*
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -457,9 +457,9 @@ void RclMain::ssearchAddTerm(QString term)
return; return;
term = QString::fromUtf8(t.c_str()); term = QString::fromUtf8(t.c_str());
QString text = sSearch->queryText->text(); QString text = sSearch->queryText->currentText();
text += QString::fromLatin1(" ") + term; text += QString::fromLatin1(" ") + term;
sSearch->queryText->setText(text); sSearch->queryText->setEditText(text);
} }
void RclMain::startNativeViewer(int docnum) void RclMain::startNativeViewer(int docnum)
@ -543,12 +543,16 @@ void RclMain::docExpand(int docnum)
list<string> terms; list<string> terms;
terms = rcldb->expand(doc); terms = rcldb->expand(doc);
// Do we keep the original query. I think we'd better not. // Do we keep the original query. I think we'd better not.
QString text;// = sSearch->queryText->text(); // rcldb->expand is set to keep the original query terms instead.
QString text;// = sSearch->queryText->currentText();
for (list<string>::iterator it = terms.begin(); it != terms.end(); it++) { for (list<string>::iterator it = terms.begin(); it != terms.end(); it++) {
text += QString::fromLatin1(" \"") + text += QString::fromLatin1(" \"") +
QString::fromUtf8((*it).c_str()) + QString::fromLatin1("\""); QString::fromUtf8((*it).c_str()) + QString::fromLatin1("\"");
} }
sSearch->queryText->setText(text); // We need to insert item here, its not auto-done like when the user types
// CR
sSearch->queryText->setEditText(text);
sSearch->queryText->insertItem(text, 0);
sSearch->setAnyTermMode(); sSearch->setAnyTermMode();
sSearch->startSimpleSearch(); sSearch->startSimpleSearch();
} }

39
src/qtgui/ssearchb.ui
View File

@ -72,7 +72,7 @@
<string>Choose type of search: any term, all terms, filename with possible wildcards.</string> <string>Choose type of search: any term, all terms, filename with possible wildcards.</string>
</property> </property>
</widget> </widget>
<widget class="QLineEdit"> <widget class="QComboBox">
<property name="name"> <property name="name">
<cstring>queryText</cstring> <cstring>queryText</cstring>
</property> </property>
@ -90,11 +90,20 @@
<height>0</height> <height>0</height>
</size> </size>
</property> </property>
<property name="frameShape"> <property name="editable">
<enum>LineEditPanel</enum> <bool>true</bool>
</property> </property>
<property name="frameShadow"> <property name="sizeLimit">
<enum>Sunken</enum> <number>20</number>
</property>
<property name="maxCount">
<number>30</number>
</property>
<property name="insertionPolicy">
<enum>AtTop</enum>
</property>
<property name="duplicatesEnabled">
<bool>false</bool>
</property> </property>
<property name="toolTip" stdset="0"> <property name="toolTip" stdset="0">
<string>Enter search terms here</string> <string>Enter search terms here</string>
@ -111,24 +120,6 @@
<receiver>SSearchBase</receiver> <receiver>SSearchBase</receiver>
<slot>startSimpleSearch()</slot> <slot>startSimpleSearch()</slot>
</connection> </connection>
<connection>
<sender>queryText</sender>
<signal>returnPressed()</signal>
<receiver>SSearchBase</receiver>
<slot>startSimpleSearch()</slot>
</connection>
<connection>
<sender>queryText</sender>
<signal>textChanged(const QString&amp;)</signal>
<receiver>SSearchBase</receiver>
<slot>searchTextChanged(const QString&amp;)</slot>
</connection>
<connection>
<sender>clearqPB</sender>
<signal>clicked()</signal>
<receiver>queryText</receiver>
<slot>clear()</slot>
</connection>
</connections> </connections>
<includes> <includes>
<include location="local" impldecl="in declaration">recoll.h</include> <include location="local" impldecl="in declaration">recoll.h</include>
@ -145,9 +136,9 @@
</slots> </slots>
<functions> <functions>
<function>init()</function> <function>init()</function>
<function>setAnyTermMode()</function>
<function>completion()</function> <function>completion()</function>
<function returnType="bool">event( QEvent * evt )</function> <function returnType="bool">event( QEvent * evt )</function>
<function>setAnyTermMode()</function>
</functions> </functions>
<layoutdefaults spacing="6" margin="0"/> <layoutdefaults spacing="6" margin="0"/>
</UI> </UI>

20
src/qtgui/ssearchb.ui.h
View File

@ -37,6 +37,14 @@ void SSearchBase::init()
searchTypCMB->insertItem(tr("Any term")); searchTypCMB->insertItem(tr("Any term"));
searchTypCMB->insertItem(tr("All terms")); searchTypCMB->insertItem(tr("All terms"));
searchTypCMB->insertItem(tr("File name")); searchTypCMB->insertItem(tr("File name"));
queryText->insertStringList(prefs.ssearchHistory);
queryText->setEditText("");
connect(queryText->lineEdit(), SIGNAL(returnPressed()),
this, SLOT(startSimpleSearch()));
connect(queryText->lineEdit(), SIGNAL(textChanged(const QString&)),
this, SLOT(searchTextChanged(const QString&)));
connect(clearqPB, SIGNAL(clicked()),
queryText->lineEdit(), SLOT(clear()));
} }
void SSearchBase::searchTextChanged( const QString & text ) void SSearchBase::searchTextChanged( const QString & text )
@ -48,7 +56,7 @@ void SSearchBase::searchTextChanged( const QString & text )
} else { } else {
searchPB->setEnabled(true); searchPB->setEnabled(true);
clearqPB->setEnabled(true); clearqPB->setEnabled(true);
string u8 = (const char *)queryText->text().utf8(); string u8 = (const char *)queryText->currentText().utf8();
if (prefs.autoSearchOnWS && !u8.empty() && u8[u8.length()-1] == ' ') if (prefs.autoSearchOnWS && !u8.empty() && u8[u8.length()-1] == ' ')
startSimpleSearch(); startSimpleSearch();
} }
@ -59,7 +67,7 @@ void SSearchBase::startSimpleSearch()
LOGDEB(("SSearchBase::startSimpleSearch\n")); LOGDEB(("SSearchBase::startSimpleSearch\n"));
Rcl::AdvSearchData sdata; Rcl::AdvSearchData sdata;
QCString u8 = queryText->text().utf8(); QCString u8 = queryText->currentText().utf8();
switch (searchTypCMB->currentItem()) { switch (searchTypCMB->currentItem()) {
case 0: case 0:
default: default:
@ -72,9 +80,13 @@ void SSearchBase::startSimpleSearch()
sdata.filename = u8; sdata.filename = u8;
break; break;
} }
prefs.ssearchHistory.clear();
for (int index = 0; index < queryText->count(); index++)
prefs.ssearchHistory.push_back(queryText->text(index));
emit startSearch(sdata); emit startSearch(sdata);
} }
void SSearchBase::setAnyTermMode() void SSearchBase::setAnyTermMode()
{ {
searchTypCMB->setCurrentItem(0); searchTypCMB->setCurrentItem(0);
@ -91,7 +103,7 @@ void SSearchBase::completion()
return; return;
} }
// Extract last word in text // Extract last word in text
string txt = (const char *)queryText->text().utf8(); string txt = (const char *)queryText->currentText().utf8();
string::size_type cs = txt.find_last_of(" "); string::size_type cs = txt.find_last_of(" ");
if (cs == string::npos) if (cs == string::npos)
cs = 0; cs = 0;
@ -131,7 +143,7 @@ void SSearchBase::completion()
if (ok) { if (ok) {
txt.erase(cs); txt.erase(cs);
txt.append(res.utf8()); txt.append(res.utf8());
queryText->setText(QString::fromUtf8(txt.c_str())); queryText->setEditText(QString::fromUtf8(txt.c_str()));
} else { } else {
return; return;
} }