RedDotPlugin

This plugin renders a clickable red dot (.) to ease the edit access to a page. The red dot will only be visible if the current wikiuser has write access to the page the dot points to. You might also specify a list of topics (see syntax), where the first topic that grants write access will be the target when you click on the red dot. After finishing an edit initiated by a red dot you will be redirected to the topic where the red dot was on, or any other topic that you specify. Note, however, that you need to enable cookies in your browser.

Syntax Rules

Tag Description
%REDDOT{"<topic1>[,..., <topicN>]" ... }% reddot the first target topic that grants write access;
Arguments:
  • redirect="...":
    jump back to a given topic after the edit process was completed; defaults to the originating topic where the red dot was on
  • text="...":
    use this text to create the edit link; defaults to a dot ( . )
  • style="...": css to be added to the reddot style
  • grant="...":
    regular expression to be checked in addition to the implicite check for write access to the target topic; reddot only if the grant matches

Furthermore, the RedDotPlugin respects the WHITEBOARD topic variable. If you add
   * Set WHITEBOARD = on
to a target topic text then the reddot link will disable the textarea (whiteboard) in edit mode. Note, however, that this feature only works on a TWiki/Dakar engine.

Examples

RedDotPlugin Global Settings

  • Set SHORTDESCRIPTION = Renders edit-links as little red dots

Plugin Installation Instructions

  • Download the ZIP file from the Plugin web (see below)
  • Unzip RedDotPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/RedDotPlugin.txt Plugin topic
    lib/TWiki/Plugins/RedDotPlugin.pm Plugin Perl module
  • (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

Plugin Author: TWiki:Main.MichaelDaum
Plugin Version: v1.28, 09 Nov 2005
Change History:  
09 Nov 2005: fix use of uninitialized variable
12 Oct 2005: don't overwrite a system oops redirect, e.g. if a mandatory formfield is missing
27 Sep 2005: added forgotten style.css; added support to redirect a save
23 Sep 2005: added text, style, grant and WHITEBOARD feature
19 Sep 2005: added redirect-to-origin feature
22 Aug 2005: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.024
CPAN Dependencies: none
Other Dependencies: TWiki:Plugins/SessionPlugin (not needed on TWiki/Dakar)
Perl Version: 5.005
License: GPL (GNU General Public License)
TWiki:Plugins/Benchmark: GoodStyle nn%, FormattedSearch nn%, RedDotPlugin nn%
Plugin Home: TWiki:Plugins/RedDotPlugin
Feedback: TWiki:Plugins/RedDotPluginDev
Appraisal: TWiki:Plugins/RedDotPluginAppraisal

-- TWiki:Main.MichaelDaum - 09 Nov 2005

Navigation

%IFSKINSTATETHEN{searchbox="pos2"}%

%FISKINSTATE%
%MYSIDEBAR%

 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback