Author: thomas.heute(a)jboss.com
Date: 2007-10-09 08:36:31 -0400 (Tue, 09 Oct 2007)
New Revision: 8573
Modified:
branches/JBoss_Portal_Branch_2_6/core/src/resources/portal-core-sar/dtd/jboss-portlet_2_6.dtd
docs/trunk/referenceGuide/en/modules/xmldescriptors.xml
Log:
Documenting the icon metadata description
Modified:
branches/JBoss_Portal_Branch_2_6/core/src/resources/portal-core-sar/dtd/jboss-portlet_2_6.dtd
===================================================================
---
branches/JBoss_Portal_Branch_2_6/core/src/resources/portal-core-sar/dtd/jboss-portlet_2_6.dtd 2007-10-09
12:24:48 UTC (rev 8572)
+++
branches/JBoss_Portal_Branch_2_6/core/src/resources/portal-core-sar/dtd/jboss-portlet_2_6.dtd 2007-10-09
12:36:31 UTC (rev 8573)
@@ -94,12 +94,31 @@
-->
<!ELEMENT partial-refresh (#PCDATA)>
+<!--
+Additional portlet information
+-->
<!ELEMENT portlet-info (icon?)>
+<!--
+Defines icons for the portlet, they can be used by the administration portlet
+to represent a particular portlet.
+-->
<!ELEMENT icon (small-icon?, large-icon?)>
+<!--
+A small icon image, usually 16x16, gif, jpg and png are usually supported.
+An absolute URL or a URL starting with the context are accepted:
+eg.
http://www.example.com/images/smallIcon.png
+eg. /myWebAppContext/images/smallIcon.png
+-->
<!ELEMENT small-icon (#PCDATA)>
+<!--
+A large icon image, usually 32x32, gif, jpg and png are usually supported.
+An absolute URL or a URL starting with the context are accepted:
+eg.
http://www.example.com/images/smallIcon.png
+eg. /myWebAppContext/images/smallIcon.png
+-->
<!ELEMENT large-icon (#PCDATA)>
<!--
Modified: docs/trunk/referenceGuide/en/modules/xmldescriptors.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-10-09 12:24:48 UTC (rev
8572)
+++ docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-10-09 12:36:31 UTC (rev
8573)
@@ -953,6 +953,28 @@
</para>
</sect3>
<sect3>
+ <title>Defining extra portlet information</title>
+ <para>Since JBoss Portal 2.6.3, icons can be defined for a portlet.
+ <programlisting><![CDATA[
+<?xml version="1.0" standalone="yes"?>
+<!DOCTYPE portlet-app PUBLIC
+ "-//JBoss Portal//DTD JBoss Portlet 2.6//EN"
+ "http://www.jboss.org/portal/dtd/jboss-portlet_2_6.dtd">
+<portlet-app>
+ <portlet>
+ <portlet-name>ManagementPortlet</portlet-name>
+ <portlet-info>
+ <icon>
+
<small-icon>/myPortetAppContext/images/smallIcon.png</small-icon>
+
<large-icon>/myPortetAppContext/images/largeIcon.png</small-icon>
+ </icon>
+ </portlet-info>
+ </portlet>
+</portlet-app>]]></programlisting>
+ Those icons can be used by different part of the portal User Interface.
+ </para>
+ </sect3>
+ <sect3>
<title>Portlet Session Replication in a Clustered
Environment</title>
</sect3>
<para>See