====== groupmatrix Plugin ======

---- plugin ----
description: Configurable listing of DokuWiki users and their group memberships
author     : Anna Dabrowska
email      : dokuwiki@cosmocode.de
type       : syntax
lastupdate : 2021-01-10
compatible : Greebo, Hogfather
depends    : 
conflicts  : 
similar    : groupusers
tags       : groups, listing, users

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-groupmatrix/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-groupmatrix/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-groupmatrix/
donationurl: 

screenshot_img : plugin:groupmatrix1.png
----

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

This plugin outputs a matrix of members and groups to visualize memberships.

===== Installation =====

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

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

The simplest syntax looks like this. It will simply list the members of the given groups and indicate who is member of which group.

<code>
---- groupmatrix ----
groups: groupa, groupb, groupc
----
</code>

The result looks like this:

{{:plugin:groupmatrix1.png}}

Additionally you can specify which user Attributes you want to see and define labels for the different groups:

<code>
---- groupmatrix ----
groups: groupa, groupb, groupc
attributes: name, mail
titles: Read, Write, Approve 
----
</code>

{{:plugin:groupmatrix2.png}}

For attributes you can use the following ones by default:

  * ''user'' - The login name of the user
  * ''name'' - The full name of the user
  * ''mail'' - The email address of the user

Your auth backend may provide additional attributes that you can access here (e.g. telephone numbers).

It is possible to customize the labels of the attributes (displayed in the table header) via DokuWiki's [[:localization|localization mechanism]]. Take a look at the ''lang.php'' files included with the plugin for pointers.

===== Changleog =====

{{rss>https://github.com/cosmocode/dokuwiki-plugin-groupmatrix/commits/master.atom date}}

===== Releases =====

{{rss>https://github.com/cosmocode/dokuwiki-plugin-groupmatrix/releases.atom description author}}