Magnolia 5.5 reached end of life on November 15, 2019. This branch is no longer supported, see End-of-life policy.
The SiteMesh module integrates the SiteMesh 3 decoration and Web application integration framework with Magnolia. If you intend to use SiteMesh only as the mechanism for dynamic page caching you can skip this page after its installation and continue with Advanced Dynamic Page Caching.
SiteMesh intercepts requests to any static or dynamically generated HTML page requested through the web-server, processes the content and then merges it with one or more decorators to build the final result." – SiteMesh 3
/server/filters/sitemesh node./server/rendering/engine/listeners/sitemesh node./modules/sitemesh node and its subnodesmagnolia-module-sitemesh.jar) from WEB-INF/lib and start up Magnolia again.SiteMesh filter processes by default only text/html but can be configured to process any text resources such as css or javascript: true info.magnolia.cms.filters.FilterDecorator true info.magnolia.voting.voters.ResponseContentTypeVoter true text/html
The decorator contains the common layout and style that should be applied to the pages in the web application". – Getting Started with SiteMesh 3
If you have samples and demo/project installed, you can find SiteMesh sample under /demo-features/modules/sitemesh-sample.html and its decorator under /demo-features/modules/sitemesh-sample/decorator.html. You can configure more that one decorator per path (and of course use regular expression for path). You can find the templates under templates:/sitemesh-sample.
Decorator selector chooses the decorators for pages. MetaTagBasedDecoratorSelector is used by default. true info.magnolia.cms.filters.FilterDecorator info.magnolia.sitemesh.config.MagnoliaConfigurableSiteMeshFilter org.sitemesh.config.MetaTagBasedDecoratorSelector /demo-features/modules/sitemesh-sample.html /demo-features/modules/sitemesh-sample/decorator.html
Processes the text content tag by tag. You can configure sets of rules under tagRuleBundles. You can use the bundles provided by SiteMesh 3.0.0. Just use info.magnolia.sitemesh.content.TagRuleBundleWrapper as class, create node wrapped and set the bundle class as the property class: true info.magnolia.cms.filters.FilterDecorator info.magnolia.sitemesh.config.MagnoliaConfigurableSiteMeshFilter info.magnolia.sitemesh.content.MagnoliaContentProcessor info.magnolia.sitemesh.content.TagRuleBundleWrapper org.sitemesh.content.tagrules.html.CoreHtmlTagRuleBundle
Because the bundles provided by SiteMesh 3 are fixed sets of rules, Magnolia offers you also configurable info.magnolia.sitemesh.content.MagnoliaTagRuleBundle. You can dynamically add info.magnolia.sitemesh.content.MagnoliaRules to this bundle: true info.magnolia.cms.filters.FilterDecorator info.magnolia.sitemesh.config.MagnoliaConfigurableSiteMeshFilter info.magnolia.sitemesh.content.MagnoliaContentProcessor info.magnolia.sitemesh.content.MagnoliaTagRuleBundle Magnolia 5.4.6+ / Sitemesh 1.0.3+. You can configure the
baseURL in the InjectUriRule node.
Set /server/filters/sitemesh/decoratedFilter/contentProcessor/tagRuleBundles/magnolia/rules/InjectUriRule/tag/baseUrl to http://localhost:8080${contextPath}, for example.
https://demo.magnolia-cms.com/.https://localhost:8080/magnoliaPublic~mgnlArea=main~. Site-specific configurations are not taken into account.
If baseURL is not set, the base URL of the current request is used:
https://demo.magnolia-cms.com/.https://demopublic.magnolia-cms.com/~mgnlArea=main~.Every info.magnolia.sitemesh.content.MagnoliaRule holds tag. info.magnolia.sitemesh.content.AbstractTag processes a html tag. You can implement for example a tag which replaces all occurrences of <b> with <s>. Set includeInContent=true on rule if you don't want to replace the original tag but only append new content after it. Add content node named tagTypes to a tag to tell which tag types you want to process. All types (open, close, ...) will be processed if no tagTypes node will be added. true info.magnolia.cms.filters.FilterDecorator info.magnolia.sitemesh.config.MagnoliaConfigurableSiteMeshFilter info.magnolia.sitemesh.content.MagnoliaContentProcessor info.magnolia.sitemesh.content.MagnoliaTagRuleBundle true info.magnolia.sitemesh.content.MagnoliaRule info.magnolia.sitemesh.content.inject.InjectUriTag mgnl:injecturi false open
| Out of the box rules | ||
|---|---|---|
| class | description | configurable fields (default values) |
info.magnolia.sitemesh.content.inject.InjectTag | Tag for any text injection. | contentToInject (empty string) |
info.magnolia.sitemesh.content.inject.sample.InjectAdmincentralButtonTag | Tag injects admincentral button to navigate to admincentral when accessing pages outside of admincentral. | contentToInject (empty string) |
info.magnolia.sitemesh.content.inject.InjectUrlTag | Tag for injection of content retrieved by URL specified as argument target of this tag.
| readTimeout (600000) connectTimeout (10000) bufferSize (4096) |
info.magnolia.sitemesh.content.inject.InjectUriTag | Tag for injection of content retrieved by URI (that means a URI which points to the same webapp) specified as argument target of this tag. The current original request is used to create URL. Other arguments are set as request headers such as | readTimeout (600000) |
true info.magnolia.module.advancedcache.rendering.FragmentInjectionListener false RELATIVE_TO_CONTEXT_ROOT </mgnl:injecturi><mgnl:injecturi target="${targetPath}" X-Magnolia-Cache="ttlValue=${ttlValue},CacheKeyGenerator=${CacheKeyGenerator},">
The SiteMesh sample contains two preconfigured dynamic components for Standard Templating Kit:
/modules/multisite/config/sites/default/templates/prototype/areas/branding/areas/metaNavigation/fragmentDefinition/modules/commenting/templates/components/comments/fragmentDefinitionSet /modules/multisite/config/sites/default/templates/prototype/areas/branding/areas/metaNavigation/fragmentDefinition=true, disable SiteMesh filter (/server/filters/sitemesh@enabled=false) and open a demo-project page to see the result of the sitemesh fragment injection listener:
...a static page content before the dynamic component... <mgnl:injecturi target="/demo-project/about~mgnlArea=branding,metaNavigation~" X-Magnolia-Cache="ttlValue=-1,CacheKeyGenerator=info.magnolia.sitemesh.samples.MetaNavigationCacheKeyGenerator,"> an dynamic meta navigation area </mgnl:injecturi> ...a static page content after the dynamic component...
There is the trivial sample for external fragment inclusion:
config:modules/sitemesh/templates/components/externalFragmentconfig:modules/sitemesh/dialogs/externalFragmentconfig:modules/standard-templating-kit/templates/pages/stkSection/areas/main/areas/opener/availableComponents/externalFragmenttemplates:sitemesh-sample/externalFragmentGo to website/demo-project/about, delete the opener teaser component and add External Fragment instead. Add URL of a page which you want to render.