From do-not-reply at jboss.org Wed Jan 30 20:43:21 2013
Content-Type: multipart/mixed; boundary="===============7777528455595403229=="
MIME-Version: 1.0
From: do-not-reply at jboss.org
To: gatein-commits at lists.jboss.org
Subject: [gatein-commits] gatein SVN: r9101 -
epp/docs/branches/6.0/Developer_Guide/en-US.
Date: Wed, 30 Jan 2013 20:43:20 -0500
Message-ID: <201301310143.r0V1hKNF005661@svn01.web.mwc.hst.phx2.redhat.com>
--===============7777528455595403229==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Author: rdickens
Date: 2013-01-30 20:43:20 -0500 (Wed, 30 Jan 2013)
New Revision: 9101
Modified:
epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml
epp/docs/branches/6.0/Developer_Guide/en-US/appendix-Quickstarts.xml
epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_de=
velopment.xml
Log:
Added 'Quickstarts' appendix and minor cleanup of GateIn references and int=
radocument links
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2013-01=
-31 01:43:08 UTC (rev 9100)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/Developer_Guide.xml 2013-01=
-31 01:43:20 UTC (rev 9101)
@@ -12,5 +12,6 @@
+
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/appendix-Quickstarts.=
xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- epp/docs/branches/6.0/Developer_Guide/en-US/appendix-Quickstarts.xml 20=
13-01-31 01:43:08 UTC (rev 9100)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/appendix-Quickstarts.xml 20=
13-01-31 01:43:20 UTC (rev 9101)
@@ -2,17 +2,18 @@
=
- Appendix - Code Examples alias Quickstarts
- GateIn Portal Quickstarts provide small, specific, working examp=
les that can be used as a reference for your own project.
- GateIn Portal Quickstarts can be obtained in one of the followin=
g ways:
+ Appendix - Quickstarts
+ JBoss Portal Platform Quickstarts provide small, specific, worki=
ng examples that can be used as a reference for your own project.
+ The Quickstarts can be obtained in one of the following ways:
=
- 1. GateIn Portal Downloads Page
+ JBoss Portal Platform Downloads Page
+ Source: https://https://docs.jboss.org/author/display/GTNPOR=
TAL35/Appendix+-+Code+Examples+alias+Quickstarts, incorporated changes up t=
o version 3
- A ZIP file containing all Quickstarts can be downloaded from
- GateIn Portal Downloads page
+ A zip archive containing all Quickstarts can be downloaded from
+ JBoss Portal Platform Downloads page
.
@@ -20,7 +21,7 @@
=
- 2. JBoss Developer Studio or Eclipse with JBoss Tools
+ JBoss Developer Studio or Eclipse with JBoss Tools
@@ -31,7 +32,7 @@
In the New Project Example dialog, select the Site
- JBoss Community GateIn Portal Examples
+ JBoss Community JBoss Portal Platform Examples
from the drop down menu
@@ -52,11 +53,11 @@
=
- 3. GitHub
+ GitHubIssue the following commandgit clone https://github.com/gatein/gatein-portal-=
quickstart.git
- ... and switch to the branch compatible with your GateIn Porta=
l version.
+ ... and switch to the branch compatible with your JBoss Portal=
Platform version.
Modified: epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Applica=
tion_development.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_d=
evelopment.xml 2013-01-31 01:43:08 UTC (rev 9100)
+++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_d=
evelopment.xml 2013-01-31 01:43:20 UTC (rev 9101)
@@ -11,13 +11,13 @@
In the context of JBoss Portal Platform, gadgets are define=
d 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.
- Within a portal, it is possible to embed any OpenSocial gad=
get in a page or in a user's dashboard. Gadgets can be added to the ap=
plication registry and links can be added to the mini-composer (see the JBo=
ss Portal Platform User Guide).
+ Within a portal, it is possible to embed any OpenSocial gad=
get in a page or in a user's dashboard. Gadgets can be added to the ap=
plication registry and links can be added to the mini-composer (see the JBo=
ss Portal Platform User Guide).
Developing Gadgets
- OpenSocial gadgets are made of standard HTML and JavaScript=
. The container offers an API, the documentation for which is available
here .
+ OpenSocial gadgets are made of standard HTML and JavaScript=
. The container offers an API, the documentation for which is available at =
http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Ga=
dget.xml.
Note that, unlike portlets, a gadget has very little knowle=
dge of its context (the portal) and its integration within the portal may b=
e more limited (in terms of visual integration for instance).
@@ -30,11 +30,10 @@
Portlet Development
- JBoss Enterprise Portal interface is fully customizable with a=
pplications called portlets. Application development can be done by using t=
he plain Portlet specification JSR286 (refer to the "Portlet Primer&qu=
ot; chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portle=
t Bridge to write applications with JavaServerFaces (JSF), RichFaces or Sea=
m (refer to the "Getting started with JBoss Portlet Bridge" chapt=
er of the JBoss Portal Platform Reference Guide).
+ JBoss Portal Platform's interface is fully customizable with a=
pplications called portlets. Application development can be done by using t=
he plain Portlet specification JSR286 (refer to the "Portlet Primer&qu=
ot; chapter in the JBoss Portal Platform Reference Guide for more information), but it is also possible to use the JBoss Portle=
t Bridge to write applications with JavaServerFaces (JSF), RichFaces or Sea=
m (refer to the "Getting started with JBoss Portlet Bridge" chapt=
er of the JBoss Portal Platform Reference Guide).
- FIXME: Insert link to "[Starting a Portlet Project]"
- 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). =
+ Whichever technology you choose, refer to Starting a Portlet Project to learn how to set up your pr=
oject in a robust and effective way using the JBoss Portal Platform Bill of=
Materials (BOM).
=
@@ -49,9 +48,8 @@
=
How to Use JBoss Portal Platform BOM
- FIXME: Link to Quickstarts section when it's available=
remark>
- Let us look at the pom.xml file from Simplest Hel=
lo World link linkend=3D"sid-55378941">Quickstart/link below, which contain=
s all necessary details.
+ Let us look at the pom.xml file from Simplest Hel=
lo World Portket example below, which contains all necessary details.
In its <dependencyManagement> section, it d=
eclares =
@@ -64,7 +62,7 @@
Simplest Hello World Portlet
-
+
<project xmlns=3D"http://maven.apache.org/POM/4.0.0" xmlns:xsi=3D"http:=
//www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=3D"http://maven.apache.org/POM/4.0.0 http://maven.a=
pache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
@@ -162,9 +160,8 @@
=
The Java Part
- FIXME: Link to Quickstarts section when it's available=
remark>
- After setting up the the Maven pom.xml file as sh=
own in the previous section, we can c=
ontinue with implementing a basic JSR286 compatible portlet. Simplest Hello=
World Portlet from the link linkend=3D"sid-55378941">GateIn Quickstarts/li=
nk collection shows the very essence of every JSR286 Portlet:
+ After setting up the the Maven pom.xml file as sh=
own in the previous section, we can continue with implementing a basic JSR2=
86 compatible portlet. Simplest Hello World Portlet from the JBoss Portal P=
latform Quickstarts collection shows =
the very essence of every JSR286 Portlet:
SimplestHelloWorldPortlet.java
@@ -231,7 +228,7 @@
portlet.xml
-
+
<portlet-app xmlns=3D"http://java.sun.com/xml/ns/portlet/portlet-app_2_=
0.xsd" version=3D"2.0"
xmlns:xsi=3D"http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLoca=
tion=3D"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>
@@ -264,7 +261,7 @@
web.xml
-
+
<web-app xmlns:xsi=3D"http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=3D"http://java.sun.com/xml/ns/javaee http://jav=
a.sun.com/xml/ns/javaee/web-app_2_5.xsd"
version=3D"2.5">
@@ -323,19 +320,18 @@
=
Example Code
- FIXME: Link to Quickstarts section when it's available=
- This section cites code from JSF2 Hello World Portlet from t=
he link linkend=3D"sid-55378941">JBoss Portal Platform Quickstarts/link col=
lection.
+ This section cites code from JSF2 Hello World Portlet from t=
he JBoss Portal Platform Quickstarts =
collection.
=
pom.xml
- There is only one noticeable difference in pom.xml=
code> against what we have shown as a general case in the section. The dependencies are different for JSF:
+ There is only one noticeable difference in pom.x=
ml against what we have shown as a general case in the Starting a Portlet Project section. The depend=
encies are different for JSF:
pom.xml
-
+
<dependencies>
<!-- =
The versions, scopes and types of these dependencies are mana=
ged in gatein-*-bom.
@@ -475,7 +471,7 @@
portlet.xml is the place where we tie the JSF template=
s with the portlet.portlet.xml
-
+
<portlet-app xmlns=3D"http://java.sun.com/xml/ns/portlet/portlet-app_2_=
0.xsd" version=3D"2.0"
xmlns:xsi=3D"http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=3D"http://java.sun.com/xml/ns/portlet/portlet-app_2=
_0.xsd
@@ -542,7 +538,7 @@
web.xml
-
+
<web-app xmlns:xsi=3D"http://www.w3.org/2001/XMLSchema-instance" xmlns=
=3D"http://java.sun.com/xml/ns/javaee" xmlns:web=3D"http://java.sun.com/xml=
/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation=3D"http://java.sun.com/xml/ns/javaee http://java.su=
n.com/xml/ns/javaee/web-app_2_5.xsd" version=3D"2.5">
<display-name>jsf2-hello-world-portlet</display-name>
@@ -644,7 +640,7 @@
faces-config.xml
-
+
<faces-config xmlns=3D"http://java.sun.com/xml/ns/javaee" xmlns:xsi=3D"=
http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=3D"http://java.sun.com/xml/ns/javaee http://java.su=
n.com/xml/ns/javaee/web-facesconfig_2_0.xsd" version=3D"2.0">
<application>
@@ -707,10 +703,9 @@
=
Example Code
- FIXME: Link to Quickstarts section when it's available=
This section cites code from JSF2+RF4 Hello World Portlet fr=
om the
- link linkend=3D"sid-55378941">JBoss Portal Platform Quicksta=
rts/link
+ JBoss Portal Platform Quickst=
arts
collection.
@@ -719,7 +714,7 @@
We need to add several RF-specific dependencies to the=
general JSF ones:pom.xml
-
+
<dependencies>
<!-- =
The versions, scopes and types of these dependencies are mana=
ged in gatein-*-bom.
@@ -768,7 +763,7 @@
Form with rich: components in main.xhtml
-
+
</p>
<h:form id=3D"jsf2HelloWorldPortlet">
<h:panelGrid columns=3D"2">
@@ -811,7 +806,7 @@
HelloBean.java
-
+
/**
* Static list of greetings. Contains {@code "Hello"} and {@code "Hi"=
}.
*/
@@ -832,7 +827,7 @@
HelloBean.java
-
+
/**
* Returns {@link #greeting}.
* =
@@ -893,7 +888,7 @@
portlet.xml
-
+
<portlet-app xmlns=3D"http://java.sun.com/xml/ns/portlet/portlet-app_2_=
0.xsd" version=3D"2.0"
xmlns:xsi=3D"http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=3D"http://java.sun.com/xml/ns/portlet/portlet-app_2=
_0.xsd
@@ -948,7 +943,7 @@
web.xml
-
+
<web-app xmlns:xsi=3D"http://www.w3.org/2001/XMLSchema-instance" xmlns=
=3D"http://java.sun.com/xml/ns/javaee" xmlns:web=3D"http://java.sun.com/xml=
/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation=3D"http://java.sun.com/xml/ns/javaee http://java.su=
n.com/xml/ns/javaee/web-app_2_5.xsd" version=3D"2.5">
<display-name>jsf2-rf4-hello-world-portlet</display-name>
@@ -1101,7 +1096,7 @@
=
- <configuration>
+ <configuration>
<hostname>127.0.0.1</hostname>
<port>9999</port>
<username>admin</username>
--===============7777528455595403229==--