RedDotPlugin

Quick-edit links

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.

REDDOT

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.

Arguments:

• 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 (see JQICON)

Examples

• RedDotPlugin%REDDOT% will get a red dot only if you are in the AdminGroup.
• WikiGuest%REDDOT{"Main.WikiGuest"}% points to your homepage.

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. "Extensions Operation and Maintenance" Tab -> "Install, Update or Remove extensions" Tab. Click the "Search for Extensions" button. Enter part of the extension name or description and press search. Select the desired extension(s) and click install. If an extension is already installed, it will not show up in the search results.

You can also install from the shell by running the extension installer as the web server user: (Be sure to run as the webserver user, not as root!)

cd /path/to/foswiki
perl tools/extension_installer <NameOfExtension> 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 https://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Dependencies

Name	Version	Description
Foswiki::Plugins::JQueryPlugin	>=3.7	Required

Change History

26 Jan 2024:	repackaging for newer JQueryPlugin; fixed icon placement
12 Sep 2016:	fixed missing jquery dependency on HoverIntent
13 Oct 2015:	fixed encoding of redirect anchor
05 Mar 2015:	rewrite as a jQuery plugin
13 Mar 2013:	modernizing some parts
11 Nov 2010:	use JQICON instead of own getIconUrl() procedure; adding js to animate the pencil; fixing double quotes in redirectto truncating the list of url params; overhault css not to disturb the rest of the page's flow; removing WHITEBOARD feature as it badly interferes with other ways to manipulate the editor
12 Feb 2010:	shipping minified and compressed files now
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