Index configuration

An index node defines a search index.

<index>
<name>...</name>
<rebuild>...</rebuild>
<project>...</project>
<locale>...</locale>
<sources>
<source>...</source>
...
</sources>
</index>

Configuration nodes

The following nodes are used to specify an index:

  • the <name> node gives the index a unique name
  • the <rebuild> node specifies if the index should be rebuilt automatically (value: auto) when the search manager is called as a cron job, or manually (value: manual) only
  • the <locale> node specifies the locale of the contents of this index. It is used to select the appropriate analyzer.
  • one or more <source> nodes are used to specify the name of an index source

Example

This example shows how to configure an index that contains the english offline resources specified by the index source "source1":

<index>
<name>Offline project (VFS)</name>
<rebuild>auto</rebuild>
<project>Offline</project>
<locale>en</locale>
<sources>
<source>source1</source>
</sources>
</index>