To add a portlet to one of your site's pages, you should configure the pages.xml
file located at custom-extension.war!/WEB-INF/conf/portal/{portal-container-name}/{site-name}/.
Here is an example of the portlet configuration in the pages.xml file:
<portlet-application>
<portlet>
<application-ref>presentation</application-ref>
<portlet-ref>SingleContentViewer</portlet-ref>
<preferences>
<preference>
<name>repository</name>
<value>repository</value>
<read-only>false</read-only>
</preference>
<preference>
<name>workspace</name>
<value>collaboration</value>
<read-only>false</read-only>
</preference>
<preference>
<name>nodeIdentifier</name>
<value>/sites content/live/acme/web contents/site artifacts/Introduce</value>
<read-only>false</read-only>
</preference>
<!-- ... -->
</preferences>
</portlet>
<title>Homepage</title>
<access-permissions>Everyone</access-permissions>
<show-info-bar>false</show-info-bar>
<show-application-state>false</show-application-state>
<show-application-mode>false</show-application-mode>
</portlet-application>
Details:
| XML tag name | Description |
|---|---|
application-ref
| Name of the webapp that contains the portlet. |
portlet-ref
| Name of the portlet. |
title
| Title of the page. |
access-permission
| Defines who can access the portlet. |
show-info-bar
| Shows the top bar with the portlet title. |
show-application-state
| Shows the collapse/expand icons. |
show-application-mode
| Shows the change portlet mode icon. |
preferences
| Contains a list of preferences specific to each portlet. Each preference has a name and a value. You can also lock it by setting the read-only element to "true". |
See also