forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cdupoiri...@apache.org
Subject svn commit: r546406 - in /forrest/trunk/site-author/content/xdocs/tools: forrestbar.xml images/ images/forrest-bar-options.png
Date Tue, 12 Jun 2007 07:32:18 GMT
Author: cdupoirieux
Date: Tue Jun 12 00:32:17 2007
New Revision: 546406

URL: http://svn.apache.org/viewvc?view=rev&rev=546406
Log:
Add documentation for the forrest bar (FOR-962)

Added:
    forrest/trunk/site-author/content/xdocs/tools/images/
    forrest/trunk/site-author/content/xdocs/tools/images/forrest-bar-options.png   (with props)
Modified:
    forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml

Modified: forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml?view=diff&rev=546406&r1=546405&r2=546406
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml Tue Jun 12 00:32:17 2007
@@ -39,7 +39,7 @@
     <section>
       <title>Installing the ForrestBar</title>
       <p>
-        ForrestBar is currently compatible with Firefox 0.9 - 1.5+ and Mozilla
+        ForrestBar is currently compatible with Firefox 0.9 - 2.0+ and Mozilla
         1.x browsers.
       </p>
       <p>
@@ -58,6 +58,156 @@
         <code>forrest -f build.xml</code> and the .xpi file will be built for
         you in the FORREST_HOME/tools/forrestbar/build directory. You can then
         install it by dragging and dropping as indicated above.
+      </p>
+    </section>
+    <section>
+      <title>Using the ForrestBar</title>
+      <p>
+        ForrestBar has the following features.
+      </p>
+      <section>
+        <title>Forrest menu</title>
+        <p>
+          This menu gives you direct access to several information about the
+          Forrest project such as :
+          <ul>
+            <li>The Forrest Site</li>
+            <li>The project Subversion repository</li>
+            <li>The project Issues manager</li>
+            <li>The mailing lists...</li>
+          </ul>
+        </p>
+        <p>
+          The last choice <em>Local Forrest</em> is a direct access to the
+          dynamic forrest site when you use <code>forrest run</code> command.
+        </p>
+      </section>
+      <section>
+        <title>Apache menu</title>
+        <p>
+          This menu gives you direct access to several information about the
+          Apache project
+        </p>
+      </section>
+      <section>
+        <title>References menu</title>
+        <p>
+          This menu gives you direct access to several documentation of
+          components used in the Forrest project such as :
+          <ul>
+            <li>The Ant documentation</li>
+            <li>The Cocoon documentation...</li>
+          </ul>
+        </p>
+      </section>
+      <section>
+        <title>Devs. menu</title>
+        <fixme author="CD">
+          I don't know how to explain this menu...
+        </fixme>
+      </section>
+      <section>
+        <title>Dispatcher-dev menu</title>
+        <warning>
+          This menu needs the <em>Local Forrest</em> (jetty) site to be launched
+        </warning>
+        <section>
+          <title>Internal formats section</title>
+          <p>
+            These options give you direct access to dispatcher internal xml
+            formats of the current page such as :
+            <ul>
+              <li>The Intermediate format</li>
+              <li>The Body</li>
+              <li>The Table of Content</li>
+              <li>...</li>
+            </ul>
+          </p>
+          <p>
+            These accesses are very interesting in development phase to display
+            - in xml format - the content of any dispatcher page.
+          </p>
+        </section>
+        <section>
+          <title>Structurer section</title>
+          <p>
+            This option gives you direct access to the structurer which is in
+            charge to generate the current page.
+          </p>
+        </section>
+        <section>
+          <title>Contracts section</title>
+          <p>
+            These options give you direct access to an automatically generated
+            page which displays the documentation of the available contracts
+            that you can use.
+          </p>
+          <p>
+            The <em>ls.contracts</em> option displays the list of standard
+            contracts available whereas the <em>ls.contracts.project</em> only
+            displays the list of contracts specific to the project.
+          </p>
+        </section>
+      </section>
+      <section>
+        <title>Search menu</title>
+        <p>
+          This menu lets you search in different Forrest related archives or
+          sites such as :
+          <ul>
+            <li>The mail (User or Devs) archives lists</li>
+            <li>The commits in subversion repository</li>
+            <li>The Forrest site</li>
+            <li>The Jira Issues - site which manages Forrest issues</li>
+          </ul>
+        </p>
+        <p>
+          To perfom a search in one of these sites, just enter a keyword in the
+          Search field and select the site you want to search in in the Search
+          menu.
+        </p>
+        <note label="Jira Issues">
+          If you enter the number of a Forrest issue you are working on (let's
+          say FOR-962) the search in the JIRA Issues site will dirrectly access to
+          the Issue properties page.
+        </note>
+        <note label="Subversion revisions">
+          Subversion revision gives you a direct access to the revision you
+          entered in the search field (let's say 521779).
+        </note>
+      </section>
+      <section>
+        <title>Contracts-dev menu</title>
+        <warning>
+          This menu needs the <em>Local Forrest</em> (jetty) site to be launched
+        </warning>
+        <p>
+          This menu gives you direct access to contracts. You can access to html
+          or fo contract by entering the contract name in the search field and
+          selecting the corresponding <em>prepare</em> or <em>resolve</em>
+          option.
+        </p>
+        <p>
+          These accesses are very useful to check that the contract you are
+          working on is found by the dispatcher and is syntaxically correct.
+        </p>
+      </section>
+    </section>
+    <section>
+      <title>Configuring the ForrestBar</title>
+      <p>
+        ForrestBar can be configure in order to change the <em>localhost</em>
+        and <em>port</em> used to connect to Forrest dynamic site (jetty).
+      </p>
+      <p>
+        The defaults are <code>localhost:8888</code> and can be changed through
+        the Options window :
+      </p>
+      <img src="images/forrest-bar-options.png" alt="ForrestBar Options window"/>
+      <p>
+        Once you have entered the correct values for your installation, the
+        ForrestBar saves them in your browser user preferences so that they will
+        be used again next time you will start your browser.
       </p>
     </section>
   </body>

Added: forrest/trunk/site-author/content/xdocs/tools/images/forrest-bar-options.png
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/images/forrest-bar-options.png?view=auto&rev=546406
==============================================================================
Binary file - no diff available.

Propchange: forrest/trunk/site-author/content/xdocs/tools/images/forrest-bar-options.png
------------------------------------------------------------------------------
    svn:mime-type = image/png



Mime
View raw message