Author: emuckenhuber Date: 2007-11-27 05:57:31 -0500 (Tue, 27 Nov 2007) New Revision: 9122 Added: docs/trunk/referenceGuide/en/modules/widgetintegration.xml Modified: docs/trunk/referenceGuide/en/master.xml Log: two words about widget integration and configuration Modified: docs/trunk/referenceGuide/en/master.xml =================================================================== --- docs/trunk/referenceGuide/en/master.xml 2007-11-27 10:41:30 UTC (rev 9121) +++ docs/trunk/referenceGuide/en/master.xml 2007-11-27 10:57:31 UTC (rev 9122) @@ -27,6 +27,7 @@ <!ENTITY security SYSTEM "modules/security.xml"> <!ENTITY troubleshooting SYSTEM "modules/troubleshooting.xml"> <!ENTITY contentintegration SYSTEM "modules/contentintegration.xml"> + <!ENTITY widgetintegration SYSTEM "modules/widgetintegration.xml"> <!ENTITY portalapi SYSTEM "modules/portalapi.xml"> <!ENTITY errorhandling SYSTEM "modules/errorhandling.xml"> <!ENTITY portletmodes SYSTEM "modules/portletmodes.xml"> @@ -77,6 +78,7 @@ <!-- Understanding urls --> &urls; <!-- Error handling --> &errorhandling; <!-- Content integration --> &contentintegration; + <!-- Widget integration --> &widgetintegration; <!-- Portlet modes --> &portletmodes; <!-- Portal API --> &portalapi; <!-- Clustering configuration --> &clustering; Added: docs/trunk/referenceGuide/en/modules/widgetintegration.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/widgetintegration.xml (rev 0) +++ docs/trunk/referenceGuide/en/modules/widgetintegration.xml 2007-11-27 10:57:31 UTC (rev 9122) @@ -0,0 +1,86 @@ +<chapter id="widgets"> + <chapterinfo> + <author> + <firstname>Emanuel</firstname> + <surname>Muckenhuber</surname> + <email&gt;emuckenh(a)redhat.com&lt;/email&gt; + </author> + </chapterinfo> + <title>Widget Integration</title> + <sect1> + <title>Introduction</title> + <para>JBoss Portal supports the integration of Google gadgets and Netvibes (<ulink url="http://dev.netvibes.com/doc/uwa_specification">UWA</... compatible) + widgets out of the box. This integration allows you to display the content of the widget within a portlet. + Both types can be added in the administration interface by editing the 'Page Layout' of a page or in the configuration of the users dashboard + when selecting the appropriate 'Content type'. + </para> + </sect1> + <sect1> + <title>Widget portlet configuration</title> + <para>It is possible to modify certain behavior of caching and fetching widgets by changing the init-param of the portlets.</para> + <para> + <itemizedlist> + <listitem> + <emphasis role="bold">connectionTimeout</emphasis> + <para> + Connection timeout for the directory lookup in milliseconds. + </para> + </listitem> + <listitem> + <emphasis role="bold">widgetExpiration</emphasis> + <para> + Time in minutes for which a widget should be cached. After this time the widget will be fetched again. + </para> + </listitem> + <listitem> + <emphasis role="bold">queryExpiration</emphasis> + <para> + Times in minutes for which a directory query should be cached. After this time the query will be performed again. + </para> + </listitem> + <listitem> + <emphasis role="bold">fetchWidgetsOnDirectoryLookup</emphasis> + <para> + This parameter defines if all widgets from a directory lookup should be fetched at the time of the query or not. + The default values is false. This means that widgets are only fetched on demand - when the information is really needed. + </para> + </listitem> + </itemizedlist> + </para> + <para> + The parameter can be changed for both widget types identically in either: + <itemizedlist> + <listitem><emphasis>jboss-portal.sar/portal-widget.war/WEB-INF/portlet.xml</emphasis> (for google gadgets)</listitem> + <listitem>or <emphasis>jboss-portal.sar/portal-widget-netvibes.war/WEB-INF/portlet.xml</emphasis> (for netvibes widgets).</listitem> + </itemizedlist> + </para> + <para> + <programlisting><![CDATA[... + <portlet> + ... + <init-param> + <name>connectionTimeout</name> + <value>5000</value> + </init-param> + <init-param> + <name>widgetExpiration</name> + <value>360</value> + </init-param> + <init-param> + <name>queryExpiration</name> + <value>60</value> + </init-param> + <init-param> + <name>fetchWidgetsOnDirectoryLookup</name> + <value>false</value> + </init-param> + ... + </portlet> +...]]></programlisting> + </para> + <para> + For Netvibes widgets it is also possible to define a init-param called <emphasis role="bold">defaultHeight</emphasis> to set a specific + default height if no height is defined by the widget itself. The default value is 250. + </para> + </sect1> +</chapter>