Custom search

This article explains how to customize the search to define custom search categories.

Configuration

By default the search box allows to search on one of the following elements:

• Search on articles only
• Search on articles and their titles
• Search on articles, their titles, and anchors

It is however possible to completely customize the Search categories by setting the two following properties:

• "search": set to the custom value
• "searchCustomSpec": points to an XML file specifying the categories specification

For example:

      search=custom
      searchCustomSpec=customSearch.xml

Setting the category for one element in the wiki

When you have specified custom search categories, you can refer to one of these categories in one of the following elements:

• An article
• A title
• An anchor

The two attributes which specify the category for one of these elements are :

• "searchCategory": for the category
• "searchName": optional for the name to be included in the Search. By default the name of the element itself will be used

Example

   <article desc="article1" searchCategory="major" searchName="toto">
      <title title="the first title" searchCategory="minor" searchName="toto"/>
      This is an <anchor id="theAnchor" searchCategory="minor" searchName="titi" />
      <title title="the second title" searchCategory="minor"/>	
   </article>