modules/banner/README.txt

Overview
--------
The banner.module allows you to display ads on your Drupal website. It
randomly displays the banners, and automatically tracks how many times each
is displayed and clicked.

Users of your website can be given ownership of banners, and be allowed to
modify certain settings and view statistics.


Requirements
------------
Drupal 4.7.x
PHP 4.3.3 or greater


Features
--------
 - Administrative features:
   o Supports many image types, flash animations, and text-based ads
   o Supports displaying multiple banners on one page
   o Supports scheduling when a banner is auto-enabled/disabled
   o Provides 'chance' mechanism to increase odds a given banner is displayed
   o Banners can be categorized with taxonomy
   o Counts banner views/clicks
   o Provides overview page w/ statistics
   o Limit banner views and/or clicks (then auto-disable)
   o Permissions (not view banners, administer, user edit)
   o Provides filecaching for optimal performance
   o Utilizes javascript to rotate banners on cached pages
   o Multiple banner status, only 'enabled' are displayed.
     (Others: disabled, blocked, pending, day limit reached, etc...)
   o Must approve user-uploaded banners
   o Can customize daily/weekly banner notification emails
   o Can send automatic renewal reminder for ads soon to expire

 - User features:
   o Can view/edit own banners if have 'manage banners' permission
   o Can view/edit all banners if have 'administer banners' permission
   o Can upload new banners in 'pending' state
   o Can manually enable/disable administratively approved banners
   o Provides daily banner statistics (views, clicks, %)
   o Can limit maximum daily views for each banner
   o Can enable daily notification email
   o Provides weekly banner statistics (views, clicks, %)
   o Can limit maximum weekly views for each banner
   o Can enable weekly notification email


Installation
------------
Please refer to the INSTALL.txt file for installation directions.


Banner publishing status
------------------------

Banner workflow     Published
-----------------------------
BANNER_PENDING      No
BANNER_ENABLED      Yes
BANNER_DAY_LIMIT    Yes
BANNER_WEEK_LIMIT   Yes
BANNER_DISABLED     Yes
BANNER_BLOCKED      Yes
BANNER_DENIED       No


Todo
----

Docs: PHP has trouble determining dimensions of .swf files if the Flash version
used is later than MX. (Thanks to Liktor Tibor for looking into this.) This
means that width and height fields should be editable by the banner owner.


FAQ
---

Q. I don't see any images. What's wrong?
A. Be sure you installed 'banner_db_php' and 'banner_file.php', and
   properly set the permissions on these files so they can be read
   by your webserver. (See step 2 under installation and configuration above)

   Alternatively, you may have to add the correct path to magic.mime to your
   php.ini file, e.g.:

   mime_magic.magicfile = "/usr/share/misc/file/magic.mime"

Q. I did install the files correctly, but I still don't see any images.
   What's wrong?
A. Try refreshing the banner cache.
   Go to: 'administer -> banner -> refresh cache'

Q. I've refreshed my cache, but I'm still not seeing images. What's wrong?
A. Edit the banner and be sure that the MIME type was properly detected. Go
   to:
      administer -> banner -> list
   then click 'edit' next to problematic banner. At the bottom of the page
   you can update the MIME type.


Credits
-------
 - Original author: Marco Molonari
 - Previous maintainer: Jeremy Andrews
 - Current maintainer: Morten Wulff


Bugs and Suggestions
--------------------
Bug reports, support requests, feature requests, etc, should be posted to
banner module project page:

http://drupal.org/project/banner


$Id: README.txt,v 1.8 2006/06/28 15:07:25 wulff Exp $
1	Overview
2	--------
3	The banner.module allows you to display ads on your Drupal website. It
4	randomly displays the banners, and automatically tracks how many times each
5	is displayed and clicked.
6
7	Users of your website can be given ownership of banners, and be allowed to
8	modify certain settings and view statistics.
9
10
11	Requirements
12	------------
13	Drupal 4.7.x
14	PHP 4.3.3 or greater
15
16
17	Features
18	--------
19	- Administrative features:
20	o Supports many image types, flash animations, and text-based ads
21	o Supports displaying multiple banners on one page
22	o Supports scheduling when a banner is auto-enabled/disabled
23	o Provides 'chance' mechanism to increase odds a given banner is displayed
24	o Banners can be categorized with taxonomy
25	o Counts banner views/clicks
26	o Provides overview page w/ statistics
27	o Limit banner views and/or clicks (then auto-disable)
28	o Permissions (not view banners, administer, user edit)
29	o Provides filecaching for optimal performance
30	o Utilizes javascript to rotate banners on cached pages
31	o Multiple banner status, only 'enabled' are displayed.
32	(Others: disabled, blocked, pending, day limit reached, etc...)
33	o Must approve user-uploaded banners
34	o Can customize daily/weekly banner notification emails
35	o Can send automatic renewal reminder for ads soon to expire
36
37	- User features:
38	o Can view/edit own banners if have 'manage banners' permission
39	o Can view/edit all banners if have 'administer banners' permission
40	o Can upload new banners in 'pending' state
41	o Can manually enable/disable administratively approved banners
42	o Provides daily banner statistics (views, clicks, %)
43	o Can limit maximum daily views for each banner
44	o Can enable daily notification email
45	o Provides weekly banner statistics (views, clicks, %)
46	o Can limit maximum weekly views for each banner
47	o Can enable weekly notification email
48
49
50	Installation
51	------------
52	Please refer to the INSTALL.txt file for installation directions.
53
54
55
56	Banner publishing status
57	------------------------
58
59	Banner workflow Published
60	-----------------------------
61	BANNER_PENDING No
62	BANNER_ENABLED Yes
63	BANNER_DAY_LIMIT Yes
64	BANNER_WEEK_LIMIT Yes
65	BANNER_DISABLED Yes
66	BANNER_BLOCKED Yes
67	BANNER_DENIED No
68
69
70	Todo
71	----
72
73	Docs: PHP has trouble determining dimensions of .swf files if the Flash version
74	used is later than MX. (Thanks to Liktor Tibor for looking into this.) This
75	means that width and height fields should be editable by the banner owner.
76
77
78	FAQ
79	---
80
81	Q. I don't see any images. What's wrong?
82	A. Be sure you installed 'banner_db_php' and 'banner_file.php', and
83	properly set the permissions on these files so they can be read
84	by your webserver. (See step 2 under installation and configuration above)
85
86	Alternatively, you may have to add the correct path to magic.mime to your
87	php.ini file, e.g.:
88
89	mime_magic.magicfile = "/usr/share/misc/file/magic.mime"
90
91	Q. I did install the files correctly, but I still don't see any images.
92	What's wrong?
93	A. Try refreshing the banner cache.
94	Go to: 'administer -> banner -> refresh cache'
95
96	Q. I've refreshed my cache, but I'm still not seeing images. What's wrong?
97	A. Edit the banner and be sure that the MIME type was properly detected. Go
98	to:
99	administer -> banner -> list
100	then click 'edit' next to problematic banner. At the bottom of the page
101	you can update the MIME type.
102
103
104	Credits
105	-------
106	- Original author: Marco Molonari
107	- Previous maintainer: Jeremy Andrews
108	- Current maintainer: Morten Wulff
109
110
111	Bugs and Suggestions
112	--------------------
113	Bug reports, support requests, feature requests, etc, should be posted to
114	banner module project page:
115
116	http://drupal.org/project/banner
117
118
119	$Id: README.txt,v 1.8 2006/06/28 15:07:25 wulff Exp $