|
a/src/README |
|
b/src/README |
|
... |
|
... |
| 90 |
|
90 |
|
| 91 |
3.3. Searching on the command line
|
91 |
3.3. Searching on the command line
|
| 92 |
|
92 |
|
| 93 |
3.4. The query language
|
93 |
3.4. The query language
|
| 94 |
|
94 |
|
|
|
95 |
3.4.1. Modifiers
|
|
|
96 |
|
|
|
97 |
3.5. Anchored searches and wildcards
|
|
|
98 |
|
| 95 |
3.4.1. More about wildcards
|
99 |
3.5.1. More about wildcards
|
| 96 |
|
100 |
|
|
|
101 |
3.5.2. Anchored searches
|
|
|
102 |
|
| 97 |
3.5. Desktop integration
|
103 |
3.6. Desktop integration
|
| 98 |
|
104 |
|
| 99 |
3.5.1. Hotkeying recoll
|
105 |
3.6.1. Hotkeying recoll
|
| 100 |
|
106 |
|
| 101 |
3.5.2. The KDE Kicker Recoll applet
|
107 |
3.6.2. The KDE Kicker Recoll applet
|
| 102 |
|
108 |
|
| 103 |
4. Programming interface
|
109 |
4. Programming interface
|
| 104 |
|
110 |
|
| 105 |
4.1. Writing a document filter
|
111 |
4.1. Writing a document filter
|
| 106 |
|
112 |
|
|
... |
|
... |
| 1658 |
configuration, so that the exact field search possibilities may be
|
1664 |
configuration, so that the exact field search possibilities may be
|
| 1659 |
different for you if someone took care of the customisation.
|
1665 |
different for you if someone took care of the customisation.
|
| 1660 |
|
1666 |
|
| 1661 |
----------------------------------------------------------------------
|
1667 |
----------------------------------------------------------------------
|
| 1662 |
|
1668 |
|
|
|
1669 |
3.4.1. Modifiers
|
|
|
1670 |
|
|
|
1671 |
Some characters are recognized as search modifiers when found immediately
|
|
|
1672 |
after the closing double quote of a phrase, as in "some
|
|
|
1673 |
term"modifierchars. The actual "phrase" can be a single term of course.
|
|
|
1674 |
Supported modifiers:
|
|
|
1675 |
|
|
|
1676 |
* l can be used to turn off stemming (mostly makes sense with p because
|
|
|
1677 |
stemming is off by default for phrases).
|
|
|
1678 |
|
|
|
1679 |
* o can be used to specify a "slack" for phrase and proximity searches:
|
|
|
1680 |
the number of additional terms that may be found between the specified
|
|
|
1681 |
ones. If o is followed by an integer number, this is the slack, else
|
|
|
1682 |
the default is 10.
|
|
|
1683 |
|
|
|
1684 |
* p can be used to turn the default phrase search into a proximity one
|
|
|
1685 |
(unordered). Example:"order any in"p
|
|
|
1686 |
|
|
|
1687 |
* A weight can be specified for a query element by specifying a decimal
|
|
|
1688 |
value at the start of the modifiers. Example: "Important"2.5.
|
|
|
1689 |
|
|
|
1690 |
----------------------------------------------------------------------
|
|
|
1691 |
|
|
|
1692 |
3.5. Anchored searches and wildcards
|
|
|
1693 |
|
|
|
1694 |
Some special characters are interpreted by Recoll in search strings to
|
|
|
1695 |
expand or specialize the search. Wildcards expand a root term in
|
|
|
1696 |
controlled ways. Anchor characters can restrict a search to succeed only
|
|
|
1697 |
if the match is found at or near the beginning of the document or one of
|
|
|
1698 |
its fields.
|
|
|
1699 |
|
|
|
1700 |
----------------------------------------------------------------------
|
|
|
1701 |
|
| 1663 |
3.4.1. More about wildcards
|
1702 |
3.5.1. More about wildcards
|
| 1664 |
|
1703 |
|
| 1665 |
All words entered in Recoll search fields will be processed for wildcard
|
1704 |
All words entered in Recoll search fields will be processed for wildcard
|
| 1666 |
expansion before the request is finally executed.
|
1705 |
expansion before the request is finally executed.
|
| 1667 |
|
1706 |
|
| 1668 |
The wildcard characters are:
|
1707 |
The wildcard characters are:
|
|
... |
|
... |
| 1689 |
expansion will produce better results than an ending * (stem expansion
|
1728 |
expansion will produce better results than an ending * (stem expansion
|
| 1690 |
is turned off when any wildcard character appears in the term).
|
1729 |
is turned off when any wildcard character appears in the term).
|
| 1691 |
|
1730 |
|
| 1692 |
----------------------------------------------------------------------
|
1731 |
----------------------------------------------------------------------
|
| 1693 |
|
1732 |
|
|
|
1733 |
3.5.2. Anchored searches
|
|
|
1734 |
|
|
|
1735 |
Two characters are used to specify that a search hit should occur at the
|
|
|
1736 |
beginning or at the end of the text. ^ at the beginning of a term or
|
|
|
1737 |
phrase constrains the search to happen at the start, $ at the end force it
|
|
|
1738 |
to happen at the end.
|
|
|
1739 |
|
|
|
1740 |
As this function is implemented as a phrase search it is possible to
|
|
|
1741 |
specify a maximum distance at which the hit should occur, either through
|
|
|
1742 |
the controls of the advanced search panel, or using the query language,
|
|
|
1743 |
for example, as in:
|
|
|
1744 |
|
|
|
1745 |
"^someterm"o10
|
|
|
1746 |
|
|
|
1747 |
which would force someterm to be found within 10 terms of the start of the
|
|
|
1748 |
text. This can be combined with a field search as in
|
|
|
1749 |
somefield:"^someterm"o10 or somefield:someterm$.
|
|
|
1750 |
|
|
|
1751 |
This feature can also be used with an actual phrase search, but in this
|
|
|
1752 |
case, the distance applies to the whole phrase and anchor, so that, for
|
|
|
1753 |
example, bla bla my unexpected term at the beginning of the text would be
|
|
|
1754 |
a match for "^my term"o5.
|
|
|
1755 |
|
|
|
1756 |
----------------------------------------------------------------------
|
|
|
1757 |
|
| 1694 |
3.5. Desktop integration
|
1758 |
3.6. Desktop integration
|
| 1695 |
|
1759 |
|
| 1696 |
Being independant of the desktop type has its drawbacks: Recoll desktop
|
1760 |
Being independant of the desktop type has its drawbacks: Recoll desktop
|
| 1697 |
integration is minimal. Here follow a few things that may help.
|
1761 |
integration is minimal. Here follow a few things that may help.
|
| 1698 |
|
1762 |
|
| 1699 |
----------------------------------------------------------------------
|
1763 |
----------------------------------------------------------------------
|
| 1700 |
|
1764 |
|
| 1701 |
3.5.1. Hotkeying recoll
|
1765 |
3.6.1. Hotkeying recoll
|
| 1702 |
|
1766 |
|
| 1703 |
It is surprisingly convenient to be able to show or hide the Recoll GUI
|
1767 |
It is surprisingly convenient to be able to show or hide the Recoll GUI
|
| 1704 |
with a single keystroke. Recoll comes with a small Python script, based on
|
1768 |
with a single keystroke. Recoll comes with a small Python script, based on
|
| 1705 |
the libwnck window manager interface library, which will allow you to do
|
1769 |
the libwnck window manager interface library, which will allow you to do
|
| 1706 |
just this. The detailed instructions are on this wiki page.
|
1770 |
just this. The detailed instructions are on this wiki page.
|
| 1707 |
|
1771 |
|
| 1708 |
----------------------------------------------------------------------
|
1772 |
----------------------------------------------------------------------
|
| 1709 |
|
1773 |
|
| 1710 |
3.5.2. The KDE Kicker Recoll applet
|
1774 |
3.6.2. The KDE Kicker Recoll applet
|
| 1711 |
|
1775 |
|
| 1712 |
The Recoll source tree contains the source code to the recoll_applet, a
|
1776 |
The Recoll source tree contains the source code to the recoll_applet, a
|
| 1713 |
small application derived from the find_applet. This can be used to add a
|
1777 |
small application derived from the find_applet. This can be used to add a
|
| 1714 |
small Recoll launcher to the KDE panel.
|
1778 |
small Recoll launcher to the KDE panel.
|
| 1715 |
|
1779 |
|