Ignore:
Timestamp:
11/24/08 14:27:56 (4 years ago)
Author:
CrawfordCurrie
Message:

Item287: Rewrote significant chunk of plugins doc to simplify and improve developer doc. Added doc: protocol to %INCLUDE to support including core module documentation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/EmptyPlugin/data/System/EmptyPlugin.txt

    r878 r920  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 14040 $"}% 
    2 ---+ Empty TWiki Plugin 
     2---+ Empty Plugin 
    33 
    44This is an empty Plugin you can use as a template to build your own [[%SYSTEMWEB%.Plugins][Plugins]]. This Plugin does nothing, but is ready to be used. 
    … …  
    66To create your own Plugin: 
    77 
    8    * Copy file ==TWiki/Plugins/EmptyPlugin.pm== to ==<name>Plugin.pm== and customize the plugin. 
     8   * Copy file ==lib/Foswiki/Plugins/EmptyPlugin.pm== to ==lib/Foswiki/Plugins/<name>Plugin.pm==. 
    99   * Create a  ==<name>Plugin== topic in the %SYSTEMWEB% web. Do so by visiting http://foswiki.org/Extensions/PluginPackage#NewPlugin and starting a new topic to get the default plugin topic text (don't save the topic). Customize your plugin topic to your needs. 
    10    * See details in [[%SYSTEMWEB%.Plugins][Plugins]]. 
     10   * See details in [[%SYSTEMWEB%.DevelopingPlugins][DevelopingPlugins]]. 
    1111 
    12 ---++ Syntax Rules 
     12---++ Plugin Handlers 
     13The following plugin handlers are defined. 
    1314 
    14 (none) 
     15%INCLUDE{"pod:Foswiki::Plugins::EmptyPlugin" level="3"}% 
    1516 
    1617---++ Plugin Settings 
    … …  
    2223      * Set SHORTDESCRIPTION = Empty Plugin used as a template for new Plugins 
    2324 
    24    * Your own setting, for example: 
    25       * Set EXAMPLE = got it! 
    26  
    27    * Debug plugin: ( TWiki sets =$debug= in your plugin. See output in =data/debug.txt=.) 
    28       * Set DEBUG = 0 
    29  
    30 ---++ Plugin Installation Instructions 
    31  
    32    * This plugin is preinstalled, you do not need to install it. 
    33  
    3425---++ Plugin Info 
    3526 
    36 |  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie | 
    37 |  Copyright: | © 2001-2007, %SYSTEMWEB%.ProjectContributor | 
     27|  Plugin Author: | Foswiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, Foswiki:Main.CrawfordCurrie | 
     28|  Copyright: | &copy; 2008, Foswiki Contributors<br>&copy; 2001-2007, TWiki Contributors | 
    3829|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | 
    3930|  Plugin Version: | %$VERSION% | 
    40 |  Change History: | <!-- versions below in reverse order -->&nbsp; | 
    41 |  20 May 2007 | Added renderWikiWordHandler | 
    42 |  01 Feb 2006: | Dakar changes | 
    43 |  21 Mar 2004: | Added afterSaveHandler | 
    44 |  14 Jul 2001: | Changed to plug&amp;play | 
    45 |  27 Feb 2001: | Initial version | 
    46 |  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 | 
    47 |  Dependencies: | %$DEPENDENCIES | 
    48 |  Foswiki:Extensions/Benchmark: | %SYSTEMWEB%.GoodStyle 99%, %SYSTEMWEB%.FormattedSearch 99%, %TOPIC% 99% | 
    49 |  Plugin Home: | http://foswiki.org/Extensions/%TOPIC% | 
    50 |  Feedback: | http://foswiki.org/Extensions/%TOPIC%Dev | 
    51 |  Appraisal: | http://foswiki.org/Extensions/%TOPIC%Appraisal | 
    5231 
    53 __Related Topics:__ [[%SYSTEMWEB%.Plugins][Plugins]], %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences 
    5432 
    55 -- %SYSTEMWEB%.ProjectContributor - 01 Feb 2006 
     33 
Note: See TracChangeset for help on using the changeset viewer.