EscapeStudiosPlugin
Display user friendly Topic names for underscore based Topics
This Plugin will improve usability by stripping and substituting characters from certain topic names when shown in the interface.
It also modifies the Specification for a
WikiWord, adding
_ and
- for any character except the last.
Included in this package is also the
EscapeStudiosSkin, providing a completely customised look and feel.
This processing will occur in the following areas of TWiki
- Tag search results display.
- Text search results display.
- Bread crumbs
If the link is specified using the
syntax, then the displayed result will not be changed by this plugin.
To create an EscapeStudios topicname rendering equivalent for Search results, a new TWikiTag
ESCAPETOPICLINK has been adding to this plugin.
There is only one parameter to
ESCAPETOPICLINK, the default one - that specifies a Topic that you want to ensure is passed to this Plugins topicname parser, and then force the creation of a topic link
added Permissions IF Variable
USERHASCHANGEPERMISSION{then="" else=""} is used to hide the topic actions from users that do not have change permssions to that topic or web.
Notes and Warnings
Because this Plugin modifies the definition of
{wikiWordRegex}, it cannot be used with another plugin that also modifies it.
This plugin also over-rides the following topics in the TWiki Release and the
TagMePlugin, which means it must be installed
last.
Processing
IF topic starts with =_=
then remove the first 6 chars from the string
Else
Change =-= and =_= from display topic to spaces
Note: Topics not containing =_= will not be processed
Test data
The
EscapeStudiosSkin uses this plugin's functionality nativlely. You can enable it by adding the following to the
TWikiPreferences topic
* Set SKIN=escape
optional backwards compatible Usage (with pattern skin)
To gain the full benefits of this Plugin you must add the escapestudios skin to the begining of the SKIN path. You can do this by adding the following to the
TWikiPreferences topic
* Set <nop>SKIN=escapestudios,pattern
Installation Instructions
You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.
Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.
- If you have TWiki 4.1 or later, you can install from the
configure interface (Go to Plugins->Find More Extensions)
- The webserver user has to have permission to write to all areas of your installation for this to work.
- If you have a permanent connection to the internet, you are recommended to use the automatic installer script
- Just download the
EscapeStudiosPlugin_installer perl script and run it.
- Notes:
- The installer script will:
- Automatically resolve dependencies,
- Copy files into the right places in your local install (even if you have renamed data directories),
- check in new versions of any installed files that have existing RCS histories files in your existing install (such as topics).
- If the $TWIKI_PACKAGES environment variable is set to point to a directory, the installer will try to get archives from there. Otherwise it will try to download from twiki.org or cpan.org, as appropriate.
- (Developers only: the script will look for twikiplugins/EscapeStudiosPlugin/EscapeStudiosPlugin.tgz before downloading from TWiki.org)
- If you don't have a permanent connection, you can still use the automatic installer, by downloading all required TWiki archives to a local directory.
- Point the environment variable
$TWIKI_PACKAGES to this directory, and the installer script will look there first for required TWiki packages.
-
$TWIKI_PACKAGES is actually a path; you can list several directories separated by :
- If you are behind a firewall that blocks access to CPAN, you can pre-install the required CPAN libraries, as described at http://twiki.org/cgi-bin/view/TWiki/HowToInstallCpanModules
- If you don't want to use the installer script, or have problems on your platform (e.g. you don't have Perl 5.8), then you can still install manually:
- Download and unpack one of the
.zip or .tgz archives to a temporary directory.
- Manually copy the contents across to the relevant places in your TWiki installation.
- Check in any installed files that have existing
,v files in your existing install (take care not to lock the files when you check in)
- Manually edit LocalSite.cfg to set any configuration variables.
- Run
configure and enable the module, if it is a plugin.
- Repeat from step 1 for any missing dependencies.
Plugin Info
