TIP TopicLockPlugin is not installed on Foswiki.org.


Adds 1-click function to lock down topics.


Put the %TOPICLOCK% macro anywhere in your topic or template. This macro gets expanded to either
  • a link to lock down the topic (read/write access to current user only)
  • a link to unlock the topic
  • a note, that locking down is not allowed

WikiGuest is always forbidden to change the lock state.

This macro takes the following parameters (all are optional):

Parameter Explanation
topic Default is the current topic. You can specify a different topic here.
web Default is current web. You can specify a different topic here.
lockformat Show this, if the topic is not locked and the user is allowed to lock it.
unlockformat Show this, if the topic is locked.
forbiddenlockformat Show this, if the topic is locked elsewhere or the current user is not allowed to set a lock.

The format strings may contain a $url parameter which gets expanded to the locking-url. $percnt, $dollar and $n behave as expected.


%TOPICLOCK{ lockformat="[[$url][Lock this Topic]]" unlockformat="[[$url][Unlock this Topic]]" forbiddenformat="totally forbidden to lock this Topic" }%

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.


Many thanks to the following sponsors for supporting this work:
  • Acknowledge any sponsors here

Author(s): Foswiki:Main.OliverKrueger
Copyright: © 2010 Oliver Krueger, (wiki-one.net)
License: GPL (Gnu General Public License)
Release: 1.1.1
Version: 6675 (2010-03-07)
Change History:  
Dependencies: None
Home page: http://foswiki.org/bin/view/Extensions/TopicLockPlugin
Support: http://foswiki.org/bin/view/Support/TopicLockPlugin

Topic revision: r1 - 07 Mar 2010, OliverKrueger
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy