[portal-commits] JBoss Portal SVN: r10970 - docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules.

Author: mmcallis Date: 2008-06-10 01:35:22 -0400 (Tue, 10 Jun 2008) New Revision: 10970 Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/ajax.xml docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/themeandlayouts.xml Log: this should finish trademark attribution for JSP Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/ajax.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/ajax.xml 2008-06-10 04:59:13 UTC (rev 10969) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/ajax.xml 2008-06-10 05:35:22 UTC (rev 10970) @@ -20,7 +20,7 @@ <para>Part of the Ajax capabilities are implemented in the layout framework which provide the structure for generating portal pages. The good news is that the existing layout only requires a few modifications in order to be ajaxified.</para> - <para>We will use as example an simplified version of the layout JSP provided in JBoss Portal 2.6 and outline + <para>We will use as example an simplified version of the layout <trademark trade="trade">JSP</trademark> provided in JBoss Portal 2.6 and outline what are the required changes that makes it an ajaxified layout: <programlisting><![CDATA[ <%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/themeandlayouts.xml =================================================================== --- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/themeandlayouts.xml 2008-06-10 04:59:13 UTC (rev 10969) +++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/themeandlayouts.xml 2008-06-10 05:35:22 UTC (rev 10970) @@ -31,9 +31,7 @@ responsible to render markup that will wrap the markup fragments produced by the individual portlets. Themes, on the other hand, are responsible to style and enhance this markup. </para> - <para>In JBoss Portal, layouts are implemented as a JSP or a Servlet. Themes are implemented - using CSS Style sheets, javascript and images. The binding element between layouts and - themes are the class and id attributes of the rendered markup. + <para>In JBoss Portal, layouts are implemented as a <trademark class="trade">JSP</trademark> or a Servlet. Themes are implemented using CSS Style sheets, javascript and images. The binding element between layouts and themes are the class and id attributes of the rendered markup. </para> <para>JBoss Portal has the concept of regions on a page. When a page is defined, and portlet windows are assigned to the page, the region, and order inside the region, has to be @@ -49,7 +47,7 @@ own entity. <itemizedlist> <para>To implement this encapsulation there are several ways:</para> - <listitem><trademark class="trade">JSP</trademark> pages that get included from the layout JSP for each region/portlet</listitem> + <listitem>JSP pages that get included from the layout JSP for each region/portlet</listitem> <listitem>a taglib that allows to place region, window, and decoration tags into the layout JSP </listitem> @@ -148,7 +146,7 @@ right of the default theme. The file <literal>tabs.jsp</literal> is used to display the pages tabs appearing on the left. </para> - <para> Again, you have several choices, either to edit the included <trademark class="trade">JSP</trademark> files directly or create your own, + <para> Again, you have several choices, either to edit the included JSP files directly or create your own, store them in a web application then edit the following file: <literal>jboss-portal.sar/META-INF/jboss-service.xml</literal>. The interesting part in that file is the following: <programlisting><![CDATA[<mbean @@ -261,7 +259,7 @@ some ingredients from the portal itself, and at the end write the response back to the requesting client. </para> - <para>Layouts can be either a JSP or a Servlet. The portal determines the layout to use + <para>Layouts can be either a <trademark class="trade">JSP</trademark> or a Servlet. The portal determines the layout to use via the configured properties of the portal, or the requested page. Both, portal and pages, can define the layout to use in order to render their content. In case both define a layout, the layout defined for the page will overwrite the one defined for the @@ -322,7 +320,7 @@ <para>As you can see, the portal or page property points to the layout to use via the name of the layout. The name has been given to the layout in the layout descriptor. It is in that layout descriptor where the name gets linked to the physical resource - (the JSP or Servlet) that will actually render the layout. + (the <trademark class="trade">JSP</trademark> or Servlet) that will actually render the layout. </para> </sect3> <sect3> @@ -368,7 +366,7 @@ --> <sect2> <title>Layout <trademark class="trade">JSP</trademark> tags</title> - <para>The portal comes with a set of JSP tags that allow the layout developer faster + <para>The portal comes with a set of <trademark class="trade">JSP</trademark> tags that allow the layout developer faster development. <itemizedlist> <para>There are currently two taglibs, containing tags for different approaches to @@ -889,7 +887,7 @@ <para>Again, analogous to the way it is done for layouts, themes are specified in the portal descriptor as a portal or page property. The page property overwrites the portal property. In addition to these two options, themes can also be specified as part of the - theme JSP tag , that is placed on the layout JSP. Here is an example portal descriptor + theme <trademark class="trade">JSP</trademark> tag , that is placed on the layout JSP. Here is an example portal descriptor that specifies the phalanx theme as the theme for the entire portal, and the industrial theme for the theme test page: <programlisting> @@ -1007,7 +1005,7 @@ ");]]> </programlisting> Note that in order for the header content injection to work, the layout needs to make - use of the headerContent JSP tag, like: + use of the headerContent <trademark class="trade">JSP</trademark> tag, like: <programlisting> <![CDATA[<%@ taglib uri="/WEB-INF/theme/portal-layout.tld" prefix="p" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" @@ -1042,7 +1040,7 @@ </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 + requires the layout <trademark class="trade">JSP</trademark> to add the "headerContent" JSP tag (see example above). One thing to note here is the order of the tags. If the headerContent tag is placed after the theme tag, it will allow portlet injected CSS files to overwrite the theme's behavior, making this feature even more powerful!