====== searchns Plugin ======

---- plugin ----
description: Lets you set apart and emphasize certain namespaces in quick search
author     : Anna Dabrowska
email      : dokuwiki@cosmocode.de
type       : action
lastupdate : 2024-03-14
compatible : Jack Jackrum, Kaos
depends    : 
conflicts  : 
similar    :
tags       : search

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-searchns/archive/main.zip
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-searchns/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-searchns/
donationurl: 
screenshot_img : 
----

This plugin lets you set apart and emphasize certain namespaces in quick search.

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Configuration =====

The plugin needs to be configured with relevant namespaces and associated labels, as shown in the example:

<code>
product:foobar:2024:     Foobar Version 2024
product:bar:2024:        Bar Version 2024
product:foobar:2023:     Foobar Version 2023
product:bar:2023:        Bar Version 2023
product:foobar_pl:2024:  Foobar Version 2024 (polski)
internal:                Company Internals
</code>

The option "all" is automatically added to the end of the list. There is a setting to place "all" at the beginning of the list.

==== Usage =====

=== Custom Search Widget ===

The plugin provides a new search widget that makes use of the configuration mentioned above. It shows a dropdown with namespace labels as defined, with an additional "all" option. The user can pick one of the labels to automatically limit the search results to the namespace associated with the label. This limit applies to shown "quick search" results (matching page names shown in an overlay) as well as to the results returned on the search page after hitting enter.

=== Page Match Grouping ===

The resulting list of matching page names is reordered and grouped by subheadings, according to the configured namespaces.