[jbosstools-commits] JBoss Tools SVN: r14977 - in trunk/documentation/guides/GettingStartedGuide/en: modules and 1 other directory.

Author: chukhutsina Date: 2009-04-30 09:08:52 -0400 (Thu, 30 Apr 2009) New Revision: 14977 Modified: trunk/documentation/guides/GettingStartedGuide/en/images/first_seam/first_seam10.png trunk/documentation/guides/GettingStartedGuide/en/modules/jsp_application.xml trunk/documentation/guides/GettingStartedGuide/en/modules/rad_jsf_application.xml Log: https://jira.jboss.org/jira/browse/JBDS-652 - Code patterns in text .All the code patterns were marked with the tag <code>.The incorrect picture was modified. Modified: trunk/documentation/guides/GettingStartedGuide/en/images/first_seam/first_seam10.png =================================================================== (Binary files differ) Modified: trunk/documentation/guides/GettingStartedGuide/en/modules/jsp_application.xml =================================================================== --- trunk/documentation/guides/GettingStartedGuide/en/modules/jsp_application.xml 2009-04-30 12:32:19 UTC (rev 14976) +++ trunk/documentation/guides/GettingStartedGuide/en/modules/jsp_application.xml 2009-04-30 13:08:52 UTC (rev 14977) @@ -9,16 +9,16 @@ </keywordset> </chapterinfo> <title>Developing a simple JSP web application</title> - + <note> <title>Note:</title> <para>We highly recommend developing in <property>Seam</property>. This chapter is for users who for some reason cannot use Seam.</para> </note> - + <para>In this chapter you'll find out how to create a simple <ulink - url="http://java.sun.com/products/jsp/">JSP</ulink> application using the - <property>JBoss Developer Studio</property>. The application will show a classic + url="http://java.sun.com/products/jsp/">JSP</ulink> application using the + <property>JBoss Developer Studio</property>. The application will show a classic &quot;Hello World!&quot; on the page.</para> <para>We&apos;ll assume that you have already launched <property>JBoss Developer Studio</property> and also that the <property>Web Development</property> perspective is the @@ -28,7 +28,7 @@ <property>Window &gt; Open Perspective &gt; Other...</property> </emphasis> from the menu bar and then selecting Web Development from the Select Perspective dialog box.</para> - + <section id="SettingUpTheProject"> <?dbhtml filename="SettingUpTheProject.html"?> <title>Setting Up the Project</title> @@ -38,18 +38,18 @@ <itemizedlist> <listitem> <para>Go to the menu bar and select <emphasis> - <property>File &gt; New &gt; Other...</property> - </emphasis></para> + <property>File &gt; New &gt; Other...</property> + </emphasis></para> </listitem> <listitem> <para>Select <emphasis> - <property>Web &gt; Dynamic Web Project</property> - </emphasis> in the New Project dialog box</para> + <property>Web &gt; Dynamic Web Project</property> + </emphasis> in the New Project dialog box</para> </listitem> <listitem> <para>Click <emphasis> - <property>Next</property> - </emphasis> + <property>Next</property> + </emphasis> </para> </listitem> <listitem> @@ -57,10 +57,10 @@ </listitem> <listitem> <para>Then select <emphasis> - <property>Minimal Configuration</property> - </emphasis> from the list of possible configurations and click <emphasis> - <property>Finish</property> - </emphasis></para> + <property>Minimal Configuration</property> + </emphasis> from the list of possible configurations and click <emphasis> + <property>Finish</property> + </emphasis></para> </listitem> </itemizedlist> <figure> @@ -71,10 +71,10 @@ </imageobject> </mediaobject> </figure> - + <para>The <emphasis> - <property>jspHello</property> - </emphasis> node should appear in the upper-left <property>Package Explorer</property> + <property>jspHello</property> + </emphasis> node should appear in the upper-left <property>Package Explorer</property> view.</para> <figure> <title>New Web Project</title> @@ -85,32 +85,32 @@ </mediaobject> </figure> </section> - + <section id="CreatingJSPPage"> <?dbhtml filename="CreatingJSPPage.html"?> <title>Creating JSP Page</title> <para>This section covers all the points how to create, edit and then preview JSP page.</para> <para>In our simple application we need to create only one JSP page which displays a - <emphasis>&quot;Hello World!&quot;</emphasis> message.</para> + <emphasis>&quot;Hello World!&quot;</emphasis> message.</para> <itemizedlist> <listitem> <para>Right click <emphasis><property>WebContent &gt; New &gt; - JSP</property>. </emphasis></para> + JSP</property>. </emphasis></para> </listitem> <listitem> <para>Type &quot;hello.jsp&quot; for a file name and click the <emphasis> - <property>Next</property> - </emphasis> button.</para> + <property>Next</property> + </emphasis> button.</para> </listitem> </itemizedlist> <para>In the next window you can choose a template for your jsp page and see its preview.</para> <itemizedlist> <listitem> <para>Select <emphasis> - <property>New JSP File (xhtml)</property> - </emphasis> template and click <emphasis> - <property>Finish</property> - </emphasis> button.</para> + <property>New JSP File (xhtml)</property> + </emphasis> template and click <emphasis> + <property>Finish</property> + </emphasis> button.</para> </listitem> </itemizedlist> <figure> @@ -128,19 +128,26 @@ <?dbhtml filename="EditingJSPPage.html"?> <title>Editing a JSP Page</title> <para>Let&apos;s now make a little change so that a jsp page displays - <emphasis>&quot;Hello World!&quot;</emphasis> message.</para> + <emphasis>&quot;Hello World!&quot;</emphasis> message.</para> <itemizedlist> <listitem> - <para>Insert this line inside the <emphasis role="bold"> - <property>&lt;body&gt;</property> + <!--<para>Insert this line inside the <emphasis role="bold"> + <property>&lt;body&gt;</property> </emphasis><emphasis role="bold"> - <property>&lt;/body&gt;</property> - </emphasis> tag: </para> + <property>&lt;/body&gt;</property> + </emphasis> tag: </para>--> + <para> + + Insert this line inside the + <code>&lt;body&gt; &lt;/body&gt; + </code> + tag: + </para> </listitem> </itemizedlist> <programlisting role="XML"><![CDATA[<% System.out.println("Hello World!"); %>]]> -</programlisting> - + </programlisting> + <para>Notice that content assist functionality is always available when you are typing:</para> <figure> <title>Content Assist in JSP Page</title> @@ -151,8 +158,8 @@ </mediaobject> </figure> <para>After changes made your <emphasis> - <property>hello.jsp</property> - </emphasis> page should look like this:</para> + <property>hello.jsp</property> + </emphasis> page should look like this:</para> <figure> <title>Hello.jsp Page</title> <mediaobject> @@ -161,21 +168,21 @@ </imageobject> </mediaobject> </figure> - + <para>This line will actually output <emphasis>&quot;Hello World!&quot;</emphasis> message in the <property>Console</property>. To make the message displayed in the Browser, just replace this line with the simple - <emphasis>Hello World!</emphasis>.</para> + <emphasis>Hello World!</emphasis>.</para> </section> - + <section id="WebXML"> <?dbhtml filename="WebXML.html"?> <title>web.xml file</title> <para>When you are creating web project the wizard creates the <emphasis> - <property>web.xml</property> - </emphasis> for you automatically. The <property>web.xml file editor</property> + <property>web.xml</property> + </emphasis> for you automatically. The <property>web.xml file editor</property> provided by <property>JBoss Developer Studio</property> is available in two modes: - <property>Tree</property> and <property>Source</property>.</para> + <property>Tree</property> and <property>Source</property>.</para> <figure> <title>Web.xml in Design and Source Mode</title> <mediaobject> @@ -186,18 +193,18 @@ </mediaobject> </figure> <para>Both modes are fully synchronized. Let&apos;s add mapping to our <emphasis> - <property>hello.jsp</property> - </emphasis> page in <emphasis> - <property>web.xml</property> - </emphasis> file.</para> + <property>hello.jsp</property> + </emphasis> page in <emphasis> + <property>web.xml</property> + </emphasis> file.</para> <itemizedlist> <listitem> <para>Switch to <property>Source</property> tab.</para> </listitem> <listitem> - <para>Add the next code into <emphasis role="bold"> - <property>&lt;welcome-file-list&gt;</property> - </emphasis>:</para> + <para>Add the next code into + <code>&lt;welcome-file-list&gt;</code> + :</para> </listitem> </itemizedlist> <programlisting role="XML"><![CDATA[<welcome-file>hello.jsp</welcome-file> @@ -206,29 +213,29 @@ made are automatically reflected in that mode.</para> <para>Actually you don&apos;t really need to do any configurations right now.</para> </section> - + <section id="DeployTheProject"> <?dbhtml filename="DeployTheProject.html"?> <title>Deploying the project</title> <para>While creating any web project you could experience a pain writing ant scripts and managing the packaging even when writing the most trivial web applications. With - <property>JBoss Developer Studio</property> you are saved from such a pain. All + <property>JBoss Developer Studio</property> you are saved from such a pain. All you need is to start <property>JBoss Server</property> and launch your application in your favorite browser.</para> <para>You can also create a war archive with <ulink - url="&aslink;#Project_archivesView">JBDS&apos;s Archive Tools</ulink> + url="&aslink;#Project_archivesView">JBDS&apos;s Archive Tools</ulink> and export it to any web server.</para> <section id="WarConfig"> <?dbhtml filename="WarConfig.html"?> <title>WAR Config</title> <para>Project archives managing is available through <ulink - url="&aslink;#Project_archivesView">Project Archives view</ulink>.</para> + url="&aslink;#Project_archivesView">Project Archives view</ulink>.</para> <itemizedlist> <listitem> <para>Select <emphasis> - <property>Window &gt; Show view &gt; Other &gt; JBoss - Tools &gt; Project archives</property> - </emphasis> from menu bar</para> + <property>Window &gt; Show view &gt; Other &gt; JBoss + Tools &gt; Project archives</property> + </emphasis> from menu bar</para> </listitem> <listitem> <para>Select a project in Package Explorer you want to be archived</para> @@ -247,8 +254,8 @@ <itemizedlist> <listitem> <para>Click, for example, <emphasis> - <property>WAR</property> - </emphasis> option to create war archive</para> + <property>WAR</property> + </emphasis> option to create war archive</para> </listitem> </itemizedlist> <para>In the <property>New WAR</property> dialog you can see automatically selected @@ -264,24 +271,24 @@ <itemizedlist> <listitem> <para>Click <emphasis> - <property>Next</property> - </emphasis> to see a stub archive configuration for your project: <figure> - <title>Stub Archive Configuration</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsp_application/jsp_application_10.png" - /> - </imageobject> - </mediaobject> - </figure> + <property>Next</property> + </emphasis> to see a stub archive configuration for your project: <figure> + <title>Stub Archive Configuration</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsp_application/jsp_application_10.png" + /> + </imageobject> + </mediaobject> + </figure> </para> </listitem> <listitem> <para>Click <emphasis> - <property>Finish</property>. </emphasis> The + <property>Finish</property>. </emphasis> The <emphasis>.war</emphasis> file will appear in <property>Package - Explorer</property> and also in <property>Project Archives</property> + Explorer</property> and also in <property>Project Archives</property> view as structure tree: <figure> <title>Archive is Created</title> <mediaobject> @@ -316,19 +323,19 @@ </mediaobject> </figure> </section> - + <section id="AutoRedeploy"> <?dbhtml filename="AutoRedeploy.html"?> <title>Auto redeploy</title> <para>When you are creating a web application and register it on <property>JBoss - Server</property> it is automatically deployed into + Server</property> it is automatically deployed into <emphasis>/deploy</emphasis> directory of the server. JBDS comes with the feature of auto-redeploy. It means that you don&apos;t need to restart - <property>JBoss Server</property>. Any changes made in the application in + <property>JBoss Server</property>. Any changes made in the application in exploded format will trigger a redeployment on the server.</para> </section> </section> - + <section id="Previewtab"> <?dbhtml filename="Previewtab.html"?> <title>JSP Page Preview</title> @@ -339,8 +346,8 @@ <itemizedlist> <listitem> <para>Make a little change to <emphasis> - <property>hello.jsp</property> - </emphasis> page, e.g. put this code snippet:</para> + <property>hello.jsp</property> + </emphasis> page, e.g. put this code snippet:</para> </listitem> </itemizedlist> <programlisting role="XML"><![CDATA[<%= new java.util.Date() %> @@ -348,8 +355,8 @@ <itemizedlist> <listitem> <para>Click <emphasis> - <property>Save</property> - </emphasis> button.</para> + <property>Save</property> + </emphasis> button.</para> </listitem> <listitem> <para>Switch to Preview page by clicking <property>Preview</property> tab at the @@ -357,20 +364,20 @@ </listitem> </itemizedlist> <!-- <figure> - <title>Preview Page</title> - <mediaobject> + <title>Preview Page</title> + <mediaobject> <imageobject> - <imagedata fileref="images/jsp_application/jsp_application_14.png"/> + <imagedata fileref="images/jsp_application/jsp_application_14.png"/> </imageobject> - </mediaobject> - </figure> ---> + </mediaobject> + </figure> + --> </section> <section id="LaunchingTheProject"> <?dbhtml filename="LaunchingTheProject.html"?> <title>Launch JSP Project</title> <para>Let&apos;s now launch our project on server. We&apos;ll use - <property>JBoss Server</property> that is shipped with <property>JBoss Developer + <property>JBoss Server</property> that is shipped with <property>JBoss Developer Studio</property>. You can do it by performing one of the following actions:</para> <itemizedlist> <listitem> @@ -383,11 +390,11 @@ </inlinemediaobject> ) .</para> </listitem> </itemizedlist> - + <itemizedlist> <listitem> <para>Click the Run icon or right click your project folder and select <emphasis> - <property>Run As &gt; Run on Server</property>. </emphasis> If you + <property>Run As &gt; Run on Server</property>. </emphasis> If you haven&apos;t made any changes in <emphasis> <property>web.xml</property> </emphasis> file or cleared it out you can launch the application by right @@ -396,9 +403,9 @@ </emphasis> page and selecting <emphasis> <property>Run on the Server</property> </emphasis>( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/jsp_application/jsp_application_16.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_16.png"/> + </imageobject> </inlinemediaobject> ).</para> </listitem> </itemizedlist> @@ -418,6 +425,6 @@ shipped with <property>JBDS</property>. </para> </section> - - </section> + + </section> </chapter> Modified: trunk/documentation/guides/GettingStartedGuide/en/modules/rad_jsf_application.xml =================================================================== --- trunk/documentation/guides/GettingStartedGuide/en/modules/rad_jsf_application.xml 2009-04-30 12:32:19 UTC (rev 14976) +++ trunk/documentation/guides/GettingStartedGuide/en/modules/rad_jsf_application.xml 2009-04-30 13:08:52 UTC (rev 14977) @@ -571,25 +571,24 @@ <para>The Visual Page Editor will open in a screen split between source code along the top and a WYSIWIG view along the bottom. You can see that some JSF code will be already generated as we choose a template when creating the page.</para> - <para>At the beginning it's necessary to create a <emphasis role="bold"> - <property>&lt;h:form&gt;</property> - </emphasis> component where all others components are put.</para> + <para>At the beginning it's necessary to create a + <code>&lt;h:form&gt;</code> + component where all others components are put.</para> <itemizedlist> <listitem> - <para>Place the mouse cursor inside <emphasis role="bold"> - <property>&lt;f:view&gt;</property> - </emphasis><emphasis role="bold"> - <property>&lt;/f:view&gt;</property> - </emphasis></para> + <para>Place the mouse cursor inside + <code>&lt;f:view&gt; + &lt;/f:view&gt;</code> + </para> </listitem> <listitem> <para>Go to JBoss Tools Palette and expand JSF HTML folder by selecting it</para> </listitem> <listitem> - <para>Click on <emphasis role="bold"> - <property>&lt;h:form&gt;</property> - </emphasis> tag <figure> + <para>Click on + <code>&lt;h:form&gt;</code> + tag <figure> <title>Insert h:form</title> <mediaobject> <imageobject> @@ -720,11 +719,11 @@ </figure> <itemizedlist> <listitem> - <para>Switch to Source mode and insert <emphasis role="bold"> - <property>&lt;br/&gt;</property> - </emphasis> tag after <emphasis role="bold"> - <property>&lt;h:outputText&gt;</property> - </emphasis> component to make a new line.</para> + <para>Switch to Source mode and insert + <code>&lt;br/&gt;</code> + tag after + <code>&lt;h:outputText&gt;</code> + component to make a new line.</para> </listitem> <listitem> <para>Click <emphasis> @@ -737,11 +736,11 @@ editor, and drop it inside the editor after the text.</para> </listitem> <listitem> - <para>Switch to a Source mode and insert <emphasis role="bold"> - <property>&lt;br/&gt;</property> - </emphasis> tag after <emphasis role="bold"> - <property>&lt;h:outputText&gt;</property> - </emphasis> component to make a new line</para> + <para>Switch to a Source mode and insert + <code>&lt;br/&gt;</code> + tag after + <code>&lt;h:outputText&gt;</code> + component to make a new line</para> </listitem> <listitem> <para>Click <emphasis> @@ -826,9 +825,9 @@ <para>Go to Source mode</para> </listitem> <listitem> - <para>Add the validation attribute to <emphasis role="bold"> - <property>&lt;f:validateLongRange&gt;</property> - </emphasis> for user input validation</para> + <para>Add the validation attribute to + <code>&lt;f:validateLongRange&gt;</code> + for user input validation</para> </listitem> </itemizedlist> <programlisting role="XML"><![CDATA[<h:inputText id="userNumber" value="#{NumberBean.userNumber}" required="true"> @@ -890,15 +889,13 @@ </emphasis></para> </listitem> <listitem> - <para>In Source mode add <emphasis role="bold"> - <property>&lt;br/&gt;</property> - </emphasis> tags between <emphasis role="bold"> - <property>&lt;outputText&gt;</property> - </emphasis>, <emphasis role="bold"> - <property>&lt;inputText&gt;</property> - </emphasis> and <emphasis role="bold"> - <property>&lt;commandButton&gt;</property> - </emphasis> components to place them on different lines</para> + <para>In Source mode add + <code>&lt;br/&gt;</code> + tags between + <code>&lt;outputText&gt;</code> + , <code>&lt;inputText&gt;</code> + and <code>&lt;commandButton&gt;</code> + components to place them on different lines</para> </listitem> </itemizedlist> <para>inputnumber.jsp page should look like this:</para> @@ -957,13 +954,11 @@ </mediaobject> </figure> <para>This page, success.jsp, is shown if you correctly guessed the number. The - <emphasis role="bold"> - <property>&lt;h:outputFormat&gt;</property> - </emphasis> tag will get the value of success_text from the properties file. The {0} + <code>&lt;h:outputFormat&gt;</code> + tag will get the value of success_text from the properties file. The {0} in success_text will be substituted for by the value of the value attribute within - the <emphasis role="bold"> - <property>&lt;f:param&gt;</property> - </emphasis> tag during runtime.</para> + the <code>&lt;f:param&gt;</code> + tag during runtime.</para> <para>At the end, you have a button which allows you to replay the game. The action value references a backing bean method. In this case, the method only terminates the current session so that when you are shown the first page, the input text box is