[jbosstools-commits] JBoss Tools SVN: r32976 - in branches/jbosstools-3.2.x/portlet/docs/reference: en-US and 1 other directory.

Author: irooskov(a)redhat.com Date: 2011-07-17 22:02:34 -0400 (Sun, 17 Jul 2011) New Revision: 32976 Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Feedback.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Preface.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/intro.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/jsf_portlet.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/master.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/reference.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/seam_portlet.xml branches/jbosstools-3.2.x/portlet/docs/reference/en-US/starting_project.xml branches/jbosstools-3.2.x/portlet/docs/reference/pom.xml Log: updated for GA Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Book_Info.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Book_Info.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -5,9 +5,9 @@ <title>JBoss Portlet Tools User Guide</title> <subtitle>Provides information relating to the JBoss Portlet Tools set.</subtitle> <productname>JBoss Developer Studio</productname> - <productnumber>4.0</productnumber> - <edition>4.0.0</edition> - <pubsnumber>4</pubsnumber> + <productnumber>4.1</productnumber> + <edition>4.1.0</edition> + <pubsnumber>1</pubsnumber> <abstract> <para>The JBoss Portlet Tools User Guide explains how to begin with and manage JBoss Portlet Tools.</para> </abstract> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Feedback.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Feedback.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Feedback.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -1,20 +1,92 @@ <?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent"> +%BOOK_ENTITIES; +]> +<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US"> + <title>Getting Help and Giving Feedback</title> + <section id="sect_JBoss-Do_You_Need_Help"> + <title>Do You Need Help?</title> + <indexterm> + <primary>help</primary> + <secondary>getting help</secondary> -<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US"> - <title>We Need Feedback!</title> - <indexterm> - <primary>feedback</primary> - <secondary>contact information for this manual</secondary> - </indexterm> - <para> - If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=1231050... - </para> - <para> - When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component. - </para> - <para> - If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. - </para> -</section> + </indexterm> + <para> + If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can: + </para> + <itemizedlist> + <listitem> + <para> + search or browse through a knowledgebase of technical support articles about Red Hat products. + </para> + </listitem> + <listitem> + <para> + submit a support case to Red Hat Global Support Services (GSS). + </para> + </listitem> + <listitem> + <para> + access other product documentation. + </para> + + </listitem> + + </itemizedlist> + <para> + Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives. + </para> + + </section> + + <section id="jboss-feedback"> + <title>Give us Feedback</title> + <!-- NOTE: You will need the following entities defined in your .ent file. + You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_ + and _YOUR_SUMMARY_ - entities are not replaced in URLs. + <!ENTITY PRODUCT "JBoss Product Name"> + <!ENTITY BZCOMPONENT "doc-triage"> + <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT... + + These entities should not affect translated documents, since Bugzilla is not localised. + --> <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + + </indexterm> + <para> + If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;. + </para> + <para> + Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly. + </para> + +<screen>Document URL: + + +Section Number and Name: + + +Describe the issue: + + +Suggestions for improvement: + + +Additional information: + + +</screen> + <para> + Be sure to give us your name so that you can receive full credit for reporting the issue. + </para> + + </section> + + +</appendix> + + Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent 2011-07-18 02:02:34 UTC (rev 32976) @@ -1,4 +1,7 @@ <!ENTITY PRODUCT "JBoss"> <!ENTITY BOOKID "JBoss_Portlet_Tools_Reference_Guide"> -<!ENTITY YEAR "2010"> +<!ENTITY YEAR "2011"> <!ENTITY HOLDER "Red Hat"> +<!ENTITY BZPRODUCT "JBoss Developer Studio"> +<!ENTITY BZCOMPONENT "Portlet Tools User Guide"> +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -8,5 +8,6 @@ <xi:include href="portlet_tools_tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="reference.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </book> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Preface.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Preface.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -8,9 +8,5 @@ <para> This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.... Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section. </para> - <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include>--> </preface> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Revision_History.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/Revision_History.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -2,31 +2,51 @@ <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> <appendix> - <title>Revision History</title> - <simpara> - <revhistory> - <revision> - <revnumber>1</revnumber><date>Wed Jun 09 2010</date> - <author> - <firstname>JBoss Tools</firstname><surname>Documentation Team&lt;/surname&gt;&lt;email&gt;irooskov(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>General updates</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>0</revnumber><date>Fri Nov 20 2009</date> - <author> - <firstname&gt;Isaac&lt;/firstname&gt;&lt;surname&gt;Rooskov&lt;/surname&gt;&lt;email&gt;irooskov(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>Initial creation of book by publican</member> - </simplelist> - </revdescription> - </revision> - </revhistory> - </simpara> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>2</revnumber> + <date>Tue Jan 18 2011</date> + <author> + <firstname>JBoss Tools</firstname> + <surname>Documentation Team</surname> + <email&gt;mcaspers(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>General updates</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>1</revnumber> + <date>Wed Jun 09 2010</date> + <author> + <firstname>JBoss Tools</firstname> + <surname>Documentation Team</surname> + <email&gt;irooskov(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>General updates</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>0</revnumber> + <date>Fri Nov 20 2009</date> + <author> + <firstname>Isaac</firstname> + <surname>Rooskov</surname> + <email&gt;irooskov(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Initial creation of book by publican</member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> </appendix> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/intro.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/intro.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/intro.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -1,96 +1,94 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="intro"> - <?dbhtml filename="intro.html"?> - <title>Introduction</title> + <?dbhtml filename="intro.html"?> + <title>Introduction</title> + + <para> + Starting from 3.0.0.Alpha1 version, the JBoss set of plugins includes tools for supporting <property>JBoss Portal</property> and JSR-186/JSR-286 portlets. Thus, this guide provides instructions on how to get started and manage <property>JBoss Portlet Tools</property>. + </para> + <section> + <title>What JBoss Portal and Portlet Tools are</title> + <para> + <property>JBoss Portal</property> provides an open source platform for hosting and serving a portal's Web interface, publishing and managing its content, and customizing its experience. It supports a wide range of features, including standard portlets, single sign-on, clustering, and internationalization. More about <property>JBoss Portal</property> can be found by visiting its home page at: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org...;. + </para> + + <para> + With <property>JBoss Portlet Tools</property> you can easily create a Java, JSF and Seam portlet and deploy it to <property>JBoss Portal</property>. + </para> + </section> - <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting <property>JBoss Portal</property> and JSR-186/JSR-286 portlets. - Thus, this guide is intended to explain you how to get started and manage <property>JBoss Portlet Tools</property>.</para> -<section> - <title>What is JBoss Portal and Portlet Tools?</title> - <para><property>JBoss Portal</property> provides an open source platform for hosting and - serving a portal's Web interface, publishing and managing its content, and customizing - its experience. It supports a wide range of features, including standard portlets, - single sign-on, clustering, and internationalization. More about <property>JBoss Portal</property> you can find visiting - its home page at: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org... + <section id="key_features"> + <title>Key Features of JBoss Portlet Tools</title> + <para> + <property>JBoss Portlet Tools</property> supports the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification (Portlet 1.0)</ulink> and <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification (Portlet 2.0)</ulink> and works with <ulink url="http://www.jboss.org/portletbridge/">JBoss Portlet Bridge</ulink> for supporting Portlets in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project (see <xref linkend="portlet_tools_tasks"/>). The project could be a non-WTP project, but you should know that if it does not have the proper portlet API JAR's, the generated classes will have compile errors. + </para> - <para>With <property>JBoss Portlet Tools</property> you can easily create a Java, JSF and Seam portlet and deploy it to <property>JBoss Portal</property>.</para> - </section> + <para>The next table lists key features supplied by <property>JBoss Portlet Tools</property>.</para> - <section id="key_features"> - <title>Key Features of JBoss Portlet Tools</title> - <para><property>JBoss Portlet Tools</property> supports the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification (Portlet 1.0)</ulink> and - <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification (Portlet 2.0)</ulink> and works with - <ulink url="http://www.jboss.org/portletbridge/">JBoss Portlet Bridge</ulink> for supporting Portlets - in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project - (see <xref linkend="portlet_tools_tasks"/>). The project could be a non-WTP project, but you should know that - if it does not have the proper portlet API jar's the generated classes will have compile errors.</para> - - <para>The next table lists key features supplied by <property>JBoss Portlet Tools</property>.</para> + <table> + <title>Key Features of JBoss Portlet Tools</title> + <tgroup cols="3"> - <table> - <title>Key Features of JBoss Portlet Tools</title> - <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + <colspec colnum="3" align="left" colwidth="1*"/> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="5*"/> - <colspec colnum="3" align="left" colwidth="1*"/> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - <entry>Chapter</entry> - </row> - </thead> + <tbody> - <tbody> + <row> + <entry> + <para>JBoss Portlet facets</para> + </entry> + <entry> + <para> + <property>JBoss Portlet Tools</property> provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project.</para> + </entry> + <entry> + <xref linkend="portlet_tools_tasks"/> + </entry> + </row> - <row> - <entry> - <para>JBoss Portlet facets</para> - </entry> - <entry> - <para><property>JBoss Portlet Tools</property> provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project.</para> - </entry> - <entry> - <xref linkend="portlet_tools_tasks"/> - </entry> - </row> + <row> + <entry> + <para>Java Portlet wizard</para> + </entry> - <row> - <entry> - <para>Java Portlet wizard</para> - </entry> + <entry> + <para>The wizard helps create a JSR-186/JSR-286 compliant portlets</para> + </entry> + <entry> + <xref linkend="java_portlet_wizard"/> + </entry> + </row> - <entry> - <para>The wizard helps create a JSR-186/JSR-286 compliant - portlets</para> - </entry> - <entry> - <xref linkend="java_portlet_wizard"/> - </entry> - </row> - - <row> - <entry> - <para>JSF/Seam Portlet wizard</para> - </entry> - <entry> - <para>This wizard helps create JSF/Seam portlets</para> - </entry> - <entry> - <xref linkend="jsf_seam_portlet_wizard"/> - </entry> - </row> - </tbody> - </tgroup> - </table> - </section> + <row> + <entry> + <para>JSF/Seam Portlet wizard</para> + </entry> + <entry> + <para>This wizard helps create JSF/Seam portlets</para> + </entry> + <entry> + <xref linkend="jsf_seam_portlet_wizard"/> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> <section id="requirements_installation"> <title>Requirements and Installation</title> - <para><property>JBoss - Portlet Tools</property> needs the following minimal requirements:</para> + <para> + <property>JBoss Portlet Tools</property> needs the following minimum requirements:</para> <itemizedlist> <listitem> @@ -100,24 +98,55 @@ <para>JBoss Tools 3.0.0.Alpha1 (for higher versions of JBoss Tools make sure you use the <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsr... version of Eclipse</ulink>)</para> </listitem> - <listitem><para>JDK 5 or higher</para></listitem> <listitem> - <para>JBoss Portal + JBoss AS bundle from: <ulink - url="http://www.jboss.org/jbossportal/download/index.html">h... - <note> - <title>Note:</title> - <para>JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA - versions of <property>JBoss Portal</property>. Remember, if you want to use Portlet - version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para> - </note> + <para>JDK 5 or higher</para> </listitem> <listitem> - <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http... + <para> + One of the following technologies: + </para> + <itemizedlist> + <listitem> + <para> + JBoss Enterprise Portal Platform version 4.3 or 5.1 + </para> + </listitem> + <listitem> + <para> + GateIn and JBoss Application Server + </para> + </listitem> + <listitem> + <para> + JBoss Portal and JBoss Application Server + </para> + <para> + A specific JBoss Portal and JBoss Application Server bundle is available from: <ulink url="http://www.jboss.org/jbossportal/download/index.html">h... + </para> + <note> + <title>Note:</title> + <para> + JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA versions of <property>JBoss Portal</property>. Remember, if you want to use Portlet version 2.0 (JSR-268), you have to choose JBoss Portal 2.7. + </para> + </note> + </listitem> + </itemizedlist> </listitem> + <listitem> + <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http... + </para> + </listitem> </itemizedlist> - - <para><property>JBoss Portlet Tools</property> is included as part of <property>JBoss Tools</property> project. + + <para> + <property>JBoss Portlet Tools</property> is included as part of the <property>JBoss Tools</property> project. Refer to <ulink url="http://www.jboss.org/tools/download/installation.html">... - for installation methods of <property>JBoss Tools</property>.</para> -</section> + for <property>JBoss Tools</property> installation instructions. + </para> + <note> + <para> + This guide will only refer to JBoss Portal from here, however you can use (and it is recommended to use) JBoss Enterprise Portal Platform or GateIn instead, as mentioned above. + </para> + </note> + </section> </chapter> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/jsf_portlet.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/jsf_portlet.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/jsf_portlet.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -2,256 +2,250 @@ <section id="jsf_portlet"> <title>Creating and Deploying a JSF Portlet</title> - <para>This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities - and then deploy it to <property>JBoss Portal</property>.</para> + <para> + This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities and then deploy it to <property>JBoss Portal</property>. + </para> - <section id="jsf_portlet1"> - <title>Creating a JSF Project with JBoss Portlet Capabilities</title> - - <para>You can create a JSF project with JBoss Portlet capabilities in two ways:</para> + <section id="jsf_portlet1"> + <title>Creating a JSF Project with JBoss Portlet Capabilities</title> + + <para>You can create a JSF project with JBoss Portlet capabilities in two ways:</para> - <orderedlist> - <listitem> - <para>Create a dynamic Web project with the <emphasis><property>JavaServer Faces</property></emphasis> - and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets enabled (see - <xref linkend="create_dyn_web_proj_jsf"/>)</para> - </listitem> - <listitem><para>Or create a JSF project using the wizard JBoss JSF Tools provides, then enable - JSF and JBoss Portlet facets and add JBoss Portlet capabilities (see - <xref linkend="create_jsf_proj"/>)</para></listitem> - </orderedlist> + <orderedlist> + <listitem> + <para> + Create a dynamic Web project with the <emphasis><property>JavaServer Faces</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets enabled (see <xref linkend="create_dyn_web_proj_jsf"/>) + </para> + </listitem> + <listitem> + <para> + Or create a JSF project using the wizard provided by JBoss JSF Tools, then enable JSF and JBoss Portlet facets and add JBoss Portlet capabilities (see + <xref linkend="create_jsf_proj"/>) + </para> + </listitem> + </orderedlist> - <para>Refer to the further sections for the procedures on how to do this.</para> + <para>Refer to the further sections for the procedures on how to do this.</para> - <section id="create_dyn_web_proj_jsf"> - <title>Creating a Dynamic Web Project with the JBoss Portlet Capabilities</title> + <section id="create_dyn_web_proj_jsf"> + <title>Creating a Dynamic Web Project with the JBoss Portlet Capabilities</title> - <para>The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</para> + <para>The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</para> - <orderedlist> - <listitem> - <para>Start the <emphasis><property>Dynamic Web Project</property></emphasis> wizard navigating to - <emphasis><property>File &gt; New &gt; Other &gt; Web &gt; Dynamic Web Project</property>.</emphasis></para> + <orderedlist> + <listitem> + <para> + Start the <emphasis><property>Dynamic Web Project</property></emphasis> wizard navigating to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>. + </para> - <note> - <title>Tip:</title> - <para>You can also select the <property>Java EE</property> perspective and then go to - <emphasis><property>File &gt; New &gt; Dynamic Web Project</property>.</emphasis></para> - </note> + <note> + <title>Tip:</title> + <para> + You can also select the <property>Java EE</property> perspective and then selecting <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>. + </para> + </note> - <figure> - <title>Setting the JSF Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Setting the JSF Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>Specify the project name and set the target runtime to <property>JBoss Portal</property> by following the points 3, 4 and 5 in the - <xref linkend="jboss_core_portlet"/> procedure.</para> - </listitem> + <listitem> + <para>Specify the project name and set the target runtime to <property>JBoss Portal</property> by following the points 3, 4 and 5 in the <xref linkend="jboss_core_portlet"/> procedure.</para> + </listitem> - <listitem> - <para>In the <emphasis><property>Configuration</property></emphasis> - area, click <emphasis><property>Modify</property></emphasis> and enable <emphasis><property>JavaServer Faces</property>,</emphasis> - <emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets. - Hit <emphasis><property>OK</property>.</emphasis></para> + <listitem> + <para>In the <emphasis><property>Configuration</property></emphasis>area, click the <guibutton>Modify</guibutton> button and enable <emphasis><property>JavaServer Faces</property>,</emphasis><emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets. Click the <guibutton>OK</guibutton> button. + </para> - <figure> - <title>Enabling the Portlet Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Enabling the Portlet Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>You may leave the next two wizard pages with defaults, just press <emphasis><property>Next</property></emphasis> to proceed.</para> - </listitem> + <listitem> + <para>You may leave the next two wizard pages with their defaults, just press the <guibutton>Next</guibutton> button to proceed.</para> + </listitem> - <listitem> - <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis> - <property>Portlet Target Runtime Provider</property></emphasis> and click <emphasis><property>Next</property>.</emphasis></para> + <listitem> + <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> and click the <guibutton>Next</guibutton> button. + </para> - <figure> - <title>JBoss Portlet Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>JBoss Portlet Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"/> + </imageobject> + </mediaobject> + </figure> - <note> - <title>Tip:</title> - <para>All types of the portlet implementation library are described more closely in the wiki article at: + <note> + <title>Tip:</title> + <para>All types of the portlet implementation library are described more closely in the wiki article at: <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"... - </note> - </listitem> + </note> + </listitem> - <listitem> - <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it - is here.</para> + <listitem> + <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it is here.</para> - <figure> - <title>JSF Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>On the <property>JBoss JSF Portlet Capabilities</property> page, select - <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> as the JSF portlet implementation library. It will - copy Portlet Bridge libraries from the server runtime to the project classpath.</para> + <listitem> + <para> + On the <property>JBoss JSF Portlet Capabilities</property> page, select <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> as the JSF portlet implementation library. It will copy Portlet Bridge libraries from the server runtime to the project classpath. + </para> - <figure> - <title>JBoss JSF PortletCapabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>JBoss JSF PortletCapabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> - <note> - <title>Tip:</title> - <para>On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking - <emphasis><property>Add/Change Richfaces Libraries</property>.</emphasis></para> - </note> + <note> + <title>Tip:</title> + <para>On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking<emphasis><property>Add/Change Richfaces Libraries</property>.</emphasis> + </para> + </note> - <note> - <title>Note:</title> - <para>You can select the <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> type. Then it - is necessary to set the home of the Portlet Bridge distribution.</para> - <para>For information about all the JSF Portlet facet library providers, refer to the wiki article at: - <ulink url="http://community.jboss.org/wiki/PortletFacetLibraries">... - </note> - </listitem> + <note> + <title>Note:</title> + <para> + You can select the <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> type. Then it is necessary to set the home of the Portlet Bridge distribution. + </para> + <para> + For information about all the JSF Portlet facet library providers, refer to the wiki article at: <ulink url="http://community.jboss.org/wiki/PortletFacetLibraries">...;. + </para> + </note> + </listitem> - <listitem> - <para>Click <emphasis><property>Finish</property>.</emphasis> The project will be created in the workbench.</para> - </listitem> - </orderedlist> - </section> + <listitem> + <para>Click the <guibutton>Finish</guibutton> button. The project will be created in the workbench.</para> + </listitem> + </orderedlist> + </section> - <section id="create_jsf_proj"> - <title>Creating a JSF Project and adding the JBoss Portlet Capabilities</title> + <section id="create_jsf_proj"> + <title>Creating a JSF Project and adding the JBoss Portlet Capabilities</title> - <para>How to organize a JSF project you can find out in the JSF Tools User Guide. Just - remember to point the target runtime to <property>JBoss Portal</property> directory location (see - how it is done for a dynamic Web project: steps 3, 4 and 5 in the - <xref linkend="jboss_core_portlet"/> procedure).</para> + <para> + For information on how to organize a JSF project you can read the JSF Tools User Guide. Just remember to point the target runtime to <property>JBoss Portal</property> directory location (see how it is done for a dynamic Web project with steps 3, 4 and 5 in the <xref linkend="jboss_core_portlet"/> procedure). + </para> - <figure> - <title>Creating New JSF Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Creating New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"/> + </imageobject> + </mediaobject> + </figure> - <para>To add the JBoss Portlet capabilities to the created JSF project you should complete the next steps:</para> - - <orderedlist> - <listitem> - <para>Right-click the project and click <emphasis> - <property>Properties</property> - </emphasis> to open the project <property>Properties</property> sheet. Select <property>Project Facets</property> - on the left and enable the <emphasis><property>JavaServer Faces</property>,</emphasis> - <emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets.</para> + <para>To add the JBoss Portlet capabilities to the JSF project you should complete the next steps:</para> + + <orderedlist> + <listitem> + <para>Right-click the project and click <guimenuitem>Properties</guimenuitem> to open the project <property>Properties</property> sheet. Select <property>Project Facets</property> on the left and enable the <emphasis><property>JavaServer Faces</property>, </emphasis><emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets.</para> - <figure> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>Notice, <emphasis> - <property>&quot;Further configuration available...&quot;</property> - </emphasis> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project. - Click the link. The <property>Modify Faceted Project</property> wizard appears.</para> - </listitem> + <listitem> + <para>Notice that the <emphasis><property>&quot;Further configuration available...&quot;</property></emphasis> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project. Click the link. The <property>Modify Faceted Project</property> wizard appears.</para> + </listitem> - <listitem> - <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the - <xref linkend="jboss_core_portlet"/> procedure. - Hit <emphasis><property>OK</property>.</emphasis></para> - </listitem> + <listitem> + <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the <xref linkend="jboss_core_portlet"/> procedure. Click the <guibutton>OK</guibutton> button. + </para> + </listitem> - <listitem> - <para>To apply the changes click <emphasis><property>Apply</property></emphasis> and then - <emphasis><property>OK</property></emphasis> to close the project <property>Properties</property> sheet.</para> - </listitem> - </orderedlist> - </section> - </section> + <listitem> + <para> + To apply the changes click the <guibutton>Apply</guibutton> button and then the <guibutton>OK</guibutton> button to close the project <property>Properties</property> sheet. + </para> + </listitem> + </orderedlist> + </section> + </section> - <section id="jsf_portlet_to_JSF_project"> - <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> - - <para>The previous section has shown how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use - the following procedure to add a JSF portlet to the created project and deploy it to <property>JBoss Portal</property>.</para> + <section id="jsf_portlet_to_JSF_project"> + <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> + + <para> + The previous section demonstrated how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use the following procedure to add a JSF portlet to the created project and deploy it to <property>JBoss Portal</property>. + </para> - <orderedlist> - <listitem> - <para>Call the - <property>Create Portlet</property> wizard by navigating to <emphasis> - <property>New > Other > JBoss Tools Web > Portlet > JSF/Seam - Portlet</property></emphasis> on the context menu of the project (for information about the wizard options, see - <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference).</para> + <orderedlist> + <listitem> + <para>Display the <property>Create Portlet</property> wizard by selecting <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Portlet</guimenuitem><guimenuitem>JSF/Seam Portlet</guimenuitem></menuchoice> from the context menu of the project (for information about the wizard options, see <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference).</para> - <figure> - <title>Calling New Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Calling New Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> - <note> - <title>Tip:</title> - <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF + <note> + <title>Tip:</title> + <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF configuration for the project, so the default values in this wizard will be set as for a JSF portlet.</para> - </note> - </listitem> + </note> + </listitem> - <listitem> - <para>Leave all the wizard pages with default values by clicking the <emphasis><property>Next</property></emphasis> button, - on the last one click <emphasis><property>Finish</property></emphasis> to complete the JSF portlet creation.</para> - </listitem> + <listitem> + <para> + Leave all the wizard pages with default values by clicking the <guibutton>Next</guibutton> button, on the last one click the <guibutton>Finish</guibutton> button to complete the JSF portlet creation. + </para> + </listitem> - <listitem> - <para>Complete the steps described in the <xref linkend="deploying_to_portal"/> procedure to - deploy a JSF portlet to <property>JBoss Portal</property>. Just use the other URL to see it in the browser: - <emphasis>http://localhost:8080/portal/portal/default/JSFPortlet</emphasis>.</para> + <listitem> + <para> + Complete the steps described in the <xref linkend="deploying_to_portal"/> procedure to deploy a JSF portlet to <property>JBoss Portal</property>. Just use the other URL to see it in the browser: <emphasis>http://localhost:8080/portal/portal/default/JSFPortlet</emphasis>. + </para> - <figure> - <title>JSF Portlet in the Browser</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </orderedlist> + <figure> + <title>JSF Portlet in the Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> - </section> + </section> </section> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/master.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/master.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -53,12 +53,12 @@ Version: 1.1.1.GA </releaseinfo> -<abstract> +<!--<abstract> <title/> <para> <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_port... version</ulink> </para> -</abstract> +</abstract>--> </bookinfo> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/reference.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/reference.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/reference.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -648,11 +648,7 @@ <section id="preferences"> <title>JBoss Portlet Preferences</title> - <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <emphasis> - <property>Window &gt; Preferences</property> - </emphasis> and then <emphasis> - <property>JBoss Tools &gt; JBoss Portlet</property>. - </emphasis></para> + <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> and then <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>JBoss Portlet.</guimenuitem></menuchoice></para> <figure> <title>JBoss Runtime Preferences</title> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/seam_portlet.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/seam_portlet.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/seam_portlet.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -2,219 +2,218 @@ <section id="seam_portlet"> <title>Creating and Deploying a Seam Portlet</title> - <para>This chapter covers the steps on how to configure a Seam portlet within a Seam - project with the help of the <property>JBoss Portlet Tools</property> features.</para> - - <section id="seam_portlet1"> - <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + <para> + This chapter covers the steps required to configure a Seam portlet within a Seam project with the help of the <property>JBoss Portlet Tools</property> features. + </para> - <para>Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</para> - <orderedlist> - <listitem> - <para>Create a dynamic Web project with the <emphasis><property>Seam</property></emphasis> - and <emphasis><property>JBoss Portlets</property></emphasis> facets enabled (see <xref linkend="create_dyn_web_proj_seam"/>)</para> - </listitem> - <listitem><para>Or create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides - and follow all the wizard steps to enable JBoss Portlet capabilities (see <xref linkend="create_seam_proj"/>)</para></listitem> - </orderedlist> + <section id="seam_portlet1"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + + <para>One of the following two procedures can be used to create a Seam project with JBoss Portlet capabilities enabled:</para> + <orderedlist> + <listitem> + <para> + Create a dynamic Web project with the <emphasis><property>Seam</property></emphasis> and <emphasis><property>JBoss Portlets</property></emphasis> facets enabled (see <xref linkend="create_dyn_web_proj_seam"/>) + </para> + </listitem> + <listitem> + <para> + Create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides and follow all the wizard steps to enable JBoss Portlet capabilities (see <xref linkend="create_seam_proj"/>) + </para> + </listitem> + </orderedlist> - <section id="create_dyn_web_proj_seam"> - <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title> + <section id="create_dyn_web_proj_seam"> + <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title> - <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should take the following steps:</para> + <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should complete the following steps:</para> - <orderedlist> - <listitem> - <para>In the <emphasis><property>File</property></emphasis> menu, go to - <emphasis><property>New &gt; Other &gt; Web &gt; Dynamic Web Project</property>.</emphasis> The <property>New Dynamic Web Project</property> - wizard starts.</para> + <orderedlist> + <listitem> + <para> Select. <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice>. The <property>New Dynamic Web Project</property> wizard will then be displayed.</para> - <figure> - <title>Creating a New Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet1.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Creating a New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>Give the project a name and follow the steps 3, 4, 5 of the - <xref linkend="jboss_core_portlet"/> procedure to set the target runtime.</para> - </listitem> + <listitem> + <para>Give the project a name and follow the steps 3, 4, 5 of the <xref linkend="jboss_core_portlet"/> procedure to set the target runtime.</para> + </listitem> - <listitem> - <para>In the <emphasis><property>Configuration</property></emphasis> area of the first wizard page, - select <emphasis> - <property>JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.</para> + <listitem> + <para> + In the <emphasis><property>Configuration</property></emphasis> area of the first wizard page, select <emphasis><property>JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project. + </para> - <note> - <title>Tip:</title> - <para>If you now click the <emphasis><property>Modify</property></emphasis> button, you should see the - <emphasis><property>JavaServer Faces</property>,</emphasis> <emphasis><property>Jboss Portlets</property></emphasis> - and <emphasis><property>Seam</property></emphasis> facets enabled.</para> - </note> + <note> + <title>Tip:</title> + <para>If you now click the <guibutton>Modify</guibutton> button, you should see the<emphasis><property>JavaServer Faces</property>,</emphasis><emphasis><property>Jboss Portlets</property></emphasis> and <emphasis><property>Seam</property></emphasis> facets enabled.</para> + </note> - <figure> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet2.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>The next two pages are for adjusting the project Java and Web modules. - They include the default values, so you can skip them by pressing <emphasis> - <property>Next</property>.</emphasis></para> - </listitem> + <listitem> + <para> + The next two pages are for adjusting the project Java and Web modules. They include the default values, so you can skip them by clicking the <guibutton>Next</guibutton> button. + </para> + </listitem> - <listitem> - <para>On the <property>Jboss Portlet Capabilities</property> page, select - <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para> + <listitem> + <para> + On the <property>Jboss Portlet Capabilities</property> page, select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library. + </para> - <note> - <title>Tip:</title> - <para>All types of the portlet implementation library are described more closely in the wiki article at: - <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"... - </note> - </listitem> + <note> + <title>Tip:</title> + <para> + All types of the portlet implementation library are described more closely in the wiki article at: <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"...;. + </para> + </note> + </listitem> - <listitem> - <para>The next page is for configuring JSF capabilities. As it contains the default values, just click - <emphasis><property>Next</property></emphasis> to proceed.</para> - </listitem> + <listitem> + <para> + The next page is for configuring JSF capabilities. As it contains the default values, just click the <guibutton>Next</guibutton> button to proceed. + </para> + </listitem> - <listitem> - <para>On the <property>Seam Facet</property> page, set a Seam runtime and - a connection profile.</para> + <listitem> + <para>On the <property>Seam Facet</property> page, set a Seam runtime and a connection profile.</para> - <note> - <title>Tip:</title> - <para>For details about how to set a Seam runtime and a connection profile, see - Configure Seam Facet Settings in the Chapter 2 of the - Seam Dev Tools Reference Guide.</para> - </note> + <note> + <title>Tip:</title> + <para> + For details about how to set a Seam runtime and a connection profile, see Configure Seam Facet Settings in the Chapter 2 of the Seam Dev Tools Reference Guide. + </para> + </note> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet3.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>On the <property>JBoss JSF Portlet Capabilities</property> page, select the - <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.</para> + <listitem> + <para> + On the <property>JBoss JSF Portlet Capabilities</property> page, select the <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library. + </para> - <note> - <title>Tip:</title> - <para>If you have <property>JBoss Portlet Bridge</property> downloaded, - alternatively you can select <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to - the <property>JBoss Portlet Bridge</property> distribution.</para> - </note> + <note> + <title>Tip:</title> + <para> + If you have <property>JBoss Portlet Bridge</property> downloaded, alternatively you can select <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to the <property>JBoss Portlet Bridge</property> distribution. + </para> + </note> - <figure> - <title>Setting Portlet Bridge Provider</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Setting Portlet Bridge Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It will add <property>JBoss Portlet Bridge</property> libraries to the project classpath.</para> + </listitem> - <para>It will add <property>JBoss Portlet Bridge</property> libraries to the project classpath.</para> - </listitem> - - <listitem> - <para>Hit <emphasis><property>Finish</property></emphasis> to complete the project creation.</para> - </listitem> - </orderedlist> - </section> + <listitem> + <para>Click the <guibutton>Finish</guibutton> button to complete the project creation.</para> + </listitem> + </orderedlist> + </section> - <section id="create_seam_proj"> - <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + <section id="create_seam_proj"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> - <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para> + <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para> - <orderedlist> - <listitem> - <para>In the <emphasis><property>File</property></emphasis> menu, go to <emphasis> - <property>New &gt; Other &gt; Seam &gt; Seam Web Project</property>.</emphasis> The <property>New Seam Project</property> - wizard appears.</para> - </listitem> + <orderedlist> + <listitem> + <para> Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice>. The <property>New Seam Project</property> wizard will be displayed.</para> + </listitem> - <listitem> - <para>Next steps are the same as in the <xref - linkend="create_dyn_web_proj_seam"/> - procedure starting from the step 2.</para> - </listitem> - </orderedlist> - </section> - </section> - - <section id="seam_portlet_to_seam_project"> - <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title> + <listitem> + <para>Next steps are the same as in the <xref linkend="create_dyn_web_proj_seam"/> procedure starting from the step 2.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="seam_portlet_to_seam_project"> + <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title> - <para>The previous section has shown you how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet - and deploy it to <property>JBoss Portal</property> by following the next procedure:</para> - - <orderedlist> - <listitem> - <para>In the <emphasis><property>File</property></emphasis> or context menu of the project go to - <emphasis><property>New > Other > JBoss Tools Web > Portlet > JSF/Seam - Portlet</property>.</emphasis></para> + <para> + The previous section has demonstrated how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet and deploy it to <property>JBoss Portal</property> by following the next procedure: + </para> + + <orderedlist> + <listitem> + <para> + Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Portlet</guimenuitem><guimenuitem>JSF/Seam Portlet</guimenuitem></menuchoice>. + </para> - <figure> - <title>Calling the Create Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet5.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Calling the Create Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>The <property>Create Portlet</property> wizard starts (for more information about wizard options, see - <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference). - As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para> + <listitem> + <para> + The <property>Create Portlet</property> wizard is displayed (for more information about wizard options, see <xref linkend="jsf_seam_portlet_wizard"/> in the guide reference). As the Seam configuration is set for the project, the wizard enters the values for the for Seam portlet. + </para> - <figure> - <title>Creating Seam Portlet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet6.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Creating Seam Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet6.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>Next two pages are filled out with default values, just press <emphasis><property>Next</property></emphasis> to - proceed. On the last one click <emphasis><property>Finish</property></emphasis> to complete.</para> - </listitem> + <listitem> + <para>Next two pages are filled out with default values, just click the <guibutton>Next</guibutton> button to proceed. On the last one click the <guibutton>Finish</guibutton> button to complete the procedure.</para> + </listitem> - <listitem> - <para>To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the - <xref linkend="deploying_to_portal"/> procedure. Just use the following URL to see it in the browser: - <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.</para> + <listitem> + <para> + To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the <xref linkend="deploying_to_portal"/> procedure. Just use the following URL to see it in the browser: <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>. + </para> - <figure> - <title>Seam Portlet in the Browser Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet7.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </orderedlist> - </section> + <figure> + <title>Seam Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> </section> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/en-US/starting_project.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/en-US/starting_project.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/en-US/starting_project.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -2,20 +2,16 @@ <section id="starting_project"> <title>Creating and Deploying a Java Portlet</title> - <para>This chapter shows how to create a Dynamic Web Project, add a Java + <para>This chapter shows how to create a Dynamic Web Project, add a Java Portlet to it and deploy it to the <property>JBoss Portal</property>.</para> - + <section id="jboss_core_portlet"> <title>Creating a Web Project with JBoss Portlet Capabilities</title> - <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> + <para>Follow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> <orderedlist> <listitem> - <para>Go to <emphasis> - <property>File > New > Dynamic Web Project</property> - </emphasis> if you are in the <property>Web</property> perspective or <emphasis><property>File > - New > Other > Web > Dynamic Web Project</property></emphasis> in any other perspective. - The <property>New Dynamic Web Project</property> wizard appears.</para> + <para>Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice> if you are in the <property>Web</property> perspective or select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project</guimenuitem></menuchoice> in any other perspective. This will display the <property>New Dynamic Web Project</property> wizard.</para> <figure> <title>New Dynamic Web Project</title> @@ -27,19 +23,14 @@ </figure> </listitem> - <listitem><para>Specify the name of the project.</para></listitem> + <listitem> + <para>Specify the name of the project.</para> + </listitem> <listitem> - <para>Click <emphasis> - <property>New</property> - </emphasis> in the <emphasis> - <property>Target Runtime</property> - </emphasis> area to create a JBoss Portal runtime. Choose <emphasis> - <property>JBoss Community &gt; JBoss 4.2 Runtime</property> - </emphasis> and select the <emphasis> - <property>Create a new local server</property> - </emphasis> check box below. Click <emphasis> - <property>Next</property>.</emphasis></para> + <para>Click the <guibutton>New</guibutton> in the <emphasis><property>Target Runtime</property></emphasis> area to create a JBoss Portal runtime. Choose <emphasis><property>JBoss Community &gt; JBoss 4.2 Runtime</property></emphasis> and select the <emphasis><property>Create a new local server</property> + </emphasis> check box below. Click the <guibutton>Next</guibutton> button. + </para> <figure> <title>New Server Runtime</title> @@ -52,12 +43,7 @@ </listitem> <listitem> - <para>The <property>New Server Runtime Environment</property> wizard appears. In the <emphasis> - <property>Name</property></emphasis> field, type <emphasis> - <property>JBoss Portal 2.7 Runtime</property>, - </emphasis> and then use the <emphasis> - <property>Browse</property></emphasis> button to point to the location of JBoss Portal + JBoss AS extracted. Click <emphasis> - <property>Next</property></emphasis> to proceed.</para> + <para>The <property>New Server Runtime Environment</property> wizard appears. In the <emphasis><property>Name</property></emphasis> field, type <emphasis><property>JBoss Portal 2.7 Runtime</property>,</emphasis> and then use the <guibutton>Browse</guibutton> button to point to the location of JBoss Portal + JBoss AS extracted. Click <guibutton>Next</guibutton> button to proceed.</para> <figure> <title>New Server Runtime Environment</title> @@ -70,11 +56,9 @@ </listitem> <listitem> - <para>At this point a new JBoss Server instance will be created. On the next page you can verify the - runtime information defined. If something is incorrect, press <emphasis> - <property>Back</property> - </emphasis> to return to the previous wizard page. Click <emphasis> - <property>Finish</property>.</emphasis></para> + <para> + At this point a new JBoss Server instance will be created. On the next page you can verify the runtime information and configuration. If something is incorrect, press the <guibutton>Back</guibutton> button to return to the previous wizard page. Click the <guibutton>Finish</guibutton> button. + </para> <figure> <title>Target Server</title> @@ -87,10 +71,9 @@ </listitem> <listitem> - <para>Click <emphasis> - <property>Modify</property> - </emphasis> in the <emphasis><property>Configuration</property></emphasis> area to enable - a portlet facet for the project.</para> + <para> + Click the <guibutton>Modify</guibutton> button in the <emphasis><property>Configuration</property></emphasis> area to enable a portlet facet for the project. + </para> <figure> <title>Setting the Project Configuration</title> @@ -103,11 +86,7 @@ </listitem> <listitem> - <para>In the <property>Project Facets</property> dialog, check <emphasis> - <property>JBoss Core Portlet</property> - </emphasis> and press <emphasis> - <property>OK</property> - </emphasis>.</para> + <para>In the <property>Project Facets</property> dialog, check <emphasis><property>JBoss Core Portlet</property></emphasis> and click the <guibutton>OK</guibutton> button.</para> <figure> <title>Enabling the JBoss Core Portlet Facet</title> @@ -120,24 +99,23 @@ <note> <title>Note:</title> - <para>If the portlet libraries aren&apos;t available in the runtime you targeted, - <emphasis> - <property>JBoss Portlets</property></emphasis> facets will be hidden on this page.</para> - <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in - <xref linkend="preferences"/>.</para> + <para> + If the portlet libraries aren&apos;t available in the runtime you targeted, <emphasis><property>JBoss Portlets</property></emphasis> facets will be hidden on this page. + </para> + <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in <xref linkend="preferences"/>.</para> </note> </listitem> <listitem> - <para>The <property>Java</property> and <property>Web Module</property> pages are for configuring Java and Web modules in the project. - Here all values are set, so leave everything as it is.</para> + <para> + The <property>Java</property> and <property>Web Module</property> pages are for configuring Java and Web modules in the project. Here the default values are fine, so leave everything as it is. + </para> </listitem> <listitem> - <para>The last wizard page will ask you to add JBoss Portlet capabilities to the - project. Select <emphasis> - <property>Portlet Target Runtime Provider</property></emphasis> and click <emphasis> - <property>Finish</property></emphasis> to complete the project creation.</para> + <para> + The last wizard page will ask you to add JBoss Portlet capabilities to the project. Select <emphasis><property>Portlet Target Runtime Provider</property></emphasis> and click the <guibutton>Finish</guibutton> button to complete the project creation. + </para> <figure> <title>Including the Portlet Libraries Provided by Target Runtime</title> @@ -151,15 +129,17 @@ <note> <title>Note:</title> <para>All types available under <emphasis> - <property>Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at: + <property>Portlet Implementation Library</property> + </emphasis> are fully described in the Wiki article at: <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries"... </note> </listitem> </orderedlist> <para>As the result, <property>JBoss Portlet Tools</property> adds <emphasis> - <property>JBoss Core Portlet</property></emphasis> facet to the project, - creates an empty <literal>portlet.xml</literal> file and adds the JBoss Portlet library to the project classpath.</para> + <property>JBoss Core Portlet</property> + </emphasis> facet to the project, + creates an empty <filename>portlet.xml</filename> file and adds the JBoss Portlet library to the project classpath.</para> <figure> <title>Portlet Project Structure Overview</title> @@ -169,19 +149,21 @@ </imageobject> </mediaobject> </figure> - </section> + </section> - <section id="adding_java_portlet"> - <title>Adding a Java Portlet to a Web Project</title> - - <para>At the previous section you have created a web project with JBoss Portlet capabilities. - The next steps will show you how to add a new Java portlet to the project.</para> + <section id="adding_java_portlet"> + <title>Adding a Java Portlet to a Web Project</title> + <para> + At the previous section you have created a web project with JBoss Portlet capabilities. The next steps will show you how to add a new Java portlet to the project. + </para> + <orderedlist> - <listitem> - <para>Right-click the project and follow to <emphasis> - <property>New &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; Java - Portlet</property>.</emphasis></para> + <listitem> + <para> + Right-click the project and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>Portlet</guimenuitem><guimenuitem>Java + Portlet</guimenuitem></menuchoice>. + </para> <figure> <title>New Java Portlet</title> @@ -194,15 +176,7 @@ </listitem> <listitem> - <para>The <property>Create Portlet</property> wizard starts (for information about the wizard options, see - <xref linkend="java_portlet_wizard"/> in the guide reference). - The wizard fills in the <emphasis><property>Project</property></emphasis> and <emphasis> - <property>Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name - (for instance, <emphasis> - <property>org.example</property></emphasis> and <emphasis> - <property>TestPortlet</property></emphasis>). Then click <emphasis> - <property>Next</property> - </emphasis>.</para> + <para>The <property>Create Portlet</property> wizard starts (for information about the wizard options, see <xref linkend="java_portlet_wizard"/> in the guide reference). The wizard fills in the <emphasis><property>Project</property></emphasis> and <emphasis><property>Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name (for instance, <emphasis><property>org.example</property></emphasis> and <emphasis><property>TestPortlet</property></emphasis>). Then click the <guibutton>Next</guibutton> button.</para> <figure> <title>Specifying Class File Destination</title> @@ -214,84 +188,85 @@ </figure> </listitem> - <listitem><para>You may leave the next three pages with default values, on the last one hit <emphasis> - <property>Finish</property>.</emphasis></para> + <listitem> + <para> + You may leave the next three pages with default values, on the last one click the <guibutton>Finish</guibutton> button. + </para> </listitem> </orderedlist> - <para>Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<literal>TestPortlet.java</literal>), - <literal>default-object.xml</literal> and <literal>portlet-instances.xml</literal> files and the <literal>portlet.xml</literal> descriptor is updated as well.</para> + <para> + Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<filename>TestPortlet.java</filename>), <filename>default-object.xml</filename> and <filename>portlet-instances.xml</filename> files and the <filename>portlet.xml</filename> descriptor is updated as well. + </para> - <figure> - <title>Structure of the Project with a Java Portlet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_12.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Structure of the Project with a Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_12.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Thus, now the project is ready to be built and deployed.</para> - </section> + <para>Now the project is ready to be built and deployed.</para> + </section> - <section id="deploying_to_portal"> - <title>Deploying a Portlet to JBoss Portal</title> + <section id="deploying_to_portal"> + <title>Deploying a Portlet to JBoss Portal</title> - <para>You can deploy a portlet project in the way you deploy any other web application.</para> + <para>You can deploy a portlet project in the way you deploy any other web application.</para> - <orderedlist> - <listitem> - <para>Right-click the project and do <emphasis> - <property>Run As &gt; Run On Server</property>. - </emphasis> The <property>Run On Server</property> wizard starts.</para> + <orderedlist> + <listitem> + <para> + Right-click the project and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server</guimenuitem></menuchoice>. The <guilabel>Run On Server</guilabel> wizard starts. + </para> - <figure> - <title>Running the Java Portlet on Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/runOnServer.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <figure> + <title>Running the Java Portlet on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/runOnServer.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> - <listitem> - <para>Select <emphasis><property>JBoss Portal 2.7 Server</property></emphasis> created before and click <emphasis><property>Next</property>.</emphasis></para> - </listitem> + <listitem> + <para>Select <emphasis><property>JBoss Portal 2.7 Server</property></emphasis> created before and click the <guibutton>Next</guibutton> button. + </para> + </listitem> - <listitem> - <para>On the <emphasis> - <property>Add and Remove</property> - </emphasis> page move the created project to the right and click <emphasis> - <property>Finish</property>.</emphasis></para> + <listitem> + <para> + On the <emphasis><property>Add and Remove</property></emphasis> page move the created project to the right and click <guilabel>Finish</guilabel>. + </para> - <figure> - <title>Deploying the Portlet Application</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_13.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Deploying the Portlet Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_13.png"/> + </imageobject> + </mediaobject> + </figure> - <para>It will deploy the portlet application and start <property>JBoss - AS</property>.</para> - </listitem> + <para>It will deploy the portlet application and start <property>JBoss AS</property>.</para> + </listitem> - <listitem> - <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your - portlet in the browser.</para> + <listitem> + <para>Use the <ulink url="http://localhost:8080/portal/portal/default/default">http://localhost:8080/portal/portal/default/default</ulink> URL to see your portlet in the browser.</para> - <figure> - <title>Java Portlet in the Browser Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_14.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </orderedlist> - </section> + <figure> + <title>Java Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_14.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> </section> Modified: branches/jbosstools-3.2.x/portlet/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.2.x/portlet/docs/reference/pom.xml 2011-07-18 01:59:12 UTC (rev 32975) +++ branches/jbosstools-3.2.x/portlet/docs/reference/pom.xml 2011-07-18 02:02:34 UTC (rev 32976) @@ -1,7 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<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/xsd/maven-4.0.0.xsd"> +<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/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.jboss.tools</groupId> @@ -10,229 +8,232 @@ <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> - <properties> - <translation>en-US</translation> - <docname>JBoss_Portal_Tools_Reference_Guide</docname> - <bookname>JBoss Portal Tools Reference Guide</bookname> - </properties> - - <profiles> + <properties> + <translation>en-US</translation> + <docname>JBoss_Portal_Tools_Reference_Guide</docname> + <bookname>JBoss Portal Tools Reference Guide</bookname> + </properties> + <profiles> + <!-- mvn compile --> - <profile> - <id>all</id> - <activation> - <activeByDefault>true</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>all</id> + <activation> + <activeByDefault>true</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.4</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <useRelativeImageUris>true</useRelativeImageUris> + </options> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml --> - <profile> - <id>html</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>html</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml-single --> - <profile> - <id>html-single</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - </plugin> + <profile> + <id>html-single</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Ppdf --> - <profile> - <id>pdf</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>pdf</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Peclipse --> - <profile> - <id>eclipse</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> - </plugins> - </build> - </profile> + <profile> + <id>eclipse</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> - </profiles> - <build> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <dependencies> - <dependency> - <groupId>org.jboss.pressgang</groupId> - <artifactId>pressgang-xslt</artifactId> - <version>1.2.0</version> - </dependency> - <dependency> - <groupId>org.jboss</groupId> - <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.1</version> - <type>jdocbook-style</type> - </dependency> - </dependencies> - <configuration> - <sourceDirectory>${project.basedir}</sourceDirectory> + </profiles> + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss.pressgang</groupId> + <artifactId>pressgang-xslt</artifactId> + <version>1.2.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.1</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${project.basedir}</sourceDirectory> <!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> --> - <sourceDocumentName>master.xml</sourceDocumentName> - <masterTranslation>en-US</masterTranslation> - <imageResource> - <directory>${project.basedir}/en-US</directory> - <includes> - <include>images/**/*</include> - </includes> - </imageResource> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${pdf.name}</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - <options> - <xincludeSupported>true</xincludeSupported> - <xmlTransformerType>saxon</xmlTransformerType> - <docbookVersion>1.72.0</docbookVersion> - <localeSeparator>-</localeSeparator> - <transformerParameters> - <property> - <name>javax.xml.parsers.DocumentBuilderFactory</name> - <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> - </property> - <property> - <name>javax.xml.parsers.SAXParserFactory</name> - <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> - </property> - </transformerParameters> - </options> - </configuration> - </plugin> - </plugins> - </pluginManagement> - </build> + <sourceDocumentName>master.xml</sourceDocumentName> + <masterTranslation>en-US</masterTranslation> + <imageResource> + <directory>${project.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${pdf.name}</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> + <localeSeparator>-</localeSeparator> + <transformerParameters> + <property> + <name>javax.xml.parsers.DocumentBuilderFactory</name> + <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> + </property> + <property> + <name>javax.xml.parsers.SAXParserFactory</name> + <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> + </property> + </transformerParameters> + </options> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> </project>