DefaultPlugin < TWiki

TWiki

TWiki.DefaultPluginr1.6 - 21 Mar 2004 - 08:12 - PeterThoenytopic end

---+ Default TWiki Plugin

The default plugin is used for some depreciated rendering of older TWiki versions and of <nop>JosWiki. This plugin can also be used to specify some simple custom rendering rules. __Note:__ Create a new [[%TWIKIWEB%.TWikiPlugins][TWikiPlugin]] based on EmptyPlugin if you plan to offer some complex rendering or other functionality.

---++ Syntax Rules

Custom rendering rules of the default plugin:

   * Allow old include syntax ( ==%<nop>INCLUDE:"TopicName"%== ) if Plugin Preferences variable ==OLDINCLUDE== is set to ==1==
   * Render depreciated ==*_text_*== as __bold italic__ text. Test if installed: *_This is bold italic_*
   * Enable <nop>JosWiki rules if <nop>JosWiki specific code is uncommented

Modify file ==TWiki/Plugins/DefaultPlugin.pm== to add your own rules or to enable <nop>JosWiki rules.

---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference
a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>DEFAULTPLUGIN_SHORTDESCRIPTION%==

   * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = This plugin can be used to specify some simple custom rendering rules. It also renders depreciated ==*_text_*== as __bold italic__ text.

   * Allow depreciated ==%<nop>INCLUDE:"TopicName"%== syntax:
      * Set OLDINCLUDE = 1

   * Debug plugin: (See output in =data/debug.txt=)
      * Set DEBUG = 0


---++ Plugin Installation Instructions

   * This plugin is preinstalled, you do not need to install it.

---++ Plugin Info

|  Plugin Author: | TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny |
|  Plugin Version: | 21 Mar 2004 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  21 Mar 2004: | Added afterSaveHandler |
|  14 Jul 2001: | Changed to plug&amp;play |
|  27 Feb 2001: | Initial version |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.0 |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |

__Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, EmptyPlugin

-- TWiki:Main.AndreaSterbini - 27 Feb 2001 %BR%
-- TWiki:Main.PeterThoeny - 21 Mar 2004

to top

End of topic
Skip to action links | Back to top

Edit | Attach image or document | Printable version | Raw text | More topic actions
Revisions: | r1.6 | > | r1.5 | > | r1.4 | Total page history | Backlinks

You are here: TWiki > DefaultPlugin

to top