modules/hof/README.txt

$Id: README.txt,v 1.2 2005/05/06 22:00:20 syscrusher Exp $

hof.module		Scott Courtney (Drupal ID "syscrusher")
				scott@4th.com  http://4th.com/

License:	GNU General Public License (http://www.gnu.org/)

RELEASE STATE:	This is a BETA RELEASE, not for production use
		This version is for Drupal 5.x only.

HOF, or "Hall of Fame", is a module that provides publicly-visible
summary statistics for a Drupal web site. Rather than providing a lot
of data on a node-by-node basis, which would likely be interesting only
to administrators, this module provides overall site statistics like
how many articles have been published, how long the site has been
online, how many active users are registered, and so on.

In addition to these aggregate statistics, the module can show a list
of the most active contributors, the most popular stories, and other
interesting credits for the past week, the past month, the past year,
and since the site's creation.

This module is extremely configurable by the administrator, and has
extensive explanations and help text in the admin screens.

The module provides the following paths:

	hof		Main Hall of Fame page, by default shows a
			table of contents of the other pages.

	hof/toc		Shows the table of contents regardless of
			administrative settings for the default page.

	hof/all		Shows all available (and permitted) statistics
			in a single page

	hof/site	Shows summary statistics for the whole site

	hof/contrib	Shows the most active contributors

	hof/node	Shows the most popular nodes

	hof/comment	Shows the most active commentors

	hof/bytype	Shows content by node type

	hof/files	Shows uploaded file counts

View the INSTALL.txt file and the online help within the HOF module for
additional details.
1	$Id: README.txt,v 1.2 2005/05/06 22:00:20 syscrusher Exp $
2
3	hof.module Scott Courtney (Drupal ID "syscrusher")
4	scott@4th.com http://4th.com/
5
6	License: GNU General Public License (http://www.gnu.org/)
7
8	RELEASE STATE: This is a BETA RELEASE, not for production use
9	This version is for Drupal 5.x only.
10
11	HOF, or "Hall of Fame", is a module that provides publicly-visible
12	summary statistics for a Drupal web site. Rather than providing a lot
13	of data on a node-by-node basis, which would likely be interesting only
14	to administrators, this module provides overall site statistics like
15	how many articles have been published, how long the site has been
16	online, how many active users are registered, and so on.
17
18	In addition to these aggregate statistics, the module can show a list
19	of the most active contributors, the most popular stories, and other
20	interesting credits for the past week, the past month, the past year,
21	and since the site's creation.
22
23	This module is extremely configurable by the administrator, and has
24	extensive explanations and help text in the admin screens.
25
26	The module provides the following paths:
27
28	hof Main Hall of Fame page, by default shows a
29	table of contents of the other pages.
30
31	hof/toc Shows the table of contents regardless of
32	administrative settings for the default page.
33
34	hof/all Shows all available (and permitted) statistics
35	in a single page
36
37	hof/site Shows summary statistics for the whole site
38
39	hof/contrib Shows the most active contributors
40
41	hof/node Shows the most popular nodes
42
43	hof/comment Shows the most active commentors
44
45	hof/bytype Shows content by node type
46
47	hof/files Shows uploaded file counts
48
49	View the INSTALL.txt file and the online help within the HOF module for
50	additional details.