SEO Support Plugin Component Parameters for CMS 10.0 - BloomReach Experience - Open Source CMS

SEO Support Plugin Component Parameters for CMS 10.0

Component Parameters

This page applies to SEO Support in CMS 10.0 only. For SEO Support in Hippo CMS 10.1 and later see SEO Support Plugin Component Parameters for CMS 10.1.

Parameters of SEOHelperComponent

The details of the component parameters are available in the ParametersInfo interface: SEOHelperComponentParamsInfo.java.

Parameter name Description Example value Default value
site-title Title of this website "Example.COM"  
site-title-in-template Flag indicating whether the title head element is already contributed by an existing template. If this parameter is set to "true", then the component will not contribute any title head element. "true" "false"
site-dc-copyright-link SITE's Dublin Core Copyright Link "http://www.example.com/html/ts/nps/terms_of_use.html"  
dc-schema-link Dublin Core Schema Link   "http://purl.org/dc/elements/1.1/"
dc-terms-link Dublin Core Terms Link   "http://purl.org/dc/terms/"
document-title-bean-props Comma separated candidate bean property names of the current request content bean from which document title can be retrieved. The component will retrieve the current request content bean and uses this property names to find a proper title of the current request content bean through Java Reflection. If multiple property names are configured, the component will look up each property until it finds a non-blank title. "title, name" "title"
document-keywords-bean-props Comma separated candidate bean property names of the current request content bean from which comma separated keywords can be retrieved. The component uses this parameter to find a proper keywords field. If multiple property names are configured, the component will look up each property until it finds a non-blank keywords field. "keywords, searchKeywords" "keywords"
default-meta-keywords If the document does not have a document-keywords-bean-props field, no meta keywords are set in the header. With this property, you can set default keywords to be used when a document does not provide any keywords. "keywordOne keywordTwo" ""
document-description-bean-props Comma separated candidate bean property names of the current request content bean from which document description can be retrieved. The component uses this parameter to find a proper description field. If multiple property names are configured, the component will look up each property until it finds a non-blank description. "description, introduction" "description"
default-meta-description If the document does not have a document-description-bean-props field, no meta description is set in the header. With this property, you can set the default description to be used when a document does not provide a description. "Site description, this site is about something" ""
headers-in-template Flag indicating whether head elements are already contributing by an existing template. If this parameter is set to "true", the component will not contribute any head elements. "true" "false"
document-attribute Request scope attribute name for the current request content bean "contentBean" "document"
menu-name Name for retrieving the site menu for the current request "sitemenu1" "main"
menu-attribute Request scope attribute name for the current request site menu "siteMenu" "menu"
menu-item-allow-expanded

Flag indicating whether the sitemenu item is allowed to be an expanded ancestor. If false, only exact matches are allowed.

If this parameter is set to "true" and the requested page is not a direct hit in the sitemenu (e.g. a news article), the name of the sitemenu item is added to the page title. Like "Example.com - News - Title of the news article". Otherwise the title will be "Example.com - Title of the news article".

If the requested page is configured in the site menu (e.g. news overview), this parameter is ignored.

true false
keywords-in-document-title

Flag whether the keywords are included in the document title.

false true
params-info-attribute Request scope attribute name for the parameters info of the current HST component. The type of the parameters info is org.onehippo.forge.seo.support.SEOHelperComponentParamsInfo. "parametersInfo" "paramsInfo"
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?