Liferay-portlet-app 5 2 0.dtd

<&#33;-- This is the DTD for the Portlet Application parameters that are specific to Liferay Portal. <&#33;DOCTYPE liferay-portlet-app PUBLIC "-//Liferay//DTD Portlet Application 5.2.0//EN" "http://www.liferay.com/dtd/liferay-portlet-app_5_2_0.dtd"> --> <&#33;-- The liferay-portlet-app element is the root of the deployment descriptor for a Liferay portlet application. --> <&#33;ELEMENT liferay-portlet-app (portlet*, role-mapper*, custom-user-attribute*)> <&#33;-- The portlet element contains the declarative data of a portlet. --> <&#33;ELEMENT portlet (portlet-name, icon?, virtual-path?, struts-path?, configuration-path?, configuration-action-class?, indexer-class?, open-search-class?, scheduler-class?, portlet-url-class?, friendly-url-mapper-class?, url-encoder-class?, portlet-data-handler-class?, portlet-layout-listener-class?, poller-processor-class?, pop-message-listener-class?, social-activity-interpreter-class?, social-request-interpreter-class?, webdav-storage-token?, webdav-storage-class?, control-panel-entry-category?, control-panel-entry-weight?, control-panel-entry-class?, preferences-company-wide?, preferences-unique-per-layout?, preferences-owned-by-group?, use-default-template?, show-portlet-access-denied?, show-portlet-inactive?, action-url-redirect?, restore-current-view?, maximize-edit?, maximize-help?, pop-up-print?, layout-cacheable?, instanceable?, scopeable?, user-principal-strategy?, private-request-attributes?, private-session-attributes?, render-weight?, ajaxable?, header-portal-css*, header-portlet-css*, header-portal-javascript*, header-portlet-javascript*, footer-portal-css*, footer-portlet-css*, footer-portal-javascript*, footer-portlet-javascript*, css-class-wrapper?, facebook-integration?, add-default-resource?, system?, active?, include?)> <&#33;-- The portlet-name element contains the unique name of the portlet. This name must match the portlet-name specified in portlet.xml. --> <&#33;ELEMENT portlet-name (#PCDATA)> <&#33;-- The icon element specifies an image that represents the portlet. --> <&#33;ELEMENT icon (#PCDATA)> <&#33;-- The virtual-path value sets the virtual path used to override the default servlet context path. For example, suppose your portlet is deployed to the servlet path "/test-portlet". By default, the portal will return "/test-portlet" for the servlet context path. You can override it by setting virtual-path to "/virtual" and have the portal return "/virtual" for the servlet context path. The default value is "" which means this is not used. --> <&#33;ELEMENT virtual-path (#PCDATA)> <&#33;-- Supppose the struts-path value is "mail". This tells the portal that all requests with the path mail/* are considered part of this portlet's scope. Users who request paths that match mail/* will only be granted access if they also have access to this portlet. This is true for both portlet requests and regular servlet requests. --> <&#33;ELEMENT struts-path (#PCDATA)> <&#33;-- The configuration-path value is no longer available. Use configuration-action-class instead. --> <&#33;ELEMENT configuration-path (#PCDATA)> <&#33;-- The configuration-action-class value must be a class that implements com.liferay.portal.kernel.portlet.ConfigurationAction and is called to allow users to configure the portlet at runtime. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/messageboards/action/ConfigurationActionImpl.html --> <&#33;ELEMENT configuration-action-class (#PCDATA)> <&#33;-- The indexer-class value must be a class that implements com.liferay.portal.kernel.search.Indexer and is called to create or update a search index for the portlet. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/messageboards/util/Indexer.html http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/search/Indexer.html http://lucene.apache.org --> <&#33;ELEMENT indexer-class (#PCDATA)> <&#33;-- The open-search-class value must be a class that implements com.liferay.portal.kernel.search.OpenSearch and is called to get search results in the OpenSearch 1.1 standard. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/alfrescocontent/util/OpenSearch.html http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/search/OpenSearch.html http://www.opensearch.org --> <&#33;ELEMENT open-search-class (#PCDATA)> <&#33;-- The scheduler-class value must be a class that implements com.liferay.portal.kernel.job.Scheduler and is called to schedule jobs for this portlet. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/calendar/job/CalendarScheduler.html http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/job/Scheduler.html http://www.opensymphony.com/quartz --> <&#33;ELEMENT scheduler-class (#PCDATA)> <&#33;-- The portlet-url-class value must be a class that extends com.liferay.portlet.PortletURLImplWrapper. Set this class to override the default portlet URL implementation. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portal/struts/StrutsActionPortletURL.html --> <&#33;ELEMENT portlet-url-class (#PCDATA)> <&#33;-- The friendly-url-mapper-class value must be a class that implements com.liferay.portal.kernel.portlet.FriendlyURLMapper. Use this if content inside a portlet needs to have a friendly URL. See the Message Boards portlet for an example of its uses. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/messageboards/MBFriendlyURLMapper.html http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/portlet/FriendlyURLMapper.html --> <&#33;ELEMENT friendly-url-mapper-class (#PCDATA)> <&#33;-- The url-encoder-class value must be a class that implements com.liferay.portal.kernel.servlet.URLEncoder. Use this to set a custom URLEncoder that is used by the RenderResponse class to implement the encodeURL method. This is useful if you need to add custom logic to rewrite URLs. --> <&#33;ELEMENT url-encoder-class (#PCDATA)> <&#33;-- The portlet-data-handler-class value must be a class that implements com.liferay.portal.kernel.lar.PortletDataHandler and is called when archiving tasks are run. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/journal/lar/PortletDataHandlerImpl.html http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/lar/PortletDataHandler.html --> <&#33;ELEMENT portlet-data-handler-class (#PCDATA)> <&#33;-- The portlet-layout-listener-class value must be a class that implements com.liferay.portal.kernel.portlet.PortletLayoutListener and is called when a portlet is added, moved, or removed from a layout. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/journalcontent/JournalContentPortletLayoutListener.html http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/portlet/PortletLayoutListener.html --> <&#33;ELEMENT portlet-layout-listener-class (#PCDATA)> <&#33;-- The poller-processor-class value must be a class that implements com.liferay.portal.kernel.poller.PollerProcessor and is triggered by the JavaScript class Liferay.Poller. It allows a portlet to use polling to be notified of data changes. See the Chat portlet for a real world implementation. See: http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/poller/PollerProcessor.html --> <&#33;ELEMENT poller-processor-class (#PCDATA)> <&#33;-- The pop-message-listener-class value must be a class that implements com.liferay.portal.kernel.pop.MessageListener and is called when processing emails. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/messageboards/pop/MessageListenerImpl.html http://docs.liferay.com/portal/5.2/javadocs/portal-kernel/com/liferay/portal/kernel/pop/MessageListener.html --> <&#33;ELEMENT pop-message-listener-class (#PCDATA)> <&#33;-- The social-activity-interpreter-class value must be a class that implements com.liferay.portlet.social.model.SocialActivityInterpreter and is called to interpret activities into friendly messages that are easily understandable by a human being. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/messageboards/social/MBActivityInterpreter.html http://docs.liferay.com/portal/5.2/javadocs/portal-service/com/liferay/portlet/social/model/SocialActivityInterpreter.html --> <&#33;ELEMENT social-activity-interpreter-class (#PCDATA)> <&#33;-- The social-request-interpreter-class value must be a class that implements com.liferay.portlet.social.model.SocialRequestInterpreter and is called to interpret requests into friendly messages that are easily understandable by a human being. See: http://docs.liferay.com/portal/5.2/javadocs/portal-service/com/liferay/portlet/social/model/SocialRequestInterpreter.html --> <&#33;ELEMENT social-request-interpreter-class (#PCDATA)> <&#33;-- The webdav-storage-token value is the WebDAV directory name for data managed by this portlet. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/documentlibrary/webdav/DLWebDAVStorageImpl.html --> <&#33;ELEMENT webdav-storage-token (#PCDATA)> <&#33;-- The webdav-storage-class value must be a class that implements com.liferay.portal.webdav.WebDAVStorage and allows data to be exposed via the WebDAV protocol. See: http://docs.liferay.com/portal/5.2/javadocs/portal-impl/com/liferay/portlet/documentlibrary/webdav/DLWebDAVStorageImpl.html --> <&#33;ELEMENT webdav-storage-class (#PCDATA)> <&#33;-- Set the control-panel-entry-category value to "my", "content", "portal" or "server" to make this portlet available in the Control Panel under that category. Note that the portlet will only be visible to the Adminisitrator unless a control-panel-entry-class is specified. --> <&#33;ELEMENT control-panel-entry-category (#PCDATA)> <&#33;-- Set the control-panel-entry-weight value to a double number to control the position of the entry within its Control Panel category. Higher values mean that the entry will appear lower in the Control Panel menu. --> <&#33;ELEMENT control-panel-entry-weight (#PCDATA)> <&#33;-- The control-panel-entry-class value must be a class that implements com.liferay.portlet.ControlPanelEntry and is called by the Control Panel. See: http://docs.liferay.com/portal/5.2/javadocs/portal-service/com/liferay/portlet/ControlPanelEntry.html --> <&#33;ELEMENT control-panel-entry-class (#PCDATA)> <&#33;-- Set the preferences-company-wide value to true if the preferences for the portlet are across the entire company. Setting this value to true means the value for preferences-unique-per-layout and preferences-owned-by-group are not used. The default value is false. For example, an administrator could set the preferences to an Announcements portlet that would save a message in the portlet's preferences. This message would then be used across all pages for that company. The portlet must not be instanceable because instanceable portlets have uniquely generated portlet ids. The default behavior of the bundled Announcements portlet sets the instanceable value to true so that normal users cannot create company wide messages. A future release would include permissions for the edit mode versus the view mode which would allow an administrator to set the message while users would just view the message. --> <&#33;ELEMENT preferences-company-wide (#PCDATA)> <&#33;-- Set the preferences-unique-per-layout value to true if the preferences for the portlet are unique across all pages. If set to false, the preferences for the portlet are shared across all pages. The default value is true. The preferences-unique-per-layout element is used in combination with the preferences-owned-by-group element. See the comments for the preferences-owned-by-group element for more information. --> <&#33;ELEMENT preferences-unique-per-layout (#PCDATA)> <&#33;-- Set the preferences-owned-by-group value to true if the preferences for the portlet are owned by the group when the portlet is shown in a group page. If set to false, the preferences are owned by the user at all times. The default value is true. Suppose the Stocks portlet has preferences-unique-per-layout set to true and preferences-owned-by-group set to false. Users can set a different list of stocks for every personal page. Users can set a different list of stocks for every community page. Suppose the Stocks portlet has preferences-unique-per-layout set to false and preferences-owned-by-group set to false. Users can set one list of stocks to be shared across all personal pages. Users can set one list of stocks to be shared across a community's set of pages. Suppose the Stocks portlet has preferences-unique-per-layout set to true and preferences-owned-by-group set to true. Users can set a different list of stocks for every personal page. Administrators set the portlet preferences for users in a community page. Administrators can set a different list of stocks for every community page that are then shared by all users within a community. Suppose the Stocks portlet has preferences-unique-per-layout set to false and preferences-owned-by-group set to true. Users can set one list of stocks to be shared across all personal pages. Administrators set the portlet preferences for users in a community page. Administrators can set one list of stocks to be shared by all users across a community's set of pages. --> <&#33;ELEMENT preferences-owned-by-group (#PCDATA)> <&#33;-- Set the use-default-template value to true if the portlet uses the default template to decorate and wrap content. Setting this to false allows the developer to own and maintain the portlet's entire outputted content. The default value is true. The most common use of this is if you want the portlet to look different from the other portlets or if you want the portlet to not have borders around the outputted content. --> <&#33;ELEMENT use-default-template (#PCDATA)> <&#33;-- Set the show-portlet-access-denied value to true if users are shown the portlet with an access denied message if they do not have access to the portlet. If set to false, users are never shown the portlet if they do not have access to the portlet. The default value is set in portal.properties. See: http://www.liferay.com/page/guest/documentation/development/properties --> <&#33;ELEMENT show-portlet-access-denied (#PCDATA)> <&#33;-- Set the show-portlet-inactive value to true if users are shown the portlet with an inactive message if the portlet is inactive. If set to false, users are never shown the portlet if the portlet is inactive. The default value is set in portal.properties. http://www.liferay.com/page/guest/documentation/development/properties --> <&#33;ELEMENT show-portlet-inactive (#PCDATA)> <&#33;-- Set the action-url-redirect value to true if an action URL for this portlet should cause an auto redirect. This helps prevent double submits. The default value is false. --> <&#33;ELEMENT action-url-redirect (#PCDATA)> <&#33;-- Set the restore-current-view value to true if the portlet restores to the current view when toggling between maximized and normal states. If set to false, the portlet will reset the current view when toggling between maximized and normal states. The default value is true. --> <&#33;ELEMENT restore-current-view (#PCDATA)> <&#33;-- Set the maximize-edit value to true if the portlet goes into the maximized state when the user goes into the edit mode. This only affects the default portal icons and not what may be programmatically set by the portlet developer. The default value is false. --> <&#33;ELEMENT maximize-edit (#PCDATA)> <&#33;-- Set the maximize-help value to true if the portlet goes into the maximized state when the user goes into the help mode. This only affects the default portal icons and not what may be programmatically set by the portlet developer. The default value is false. --> <&#33;ELEMENT maximize-help (#PCDATA)> <&#33;-- Set the pop-up-print value to true if the portlet goes into the pop up state when the user goes into the print mode. This only affects the default portal icons and not what may be programmatically set by the portlet developer. The default value is true. --> <&#33;ELEMENT pop-up-print (#PCDATA)> <&#33;-- Set the layout-cacheable flag to true if the data contained in this portlet can will never change unless the layout or Journal portlet entry is changed. --> <&#33;ELEMENT layout-cacheable (#PCDATA)> <&#33;-- Set the instanceable value to true if the portlet can appear multiple times on a page. If set to false, the portlet can only appear once on a page. The default value is false. --> <&#33;ELEMENT instanceable (#PCDATA)> <&#33;-- If the scopeable is set to true, an administrator will be able to configure the scope of the data of the portlet to either the current community (default), the current layout, or the scope of any other layout of the community that already exists. Portlets that want to support this must be programmed to obtain the proper scope group id according to the configuration and scope their data accordingly. The default is false. --> <&#33;ELEMENT scopeable (#PCDATA)> <&#33;-- Set the user-principal-strategy value to either "userId" or "screenName". Calling request.getRemoteUser will normally return the user id. However, some portlets may need the user principal returned to be screen name instead. --> <&#33;ELEMENT user-principal-strategy (#PCDATA)> <&#33;-- Set the private-request-attributes value to true if the portlet does not share request attributes with the portal or any other portlet. The default value is true. The property "request.shared.attributes" in portal.properties specifies which request attributes are shared even when the private-request-attributes value is true. --> <&#33;ELEMENT private-request-attributes (#PCDATA)> <&#33;-- Set the private-session-attributes value to true if the portlet does not share session attributes with the portal. The default value is true. The property "session.shared.attributes" in portal.properties specifies which session attributes are shared even when the private-session-attributes value is true. --> <&#33;ELEMENT private-session-attributes (#PCDATA)> <&#33;-- The default value of render-weight is 1. If set to a value less than 1, the portlet is rendered in parallel. If set to a value of 1 or greater, then the portlet is rendered serially. Portlets with a greater render weight have greater priority and will be rendered before portlets with a lower render weight. If the ajaxable value is set to false, then render-weight is always set to 1 if it is set to a value less than 1. This means ajaxable can override render-weight if ajaxable is set to false. --> <&#33;ELEMENT render-weight (#PCDATA)> <&#33;-- The default value of ajaxable is true. If set to false, then this portlet can never be displayed via Ajax. --> <&#33;ELEMENT ajaxable (#PCDATA)> <&#33;-- Set the path of CSS that will be referenced in the page's header relative to the portal's context path. --> <&#33;ELEMENT header-portal-css (#PCDATA)> <&#33;-- Set the path of CSS that will be referenced in the page's header relative to the portlet's context path. --> <&#33;ELEMENT header-portlet-css (#PCDATA)> <&#33;-- Set the path of JavaScript that will be referenced in the page's header relative to the portal's context path. --> <&#33;ELEMENT header-portal-javascript (#PCDATA)> <&#33;-- Set the path of JavaScript that will be referenced in the page's header relative to the portlet's context path. --> <&#33;ELEMENT header-portlet-javascript (#PCDATA)> <&#33;-- Set the path of CSS that will be referenced in the page's footer relative to the portal's context path. --> <&#33;ELEMENT footer-portal-css (#PCDATA)> <&#33;-- Set the path of CSS that will be referenced in the page's footer relative to the portlet's context path. --> <&#33;ELEMENT footer-portlet-css (#PCDATA)> <&#33;-- Set the path of JavaScript that will be referenced in the page's footer relative to the portal's context path. --> <&#33;ELEMENT footer-portal-javascript (#PCDATA)> <&#33;-- Set the path of JavaScript that will be referenced in the page's footer relative to the portlet's context path. --> <&#33;ELEMENT footer-portlet-javascript (#PCDATA)> <&#33;-- Set name of the CSS class that will be injected in the DIV that wraps this portlet. --> <&#33;ELEMENT css-class-wrapper (#PCDATA)> <&#33;-- Set the facebook-integration value to either "fbml" or "iframe". The default value is "iframe" because IFrame integration will work without requiring any changes to your code. See the Message Boards portlet for minor changes that were made to make it FBML compliant. Note that the Liferay tag libraries already output FBML automatically if a request is made by Facebook. --> <&#33;ELEMENT facebook-integration (#PCDATA)> <&#33;-- If the add-default-resource value is set to false, and the portlet does not belong to the page but has been dynamically added, then the user will see that he does not have permissions to view the portlet. If the add-default-resource value is set to true, the default portlet resources and permissions are added to the page. The user can then view the portlet. Most portlets are harmless and can benefit from this flexibility. However, to prevent security loop holes, the default value is false. --> <&#33;ELEMENT add-default-resource (#PCDATA)> <&#33;-- Set the system value to true if the portlet is a system portlet that a user cannot manually add to their page. The default value is false. --> <&#33;ELEMENT system (#PCDATA)> <&#33;-- Set the active value to true if the portlet is active and available to users. If set to false, the portlet will not be active or available to users. The default value is true. This value can be changed at runtime via the Admin portlet. --> <&#33;ELEMENT active (#PCDATA)> <&#33;-- Set the include value to true to if the portlet is available to the portal. If set to false, the portlet is not available to the portal. The default value is true. Portlets that are not included as part of the portal are never available to the user to be made active or inactive. As far the user knows, the portlets do not even exist in the system. This allows the Liferay developers to bundle a lot of portlets in one core package, and yet allow custom deployments to turn on or off individual portlets or sets of portlets. This follows the Siebel and Microsoft model of bundling everything in one core package, but using XML configuration or registry settings to turn on and off features or sets of features. We do not recommend that custom deployers modify the core source by removing specific portlets because this prevents an easy upgrade process in the future. The best way to turn on and off portlets is to set the include element. The advantage of this way of doing things is that it becomes very easy to deploy Liferay. All features are available in one package. The disadvantage is that by not utilizing all of the portlets, you are wasting disk space and may even take a small but static memory footprint. However, we feel that the extra disk space and memory usage is a cheap price to pay in order to provide an easy installation and upgrade path. --> <&#33;ELEMENT include (#PCDATA)> <&#33;-- The role-mapper contains two names specified by role-name and role-link. The role-name value must be a role specified in portlet.xml. The role-link value must be the name of a Liferay role that exists in the database. The role-mapper element pairs up these two values to map roles from portlet.xml to roles in the Liferay database. This is needed because Liferay roles may contain spaces whereas roles in portlet.xml cannot contain spaces. This also adds extra flexibility where the portlet vendor does not need to have any knowledge about Liferay's roles. --> <&#33;ELEMENT role-mapper (role-name, role-link)> <&#33;-- See the comments in role-mapper element. --> <&#33;ELEMENT role-name (#PCDATA)> <&#33;-- See the comments in role-mapper element. --> <&#33;ELEMENT role-link (#PCDATA)> <&#33;-- The custom-user-attribute contains a list of names that are retrieved using a custom class that extends com.liferay.portlet.CustomUserAttributes. Download the sample hot deployable portlet WAR named test.war. Look for the class com.sample.strutsliferay.portlet.SampleUserAttributes to see how it associates the custom user attribute "user.name.test" with the value "Test Name". This class could be modified to read custom user attributes from another datasource that may be a database, a LDAP server, or a web service. See: http://www.liferay.com/page/guest/documentation/development/hot_deploy --> <&#33;ELEMENT custom-user-attribute (name+, custom-class)> <&#33;-- See the comments in custom-user-attribute element. --> <&#33;ELEMENT name (#PCDATA)> <&#33;-- See the comments in custom-user-attribute element. --> <&#33;ELEMENT custom-class (#PCDATA)>