Booleansearchfilter

Summary:

Version: 20250331

Status: In active use

Maintainer: harcokuppens

License: MIT

Questions answered by this recipe

How can I do more complex boolean search on content on the current page, such that only the matching items are shown?

Description

Cookbook to add a search form on a HTML page to search items using a boolean expression of words, making none-matched items hidden, and making the searched words highlighted in the matched items.

The source code of this cookbook is at the cookbook's repository, which also provides a devcontainer in which you can see the plugin in action and further develop it.

The booleansearchfilter cookbook script is a wrapper around the Boolean Search Filter JavaScript library. The (:booleansearchfilter:)directive inserts a <div> tag, where the library dynamically creates a Boolean search form. You can see the library in action at the following URL.

The directive (:booleansearchfilter:) has the following options:

id: the id of the div tag added in which search form is placed. Default id: "BooleanSearch".
elementsCssSelector: Sets the CSS selector for the elements to be searched. Default: "li" if sectionElementsCssSelector also set, otherwise the default is "#wikitext li" to only search list items within PmWiki's content area.
sectionElementsCssSelector: Sets the CSS selector for the section elements to be searched. If this method is called then we have multiple lists, one per section, where sections are selected by the sectionElementsCssSelector, and elements within the section with the elementsCssSelector. When this method is not called the library only uses the elementsCssSelector for a single list of elements without any sections. Default: not set, only elementsCssSelector is used.
subscript: to provide an alternative subscript (HTML code in a string value), below the search box in the search form
highlighting: to provide a boolean ("true" or "false") to enable or disable highlighting. Default: "true".

Example

The following pmwiki markup:

 
        (:booleansearchfilter sectionElementsCssSelector='#mycontent > h1' 'elementsCssSelector='li':)

Will search for H1 tags as direct childs of an element with id mycontent as the search sections. Within each H1 section it will search for matching items with css select LI. Items not matched get hidden, and in matched items the search words in the boolean expression in the search box get highlighted. If there are no matches in the section then the whole section with the H1 tag get hidden.

Installation

Download booleansearchfilter-20250331.zip, unpack the files to the associated directories, and add to config.php:

include_once("$FarmD/cookbook/booleansearchfilter/booleansearchfilter.php");

Notes

for custom boolean search form adjust the cookbook script in which there is already commented out code to add a custom form

Release Notes

20250331: initial version - booleansearchfilter-20250331.zip - harcokuppens ?

Contributors

harcokuppens ?

Comments

See discussion at Booleansearchfilter-Talk ?

User notes ? : If you use, used or reviewed this recipe, you can add your name. These statistics appear in the Cookbook listings and will help newcomers browsing through the wiki.