From: <de...@de...> - 2008-02-14 02:21:35
|
Author: StephaneLenclud Date: 2008-02-13 20:21:37 -0600 (Wed, 13 Feb 2008) New Revision: 16399 Trac url: http://develop.twiki.org/trac/changeset/16399 Added: twiki/branches/MAIN/twikiplugins/PerforcePlugin/data/TWiki/ twiki/branches/MAIN/twikiplugins/PerforcePlugin/data/TWiki/PerforcePlugin.txt Log: Item5354: Adding missing plugin topic. Added: twiki/branches/MAIN/twikiplugins/PerforcePlugin/data/TWiki/PerforcePlugin.txt =================================================================== --- twiki/branches/MAIN/twikiplugins/PerforcePlugin/data/TWiki/PerforcePlugin.txt (rev 0) +++ twiki/branches/MAIN/twikiplugins/PerforcePlugin/data/TWiki/PerforcePlugin.txt 2008-02-14 02:21:37 UTC (rev 16399) @@ -0,0 +1,71 @@ +---+!! <nop>%TOPIC% + +_short description here_ + +%TOC% + +---++ Syntax Rules + + * + * + +---++ Examples + + * + * + +---++ Plugin Settings + +Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>NEWPLUGIN_SHORTDESCRIPTION%== + + * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic: + * Set SHORTDESCRIPTION = _one line description here_ + + * Debug plugin: (See output in =data/debug.txt=) + * Set DEBUG = 0 + + * My own setting: + * Set HOWTO = got it! + +---++ Plugin Installation Instructions + +__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server. + + * Download the ZIP file from the Plugin Home (see below) + * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content: + | *File:* | *Description:* | + | ==data/TWiki/%TOPIC%.txt== | Plugin topic | + | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | + | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | + * Configure the Plugin: + * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure]] script to enable the Plugin + * Change the Plugin settings as needed + * Test if the installation was successful: + * _enter samples here_ + +---++ Plugin Info + +| Plugin Author: | TWiki:Main.StephaneLenclud | +| Copyright: | © 2007, TWiki:Main.StephaneLenclud | +| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | +| Plugin Version: | 14 Feb 2008 (V1.000) | +| Change History: | <!-- versions below in reverse order --> | +| 14 Feb 2008: | Initial version | +| TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 | +| CPAN Dependencies: | none | +| Other Dependencies: | none | +| Perl Version: | 5.005 | +| [[TWiki:Plugins/Benchmark][Benchmarks]]: | %TWIKIWEB%.GoodStyle nn%, %TWIKIWEB%.FormattedSearch nn%, %TOPIC% nn% | +| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% | +| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | +| Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | + +__Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences + +%TOPICCREATE{ template="Plugins.PluginDevTemplate" topic="PerforcePluginDev" disable="NewPluginTemplate" parameters="pluginName=PerforcePlugin&RelatedTopics=PerforcePlugin, PerforcePluginAppraisal" }% %TOPICCREATE{ template="Plugins.PluginAppraisalTemplate" topic="PerforcePluginAppraisal" disable="NewPluginTemplate" parameters="RelatedTopics=PerforcePlugin, PerforcePluginDev" }% +-- TWiki:Main.StephaneLenclud - 14 Feb 2008 + + + + + |