TWiki > TWiki > DefaultPlugin	TWiki webs: Main | TWiki | Know | Sandbox
	TWiki . { Welcome | Register | Changes | Topics | Index | Search | Go }

Default TWiki Plugin

The default plugin is used for some deprecated rendering of older TWiki versions and of JosWiki. This plugin can also be used to specify some simple custom rendering rules. Note: Create a new 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 ( %INCLUDE:"TopicName"% ) if Plugin Preferences variable OLDINCLUDE is set to 1
• Render deprecated *_text_* as bold italic text. Test if installed: This is bold italic
• Enable JosWiki rules if JosWiki specific code is uncommented

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

DefaultPlugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %DEFAULTPLUGIN_SHORTDESCRIPTION%

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = This plugin can be used to specify some simple custom rendering rules. It also renders deprecated *_text_* as bold italic text.

• Allow deprecated %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

Related Topics: TWikiPreferences, TWikiPlugins, EmptyPlugin

-- AndreaSterbini - 27 Feb 2001
-- PeterThoeny - 14 Jul 2001