Google Git
Sign in
apache / forrest / forrest_08_release_site / . / tools / eclipse.html
blob: 115b460137901c14697b78d4626f436a63601f5a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.8-dev">
<meta name="Forrest-skin-name" content="pelt">
<title>
Apache Forrest: Eclipse Plugin
</title>
<link type="text/css" href="../skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
<link type="text/css" href="../skin/profile.css" rel="stylesheet">
<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
<link rel="shortcut icon" href="../favicon.ico">
</head>
<body onload="init()">
<script type="text/javascript">ndeSetTextSize();</script>
<div id="top">
<!--+
|breadtrail
+-->
<div class="breadtrail">
<a href="http://www.apache.org/">apache</a> &gt; <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
</div>
<!--+
|header
+-->
<div class="header">
<!--+
|start group logo
+-->
<div class="grouplogo">
<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
</div>
<!--+
|end group logo
+-->
<!--+
|start Project Logo
+-->
<div class="projectlogo">
<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
</div>
<!--+
|end Project Logo
+-->
<!--+
|start Search
+-->
<div class="searchbox">
<form action="http://www.google.com/search" method="get" class="roundtopsmall">
<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp;
<input name="Search" value="Search" type="submit">
</form>
</div>
<!--+
|end search
+-->
<!--+
|start Tabs
+-->
<ul id="tabs">
<li>
<a class="unselected" href="../index.html">Welcome</a>
</li>
<li>
<a class="unselected" href="../contrib.html">Developers</a>
</li>
<li>
<a class="unselected" href="../versions/index.html">Versioned Docs</a>
</li>
<li>
<a class="unselected" href="../pluginDocs/index.html">Plugins</a>
</li>
<li class="current">
<a class="selected" href="../tools/index.html">Tools</a>
</li>
</ul>
<!--+
|end Tabs
+-->
</div>
</div>
<div id="main">
<div id="publishedStrip">
<!--+
|start Subtabs
+-->
<div id="level2tabs"></div>
<!--+
|end Endtabs
+-->
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<!--+
|breadtrail
+-->
<div class="breadtrail">
&nbsp;
</div>
<!--+
|start Menu, mainarea
+-->
<!--+
|start Menu
+-->
<div id="menu">
<div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Tools</div>
<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
<a href="../tools/index.html">Index</a>
</div>
<div class="menuitem">
<a href="../tools/forrestbar.html">ForrestBar</a>
</div>
<div class="menuitem">
<a href="../tools/forrestbot.html">Forrestbot</a>
</div>
<div class="menuitem">
<a href="../tools/forrestbot-web-interface.html">Forrestbot Webapp</a>
</div>
<div class="menupage">
<div class="menupagetitle">Eclipse Plugin</div>
</div>
<div class="menuitem">
<a href="../tools/xxe.html">XXE-Editor</a>
</div>
</div>
<div id="credit"></div>
<div id="roundbottom">
<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
<!--+
|alternative credits
+-->
<div id="credit2">
<a href="http://apachecon.com/2007/EU/"><img border="0" title="ApacheCon Europe 2007" alt="ApacheCon Europe 2007 - logo" src="http://apache.org/ads/ApacheCon/2007-europe-125x125.png" style="width: 125px;height: 125px;"></a><a href="http://people.apache.org/calendar.html#200711"><img border="0" title="ApacheCon US 2007" alt="ApacheCon US 2007 - logo" src="http://apache.org/ads/ApacheCon/2007-usa-125x125.png" style="width: 125px;height: 125px;"></a>
</div>
</div>
<!--+
|end Menu
+-->
<!--+
|start content
+-->
<div id="content">
<div title="Portable Document Format" class="pdflink">
<a class="dida" href="eclipse.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
PDF</a>
</div>
<div class="trail">Font size:
&nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
&nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
&nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
</div>
<h1>
Apache Forrest: Eclipse Plugin
</h1>
<div id="minitoc-area">
<ul class="minitoc">
<li>
<a href="#overview">
Eclipse Plugin
</a>
</li>
<li>
<a href="#install">
Installation notes
</a>
</li>
<li>
<a href="#Wizards">Wizards</a>
<ul class="minitoc">
<li>
<a href="#newProject">Creating a new Forrest Project</a>
</li>
<li>
<a href="#newXDoc">Creating a new XDoc</a>
</li>
</ul>
</li>
<li>
<a href="#editors">Editors</a>
<ul class="minitoc">
<li>
<a href="#siteXMLEditor">
site.xml Editor
</a>
</li>
<li>
<a href="#tabsXMLEditor">
tabs.xml Editor
</a>
</li>
<li>
<a href="#LocationmapEditor">
Locationmap.xml Editor
</a>
</li>
<li>
<a href="#ForrestViews">
Activate Forrest:Views for a project
</a>
</li>
<li>
<a href="#RepositoryBrowser">
Browse a remote Repostory
</a>
<ul class="minitoc">
<li>
<a href="#Daisy+Repository">Daisy Repository</a>
</li>
</ul>
</li>
</ul>
</li>
<li>
<a href="#ModifyandBuild">
Modify and Build Forrest Sites
</a>
<ul class="minitoc">
<li>
<a href="#ModifySettings">
Modify Settings
</a>
</li>
<li>
<a href="#BuildSettings">
Build Site Options
</a>
</li>
</ul>
</li>
</ul>
</div>
<a name="N1000D"></a><a name="overview"></a>
<h2 class="underlined_10">
Eclipse Plugin
</h2>
<div class="section">
<div class="warning">
<div class="label">Warning</div>
<div class="content">
The Forrest plugin for Eclipse is new and under development.
</div>
</div>
</div>
<a name="N10017"></a><a name="install"></a>
<h2 class="underlined_10">
Installation notes
</h2>
<div class="section">
<p>
To get you started while the documentation is being developed, see this
forrest-dev mail thread:
<a href="http://marc.theaimsgroup.com/?t=112059632000001"> [eclipse] How
to install? </a> .
</p>
</div>
<a name="N10025"></a><a name="Wizards"></a>
<h2 class="underlined_10">Wizards</h2>
<div class="section">
<p>
A number of wizards are provided for performing common tasks. This
section briefly describes the available wizards.
</p>
<a name="N1002E"></a><a name="newProject"></a>
<h3 class="underlined_5">Creating a new Forrest Project</h3>
<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 -&gt; Seed New Project.
</p>
<p>
<strong>Project Name and Location</strong>
</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). When you are done, click on Next
</p>
<p>
<strong>Site options</strong>
</p>
<p>
Here you will see the Site Options page. This is where you can specify
certain options for your new site. Currently the available options
are:
</p>
<ul>
<li>Group Name</li>
<li>Project Name</li>
<li>Vendor</li>
<li>Copyright link</li>
<li>Disable PDF link</li>
<li>Disable POD link</li>
<li>Disable Print link</li>
<li>Disable Text link</li>
<li>Disable XML link</li>
</ul>
<p>
There is also an option to save these sselections as your default
settings. If this is done, the next time you create a project it will
have the same seelections that you have specified here. When you are
finished with this page, click on Next
</p>
<p>
<strong>Activate Plugins</strong>
</p>
<p>
This page allows you to select the plugins that you would like your
project to use. The list of available plugins is on the left and list
of plugins that you have chosen for your project is on the right. Once
you have selected those plugins click on Finish to create your new
Site Project.
</p>
<a name="N10074"></a><a name="newXDoc"></a>
<h3 class="underlined_5">Creating a new XDoc</h3>
<p>
To create a new XDoc within yout Forrest project select "New -&gt;
Other..." and then select "New XDoc" from the Forrest node.
</p>
</div>
<a name="N1007F"></a><a name="editors"></a>
<h2 class="underlined_10">Editors</h2>
<div class="section">
<p>
A number of editors are provided for Forrest configuration files. This
section describes those editors.
</p>
<a name="N10088"></a><a name="siteXMLEditor"></a>
<h3 class="underlined_5">
site.xml Editor
</h3>
<p>
First, you need to activate the Site.xml view. This can be done by:
<span class="codefrag"> Window -&gt; Show View -&gt; Other... -&gt; Forrest -&gt; SiteXML -&gt; OK
</span> 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>
<div class="warning">
<div class="label">Warning</div>
<div class="content">
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.
</div>
</div>
<div class="fixme">
<div class="label">Fixme (Anil Ramnanan)</div>
<div class="content">
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
</div>
</div>
<a name="N100AB"></a><a name="tabsXMLEditor"></a>
<h3 class="underlined_5">
tabs.xml Editor
</h3>
<p>
First, you need to activate the Tab.xml view. This can be done by:
<span class="codefrag"> Window -&gt; Show View -&gt; Other... -&gt; Forrest -&gt; TabXML -&gt; OK
</span> 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 tabs.xml as a tree in the view.
</p>
<p>
To add a new element to the tabs.xml file right click on an element in
the tabs.xml tree and select "Add Element". A wizard will come up
which will allow you to enter the Id, Dir, Label and Index File for
the new tab element that is being added.
</p>
<p>
To delete an element, right click on the element in the tree and click
on Delete Element
</p>
<div class="warning">
<div class="label">Warning</div>
<div class="content">
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.
</div>
</div>
<div class="fixme">
<div class="label">Fixme (Anil Ramnanan)</div>
<div class="content">
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
</div>
</div>
<a name="N100C5"></a><a name="LocationmapEditor"></a>
<h3 class="underlined_5">
Locationmap.xml Editor
</h3>
<p>
First, you need to activate the Locationmap view. This can be done by:
</p>
<p>
Window -&gt; Show View -&gt; Other... -&gt; Forrest -&gt; Locationmap -&gt; OK
</p>
<p>
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 Locationmap.xml as a tree in the view.
</p>
<p>
To add a match, you must rich click on the locater element and click
on "Add Match". A wizard will come up asking you to enter the Pattern
or the Match.
</p>
<p>
Right click on the match you just created and click on "Add Location".
This will allow you to enter the Location Source.
</p>
<p>
To delete an element, right click on the element in the tree and click
on Delete Element
</p>
<p>
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".
</p>
<div class="fixme">
<div class="label">Fixme (Anil Ramnanan)</div>
<div class="content">
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
</div>
</div>
<a name="N100E5"></a><a name="ForrestViews"></a>
<h3 class="underlined_5">
Activate Forrest:Views for a project
</h3>
<p>
To activate views when seeding a new project:
</p>
<p>
File -&gt; New -&gt; Project -&gt; Forrest -&gt; Seed New Project -&gt; Next
</p>
<p>
Type in the name of the project and click on Next. To Activate views
for the new project, check off "Activate Views" and click on Finish.
When "Activate Views" is selected, the new project has
project.skin=leather-dev uncommented and the relevant plugins for
views are added to project.required.plugins
</p>
<p>
To add a new View doc (*.fv), click on New -&gt; Other -&gt; Forrest -&gt; View
Doc. Enter the file name of the view document and click on Finish.
</p>
<a name="N100F8"></a><a name="RepositoryBrowser"></a>
<h3 class="underlined_5">
Browse a remote Repostory
</h3>
<p>
The Repository Browser allows you to browse a a remote repository and
include the documents in a Forrest Project. To show the Repository
Browser view go to Window -&gt; Show View - &gt;Other. Expand the Forrest
Tree and select Repository Browser.
</p>
<div class="note">
<div class="label">Note</div>
<div class="content">
Currently the repository Browser only has support for the Daisy
repository but support for other repoisotries can be easily added. If
you have specific need pleae join us on the dev list where we will be
happy to assist.
</div>
</div>
<a name="N10104"></a><a name="Daisy+Repository"></a>
<h4>Daisy Repository</h4>
<p>
For the Repository Browser to work with the
<a href="http://www.cocoondev.org/daisy">Daisy repository</a>, the
settings for the daisy repository must be configured.
</p>
<p>
Go to Windows -&gt; Preferences. Chose Daisy. Here you will see a
number of options to set for the daisy repository.
</p>
<ul>
<li>Repository Location - this is the http location of the repoistory browser. This can be a domain name or an IP address e.g. localhost or 127.0.0.1</li>
<li>Repository Port - This is the port that the repository runs on e.g. 9623</li>
<li>Repository Username - This is the username that is set for the repository</li>
<li>Repository Password - This is the password that is used to authenticate the user for the repository</li>
</ul>
<p>
To include a document from a Repository in a Forrest Project, click on
the document in the Document list of the repository browser and drag
it to locator section in the Locationmap View.
</p>
</div>
<a name="N10129"></a><a name="ModifyandBuild"></a>
<h2 class="underlined_10">
Modify and Build Forrest Sites
</h2>
<div class="section">
<p>
Once a Forrest Project has been created the user can access the context
menus to modify and build the site.
</p>
<a name="N10132"></a><a name="ModifySettings"></a>
<h3 class="underlined_5">
Modify Settings
</h3>
<p>
In order to modify the settings of a project, right click on the
project in the Package Explorer. At the bottom of the menu you will
find two meny items.
</p>
<ul>
<li>Modify Plugins Selection - This will let you add and remove Forrest plugins from your project</li>
<li>Modify Configurations - This allows you to modify the Site Option settings that were selected when the project was created.</li>
</ul>
<a name="N10145"></a><a name="BuildSettings"></a>
<h3 class="underlined_5">
Build Site Options
</h3>
<p>
In order to build a project, right click on the project in the Package
Explorer. At the bottom of the menu you will find the Site menu item.
This menu item has a number of sub items.
</p>
<ul>
<li>Start Test Server - This will start the project as a local webapp and open a browser window that will allow you to preview it.</li>
<li>Stop Test Server - This will stop the local webapp.</li>
<li>Build WAR File - This will build the site as a webapp in a war file located in the build folder of your project.</li>
<li>Build Site - This will build a static site from your project in the Build folder of your project.</li>
</ul>
</div>
</div>
<!--+
|end content
+-->
<div class="clearboth">&nbsp;</div>
</div>
<div id="footer">
<!--+
|start bottomstrip
+-->
<div class="lastmodified">
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<div class="copyright">
Copyright &copy;
2002-2007 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
<!--+
|end bottomstrip
+-->
</div>
</body>
</html>