Author: smukhina Date: 2007-11-20 11:26:02 -0500 (Tue, 20 Nov 2007) New Revision: 4986 Removed: trunk/jsf/docs/userguide/en/modules/visual_page.xml Modified: trunk/jsf/docs/userguide/en/master.xml trunk/jsf/docs/userguide/en/modules/jsf_support.xml trunk/jsf/docs/userguide/en/modules/roadmap.xml Log: chapters on editors are placed into one chapter name of the guide is changed, as it is mostly of RHDS and not JBossTools http://jira.jboss.com/jira/browse/RHDS-175 Modified: trunk/jsf/docs/userguide/en/master.xml =================================================================== --- trunk/jsf/docs/userguide/en/master.xml 2007-11-20 16:08:24 UTC (rev 4985) +++ trunk/jsf/docs/userguide/en/master.xml 2007-11-20 16:26:02 UTC (rev 4986) @@ -2,39 +2,27 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "../../resources/support/docbook-dtd/docbookx.dtd" -[<!ENTITY rhds SYSTEM "modules/rhds.xml"> +[ +<!ENTITY rhds SYSTEM "modules/rhds.xml"> <!ENTITY roadmap SYSTEM "modules/roadmap.xml"> <!ENTITY jsf_support SYSTEM "modules/jsf_support.xml"> <!ENTITY struts SYSTEM "modules/struts.xml"> -<!-- <!ENTITY HibernateTools SYSTEM "modules/HibernateTools.xml"> --> - -<!-- <!ENTITY DeploymentandRunning SYSTEM "modules/DeploymentandRunning.xml"> --> - -<!--<!ENTITY AddingCustomCapabilityFeaturesTemplates SYSTEM "modules/AddingCustomCapabilityFeaturesTemplates.xml">--> - <!ENTITY palette SYSTEM "modules/palette.xml"> - <!ENTITY web_projects SYSTEM "modules/web_projects.xml"> +<!ENTITY editors SYSTEM "modules/editors.xml"> +<!ENTITY verif_valid SYSTEM "modules/verif_valid.xml"> +<!--<!ENTITY editors_features SYSTEM "modules/editors_features.xml"> --> -<!-- <!ENTITY J2EEandOtherTools SYSTEM "modules/J2EEandOtherTools.xml"> --> -<!ENTITY visual_page SYSTEM "modules/visual_page.xml"> <!ENTITY verif_valid SYSTEM "modules/verif_valid.xml"> -<!ENTITY editors_features SYSTEM "modules/editors_features.xml"> -<!-- <!ENTITY DatabaseTools SYSTEM "modules/DatabaseTools.xml"> --> -<!ENTITY verif_valid SYSTEM "modules/verif_valid.xml"> - -<!ENTITY visual_page SYSTEM "modules/visual_page.xml"> - -<!ENTITY more_editors SYSTEM "modules/more_editors.xml"> +<!-- <!ENTITY more_editors SYSTEM "modules/more_editors.xml"> --> <!ENTITY preferences SYSTEM "modules/preferences.xml"> -<!ENTITY faq SYSTEM "modules/faq.xml"> + ]> <book> <bookinfo> - <title>JBoss JSF and Struts Tools</title> - <!-- <subtitle>A JSF component library built on Ajax4jsf for incorporating rich UI widgets into Web applications</subtitle> --> + <title>RHDS Reference Guide</title> <copyright> <year>2007</year> <holder>Red Hat</holder> @@ -45,30 +33,15 @@ </bookinfo> <toc/> - - &rhds; - &roadmap; + &rhds; + &roadmap; &jsf_support; &struts; - <!-- &HibernateTools; --> - - <!--&AddingCustomCapabilityFeaturesTemplates; --> - - <!-- &DeploymentandRunning; --> - &palette; - &web_projects; - - - <!-- &DatabaseTools; - &J2EEandOtherTools; --> - &verif_valid; - &editors_features; - &visual_page; - &more_editors; +<!-- &editors_features; --> + &editors; +<!-- &more_editors; --> &preferences; - &faq; - </book> Modified: trunk/jsf/docs/userguide/en/modules/jsf_support.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/jsf_support.xml 2007-11-20 16:08:24 UTC (rev 4985) +++ trunk/jsf/docs/userguide/en/modules/jsf_support.xml 2007-11-20 16:26:02 UTC (rev 4986) @@ -92,6 +92,14 @@ </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:</para> + +<!-- Red Hat 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 + with MyFaces and Facelets and then save it as a template for future use. + + How can I add Facelets support to an existing project?</para> + <para>A: Right-click on the folder of existing project and select <emphasis>JBoss Tools &gt; Add Custom Capabilities.. &gt; Facelets</emphasis>. </para> + --> <figure> <title>Facelets Components</title> <mediaobject> Modified: trunk/jsf/docs/userguide/en/modules/roadmap.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/roadmap.xml 2007-11-20 16:08:24 UTC (rev 4985) +++ trunk/jsf/docs/userguide/en/modules/roadmap.xml 2007-11-20 16:26:02 UTC (rev 4986) @@ -2,31 +2,45 @@ <chapter id="roadmap" xreflabel="roadmap"> <?dbhtml filename="roadmap.html"?> <title>Roadmap to Learn Red Hat Developer Studio</title> - <para><property>Red Hat Developer Studio</property> is an advanced enterprise-level Web application development environment for - leveraging open source, J2EE and AJAX technologies within the Eclipse environment.</para> - <para>The extensive collection of specialized wizards, - editors and views in Red Hat Developer Studio is constantly - expanding to meet the needs of enterprise developers to keep pace - with rapidly changing business environments. Red Hat Developer - Studio is packed with powerful features, including a WYSIWYG Visual - Page Editor for JSP files and also comprehensive support for Hibernate Object/Relational Mapping covering - reverse-engineering and meet-in-the-middle approaches.</para> -<para>One of the most essential elements of <property>Red Hat Developer Studio</property> is <property>Seam framework</property>. -Seam provides a single programming model for developers to use underlying frameworks such as JSF, EJB3, JMS, Web Services, jBPM, JBoss Rules, Ajax4jsf, RichFaces, Facelets, Spring, iText, Quartz, TestNG, etc., via simple annotated POJOs (Plain Old Java Objects).</para> - <section id="RedHatDeveloperStudio"> - <?dbhtml filename="GettingStartedwithRHDS.html"?> - <title>Red Hat Developer Studio</title> - - <para>Red Hat Developer Studio includes a versatile WYSIWYG Visual Page Editor for JSP files. You have a possibility to visually design HTML/XHTML/JSP/JSF pages with drag and drop or see visual changes as you edit markup:</para> - <figure> + <para><property>Red Hat Developer Studio</property> is an advanced enterprise-level Web application development environment for + leveraging open source, J2EE and AJAX technologies within the Eclipse environment. The extensive collection of specialized wizards, editors and views in Red Hat Developer Studio is constantly expanding to meet the needs of enterprise developers to keep pace with rapidly changing business environments. Red Hat Developer Studio is packed with lot's of powerful features:</para> + + <figure> <title>Red Hat Developer Studio Overview</title> <mediaobject> <imageobject> <imagedata fileref="images/roadmap/roadmap_1.png"/> </imageobject> </mediaobject> - </figure> - <para>Here is the table of main features of <property>Red Hat Developer Studio</property>:</para> +</figure> + +<itemizedlist> +<listitem><para><property>Seam framework</property> Seam provides a single programming model for developers to use underlying frameworks such as JSF, EJB3, JMS, Web Services, jBPM, JBoss Rules, Ajax4jsf, RichFaces, Facelets, Spring, iText, Quartz, TestNG, etc., via simple annotated POJOs (Plain Old Java Objects).</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/rhds/Getting_Started/GetStartS... Started Guide</ulink></para></listitem> +<!--TODO link for Seam Guide --> + +<listitem><para><property>Hibernate Tools</property> 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><property>RichFaces Support</property>. 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>JBoss AS Tools</property></emphasis> Easy start, stop and debug of JBoss AS 4+ servers from within Eclipse. It also includes 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><property>JBPM Tools</property> 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>--> + +<listitem><para><property>WYSIWYG Visual Page Editor </property> gives a possibility to visually design HTML/XHTML/JSP/JSF pages with drag and drop or see visual changes as you edit markup.</para></listitem> + +<!-- <ulink url="http://docs.jboss.com/seam/2.0.0.GA/reference/en/html/index.htm... VPE Chapter </ulink> or <ulink url="http://www.redhat.com/developers/rhds/Getting_Started/GetStartS... Started Guide</ulink></para></listitem> --> + +<listitem> And lot's of other useful functionality described further in this guide</listitem> + +</itemizedlist> + + + <!-- <para>Here is the table of main features of <property>Red Hat Developer Studio</property>:</para> <table> <title>Key Functionality for Red Hat Developer Studio</title> <tgroup cols="2"> @@ -97,7 +111,8 @@ </tbody> </tgroup> </table> - - <para>Red Hat Developer Studio, through a steady schedule of updates, continues to build on and significantly improve its role as a unique environment that radically simplifies and accelerates application development cycles.</para> - </section> + --> + + <para>Red Hat Developer Studio, also has a steady schedule of updates, continues to build on and significantly improve its role as a unique environment that radically simplifies and accelerates application development cycles.</para> + </chapter> Deleted: trunk/jsf/docs/userguide/en/modules/visual_page.xml =================================================================== --- trunk/jsf/docs/userguide/en/modules/visual_page.xml 2007-11-20 16:08:24 UTC (rev 4985) +++ trunk/jsf/docs/userguide/en/modules/visual_page.xml 2007-11-20 16:26:02 UTC (rev 4986) @@ -1,290 +0,0 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="visual_page" xreflabel="visual_page"> - <?dbhtml filename="visual_page.html"?> - <chapterinfo> - <keywordset> - <keyword>Red Hat Developer Studio</keyword> - <keyword>RHDS</keyword> - <keyword>Visual Page Editor</keyword> - </keywordset> - </chapterinfo> -<title>Visual Page Editor</title> -<para>Red Hat Developer Studio comes with a powerful and customizable <property>Visual Page Editor</property> (VPE). You can use the Visual Page Editor to develop an application using any technology: JSF, Struts, JSP, HTML and others.</para> -<section id="VisualPageEditor174"> -<?dbhtml filename="VisualPageEditor.html"?> -<title>Visual Page Editor</title> - -<para>Now VPE has four tabs: Visual/Source, Visual, Source and Preview.</para> -<para>Split screen design with instant synchronization between source and visual views:</para> - -<figure> -<title>Visual/Source View</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_1.png" /> - </imageobject> -</mediaobject> -</figure> - -<para>You can also switch to pure Visual design:</para> -<figure> -<title>Visual View</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_2.png" /> - </imageobject> -</mediaobject> -</figure> - -<para>Or work just in Source view. Note that selection bar is now available not only in Visual mode but also in Source one:</para> -<figure> -<title>Source View</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_3.png" /> - </imageobject> -</mediaobject> -</figure> -<para>No matter what view you select, you get full integration with Properties and Outline views:</para> -<figure> -<title>Properties And Outline Views</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_4.png" /> - </imageobject> -</mediaobject> -</figure> -<para>Preview mode is read-only, it only shows how the page will look like in a browser.</para> -<figure> -<title>Preview Mode</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_5.png" /> - </imageobject> -</mediaobject> -</figure> -<para>Use the graphical toolbar to add inline styling to any tag.</para> -<figure> -<title>Graphical Toolbar</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_6.png" /> - </imageobject> -</mediaobject> -</figure> -<para>With just a click or drag-and-drop insert any tags from the palette on to the page you are editing.</para> -<figure> -<title>Inserting Tags From Palette</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_7.png" /> - </imageobject> -</mediaobject> -</figure> - -<section id="AdvancedSettings954"> -<?dbhtml filename="AdvancedSettings.html"?> -<title>Advanced Settings</title> - - <para>There are three buttons on the <property>Visual Page Editor</property> left side:</para> - - <figure> - <title>Visual Page Editor Buttons</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_8.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>Preferences</para></listitem> - </itemizedlist> - <para>Provides quick access to Visual Page Editor preferences.</para> - <figure> - <title>Visual Page Editor Preferences Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_9.png" /> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem><para>Refresh</para></listitem> - </itemizedlist> - <para>Refresh displaying information with this button.</para> - - <itemizedlist> - <listitem><para>Page Design Options</para></listitem> - </itemizedlist> -<para>This button leads to page design options.</para> - <figure> - <title>Page Design Options</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_10.png" /> - </imageobject> - </mediaobject> - </figure> -<para>This dialog let&apos;s you set resources which are usually only resolved in runtime. To set a stylesheet, - click <emphasis><property>Add</property></emphasis> (for CSS File Path section) and add your stylesheet. It works when CSS is defined on your page in the following way:</para> - -<para>Code:</para> - <programlisting role="XML"><![CDATA[<link rel="stylesheet" type="text/css" href="#{facesContext.externalContext.requestContextPath}/style.css"/> -]]></programlisting> - -<para>This will work fine in runtime, but the Visual Page Editor doesn&apos;t know what requestContextPath in design time is.</para> - -<para>The next section (URI), let&apos;s you add URI taglibs if you are using includes so that the editor knows - where to find the tag libraries.</para> - -<para>The first two sections let you define actual runtime folders. Here is an example.</para> - -<para>Let&apos;s say you have the following project structure:</para> - -<programlisting role="XML"><![CDATA[WebContent/ - pages/ - img/ - a.gif - header.jsp - main.jsp -]]></programlisting> -<para>header.jsp content:</para> -<programlisting role="XML"><![CDATA[My Header -<img src="img/a.gif"/> -]]></programlisting> -<para>main.jsp:</para> -<programlisting role="XML"><![CDATA[<jsp:include page="pages/header.jsp" /> -]]></programlisting> -<para> - When you open <emphasis><property>main.jsp</property></emphasis> in Visual Page Editor, it will not be able to resolve the image from the header, - however, it will work fine in runtime. To fix this in design time, click the <emphasis><property>Page Design Options</property></emphasis> button and - set <emphasis><property>Actual Run-Time Relative</property></emphasis> Folder to <emphasis><property>&lt;project&gt;WebContent > pages</property></emphasis> and you will see the image appear.</para> -<para></para> - <itemizedlist> - <listitem><para>Hide Selection bar</para></listitem> - </itemizedlist> -<para> By clicking on the component in Visual view or selecting a code snippet in Source mode you can see the tags tree. If you want to hide the selection bar, use the &quot;Hide Selection Bar&quot; button on the lower right side.</para> - - <figure> - <title>Selection Bar</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/visual_page/visual_page_11.png"/> - </imageobject> - </mediaobject> - </figure> - -</section> -</section> - -<section id="SetupnotesforLinu895x"> -<?dbhtml filename="SetupNotesforLinux.html"?> -<title>Setup notes for Linux</title> -<section id="HowToStartTheVisualPageEditorUnderLinux85"> -<?dbhtml filename="HowToStartTheVisualPageEditorUnderLinux.html"?> -<title>How to Start the Visual Page Editor under Linux</title> - -<para>Linux users may need to do the following to get the Visual Editor to work correctly on their machines.</para> - <itemizedlist> -<listitem><para>On Fedora or Red Hat Enterprise Linux distributions, install the compat-libstdc++-33.i386 and libXp packages:</para></listitem> -</itemizedlist> -<programlisting role="JAVA"><![CDATA[yum install compat-libstdc++-33 libXp -]]></programlisting> - -<itemizedlist> -<listitem><para>On other rpm-based distributions download libXp.i386 package from <ulink url="http://rpm.pbone.net/index.php3/stat/4/idpl/3418392/com/libXp-1... -</para></listitem> -<listitem><para>And install it on your machine:</para></listitem> -</itemizedlist> -<programlisting role="JAVA"><![CDATA[rpm -U libXp-1.0.0-8.i386 -]]></programlisting> - -<itemizedlist> -<listitem><para>Open the RHDS perspective. If you see the Help view open, close it and restart RHDS -</para></listitem> -</itemizedlist> -</section> - - <!-- <section id="JustInCase06"> -<?dbhtml filename="JustInCase.html"?> -<title>Just in Case</title> - -<para>If you still experience problems, tell us about your system. Please do the following:</para> -<itemizedlist> - <listitem><para>Clear the Eclipse log file, <emphasis>&lt;workspace&gt;\.metadata\.log</emphasis></para></listitem> - -<listitem><para>Start Eclipse with the -debug option:</para></listitem></itemizedlist> -<programlisting role="JAVA"><![CDATA[eclipse -debug -]]></programlisting> -<itemizedlist> - <listitem><para>Send the Eclipse log file (<emphasis>&lt;workspace&gt;\.metadata\.log</emphasis>) to <ulink url="mailto:support@exadel.com">support@exadel.com</ulink></para></listitem> -</itemizedlist> - </section> - --> -</section> - -<section id="JSPsyntaxvalidation84"> -<?dbhtml filename="JSPsyntaxValidation.html"?> -<title>JSP syntax validation</title> -<para>When working in JBoss Tools JSP editor you are constantly provided with feedback and -contextual error checking as you type.</para> -</section> - - <!-- <section id="CreateLookAndFeel(Design-timeMetadate)ForAnyCustomJSFComponents41"> -<?dbhtml filename="CreateLookAndFeel(Design-timeMetadate)ForAnyCustomJSFComponents.html"?> -<title>JSP Visual Page Editor - Design Time Look and Feel for Custom Components</title> - -<itemizedlist> -<listitem><ulink url="http://www.jboss.org/404.html">Template definition for design-time representation of custom tags</ulink> (pdf) -<para></para> - <note> - <title>Note:</title> - <para>The templates files are now saved in <emphasis>&lt;RedHatDeveloperStudio&gt;\eclipse\plugins\com.exadel.vpe_1.1.1\plugin.xml</emphasis>. The PDF files show the old location.</para> - </note> -<para></para></listitem> - -<listitem><ulink url="http://www.jboss.org/404.html">Steps to Create Plug-in</ulink> (pdf)</listitem> -<listitem><ulink url="index.html">How to use create(..) method</ulink> (pdf)</listitem> -<listitem>API -<itemizedlist> -<listitem><ulink url="http://www.jboss.org/404.html">VpeAbstractTemplate</... -<listitem><ulink url="http://www.jboss.org/404.html">VpeTemplate</ulink>... -<listitem><ulink url="http://www.jboss.org/404.html">Download</ulink> examples. The examples.zip file contains two - applications. The first application transforms the JSP source tag into visual tag (HTML). This application - is an Eclipse plug-in. Import as an Eclipse project. The second application is a Web applications which - uses the custom component (project with JSF Nature).</listitem> -</itemizedlist> -<para>Please send us an email to <ulink url="mailto:support@exadel.com">support@exadel.com</ulink> if you have - questions about this feature.</para> -</section> ---> - -<section id="HTML401Suppor421t"> -<?dbhtml filename="HTML4.01Support.html"?> -<title>HTML 4.01 Support</title> -</section> - -<section id="JSP2.0JSTL1.0And1.1Suppor52t"> -<?dbhtml filename="JSP2.0JSTL1.0And1.1Support.html"?> -<title>JSP 2.0, JSTL 1.0/1.1 support</title> -</section> - -<section id="PageEditorWithPreview53"> -<?dbhtml filename="PageEditorWithPreview.html"?> -<title>JSP Page Preview</title> - -<para>Red Hat Developer Studio comes with JSP design-time preview features. When designing JSP pages you - can easily preview how they will look during runtime. You can even attach your stylesheet to the preview.</para> - -<para>JSP preview is available for:</para> - -<itemizedlist> -<listitem><para>Struts Pages</para></listitem> -<listitem><para>JSF Pages</para></listitem> -</itemizedlist> - -<para>The preview features are available with <link linkend="VisualPageEditor">Visual Page Editor</link>.</para> -</section> - -</chapter> \ No newline at end of file