Attachment 40274 Details for Bug 140042 – Update to facets and runtimes documentation

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

[patch] Update to facets and runtimes documentation

org.eclipse.jst.j2ee.doc.user.patch140042.txt (text/plain), 11.10 KB, created by Tim McMackin

on 2006-05-03 14:23:53 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Tim McMackin

Created: 2006-05-03 14:23:53 EDT

Size: 11.10 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.jst.j2ee.doc.user
>Index: topics/taddingfacet.html
>===================================================================
>RCS file: /cvsroot/webtools/jst/components/doc/plugins/org.eclipse.jst.j2ee.doc.user/topics/taddingfacet.html,v
>retrieving revision 1.2
>diff -u -r1.2 taddingfacet.html
>--- topics/taddingfacet.html	15 Mar 2006 17:23:16 -0000	1.2
>+++ topics/taddingfacet.html	3 May 2006 18:14:47 -0000
>@@ -25,9 +25,22 @@
> you add a facet to a project, that project is configured to perform a certain
> task, fulfill certain requirements, or have certain characteristics. For example,
> the EAR facet sets up a project to function as an enterprise application by
>-adding a deployment descriptor and setting up the project's classpath.<p>New
>-projects generally have facets added to them when they are created. To add
>-another facet to a project that already exists, follow these steps:</p>
>+adding a deployment descriptor and setting up the project's classpath.<p>You
>+can add facets only to J2EE projects and other types of projects that are
>+based on J2EE projects, such as enterprise application projects, dynamic Web
>+projects, and EJB projects. You cannot add facets to a Java project or plug-in
>+project, for example. Typically, a facet-enabled project has at least one
>+facet when it is created, allowing you to add more facets if necessary. For
>+example, a new EJB project has the EJB Module facet. You can then add other
>+facets to this project like the EJBDoclet (XDoclet) facet.</p>
>+<p>Some facets
>+require other facets as prerequisites. Other facets cannot be in the same
>+project together. For example, you cannot add the Dynamic Web Module facet
>+to an EJB project because the EJB project already has the EJB Module facet.
>+Some facets can be removed from a project and others cannot.</p>
>+<p>New projects
>+generally have facets added to them when they are created. To add another
>+facet to a project that already exists, follow these steps:</p>
> </div>
> <ol><li class="stepexpand"><span>In the Project Explorer view, right-click the project and then
> click <span class="uicontrol">Properties</span>.</span></li>
>@@ -35,13 +48,25 @@
> <li class="stepexpand"><span>Click <span class="uicontrol">Add/Remove Project Facets</span>.</span></li>
> <li class="stepexpand"><span>In the Add/Remove Project Facets window, select the check boxes
> next to the facets you want this project to have and select a version number
>-for each facet.</span> You can also choose a preset combination of facets
>-from the <span class="uicontrol">Presets</span> list, and you can find out more about
>-the requirements for each facet by right-clicking the facet name and then
>-clicking <span class="uicontrol">Show Constraints</span>.</li>
>+for each facet.</span> <div class="p">Only the facets that are valid for the project
>+are listed:<ul><li>The list of runtimes selected for the project limits the facets shown
>+in the list. Only the facets compatible with all selected target runtimes
>+are shown.</li>
>+<li>The currently selected facets and their version numbers limit the other
>+facets shown in the list. For example, if the project contains the Dynamic
>+Web Module facet, the EJB Module facet is not listed because these two facets
>+cannot be in the same project.</li>
>+</ul>
>+You can find out more about the requirements and limitations for each
>+facet by right-clicking the facet name and then clicking <span class="uicontrol">Show Constraints</span>.</div>
>+<p>You
>+can also choose a preset combination of facets from the <span class="uicontrol">Presets</span> list.</p>
>+</li>
>+<li class="stepexpand"><span>To remove a facet, clear its check box.</span> Not all facets
>+can be removed.</li>
> <li class="stepexpand"><span>If you want to limit the project so it will be compatible with
> one or more runtimes, click the <span class="uicontrol">Show Runtimes</span> button
>-and select the runtimes that you want the project to be compatible with.</span></li>
>+and select the runtimes that you want the project to be compatible with.</span> For more information on runtimes, see <a href="tjtargetserver.html" title="When you develop J2EE applications, you can specify the server runtime environments for your J2EE projects. The target server is specified during project creation and import, and it can be changed in the project properties. The target server setting is the default mechanism for setting the class path for J2EE projects.">Specifying target servers for J2EE projects</a>.</li>
> <li class="stepexpand"><span>Click <span class="uicontrol">Finish</span>.</span></li>
> <li class="stepexpand"><span>Click <span class="uicontrol">OK</span>.</span></li>
> </ol>
>@@ -51,9 +76,10 @@
> <div class="parentlink"><strong>Parent topic:</strong> <a href="../topics/ph-projects.html" title="The workbench can work with many different types of projects. The following topics cover creating and managing some of the types of projects related to J2EE development.">Working with projects</a></div>
> </div>
> <div class="reltasks"><strong>Related tasks</strong><br />
>-<div><a href="../topics/tjear.html">Creating an enterprise application project</a></div>
>+<div><a href="../topics/tjear.html" title="">Creating an enterprise application project</a></div>
> <div><a href="../topics/tjappproj.html" title="You can use a wizard to create a new application client project and add it to a new or existing enterprise application project.">Creating an application client project</a></div>
> <div><a href="../topics/tjrar.html" title="A connector is a J2EE standard extension mechanism for containers to provide connectivity to enterprise information systems (EISs).">Creating a connector project</a></div>
>+<div><a href="../topics/cjearproj.html" title="An enterprise application project ties together the resources that are required to deploy a J2EE enterprise application.">Enterprise application projects</a></div>
> </div>
> </div>
> </body>
>Index: topics/tjtargetserver.html
>===================================================================
>RCS file: /cvsroot/webtools/jst/components/doc/plugins/org.eclipse.jst.j2ee.doc.user/topics/tjtargetserver.html,v
>retrieving revision 1.6
>diff -u -r1.6 tjtargetserver.html
>--- topics/tjtargetserver.html	27 Apr 2006 18:57:36 -0000	1.6
>+++ topics/tjtargetserver.html	3 May 2006 18:14:47 -0000
>@@ -25,7 +25,7 @@
> during project creation and import, and it can be changed in the project properties.
> The target server setting is the default mechanism for setting the class path
> for J2EE projects.</div><div class="section"><p>In order to support different application servers that use different
>-JDK levels for their Javaâ¢ Runtime Environment (JRE), the workbench
>+JDK levels for their Java Runtime Environment (JRE), the workbench
> prompts you for a target server setting for each J2EE project. For example,
> if you want to take advantage of the features of JDK 1.4.2, your applications
> require different class path entries than those that were used in previous
>@@ -56,7 +56,7 @@
> for the resulting projects. The list of target servers that you can choose
> from is filtered based on installed runtimes, the J2EE level of the application,
> and the J2EE module type. For example, for EJB projects only application servers
>-that support Enterprise JavaBeansâ¢ are displayed. All projects
>+that support Enterprise JavaBeans are displayed. All projects
> inside a single EAR file must be targeted to the same server. If you create
> a new project and add it to an existing EAR project during creation, the project
> inherits the target server setting of the EAR project.</p>
>@@ -70,24 +70,23 @@
> <ol><li class="stepexpand"><span>In the Project Explorer view of the J2EE perspective, right-click
> the enterprise application or module project, and select <span class="uicontrol">Properties</span> from
> the pop-up menu.</span> The Properties dialog for the project opens.</li>
>-<li class="stepexpand"><span>Select the <span class="uicontrol">Project Facets</span> page on the Properties
>-dialog.</span></li>
>-<li class="stepexpand"><span>Click the <span class="uicontrol">Add/Remove Project Facets</span> button.</span></li>
>-<li class="stepexpand"><span>In the Select Project Facets window, click the <span class="uicontrol">Show
>-Runtimes</span> button.</span> The <span class="uicontrol">Runtimes</span> list
>-shows all of the runtimes in your workspace. The grayed-out runtimes are not
>-compatible with the currently selected project facets. The runtime in bold,
>-if there is one, is the preferred runtime for the project.</li>
>+<li class="stepexpand"><span>Select the <span class="uicontrol">Targeted Runtimes</span> page on the
>+Properties dialog.</span></li>
> <li class="stepexpand"><span>In the <span class="uicontrol">Runtimes</span> list, select the check boxes
>-next to the runtimes you want to develop the project for.</span> The runtimes
>-you select filter the list of available facets in the <span class="uicontrol">Project Facet</span> list.<p>If
>-you select any runtimes for the project, you must make one of those runtimes
>-the preferred runtime for the project. If you select only one runtime from
>-the list, that runtime is automatically made the preferred runtime.</p>
>+next to each of the runtimes that you want to develop the project for.</span> <p>Only the runtimes compatible with the project's facets are shown.
>+You can select the <span class="uicontrol">Show all runtimes</span> check box to display
>+the runtimes not compatible with the project's current facet configuration.
>+These runtimes are grayed out.</p>
>+<p>If you don't see the runtime that you
>+want to use, you need to add it to the runtimes in the workbench. See <a href="../org.eclipse.wst.server.ui.doc.user/topics/twinstprf.html">Defining the installed server runtime environments</a>.</p>
>+</li>
>+<li class="stepexpand"><span>To select the primary runtime, click on a runtime and then click
>+the <span class="uicontrol">Make Primary</span> button.</span> <p>If you select
>+any runtimes for the project, you must make one of those runtimes the primary
>+runtime for the project. If you select only one runtime from the list, that
>+runtime is automatically made the primary runtime. The primary runtime is
>+shown in bold text.</p>
> </li>
>-<li class="stepexpand"><span>To select the preferred runtime, click on a runtime and then click
>-the <span class="uicontrol">Make Preferred</span> button.</span> The preferred
>-runtime is shown in bold text.</li>
> <li class="stepexpand"><span>Click <span class="uicontrol">Finish</span>.</span></li>
> <li class="stepexpand"><span>Click <span class="uicontrol">OK</span>.</span></li>
> </ol>
>@@ -99,5 +98,6 @@
> <div class="relconcepts"><strong>Related concepts</strong><br />
> <div><a href="../topics/cjarch.html" title="The Java 2 Platform, Enterprise Edition (J2EE) provides a standard for developing multitier, enterprise services.">J2EE architecture</a></div>
> </div>
>-</div></body>
>+<div><strong>Related information</strong><div><a href="../../org.eclipse.wst.server.ui.doc.user/topics/twinstprf.html">Defining the installed server runtime environments</a></div>
>+</div></div></body>
> </html>
>\ No newline at end of file

Actions: View | Diff

Attachments on bug 140042: 40274