Difference: TWikiPlugins (15 vs. 16)

Revision 1618 Sep 2001 - MikeMannix

  TWiki Plugins
  Overview
-<
<
+You can add Plugins to extend TWiki's functionality, without altering the core program code. With a plug-in approach, you can:
->
>
+You can add Plugins to extend TWiki's functionality, without altering the core program code. A plug-in approach lets you:
  add virtually unlimited features while keeping the main TWiki code compact and efficient;
  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 - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the TWiki:Plugins web.
->
>
+Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the  TWiki:Plugins  web.
  Preinstalled Plugins 

TWiki comes with three Plugins as part of the standard installation.
-<
<
+ DefaultPlugin handles some legacy TWiki variables that may be present in long-established sites. This option can be controlled from TWikiPreferences. (Perl programmers can also add rules for simple custom processing.)
->
>
+ DefaultPlugin optionally handles some legacy variables from older versions of TWiki. You can control this option from TWikiPreferences. (Perl programmers can also add rules for simple custom processing.)
-<
<
+ EmptyPlugin is a fully functional module, minus active code; it does nothing and serves as a template for new Plugin development.
->
>
+ EmptyPlugin is a fully functional module, minus active code; it does nothing and serves as a template for new Plugin development.
-<
<
+ InterwikiPlugin is preinstalled but can be disabled or removed. Use it for quick linking to to remote sites: TWiki:Plugins expands to TWiki:Plugins on TWiki.org. You can add your own shortcuts and URLs to the existing directory of Wiki-related and other probably useful sites.
->
>
+ InterwikiPlugin is preinstalled but can be disabled or removed. Use it for shorthand linking to remote sites, ex: TWiki:Plugins expands to TWiki:Plugins on TWiki.org. You can edit the predefined set of of Wiki-related sites, and add your own.
  Installing Plugins
  Test Plugins and other new features in the Test installation until you're satisfied.
  Copy the modified files to the Production installation. 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 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 TWikiPreferences. Redefine the DISABLEDPLUGINS variable in the Test web and do the testing there.
  Managing Plugins
-<
<
+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.
->
>
+When you finish installing a Plugin, 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.
  Setting Preferences
  The %PLUGINDESCRIPTIONS% variable displays a bullet list with a one-line description of each active Plugins. This variable is based on the %<plugin>_SHORTDESCRIPTION% Preferences variables of individual topics and is shown in TextFormattingRules.
-<
<
+ DEMO: Active Plugin Variables
->
>
+DEMO: Automatically List Active Plugins Using Variables
-<
<
+%ACTIVATEDPLUGINS%
->
>
+Using %ACTIVATEDPLUGINS%:
 On this TWiki site, the active Plugins are: SpreadSheetPlugin, BackupRestorePlugin, ColorPickerPlugin, CommentPlugin, EditTablePlugin, HeadlinesPlugin, InterwikiPlugin, JQueryPlugin, PreferencesPlugin, SetGetPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin, TagMePlugin, TinyMCEPlugin, TwistyPlugin, WysiwygPlugin.
-<
<
+%PLUGINDESCRIPTIONS%
->
>
+Using %PLUGINDESCRIPTIONS%:
 You can use any of these active TWiki Plugins:
 SpreadSheetPlugin (2013-01-09, $Rev: 24773 (2013-02-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables or anywhere in topic text 
 BackupRestorePlugin (2013-02-16, $Rev: 25107 (2013-02-16) $): Administrator utility to backup, restore and upgrade a TWiki site 
 ColorPickerPlugin (2013-02-15, $Rev: 25075 (2013-02-16) $): Color picker, packaged for use in TWiki forms and TWiki applications 
 CommentPlugin (2013-02-10, $Rev: 24978 (2013-02-16) $): Quickly post comments to a page without an edit/preview/save cycle 
 EditTablePlugin (2013-01-13, $Rev: 25109 (2013-02-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes 
 HeadlinesPlugin (2013-02-16, $Rev: 25105 (2013-02-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites 
 InterwikiPlugin (2013-02-12, $Rev: 25007 (2013-02-16) $): Text ExternalSite:Page links to a page on an external site based on aliases defined in a rules topic 
 JQueryPlugin (2013-01-28, $Rev: 24817 (2013-02-16) $): jQuery JavaScript library for TWiki 
 PreferencesPlugin (2013-01-28, $Rev: 24819 (2013-02-16) $): Allows editing of preferences using fields predefined in a form 
 PublishWebPlugin: (disabled) 
 SetGetPlugin (2013-01-28, $Rev: 24823 (2013-02-16) $): Set and get variables in topics, optionally persistently across topic views 
 SlideShowPlugin (2013-01-13, $Rev: 24790 (2013-02-16) $): Create web based presentations based on topics with headings. 
 SmiliesPlugin (2013-01-13, $Rev: 24786 (2013-02-16) $): Render smilies as icons, like  :-) for  or  :eek: for  
 TWikiNetSkinPlugin: (disabled) 
 TablePlugin (2013-01-28, $Rev: 24827 (2013-02-16) $): Control attributes of tables and sorting of table columns 
 TagMePlugin (2013-01-28, $Rev: 24829 (2013-02-16) $): Tag wiki content collectively to find content by keywords 
 TinyMCEPlugin (2011-07-10, $Rev: 24853 (2013-02-16) $): Integration of TinyMCE with WysiwygPlugin 
 TwistyPlugin (2013-02-16, $Rev: 25099 (2013-02-16) $): Twisty section JavaScript library to open/close content dynamically 
 WysiwygPlugin (2011-11-11, $Rev: 22425 (2013-02-16) $): Translator framework for Wysiwyg editors
 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.
->
>
  The DefaultPlugin Alternative 
 

 DefaultPlugin can handle some outdated TWiki variables, found, for example, in sites recently updated from an old version. Settings are in DefaultPlugin topic. You can also add your own simple custom processing rules here, though in all but very simple cases, writing a new Plugin is preferable.
 OUTLINE: Doc Topic Contents 

Check EmptyPlugin on TWiki.org for the latest Plugin doc topic template. Here's a quick overview of what's covered:
-<
<
+Syntax Rules: Describe any special text formatting that will be rendered.
->
>
+Syntax Rules: <Describe any special text formatting that will be rendered.>"
-<
<
+MyFirstPlugin Settings: Description and settings for custom Plugin %VARIABLES%, and those required by TWiki.
->
>
+MyFirstPlugin Settings: <Description and settings for custom Plugin %VARIABLES%, and those required by TWiki.>"
-<
<
+Plugins Preferences work exactly like TWikiPreferences and WebPreferences: six (6) spaces and then: 
 
 
 Set EXAMPLE = got it!
->
>
+Plugins Preferences <If user settings are needed, explain... Entering valuse works exactly like TWikiPreferences and WebPreferences: six (6) spaces and then:>" 
 
 
 Set <EXAMPLE = value added>
-<
<
+How-to Instructions: Step-by-step set-up guide, user help, whatever it takes to install and run, goes here.
->
>
+How-to Instructions: <Step-by-step set-up guide, user help, whatever it takes to install and run, goes here.>"
-<
<
+Test Example: Include an example of the Plugin in action: if it works, the installation was a success!
->
>
+Test Example: <Include an example of the Plugin in action: if it works, the installation was a success!>"
-<
<
+Plugin Info: Version, credits, history, requirements - entered in a form, displayed as a table. Both are automatically generated when you create or edit a page in the TWiki:Plugins web.
->
>
+Plugin Info: <Version, credits, history, requirements - entered in a form, displayed as a table. Both are automatically generated when you create or edit a page in the TWiki:Plugins web.>"

View topic | History: r37 < r36 < r35 < r34 | More topic actions...