diff options
author | MikeMannix <MikeMannix> | 2001-09-01 03:52:16 +0000 |
---|---|---|
committer | MikeMannix <MikeMannix> | 2001-09-01 03:52:16 +0000 |
commit | 2830ad80812baba8001d6ca86cab63a443e48297 (patch) | |
tree | 470ac4461bcf4364d38b96f8430c4df87f1cd134 /TWiki/TWikiPlugins.mdwn | |
parent | dfb7c8f1dad96a95792b5a0606e23984b501037d (diff) |
none
Diffstat (limited to 'TWiki/TWikiPlugins.mdwn')
-rw-r--r-- | TWiki/TWikiPlugins.mdwn | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/TWiki/TWikiPlugins.mdwn b/TWiki/TWikiPlugins.mdwn index 08a97b96..1eed501e 100644 --- a/TWiki/TWikiPlugins.mdwn +++ b/TWiki/TWikiPlugins.mdwn @@ -30,7 +30,7 @@ TWikiPlugin documentation pages are located at TWiki.org, in TWiki:Plugins web. * **Dev page:** Post feature requests, bug reports and general dev comments; topic title ends in <code>**Dev**</code> (ex: <code>**SomePluginDev**</code>). * **User support:** Post installation, how to use type questions (and answers, if you have them) in the TWiki:Support web. -### <a name="Pre_Installed_Plugins"> Pre-Installed Plugins </a> +### <a name="Preinstalled_Plugins"> Preinstalled Plugins </a> TWiki comes with three Plugins as part of the standard installation. @@ -40,11 +40,11 @@ TWiki comes with three Plugins as part of the standard installation. * **InterwikiPlugin** is included but can be disabled or removed. Use it for quick linking to frequently linked to remote sites. Ex: <code>**TWiki:Plugins**</code> expands to TWiki:Plugins - on TWiki.org. You can add your own shortcuts and URLs to the existing directory of Wiki-related sites. -### <a name="Managing_Installed_Plugins"> Managing Installed Plugins </a> +### <a name="Managing_Plugins"> Managing Plugins </a> Ideally, after you've installed a Plugin, just read the instructions and you're set. In fact, some Plugins require additional settings or offer extra options that you can modify on Preferences pages. You may want to make a Plugin available only in certain webs, or temporarily disable it. And having to list all available Plugins will probably come up. You can handle all of these with simple procedures. -#### <a name="Set_Preferences_for_Individual_P"> Set Preferences for Individual Plugins </a> +#### <a name="Setting_Preferences"> Setting Preferences </a> Installed Plugins can be **toggled on or off**, site-wide or by web, through TWikiPreferences and individual WebPreferences: @@ -63,7 +63,7 @@ Installed Plugins can be **toggled on or off**, site-wide or by web, through TWi * The settings can be retrieved as Preferences variables like <code>**%<pluginname>\_<var>%**</code>, ex: <code>**%DEFAULTPLUGIN\_SHORTDESCRIPTION%**</code> shows the description of the DefaultPlugin. -#### <a name="List_Active_Plugins_Automaticall"> List Active Plugins Automatically </a> +#### <a name="Listing_Active_Plugins"> Listing Active Plugins </a> Plugin status variables let you list all active Plugins wherever needed. There are two list formats: @@ -84,7 +84,7 @@ Plugin status variables let you list all active Plugins wherever needed. There a <a name="CreatePlugins"></a> -### <a name="Creating_New_Plugins"> Creating New Plugins </a> +### <a name="Creating_Plugins"> Creating Plugins </a> With a reasonable knowledge of the Perl scripting language, you can create new Plugins or modify and extend existing ones. Basic plug-in architecture uses an Application Programming Interface (API), a set of software instructions that allow external code to interact with the main program. The TWiki Plugin API Plugins by providing a programming interface for TWiki. @@ -115,17 +115,17 @@ In addition to TWiki core functions, Plugins can use **predefined hooks**, or ** * For improve performance, enable only the functions you really need. NOTE: <code>**outsidePREHandler**</code> and <code>**insidePREHandler**</code> are particularly expensive. -#### <a name="Customize_the_DefaultPlugin"> Customize the DefaultPlugin </a> +#### <a name="The_DefaultPlugin_Alternative"> The DefaultPlugin Alternative </a> * **DefaultPlugin** can handle some outdated TWiki variables, found, for example, in sites recently updated from an old version. Settings are in %TWIKIWEB%.TWikiPreferences. You can also add your own simple custom processing rules here, though in all but very simple cases, writing a new Plugin is preferable. -#### <a name="Create_a_Plugin_Module_in_Perl"> Create a Plugin Module in Perl </a> +#### <a name="Creating_the_Perl_Module"> Creating the Perl Module </a> Copy file ([`EmptyPlugin.pm`](http://twiki.org/lib/TWiki/Plugins/EmptyPlugin.pm) to <code>**<name>Plugin.pm**</code> `=EmptyPlugin.pm=` contains no executable code, so it does nothing, but it's ready to be used. Customize it. Refer to the Plugin API specs for more information. <a name="CreatePluginTopic"></a> -#### <a name="Create_a_Plugin_Documentation_To"> Create a Plugin Documentation Topic </a> +#### <a name="Writing_the_Documentation_Topic"> Writing the Documentation Topic </a> The Plugin documentation topic contains usage instructions and version details. It serves the Plugin files as %TWIKIWEB%.FileAttachments for downloading. (The doc topic is also included _in_ the distribution package.) To create a documentation topic: @@ -165,7 +165,7 @@ The Plugin documentation topic contains usage instructions and version details. <a name="CreatePluginPackage"></a> -#### <a name="Package_a_Plugin_for_Distributio"> Package a Plugin for Distribution </a> +#### <a name="Packaging_for_Distribution"> Packaging for Distribution </a> A minimum Plugin release consists of a Perl module with a [[TWiki/WikiName]] that ends in <code>**Plugin**</code>, ex: <code>**YourPlugin.pm**</code>, and a documentation page with the same name(<code>**YourPlugin.txt**</code>). @@ -180,7 +180,7 @@ A minimum Plugin release consists of a Perl module with a [[TWiki/WikiName]] tha <a name="PublishPlugin"></a> -#### <a name="Publish_a_Plugin_for_General_Use"> Publish a Plugin for General Use </a> +#### <a name="Publishing_for_Public_Use"> Publishing for Public Use </a> You can release your tested, packaged Plugin to the TWiki community through the TWiki:Plugins web, where all Plugins submitted to TWiki.org are available for download and further development discussion. Publish your Plugin in three steps: |