forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgard...@apache.org
Subject svn commit: r225533 - /forrest/trunk/site-author/content/xdocs/tools/eclipse.xml
Date Wed, 27 Jul 2005 14:58:18 GMT
Author: rgardler
Date: Wed Jul 27 07:58:11 2005
New Revision: 225533

URL: http://svn.apache.org/viewcvs?rev=225533&view=rev
Log:
add documentation for the wizards

Modified:
    forrest/trunk/site-author/content/xdocs/tools/eclipse.xml

Modified: forrest/trunk/site-author/content/xdocs/tools/eclipse.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/tools/eclipse.xml?rev=225533&r1=225532&r2=225533&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/eclipse.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/eclipse.xml Wed Jul 27 07:58:11 2005
@@ -44,40 +44,69 @@
           .
         </p>
       </section>
-<section id="siteXMLEditor">
-        <title>
-          site.xml Editor
-        </title>
-        <p>
-          First, you need to activate the Site.xml view. This can be done by:
-          <code>
-            Window -> Show View -> Other... -> Forrest -> SiteXML -> OK
-          </code>
-          Now you will see the the view open up in Eclipse. To view a tree, click on the
project you are working and you should see the structure of the site.xml as a tree in the
view.
-        </p>
-        <p>
-          There are two ways to add the note to the site.xml file.
-        </p>
-          <ol>
-            <li>
-              Drag a document from the Package Explorer to the tree. This will create a new
element called NewElement which will allow with references to that new object
-            </li>
-            <li>
-              Right click on an element in the site.xml tree and select "Add Element". A
wizard will come up which will allow you to enter the HREF, Description, Label and Element
name for the new element that is being added.
-            </li>
-          </ol>
-        <p>
-          To delete an element, right click on the element in the tree and click on "Delete
Element".
-        </p>
-        <warning>
-          For the changes to show up when you run a test site for your project, you must
save the changes. Right click on the tree and select
-		  "Save". In a later version of the plugin this step will not be necessary.
-        </warning>
-        <fixme author="Anil Ramnanan">
-          Currently there is no easy way to edit an existing element. The element will be
linked to the Properties View in Eclipse to allow for easy editing
-        </fixme>
+
+      <section>
+        <title>Wizards</title>
+        <p>A number of wizards are provided for perfomring common tasks. This section
briefly describes
+        the available wizards.</p>
+        
+        <section id="newProject">
+          <title>Creating a new Forrest Project</title>
+          <p>To create a new Forrest project select "New Project" from either the context
menu in the package explorer or the
+          "New" menu and select Forrest -> Seed New Project.</p>
+          
+          <p>A wizard will ask you for the name of the project and the location in
which the project files are to be created
+          (by default the files will be in your current workspace). If you click "Finish"
at this point a basic project will
+          be created. However, if you click "Next" you will be given the opportunity to select
which plugins you wish to 
+          include in the project.</p>
+        </section>
+        
+        <section id="newXDoc">
+          <title>Creating a new XDoc</title>
+          <p>To create a new XDoc within yout Forrest project select "New -> Other..."
and then select
+          "New XDoc" from the Forrest node.</p>
+        </section>
       </section>
-<section id="tabsXMLEditor">
+      
+      <section id="editors">
+        <title>Editors</title>
+        <p>A number of editors are provided for Forrest configuration files. This section
describes those editors.</p>
+        
+        <section id="siteXMLEditor">
+          <title>
+            site.xml Editor
+          </title>
+          <p>
+            First, you need to activate the Site.xml view. This can be done by:
+            <code>
+              Window -> Show View -> Other... -> Forrest -> SiteXML -> OK
+            </code>
+            Now you will see the the view open up in Eclipse. To view a tree, click on the
project you are working and you should see the structure of the site.xml as a tree in the
view.
+          </p>
+          <p>
+            There are two ways to add the note to the site.xml file.
+          </p>
+            <ol>
+              <li>
+                Drag a file from the Package Explorer to the tree. This will create a new
element 
+                with references to that dropped file(s).
+              </li>
+              <li>
+                Right click on an element in the site.xml tree and select "Add Element".
A wizard will come up which will allow you to enter the HREF, Description, Label and Element
name for the new element that is being added.
+              </li>
+            </ol>
+          <p>
+            To delete an element, right click on the element in the tree and click on "Delete
Element".
+          </p>
+          <warning>
+            For the changes to show up when you run a test site for your project, you must
save the changes. Right click on the tree and select
+        "Save". In a later version of the plugin this step will not be necessary.
+          </warning>
+          <fixme author="Anil Ramnanan">
+            Currently there is no easy way to edit an existing element. The element will
be linked to the Properties View in Eclipse to allow for easy editing
+          </fixme>
+        </section>
+      <section id="tabsXMLEditor">
         <title>
           tabs.xml Editor
         </title>
@@ -105,7 +134,7 @@
         </fixme>
       </section>
 	
-	<section id="LocationmapEditor">
+	    <section id="LocationmapEditor">
         <title>
           Locationmap.xml Editor
         </title>
@@ -138,7 +167,8 @@
           Currently there is no easy way to edit an element. The element will be linked to
the Properties View in Eclipse to allow for easy editing
         </fixme>
       </section>
-<section id="Forrest:Views">
+
+      <section id="Forrest:Views">
         <title>
           Activate Forrest:Views for a project
         </title>
@@ -159,5 +189,6 @@
          the view document and click on Finish.
         </p>
       </section>
+    </section>
 </body>    
 </document>



Mime
View raw message