TWiki/DefaultPlugin.mdwn


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

## <a name="Default_TWiki_Plugin"> Default TWiki Plugin </a>

The default plugin is used for some depreciated 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 depreciated <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_Preferences"> %TOPIC% Preferences </a>

Plugin preferences are stored as preferences variables. To reference a plugin preference write <code>**%&lt;plugin&gt;\_&lt;preference&gt;%**</code>, i.e. <code>**%DEFAULTPLUGIN\_SHORTDESCRIPTION%**</code>

* One line description, is included in the %TWIKIWEB%.TextFormattingRules topic:
  * Set SHORTDESCRIPTION = This plugin can be used to specify some simple custom rendering rules. It also renders depreciated <code>**\*\_text\_\***</code> as **_bold italic_** text.
* Allow depreciated <code>**%INCLUDE:"TopicName"%**</code> syntax:
  * Set OLDINCLUDE = 1

### <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> 08 Jul 2001 </td>
  </tr>
  <tr>
    <td align="right"> Change History: </td>
    <td> 08 Jul 2001: Changed to plug&amp;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 - 08 Jul 2001 <br />