forrest-site-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r546751 [2/2] - in /forrest/site: ./ docs_0_90/ pluginDocs/plugins_0_70/ pluginDocs/plugins_0_80/ pluginDocs/plugins_0_90/ skin/images/ tools/ tools/images/
Date Wed, 13 Jun 2007 06:34:46 GMT
Modified: forrest/site/tools/forrestbar.html
URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbar.html?view=diff&rev=546751&r1=546750&r2=546751
==============================================================================
--- forrest/site/tools/forrestbar.html (original)
+++ forrest/site/tools/forrestbar.html Tue Jun 12 23:34:44 2007
@@ -159,22 +159,62 @@
 <div id="minitoc-area">
 <ul class="minitoc">
 <li>
-<a href="#What%27s+the+ForrestBar%3F">What's the ForrestBar?</a>
+<a href="#What+is+the+ForrestBar%3F">What is the ForrestBar?</a>
 </li>
 <li>
 <a href="#Installing+the+ForrestBar">Installing the ForrestBar</a>
 </li>
+<li>
+<a href="#Using+the+ForrestBar">Using the ForrestBar</a>
+<ul class="minitoc">
+<li>
+<a href="#Forrest+menu">Forrest menu</a>
+</li>
+<li>
+<a href="#Apache+menu">Apache menu</a>
+</li>
+<li>
+<a href="#References+menu">References menu</a>
+</li>
+<li>
+<a href="#Devs.+menu">Devs. menu</a>
+</li>
+<li>
+<a href="#Dispatcher-dev+menu">Dispatcher-dev menu</a>
+<ul class="minitoc">
+<li>
+<a href="#Internal+formats+section">Internal formats section</a>
+</li>
+<li>
+<a href="#Structurer+section">Structurer section</a>
+</li>
+<li>
+<a href="#Contracts+section">Contracts section</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Search+menu">Search menu</a>
+</li>
+<li>
+<a href="#Contracts-dev+menu">Contracts-dev menu</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Configuring+the+ForrestBar">Configuring the ForrestBar</a>
+</li>
 </ul>
 </div>
     
-<a name="N1000D"></a><a name="What%27s+the+ForrestBar%3F"></a>
-<h2 class="underlined_10">What's the ForrestBar?</h2>
+<a name="N1000D"></a><a name="What+is+the+ForrestBar%3F"></a>
+<h2 class="underlined_10">What is the ForrestBar?</h2>
 <div class="section">
 <p>
         The ForrestBar is a toolbar extension made for the
         <a href="http://www.mozilla.org/products/mozilla1.x/">Mozilla</a>
         and <a href="http://www.mozilla.org/products/firefox/">Firefox</a>
-        browsers that eases the navigation of online Forrest resources
+        browsers that eases the navigation of online Apache Forrest resources
         (including local instances of Forrest running on jetty or as a webapp),
         Apache links and other Apache projects.
       </p>
@@ -188,7 +228,7 @@
 <h2 class="underlined_10">Installing the ForrestBar</h2>
 <div class="section">
 <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>
@@ -202,11 +242,223 @@
         the downloaded .xpi file into your browser's window and drop it.
       </p>
 <p>
-        To build ForrestBar locally rather than downloading, go to
+        To build (and perhaps enhance) ForrestBar locally rather than downloading, go to
         FORREST_HOME/tools/forrestbar and run the following command:
         <span class="codefrag">forrest -f build.xml</span> 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>
+</div>
+    
+<a name="N1003C"></a><a name="Using+the+ForrestBar"></a>
+<h2 class="underlined_10">Using the ForrestBar</h2>
+<div class="section">
+<p>
+        ForrestBar has the following features.
+      </p>
+<a name="N10045"></a><a name="Forrest+menu"></a>
+<h3 class="underlined_5">Forrest menu</h3>
+<p>
+          This menu gives you direct access to various information about the
+          Forrest project such as :
+        </p>
+<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>
+          The last choice <em>Local Forrest</em> is a direct access to the
+          dynamic forrest site when you use <span class="codefrag">'forrest run'</span>
mode.
+        </p>
+<a name="N10067"></a><a name="Apache+menu"></a>
+<h3 class="underlined_5">Apache menu</h3>
+<p>
+          This menu gives you direct access to several information about the
+          Apache Software Foundation.
+        </p>
+<a name="N10071"></a><a name="References+menu"></a>
+<h3 class="underlined_5">References menu</h3>
+<p>
+          This menu gives you direct access to several documentation of
+          components used in the Forrest project such as :
+        </p>
+<ul>
+          
+<li>The Apache Ant documentation</li>
+          
+<li>The Apache Cocoon documentation</li>
+          
+<li>The Subversion Book</li>
+        
+</ul>
+<a name="N10087"></a><a name="Devs.+menu"></a>
+<h3 class="underlined_5">Devs. menu</h3>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+          This menu needs the <em>Local Forrest</em> site to be launched, i.e.
+          <span class="codefrag">'forrest run'</span> mode.
+        </div>
+</div>
+<p>
+          This menu provides various general resources for developers.
+        </p>
+<ul>
+          
+<li>Access to "abs-menulinks" which is the internal representation
+            of the "site.xml" navigation configuration. See
+            <a href="../docs_0_90/linking.html#menu_generation">explanation</a>.
+            Like the <a href="../docs_0_90/faq.html#linkmap">Linkmap</a>, it
assists
+            with development and <a href="../howto-dev.html#debug">debugging</a>.
+          </li>
+          
+<li>Access to the Cocoon Profiler which shows summary information about sitemap processing.
+            See configuration <a href="../howto-dev.html#debug-cocoon-profiler">notes</a>.
+          </li>
+        
+</ul>
+<div class="fixme">
+<div class="label">Fixme (open)</div>
+<div class="content">
+          Need to re-enable access to localhost:8888/foo/bar.xml and localhost:8888/foo/bar.fo
internal formats.
+        </div>
+</div>
+<a name="N100B7"></a><a name="Dispatcher-dev+menu"></a>
+<h3 class="underlined_5">Dispatcher-dev menu</h3>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+          This menu needs the <em>Local Forrest</em> site to be launched, i.e.
+          <span class="codefrag">'forrest run'</span> mode.
+          The site needs to be enabled to use the Dispatcher.
+        </div>
+</div>
+<a name="N100C6"></a><a name="Internal+formats+section"></a>
+<h4>Internal formats section</h4>
+<p>
+            These options give you direct access to dispatcher internal xml
+            formats of the current page such as :
+          </p>
+<ul>
+            
+<li>The Intermediate format</li>
+            
+<li>The Body</li>
+            
+<li>The Table of Content</li>
+            
+<li>...</li>
+          
+</ul>
+<p>
+            These accesses are very interesting in development phase to display
+            - in xml format - the content of any dispatcher page.
+          </p>
+<a name="N100E2"></a><a name="Structurer+section"></a>
+<h4>Structurer section</h4>
+<p>
+            This option gives you direct access to the structurer which is in
+            charge to generate the current page.
+          </p>
+<a name="N100EC"></a><a name="Contracts+section"></a>
+<h4>Contracts section</h4>
+<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>
+<a name="N10100"></a><a name="Search+menu"></a>
+<h3 class="underlined_5">Search menu</h3>
+<p>
+          This menu lets you search in different Forrest related archives or
+          sites such as :
+        </p>
+<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>
+          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>
+<div class="note">
+<div class="label">Jira Issues</div>
+<div class="content">
+          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.
+        </div>
+</div>
+<div class="note">
+<div class="label">Subversion revisions</div>
+<div class="content">
+          Subversion revision gives you a direct access to the revision you
+          entered in the search field (let's say 521779).
+        </div>
+</div>
+<a name="N10124"></a><a name="Contracts-dev+menu"></a>
+<h3 class="underlined_5">Contracts-dev menu</h3>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+          This menu needs the <em>Local Forrest</em> site to be launched, i.e.
+          <span class="codefrag">'forrest run'</span> mode.
+          The site needs to be enabled to use the Dispatcher.
+        </div>
+</div>
+<p>
+          This menu gives you direct access to Dispatcher 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 syntactically correct.
+        </p>
+</div>
+    
+<a name="N10141"></a><a name="Configuring+the+ForrestBar"></a>
+<h2 class="underlined_10">Configuring the ForrestBar</h2>
+<div class="section">
+<p>
+        ForrestBar can be configured in order to change the <em>localhost</em>
+        and <em>port</em> used to connect to Forrest dynamic site, i.e. if you
+        have changed <span class="codefrag">'forrest run'</span> mode to use
a
+        <a href="../docs_0_90/faq.html#run_port">different port</a>.
+      </p>
+<p>
+        The defaults are <span class="codefrag">localhost:8888</span> and can
be changed through
+        the Options window :
+      </p>
+<p>
+        
+<img alt="ForrestBar Options window" src="images/forrest-bar-options.png">
+      </p>
+<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>
 </div>
   

Modified: forrest/site/tools/forrestbar.pdf
URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbar.pdf?view=diff&rev=546751&r1=546750&r2=546751
==============================================================================
Binary files - no diff available.

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

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



Mime
View raw message