You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2005/04/03 08:57:52 UTC
svn commit: r159895 -
forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml
Author: crossley
Date: Sat Apr 2 22:57:50 2005
New Revision: 159895
URL: http://svn.apache.org/viewcvs?view=rev&rev=159895
Log:
Fix some typos.
Modified:
forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml
Modified: forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml?view=diff&r1=159894&r2=159895
==============================================================================
--- forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml (original)
+++ forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml Sat Apr 2 22:57:50 2005
@@ -25,9 +25,9 @@
<body>
<section id="overview">
<title>Overview</title>
- <p>Forrest can be extending with the addition of plugins. This document
+ <p>Forrest can be extended with the addition of plugins. This document
describes what a plugin is and outlines the plugin infrastructure so
- that you can start building your own Forrest extenstions.</p>
+ that you can start building your own Forrest extensions.</p>
<warning>The Plugin Infrastructure is still at an early stage of design
and implementation, consequently this document <em>may</em> be out of date.
@@ -41,7 +41,7 @@
<p>A Forrest plugin is a set of resources and configuration files that
extend the functionality of Forrest. They will typically consist of a
- sitemap, zero or more stylesheets and zero or more schema's.</p>
+ sitemap, zero or more stylesheets and zero or more schemas.</p>
<p>The plugins sitemap is mounted by Forrest's sitemap after the project
specific sitemap but before the Forrest default matchers. This allows
@@ -83,9 +83,9 @@
interfere with any internal Forrest infrastructure matches, or any
other plugins infrastructure matches.</p>
- <p>An input plugin may also providea <code>resources.xmap</code>
+ <p>An input plugin may also provide a <code>resources.xmap</code>
file. This can be used to match additional resources that are not
- stored in XMl files, for example, javascript files.</p>
+ stored in XML files, for example, javascript files.</p>
</section>
<section id="outputPlugins">
@@ -95,7 +95,7 @@
s5 plugin extends Forrest to produce HTML slides from Forrest
documents.</p>
- <p>An output plugin provides a <code>output.xmap</code> file.
+ <p>An output plugin provides an <code>output.xmap</code> file.
This provides the relevant output matchers (i.e.
**.html, **.pdf, **.slides), it is mounted before any of the default
matchers for Forrest and so can override this default behaviour.</p>
@@ -105,17 +105,17 @@
<title>Internal Plugins</title>
<p>Internal plugins are for advanced use only. They provide ways
- of extending or overriding Forrests
+ of extending or overriding Forrest's
internal operations. For example, the IMSManifest plugin
allows Forrest projects to use an IMS Manifest file instead of
- a site.xml and tabs.xml.</p>
+ a site.xml and tabs.xml configuration files.</p>
- <p>Internal plugins provide a <code>internal.xmap</code> file.
+ <p>Internal plugins provide an <code>internal.xmap</code> file.
This provides the infrastructure matchers (i.e.
site.xml, faq.xml, issues.xml), and will be mounted before
*any* of the Forrest matches. This sitemap can override any behaviour
within Forrest and so developers of these plugins must be especially
- careful with the construction of their matchers since they will be
+ careful with the construction of their matchers, since they will be
processed before any other matchers and consequently can easily break
existing functionality. You must only do a <map:generate ...>
if you are certain you are going to process the full result. </p>
@@ -126,7 +126,7 @@
<title>Naming Conventions</title>
<p>Technically you can name a plugin anything you like. However, we
do have some naming conventions that we recomend you follow. This is
- to minimis the chances of collision between plugins from different
+ to minimise the chances of collision between plugins from different
developers.</p>
<p>The name should be structured like a java package name, and should
@@ -185,15 +185,15 @@
| |
| |-- catalog.xcat
| |
- | |--DTD (dtd's etc.)
+ | |-- dtd (DTDs etc.)
|
- |-- stylesheets (xsl's etc.)
+ |-- stylesheets (XSLs etc.)
</source>
<section>
<title>The IMS Manifest Plugin</title>
- <p>If we consider the IMS Manifest Plugin described above we see that we
+ <p>If we consider the IMS Manifest Plugin described above, we see that we
will need the following files and directory structure:</p>