[gatein-commits] gatein SVN: r9101 - epp/docs/branches/6.0/Developer_Guide/en-US.

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_development.xml Log: Added 'Quickstarts' appendix and minor cleanup of GateIn references and intradocument links 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-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 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-4-GDG_Portal_Development.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-5-GDG_Application_development.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="chapter-6-GDG_JavaScript_Development.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="appendix-Quickstarts.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Revision_History.xml"/> </book> Modified: epp/docs/branches/6.0/Developer_Guide/en-US/appendix-Quickstarts.xml =================================================================== --- epp/docs/branches/6.0/Developer_Guide/en-US/appendix-Quickstarts.xml 2013-01-31 01:43:08 UTC (rev 9100) +++ epp/docs/branches/6.0/Developer_Guide/en-US/appendix-Quickstarts.xml 2013-01-31 01:43:20 UTC (rev 9101) @@ -2,17 +2,18 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <chapter id="sid-55378941"> - <title>Appendix - Code Examples alias Quickstarts</title> - <para>GateIn Portal Quickstarts provide small, specific, working examples that can be used as a reference for your own project.</para> - <para>GateIn Portal Quickstarts can be obtained in one of the following ways:</para> + <title>Appendix - Quickstarts</title> + <para>JBoss Portal Platform Quickstarts provide small, specific, working examples that can be used as a reference for your own project.</para> + <para>The Quickstarts can be obtained in one of the following ways:</para> <section id="sid-55378941_Appendix-Quickstarts-DownloadsPage"> - <title>1. GateIn Portal Downloads Page</title> + <title>JBoss Portal Platform Downloads Page</title> + <remark>Source: https://https://docs.jboss.org/author/display/GTNPORTAL35/Appendix+-+Code..., incorporated changes up to version 3</remark> <itemizedlist> <listitem> <para> - A ZIP file containing all Quickstarts can be downloaded from - <ulink url="http://www.jboss.org/gatein/downloads/gateinportal.html"&g... Portal Downloads page</ulink> + A zip archive containing all Quickstarts can be downloaded from + <ulink url="http://www.jboss.org/gatein/downloads/gateinportal.html"&g... Portal Platform Downloads page</ulink> . </para> </listitem> @@ -20,7 +21,7 @@ </section> <section id="sid-55378941_Appendix-Quickstarts-IDE"> - <title>2. JBoss Developer Studio or Eclipse with JBoss Tools</title> + <title>JBoss Developer Studio or Eclipse with JBoss Tools</title> <itemizedlist> <listitem> <para> @@ -31,7 +32,7 @@ <listitem> <para> In the New Project Example dialog, select the Site - <code>JBoss Community GateIn Portal Examples</code> + <code>JBoss Community JBoss Portal Platform Examples</code> from the drop down menu </para> </listitem> @@ -52,11 +53,11 @@ </section> <section id="sid-55378941_Appendix-Quickstarts-GitHub"> - <title>3. GitHub</title> + <title>GitHub</title> <para>Issue the following command</para> <informalexample> <programlisting>git clone https://github.com/gatein/gatein-portal-quickstart.git</programlisting... </informalexample> - <para>... and switch to the branch compatible with your GateIn Portal version.</para> + <para>... and switch to the branch compatible with your JBoss Portal Platform version.</para> </section> </chapter> 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-31 01:43:08 UTC (rev 9100) +++ epp/docs/branches/6.0/Developer_Guide/en-US/chapter-5-GDG_Application_development.xml 2013-01-31 01:43:20 UTC (rev 9101) @@ -11,13 +11,13 @@ 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> <para> - Within a portal, it is possible to embed any OpenSocial gadget in a page or in a user&apos;s dashboard. Gadgets can be added to the application registry and links can be added to the mini-composer (see the JBoss Portal Platform User Guide). + Within a portal, it is possible to embed any OpenSocial gadget in a page or in a user&apos;s dashboard. Gadgets can be added to the application registry and links can be added to the mini-composer (see the JBoss Portal Platform <citetitle>User Guide</citetitle>). </para> </section> <section id="sid-819807_GDG-GadgetDevelopment-DevelopingGadgets"> <title>Developing Gadgets</title> <para> - OpenSocial gadgets are made of standard HTML and JavaScript. The container offers an API, the documentation for which is available <ulink url="http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Ga... . + OpenSocial gadgets are made of standard HTML and JavaScript. The container offers an API, the documentation for which is available at <ulink url="http://opensocial-resources.googlecode.com/svn/spec/1.0/Core-Ga...;. </para> <para> 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). @@ -30,11 +30,10 @@ <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 &quot;Portlet Primer&quot; 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 &quot;Getting started with JBoss Portlet Bridge&quot; chapter of the JBoss Portal Platform <citetitle>Reference Guide)</citetitle>. + JBoss Portal Platform's interface is fully customizable with applications called portlets. Application development can be done by using the plain Portlet specification JSR286 (refer to the &quot;Portlet Primer&quot; 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 &quot;Getting started with JBoss Portlet Bridge&quot; chapter of the JBoss Portal Platform <citetitle>Reference Guide)</citetitle>. </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). + Whichever technology you choose, refer to <link linkend="sid-55378991">Starting a Portlet Project</link> 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 id="sid-55378991"> @@ -49,9 +48,8 @@ <section id="sid-55378991_StartingaPortletProject-HowtoUseBOM"> <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 Portket example below, which contains all necessary details. </para> <para> In its <code>&lt;dependencyManagement&gt;</code> section, it declares @@ -64,7 +62,7 @@ </para> <example> <title>Simplest Hello World Portlet</title> - <programlisting> + <programlisting language="XML"> &lt;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"&gt; &lt;modelVersion&gt;4.0.0&lt;/modelVersion&gt; @@ -162,9 +160,8 @@ <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: + After setting up the the Maven <code>pom.xml</code> file as shown in the previous section, we can continue with implementing a basic JSR286 compatible portlet. Simplest Hello World Portlet from the JBoss Portal Platform <link linkend="sid-55378941">Quickstarts</link> collection shows the very essence of every JSR286 Portlet: </para> <example> <title>SimplestHelloWorldPortlet.java</title> @@ -231,7 +228,7 @@ </para> <example> <title>portlet.xml</title> - <programlisting> + <programlisting language="XML"> &lt;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... http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"&gt; &lt;portlet&gt; @@ -264,7 +261,7 @@ </para> <example> <title>web.xml</title> - <programlisting> + <programlisting language="XML"> &lt;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"&gt; @@ -323,19 +320,18 @@ <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">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. The dependencies are different for JSF: + There is only one noticeable difference in <filename>pom.xml</filename> against what we have shown as a general case in the <link linkend="sid-55378991">Starting a Portlet Project</link> section. The dependencies are different for JSF: </para> <example> <title>pom.xml</title> - <programlisting> + <programlisting language="XML"> &lt;dependencies&gt; &lt;!-- The versions, scopes and types of these dependencies are managed in gatein-*-bom. @@ -475,7 +471,7 @@ <para>portlet.xml is the place where we tie the JSF templates with the portlet.</para> <example> <title>portlet.xml</title> - <programlisting> + <programlisting language="XML"> &lt;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... @@ -542,7 +538,7 @@ </para> <example> <title>web.xml</title> - <programlisting> + <programlisting language="XML"> &lt;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"&gt; &lt;display-name&gt;jsf2-hello-world-portlet&lt;/display-name&gt; @@ -644,7 +640,7 @@ </para> <example> <title>faces-config.xml</title> - <programlisting> + <programlisting language="XML"> &lt;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"&gt; &lt;application&gt; @@ -707,10 +703,9 @@ <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">JBoss Portal Platform Quickstarts/link + <link linkend="sid-55378941">JBoss Portal Platform Quickstarts</link> collection. </para> <section id="sid-55477018_JSFPortletDevelopmentwithRichFaces-pom.xml"> @@ -719,7 +714,7 @@ <para>We need to add several RF-specific dependencies to the general JSF ones:</para> <example> <title>pom.xml</title> - <programlisting> + <programlisting language="XML"> &lt;dependencies&gt; &lt;!-- The versions, scopes and types of these dependencies are managed in gatein-*-bom. @@ -768,7 +763,7 @@ </para> <example> <title>Form with rich: components in main.xhtml</title> - <programlisting> + <programlisting language="XML"> &lt;/p&gt; &lt;h:form id="jsf2HelloWorldPortlet"&gt; &lt;h:panelGrid columns="2"&gt; @@ -811,7 +806,7 @@ </para> <example> <title>HelloBean.java</title> - <programlisting> + <programlisting language="Java"> /** * Static list of greetings. Contains {@code "Hello"} and {@code "Hi"}. */ @@ -832,7 +827,7 @@ </example> <example> <title>HelloBean.java</title> - <programlisting> + <programlisting language="Java"> /** * Returns {@link #greeting}. * @@ -893,7 +888,7 @@ </para> <example> <title>portlet.xml</title> - <programlisting> + <programlisting language="XML"> &lt;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... @@ -948,7 +943,7 @@ </para> <example> <title>web.xml</title> - <programlisting> + <programlisting language="XML"> &lt;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"&gt; &lt;display-name&gt;jsf2-rf4-hello-world-portlet&lt;/display-name&gt; @@ -1101,7 +1096,7 @@ </para> <informalexample> - <programlisting>&lt;configuration&gt; + <programlisting language="XML">&lt;configuration&gt; &lt;hostname&gt;127.0.0.1&lt;/hostname&gt; &lt;port&gt;9999&lt;/port&gt; &lt;username&gt;admin&lt;/username&gt;