summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Thoeny <web-hurd@gnu.org>2001-07-09 08:53:42 +0000
committerPeter Thoeny <web-hurd@gnu.org>2001-07-09 08:53:42 +0000
commit9f2a0ee22ff5f894d3310c18d319fec8132dd365 (patch)
tree90499e14409c17c1ecca60143bbfc5243fb0fdf8
parent1dc31816455e64ef86c29c4f6345a8dd62a71df1 (diff)
none
-rw-r--r--TWiki/DefaultPlugin.mdwn62
1 files changed, 57 insertions, 5 deletions
diff --git a/TWiki/DefaultPlugin.mdwn b/TWiki/DefaultPlugin.mdwn
index fcfa1fca..1c0df902 100644
--- a/TWiki/DefaultPlugin.mdwn
+++ b/TWiki/DefaultPlugin.mdwn
@@ -1,15 +1,67 @@
-**Default TWiki Plugin**
+## <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 [[TWikiPlugins]] based on [[EmptyPlugin]] if you plan to offer some complex rendering or functions.
+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 [[TWikiPreferences]] variable <code>**DEFAULTPLUGIN\_OLDINCLUDE**</code> is set to <code>**1**</code>
+* 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.
-**_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], [[EmptyPlugin]]
+### <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]]
--- [[Main/PeterThoeny]] - 13 Mar 2001 <br />
+-- %TWIKIWEB%.AndreaSterbini - 27 Feb 2001 <br /> -- %TWIKIWEB%.PeterThoeny - 08 Jul 2001 <br />