Author: smumford Date: 2010-05-10 22:41:02 -0400 (Mon, 10 May 2010) New Revision: 3033 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml Log: JBEPP-276: Check in with Publican workaround. Issue: https://bugzilla.redhat.com/show_bug.cgi?id=590933 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml 2010-05-10 22:39:07 UTC (rev 3032) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/Book_Info.xml 2010-05-11 02:41:02 UTC (rev 3033) @@ -12,7 +12,7 @@ <pubsnumber>1.0</pubsnumber> <abstract> <para> - This Reference Guide is a high-level usage document. It deals with more advanced topics than the Install and User guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the &PRODUCT; product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. + This Reference Guide is a high-level usage document. It deals with more advanced topics than the Installation and User Guides, adding new content or taking concepts discussed in the earlier documents further. It aims to provide supporting documentation for advanced users of the &PRODUCT; product. Its primary focus is on advanced use of the product and it assumes an intermediate or advanced knowledge of the technology and terms. </para> </abstract> <corpauthor> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-10 22:39:07 UTC (rev 3032) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-11 02:41:02 UTC (rev 3033) @@ -36,41 +36,40 @@ </para> </note> -<programlisting role="XML">&lt;field name="membershipType"&gt; - &lt;collection type="java.util.ArrayList"&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType"&gt; - &lt;field name="type"&gt; - &lt;string&gt;member&lt;/string&gt; - &lt;/field&gt; - &lt;field name="description"&gt; - &lt;string&gt;member membership type&lt;/string&gt; - &lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType"&gt; - &lt;field name="type"&gt; - &lt;string&gt;owner&lt;/string&gt; - &lt;/field&gt; - &lt;field name="description"&gt; - &lt;string&gt;owner membership type&lt;/string&gt; - &lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType"&gt; - &lt;field name="type"&gt; - &lt;string&gt;validator&lt;/string&gt; - &lt;/field&gt; - &lt;field name="description"&gt; - &lt;string&gt;validator membership type&lt;/string&gt; - &lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; - &lt;/collection&gt; -&lt;/field&gt; -</programlisting> +<programlisting language="XML" role="XML"><![CDATA[<field name="membershipType"> + <collection type="java.util.ArrayList"> + <value> + <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType"> + <field name="type"> + <string>member</string> + </field> + <field name="description"> + <string>member membership type</string> + </field> + </object> + </value> + <value> + <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType"> + <field name="type"> + <string>owner</string> + </field> + <field name="description"> + <string>owner membership type</string> + </field> + </object> + </value> + <value> + <object type="org.exoplatform.services.organization.OrganizationConfig$MembershipType"> + <field name="type"> + <string>validator</string> + </field> + <field name="description"> + <string>validator membership type</string> + </field> + </object> + </value> + </collection> +</field>]]></programlisting> </section> <section id="sect-Reference_Guide-Predefined_User_Configuration-Groups"> @@ -79,44 +78,43 @@ The predefined groups are specified in the <emphasis role="bold">group</emphasis> field of the <emphasis role="bold">OrganizationConfig</emphasis> plugin parameter. </para> -<programlisting role="XML">&lt;field name="group"&gt; - &lt;collection type="java.util.ArrayList"&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.OrganizationConfig$Group"&gt; - &lt;field name="name"&gt; - &lt;string&gt;portal&lt;/string&gt; - &lt;/field&gt; - &lt;field name="parentId"&gt; - &lt;string&gt;&lt;/string&gt; - &lt;/field&gt; - &lt;field name="type"&gt; - &lt;string&gt;hierachy&lt;/string&gt; - &lt;/field&gt; - &lt;field name="description"&gt; - &lt;string&gt;the /portal group&lt;/string&gt; - &lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.OrganizationConfig$Group"&gt; - &lt;field name="name"&gt; - &lt;string&gt;community&lt;/string&gt; - &lt;/field&gt; - &lt;field name="parentId"&gt; - &lt;string&gt;/portal&lt;/string&gt; - &lt;/field&gt; - &lt;field name="type"&gt; - &lt;string&gt;hierachy&lt;/string&gt; - &lt;/field&gt; - &lt;field name="description"&gt; - &lt;string&gt;the /portal/community group&lt;/string&gt; - &lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; +<programlisting language="XML" role="XML"><![CDATA[<field name="group"> + <collection type="java.util.ArrayList"> + <value> + <object type="org.exoplatform.services.organization.OrganizationConfig$Group"> + <field name="name"> + <string>portal</string> + </field> + <field name="parentId"> + <string></string> + </field> + <field name="type"> + <string>hierachy</string> + </field> + <field name="description"> + <string>the /portal group</string> + </field> + </object> + </value> + <value> + <object type="org.exoplatform.services.organization.OrganizationConfig$Group"> + <field name="name"> + <string>community</string> + </field> + <field name="parentId"> + <string>/portal</string> + </field> + <field name="type"> + <string>hierachy</string> + </field> + <field name="description"> + <string>the /portal/community group</string> + </field> + </object> + </value> ... - &lt;/collection&gt; -&lt;/field&gt; -</programlisting> + </collection> +</field>]]></programlisting> </section> <section id="sect-Reference_Guide-Predefined_User_Configuration-Users"> @@ -125,32 +123,31 @@ The predefined users are specified in the <emphasis role="bold">membershipType</emphasis> field of the <emphasis role="bold">OrganizationConfig</emphasis> plugin parameter. </para> -<programlisting role="XML">&lt;field name="user"&gt; - &lt;collection type="java.util.ArrayList"&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.OrganizationConfig$User"&gt; - &lt;field name="userName"&gt;&lt;string&gt;root&lt;/string&gt;&lt;/field&gt; - &lt;field name="password"&gt;&lt;string&gt;exo&lt;/string&gt;&lt;/field&gt; - &lt;field name="firstName"&gt;&lt;string&gt;root&lt;/string&gt;&lt;/field&gt; - &lt;field name="lastName"&gt;&lt;string&gt;root&lt;/string&gt;&lt;/field&gt; - &lt;field name="email"&gt;&lt;string&gt;exoadmin@localhost&lt;/string&gt;&lt;/field&gt; - &lt;field name="groups"&gt;&lt;string&gt;member:/admin,member:/user,owner:/portal/admin&lt;/string&gt;&lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.OrganizationConfig$User"&gt; - &lt;field name="userName"&gt;&lt;string&gt;exo&lt;/string&gt;&lt;/field&gt; - &lt;field name="password"&gt;&lt;string&gt;exo&lt;/string&gt;&lt;/field&gt; - &lt;field name="firstName"&gt;&lt;string&gt;site&lt;/string&gt;&lt;/field&gt; - &lt;field name="lastName"&gt;&lt;string&gt;site&lt;/string&gt;&lt;/field&gt; - &lt;field name="email"&gt;&lt;string&gt;exo@localhost&lt;/string&gt;&lt;/field&gt; - &lt;field name="groups"&gt;&lt;string&gt;member:/user&lt;/string&gt;&lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; +<programlisting language="XML" role="XML"><![CDATA[<field name="user"> + <collection type="java.util.ArrayList"> + <value> + <object type="org.exoplatform.services.organization.OrganizationConfig$User"> + <field name="userName"><string>root</string></field> + <field name="password"><string>exo</string></field> + <field name="firstName"><string>root</string></field> + <field name="lastName"><string>root</string></field> + <field name="email"><string>exoadmin@localhost</string></field> + <field name="groups"><string>member:/admin,member:/user,owner:/portal/admin</string></field> + </object> + </value> + <value> + <object type="org.exoplatform.services.organization.OrganizationConfig$User"> + <field name="userName"><string>exo</string></field> + <field name="password"><string>exo</string></field> + <field name="firstName"><string>site</string></field> + <field name="lastName"><string>site</string></field> + <field name="email"><string>exo@localhost</string></field> + <field name="groups"><string>member:/user</string></field> + </object> + </value> ... - &lt;/collection&gt; -&lt;/field&gt; -</programlisting> + </collection> +</field>]]></programlisting> </section> <section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_monitoring_user_creation"> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-10 22:39:07 UTC (rev 3032) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-11 02:41:02 UTC (rev 3033) @@ -17,18 +17,17 @@ To do this, configure a parameter called <emphasis>gadgets.hostName</emphasis>. The value is the <emphasis>path/to/gadgetServer</emphasis> in <literal>GadgetRegisteryService</literal>: </para> -<programlisting>&lt;component&gt; - &lt;key&gt;org.exoplatform.application.gadget.GadgetRegistryService&lt;/key&gt; - &lt;type&gt;org.exoplatform.application.gadget.jcr.GadgetRegistryServiceImpl&lt;/type&gt; - &lt;init-params&gt; - &lt;value-param&gt; - &lt;name&gt;gadgets.hostName&lt;/name&gt; - &lt;description&gt;Gadget server url&lt;/description&gt; - &lt;value&gt;http://localhost:8080/GateInGadgetServer/gadgets/&lt;/value&gt; - &lt;/value-param&gt; - &lt;/init-params&gt; -&lt;/component&gt; -</programlisting> +<programlisting language="XML" role="XML"><![CDATA[<component> + <key>org.exoplatform.application.gadget.GadgetRegistryService</key> + <type>org.exoplatform.application.gadget.jcr.GadgetRegistryServiceImpl</type> + <init-params> + <value-param> + <name>gadgets.hostName</name> + <description>Gadget server url</description> + <value>http://localhost:8080/GateInGadgetServer/gadgets/</value> + </value-param> + </init-params> +</component>]]></programlisting> <para> It is also possible to have multiple rendering servers. This helps to balance the rendering load across multiple servers. </para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-10 22:39:07 UTC (rev 3032) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/PortletBridge/configuration.xml 2010-05-11 02:41:02 UTC (rev 3033) @@ -86,9 +86,9 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" version="2.4"> - ...--> + ... <!-- This is optional parameters for a facelets based application --> - <!-- <context-param> + <context-param> <param-name>org.ajax4jsf.VIEW_HANDLERS</param-name> <param-value>org.jboss.portletbridge.application.FaceletPortletViewHandler</param-value> </context-param> 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-10 22:39:07 UTC (rev 3032) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/PortletDevelopment/Standard.xml 2010-05-11 02:41:02 UTC (rev 3033) @@ -3,6 +3,8 @@ <!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent"> %BOOK_ENTITIES; ]> + + <chapter id="chap-Reference_Guide-Portlet_Primer"> <title>Portlet Primer</title> <section id="sect-Reference_Guide-Portlet_Primer-JSR_168_and_JSR_286_overview"> @@ -157,7 +159,7 @@ <para> Create a new portal page and add the portlet to it. </para> -<!-- This image needs to be updated to RH skinned version of Portal. Unable to do this. SM --> + <mediaobject> <imageobject role="html"> <imagedata fileref="images/PortletDevelopment/Standard/first_portlet/deployed.png" format="PNG" align="center" scale="100" /> @@ -305,6 +307,7 @@ <para> Below is an example of the <filename>SimplestHelloWorldPortlet/WEB-INF/portlet.xml</filename> file. This file must adhere to its definition in the JSR-286 Portlet Specification. More than one portlet application may be defined in this file: </para> + <programlistingco> <areaspec> <area coords="8" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletname" /> @@ -312,11 +315,10 @@ <area coords="12" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.supports" /> <area coords="15" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletinfo" /> </areaspec> - -<programlisting language="XML" role="XML"><![CDATA[<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" +<!-- TODO XML highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved--> +<programlisting><![CDATA[<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2... - http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" + xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2... http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" version="2.0"> <portlet> <portlet-name>SimplestHelloWorldPortlet</portlet-name> @@ -427,7 +429,6 @@ </para> </step> </procedure> -<!-- This Image needs to be updated with RH Portal skin. Unable to action this. SM --> <mediaobject> <imageobject role="html"> <imagedata fileref="images/PortletDevelopment/Standard/jsp_portlet/output.png" format="PNG" align="center" scale="100" /> @@ -483,8 +484,8 @@ <area coords="25" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.requestDispatcher" /> <area coords="26" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.include" /> </areaspec> - -<programlisting language="Java" role="JAVA"><![CDATA[package org.gatein.portal.examples.portlets; +<!-- TODO JAVA highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved--> +<programlisting><![CDATA[package org.gatein.portal.examples.portlets; import java.io.IOException; @@ -551,8 +552,8 @@ <para> The generic portlet that is inherited dispatches the different views to the methods: <literal>doView</literal> , <literal>doHelp</literal> and <literal>doEdit</literal>. </para> - -<programlisting language="Java" role="JAVA"><![CDATA[... +<!-- TODO JAVA highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved--> +<programlisting><![CDATA[... protected void doHelp(RenderRequest rRequest, RenderResponse rResponse) throws PortletException, IOException, UnavailableException { @@ -584,8 +585,8 @@ <area coords="5" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.getActionParameter" /> <area coords="6" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.setRenderParameter" /> </areaspec> - -<programlisting language="Java" role="JAVA"><![CDATA[... +<!-- TODO JAVA highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved--> +<programlisting><![CDATA[... public void processAction(ActionRequest aRequest, ActionResponse aResponse) throws PortletException, IOException, UnavailableException { @@ -755,13 +756,12 @@ <area coords="21" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.view" /> <area coords="26" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.edit" /> <area coords="31" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.help" /> - </areaspec> - -<programlisting language="XML" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> + </areaspec> +<!-- TODO XML highlight once issue https://bugzilla.redhat.com/show_bug.cgi?id=590933 resolved--> +<programlisting><![CDATA[<?xml version="1.0" encoding="UTF-8"?> <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2... - http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" + xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2... http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" version="2.0"> <portlet> <portlet-name>JSFHelloUserPortlet</portlet-name>