Channel Editor Catalog - BloomReach Experience - Open Source CMS

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

08-01-2018

Channel Editor Catalog

The Channel Editor shows a list of components in the Component Toolbar. These components are retrieved from the HST catalog, which is configured at:

/hst:hst/hst:configurations/mychannel/hst:catalog

Creating a catalog item for the Channel Editor

Each component in the HST catalog is defined by a child node with primary node type hst:containeritemcomponent.

For example:

/hst:hst/hst:configurations/mychannel:
  /hst:catalog:
    jcr:primaryType: hst:catalog
    /event-catalog:
      jcr:primaryType: hst:containeritempackage
      /pageactions:
        jcr:primaryType: hst:containeritemcomponent
        hst:template: standard.main.left.pageactions
        hst:xtype: hst.item
        hst:label: Page Actions
        hst:iconpath: images/catalog/icon-page-action.png

The hst:label and/or hst:iconpath properties of a catalog item specify the name and icon of the component in the Component Toolbar, respectively.  The icon path is relative to the root of the site application.

Reusable Components

The HstResourceServlet makes it possible to load images from the classpath too. By convention, this servlet is mapped to:

<servlet>
  <servlet-name>HstResourceServlet</servlet-name>
  <servlet-class>org.onehippo.cms7.utilities.servlet.ResourceServlet</servlet-class>
  <init-param>
    <param-name>jarPathPrefix</param-name>
    <param-value>META-INF/web-resources</param-value>
  </init-param>
</servlet>
<servlet-mapping>
  <servlet-name>HstResourceServlet</servlet-name>
  <url-pattern>/resources/*</url-pattern>
</servlet-mapping>

Reusable catalog components should include their resources as

src/main/resources/META-INF/web-resources/my-image.png

and in the repository hst configuration have the property

hst:iconpath = resources/my-image.png

 

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?