Author: crossley
Date: Tue Jun 12 19:05:37 2007
New Revision: 546705
URL: http://svn.apache.org/viewvc?view=rev&rev=546705
Log:
Explain the "Devs." menu: "Cocoon Profiler" and "abs-menulinks".
Other minor text tweaks.
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=546705&r1=546704&r2=546705
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml Tue Jun 12
19:05:37 2007
@@ -22,12 +22,12 @@
</header>
<body>
<section>
- <title>What's the ForrestBar?</title>
+ <title>What is the ForrestBar?</title>
<p>
The ForrestBar is a toolbar extension made for the
<link href="http://www.mozilla.org/products/mozilla1.x/";>Mozilla</link>
and <link
href="http://www.mozilla.org/products/firefox/";>Firefox</link>
- 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>
@@ -53,7 +53,7 @@
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:
<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
@@ -68,7 +68,7 @@
<section>
<title>Forrest menu</title>
<p>
- This menu gives you direct access to several information about the
+ This menu gives you direct access to various information about the
Forrest project such as :
</p>
<ul>
@@ -79,14 +79,14 @@
</ul>
<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.
+ dynamic forrest site when you use <code>'forrest run'</code> mode.
</p>
</section>
<section>
<title>Apache menu</title>
<p>
This menu gives you direct access to several information about the
- Apache project
+ Apache Software Foundation.
</p>
</section>
<section>
@@ -96,20 +96,41 @@
components used in the Forrest project such as :
</p>
<ul>
- <li>The Ant documentation</li>
- <li>The Cocoon documentation...</li>
+ <li>The Apache Ant documentation</li>
+ <li>The Apache Cocoon documentation</li>
+ <li>The Subversion Book</li>
</ul>
</section>
<section>
<title>Devs. menu</title>
- <fixme author="CD">
- I don't know how to explain this menu...
+ <warning>
+ This menu needs the <em>Local Forrest</em> site to be launched, i.e.
+ <code>'forrest run'</code> mode.
+ </warning>
+ <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
+ <link href="site:linking/menu_generation">explanation</link>.
+ Like the <link href="site:faq/linkmap">Linkmap</link>, it assists
+ with development and <link
href="site:procedures/forrest-dev/debug">debugging</link>.
+ </li>
+ <li>Access to the Cocoon Profiler which shows summary information
about sitemap processing.
+ See configuration <link
href="site:debug-cocoon-profiler">notes</link>.
+ </li>
+ </ul>
+ <fixme author="open">
+ Need to re-enable access to localhost:8888/foo/bar.xml and
localhost:8888/foo/bar.fo internal formats.
</fixme>
</section>
<section>
<title>Dispatcher-dev menu</title>
<warning>
- This menu needs the <em>Local Forrest</em> (jetty) site to be
launched
+ This menu needs the <em>Local Forrest</em> site to be launched, i.e.
+ <code>'forrest run'</code> mode.
+ The site needs to be enabled to use the Dispatcher.
</warning>
<section>
<title>Internal formats section</title>
@@ -179,25 +200,29 @@
<section>
<title>Contracts-dev menu</title>
<warning>
- This menu needs the <em>Local Forrest</em> (jetty) site to be
launched
+ This menu needs the <em>Local Forrest</em> site to be launched, i.e.
+ <code>'forrest run'</code> mode.
+ The site needs to be enabled to use the Dispatcher.
</warning>
<p>
- This menu gives you direct access to contracts. You can access to
html
+ 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 syntaxically correct.
+ working on is found by the dispatcher and is syntactically 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).
+ 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 <code>'forrest run'</code> mode to use a
+ <link href="site:faq/run_port">different port</link>.
</p>
<p>
The defaults are <code>localhost:8888</code> and can be changed through
