PurplePluginDev
This plugin adds purple links to all site topics. The generation of anchors in the first version will be dynamic and unstored, the numbers are only for display. A future feature of this plugin is planned to allow the static anchors to be embedded in the pages themselves. Because it's design is to allow granular addressability.
There are three types of addressability possible with Purple.
- purple numbers correspond to Augment's hierarchical address
- NID is Node ID which is supposed to be a static anchor that never changes as content is moved about, changed, deleted, etc. It is designed to be globally assigned for some given namespace.
- label is for HTML a regular anchor.
Source of the software is
http://www.eekim.com/software/purple/ by Eugene Kim and/or
http://www.blueoxen.org/tools/purplewiki/.
Examples
PurplePluginDev Global Settings
Plugin settings are stored as preferences variables. To reference a plugin setting write
%<plugin>_<setting>%
, i.e.
%INTERWIKIPLUGIN_SHORTDESCRIPTION%
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = adds purple anchors and links to all site topics
- Debug plugin: (See output in
data/debug.txt
)
- My own setting:
- Set PURPLEPLUGINENABLE = 1 - a better name for this variable needs to be created.
Plugin Installation Instructions
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
PurplePluginDev.zip
in your twiki installation directory. Content: File: | Description: |
data/TWiki/PurplePluginDev.txt | Plugin topic |
data/TWiki/PurplePluginDev.txt,v | Plugin topic repository |
lib/TWiki/Plugins/PurplePluginDev.pm | Plugin Perl module |
- Set the PURPLEPLUGINENABLE variable in your site wide preferences TWiki.TWikiPreferences.
- Test if the installation was successful by viewing any page.
Plugin Info
Related Topics: TWikiPreferences,
TWikiPlugins
--
TWiki:Main/GrantBow - 20 Jan 2003
Umm. This topic should be renamed to be
PurplePlugin not
PurplePluginDev... Also the USERNAME variables still need to be set.
--
MattWilkie - 20 Jan 2003
-- RD
Richard and Matt, I probably created this topic from the wrong location and used the wrong template. However because this plugin
doesn't exist yet I would like to keep this topic named Dev for right now and just use it as a place to work on the real
PurplePlugin page over time.
--
GrantBow - 20 Jan 2003
OK, perhaps it is a bit unusual to brainstorm in a topic like this but since there's no plugin to install yet and I want to work on the final documentation that will go in the non-dev topic I feel this approach was best. I will have to learn quite a bit before actually doing this plugin myself. Any pointers and suggestions would be most appreciated.
--
GrantBow - 25 Jan 2003