Author: ochikvina
Date: 2008-04-08 10:49:46 -0400 (Tue, 08 Apr 2008)
New Revision: 7419
Added:
trunk/struts/docs/struts_tools_ref_guide/en/modules/code_generation.xml
trunk/struts/docs/struts_tools_ref_guide/en/modules/config_file_debugger.xml
trunk/struts/docs/struts_tools_ref_guide/en/modules/editors.xml
trunk/struts/docs/struts_tools_ref_guide/en/modules/modules.xml
trunk/struts/docs/struts_tools_ref_guide/en/modules/page_links_recognizer.xml
trunk/struts/docs/struts_tools_ref_guide/en/modules/project_verification.xml
trunk/struts/docs/struts_tools_ref_guide/en/modules/projects.xml
trunk/struts/docs/struts_tools_ref_guide/en/modules/rel_resources_links.xml
Log:
http://jira.jboss.com/jira/browse/JBDS-261 - reorganizing tthe guide structure; organizing
new chapters
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/code_generation.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/code_generation.xml
(rev 0)
+++ trunk/struts/docs/struts_tools_ref_guide/en/modules/code_generation.xml 2008-04-08
14:49:46 UTC (rev 7419)
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="code_generation">
+ <?dbhtml filename="code_generation.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Code Generation</title>
+
+ <para>JBoss Tools comes with a <property>code
generation</property>
+ feature. You can generate stub code for Struts Actions, FormBeans, Forwards
+ and Exceptions.</para>
+
+ <para>The code generation that JBoss tooling provides is based on Velocity
templates
+ which can be modified for your use. The templates are located at
<emphasis>
+ <property> {JBossStudioHome} > templates >
+ codegeneration</property>. </emphasis></para>
+
+ <para>There are a number of ways to invoke code generation. One is simply
+ right-clicking the Struts diagram and selecting <emphasis>
+ <property>Generate Java Code....</property>
+ </emphasis></para>
+
+ <figure>
+ <title>Selecting Generate Java Code</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_45.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On this screen you can select for which elements to generate code. If
you
+ select Next you will be able to specify more options for each of the
+ categories you selected.</para>
+
+ <figure>
+ <title>Generate - Step 1</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_46.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>please be careful not to override your existing files.</para>
+ </tip>
+
+ <para>When generation is complete, a result window will appear letting you know
how
+ many classes were generated:</para>
+
+ <figure>
+ <title>Generation Finished</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_47.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You don't always have to generate code for all elements at once.
You
+ can invoke generation for just an individual Struts artifact as well.
+ Right-click an element on the diagram of the Struts configuration file and
+ select <emphasis>
+ <property>Generate Java Code...</property>
+ </emphasis> from the context menu.</para>
+
+ <figure>
+ <title>Generation For Individual Struts Artifact</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_48.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The same can be done from within the Tree viewer for the editor of the
Struts
+ configuration file.</para>
+
+ <figure>
+ <title>Generation in Struts Config Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_49.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
\ No newline at end of file
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/config_file_debugger.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/config_file_debugger.xml
(rev 0)
+++
trunk/struts/docs/struts_tools_ref_guide/en/modules/config_file_debugger.xml 2008-04-08
14:49:46 UTC (rev 7419)
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="config_file_debugger">
+ <?dbhtml filename="config_file_debugger.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Struts Configuration File Debugger</title>
+
+ <para>JBoss Tools come with <property>Struts configuration file
+ debugger</property>. It allows you to set break points on Struts diagram
and
+ then simply launch the server in debug mode.</para>
+
+ <para>Simply right click an Action or a page and select Add <emphasis>
+ <property>Breakpoint</property>. </emphasis></para>
+ <figure>
+ <title>Adding Breakpoint</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_50.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
\ No newline at end of file
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/editors.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/editors.xml
(rev 0)
+++ trunk/struts/docs/struts_tools_ref_guide/en/modules/editors.xml 2008-04-08 14:49:46
UTC (rev 7419)
@@ -0,0 +1,428 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="editors">
+ <?dbhtml filename="editors.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Editors</title>
+
+ <section id="struts_config_editor">
+
+ <title>Graphical Editor for Struts Configuration Files</title>
+
+ <para>The Struts configuration file editor has three modes with different
representation of <emphasis>
+ <property>struts-config.xml</property>:
</emphasis>Diagram, Tree and Source. The
+ modes can be selected via the tabs at the bottom of the editor. Any changes
made in one
+ mode are immediately visible when you switch to any other mode.</para>
+
+ <para>When working in Source view, you always have all the following
features available:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Content Assist</para>
+ </listitem>
+ <listitem>
+ <para>Open On Selection</para>
+ </listitem>
+ <listitem>
+ <para>File Folding</para>
+ </listitem>
+ </itemizedlist>
+ <section id="StrutsDiagramMode453">
+
+ <title>Diagram Mode</title>
+
+ <para>The Diagram mode graphically displays the Web flow of the
application defined in
+ the Struts configuration file.</para>
+
+ <figure>
+ <title>Diagram Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_14.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Diagram mode allows to edit navigation in your Struts
application. Just by
+ right-clicking anywhere on the diagram, you can use a context menu to
create the
+ building blocks of a Struts application:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Actions</para>
+ </listitem>
+ <listitem>
+ <para>Global forwards</para>
+ </listitem>
+ <listitem>
+ <para>Global exceptions</para>
+ </listitem>
+ <listitem>
+ <para>JSP Pages</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Diagram Context Menu</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_15.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Along the upper-left side of the editor is a stack of seven icons
for changing the
+ behavior of the cursor in the diagram. </para>
+
+ <figure>
+ <title>Editor Icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_16.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The first icon switches to the default regular selection cursor,
the second to the
+ marquee selection cursor and the third to the new connection cursor. The
last four
+ icons switch the cursor to an insert cursor for each type of Struts build
block
+ listed above (and in the order listed).</para>
+
+ <para>For instance, clicking on the first of these four icons (the one
with the gears)
+ will switch the cursor to insert actions. Clicking anywhere in the
diagram with this
+ cursor has the same effect as right-click and selecting <emphasis>
+ <property>Add > Action...</property>
+ </emphasis> from the context menu with the regular cursor active.
It's just
+ more efficient to use this cursor if you're adding more than one
action at
+ once.</para>
+
+
+ </section>
+ <section id="StrutsTreeMode42">
+
+ <title>Tree Mode</title>
+
+ <para>The Tree mode represents the different elements of the Struts
application that are
+ organized into functional categories on the left-hand side and a form for
editing
+ the properties of currently selected items on the right-hand
side.</para>
+
+ <figure>
+ <title>Tree Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_17.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also right-click on any node in the category tree and
perform appropriate
+ operations through a context menu. For instance, by right-clicking on
the
+ action-mappings category node, you can add new actions to the
application.</para>
+
+ <figure>
+ <title>Tree Context Menu</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_18.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsSourceMode9655">
+
+ <title>Source Mode</title>
+
+ <para>In the Source mode, you have complete editing control of the
underlying XML
+ coding.</para>
+
+ <figure>
+ <title>Source Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_19.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can take advantage of <link
+
linkend="CodeAssistAndDynamicCodeAssist42BasedOnProjectData">code
assist</link>.</para>
+
+ <figure>
+ <title>Code Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_20.png"
scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The editor will also immediately flag any errors.</para>
+
+ <figure>
+ <title>Errors in Source Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_21.png"
scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Finally, you can use the Outline view with the editor to easily
navigate through
+ the file.</para>
+
+ <figure>
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_22.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <para>Find more information about editor features <link
linkend="editors_features"
+ >here</link>.</para>
+
+ </section>
+
+ <section id="GraphicalEditorForTilesFiles132">
+
+ <title>Graphical Editor for Tiles Files</title>
+
+ <para>The Tiles configuration file editor has three main modes: Tree,
Diagram and Source.
+ The modes can be selected via the tabs at the bottom of the editor. Any
changes made in
+ one mode are immediately visible when you switch to any other
mode.</para>
+
+ <para>When working in Source view, you always have all following features
available:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Content Assist</para>
+ </listitem>
+ <listitem>
+ <para>Open On Selection</para>
+ </listitem>
+ </itemizedlist>
+ <section id="CreateNewTilesFile1422">
+
+ <title>Create New Tiles File</title>
+
+ <para>To create new Tiles files, right click any folder and select
<emphasis>
+ <property>New > Tiles File</property>.
</emphasis></para>
+ <figure>
+ <title>Creating a New Tiles File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_23.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsTreeView896">
+
+ <title>Tree Mode</title>
+
+ <para>The Tree mode represents the different elements of the Tiles file
that are
+ organized into functional categories on the left-hand side and a form for
editing
+ the properties of currently selected items on the right-hand
side.</para>
+ <figure>
+ <title>Tree Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_24.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To edit the file, simply right click any node and select among
the available
+ actions.</para>
+ <figure>
+ <title>Editing in Tiles Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_25.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsDiagramView4643">
+
+ <title>Diagram Mode</title>
+
+ <para>The Diagram mode allows you to create complex Tiles files in the
form of a
+ diagram.</para>
+ <figure>
+ <title>Diagram Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_26.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To create new definitions, simply right click anywhere in the
diagram.</para>
+ <figure>
+ <title>Creating New Definition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_27.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also use the Diagram toolbar to make editing
easier.</para>
+ <figure>
+ <title>Diagram Toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_28.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> It contains four icons for changing the cursor state. The first
one is the
+ default cursor state for selecting existing nodes. The second icon is
marquee
+ selector. The third is used for creating new connections and the last one
is for
+ adding definition template to the content.</para>
+ </section>
+ <section id="StrutsSource75">
+
+ <title>Source</title>
+
+ <para>The other mode of the <property>Tiles
editor</property> is the Source mode that
+ gives you full control over the source. Any changes here will immediately
appear in
+ other modes when you switch to them.</para>
+ <figure>
+ <title>Source Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/struts/struts_29.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><link
linkend="CodeAssistAndDynamicCodeAssist42BasedOnProjectData">Code
+ assist</link> is available in the Source mode.</para>
+ <figure>
+ <title>Code Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_30.png"
scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Any errors are immediately reported as shown below:</para>
+ <figure>
+ <title>Errors Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_31.png"
scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also use the Outline view together with the
editor's Source mode.
+ It provides an easier navigation through the file.</para>
+ <figure>
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_32.png"
scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+ <section id="GraphicalEditorForStrutsValidationFiles86">
+
+ <title>Graphical Editor for Struts Validation Files</title>
+
+ <para>Providing full support for development Struts applications JBoss
Tools comes with a
+ visual validation editor. To create a new validation file, right click any
folder in
+ Project Explorer and select <emphasis>
+ <property>File > New > Other...</property>
+ </emphasis>from the context menu and then <emphasis>
+ <property>JBoss Tools Web > Struts > Validation
File</property>. </emphasis></para>
+ <figure>
+ <title>Creating New Validation File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_33.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The validation editor works with five modes: Formsets, Validators,
Constants and
+ standard Tree and Source that you can easily switch over using tabs at the
bottom of the
+ editor.</para>
+ <para>The Formsets mode shows forms and their elements on the left side and
the dialogue for
+ defining their validation rules on the right side.</para>
+ <figure>
+ <title>Formsets Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_34.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Constants mode let you set constant values for your validation
rules.</para>
+ <figure>
+ <title>Constansts Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_35.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The validation file can also be viewed in a Tree mode.</para>
+ <figure>
+ <title>Tree Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_36.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>At any point you have full control over the source by switching to
the Source mode.
+ Any editing in this mode will immediately be available in other modes of the
editor.</para>
+ <figure>
+ <title>Source Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_37.png"
scale="85"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also open your own custom or Struts-standard
<emphasis>
+ <property>validation-rules.xml</property>
+ </emphasis> file.</para>
+ <para>The Validators mode shows the validation rules for a selected
validator. You can of
+ course add your own rules.</para>
+ <figure>
+ <title>Validators Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_38.png"
scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Here are the validation rules shown in the Source mode.</para>
+ <figure>
+ <title>Validation Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_39.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/modules.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/modules.xml
(rev 0)
+++ trunk/struts/docs/struts_tools_ref_guide/en/modules/modules.xml 2008-04-08 14:49:46
UTC (rev 7419)
@@ -0,0 +1,99 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="modules">
+ <?dbhtml filename="modules.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Modules</title>
+
+ <para>JBoss Tools support working with Struts projects that have
+ multiple modules. You can easily do the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Add new modules</para>
+ </listitem>
+ <listitem>
+ <para>Edit modules for an existing project or during Struts project
+ import</para>
+ </listitem>
+ </itemizedlist>
+ <para>Now, let's discuss this functionality in more
detail.</para>
+ <section id="WhenImportingAStrutsProject432">
+
+ <title>When Importing a Struts Project</title>
+
+ <para>During Struts project import, if the project has multiple modules,
you
+ will see a screen with all existing modules. You can select each
+ module and edit its details.</para>
+
+ <figure>
+ <title>Configuring Project Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_40.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="EditingModulesInAnExistingProject1">
+
+ <title>Editing Modules in an Existing Project</title>
+ <para>To edit modules in an existing project, right click the project and
+ select <emphasis>
+ <property>JBoss Tools > Modules Configuration</property>.
+ </emphasis></para>
+ <figure>
+ <title>Choosing Modules Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_41.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You will see the same screen as above where you will be able to
select
+ a module and edit its details.</para>
+ <figure>
+ <title>Modules Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_42.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="AddingNewModules1">
+
+ <title>Adding New Modules</title>
+
+ <para>Adding a new module is very simple. First switch to Web Project
view.
+ Expand your project to the Configuration folder. Under that folder
+ you should see the current modules. Right click on Configuration and
+ select <emphasis>
+ <property>New > Struts Config</property>.
</emphasis></para>
+ <figure>
+ <title>Adding New Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_43.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You will see the screen below. You can specify a new module name and
+ also add the new Struts configuration file to web.xml file.</para>
+ <figure>
+ <title>Adding New Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_44.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/page_links_recognizer.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/page_links_recognizer.xml
(rev 0)
+++
trunk/struts/docs/struts_tools_ref_guide/en/modules/page_links_recognizer.xml 2008-04-08
14:49:46 UTC (rev 7419)
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="page_links_recognizer">
+ <?dbhtml filename="page_links_recognizer.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Customizable Page Links Recognizer</title>
+
+ <para><property>Custom page links</property> allow you to define
custom Struts page
+ links that will be recognizable in the Struts application diagram. You can
+ define these links by selecting <emphasis>
+ <property>Window > Preferences</property>
+ </emphasis> from the menu bar and then selecting <emphasis>
+ <property>JBoss Tools > Web > Struts >
Customization</property>
+ </emphasis> from the Preferences dialog box.</para>
+ <figure>
+ <title>Customization Panel</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_51.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
\ No newline at end of file
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/project_verification.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/project_verification.xml
(rev 0)
+++
trunk/struts/docs/struts_tools_ref_guide/en/modules/project_verification.xml 2008-04-08
14:49:46 UTC (rev 7419)
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="project_verification">
+ <?dbhtml filename="project_verification.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Struts Project Verification</title>
+
+ <para>JBoss Tools provide the same functionality for Struts
+ projects. To configure Struts project verification select <emphasis>
+ <property>Window > Preferences</property>
+ </emphasis> from the menu bar, select <emphasis>
+ <property>JBoss Tools > Web > Verification</property>
+ </emphasis> from the Preferences dialog box and then expand the
+ Struts Rules node.</para>
+ <figure>
+ <title>Struts Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/verif_valid/verif_valid_8.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Suppose you are working in the Source viewer for a Struts
+ configuration file as shown below:</para>
+ <figure>
+ <title>Struts Configuration File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/verif_valid/verif_valid_9.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>While typing a class name or entering it from the graphical editor,
+ you might make a minor typo (like <emphasis role="italic">
+ <property>"sample.GreetingAction1"</property>
+ </emphasis> instead of <emphasis role="italic">
+ <property>"sample.GreetingAction"</property>
+ </emphasis>). After saving the file,
+ <property>verification</property> checks to make sure everything is
+ correct and finds the error below:</para>
+ <figure>
+ <title>Error Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/verif_valid/verif_valid_10.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Notice that the Package Explorer View shows a marked folder and a
+ marked file where the error is.</para>
+ <para>You can place the cursor over the line with the error to view a
+ detailed error message:</para>
+ <figure>
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/verif_valid/verif_valid_11.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The verification also checks to make sure you have specified the
+ correct JSP page for the forward:</para>
+ <figure>
+ <title>JSP Page Verification</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/verif_valid/verif_valid_12.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once you place the cursor over the line, you can see the error
+ message:</para>
+ <figure>
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/verif_valid/verif_valid_13.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You can always invoke the verification by switching to the Diagram
+ viewer, right-clicking and selecting <emphasis>
+ <property>Verify</property>
+ </emphasis> from the context menu:</para>
+ <figure>
+ <title>Verify Command</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/verif_valid/verif_valid_14.png"
+ />
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
\ No newline at end of file
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/projects.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/projects.xml
(rev 0)
+++ trunk/struts/docs/struts_tools_ref_guide/en/modules/projects.xml 2008-04-08 14:49:46
UTC (rev 7419)
@@ -0,0 +1,270 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="projects">
+ <?dbhtml filename="projects.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Projects</title>
+
+ <para>JBoss Tools provides the following functionality when working with
Struts:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Create new <property>Struts
projects</property></para>
+ </listitem>
+ <listitem>
+ <para>Import (open) existing Struts projects. You can import any
project
+ structure</para>
+ </listitem>
+ <listitem>
+ <para>Add <property>Struts capabilities</property> to any
existing Eclipse
+ project</para>
+ </listitem>
+ <listitem>
+ <para>Import and add Struts capabilities to any existing project
created outside
+ Eclipse.</para>
+ </listitem>
+ </itemizedlist>
+ <para>Now, we'll focus on all these points more fully.</para>
+
+ <section id="CreatingANewStrutsProjec745t">
+
+ <title>Creating a New Struts Project</title>
+
+
+ <para>JBoss Tools provides a New Struts Project Wizard that radically
simplifies the process
+ for getting started with a new Struts project. You just need to follow these
steps:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Select<emphasis>
+ <property>File > New > Project...</property>
+ </emphasis> from the menu bar. Then, select <emphasis>
+ <property>JBoss Tools Web > Struts > Struts
Project</property>
+ </emphasis> in this dialog box. Click <emphasis>
+ <property>Next</property>:
</emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Selecting Struts Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>On this form, provide the <property>Project
Name</property>. You can also
+ select where to create the project or use the default
path.</para>
+ <para>Next to <property>Struts Environment</property>
set which Struts version to
+ use.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>Creating Struts Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Don't put spaces in project names since some OS could
experience problems
+ with their processing and searching these files.</para>
+ </tip>
+
+ <para>You can select the KickStart template, then the project created will
include a simple
+ Hello World type application that is ready to run.</para>
+
+ <figure>
+ <title>Choosing Struts Template </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_3_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Next, you register this application with the current servlet
container defined
+ for your workspace (JBoss AS, by default) in order to allow you to
test your
+ application more easily while still developing it. A new entry will
be added in
+ the servlet container configuration file to enable running the
application
+ in-place (called null deployment or link deployment). Uncheck the
<emphasis
+ role="italic">
+ <property>"Target
Server"</property>
+ </emphasis> check box if for some reason you don't
want to register
+ your application at this point.</para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Registering The Project at Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>On the next form, you can select the TLD files to include in
this
+ project:</para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Selecting Tag Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After the project is created, you should have the following project
structure (if you
+ used the KickStart template):</para>
+
+ <figure>
+ <title>Project Structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>If you want to hide the jar files from Web App Libraries in view,
select the
+ down-pointing arrow in the upper right corner, select
+ <emphasis>Filters...</emphasis>, check the box next to Name
filter patterns
+ (matching names will be hidden), and type *.jar into the field. Then,
click OK.
+ </para>
+ </tip>
+ </section>
+ <section id="ImportingAnExistingStrutsProjectWithAnyStructure9653">
+
+ <title>Importing an Existing Struts Project with Any
Structure</title>
+
+ <para>For detailed information on migration projects to JBoss Developer
Studio see <ulink
+
url="../../../Exadel-migration/en/html_single/index.html">Migration
Guide</ulink>.</para>
+
+ </section>
+ <section id="AddingStrutsCapabilityToAnExistingWebApplication532">
+
+ <title>Adding Struts Capability to an Existing Web
Application</title>
+
+ <para>Here, we'll consider how to add Struts functionality (Struts
libraries, tag
+ libraries and a Struts configuration file) to any existing Web application
project in
+ your Eclipse workspace.</para>
+
+ <para>By adding a Struts Nature to your project, you can now edit files
using JBoss Tools
+ editors, such as the <link
linkend="struts_config_editor">Struts configuration
+ editor</link> and the JBoss Tools JSP editor. To take advantage of this
just right-click
+ the project and select <emphasis>
+ <property>JBoss Tools > Add Struts
Capabilities</property>
+ </emphasis> from the context menu. This will start the process of
adding all necessary
+ libraries and files to make a Web Struts project from your one.</para>
+
+ <figure>
+ <title>Adding Struts Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the wizard you should point to location of your deployment
descriptor file web.xml
+ and name of the project.</para>
+
+ <figure>
+ <title>Choosing Project Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>After hitting <emphasis>
+ <property>Next</property>, </emphasis> you will see the
following screen. This
+ screen simply means that you need to add at least one Struts module to your
project to
+ make this project a Struts project. Adding a Struts module means that a new
+ struts-config.xml will be added to your project and registered in the web.xml
file. In
+ addition, all required Struts libraries will be added. To add a Struts
module, select
+ the <emphasis>
+ <property>Add Struts Support</property>
+ </emphasis> button.</para>
+ <figure>
+ <title>Project Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here you can select what Struts
<property>Version</property>, <property>Servlet
+ Class</property>, <property>URL Pattern</property> and
<property>TLD</property>s to add
+ to this project.</para>
+
+ <figure>
+ <title>Selecting Struts Support Options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When done, you will see the default Struts module configuration
information. See how
+ to Edit <link
linkend="SupportForMultipleStrutsModules75">Struts
modules</link>.</para>
+
+ <figure>
+ <title>Project Configuration Information</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_11.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the last screen you can set the different folders for your project
as well as
+ register this application with a servlet container. If you want the libraries
(.jar
+ files) will be automatically added to your project, click on the checkbox
<emphasis>
+ <property>Add
Libraries</property>.</emphasis></para>
+
+ <figure>
+ <title>Registering the Project at Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_12.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When done, you can open end edit the struts-config.xml file using
usefull Struts
+ configuration file editor provided by JBDS. (The Struts configuration is
shown below in
+ the Tree viewer).</para>
+
+ <figure>
+ <title>Struts-config.xml File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_13.png"
scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+</chapter>
Added: trunk/struts/docs/struts_tools_ref_guide/en/modules/rel_resources_links.xml
===================================================================
--- trunk/struts/docs/struts_tools_ref_guide/en/modules/rel_resources_links.xml
(rev 0)
+++ trunk/struts/docs/struts_tools_ref_guide/en/modules/rel_resources_links.xml 2008-04-08
14:49:46 UTC (rev 7419)
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="rel_resources_links">
+ <?dbhtml filename="rel_resources_links.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Relevant Resources Links</title>
+
+ <para>Find out necessary information on <ulink
url="http://struts.apache.org/">Struts
+ technology</ulink> if you don't know
enough.</para>
+
+</chapter>