mod_search

See also

Search, Custom search

mod_search implements various ways of searching through the main resource table using m_search.

Configuration

There are two site configuration variables to tweak PostgreSQL text search settings.

mod_search.rank_behaviour

An integer representation to influence PostgreSQL search behaviour.

Default: 37 (1 | 4 | 32)

mod_search.rank_weight

A set of four numbers to override relative weights for the ABCD categories.

Default: {0.05, 0.25, 0.5, 1.0}

The following searches are implemented in mod_search:

NameDescriptionRequired arguments
queryVery powerful search with which you can implement almost all of the other search functionality. See: Search
facetsPerforms a query (see above) and then calculates facets. The facets are defined using the pivot/facet.tpl template. Facets are returned in the facets field of the search result. This shows per facet the counts for alternative values.
subfacetsPerforms a query (see above) and then calculates facets. The facets are defined using the pivot/facet.tpl template. Facets are returned in the facets field of the search result. This is a drill down where the facets are counted from the matching resources in the query. That means that only facet values that are in the result set are shown.
facet_valuesReturns an empty result with the facets field set to all possible values per facet, or the min/max range for a range facet.
featuredList of pages, featured ones first.
featuredList of pages in a category, featured ones first.cat
featuredList of pages in a category having a certain object, featured pages first.cat, object, predicate
latestThe newest pages.
latestThe newest pages within in a category.cat
upcomingSelects pages with future date_end.
upcoming_onSelects pages with date_end after the given time.datetime
upcoming_dateSelects pages with date_end after the given date.date
finishedSelects pages with a past date_end.
finished_onSelects pages with a date_end before the given time.datetime
finished_dateSelects pages with a date_end before the given date.date
unfinishedSelects pages with a date_end in the future.
unfinished_onSelects pages with a date_end after the given time.datetime
unfinished_dateSelects pages with a date_end after the given date.date
ongoingPages with past date_start and future date_end.
ongoing_onPages with a date_start - date_end range around the given time.datetime
ongoing_datePages with a date_start - date_end range around the given date.date
autocompleteFull text search where the last word gets a wildcard.text
autocompleteFull text search where the last word gets a wildcard, filtered by category.cat, text
fulltextFull text search. Returns {id,score} tuples.text
fulltextFull text search, filtered by category. Returns {id,score} tuples.cat, text
referrersAll subjects of a page.id
media_category_imageAll pages with a medium and within a certain category. Used to find category images.cat
media_category_depictionAll pages with a depiction edge to an image. Used to find category images.cat
mediaAll pages with a medium, ordered by descending creation date.
all_bytitleReturn all {title,id} pairs for a category, sorted on title.cat
all_bytitle_featuredReturn all {title,id} pairs for a category, sorted on title, featured pages firstcat
all_bytitleReturn all {title,id} pairs for a category without subcategories, sorted on title.cat_is
all_bytitle_featuredReturn all {title,id} pairs for a category without subcategories, sorted on title, featured pages first.cat_is
match_objectsReturns a list of pages with similar object ids to the objects of the given resource with the given id. Accepts optional cat parameters for filtering on category. Optionally accepts a predicate parameter to only use the objects that are connected to the given id using the predicate or predicates.id
match_objects_catsReturns a list of pages with similar object ids or categories. Accepts an optional cat parameter for filtering on category.id
archive_yearReturns an overview on publication year basis, for a specified category. Every row returned has parts: “as_date”, “year” and “count”. The order is descending, newest year first.cat
archive_year_monthReturn a grouped “archive” overview of resources within a category. The result is a double list, consisting of [ {year, [ months ] }]. The result is grouped on publication year and month, and includes counts. The order is descending, newest year first.cat
keyword_cloudReturn a list of {keyword_id, count} for all resources within a given category. The list is ordered on keyword title. Default predicate is subject, default category is keyword. Change optional keywordpred and keywordcat to create a different cloud.cat, keywordpred, keywordcat
previousGiven an id, return a list of “previous” ids in the given category. This list is ordered by publication date, latest first.id, cat
nextGiven an id, return a list of “next” ids in the given category. This list is ordred by publication date, oldest first.id, cat

Edit on GitHub

Models

search_status

Not yet documented.

See also

Search

Using the query search API you can retrieve lists of resources in various ways. In your templates, you do so through…

Custom search

Implement a custom search by observing the search_query notification in your module. Imagine you want to search cookies…

search

See also

Referred by

search

See also