Author: afedosik Date: 2008-01-17 11:57:05 -0500 (Thu, 17 Jan 2008) New Revision: 5771 Removed: trunk/jsf/docs/userguide/en/modules/features_list.xml trunk/jsf/docs/userguide/en/modules/jboss_tools.xml Modified: trunk/jsf/docs/userguide/en/master.xml trunk/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml trunk/jsf/docs/userguide/en/modules/jsf_support.xml Log: http://jira.jboss.com/jira/browse/JBDS-162 Guide structure and JSF support chapter updated according Sveta remarks Modified: trunk/jsf/docs/userguide/en/master.xml =================================================================== --- trunk/jsf/docs/userguide/en/master.xml 2008-01-17 16:05:19 UTC (rev 5770) +++ trunk/jsf/docs/userguide/en/master.xml 2008-01-17 16:57:05 UTC (rev 5771) @@ -4,7 +4,6 @@ [ <!ENTITY Visual_Web_Tools SYSTEM "modules/Visual_Web_Tools.xml"> -<!ENTITY features_list SYSTEM "modules/features_list.xml"> <!ENTITY jsf_support SYSTEM "modules/jsf_support.xml"> <!ENTITY struts_support SYSTEM "modules/struts_support.xml"> <!ENTITY editors SYSTEM "modules/editors.xml"> @@ -34,10 +33,8 @@ <toc/> - &jsf_support; &Visual_Web_Tools; - &features_list; - + &jsf_support; &struts_support; &editors; &palette; Modified: trunk/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml 2008-01-17 16:05:19 UTC (rev 5770) +++ trunk/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml 2008-01-17 16:57:05 UTC (rev 5771) @@ -11,8 +11,113 @@ </chapterinfo> <title>Visual Web Tools</title> - <para>In <property>JBoss Tools</property> - there is an extensive collection of specialized wizards, - editors and views that can be used in various scenarios while developing Web applications. The following - chapters walksthrough these features.</para> + + <para>This guide covers the usage of Visual Web Tools in <property>JBoss Developer Studio</property> and <property>JBoss Tools</property>. The difference + between these products is that JBoss Tools are just a set of Eclipse plugins and JBoss Developer Studio adds:</para> + <itemizedlist> + <listitem><para>an installer</para></listitem> + <listitem><para>Eclipse and Web Tools preconfigured</para></listitem> + <listitem><para>JBoss EAP with JBoss AS and Seam preconfigured</para></listitem> + <listitem><para>3rd party plugins bundled and configured</para></listitem> + <listitem><para>access to RHEL and Red Hat Network</para></listitem> + <listitem><para>access to the JBoss/Red Hat supported software</para></listitem> + </itemizedlist> + + <para>You can find more information about JBoss Developer Studio <ulink url="http://www.jboss.com/products/devstudio">here</ulink... + + <para>In JBoss Tools there is an extensive collection of specialized wizards, editors and views that can be used in various scenarios while developing Web + applications. The following chapters walk through these features.</para> + + <section id="key_features"> + <title>Key Features of Visual Web Tools</title> + <para>Here is the table of main features of Visual Web Tools:</para> + <table> + <title>Key Functionality for Visual Web Tools</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + <tbody> + <row> + <entry>Visual Page Editor</entry> + <entry>Powerful and customizable visual page editor. Possibility to develop an application using any web technology: jsf, seam, struts, jsp, html and others. Developing using four tabs: visual/source, visual, source and preview.Fast and easy switching between these tabs. Split screen design of visual and source views. Full and instant synchronization between source and visual views. Integration with properties and outline views. Graphical toolbar to add inline styling to any tag.</entry> + <entry><link linkend="visual_page">visual page editor</link></entry> + </row> + <row> + <entry>JBoss Tools Palette</entry> + <entry>Organizing various tags by groups, inserting tags into a jsp or xhtml page with one click, adding custom or 3rd party tag libraries into the palette, easy controling the number of tag groups shown on the palette.</entry> + <entry><link linkend="palette">jboss tools palette</link></entry> + </row> + <row> + <entry>Web Projects View</entry> + <entry>Visualizing and displaying projects by function. Easy selecting of different kinds of items and dropping them into jsp pages. Using context menus to develop the application. Using icon shortcuts to create and import JSF and Struts projects. Expanding and inspecting tag library files. Selecting custom and third-party tag libraries to drag and drop onto the JBoss Tools Palette.</entry> + <entry><link linkend="web_projects">web projects view</link></entry> + </row> + <row> + <entry>JSF and Facelets support</entry> + <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry> + <entry><link linkend="SupportForJSFEnvironmentsJSF_RIMyFacesFaceletsShaleOrAnyCustom442">jsf support</link></entry> + </row> + + <row> + <entry>Flexible and customizable project template management</entry> + <entry>Jump-start development with out-of-the-box templates or easily customized templates + for re-use.</entry> + <entry><link linkend="WorkingWithProjects7844">working with projects</link></entry> + </row> + <row> + <entry>Support for Managed Beans</entry> + <entry>Adding new managed beans, generating code for attributes, properties and getter/setter methods.</entry> + <entry><link linkend="ManagedBeans96453">managed beans</link></entry> + </row> + <row> + <entry>OpenOn</entry> + <entry>Easy navigation between views and other parts of your projects.</entry> + <entry><link linkend="FaceletsSupport865">facelets support</link></entry> + </row> + <row> + <entry>Content Assist</entry> + <entry>Code completion proposals while working in java, xml, jsp, xhtml, xhtml, seam project and jsf configuration files. Content assist based on project data (dynamic code assist); with graphical editor. Code completion for values from property files, beans attributes and methods, navigation rule outcomes and jsf variables.</entry> + <entry><link linkend="ContentAssist976">content assist</link></entry> + </row> + <row> + <entry>Support for Custom Converters and Validators</entry> + <entry>Fast creating of custom converters and validators with tree view of faces-config.xml file.</entry> + <entry><link linkend="CreateAndRegisterACustomConverter94230">converters and validators</link></entry> + </row> + <row> + <entry>Verification and Validation</entry> + <entry>All occuring errors will be immediately reported by verification feature, no matter in what view you are working. Constant validation and errors checking allows to catch many of the errors during development process that significantly reduces development time.</entry> + <entry><link linkend="verif_valid">verification and validation</link></entry> + </row> + <row> + <entry>Drag-and-Drop</entry> + <entry>Possibility of inserting any tag onto the page you are editing by just drag-and-droping it from the palette to this page. Adding any properties, managed bean attributes, navigation rules, tag library file declarations, jsp files from web projects view by clicking them and draging to source code.</entry> + <entry><link linkend="visual_page">visual page editor</link> <link linkend="DragAndDrop">drag-and-drop</link></entry> + </row> + <row> + <entry>Struts Support</entry> + <entry>Step-by-step wizards for creating a new struts project with a number of predefined templates, importing existing ones and adding struts capabilities to non-struts web projects.</entry> + <entry><link linkend="struts1">struts support</link></entry> + </row> + + <row> + <entry>Support for JSF and JSF Configuration Files</entry> + <entry>Working on files using three modes: diagram, tree and source. Synchronization between the modes and full control over the code. Easy moving around the diagram using the Diagram Navigator. Working with struts projects that have multiple modules. Possibility to use Struts configuration file debugger allowing to set break points on struts diagram and then launch the server in debug mode.</entry> + <entry><link linkend="GraphicalEditorAndViewingForJSFConfigurationFiles76331">graphical editor for jsf</link> <link linkend="GraphicalEditorForStrutsConfigurationFiles564">graphical editor for struts</link> </entry> + </row> + <row> + <entry>Rich Faces Support</entry> + <entry>Tight integration between JBDS and RichFaces frameworks. Easy managing RichFaces components in any web application.</entry> + <entry><link linkend="RichFacesSupport">rich faces support</link></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + </chapter> Deleted: trunk/jsf/docs/userguide/en/modules/features_list.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/features_list.xml 2008-01-17 16:05:19 UTC (rev 5770) +++ trunk/jsf/docs/userguide/en/modules/features_list.xml 2008-01-17 16:57:05 UTC (rev 5771) @@ -1,94 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="roadmap" xreflabel="roadmap"> - <?dbhtml filename="roadmap.html"?> - <title>Key Features of Visual Web Tools</title> - <para>Here is the table of main features of Visual Web Tools:</para> - <table> - <title>Key Functionality for Visual Web Tools</title> - <tgroup cols="3"> - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - <entry>Chapter</entry> - </row> - </thead> - <tbody> - <row> - <entry>Visual Page Editor</entry> - <entry>Powerful and customizable visual page editor. Possibility to develop an application using any web technology: jsf, seam, struts, jsp, html and others. Developing using four tabs: visual/source, visual, source and preview.Fast and easy switching between these tabs. Split screen design of visual and source views. Full and instant synchronization between source and visual views. Integration with properties and outline views. Graphical toolbar to add inline styling to any tag.</entry> - <entry><link linkend="visual_page">visual page editor</link></entry> - </row> - <row> - <entry>JBoss Tools Palette</entry> - <entry>Organizing various tags by groups, inserting tags into a jsp or xhtml page with one click, adding custom or 3rd party tag libraries into the palette, easy controling the number of tag groups shown on the palette.</entry> - <entry><link linkend="palette">jboss tools palette</link></entry> - </row> - <row> - <entry>Web Projects View</entry> - <entry>Visualizing and displaying projects by function. Easy selecting of different kinds of items and dropping them into jsp pages. Using context menus to develop the application. Using icon shortcuts to create and import JSF and Struts projects. Expanding and inspecting tag library files. Selecting custom and third-party tag libraries to drag and drop onto the JBoss Tools Palette.</entry> - <entry><link linkend="web_projects">web projects view</link></entry> - </row> - <row> - <entry>JSF and Facelets support</entry> - <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry> - <entry><link linkend="SupportForJSFEnvironmentsJSF_RIMyFacesFaceletsShaleOrAnyCustom442">jsf support</link></entry> - </row> - - <row> - <entry>Flexible and customizable project template management</entry> - <entry>Jump-start development with out-of-the-box templates or easily customized templates - for re-use.</entry> - <entry><link linkend="WorkingWithProjects7844">working with projects</link></entry> - </row> - <row> - <entry>Support for Managed Beans</entry> - <entry>Adding new managed beans, generating code for attributes, properties and getter/setter methods.</entry> - <entry><link linkend="ManagedBeans96453">managed beans</link></entry> - </row> - <row> - <entry>OpenOn</entry> - <entry>Easy navigation between views and other parts of your projects.</entry> - <entry><link linkend="FaceletsSupport865">facelets support</link></entry> - </row> - <row> - <entry>Content Assist</entry> - <entry>Code completion proposals while working in java, xml, jsp, xhtml, xhtml, seam project and jsf configuration files. Content assist based on project data (dynamic code assist); with graphical editor. Code completion for values from property files, beans attributes and methods, navigation rule outcomes and jsf variables.</entry> - <entry><link linkend="ContentAssist976">content assist</link></entry> - </row> - <row> - <entry>Support for Custom Converters and Validators</entry> - <entry>Fast creating of custom converters and validators with tree view of faces-config.xml file.</entry> - <entry><link linkend="CreateAndRegisterACustomConverter94230">converters and validators</link></entry> - </row> - <row> - <entry>Verification and Validation</entry> - <entry>All occuring errors will be immediately reported by verification feature, no matter in what view you are working. Constant validation and errors checking allows to catch many of the errors during development process that significantly reduces development time.</entry> - <entry><link linkend="verif_valid">verification and validation</link></entry> - </row> - <row> - <entry>Drag-and-Drop</entry> - <entry>Possibility of inserting any tag onto the page you are editing by just drag-and-droping it from the palette to this page. Adding any properties, managed bean attributes, navigation rules, tag library file declarations, jsp files from web projects view by clicking them and draging to source code.</entry> - <entry><link linkend="visual_page">visual page editor</link> <link linkend="DragAndDrop">drag-and-drop</link></entry> - </row> - <row> - <entry>Struts Support</entry> - <entry>Step-by-step wizards for creating a new struts project with a number of predefined templates, importing existing ones and adding struts capabilities to non-struts web projects.</entry> - <entry><link linkend="struts1">struts support</link></entry> - </row> - - <row> - <entry>Support for JSF and JSF Configuration Files</entry> - <entry>Working on files using three modes: diagram, tree and source. Synchronization between the modes and full control over the code. Easy moving around the diagram using the Diagram Navigator. Working with struts projects that have multiple modules. Possibility to use Struts configuration file debugger allowing to set break points on struts diagram and then launch the server in debug mode.</entry> - <entry><link linkend="GraphicalEditorAndViewingForJSFConfigurationFiles76331">graphical editor for jsf</link> <link linkend="GraphicalEditorForStrutsConfigurationFiles564">graphical editor for struts</link> </entry> - </row> - <row> - <entry>Rich Faces Support</entry> - <entry>Tight integration between JBDS and RichFaces frameworks. Easy managing RichFaces components in any web application.</entry> - <entry><link linkend="RichFacesSupport">rich faces support</link></entry> - </row> - </tbody> - </tgroup> - </table> - - </chapter> \ No newline at end of file Deleted: trunk/jsf/docs/userguide/en/modules/jboss_tools.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/jboss_tools.xml 2008-01-17 16:05:19 UTC (rev 5770) +++ trunk/jsf/docs/userguide/en/modules/jboss_tools.xml 2008-01-17 16:57:05 UTC (rev 5771) @@ -1,36 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="jboss_tools" xreflabel="jboss_tools"> - <?dbhtml filename="jboss_tools.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Eclipse</keyword> - <keyword>Java</keyword> - <keyword>Tomcat</keyword> - </keywordset> - </chapterinfo> - <title>JBoss Tools</title> -<para>JBoss Tools is an umbrella project for the JBoss developed plugins that will make it into JBoss Developer Studio. It includes the following Eclipse modules:</para> -<itemizedlist> - <listitem><para><emphasis><property>Seam Tools</property></emphasis> Will include support for seam-gen, RichFaces VE integration, Seam related code completion and refactoring and more.</para> - <para>To read more on Seam, see <ulink url="http://docs.jboss.com/seam/2.0.0.GA/reference/en/html/index.htm... Reference Guide </ulink> or <ulink url="http://www.redhat.com/developers/jbds/Getting_Started/GetStartS... Started Guide</ulink></para></listitem> - <!--TODO link for Seam Guide --> - - <listitem><para><emphasis><property>RichFaces Support</property></emphasis>. <para>Rich Faces is an open source framework that adds Ajax capability into existing JSF applications without resorting to JavaScript.</para> - <para>To read more on RF, see<ulink url="http://labs.jboss.com/jbossrichfaces/docs/index.html"> RF Developer Guide</ulink></para></listitem> - - <listitem><para><emphasis><property>Hibernate Tools</property></emphasis>Supporting mapping files, annotations and JPA with reverse engineering, code completion, project wizards, refactoring, interactive HQL/JPA-QL/Criteria execution and more.In short a merger of Hibernate Tools and Exadel ORM features.</para> - <para>To read more on Hibernate Tools, see <ulink url="http://www.hibernate.org/hib_docs/tools/reference/en/html/"... Tools Reference Guide</ulink></para></listitem> - - <listitem><para><emphasis><property>JBoss AS Tools</property></emphasis> Easy start, stop and debug of JBoss AS 4+ servers from within Eclipse. Will also include features for efficient packaging and deployment of any type of Eclipse project.</para></listitem> - <!-- TODO link for docs <para>To read more on AS Tools, see <ulink url="AS Tools">Hibernate Tools Reference Guide</ulink></listitem>--> - - <listitem><para><emphasis><property>Drools IDE</property></emphasis>Rules file editing, Rete View, working memory debugging/inspection and more.</para></listitem> - <!-- TODO link for docs <para>To read more on AS Tools, see <ulink url="AS Tools">Hibernate Tools Reference Guide</ulink></listitem>--> - - <listitem><para><emphasis><property>JBPM Tools</property></emphasis>JBPM workflow editing, deployment and more.</para></listitem> - <!-- TODO link for docs <para>To read more on AS Tools, see <ulink url="AS Tools">Hibernate Tools Reference Guide</ulink></listitem>--> - - </itemizedlist> - -</chapter> Modified: trunk/jsf/docs/userguide/en/modules/jsf_support.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/jsf_support.xml 2008-01-17 16:05:19 UTC (rev 5770) +++ trunk/jsf/docs/userguide/en/modules/jsf_support.xml 2008-01-17 16:57:05 UTC (rev 5771) @@ -85,13 +85,15 @@ <?dbhtml filename="FaceletsSupport.html"?> <title>Facelets Support</title> - <para><property>Facelets</property> extends JavaServer Faces by providing a - lightweight framework that radically simplifies the design of presentation - pages for JSF. JBoss Developer Studio provides support for Facelets in a - variety of ways.</para> + <para>The <ulink url="https://facelets.dev.java.net/">Facelets</ulink> extends JavaServer Faces by providing a lightweight framework that radically simplifies the design + of presentation pages for JSF. JBoss Developer Studio provides support for Facelets in a variety of ways:</para> + + <itemizedlist> + <listitem><para>The New JSF Project wizard contains templates for creating Facelets projects based on version 1.2 of the JSF Reference Implementation. Just select the + <property>JSF 1.2 with Facelets</property> in JSF Environment section.</para></listitem> + </itemizedlist> - <para>The Create New JSF Project wizard contains templates for creating - Faceletsprojects based on version 1.2 of the JSF Reference Implementation:</para> + <figure> <title>Choosing Facelets Environment</title> <mediaobject> @@ -101,8 +103,7 @@ </mediaobject> </figure> - <para>Once you select the environment, you can select one of the six available - templates:</para> + <para>Once you select the environment, you can select the one of three available templates.</para> <figure> <title>Choosing Facelets Template</title> <mediaobject> @@ -111,8 +112,13 @@ </imageobject> </mediaobject> </figure> - <para>The JBoss Tools Palette comes with the Facelets components ready to use. A - useful tip appears when you hover the mouse cursor over the tag - that includes a detailed description of the tag component, the syntax and available attributes:</para> + + <itemizedlist> + <listitem><para>The JBoss Tools Palette comes with the Facelets components ready to use. A + useful tip appears when you hover the mouse cursor over the tag, the tip includes a detailed description of the tag component, the syntax and available attributes.</para></listitem> + </itemizedlist> + + <!-- JBoss Developer Studio does not provide templates for MyFaces right out of the box, but you can easily do it yourself with the &quot;Save As Template&quot; feature (available on the File submenu). Just create a small project @@ -129,8 +135,11 @@ </imageobject> </mediaobject> </figure> - <para>Code assist for <property>Facelets tags</property> is available when editing - xhtml files:</para> + + <itemizedlist> + <listitem><para>Code assist (ctrl + space) for <property>Facelets tags</property> is available when editing xhtml files.</para></listitem> + </itemizedlist> + <figure> <title>XHTML File Code Assist</title> <mediaobject> @@ -140,16 +149,9 @@ </mediaobject> </figure> - <itemizedlist> - <listitem> - <para>Code assist is also available for <emphasis - role="italic"> - <property>&quot;jsfc&quot;</property> - </emphasis> attribute in any HTML tag</para> - </listitem> - </itemizedlist> - - <figure> + <para>Code assist is also available for <emphasis role="italic"><property>&quot;jsfc&quot;</property></emphasis> attribute in any HTML tag.</para> + + <figure> <title>Code Assist for Jsfc Attribute</title> <mediaobject> <imageobject> @@ -158,14 +160,9 @@ </mediaobject> </figure> - <itemizedlist> - <listitem> - <para>Then you get the code assist for JSF components are available - on the page</para> - </listitem> - </itemizedlist> - - <figure> + <para>After selecting <emphasis role="italic"><property>&quot;jsfc&quot;</property></emphasis> you get the code assist for JSF components available on a page.</para> + + <figure> <title>Code Assist for JSF Components</title> <mediaobject> <imageobject> @@ -174,15 +171,10 @@ </mediaobject> </figure> - <itemizedlist> - <listitem> - <para>Then you will see all available attributes for the - component.</para> - </listitem> - </itemizedlist> - + <para>When a component is chosen you will see all available attributes for it.</para> + <figure> - <title/> + <title>Available Attributes for the Component</title> <mediaobject> <imageobject> <imagedata fileref="images/jsf_support/jsf_support_8.png" scale="80"/> @@ -190,11 +182,14 @@ </mediaobject> </figure> - <para>JBDS provides Eclipse&apos;s <emphasis><property>OpenOn</property></emphasis> feature for editing Facelets files. Using this feature, you can easily navigate between - the <property>Facelets templates</property> and other parts of your - projects. Just by holding down the Control key while hovering the mouse - cursor over a reference to a template, the reference becomes a hyperlink to - open that template.</para> +<itemizedlist> + <listitem> <para>JBDS provides Eclipse&apos;s <emphasis><property>OpenOn</property></emphasis> feature for editing Facelets files. Using this feature, you can easily navigate between + the <property>Facelets templates</property> and other parts of your + projects. Just by holding down the Control key while hovering the mouse + cursor over a reference to a template, the reference becomes a hyperlink to + open that template.</para></listitem> +</itemizedlist> + <figure> <title>Template Hyperlink</title> <mediaobject>