README
1GROUPMANAGER
2========
3
4GROUPMANAGER is based on the original plugin GROUPMGR by Alex Forencich. This plugin has
5not been updated since 2010. It actually even never left the devel-zone, but the idea is
6great!
7
8GROUPMGR already allowed easy modification of group membership by non-admins.
9This greatly simplified management of collaborative projects by group-admins.
10
11GROUPMANAGER adds in functionality from the usermanager by Christopher Smith. This way
12existing users can easily be found and added to groups in Wikis with many users.
13Groupmanager may also enable group-admins to add and delete users independently from a
14super user, if these users belong to the groups they administer.
15
16GROUPMANAGER has been designed with a certain scenario and setup in mind.
17This scenario is helpful to make Groupmanager a workable solution.
18That's why it is worked out at https://www.dokuwiki.org/plugin:groupmanager in more detail.
19
20Installation
21------------
22
23Unzip into lib/plugins directory
24
25=====Syntax=====
26
27<code>~~groupmanager|[groups to manage]|[allowed users and groups]~~</code>
28
29Groups to manage separated by commas; the first group in the list will be the default group.
30
31**Be careful**:
32Use ''~~groupmanager~~'' in lowercase letters; ''~~GROUPMANAGER~~'' may not work!
33
34==== Example 1 ====
35
36<code>~~groupmanager|wg_mygroup_reader|@wg_mygroup_admin~~</code>
37
38Members of group ‘ wg_mygroup_reader ‘ can be managed by group ‘ wg_mygroup_admin ‘
39
40==== Example 2 ====
41
42<code>~~groupmanager|wg_mygroup_reader, wg_mygroup_editor|harald, @admin~~</code>
43
44Members of ‘ wg_mygroup_reader ‘ and ‘ wg_mygroup_editor ‘ can be managed by user ‘harald’ and members of the group ‘admin’
45
46
47REMARKS
48-------
491. In the examples above groups managed by groupmanager are named following the naming
50 convention “wg_[groupname]_[role]”. This is not required by the syntax, but I would
51 advise it nevertheless. (Side note: The interface beautifies the name of groups for
52 simple users a bit by deleting the prefix “wg_”, replacing “_” with ” ” and
53 capitalizing the first letter of the resulting words.)
542. Super user groups can only be managed by super users
553. Group-admins may assign the group-admin role to other users!
564. But: users cannot remove themselves from the group that grants them access to the
57 group admin (including admins)
585. The conf_namespace option specifies a separate namespace for configuration.
59 When the config namespace is used, a placeholder tag (~~groupmanager~~) can be used
60 in the actual page while the full tag is placed in the configuration namespace at
61 config_namespace:ID.
626. If require_conf_namespace is set, all configuration options placed in the page
63 are ignored, necessitating the use of the configuration namespace. For security
64 reasons, this is the default configuration.
657. The “forbidden_groups” configuration setting specifies groups that cannot be
66 edited with the plugin (only relevant if conf_namespace is not configured).
678. If allow_add_user is set, a dialog will be present in the interface that will
68 allow users to be added to the Wiki. They will be automatically added to the
69 “default” group, which is the first managed group (wg_mygroup_reader in the example).
709. If allow_delete_user is set, checkboxes will be added to each user-record.
71 Clicking on “update group” will delete checked users.
72