You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by th...@apache.org on 2006/07/25 11:07:46 UTC
svn commit: r425340 [2/10] - in
/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo:
./ docs/ docs/developer/ docs/developer/useCases/ docs/user/
docs/user/useCases/ images/ projectDetails/ projectDetails/category/ skin/
s...
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/changes_current.rss
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/changes_current.rss?rev=425340&r1=425339&r2=425340&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/changes_current.rss (original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/changes_current.rss Tue Jul 25 02:07:44 2006
@@ -1,6 +1,118 @@
<?xml version="1.0" encoding="ISO-8859-1"?><!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN" "http://my.netscape.com/publish/formats/rss-0.91.dtd">
-<rss version="0.91"><channel><title>Plugin: Project Info input (0.2-dev) Changes</title><link>changes.html</link><description>Plugin: Project Info input (0.2-dev) Changes</description><language>en-us</language>
+<rss version="0.91"><channel><title>Plugin: projectInfo input (0.2-dev) Changes</title><link>changes.html</link><description>Plugin: projectInfo input (0.2-dev) Changes</description><language>en-us</language>
+ See also the main
+ changes
+ related to all plugins.
+
+
+
+ <item><title>code add</title><link>changes.html</link><description>code add
+ by
+ TS
+ :
+ Add support
+ for svn log files. This let you extract changes based on a svn log
+ file. Further this provides some handy ways to find out the first and
+ last commit of a month and the generation of svn cli commands. </description></item>
+ <item><title>code add</title><link>changes.html</link><description>code add
+ by
+ DC
+ :
+
+ Enable optional release/introduction elements.
+ </description></item>
+ <item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Allow an aggregation of all
+ use cases in a project.
+ </description></item>
+ <item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Start off a use
+ case document for the changelog features of the plugin.
+ </description></item>
+ <item><title>code add</title><link>changes.html</link><description>code add
+ by
+ DC
+ :
+
+ Add section to output "Introduction and explanation of symbols".
+ Show the unique symbols.
+ </description></item>
+ <item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ List all contributors for each release by showing a list of committers
+ and a list of other contributors.
+ </description></item>
+ <item><title>code fix</title><link>changes.html</link><description>code fix
+ by
+ TS
+ :
+ Fixing small issue with the
+ last ',' which should not be displayed on the last entry of the
+ contributors list. </description></item>
+ <item><title>code fix
+ (bug FOR-839)
+ </title><link>changes.html</link><description>code fix
+ by
+ RDG
+ (fixes bug FOR-839)
+
+ :
+
+ Using a unique key including the release version.
+ </description></item>
+ <item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ Make the list of contributors for each release be a compact list.
+ </description></item>
+ <item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ Changed rendered text for @dev attribute from "(@dev)" to the more
+ explicit "Committed by @dev.".
+ </description></item>
+ <item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ Changed rendered text for @fix-for from "Fixes" to the more general
+ "See Issue".
+ </description></item>
+ <item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Add support for Use Case documentation. This can be used to generate various different
+ types of user an developer documentation, such as step by step user instructions, or
+ developer implementation notes. See
+ http://localhost:8888/docs/developer/useCases.html for more information.
+ </description></item>
+ <item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Use locationmap for resolution of resources and files. Resources are exposed via
+ {lm:projectInfo.*}
+ </description></item>
<item><title>code add</title><link>changes.html</link><description>code add
by
RDG
@@ -118,6 +230,99 @@
Add projectDetails page using the DOAP.xml descriptor.
</description></item>
<item><title>code add</title><link>changes.html</link><description>code add
+ by
+ TS
+ :
+ Add support
+ for svn log files. This let you extract changes based on a svn log
+ file. Further this provides some handy ways to find out the first and
+ last commit of a month and the generation of svn cli commands. </description></item><item><title>code add</title><link>changes.html</link><description>code add
+ by
+ DC
+ :
+
+ Enable optional release/introduction elements.
+ </description></item><item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Allow an aggregation of all
+ use cases in a project.
+ </description></item><item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Start off a use
+ case document for the changelog features of the plugin.
+ </description></item><item><title>code add</title><link>changes.html</link><description>code add
+ by
+ DC
+ :
+
+ Add section to output "Introduction and explanation of symbols".
+ Show the unique symbols.
+ </description></item><item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ List all contributors for each release by showing a list of committers
+ and a list of other contributors.
+ </description></item><item><title>code fix</title><link>changes.html</link><description>code fix
+ by
+ TS
+ :
+ Fixing small issue with the
+ last ',' which should not be displayed on the last entry of the
+ contributors list. </description></item><item><title>code fix
+ (bug FOR-839)
+ </title><link>changes.html</link><description>code fix
+ by
+ RDG
+ (fixes bug FOR-839)
+
+ :
+
+ Using a unique key including the release version.
+ </description></item><item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ Make the list of contributors for each release be a compact list.
+ </description></item><item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ Changed rendered text for @dev attribute from "(@dev)" to the more
+ explicit "Committed by @dev.".
+ </description></item><item><title>code update</title><link>changes.html</link><description>code update
+ by
+ DC
+ :
+
+ Changed rendered text for @fix-for from "Fixes" to the more general
+ "See Issue".
+ </description></item><item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Add support for Use Case documentation. This can be used to generate various different
+ types of user an developer documentation, such as step by step user instructions, or
+ developer implementation notes. See
+ http://localhost:8888/docs/developer/useCases.html for more information.
+ </description></item><item><title>code add</title><link>changes.html</link><description>code add
+ by
+ RDG
+ :
+
+ Use locationmap for resolution of resources and files. Resources are exposed via
+ {lm:projectInfo.*}
+ </description></item><item><title>code add</title><link>changes.html</link><description>code add
by
RDG
:
Added: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/all.html
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/all.html?rev=425340&view=auto
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/all.html (added)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/all.html Tue Jul 25 02:07:44 2006
@@ -0,0 +1,1165 @@
+<!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">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Use Cases</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://forrest.apache.org/">Apache Forrest</a> > <a href="http://forrest.apache.org/pluginDocs/">Plugins</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://forrest.apache.org/"><img class="logoImage" alt="Apache Forrest" src="../../../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href=""><img class="logoImage" alt="Plugin: projectInfo input" src="../../../images/project.png" title="org.apache.forrest.plugin.input.projectInfo plugin for Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="http://forrest.apache.org/pluginDocs">Forrest Plugins</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../../../index.html">Home</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">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../../../skin/')" id="menu_1.1Title" class="menutitle">About</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../index.html" title="Welcome to org.apache.forrest.plugin.input.projectInfo">Index</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.2', '../../../skin/')" id="menu_1.1.2Title" class="menutitle">Release Notes</div>
+<div id="menu_1.1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../releaseNotes_0.1.html">Version 0.1</a>
+</div>
+<div class="menuitem">
+<a href="../../../releaseNotes_0.2-dev.html">Version 0.2-dev</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../changes.html" title="History of Changes">Changes</a>
+</div>
+<div class="menuitem">
+<a href="../../../todo.html" title="Todo List">Todo</a>
+</div>
+<div class="menuitem">
+<a href="http://forrest.apache.org/docs/plugins" title="Index of Forrest Plugins">Plugins Index</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../../../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
+<div onclick="SwitchMenu('menu_1.2.1', '../../../skin/')" id="menu_1.2.1Title" class="menutitle">User</div>
+<div id="menu_1.2.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/user/useCases/changeLogFeatures.html">Change Log</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/user/useCases/useCaseFeatures.html">Use Cases</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/user/useCases/all.html">All Cases</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2.2', '../../../skin/')" id="menu_selected_1.2.2Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Developer</div>
+<div id="menu_selected_1.2.2" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="../../../docs/developer/useCases/changeLogFeatures.html">Change Log</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/developer/useCases/useCaseFeatures.html">Use Cases</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">All Cases</div>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../../../skin/')" id="menu_1.3Title" class="menutitle">Projects</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.3.1', '../../../skin/')" id="menu_1.3.1Title" class="menutitle">Navigation Indexes</div>
+<div id="menu_1.3.1" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.3.1.1', '../../../skin/')" id="menu_1.3.1.1Title" class="menutitle">All</div>
+<div id="menu_1.3.1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/projectDetails.html" title="Project details for projectInfo">projectInfo</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/projectDetails.forrest.html" title="Project details for Apache Forrest">Apache Forrest</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.1.2', '../../../skin/')" id="menu_1.3.1.2Title" class="menutitle">Java</div>
+<div id="menu_1.3.1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/projectDetails.forrest.html" title="Project details for Apache Forrest">Apache Forrest</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.1.3', '../../../skin/')" id="menu_1.3.1.3Title" class="menutitle">Language Indexes</div>
+<div id="menu_1.3.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/Java_lang.html" title="All projects using Java">Java</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/XML_lang.html" title="All projects using XML">XML</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/XSLT_lang.html" title="All projects using XSLT">XSLT</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../../../skin/')" id="menu_1.3.2Title" class="menutitle">Page Indexes</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/lang-index.html" title="A list of all projects, indexed by language">Index by Language</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/Java_lang.html" title="A list of Jave projects">Java Index</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/category-index.html" title="A list of all projects, indexed by language">Index by Category</a>
+</div>
+</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"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div class="trail">Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Use Cases</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Uses+Cases+for+Change+Log+management+features+of+org.apache.forrest.plugin.input.projectInfo">Uses Cases for Change Log management features of org.apache.forrest.plugin.input.projectInfo</a>
+<ul class="minitoc">
+<li>
+<a href="#Write+status.xml+File">Write status.xml File</a>
+<ul class="minitoc">
+<li>
+<a href="#Justification">Justification</a>
+</li>
+<li>
+<a href="#Summary">Summary</a>
+</li>
+<li>
+<a href="#Details">Details</a>
+</li>
+<li>
+<a href="#Implementation+Notes">Implementation Notes</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Uses+Cases+for+the+Use+Case+management+features+of+org.apache.forrest.plugin.input.projectInfo">Uses Cases for the Use Case management features of org.apache.forrest.plugin.input.projectInfo</a>
+<ul class="minitoc">
+<li>
+<a href="#Write+Use+Case+Documentation">Write Use Case Documentation</a>
+<ul class="minitoc">
+<li>
+<a href="#Justification-N10151">Justification</a>
+</li>
+<li>
+<a href="#Summary-N10170">Summary</a>
+</li>
+<li>
+<a href="#Details-N1019E">Details</a>
+</li>
+<li>
+<a href="#Implementation+Notes-N10273">Implementation Notes</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Generate+Use+Case+Documentation+for+Developers">Generate Use Case Documentation for Developers</a>
+<ul class="minitoc">
+<li>
+<a href="#Justification-N102D6">Justification</a>
+</li>
+<li>
+<a href="#Summary-N102E3">Summary</a>
+</li>
+<li>
+<a href="#Details-N102EE">Details</a>
+</li>
+<li>
+<a href="#Implementation+Notes-N10310">Implementation Notes</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Generate+Use+Case+Documentation+for+Users">Generate Use Case Documentation for Users</a>
+<ul class="minitoc">
+<li>
+<a href="#Justification-N1034D">Justification</a>
+</li>
+<li>
+<a href="#Summary-N1035A">Summary</a>
+</li>
+<li>
+<a href="#Details-N10365">Details</a>
+</li>
+<li>
+<a href="#Implementation+Notes-N10389">Implementation Notes</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Generate+a+Functionality+Matrix">Generate a Functionality Matrix</a>
+<ul class="minitoc">
+<li>
+<a href="#Summary-N103C0">Summary</a>
+</li>
+<li>
+<a href="#Details-N103CB">Details</a>
+</li>
+<li>
+<a href="#Implementation+Notes-N103ED">Implementation Notes</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<a name="N10007"></a><a name="Uses+Cases+for+Change+Log+management+features+of+org.apache.forrest.plugin.input.projectInfo"></a>
+<h2 class="underlined_10">Uses Cases for Change Log management features of org.apache.forrest.plugin.input.projectInfo</h2>
+<div class="section">
+<a name="N1000B"></a><a name="Write+status.xml+File"></a>
+<h3 class="underlined_5">Write status.xml File</h3>
+<p>Status.xml if an XML file that records the actions that have been taken in each release
+ of a project. You can then generate a Change Log from that file using the projectInfo
+ plugin.</p>
+<a name="N10014"></a><a name="Justification"></a>
+<h4>Justification</h4>
+<p>Provide a central location and a semi-structured format for recording
+ actions taken during project development. This file can then be used to
+ generate various views on the changes in a release. For example:</p>
+<ul>
+
+<li>Changes between releases</li>
+
+<li>Developers involved in a release</li>
+
+<li>Release notes</li>
+
+</ul>
+<a name="N1002A"></a><a name="Summary"></a>
+<h4>Summary</h4>
+<ol class="steps">
+
+<li>
+<strong>Create/open a status.xml file</strong>
+</li>
+
+
+<li>
+<strong>Create a developer list</strong>
+</li>
+
+
+
+<li>
+<strong>Create a contexts list</strong>
+</li>
+
+
+<li>
+<strong>Create a changes element</strong>
+</li>
+
+
+<li>
+<strong>Create a release element</strong>
+</li>
+
+
+<li>
+<strong>Create a notes element</strong>
+</li>
+
+
+<li>
+<strong>Add actions taken during the development cycle</strong>
+</li>
+
+
+<li>
+<strong>Generate the change log</strong>
+</li>
+
+</ol>
+<a name="N10051"></a><a name="Details"></a>
+<h4>Details</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Description</th><th>Result</th><th>Status</th>
+</tr>
+
+<tr>
+<td>1. Create/open a status.xml file</td><td>
+
+<p>In your favourite XML editor either create a new file
+ or open an existing status.xml file. The default location of these files
+ within a Forrest content object is in the project root. This file should
+ conform to one of the status.xml schemas. The root element for this
+ document is <span class="codefrag">status</span>.</p>
+
+</td><td>You have either a blank status.xml document or an existing one ready for editing.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>2. Create a developer list</td><td>
+
+<p>In order to attribute changes to a specific developer it is neceessary to create
+ a <span class="codefrag">developers</span> element. Within this element you should add a single
+ <span class="codefrag">person</span> element for each develop who works on the project.</p>
+
+</td><td>Each developer is identified in the status.xml file.</td><td>Implemented</td>
+</tr>
+
+
+
+<tr>
+<td>3. Create a contexts list</td><td>
+
+<p>Each action within a release is given a context to help classify changes.
+ When reports are created the context of an action is used to create a more
+ readable report in which similar actions are grouped together. You can
+ specify any contexts you like within the <span class="codefrag">contexts</span> element.</p>
+
+<p>Common contexts used in an software development project are:</p>
+
+<pre class="code">
+<contexts>
+ <context id="code" title="Changes to the Code Base"/>
+ <context id="docs" title="Changes to Documentation"/>
+ <context id="admin" title="Changes to Project Administration"/>
+ <context id="design" title="Changes to Design"/>
+ <context id="build" title="Changes to Build"/>
+</contexts>
+ </pre>
+
+</td><td>The status.xml file describes the sufficient contexts to group common
+ actions together.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>4. Create a changes element</td><td>
+
+<p>Actions that describe the changed in a release are placed within
+ a <span class="codefrag">changes</span>.</p>
+
+</td><td>Status.xml holds an changes element that will group all release
+ information.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>5. Create a release element</td><td>
+
+<p>The details of each release are enclosed within a <span class="codefrag">release</span> element,
+ so you need to create that now.</p>
+
+</td><td>You have the container for your current development release.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>6. Create a notes element</td><td>
+
+<p>Each release can have a <span class="codefrag">notes</span> section. This is used
+ to provide descriptive text at the start of many reports. The notes
+ should describe the release in fairly high level detail, it should
+ not describe any change descriptions, these will be added in the
+ next step.</p>
+
+</td><td>You have a user focussed description of the project and this release.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>7. Add actions taken during the development cycle</td><td>
+
+<p>During the development cycle for the release <span class="codefrag">action</span> elements
+ should be added for each significant contribution to the release.</p>
+
+
+<p>If the change is of particular significance and you woul dlike it to appear
+ in the release notes generated by the projectInfo plugin you should set the
+ <span class="codefrag">importance</span> attribute to <span class="codefrag">"high"</span>.</p>
+
+</td><td>Each significant change in this development cycle is describe in a
+ <span class="codefrag">action</span> element.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>8. Generate the change log</td><td>
+
+<p>To generate a changelog from your status.xml file you need to request
+ <span class="codefrag">/changes.html</span> or <span class="codefrag">changes.pdf</span> or whatever format
+ you have enabled within Forrest using output plugins.</p>
+
+
+<p>Note that the projectInfo plugin provides a special RSS output format
+ of. Technically, this should not be part of an input plugin and therefore
+ it may be moved at a later date. However, you will always be able to
+ generate the RSS feed by requesting <span class="codefrag">changes.rss</span>.</p>
+
+
+<p>You can generate a change log for a specific version by specifying a
+ version number in the request, for example, <span class="codefrag">changes_0.1.html</span>.</p>
+
+</td><td>Your project is able to generate a changelog.</td><td>Implemented</td>
+</tr>
+
+</table>
+<a name="N10104"></a><a name="Implementation+Notes"></a>
+<h4>Implementation Notes</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Notes</th>
+</tr>
+
+<tr>
+<td>1. Create/open a status.xml file</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>2. Create a developer list</td><td>
+<br>
+</td>
+</tr>
+
+
+
+<tr>
+<td>3. Create a contexts list</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>4. Create a changes element</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>5. Create a release element</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>6. Create a notes element</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>7. Add actions taken during the development cycle</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>8. Generate the change log</td><td>
+<br>
+</td>
+</tr>
+
+</table>
+</div>
+<a name="N10140"></a><a name="Uses+Cases+for+the+Use+Case+management+features+of+org.apache.forrest.plugin.input.projectInfo"></a>
+<h2 class="underlined_10">Uses Cases for the Use Case management features of org.apache.forrest.plugin.input.projectInfo</h2>
+<div class="section">
+<a name="N10144"></a><a name="Write+Use+Case+Documentation"></a>
+<h3 class="underlined_5">Write Use Case Documentation</h3>
+<p>Write semi-structured use case documents so that they can be reused in a variety of ways.
+ This use case describews a process for writing such documents. This document is derived from
+ such a <a href="useCaseFeatures.source.xml">source document</a>.</p>
+<a name="N10151"></a><a name="Justification-N10151"></a>
+<h4>Justification</h4>
+<p>A use case describes a unit of work. It is typically used in the design
+ stages of a software project. It is very useful for describing what an applicaiton must
+ do and what patchs through the system can be taken.</p>
+<p>By bringing this information together in a semi-structured document we can use it in many
+ different ways. For example:</p>
+<ul>
+
+<li>Requirements Documentation</li>
+
+<li>Developer Documentation</li>
+
+<li>User Documentaiton</li>
+
+<li>Functionality Matrices</li>
+
+<li>Task Lists</li>
+
+</ul>
+<a name="N10170"></a><a name="Summary-N10170"></a>
+<h4>Summary</h4>
+<ol class="steps">
+
+<li>
+<strong>Create/open a Use Case file</strong>
+</li>
+
+
+<li>
+<strong>Create a new use case</strong>
+</li>
+
+
+<li>
+<strong>Describe the overall objective of the use case</strong>
+</li>
+
+
+<li>
+<strong>Define each step in the Use Case</strong>
+</li>
+
+
+<li>
+<strong>Descripbe the step</strong>
+</li>
+
+
+<li>
+<strong>Describe the expected results</strong>
+</li>
+
+
+<li>
+<strong>Add "fixme" notes</strong> (Optional)</li>
+
+
+<li>
+<strong>Add alternatives</strong> (Optional)</li>
+
+
+<li>
+<strong>Write Implementation Notes</strong> (Optional)</li>
+
+</ol>
+<a name="N1019E"></a><a name="Details-N1019E"></a>
+<h4>Details</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Description</th><th>Result</th><th>Status</th>
+</tr>
+
+<tr>
+<td>1. Create/open a Use Case file</td><td>In your favourite XML editor either create a new file
+ or open an existing use case file. The default location of these files
+ within a Forrest content object is <span class="codefrag">/content/documentation/useCases/**.xml</span>
+ </td><td>You have either a blank use case document or an existing one ready for editing.</td><td>
+ Implemented with fixmes:-<br>
+ High: 1<br>
+</td>
+</tr>
+
+
+<tr>
+<td>2. Create a new use case</td><td>
+
+<p>A use case is enclosed within a <span class="codefrag">useCase</span> element.
+ Each use case should be given a brief <span class="codefrag">title</span> to describe it.</p>
+
+
+</td><td>You have the container for your new use case.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>3. Describe the overall objective of the use case</td><td>
+
+<p>Each use case should be described in terms of:</p>
+
+<ul>
+
+<li>The objective</li>
+
+<li>The expected results</li>
+
+<li>The justification</li>
+
+</ul>
+
+<p>This information should be placed in the <span class="codefrag">description</span> element
+ of your use case. This node allows any XDoc markup and therefore you are
+ reasonably free to use whatever formatting or images are needed to convey the
+ important details most efficiently.</p>
+
+</td><td>You have a use case that is described sufficiently well for an average user of the end system
+ to understand its purpose.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>4. Define each step in the Use Case</td><td>
+
+<p>Each use case will be subdivided into one or more steps that must be carried out
+ in order to complete the task. Each of these steps is defined within a <span class="codefrag">step</span>
+ element which are chilren of a <span class="codefrag">steps</span> element.</p>
+
+</td><td></td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>5. Descripbe the step</td><td>
+
+<p>Each step has a title and a description. The description should provide enough information
+ for a user to complete the task and for a developer to implement support for the user in that
+ task.</p>
+
+
+<p>In addition each step can be described as required or optional. By default a step is assumed
+ be required. To set it to optional add a <span class="codefrag">required="false"</span> attribute to the
+ <span class="codefrag">step</span> element.</p>
+
+</td><td>A user will be able to follow instructions on how to carry out the step.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>6. Describe the expected results</td><td>
+
+<p>Provide, within a <span class="codefrag">result</span> a brief description of the expected results from
+ this step. This should summarise what state the application will be in once this use case
+ has been performed.</p>
+
+</td><td>You will have provided enough information to allow developers to test the functionality and
+ users to identify when a step has been succesfully completed.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>7. Add "fixme" notes<br>(Optional)</td><td>
+
+<p>A fixme note is enclosed within a <span class="codefrag">fixme</span> element. It describes something that
+ remains to be done within this step. Each fixme has a priority attribute which can take one of
+ of the followin values:</p>
+
+
+<ul>
+
+<li>Enhancement - a nice to have ehancment that may or may not be implemented.</li>
+
+<li>Low - this is considered an important addition to the use case, but everything works without it.</li>
+
+<li>High - this is an important addition. Everything works without it, but having this implmeneted would
+ improve the application considerably.</li>
+
+<li>Major - this is nor preventing work that utilises the use case, but it is considered a requirement
+ for the next release since it adds key functionlaity.</li>
+
+<li>Blocker - this is preventing the correct operation of this use case and must be implmeneted ASAP</li>
+
+</ul>
+
+
+<p>Although this step is optional, it is good practice to allways add a
+ <span class="codefrag"><fixme priority="blocker">Not yet implemented</fixme></span>
+ element to all new steps. This is becuase these nodes will be used to build a
+ functionality matrix later on.</p>
+
+</td><td>Users will be able to understand to what degree a step is implemented and developers will be able to
+ see what remains to be done.</td><td>
+ Implemented with fixmes:-<br>
+</td>
+</tr>
+
+
+<tr>
+<td>8. Add alternatives<br>(Optional)</td><td>
+
+<p>Sometimes there will be alternative paths through each step. These can be described in an
+ <span class="codefrag">alternatives</span> element that allows free-form XDoc content. However, please be
+ careful, if an alternative is more than a simple variation you may want to consider a
+ whole new use case for the alternative.</p>
+
+</td><td>Minor variations in the path through a use case will be documented for your users.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>9. Write Implementation Notes<br>(Optional)</td><td>
+
+<p>Developer implementation notes for each of the steps should be added either when writing the
+ initial use case or later during the development phases of the use case. These notes are for technical readers
+ and are intended to help those who come after the initial author to get a starting point when inspecting how
+ a feature is implemented. It is not intended that these notes will contain full implementation details, only an
+ overview should be provided.</p>
+
+</td><td>A technical reader will be able to gain a baisc understanding of how each step is implemented in the
+ application.</td><td>Implemented</td>
+</tr>
+
+</table>
+<a name="N10273"></a><a name="Implementation+Notes-N10273"></a>
+<h4>Implementation Notes</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Notes</th>
+</tr>
+
+<tr>
+<td>1. Create/open a Use Case file</td><td>
+<br>
+<div class="fixme">
+<div class="label">Fixme (High)</div>
+<div class="content">Aggregate all documents in the useCases directory to provide
+ ne large document describing all use cases.</div>
+</div>
+</td>
+</tr>
+
+
+<tr>
+<td>2. Create a new use case</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>3. Describe the overall objective of the use case</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>4. Define each step in the Use Case</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>5. Descripbe the step</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>6. Describe the expected results</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>7. Add "fixme" notes</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>8. Add alternatives</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>9. Write Implementation Notes</td><td>
+<br>
+</td>
+</tr>
+
+</table>
+<a name="N102B8"></a><a name="Generate+Use+Case+Documentation+for+Developers"></a>
+<h3 class="underlined_5">Generate Use Case Documentation for Developers</h3>
+<p>Generate a complete list of all use cases for a project in a format useful to
+ developers of the application. This list is to include:</p>
+<ul>
+
+<li>a description of the use case</li>
+
+<li>a summary of each of the steps involved</li>
+
+<li>full details of each of the steps</li>
+
+<li>a description of the expected outcome of each step</li>
+
+<li>details of common alternatives in each step</li>
+
+<li>implementation notes for each step</li>
+
+</ul>
+<a name="N102D6"></a><a name="Justification-N102D6"></a>
+<h4>Justification</h4>
+<p>A use case describes a unit of work. It is typically used in the design
+ stages of a software project, however, they can often be useful in creating
+ user documentaiton. Especially when they describe user interface functionality.</p>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">Unfortunately this use case document does not currently cover all functions
+ of the plugin since this functionlaity was added after many other features. Whilst you
+ are exploring this feature, why not add a use case to the plugin and submit a patch
+ so that those coming after you can enjoy more complete documentation.</div>
+</div>
+<a name="N102E3"></a><a name="Summary-N102E3"></a>
+<h4>Summary</h4>
+<ol class="steps">
+
+<li>
+<strong>Make HTTP request</strong>
+</li>
+
+</ol>
+<a name="N102EE"></a><a name="Details-N102EE"></a>
+<h4>Details</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Description</th><th>Result</th><th>Status</th>
+</tr>
+
+<tr>
+<td>1. Make HTTP request</td><td>
+
+<p>
+ Request
+ http://localhost:8888/docs/developer/useCases.xml
+ </p>
+
+</td><td>
+
+<p>
+ An XDoc is created that describes the use cases
+ </p>
+
+</td><td>
+ Implemented with fixmes:-<br>
+ High: 1<br>
+</td>
+</tr>
+
+</table>
+<a name="N10310"></a><a name="Implementation+Notes-N10310"></a>
+<h4>Implementation Notes</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Notes</th>
+</tr>
+
+<tr>
+<td>1. Make HTTP request</td><td>
+
+<p>The source document for use cases is, by default, called <span class="codefrag">useCases.xml</span> and is
+ located in the root of the projects xdocs directory.</p>
+
+
+<p>The URL space <span class="codefrag">docs/**/useCases.xml</span> is reserved for the projectInfo plugin. A request to
+ /docs/developer/useCases.xml results in the useCases.xml file being translated into an XDoc as per
+ the usual forrest processing. See the input.xmap file fo this plugin,</p>
+
+<br>
+<div class="fixme">
+<div class="label">Fixme (High)</div>
+<div class="content">Make the summary optional - already added
+ $includeImplementationNotes parameter to stylesheet. Need to pass value form sitemap.</div>
+</div>
+</td>
+</tr>
+
+</table>
+<a name="N10332"></a><a name="Generate+Use+Case+Documentation+for+Users"></a>
+<h3 class="underlined_5">Generate Use Case Documentation for Users</h3>
+<p>Generate a complete list of all use cases for a project. This list is to include:</p>
+<ul>
+
+<li>a description of the use case</li>
+
+<li>a summary of each of the steps involved</li>
+
+<li>full details of each of the steps</li>
+
+<li>a description of the expected outcome of each step</li>
+
+<li>details of common alternatives in each step</li>
+
+</ul>
+<a name="N1034D"></a><a name="Justification-N1034D"></a>
+<h4>Justification</h4>
+<p>A use case describes a unit of work. It is typically used in the design
+ stages of a software project, however, they can often be useful in creating
+ user documentaiton. Especially when they describe user interface functionality.</p>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">Unfortunately the use case document does not currently cover all functions
+ of the plugin since this functionlaity was added after many other features. Whilst you
+ are exploring this feature, why not add a use case to the plugin and submit a patch
+ so that those coming after you can enjoy more complete documentation.</div>
+</div>
+<a name="N1035A"></a><a name="Summary-N1035A"></a>
+<h4>Summary</h4>
+<ol class="steps">
+
+<li>
+<strong>Make HTTP request</strong>
+</li>
+
+</ol>
+<a name="N10365"></a><a name="Details-N10365"></a>
+<h4>Details</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Description</th><th>Result</th><th>Status</th>
+</tr>
+
+<tr>
+<td>1. Make HTTP request</td><td>
+
+<p>
+ Request
+ http://localhost:8888/docs/user/useCases.xml
+ </p>
+
+</td><td>
+
+<p>
+ An XDoc is created that describes the use cases
+ </p>
+
+</td><td>
+ Implemented with fixmes:-<br>
+ High: 1<br>
+ Low: 1<br>
+</td>
+</tr>
+
+</table>
+<a name="N10389"></a><a name="Implementation+Notes-N10389"></a>
+<h4>Implementation Notes</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Notes</th>
+</tr>
+
+<tr>
+<td>1. Make HTTP request</td><td>
+
+<p>The source document for use cases is, by default, called <span class="codefrag">useCases.xml</span> and is
+ located in the root of the projects xdocs directory.</p>
+
+
+<p>The URL space <span class="codefrag">docs/**/useCases.xml</span> is reserved for the projectInfo plugin. A request to
+ /docs/user/useCases.xml results in the useCases.xml file being translated into an XDoc as per
+ the usual forrest processing, see input.xmap for more details.</p>
+
+<br>
+<div class="fixme">
+<div class="label">Fixme (High)</div>
+<div class="content">Enable the retrieval of a specific use case rather than all at once.</div>
+</div>
+<div class="fixme">
+<div class="label">Fixme (Low)</div>
+<div class="content">Make the summary optional - there is a switch in the XSL for this, just need to pass a property
+ from the XMAP</div>
+</div>
+</td>
+</tr>
+
+</table>
+<a name="N103AE"></a><a name="Generate+a+Functionality+Matrix"></a>
+<h3 class="underlined_5">Generate a Functionality Matrix</h3>
+<p>If a use case document is correcly marked up with <span class="codefrag">fixme</span> elements it is possible
+ to create a functionality matrix for each use case. This will show how complete the implementation
+ of a use case is.</p>
+<p>A table can be created which shows each of the steps in a use case, each step can be given a
+ count for the bumber of fixme items outstanding on each of the steps. Furthermore, since each
+ <span class="codefrag">fixme</span> is given a priority we can clearly indicate which use cases are operational an
+ hich are not.</p>
+<a name="N103C0"></a><a name="Summary-N103C0"></a>
+<h4>Summary</h4>
+<ol class="steps">
+
+<li>
+<strong>Make HTTP request</strong>
+</li>
+
+</ol>
+<a name="N103CB"></a><a name="Details-N103CB"></a>
+<h4>Details</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Description</th><th>Result</th><th>Status</th>
+</tr>
+
+<tr>
+<td>1. Make HTTP request</td><td>
+
+<p>
+ Request
+ http://localhost:8888/docs/developer/featureMatrix/useCases.xml
+ </p>
+
+</td><td>
+
+<p>
+ An XDoc is created that lists the steps in each use case and identifies the status
+ of each use case.
+ </p>
+
+</td><td>
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">Not Implemented</div>
+</div>
+ Blockers: 1<br>
+</td>
+</tr>
+
+</table>
+<a name="N103ED"></a><a name="Implementation+Notes-N103ED"></a>
+<h4>Implementation Notes</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Notes</th>
+</tr>
+
+<tr>
+<td>1. Make HTTP request</td><td>
+
+<p>The source document for use cases is, by default, called <span class="codefrag">useCases.xml</span> and is
+ located in the root of the projects xdocs directory.</p>
+
+
+<p>The URL space <span class="codefrag">docs/**/useCases.xml</span> is reserved for the projectInfo plugin. A request to
+ /docs/developer/featureMatrix/useCases.xml results in the useCases.xml file being translated into an XDoc as per
+ the usual forrest processing. See the input.xmap file fo this plugin,</p>
+
+<br>
+<div class="fixme">
+<div class="label">Fixme (Blocker)</div>
+<div class="content">Not Implemented Yet - although the user and dev use case documents
+ do show the status of each step in the details table and implementation notes.</div>
+</div>
+</td>
+</tr>
+
+</table>
+</div>
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </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 ©
+ 2004-2006 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/all.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/changeLogFeatures.html
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/changeLogFeatures.html?rev=425340&view=auto
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/changeLogFeatures.html (added)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/changeLogFeatures.html Tue Jul 25 02:07:44 2006
@@ -0,0 +1,517 @@
+<!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">
+<meta name="Forrest-skin-name" content="pelt">
+<title>Use Cases</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://forrest.apache.org/">Apache Forrest</a> > <a href="http://forrest.apache.org/pluginDocs/">Plugins</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://forrest.apache.org/"><img class="logoImage" alt="Apache Forrest" src="../../../images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<!--+
+ |end group logo
+ +-->
+<!--+
+ |start Project Logo
+ +-->
+<div class="projectlogoA1">
+<a href=""><img class="logoImage" alt="Plugin: projectInfo input" src="../../../images/project.png" title="org.apache.forrest.plugin.input.projectInfo plugin for Apache Forrest"></a>
+</div>
+<!--+
+ |end Project Logo
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="http://forrest.apache.org/pluginDocs">Forrest Plugins</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../../../index.html">Home</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">
+
+
+ </div>
+<!--+
+ |start Menu, mainarea
+ +-->
+<!--+
+ |start Menu
+ +-->
+<div id="menu">
+<div onclick="SwitchMenu('menu_1.1', '../../../skin/')" id="menu_1.1Title" class="menutitle">About</div>
+<div id="menu_1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../index.html" title="Welcome to org.apache.forrest.plugin.input.projectInfo">Index</a>
+</div>
+<div onclick="SwitchMenu('menu_1.1.2', '../../../skin/')" id="menu_1.1.2Title" class="menutitle">Release Notes</div>
+<div id="menu_1.1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../releaseNotes_0.1.html">Version 0.1</a>
+</div>
+<div class="menuitem">
+<a href="../../../releaseNotes_0.2-dev.html">Version 0.2-dev</a>
+</div>
+</div>
+<div class="menuitem">
+<a href="../../../changes.html" title="History of Changes">Changes</a>
+</div>
+<div class="menuitem">
+<a href="../../../todo.html" title="Todo List">Todo</a>
+</div>
+<div class="menuitem">
+<a href="http://forrest.apache.org/docs/plugins" title="Index of Forrest Plugins">Plugins Index</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../../../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Documentation</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
+<div onclick="SwitchMenu('menu_1.2.1', '../../../skin/')" id="menu_1.2.1Title" class="menutitle">User</div>
+<div id="menu_1.2.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../docs/user/useCases/changeLogFeatures.html">Change Log</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/user/useCases/useCaseFeatures.html">Use Cases</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/user/useCases/all.html">All Cases</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.2.2', '../../../skin/')" id="menu_selected_1.2.2Title" class="menutitle" style="background-image: url('../../../skin/images/chapter_open.gif');">Developer</div>
+<div id="menu_selected_1.2.2" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Change Log</div>
+</div>
+<div class="menuitem">
+<a href="../../../docs/developer/useCases/useCaseFeatures.html">Use Cases</a>
+</div>
+<div class="menuitem">
+<a href="../../../docs/developer/useCases/all.html">All Cases</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../../../skin/')" id="menu_1.3Title" class="menutitle">Projects</div>
+<div id="menu_1.3" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.3.1', '../../../skin/')" id="menu_1.3.1Title" class="menutitle">Navigation Indexes</div>
+<div id="menu_1.3.1" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.3.1.1', '../../../skin/')" id="menu_1.3.1.1Title" class="menutitle">All</div>
+<div id="menu_1.3.1.1" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/projectDetails.html" title="Project details for projectInfo">projectInfo</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/projectDetails.forrest.html" title="Project details for Apache Forrest">Apache Forrest</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.1.2', '../../../skin/')" id="menu_1.3.1.2Title" class="menutitle">Java</div>
+<div id="menu_1.3.1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/projectDetails.forrest.html" title="Project details for Apache Forrest">Apache Forrest</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.1.3', '../../../skin/')" id="menu_1.3.1.3Title" class="menutitle">Language Indexes</div>
+<div id="menu_1.3.1.3" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/Java_lang.html" title="All projects using Java">Java</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/XML_lang.html" title="All projects using XML">XML</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/XSLT_lang.html" title="All projects using XSLT">XSLT</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3.2', '../../../skin/')" id="menu_1.3.2Title" class="menutitle">Page Indexes</div>
+<div id="menu_1.3.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="../../../projectDetails/lang-index.html" title="A list of all projects, indexed by language">Index by Language</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/Java_lang.html" title="A list of Jave projects">Java Index</a>
+</div>
+<div class="menuitem">
+<a href="../../../projectDetails/category-index.html" title="A list of all projects, indexed by language">Index by Category</a>
+</div>
+</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"></div>
+</div>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div class="trail">Font size:
+ <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
+ <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
+ <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
+</div>
+<h1>Use Cases</h1>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Uses+Cases+for+Change+Log+management+features+of+org.apache.forrest.plugin.input.projectInfo">Uses Cases for Change Log management features of org.apache.forrest.plugin.input.projectInfo</a>
+<ul class="minitoc">
+<li>
+<a href="#Write+status.xml+File">Write status.xml File</a>
+<ul class="minitoc">
+<li>
+<a href="#Justification">Justification</a>
+</li>
+<li>
+<a href="#Summary">Summary</a>
+</li>
+<li>
+<a href="#Details">Details</a>
+</li>
+<li>
+<a href="#Implementation+Notes">Implementation Notes</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<a name="N10007"></a><a name="Uses+Cases+for+Change+Log+management+features+of+org.apache.forrest.plugin.input.projectInfo"></a>
+<h2 class="underlined_10">Uses Cases for Change Log management features of org.apache.forrest.plugin.input.projectInfo</h2>
+<div class="section">
+<a name="N1000B"></a><a name="Write+status.xml+File"></a>
+<h3 class="underlined_5">Write status.xml File</h3>
+<p>Status.xml if an XML file that records the actions that have been taken in each release
+ of a project. You can then generate a Change Log from that file using the projectInfo
+ plugin.</p>
+<a name="N10014"></a><a name="Justification"></a>
+<h4>Justification</h4>
+<p>Provide a central location and a semi-structured format for recording
+ actions taken during project development. This file can then be used to
+ generate various views on the changes in a release. For example:</p>
+<ul>
+
+<li>Changes between releases</li>
+
+<li>Developers involved in a release</li>
+
+<li>Release notes</li>
+
+</ul>
+<a name="N1002A"></a><a name="Summary"></a>
+<h4>Summary</h4>
+<ol class="steps">
+
+<li>
+<strong>Create/open a status.xml file</strong>
+</li>
+
+
+<li>
+<strong>Create a developer list</strong>
+</li>
+
+
+
+<li>
+<strong>Create a contexts list</strong>
+</li>
+
+
+<li>
+<strong>Create a changes element</strong>
+</li>
+
+
+<li>
+<strong>Create a release element</strong>
+</li>
+
+
+<li>
+<strong>Create a notes element</strong>
+</li>
+
+
+<li>
+<strong>Add actions taken during the development cycle</strong>
+</li>
+
+
+<li>
+<strong>Generate the change log</strong>
+</li>
+
+</ol>
+<a name="N10051"></a><a name="Details"></a>
+<h4>Details</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Description</th><th>Result</th><th>Status</th>
+</tr>
+
+<tr>
+<td>1. Create/open a status.xml file</td><td>
+
+<p>In your favourite XML editor either create a new file
+ or open an existing status.xml file. The default location of these files
+ within a Forrest content object is in the project root. This file should
+ conform to one of the status.xml schemas. The root element for this
+ document is <span class="codefrag">status</span>.</p>
+
+</td><td>You have either a blank status.xml document or an existing one ready for editing.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>2. Create a developer list</td><td>
+
+<p>In order to attribute changes to a specific developer it is neceessary to create
+ a <span class="codefrag">developers</span> element. Within this element you should add a single
+ <span class="codefrag">person</span> element for each develop who works on the project.</p>
+
+</td><td>Each developer is identified in the status.xml file.</td><td>Implemented</td>
+</tr>
+
+
+
+<tr>
+<td>3. Create a contexts list</td><td>
+
+<p>Each action within a release is given a context to help classify changes.
+ When reports are created the context of an action is used to create a more
+ readable report in which similar actions are grouped together. You can
+ specify any contexts you like within the <span class="codefrag">contexts</span> element.</p>
+
+<p>Common contexts used in an software development project are:</p>
+
+<pre class="code">
+<contexts>
+ <context id="code" title="Changes to the Code Base"/>
+ <context id="docs" title="Changes to Documentation"/>
+ <context id="admin" title="Changes to Project Administration"/>
+ <context id="design" title="Changes to Design"/>
+ <context id="build" title="Changes to Build"/>
+</contexts>
+ </pre>
+
+</td><td>The status.xml file describes the sufficient contexts to group common
+ actions together.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>4. Create a changes element</td><td>
+
+<p>Actions that describe the changed in a release are placed within
+ a <span class="codefrag">changes</span>.</p>
+
+</td><td>Status.xml holds an changes element that will group all release
+ information.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>5. Create a release element</td><td>
+
+<p>The details of each release are enclosed within a <span class="codefrag">release</span> element,
+ so you need to create that now.</p>
+
+</td><td>You have the container for your current development release.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>6. Create a notes element</td><td>
+
+<p>Each release can have a <span class="codefrag">notes</span> section. This is used
+ to provide descriptive text at the start of many reports. The notes
+ should describe the release in fairly high level detail, it should
+ not describe any change descriptions, these will be added in the
+ next step.</p>
+
+</td><td>You have a user focussed description of the project and this release.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>7. Add actions taken during the development cycle</td><td>
+
+<p>During the development cycle for the release <span class="codefrag">action</span> elements
+ should be added for each significant contribution to the release.</p>
+
+
+<p>If the change is of particular significance and you woul dlike it to appear
+ in the release notes generated by the projectInfo plugin you should set the
+ <span class="codefrag">importance</span> attribute to <span class="codefrag">"high"</span>.</p>
+
+</td><td>Each significant change in this development cycle is describe in a
+ <span class="codefrag">action</span> element.</td><td>Implemented</td>
+</tr>
+
+
+<tr>
+<td>8. Generate the change log</td><td>
+
+<p>To generate a changelog from your status.xml file you need to request
+ <span class="codefrag">/changes.html</span> or <span class="codefrag">changes.pdf</span> or whatever format
+ you have enabled within Forrest using output plugins.</p>
+
+
+<p>Note that the projectInfo plugin provides a special RSS output format
+ of. Technically, this should not be part of an input plugin and therefore
+ it may be moved at a later date. However, you will always be able to
+ generate the RSS feed by requesting <span class="codefrag">changes.rss</span>.</p>
+
+
+<p>You can generate a change log for a specific version by specifying a
+ version number in the request, for example, <span class="codefrag">changes_0.1.html</span>.</p>
+
+</td><td>Your project is able to generate a changelog.</td><td>Implemented</td>
+</tr>
+
+</table>
+<a name="N10104"></a><a name="Implementation+Notes"></a>
+<h4>Implementation Notes</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+<tr>
+<th>Step</th><th>Notes</th>
+</tr>
+
+<tr>
+<td>1. Create/open a status.xml file</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>2. Create a developer list</td><td>
+<br>
+</td>
+</tr>
+
+
+
+<tr>
+<td>3. Create a contexts list</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>4. Create a changes element</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>5. Create a release element</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>6. Create a notes element</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>7. Add actions taken during the development cycle</td><td>
+<br>
+</td>
+</tr>
+
+
+<tr>
+<td>8. Generate the change log</td><td>
+<br>
+</td>
+</tr>
+
+</table>
+</div>
+</div>
+<!--+
+ |end content
+ +-->
+<div class="clearboth"> </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 ©
+ 2004-2006 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
+</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/docs/developer/useCases/changeLogFeatures.html
------------------------------------------------------------------------------
svn:eol-style = native