Author: afedosik Date: 2007-11-23 08:01:17 -0500 (Fri, 23 Nov 2007) New Revision: 5053 Added: trunk/seam/docs/reference/en/images/seam_editors/ trunk/seam/docs/reference/en/images/seam_editors/seam_editors1.png trunk/seam/docs/reference/en/images/seam_editors/seam_editors2.png trunk/seam/docs/reference/en/images/seam_editors/seam_editors2_1.png trunk/seam/docs/reference/en/images/seam_editors/seam_editors3.png trunk/seam/docs/reference/en/images/seam_view/ trunk/seam/docs/reference/en/images/seam_view/seam_view1.png trunk/seam/docs/reference/en/images/seam_view/seam_view1_1.png trunk/seam/docs/reference/en/images/seam_view/seam_view1_2.png trunk/seam/docs/reference/en/images/seam_view/seam_view1_3.png trunk/seam/docs/reference/en/images/seam_view/seam_view1_4.png trunk/seam/docs/reference/en/images/seam_view/seam_view2.png trunk/seam/docs/reference/en/images/seam_view/seam_view3.png trunk/seam/docs/reference/en/images/seam_view/seam_view4.png trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards4.png trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards4_1.png trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards5.png trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards6.png trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards6_1.png trunk/seam/docs/reference/en/modules/seam_editors.xml trunk/seam/docs/reference/en/modules/seam_view.xml Modified: trunk/seam/docs/reference/en/images/create_new_seam/create_seam11.png trunk/seam/docs/reference/en/images/create_new_seam/create_seam13_0.png trunk/seam/docs/reference/en/images/create_new_seam/create_seam14.png trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards2.png trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards3.png trunk/seam/docs/reference/en/master.xml trunk/seam/docs/reference/en/modules/creating_new_seam.xml trunk/seam/docs/reference/en/modules/seam_wizards.xml Log: http://jira.jboss.com/jira/browse/RHDS-289 more chapters and screenshots Modified: trunk/seam/docs/reference/en/images/create_new_seam/create_seam11.png =================================================================== (Binary files differ) Modified: trunk/seam/docs/reference/en/images/create_new_seam/create_seam13_0.png =================================================================== (Binary files differ) Modified: trunk/seam/docs/reference/en/images/create_new_seam/create_seam14.png =================================================================== (Binary files differ) Added: trunk/seam/docs/reference/en/images/seam_editors/seam_editors1.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_editors/seam_editors1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_editors/seam_editors2.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_editors/seam_editors2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_editors/seam_editors2_1.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_editors/seam_editors2_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_editors/seam_editors3.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_editors/seam_editors3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view1.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view1_1.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view1_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view1_2.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view1_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view1_3.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view1_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view1_4.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view1_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view2.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view3.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_view/seam_view4.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_view/seam_view4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards2.png =================================================================== (Binary files differ) Modified: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards3.png =================================================================== (Binary files differ) Added: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards4.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards4_1.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards4_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards5.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards6.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards6_1.png =================================================================== (Binary files differ) Property changes on: trunk/seam/docs/reference/en/images/seam_wizards/seam_wizards6_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/seam/docs/reference/en/master.xml =================================================================== --- trunk/seam/docs/reference/en/master.xml 2007-11-23 12:29:29 UTC (rev 5052) +++ trunk/seam/docs/reference/en/master.xml 2007-11-23 13:01:17 UTC (rev 5053) @@ -8,6 +8,9 @@ <!ENTITY directory_structure SYSTEM "modules/directory_structure.xml"> <!ENTITY seam_wizards SYSTEM "modules/seam_wizards.xml"> <!ENTITY generate_entities SYSTEM "modules/generate_entities.xml"> +<!ENTITY seam_editors SYSTEM "modules/seam_editors.xml"> +<!ENTITY seam_view SYSTEM "modules/seam_view.xml"> + <!ENTITY crud_database_application SYSTEM "modules/crud_database_application.xml"> <!ENTITY crud_application_walkthrough SYSTEM "modules/crud_application_walkthrough.xml"> <!ENTITY business_application SYSTEM "modules/business_application.xml"> @@ -22,7 +25,7 @@ <year>2007</year> <holder>Red Hat</holder> </copyright> - <releaseinfo> + <releaseinfo> <para>Version: 2.0.0.GA</para> </releaseinfo> </bookinfo> @@ -35,6 +38,8 @@ &directory_structure; &seam_wizards; &generate_entities; +&seam_editors; +&seam_view; &crud_database_application; &crud_application_walkthrough; &testng; Modified: trunk/seam/docs/reference/en/modules/creating_new_seam.xml =================================================================== --- trunk/seam/docs/reference/en/modules/creating_new_seam.xml 2007-11-23 12:29:29 UTC (rev 5052) +++ trunk/seam/docs/reference/en/modules/creating_new_seam.xml 2007-11-23 13:01:17 UTC (rev 5053) @@ -149,7 +149,7 @@ <para>This wizard helps you to add JSF capabilities into your project. </para> <para>Checking <emphasis><property>Server Supplied JSF Implementation</property></emphasis> - means that you will have a default JSF implementation deployed on server. </para> + means that you will have a default JSF implementation given by server.</para> <figure> <title>Adding JSF Capabilities to Web Project</title> @@ -160,7 +160,7 @@ </mediaobject> </figure> - <para>In case when you want to create your custom JSF implementation check a lower radio button. You are able to create a library of jars by clicking on + <para>In case when you want to use your custom JSF implementation check a lower radio button. You are able to create a library of jars by clicking on <emphasis><property>New</property></emphasis> button.</para> <para>Type a <property>Library Name</property>, select a <property>Version Supported</property> and add <property>Library jars</property>. Click on <emphasis><property>Finish</property>.</emphasis></para> <figure> @@ -213,6 +213,7 @@ <itemizedlist> <listitem><para>Create Seam runtime and define Seam home folder. Click on <emphasis><property>Add</property></emphasis> button in the <property>General</property> section.</para></listitem> </itemizedlist> + <para>Notice that in this wizard presented below you can create a Seam runtime only for that version which was selected in the <link linkend="projectFacets">Project Facets</link> wizard (version 1.2 in our case).</para> <figure> <title>Seam Runtime Creation</title> Added: trunk/seam/docs/reference/en/modules/seam_editors.xml =================================================================== --- trunk/seam/docs/reference/en/modules/seam_editors.xml (rev 0) +++ trunk/seam/docs/reference/en/modules/seam_editors.xml 2007-11-23 13:01:17 UTC (rev 5053) @@ -0,0 +1,88 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="seam_editors" xreflabel="seam_editors"> + <?dbhtml filename="seam_editors.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Seam</keyword> + <keyword>RHDS</keyword> + </keywordset> + </chapterinfo> + + <title>Seam Editors Features</title> + + <section> + + <title>Content Assist</title> + + <para><property>Content Assist</property> (ctrl + space) is available when using expression language in:</para> + <itemizedlist> + <listitem><para>JSP</para></listitem> + <listitem><para>XHTML</para></listitem> + <listitem><para>XML</para></listitem> + <listitem><para>JAVA</para></listitem> + </itemizedlist> + + <figure> + <title>Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors1.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section> + <title>OpenOn</title> + + <para><property>OpenOn</property> let's you easily navigate through your project without using the Package Explorer or Project Explorer. + After pressing ctrl + left click you will see a corresponding method or class.</para> + + <figure> + <title>OpenOn</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors2.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section> + <title>Seam Validation</title> + + <para>Validation of various possible problematic definitions is implemented for Seam applications.</para> + + <para>If an issue is found it will show up in the standard <property>Problems View</property>.</para> + + <figure> + <title>OpenOn</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors2_1.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>In the preferences page for Seam Validator you can see and modify the validator behavior. Go to <emphasis><property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property></emphasis> + and select the severity level for the optional Seam Validator problem.</para> + + <figure> + <title>Seam Validator Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On WTP projects validation are enabled by default and thus executed automatically, but on normal Java projects you will have to go and add the Validation builder to your project . + It is available in the properties of your project under <property>Validation</property>. The validations can be run manually by clicking <property>Validate</property> via the context menu + on your project which will execute all the active WTP validations.</para> + </section> + + </chapter> Added: trunk/seam/docs/reference/en/modules/seam_view.xml =================================================================== --- trunk/seam/docs/reference/en/modules/seam_view.xml (rev 0) +++ trunk/seam/docs/reference/en/modules/seam_view.xml 2007-11-23 13:01:17 UTC (rev 5053) @@ -0,0 +1,129 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="seam_view" xreflabel="seam_view"> + <?dbhtml filename="seam_view.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Seam</keyword> + <keyword>RHDS</keyword> + </keywordset> + </chapterinfo> + + <title>Seam Views</title> + + <section> + <title>Seam Components View</title> + + <para>The <property>Seam Components View</property> is available from Seam perspective. It provides a list of the seam components found in the project.</para> + + <figure> + <title>Seam Components View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Seam Component View can show a components default scope in two ways:</para> + + <itemizedlist> + <listitem><para>as labels on each component</para></listitem> + </itemizedlist> + + <figure> + <title>As label</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view1_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>as a node per scope where the components are grouped under a node representing its default scope.</para></listitem> + </itemizedlist> + + <figure> + <title>As node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view1_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Seam Packages can be presented in two ways:</para> + + <itemizedlist> + <listitem><para>Flat</para></listitem> + </itemizedlist> + + <figure> + <title>Flat Presentation of Seam Packages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view1_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>Hierarchical</para></listitem> + </itemizedlist> + + <figure> + <title>Hierarchical Presentation of Seam Packages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view1_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Seam Component View can be filtered by choosing <property>Customize View</property></para> + + <figure> + <title>Customize View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> and select the <emphasis><property>Seam Components from Libraries</property></emphasis> under the Filters tab. + This will make the view ignore components defined in jar's. This will hide the many built-in Seam components and leave only those left that are actually + defined in the project or have actively configured via components.xml. Consequently deselecting the filter will show you all available components.</para> + <para>Selecting the <emphasis><property>Seam Components from Referenced Projects</property></emphasis> will hide the components that are dependent on other project.</para> + + <figure> + <title>Available Customozations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view3.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + + <section> + <title>Project Explorer integration</title> + + <para>If you don't like to have a view for every piece of information in Eclipse, the content of the Seam Components view is also avaible as a node + in the built-in Project Explorer (not Package Explorer !) view in Eclipse.</para> + + <figure> + <title>Seam Components in Project Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_view/seam_view4.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + </chapter> Modified: trunk/seam/docs/reference/en/modules/seam_wizards.xml =================================================================== --- trunk/seam/docs/reference/en/modules/seam_wizards.xml 2007-11-23 12:29:29 UTC (rev 5052) +++ trunk/seam/docs/reference/en/modules/seam_wizards.xml 2007-11-23 13:01:17 UTC (rev 5053) @@ -38,6 +38,9 @@ <title>New Seam Action</title> + <para>To create a New Seam Action you should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, + <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis><property>Browse</property></emphasis> button.</para> + <para>WAR deployment:</para> <figure> @@ -49,9 +52,10 @@ </mediaobject> </figure> + <para>EAR deployment differs from WAR in that you need type a name for <property>Local interface</property> and <property>Bean</property>.</para> <para>EAR deployment:</para> - + <figure> <title>New Seam Action Wizard</title> <mediaobject> @@ -65,14 +69,81 @@ <section id="seam_form"> <title>New Seam Form</title> + <para>To create a New Seam Form you should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, + <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis><property>Browse</property></emphasis> button.</para> + <para>WAR deployment:</para> + + <figure> + <title>New Seam Form Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards4.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>EAR deployment differs from WAR in that you need type a name for <property>Local interface</property> and <property>Bean</property>.</para> + <para>EAR deployment:</para> + + <figure> + <title>New Seam Form Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards4_1.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> <section id="seam_entity"> <title>New Seam Entity</title> + <para>To create New Seam Entity you should select a necessary project, type a name for <property>Entity class</property>, select a + <property>Package</property> using <emphasis><property>Browse</property></emphasis> button, type a name for <property>Master Page</property> and <property>Page</property>.</para> + + <figure> + <title>New Seam Entity Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards5.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> <section id="seam_conversation"> <title>New Seam Conversation</title> + + <para>To create a New Seam Conversation you should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, + <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis><property>Browse</property></emphasis> button.</para> + + <para>WAR deployment:</para> + + <figure> + <title>New Seam Conversation Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>EAR deployment differs from WAR in that you need type a name for <property>Local interface</property> and <property>Bean</property>.</para> + <para>EAR deployment:</para> + + <figure> + <title>New Seam Conversation Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards6_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> </chapter>