PhantomPlugin

PhantomPlugin Purpose

One of target of this plugin - help with documentation for developers. It have custom variables syntax, custom highlighting support for languages and colorers to highlight the plain text.

Current Features

• Variables macro language. You can define variables on all TWiki pages. Read PhantomPluginVariables topic to get more information about this feature.
• Text Formatters. You can define how plugin will format text. For more information please read PhantomPluginFormatters topic.
• Highlighters. You can use predefined or create yourself custom highliters for text (or programmimg code). Read PhantomHighlighters topic to get more information about this feature.

Plugin Development

Please see topic PhantomPluginDev.

If you can say something about this plugin or you have any ideas, i'll be glag if you write in development topic about it.

PhantomPlugin Global Settings

Following variables may using in your work. You can customize each TWiki web by setting this variables in WebPreferences of web. The variables setted in WebPreferences are overload this settings. The TWikiPreferences overload this PhantomPlugin settings, WebPreferences overload TWikiPreferences.

Plugin core settings

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Text processing plugin. Custom variables, custom text formatters etc.

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 1

• Content type of every server response. You can use custom content type. If you don't set skin, this variable have effect only to HTTP header. If you enable a skin, in each template was a META tag with value of this variable. To get more information about skin support, please read PhantomSkin topic. You can leave it variable with empty value, then no content type will be used. This may solve the problem of displaying some non-ISO languages encodings.
  • Set WEBCONTENTTYPE = text/html; charset=windows-1251

Plugins installation

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip PhantomPlugin.zip in your twiki installation directory.
• Test if the installation was successful:
  • The pages chage encoding to charset in %WEBCONTENTTYPE%
  • Try http://twiki.org/cgi-bin/view/Plugins/PhantomPlugin?skin=phantom

Plugin Info

Plugin Author:	AlexeyEfimov
Plugin Version:	09 Sep 2002 (V1.100)
Change History:
28 Aug 2002:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/PhantomPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/PhantomPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- AlexeyEfimov - 17 Nov 2002