From jbosstools-commits at lists.jboss.org Sun Jan 30 23:11:32 2011 Content-Type: multipart/mixed; boundary="===============4298790851381461542==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r28743 - trunk/as/docs/reference/en-US. Date: Sun, 30 Jan 2011 23:11:32 -0500 Message-ID: <201101310411.p0V4BWRd010588@svn01.web.mwc.hst.phx2.redhat.com> --===============4298790851381461542== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: mcaspers Date: 2011-01-30 23:11:32 -0500 (Sun, 30 Jan 2011) New Revision: 28743 Modified: trunk/as/docs/reference/en-US/webtools.xml Log: General Updates Modified: trunk/as/docs/reference/en-US/webtools.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/as/docs/reference/en-US/webtools.xml 2011-01-31 03:44:52 UTC (rev= 28742) +++ trunk/as/docs/reference/en-US/webtools.xml 2011-01-31 04:11:32 UTC (rev= 28743) @@ -1,48 +1,36 @@ Projects - The most popular of the projects we deal with are the J2EE ones, su= ch as Dynamic Web - Project, EJB Project, or EAR project. Web projects of JBoss To= ols are - Struts, JSF and Seam projects. All of them are called faceted projects. = Thus, in this - chapter we are going to tell you about facets the main benefit of which = to provide proper - structuring and packaging for any type of project. - + + The most popular of the projects we deal with are the J2EE ones, such as= Dynamic Web Project, EJB Project, or EAR project. JBoss Tools= web projects include Struts, JSF and Seam projects. These ar= e referred to as faceted projects. This chapter will cover facets, which ar= e used to provide provide a consistent structure and packaging features to = any type of project. + + =
Faceted Projects Overview - The idea behind faceted projects is that each project can accept u= nits of - functionality, or facets, which can be added or removed by the user. Mo= st often, these - facets either add to the project's classpath, enable a builder, or watc= h the project in - some other fashion. Generally, every project concerned has at least one= facet when - it's created. As an example, a Web project has a WebDoclet facet, = or an EJB - Project has an EJB Module facet as prerequisites. - - WTP projects have undergone some criticism as being - over-engineered or too restrictive in their design= . WTP projects - are set up in a tree-relationship to each other, where one project can = be a child of - another. For example, an EAR project may have a Web Project child, an E= JB project child, - or other types. - - However, the benefit of this is that the structure of your projec= ts is then known, - and packaging it up *should* be trivial. Apparently, if your project is= non-standard, or - you feel too confined by such rigid structural requirements, you can st= ill choose to - package your project using the A= rchives - plugin. + + The idea behind faceted projects is that each project can accept units = of functionality, or facets, which can be added or removed by the user. The= se facets either add to the project's classpath, enable a builder, or watch= the project in some other fashion. Typically every project concerned has a= t least one facet when it is created. As an example, a Web project has a We= bDoclet facet, or an EJB Project has an EJB Module facet as prerequisites. + + = + + WTP projects have been criticized for being over-engineered or too rest= rictive in their design. WTP projects are set up in a tree-relationship to = each other, where one project can be a child of another. For example, an EA= R project may have a Web Project child, an EJB project child, or other type= s. + + = + + However, the benefit of this is that the structure of your projects is = then known, and packaging it up should be trivial. If = your project is non-standard, or you feel too confined by such rigid struct= ural requirements, you can still choose to package your project using the A= rchives plugin (see ). +
= - + =
Adding Facets to a Project - - In this section we're going to consider the facets added by <= property>JBoss - Tools and show how you can configure them in a project: add= new ones or - modify already existing configuration of the facets. - - One way to configure the facets is doing it while organizing a new= project. To - demonstrate this let's create a new Dynamic Web Project<= /property> by - selecting - File > New > Other... - and then - Web > Dynamic Web Project. + = + + This section will cover the facets added by JBoss Tools and show how you can configure them in a project by adding new ones o= r modifying existing facet configurations. + + = + + One way to configure the facets is doing it while organizing a new proj= ect. To demonstrate this let's create a new Dynamic Web Proj= ect by selecting FileNewOther...W= ebDynamic Web Project. +
New Dynamic Web Project @@ -51,17 +39,15 @@
- Click - Next - and you will see Dynamic Web Project page like on the figur= e below. - - The first page of most WTP projects allows you to target a specif= ic runtime, - representing a server's library location. It will also provide you the = ability to add - this project to an EAR project, and select a preselected default set of= facets, called - a configuration, rather than manually select each facet you might want.= - Selecting the runtime, again, allows the project to install the p= roper classpaths to - the project so it knows what code to compile against. - + Click the Next button and you will see a Dy= namic Web Project page like on the figure below. + = + + The first page of most WTP projects allows you to target a specific run= time, which represents a server's library location. It will also provide yo= u the ability to add this project to an EAR project, and select a preselect= ed default set of facets, called a configuration, rather than manually sele= ct each required facet. + + + Selecting the runtime allows the project to install the proper classpat= hs to the project so it knows what code to compile against. + + =
New Dynamic Web Project @@ -70,12 +56,10 @@
- Click on the - Modify - button next to Configuration section i= n order to open - the wizard which allows you to modify a chosen configuration. The wizar= d looks as - follows. - + + Click the Modify button next to the Co= nfiguration section to open a wizard which allows you to modify = the chosen configuration. The wizard is shown in the image below. + + =
Project Facets Wizard @@ -84,9 +68,8 @@
- - Here part of the listed facets are those which are provided by WTP= . Some of them are - added by JBoss Tools. They are: + = + Here part of the listed facets are those which are provided by WTP= . Some of them are added by JBoss Tools. They are: BIRT Charting Runtime Component @@ -107,11 +90,10 @@ Seam - - On this wizard page you can enable or disable any facet as well as= change it version. - What you should note here is that some facets or facets versions may co= nflict with each - other. In case of incompatibility you'll be prompted about this in= the combo - box underneath. + = + + On this wizard page you can enable or disable any facet as well as chan= ge its version. What you should note here is that some facets or facets ver= sions may conflict with each other. In case of incompatibility you will be = notified in the combo box underneath. +
Facet Constraints @@ -120,9 +102,7 @@
- When switching on the - Runtimes - tab on the right you'll see the current server Runtime= . + When switching on the Runtimes tab on the rig= ht you will see the current server Runtime.
Runtimes on the Project Facets Wizard @@ -131,33 +111,27 @@
- On this tab you can also create a new Server Runtime and make it p= rimary by pressing - Make Primary - button after enabling it. + + On this tab you can also create a new Server Runtime and make it primar= y by enabling it and then clicking the Make Primary = button. + + = + + Clicking on the OK button will save the chosen c= onfiguration of the facets and return you to the Dynamic Web Project wizard= (see ). Additional pages in the wizard = are specific to either the project type or the facets selected. + = - Clicking on - OK - will save the chosen configuration of the facets and return= you to the Dynamic Web Project wizard. Further= pages in the - wizard are specific to either the project type or the facets selected.<= /para> - - - If you need to configure the facets for the existing project, you = should bring up the - context menu for selected project and click - Properties - and then - Project Facets. This will bring up th= e familiar - Project Facets wizard, where y= ou can create - your own custom facets configuration. - + = + + If you need to configure the facets for an existing project, right clic= k on the project, select Properties and then sel= ect Project Facets. This will bring up the Project Fac= ets wizard (see ), where you can create y= our own custom facets configuration. + + = - + =
Relevant Resources Links - - More on the WTP facets you can read in the eclipse help. + = + + More information on the WTP facets can be found in the Eclipse help. +
--===============4298790851381461542==--