DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== selectsearch Plugin ======

---- plugin ----
description: Provide a dropdown with namespaces to restrict the search in
author     : Frank Schiebel 
email      : frank@linuxmuster.net 
type       : action
lastupdate : 2012-11-01
compatible : 2012-10-13
depends    : 
conflicts  : 
similar    : fancysearch, nssearch
tags       : search, namespace, dropdown

downloadurl: https://github.com/ironiemix/dokuwiki-selectsearch/zipball/master
bugtracker : 
sourcerepo : https://github.com/ironiemix/dokuwiki-selectsearch
donationurl: http://www.openschulportfolio.de/about
----
[[http://www.openschulportfolio.de|{{http://www.openschulportfolio.de/_media/wiki/logo/logo.png}}]]

===== Installation =====

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

===== Examples/Usage =====

The selectsearch plugin is a "non-fancy" copy of the fancysearch plugin. It is possible to define a list of namespaces in the plugin config (via the config manager) from which the user can choose when doing a search in the wiki. The results will be restricted to the chosen namespace.

{{http://www.openschulportfolio.de/_media/dokumentation/searchbox.png|}}

To use the Plugin you have to include the searchbox in your template:

$selectsearch = plugin_load('action', 'selectsearch');
    if (!is_null($selectsearch)) {
        $selectsearch->tpl_searchform();
    } else {
        tpl_searchform();
    }

===== Configuration and Settings =====

In the configuration manager you can define a list of namespaces to be selected by the user when doing a search.

The syntax for the option is ''the:name:space>Text to display in dropdown''

The options are comma seperated. For having an option to search the whole wiki, you have to add an empty namespace like this: ''>whole wiki</tt''

The defalut value gives a good impression how this works:

$conf['searchnamespaces'] = ">All pages,portfolio>Portfolio,hilfe>Help";

=== Change Log ===

* **2012-11-01**
    * Initial release

=== Known Bugs and Issues ===

===== FAQ =====

//[discussions should ideally be deleted and turned into FAQ entries along the way]//

===== Discussion =====

* The Quick result pop-up no longer appears when this plugin is activated. Is that intentional? 
  * Within what template file(s) would you add the searchbox syntax?

Please fill all the letters into the box to prove you're human. A J F A᠎ M Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International