Document Component - BloomReach Experience - Open Source CMS

This article covers a Hippo CMS version 10. There's an updated version available that covers our most recent release.

12-05-2015

Document Component

Class Name

The Document Component is implemented by the class

org.onehippo.cms7.essentials.components.EssentialsDocumentComponent

Purpose

This class is used to make the content of a document available as a Java bean to the rendering template (JSP or FTL). Typically, the component parameter is used to identify the document. No redirection is done if no document can be made available.

Like that, the component is typically used to make additional content available for presentation on a page, while the Content Component is better suited for the main content of a page. Such additional content is typically presented in a side column or in the footer of a page.

Component Parameters

 Name  Description
 document  Repository path to the document (handle) representing the desired document, relative to the site's content root. If not specified, the component will use the requested URL and the site map to determine what document to fetch.

Rendering Attributes

Name Type Description
document  org.hippoecm.hst.content.beans.standard.HippoBean A HippoBean representing the document identified by the component. May be null.
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?