[[PageOutline(2-5,Contents,pullout)]]

= Manage user groups in configuration file

{{{#!box info
'''Notice''': there are plans to integrate the functionality of this plugin into AccountManagerPlugin.
}}}

== Description

This an editor with drop down lists to edit the ht groups file for a project. It uses the Genshi templating engine.

It is a companion plugin to the FineGrainedPageAuthzEditorPlugin.

'''Fork:''' I have made a [https://github.com/trac-hacks/trac-htgroupeditor fork on GitHub] with some improvements and fixes. Feel free to [https://github.com/trac-hacks/trac-htgroupeditor/issues suggest new enhancements and fixes]. Install with `pip install HtGroupEditorPlugin`.

[[Image(grp_edit_screenshot.png)]].

=== File Locations

This plugin tries to find the names of the files it has to work with from the config object that reads them in from the normal config file for a Trac project. They may be specified in a project specific file or an inherited one.

The list of users are obtained from the account_manager object, that will read them from one of its password stores. See AccountManagerPlugin documentation for the appropriate configuration options.

For the group file it is looked for under the account-manager section and the name group_file. If this fails it then looks under the htgroups section.

== Bugs/Feature Requests

Existing bugs and feature requests for HtGroupEditorPlugin are 
[report:9?COMPONENT=HtGroupEditorPlugin here].

If you have any issues, create a 
[/newticket?component=HtGroupEditorPlugin new ticket].

[[TicketQuery(component=HtGroupEditorPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:htgroupeditorplugin here].

== Source

You can check out HtGroupEditorPlugin from [/svn/htgroupeditorplugin here] using Subversion, or [source:htgroupeditorplugin browse the source] with Trac.

== Installation

It uses the following additional module which may require installation: !ConfigObj from [http://www.voidspace.org.uk/python/configobj.html#introduction]

Install in the normal way with `python setup.py install`.

== Configuration

To configure the file locations, add the following to your `trac.ini` file:
{{{#!ini
[account-manager]
group_file = /some/project/directory/groups
}}}

or

{{{#!ini
[htgroups]
group_file = /some/project/directory/groups
}}}

== Recent Changes

[[ChangeLog(htgroupeditorplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:robert_martin] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''