forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cdupoiri...@apache.org
Subject svn commit: r394091 - /forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml
Date Fri, 14 Apr 2006 13:22:33 GMT
Author: cdupoirieux
Date: Fri Apr 14 06:22:31 2006
New Revision: 394091

URL: http://svn.apache.org/viewcvs?rev=394091&view=rev
Log:
Suppress extra spaces and change chapters indentation before to edit them.

Modified:
    forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml

Modified: forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml?rev=394091&r1=394090&r2=394091&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml (original)
+++ forrest/trunk/site-author/content/xdocs/pluginDocs/plugins_0_80/usingPlugins.xml Fri Apr
14 06:22:31 2006
@@ -30,25 +30,25 @@
       does not end there. Forrest can be extended through the addition of
       plugins. This document serves as an introduction to the Forrest
       plugin mechanism.</p>
-  
+
       <section id="available">
         <title>What plugins are available?</title>
         <p>You can run the command <code>forrest available-plugins</code>
to get
         a list of the known plugins for Forrest.</p>
-        
+
         <p>If you would like to have your own plugin added to this list then
         contact the <a href="site:mail-lists">developer mailing list</a>.</p>
       </section>
     </section>
-        
+
     <section id="install">
       <title>How is a Plugin Installed?</title>
         <section id="required">
           <title>List of Plugins Needed by the Project</title>
-          <p>If a site requires one or more plugins then the site designer will 
-           have to list them in the <code>project.required.plugins</code> property

-           in the projects <code>forrest.properties</code> file. When Forrest

-           builds the site it will automatically discover the plugins and install 
+          <p>If a site requires one or more plugins then the site designer will
+           have to list them in the <code>project.required.plugins</code> property
+           in the projects <code>forrest.properties</code> file. When Forrest
+           builds the site it will automatically discover the plugins and install
            them. In otherwords, the user needs do nothing.</p>
            <p>For example,</p>
            <source>project.required.plugins=org.apache.forrest.plugin.input.OpenOffice.org,org.apache.forrest.plugin.input.simplifiedDocbook</source>
@@ -56,7 +56,7 @@
            will cause Forrest to load the plugins called "org.apache.forrest.plugin.input.OpenOffice.org"
and
            "org.apache.forrest.plugin.input.simplifiedDocbook".</p>
            <note>By default a new forrest project has that property configured
-           to include some plugins. Currently there is only one to generate 
+           to include some plugins. Currently there is only one to generate
            PDF output from your source documents.</note>
         </section>
         <section id="version">
@@ -64,13 +64,13 @@
           <p>In the absence of a version number for the plugin (as is the case in the
example above)
           the most recent version that is applicabe to your release of Forrest will be used.
This
           may result in unexpected behaviour if a new version of the plugin has been released
that
-          is incompatible with your current site. To force Forrest into using a specific
version of 
+          is incompatible with your current site. To force Forrest into using a specific
version of
           a plugin you should add "-VERSION_NUMBER" to the end of the plugin name. For example,
           to force forrest to use the 1.0 version of the OpenOffice.org plugin you would
use
           <code>org.apache.forrest.plugin.input.OpenOffice.org-1.0</code>. If
you define a version of the
           plugin that does not exist then it will fall back to using the most recent version
available.
-          This feature is useful when 
-          developing a new site as you can quickly force a plugin upgrade by deleting all
installed 
+          This feature is useful when
+          developing a new site as you can quickly force a plugin upgrade by deleting all
installed
           plugins (use the command 'ant cleanPlugins'). However, this might result in the
installation
           of an in-development plugin, therefore in a production environment you should always
specify
           a known working version.</p>
@@ -93,13 +93,13 @@
             <li>if not found : the remote site (with no forrest version directory)</li>
           </ol>
           <p>By default, forrest looks into the two following directories to find plugins
sources : <code>${forrest.home}/plugins</code> and <code>${forrest.home}/whiteboard/plugins</code>.
-          It is possible to add other sources locations by specifying the <code>project.required.plugins.src</code>
property 
+          It is possible to add other sources locations by specifying the <code>project.required.plugins.src</code>
property
           in the projects <code>forrest.properties</code> file.</p>
           <p>For example,</p>
           <source>project.required.plugins.src=${forrest.home}/plugins,${forrest.home}/whiteboard/plugins,${project.home}/plugins</source>
            <p>
            will add the project specific directory <code>${project.home}/plugins</code>
to the list of directories to search in.</p>
-          <p>If sources are not found, forrest will try to get them from the Web. Forrest
<em>knows</em> the plugins description with plugins descriptors files 
+          <p>If sources are not found, forrest will try to get them from the Web. Forrest
<em>knows</em> the plugins description with plugins descriptors files
           in which plugins are described as follows :</p>
           <source><![CDATA[<plugin name="org.apache.forrest.plugin.output.pdf"
   type="output"
@@ -108,69 +108,69 @@
   url="http://forrest.apache.org/plugins/"
   version="0.2">
   <description>
-    Enable Forrest documents to be output in PDF format. 
+    Enable Forrest documents to be output in PDF format.
   </description>
   <forrestVersion>0.8</forrestVersion>
 </plugin>]]></source>
           <p>The url to download the different plugins is indicated in this file.</p>
           <p>By default, forrest gets the two following plugins descriptors files :
<code>http://forrest.apache.org/plugins/plugins.xml</code> and <code>http://forrest.apache.org/plugins/whiteboard-plugins.xml</code>.
-          It is possible to add other plugins descriptors files by specifying the <code>forrest.plugins.descriptors</code>
property 
+          It is possible to add other plugins descriptors files by specifying the <code>forrest.plugins.descriptors</code>
property
           in the projects <code>forrest.properties</code> file.</p>
           <p>For example,</p>
           <source>forrest.plugins.descriptors=http://forrest.apache.org/plugins/plugins.xml,http://forrest.apache.org/plugins/whiteboard-plugins.xml,file:///${project.home}/plugins/plugins.xml</source>
           <p>
           will add the project specific plugins descriptors file <code>file:///${project.home}/plugins/plugins.xml</code>
to the list of descriptors.</p>
         </section>
-      <section id="local-deploy">
-        <title>Editing plugins sources to enhance functionality</title>
-        <p>
-          Until issue
-          <a href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>
-          is fixed to enable the use of plugins in-place, any changes to
-          sources need to be locally deployed.
-          See <a href="#more">Further reading</a> for "How to build a Plugin".
-        </p>
-        </section>
-      <section id="no-plugins">
-        <title>Upgrading from a Version of Forrest Without Plugins</title>
-        <p>The plugin functionality was introduced in version 0.7 of Forrest.
-        At this time some of the functionality previously in Forrest was
-        extracted into a plugin. However, we have not broken backward 
-        compatability with earlier versions. In the absence of a
-        <code>project.required.plugins</code> property in the projects 
-        <code>forrest.properties</code> file all plugins that contain 
-        functionality previously part of Forrest itself will be loaded
-        automatically. Unless you intend to use new functionality provided
-        by a plugin you will not need to make any changes top your project.</p>
-        
-        <p>If you do require additional plugin functionality, be sure to
-        include all required plugins in the 
-        <code>project.required.plugins</code> property in the project's
-        <code>forrest.properties</code>. You can view
-        <code>main/webapp/default-forrest.properties</code>
-        to see the names of plugins that provide previously core 
-        functionality.</p>
-        
-        <p>It is also worth noting that there is a small performance 
-        improvement if you remove plugins that are not in use. Therefore,
-        if you do not use one or more of the plugins named in the 
-        <code>project.required.plugins</code> property of 
-        <code>main/webapp/default-forrest.properties</code>
-        it is recomended that you override this value in your project's
-        <code>forrest.properties</code> file.</p>
       </section>
+    <section id="local-deploy">
+      <title>Editing plugins sources to enhance functionality</title>
+      <p>
+        Until issue
+        <a href="http://issues.apache.org/jira/browse/FOR-388">FOR-388</a>
+        is fixed to enable the use of plugins in-place, any changes to
+        sources need to be locally deployed.
+        See <a href="#more">Further reading</a> for "How to build a Plugin".
+      </p>
+      </section>
+    <section id="no-plugins">
+      <title>Upgrading from a Version of Forrest Without Plugins</title>
+      <p>The plugin functionality was introduced in version 0.7 of Forrest.
+      At this time some of the functionality previously in Forrest was
+      extracted into a plugin. However, we have not broken backward
+      compatability with earlier versions. In the absence of a
+      <code>project.required.plugins</code> property in the projects
+      <code>forrest.properties</code> file all plugins that contain
+      functionality previously part of Forrest itself will be loaded
+      automatically. Unless you intend to use new functionality provided
+      by a plugin you will not need to make any changes to your project.</p>
+
+      <p>If you do require additional plugin functionality, be sure to
+      include all required plugins in the
+      <code>project.required.plugins</code> property in the project's
+      <code>forrest.properties</code>. You can view
+      <code>main/webapp/default-forrest.properties</code>
+      to see the names of plugins that provide previously core
+      functionality.</p>
+
+      <p>It is also worth noting that there is a small performance
+      improvement if you remove plugins that are not in use. Therefore,
+      if you do not use one or more of the plugins named in the
+      <code>project.required.plugins</code> property of
+      <code>main/webapp/default-forrest.properties</code>
+      it is recomended that you override this value in your project's
+      <code>forrest.properties</code> file.</p>
     </section>
-    
+
     <section id="conflict">
       <title>Avoiding Plugin Conflicts</title>
-      <p>Clashes between plugins can occur. For example, the simplified-docbook 
-      and full docbook plugins may try and process the same files. In this 
-      instance the one that is mounted first will take precedence. Plugins 
-      are mounted in the order they appear in the 
-      <code>project.required.plugins</code> property, therefore the mounting

+      <p>Clashes between plugins can occur. For example, the simplified-docbook
+      and full docbook plugins may try and process the same files. In this
+      instance the one that is mounted first will take precedence. Plugins
+      are mounted in the order they appear in the
+      <code>project.required.plugins</code> property, therefore the mounting
       order and therefore processing precedence is under user control.</p>
     </section>
-    
+
     <section id="more">
       <title>Further Reading</title>
       <ul>



Mime
View raw message