From jbosstools-commits at lists.jboss.org Mon May 25 08:24:04 2009 Content-Type: multipart/mixed; boundary="===============5982004322814241470==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r15490 - trunk/jsf/docs/jsf_tools_ref_guide/en/modules. Date: Mon, 25 May 2009 08:16:54 -0400 Message-ID: --===============5982004322814241470== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: ochikvina Date: 2009-05-25 08:16:54 -0400 (Mon, 25 May 2009) New Revision: 15490 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en/modules/projects.xml Log: https://jira.jboss.org/jira/browse/JBDS-621 - added the 'Relevant Resources= Links' section to the 'Projects' chapter; Modified: trunk/jsf/docs/jsf_tools_ref_guide/en/modules/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/modules/projects.xml 2009-05-25 1= 2:15:46 UTC (rev 15489) +++ trunk/jsf/docs/jsf_tools_ref_guide/en/modules/projects.xml 2009-05-25 1= 2:16:54 UTC (rev 15490) @@ -1,462 +1,405 @@ - - - - JBoss Developer Studio - Eclipse - JSF Tools - Java - JBoss - - - = - Projects - To take an advantage of JSF firstly you shou= ld perform one of the next - steps: + + + + JBoss Developer Studio + Eclipse + JSF Tools + Java + JBoss + + = - - - Create new JSF projects - - - Import (open) existing JSF p= rojects - - - Add JSF capability to any ex= isting Eclipse - project - - - Import and add JSF capabilit= y to any existing project - created outside Eclipse. - - - In this section we're going to stop on = each of them in - detail. - = -
+ Projects + To take an advantage of JSF firstly you should perform one o= f the next steps: = - Creating a New JSF Project + + + 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. = - If you want your project to already = contain all JSF - libraries, tag libraries and JSF c= onfiguration file, just - organize a new brand JSF project. = It is possible to do this easily with the - help of the special wizard. To get= it, select - File > New &= gt; Project - > JBoos Tools Web >= ; JSF - > JSF Project - and click - Next.= +
= -
- Choosing a JSF Project</tit= le> - <mediaobject> - <imageobject> - <imagedata - fileref=3D"images/jsf_su= pport/jsf_support_10.png" - /> - </imageobject> - </mediaobject> - </figure> + <title>Creating a New JSF Project = - On the next form you'll be prom= pted to enter - Project Name and select a - location for the project or just l= eave a default path. - Here, JSF Version also allows you to= select which JSF - implementation to use. -
- Creating a New JSF Project<= /title> - <mediaobject> - <imageobject> - <imagedata - fileref=3D"images/jsf_su= pport/jsf_support_11.png" - /> - </imageobject> - </mediaobject> - </figure> + <para>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<emphasis> + <property> File > New > Project >= JBoos Tools + Web > JSF > JSF Project</pro= perty> + </emphasis> and click <emphasis> + <property>Next</property>.</emphasis></par= a> = - <para>There is a number of predefined proj= ect templates that are flexible and - easily customizable. Thus you can = pick a different template - on which the projects Importing Ex= isting should be based on. Almost all - templates come in two variations: = with jsf libraries and - without ones.</para> - <figure> - <title>Choosing JSF Templates</tit= le> - <mediaobject> - <imageobject> - <imagedata - fileref=3D"images/jsf_su= pport/jsf_support_12.png " - /> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Choosing a JSF Project + + + + + +
= - The table below provides description= for each possible JSF - template. - - JSF Project Templates</titl= e> - <tgroup cols=3D"2"> - <colspec colnum=3D"1" alig= n=3D"left" colwidth=3D"1*"/> - <colspec colnum=3D"2" colw= idth=3D"3*"/> + <para>On the next form you'll be prompted to enter <p= roperty>Project + Name</property> and select a location for = the project or just leave + a default path.</para> + <para>Here, JSF Version also allows you to select which JS= F implementation to + use.</para> + <figure> + <title>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. +
+ Choosing JSF Templates + + + + + +
= - - - + The table below provides description for each possib= le JSF template. +
+ JSF Project Templates + + + + + + + + Template - + = - + Description - - - + + + = - + = - - + + JSFBlankWithLi= bs - + = - - This template will - create a standard - Web project - structure with all - JSF - capabilities - - + + This template will= create a standard Web + project structure with a= ll JSF capabilities + + = - - + + JSFKickStartWi= thLibs - + = - - This template will - create a standard - Web project - structure but will - also include a - sample application - that is ready to - run - - + + This template will= create a standard Web + project structure but wi= ll also include a sample + application that is read= y to run + + = - - + + JSFKickStartWi= thoutLibs - + = - - Some servers alrea= dy - provide jsf libs and - you take risk of - getting conflicting - libraries while - deploying your - project. To avoid - such conflicts, use - a template without - libs if you have a - server with its own - jsf libraries - - + + 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 + + = - - -
+ + + = = - = - On the next screen select what - Servlet version<= /property> - to use and whether to = register this application - with JBoss AS (or other server) fo= r running and testing your application. + 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. = - The - Context Path - is the name under whic= h the application will be - deployed. + The + Context Path + is the name under which the applicatio= n will be deployed. = - The - Runtime - value tells Eclipse wh= ere to find Web libraries - in order to build (compile) the pr= oject. 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 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 - Target Server - allows you specifying = whether to deploy the - application. The Target Server cor= responds to the Runtime - value selected above. If you don&a= pos;t want to deploy - the application, uncheck this valu= e. -
- Registering the Project on = Server - - - - - -
+ 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 + + + + + +
= - When you are all done, you should ha= ve the project that has - been appeared in the Package Explo= rer view: -
- A New Project in the Packag= e Explorer - - - - - -
+ 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>At this point you can open <emphasis> - <property>faces-config.xml= </property> - </emphasis> and start working on y= our application. - There are a lot of features - to develop JSF applications. We wi= ll describe the features - further.</para> - </section> + <para>At this point you can open <emphasis> + <property>faces-config.xml</property> + </emphasis> and start working on your application.= There are a lot of + features to develop JSF applications. We will desc= ribe the features + further.</para> + </section> = - <section id=3D"ImportingExsJSFProjWithAnyStr74447"> + <section id=3D"ImportingExsJSFProjWithAnyStr74447"> = - <title>Importing Existing JSF Projects wit= h Any Structure + Importing Existing JSF Projects with Any Structure<= /title> = - <para>For detailed information on migratio= n of JSF projects into a workspace see <ulink - url=3D"&migrationlink;#jsf_struts"= >Migration Guide</ulink>.</para> + <para>For detailed information on migration of JSF project= s into a workspace see + <ulink url=3D"&migrationlink;#jsf_struts">= Migration + Guide</ulink>.</para> = - </section> - <section id=3D"add_jsf_capability"> + </section> + <section id=3D"add_jsf_capability"> = - <title>Adding JSF Capability to Any Existi= ng Eclipse Project + Adding JSF Capability to Any Existing Eclipse Proje= ct = - It's also possible to add JSF capability - (JSF libraries, tag libraries) to = any existing Eclipse - project in your workspace. After t= hat you'll be - able to make use of such editors a= s JSF configuration editor, JBoss - Tools JSP editor and any others. - Right click the project and select <= emphasis> - JBoss Tools > Ad= d JSF - Capabilities. <= /emphasis> This will start - the process of adding all necessar= y libraries, files to make - this a Web JSF project. -
- Adding JSF Capabilities</ti= tle> - <mediaobject> - <imageobject> - <imagedata - fileref=3D"images/jsf_su= pport/jsf_support_16.png" - /> - </imageobject> - </mediaobject> - </figure> - <para>The wizard will first ask you to sho= w the <emphasis> - <property>web.xml</propert= y> - </emphasis> file location and the = project name.</para> - <figure> - <title>Project Location - - - - - -
- On the last form you can set the dif= ferent folders for your - project as well as register this a= pplication with a servlet - container. + 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= . = - Make sure to select - Add Libraries - to add all required JS= F related libraries to this project. + Make sure to select + Add Libraries + to add all required JSF related librar= ies to this + project. = - The - Context Path - is the name under whic= h the application will be - deployed. + The + Context Path + is the name under which the applicatio= n will be deployed. = - The - Runtime - value tells Eclipse wh= ere to find Web libraries - in order to build (compile) the pr= oject. It is not possible - to finish project import without s= electing Runtime. If you - don't have any values, select= - New... - to add new Runtime. + 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 - Target Server - allows you to specify = whether to deploy the - application. The Target Server cor= responds to the Runtime - value selected above. If you don&a= pos;t want to deploy - the application, uncheck this valu= e. -
- Project Folders - - - - - -
- Once your project is imported you ca= n see that JSF related - libraries have been added to your = project: - jsf-api.jar - and - jsf-impl.jar - . - - Note: - Some application servers pro= vide their own jsf - implementation libraries. = Thus, to avoid conflicts you - should not add jsf librari= es while adding jsf - capabilities. - - You are now ready to work with JSF b= y creating a new JSF - configuration file: + 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: = = -
- Creating a New JSF Configur= ation 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 s= hould be opened in a - special <link - linkend=3D"jsf_config_file" - >Faces Config Editor</link= >.</para> - </section> - <section id=3D"AddingYourOwnProjectTemplates853"> + <para>Once the file has been created, it should be opened = in a special <link + linkend=3D"jsf_config_file">Faces Config E= ditor</link>.</para> + </section> + <section id=3D"AddingYourOwnProjectTemplates853"> = - <title>Adding Your Own Project Templates</= title> - <para>Template is a set of files that is s= erved as a basis to facilitate - the creation of a new project. Pro= ject templates provide - content and structure for a projec= t.</para> - <para>There is a powerful - templating capability for creating= new and importing - existing Struts and JSF projects. = This templating facility - has a variety of aspects to consid= er. But, let's - start with the most straightforwar= d case and consider the - process of creating a template fro= m your existing JSF - project.</para> + <title>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 th= at you want to use as - the basis for a new temp= late. Follow - these steps to make a template out= of it: - - - In the Web Projects = view, right-click the - project and select - JBoss Tools JS= F > Save As + 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 Temp= late - - - - - -
- - - In the first dialog = box, you can choose a name - for the template (defaul= ts to the project - name) and confirm what r= un-time - implementation of the pr= oject - technology will be used<= /para> - + + + +
+ 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<= /title> - <mediaobject> - <imageobject> - <imagedata - fileref=3D"images/jsf_su= pport/jsf_support_20_1.png" - /> - </imageobject> - </mediaobject> - </figure> + </itemizedlist> + <figure> + <title>Define Template Properties + + + + + +
= = - - - Select - Next - and you will= be sent to a dialog - box with your project st= ructure displayed - with check boxes. Here y= ou can check only - those parts and files in= your project - directory that should be= part of the - template - - -
- Define Template Properties<= /title> - <mediaobject> - <imageobject> - <imagedata - fileref=3D"images/jsf_su= pport/jsf_support_20_2.png" - /> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>At this point, unles= s you want to designate - some extra files as havi= ng Velocity template - coding inside them, you = should click <emphasis> - <property>Finish</proper= ty> - </emphasis>.</para> - </listitem> - </itemizedlist> - <para>That's it. Now, you can use thi= s template with any - new or imported project that uses = the same run-time - implementation as the project you = turned into a - template.</para> - <para>At this point, you have a fully conf= igured project and now you can - bring some new logic to it startin= g from JSF configuration - file.</para> - </section> -</chapter> \ No newline at end of file + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>Next</property> + </emphasis> 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</para> + </listitem> + </itemizedlist> + <figure> + <title>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= . +
+ --===============5982004322814241470==--