Author: smukhina Date: 2007-07-06 07:28:48 -0400 (Fri, 06 Jul 2007) New Revision: 2336 Modified: trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/BusinessProcessAndRulesApplication.xml trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedForCreatingaJSFApplication.xml trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedGuideforJSFwithHibernate.xml trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedStrutsValidationExamples.xml trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedWithRHDS.xml.bak Log: http://jira.jboss.com/jira/browse/EXIN-373 italic font style Modified: trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/BusinessProcessAndRulesApplication.xml =================================================================== --- trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/BusinessProcessAndRulesApplication.xml 2007-07-06 10:06:18 UTC (rev 2335) +++ trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/BusinessProcessAndRulesApplication.xml 2007-07-06 11:28:48 UTC (rev 2336) @@ -49,7 +49,7 @@ Those files are very simple and we will review them as we go along with the tutorial. We import them here to reduce potential typos and other errors in the tutorial.</para> <orderedlist> -<listitem>Choose the File -> Import ... menu and then select General -> Existing project into workspace and +<listitem>Choose the <emphasis>File -> Import ...</emphasis> menu and then select <emphasis>General -> Existing</emphasis> project into workspace and click on the Next button.</listitem> </orderedlist> <figure> @@ -90,7 +90,7 @@ </mediaobject> </figure> <orderedlist continuation="continues"> -<listitem>Right click on the rules-bpm/build.xml file, and select Run AS ... -> Ant Build.</listitem> +<listitem>Right click on the rules-bpm/build.xml file, and select <emphasis>Run AS ... -> Ant</emphasis> Build.</listitem> </orderedlist> <figure> @@ -120,8 +120,8 @@ <orderedlist> <listitem>Select the<emphasis> EclipseCon/resources </emphasis>directory. That is where we are going to put the rules definition file.</listitem> - <listitem>Select the following menu actions: File -> New -> Other ... -> JBoss Rules -> New - Rules Resource to bring up the JBoss Rules wizard.</listitem> + <listitem>Select the following menu actions: F<emphasis>ile -> New -> Other ... -> JBoss Rules -> New + Rules Resource</emphasis> to bring up the JBoss Rules wizard.</listitem> </orderedlist> <figure> <title>New Rules File</title> @@ -181,7 +181,7 @@ ]]></programlisting> <para>Notice that the IDE automatically highlights the syntax and provides auto-completion help. You may wonder how Seam knows to load the process-order.drl file for the application.</para> - <para>If you look in the resources/WEB-INF/components.xml file we copied from the imported + <para>If you look in the <emphasis>resources/WEB-INF/components.xml</emphasis> file we copied from the imported rules-bpm project. It has an element pointing to the process-order.drl file.</para> <programlisting role="XML"><![CDATA[<drools:rule-base name="securityRules"> <drools:rule-files> @@ -198,7 +198,7 @@ refunded. Since the business analyst typically designs this process, it is very high level and can be drawn up in a GUI designer.</para> <orderedlist> - <listitem>Select the<emphasis> EclipseCon/resources </emphasis>folder and select menu actions File -> New -> File. + <listitem>Select the<emphasis> EclipseCon/resources </emphasis>folder and select menu actions <emphasis>File -> New -> File</emphasis>. Add a new file called process-order.jpdl.xml as shown below:</listitem> </orderedlist> <figure> @@ -220,8 +220,8 @@ </process-definition> ]]></programlisting> <orderedlist continuation="continues"> -<listitem>Right click on the process-order.jpdl.xml file and select Open with ... -> jBPM -Graphical Process Designer.</listitem> +<listitem>Right click on the process-order.jpdl.xml file and select <emphasis>Open with ... -> jBPM +Graphical Process Designer</emphasis>.</listitem> </orderedlist> <figure> <title>Opening Graphical Process Designer</title> @@ -264,8 +264,8 @@ the outcome of each node – hence the next node in the process.</para> <para>Let&apos;s go through the exercise for the &quot;Check Inventory&quot; node first.</para> <orderedlist> - <listitem>Right click on the &quot;Check Inventory&quot; node in the designer and select Add - Actions -> Node Enter from the menu as shown below.</listitem> + <listitem>Right click on the &quot;Check Inventory&quot; node in the designer and select <emphasis>Add + Actions -> Node Enter </emphasis>from the menu as shown below.</listitem> </orderedlist> <figure> <title>Node Entering</title> @@ -291,7 +291,7 @@ <orderedlist continuation="continues"> <listitem>Double click on action1 to bring up the wizard. Select Handler on the left and enter com.mydomain.EclipseCon.process. CheckInventoryAction as the class and bean as the type as shown - below. You can can also search for the class by clicking on the Browse.. button.</listitem> + below. You can can also search for the class by clicking on the <emphasis>Browse...</emphasis> button.</listitem> </orderedlist> <figure> <title>Action Handler</title> Modified: trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedForCreatingaJSFApplication.xml =================================================================== --- trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedForCreatingaJSFApplication.xml 2007-07-06 10:06:18 UTC (rev 2335) +++ trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedForCreatingaJSFApplication.xml 2007-07-06 11:28:48 UTC (rev 2336) @@ -213,7 +213,7 @@ box in the editor after &quot;Please enter name:&quot;</para></listitem> <listitem><para>In the attributes dialog, click in the value field next to the value attribute and click on the <emphasis>... </emphasis>button</para></listitem> -<listitem><para>Then, select the Managed Beans/personBean/name node and click on the Ok +<listitem><para>Then, select the <emphasis>Managed Beans/personBean/name</emphasis> node and click on the Ok button</para></listitem> <listitem><para>Back in the attributes dialog, select the Advanced tab, type in name as the value for the id attribute, and then click on the Finish button</para></listitem>' @@ -221,7 +221,7 @@ innermost box in the editor after the input box</para></listitem> <listitem><para>In the attributes dialog, click in the value field next to the action attribute and click on the <emphasis>... </emphasis>button</para></listitem> -<listitem><para>Then, select the View Actions/greeting node and click on the Ok button</para></listitem> +<listitem><para>Then, select the <emphasis>View Actions/greetin</emphasis>g node and click on the Ok button</para></listitem> <listitem><para>Back in the attributes dialog box, type in Say Hello as the value for the value attribute (&quot;Say Hello&quot;) and then click on the Finish button</para></listitem> </itemizedlist> @@ -269,7 +269,7 @@ box in the editor after &quot;Hello&quot;</para></listitem> <listitem><para>In the attributes dialog, click in value field next to the value attribute and click on the ... button</para></listitem> -<listitem><para>Then, select the Managed Beans/personBean/name node, click on the Ok button, +<listitem><para>Then, select the <emphasis>Managed Beans/personBean/name</emphasis> node, click on the Ok button, and then click on the Finish button</para></listitem> <listitem><para>Right after the output field, type an exclamation point (!)</para></listitem> </itemizedlist> @@ -319,7 +319,7 @@ <para>Note the .jsf extension for the file name. This is a mapping defined in the web.xml file for the project for invoking JavaServer Faces when you run the application.</para> <itemizedlist continuation="continues"> -<listitem><para>Select File/Save from the menu bar.</para></listitem> +<listitem><para>Select<emphasis> File/Save</emphasis> from the menu bar.</para></listitem> </itemizedlist> </section> <section id="RunningTheApplicationJSF"> Modified: trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedGuideforJSFwithHibernate.xml =================================================================== --- trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedGuideforJSFwithHibernate.xml 2007-07-06 10:06:18 UTC (rev 2335) +++ trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedGuideforJSFwithHibernate.xml 2007-07-06 11:28:48 UTC (rev 2336) @@ -25,7 +25,7 @@ </itemizedlist> <para>The ormHibernate3-jsf project should appear in the Package Explorer with a standard Web application structure. As we mentioned before, this is a JSF application. To see the JSF configuration file, browse to - WebContent/WEB-INF/faces-config.xml.</para> + <emphasis>WebContent/WEB-INF/faces-config.xml</emphasis>.</para> <para>In the JavaSource folder, you will find the following Java source files. We will briefly explain these files and then run the application.</para> <table> @@ -163,7 +163,7 @@ <itemizedlist continuation="continues"> <listitem><para>In the ORM Explorer view, reveal the -ormHibernate3-jsf/JavaSource/hibernate.cfg.xml/demo/User -> user node, right-click it, and select +<emphasis>ormHibernate3-jsf/JavaSource/hibernate.cfg.xml/demo/User -> user node</emphasis>, right-click it, and select Open Mapping from the context menu.</para></listitem> <listitem><para>In the editor that opens up for the mapping file, just change the class attribute for generator to a value of assigned and you&apos;re done with this file.</para></listitem> @@ -396,7 +396,7 @@ <title>Creating the Database Table</title> <para>Let&apos;s first create the script for our database table in Red Hat Developer Studio.</para> <itemizedlist continuation="continues"> -<listitem><para>In the ORM Explorer view, right-click on JavaSource/hibernate.cfg.xml and select "Generate DDL Wizard".</para></listitem> +<listitem><para>In the ORM Explorer view, right-click on <emphasis>JavaSource/hibernate.cfg.xml</emphasis> and select "Generate DDL Wizard".</para></listitem> <listitem><para>Select HSQL as the Dialect and leave Location as is.</para></listitem> <listitem><para>Click Finish.</para></listitem> @@ -409,12 +409,12 @@ <title>Making the Database Available for the Application</title> <para>The databse server, HSQLDB, is provided with the project. It&apos;s located in the ormHibernate3-jsf/hsqldb folder.</para> <itemizedlist continuation="continues"> -<listitem><para>Start the database server: .../ormHibernate3-jsf/hsqldb/bin/server.bat</para></listitem> -<listitem><para>In a separate window, start the admin tool: .../ormHibernate3-jsf/hsqldb/bin/dbadmin.bat</para></listitem> +<listitem><para>Start the database server: <emphasis>.../ormHibernate3-jsf/hsqldb/bin/server.bat</emphasis></para></listitem> +<listitem><para>In a separate window, start the admin tool: <emphasis>.../ormHibernate3-jsf/hsqldb/bin/dbadmin.bat</emphasis></para></listitem> </itemizedlist> <para>This will launch a small GUI application, HSQL Database Manager.</para> <itemizedlist continuation="continues"> -<listitem><para>Leave all values as they are, only change URL: to the following: jdbc:hsqldb:hsql://localhost</para></listitem> +<listitem><para>Leave all values as they are, only change URL: to the following: <emphasis>jdbc:hsqldb:hsql://localhost</emphasis></para></listitem> <listitem><para>Click OK.</para></listitem> <listitem><para>Select <emphasis> File/Open Script...</emphasis>from the menu bar of HSQL Database Manager.</para></listitem> <listitem><para>Find and open the the DDL file we just created.</para></listitem> @@ -424,7 +424,7 @@ <para>The User database should now appear in the expand/collapse tree to the left.</para> <itemizedlist continuation="continues"> <listitem><para>Select<emphasis> File/Exit </emphasis>from the menu bar.</para></listitem> -<listitem><para>Stop the database server: .../ormHibernate3-jsf/hsqldb/bin/shutdown.bat</para></listitem> +<listitem><para>Stop the database server: <emphasis>.../ormHibernate3-jsf/hsqldb/bin/shutdown.bat</emphasis></para></listitem> </itemizedlist> </section> Modified: trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedStrutsValidationExamples.xml =================================================================== --- trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedStrutsValidationExamples.xml 2007-07-06 10:06:18 UTC (rev 2335) +++ trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedStrutsValidationExamples.xml 2007-07-06 11:28:48 UTC (rev 2336) @@ -183,7 +183,7 @@ <listitem><para>In the Edit Properties window, insert the cursor into the value column for the input property and click on the <emphasis>...</emphasis> button.</para></listitem> -<listitem><para>In the dialog box, make sure the Pages tab is selected, select StrutsHello/WEB-ROOT(WebContent)/pages/inputname.jsp, click the Ok button, and then click on the Close button.</para></listitem> +<listitem><para>In the dialog box, make sure the Pages tab is selected, select <emphasis>StrutsHello/WEB-ROOT(WebContent)/pages/inputname.jsp</emphasis>, click the Ok button, and then click on the Close button.</para></listitem> </itemizedlist> </section> <section id="EditingTheFormBean"> Modified: trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedWithRHDS.xml.bak =================================================================== --- trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedWithRHDS.xml.bak 2007-07-06 10:06:18 UTC (rev 2335) +++ trunk/documentation/GettingStartedGuide/docs/userguide/en/modules/GettingStartedWithRHDS.xml.bak 2007-07-06 11:28:48 UTC (rev 2336) @@ -10,30 +10,6 @@ </keywordset> </chapterinfo> <title>Getting Started with Red Hat Developer Studio</title> - <section id="TechnicalRequirements"> - <?dbhtml filename="TechnicalRequirements.html"?> -<title>Technical Requirements</title> - <section id="Java"> - <title>Java</title> - <para>Before installing Red Hat Developer Studio, make sure you have one of the following versions of Java - installed:</para> - <itemizedlist> - <listitem><para>JDK 1.4.2 or higher</para></listitem> - </itemizedlist> - <para>It must be the full JDK, not just the JRE (Java Runtime Environment). For more information about - target operating environments and compatible Java versions please refer to the JBoss web site. Please note - that the Eclipse documentation states that you only need a Java Runtime Environment for Eclipse, but to - use Red Hat Developer Studio requires a full JDK in order to compile Java classes and JSP pages.</para> - </section> - <section id="OperatingSystems"> - <?dbhtml filename="OperatingSystems.html"?> - <title>Operating Systems</title> - <itemizedlist> - <listitem><para>Windows</para></listitem> - <listitem><para>Linux</para></listitem> - </itemizedlist> - </section> - </section> <section id="Installing"> <?dbhtml filename="Installing.html"?> <title>Installing</title> @@ -57,100 +33,46 @@ </mediaobject> </figure> - <para>After installation process you will have all required platforms to run Red Hat Developer Studio:</para> + <para>Installation process includes all required platforms to run Red Hat Developer Studio:</para> <itemizedlist> <listitem> <para>Eclipse 3.2.2</para> </listitem> <listitem> - <para>JBoss Application Server</para> + <para>JBoss J2EE Application Server</para> + <figure> + <title>JBoss J2EE Application Server installing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/install2.png"/> + </imageobject> + </mediaobject> + </figure> + <note>The installer will install JBoss J2EE Application Server for running your applications if you select this option during the installation process. + If you want to use a different server than ours, you can change the setting in Red Hat Developer Studio.</note> </listitem> </itemizedlist> - - <para>Red Hat Developer Studio comes with the following plug-ins:</para> - <itemizedlist> - <listitem><para>WTP runtime 1.5</para></listitem> - <listitem><para>GEF runtime 3.2</para></listitem> - <listitem><para>JEM runtime 1.2</para></listitem> - <listitem><para>EMF and SDO runtime 2.2</para></listitem> - <listitem><para>XSD runtime 2.2</para></listitem> - <listitem>Hibernate-tools-3.1.0 beta5 (without WTP, EMF, GEF, and other non-Hibernate plug-ins from - Hibernate-tools-3.1.0 beta5)</listitem> - <listitem><para>QuickImage 0.2.0</para></listitem> - <listitem><para>Spring IDE 1.3.2</para></listitem> - <listitem><para>Sun Glassfish 0.3</para></listitem> - </itemizedlist> - </section> <section id="InstallingthroughTheUpdateSite"> <?dbhtml filename="InstallingthroughTheUpdateSite.html"?> - <title>Installing through the update Site</title> + <title>Installing via update Site</title> TBD </section> </section> - <section id="RunningForTheFirstTime"> - <?dbhtml filename="RunningForTheFirstTime.html"?> - <title>Running for the First Time</title> - <itemizedlist> - <listitem><para> Launch Eclipse</para></listitem> - <listitem><para> Select Window/Open Perspective.../Other...</para></listitem> - <listitem><para> Select Red Hat Developer Studio from the perspective list</para></listitem> - </itemizedlist> - <para>We recommend starting Eclipse with VM arguments to make more memory (heap) available for large-scale projects. Open the file &lt;eclipse&gt;\eclipse.ini and set the following:</para> - <para>eclipse -clean -vmargs -Xms512m -Xmx512m -XX:MaxPermSize=128m</para> - <para>This setting will allow the Java heap to grow to 512MB.</para> - </section> - <section id="Upgrading"> + <section id="Upgrading"> <?dbhtml filename="Upgrading.html"?> <title>Upgrading</title> <para>To upgrade, just uninstall your current version and install the new version.</para> - - <itemizedlist> - <listitem><para> Make sure Eclipse is not running.</para> -<para>Uninstall your current version of RHDS. You can do one of the following:</para> -</listitem> -<listitem><para>Run the Red Hat Developer Studio uninstaller</para></listitem> - <listitem><para>Delete the file {EclipseHome}/links/com.exadel.studio.link</para> -<para>Either method will uninstall RHDS.</para> -</listitem> -<listitem>Start Eclipse: - <para>eclipse -clean</para></listitem> - </itemizedlist> - - <itemizedlist> - <listitem><para>Close Eclipse</para></listitem> - <listitem><para>Install the new version of Red Hat Developer Studio.</para></listitem> - <listitem>After installation, start Eclipse with the -clean option: - <para>eclipse -clean</para></listitem> - </itemizedlist> - - <para>This step is very important as it will clear the Eclipse cache of the old uninstalled plug-in.</para> - <note> - <title>Note:</title> - <para>It is recommended to uninstall Red Hat Developer along with Eclipse and install Red Hat Developer - Studio into a new clean Eclipse</para> - </note> - </section> + </section> <section id="Uninstalling"> <?dbhtml filename="Uninstalling.html"?> <title>Uninstalling</title> - <para> Make sure Eclipse is not running.</para> - <para> Uninstall your current version of Red Hat Developer Studio. You can do one of the following:</para> - <itemizedlist> - <listitem><para>Run the Red Hat Developer Studio uninstaller</para></listitem> - <listitem><para>Delete the file {EclipseHome}/links/com.exadel.studio.link</para> -<para>Either method will uninstall Red Hat Developer Studio.</para> -</listitem> -</itemizedlist> - <itemizedlist> - <listitem><para>Start Eclipse with the -clean option:</para> -<para>eclipse -clean</para> -</listitem> -</itemizedlist> - <para>This step is very important as it will clear the Eclipse cache of the uninstalled plug-in.</para> + <para>Make sure Red Hat Developer Studio is not running.</para> + <para>Uninstall your current version of Red Hat Developer Studio by running uninstaller.</para> + </section> <section id="Subscription"> <?dbhtml filename="Subscription.html"?> @@ -162,15 +84,75 @@ <title>Support</title> <para>If you have comments or questions, you can send them to <ulink url="mailto:support@exadel.com">support@exadel.com</ulink> or - <ulink url="">Red Hat Developer Studio Forum</ulink>.</para> + <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Hat Developer Studio Forum</ulink>.</para> <para>When writing to support, please include the following information:</para> <itemizedlist> - <listitem><para>Eclipse version</para></listitem> <listitem><para> Red Hat Developer Studio version</para></listitem> <listitem><para>Exact error message</para></listitem> <listitem><para>Exact steps you took to get the error</para></listitem> </itemizedlist> </section> +<section id="FAQ"> + <?dbhtml filename="FAQ.html"?> + <title>FAQ</title> + <para>For easy reference to Red Hat Developer Studio related questions, our FAQ provides answers to our most &quot;popular&quot; questions. + The sections of questions are organized by type. For further support, please contact support(a)exadel.com.&lt;/para&gt; + <section id="Before_Installing"> + <title>Before Installing, Tutorials, Examples, Readme Files</title> + <para><emphasis role="bold">I'm looking for examples, do you have any?</emphasis></para> + <para>Yes, simply go to our tutorials page</para> + <para><emphasis role="bold">Where can I find the Red Hat Developer Studio readme file?</emphasis></para> + <para>It's at http://www.exadel.com/web/portal/products/ReleaseNotes</para> + <para><emphasis role="bold">Where can I find some documentation for Red Hat Developer Studio?</emphasis></para> + <para>Try these resources:</para> + <para>TBD</para> + <para><emphasis role="bold">What version of Eclipse does Red Hat Developer Studio support?</emphasis></para> + <para>Red Hat Developer Studio works with Eclipse 3.2.2 </para> + </section> + <section id="Downloading"> + <title>Downloading</title> + <para><emphasis role="bold">Where can I download a copy of Red Hat Developer Studio?</emphasis></para> + <para>Simply go TBD. </para> + </section> + <section id="Installation_Issues"> + <title>Installation Issues</title> + <para><emphasis role="bold">Do I need to have JBoss server installed to run Red Hat Developer Studio?</emphasis></para> + <para>No. Red Hat Developer Studio already comes bundled with JBoss server. We bundle it together so that you don't need to download any + additional software and can test your application in a Web browser right away.</para> + <para>If you want to use a different JBoss server installation, after installing, simply go to preferences and change the settings to point to another + Jboss server installation.</para> + <para>Red Hat Developer Stuiod works with any serlvet container, not just JBoss. For more information on deployment, please see the Deploying Your Application section.</para> + <para><emphasis role="bold"> What third-party plug-ins are installed with RHDS?</emphasis></para> + <para>Read the <link linkend="Installing">Installing</link> section.</para> + </section> + <section id="Importing_Projects"> + <title>Importing Projects</title> + <para><emphasis role="bold">I have an existing Struts or JSF project. Can I open the project in RHDS?</emphasis></para> + <para>Yes. Read the TBD</para> + <para><emphasis role="bold">Can I import a .war file?</emphasis></para> + <para>Yes. Read the TBD</para> + </section> + <section id="Troubleshooting"> + <title>Troubleshooting, Problems, Configuration, Error Messages</title> + <para><emphasis role="bold">Is it possible to increase the performance of Eclipse after installing your product? My Eclipse now crawls.</emphasis></para> + <para>By default, Eclipse allocates only 128 Mb of memory whatever physical memory you actually have installed. You can significantly increase performance + if you allocate more memory. For example:</para> + <para>eclipse.exe -vmargs -Xmx512M</para> + <para><emphasis role="bold">How can I add my own tag library to the Red Hat Palette?</emphasis></para> + <para>See Adding Tag Libraries in JBossJSFTools Guide</para> + <para><emphasis role="bold">I see the Oracle ADF Faces component library tags in the Red Hat Palette, but I can't seem to find the libraries for ADF. + How do I use this component library with RHDS?</emphasis></para> + <para>See Adding Support for the Oracle ADF Components Library in the RHDS User Guide.</para> + </section> +</section> + +<section id="OtherRelevantResourcesOnTheTopic33"> +<?dbhtml filename="OtherRelevantResourcesOnTheTopic33.html"?> +<title>Other relevant resources on the topic</title> +<para>RHDS on JBoss: <ulink url="http://labs.jboss.com/rhdevstudio/">Red Hat Developer Studio</ulink></para> +<para>Forum: <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Forum</ulink></para> +<para>Download: <ulink url="http://www.exadel.com/web/portal/download/esp35">RHDS Download</ulink></para> +</section> </chapter>