forrest-site-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r527368 [6/6] - in /forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo: ./ docs/developer/useCases/ docs/user/useCases/ images/ skin/ skin/images/ svn-log/ useCases/
Date Wed, 11 Apr 2007 02:03:34 GMT
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/todo.html
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/todo.html?view=diff&rev=527368&r1=527367&r2=527368
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/todo.html
(original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/todo.html
Tue Apr 10 19:03:32 2007
@@ -77,7 +77,7 @@
     |breadtrail
     +-->
 <div class="breadtrail">
-             
+
              &nbsp;
            </div>
 <!--+
@@ -196,7 +196,6 @@
 </ul>
 </div>
     
-    
 <a name="N1001A"></a><a name="medium"></a>
 <h2 class="underlined_10">medium</h2>
 <div class="section">
@@ -208,9 +207,6 @@
        &rarr; open</li>
 </ul>
 </div>
-    
-    
-    
     
 <a name="N10024"></a><a name="low"></a>
 <h2 class="underlined_10">low</h2>

Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/changeLogFeatures.xml
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/changeLogFeatures.xml?view=diff&rev=527368&r1=527367&r2=527368
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/changeLogFeatures.xml
(original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/changeLogFeatures.xml
Tue Apr 10 19:03:32 2007
@@ -17,63 +17,70 @@
 -->
 <useCases>
   <title>Uses Cases for Change Log management features of org.apache.forrest.plugin.input.projectInfo</title>
-
   <useCase>
     <title>Write status.xml File</title>
     <description>
-      <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>
-
+      <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>
       <section>
         <title>Justification</title>
-
-        <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>
-
+        <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>
       </section>
-      
     </description>
-
     <steps>
       <step>
         <title>Create/open a status.xml file</title>
         <description>
-          <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 <code>status</code>.</p>
+          <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 <code>status</code>.
+          </p>
         </description>
         <result>You have either a blank status.xml document or an existing one ready
for editing.</result>
       </step>
-      
       <step>
         <title>Create a developer list</title>
         <description>
-          <p>In order to attribute changes to a specific developer it is neceessary
to create
-          a <code>developers</code> element. Within this element you should add
a single
-          <code>person</code> element for each develop who works on the project.</p>
+          <p>
+            In order to attribute changes to a specific developer it is
+            neceessary to create a <code>developers</code> element. Within this
+            element you should add a single <code>person</code> element for each
+            develop who works on the project.
+          </p>
         </description>
         <result>Each developer is identified in the status.xml file.</result>
       </step>
-
-      
       <step>
         <title>Create a contexts list</title>
         <description>
-          <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 <code>contexts</code> element.</p>
-          <p>Common contexts used in an software development project are:</p>
-          <source><![CDATA[
+          <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
+            <code>contexts</code> element.
+          </p>
+
+          <p>
+            Common contexts used in an software development project are:
+          </p>
+          <source>
+<![CDATA[
 <contexts>
  <context id="code" title="Changes to the Code Base"/>
  <context id="docs" title="Changes to Documentation"/>
@@ -81,78 +88,91 @@
  <context id="design" title="Changes to Design"/>
  <context id="build" title="Changes to Build"/>
 </contexts> 
-          ]]></source>
+          ]]>
+          </source>
         </description>
         <result>The status.xml file describes the sufficient contexts to group common
         actions together.</result>
       </step>
-      
       <step>
         <title>Create a changes element</title>
         <description>
-          <p>Actions that describe the changed in a release are placed within
-          a <code>changes</code>.</p>
+          <p>
+            Actions that describe the changed in a release are placed within a
+            <code>changes</code>.
+          </p>
         </description>
         <result>Status.xml holds an changes element that will group all release 
         information.</result>
       </step>
-      
       <step>
         <title>Create a release element</title>
         <description>
-          <p>The details of each release are enclosed within a <code>release</code>
element,
-          so you need to create that now.</p>
+          <p>
+            The details of each release are enclosed within a
+            <code>release</code> element, so you need to create that now.
+          </p>
         </description>
-
         <result>You have the container for your current development release.</result>
       </step>
-
-        <step>
-          <title>Create a notes element</title>
-          <description>
-            <p>Each release can have a <code>notes</code> section. This
is used
-            to provide descriptive text at the start of many reports. The notes
+      <step>
+        <title>Create a notes element</title>
+        <description>
+          <p>
+            Each release can have a <code>notes</code> 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>
-          </description>
-
-          <result>You have a user focussed description of the project and this release.</result>
-        </step>
-
-        <step>
-          <title>Add actions taken during the development cycle</title>
-          <description>
-            <p>During the development cycle for the release <code>action</code>
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
-            <code>importance</code> attribute to <code>"high"</code>.</p>
-          </description>
-          
-          <result>Each significant change in this development cycle is describe in
a 
+            not describe any change descriptions, these will be added in the
+            next step.
+          </p>
+        </description>
+        <result>You have a user focussed description of the project and this release.</result>
+      </step>
+      <step>
+        <title>Add actions taken during the development cycle</title>
+        <description>
+          <p>
+            During the development cycle for the release <code>action</code>
+            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 <code>importance</code> attribute to
+            <code>"high"</code>.
+          </p>
+        </description>
+        <result>Each significant change in this development cycle is describe in a

           <code>action</code> element.</result>
-        </step>
-
-        <step>
-          <title>Generate the change log</title>
-          <description>
-            <p>To generate a changelog from your status.xml file you need to request
-            <code>/changes.html</code> or <code>changes.pdf</code>
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 <code>changes.rss</code>.</p>
-            
-            <p>You can generate a change log for a specific version by specifying a

-            version number in the request, for example, <code>changes_0.1.html</code>.</p>
-          </description>
-          
-          <result>Your project is able to generate a changelog.</result>
-        </step>
+      </step>
+      <step>
+        <title>Generate the change log</title>
+        <description>
+          <p>
+            To generate a changelog from your status.xml file you need to
+            request <code>/changes.html</code> or <code>changes.pdf</code>
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
+            <code>changes.rss</code>.
+          </p>
+
+          <p>
+            You can generate a change log for a specific version by specifying a
+            version number in the request, for example,
+            <code>changes_0.1.html</code>.
+          </p>
+        </description>
+        <result>Your project is able to generate a changelog.</result>
+      </step>
     </steps>
   </useCase>
 </useCases>

Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/useCaseFeatures.xml
URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/useCaseFeatures.xml?view=diff&rev=527368&r1=527367&r2=527368
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/useCaseFeatures.xml
(original)
+++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.projectInfo/useCases/useCaseFeatures.xml
Tue Apr 10 19:03:32 2007
@@ -17,24 +17,27 @@
 -->
 <useCases>
   <title>Uses Cases for the Use Case management features of org.apache.forrest.plugin.input.projectInfo</title>
-
   <useCase>
     <title>Write Use Case Documentation</title>
     <description>
-      <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>
-
+      <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>
       <section>
         <title>Justification</title>
-
-        <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>
-
+        <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>
@@ -43,181 +46,198 @@
           <li>Task Lists</li>
         </ul>
       </section>
-      
     </description>
-
     <steps>
       <step>
         <title>Create/open a Use Case file</title>
-        <description>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 <code>/content/documentation/useCases/**.xml</code>
+        <description>
+          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
+          <code>/content/documentation/useCases/**.xml</code>
         </description>
         <result>You have either a blank use case document or an existing one ready
for editing.</result>
-
-        <fixme priority="Medium">Create a DTD for use case descriptions.</fixme>
-        <fixme priority="High">Aggregate all documents in the useCases directory to
provide
-        ne large document describing all use cases.</fixme>
+        <fixme priority="Medium">
+          Create a DTD for use case descriptions.
+        </fixme>
+        <fixme priority="High">
+          Aggregate all documents in the useCases directory to provide ne large
+          document describing all use cases.
+        </fixme>
       </step>
-
       <step>
         <title>Create a new use case</title>
         <description>
-          <p>A use case is enclosed within a <code>useCase</code> element.
-          Each use case should be given a brief <code>title</code> to describe
it.</p>
-
+          <p>
+            A use case is enclosed within a <code>useCase</code> element. Each
+            use case should be given a brief <code>title</code> to describe it.
+          </p>
         </description>
-
         <result>You have the container for your new use case.</result>
       </step>
-
-        <step>
-          <title>Describe the overall objective of the use case</title>
-          <description>
-            <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 <code>description</code>
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>
-          </description>
-
-          <result>You have a use case that is described sufficiently well for an average
user of the end system
+      <step>
+        <title>Describe the overall objective of the use case</title>
+        <description>
+          <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 <code>description</code>
+            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>
+        </description>
+        <result>You have a use case that is described sufficiently well for an average
user of the end system
         to understand its purpose.</result>
-        </step>
-
-        <step>
-          <title>Define each step in the Use Case</title>
-          <description>
-            <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 <code>step</code>
-          element which are chilren of a <code>steps</code> element.</p>
-          </description>
-        </step>
-
-        <step>
-          <title>Descripbe the step</title>
-          <description>
-            <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 <code>required="false"</code>
attribute to the
-            <code>step</code> element.</p>
-          </description>
-
-          <result>A user will be able to follow instructions on how to carry out the
step.</result>
-        </step>
+      </step>
+      <step>
+        <title>Define each step in the Use Case</title>
+        <description>
+          <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 <code>step</code> element which are chilren of a
+            <code>steps</code> element.
+          </p>
+        </description>
+      </step>
+      <step>
+        <title>Descripbe the step</title>
+        <description>
+          <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>
 
-        <step>
-          <title>Describe the expected results</title>
-          <description>
-            <p>Provide, within a <code>result</code> 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>
-          </description>
-          <result>You will have provided enough information to allow developers to
test the functionality and
+          <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
+            <code>required="false"</code> attribute to the <code>step</code>
+            element.
+          </p>
+        </description>
+        <result>A user will be able to follow instructions on how to carry out the
step.</result>
+      </step>
+      <step>
+        <title>Describe the expected results</title>
+        <description>
+          <p>
+            Provide, within a <code>result</code> 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>
+        </description>
+        <result>You will have provided enough information to allow developers to test
the functionality and
           users to identify when a step has been succesfully completed.</result>
-        </step>
-
-        <step required="false">
-          <title>Add "fixme" notes</title>
-          <description>
-            <p>A fixme note is enclosed within a <code>fixme</code> 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
+      </step>
+      <step required="false">
+        <title>Add "fixme" notes</title>
+        <description>
+          <p>
+            A fixme note is enclosed within a <code>fixme</code> 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
+            <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

-            <code>&lt;fixme priority="blocker"&gt;Not yet implemented&lt;/fixme&gt;</code>
-            element to all new steps. This is becuase these nodes will be used to build a

-            functionality matrix later on.</p>
-          </description>
-
-          <result>Users will be able to understand to what degree a step is implemented
and developers will be able to 
+            <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
+            <code>&lt;fixme priority="blocker"&gt;Not yet
+            implemented&lt;/fixme&gt;</code> element to all new steps. This
is
+            becuase these nodes will be used to build a functionality matrix
+            later on.
+          </p>
+        </description>
+        <result>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.</result>
-          
-          <fixme priority="enhancement">All fixmes to link to an issue tracker entry</fixme>
-        </step>
-
-        <step required="false">
-          <title>Add alternatives</title>
-          <description>
-            <p>Sometimes there will be alternative paths through each step. These can
be described in an
-            <code>alternatives</code> 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>
-          </description>
-
-          <result>Minor variations in the path through a use case will be documented
for your users.</result>
-        </step>
-        
-        <step required="false">
-          <title>Write Implementation Notes</title>
-          <description>
-            <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>
-          </description>
-          
-          <result>A technical reader will be able to gain a baisc understanding of
how each step is implemented in the 
+        <fixme priority="enhancement">
+          All fixmes to link to an issue tracker entry
+        </fixme>
+      </step>
+      <step required="false">
+        <title>Add alternatives</title>
+        <description>
+          <p>
+            Sometimes there will be alternative paths through each step. These
+            can be described in an <code>alternatives</code> 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>
+        </description>
+        <result>Minor variations in the path through a use case will be documented
for your users.</result>
+      </step>
+      <step required="false">
+        <title>Write Implementation Notes</title>
+        <description>
+          <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>
+        </description>
+        <result>A technical reader will be able to gain a baisc understanding of how
each step is implemented in the 
           application.</result>
-        </step>          
+      </step>
     </steps>
   </useCase>
-
   <useCase status="In Progress" owner="open">
     <title>Generate Use Case Documentation for Developers</title>
-
     <description>
-      <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>
-
+      <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> 
+        <li>implementation notes for each step</li>
       </ul>
-
       <section>
         <title>Justification</title>
-        <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>
-
-        <warning>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.</warning>
+        <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>
+        <warning>
+          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.
+        </warning>
       </section>
     </description>
-
     <steps>
       <step>
         <title>Make HTTP request</title>
         <description>
           <p>
-            Request
-            http://localhost:8888/docs/developer/useCases.xml
+            Request http://localhost:8888/docs/developer/useCases.xml
           </p>
         </description>
         <result>
@@ -225,38 +245,48 @@
             An XDoc is created that describes the use cases
           </p>
         </result>
-
-        <fixme priority="High">Make the summary optional - already added 
-        $includeImplementationNotes parameter to stylesheet. Need to pass value form sitemap.</fixme>
-        
+        <fixme priority="High">
+          Make the summary optional - already added $includeImplementationNotes
+          parameter to stylesheet. Need to pass value form sitemap.
+        </fixme>
         <alternatives>
-          <p>Depending on what plugins are available within your running instance of
Forrest you will
-          be able to request different output formats as per the usual Forrest usage. For
example requesting
-          a http://localhost:8888/docs/developer/useCases.html will generate the HTML document,
whilst
-          http://localhost:8888/docs/developer/useCases.pdf will generate the PDF document
(as long
-          as you have the relevant plugins installed).</p>
+          <p>
+            Depending on what plugins are available within your running instance
+            of Forrest you will be able to request different output formats as
+            per the usual Forrest usage. For example requesting a
+            http://localhost:8888/docs/developer/useCases.html will generate the
+            HTML document, whilst
+            http://localhost:8888/docs/developer/useCases.pdf will generate the
+            PDF document (as long as you have the relevant plugins installed).
+          </p>
         </alternatives>
-
         <implementation>
           <description>
-            <p>The source document for use cases is, by default, called <code>useCases.xml</code>
and is
-            located in the root of the projects xdocs directory.</p>
-
-            <p>The URL space <code>docs/**/useCases.xml</code> 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>
+            <p>
+              The source document for use cases is, by default, called
+              <code>useCases.xml</code> and is located in the root of the
+              projects xdocs directory.
+            </p>
+
+            <p>
+              The URL space <code>docs/**/useCases.xml</code> 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>
           </description>
         </implementation>
       </step>
     </steps>
   </useCase>
-  
   <useCase status="In Progress" owner="open">
     <title>Generate Use Case Documentation for Users</title>
-
     <description>
-      <p>Generate a complete list of all use cases for a project. This list is to include:</p>
-
+      <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>
@@ -264,27 +294,29 @@
         <li>a description of the expected outcome of each step</li>
         <li>details of common alternatives in each step</li>
       </ul>
-
       <section>
         <title>Justification</title>
-        <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>
-
-        <warning>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.</warning>
+        <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>
+        <warning>
+          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.
+        </warning>
       </section>
     </description>
-
     <steps>
       <step>
         <title>Make HTTP request</title>
         <description>
           <p>
-            Request
-            http://localhost:8888/docs/user/useCases.xml
+            Request http://localhost:8888/docs/user/useCases.xml
           </p>
         </description>
         <result>
@@ -292,46 +324,60 @@
             An XDoc is created that describes the use cases
           </p>
         </result>
-
-        <fixme priority="High">Enable the retrieval of a specific use case rather than
all at once.</fixme>
-        <fixme priority="Low">Make the summary optional - there is a switch in the
XSL for this, just need to pass a property
-        from the XMAP</fixme>
-        
+        <fixme priority="High">
+          Enable the retrieval of a specific use case rather than all at once.
+        </fixme>
+        <fixme priority="Low">
+          Make the summary optional - there is a switch in the XSL for this,
+          just need to pass a property from the XMAP
+        </fixme>
         <alternatives>
-          <p>Depending on what plugins are available within your running instance of
Forrest you will
-          be able to request different output formats as per the usual Forrest usage. For
example requesting
-          a http://localhost:8888/docs/user/useCases.html will generate the HTML document,
whilst
-          http://localhost:8888/docs/user/useCases.pdf will generate the PDF document (as
long
-          as you have the relevant plugins installed).</p>
+          <p>
+            Depending on what plugins are available within your running instance
+            of Forrest you will be able to request different output formats as
+            per the usual Forrest usage. For example requesting a
+            http://localhost:8888/docs/user/useCases.html will generate the HTML
+            document, whilst http://localhost:8888/docs/user/useCases.pdf will
+            generate the PDF document (as long as you have the relevant plugins
+            installed).
+          </p>
         </alternatives>
-
         <implementation>
           <description>
-            <p>The source document for use cases is, by default, called <code>useCases.xml</code>
and is
-            located in the root of the projects xdocs directory.</p>
-
-            <p>The URL space <code>docs/**/useCases.xml</code> 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>
+            <p>
+              The source document for use cases is, by default, called
+              <code>useCases.xml</code> and is located in the root of the
+              projects xdocs directory.
+            </p>
+
+            <p>
+              The URL space <code>docs/**/useCases.xml</code> 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>
           </description>
         </implementation>
       </step>
     </steps>
   </useCase>
-  
   <useCase status="In Progress">
     <title>Generate a Functionality Matrix</title>
     <description>
-      <p>If a use case document is correcly marked up with <code>fixme</code>
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
-      <code>fixme</code> is given a priority we can clearly indicate which use
cases are operational an 
-      hich are not.</p>
+      <p>
+        If a use case document is correcly marked up with <code>fixme</code>
+        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 <code>fixme</code> is given
a
+        priority we can clearly indicate which use cases are operational an hich
+        are not.
+      </p>
     </description>
-    
     <steps>
       <step>
         <title>Make HTTP request</title>
@@ -343,34 +389,45 @@
         </description>
         <result>
           <p>
-            An XDoc is created that lists the steps in each use case and identifies the status
-            of each use case.
+            An XDoc is created that lists the steps in each use case and
+            identifies the status of each use case.
           </p>
         </result>
-
-        <fixme priority="Blocker">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.</fixme>
-        
+        <fixme priority="Blocker">
+          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.
+        </fixme>
         <alternatives>
-          <p>Depending on what plugins are available within your running instance of
Forrest you will
-          be able to request different output formats as per the usual Forrest usage. For
example requesting
-          a http://localhost:8888/docs/developer/featureMatrix/useCases.html will generate
the HTML document, whilst
-          http://localhost:8888/docs/developer/featureMatrix/useCases.pdf will generate the
PDF document (as long
-          as you have the relevant plugins installed).</p>
+          <p>
+            Depending on what plugins are available within your running instance
+            of Forrest you will be able to request different output formats as
+            per the usual Forrest usage. For example requesting a
+            http://localhost:8888/docs/developer/featureMatrix/useCases.html
+            will generate the HTML document, whilst
+            http://localhost:8888/docs/developer/featureMatrix/useCases.pdf will
+            generate the PDF document (as long as you have the relevant plugins
+            installed).
+          </p>
         </alternatives>
-
         <implementation>
           <description>
-            <p>The source document for use cases is, by default, called <code>useCases.xml</code>
and is
-            located in the root of the projects xdocs directory.</p>
-
-            <p>The URL space <code>docs/**/useCases.xml</code> 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>
+            <p>
+              The source document for use cases is, by default, called
+              <code>useCases.xml</code> and is located in the root of the
+              projects xdocs directory.
+            </p>
+
+            <p>
+              The URL space <code>docs/**/useCases.xml</code> 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>
           </description>
         </implementation>
       </step>
     </steps>
   </useCase>
 </useCases>
-



Mime
View raw message