Welcome, Registration, and other StartingPoints; Foswiki history & Wiki style; All the docs...
Edit | Attach | New | Raw | Delete | History | Print | Tools
You are here: System » 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: %REDDOT{"<topic1>[,..., <topicN>]" ... }%

Renders a reddot for the given topic. If there are multiple topics topic1, topic2, ...., topicN, then the first target topic that grants write access will be chosen.


  • redirect="<jump-back-topic>": specifies the topic to jump back to after the edit process was completed; defaults to the originating topic where the red dot was on
  • text="...": display text for the edit link; defaults to a dot ( . )
  • style="...": css to be added to the reddot style
  • class="...": css class to be asigned to this reddot
  • grant="...": regular expression to be checked in addition to the implicite access check for write access; reddot only if the grant pattern matches
  • icon="...": name of an icon to be used instead of the display text; icons are searched along the iconsearchpath


The iconsearchpath is specified in the REDDOTPLUGIN_ICONSEARCHPATH preference variable. This is a list of topics that are searched for an icon name, e.g. as given in the icon argument to the %REDDOT tag. If you also installed Foswiki:Extensions/JQueryPlugin, then the icon search path given in JQUERYPLUGIN_ICONSEARCHPATH can be reused instead. If none are defined the icon search path defaults to FamFamFamSilkIcons, FamFamFamSilkCompanion1Icons, FamFamFamFlagIcons, FamFamFamMiniIcons, FamFamFamMintIcons.


The RedDotPlugin respects the WHITEBOARD topic variable. If you add Set WHITEBOARD = off to a target topic text then the reddot link will disable the textarea (whiteboard) in edit mode and jump right into the formfield editor.


Plugin 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.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Plugin Info

Plugin Author: Michael Daum
Copyright ©: 2005-2009, Michael Daum http://michaeldaumconsulting.com
License: GPL (GNU General Public License)
Plugin Version: v2.01
Change History:  
24 Apr 2009: added icon and class argument, converted to foswiki plugin
07 Jan 2009: certified for foswiki/compat
14 Jun 2008: redirecting to the url current url including its current url params
03 Jan 2008: using TWiki-4 APIs to register tags; fixed default values for reddots
18 Sep 2006: don't use private apis; removed endRenderingHandler: this plugin does not work on older core engine releases!; create cgi urls properly
31 Aug 2006: added NO_PREFS_IN_TOPIC
24 Aug 2006: more effort to find out the current cgi action, even when using short urls
28 Jul 2006: added PatternSkin css to really make reddots red
10 Mar 2006: use ENV instead of the CGI object to detect the current cgi action
15 Feb 2006: don't initialize the redirector in scripted mode
14 Feb 2006: fixed redirects to anchors; fixed permission check on old core engine releases; fixed use of uninitialised variables on perl 5.8.8
26 Jan 2006: w3c fixes
01 Dec 2005: fixed deprecation warnings on dakar
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
Dependency: $Foswiki::Plugins::VERSION 1.024
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home: Foswiki:Extensions/RedDotPlugin
Support: Foswiki:Support/RedDotPlugin
Copyright © 2015 Atomikos BVBA. Transaction Management for Extreme Transaction Processing and SOA Environments serving ISV, Commercial, OEM and Open Source Markets
Site map RSS ATOM