diff options
author | MikeMannix <MikeMannix> | 2001-08-27 09:19:48 +0000 |
---|---|---|
committer | MikeMannix <MikeMannix> | 2001-08-27 09:19:48 +0000 |
commit | 4a884b9ef0e388843017ad8a29fb31c507900d15 (patch) | |
tree | c6cece36f2531a1dd4855a544c475c419b4fc21b | |
parent | fa3a032e98df40b3f0bc9a1939e608a09d5179db (diff) |
none
-rw-r--r-- | TWiki/TWikiPlugins.mdwn | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/TWiki/TWikiPlugins.mdwn b/TWiki/TWikiPlugins.mdwn index 891590d2..9808c733 100644 --- a/TWiki/TWikiPlugins.mdwn +++ b/TWiki/TWikiPlugins.mdwn @@ -10,7 +10,7 @@ TWikiPlugins allow you to add new features to TWiki without changing the core pr * heavily customize an installation and still do clean updates to new versions of TWiki; * rapidly develop new TWiki functions in Perl using the Plugin API. -Everything to do with TWiki Plugins - including demos, new releases, downloads, and discussion - is available at TWiki.org, in the ** [TWiki.org Plugins web](http://twiki.org/cgi-bin/view/Plugins)**. +Everything to do with TWiki Plugins - including demos, new releases, downloads, and discussion - is available at TWiki.org, in the ** [[TWikiPlugins]]**. <a name="InstallPlugin"></a> @@ -48,9 +48,9 @@ Ideally, after you've installed a Plugin, just read the instructions and you're #### <a name="Set_Preferences_for_Individual_P"> Set Preferences for Individual Plugins </a> -Installed Plugins can be **toggled on or off**, site-wide or by web, through [[TWiki/TWikiPreferences]] and individual [[WebPreferences]]: +Installed Plugins can be **toggled on or off**, site-wide or by web, through TWikiPreferences and individual WebPreferences: -* All Plugin modules present in the <code>**lib/TWiki/Plugins**</code> directory are activated automatically unless disabled by the <code>**DISABLEDPLUGINS**</code> Preferences variable in TWikiPreferences. You can optionally list the installed Plugins in the <code>**INSTALLEDPLUGINS**</code> Preferences variable. This is useful to define the sequence of Plugin execution, or to specify other webs than the %WIKITOOLNAME% web for the Plugin topics. Settings in [[TWiki/TWikiPreferences]] are: +* All Plugin modules present in the <code>**lib/TWiki/Plugins**</code> directory are activated automatically unless disabled by the <code>**DISABLEDPLUGINS**</code> Preferences variable in TWikiPreferences. You can optionally list the installed Plugins in the <code>**INSTALLEDPLUGINS**</code> Preferences variable. This is useful to define the sequence of Plugin execution, or to specify other webs than the %WIKITOOLNAME% web for the Plugin topics. Settings in %TWIKIWEB%.TWikiPreferences are: * <code>**Set INSTALLEDPLUGINS = DefaultPlugin, ...**</code> * <code>**Set DISABLEDPLUGINS = EmptyPlugin, ...**</code> @@ -69,8 +69,8 @@ Installed Plugins can be **toggled on or off**, site-wide or by web, through [[T Plugin status variables let you list all active Plugins wherever needed. There are two list formats: -* The <code>**%ACTIVATEDPLUGINS%**</code> variable lists activated Plugins by name. (This variable is displayed in [[TWiki/TWikiPreferences]] for debugging use.) -* The <code>**%PLUGINDESCRIPTIONS%**</code> variable displays a bullet list with a one-line description of each active Plugins. This variable is based on the <code>**%<plugin>\_SHORTDESCRIPTION%**</code> Preferences variables of individual topics and is shown in [[TWiki/TextFormattingRules]]. +* The <code>**%ACTIVATEDPLUGINS%**</code> variable lists activated Plugins by name. (This variable is displayed in %TWIKIWEB%.TWikiPreferences for debugging use.) +* The <code>**%PLUGINDESCRIPTIONS%**</code> variable displays a bullet list with a one-line description of each active Plugins. This variable is based on the <code>**%<plugin>\_SHORTDESCRIPTION%**</code> Preferences variables of individual topics and is shown in %TWIKIWEB%.TextFormattingRules. > > @@ -82,7 +82,7 @@ Plugin status variables let you list all active Plugins wherever needed. There a * **Method 1:** Create a Production and a Test installation of TWiki. The <code>**twiki/data**</code>, <code>**twiki/templates**</code> and <code>**twiki/pub**</code> directories are shared, and the <code>**twiki/bin**</code> and <code>**twiki/lib**</code> directories are separate. Do all tests of Plugins and other new features in the Test installation. When everything works, copy the modified files over to the Production installation. This way, you can update a live TWiki installation and users won't even notice. -* **Method 2:** List the Plugin under test in the DISABLEDPLUGINS variable in [[TWiki/TWikiPreferences]]. Redefine the DISABLEDPLUGINS variable in the test web and do the testing there. +* **Method 2:** List the Plugin under test in the DISABLEDPLUGINS variable in %TWIKIWEB%.TWikiPreferences. Redefine the DISABLEDPLUGINS variable in the test web and do the testing there. <a name="CreatePlugins"></a> @@ -145,11 +145,13 @@ The Plugin documentation topic contains usage instructions and version details. > > Check > -> [EmptyPlugin](http://TWiki.org/cgi-bin/view/TWiki/EmptyPlugin) +> +> +> [[TWIKIWEBEmptyPlugin]] > > on TWiki.org for the latest Plugin doc topic template. Here's a quick overview of what's covered: > -> **Syntax Rules:** **_explanation coming up_** +> **Syntax Rules:** Describe any special text formatting that will be rendered. > > **YourPlugin Settings:** Description and settings for your custom Plugin %VARIABLES%, and those required by TWiki. > @@ -186,7 +188,7 @@ You can release your tested, packaged Plugin to the TWiki community through the 1. **Post** the Plugin documentation topic in the TWiki:Plugins web: * create a new topic using the Plugin name, ex: <code>**YourPlugin.txt**</code>; - * paste in the topic text from How to Create the Plugin Documentation Topic and Save. + * paste in the topic text from Creating Plugin Documentation and Save. 2. **Attach** the distribution zip file to the topic, ex: <code>**YourPlugin.zip**</code>. 3. **Link** from the doc page to a new, blank page named after the Plugin, and ending in <code>**Dev**</code>, ex: <code>**YourPluginDev**</code>. This is the discussion page for future development. (User support for Plugins is handled in TWiki:Support.) |