Part 3.2: Documenting your plugin

public final PluginConfigKey<String> PATTERN = PluginConfigKey.<String>builder()
        .pluginId(getPluginId())
        .id("pattern")
        .type(PluginConfigKeyType.builder().type(PluginConfigKeyType.Format.STRING).build())
        .defaultValue(".")
        .label("Prefix pattern") (1)
        .description("Pattern of characters to match prefix against.") (2)
        .longDescription("The pattern specified here is a _Java regular expression_ that is matched against the title.\n"+
                        "\n"+
                "See also: link:https://www.regexplanet.com/advanced/java/index.html[Java regex tester]") (3)
        .build();

public final PluginConfigKey<String> REPLACEMENT = PluginConfigKey.<String>builder()
        .pluginId(getPluginId())
        .id("replaceWith")
        .type(PluginConfigKeyType.builder().type(PluginConfigKeyType.Format.STRING).build())
        .label("Replacement text") (1)
        .description("Text that will replace any matches.") (2)
        .build();

    /**
      *  Audience field is used to flag the content of the documentation page as being suitable for one or more of these DXP audiences.
      *  There are different types of Audience defined here {@link Audience}
      *
      *  This method returns list of Audience selected for the plugin.
     */
    @Override public List <Audience> getAudience() {
        return List.of(Audience.SITE_BUILDER, Audience.DEVELOPER);
    }

    /**
     *  Marketplace subtype is mostly defined by the interfaces that are implemented for the plugin.
     *  Complete list if marketplace subtypes is defined here {@link MarketplaceSubtype}
     */
    @Override public List <MarketplaceSubtype> getMarketplaceSubtype() {
        return List.of(MarketplaceSubtype.SEARCH_LIFECYCLE);
    }

    /**
     *   Product topic is about describing the topics that the plugin you’re building relates to.
     *   So when you select one of those topics in the facets for example the plugin will come up in the possible results.
     *   Available options can be found here {@link ProductTopic} (2)
     */
    @Override public List <ProductTopic> getProductTopic() {
        return List.of(ProductTopic.RESULTS_PAGE);
    }

    /**
     *   Product subtopics are defined for each of the product topic.
     *   Available options can be found here {@link ProductSubtopicCategory} (2)
     */
    @Override public List <ProductSubtopicCategory> getProductSubtopic() {
        return List.of(ProductSubtopic.ResultsPage.DATA_MODEL_MANIPULATION, ProductSubtopic.ResultsPage.DATA_MODEL_SEARCH, ProductSubtopic.ResultsPage.RESULTS_TEMPLATES);
    }

This plugin works by replacing parts of the title using a pair of configuration keys that define a link:https://www.regexplanet.com/advanced/java/index.html[Java regular expression] that identifies what should be replaced, and a corresponding key that defines the replacement for the matched text.

The title is updated within the search data model and works with both Freemarker templating, and integrations with the search JSON and XML endpoints.

WARNING: If you choose to sort your search results by title then sorting may not work correctly. This is because your changes to the title are applied after the results are returned by the query processor (which applies any sorting to the result set). Sorting will work correctly if your title modifications are to remove a suffix from your titles, or a prefix that is common to every title in your index.

=== Example: Remove a prefix from search result titles

Consider a website where the page titles include a common suffix, 'ACME Corporation - ', for every title. This looks terrible in the search results and makes the results difficult to read. The following plugin configuration will strip this off the start of a title when the results are returned from the index.

Enable the title prefix plugin on your results page and add the following configuration

|===
|Configuration key|Value

|Prefix pattern|`^ACME Corporation -\s+`
|Replace with|
|===

This configuration matches the string 'ACME Corporation -' including any following whitespace, at the start of a tit