RedDotPlugin < System

<!--

   PLEASE DO NOT EDIT THIS TOPIC

   It is automatically generated from the subversion repository, and any changes
   you make will simply be overwritten the next time a release is generated.

   Instead, you could check your fix in, raise a bug in the Bugs web, or mail the author(s).
-->
---+!! %TOPIC%

This plugin renders a clickable red dot (<a style="color:red; font-weight:bold; padding-left:2px; padding-right:2px; line-height:100%; font-size:18px; text-decoration:none" href="%SCRIPTURLPATH{"edit"}%/%WEB%/%TOPIC%?t=%SERVERTIME{"$year$mo$day$min$sec"}%">.</a>) 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.

%TOC%

---++ REDDOT
Syntax: =%<nop>REDDOT{"&lt;topic1>[,..., &lt;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="&lt;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_

---++ 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=.

---++ WHITEBOARD
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.

---++ Examples
   * %TOPIC%%REDDOT%  will get a red dot only if you are in the 
     %USERSWEB%.AdminGroup.
   * %WIKIUSERNAME%%REDDOT{"%WIKIUSERNAME%"}% points to your homepage.

---++ 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
<!-- provided for compatibility only
   * Set SHORTDESCRIPTION = Renders edit-links as little red dots
-->


|  Plugin Author: | Michael Daum |
|  Copyright &copy;: | 2005-2010, Michael Daum http://michaeldaumconsulting.com |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Release: | 2.02 |
|  Version: | 6369 (2010-02-16) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  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 <nop>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 |
|  Plugin Home: | Foswiki:Extensions/%TOPIC% |
|  Support: | Foswiki:Support/%TOPIC% |
Topic attachments
I	Attachment	Action	Size	Date	Who
EXT	Makefile	manage	0.1 K	16 Feb 2010 - 13:16	AdminUser
css	styles.css	manage	0.4 K	16 Feb 2010 - 13:16	AdminUser
gz	styles.css.gz	manage	0.2 K	16 Feb 2010 - 13:16	AdminUser
css	styles.uncompressed.css	manage	0.5 K	16 Feb 2010 - 13:16	AdminUser
This topic: System > RedDotPlugin
Topic revision: 12 Oct 2010, AdminUser (raw view)
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback