View source for Nepomuk/kioslaves/search

This page documents how the features provided by the 'nepomuksearch' kioslave.

= Introduction =

Nepomuk allows the creation of custom search folders via the 'nepomuksearch' kioslave. This kioslave can understand a number of different queries based on the custom Nepomuk query language.

The syntax for using the kioslave is as follows - <tt>nepomuksearch:/?query='Query'</tt> or <tt>nepomuksearch:/Query</tt>. Here "Query" is the special Nepomuk query.

Though Nepomuk stores a lot of different information, this kioslave will only show information that can be represented as a file.

= Nepomuk Queries =

=== Simple Queries ===
The simplest queries are just simple strings that can be used for full text search. Example - <tt>nepomuksearch:/Coldplay</tt> will search for all the files which contain the word "Coldplay".

=== Tag Queries ===
You can look for files which have been tagged with certain tags by writing the following query -

<tt>nepomuksearch:/hasTag:KDE</tt>

=== Combining different Queries ===
Multiple queries can be combined with the AND and OR operators. For example - Searching for a file with multiple tags -
<tt>nepomuksearch:/hasTag:KDE and hasTag:Fire</tt>.

=== Negation ===
Certain properties of the query can be negated using the <tt>-</tt> operator.

Example - <tt>nepomuksearch:/hasTag:KDE and -hasTag:Fire</tt>. This will search for all the files which have the tag KDE and do not have the Fire.

=== Searchable Properties ===

<tt>hasTag</tt> is just one of the many properties that can be used for searching in Nepomuk. Here is a list of some of the most commonly used properties -

General Properties
* title: - The title of the file. Useful for documents
* filename - The filename
* hasTag:
* numericRating


Music Properties
* performer:
* musicAlbum:


Audio Properties
* duration:  - Has to be written in seconds
* channels - Generally 1/2


Image Properties
* width
* height
* flash
* whiteBalance
* isoSpeedRatings
* saturation
* model
* make
* sharpness
* orientation


== Search Operators ==

Nepomuk offers a variety of different operators that can be used be used:
* Contains - :
* Less - <
* Equal - =
* Greater >
* LessEqual - <=
* GreaterEqual - >=


Example - <tt>nepomuksearch:/rating<4 and width=320</tt>. This will search for all the files which have a rating less than 4 and a width of 320.