Author: thomas.heute(a)jboss.com Date: 2010-05-20 08:47:28 -0400 (Thu, 20 May 2010) New Revision: 3159 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/images/PortletDevelopment/Standard/first_portlet/deployed.png portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/images/PortletDevelopment/Standard/jsp_portlet/output.png portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml Log: JBEPP-276: Reference Guide Added screenshots, fixed few little things Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/images/PortletDevelopment/Standard/first_portlet/deployed.png =================================================================== (Binary files differ) Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/images/PortletDevelopment/Standard/jsp_portlet/output.png =================================================================== (Binary files differ) Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-20 11:01:22 UTC (rev 3158) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-20 12:47:28 UTC (rev 3159) @@ -78,7 +78,7 @@ <section id="sect-Reference_Guide-JSR_168_and_JSR_286_overview-Window_States"> <title>Window States</title> <para> - Window states are an indicator of how much page space a portlet consumes on any given page. The three states defined by the JSR-168 specification are: + Window states are an indicator of how much page space a portlet consumes on any given page. The three states defined by the JSR-286 specification are: </para> <variablelist> <varlistentry> @@ -126,10 +126,9 @@ <para> This section describes how to deploy a portlet in &PRODUCT;. </para> -<!-- SimpleHelloWorld does not seem to be in the product. JIRA comment by jjamrich JBEPP-276 17/May/10 <para> - A sample portlet called <filename>SimplestHelloWorld</filename> is located in the <literal>examples</literal> directory at the root of your &PRODUCT; binary package. This sample is used in the following examples. - </para> --> + An example portlet called <filename>SimplestHelloWorld</filename> is located in the <literal>epp-doc/examples/portlets</literal> directory at the root of your &PRODUCT; sources package. + </para> <section id="sect-Reference_Guide-Deploying_your_first_Portlet-Compiling"> <title>Compiling</title> <para> @@ -146,7 +145,8 @@ </step> <step> <para> - If the compile is successfully packaged, the result will be available in: <filename><replaceable>applicationname</replaceable>/target/<replaceable>applicationname</replaceable>-0.0.1.war </filename>. + If the example is successfully packaged, the result will be available in: <filename>simplesthelloworld/target/gatein-simplest-helloworld<replaceable>-1.0.0-GA-SNAPSHOT</replaceable>.war </filename>. + </para> </step> <step> @@ -164,14 +164,14 @@ Create a new portal page and add the portlet to it. </para> - <!-- Outdated Screenshot <mediaobject> + <mediaobject> <imageobject role="html"> <imagedata fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" align="center" scale="100" /> </imageobject> <imageobject role="fo"> <imagedata fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" align="center" contentwidth="120mm" /> </imageobject> - </mediaobject> --> + </mediaobject> </step> </procedure> @@ -402,11 +402,10 @@ </listitem> </orderedlist> -<!-- No examples in binary packages as per comment by jjamrich JIRA JBEPP-276 17/May/10 <formalpara> <title>Compiling the example</title> <para> - The example used in this section can be found in the <filename>JSPHelloUser</filename> directory. + The example used in this section can be found in the <literal>epp-doc/examples/portlets</literal> directory at the root of your &PRODUCT; sources package. </para> </formalpara> <para> @@ -420,17 +419,17 @@ </programlisting> </para> <para> - in the <filename>JSPHelloUser</filename> directory. + in the <filename>jsphellouser</filename> directory. </para> </step> <step> <para> - Copy <filename>JSPHelloUser/target/JSPHelloUser-0.0.1.war </filename> to the <literal>deploy</literal> directory of JBoss Application Server. + Copy <filename>jsphellouser/target/gatein-jsp-hellouser-<replaceable>1.0.0-GA-SNAPSHOT</replaceable>.war</filename> to the <literal>deploy</literal> directory of JBoss Application Server. </para> </step> <step> <para> - Select the new <literal>JSPHelloUser</literal> tab in your portal. + Create a new portal page and add the portlet to it. </para> </step> </procedure> @@ -446,7 +445,7 @@ <para> The <literal>EDIT</literal> button only appears for logged-in users. </para> - </note> --> + </note> <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Package_Structure"> <title>Package Structure</title> <para> @@ -456,7 +455,7 @@ The <literal>JSPHelloUser</literal> portlet contains the mandatory portlet application descriptors. The following is an example of the directory structure of the <literal>JSPHelloUser</literal> portlet: </para> -<programlisting>JSPHelloUser-0.0.1.war +<programlisting>gatein-jsp-hellouser->1.0.0-GA-SNAPSHOT.war |-- META-INF | |-- MANIFEST.MF |-- WEB-INF @@ -480,7 +479,7 @@ <section id="sect-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class"> <title>Portlet Class</title> <para> - The code below is from the <filename> JSPHelloUser/src/main/java/org/gatein/portal/examples/portlets/JSPHelloUserPortlet.java </filename> Java source. It is split in different pieces. + The code below is from the <filename> jsphellouser/src/main/java/org/gatein/portal/examples/portlets/JSPHelloUserPortlet.java </filename> Java source. It is split in different pieces. </para> <programlistingco> <areaspec> @@ -738,7 +737,7 @@ In order to write a portlet using JSF a 'bridge' is needed. This software allows developers to write a portlet application as if it was a JSF application. The bridge then negotiates the interactions between the two layers. </para> <para> - An example of the JBoss Portlet Bridge is available in <filename>/portletbridge/examples/</filename>. The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application. + An example using the JBoss Portlet Bridge is available in the <literal>epp-doc/examples/portlets</literal> directory at the root of your &PRODUCT; sources package. The configuration is slightly different from a JSP application. This example can be used as a base to configure instead of creating a new application. </para> <para> As in any JSF application, the file <literal>faces-config.xml</literal> is required. It must contain the following information: @@ -826,7 +825,10 @@ </callout> </calloutlist> </programlistingco> - + <note> + <title>JBoss Portlet Bridge</title> + <para>For more information about the JBoss Portlet Bridge, see the dedicated chapter which is part of this document.</para> + </note> </section> </section>