====== aclinfo Plugin ======

---- plugin ----
description: Shows who has which permissions for the current page
author     : Andreas Gohr
email      : dokuwiki@cosmocode.de
type       : syntax
lastupdate : 2020-10-01
compatible : Binky, Hogfather, Jack Jackrum
depends    : 
conflicts  : 
similar    : permissioninfo, aclauditor
tags       : acl, sidebar

downloadurl: https://github.com/cosmocode/aclinfo/zipball/master
sourcerepo : https://github.com/cosmocode/aclinfo/
bugtracker : https://github.com/cosmocode/aclinfo/issues
----

This plugin displays all users and groups that are set up in [[:ACLs]] and are affecting the current page. Effectively the plugin gives you a hint who can do what on the current page. It is written with sidebar templates in mind and will always show the permissions of the main page not of the sidebar page.

:!: When used in a sidebar, you need to use the ''[[::caching|~~NOCACHE~~]]'' macro to make this plugin work correctly.

===== Download and Installation =====

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Syntax and Usage =====

Simply put the following code into your page (e.g. your sidebar page):

  ~~ACLINFO~~

To check a specific page, add it separated by a ! character:

  ~~ACLINFO!some:page~~


===== User Comments =====

==== No proper function without "~~NOCACHE~~" ====

Even when not using this plugin in a sidebar (as mentioned for basic using) you should combine it - in production environments - with ''[[::caching|~~NOCACHE~~]]'' - otherwise you will run in effects due to ACL infos from cache, but not from the current (-ly changed) ACL table, which may consume your time hunting "ghost errors". - reported for DokuWiki 2010-11-07a "Anteater", plugin version with self-info in plugin manager as 2010-06-12, should be obviously that one stated here as "Last updated on 2008-12-26"; detail: in preview mode it seems you have always a non-cached view, so you may see effects of "missing" NOCACHE only after saving a page. //---hh 29/5/11//

==== Suggestions ====

It would be nice to control the display style with a simple trigger for "show comma separated inline instead of unordered list items" (avoiding user-side "adjustments" at plugin´s  code level :-x). --hh 29/5/11