Return-Path: 
 <svn-return-1761-apmail-forrest-svn-archive=forrest.apache.org@forrest.apache.org>
Delivered-To: apmail-forrest-svn-archive@www.apache.org
Received: (qmail 94896 invoked from network); 3 Apr 2005 07:26:28 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 3 Apr 2005 07:26:28 -0000
Received: (qmail 29393 invoked by uid 500); 3 Apr 2005 07:26:27 -0000
Delivered-To: apmail-forrest-svn-archive@forrest.apache.org
Received: (qmail 29344 invoked by uid 500); 3 Apr 2005 07:26:27 -0000
Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:svn-help@forrest.apache.org>
list-unsubscribe: <mailto:svn-unsubscribe@forrest.apache.org>
List-Post: <mailto:svn@forrest.apache.org>
Reply-To: "Forrest Developers List" <dev@forrest.apache.org>
Delivered-To: mailing list svn@forrest.apache.org
Received: (qmail 29331 invoked by uid 99); 3 Apr 2005 07:26:27 -0000
X-ASF-Spam-Status: No, hits=-9.8 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received: from minotaur.apache.org (HELO minotaur.apache.org)
 (209.237.227.194)
  by apache.org (qpsmtpd/0.28) with SMTP; Sat, 02 Apr 2005 23:26:25 -0800
Received: (qmail 94864 invoked by uid 65534); 3 Apr 2005 07:26:24 -0000
Message-ID: <20050403072624.94862.qmail@minotaur.apache.org>
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
X-Mailer: svnmailer-1.0.0-dev
Date: Sun, 03 Apr 2005 07:26:24 -0000
Subject: svn commit: r159897 -
 forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
To: svn@forrest.apache.org
From: crossley@apache.org
X-Virus-Checked: Checked
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N

Author: crossley
Date: Sat Apr  2 23:26:23 2005
New Revision: 159897

URL: http://svn.apache.org/viewcvs?view=3Drev&rev=3D159897
Log:
Add section IDs. Minor text tweaks and some typos.

Modified:
    forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml

Modified: forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.x=
ml
URL: http://svn.apache.org/viewcvs/forrest/trunk/docs-author/content/xdocs/=
howto/howto-buildPlugin.xml?view=3Ddiff&r1=3D159896&r2=3D159897
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D
--- forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml (or=
iginal)
+++ forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml Sat=
 Apr  2 23:26:23 2005
@@ -1,6 +1,6 @@
 <?xml version=3D"1.0" encoding=3D"UTF-8"?>
 <!--
-  Copyright 2002-2004 The Apache Software Foundation or its licensors,
+  Copyright 2002-2005 The Apache Software Foundation or its licensors,
   as applicable.
=20
   Licensed under the Apache License, Version 2.0 (the "License");
@@ -25,8 +25,8 @@
     <abstract>This How-To describes the steps necessary to build a plugin =
for=20
     Forrest. Forrest uses plugins to add new input formats, output formats
     and to change its default behaviour. Since plugins are downloaded when
-    needed and can be hosted at any location plugin code can be developed=20
-    independantly of Apache Forrest. This how-to describes each of the maj=
or
+    needed and can be hosted at any location, plugin code can be developed=20
+    independently of Apache Forrest. This how-to describes each of the maj=
or
     steps in creating a plugin and then works through some examples of=20
     plugin creation in order to illustrate the materials.</abstract>
=20
@@ -35,7 +35,7 @@
=20
   <audience title=3D"Intended Audience">
     <p>Users needing to add additional input formats or output formats or
-    to change the way Forrest internals work.</p>
+    to change the operation of the Forrest internals.</p>
    =20
     <warning>The Plugin Infrastructure is still at an early stage of desig=
n=20
     and implementation, consequently this How-To <em>may</em> be out of da=
te
@@ -75,7 +75,7 @@
      =20
     </section>
    =20
-    <section>
+    <section id=3D"ant">
     	<title>Make ant Available on the Command Line</title>
     	<p>
     		The following instructions rely heavily on
@@ -92,7 +92,7 @@
     	</p>
     </section>
    =20
-    <section>
+    <section id=3D"seed">
       <title>Seed a New Plugin</title>
       <p>Regardless of the type of plugin you are building, the directory
       structure is almost identical, as are most of the requried
@@ -113,24 +113,24 @@
      =20
       <note>Although you can name your project anything you like we do hav=
e=20
       some <a href=3D"site:documentation/developers/pluginInfrastructure">=
naming=20
-      coventions</a> that we recomend you follow.</note>=20
+      coventions</a> that we recommend you follow.</note>=20
      =20
       <note>If you plan on building your plugin elsewhere you can copy the
       <code>build.xml</code> build file to your own plugin work directory =
and=20
       use it there.</note>
      =20
       <p>See=20
-      <a href=3D"site:documentation/developers/pluginInfrastructure">What =
Does=20
-      a Forrest Plugin Look Like?</a> for more information on the plugin
+      <a href=3D"site:documentation/developers/pluginInfrastructure">Plugin
+      Infrastructure</a> for more information about the plugin
       directory structure and configuration files.</p>
    =20
-      <section>
+      <section id=3D"edit-template">
         <title>Edit the Plugin Template</title>
         <p>You now have a skeleton plugin project. However, it doesn't do=20
         anything useful yet. Now is a good time to edit some of the files
         provided. For example:</p>
        =20
-        <section>
+        <section id=3D"status">
           <title>status.xml</title>
           <p>This file is used to track changes to the plugin
           project and to manage lists of things that still need to be done.
@@ -143,7 +143,7 @@
           plugin.</p>
         </section>
        =20
-        <section>
+        <section id=3D"forrest-properties">
           <title>forrest.properties</title>
          =20
           <p>This file defines many configuration parameters for Forrest. =
It
@@ -151,7 +151,7 @@
           for more details.</p>
         </section>
        =20
-        <section>
+        <section id=3D"skinconf">
           <title>src/documentation/skinconf.xml</title>
           <p>This configures the skin for your plugins documentation. There
           are some items that need to be configured in here, for example, =
the
@@ -159,7 +159,7 @@
           best to read through it, changing what you need to.</p>
         </section>
        =20
-        <section>
+        <section id=3D"doc">
           <title>Documentation</title>
           <p>It is also a good idea to start writing the documentation at =
this
           stage. The above process created a very simple plugin documentat=
ion
@@ -168,8 +168,8 @@
       </section>
     </section>
    =20
-    <section>
-      <title>Edit the Plugin XMap file(s)</title>
+    <section id=3D"edit-sitemap">
+      <title>Edit the Plugin sitemap file(s)</title>
       <p>The plugin <code>xmap</code> file is a Cocoon sitemap that is mou=
nted
       at a strategic place in the Forrest pipeline. It is in this file
       that you will instruct Forrest how to operate. An input plugin
@@ -187,47 +187,47 @@
       for some hints and tips on creating plugin sitemaps. In addition, as=
 with
       all development work on Forrest, you will find
       the <a href=3D"ext:forrest/mail-lists/forrest-dev">developer mailing=
 list</a>
-      a very doog resource (check the archives before posting, please).</p>
+      a very good resource (check the archives before posting, please).</p>
      =20
-      <section>
+      <section id=3D"components">
         <title>Components, Actions and Resources</title>
         <p>If your plugin uses any components (i.e. generators, transforme=
rs or
         serializers), actions or resources they must
-        be defined in either the plugins xmap or one of its parents. The p=
arents
+        be defined in either the xmap for this plugin or one of its parent=
s=2E The parents
         of an <code>input.xmap</code> are <code>sitemap.xmap</code> and
         <code>forrest.xmap</code>, whilst the parent of both=20
         <code>output.xmap</code> and <code>internal.xmap</code> are=20
-        <code>sitemap.xmap</code>.</p>
+        <code>sitemap.xmap</code></p>
         <p>If you want to use the realpath where the sitemap.xmap of your =
plugin=20
-        resides then you have to use=20
+        resides then you need to use=20
         <code>{forrest:plugins}/PLUGIN_NAME</code> instead of <code>{realp=
ath:/}</code>.
         </p>
         <p>See the examples below for more details.</p>
       </section>
     </section>
    =20
-    <section>
+    <section id=3D"resources">
       <title>Create the Necessary Resource Files</title>
       <fixme author=3D"rdg">Discuss the XSL files and other such resources=
</fixme>
     </section>
    =20
-    <section>
+    <section id=3D"samples">
       <title>Create Samples in the Documentation</title>
       <p>Plugin documentation should provide (as a minimum) an
       index page that provides an overview and a set of samples that demon=
strate
-      the functionlaity of the plugin. Typically these samples will be
+      the functionality of the plugin. Typically these samples will be
       provided in a <code>samples</code> subdirectory in the plugin=20
       documentation and will be referenced from both <code>site.xml</code>
-      and <code>tabs.xml</code>.</p>
+      and <code>tabs.xml</code> configuration files.</p>
      =20
       <p>Try to provide a sample for all the major functions of your plugin
       and document any configuration that is available.</p>
     </section>
    =20
-    <section>
+    <section id=3D"test">
       <title>Testing a Plugin</title>
       <p>Since your documentation for the plugin illustrates all of its=20
-      functionality you can use that site for testing the plugin. However,=
 you
+      functionality, you can use that site for testing the plugin. However=
, you
       must first deploy in your local install of Forrest. Each plugin cont=
ains
       a buildfile that includes a <code>test</code> target. This target, by
       default, builds the documtantion for your plugin.</p>
@@ -243,25 +243,25 @@
      =20
       <p>It is also a really good idea to build proper tests for your=20
       plugins using a suitable testing framework, for example,=20
-      <a href=3D"http://webtest.canoo.com/">WebTest</a>. We recomend that =
you
+      <a href=3D"http://webtest.canoo.com/">WebTest</a>. We recommend that=
 you
       extend the <code>test</code> target in your plugins build file becau=
se
       this target is also used when performing integration tests on Forres=
t=2E
-      In addition, we recomend that you use the samples in your documentat=
ion=20
+      In addition, we recommend that you use the samples in your documenta=
tion=20
       for your tests, this way you are documenting your plugin at the same=
 time=20
       as writing your tests.</p>
     </section>
    =20
-    <section>
+    <section id=3D"release">
       <title>Releasing a Plugin</title>
    =20
-      <section>
+      <section id=3D"register">
         <title>Register the Plugin with Apache Forrest</title>
         <fixme author=3D"rdg">Describe the plugins.xml file</fixme>
         <fixme author=3D"rdg">Describe making a request of Forrest devs fo=
r=20
         inclusion</fixme>
       </section>
      =20
-      <section>
+      <section id=3D"deploy">
         <title>Deploying the Plugin</title>
         <p>To deploy the plugin so that others can use it, it must be made=20
         available as a zip from the URL indicated in the=20
@@ -272,7 +272,7 @@
         <code>ant deploy</code> from within the plugin directory.</p>
        =20
         <p>This command will, by default, deploy to the Apache Forrest web=
 site.
-        In order to do this you need write access to Forrest. If you want =
to
+        In order to do this you need commit access to Forrest. If you want=
 to
         deploy your plugin to a different location you=20
         can build the zip of your plugin with <code>ant dist</code>
         and then copy the zip file from <code>build/dist</code> to wherever
@@ -281,7 +281,7 @@
         <note>Running this command on any plugin will also deploy any
         changes to the <code>plugins.xml</code> file. If you are deploying=
 to
         your own website you will have to request changes to the=20
-        <code>plugins.xml</code> and have a Forrest committer publish the =
new
+        <code>plugins.xml</code> and ask the Forrest committers to publish=
 the new
         document.</note>
        =20
         <warning>Running the <code>deploy</code> or <code>dist</code> targ=
ets
@@ -292,21 +292,21 @@
       </section>
     </section>
    =20
-    <section>
+    <section id=3D"examples">
       <title>Examples</title>
       <p>This section will provide some example plugins to help illustrate=
 the
       steps discussed above.</p>
-        <section>
+        <section id=3D"input">
           <title>Input Plugin</title>
           <fixme author=3D"RDG">Discuss OpenOffice.org plugin here</fixme>
         </section>
        =20
-        <section>
+        <section id=3D"output">
           <title>Output Plugin</title>
           <fixme author=3D"RDG">Discuss s5 plugin here</fixme>
         </section>
        =20
-        <section>
+        <section id=3D"internal">
           <title>Internal Plugin</title>
           <fixme author=3D"RDG">Discuss IMSManifest plugin here</fixme>
         </section>