Suggested documentation for new version of hack-free plugin

For development discussion see SpacedWikiWordPluginNextGenDev

Spaced Wiki Word Plugin

Causes wiki words to be displayed with spaces between capitals within the main text and templates.

Syntax Rules

Create internal links as usual with WikiWords. WikiWordLinks will be spaced out and displayed as Wiki Word Links.

To turn off spacing, put the WikiWord within double brackets (e.g. [[WikiWord]]). This will leave the word unspaced and display it as an internal link.

To turn off spacing and linking, use an <opt> tag immediately before a WikiWord.

SpacedWikiWordPluginNextGen Settings

Plugin settings are stored as preferences variables.

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Causes wiki words to be displayed with spaces between capitals.

• Comma-separated list of specific words that will never be spaced out, even embedded within longer WikiWords. Default: TWiki
  • Set SPACEDWIKIWORDPLUGIN_DONTSPACE = TWiki
    Known limitation: Only one DONTSPACE word per WikiWord will be recognized and remain unspaced

• Comma-separated list of skins that will have WikiWords spaced out. Default: twiki
  • Set SPACEDWIKIWORDPLUGIN_SPACESKIN = twiki

Plugin Installation Instructions

To install plugin:

• Copy SpacedWikiWordPlugin.pm to the lib web.
• Create a Plugin topic in the TWiki06x01 web. Copy this text to it.

Plugin Info

Plugin Author:	MartinCleaver, RichardEllery, ColasNahaboo, StefanLindmark
Plugin Version:	09 Jun 2003
Change History:	14 Apr 2002 Initial released version 09 Jun 2003 Updated version without hack to TWiki.pm. Introduced preference variables.
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.0
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SpacedWikiWordPluginNextGen ( TWiki:Plugins/SpacedWikiWordPluginNextGen )
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SpacedWikiWordPluginNextGenDev ( TWiki:Plugins/SpacedWikiWordPluginNextGenDev )

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

-- StefanLindmark - 09 Jun 2003