[portal-commits] JBoss Portal SVN: r7612 - in docs/trunk/referenceGuide/en: images/migration and 6 other directories.

Author: thomas.heute(a)jboss.com Date: 2007-06-28 18:46:12 -0400 (Thu, 28 Jun 2007) New Revision: 7612 Added: docs/trunk/referenceGuide/en/images/tutorials/SpecPortalDef.png Removed: docs/trunk/referenceGuide/en/images/SpecPortalDef.png docs/trunk/referenceGuide/en/images/descriptors/ docs/trunk/referenceGuide/en/images/migration/cms_webdav_1.gif docs/trunk/referenceGuide/en/images/migration/cms_webdav_2.gif docs/trunk/referenceGuide/en/images/setup/default_ss.gif docs/trunk/referenceGuide/en/images/setup/inst_localhost.gif docs/trunk/referenceGuide/en/images/setup/inst_localhost.jpg docs/trunk/referenceGuide/en/images/snapshot1.png docs/trunk/referenceGuide/en/images/theme_ss.gif docs/trunk/referenceGuide/en/images/tutorials/first_portlet/output.gif docs/trunk/referenceGuide/en/images/tutorials/jsf_portlet/output.gif docs/trunk/referenceGuide/en/images/tutorials/jsp_portlet/output.gif Modified: docs/trunk/referenceGuide/en/images/migration/theme.png docs/trunk/referenceGuide/en/modules/cmsPortlet.xml docs/trunk/referenceGuide/en/modules/featurelist.xml docs/trunk/referenceGuide/en/modules/identity.xml docs/trunk/referenceGuide/en/modules/installation.xml docs/trunk/referenceGuide/en/modules/ldap.xml docs/trunk/referenceGuide/en/modules/security.xml docs/trunk/referenceGuide/en/modules/supported.xml docs/trunk/referenceGuide/en/modules/themeandlayouts.xml docs/trunk/referenceGuide/en/modules/tutorials.xml docs/trunk/referenceGuide/en/modules/wsrp.xml docs/trunk/referenceGuide/en/modules/xmldescriptors.xml Log: Polishing reference doc in trunk Deleted: docs/trunk/referenceGuide/en/images/SpecPortalDef.png =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/migration/cms_webdav_1.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/migration/cms_webdav_2.gif =================================================================== (Binary files differ) Modified: docs/trunk/referenceGuide/en/images/migration/theme.png =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/default_ss.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_localhost.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/setup/inst_localhost.jpg =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/snapshot1.png =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/theme_ss.gif =================================================================== (Binary files differ) Copied: docs/trunk/referenceGuide/en/images/tutorials/SpecPortalDef.png (from rev 7609, docs/trunk/referenceGuide/en/images/SpecPortalDef.png) =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/tutorials/first_portlet/output.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/tutorials/jsf_portlet/output.gif =================================================================== (Binary files differ) Deleted: docs/trunk/referenceGuide/en/images/tutorials/jsp_portlet/output.gif =================================================================== (Binary files differ) Modified: docs/trunk/referenceGuide/en/modules/cmsPortlet.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/cmsPortlet.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/cmsPortlet.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -51,8 +51,7 @@ <section> <title>Configuring a window to display CMS content</title> <para>Showing CMS content in a portal window can be done in the deployment descriptor quite easily - <programlisting><![CDATA[ -<window> + <programlisting><![CDATA[<window> <window-name>MyCMSWindow</window-name> <content> <content-type>cms</content-type> @@ -83,8 +82,7 @@ <emphasis>jboss-portal.sar/portal-core.war/WEB-INF/portlet.xml</emphasis> . </para> - <programlisting><![CDATA[ -<portlet-preferences> + <programlisting><![CDATA[<portlet-preferences> <preference> <name>indexpage</name> <value>/default/index.html</value> @@ -106,8 +104,7 @@ <para>Here is the default configuration for the CMS repository found under <literal>portal-cms.sar/META-INF-INF/jboss-service.xml</literal> </para> - <programlisting><![CDATA[ -... + <programlisting><![CDATA[... <attribute name="DoChecking">true</attribute> <attribute name="DefaultContentLocation">portal/cms/conf/default-content/default/</attribute> <attribute name="DefaultLocale">en</attribute> @@ -154,8 +151,7 @@ and change the value of Prefix to something else. Please note that you cannot change it to "nothing", you need to provide a value. </para> - <programlisting><![CDATA[ -... + <programlisting><![CDATA[... <mbean code="org.jboss.portal.core.cms.CMSObjectCommandFactory" name="portal:commandFactory=CMSObject" @@ -345,8 +341,7 @@ It works the same way as the server interceptor, for each interceptor you need to define an mbean then add it to the cms interceptor stack. For example, if you have the 2 default interceptors, you should have the following lines in the jboss-service.xml file: - <programlisting><![CDATA[ -<!-- ACL Security Interceptor --> + <programlisting><![CDATA[<!-- ACL Security Interceptor --> <mbean code="org.jboss.portal.cms.impl.interceptors.ACLInterceptor" name="portal:service=Interceptor,type=Cms,name=ACL" xmbean-dd="" xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> @@ -439,8 +434,7 @@ </para> <para> If you create your own interceptor <literal>org.example.myCMSInterceptor</literal>, the service descriptor file will look like: - <programlisting><![CDATA[ - <mbean code="org.example.myCMSInterceptor" + <programlisting><![CDATA[<mbean code="org.example.myCMSInterceptor" name="portal:service=Interceptor,type=Cms,name=MyName" xmbean-dd="" xmbean-code="org.jboss.portal.common.system.JBossServiceModelMBean"> <xmbean /> Modified: docs/trunk/referenceGuide/en/modules/featurelist.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/featurelist.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/featurelist.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -84,16 +84,12 @@ instances running inside of one Portal container. </listitem> <listitem> - <emphasis role="bold"> - <trademark class="trade">IPC</trademark> - </emphasis> + <emphasis role="bold">IPC</emphasis> Inter-Portlet Communication API enables portlets to create links to other objects such as a page, portal or window . </listitem> <listitem> - <emphasis role="bold"> - <trademark class="trade">Dynamicity</trademark> - </emphasis> + <emphasis role="bold">Dynamicity</emphasis> The ability for administrators and users to create and destroy objects such as portlets, pages, portals, themes, and layouts at runtime. </listitem> @@ -259,5 +255,9 @@ Content can be attributed to a specific locale and then served to the user based on his/her browser settings. </listitem> + <listitem> + <emphasis role="bold">Workflow Support:</emphasis> + Basic submit for review and approval process. + </listitem> </itemizedlist> </preface> Modified: docs/trunk/referenceGuide/en/modules/identity.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/identity.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/identity.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -234,7 +234,7 @@ <warning> UserProfileModule.getProperty() method returns an Object. In most cases with DB backend it will always be String object. But normally you should check what - object will be retreived using getProfileInfo() method. + object will be retrieved using getProfileInfo() method. </warning> </listitem> <listitem> Modified: docs/trunk/referenceGuide/en/modules/installation.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/installation.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/installation.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -1,28 +1,7 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="installation"> - <chapterinfo> - <author> - <firstname>Roy</firstname> - <surname>Russo</surname> - <email>roy at jboss dot org</email> - </author> - </chapterinfo> <title>Installation</title> <para>Depending on your needs, there are several different methods to get JBoss Portal up and running. - <itemizedlist> - <listitem> - <xref linkend="install_bundle"/> - </listitem> - <listitem> - <xref linkend="install_binary"/> - </listitem> - <listitem> - <xref linkend="install_source"/> - </listitem> - <listitem> - <xref linkend="install_installer"/> - </listitem> - </itemizedlist> <note>Pre-configured clustered versions are available from the <ulink url="http://labs.jboss.com/portal/jbossportal/download/index.html&qu... page</ulink> @@ -593,7 +572,7 @@ <para> <mediaobject> <imageobject> - <imagedata align="center" valign="middle" fileref="images/setup/inst_localhost.jpg"/> + <imagedata align="center" valign="middle" fileref="images/setup/inst_localhost.png"/> </imageobject> </mediaobject> </para> Modified: docs/trunk/referenceGuide/en/modules/ldap.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/ldap.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/ldap.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -207,7 +207,7 @@ </para> <sect3> <title>LDAPUserModuleImpl</title> - <para>This is the base implementation of LDAP <emphasis>UserModule</emphasis>. It supports user creation, but will retreive users and create them + <para>This is the base implementation of LDAP <emphasis>UserModule</emphasis>. It supports user creation, but will retrieve users and create them in strictly specified place in LDAP tree.</para> <para>To enable it in your configuration you should have: <programlisting><![CDATA[ @@ -287,7 +287,7 @@ </sect3> <sect3> <title>LDAPExtUserModuleImpl</title> - <para>Aim of this implementation is to give more flexibility for users retreival. You can specify LDAP filter + <para>Aim of this implementation is to give more flexibility for users retrieval. You can specify LDAP filter that will be used for searches. This module doesn't support user creation and removal</para> <para>To enable it in your configuration you should have: <programlisting><![CDATA[ @@ -381,7 +381,7 @@ </para> <sect3> <title>LDAPRoleModuleImpl</title> - <para>This is the base implementation of LDAP <emphasis>RoleModule</emphasis>. It supports user creation, but will retreive roles and create them + <para>This is the base implementation of LDAP <emphasis>RoleModule</emphasis>. It supports user creation, but will retrieve roles and create them in strictly specified place in LDAP tree.</para> <para>To enable it in your configuration you should have: <programlisting><![CDATA[ @@ -417,7 +417,7 @@ </sect3> <sect3> <title>LDAPExtRoleModuleImpl</title> - <para>Aim of this implementation is to give more flexibility for roless retreival. You can specify LDAP filter + <para>Aim of this implementation is to give more flexibility for roless retrieval. You can specify LDAP filter that will be used for searches. This module doesn't support role creation and removal</para> <para>This module doesn't support role creation and removal</para> <para>To enable it in your configuration you should have: @@ -548,7 +548,7 @@ <emphasis role="bold">common</emphasis>: <itemizedlist> <listitem> - <emphasis role="bold">membershipAttributeID</emphasis> - LDAP attribute that defines member users ids. This will be used to retreived users from role + <emphasis role="bold">membershipAttributeID</emphasis> - LDAP attribute that defines member users ids. This will be used to retrieved users from role entry. </listitem> <listitem> @@ -580,7 +580,7 @@ <emphasis role="bold">common</emphasis>: <itemizedlist> <listitem> - <emphasis role="bold">membershipAttributeID</emphasis> - LDAP attribute that defines role ids that user belongs to. This will be used to retreived roles + <emphasis role="bold">membershipAttributeID</emphasis> - LDAP attribute that defines role ids that user belongs to. This will be used to retrieved roles from user entry. </listitem> <listitem> @@ -597,7 +597,7 @@ <title>UserProfileModule</title> <sect3> <title>LDAPUserProfileModuleImpl</title> - <para>This is standard implementation that enables to retreive user properties from atributes in LDAP entries.</para> + <para>This is standard implementation that enables to retrieve user properties from atributes in LDAP entries.</para> <para>To enable it in your configuration you should have: <programlisting><![CDATA[ <module> Modified: docs/trunk/referenceGuide/en/modules/security.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/security.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/security.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -59,8 +59,7 @@ <para>The based principle of the security mechanism is that everything is restricted unless you grant privileges. You grant privilege on a portal node by adding a security constraint as explained here: <para> - <programlisting><![CDATA[ -<security-constraint> + <programlisting><![CDATA[<security-constraint> <policy-permission> <unchecked/> <action-name>viewrecursive</action-name> @@ -185,89 +184,101 @@ The configuration for the CMS Security service is specified in the jboss-portal.sar/portal-cms.sar/META-INF/jboss-service.xml file. The portion of the configuration relevant for securing the CMS service is listed as follows: <programlisting><![CDATA[<!-- interceptor factory where all cms interceptors are registered --> - <mbean - code="org.jboss.portal.server.impl.invocation.JBossInterceptorStackFactory" - name="portal:service=InterceptorStackFactory,type=Cms" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <depends-list optional-attribute-name="InterceptorNames"> - <depends-list-element>portal:service=Interceptor,type=Cms,name=ACL</depends-list-element> - <depends-list-element>portal:service=Interceptor,type=Cms,name=ApprovalWorkflow</depends-list-element> - </depends-list> - </mbean> - - <!-- CMS Authorization Security Service --> - <mbean - code="org.jboss.portal.cms.security.AuthorizationManagerImpl" - name="portal:service=AuthorizationManager,type=cms" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <attribute name="JNDIName">java:portal/cms/AuthorizationManager</attribute> - <depends optional-attribute-name="Provider" proxy-type="attribute"> - portal:service=AuthorizationProvider,type=cms - </depends> - </mbean> - <mbean - code="org.jboss.portal.cms.security.AuthorizationProviderImpl" - name="portal:service=AuthorizationProvider,type=cms" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <depends optional-attribute-name="IdentityServiceController" proxy-type="attribute">portal:service=Module,type=IdentityServiceController</depends> - </mbean> - - <!-- ACL Security Interceptor --> - <mbean - code="org.jboss.portal.cms.impl.interceptors.ACLInterceptor" - name="portal:service=Interceptor,type=Cms,name=ACL" - xmbean-dd="" - xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> - <xmbean/> - <attribute name="JNDIName">java:/portal/cms/ACLInterceptor</attribute> - <attribute name="CmsSessionFactory">java:/portal/cms/CMSSessionFactory</attribute> - <attribute name="IdentitySessionFactory">java:/portal/IdentitySessionFactory</attribute> - <attribute name="DefaultPolicy"> - <policy> - <!-- permissions on the root cms node --> - <criteria name="path" value="/"> - <permission name="cms" action="read"> - <role name="Anonymous"/> - </permission> - <permission name="cms" action="write"> - <role name="User"/> - </permission> - <permission name="cms" action="manage"> - <role name="Admin"/> - </permission> - </criteria> - <!-- permissions on the default cms node --> - <criteria name="path" value="/default"> - <permission name="cms" action="read"> - <role name="Anonymous"/> - </permission> - <permission name="cms" action="write"> - <role name="User"/> - </permission> - <permission name="cms" action="manage"> - <role name="Admin"/> - </permission> - </criteria> - <!-- permissions on the private/protected node --> - <criteria name="path" value="/default/private"> - <permission name="cms" action="manage"> - <role name="Admin"/> - </permission> - </criteria> - </policy> - </attribute> - <depends optional-attribute-name="AuthorizationManager" proxy-type="attribute"> - portal:service=AuthorizationManager,type=cms - </depends> - <depends>portal:service=Hibernate,type=CMS</depends> - <depends>portal:service=Module,type=IdentityServiceController</depends> - </mbean>]]> +<mbean + code="org.jboss.portal.server.impl.invocation.JBossInterceptorStackFactory" + name="portal:service=InterceptorStackFactory,type=Cms" xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean /> + <depends-list optional-attribute-name="InterceptorNames"> + <depends-list-element> + portal:service=Interceptor,type=Cms,name=ACL + </depends-list-element> + <depends-list-element> + portal:service=Interceptor,type=Cms,name=ApprovalWorkflow + </depends-list-element> + </depends-list> +</mbean> + +<!-- CMS Authorization Security Service --> +<mbean code="org.jboss.portal.cms.security.AuthorizationManagerImpl" + name="portal:service=AuthorizationManager,type=cms" xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean /> + <attribute name="JNDIName"> + java:portal/cms/AuthorizationManager + </attribute> + <depends optional-attribute-name="Provider" + proxy-type="attribute"> + portal:service=AuthorizationProvider,type=cms + </depends> +</mbean> +<mbean code="org.jboss.portal.cms.security.AuthorizationProviderImpl" + name="portal:service=AuthorizationProvider,type=cms" xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean /> + <depends optional-attribute-name="IdentityServiceController" + proxy-type="attribute"> + portal:service=Module,type=IdentityServiceController + </depends> +</mbean> + +<!-- ACL Security Interceptor --> +<mbean code="org.jboss.portal.cms.impl.interceptors.ACLInterceptor" + name="portal:service=Interceptor,type=Cms,name=ACL" xmbean-dd="" + xmbean-code="org.jboss.portal.jems.as.system.JBossServiceModelMBean"> + <xmbean /> + <attribute name="JNDIName"> + java:/portal/cms/ACLInterceptor + </attribute> + <attribute name="CmsSessionFactory"> + java:/portal/cms/CMSSessionFactory + </attribute> + <attribute name="IdentitySessionFactory"> + java:/portal/IdentitySessionFactory + </attribute> + <attribute name="DefaultPolicy"> + <policy> + <!-- permissions on the root cms node --> + <criteria name="path" value="/"> + <permission name="cms" action="read"> + <role name="Anonymous" /> + </permission> + <permission name="cms" action="write"> + <role name="User" /> + </permission> + <permission name="cms" action="manage"> + <role name="Admin" /> + </permission> + </criteria> + <!-- permissions on the default cms node --> + <criteria name="path" value="/default"> + <permission name="cms" action="read"> + <role name="Anonymous" /> + </permission> + <permission name="cms" action="write"> + <role name="User" /> + </permission> + <permission name="cms" action="manage"> + <role name="Admin" /> + </permission> + </criteria> + <!-- permissions on the private/protected node --> + <criteria name="path" value="/default/private"> + <permission name="cms" action="manage"> + <role name="Admin" /> + </permission> + </criteria> + </policy> + </attribute> + <depends optional-attribute-name="AuthorizationManager" + proxy-type="attribute"> + portal:service=AuthorizationManager,type=cms + </depends> + <depends>portal:service=Hibernate,type=CMS</depends> + <depends> + portal:service=Module,type=IdentityServiceController + </depends> +</mbean>]]> </programlisting> </para> </sect2> Modified: docs/trunk/referenceGuide/en/modules/supported.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/supported.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/supported.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -20,7 +20,7 @@ <title>Minimum System Requirements</title> <para> <itemizedlist> - <listitem>JDK 1.4 or higher (1.4.2 is recommended)</listitem> + <listitem>JDK 1.4 or JDK 5 (JDK 6 is not part of the test platform)</listitem> <listitem>512 MB RAM</listitem> <listitem>100 MB hard disk space</listitem> <listitem>400 MHz CPU</listitem> @@ -36,7 +36,7 @@ <sect1> <title>JBoss Application Server</title> <para>As of today JBoss Portal only works with JBoss Application Server.</para> - <para>Currently we recommend using JBoss AS 4.0.5.GA, support for JBoss AS 4.2.x is on its way.</para> + <para>JBoss AS 4.0.5.GA and JBoss AS 4.2.0.GA are supported.</para> <warning> <para> Versions before 4.0.4 of JBoss Application Server are not supported with this version of JBoss Portal.</para> </warning> Modified: docs/trunk/referenceGuide/en/modules/themeandlayouts.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/themeandlayouts.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/themeandlayouts.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -151,8 +151,7 @@ <para> Again, you have several choices, either to edit the included JSPs directly or create your own, store them in a web application then edit the following file: <literal>portal-core.sar/META-INF/jboss-service.xml</literal>. The interesting part in that file is the following: - <programlisting><![CDATA[ -<mbean + <programlisting><![CDATA[<mbean code="org.jboss.portal.core.aspects.controller.PageCustomizerInterceptor" name="portal:service=Interceptor,type=Command,name=PageCustomizer" xmbean-dd="" @@ -164,8 +163,7 @@ <depends optional-attribute-name="PortalAuthorizationManagerFactory" proxy-type="attribute">portal:service=PortalAuthorizationManagerFactory</depends> -</mbean> - ]]></programlisting> +</mbean>]]></programlisting> The three attibutes are: <itemizedlist> <listitem>TargetContextPath: Defines the web application context where the JSPs are located</listitem> @@ -189,8 +187,7 @@ Therefore it is possible to generate the URL using the <emphasis>toString()</emphasis> method and change various things related to the URL. With that in hand, if someone just wanted to display the logged-in username and a link to log out, he could write: - <programlisting><![CDATA[ -<%@ page import="org.jboss.portal.identity.User" %> + <programlisting><![CDATA[<%@ page import="org.jboss.portal.identity.User" %> <% User user = (User) request.getAttribute("org.jboss.portal.header.USER"); @@ -212,8 +209,7 @@ <a href="<%= signOutURL %>">Logout</a> <% } -%> - ]]></programlisting> +%>]]></programlisting> </para> <para>Writing the tabs JSP</para> <para>A couple of request attributes are set so that they can be used by the JSP, here is the list of attributes and their meaning: @@ -276,8 +272,7 @@ deployer. If the layout deployer detects such a descriptor in a web application, it will parse the content and register the layouts with the layout service of the portal. Here is an example of such a descriptor file: - <programlisting><![CDATA[ -<layouts> + <programlisting><![CDATA[<layouts> <layout> <name>phalanx</name> <uri>/phalanx/index.jsp</uri> @@ -297,8 +292,7 @@ <para>Portals and pages can be configured to use a particular layout. The connection to the desired layout is made in the portal descriptor (YourNameHere-object.xml). Here is an example of such a portal descriptor: - <programlisting><![CDATA[ -<portal> + <programlisting><![CDATA[<portal> <portal-name>default</portal-name> <properties> <!-- Set the layout for the default portal --> @@ -395,8 +389,7 @@ </para> <para>Here is an example layout JSP that uses tags from the latter: <programlisting> - <![CDATA[ -<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> + <![CDATA[<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> @@ -435,8 +428,7 @@ </div> </div> </body> -</html> -]]></programlisting> +</html>]]></programlisting> </para> <para> <sect3> @@ -670,25 +662,30 @@ RenderSet descriptor is located in the WEB-INF/layout folder of a web application, and is named portal-renderSet.xml. Here is an example descriptor: <programlisting> - <![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <![CDATA[<?xml version="1.0" encoding="UTF-8"?> <portal-renderSet> -<renderSet name="divRenderer"> -<set content-type="text/html"> -<region-renderer>org.jboss.portal.theme.impl.render.DivRegionRenderer</region-renderer> -<window-renderer>org.jboss.portal.theme.impl.render.DivWindowRenderer</window-renderer> -<portlet-renderer>org.jboss.portal.theme.impl.render.DivPortletRenderer</portlet-renderer> -<decoration-renderer>org.jboss.portal.theme.impl.render.DivDecorationRenderer</decoration-renderer> -</set> -</renderSet> -<renderSet name="emptyRenderer"> -<set content-type="text/html"> -<region-renderer>org.jboss.portal.theme.impl.render.EmptyRegionRenderer</region-renderer> -<window-renderer>org.jboss.portal.theme.impl.render.EmptyWindowRenderer</window-renderer> -<portlet-renderer>org.jboss.portal.theme.impl.render.EmptyPortletRenderer</portlet-renderer> -<decoration-renderer>org.jboss.portal.theme.impl.render.EmptyDecorationRenderer</decoration-renderer> -</set> -</renderSet> + <renderSet name="divRenderer"> + <set content-type="text/html"> + <region-renderer>org.jboss.portal.theme.impl.render.DivRegionRenderer</region-renderer> + <window-renderer>org.jboss.portal.theme.impl.render.DivWindowRenderer</window-renderer> + <portlet-renderer>org.jboss.portal.theme.impl.render.DivPortletRenderer</portlet-renderer> + <decoration-renderer> + org.jboss.portal.theme.impl.render.DivDecorationRenderer + </decoration-renderer> + </set> + </renderSet> + <renderSet name="emptyRenderer"> + <set content-type="text/html"> + <region-renderer>org.jboss.portal.theme.impl.render.EmptyRegionRenderer</region-renderer> + <window-renderer>org.jboss.portal.theme.impl.render.EmptyWindowRenderer</window-renderer> + <portlet-renderer> + org.jboss.portal.theme.impl.render.EmptyPortletRenderer + </portlet-renderer> + <decoration-renderer> + org.jboss.portal.theme.impl.render.EmptyDecorationRenderer + </decoration-renderer> + </set> + </renderSet> </portal-renderSet> ]]></programlisting> </para> @@ -699,43 +696,40 @@ or page property, or a particular layout can specify an anonymous RenderSet to use. Here is an example of a portal descriptor: <programlisting> - <![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <![CDATA[<?xml version="1.0" encoding="UTF-8"?> <portal> -<portal-name>default</portal-name> -<properties> -<!-- use the divRenderer for this portal --> -<property> -<name>theme.renderSetId</name> -<value>divRenderer</value> -</property> -</properties> -<pages> -<default-page>default</default-page> -<page> -<page-name>default</page-name> -<properties> -<!-- overwrite the portal's renderset for this page --> -<property> -<name>theme.renderSetId</name> -<value>emptyRenderer</value> -</property> -</properties> -<window> -<window-name>TestPortletWindow</window-name> -<instance-ref>TestPortletInstance</instance-ref> -<region>center</region> -<height>0</height> -</window> -</page> -</pages> -</portal> - ]]></programlisting> + <portal-name>default</portal-name> + <properties> + <!-- use the divRenderer for this portal --> + <property> + <name>theme.renderSetId</name> + <value>divRenderer</value> + </property> + </properties> + <pages> + <default-page>default</default-page> + <page> + <page-name>default</page-name> + <properties> + <!-- overwrite the portal's renderset for this page --> + <property> + <name>theme.renderSetId</name> + <value>emptyRenderer</value> + </property> + </properties> + <window> + <window-name>TestPortletWindow</window-name> + <instance-ref>TestPortletInstance</instance-ref> + <region>center</region> + <height>0</height> + </window> + </page> + </pages> +</portal>]]></programlisting> Here is an example of a layout descriptor with an anonymous RenderSet: <programlisting> - <![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <![CDATA[<?xml version="1.0" encoding="UTF-8"?> <layouts> <renderSet> <set content-type="text/html"> @@ -750,8 +744,7 @@ <uri>/generic/index.jsp</uri> <uri state="maximized">/generic/maximized.jsp</uri> </layout> -</layouts> - ]]></programlisting> +</layouts>]]></programlisting> Again, anologous to layout strategies, the anonymous RenderSet overwrites the one specified for the page, and that overwrites the one specified for the portal. In other words: all pages that use the layout that defines an anonymous @@ -766,8 +759,7 @@ Here is an example for a window that uses the implementations of the emptyRenderer renderSet for all three aspects: <programlisting> - <![CDATA[ -<window> + <![CDATA[<window> <window-name>NavigationPortletWindow</window-name> <instance-ref>NavigationPortletInstance</instance-ref> <region>navigation</region> @@ -825,8 +817,7 @@ theme(s) to the ThemeService, which in turn makes the themes available for consumption by the portal. Here is an example of a theme descriptor: <programlisting> - <![CDATA[ -<themes> + <![CDATA[<themes> <theme> <name>nodesk</name> <link href="/nodesk/css/portal_style.css" rel="stylesheet" type="text/css" /> @@ -887,8 +878,7 @@ } </script> </theme> -</themes> - ]]></programlisting> +</themes>]]></programlisting> </para> <para>Themes are defined in the portal-themes.xml theme descriptor, which is localted in the WEB-INF/ folder of the web application. @@ -903,88 +893,93 @@ that specifies the phalanx theme as the theme for the entire portal, and the industrial theme for the theme test page: <programlisting> - <![CDATA[ -<portal> -<portal-name>default</portal-name> -<properties> -<!-- Set the theme for the default portal --> -<property> -<name>layout.id</name> -<value>phalanx</value> -</property> -</properties> -<pages> -<page> -<page-name>theme test</page-name> -<properties> -<!-- set a difference layout for this page --> -<property> -<name>layout.id</name> -<value>industrial</value> -</property> -</properties> -<window> -<window-name>CatalogPortletWindow</window-name> -<instance-ref>CatalogPortletInstance</instance-ref> -<region>left</region> -<height>0</height> -</window> -</page> -</pages> -</portal> - ]]></programlisting> + <![CDATA[<portal> + <portal-name>default</portal-name> + <properties> + <!-- Set the theme for the default portal --> + <property> + <name>layout.id</name> + <value>phalanx</value> + </property> + </properties> + <pages> + <page> + <page-name>theme test</page-name> + <properties> + <!-- set a difference layout for this page --> + <property> + <name>layout.id</name> + <value>industrial</value> + </property> + </properties> + <window> + <window-name>CatalogPortletWindow</window-name> + <instance-ref>CatalogPortletInstance</instance-ref> + <region>left</region> + <height>0</height> + </window> + </page> + </pages> +</portal>]]></programlisting> And here is an example of a layout JSP that defines a default theme to use if no other theme was defined for the portal or page: <programlisting> - <![CDATA[ -<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> + <![CDATA[<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<title><%= "JBoss Portal :: 2.2 early (Industrial)" %></title> -<meta http-equiv="Content-Type" content="text/html;" /> -<p:theme themeName='industrial' /> -<p:headerContent /> -</head> -<body id="body"> -<div id="portal-container"> -<div id="sizer"> -<div id="expander"> -<div id="logoName"></div> -<table border="0" cellpadding="0" cellspacing="0" id="header-container"> -<tr> -<td align="center" valign="top" id="header"><div id="spacer"></div></td> -</tr> -</table> -<div id="content-container"> -<p:region regionName='This-Is-The-Page-Region-To-Query-The-Page' -regionID='This-Is-The-Tag-ID-Attribute-To-Match-The-CSS-Selector'/> -<p:region regionName='left' regionID='regionA'/> -<p:region regionName='center' regionID='regionB'/> -<hr class="cleaner" /> -<div id="footer-container" class="portal-copyright">Powered by -<a class="portal-copyright" href="http://www.jboss.com/products/jbossportal"> - JBoss Portal -</a><br/> -Theme by <a class="portal-copyright" href="http://www.novell.com">Novell</a> -</div> -</div> -</div> -</div> -</div> -</body> -</html> - ]]></programlisting> + <head> + <title><%= "JBoss Portal :: 2.2 early (Industrial)" %></title> + <meta http-equiv="Content-Type" content="text/html;" /> + <p:theme themeName='industrial' /> + <p:headerContent /> + </head> + <body id="body"> + <div id="portal-container"> + <div id="sizer"> + <div id="expander"> + <div id="logoName"></div> + <table border="0" cellpadding="0" cellspacing="0" + id="header-container"> + <tr> + <td align="center" valign="top" id="header"> + <div id="spacer"></div> + </td> + </tr> + </table> + <div id="content-container"> + <p:region + regionName='This-Is-The-Page-Region-To-Query-The-Page' + regionID='This-Is-The-Tag-ID-Attribute-To-Match-The-CSS-Selector' /> + <p:region regionName='left' regionID='regionA' /> + <p:region regionName='center' regionID='regionB' /> + <hr class="cleaner" /> + <div id="footer-container" class="portal-copyright"> + Powered by + <a class="portal-copyright" + href="http://www.jboss.com/products/jbossportal"> + JBoss Portal + </a> + <br /> + Theme by + <a class="portal-copyright" + href="http://www.novell.com"> + Novell + </a> + </div> + </div> + </div> + </div> + </div> + </body> +</html>]]></programlisting> For the function of the individual tags in this example, please refere to the layout section of this document. </para> </sect2> <sect2> <title>How to write your own Theme</title> - <para>Ask your favorite web designer and/or consult the Theme Style Guide in this document - ;) - </para> + <para>Ask your favorite web designer and/or consult the Theme Style Guide in this document.</para> </sect2> </sect1> <sect1> @@ -1007,30 +1002,27 @@ of the wsrp_rewrite_ token in the portlet fragment will be replaced with a unique token (the window id). If the portlet also specifies content to be injected into the header of the page, that content is also subject to this rewrite. - <programlisting>res.setProperty("HEADER_CONTENT", " + <programlisting><![CDATA[res.setProperty("HEADER_CONTENT", " <script>function wsrp_rewrite_OnFocus(){alert('hello button');}</script> - "); + ");]]> </programlisting> Note that in order for the header content injection to work, the layout needs to make use of the headerContent JSP tag, like: <programlisting> - <![CDATA[ -<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> + <![CDATA[<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> -<head> -<title><JBoss Portal 2.2 early</title> -<meta http-equiv="Content-Type" content="text/html;" /> + <head> + <title><JBoss Portal 2.2 early</title> + <meta http-equiv="Content-Type" content="text/html;" /> -<p:headerContent /> - -</head> -<body id="body"> -<p>...</p> -</body> -</html> - ]]></programlisting> + <p:headerContent /> + </head> + <body id="body"> + <p>...</p> + </body> +</html>]]></programlisting> </para> </sect2> <sect2> @@ -1039,17 +1031,15 @@ header, it can do so by providing the context relative URI to the file in the jboss-portlet.xml descriptor, like: <programlisting> - <![CDATA[ -<portlet-app> -<portlet> -<portlet-name>HeaderContentPortlet</portlet-name> -<header-content> -<link rel="stylesheet" type="text/css" href="/portlet-styles/HeaderContent.css" + <![CDATA[<portlet-app> + <portlet> + <portlet-name>HeaderContentPortlet</portlet-name> + <header-content> + <link rel="stylesheet" type="text/css" href="/portlet-styles/HeaderContent.css" title="" media="screen" /> -</header-content> -</portlet> -</portlet-app> - ]]></programlisting> + </header-content> + </portlet> +</portlet-app>]]></programlisting> </para> <para>This functionality, just like the previously described header content injection, requires the layout JSP to add the "headerContent" JSP tag (see example above). One thing to note here is @@ -1063,8 +1053,7 @@ <para>One possible use of window properties is demonstrated in the divRenderer RenderSet implementation. If a window definition (in the portal descriptor) contains a property like: <programlisting> - <![CDATA[ -<window> + <![CDATA[<window> <window-name>HintPortletWindow</window-name> <instance-ref>HintPortletInstance</instance-ref> <region>center</region> @@ -1076,8 +1065,7 @@ <value>emptyRenderer</value> </property> </properties> -</window> - ]]></programlisting> +</window>]]></programlisting> the DivWindowRenderer will use the decoration renderer from the emptyRenderer RenderSet to render the decoration for this window (not delegate to the DivDecorationRenderer). As a result, the portlet window will be part of the rendered page, but it will not have a title, @@ -1154,13 +1142,17 @@ </para> <listitem> <para>Portal Body Selector - <programlisting> -#body { -background-image: url(images/portal_background.gif); -margin: 0px; -padding: 0px; -} - </programlisting> + <programlisting>#body { + background-color: #FFFFFF; + background-image: url( images/header_bg.gif ); + background-repeat: repeat-x; + margin: 0px; + padding: 0px; + font-family: Verdana, Arial, Helvetica, sans-serif; + background-repeat: repeat-x; + font-size: 11px; + color: #656565; +}</programlisting> Usage: This selector controls the background of the page, and can be modified to set a base font-family, layout margin, etc. that will be inherited by all child elements that do not have their own individual style applied. By default, @@ -1169,31 +1161,25 @@ </listitem> <listitem> <para>Portal Header Selectors - <programlisting> -#spacer { -width: 1024px; -line-height: 0px; -font-size: 0px; -height: 0px; -} - </programlisting> + <programlisting>#spacer { + width: 770px; + line-height: 0px; + font-size: 0px; + height: 0px; +}</programlisting> Usage: Spacer div used to keep header at certain width regardless of display size. This is done to avoid overlapping of tab navigation in header. To account for different display sizes, this selector can be modified to force a horizontal scroll in the browser which eliminates any issue with overlapping elements in the header. - <programlisting> -#header-container { -background-image: url(images/portal_background.gif); -background-repeat: repeat-y; -height: 100%; -min-width: 1000px; -width: 100%; -/* test to reposition header on page -position: absolute; -bottom: 5px;*/ - } - </programlisting> + <programlisting>#header-container { + background-repeat: repeat-y; + height: 100%; + min-width: 1000px; + width: 100%; + position: absolute; + bottom: 5px;*/ + }</programlisting> Usage: Wrapper selector used to control the position of the header on the page. This selector is applied as an ID on the table used to structure the header. You can adjust the attributes to reposition @@ -1202,34 +1188,31 @@ <para>Screenshot:</para> <para> <imageobject> - <imagedata fileref="images/themeguide/portlet-header.gif" format="gif"/> + <imagedata fileref="images/themeguide/portal-header.gif" format="gif"/> </imageobject> </para> - <programlisting> -#header { -background-image: url(images/header.gif); -background-repeat: repeat-x; -height: 100px; -padding: 0px; -/*margin: 0 25% 0 25%;*/ -} - </programlisting> + <programlisting>#header { + height: 65px; + width: 100%; + padding: 0px; + margin: 0px; + z-index: 1; +}</programlisting> Usage: This selector applies the header background image in the portal. It can be adjusted to accommodate a header background of a certain width/height or, as it currently does, repeat the header graphic so that it tiles across the header portion of the page. - <programlisting> -#logoName { -background-image: url(images/JBossLogo.gif); -background-repeat: no-repeat; -width: 187px; -height: 35px; -position: absolute; -left: 15px; -top: 16px; -z-index: 2; -} - </programlisting> + <programlisting>#logoName { + background-image: url( images/logo.gif ); + background-repeat: no-repeat; + float: left; + width: 250px; + height: 25px; + z-index: 2; + position: absolute; + left: 20px; + top: 10px; +}</programlisting> Usage: Logo selector which is used to brand the header with a specific, customized logo. The style is applied as an ID on an absolutely positioned DIV element which enables it to be moved to any location on the page, and allows it @@ -1238,14 +1221,13 @@ </listitem> <listitem> <para>Portal Layout Region Selectors - <programlisting> -#portal-container { + <programlisting>#portal-container { +/* part of below IE hack to preserve min-width for portlet regions */ /*width: 100%;*/ + margin: 4px 2% 0px 2%; -/*IE specific approach to preserve min-width for portlet regions */ -padding: 0 350px 0 350px; -} - </programlisting> + padding: 0 350px 0 350px; +}</programlisting> Usage: Wrapper for entire portal which starts/ends after/before the BODY tag (see red border in screen shot). The padding attribute for this selector is used to preserve a minimum width setting for the portlet regions (discussed @@ -1261,103 +1243,87 @@ /> </imageobject> </para> - <programlisting> -/* min width for IE */ + <programlisting>/* min width for IE */ #expander { -margin: 0 -350px 0 -350px; -position: relative; + position: relative; + padding: 0 0 0 0; + + margin: 0 -350px 0 -350px; + min-width: 770px; + padding: 0 0 0 0; } -/* min width for IE */ +/* min width hack for IE */ #sizer { -width: 100%; + width: 100%; } -/* IE min width \*/ +/* IE Hack \*/ * html #portal-container, -* html #sizer, -* html #expander { height: 0; } - </programlisting> + * html #sizer, + * html #expander { + height: 0; +}</programlisting> Usage: These selectors are used in conjunction with the above, portal-container, selector to preserve a minimum width setting for the portlet regions. This was implemented to maintain a consistent look across different browsers. - <programlisting> -/*table that contains all regions. does not include header*/ -#content-container { -height: 100%; -text-align:left; -max-width: 1600px; -min-width: 800px; -} - </programlisting> + <programlisting>#content-container { + height: 100%; + text-align: left; + width: 100%; + min-width: 770px; + /* + position: absolute; + top: 70px; + left: 0px; / * z-index: 1; * / + / * part of below IE hack +padding: 0 350px 0 350px; * / + padding: 0px 100px 0px 0px; + */ +}</programlisting> Usage: Wrapper that contains all regions in portal with the exception of the header (see orange border in screen shot). Its attributes can be adjusted to create margin space on page, as well as control positioning of the area of the page below the header. - <programlisting> + <programlisting>/* portlet regions within content-container. this includes footer-container. */ #regionA { -/* test to swap columns with regionB... -float: right; */ - -width: 30%; -float: left; -margin: 0px; -padding: 0px; -min-width: 250px; -} - </programlisting> + width: 30%; + float: left; + margin: 0px; + padding: 0px; + min-width: 250px; /*height: 300px;*/ +}</programlisting> Usage: First portlet region located within the content-container (see blue border in screen shot). This selector controls the width of the region as well as its location on the page. Designers can very easily reposition this region in the portal (e.g. swap left regionA with right regionB, etc.) by adjusting the attributes of this selector. - <programlisting> -#regionB { -/*test to swap columns with regionA... + <programlisting>#regionB { + /* test to swap columns.. margin: 0 30% 0 0; */ -/* two column layout*/ -margin: 0 0 0 30%; -padding: 0; -width: 69%; - -/* test to add 3rd region in layout... -width: 40%; -float: left;*/ -} - </programlisting> + /*two column layout +margin: 0 0 0 30%;*/ + padding: 0px; /* test to add 3rd region in layout...*/ + width: 67%; + float: left; /*height: 300px;*/ +}</programlisting> Usage: Second portlet region located within the content-container (see blue border in screen shot). Similar to regionA, this selector controls the width of the region as well as its location on the page. - <programlisting> -#regionC { -/* inclusion of 3rd region - comment out for 2 region testing -padding: 0px; -width: 27%; -float: left;*/ -display: none; -} - </programlisting> + <programlisting>#regionC { +/* inclusion of 3rd region - comment out for 2 region testing */ + padding: 0px; + margin: 0px; + width: 28%; + float: left; /*hide 3rd region*/ + display: none; +}</programlisting> Usage: Third portlet region located within the content-container (please refer to blue border in screen shot representing regionA and regionB for an example). Used for 3 column layout. Similar to regionA and regionB, this selector controls the width of the region as well as its location on the page. - <programlisting> -/* give a maximized portlet more space */ -#regionMaximized { -width: 100%; -float: left; -margin: 0px; -padding: 0px; -min-width: 400px; -} - </programlisting> - Usage: Portlet region located within the content-container (please refer to - blue border in screen shot representing regionA and regionB for an example). - Used for a one column layout to allow one portlet to take over the entire page. - Similar to regionA, regionB, and regionB, this selector controls the width of - the region as well as its location on the page. <para>Screenshot:</para> <para> <imageobject> @@ -1376,205 +1342,54 @@ </programlisting> Usage: Used to clear floats in regionA, regionB and regionC DIVs so that footer spans bottom of page. - <programlisting> -#footer-container { -margin: 30px 25% 0 25%; -text-align: center; -} - </programlisting> + <programlisting>#footer-container { + padding: 10px; + text-align: center; + clear: both; +}</programlisting> Usage: Footer region located towards the bottom of the content-container (see above screen shot). This region spans the entire width of the page, but can be adjusted (just like regionA, regionB and regionC) to take on a certain position and width/height in the layout. - <programlisting> -#navigation-container {} - </programlisting> - Usage: Unused at this time. - <programlisting> -#sub-navigation-container {} - </programlisting> - Usage: Unused at this time. </para> </listitem> <listitem> - <para>Tab Navigation Selectors for Header - <programlisting> -UL#tabsHeader { -margin: 0; -padding-left: 300px; -min-width: 550px; -} - </programlisting> - Usage: Used to provide position (through padding attribute) of tabbed - navigational items in header. A padding-left of 300px gives space for the left - hand logo area and can be adjusted as needed to set the desired location for - the navigation. - <programlisting> -UL#tabsHeader li { -list-style: none; -float: left; -margin-left: 0px; -margin-top: 74px; -margin-right: 0px; -line-height: 24px; -padding: 0px; -border-left: 1px solid #72828E; -} - </programlisting> - Usage: Selector used to style list items as horizontal navigation and to set - the spacing and position of each nav item that's available. - <programlisting> -UL#tabsHeader li:hover { -background-image: url(images/highlightedTab.gif); -background-repeat: repeat-x; -} - </programlisting> - Usage: Used to provide hover pseudo class on navigation items so that the tab - background will change upon mouseover. Note that currently IE only supports the - hover pseudo class on links, so this selector will only affect non-IE browsers - (e.g. FireFox, etc.). - <programlisting> -UL#tabsHeader li.hoverOn { -background-image: url(images/highlightedTab.gif); -background-repeat: repeat-x; -} - -UL#tabsHeader li.hoverOff { -background-image:none; -} - </programlisting> - Usage: These two selectors are implemented to account for the fact that IE - cannot understand the use of a pseudo class on the LI element. They provide the - same mouseover effect as the “UL#tabsHeader li:hover�? selector when hovering - the navigation item in IE, and are used in combination with - onmouseover/onmouseout event handlers in the header navigation: - <programlisting> - <![CDATA[ -<li onmouseover="this.className='hoverOn'" onmouseout="this.className='hoverOff'"> -<a href="#">Tab Nav</a> -</li> -]]> - </programlisting> - <programlisting> -UL#tabsHeader a { -display: block; -float: left; -padding: 4px 15px 5px 15px; -text-decoration: none; -font: 13px/normal Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -background: 100% 0 no-repeat; -color: #596874; -} - </programlisting> - Usage: This selector styles the navigational links, indicating padding - surrounding the link as well as font family, color and text-decoration. - <programlisting> -UL#tabsHeader a:hover { -text-decoration: underline; -} - </programlisting> - Usage: Used to underline navigational links when hovering with mouse. Unlike - the li:hover pseudo class, IE does support the hover effect on links, so there - is no need for a separate set of selectors to deal with this effect. - <programlisting> -UL#tabsHeader #current, UL#tabsHeader #current a { -font: 13px/normal Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-weight: 600; -color: #EBEAEA; -background-image: url(images/activeTab.gif); -background-repeat: repeat-x; -border-right: 0px; -border-left: 0px; -} - </programlisting> - Usage: This selector is set on the current/selected navigation item to style - both the background of the tab as well as font properties such as color and - weight. Example: - <programlisting> - <![CDATA[ -<li id="current" onmouseover="this.className='hoverOn'" onmouseout="this.className='hoverOff'"> -<a href="#">Tab Nav</a> -</li> -]]> - </programlisting> - <programlisting> -/* backslash for IE5-Mac \*/ -UL#tabsHeader a {float: none;} /* End Mac Hack */ -html&gt;body UL#tabsHeader a {width: auto;} /* fixes IE issues */ - </programlisting> - Usage: Also known in the industry as an example of the “Holly Hack�?, the above - is added to the stylesheet to handle certain buggy issues with IE. This section - of the stylesheet should be left alone as subsequent changes can effect the way - things behave in IE. - <programlisting> -li.currentTabBackground { -background: #fff; -} - -li.currentTabBackgroundSubNav { -background: #eeeeef; -} - </programlisting> - Usage: The above two selectors are not currently in use. Included to account - for future changes to the navigation where multiple tiers/levels might be - incorporated. - </para> - </listitem> - <listitem> <para>Portlet Container Window Selectors - <programlisting> -.portlet-container { -padding: 10px; -} - </programlisting> + <programlisting>.portlet-container { + padding: 10px; +}</programlisting> Usage: Wrapper that surrounds the portlet windows (see green border in screen shot). Currently, this selector is used to create space (padding) between the portlets displayed in each particular region. - <programlisting> -.portlet-titlebar-title { -font-family: Verdana, Arial, Helvetica, sans-serif; -font-size: 11px; -font-weight: 500; -color: #596874; -white-space: nowrap; -line-height: 100%; -float: left; -text-indent: 15px; -} - </programlisting> + <programlisting>.portlet-titlebar-title { + color: #656565; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 12px; + font-weight: bold; + white-space: nowrap; + line-height: 100%; + float: left; + text-indent: 5px; + padding-top: 5px; + padding-bottom: 6px; +}</programlisting> Usage: Class used to style the title of each portlet window. Attributes of this selector set font properties, indentation and position of title. - <programlisting> -.portlet-titlebar-decoration { -background-image: url(images/portlet-win-decoration.gif); -background-repeat: no-repeat; -height: 11px; -width: 11px; -float: left; -position: relative; -top: 6px; -} - </programlisting> - Usage: Used to display top left portlet window decoration (e.g. sphere icon in - Industrial theme). Attributes for this selector set position and dimensions of - this decoration. - <programlisting> -.portlet-mode-container { -float: right; -} - </programlisting> + <programlisting>.portlet-mode-container { + float: right; + padding-top: 4px; + white-space: nowrap; +}</programlisting> Usage: Wrapper that contains the portlet window modes that display in the top right section of the portlet windows. - <programlisting> -.portlet-titlebar-left { -background-image: url(images/portlet-top-left.gif); -background-repeat: no-repeat; -width: 9px; -height: 33px; -background-position: right; -min-width: 9px; -} - </programlisting> + <programlisting>.portlet-titlebar-left { + background-image: url( images/portlet-top-left.gif ); + background-repeat: no-repeat; + width: 9px; + height: 29px; + min-width: 9px; + background-position: bottom; +}</programlisting> Usage: Used to style the top left corner of the portlet window. Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the first column (TD) in the first row (TR). @@ -1585,13 +1400,12 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-titlebar-center { -background-image: url(images/portlet-top-middle.gif); -background-repeat: repeat-x; -height: 33px; -} - </programlisting> + <programlisting>.portlet-titlebar-center { + background-image: url( images/portlet-top-middle.gif ); + background-repeat: repeat-x; + height: 29px; + background-position: bottom; +}</programlisting> Usage: Used to style the center section of the portlet title bar. Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the second column (TD) in the first row (TR). @@ -1602,15 +1416,14 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-titlebar-right { -background-image: url(images/portlet-top-right.gif); -background-repeat: no-repeat; -width: 10px; -height: 33px; -min-width: 10px; -} - </programlisting> + <programlisting>.portlet-titlebar-right { + background-image: url( images/portlet-top-right.gif ); + background-repeat: no-repeat; + width: 10px; + height: 30px; + min-width: 10px; + background-position: bottom left; +}</programlisting> Usage: Used to style the top right corner of the portlet window. Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the third column (TD) in the first row (TR). @@ -1621,16 +1434,17 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-content-left { -background-image: url(images/portlet-left-vertical.gif); -height: 100%; -background-repeat: repeat-y; -background-position: right; -width: 9px; -min-width: 9px; -} - </programlisting> + <programlisting>.portlet-content-left { + background-image: url( images/portlet-left-vertical.gif ); + background-repeat: repeat-y; + width: 9px; + min-width: 9px; + /* + width:20px; + background-color:#FFFFFF; + border-left: 1px solid #dfe8ed; + */ +}</programlisting> Usage: Used to style the left hand vertical lines that make up the portlet window. Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the first column (TD) in the second row (TR). @@ -1643,15 +1457,11 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-content-center { -background-color: #f7f7f7; -background-repeat: repeat; -vertical-align: top; -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 13px; -} - </programlisting> + <programlisting>.portlet-content-center { + vertical-align: top; + padding: 0; + margin: 0; +}</programlisting> Usage: Used to style the center, content area where the portlet content is injected into the portlet window (see below screen). Attributes for this selector control the positioning of the portlet content as well as the @@ -1665,11 +1475,11 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-body { -background-color: #f7f7f7; -} - </programlisting> + <programlisting>.portlet-body { + background-color: #FFFFFF; + padding: 0; + margin: 0; +}</programlisting> Usage: An extra selector for controlling the content section of the portlet windows (see below screen). This was added to better deal with structuring the content that gets inserted/rendered in the portlet windows, specifically if the @@ -1680,16 +1490,21 @@ <imagedata fileref="images/themeguide/portlet-body.gif" format="gif"/> </imageobject> </para> - <programlisting> -.portlet-content-right { -background-image: url(images/portlet-right-vertical.gif); -height: 100%; -background-repeat: repeat-y; -background-position: left; -width: 10px; -min-width: 10px; -} - </programlisting> + <programlisting>.portlet-content-right { + background-image: url( images/portlet-right-vertical.gif ); + height: 100%; + background-repeat: repeat-y; + background-position: left; + width: 5px; + min-width: 5px; + padding: 0; + margin: 0; + /* + width:5px; + background-color:#FFFFFF; + border-right: 1px solid #dfe8ed; + */ +}</programlisting> Usage: Used to style the right hand vertical lines that make up the portlet window. Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the third column (TD) in the second row (TR). @@ -1702,16 +1517,22 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-footer-left { -background-image: url(images/portlet-bottom-left.gif); -width: 9px; -height: 9px; -background-repeat: no-repeat; -background-position: top right; -min-width: 9px; -} - </programlisting> + <programlisting>.portlet-footer-left { + background-image: url( images/portlet-bottom-left.gif ); + width: 9px; + height: 4px; + background-repeat: no-repeat; + background-position: top right; + min-width: 9px; + padding: 0; + margin: 0; + /* + background-color:#FFFFFF; + border-bottom: 1px solid #98b7c6; + border-left: 1px solid #dfe8ed; + height:5px; + */ +}</programlisting> Usage: Used to style the bottom left corner of the portlet window. Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the first column (TD) in the third row (TR). @@ -1722,13 +1543,15 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-footer-center { -background-image: url(images/portlet-bottom-middle.gif); -height: 14px; -background-repeat: repeat-x; -} - </programlisting> + <programlisting>.portlet-footer-center { + background-image: url( images/portlet-bottom-middle.gif ); + height: 4px; + background-repeat: repeat-x; + /* background-color:#FFFFFF; + border-bottom: 1px solid #98b7c6; + height:5px; + */ +}</programlisting> Usage: Used to style the bottom, center of the portlet window (i.e. the bottom horizontal line in the Industrial theme). Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the second column @@ -1740,15 +1563,19 @@ format="gif"/> </imageobject> </para> - <programlisting> -.portlet-footer-right { -background-image: url(images/portlet-bottom-right.gif); -width: 10px; -height: 9px; -background-repeat: no-repeat; -min-width: 10px; -} - </programlisting> + <programlisting>.portlet-footer-right { + background-image: url( images/portlet-bottom-right.gif ); + width: 5px; + height: 4px; + background-repeat: no-repeat; + min-width: 5px; + /* + background-color:#FFFFFF; + border-bottom: 1px solid #98b7c6; + border-right: 1px solid #dfe8ed; + height:5px; + */ +}</programlisting> Usage: Used to style the bottom right corner of the portlet window. Each portlet window consists of one table that has 3 columns and 3 rows. This selector styles the third column (TD) in the third row (TR). @@ -1763,117 +1590,110 @@ </listitem> <listitem> <para>Portlet Window Mode Selectors - <programlisting> -.portlet-mode-maximized { -background-image: url(images/maximize.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-maximized { + background-image: url( images/ico_16_maximize.gif ); + background-repeat: no-repeat; + width: 16px; + height: 16px; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; +}</programlisting> Usage: Selector used to display the portlet maximize mode. Attributes for this selector control the display and dimensions of the maximize icon, including the behavior of the mouse pointer when hovering the mode. - <programlisting> -.portlet-mode-minimized { -background-image: url(images/minimize.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-minimized { + background-image: url( images/ico_16_minimize.gif ); + background-repeat: no-repeat; + width: 16px; + height: 16px; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; +}</programlisting> Usage: Selector used to display the portlet minimize mode. Attributes for this selector control the display and dimensions of the minimize icon, including the behavior of the mouse pointer when hovering the mode. - <programlisting> -.portlet-mode-normal { -background-image: url(images/normal.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-normal { + background-image: url( images/ico_16_normal.gif ); + width: 16px; + height: 16px; + background-repeat: no-repeat; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; +}</programlisting> Usage: Selector used to display the portlet normal mode (i.e. the icon that when clicked, restores the portlet to the original, default view). Attributes for this selector control the display and dimensions of the normal icon, including the behavior of the mouse pointer when hovering the mode. - <programlisting> -.portlet-mode-help { -background-image: url(images/help.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-help { + background-image: url( images/ico_16_help.gif ); + width: 16px; + height: 16px; + background-repeat: no-repeat; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; +}</programlisting> Usage: Selector used to display the portlet help mode. Attributes for this selector control the display and dimensions of the help icon, including the behavior of the mouse pointer when hovering the mode. - <programlisting> -.portlet-mode-edit { -background-image: url(images/edit.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-edit { + background-image: url( images/ico_edit.gif ); + background-repeat: no-repeat; + width: 28px; + height: 16px; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; +}</programlisting> Usage: Selector used to display the portlet edit mode. Attributes for this selector control the display and dimensions of the edit icon, including the behavior of the mouse pointer when hovering the mode. - <programlisting> -.portlet-mode-remove { -background-image: url(images/remove.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-remove { + background-image: url( images/ico_16_remove.gif ); + background-repeat: no-repeat; + width: 16px; + height: 16px; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; +}</programlisting> Usage: Currently not available. But here is the intended use: Selector used to display the portlet remove mode. Attributes for this selector control the display and dimensions of the remove icon, including the behavior of the mouse pointer when hovering the mode. - <programlisting> -.portlet-mode-view { -background-image: url(images/view.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-view { + background-image: url( images/ico_cancel.gif ); + background-repeat: no-repeat; + width: 28px; + height: 16px; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; + padding-right: 20px; +}</programlisting> Usage: Selector used to display the portlet view mode. Attributes for this selector control the display and dimensions of the view icon, including the behavior of the mouse pointer when hovering the mode. - <programlisting> -.portlet-mode-reload { -background-image: url(images/reload.gif); -width: 16px; -height: 23px; -background-repeat: no-repeat; -float: left; -display: inline; -cursor: pointer; -} - </programlisting> + <programlisting>.portlet-mode-reload { + background-image: url( images/ico_16_reload.gif ); + background-repeat: no-repeat; + width: 16px; + height: 16px; + float: left; + display: inline; + cursor: pointer; + padding-left: 3px; +}</programlisting> Usage: Currently not available. But here is the intended use: Selector used to display the portlet reload mode. Attributes for this selector control the display and dimensions of the reload icon, including the behavior of the mouse @@ -1882,23 +1702,21 @@ </listitem> <listitem> <para>Copyright Selectors - <programlisting> -.portal-copyright { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -color: #5E6D7A; + <programlisting>.portal-copyright { + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 10px; + color: #5E6D7A; } a.portal-copyright { -color: #768591; -text-decoration: none; + color: #768591; + text-decoration: none; } a.portal-copyright:hover { -color: #96A5B1; -text-decoration: none; -} - </programlisting> + color: #bcbcbc; + text-decoration: underline; +}</programlisting> Usage: The above three selectors are used to style copyright content in the portal. The portal-copyright selector sets the font properties (color, etc.), and the a.portal-copyright/a.portal-copyright:hover selectors style any links @@ -1906,102 +1724,57 @@ </para> </listitem> <listitem> - <para>Element Selectors - <programlisting> -a { -color: #768591; -text-decoration: none; -} -a:hover { -color: #96A5B1; -text-decoration: none; -} - </programlisting> - Usage: The above two selectors style all anchor elements that do not have their - own class/selector applied. - <programlisting> -INPUT { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 10px; -} - </programlisting> - Usage: The above selector styles all INPUT elements that do not have their own - class/selector applied. - <programlisting> -SELECT { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 10px; -} - </programlisting> - Usage: The above selector styles all SELECT elements that do not have their own - class/selector applied. - <programlisting> -FONT { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 10px; -color: #768591; -} - </programlisting> - Usage: The above selector styles all FONT elements that do not have their own - class/selector applied. - <programlisting> -FIELDSET { -background-color: #f7f7f7; -border:1px solid #BABDB6; -padding: 6px; -} - </programlisting> - Usage: The above selector styles all FIELDSET elements that do not have their - own class/selector applied. - <programlisting> -LEGEND { -background-color: transparent; -padding-left: 6px; -padding-right: 6px; -padding-bottom: 0px; -font-size: 14px; -} - </programlisting> - Usage: The above selector styles all LEGEND elements that do not have their own - class/selector applied. - </para> - </listitem> - <listitem> <para>Table Selectors - <programlisting> -.portlet-table-header {} - </programlisting> - Usage: Not currently in use. Intended for styling tables (specifically, the TH + <programlisting>.portlet-table-header { + background-color: #eef; + padding: 0 5px 5px 5px; + font-weight: bold; + color: #656565; + font-size: 12px; + border-bottom: 1px solid #d5d5d5; +}</programlisting> + Usage: Intended for styling tables (specifically, the TH or table header elements) that get rendered within a portlet window. - <programlisting> -.portlet-table-body {} - </programlisting> - Usage: Not currently in use. Intended for styling the table body element used + <programlisting>.portlet-table-body { + +}</programlisting> + Usage: Intended for styling the table body element used to group rows in a table. - <programlisting> -.portlet-table-alternate {} - </programlisting> - Usage: Not currently in use. Used to style the background color (and possibly + <programlisting>.portlet-table-alternate { + background-color: #E6E8E5; + border-bottom: 1px solid #d5d5d5; +}</programlisting> + Usage: Used to style the background color (and possibly other attributes) for every other row within a table. - <programlisting> -.portlet-table-selected {} - </programlisting> - Usage: Not currently in use. Used to style text, color, etc. in a selected cell + <programlisting>.portlet-table-selected { + color: #000; + font-size: 12px; + background-color: #CBD4E6; +}</programlisting> + Usage: Used to style text, color, etc. in a selected cell range. - <programlisting> -.portlet-table-subheader {} - </programlisting> - Usage: Not currently in use. Used to style a subheading within a table that + <programlisting>.portlet-table-subheader { + font-weight: bold; + color: #000; + font-size: 12px; +}</programlisting> + Usage: Used to style a subheading within a table that gets rendered in a portlet. - <programlisting> -.portlet-table-footer {} - </programlisting> - Usage: Not currently in use. Similar to portlet-table-header and + <programlisting>.portlet-table-footer { + padding: 5px 5px 0 5px; + font-weight: bold; + color: #656565; + font-size: 12px; + border: none; + border-top: 1px solid #d5d5d5; +}</programlisting> + Usage: Similar to portlet-table-header and portlet-table-body, this selector is used to style the table footer element which is used to group the footer row in a table. - <programlisting> -.portlet-table-text {} - </programlisting> + <programlisting>.portlet-table-text { + padding: 3px 5px; + border-bottom: 1px solid #d5d5d5; +}</programlisting> Usage: Text that belongs to the table but does not fall in one of the other categories (e.g. explanatory or help text that is associated with the table). This selector can also be modified to provide styled text that can be used in @@ -2010,226 +1783,184 @@ </listitem> <listitem> <para>FONT Selectors - <programlisting> -.portlet-font { -color:#000; -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 10px; -} - </programlisting> + <programlisting>.portlet-font { + color: #000000; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 11px; +}</programlisting> Usage: Used to style the font properties on text used in a portlet. Typically this class is used for the display of non-accentuated information. - <programlisting> -.portlet-font-dim { -color:#888385; -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 10px; -} - </programlisting> + <programlisting>.portlet-font-dim { + color: #777777; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 11px; +}</programlisting> Usage: A lighter version (color-wise) of the portlet-font selector. </para> </listitem> <listitem> <para>FORM Selectors - <programlisting> -.portlet-form-label { -color:#4A4A4A; -text-decoration:none; -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -} - </programlisting> + <programlisting>.portlet-form-label { + font-size: 10px; + color: #656565; +}</programlisting> Usage: Text used for the descriptive label of an entire form (not the label for each actual form field). - <programlisting> -.portlet-form-button { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -color: #270F07; -} - </programlisting> + <programlisting>.portlet-form-button { + font-size: 10px; + font-weight: bold; + color: #FFFFFF; + background-color: #5078aa; + border-top: 1px solid #97B7C6; + border-left: 1px solid #97B7C6; + border-bottom: 1px solid #254869; + border-right: 1px solid #254869; +}</programlisting> Usage: Used to style portlet form buttons (e.g. Submit). - <programlisting> -.portlet-icon-label {} - </programlisting> - Usage: Not currently in use. Text that appears beside a context dependent + <programlisting>.portlet-icon-label { + +}</programlisting> + Usage: Text that appears beside a context dependent action icon. - <programlisting> -.portlet-dlg-icon-label {} - </programlisting> - Usage: Not currently in use. Text that appears beside a "standard" icon (e.g + <programlisting>.portlet-dlg-icon-label { + +}</programlisting> + Usage: Text that appears beside a "standard" icon (e.g Ok, or Cancel). - <programlisting> -.portlet-form-field-label { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -color: #4A4A4A; -} - </programlisting> + <programlisting>.portlet-form-field-label { + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 10px; + color: #000; + vertical-align: bottom; + white-space: nowrap +}</programlisting> Usage: Selector used to style portlet form field labels. - <programlisting> -.portlet-form-field { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -color: #4A4A4A; -margin-top: 10px; -} - </programlisting> + <programlisting>.portlet-form-field { + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 10px; + color: #000; /*margin-top: 10px;*/ +}</programlisting> Usage: Selector used to style portlet form fields (i.e. INPUT controls, SELECT elements, etc.). </para> </listitem> <listitem> <para>LINK Selectors - <programlisting> -.portal-links:link { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -color: #242424; -text-decoration: none; + <programlisting>.portal-links:link { + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 11px; + font-weight: bold; + color: #242424; + text-decoration: none; } .portal-links:hover { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -color: #5699B7; -text-decoration: none; + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 11px; + font-weight: bold; + color: #5699B7; + text-decoration: none; } .portal-links:active { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -color: #242424; -text-decoration: none; + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 11px; + font-weight: bold; + color: #242424; + text-decoration: none; } .portal-links:visited { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -color: #242424; -text-decoration: none; -} - </programlisting> + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 11px; + font-weight: bold; + color: #242424; + text-decoration: none; +}</programlisting> Usage: The above four selectors are used to style links in the portal. Each pseudo class (i.e. hover, active, etc.) provides a different link style. </para> </listitem> <listitem> <para>MESSAGE Selectors - <programlisting> -.portlet-msg-status { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 10px; -font-style: normal; -color: #788793; -} - </programlisting> + <programlisting>.portlet-msg-status { + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 12px; + font-style: normal; + color: #336699; +}</programlisting> Usage: Selector used to signify the status of a current operation that takes - place in the portlet (e.g. “saving results�?, “step 1 of 4�?). - <programlisting> -.portlet-msg-info { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-style: italic; -color: #000; -} - </programlisting> + place in the portlet (e.g. "saving results", "step 1 of 4"). + <programlisting>.portlet-msg-info { + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 12px; + font-style: italic; + color: #000; +}</programlisting> Usage: Selector used to signify general information in a portlet (e.g. help messages). - <programlisting> -.portlet-msg-error { -color:red; -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -} - </programlisting> + <programlisting>.portlet-msg-error { + color: red; + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 12px; + font-weight: bold; +}</programlisting> Usage: Selector used to signify an error message in the portlet (e.g. form validation error). - <programlisting> -.portlet-msg-alert { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -color: #821717; -} - </programlisting> + <programlisting>.portlet-msg-alert { + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 12px; + font-weight: bold; + color: #821717; +}</programlisting> Usage: Selector used to style an alert that is displayed to the user. - <programlisting> -.portlet-msg-success { -font-family: Verdana, Arial, Helvetica, Geneva, Swiss, SunSans-Regular; -font-size: 9px; -font-weight: bold; -color: #359630; -} - </programlisting> + <programlisting>.portlet-msg-success { + font-family: Verdana, Arial, Helvetica, Sans-Serif, sans-serif; + font-size: 12px; + font-weight: bold; + color: #359630; +}</programlisting> Usage: Selector used to indicate successful completion of an action in a - portlet (e.g. “save successful�?). + portlet (e.g. "save successful"). </para> </listitem> <listitem> <para>SECTION Selectors - <programlisting> -.portlet-section-header { -font-weight: bold; -font-family: Verdana, Arial, Helvetica, sans-serif; -font-size: 13px; -color: #768591; -background-color: #f7f7f7; + <programlisting>.portlet-section-header { + font-weight: bold; + color: #656565; + font-size: 12px; } - </programlisting> +</programlisting> Usage: Table or section header. - <programlisting> -.portlet-section-body { -font-family: Verdana, Arial, Helvetica, sans-serif; -font-size: 10px; -} - </programlisting> + <programlisting>.portlet-section-body { + color: #656565; +}</programlisting> Usage: Normal text in a table cell. - <programlisting> -.portlet-section-alternate { -background-color: #ececed; -font-family: Verdana, Arial, Helvetica, sans-serif; -font-size: 9px; -} - </programlisting> + <programlisting>.portlet-section-alternate { + background-color: #F2F2F2; +}</programlisting> Usage: Used to style background color and text in every other table row. - <programlisting> -.portlet-section-selected { -background-color: #89AEC6; -font-family: Verdana, Arial, Helvetica, sans-serif; -font-size: 9px; -} - </programlisting> + <programlisting>.portlet-section-selected { + background-color: #CBD4E6; +}</programlisting> Usage: Used to style background and font properties in a selected cell range. - <programlisting> -.portlet-section-subheader { -font-weight: bold; -font-size: 10px; -font-family: Verdana, Arial, Helvetica, sans-serif; -color: #000; -} - </programlisting> + <programlisting>.portlet-section-subheader { + font-weight: bold; + font-size: 10px; +}</programlisting> Usage: Used to style a subheading within a table/section that gets rendered in a portlet. - <programlisting> -.portlet-section-footer { -font-family: Verdana, Arial, Helvetica, sans-serif; -background-color: #f7f7f7; -font-size: 8px; -} - </programlisting> + <programlisting>.portlet-section-footer { + font-size: 11px; +}</programlisting> Usage: Used to style footer area of a section/table that gets rendered in a portlet. - <programlisting> -.portlet-section-text {} - </programlisting> - Usage: Not currently used. Text that belongs to a section but does not fall in + <programlisting>.portlet-section-text { + font-size: 12px; + font-style: italic; +}</programlisting> + Usage: Text that belongs to a section but does not fall in one of the other categories. This selector can also be modified to provide styled text that can be used in all sections that are rendered within a portlet. @@ -2240,53 +1971,49 @@ <programlisting> .portlet-menu {} </programlisting> - Usage: Not currently used. General menu settings such as background color, + Usage: General menu settings such as background color, margins, etc. - <programlisting> -.portlet-menu-item { -color: #242424; -text-decoration: none; -font-family: Verdana, Arial, Helvetica, sans-serif; -font-size: 9px; -} - </programlisting> - Usage: Not currently used. Normal, unselected menu item. - <programlisting> -.portlet-menu-item:hover { -color: #5699B7; -text-decoration: none; -font-family: Verdana, Arial, Helvetica, sans-serif; -font-size: 9px; -} - </programlisting> - Usage: Not currently used. Used to style hover effect on a normal, unselected + <programlisting>.portlet-menu-item { + color: #242424; + text-decoration: none; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 12px; +}</programlisting> + Usage: Normal, unselected menu item. + <programlisting>.portlet-menu-item:hover { + color: #5699B7; + text-decoration: none; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: 12px; +}</programlisting> + Usage: Used to style hover effect on a normal, unselected menu item. <programlisting> .portlet-menu-item-selected {} </programlisting> - Usage: Not currently used. Applies to selected menu items. + Usage: Applies to selected menu items. <programlisting> .portlet-menu-item-selected:hover {} </programlisting> - Usage: Not currently used. Selector styles the hover effect on a selected menu + Usage: Selector styles the hover effect on a selected menu item. <programlisting> .portlet-menu-cascade-item {} </programlisting> - Usage: Not currently used. Normal, unselected menu item that has sub-menus. + Usage: Normal, unselected menu item that has sub-menus. <programlisting> .portlet-menu-cascade-item-selected {} </programlisting> - Usage: Not currently used. Selected sub-menu item. + Usage: Selected sub-menu item. <programlisting> .portlet-menu-description {} </programlisting> - Usage: Not currently used. Descriptive text for the menu (e.g. in a help + Usage: Descriptive text for the menu (e.g. in a help context below the menu). <programlisting> .portlet-menu-caption {} </programlisting> - Usage: Not currently used. Selector used to style menu captions. + Usage: Selector used to style menu captions. </para> </listitem> <listitem> @@ -2294,39 +2021,39 @@ <programlisting> .portlet-horizontal-separator {} </programlisting> - Usage: Not currently used. A separator bar similar to a horizontal rule, but + Usage: A separator bar similar to a horizontal rule, but with styling matching the page. <programlisting> .portlet-nestedTitle-bar {} </programlisting> - Usage: Not currently used. Allows portlets to mimic the title bar when nesting + Usage: Allows portlets to mimic the title bar when nesting something. <programlisting> .portlet-nestedTitle {} </programlisting> - Usage: Not currently used. Allows portlets to match the textual character of + Usage: Allows portlets to match the textual character of the title on the title bar. <programlisting> .portlet-tab {} </programlisting> - Usage: Not currently used. Support portlets having tabs in the same style as + Usage: Support portlets having tabs in the same style as the page or other portlets. <programlisting> .portlet-tab-active {} </programlisting> - Usage: Not currently used. Highlight the tab currently being shown. + Usage: Highlight the tab currently being shown. <programlisting> .portlet-tab-selected {} </programlisting> - Usage: Not currently used. Highlight the selected tab (not yet active). + Usage: Highlight the selected tab (not yet active). <programlisting> .portlet-tab-disabled {} </programlisting> - Usage: Not currently used. A tab which can not be currently activated. + Usage: A tab which can not be currently activated. <programlisting> .portlet-tab-area {} </programlisting> - Usage: Not currently used. Top level style for the content of a tab. + Usage: Top level style for the content of a tab. </para> </listitem> </itemizedlist> @@ -2346,7 +2073,7 @@ </programlisting> Usage: - Not currently used. Denotes a dynamic region which can be subject to ajax capabilities. + Denotes a dynamic region which can be subject to ajax capabilities. </listitem> <listitem> <programlisting> @@ -2354,7 +2081,7 @@ </programlisting> Usage: - Not currently used. Denotes a dynamic window which can be subject to ajax capabilities. + Denotes a dynamic window which can be subject to ajax capabilities. </listitem> <listitem> <programlisting> @@ -2362,7 +2089,7 @@ </programlisting> Usage: - Not currently used. Denotes a dynamic decorator which can be subject to ajax capabilities. + Denotes a dynamic decorator which can be subject to ajax capabilities. </listitem> <listitem> <programlisting> @@ -2370,7 +2097,7 @@ </programlisting> Usage: - Not currently used. Denotes a dynamic content which can be subject to ajax capabilities. + Denotes a dynamic content which can be subject to ajax capabilities. </listitem> <listitem> <programlisting> Modified: docs/trunk/referenceGuide/en/modules/tutorials.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/tutorials.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/tutorials.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -30,7 +30,7 @@ having one portlet.</para> <mediaobject> <imageobject> - <imagedata align="center" fileref="images/SpecPortalDef.png" valign="middle"/> + <imagedata align="center" fileref="images/tutorials/SpecPortalDef.png" valign="middle"/> </imageobject> </mediaobject> </sect2> @@ -191,8 +191,7 @@ <listitem> <para> portlet.xml - <programlisting><![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_1... @@ -215,22 +214,19 @@ <itemizedlist> <listitem> <para> - <programlisting><![CDATA[ -<portlet-name>HelloWorldPortlet</portlet-name>]]></programlisting> + <programlisting><![CDATA[<portlet-name>HelloWorldPortlet</portlet-name>]]></programlisting> Define your portlet name. It does not have to be the Class name. </para> </listitem> <listitem> <para> - <programlisting><![CDATA[ -<portlet-class>org.jboss.portlet.hello.HelloWorldPortlet</portlet-class>]]></programlisting> + <programlisting><![CDATA[<portlet-class>org.jboss.portlet.hello.HelloWorldPortlet</portlet-class>]]></programlisting> The FQN of your portlet class must be declared here. </para> </listitem> <listitem> <para> - <programlisting><![CDATA[ -<supports> + <programlisting><![CDATA[<supports> <mime-type>text/html</mime-type> <portlet-mode>VIEW</portlet-mode> </supports>]]></programlisting> @@ -247,8 +243,7 @@ </listitem> <listitem> <para> - <programlisting><![CDATA[ -<portlet-info> + <programlisting><![CDATA[<portlet-info> <title>HelloWorld Portlet</title> </portlet-info> ]]></programlisting> @@ -261,8 +256,7 @@ </listitem> <listitem> <para>portlet-instances.xml - <programlisting><![CDATA[ -<?xml version="1.0" standalone="yes"?> + <programlisting><![CDATA[<?xml version="1.0" standalone="yes"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portlet Instances 2.6//EN" "http://www.jboss.org/portal/dtd/portlet-instances_2_6.dtd"> @@ -291,8 +285,7 @@ </listitem> <listitem> <para>helloworld-object.xml - <programlisting><![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portal Object 2.6//EN" "http://www.jboss.org/portal/dtd/portal-object_2_6.dtd"> @@ -314,8 +307,7 @@ specifying where it should appear on that page. This is a specific descriptor to JBoss Portal. Since 2.6 we can replace also the window section by the following which will do exactly the same. - <programlisting><![CDATA[ -<window> + <programlisting><![CDATA[<window> <window-name>HelloWorldPortletWindow</window-name> <content> <content-type>portlet</content-type> @@ -382,8 +374,7 @@ </listitem> <listitem> <para> - <programlisting><![CDATA[ -<region>center</region> + <programlisting><![CDATA[<region>center</region> <height>1</height>]]></programlisting> Specify the layout region and order this window will be found on the portal page. </para> @@ -460,9 +451,8 @@ will trigger a <emphasis>hot-deploy</emphasis> : - <programlisting><![CDATA[ -18:25:56,366 INFO [Server] JBoss (MX MicroKernel) [4.0.3SP1 (build: - CVSTag=JBoss_4_0_3_SP1 date=200510231054)] Started in 1m:3s:688ms + <programlisting><![CDATA[18:25:56,366 INFO [Server] JBoss (MX MicroKernel) [4.0.5.GA (build: + CVSTag=JBoss_4_0_5_GA date=2006000000)] Started in 1m:3s:688ms 18:26:21,147 INFO [TomcatDeployer] deploy, ctxPath=/helloworldportlet, warUrl=.../tmp/deploy/tmp35219helloworldportlet-exp.war/]]></programlisting> Pointing your browser to @@ -470,7 +460,7 @@ , should yield a view of our HelloWorldPortlet: <mediaobject> <imageobject> - <imagedata align="center" fileref="images/tutorials/first_portlet/output.gif" valign="middle"/> + <imagedata align="center" fileref="images/tutorials/first_portlet/output.png" valign="middle"/> </imageobject> </mediaobject> </para> @@ -582,18 +572,16 @@ .getRequestDispatcher("/WEB-INF/jsp/edit.jsp"); prd.include(rRequest, rResponse); } -}]]> - </programlisting> +}]]></programlisting> Now lets look at some of our methods: <itemizedlist> <listitem> <para> - <programlisting><![CDATA[ protected void doHelp(RenderRequest rRequest, RenderResponse rResponse) { ... } + <programlisting><![CDATA[protected void doHelp(RenderRequest rRequest, RenderResponse rResponse) { ... } // And -protected void doEdit(RenderRequest rRequest, RenderResponse rResponse) { ... } ]]> - </programlisting> +protected void doEdit(RenderRequest rRequest, RenderResponse rResponse) { ... } ]]></programlisting> Support for these Modes must be declared in the portlet.xml. They will be triggered when a user clicks on the respective icons in the portlet window titlebar, or through generated links within the portlet. @@ -601,8 +589,7 @@ </listitem> <listitem> <para> - <programlisting><![CDATA[ -public void processAction(ActionRequest aRequest, ActionResponse aResponse) + <programlisting><![CDATA[public void processAction(ActionRequest aRequest, ActionResponse aResponse) throws PortletException, IOException, UnavailableException { String sYourname = (String) aRequest.getParameter("yourname"); @@ -625,8 +612,7 @@ </listitem> <listitem> <para> - <programlisting><![CDATA[ -protected void doView(RenderRequest rRequest, RenderResponse rResponse) + <programlisting><![CDATA[protected void doView(RenderRequest rRequest, RenderResponse rResponse) throws PortletException, IOException, UnavailableException ]]></programlisting> In this case, our doView, is responsible for dispatching to the appropriate jsp @@ -665,8 +651,7 @@ <listitem> <para> portlet.xml - <programlisting><![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_1... @@ -726,8 +711,7 @@ : </para> <para> - <programlisting><![CDATA[ -<%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %> + <programlisting><![CDATA[<%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %> <portlet:defineObjects/> @@ -766,10 +750,8 @@ </listitem> <listitem> <para> - <programlisting><![CDATA[ -<form action="<portlet:actionURL><portlet:param name="page" value="mainview"/> - </portlet:actionURL>" method="POST">]]> - </programlisting> + <programlisting><![CDATA[<form action="<portlet:actionURL><portlet:param name="page" value="mainview"/> + </portlet:actionURL>" method="POST">]]></programlisting> We create an HTML form, but generate the URL it will post to, using the portlet tag library. In this case, notice how we are creating an <emphasis>actionURL</emphasis> @@ -780,10 +762,8 @@ </listitem> <listitem> <para> - <programlisting><![CDATA[ -<a href="<portlet:renderURL><portlet:param name="yourname" value="Roy Russo"> -</portlet:param></portlet:renderURL>">]]> - </programlisting> + <programlisting><![CDATA[<a href="<portlet:renderURL><portlet:param name="yourname" value="Roy Russo"> +</portlet:param></portlet:renderURL>">]]></programlisting> Likewise, we are able to create a link to our <emphasis>doView</emphasis> , by simply creating it with a @@ -853,9 +833,8 @@ will trigger a <emphasis>hot-deploy</emphasis> : - <programlisting><![CDATA[ -15:54:34,234 INFO [Server] JBoss (MX MicroKernel) [4.0.4.CR2 (build: - CVSTag=JBoss_4_0_4_CR2 date=200603311500)] + <programlisting><![CDATA[15:54:34,234 INFO [Server] JBoss (MX MicroKernel) [4.0.5.GA (build: + CVSTag=JBoss_4_0_5_GA date=2006000000)] Started in 1m:9s:766ms 15:55:04,062 INFO [TomcatDeployer] deploy, ctxPath=/helloworldjspportlet, warUrl=.../tmp/deploy/tmp57782helloworldjspportlet-exp.war/]]></programlisting> @@ -864,7 +843,7 @@ , should yield a view of our HelloWorldPortlet: <mediaobject> <imageobject> - <imagedata align="center" fileref="images/tutorials/jsp_portlet/output.gif" valign="middle"/> + <imagedata align="center" fileref="images/tutorials/jsp_portlet/output.png" valign="middle"/> </imageobject> </mediaobject> </para> @@ -934,8 +913,7 @@ <listitem> <para> portlet.xml - <programlisting><![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_1... @@ -966,8 +944,7 @@ Here we define our portlet class, as we normally would. However, note the use of the MyFacesGenericPortlet. In this case, we will allow the MyFacesGenericPortlet to handle all requests/responses from our users: - <programlisting><![CDATA[ -<portlet-class>org.apache.myfaces.portlet.MyFacesGenericPortlet</portlet-class>]]></programlisting> + <programlisting><![CDATA[<portlet-class>org.apache.myfaces.portlet.MyFacesGenericPortlet</portlet-class>]]></programlisting> <note>If you wanted to add more functionality to your JSF portlet, not included in the MyFacesGenericPortlet, you could sublass it and create your own Class.</note> </para> @@ -976,8 +953,7 @@ <para> We need to initialize the portlet with a default view page for it to render, much like a welcome page: - <programlisting><![CDATA[ -<init-param> + <programlisting><![CDATA[<init-param> <name>default-view</name> <value>/WEB-INF/jsp/index.jsp</value> </init-param>]]></programlisting> @@ -988,8 +964,7 @@ </listitem> <listitem> <para>faces-config.xml - <programlisting><![CDATA[ -<?xml version="1.0"?> + <programlisting><![CDATA[<?xml version="1.0"?> <!DOCTYPE faces-config PUBLIC "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN" "http://java.sun.com/dtd/web-facesconfig_1_0.dtd"> @@ -1076,21 +1051,20 @@ will trigger a <emphasis>hot-deploy</emphasis> : - <programlisting><![CDATA[ -22:30:03,093 INFO [TomcatDeployer] deploy, ctxPath=/helloworldjsfportlet, + <programlisting><![CDATA[22:30:03,093 INFO [TomcatDeployer] deploy, ctxPath=/helloworldjsfportlet, warUrl=.../tmp/deploy/tmp5571helloworldjsfportlet-exp.war/ 22:30:03,312 INFO [FacesConfigurator] Reading standard config org/apache/myfaces/resource/standard-faces-config.xml 22:30:03,390 INFO [FacesConfigurator] Reading config - jar:file:/C:/jboss-4.0.4.CR2/server/default/tmp/deploy/ + jar:file:/C:/jboss-4.0.5.GA/server/default/tmp/deploy/ tmp5504jboss-portal.sar-contents/lib/jsf-facelets.jar!/ META-INF/faces-config.xml -22:30:03,406 INFO [FacesConfigurator] Reading config jar:file:/C:/jboss-4.0.4.CR2/ +22:30:03,406 INFO [FacesConfigurator] Reading config jar:file:/C:/jboss-4.0.5.GA/ server/default/tmp/deploy/tmp5504jboss-portal.sar-contents/ lib/tomahawk.jar!/META-INF/faces-config.xml 22:30:03,468 INFO [FacesConfigurator] Reading config /WEB-INF/faces-config.xml 22:30:03,484 ERROR [LocaleUtils] Locale name null or empty, ignoring -22:30:03,640 INFO [MyFacesGenericPortlet] PortletContext 'C:\jboss-4.0.4.CR2\server\ +22:30:03,640 INFO [MyFacesGenericPortlet] PortletContext 'C:\jboss-4.0.5.GA\server\ default\.\tmp\deploy\tmp5571helloworldjsfportlet-exp.war\' initialized.]]></programlisting> Pointing your browser to @@ -1098,7 +1072,7 @@ , should yield a view of our HelloWorldJSFPortlet: <mediaobject> <imageobject> - <imagedata align="center" fileref="images/tutorials/jsf_portlet/output.gif" valign="middle"/> + <imagedata align="center" fileref="images/tutorials/jsf_portlet/output.png" valign="middle"/> </imageobject> </mediaobject> </para> Modified: docs/trunk/referenceGuide/en/modules/wsrp.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/wsrp.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/wsrp.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -129,7 +129,8 @@ <para> <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"> +<!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>BasicPortlet</portlet-name> @@ -244,18 +245,17 @@ "http://www.jboss.org/portal/dtd/jboss-wsrp-consumer_2_6.dtd"> <?xml version="1.0" standalone="yes"?> <deployments> - <deployment> - <wsrp-producer id="bea" expiration-cache="120"> - <endpoint-wsdl-url>http://wsrp.bea.com:7001/producer/producer?WSDL</endpoint-wsdl-url> - <registration-data> - <property> - <name>registration/consumerRole</name> - <lang>en</lang> - <value>public</value> - </property> - </registration-data> - </wsrp-producer> - </deployment> + <deployment> + <wsrp-producer id="bea" expiration-cache="120"> + <endpoint-wsdl-url>http://wsrp.bea.com:7001/producer/producer?WSDL</endpoint-wsdl-url> + <registration-data> + <property> + <name>registration/consumerRole</name> + <lang>en</lang> + <value>public</value> + </registration-data> + </wsrp-producer> + </deployment> </deployments>]]></programlisting> This producer descriptor gives access to BEA's public WSRP producer. We will look at the details of the different elements later. Note for now the <emphasis>producer-id</emphasis> element with a "bea" value. Put @@ -484,22 +484,28 @@ </para> <para> - <programlisting><![CDATA[ -<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" + <programlisting><![CDATA[<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" "http://www.jboss.org/portal/dtd/jboss-wsrp-consumer_2_6.dtd"> <?xml version="1.0" encoding="UTF-8"?> <deployments> <deployment> <wsrp-producer id="self" expiration-cache="300"> <!-- - we need to use the individual endpoint configuration because the configuration via wsdl forces an - immediate attempt to access the web service description which is not available yet at this point of deployment + we need to use the individual endpoint configuration because the configuration via + wsdl forces an immediate attempt to access the web service description which is not + available yet at this point of deployment --> <endpoint-config> - <service-description-url>http://localhost:8080/portal-wsrp/ServiceDescriptionService</service-description-url> + <service-description-url> + http://localhost:8080/portal-wsrp/ServiceDescriptionService + </service-description-url> <markup-url>http://localhost:8080/portal-wsrp/MarkupService</markup-url> - <registration-url>http://localhost:8080/portal-wsrp/RegistrationService</registration-url> - <portlet-management-url>http://localhost:8080/portal-wsrp/PortletManagementService</portlet-management-url> + <registration-url> + http://localhost:8080/portal-wsrp/RegistrationService + </registration-url> + <portlet-management-url> + http://localhost:8080/portal-wsrp/PortletManagementService + </portlet-management-url> </endpoint-config> <registration-data/> </wsrp-producer> @@ -512,8 +518,7 @@ URLs:</para> <para> - <programlisting><![CDATA[ -<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" + <programlisting><![CDATA[<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" "http://www.jboss.org/portal/dtd/jboss-wsrp-consumer_2_6.dtd"> <?xml version="1.0" encoding="UTF-8"?> <deployments> @@ -542,8 +547,7 @@ data and cache expiring every minute:</para> <para> - <programlisting><![CDATA[ -<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" + <programlisting><![CDATA[<!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD WSRP Remote Producer Configuration 2.6//EN" "http://www.jboss.org/portal/dtd/jboss-wsrp-consumer_2_6.dtd"> <?xml version="1.0" encoding="UTF-8"?> <deployments> @@ -578,8 +582,8 @@ <title>Default configuration</title> <para> Let's look at the default configuration: - <programlisting><![CDATA[ -<!DOCTYPE producer-configuration PUBLIC "-//JBoss Portal//DTD WSRP Local Producer Configuration 2.6//EN" + <programlisting><![CDATA[<!DOCTYPE producer-configuration PUBLIC + "-//JBoss Portal//DTD WSRP Local Producer Configuration 2.6//EN" "http://www.jboss.org/portal/dtd/jboss-wsrp-producer_2_6.dtd"> <?xml version="1.0" encoding="UTF-8"?> <producer-configuration> @@ -685,26 +689,26 @@ values for two String registration properties named "name1" and "name2" respectively. The registration service will use the <literal>com.example.portal.SomeCustomRegistrationPolicy</literal> class for its registration policy. - <programlisting><![CDATA[ -<!DOCTYPE producer-configuration PUBLIC "-//JBoss Portal//DTD WSRP Local Producer Configuration 2.6//EN" + <programlisting><![CDATA[<!DOCTYPE producer-configuration PUBLIC + "-//JBoss Portal//DTD WSRP Local Producer Configuration 2.6//EN" "http://www.jboss.org/portal/dtd/jboss-wsrp-producer_2_6.dtd"> <?xml version="1.0" encoding="UTF-8"?> <producer-configuration> - <registration-configuration fullServiceDescriptionRequiresRegistration="true"> - <registration-policy>com.example.portal.SomeCustomRegistrationPolicy</registration-policy> - <registration-property-description> - <name>name1</name> - <type>xsd:string</type> - <hint xml:lang="en" resourceName="resource.hint1">hint1</hint> - <label xml:lang="en" resourceName="resource.label1">label1</label> - </registration-property-description> - <registration-property-description> - <name>name2</name> - <type>xsd:string</type> - <hint xml:lang="en" resourceName="resource.hint2">hint2</hint> - <label xml:lang="en" resourceName="resource.label2">label2</label> - </registration-property-description> - </registration-configuration> + <registration-configuration fullServiceDescriptionRequiresRegistration="true"> + <registration-policy>com.example.portal.SomeCustomRegistrationPolicy</registration-policy> + <registration-property-description> + <name>name1</name> + <type>xsd:string</type> + <hint xml:lang="en" resourceName="resource.hint1">hint1</hint> + <label xml:lang="en" resourceName="resource.label1">label1</label> + </registration-property-description> + <registration-property-description> + <name>name2</name> + <type>xsd:string</type> + <hint xml:lang="en" resourceName="resource.hint2">hint2</hint> + <label xml:lang="en" resourceName="resource.label2">label2</label> + </registration-property-description> + </registration-configuration> </producer-configuration>]]></programlisting> </para> </sect2> Modified: docs/trunk/referenceGuide/en/modules/xmldescriptors.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-06-28 20:10:32 UTC (rev 7611) +++ docs/trunk/referenceGuide/en/modules/xmldescriptors.xml 2007-06-28 22:46:12 UTC (rev 7612) @@ -14,8 +14,7 @@ descriptors although it was internally validated by the portal. Since 2.6 we have worked on providing Document Type Definition (DTD) for the various descriptors. The DTD validation will be only effective if you XML descriptors declares it like that:</para> - <programlisting><![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE deployments PUBLIC "-//JBoss Portal//DTD Portal Object 2.6//EN" "http://www.jboss.org/portal/dtd/portal-object_2_6.dtd"> @@ -24,16 +23,14 @@ between using the DTD and not is that the additional DTD validation is more strict specifically on the order of the XML elements. The following example will be accepted without the DTD declaration and will not with the DTD declaration:</para> - <programlisting><![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <deployment> <if-exists>overwrite</if-exists> <parent-ref>default.default</parent-ref> ... </deployment>]]></programlisting> <para>The correct descriptor is rather:</para> - <programlisting><![CDATA[ -<?xml version="1.0" encoding="UTF-8"?> + <programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <deployment> <parent-ref>default.default</parent-ref> <if-exists>overwrite</if-exists> @@ -53,11 +50,8 @@ <itemizedlist> <listitem> <para> -Element <![CDATA[<!ELEMENT portlet-app (remotable?,portlet*,service*)> - -]]> -</para><para><programlisting><![CDATA[ -The remotable element is used to configure the default behavior of the portlets with +Element <![CDATA[<!ELEMENT portlet-app (remotable?,portlet*,service*)>]]> +</para><para><programlisting><![CDATA[The remotable element is used to configure the default behavior of the portlets with respect to WSRP exposure. For each portlet defined in portlet.xml, it is possible to configure specific @@ -67,12 +61,9 @@ using the service elements.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,header-content?)> +Element <![CDATA[<!ELEMENT portlet (portlet-name,remotable?,ajax?,session-config?,transaction?,header-content?)>]]> +</para><para><programlisting><![CDATA[Additional configuration for a portlet. -]]> -</para><para><programlisting><![CDATA[ -Additional configuration for a portlet. - The portlet-name defines the name of the portlet. It must match a portlet defined already in portlet.xml of the same web application. @@ -96,44 +87,29 @@ </portlet>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT portlet-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The portlet name.]]></programlisting></para> +Element <![CDATA[<!ELEMENT portlet-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The portlet name.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT remotable (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The remotable value is used for WSRP exposure. The accepted values are the +Element <![CDATA[<!ELEMENT remotable (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The remotable value is used for WSRP exposure. The accepted values are the litterals true of false.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT ajax (partial-refresh)> - -]]> -</para><para><programlisting><![CDATA[ -The ajax tag allows to configure the ajax capabilities of the portlet. If +Element <![CDATA[<!ELEMENT ajax (partial-refresh)>]]> +</para><para><programlisting><![CDATA[The ajax tag allows to configure the ajax capabilities of the portlet. If the portlet is tagged as partial-refresh then the portal may use partial page refreshing and render only that portlet. If the portlet partial-refresh value is false, then the portal will perform a full page refresh when the portlet is refreshed.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT partial-refresh (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The authorized values for the partial-refresh element are true or false.]]></programlisting></para> +Element <![CDATA[<!ELEMENT partial-refresh (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The authorized values for the partial-refresh element are true or false.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT session-config (distributed)> +Element <![CDATA[<!ELEMENT session-config (distributed)>]]> +</para><para><programlisting><![CDATA[This element configure the portlet session of the portlet. -]]> -</para><para><programlisting><![CDATA[ -This element configure the portlet session of the portlet. - The distributed element instructs the container to distribute the session attributes using the portal session replication. It applies only to local portlets are not to remote portlets. The default value is false. @@ -145,18 +121,12 @@ </session-config>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT distributed (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The authorized values for the distributed element are true or false.]]></programlisting></para> +Element <![CDATA[<!ELEMENT distributed (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The authorized values for the distributed element are true or false.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT transaction (trans-attribute)> - -]]> -</para><para><programlisting><![CDATA[ -Defines how the portlet behaves with the transactionnal context. The default value +Element <![CDATA[<!ELEMENT transaction (trans-attribute)>]]> +</para><para><programlisting><![CDATA[Defines how the portlet behaves with the transactionnal context. The default value is Never. Example: @@ -166,48 +136,32 @@ <transaction>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT trans-attribute (#PCDATA)> - -]]> +Element <![CDATA[<!ELEMENT trans-attribute (#PCDATA)>]]> </para><para><programlisting><![CDATA[ The trans-attribute value defines the transactionnal behavior. The accepted values are Required, Mandatory, Never, Supports, NotSupported and RequiresNew.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT header-content (link | script | meta)*> - -]]> -</para><para><programlisting><![CDATA[ -Specify content which should be included in the portal aggregated page when the portlet +Element <![CDATA[<!ELEMENT header-content (link | script | meta)*>]]> +</para><para><programlisting><![CDATA[Specify content which should be included in the portal aggregated page when the portlet is present on that page. This setting only applies when the portlet is used in the local mode.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT link EMPTY> - -]]> +Element <![CDATA[<!ELEMENT link EMPTY>]]> </para><para><programlisting><![CDATA[ No content is allowed inside an link element.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT script (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The script header element can contain inline script definitions.]]></programlisting></para> +Element <![CDATA[<!ELEMENT script (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The script header element can contain inline script definitions.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT meta EMPTY> - -]]> -</para><para><programlisting><![CDATA[ -No content is allowed for meta element.]]></programlisting></para> +Element <![CDATA[<!ELEMENT meta EMPTY>]]> +</para><para><programlisting><![CDATA[No content is allowed for meta element.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT service (service-name,service-class,service-ref)> - -]]> -</para><para><programlisting><![CDATA[ -Declare a service that will be injected by the portlet container as an +Element <![CDATA[<!ELEMENT service (service-name,service-class,service-ref)>]]> +</para><para><programlisting><![CDATA[Declare a service that will be injected by the portlet container as an attribute of the portlet context. Example: @@ -227,25 +181,16 @@ }]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT service-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The service name that will be used to bind the service as a portlet context attribute.]]></programlisting></para> +Element <![CDATA[<!ELEMENT service-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The service name that will be used to bind the service as a portlet context attribute.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT service-class (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The full qualified name of the interface that the service implements.]]></programlisting></para> +Element <![CDATA[<!ELEMENT service-class (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The full qualified name of the interface that the service implements.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT service-ref (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The reference to the service. In the JMX Microkernel environment it consist of the JMX +Element <![CDATA[<!ELEMENT service-ref (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The reference to the service. In the JMX Microkernel environment it consist of the JMX name of the service MBean. For an MBean reference if the domain is left out, then the current domain of the portal will be used.]]></programlisting></para> </listitem></itemizedlist> @@ -258,9 +203,7 @@ <itemizedlist> <listitem> <para> -Element <![CDATA[<!ELEMENT deployments (deployment*)> - -]]> +Element <![CDATA[<!ELEMENT deployments (deployment*)>]]> </para><para><programlisting><![CDATA[ The deployements element is a container for deployment elements.]]></programlisting></para> </listitem><listitem> @@ -268,26 +211,19 @@ Element <![CDATA[<!ELEMENT deployment (if-exists?,instance)> ]]> -</para><para><programlisting><![CDATA[ -The deployment is a container for an instance element.]]></programlisting></para> +</para><para><programlisting><![CDATA[The deployment is a container for an instance element.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT if-exists (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The if-exists element is used to define action to take if instance with such name is +Element <![CDATA[<!ELEMENT if-exists (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The if-exists element is used to define action to take if instance with such name is already present. Possible values are overwrite or keep . Overwrite will destroy the existing object in the database and create a new one, based on the content of the deployment. Keep will maintain the existing object deployment or create a new one if it does not yet exist.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT instance (instance-id,portlet-ref,preferences?,security-constraint?)> - -]]> -</para><para><programlisting><![CDATA[ -The instance element is used to create an instance of a portlet from the portlet +Element <![CDATA[<!ELEMENT instance (instance-id,portlet-ref,preferences?,security-constraint?)>]]> +</para><para><programlisting><![CDATA[The instance element is used to create an instance of a portlet from the portlet application of the same war file containing the portlet-instances.xml file. The portlet will be created and configured only if the portlet is present and an instance with such a name does not already exist. @@ -312,54 +248,33 @@ </instance>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT instance-id (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The identifier of the instance.]]></programlisting></para> +Element <![CDATA[<!ELEMENT instance-id (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The identifier of the instance.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT portlet-ref (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The reference to the portlet which is its portlet name.]]></programlisting></para> +Element <![CDATA[<!ELEMENT portlet-ref (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The reference to the portlet which is its portlet name.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT preferences (preference)> - -]]> -</para><para><programlisting><![CDATA[ -The preferences element configures the instance with a specific set of preferences.]]></programlisting></para> +Element <![CDATA[<!ELEMENT preferences (preference)>]]> +</para><para><programlisting><![CDATA[The preferences element configures the instance with a specific set of preferences.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT preference (name,value)> - -]]> -</para><para><programlisting><![CDATA[ -The preference configure one preference of a set of preferences.]]></programlisting></para> +Element <![CDATA[<!ELEMENT preference (name,value)>]]> +</para><para><programlisting><![CDATA[The preference configure one preference of a set of preferences.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -A name.]]></programlisting></para> +Element <![CDATA[<!ELEMENT name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[A name.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT value (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -A string value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT value (#PCDATA)>]]> +</para><para><programlisting><![CDATA[A string value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT security-constraint (policy-permission*)> +Element <![CDATA[<!ELEMENT security-constraint (policy-permission*)>]]> +</para><para><programlisting><![CDATA[The security-constraint element is a container for policy-permission elements -]]> -</para><para><programlisting><![CDATA[ -The security-constraint element is a container for policy-permission elements - Examples: <security-constraint> @@ -377,18 +292,12 @@ </security-constraint>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)> - -]]> -</para><para><programlisting><![CDATA[ -The policy-permission element is used to secure a specific portlet instance based on a user's role.]]></programlisting></para> +Element <![CDATA[<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> +</para><para><programlisting><![CDATA[The policy-permission element is used to secure a specific portlet instance based on a user's role.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT action-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The action-name element is used to define the access rights given to the role defined. +Element <![CDATA[<!ELEMENT action-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The action-name element is used to define the access rights given to the role defined. Possible values are: * view - Users can view the page. @@ -398,19 +307,13 @@ pages.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT unchecked EMPTY> - -]]> -</para><para><programlisting><![CDATA[ -The unchecked element is used to define (if present) that anyone can view this instance]]></programlisting></para> +Element <![CDATA[<!ELEMENT unchecked EMPTY>]]> +</para><para><programlisting><![CDATA[The unchecked element is used to define (if present) that anyone can view this instance]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT role-name (#PCDATA)> +Element <![CDATA[<!ELEMENT role-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The role-name element is used to define a role that this security constraint will apply to -]]> -</para><para><programlisting><![CDATA[ -The role-name element is used to define a role that this security constraint will apply to - * <role-name>SOMEROLE</role-name> Access to this instance is limited to the defined role.]]></programlisting></para> </listitem></itemizedlist> </para> @@ -421,18 +324,12 @@ <itemizedlist> <listitem> <para> -Element <![CDATA[<!ELEMENT deployments (deployment*)> - -]]> -</para><para><programlisting><![CDATA[ -The deployements element is a generic container for deployment elements.]]></programlisting></para> +Element <![CDATA[<!ELEMENT deployments (deployment*)>]]> +</para><para><programlisting><![CDATA[The deployements element is a generic container for deployment elements.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT deployment (parent-ref,if-exists?,(context | portal | page | window))> - -]]> -</para><para><programlisting><![CDATA[ -The deployment is a generic container for portal object elements. The parent-ref +Element <![CDATA[<!ELEMENT deployment (parent-ref,if-exists?,(context | portal | page | window))>]]> +</para><para><programlisting><![CDATA[The deployment is a generic container for portal object elements. The parent-ref child gives the name of the parent object that the current object will use as parent. The optional if-exists element define the behavior when a portal object which an identical name is already child of the parent element. The default behavior of @@ -459,11 +356,8 @@ 3/ security-constraint : defines security configuration of the portal object.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT parent-ref (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -Contains a reference to the parent object. The naming convention for naming object +Element <![CDATA[<!ELEMENT parent-ref (#PCDATA)>]]> +</para><para><programlisting><![CDATA[Contains a reference to the parent object. The naming convention for naming object is to concatenate the names of the path to the object and separate the names by a dot. If the path is empty then the empty string must be used. @@ -477,34 +371,23 @@ <parent-ref>default.default</parent-ref> the object with the path (default,default)]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT if-exists (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The authorized values are overwrite and keep. Overwrite means that the existing +Element <![CDATA[<!ELEMENT if-exists (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The authorized values are overwrite and keep. Overwrite means that the existing object will be destroyed and the current declaration will be used. Keep means that the existing object will not be destroyed and no creation hence will be done.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT context (context-name,properties?,listener?,security-constraint?,portal*)> - -]]> -</para><para><programlisting><![CDATA[ -A portal object of type context. A context type represent a node in the tree which +Element <![CDATA[<!ELEMENT context (context-name,properties?,listener?,security-constraint?,portal*)>]]> +</para><para><programlisting><![CDATA[A portal object of type context. A context type represent a node in the tree which does not have a visual representation. It can exist only under the root. A context can only have children with the portal type.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT context-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The context name value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT context-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The context name value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?,listener?,security-constraint?,page*)> - -]]> +Element <![CDATA[<!ELEMENT portal (portal-name,supported-modes,supported-window-states?,properties?,listener?,security-constraint?,page*)>]]> </para><para><programlisting><![CDATA[ A portal object of type portal. A portal type represents a virtual portal and can have children of type page. In addition of the common portal object elements it support @@ -513,19 +396,13 @@ (view,edit,help) and (normal,minimized,maximized).]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT portal-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The portal name value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT portal-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The portal name value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT supported-modes (mode*)> +Element <![CDATA[<!ELEMENT supported-modes (mode*)>]]> +</para><para><programlisting><![CDATA[The supported modes of a portal. -]]> -</para><para><programlisting><![CDATA[ -The supported modes of a portal. - Example: <supported-mode> @@ -535,16 +412,12 @@ </supported-mode>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT mode (#PCDATA)> - -]]> +Element <![CDATA[<!ELEMENT mode (#PCDATA)>]]> </para><para><programlisting><![CDATA[ A portlet mode value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT supported-window-states (window-state*)> - -]]> +Element <![CDATA[<!ELEMENT supported-window-states (window-state*)>]]> </para><para><programlisting><![CDATA[ The supported window states of a portal. @@ -557,34 +430,24 @@ </supported-window-states>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT window-state (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -A window state value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT window-state (#PCDATA)>]]> +</para><para><programlisting><![CDATA[A window state value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page | window)*)> - -]]> -</para><para><programlisting><![CDATA[ -A portal object of type page. A page type represents a page which can have children of +Element <![CDATA[<!ELEMENT page (page-name,properties?,listener?,security-constraint?,(page | window)*)>]]> +</para><para><programlisting><![CDATA[A portal object of type page. A page type represents a page which can have children of type page and window. The children windows are the windows of the page and the children pages are the subpages of this page.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT page-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The page name value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT page-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The page name value.]]></programlisting></para> </listitem><listitem> <para> Element <![CDATA[<!ELEMENT window (window-name,(instance-ref | content),region,height,properties?,listener?)> ]]> -</para><para><programlisting><![CDATA[ -A portal object of type window. A window type represents a window. Beside the common +</para><para><programlisting><![CDATA[A portal object of type window. A window type represents a window. Beside the common properties a window has a content and belong to a region on the page. The instance-ref or content tags are used to define the content of the window. The @@ -595,18 +458,12 @@ The region and height defines how the window is placed in the page.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT window-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The window name value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT window-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The window name value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT instance-ref (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -Define the content of the window as a reference to a portlet instance. The value +Element <![CDATA[<!ELEMENT instance-ref (#PCDATA)>]]> +</para><para><programlisting><![CDATA[Define the content of the window as a reference to a portlet instance. The value is the id of the instance. Example: @@ -614,11 +471,8 @@ <instance-ref>MyPortletInstance</instance-ref>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT content (content-type,content-uri)> - -]]> -</para><para><programlisting><![CDATA[ -Define the content of the window in a generic manner. The content is define by +Element <![CDATA[<!ELEMENT content (content-type,content-uri)>]]> +</para><para><programlisting><![CDATA[Define the content of the window in a generic manner. The content is define by the type of the content and an URI which acts as an identificator for the content. Example: @@ -634,75 +488,45 @@ </content>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT content-type (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The content type of the window.]]></programlisting></para> +Element <![CDATA[<!ELEMENT content-type (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The content type of the window.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT content-uri (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The content URI of the window.]]></programlisting></para> +Element <![CDATA[<!ELEMENT content-uri (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The content URI of the window.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT region (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The region the window belongs to.]]></programlisting></para> +Element <![CDATA[<!ELEMENT region (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The region the window belongs to.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT height (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The height of the window in the particular region.]]></programlisting></para> +Element <![CDATA[<!ELEMENT height (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The height of the window in the particular region.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT listener (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -Define a listener for a portal object. The value is the id of the listener.]]></programlisting></para> +Element <![CDATA[<!ELEMENT listener (#PCDATA)>]]> +</para><para><programlisting><![CDATA[Define a listener for a portal object. The value is the id of the listener.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT properties (property*)> - -]]> -</para><para><programlisting><![CDATA[ -A set of generic properties for the portal object.]]></programlisting></para> +Element <![CDATA[<!ELEMENT properties (property*)>]]> +</para><para><programlisting><![CDATA[A set of generic properties for the portal object.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT property (name,value)> - -]]> -</para><para><programlisting><![CDATA[ -A generic string property.]]></programlisting></para> +Element <![CDATA[<!ELEMENT property (name,value)>]]> +</para><para><programlisting><![CDATA[A generic string property.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -A name value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[A name value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT value (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -A value.]]></programlisting></para> +Element <![CDATA[<!ELEMENT value (#PCDATA)>]]> +</para><para><programlisting><![CDATA[A value.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT security-constraint (policy-permission*)> +Element <![CDATA[<!ELEMENT security-constraint (policy-permission*)>]]> +</para><para><programlisting><![CDATA[The security-constraint element is a container for policy-permission elements -]]> -</para><para><programlisting><![CDATA[ -The security-constraint element is a container for policy-permission elements - Examples: <security-constraint> @@ -720,34 +544,22 @@ </security-constraint>]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)> - -]]> -</para><para><programlisting><![CDATA[ -The policy-permission element is used to secure a specific portal page based on a user's role.]]></programlisting></para> +Element <![CDATA[<!ELEMENT policy-permission (action-name*,unchecked?,role-name*)>]]> +</para><para><programlisting><![CDATA[The policy-permission element is used to secure a specific portal page based on a user's role.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT action-name (#PCDATA)> +Element <![CDATA[<!ELEMENT action-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The role-name element is used to define a role that this security constraint will apply to -]]> -</para><para><programlisting><![CDATA[ -The role-name element is used to define a role that this security constraint will apply to - * <role-name>SOMEROLE</role-name> Access to this portal page is limited to the defined role.]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT unchecked EMPTY> - -]]> -</para><para><programlisting><![CDATA[ -The unchecked element is used to define (if present) that anyone can view this portal page]]></programlisting></para> +Element <![CDATA[<!ELEMENT unchecked EMPTY>]]> +</para><para><programlisting><![CDATA[The unchecked element is used to define (if present) that anyone can view this portal page]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT role-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -The action-name element is used to define the access rights given to the role defined. +Element <![CDATA[<!ELEMENT role-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[The action-name element is used to define the access rights given to the role defined. Possible values are: * view - Users can view the page.]]></programlisting></para> @@ -761,20 +573,14 @@ <itemizedlist> <listitem> <para> -Element <![CDATA[<!ELEMENT jboss-app (app-name?)> - -]]> -</para><para><programlisting><![CDATA[ -<!DOCTYPE jboss-app PUBLIC +Element <![CDATA[<!ELEMENT jboss-app (app-name?)>]]> +</para><para><programlisting><![CDATA[<!DOCTYPE jboss-app PUBLIC "-//JBoss Portal//DTD JBoss Web Application 2.6//EN" "http://www.jboss.org/portal/dtd/jboss-app_2_6.dtd">]]></programlisting></para> </listitem><listitem> <para> -Element <![CDATA[<!ELEMENT app-name (#PCDATA)> - -]]> -</para><para><programlisting><![CDATA[ -When a web application is deployed, the context path under wich it is deployed +Element <![CDATA[<!ELEMENT app-name (#PCDATA)>]]> +</para><para><programlisting><![CDATA[When a web application is deployed, the context path under wich it is deployed is taken as application name. The application name value in this descriptor is used to override it. When a component references a references a portlet, it needs to reference the application too and if the portlet application war file is renammed @@ -1394,8 +1200,8 @@ <para> By default, when a user logs in, she is forwarded to the default page of the default portal. In order to forward her to her dashboard, it is possible to set in the file <emphasis>jboss-portal.sar/conf/config.xml</emphasis>: - <programlisting><![CDATA[ -<!-- Namespace to use when logging-in, use "dashboard" to directly log-in the dashboard otherwise use "default" --> + <programlisting><![CDATA[<!-- Namespace to use when logging-in, use "dashboard" to directly + log-in the dashboard otherwise use "default" --> <entry key="core.login.namespace">dashboard</entry> ]]></programlisting> </para>