forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgard...@apache.org
Subject svn commit: rev 76139 - in forrest/trunk/docs-author/content/xdocs: howto plugins
Date Wed, 17 Nov 2004 15:07:51 GMT
Author: rgardler
Date: Wed Nov 17 07:07:50 2004
New Revision: 76139

Modified:
   forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
   forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml
Log:
add comments on naming conventions

Modified: forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
==============================================================================
--- forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml	(original)
+++ forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml	Wed Nov 17 07:07:50
2004
@@ -91,6 +91,10 @@
       build a minimal plugin directory structure and configuration. You will 
       need to customise these files to buyild your plugin.</p>
       
+      <note>Although you can name your project anything you like we do have 
+      some <a href="site:documentation/developers/pluginInfrastructure">naming 
+      coventions</a> that we recomend you follow.</note> 
+      
       <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

       use it there.</note>
@@ -101,7 +105,7 @@
       directory structure and configuration files.</p>
     
       <section>
-        <title>Edit the Plugin Tempalte</title>
+        <title>Edit the Plugin Template</title>
         <p>You now have a skeleton plugin project. However, it doesn't do 
         anything useful yet. Now is a good time to edit some of the files
         provided. For example:</p>

Modified: forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml
==============================================================================
--- forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml	(original)
+++ forrest/trunk/docs-author/content/xdocs/plugins/pluginInfrastructure.xml	Wed Nov 17 07:07:50
2004
@@ -106,6 +106,27 @@
       </section>
       
       <section>
+        <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
+        developers.</p>
+        
+        <p>The name should be structured like a java package name, and should
+        include a relevant reverse domain name. For example:</p>
+        
+        <source>org.apache.forrest.plugin.PLUGINNAME</source>
+        <source>net.sf.forrestPlugins.PLUGINNAME</source>
+        
+        <p>In addition the name of the plugin should indicate the type of plugin
+        it is:</p>
+        
+        <source>NAME-input</source>
+        <source>NAME-output</source>
+        <source>NAME-internal</source>
+      </section>
+      
+      <section>
         <title>An Example Plugin</title>
   
         <p>In order to fully understand the applicability of Forrest Plugins we 
@@ -160,7 +181,7 @@
 
      
 <source>
-IMSManifest
+org.apache.forrest.plugin.IMSManifest-internal
   |
   |-- sitemap.xmap
   |
@@ -183,7 +204,7 @@
   <map:select type="exists">
     <map:when test="{project:content.xdocs}imsmanifest.xml">
        <map:generate src="{project:content.xdocs}imsmanifest.xml" />
-       <map:transform src="{forrest:plugins}/IMSManifest/resources/stylesheets/imsmanifest2site.xsl"/>
+       <map:transform src="{forrest:plugins}/org.apache.forrest.plugin.IMSManifest-internal/resources/stylesheets/imsmanifest2site.xsl"/>
        <map:transform src="{forrest:stylesheets}/absolutize-linkmap.xsl" />
        <map:transform src="{forrest:stylesheets}/site2site-normalizetabs.xsl" />
      <map:serialize type="xml"/>
@@ -216,9 +237,9 @@
 
   <source><![CDATA[
 <map:select type="exists">
-  <map:when test="{forrest:plugins}/IMSManifest/sitemap.xmap">
+  <map:when test="{forrest:plugins}/org.apache.forrest.plugin.IMSManifest-internal/sitemap.xmap">
     <map:mount uri-prefix="" 
-      src="{forrest:plugins}/IMSManifest/sitemap.xmap" 
+      src="{forrest:plugins}/org.apache.forrest.plugin.IMSManifest-internal/sitemap.xmap"

       check-reload="yes" 
       pass-through="true"/>
   </map:when>

Mime
View raw message