From jbosstools-commits at lists.jboss.org Wed Jan 26 22:22:21 2011 Content-Type: multipart/mixed; boundary="===============1046209163696808540==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r28641 - trunk/jsf/docs/jsf_tools_ref_guide/en-US. Date: Wed, 26 Jan 2011 22:22:21 -0500 Message-ID: <201101270322.p0R3MLR0014192@svn01.web.mwc.hst.phx2.redhat.com> --===============1046209163696808540== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: mcaspers Date: 2011-01-26 22:22:20 -0500 (Wed, 26 Jan 2011) New Revision: 28641 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml Log: General Updates Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml 2011-01-27 02:54:= 57 UTC (rev 28640) +++ trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml 2011-01-27 03:22:= 20 UTC (rev 28641) @@ -1,75 +1,68 @@ - - - - JBoss Developer Studio - Eclipse - JSF Tools - Java - JBoss - - + + + + JBoss Developer Studio + Eclipse + JSF Tools + Java + JBoss + + = - Projects - To take an advantage of JSF firstly you should perform one o= f the next steps: + Projects + To take an advantage of JSF you will need to perform one of the nex= t steps: = - - - Create new JSF projects - - - Import (open) existing JSF projects - - - Add JSF capability to any existing Eclipse p= roject - - - Import and add JSF capability to any existin= g project created outside - Eclipse. - - - In this section we're going to stop on each of them in = detail. + + + Create new JSF projects + + + Import (open) existing JSF projects + + + Add JSF capability to any existing Eclipse project + + + Import and add JSF capability to any existing project created out= side Eclipse. + + + This section will go into more detail for each step. = -
+
= - Creating a New JSF Project + Creating a New JSF Project = - If you want your project to already contain all JSF = libraries, tag libraries - and JSF configuration file, just organize a new br= and JSF project. It is - possible to do this easily with the help of the sp= ecial wizard. To get it, select - File > New > Project >= JBoos Tools - Web > JSF > JSF Project - and click - Next. + + It is easy to create a new project that contains all the JSF libraries,= tag libraries and JSF configuration file with the aid of a special wizard.= To get it, select File= NewJBoos Tools WebJSF= JSF Project and click= the Next button. + = -
- Choosing a JSF Project - - - - - -
+
+ Choosing a JSF Project + + + + + +
= - On the next form you'll be prompted to enter Project - Name and select a location for = the project or just leave - a default path. - Here, JSF Version also allows you to select which JS= F implementation to - use. -
- Creating a New JSF Project - - - - - -
+ + On the next page you will be prompted to enter the Project Na= me and select a location for the project (or just leave a defaul= t path). + + The JSF Version option also allows you to spe= cify the JSF implementation to use. +
+ Creating a New JSF Project + + + + + +
= - There is a number of predefined project templates th= at are flexible and easily - customizable. Thus you can pick a different templa= te on which the projects - Importing Existing should be based on. Almost all = templates come in two - variations: with jsf libraries and without ones. + + There are a number of predefined project templates that are both flexib= le and easily customizable. You can pick a different template on which the = projects Importing Existing should be based on. Almost all templates come i= n two variations: with and without JSF libraries. +
Choosing JSF Templates @@ -77,82 +70,77 @@ -
+ = - The table below provides description for each possib= le JSF template. - - JSF Project Templates - - - + The table below provides description for each possible JSF templat= e. +
+ JSF Project Templates + + + = = - - - - Template - + + + + Template + = - - Description - - - + + Description + + + = - + = - - - - - JSFBlankWithLi= bs - - - + + + + + JSFBlankWithLibs + + + = - - This template will= create a standard Web - project structure with a= ll JSF capabilities - - + + This template will create a standard Web project structure wi= th all the JSF capabilities + + = - - - - - JSFKickStartWi= thLibs - - - + + + + + JSFKickStartWithLibs + + + = - - This template will= create a standard Web - project structure but wi= ll also include a sample - application that is read= y to run - - + + This template will create a standard Web project structure, a= nd also include a sample application that is ready to run + + = - - - - - JSFKickStartWi= thoutLibs - - - + + + + + JSFKickStartWithoutLibs + + + = - - Some servers alrea= dy provide jsf libs and - you take risk of getting= conflicting libraries - while deploying your pro= ject. To avoid such - conflicts, use a templat= e without libs if you have - a server with its own js= f libraries - - + + + Some servers already provide JSF libs and you risk library conflic= ts while deploying your project. To avoid such conflicts, use a template wi= thout libs if you have a server with its own JSF libraries. + + + = - - -
+ + + = = = - On the next screen select what - Servlet version - to use and whether to register this ap= plication with JBoss AS - (or other server) for running and testing your app= lication. + + On the next page you need to select which Servlet version to use, and specify whether or not to register this application wit= h JBoss AS (or other server) in order to run and test your application. + = - The - Context Path - is the name under which the applicatio= n will be deployed. + The Context Path option defines the name unde= r which the application will be deployed. = - The - Runtime - value tells Eclipse where to find Web = libraries in order to - build (compile) the project. It is not possible to= finish project creation - without selecting Runtime. If you don't have = any values, select - New... - to add new Runtime. + + The Runtime value tells Eclipse where to find the = Web libraries necessary to build (compile) the project. It is not possible = to finish the project creation without selecting a Runtime. If you do not h= ave any values, click the New... button to add new R= untime. + = - The - Target Server - allows you specifying whether to deplo= y the application. The - Target Server corresponds to the Runtime value sel= ected above. If you - don't want to deploy the application, uncheck= this value. -
- Registering the Project on Server - - - - - -
+ + The Target Server option allows you specifying whe= ther or not to deploy the application. The Target Server corresponds to the= Runtime value selected above. If you do not want to deploy the application= , uncheck this option. + +
+ Registering the Project on Server + + + + + +
= - When you are all done, you should have the project t= hat has been appeared in - the Package Explorer view: -
- A New Project in the Package Explorer</titl= e> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/jsf_s= upport/jsf_support_15.png"/> - </imageobject> - </mediaobject> - </figure> + <para>When you are all done, you should see that the project has been ap= peared in the Package Explorer view:</para> + <figure> + <title>A New Project in the Package Explorer + + + + + +
= - At this point you can open - faces-config.xml - and start working on your application.= There are a lot of - features to develop JSF applications. We will desc= ribe the features - further. -
+ + At this point you can open the faces-config.xml fi= le and start working on your application. There are a lot of features avail= able when developing JSF applications. These features will be discussed in = more detail later in this document. +
= -
+
= - Importing Existing JSF Projects with Any Structure<= /title> + <title>Importing Existing JSF Projects with Any Structure = - For detailed information on migration of JSF project= s into a workspace see the Migration - Guide. + For detailed information on migration of JSF projects into a works= pace see the Migration Guide. = -
-
+
+
= - Adding JSF Capability to Any Existing Eclipse Proje= ct + Adding JSF Capability to Any Existing Eclipse Project = - It's also possible to add JSF capabil= ity (JSF - libraries, tag libraries) to any existing Eclipse = project in your workspace. - After that you'll be able to make use of such= editors as JSF - configuration editor, JBoss Tools JSP editor and a= ny others. - Right click the project and select - JBoss Tools > Add JSF Capabiliti= es. - This will start the process of adding all necessar= y libraries, files to make - this a Web JSF project. -
- Adding JSF Capabilities - - - - - -
- The wizard will first ask you to show the - web.xml - file location and the project name. -
- Project Location - - - - - -
- On the last form you can set the different folders f= or your project as well as - register this application with a servlet container= . + + It is also possible to add JSF capabilities = (JSF libraries, tag libraries) to any existing Eclipse project in your work= space. After that you will be able to make use of features such as the JSF = configuration editor, JBoss Tools JSP editor and any others. + + + Right click the project and select JBoss Tools= Add JSF Capabilities = from the context menu. This will start the process of adding the necessary = libraries and files to convert the project into a Web JSF project. + +
+ Adding JSF Capabilities + + + + + +
+ The wizard will first ask you to define location of the = web.xml file and the project name. +
+ Project Location + + + + + +
+ On the last page you can specify the different folders for your pr= oject as well as register this application with a servlet container. = - Make sure to select - Add Libraries - to add all required JSF related librar= ies to this - project. + Make sure to select the Add Libraries option = to add all required JSF related libraries into your project. = - The - Context Path - is the name under which the applicatio= n will be deployed. + The Context Path option defines the name unde= r which the application will be deployed. = - The - Runtime - value tells Eclipse where to find Web = libraries in order to - build (compile) the project. It is not possible to= finish project import - without selecting Runtime. If you don't have = any values, select - New... - to add new Runtime. + + The Runtime value tells Eclipse where to find Web = libraries necessary to build (compile) the project. It is not possible to f= inish project import without selecting the Runtime. If you don not have any= values, click the New... button to add a new Runtim= e. + = - The - Target Server - allows you to specify whether to deplo= y the application. The - Target Server corresponds to the Runtime value sel= ected above. If you - don't want to deploy the application, uncheck= this value. -
- Project Folders - - - - - -
- Once your project is imported you can see that JSF r= elated libraries have been - added to your project: - jsf-api.jar - and - jsf-impl.jar - . - - Note: - Some application servers provide their own j= sf implementation - libraries. Thus, to avoid conflicts you sh= ould not add jsf libraries - while adding jsf capabilities. - - You are now ready to work with JSF by creating a new= JSF configuration - file: + + The Target Server option allows you to specify whe= ther or not to deploy the application. The Target Server corresponds to the= Runtime value selected above. If you do not want to deploy the application= , uncheck this value. + +
+ Project Folders + + + + + +
+ + Once your project is imported you can see that JSF related libraries jsf-api.jar and jsf-impl.jar have b= een added to your project. + = + + Note: + + Some application servers provide their own JSF implementation librarie= s. To avoid conflicts you should not add JSF libraries while adding JSF cap= abilities. + + + You are now ready to work with JSF by creating a new JSF configura= tion file: = +
+ Creating a New JSF Configuration File + + + + + +
= -
- Creating a New JSF Configuration File</titl= e> - <mediaobject> - <imageobject> - <imagedata fileref=3D"images/jsf_s= upport/jsf_support_19.png"/> - </imageobject> - </mediaobject> - </figure> + <para>Once the file has been created, it should be opened in a special e= ditor (see <xref linkend=3D"jsf_config_file"/>).</para> + </section> + <section id=3D"AddingYourOwnProjectTemplates853"> = - <para>Once the file has been created, it should be opened = in a special <xref linkend=3D"jsf_config_file"/>.</para> - </section> - <section id=3D"AddingYourOwnProjectTemplates853"> + <title>Adding Your Own Project Templates + + A template is a set of files that is provided as a basis when creating = a new project. Project templates provide content and structure for a projec= t. + + + JSF Tools provides powerful template capabilities which allow you to cr= eate new templates and import existing Struts and JSF projects. This templa= ting facility has a variety of aspects to consider. Let's start with t= he most straightforward case and consider the process of creating a templat= e from your existing JSF project. + = - Adding Your Own Project Templates - Template is a set of files that is served as a basis= to facilitate the - creation of a new project. Project templates provi= de content and structure - for a project. - There is a powerful templating capability for creati= ng new and importing - existing Struts and JSF projects. This templating = facility has a variety of - aspects to consider. But, let's start with th= e most straightforward - case and consider the process of creating a templa= te from your existing JSF - project. + + Let's say you have a project that you want to use as the basis for= a new template. The following steps will show you how= to achieve this: + + + + + In the Web Projects view, right-click the project and select JBoss Tools JSSave As Template<= /guimenuitem> + + + +
+ Saving Your Project as Template + + + + + +
+ + + + In the first dialog box, you can specify a name for the template (it = will default to the project name) and confirm what run-time implementation = of the project technology will be used. + + = - Let's say you have a project that you want to u= se as the basis for a - new template. Follow these st= eps to make a template out - of it: - - - In the Web Projects view, right-clic= k the project and select - JBoss Tools JSF = > Save As - Template - - - -
- Saving Your Project as Template - - - - - -
- - - In the first dialog box, you can cho= ose a name for the - template (defaults to the project = name) and confirm what - run-time implementation of the pro= ject technology will be - used - + +
+ Define Template Properties + + + + + +
= - -
- Define Template Properties - - - - - -
= + + + + When you click the Next button a dialog box wi= ll be presented with your project structure displayed, along with a number = of check boxes. Here you can select only those parts and files in your proj= ect directory that should be part of the template. + + + +
+ Define Template Properties + + + + + +
+ + + + At this point, unless you want to designate some extra files as havin= g Velocity template coding inside them, you should click the Fin= ish button. + + + + + That's it. This template can be used with any new or imported proj= ect that uses the same run-time implementation as the project you turned in= to a template. + + At this point you have a fully configured project. Now you can add= some additional logic to it starting with the JSF configuration file. +
+
+ Relevant Resources Links = - - - Select - Next - and you will be sent t= o a dialog box with your - project structure displayed with c= heck boxes. Here you can - check only those parts and files i= n your project directory - that should be part of the templat= e - - -
- Define Template Properties - - - - - -
- - - At this point, unless you want to de= signate some extra files - as having Velocity template coding= inside them, you should - click - Finish - . - - - That's it. Now, you can use this template with = any new or imported - project that uses the same run-time implementation= as the project you turned - into a template. - At this point, you have a fully configured project a= nd now you can bring some - new logic to it starting from JSF configuration fi= le. -
-
- Relevant Resources Links - - You can find more in-depth explanation on how to wor= k with special wizards, editors and views that can - be used in various scenarios while developing JSF = applications in our Visual Web Tools Guide. -
+ + You can find a more in-depth explanation on how to work with the specia= l wizards, editors and views that can be used while developing JSF applicat= ions in our Visual Web Tools Guide. + +
--===============1046209163696808540==--