diff options
Diffstat (limited to 'TWiki/DefaultPlugin.mdwn')
-rw-r--r-- | TWiki/DefaultPlugin.mdwn | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/TWiki/DefaultPlugin.mdwn b/TWiki/DefaultPlugin.mdwn new file mode 100644 index 00000000..aae0be36 --- /dev/null +++ b/TWiki/DefaultPlugin.mdwn @@ -0,0 +1,71 @@ +## <a name="Default_TWiki_Plugin"> Default TWiki Plugin </a> + +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 [[TWIKIWEBTWikiPlugins]] based on [[EmptyPlugin]] if you plan to offer some complex rendering or other functionality. + +### <a name="Syntax_Rules"> Syntax Rules </a> + +Custom rendering rules of the default plugin: + +* Allow old include syntax ( <code>**%INCLUDE:"TopicName"%**</code> ) if Plugin Preferences variable <code>**OLDINCLUDE**</code> is set to <code>**1**</code> +* Render deprecated <code>**\*\_text\_\***</code> as **_bold italic_** text. Test if installed: **\_This is bold italic\_** +* Enable JosWiki rules if JosWiki specific code is uncommented + +Modify file <code>**TWiki/Plugins/DefaultPlugin.pm**</code> to add your own rules or to enable JosWiki rules. + +### <a name="_TOPIC_Settings"> %TOPIC% Settings </a> + +Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%<plugin>\_<setting>%**</code>, i.e. <code>**%DEFAULTPLUGIN\_SHORTDESCRIPTION%**</code> + +* 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 deprecated <code>**\*\_text\_\***</code> as **_bold italic_** text. + +* Allow deprecated <code>**%INCLUDE:"TopicName"%**</code> syntax: + * Set OLDINCLUDE = 1 + +* Debug plugin: (See output in `data/debug.txt`) + * Set DEBUG = 0 + +### <a name="Plugin_Installation_Instructions"> Plugin Installation Instructions </a> + +* This plugin is preinstalled, you do not need to install it. + +### <a name="Plugin_Info"> Plugin Info </a> + +<table border="1" cellpadding="1" cellspacing="0"> + <tr> + <td align="right"> Plugin Author: </td> + <td> %TWIKIWEB%.AndreaSterbini, %TWIKIWEB%.PeterThoeny </td> + </tr> + <tr> + <td align="right"> Plugin Version: </td> + <td> 14 Jul 2001 </td> + </tr> + <tr> + <td align="right"> Change History: </td> + <td> 14 Jul 2001: Changed to plug&amp;play <br /> 27 Feb 2001: Initial version </td> + </tr> + <tr> + <td align="right"> CPAN Dependencies: </td> + <td> none </td> + </tr> + <tr> + <td align="right"> Other Dependencies: </td> + <td> none </td> + </tr> + <tr> + <td align="right"> Perl Version: </td> + <td> 5.0 </td> + </tr> + <tr> + <td align="right"> Plugin Home: </td> + <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td> + </tr> + <tr> + <td align="right"> Feedback: </td> + <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td> + </tr> +</table> + +**_Related Topics:_** %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, [[EmptyPlugin]] + +-- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br /> -- %TWIKIWEB%.PeterThoeny - 14 Jul 2001 <br /> |