modules/user_list/README.txt

USER LIST
// $Id: README.txt,v 1.1.2.3 2008/05/06 16:07:28 deekayen Exp $

Authored by Aaron Winborn
Advomatic, LLC
http://www.advomatic.com/
winborn (at) advomatic (dot) com

This module creates several user lists, which may be viewed as pages and
blocks. User lists may be displayed alphabetically, beginning with A-Z,
by newest, or as a list of users who have posted content of a certain
type. Lists may also be displayed by user role.

INSTALLATION:

Simply copy the folder and files into the modules directory. Then go to
Administer > Site building > Modules, and activate the user_list module.

Note that you must enable access with the 'access user lists' permission
to the user listings at /admin/access, which controls viewing both blocks
and pages. If enabled and allowed, the main user listing page may be
viewed at /user_list.

Go to /admin/settings/user_list to change the global settings for user
lists, and to /admin/block to configure specific user listing blocks if
desired. Note that all blocks provided by this module are appended with
"User List:", so they may be differentiated by similar blocks provided by
other modules.

Note: roles with a forward slash / in the name will not work correctly
when trying to navigate to those as a role-based user list and should be
renamed to work. See http://drupal.org/node/104839 for more information.

THEMING:

Two theme functions are available for custom themes. These are
theme('user_list_list'), which controls the actual list of users to
display, and theme('user_list_menu'), which controls the display of the
optional embedded menu on user listing pages. The user lists are in turn
themed with the user.module's theme('user_list'), which may also be
overridden for customization.

API:

If you wish to access a user list view directly from a module, theme, or
php code block, you may directly call _user_list() from your function with
the parameters you desire. The embedded menu may be called directly with
_user_list_embedded_menu().

TODO:

Allow display by profiles or tables
Integrate profile fields into table views
Add access perms per user list

1	USER LIST
2	// $Id: README.txt,v 1.1.2.3 2008/05/06 16:07:28 deekayen Exp $
3
4	Authored by Aaron Winborn
5	Advomatic, LLC
6	http://www.advomatic.com/
7	winborn (at) advomatic (dot) com
8
9	This module creates several user lists, which may be viewed as pages and
10	blocks. User lists may be displayed alphabetically, beginning with A-Z,
11	by newest, or as a list of users who have posted content of a certain
12	type. Lists may also be displayed by user role.
13
14	INSTALLATION:
15
16	Simply copy the folder and files into the modules directory. Then go to
17	Administer > Site building > Modules, and activate the user_list module.
18
19	Note that you must enable access with the 'access user lists' permission
20	to the user listings at /admin/access, which controls viewing both blocks
21	and pages. If enabled and allowed, the main user listing page may be
22	viewed at /user_list.
23
24	Go to /admin/settings/user_list to change the global settings for user
25	lists, and to /admin/block to configure specific user listing blocks if
26	desired. Note that all blocks provided by this module are appended with
27	"User List:", so they may be differentiated by similar blocks provided by
28	other modules.
29
30	Note: roles with a forward slash / in the name will not work correctly
31	when trying to navigate to those as a role-based user list and should be
32	renamed to work. See http://drupal.org/node/104839 for more information.
33
34	THEMING:
35
36	Two theme functions are available for custom themes. These are
37	theme('user_list_list'), which controls the actual list of users to
38	display, and theme('user_list_menu'), which controls the display of the
39	optional embedded menu on user listing pages. The user lists are in turn
40	themed with the user.module's theme('user_list'), which may also be
41	overridden for customization.
42
43	API:
44
45	If you wish to access a user list view directly from a module, theme, or
46	php code block, you may directly call _user_list() from your function with
47	the parameters you desire. The embedded menu may be called directly with
48	_user_list_embedded_menu().
49
50	TODO:
51
52	Allow display by profiles or tables
53	Integrate profile fields into table views
54	Add access perms per user list
55