Help Center

Menu

Plugin: Remap default title

Purpose

The purpose of this plugin is to provide the search administrator with a way of controlling what populates the result title.

Funnelback derives the title from the first entry into the metadata class t field which is the <title> content, followed by h1 through to h4 and any metadata mappings added by the user.

The plugin allows the user to change the default title derivation by specifying a different element to derive the title from. The plugin will replace the title with the content from the specified element and add the original title as meta field fb.original-title.

This plugin only supports HTML page. For the XML title mapping, please use metadata mappings to configure the mapping with metadata class t directly.

Usage

Enable the plugin

  1. Select Plugins from the side navigation pane and click on the Remap default title tile.

  2. From the Location section, select the data source to which you would like to enable this plugin from the Select a data source select list.

The plugin will take effect after setup steps and an advanced > full update of the data source has completed.

Configuration settings

The configuration settings section is where you do most of the configuration for your plugin. The settings enable you to control how the plugin behaves.

The configuration key names below are only used if you are configuring this plugin manually. The configuration keys are set in the data source configuration to configure the plugin. When setting the keys manually you need to type in (or copy and paste) the key name and value.

Title element selector

Configuration key

plugin.remap-default-title.config.titleElement.selector

Data type

string

Required

This setting is required

An element that matches this Jsoup selector will be used as title by this plugin, e.g. meta[content=events] selects meta tags with a content property of events

Title element type

Configuration key

plugin.remap-default-title.config.titleElement.type

Data type

string

Default value

FIELD CONTENT

Allowed values

FIELD CONTENT,ATTRIBUTE VALUE

Required

This setting is required

Defines if the title is sourced from the element content, or as the value of an attribute.

Title element attribute value

Configuration key

plugin.remap-default-title.config.titleElement.attributeName

Data type

string

Default value

++

Required

This setting is optional

Defines the name of the element’s attribute containing the title, if the title element type is set to ATTRIBUTE VALUE.

  • If the default title element is not found, the plugin will not change the title.

  • If more than one element matches the selector, the first one found will be used to replace the title.

If you wish to map the original title to a metadata class, you can use the metadata mappings to map the HTML meta tag with name fb.original-title to corresponding metadata class.

Filter chain configuration

This plugin uses filters which are used to apply transformations to the gathered content.

The filters run in sequence and need be set in an order that makes sense. The plugin supplied filter(s) (as indicated in the listing) should be re-ordered to an appropriate point in the sequence.

Changes to the filter order affects the way the data source processes gathered documents. See: document filters documentation.

Filter classes

This plugin supplies a filter that runs in the main document filter chain: com.funnelback.plugin.remapdefaulttitle.RemapDefaultTitleStringFilter

Drag the com.funnelback.plugin.remapdefaulttitle.RemapDefaultTitleStringFilter plugin filter to where you wish it to run in the filter chain sequence.

Examples

Given an HTML document as following:

<html>
    <head>
        <title>hello world</title>
        <meta name='title' content='New title'>
    </head>
    <body>
        <p>Hello World</p>
            <ol>
                <li>Title 1</li>
                <li>Title 2</li>
            </ol>
    </body>
</html>

Replace title from HTML element content

To replace title hello world with Title 1 from the HTML element content, use the following configuration:

Configuration key name Value

Title element selector

ol > li

Title element type

FIELD CONTENT

The plugin will transform the HTML document as following for Funnelback to index:

<html>
    <head>
        <title>Title 1</title>
        <meta name='title' content='New title'>
        <meta name="fb.original-title" content="hello world">
    </head>
    <body>
        <p>Hello World</p>
            <ol>
                <li>Title 1</li>
                <li>Title 2</li>
            </ol>
    </body>
</html>

Replace title from HTML element attribute

To replace title hello world with New Title from the HTML element content, use the following configuration:

Configuration key name Value

Title element selector

meta[name='title']

Title element type

ATTRIBUTE VALUE

Title element attribute value

content

The plugin will transform the HTML document as following for Funnelback to index:

<html>
    <head>
        <title>Title 1</title>
        <meta name='title' content='New title'>
        <meta name="fb.original-title" content="hello world">
    </head>
    <body>
        <p>Hello World</p>
            <ol>
                <li>Title 1</li>
                <li>Title 2</li>
            </ol>
    </body>
</html>

Change log

See also