none
authorPeterThoeny <PeterThoeny>
Fri, 1 Aug 2003 05:37:04 +0000 (05:37 +0000)
committerPeterThoeny <PeterThoeny>
Fri, 1 Aug 2003 05:37:04 +0000 (05:37 +0000)
TWiki/TWikiPlugins.mdwn
TWiki/TextFormattingRules.mdwn

index e65d7f9..a9fb963 100644 (file)
@@ -5,6 +5,7 @@
         <li><a href="#Preinstalled Plugins"> Preinstalled Plugins</a></li>
         <li><a href="#Installing Plugins"> Installing Plugins</a><ul>
             <li><a href="#On-Site Pretesting"> On-Site Pretesting</a></li>
+            <li><a href="#A Note on Performance"> A Note on Performance</a></li>
           </ul>
         </li>
         <li><a href="#Managing Plugins"> Managing Plugins</a><ul>
@@ -90,6 +91,12 @@ To test new Plugins on your installation before making them public, you may want
 
 - **Method 2:** List the Plugin being tested in the `DISABLEDPLUGINS` variable in [[TWikiPreferences]]. Redefine the `DISABLEDPLUGINS` variable in the `Sandbox` web and do the testing there.
 
+### <a name="A Note on Performance"></a> A Note on Performance
+
+The performance of the system depends on the number of Plugins installed and on the Plugin implementation. Some Plugins impose no measurable performance decrease, some do. For example, `outsidePREHandler` is an expensive callback function, or a Plugin might use many Perl libraries that needs to be initialized with each page view (unless you run mod\_perl). It is recommended to measure the performance with and without a new Plugin.
+
+In case you need to install an "expensive" Plugin and you need its functionality only in one web you can place the Plugin topic into that web. TWiki will initialize the Plugin only if the Plugin topic is found (which won't be the case for other webs.)
+
 ## <a name="Managing Plugins"></a> Managing Plugins
 
 When you finish [[installing a Plugin|Main/WebHome#InstallPlugin]], you should be able to read the user instructions and go. In fact, some Plugins require additional settings or offer extra options that you have to select. Also, you may want to make a Plugin available only in certain webs, or temporarily disable it. And may want to list all available Plugins in certain topics. You can handle all of these management tasks with simple procedures.
index 0f487b4..f802514 100644 (file)
@@ -245,7 +245,7 @@ Know.ReadmeFirst
     </td>
   </tr>
   <tr bgcolor="#ffffff">
-    <td valign="top"><a name="SquareBrackets"></a> <strong>Forced Links:</strong> %BR% You can create a forced internal link by enclosing words in double square brackets. %BR% <strong><em>Note:</em></strong> Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, <code>[[text formatting FAQ]]</code> links to topic [[Main/TextFormattingFAQ]]. You can also refer to a different web and use anchors. </td>
+    <td valign="top"><a name="SquareBrackets"></a> <strong>Forced Links:</strong> %BR% You can create a forced internal link by enclosing words in double square brackets. %BR% <strong><em>Note:</em></strong> Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, <code>[[text formatting FAQ]]</code> links to topic [[Main/TextFormattingFAQ]]. You can also refer to a different web and use anchors. %BR% <strong><em>Note:</em></strong> To "escape" double square brackets that would otherwise be a correct link, use <code>&lt;nop&gt;</code> between the leading left square brackets, that is, begin with <code>[&lt;nop&gt;[....</code></td>
     <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
 [[wiki syntax]]
 
@@ -368,6 +368,8 @@ Variables are names that are enclosed in percent signs `%` that are expanded on
 
 - There are many more variables, see **[[TWikiVariables]]**.
 
+- To "escape" a percent sign that would otherwise be interpreted as a variable, add `<nop>` after the first percent sign. Write: <code><span><font> %&lt;nop&gt;SOMEVARIABLE% </font></span></code> to get: %SOMEVARIABLE%.
+
 ## <a name="TWikiPlugin Formatting Extension"></a><a name="_TWikiPlugin Formatting Extensio"></a> TWikiPlugin Formatting Extensions
 
 Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, the optional [SpreadSheetPlugin](http://twiki.org/cgi-bin/view/Plugins/SpreadSheetPlugin) lets you create a spreadsheet with the same basic notation used in TWiki tables.