SEO Support Plugin Component Parameters
This page outlines the available settings for the SEO component in Bloomreach Content.
Component Parameters
SEOHelperComponent Parameters
The SEOHelperComponentParamsInfo.java interface defines the component parameters. The table below lists parameters that you can configure in the CMS UI. Additional parameters are only available through the CMS console; see the second table for details.
| Parameter | Description | Example value | Default value |
|---|---|---|---|
| Use title-tag provided by page templates | Indicates whether the page template provides a <title> tag. When enabled, the SEO plugin ignores all other title-tag related settings. | true (checked) / false (unchecked) | false |
| Site Title | The static part of the website's title, independent of individual pages. | "FreshNews" | |
| Title field(s) in the documents | Comma-separated list of candidate field names in the document used to retrieve the "pageTitle". Specify field names exactly as the corresponding bean property. The component checks each field in order and uses the first non-blank value. | "title, heading" | "title" |
| Menu Name | The menu name used to retrieve the "menuItem" value. The "menuItem" can be included in the page title if the requested page matches or is below an item in this menu. | "main-menu" | "main" |
| Use Expanded Menu Item | Determines if "menuItem" can be an ancestor of the requested page. If false, "menuItem" is set only when the page matches a menu item exactly. If true, "menuItem" can also be set if the menu item refers to an ancestor (such as a parent folder). | true (checked) / false (unchecked) | false |
| Template Page Title | Template for assembling the <title> tag. Supported placeholders: %(siteTitle), %(menuItem), %(pageTitle). The %(keywords) placeholder is also supported for backward compatibility, but its use is discouraged. | "%(pageTitle) @ %(siteTitle)" | "%(siteTitle) - %(menuItem) - %(pageTitle) : %(keywords)" |
| Description Field(s) in the documents | Comma-separated list of candidate field names in the document for the meta-description tag. Specify field names exactly as the corresponding bean property. The component checks each field in order and uses the first non-blank value. | "description, introduction" | "description" |
| Default Meta Description | Used as the meta-description if no value is found in the specified document fields. If empty, the meta-description tag is not generated. | "FreshNews rules" | "" |
| Image field(s) in the documents | Comma-separated list of candidate field names in the document for the og:image and og:image:alt tags. Specify field names exactly as the corresponding bean property. The component checks each field in order and uses the first non-blank value. | "image,banner" | "image" |
| Site DC Copyright Link | URL for the site's Dublin Core Copyright Link. | "http://www.example.com/html/ts/nps/terms_of_use.html" | "" |
| DC Schema Link | URL for the Dublin Core Schema. | "http://purl.org/dc/elements/1.1/" | "http://purl.org/dc/elements/1.1/" |
| DC Terms Link | URL for the Dublin Core Terms. | "http://purl.org/dc/terms/" | "http://purl.org/dc/terms/" |
| Enable DC Language | Controls whether the DC.language tag is generated. Only the string "true" enables the tag; all other values disable it. | "true" | "" |
| DC Language | Overrides the default value for the DC.language tag, which is otherwise derived from the request's locale. | "en-US" | "" |
The following parameters are only configurable through the CMS console:
| Parameter | Description | Default value |
|---|---|---|
| document-attribute | Name of the request scope attribute for the current content bean. | document |
| menu-attribute | Name of the request scope attribute for the current site menu. | menu |
| params-info-attribute | Name of the request scope attribute for the parameters info of the current HST component. | paramsInfo |
| document-keywords-bean-props | Candidate bean property names in the current content bean from which to retrieve comma-separated keywords. | keywords |
| headers-in-template | Indicates if a render template contributes head elements. | false |
| keywords-in-document-title | Indicates if keywords are appended to the document title. | true |
| default-meta-keywords | Used when no meta-keywords are present in the document. |