Advanced Search Plugin - blojsom - Confluence

Availability

The Advanced Search plugin can be downloaded from the blojsom plugins download page.

Description

The Advanced Search plugin allows a user to search through all of a user's blog entries based on a given set of criteria. It provides a much richer set of criteria than the Simple Search plugin to search information contained in a blojsom blog. The Advanced Search plugin supports multiple blogs and will create a separate index for each blog.

Installation and Setup

Place the lucene-1.4.3.jar and advanced-search-plugin-1.2.jar files in blojsom's /WEB-INF/lib directory.

In your global /WEB-INF/plugin.properties file, add the following line:

advanced-search=com.richardspackmann.blojsom.plugin.advancedsearch.AdvancedSearchPlugin

You may then add "advanced-search" to one of the flavor-based plugin chains. These plugin chains can be found in the individual user's plugin.properties file. For example:

html.blojsom-plugin-chain=...,advanced-search,...

The Advanced Search plugin has its own configuration file, advancedsearch.properties, that is referenced in /WEB-INF/web.xml.

<init-param>
    <param-name>plugin-advancedsearch</param-name>
    <param-value>advancedsearch.properties</param-value>
</init-param>

The advancedsearch.properties file will be located in the respective /WEB-INF/(blog-id) directories and has a number of configurable parameters:

# This should be the directory where the lucene index is going to be created
# by the plugin. It will be created beneath the
# blojsom-configuration-base-directory defined in blojsom.properties. Thus this
# field MUST be a directory name and not an absolute path.
lucene-index-dir=lucene-index

Usage and URL Parameters

URL parameters

The following URL parameters control the results returned by the Advanced Search plugin.

URL Parameter	Description	Default Value	Allowed Values
`query`	Search query.	N/A	N/A
`date-sort-operation`	Determines how results will be sorted.	`relevance`	`relevance` or `date`
`boolean-operation`	Determines how the search terms will be joined together.	`or`	`and` or `or`
`text-search-operation`	Text search location that should be performed.	`both`	`title`, `content`, or `both`

Additional Notes

The following words are not included in your search even if entered:

"a", "an", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "no", "not", "of", "on", "or", "s", "such", "t", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with".