gatein SVN: r9068 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-01-21 00:12:50 -0500 (Mon, 21 Jan 2013)
New Revision: 9068
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
Log:
Grammar and spelling corrections
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-21 05:12:43 UTC (rev 9067)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-21 05:12:50 UTC (rev 9068)
@@ -30,7 +30,7 @@
<section id="sid-819805">
<title>Portlet Development</title>
<para>
- JBoss Enterprise Portal interface is fully customizable with applications called portlets. Application development can be done by using the plain Portlet specification JSR286 (refer to the "Portlet Primer" chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JavaServerFaces (JSF), RichFaces or Seam (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Portal Platform Reference Guide).
+ JBoss Enterprise Portal interface is fully customizable with applications called portlets. Application development can be done by using the plain Portlet specification JSR286 (refer to the "Portlet Primer" chapter in the JBoss Portal Platform <citetitle>Reference Guide</citetitle> for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JavaServerFaces (JSF), RichFaces or Seam (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Portal Platform <citetitle>Reference Guide)</citetitle>.
</para>
<remark>FIXME: Insert link to "[Starting a Portlet Project]"</remark>
<para>
@@ -43,9 +43,7 @@
<title>The BOM Concept</title>
<para>
- To make the management of dependencies easier, JBoss Portal Platform Team has prepared the Bill of Materials (BOM) needed for developing typical portlet applications. BOM is a Maven
- <code>pom.xml</code>
- file which specifies the versions, types and scopes of dependencies which are granted to be compatible with (or indeed in many cases provided by) JBoss Portal Platform.
+ To make the management of dependencies easier, JBoss Portal Platform Team has prepared the Bill of Materials (BOM) needed for developing typical portlet applications. BOM is a Maven <code>pom.xml</code> file which specifies the versions, types and scopes of dependencies which are granted to be compatible with (or indeed in many cases provided by) JBoss Portal Platform.
</para>
</section>
<section id="sid-55378991_StartingaPortletProject-HowtoUseBOM">
@@ -53,40 +51,16 @@
<title>How to Use JBoss Portal Platform BOM</title>
<remark>FIXME: Link to Quickstarts section when it's available</remark>
<para>
- Let us look at the
- <code>pom.xml</code>
- file from Simplest Hello World
- link linkend="sid-55378941">Quickstart/link
- below, which contains all necessary details.
+ Let us look at the <code>pom.xml</code> file from Simplest Hello World link linkend="sid-55378941">Quickstart/link below, which contains all necessary details.
</para>
<para>
- In its
- <code><dependencyManagement></code>
- section, it declares
+ In its <code><dependencyManagement></code> section, it declares
<code><dependency></code>
<code>gatein-3.5-bom</code>
with
<code><scope></code>
<code>import</code>
- . It indicates that the dependency will
- <emphasis role="italics">de facto</emphasis>
- be replaced with the dependencies in its
- <code>dependencyManagement</code>
- section. Due to this fact, in the
- <code><dependencies></code>
- section of the Simplest Hello World
- <code>pom.xml</code>
- , we can declare the
- <code>javax.portlet:portlet-api</code>
- dependency without specifying its
- <code><version></code>
- ,
- <code><type></code>
- or
- <code><scope></code>
- . All those details are managed by
- <code>gatein-3.5-bom</code>
- .
+ . It indicates that the dependency will <emphasis role="italics">de facto</emphasis> be replaced with the dependencies in its <code>dependencyManagement</code> section. Due to this fact, in the <code><dependencies></code> section of the Simplest Hello World <code>pom.xml</code>, we can declare the <code>javax.portlet:portlet-api</code> dependency without specifying its <code><version></code>, <code><type></code> or <code><scope></code>. All those details are managed by <code>gatein-3.5-bom</code>.
</para>
<example>
<title>Simplest Hello World Portlet</title>
@@ -126,10 +100,10 @@
<dependencyManagement>
<dependencies>
<!--
- Define the version of GateIn we build for. In its dependencyManagement,
- GateIn Bill of Materials (BOM) specifies the versions, types and scopes
- of dependencies which are granted to be compatible with (or indeed
- in many cases provided by) JBoss Portal Platform.
+ Define the version of JBoss Portal Platform we build for. In its dependencyManagement,
+ JBoss Portal Platform Bill of Materials (BOM) specifies the versions, types and scopes
+ of dependencies which are granted to be compatible with (or indeed in many cases
+ provided by) JBoss Portal Platform.
-->
<dependency>
<groupId>org.jboss.bom</groupId>
@@ -178,9 +152,7 @@
</programlisting>
</example>
<para>
- Further steps, after you have set up the
- <code>pom.xml</code>
- file for your project, depend on the technology you have chosen for writing portlets.
+ Further steps, after you have set up the <code>pom.xml</code> file for your project, depend on the technology you have chosen for writing portlets.
</para>
</section>
</section>
@@ -192,17 +164,11 @@
<title>The Java Part</title>
<remark>FIXME: Link to Quickstarts section when it's available</remark>
<para>
- After setting up the the Maven
- <code>pom.xml</code>
- file as shown in the
- <link linkend="sid-55378991">previous section</link>
- , we can continue with implementing a basic JSR286 compatible portlet. Simplest Hello World Portlet from the
- link linkend="sid-55378941">GateIn Quickstarts/link
- collection shows the very essence of every JSR286 Portlet:
+ After setting up the the Maven <code>pom.xml</code> file as shown in the <link linkend="sid-55378991">previous section</link>, we can continue with implementing a basic JSR286 compatible portlet. Simplest Hello World Portlet from the link linkend="sid-55378941">GateIn Quickstarts/link collection shows the very essence of every JSR286 Portlet:
</para>
<example>
<title>SimplestHelloWorldPortlet.java</title>
- <programlisting>
+ <programlisting language="Java">
package org.jboss.portal.portlet.samples;
import java.io.IOException;
@@ -252,15 +218,7 @@
</listitem>
</itemizedlist>
<para>
- In this simplest portlet variant we have decided not to support EDIT and HELP portlet modes. To add them, just override the
- <code>doEdit()</code>
- and
- <code>doHelp</code>
- from
- <code>javax.portlet.GenericPortlet</code>
- and configure the
- <code>portlet.xml</code>
- file accordingly.
+ In this simplest portlet variant, EDIT and HELP portlet modes are not supported. To add them, override the <code>doEdit()</code> and <code>doHelp</code> from <code>javax.portlet.GenericPortlet</code> and configure the <code>portlet.xml</code> file accordingly.
</para>
</section>
<section id="sid-55477012_StandardPortletDevelopmentJSR286-portlet.xml">
@@ -269,7 +227,7 @@
<para>
The
<code>portlet.xml</code>
- file for a plain JSR286 portlet is pretty straigtforward:
+ file for a plain JSR286 portlet is as follows:
</para>
<example>
<title>portlet.xml</title>
@@ -301,11 +259,8 @@
<title>web.xml</title>
<para>
- There is no need to configure any filters, servlets, mapping & co. for a plain JSR286 portlet to work but maven-war-plugin by default requires the
- <code>web.xml</code>
- . To solve it, just include a
- <code>web.xml</code>
- file which contains solely the root element like the following:
+ There is no need to configure filters, servlets or mapping for a plain JSR286 portlet to work but maven-war-plugin by default requires the
+ <code>web.xml</code>. To solve it, include a <code>web.xml</code> file which contains solely the root element:
</para>
<example>
<title>web.xml</title>
@@ -355,7 +310,7 @@
<title>JSF2 Portlet Development</title>
<para>
- The Portlet Bridge pre-installed in JBoss Portal Platform allows for implementing portlets with JavaServer Faces (JSF) 2.1 and RichFaces (RF) 4.2.3. As RichFaces is just a component library for JavaServer Faces, the guidelines for using both of them is very similar. More precisely, setup for a JavaServer Faces portlet project is a superset of a RichFaces project setup. In accordance with that, you need to read both
+ The Portlet Bridge pre-installed in JBoss Portal Platform allows for implementing portlets with JavaServer Faces (JSF) 2.1 and RichFaces (RF) 4.2.3. As RichFaces is a component library for JavaServer Faces, the guidelines for using both of them are very similar. More precisely, the setup for a JavaServer Faces portlet project is a superset of a RichFaces project setup. In accordance with that, you need to read both
<xref linkend="sid-55477016"/>
and
<xref linkend="sid-55477018"/>
@@ -370,19 +325,13 @@
<title>Example Code</title>
<remark>FIXME: Link to Quickstarts section when it's available</remark>
<para>
- This section cites code from JSF2 Hello World Portlet from the
- link linkend="sid-55378941">JBoss Portal Platform Quickstarts/link
- collection.
+ This section cites code from JSF2 Hello World Portlet from the link linkend="sid-55378941">JBoss Portal Platform Quickstarts/link collection.
</para>
<section id="sid-55477016_BasicJSFPortletDevelopment-pom.xml">
<title>pom.xml</title>
<para>
- There is only one noticeable difference in
- <code>pom.xml</code>
- against what we have shown as a general case in the
- <xref linkend="sid-55378991"/>
- section: We need to add different dependencies for JSF:
+ There is only one noticeable difference in <code>pom.xml</code> against what we have shown as a general case in the <xref linkend="sid-55378991"/> section. The dependencies are different for JSF:
</para>
<example>
<title>pom.xml</title>
@@ -457,57 +406,57 @@
. This bean is implemented in Java as follows:
</para>
<informalexample>
- <programlisting>
-26. /**
-27. * {@link HelloBean} is the JSF backing bean for the application, holding the input data to be re-displayed.
-28. */
-29. @ManagedBean(name = "helloBean")
-30. @SessionScoped
-31. public class HelloBean implements Serializable {
-32.
-33. private static final long serialVersionUID = -6239437588285327644L;
-34.
-35. /**
-36. * Stores the name which will be used to greet the application user.
-37. */
-38. private String name;
-39.
-40. /**
-41. * Initializes {@link #name} with the value {@code "World"}.
-42. */
-43. @PostConstruct
-44. public void postContruct() {
-45. this.name = "World";
-46. }
-47.
-48. /**
-49. * Returns {@link #name}.
-50. *
-51. * @return {@link #name}
-52. */
-53. public String getName() {
-54. return name;
-55. }
-56.
-57. /**
-58. * Set {@link #name}.
-59. *
-60. * @param name
-61. */
-62. public void setName(String name) {
-63. this.name = name;
-64. }
-65.
-66. /**
-67. * Resets {@link #name} to the default value {@code "World"}.
-68. *
-69. * @param ae ignored
-70. */
-71. public void reset(ActionEvent ae) {
-72. this.name = "World";
-73. }
-74.
-75. }
+ <programlisting language="Java">
+ /**
+ * {@link HelloBean} is the JSF backing bean for the application, holding the input data to be re-displayed.
+ */
+ @ManagedBean(name = "helloBean")
+ @SessionScoped
+ public class HelloBean implements Serializable {
+
+ private static final long serialVersionUID = -6239437588285327644L;
+
+ /**
+ * Stores the name which will be used to greet the application user.
+ */
+ private String name;
+
+ /**
+ * Initializes {@link #name} with the value {@code "World"}.
+ */
+ @PostConstruct
+ public void postContruct() {
+ this.name = "World";
+ }
+
+ /**
+ * Returns {@link #name}.
+ *
+ * @return {@link #name}
+ */
+ public String getName() {
+ return name;
+ }
+
+ /**
+ * Set {@link #name}.
+ *
+ * @param name
+ */
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ /**
+ * Resets {@link #name} to the default value {@code "World"}.
+ *
+ * @param ae ignored
+ */
+ public void reset(ActionEvent ae) {
+ this.name = "World";
+ }
+
+ }
</programlisting>
</informalexample>
<para>
@@ -634,9 +583,9 @@
<title>Custom CSS</title>
<para>
- Portlet Bridge supports loading of CSS resources in the "JSF way". Just use the
+ Portlet Bridge supports loading of CSS resources in the "JSF way". Use the
<code><h:outputStylesheet library="css" name="jsf2-hello-world-portlet.css" /></code>
- as we do in the
+ as in the
<code>main.xhtml</code>
file above. The
<code>jsf2-hello-world-portlet.css</code>
@@ -662,20 +611,20 @@
<example>
<title>jsf2-hello-world-portlet.css</title>
<programlisting>
-17. div.jsf2HelloWorldPortlet {
-18. padding: 10px;
-19. /* In the following we use a JSF Expression Language expression rather then plain relative path.
-20. Plain relative paths do not work in JSF portlets. The expression #{resource['...']} is
-21. dynamically evaluated to a proper public URL. The path '/css/background/jsf-logo.png'
-22. used in the expression is relative to resources folder of this web application.
-23. See https://docs.jboss.org/author/display/PBR/Resource+Serving */
-24. background: url(#{resource['/css/background/jsf-logo.png']}) no-repeat;
-25. background-position-x: 753px;
-26. background-position-y: 10px;
-27. }
-28. div.jsf2HelloWorldPortlet p {
-29. width: 713px;
-30. }
+ div.jsf2HelloWorldPortlet {
+ padding: 10px;
+ /* In the following we use a JSF Expression Language expression rather then plain relative path.
+ Plain relative paths do not work in JSF portlets. The expression #{resource['...']} is
+ dynamically evaluated to a proper public URL. The path '/css/background/jsf-logo.png'
+ used in the expression is relative to resources folder of this web application.
+ See https://docs.jboss.org/author/display/PBR/Resource+Serving */
+ background: url(#{resource['/css/background/jsf-logo.png']}) no-repeat;
+ background-position-x: 753px;
+ background-position-y: 10px;
+ }
+ div.jsf2HelloWorldPortlet p {
+ width: 713px;
+ }
</programlisting>
</example>
</section>
@@ -690,7 +639,7 @@
resource bundle are stored under
<code>src/main/resources/org/jboss/as/quickstarts/jsf</code>
. The following settings in
- <code>faces-config.xml</code>
+ <filename>faces-config.xml</filename>
are needed so that this bundle can be used in JSF templates.
</para>
<example>
@@ -1138,19 +1087,17 @@
<para>
To deploy to other than default
<code>localhost:9999</code>
- JBoss instance, copy the following configuration
-
- just after
+ JBoss Portal Platform instance, copy the following configuration just after
<code><version>${jboss.as.plugin.version}</version></code>
in the
- <code>pom.xml</code>
+ <filename>pom.xml</filename>
file and adjust it to suit your needs.
Note that
<code><username></code>
and
<code><password></code>
- elements can be omitted sometimes, depending on your JBoss security settings.
+ elements can be omitted sometimes, depending on JBoss Portal Platform's security settings.
</para>
<informalexample>
11 years, 11 months
- 1
- 0
gatein SVN: r9067 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-01-21 00:12:43 -0500 (Mon, 21 Jan 2013)
New Revision: 9067
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
Log:
Minor edits
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-21 04:33:14 UTC (rev 9066)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-21 05:12:43 UTC (rev 9067)
@@ -23,7 +23,7 @@
Note that, unlike portlets, a gadget has very little knowledge of its context (the portal) and its integration within the portal may be more limited (in terms of visual integration for instance).
</para>
<para>
- While Google Web Toolkit (GWT) applications can also technically be used as gadgets and GWT makes it easy to write user-friendly applications, we do not recommend its usage as its support can be limited and Google's strategy to keep GWT applications running as gadgets cannot clearly be established. Consequently, GWT applications are not supported by the JBoss Portal Platform support agreement.
+ While Google Web Toolkit (GWT) applications can also technically be used as gadgets and GWT makes it easy to write user-friendly applications, its usage is not recommended as its support can be limited and Google's strategy to keep GWT applications running as gadgets cannot clearly be established. Consequently, GWT applications are not supported by the JBoss Portal Platform support agreement.
</para>
</section>
</section>
@@ -387,22 +387,22 @@
<example>
<title>pom.xml</title>
<programlisting>
-068. <dependencies>
-069. <!--
-070. The versions, scopes and types of these dependencies are managed in gatein-*-bom.
-071. You need to name only groupId and artifactId here.
-072. Name only those artifacts you refer to in your code.
-073. Look at gatein-*-bom POM file for the complete list of available artifacts.
-074. -->
-075. <dependency>
-076. <groupId>org.jboss.spec.javax.faces</groupId>
-077. <artifactId>jboss-jsf-api_2.1_spec</artifactId>
-078. </dependency>
-079. <dependency>
-080. <groupId>org.jboss.portletbridge</groupId>
-081. <artifactId>portletbridge-api</artifactId>
-082. </dependency>
-083. </dependencies>
+ <dependencies>
+ <!--
+ The versions, scopes and types of these dependencies are managed in gatein-*-bom.
+ You need to name only groupId and artifactId here.
+ Name only those artifacts you refer to in your code.
+ Look at gatein-*-bom POM file for the complete list of available artifacts.
+ -->
+ <dependency>
+ <groupId>org.jboss.spec.javax.faces</groupId>
+ <artifactId>jboss-jsf-api_2.1_spec</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-api</artifactId>
+ </dependency>
+ </dependencies>
</programlisting>
</example>
</section>
@@ -771,41 +771,41 @@
<example>
<title>pom.xml</title>
<programlisting>
-068. <dependencies>
-069. <!--
-070. The versions, scopes and types of these dependencies are managed in gatein-*-bom.
-071. You need to name only groupId and artifactId here.
-072. Name only those artifacts you refer to in your code.
-073. Look at gatein-*-bom POM file for the complete list of available artifacts.
-074. -->
-075. <!-- General JSF dependencies -->
-076. <dependency>
-077. <groupId>org.jboss.spec.javax.faces</groupId>
-078. <artifactId>jboss-jsf-api_2.1_spec</artifactId>
-079. </dependency>
-080. <dependency>
-081. <groupId>org.jboss.portletbridge</groupId>
-082. <artifactId>portletbridge-api</artifactId>
-083. </dependency>
-084.
-085. <!-- RF-sprecific dependencies -->
-086. <dependency>
-087. <groupId>org.jboss.portletbridge</groupId>
-088. <artifactId>portletbridge-extension-richfaces</artifactId>
-089. </dependency>
-090. <dependency>
-091. <groupId>org.richfaces.ui</groupId>
-092. <artifactId>richfaces-components-api</artifactId>
-093. </dependency>
-094. <dependency>
-095. <groupId>org.richfaces.ui</groupId>
-096. <artifactId>richfaces-components-ui</artifactId>
-097. </dependency>
-098. <dependency>
-099. <groupId>org.richfaces.core</groupId>
-100. <artifactId>richfaces-core-impl</artifactId>
-101. </dependency>
-102. </dependencies>
+ <dependencies>
+ <!--
+ The versions, scopes and types of these dependencies are managed in gatein-*-bom.
+ You need to name only groupId and artifactId here.
+ Name only those artifacts you refer to in your code.
+ Look at gatein-*-bom POM file for the complete list of available artifacts.
+ -->
+ <!-- General JSF dependencies -->
+ <dependency>
+ <groupId>org.jboss.spec.javax.faces</groupId>
+ <artifactId>jboss-jsf-api_2.1_spec</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-api</artifactId>
+ </dependency>
+
+ <!-- RF-sprecific dependencies -->
+ <dependency>
+ <groupId>org.jboss.portletbridge</groupId>
+ <artifactId>portletbridge-extension-richfaces</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.richfaces.ui</groupId>
+ <artifactId>richfaces-components-api</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.richfaces.ui</groupId>
+ <artifactId>richfaces-components-ui</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.richfaces.core</groupId>
+ <artifactId>richfaces-core-impl</artifactId>
+ </dependency>
+ </dependencies>
</programlisting>
</example>
</section>
11 years, 11 months
- 1
- 0
gatein SVN: r9066 - in epp/docs/branches/6.0: Reference_Guide/en-US and 1 other directories.
by do-not-reply＠jboss.org
Author: jaredmorgs
Date: 2013-01-20 23:33:14 -0500 (Sun, 20 Jan 2013)
New Revision: 9066
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml
Log:
Minor changes to the Portal Dev section before pushing the changes to the docs-stage for review.
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-18 12:56:57 UTC (rev 9065)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-21 04:33:14 UTC (rev 9066)
@@ -35,11 +35,8 @@
<title>Example</title>
<mediaobject>
<imageobject role="html">
- <imagedata align="center" scale="100" fileref="images/7372962/portalextensionstructure.png" format="PNG"/>
+ <imagedata align="center" scale="100" fileref="images/portalextensionstructure.png" format="PNG"/>
</imageobject>
- <imageobject role="fo">
- <imagedata width="150mm" align="center" fileref="images/7372962/portalextensionstructure.png" format="PNG"/>
- </imageobject>
</mediaobject>
</figure>
<section id="Portal_Extension">
@@ -247,9 +244,7 @@
</para>
<section id="gatein-resources-xml">
<title>gatein-resources.xml</title>
- <para>
- In our case
- <code>gatein-resources.xml</code>
+ <para> <code>gatein-resources.xml</code>
is located in the
<filename>war/src/main/webapp/WEB-INF</filename>
sub-folder of the Portal Extension Quickstart project.
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2013-01-18 12:56:57 UTC (rev 9065)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/Revision_History.xml 2013-01-21 04:33:14 UTC (rev 9066)
@@ -18,7 +18,7 @@
<revdescription>
<simplelist>
<member>Final comments done for https://docs.jboss.org/author/display/GTNPORTAL35/Internationalization+Co.... Section ready for QA.</member>
- <member/>
+ <member>Rebased changes for https://docs.jboss.org/author/display/GTNPORTAL35/Configuring+GateIn%27s+...</member>
</simplelist>
</revdescription>
</revision>
Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml
===================================================================
--- epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2013-01-18 12:56:57 UTC (rev 9065)
+++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/WSRP.xml 2013-01-21 04:33:14 UTC (rev 9066)
@@ -1664,7 +1664,7 @@
<section>
<title>Overview</title>
<para>
- The preferred way to configure the behavior of Portal's WSRP Producer is via the WSRP configuration portlet.
+ The preferred way to configure the behavior of Portal's WSRP Producer is through the WSRP configuration portlet.
Alternatively, it is possible to add an XML file called
<filename>wsrp-producer-config.xml</filename>
in the
11 years, 11 months
- 1
- 0
gatein SVN: r9065 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: ppenicka
Date: 2013-01-18 07:56:57 -0500 (Fri, 18 Jan 2013)
New Revision: 9065
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
Log:
Fixed Jared's build issue. The problem was wrong attribute "lang" of programlisting. Corrected to "language", now the book can be built successfully.
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-18 07:05:47 UTC (rev 9064)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-18 12:56:57 UTC (rev 9065)
@@ -95,7 +95,7 @@
</para>
<example>
<title>configuration.xml</title>
- <programlisting lang="XML"><configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ <programlisting language="XML"><configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd">
<external-component-plugins>
<!-- The full qualified name of the PortalContainerConfig -->
11 years, 11 months
- 1
- 0
gatein SVN: r9064 - in epp/docs/branches/6.0/Developer_Guide/en-US: images and 1 other directory.
by do-not-reply＠jboss.org
Author: jaredmorgs
Date: 2013-01-18 02:05:47 -0500 (Fri, 18 Jan 2013)
New Revision: 9064
Added:
epp/docs/branches/6.0/Developer_Guide/en-US/images/Kinds+of+Navigation.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/complexinfra.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-local-index.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-shared-index.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-standalone-index.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/navigation-bar.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/portalExtensions.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/portalextensionstructure.png
epp/docs/branches/6.0/Developer_Guide/en-US/images/simpleinfra.png
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml
epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml
epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
Log:
Incorporated changes to Portal Extension chapter, but there is an XML error I just can't track down. I don't want to risk not checking in my day's changes, but I srsly can't track down the effing thing. So pushing in with the error and will look on Monday to try and resolve
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml 2013-01-18 04:45:43 UTC (rev 9063)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/Book_Info.xml 2013-01-18 07:05:47 UTC (rev 9064)
@@ -5,7 +5,7 @@
]>
<bookinfo id="book-Developer_Guide-Developer_Guide">
<title>Developer Guide</title>
- <subtitle>for use with JBoss Portal Platform 6 and it's patch releases.</subtitle>
+ <subtitle>for use with JBoss Portal Platform 6.</subtitle>
<productname>JBoss Portal Platform</productname>
<productnumber>6</productnumber>
<edition>6.0.0</edition>
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2013-01-18 04:45:43 UTC (rev 9063)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2013-01-18 07:05:47 UTC (rev 9064)
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Freeform XML Formatting. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!-- This document was created with Syntext Serna Freeform XML Formatting. --><!-- This document was created with Syntext Serna Free. --><!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "Developer_Guide.ent">
%BOOK_ENTITIES;
]>
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2013-01-18 04:45:43 UTC (rev 9063)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/Revision_History.xml 2013-01-18 07:05:47 UTC (rev 9064)
@@ -4,7 +4,23 @@
<title>Revision History</title>
<simpara>
<revhistory>
- <revision>
+ <revision>
+ <revnumber>6.0.0-6</revnumber>
+ <date>Fri Jan 18 2013</date>
+ <author>
+ <firstname>Jared</firstname>
+ <surname>Morgan</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Added all the raw changes from the Portal Extension section on Confluence.</member>
+ <member>Incorporated changes up to Rev 4 from https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Groovy+Template+... </member>
+ <member>Incorporated changes up to Rev 4 from https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Skin+for+a+Portlet with a question about how Quickstarts will be delivered.</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>6.0.0-5</revnumber>
<date>Tue Oct 30 2012</date>
<author>
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-18 04:45:43 UTC (rev 9063)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-4-GDG_Portal_Development.xml 2013-01-18 07:05:47 UTC (rev 9064)
@@ -1,125 +1,790 @@
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" []>
- <chapter id="sid-8094155">
- <title>Portal Development</title>
-
- <section id="sid-7372962">
- <title>Portal containers</title>
-
- <para>
+<chapter id="sid-8094155">
+ <title>Portal Development</title>
+ <section id="sid-7372962">
+ <title>Portal containers</title>
+ <para>
In a single instance (or cluster) of JBoss Portal Platform, multiple portals can be running and share resources with other portals with two levels of granularity:
</para>
-
- <itemizedlist>
- <listitem>
- <para>
+ <itemizedlist>
+ <listitem>
+ <para>
Portal Containers: A portal container can host multiple sites, and a JBoss Portal Platform instance can host multiple portal containers
</para>
- </listitem>
-
- <listitem>
- <para>
+ </listitem>
+ <listitem>
+ <para>
Site: A site can have a unique identity, with its own skin applied to a set of pages.
</para>
- </listitem>
- </itemizedlist>
-
- <para>
+ </listitem>
+ </itemizedlist>
+ <para>
The biggest granularity is what is called "Portal Containers". A Portal Container can host multiple "Sites". Those two components have a unique identifier that can be found in the default URL mapping according to the following scheme: <code><ulink url="http://localhost:8080/"/><portalcontainer>/<site> </code>
</para>
-
- <para>
+ <para>
When creating a website, you can either create a portal container or extend an existing one. Extending an existing portal container, such as the default one provided with JBoss Portal Platform, is the recommended option because you only need to customize it to suit your requirements. Another benefit of the extension method is that upgrades consist of copying the newer distribution archives in place of the originals. This upgrade method is not possible if the distribution archives have been modified.
</para>
-
- <para>
+ <para>
While running multiple portal containers is possible, it's recommended to keep those on separate installations. Note that multiple websites can run in a single portal container and share some services.
</para>
-
- <para>
+ <para>
The procedure for creating portal containers and extending existing portal containers is similar: create an enterprise archive (EAR) containing configuration details, runnable code and static resources.
</para>
-
- <figure>
- <title>Example</title>
-
+ <figure>
+ <title>Example</title>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata align="center" scale="100" fileref="images/7372962/portalextensionstructure.png" format="PNG"/>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata width="150mm" align="center" fileref="images/7372962/portalextensionstructure.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <section id="Portal_Extension">
+ <title>Portal Extension</title>
+ <remark>Source taken from: https://docs.jboss.org/author/display/GTNPORTAL35/Portal+Extension</remark>
+ <para>When extending an existing Portal Container, the name of the portal in the Extension configuration is the same as the name of the existing Portal Container. The configuration (and other aspects) of the existing Portal Container can therefore be shadowed by the Extension. Using this approach, many aspects of an available Portal Container can be customized, such as (but not limited to) the following topics described in the indicated sections:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <xref linkend="Custom_Groovy_Template_For_Portlet"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Custom_Skin_For_Portlet"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para><xref linkend="CSS_and_Images"/></para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Custom_Navigation_And_Pages"/>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <xref linkend="Internationalization_Navigation_Nodes"/>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <section id="How_The_Shadowing_Mechanism_Works">
+ <title>How the Shadowing Mechanism Works</title>
+ <para>A schematic representation of the shadowing mechanism can be seem in <xref linkend="fig-Shadowing_Mechanism"/>.</para>
+ <figure id="fig-Shadowing_Mechanism">
+ <title>Shadowing Mechanism</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/portalextensionstructure.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ The Extension EAR's <code>conf/configuration.xml</code> file plays a crucial role in shadowing. Consider the following code extract present in the
+ <ulink url="https://github.com/gatein/gatein-portal-quickstart/tree/master/gatein-por...">Portal Extension Quickstart</ulink>
+ . In this code extract, the
+ <code>name</code>
+ parameter of the
+ <code>PortalContainerDefinition</code>
+ is set to
+ <code>"portal"</code>
+ . Because a portal container called "portal" already exists in the default JBoss Portal Platform 6 installation, the container name is redefined in this file:
+ </para>
+ <example>
+ <title>configuration.xml</title>
+ <programlisting lang="XML"><configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd">
+ <external-component-plugins>
+ <!-- The full qualified name of the PortalContainerConfig -->
+ <target-component>org.exoplatform.container.definition.PortalContainerConfig</target-component>
+ <component-plugin>
+ <!-- The name of the plugin -->
+ <name>Add PortalContainer Definitions</name>
+ <!-- The name of the method to call on the PortalContainerConfig in order to register the PortalContainerDefinitions -->
+ <set-method>registerPlugin</set-method>
+ <!-- The full qualified name of the PortalContainerDefinitionPlugin -->
+ <type>org.exoplatform.container.definition.PortalContainerDefinitionPlugin</type>
+ <init-params>
+ <object-param>
+ <name>portal</name>
+ <object type="org.exoplatform.container.definition.PortalContainerDefinition">
+ <!-- The name of the Portal Container: note that a Portal Container called "portal"
+ already exists in the default GateIn installation. Therefore, we actually redefine
+ that existing Portal Container here. -->
+ <field name="name">
+ <string>portal</string>
+ </field>
+ <!-- The name of the context name of the rest web application -->
+ <field name="restContextName">
+ <string>rest</string>
+ </field>
+ <!-- The name of the realm -->
+ <field name="realmName">
+ <string>gatein-domain</string>
+ </field>
+ <field name="externalSettingsPath">
+ <string>configuration.properties</string>
+ </field>
+ <!--
+ The list of all the context names that are needed to initialize the Portal Container properly.
+ The order of the dependencies will define the initialization order and also the order for
+ loading resources. When a resource with the same path, say /dir/subdir/resource, is available
+ in more than one of the listed contexts, the one from the context closest to the end of this list
+ will be chosen. Here we want the resources available in gatein-portal-extension to win over all
+ other resources. Therefore we have added gatein-portal-extension as the last element of the list.
+ -->
+ <field name="dependencies">
+ <collection type="java.util.ArrayList">
+ <value>
+ <string>eXoResources</string>
+ </value>
+ <value>
+ <string>portal</string>
+ </value>
+ <value>
+ <string>dashboard</string>
+ </value>
+ <value>
+ <string>exoadmin</string>
+ </value>
+ <value>
+ <string>eXoGadgets</string>
+ </value>
+ <value>
+ <string>gwtGadgets</string>
+ </value>
+ <value>
+ <string>eXoGadgetServer</string>
+ </value>
+ <value>
+ <string>rest</string>
+ </value>
+ <value>
+ <string>web</string>
+ </value>
+ <value>
+ <string>gatein-portal-extension</string>
+ </value>
+ </collection>
+ </field>
+ </object>
+ </object-param>
+ </init-params>
+ </component-plugin>
+ </external-component-plugins>
+</configuration></programlisting>
+ </example>
+ <para>Other resources available in an existing Portal Container can be customized in a similar way. Please refer to the following sections for more details.</para>
+ </section>
+ <section id="Custom_Groovy_Template_For_Portlet">
+ <title>Custom Groovy Template for a Portlet</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Groovy+Template+...</remark>
+ <para>
+ After having set up the
+ <code>conf/configuration.xml</code>
+ file as described in
+ <xref linkend="How_The_Shadowing_Mechanism_Works"/> you can proceed with customizing the Groovy templates of portlets.
+ </para>
+ <para>Shadowing of built-in Groovy templates is controlled by the order of
+ <code><dependencies></code>
+ in the configuration of the Portal Container (or Extension) as described in <xref linkend="How_The_Shadowing_Mechanism_Works"/>. </para>
+ <para>If a template with the same path (for example,
+ <filename>/dir/subdir/template.gtmpl</filename>) is available in more than one of the dependencies, the template from the context closest to the end of the list of dependencies is chosen. To ensure that the template created in <xref linkend="proc-Customizing_HomePagePortlet"/> is chosen,
+ <code>gatein-portal-extension</code>
+is added as the last element in the list.
+ </para>
+ <note>
+ <para> This section mentions code directly available from the Portal Extension Example in the
+ JBoss Portal Platform Quickstarts
+ collection.
+ </para>
+ </note>
+ <procedure id="proc-Customizing_HomePagePortlet">
+ <title>Customizing HomePagePortlet</title>
+ <para>Complete this procedure to change the text and layout used in the default HomePagePortlet shipped with the platform in a custom Extension. </para>
+ <step>
+ <para>Copy <filename><replaceable>JPP_HOME</replaceable>/gatein/gatein.ear/portal.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl</filename> </para>
+ </step>
+ <step>
+ <para>Paste the file into the <filename>war/src/main/webapp/templates/groovy/webui/component/</filename> folder of the Extension EAR. </para>
+ <important>
+ <para>The file location in the custom extension must mirror the original location of the file for shadowing to work correctly.</para>
+ </important>
+ </step>
+ <step>
+ <para>Make the desired changes to the text and layout of the HomePagePortlet in the custom extension.</para>
+ </step>
+ <step>
+ <para>Deploy the extension EAR to the portal platform. The HomePagePortlet mirrors the changes made in the custom extension.</para>
+ </step>
+ </procedure>
+ </section>
+ <section id="Custom_Skin_For_Portlet">
+ <title>Custom Skin for a Portlet</title>
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/Custom+Skin+for+a+Portlet</remark>
+ <para>
+ This section mentions code from the Portal Extension Examples available for download from <ulink url="https://access.redhat.com/"/>. as part of your JBoss Portal Platform subscription.
+ </para>
+ <para>The same guidelines that apply when creating a new portlet skin also apply when creating a custom skin for a built-in portlet distributed with JBoss Portal Platform. </para>
+ <para>Declare the skin first in the
+ <code>gatein-resources.xml</code>
+ file, and then create the CSS and other supporting files such as backgrounds.
+ </para>
+ <para>Shadowing of built-in Groovy templates is controlled by the order of
+ <code><dependencies></code>
+ in the configuration of the Portal Container (or Extension) as described in <xref linkend="How_The_Shadowing_Mechanism_Works"/>. </para>
+ <para>When the
+ <code>HomePagePortlet</code>
+skin defined in
+ <code>web.war</code>
+is available in more than one of the dependencies, the template from the context closest to the end of the list of dependencies is chosen. To ensure that the skin available in
+ <code>gatein-portal-extension</code> is chosen,
+ <code>gatein-portal-extension</code>
+is added as the last element in the list.
+ </para>
+ <section id="gatein-resources-xml">
+ <title>gatein-resources.xml</title>
+ <para>
+ In our case
+ <code>gatein-resources.xml</code>
+ is located in the
+ <filename>war/src/main/webapp/WEB-INF</filename>
+ sub-folder of the Portal Extension Quickstart project.
+ </para>
+ <example>
+ <title>gatein-resources.xml</title>
+ <programlisting language="XML">
+<gatein-resources xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_resources_1_3 http://www.gatein.org/xml/ns/gatein_resources_1_3"
+ xmlns="http://www.gatein.org/xml/ns/gatein_resources_1_3">
+
+ <!-- GateIn will load this CSS for HomePagePortlet instead of the default one. -->
+ <portlet-skin>
+ <!--
+ The name of the web application containing the portlet.xml file in which
+ BannerPortlet is definded. The application name is usually the same as
+ the name of the WAR through which the application was deployed.
+ -->
+ <application-name>web</application-name>
+ <!-- <portlet-name> value from the portlet.xml referenced above -->
+ <portlet-name>HomePagePortlet</portlet-name>
+ <skin-name>Default</skin-name>
+ <css-path>/templates/skin/webui/component/UIHomePagePortlet/DefaultStylesheet.css</css-path>
+ </portlet-skin></programlisting>
+ </example>
+ </section>
+ <section id="CSS_and_Images">
+ <title>CSS and Images</title>
+ <para>
+ In the
+ <code>gatein-resources.xml</code> file in <xref linkend="gatein-resources-xml"/>, the custom skin is set to use the CSS file
+ <filename>/templates/skin/webui/component/UIHomePagePortlet/DefaultStylesheet.css</filename>
+ which translates to the Portal Extension Quickstart project
+ <filename>war/src/main/webapp/templates/skin/webui/component/UIHomePagePortlet/DefaultStylesheet.css</filename>
+file.
+
+ In the CSS file itself, image files use relative paths as demonstrated in <xref linkend="exam-DefaultStylesheetCss"/>:
+ </para>
+ <example id="exam-DefaultStylesheetCss">
+ <title>DefaultStylesheet.css</title>
+ <programlisting>
+051. .UIHomePagePortlet .TRContainer .DotLine {
+052. background: url("DefaultSkin/background/Line.gif") no-repeat -2px top;
+053. height: 1px;
+054. width: 182px;
+055. margin: 7px auto;
+056. }
+</programlisting>
+ </example>
+ <note>
+ <para>For further information about creating portlets skins, refer to<citetitle> Skinning the Portal</citetitle> in the JBoss Portal Platform <citetitle>Reference Guide</citetitle>.</para>
+ </note>
+ </section>
+ </section>
+ <section id="Custom_Navigation_And_Pages">
+ <title>Custom Navigation and Pages</title>
+ <para>
+ This section mentions code from the Portal Extension Examples available for download from <ulink url="https://access.redhat.com/"/>. as part of your JBoss Portal Platform subscription.
+ </para>
+ <para>In Portal Extension quickstart, we have added a couple of navigation nodes and pages to the ones available in the default GateIn Portal installation.</para>
+ <section id="portal-configuration-xml">
+ <title>portal-configuration.xml</title>
+ <para>
+ In Portal Extension quickstart, this configuration file is located in
+ <code>war/src/main/webapp/WEB-INF/conf/sample-ext/portal</code>
+ directory. It is the starting point of the navigation customization. We will not say more about this file here as there is usually no need to change it. Please refer to
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264592">Portal Navigation Configuration</ulink>
+ section of GateIn Portal Reference Guide for more information.
+ </para>
+ </section>
+ <section id="Three_Kinds_Of_Navigation">
+ <title>Three kinds of Navigation</title>
+ <para>Rather than using too many words to explain what and why, let us look at the following image:</para>
+ <figure>
+ <title>TODO InformalFigure image title empty</title>
<mediaobject>
- <imageobject role="html">
- <imagedata align="center" scale="100" fileref="images/7372962/portalextensionstructure.png" format="PNG"/>
- </imageobject>
-
- <imageobject role="fo">
- <imagedata width="150mm" align="center" fileref="images/7372962/portalextensionstructure.png" format="PNG"/>
- </imageobject>
+ <imageobject>
+ <imagedata fileref="images/Kinds+of+Navigation.png"/>
+ </imageobject>
</mediaobject>
- </figure>
-
- <section id="sid-7372962_GDG-Portalcontainers-Portalextension">
- <title>Portal extension</title>
-
- <para>
- A portal extension is packaged as an Enterprise ARchive (EAR), a configuration file allows to define which services are required and by ordering those, it is possible to modify some elements. It can be a configuration setting, a translation, a visual template, a page to add.
+ </figure>
+ </section>
+ <section id="Adding_Navigation_Node_Site_Navigation">
+ <title>Adding a Navigation Node to a Site Navigation</title>
+ <para>
+ Let us have a look at
+ <code>war/src/main/webapp/WEB-INF/conf/sample-ext/portal/portal/classic/navigation.xml</code>
+ . Note that in this path,
+ <emphasis role="italics">classic</emphasis>
+ is the name of the site the navigation of which we are which we want to define.
</para>
-
- <para>
- Portal extensions can shadow existing services, a portal will usually be composed of various extensions, which usually add services.
+ <example>
+ <title>Site-wide navigation.xml</title>
+ <programlisting>
+19. <node-navigation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+20. xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3" xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_3">
+21. <!-- Priority has no significance in site navigations. But it is required. See GTNPORTAL-2751 -->
+22. <priority>1</priority>
+23.
+24. <!--
+25. In this file, we are adding a navigation node to the navigation of the site called "classic".
+26. The site-wide navigation is used e.g. in NavigationPortlet.
+27. Visibility of navigation nodes depends on <access-permissions> set in the sibling pages.xml file.
+28. See also portal.configuration section of the file ../../portal-configuration.xml.
+29. -->
+30. <page-nodes>
+31. <node>
+32. <name>page-just-added</name>
+33. <!--
+34. #{portal.extension.justAddedPage} is place holder for an internationalized string.
+35. See WEB-INF/classes/locale/navigation/portal/classic_en.properties
+36. -->
+37. <label>#{portal.extension.justAddedPage}</label>
+</programlisting>
+ </example>
+ <para>
+ In this file, we have added
+ <code>page-just-added</code>
+ navigation node into the portal navigation. It can be seen in the navigation bar.
</para>
-
- <figure>
- <title>Example</title>
-
- <mediaobject>
- <imageobject role="html">
- <imagedata align="center" scale="100" fileref="images/7372962/portalExtensions.png" format="PNG"/>
- </imageobject>
- </mediaobject>
+ <para>
+ <figure>
+ <title>TODO InformalFigure image title empty</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/navigation-bar.png"/>
+ </imageobject>
+ </mediaobject>
</figure>
-
- <para>
- In a portal extension, elements are shadowed by using the same directory location, so if you want to rewrite the groovy template of the HomePagePortlet which is located in <filename>gatein.ear/02portal.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl</filename>, it would be in an extension at a location such as <filename>myExtension/myWar.war/templates/groovy/webui/component/UIHomePagePortlet.gtmpl</filename>. The ordering will be defined by the portal extension configuration.
</para>
- </section>
+ <para>
+ The
+ <code>page-just-added</code>
+ navigation node refers to
+ <code>portal::classic::justAddedPage</code>
+ which we define in
+ <code>pages.xml</code>
+ file located in the same directory as the above
+ <code>navigation.xml</code>
+ .
+ </para>
+ <example>
+ <title>Site-wide pages.xml</title>
+ <programlisting>
+19. <page-set xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3"
+20. xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_3">
+21. <page>
+22. <name>justAddedPage</name>
+23. <title>Page Just Added</title>
+24. <!-- This page and any navigation nodes refering to it will be visible to all visitors (signed in or anonymous). -->
+25. <access-permissions>Everyone</access-permissions>
+26. <edit-permission>*:/platform/administrators</edit-permission>
+27. <portlet-application>
+28. <portlet>
+29. <application-ref>gatein-portal-extension</application-ref>
+30. <portlet-ref>JustAddedPortlet</portlet-ref>
+31. </portlet>
+32. <title>Just Added Portlet</title>
+33. <access-permissions>Everyone</access-permissions>
+34. <show-info-bar>false</show-info-bar>
+35. <show-application-state>false</show-application-state>
+36. <show-application-mode>false</show-application-mode>
+37. </portlet-application>
+38. </page>
+39. </page-set>
+</programlisting>
+ </example>
+ <para>
+ Note that
+ <code>page-just-added</code>
+ navigation node and the related pages are visible to all portal visitors (signed in or anonymous) due to
+ <code><access-permissions></code>
+ set to
+ <code>Everyone</code>
+ in the above file.
+ </para>
+ </section>
+ <section id="Adding_Navigation_Node_Group_Navigation">
+ <title>Adding a Navigation Node to a Group Navigation</title>
+ <para>
+ To add a new navigation node visible to the members of
+ <code>/platform/administrators</code>
+ group we need to create a
+ <code>navigation.xml</code>
+ file located in
+ <code>war/src/main/webapp/WEB-INF/conf/sample-ext/portal/group/platform/administrators/navigation.xml</code>
+ . Note that the name of the user group
+ <code>/platform/administrators</code>
+ is a part of the path.
+ </para>
+ <example>
+ <title>navigation.xml of /platform/administrators group</title>
+ <programlisting>
+19. <node-navigation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+20. xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3" xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_3">
+21. <!-- Priority is currently ignored for importMode merge. But it is required. See GTNPORTAL-2751 -->
+22. <priority>1</priority>
+23.
+24. <page-nodes>
+25. <node>
+26. <name>admins-sitemap</name>
+27. <!--
+28. #{platform.administrators.adminsSitemap} is place holder for an internationalized string.
+29. See WEB-INF/classes/locale/navigation/group/platform/administrators_en.properties
+30. -->
+31. <label>#{platform.administrators.adminsSitemap}</label>
+32. <page-reference>group::/platform/administrators::adminsSitemap</page-reference>
+33. </node>
+34. </page-nodes>
+35. </node-navigation>
+</programlisting>
+ </example>
+ <para>
+ The navigation node
+ <code>admins-sitemap</code>
+ refers to
+ <code>adminsSitemap</code>
+ page defined in the sibling
+ <code>pages.xml</code>
+ file:
+ </para>
+ <example>
+ <title>pages.xml of /platform/administrators group</title>
+ <programlisting>
+19. xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_3">
+20. <!--
+21. adminsSitemap page contains just SiteMapPortlet. There is nothing special about it.
+22. It is here just to demonstrate the adding of nodes to group navigation in the sibling
+23. navigation.xml file.
+24. -->
+25. <page>
+26. <name>adminsSitemap</name>
+27. <title>Admins' Sitemap</title>
+28. <access-permissions>*:/platform/administrators</access-permissions>
+29. <edit-permission>*:/platform/administrators</edit-permission>
+30. <portlet-application>
+31. <portlet>
+32. <application-ref>web</application-ref>
+33. <portlet-ref>SiteMapPortlet</portlet-ref>
+34. </portlet>
+35. <title>Sitemap</title>
+36. <access-permissions>*:/platform/administrators</access-permissions>
+37. <show-info-bar>false</show-info-bar>
+38. </portlet-application>
+39. </page>
+40. </page-set>
+</programlisting>
+ </example>
+ </section>
+ <section id="Adding_Navigation_Node_User_Navigation">
+ <title>Adding a Navigation Node to a User Navigation</title>
+ <para>
+ To add a new navigation node visible to a particular user, say
+ <code>root</code>
+ we need to create a
+ <code>navigation.xml</code>
+ file located in
+ <code>war/src/main/webapp/WEB-INF/conf/sample-ext/portal/user/root/navigation.xml</code>
+ . Note that the name of the user
+ <code>root</code>
+ is a part of the path.
+ </para>
+ <example>
+ <title>navigation.xml of user root</title>
+ <programlisting>
+19. <node-navigation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+20. xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3" xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_3">
+21. <!-- Priority has no significance in user navigations. But it is required. See GTNPORTAL-2751 -->
+22. <priority>1</priority>
+23.
+24. <page-nodes>
+25. <node>
+26. <name>roots-extra-dashboard</name>
+27. <label>#{user.root.RootsExtraDashboard}</label>
+28. <page-reference>user::root::roots-dashboard</page-reference>
+29. </node>
+30. </page-nodes>
+31. </node-navigation>
+</programlisting>
+ </example>
+ <para>
+ The navigation node
+ <code>roots-extra-dashboard</code>
+ refers to
+ <code>roots-dashboard</code>
+ page defined in the sibling
+ <code>pages.xml</code>
+ file:
+ </para>
+ <example>
+ <title>pages.xml of user root</title>
+ <programlisting>
+19. <page-set xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_3 http://www.gatein.org/xml/ns/gatein_objects_1_3"
+20. xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_3">
+21. <!--
+22. roots-dashboard page contains just DashboardPortlet. There is nothing special about it.
+23. It is here just to demonstrate the adding of nodes to user navigation in the sibling
+24. navigation.xml file.
+25. -->
+26. <page>
+27. <name>roots-dashboard</name>
+28. <title>Root's Extra Dashboard</title>
+29. <access-permissions>*:/platform/users</access-permissions>
+30. <edit-permission>*:/platform/administrators</edit-permission>
+31. <portlet-application>
+32. <portlet>
+33. <application-ref>dashboard</application-ref>
+34. <portlet-ref>DashboardPortlet</portlet-ref>
+35. </portlet>
+36. <title>Root's Extra Dashboard</title>
+37. <access-permissions>*:/platform/users</access-permissions>
+38. <show-info-bar>false</show-info-bar>
+39. </portlet-application>
+40. </page>
+41. </page-set>
+42.
+</programlisting>
+ </example>
+ </section>
+ <section id="Internationalization_Navigation_Nodes">
+ <title>Internationalization of Navigation Nodes</title>
+ <para>
+ As you can see in the above
+ <code>navigation.xml</code>
+ files the labels of navigation nodes can be internationalized. The files containing translation resources live under
+ <code>war/src/main/webapp/WEB-INF/classes/locale/navigation</code>
+ . The directory layout is similar to the one used for
+ <code>navigation.xml</code>
+ and
+ <code>pages.xml</code>
+ files:
+ </para>
+ <para>
+ Note that the navigation resource bundles also need to be named in
+ <code>init.resources</code>
+ parameter of
+ <code>BaseResourceBundlePlugin</code>
+ in
+ <code>war/src/main/webapp/WEB-INF/conf/sample-ext/common/common-configuration.xml</code>
+ :
+ </para>
+ <example>
+ <title>common-configuration.xml containing declarations of navigation resource bundles</title>
+ <programlisting>
+19. <configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+20. xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd">
+21. <external-component-plugins>
+22. <!-- The full qualified name of the ResourceBundleService -->
+23. <target-component>org.exoplatform.services.resources.ResourceBundleService</target-component>
+24. <component-plugin>
+25. <!-- The name of the plugin -->
+26. <name>Sample ResourceBundle Plugin</name>
+27. <!-- The name of the method to call on the ResourceBundleService in order to register the ResourceBundles -->
+28. <set-method>addResourceBundle</set-method>
+29. <!-- The full qualified name of the BaseResourceBundlePlugin -->
+30. <type>org.exoplatform.services.resources.impl.BaseResourceBundlePlugin</type>
+31. <init-params>
+32. <values-param>
+33. <name>init.resources</name>
+34. <description>Initiate the following resources during the first launch.</description>
+35. <value>locale.portal.extension</value>
+36. <value>locale.navigation.user.root</value>
+37. <!--
+38. Note that we actually do not need to name locale.navigation.portal.classic and
+39. locale.navigation.group.platform.administrators here as they are in init.resources
+40. of the default GateIn installation. But it makes no harm to include them once again here.
+41. -->
+42. <value>locale.navigation.portal.classic</value>
+43. <value>locale.navigation.group.platform.administrators</value>
+44. </values-param>
+45. <values-param>
+</programlisting>
+ </example>
+ </section>
</section>
-
- <section id="sid-8094158">
- <title>Visual identity</title>
-
- <para>
+ <section id="Custom_Internationalization_Resource_Bundles">
+ <title>Custom Internationalization Resource Bundles</title>
+ <para>
+ This section mentions code from the Portal Extension Examples available for download from <ulink url="https://access.redhat.com/"/>. as part of your JBoss Portal Platform subscription.
+ </para>
+ <para>There are two resource bundle customization scenarios possible with a Portal Extension:</para>
+ <itemizedlist>
+ <listitem>
+ <para>to add new resource bundle items to the ones available in default GateIn Portal installation and</para>
+ </listitem>
+ <listitem>
+ <para>to assign new values to resource bundle items available in default GateIn Portal installation</para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Both scenarios can be demonstrated on
+ <code>locale.portal.extension</code>
+ resource bundle. To use this bundle we need to include it in both
+ <code>init.resources</code>
+ and
+ <code>portal.resource.names</code>
+ parameters of
+ <code>BaseResourceBundlePlugin</code>
+ in
+ <code>war/src/main/webapp/WEB-INF/conf/sample-ext/common/common-configuration.xml</code>
+ :
+ </para>
+ <example>
+ <title>common-configuration.xml containing declarations of navigation resource bundles</title>
+ <programlisting>
+19. <configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+20. xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd">
+21. <external-component-plugins>
+22. <!-- The full qualified name of the ResourceBundleService -->
+23. <target-component>org.exoplatform.services.resources.ResourceBundleService</target-component>
+24. <component-plugin>
+25. <!-- The name of the plugin -->
+26. <name>Sample ResourceBundle Plugin</name>
+27. <!-- The name of the method to call on the ResourceBundleService in order to register the ResourceBundles -->
+28. <set-method>addResourceBundle</set-method>
+29. <!-- The full qualified name of the BaseResourceBundlePlugin -->
+30. <type>org.exoplatform.services.resources.impl.BaseResourceBundlePlugin</type>
+31. <init-params>
+32. <values-param>
+33. <name>init.resources</name>
+34. <description>Initiate the following resources during the first launch.</description>
+35. <value>locale.portal.extension</value>
+36. <value>locale.navigation.user.root</value>
+37. <!--
+38. Note that we actually do not need to name locale.navigation.portal.classic and
+39. locale.navigation.group.platform.administrators here as they are in init.resources
+40. of the default GateIn installation. But it makes no harm to include them once again here.
+41. -->
+42. <value>locale.navigation.portal.classic</value>
+43. <value>locale.navigation.group.platform.administrators</value>
+44. </values-param>
+45. <values-param>
+46. <name>portal.resource.names</name>
+47. <description>These resources are merged to a single resource bundle which is accessible from anywhere
+48. in GateIn. All these keys are located in the same bundle, which is separated from the navigation
+49. resource bundles.</description>
+50. <value>locale.portal.extension</value>
+51. </values-param>
+52. </init-params>
+53. </component-plugin>
+54. </external-component-plugins>
+55. </configuration>
+</programlisting>
+ </example>
+ <para>
+ The English version of
+ <code>locale.portal.extension</code>
+ can be found under
+ <code>war/src/main/webapp/WEB-INF/classes/locale/portal/extension_en.properties</code>
+ :
+ </para>
+ <example>
+ <title>English version of locale.portal.extension</title>
+ <programlisting>
+17. UIHomePagePortlet.Label.Slogan=Congratulations!
+18. UIHomePagePortlet.Label.SubSlogan=You have just installed the GateIn Portal Extension
+19. UIHomePagePortlet.Label.Title=Sign in as:
+</programlisting>
+ </example>
+ <para>
+ <code>UIHomePagePortlet.Label.SubSlogan</code>
+ is a new key which is not available in default GateIn Portal installation.
+ </para>
+ <para>
+ However,
+ <code>UIHomePagePortlet.Label.Slogan</code>
+ is redefined in
+ <code>extension_en.properties</code>
+ shown above. In
+ <code>gatein.ear/web.war/WEB-INF/classes/locale/portlet/web/GroovyPortlet_en.properties</code>
+ it is already defined as
+ </para>
+ <programlisting>UIHomePagePortlet.Label.Slogan=The Best of eXo and JBoss Portal<div>GateIn #{gatein.version}</div></programlisting>
+ <para>
+ and here, within the Portal Extension we assign a new value
+ <code>Congratulations!</code>
+ to it.
+ </para>
+ <para>
+ Please refer to the
+ <link linkend="Adding_Navigation_Node_Group_Navigation">previous section</link>
+ for more details on internationalization of navigation nodes.
+ </para>
+ </section>
+ <section id="Custom_Sign_In_Page">
+ <title>Custom Sign in Page</title>
+ <para>When accessing a page that requires privileges, a Sign in page is shown and it can be customized by using an extension. To do so, it would be enough to copy the file located at:</para>
+ <example>
+ <title>Login JSP</title>
+ <programlisting>
+gatein.ear/portal.war/login/jsp/login.jsp
+</programlisting>
+ </example>
+ <para>and include it in a portal extension such as myExtension.ear/myWar.war/login/jsp/login.jsp</para>
+ <para>All the logic must be carefully kept in the login page so that the portal will keep working as it should.</para>
+ <para>To modify the modal window which pops up when the user decides to sign-in, the extension would have a modified copy of:</para>
+ <example>
+ <title>Login Form</title>
+ <programlisting>
+gatein.ear/portal.war/groovy/portal/webui/UILoginForm.gtmpl
+</programlisting>
+ </example>
+ </section>
+ </section>
+ </section>
+ <section id="Visual_Identity">
+ <title>Visual identity</title>
+ <para>
A portal visual identity is made of HTML produced as a result of portal aggregation (the components that make a page like columns and rows combined with the content produced by the portlets) and associated CSS files.
</para>
-
- <para>
+ <para>
JBoss Portal Platform allows to deploy multiple skins consisting of CSS files, which makes it possible to apply styling to the page compositions and components of a page (portlets). Different skins can be applied to the different websites, also if made available to the users, they can choose their preferred skin.
</para>
-
- <section id="sid-8094158_GDG-Visualidentity-Customizingtheloginpage">
- <title>Customizing the login page</title>
-
- <para>
+ <section id="Customizing_Login_Page">
+ <title>Customizing the login page</title>
+ <para>
When accessing a page that requires privileges, a login page is shown and it can be customized by using an extension. To do so, it would be enough to copy the file located at:
</para>
-
- <example>
- <title>Login JSP</title>
-<programlisting>gatein.ear/02portal.war/login/jsp/login.jsp</programlisting>
- </example>
-
- <para>
+ <example>
+ <title>Login JSP</title>
+ <programlisting>gatein.ear/02portal.war/login/jsp/login.jsp</programlisting>
+ </example>
+ <para>
and include it in a portal extension such as myExtension.ear/myWar.war/login/jsp/login.jsp
</para>
-
- <para>
+ <para>
All the logic must be carefully kept in the login page so that the portal will keep working as it should.
</para>
-
- <para>
+ <para>
To modify the modal window which pops up when the user decides to sign-in, the extension would have a modified copy of:
</para>
-
- <example>
- <title>Login Form</title>
-<programlisting>gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</programlisting>
- </example>
- </section>
- </section>
- </chapter>
+ <example>
+ <title>Login Form</title>
+ <programlisting>gatein.ear/02portal.war/groovy/portal/webui/UILoginForm.gtmpl</programlisting>
+ </example>
+ </section>
+ </section>
+</chapter>
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/Kinds+of+Navigation.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/Kinds+of+Navigation.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/complexinfra.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/complexinfra.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-local-index.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-local-index.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-shared-index.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-shared-index.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-standalone-index.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/diagram-standalone-index.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/navigation-bar.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/navigation-bar.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/portalExtensions.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/portalExtensions.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/portalextensionstructure.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/portalextensionstructure.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: epp/docs/branches/6.0/Developer_Guide/en-US/images/simpleinfra.png
===================================================================
(Binary files differ)
Property changes on: epp/docs/branches/6.0/Developer_Guide/en-US/images/simpleinfra.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
11 years, 11 months
- 1
- 0
gatein SVN: r9063 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2013-01-17 23:45:43 -0500 (Thu, 17 Jan 2013)
New Revision: 9063
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-6-GDG_JavaScript_Development.xml
Log:
Initial edits to new JavaScript Development content from Confluence
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-6-GDG_JavaScript_Development.xml
===================================================================
(Binary files differ)
11 years, 11 months
- 1
- 0
gatein SVN: r9062 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-01-17 23:04:42 -0500 (Thu, 17 Jan 2013)
New Revision: 9062
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
Log:
Replaced instance of 'GateIn Portal' with 'JBoss Portal Platform'
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-18 01:49:30 UTC (rev 9061)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-18 04:04:42 UTC (rev 9062)
@@ -43,14 +43,14 @@
<title>The BOM Concept</title>
<para>
- To make the management of dependencies easier, GateIn Portal Team has prepared the Bill of Materials (BOM) needed for developing typical portlet applications. BOM is a Maven
+ To make the management of dependencies easier, JBoss Portal Platform Team has prepared the Bill of Materials (BOM) needed for developing typical portlet applications. BOM is a Maven
<code>pom.xml</code>
- file which specifies the versions, types and scopes of dependencies which are granted to be compatible with (or indeed in many cases provided by) GateIn Portal.
+ file which specifies the versions, types and scopes of dependencies which are granted to be compatible with (or indeed in many cases provided by) JBoss Portal Platform.
</para>
</section>
<section id="sid-55378991_StartingaPortletProject-HowtoUseBOM">
- <title>How to Use GateIn Portal BOM</title>
+ <title>How to Use JBoss Portal Platform BOM</title>
<remark>FIXME: Link to Quickstarts section when it's available</remark>
<para>
Let us look at the
@@ -129,7 +129,7 @@
Define the version of GateIn we build for. In its dependencyManagement,
GateIn Bill of Materials (BOM) specifies the versions, types and scopes
of dependencies which are granted to be compatible with (or indeed
- in many cases provided by) GateIn Portal.
+ in many cases provided by) JBoss Portal Platform.
-->
<dependency>
<groupId>org.jboss.bom</groupId>
@@ -355,7 +355,7 @@
<title>JSF2 Portlet Development</title>
<para>
- The Portlet Bridge pre-installed in GateIn Portal allows for implementing portlets with JavaServer Faces (JSF) 2.1 and RichFaces (RF) 4.2.3. As RichFaces is just a component library for JavaServer Faces, the guidelines for using both of them is very similar. More precisely, setup for a JavaServer Faces portlet project is a superset of a RichFaces project setup. In accordance with that, you need to read both
+ The Portlet Bridge pre-installed in JBoss Portal Platform allows for implementing portlets with JavaServer Faces (JSF) 2.1 and RichFaces (RF) 4.2.3. As RichFaces is just a component library for JavaServer Faces, the guidelines for using both of them is very similar. More precisely, setup for a JavaServer Faces portlet project is a superset of a RichFaces project setup. In accordance with that, you need to read both
<xref linkend="sid-55477016"/>
and
<xref linkend="sid-55477018"/>
@@ -371,7 +371,7 @@
<remark>FIXME: Link to Quickstarts section when it's available</remark>
<para>
This section cites code from JSF2 Hello World Portlet from the
- link linkend="sid-55378941">GateIn Portal Quickstarts/link
+ link linkend="sid-55378941">JBoss Portal Platform Quickstarts/link
collection.
</para>
<section id="sid-55477016_BasicJSFPortletDevelopment-pom.xml">
@@ -761,7 +761,7 @@
<remark>FIXME: Link to Quickstarts section when it's available</remark>
<para>
This section cites code from JSF2+RF4 Hello World Portlet from the
- link linkend="sid-55378941">GateIn Portal Quickstarts/link
+ link linkend="sid-55378941">JBoss Portal Platform Quickstarts/link
collection.
</para>
<section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-pom.xml">
@@ -1125,7 +1125,7 @@
<title>Building and Deploying Portlets</title>
<orderedlist>
<listitem>
- <para>Make sure you have your GateIn Portal instance is running.</para>
+ <para>Make sure you have your JBoss Portal Platform instance is running.</para>
</listitem>
<listitem>
<para>Open a command line and navigate to the root directory of your portlet project.</para>
11 years, 11 months
- 1
- 0
gatein SVN: r9061 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-01-17 20:49:30 -0500 (Thu, 17 Jan 2013)
New Revision: 9061
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
Log:
Source URL: https://docs.jboss.org/author/display/GTNPORTAL35/GDG-Application+develop... Incorporated raw docs from Confluence wiki
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-18 00:12:20 UTC (rev 9060)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-18 01:49:30 UTC (rev 9061)
@@ -5,8 +5,8 @@
<section id="sid-819807">
<title>Gadget Development</title>
<section id="sid-819807_GDG-GadgetDevelopment-Introduction">
+ <title>Introduction</title>
<remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/GDG-Portlet+Development, incorporated changes up to version 10</remark>
- <title>Introduction</title>
<para>
In the context of JBoss Portal Platform, gadgets are defined by the Google OpenSocial specifications. Since JBoss Portal Platform &VY;, the portal framework includes Apache Shindig 2.0 which is made to support the version 0.9 and 1.0 of OpenSocial.
</para>
@@ -30,11 +30,1144 @@
<section id="sid-819805">
<title>Portlet Development</title>
<para>
- JBoss Enterprise Portal interface is fully customizable with applications called portlets. Application development can be done by using the plain Portlet specification JSR-286 (refer to the "Portlet Primer" chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JavaServerFaces (JSF), RichFaces or Seam (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Portal Platform Reference Guide).
+ JBoss Enterprise Portal interface is fully customizable with applications called portlets. Application development can be done by using the plain Portlet specification JSR286 (refer to the "Portlet Primer" chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JavaServerFaces (JSF), RichFaces or Seam (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Portal Platform Reference Guide).
</para>
<remark>FIXME: Insert link to "[Starting a Portlet Project]"</remark>
<para>
Whichever technology you choose, refer to [Starting a Portlet Project] to learn how to set up your project in a robust and effective way using the JBoss Portal Platform Bill of Materials (BOM).
</para>
- </section>
+ <section id="sid-55378991">
+
+ <title>Starting a Portlet Project</title>
+ <section id="sid-55378991_StartingaPortletProject-TheBOMConcept">
+
+ <title>The BOM Concept</title>
+ <para>
+ To make the management of dependencies easier, GateIn Portal Team has prepared the Bill of Materials (BOM) needed for developing typical portlet applications. BOM is a Maven
+ <code>pom.xml</code>
+ file which specifies the versions, types and scopes of dependencies which are granted to be compatible with (or indeed in many cases provided by) GateIn Portal.
+ </para>
+ </section>
+ <section id="sid-55378991_StartingaPortletProject-HowtoUseBOM">
+
+ <title>How to Use GateIn Portal BOM</title>
+ <remark>FIXME: Link to Quickstarts section when it's available</remark>
+ <para>
+ Let us look at the
+ <code>pom.xml</code>
+ file from Simplest Hello World
+ link linkend="sid-55378941">Quickstart/link
+ below, which contains all necessary details.
+ </para>
+ <para>
+ In its
+ <code><dependencyManagement></code>
+ section, it declares
+ <code><dependency></code>
+ <code>gatein-3.5-bom</code>
+ with
+ <code><scope></code>
+ <code>import</code>
+ . It indicates that the dependency will
+ <emphasis role="italics">de facto</emphasis>
+ be replaced with the dependencies in its
+ <code>dependencyManagement</code>
+ section. Due to this fact, in the
+ <code><dependencies></code>
+ section of the Simplest Hello World
+ <code>pom.xml</code>
+ , we can declare the
+ <code>javax.portlet:portlet-api</code>
+ dependency without specifying its
+ <code><version></code>
+ ,
+ <code><type></code>
+ or
+ <code><scope></code>
+ . All those details are managed by
+ <code>gatein-3.5-bom</code>
+ .
+ </para>
+ <example>
+ <title>Simplest Hello World Portlet</title>
+ <programlisting>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>simplest-hello-world-portlet</artifactId>
+ <groupId>org.gatein.portal.quickstarts</groupId>
+ <name>Simplest Hello World Portlet</name>
+ <version>3.5.0.Final</version>
+ <packaging>war</packaging>
+ <description>The very essence of every possible portlet.</description>
+ <url>http://www.gatein.org</url>
+ <licenses>
+ <license>
+ <name>Apache License, Version 2.0</name>
+ <distribution>repo</distribution>
+ <url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
+ </license>
+ </licenses>
+
+ <properties>
+ <!-- GateIn Bill of Materials (BOM) version -->
+ <org.jboss.bom.gatein-bom.version>1.0.0.Final</org.jboss.bom.gatein-bom.version>
+
+ <!-- Plugin versions and settings -->
+ <jboss.as.plugin.version>7.1.1.Final</jboss.as.plugin.version>
+ <!-- maven-compiler-plugin -->
+ <maven.compiler.plugin.version>2.5.1</maven.compiler.plugin.version>
+ <maven.compiler.target>1.6</maven.compiler.target>
+ <maven.compiler.source>1.6</maven.compiler.source>
+ <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+ </properties>
+
+ <dependencyManagement>
+ <dependencies>
+ <!--
+ Define the version of GateIn we build for. In its dependencyManagement,
+ GateIn Bill of Materials (BOM) specifies the versions, types and scopes
+ of dependencies which are granted to be compatible with (or indeed
+ in many cases provided by) GateIn Portal.
+ -->
+ <dependency>
+ <groupId>org.jboss.bom</groupId>
+ <artifactId>gatein-3.5-bom</artifactId>
+ <version>${org.jboss.bom.gatein-bom.version}</version>
+ <type>pom</type>
+ <scope>import</scope>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+
+ <dependencies>
+ <!--
+ The versions, scopes and types of these dependencies are managed in gatein-*-bom.
+ You need to name only groupId and artifactId here.
+ Name only those artifacts you refer to in your code.
+ Look at gatein-*-bom POM file for the complete list of available artifacts.
+ -->
+ <dependency>
+ <groupId>javax.portlet</groupId>
+ <artifactId>portlet-api</artifactId>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <finalName>${project.artifactId}</finalName>
+ <plugins>
+ <plugin>
+ <groupId>org.jboss.as.plugins</groupId>
+ <artifactId>jboss-as-maven-plugin</artifactId>
+ <version>${jboss.as.plugin.version}</version>
+ </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>${maven.compiler.plugin.version}</version>
+ <configuration>
+ <source>${maven.compiler.source}</source>
+ <target>${maven.compiler.target}</target>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+</programlisting>
+ </example>
+ <para>
+ Further steps, after you have set up the
+ <code>pom.xml</code>
+ file for your project, depend on the technology you have chosen for writing portlets.
+ </para>
+ </section>
+ </section>
+ <section id="sid-55477012">
+
+ <title>Standard Portlet Development (JSR286)</title>
+ <section id="sid-55477012_StandardPortletDevelopmentJSR286-TheJavaPart">
+
+ <title>The Java Part</title>
+ <remark>FIXME: Link to Quickstarts section when it's available</remark>
+ <para>
+ After setting up the the Maven
+ <code>pom.xml</code>
+ file as shown in the
+ <link linkend="sid-55378991">previous section</link>
+ , we can continue with implementing a basic JSR286 compatible portlet. Simplest Hello World Portlet from the
+ link linkend="sid-55378941">GateIn Quickstarts/link
+ collection shows the very essence of every JSR286 Portlet:
+ </para>
+ <example>
+ <title>SimplestHelloWorldPortlet.java</title>
+ <programlisting>
+package org.jboss.portal.portlet.samples;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+
+import javax.portlet.GenericPortlet;
+import javax.portlet.RenderRequest;
+import javax.portlet.RenderResponse;
+
+/**
+ * The simplest posible Portlet.
+ *
+ * @author Peter Palaga
+ */
+public class SimplestHelloWorldPortlet extends GenericPortlet {
+ /**
+ * Serves the VIEW mode. Writes "Hello World !" to the response writer.
+ *
+ * @see javax.portlet.GenericPortlet#doView(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
+ */
+ @Override
+ public void doView(RenderRequest request, RenderResponse response) throws IOException {
+ PrintWriter writer = response.getWriter();
+ writer.write("Hello World !");
+ writer.close();
+ }
+}
+</programlisting>
+ </example>
+ <para>As you can see in the listing, we have done two important things:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ We extended
+ <code>javax.portlet.GenericPortlet</code>
+ from
+ <code>javax.portlet:portlet-api</code>
+ artifact.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ We have overriden the
+ <code>doView()</code>
+ method.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ In this simplest portlet variant we have decided not to support EDIT and HELP portlet modes. To add them, just override the
+ <code>doEdit()</code>
+ and
+ <code>doHelp</code>
+ from
+ <code>javax.portlet.GenericPortlet</code>
+ and configure the
+ <code>portlet.xml</code>
+ file accordingly.
+ </para>
+ </section>
+ <section id="sid-55477012_StandardPortletDevelopmentJSR286-portlet.xml">
+
+ <title>portlet.xml</title>
+ <para>
+ The
+ <code>portlet.xml</code>
+ file for a plain JSR286 portlet is pretty straigtforward:
+ </para>
+ <example>
+ <title>portlet.xml</title>
+ <programlisting>
+<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" version="2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">
+ <portlet>
+ <description>Simplest Hello World Portlet is the very essence of every possible Portlet.</description>
+ <portlet-name>SimplestHelloWorldPortlet</portlet-name>
+ <display-name>Simplest Hello World Portlet</display-name>
+ <portlet-class>org.jboss.portal.portlet.samples.SimplestHelloWorldPortlet</portlet-class>
+ <supports>
+ <mime-type>text/html</mime-type>
+ <portlet-mode>view</portlet-mode>
+ <!-- You can uncomment the other modes when your portlet-class supports them
+ <portlet-mode>edit</portlet-mode>
+ <portlet-mode>help</portlet-mode>
+ -->
+ </supports>
+ <portlet-info>
+ <title>Simplest Hello World Portlet</title>
+ </portlet-info>
+ </portlet>
+</portlet-app>
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477012_StandardPortletDevelopmentJSR286-web.xml">
+
+ <title>web.xml</title>
+ <para>
+ There is no need to configure any filters, servlets, mapping & co. for a plain JSR286 portlet to work but maven-war-plugin by default requires the
+ <code>web.xml</code>
+ . To solve it, just include a
+ <code>web.xml</code>
+ file which contains solely the root element like the following:
+ </para>
+ <example>
+ <title>web.xml</title>
+ <programlisting>
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+ version="2.5">
+ <!--
+ There is no need to configure any filters, servlets, mapping & co. for this demo to work
+ but maven-war-plugin by default requires this file.
+ -->
+</web-app>
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477012_StandardPortletDevelopmentJSR286-FurtherSteps">
+
+ <title>Further Steps</title>
+ <para>
+ After having done all the above, it is time to
+ <link linkend="sid-55379158">build and deploy the portlet</link>
+ ,
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264662">import it</ulink>
+ and
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264655">add it to a page</ulink>
+ so that you can test its functionality.
+ </para>
+ </section>
+ <section id="sid-55477012_StandardPortletDevelopmentJSR286-Seealso">
+
+ <title>See also</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264602">Portlet Primer</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="http://jcp.org/en/jsr/detail?id=286">JSR286</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+ <section id="sid-55477014">
+
+ <title>JSF2 Portlet Development</title>
+ <para>
+ The Portlet Bridge pre-installed in GateIn Portal allows for implementing portlets with JavaServer Faces (JSF) 2.1 and RichFaces (RF) 4.2.3. As RichFaces is just a component library for JavaServer Faces, the guidelines for using both of them is very similar. More precisely, setup for a JavaServer Faces portlet project is a superset of a RichFaces project setup. In accordance with that, you need to read both
+ <xref linkend="sid-55477016"/>
+ and
+ <xref linkend="sid-55477018"/>
+ when developing with RichFaces.
+ </para>
+ <section id="sid-55477016">
+
+ <title>Basic JSF Portlet Development</title>
+ <para>JSF stands for JavaServer Pages. The JSF version delivered by the built-in Portlet Bridge is 2.1.</para>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-ExampleCode">
+
+ <title>Example Code</title>
+ <remark>FIXME: Link to Quickstarts section when it's available</remark>
+ <para>
+ This section cites code from JSF2 Hello World Portlet from the
+ link linkend="sid-55378941">GateIn Portal Quickstarts/link
+ collection.
+ </para>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-pom.xml">
+
+ <title>pom.xml</title>
+ <para>
+ There is only one noticeable difference in
+ <code>pom.xml</code>
+ against what we have shown as a general case in the
+ <xref linkend="sid-55378991"/>
+ section: We need to add different dependencies for JSF:
+ </para>
+ <example>
+ <title>pom.xml</title>
+ <programlisting>
+068. <dependencies>
+069. <!--
+070. The versions, scopes and types of these dependencies are managed in gatein-*-bom.
+071. You need to name only groupId and artifactId here.
+072. Name only those artifacts you refer to in your code.
+073. Look at gatein-*-bom POM file for the complete list of available artifacts.
+074. -->
+075. <dependency>
+076. <groupId>org.jboss.spec.javax.faces</groupId>
+077. <artifactId>jboss-jsf-api_2.1_spec</artifactId>
+078. </dependency>
+079. <dependency>
+080. <groupId>org.jboss.portletbridge</groupId>
+081. <artifactId>portletbridge-api</artifactId>
+082. </dependency>
+083. </dependencies>
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-JSFTemplateFiles">
+
+ <title>JSF Template Files</title>
+ <para>
+ In the following listing you can see the beginning of a typical JSF portlet template. It is taken from
+ <code>main.xhtml</code>
+ file located in
+ <code>src/main/webapp/pages</code>
+ directory.
+ </para>
+ <para>Code Snippet error: Read timed out.</para>
+ <para>
+ Note that
+ <code><f:view></code>
+ as a root element of the portlet template above prevents an erroneous
+ <code><html></code>
+ within
+ <code><body></code>
+ coming from portal. Moreover, the
+ <code><h:head></code>
+ and
+ <code><h:body></code>
+ elements are always needed for JSF Facelets to work.
+ </para>
+ <para>
+ The following listing shows the use of several JSF elements, such as
+ <code><h:outputLabel></code>
+ ,
+ <code><h:inputText></code>
+ and
+ <code><h:commandButton></code>
+ within
+ <code><h:form></code>
+ .
+ </para>
+ <para>Code Snippet error: Read timed out.</para>
+ <para>
+ The complete source code of the above template can be found in
+ <code>src/main/webapp/pages/main.xhtml</code>
+ of JSF2 Hello World Portlet project.
+ </para>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-JavaBeans">
+
+ <title>Java Beans</title>
+ <para>
+ In the JSF template file shown above, we refer to
+ <code>helloBean</code>
+ . This bean is implemented in Java as follows:
+ </para>
+ <informalexample>
+ <programlisting>
+26. /**
+27. * {@link HelloBean} is the JSF backing bean for the application, holding the input data to be re-displayed.
+28. */
+29. @ManagedBean(name = "helloBean")
+30. @SessionScoped
+31. public class HelloBean implements Serializable {
+32.
+33. private static final long serialVersionUID = -6239437588285327644L;
+34.
+35. /**
+36. * Stores the name which will be used to greet the application user.
+37. */
+38. private String name;
+39.
+40. /**
+41. * Initializes {@link #name} with the value {@code "World"}.
+42. */
+43. @PostConstruct
+44. public void postContruct() {
+45. this.name = "World";
+46. }
+47.
+48. /**
+49. * Returns {@link #name}.
+50. *
+51. * @return {@link #name}
+52. */
+53. public String getName() {
+54. return name;
+55. }
+56.
+57. /**
+58. * Set {@link #name}.
+59. *
+60. * @param name
+61. */
+62. public void setName(String name) {
+63. this.name = name;
+64. }
+65.
+66. /**
+67. * Resets {@link #name} to the default value {@code "World"}.
+68. *
+69. * @param ae ignored
+70. */
+71. public void reset(ActionEvent ae) {
+72. this.name = "World";
+73. }
+74.
+75. }
+</programlisting>
+ </informalexample>
+ <para>
+ The
+ <code>@ManagedBean</code>
+ and
+ <code>@SessionScoped</code>
+ annotations allow for omitting of equivalent declarations in the
+ <code>faces-config.xml</code>
+ file.
+ </para>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-portlet.xml">
+
+ <title>portlet.xml</title>
+ <para>portlet.xml is the place where we tie the JSF templates with the portlet.</para>
+ <example>
+ <title>portlet.xml</title>
+ <programlisting>
+<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" version="2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
+ http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">
+ <portlet>
+ <description>A simple JSF2 portlet.</description>
+ <portlet-name>jsf2HelloWorldPortlet</portlet-name>
+ <display-name>JSF2 Hello World Portlet</display-name>
+ <portlet-class>javax.portlet.faces.GenericFacesPortlet</portlet-class>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.view</name>
+ <value>/pages/main.xhtml</value>
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.edit</name>
+ <value>/pages/edit.xhtml</value>
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.help</name>
+ <value>/pages/help.xhtml</value>
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.preserveActionParams</name>
+ <value>true</value>
+ </init-param>
+ <expiration-cache>0</expiration-cache>
+ <supports>
+ <mime-type>text/html</mime-type>
+ <portlet-mode>VIEW</portlet-mode>
+ <portlet-mode>EDIT</portlet-mode>
+ <portlet-mode>HELP</portlet-mode>
+ </supports>
+ <portlet-info>
+ <title>JSF2 Hello World Portlet</title>
+ </portlet-info>
+ <container-runtime-option>
+ <name>org.gatein.pc.remotable</name>
+ <value>true</value>
+ </container-runtime-option>
+ </portlet>
+</portlet-app>
+
+
+</programlisting>
+ </example>
+ <para>
+ Note that the
+ <code>javax.portlet.faces.defaultViewId.*</code>
+ <code>init-params</code>
+ are used to bind the JSF templates with the respective portlet view modes.
+ <code>javax.portlet.faces.GenericFacesPortlet</code>
+ as a
+ <code><portlet-class></code>
+ will serve the purpose for most JSF portlets.
+ </para>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-web.xml">
+
+ <title>web.xml</title>
+ <para>
+ JSF portlets require a few tweaks in the
+ <code>web.xml</code>
+ file:
+ </para>
+ <example>
+ <title>web.xml</title>
+ <programlisting>
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">
+ <display-name>jsf2-hello-world-portlet</display-name>
+ <context-param>
+ <description>See https://docs.jboss.org/author/display/PBR/Render+Policy</description>
+ <param-name>javax.portlet.faces.RENDER_POLICY</param-name>
+ <param-value>ALWAYS_DELEGATE</param-value>
+ </context-param>
+
+ <!-- The following params are documented here: http://myfaces.apache.org/core21/myfaces-impl/webconfig.html -->
+ <context-param>
+ <param-name>javax.faces.FACELETS_VIEW_MAPPINGS</param-name>
+ <param-value>*.xhtml</param-value>
+ </context-param>
+ <context-param>
+ <param-name>facelets.DEVELOPMENT</param-name>
+ <param-value>false</param-value>
+ </context-param>
+ <context-param>
+ <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
+ <param-value>.xhtml</param-value>
+ </context-param>
+
+ <servlet>
+ <servlet-name>Faces Servlet</servlet-name>
+ <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
+ <load-on-startup>1</load-on-startup>
+ </servlet>
+ <servlet-mapping>
+ <servlet-name>Faces Servlet</servlet-name>
+ <url-pattern>*.faces</url-pattern>
+ </servlet-mapping>
+</web-app>
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-CustomCSS">
+
+ <title>Custom CSS</title>
+ <para>
+ Portlet Bridge supports loading of CSS resources in the "JSF way". Just use the
+ <code><h:outputStylesheet library="css" name="jsf2-hello-world-portlet.css" /></code>
+ as we do in the
+ <code>main.xhtml</code>
+ file above. The
+ <code>jsf2-hello-world-portlet.css</code>
+ file needs to be placed in
+ <code>resources/css</code>
+ folder of the web application.
+ </para>
+ <para>
+ Note that relative paths like
+ <code>url('css/background/jsf-logo.png')</code>
+ do not work when used in CSS loaded via
+ <code><h:outputStylesheet ...></code>
+ . Rather a JSF Expression Language expression
+ <code>#{resource['/css/background/jsf-logo.png']</code>
+ } needs to be used. This expression is dynamically evaluated to a proper public URL. The path
+ <code>'/css/background/jsf-logo.png'</code>
+ used in the expression is relative to
+ <code>resources</code>
+ folder of the web application. See also
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=51806374">Resource Serving</ulink>
+ .
+ </para>
+ <example>
+ <title>jsf2-hello-world-portlet.css</title>
+ <programlisting>
+17. div.jsf2HelloWorldPortlet {
+18. padding: 10px;
+19. /* In the following we use a JSF Expression Language expression rather then plain relative path.
+20. Plain relative paths do not work in JSF portlets. The expression #{resource['...']} is
+21. dynamically evaluated to a proper public URL. The path '/css/background/jsf-logo.png'
+22. used in the expression is relative to resources folder of this web application.
+23. See https://docs.jboss.org/author/display/PBR/Resource+Serving */
+24. background: url(#{resource['/css/background/jsf-logo.png']}) no-repeat;
+25. background-position-x: 753px;
+26. background-position-y: 10px;
+27. }
+28. div.jsf2HelloWorldPortlet p {
+29. width: 713px;
+30. }
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-Internationalization">
+
+ <title>Internationalization</title>
+ <para>
+ Internationalization is supported via standard Java Resource bundles. In our example project the
+ <code>*.property</code>
+ files of
+ <code>org.jboss.as.quickstarts.jsf.messages</code>
+ resource bundle are stored under
+ <code>src/main/resources/org/jboss/as/quickstarts/jsf</code>
+ . The following settings in
+ <code>faces-config.xml</code>
+ are needed so that this bundle can be used in JSF templates.
+ </para>
+ <example>
+ <title>faces-config.xml</title>
+ <programlisting>
+<faces-config xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-facesconfig_2_0.xsd" version="2.0">
+ <application>
+ <!-- Declare the internationalization resources -->
+ <resource-bundle>
+ <!-- The resource bundle property files are in src/main/resources/org/jboss/as/quickstarts/jsf -->
+ <base-name>org.jboss.as.quickstarts.jsf.messages</base-name>
+ <var>msgs</var>
+ </resource-bundle>
+ <locale-config>
+ <default-locale>en</default-locale>
+ <supported-locale>de</supported-locale>
+ </locale-config>
+ </application>
+</faces-config>
+</programlisting>
+ </example>
+ <para>
+ Note that in the above faces-config.xml, we have made our bundle visible in JSF templates under the variable
+ <code>msgs</code>
+ . Its individual entries can then be accessed using the usual Expression Language dot notation: e.g.
+ <code>#{msgs.Name</code>
+ }.
+ </para>
+ </section>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-FurtherSteps">
+
+ <title>Further Steps</title>
+ <para>
+ After having done all the above, it is time to
+ <link linkend="sid-55379158">build and deploy the portlet</link>
+ ,
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264662">import it</ulink>
+ and
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264655">add it to a page</ulink>
+ so that you can test its functionality.
+ </para>
+ </section>
+ <section id="sid-55477016_BasicJSFPortletDevelopment-Seealso">
+
+ <title>See also</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264602">Portlet Primer</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+ <section id="sid-55477018">
+
+ <title>JSF Portlet Development with RichFaces</title>
+ <para>
+ As we have already noted, RichFaces (RF) is just a component library for JavaServer Faces (JSF). Therefore, everything said in the
+ <xref linkend="sid-55477016"/>
+ chapter applies here too.
+ </para>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-ExampleCode">
+
+ <title>Example Code</title>
+ <remark>FIXME: Link to Quickstarts section when it's available</remark>
+ <para>
+ This section cites code from JSF2+RF4 Hello World Portlet from the
+ link linkend="sid-55378941">GateIn Portal Quickstarts/link
+ collection.
+ </para>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-pom.xml">
+
+ <title>pom.xml</title>
+ <para>We need to add several RF-specific dependencies to the general JSF ones:</para>
+ <example>
+ <title>pom.xml</title>
+ <programlisting>
+068. <dependencies>
+069. <!--
+070. The versions, scopes and types of these dependencies are managed in gatein-*-bom.
+071. You need to name only groupId and artifactId here.
+072. Name only those artifacts you refer to in your code.
+073. Look at gatein-*-bom POM file for the complete list of available artifacts.
+074. -->
+075. <!-- General JSF dependencies -->
+076. <dependency>
+077. <groupId>org.jboss.spec.javax.faces</groupId>
+078. <artifactId>jboss-jsf-api_2.1_spec</artifactId>
+079. </dependency>
+080. <dependency>
+081. <groupId>org.jboss.portletbridge</groupId>
+082. <artifactId>portletbridge-api</artifactId>
+083. </dependency>
+084.
+085. <!-- RF-sprecific dependencies -->
+086. <dependency>
+087. <groupId>org.jboss.portletbridge</groupId>
+088. <artifactId>portletbridge-extension-richfaces</artifactId>
+089. </dependency>
+090. <dependency>
+091. <groupId>org.richfaces.ui</groupId>
+092. <artifactId>richfaces-components-api</artifactId>
+093. </dependency>
+094. <dependency>
+095. <groupId>org.richfaces.ui</groupId>
+096. <artifactId>richfaces-components-ui</artifactId>
+097. </dependency>
+098. <dependency>
+099. <groupId>org.richfaces.core</groupId>
+100. <artifactId>richfaces-core-impl</artifactId>
+101. </dependency>
+102. </dependencies>
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-JSFTemplateFiles">
+
+ <title>JSF Template Files</title>
+ <para>
+ We use
+ <code><rich:*></code>
+ components in the templates:
+ </para>
+ <example>
+ <title>Form with rich: components in main.xhtml</title>
+ <programlisting>
+ </p>
+ <h:form id="jsf2HelloWorldPortlet">
+ <h:panelGrid columns="2">
+ <h:outputLabel value="#{msgs.Greeting}" for="greeting"/>
+ <rich:select id="greeting" value="#{helloBean.greeting}">
+ <f:selectItems value="#{helloBean.greetings}" />
+ <f:ajax render="output" event="selectitem"/>
+ </rich:select>
+
+ <h:outputLabel value="#{msgs.Name}" for="nameInput"/>
+ <h:inputText id="nameInput" value="#{helloBean.name}">
+ <f:validateLength minimum="1" maximum="50" />
+ <f:ajax render="output" event="keyup"/>
+ </h:inputText>
+ </h:panelGrid>
+ <p>
+ <h:panelGroup id="output">
+ <strong><h:outputText value="#{helloBean.greeting} #{helloBean.name}!" rendered="#{not empty helloBean.name}"/></strong>
+ </h:panelGroup>
+ </p>
+ <p>
+ <h:commandButton id="reset" value="#{msgs.Reset}" actionListener="#{helloBean.reset}">
+ <f:ajax render="@form" />
+ </h:commandButton> - #{msgs.ResetComment}
+ </p>
+ <p>
+ <h:commandButton id="reload" value="#{msgs.Reload}" /> - #{msgs.ReloadComment}
+ </p>
+</programlisting>
+ </example>
+ <para>The complete source code of the above template can be found in src/main/webapp/pages/main.xhtml of JSF2+RF4 Hello World Portlet quickstart.</para>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-JavaBeans">
+
+ <title>Java Beans</title>
+ <para>
+ The HelloBean presented in the
+ <xref linkend="sid-55477016"/>
+ chapter was extended firstly to provide a list of greeting phrases selectable in the drop-down box on the main.xhtml page and secondly to be able to store the greeting phrase selected in the drop-down box.
+ </para>
+ <example>
+ <title>HelloBean.java</title>
+ <programlisting>
+ /**
+ * Static list of greetings. Contains {@code "Hello"} and {@code "Hi"}.
+ */
+ private static final List<SelectItem> GREETINGS;
+
+ static {
+ List<SelectItem> l = new ArrayList<SelectItem>(2);
+ l.add(new SelectItem("Hello"));
+ l.add(new SelectItem("Hi"));
+ GREETINGS = Collections.unmodifiableList(l);
+ }
+
+ /**
+ * Stores the greeting phrase which will be used to greet the application user.
+ */
+ private String greeting;
+</programlisting>
+ </example>
+ <example>
+ <title>HelloBean.java</title>
+ <programlisting>
+ /**
+ * Returns {@link #greeting}.
+ *
+ * @return {@link #greeting}
+ */
+ public String getGreeting() {
+ return greeting;
+ }
+
+ /**
+ * Set {@link #greeting}.
+ *
+ * @param greeting
+ */
+ public void setGreeting(String greeting) {
+ this.greeting = greeting;
+ }
+
+ /**
+ * Returns {@link #GREETINGS}.
+ *
+ * @return {@link #GREETINGS}
+ */
+ public List<SelectItem> getGreetings() {
+ return GREETINGS;
+ }
+
+
+ /**
+ * Resets {@link #name} to the default value {@code "World"} and {@link #greeting} with the default value {@code "Hello"}.
+ *
+ * @param ae ignored
+ */
+ public void reset(ActionEvent ae) {
+ this.name = "World";
+ this.greeting = "Hello";
+ }
+
+ }
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-portlet.xml">
+
+ <title>portlet.xml</title>
+ <para>
+ There is no substantial change in portlet.xml against the
+ <xref linkend="sid-55477016"/>
+ chapter. Only
+ <code><description></code>
+ ,
+ <code><portlet-name></code>
+ ,
+ <code><display-name></code>
+ and
+ <code><title></code>
+ have been changed.
+ </para>
+ <example>
+ <title>portlet.xml</title>
+ <programlisting>
+<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd" version="2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
+ http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd">
+ <portlet>
+ <description>A simple portlet usinf JSF2 and RF4.</description>
+ <portlet-name>jsf2Rf4HelloWorldPortlet</portlet-name>
+ <display-name>JSF2+RF4 Hello World Portlet</display-name>
+ <portlet-class>javax.portlet.faces.GenericFacesPortlet</portlet-class>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.view</name>
+ <value>/pages/main.xhtml</value>
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.edit</name>
+ <value>/pages/edit.xhtml</value>
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.defaultViewId.help</name>
+ <value>/pages/help.xhtml</value>
+ </init-param>
+ <init-param>
+ <name>javax.portlet.faces.preserveActionParams</name>
+ <value>true</value>
+ </init-param>
+ <expiration-cache>0</expiration-cache>
+ <supports>
+ <mime-type>text/html</mime-type>
+ <portlet-mode>VIEW</portlet-mode>
+ <portlet-mode>EDIT</portlet-mode>
+ <portlet-mode>HELP</portlet-mode>
+ </supports>
+ <portlet-info>
+ <title>JSF2+RF4 Hello World Portlet</title>
+ </portlet-info>
+ <container-runtime-option>
+ <name>org.gatein.pc.remotable</name>
+ <value>true</value>
+ </container-runtime-option>
+ </portlet>
+</portlet-app>
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-web.xml">
+
+ <title>web.xml</title>
+ <para>
+ We set a few more
+ <code>init-params</code>
+ in web.xml for RichFaces components to work:
+ </para>
+ <example>
+ <title>web.xml</title>
+ <programlisting>
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">
+ <display-name>jsf2-rf4-hello-world-portlet</display-name>
+ <context-param>
+ <description>See https://docs.jboss.org/author/display/PBR/Installing+Portlet+Bridge#Insta...
+ <param-name>org.gatein.portletbridge.WAR_BUNDLES_PORTLETBRIDGE</param-name>
+ <param-value>true</param-value>
+ </context-param>
+ <context-param>
+ <description>See https://docs.jboss.org/author/display/PBR/Render+Policy</description>
+ <param-name>javax.portlet.faces.RENDER_POLICY</param-name>
+ <param-value>ALWAYS_DELEGATE</param-value>
+ </context-param>
+
+ <!-- The following params are documented here: http://myfaces.apache.org/core21/myfaces-impl/webconfig.html -->
+ <context-param>
+ <param-name>javax.faces.FACELETS_VIEW_MAPPINGS</param-name>
+ <param-value>*.xhtml</param-value>
+ </context-param>
+ <context-param>
+ <param-name>facelets.DEVELOPMENT</param-name>
+ <param-value>false</param-value>
+ </context-param>
+ <context-param>
+ <param-name>javax.faces.DEFAULT_SUFFIX</param-name>
+ <param-value>.xhtml</param-value>
+ </context-param>
+ <context-param>
+ <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
+ <param-value>server</param-value>
+ </context-param>
+ <context-param>
+ <param-name>javax.faces.PROJECT_STAGE</param-name>
+ <!-- Change to Production to compress js files, etc. -->
+ <param-value>Development</param-value>
+ </context-param>
+
+ <context-param>
+ <description>http://docs.jboss.org/richfaces/latest_4_X/Developer_Guide...
+ <param-name>org.richfaces.skin</param-name>
+ <param-value>#{skinBean.skin}</param-value>
+ </context-param>
+ <context-param>
+ <description>See http://docs.jboss.org/richfaces/latest_4_X/Developer_Guide/en-US/html/cha...
+ <param-name>org.richfaces.resourceOptimization.enabled</param-name>
+ <param-value>true</param-value>
+ </context-param>
+
+ <servlet>
+ <servlet-name>Faces Servlet</servlet-name>
+ <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
+ <load-on-startup>1</load-on-startup>
+ </servlet>
+ <servlet-mapping>
+ <servlet-name>Faces Servlet</servlet-name>
+ <url-pattern>*.faces</url-pattern>
+ </servlet-mapping>
+ <servlet-mapping>
+ <servlet-name>Faces Servlet</servlet-name>
+ <url-pattern>*.jsf</url-pattern>
+ </servlet-mapping>
+ <servlet-mapping>
+ <servlet-name>Faces Servlet</servlet-name>
+ <url-pattern>/faces/*</url-pattern>
+ </servlet-mapping>
+
+ <mime-mapping>
+ <extension>xcss</extension>
+ <mime-type>text/css</mime-type>
+ </mime-mapping>
+
+</web-app>
+</programlisting>
+ </example>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-CustomCSS">
+
+ <title>Custom CSS</title>
+ <para>
+ Fully analogous with
+ <link linkend="sid-55477016">plain JSF portlets</link>
+ .
+ </para>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-Internationalization">
+
+ <title>Internationalization</title>
+ <para>
+ Fully analogous with
+ <link linkend="sid-55477016">plain JSF portlets</link>
+ .
+ </para>
+ </section>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-FurtherSteps">
+
+ <title>Further Steps</title>
+ <para>
+ After having done all the above, it is time to
+ <link linkend="sid-55379158">build and deploy the portlet</link>
+ ,
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264662">import it</ulink>
+ and
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264655">add it to a page</ulink>
+ so that you can test its functionality.
+ </para>
+ </section>
+ <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-Seealso">
+
+ <title>See also</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="https://docs.jboss.org/author/pages/viewpage.action?pageId=54264602">Portlet Primer</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+ </section>
+ <section id="sid-55379158">
+
+ <title>Building and Deploying Portlets</title>
+ <orderedlist>
+ <listitem>
+ <para>Make sure you have your GateIn Portal instance is running.</para>
+ </listitem>
+ <listitem>
+ <para>Open a command line and navigate to the root directory of your portlet project.</para>
+ </listitem>
+ <listitem>
+ <para>Type this command to build and deploy the archive:</para>
+ <informalexample>
+ <programlisting>mvn clean package jboss-as:deploy</programlisting>
+ </informalexample>
+ <para>
+ To deploy to other than default
+ <code>localhost:9999</code>
+ JBoss instance, copy the following configuration
+
+ just after
+ <code><version>${jboss.as.plugin.version}</version></code>
+ in the
+ <code>pom.xml</code>
+ file and adjust it to suit your needs.
+
+ Note that
+ <code><username></code>
+ and
+ <code><password></code>
+ elements can be omitted sometimes, depending on your JBoss security settings.
+
+ </para>
+ <informalexample>
+ <programlisting><configuration>
+ <hostname>127.0.0.1</hostname>
+ <port>9999</port>
+ <username>admin</username>
+ <password>secret</password>
+</configuration></programlisting>
+ </informalexample>
+ <para>
+ This will deploy
+ <code>target/simplest-hello-world-portlet.war</code>
+ to the running instance of the portal.
+ </para>
+ </listitem>
+ </orderedlist>
+ </section>
+ </section>
</chapter>
11 years, 11 months
- 1
- 0
gatein SVN: r9060 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: smumford
Date: 2013-01-17 19:12:20 -0500 (Thu, 17 Jan 2013)
New Revision: 9060
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-6-GDG_JavaScript_Development.xml
Log:
Corrected build errors introduced to section IDs with GateIn/JBoss Portal Platform find/replace.
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-6-GDG_JavaScript_Development.xml
===================================================================
(Binary files differ)
11 years, 11 months
- 1
- 0
gatein SVN: r9059 - epp/docs/branches/6.0/Developer_Guide/en-US.
by do-not-reply＠jboss.org
Author: rdickens
Date: 2013-01-17 18:24:02 -0500 (Thu, 17 Jan 2013)
New Revision: 9059
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
Log:
https://docs.jboss.org/author/display/GTNPORTAL35/GDG-Portlet+Development, incorporated changes in Confluence wiki up to version 10
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml
===================================================================
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-17 05:03:33 UTC (rev 9058)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-17 23:24:02 UTC (rev 9059)
@@ -5,6 +5,7 @@
<section id="sid-819807">
<title>Gadget Development</title>
<section id="sid-819807_GDG-GadgetDevelopment-Introduction">
+ <remark>Source: https://docs.jboss.org/author/display/GTNPORTAL35/GDG-Portlet+Development, incorporated changes up to version 10</remark>
<title>Introduction</title>
<para>
In the context of JBoss Portal Platform, gadgets are defined by the Google OpenSocial specifications. Since JBoss Portal Platform &VY;, the portal framework includes Apache Shindig 2.0 which is made to support the version 0.9 and 1.0 of OpenSocial.
@@ -29,10 +30,11 @@
<section id="sid-819805">
<title>Portlet Development</title>
<para>
- JBoss Enterprise Portal interface is fully customized with applications called portlets. Application development can be done by using the plain Portlet specification JSR-286 (refer to the "Portlet Primer" chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JSF and/or RichFaces and/or Seam (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Portal Platform Reference Guide).
+ JBoss Enterprise Portal interface is fully customizable with applications called portlets. Application development can be done by using the plain Portlet specification JSR-286 (refer to the "Portlet Primer" chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portlet Bridge to write applications with JavaServerFaces (JSF), RichFaces or Seam (refer to the "Getting started with JBoss Portlet Bridge" chapter of the JBoss Portal Platform Reference Guide).
</para>
+ <remark>FIXME: Insert link to "[Starting a Portlet Project]"</remark>
<para>
- Depending on the complexity of the application and the familiarity of the team with JSF, one approach or the other can be the right choice for your team.
+ Whichever technology you choose, refer to [Starting a Portlet Project] to learn how to set up your project in a robust and effective way using the JBoss Portal Platform Bill of Materials (BOM).
</para>
</section>
</chapter>
11 years, 11 months
- 1
- 0