Help Center

Menu

Plugin: Rename facet categories

Other versions of this plugin may exist. Please ensure you are viewing the documentation for the version that you are currently using. If you are not running the latest version of your plugin we recommend upgrading. See: list of all available versions of this plugin.

Purpose

This plugin enables you to change the labels of facet categories.

Usage

Enabling the plugin

Enable the rename-facet-categories plugin on your results page from the Extensions screen in the administration dashboard or add the following results page configuration to enable the plugin.

plugin.rename-facet-categories.enabled=true
plugin.rename-facet-categories.version=1.0.0

Plugin configuration settings

The following option can be set (multiple times) in the results page configuration to configure the plugin:

  • plugin.rename-facet-categories.config.<facet_name>.<category_label>: Sets the new label to apply to the facet category.

Where:

  • <facet_name> is the facet containing the category that is to be renamed.

  • <category_label> is the category that you wish to rename.

Examples

Update the Bob category to Robert and UK category to United Kingdom

The following example will result in Robert being displayed in the People facet in place of Bob; and United Kingdom being displayed in the Country facet instead of UK.

plugin.rename-facet-categories.config.People.Bob=Robert
plugin.rename-facet-categories.config.Country.UK=United Kingdom
This plugin only changes the label for a facet category and will not collapse together categories. For example if your facet already includes a category Robert and you rename Bob to Robert you will end up with two categories called Robert in the facet - one containing the count for items originally labelled Bob and the other for the pre-existing Robert category.

See also

All versions of rename-facet-categories