Web Permissions Plugin

This plugin provides a centralised interface to TWiki permissions that are applied on a web level.

The idea is to present web permissions as a matrix that has columns of webs and rows of users. For each web, you can control which users can view or change that web. All user webs, every registered user (except admin users), and every group (except admin groups) are shown in the matrix.

This control model is very useful in cases such as a web per project environment. In this case you will probably want to give team members change access to the specific projects they are working on. The plugin gives you a simple, one page interface, for handling these permissions.

The plugin tries very hard to keep the permissions specification you started with. It reads and writes web preferences topics only. Note that topic level permissions still work as normal.

THIS PLUGIN REQUIRES TWiki-4.0.0 or later

Syntax Rules

The permissions matrix can be viewed (and edited) by entering %WEBPERMISSIONS% anywhere in a topic. You have to have admin rights (be a member of TWikiAdminGroup) to view/edit the matrix.

If you have admin rights and the plugin is installed, you will see the matrix below:

%WEBPERMISSIONS%

Plugin Settings

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = View and edit web permissions

By default, the plugin only supports VIEW and CHANGE permissions on webs. You can change the set of access modes handled by the plugin by defining a configuration variable (in LocalSite.cfg) to be a comma-separated list of access modes. For example,

$TWiki::cfg{Plugins}{WebPermissionsPlugin}{modes} = 'VIEW,CHANGE,RENAME';

Plugin Installation Instructions

Note: These instructions are for the TWiki maintainer. No changes to your browser are required. This plugin makes extensive use of new features added to TWiki in the Feb 2006 release. Earlier versions lack all the features described here. Make sure you install using the zip appropriate to your TWiki installation. For best overall performance, please upgrade your TWiki to the latest released version.

• Download the archive (zip or tgz) from the Plugin web (see below). Contents:

  File:	Description:
  lib/TWiki/Plugins/WebPermissionsPlugin.pm
  data/TWiki/WebPermissionsPlugin.txt
  pub/TWiki/WebPermissionsPlugin/CHANGE.gif
  pub/TWiki/WebPermissionsPlugin/VIEW.gif

• Unpack the archive in your twiki installation directory.
• perl WebPermissionsPlugin_installer.pl to automatically check and install other TWiki modules that this module depends on. This script also includes an uninstaller should you ever wish to remove the plugin from your installation.
• Alternatively, manually make sure the dependencies listed in the table below are resolved.

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

This plugin was developed on behalf of Evolved Media Network

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWikiContributor - 01 Feb 2022