/[drupal]/contributions/modules/banner/INSTALL.txt
ViewVC logotype

Contents of /contributions/modules/banner/INSTALL.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.8 - (show annotations) (download)
Tue Jan 30 21:53:01 2007 UTC (2 years, 9 months ago) by wulff
Branch: MAIN
CVS Tags: HEAD
Changes since 1.7: +6 -3 lines
File MIME type: text/plain
# 89003 - clearing up installation instructions - thanks sun
# 99861 - URL restricted to 128 characters - thanks sun
#102676 - wrong placeholders used in t() - thanks ac
#102832 - blocks displaying though no banners are available - thanks ac/heine
#109245 - wrong status for week statistics - thanks plumbley
#114165 - no menu item for admin settings page - thanks pebosi
1 Preparation
2 ===========
3
4 1. Go to 'administer -> settings' and configure the file system settings. Make
5 sure that 'Download method' is set to 'Public'.
6
7 2. Go to 'administer -> modules' and enable upload.module if you wish to use
8 uploaded images or text files as banners.
9
10 3. Optional: Download and install scheduler.module if you wish to schedule
11 publishing and unpublishing of your banners.
12
13
14 Installation and configuration
15 ==============================
16
17 1. Copy the banner directory to your Drupal modules directory.
18
19 2. Copy the files 'banner_db.php' and 'banner_file.php' to your site root.
20
21 3. Go to 'administer -> modules' and enable the banner module. The module will
22 automatically create the banner table in the database.
23
24 4. Go to 'administer -> settings -> banner' and configure the banner maodule.
25 At a minimum, you will have to configure the cache and block settings.
26
27 Cache settings: Choose the cache handler you wish to use. The database
28 handler always works and has more advanced taxonomy filtering than the
29 file handler. The file handler is much faster than the database handler.
30
31 Block settings: Choose how many banner blocks the module should provide.
32
33 FIXME: Description of taxonomy filtering
34
35 5. If you don't want new banners to be displayed on the front page with your
36 other nodes, go to 'administer -> settings -> content types -> banner' and
37 uncheck the "Promoted to front page" setting.
38
39 6. Go to 'administer -> access control' and configure the banner permissions.
40 The following permissions are available:
41
42 'administer banners' - users can add/edit/delete all banners on your site
43 'create banners' - users can create and manage banners
44 'view banners' - users can view banners
45
46
47 Create banners
48 ==============
49
50 Banners are just another type of node. Go to 'create content -> banner' to
51 create a new banner.
52
53 The banner module supports four banner modes: Upload, text, JavaScript and
54 remote. The following fields are used by all the modes:
55
56 Title: Shown in admin overviews and when viewing the banner as a node
57 Description: Shown when viewing the banner as a node
58
59 URL: The URL users are taken to when clicking the banner
60 Target: The frame target for the banner URL
61 Status: Set to 'enabled' to publish the banner immediately
62 Group: The banner group the new banner belongs to
63
64 Modes
65 -----
66
67 Upload: Use the upload mode if you want to use an uploaded image or a text file
68 as a banner. Enter the basic banner information and click 'File attachments' on
69 the node edit form. You can add as many files as you wish to your banner, but
70 only the first file on the list will be used. If you are uploading a text file,
71 the text '%url' is replaced by the banner URL (e.g. banner/7) when the banner
72 is displayed.
73
74 Text: Use the text mode if you wish to enter the banner text directly on the
75 node edit form. Enter the banner text in the 'Content' field. The text '%url'
76 is replaced by the banner URL (e.g. banner/7) when the banner is displayed.
77
78 JavaScript: Use the JavaScript mode if you wish to use a piece of JavaScript to
79 display your banner. Enter the JavaScript in the 'Content' field. This won't
80 support Google ads without manual modification of your site template to include
81 Google's JavaScript.
82
83 Remote: Use the remote mode to use a remote image as a banner. Enter the URL of
84 the remote image in the 'Content' field.
85
86
87 Show banners
88 ============
89
90 You can either use the banner blocks provided by the module or create your own.
91 If you need special banner placements, you can modify your theme to insert
92 banners anywhere you want.
93
94 Banner blocks
95 -------------
96
97 1. Go to 'administer -> blocks' and click the 'configure' link next to the
98 'Banner 1' block. (Edit the module settings if you need more banner blocks.)
99 The following settings are available:
100
101 Banner group: Show banners from the selected group
102 Banner group: Show this many different banners from the selected group
103
104 2. Select the placement of the block and enable it.
105
106 If you have more than one banner block, you can use the banner groups to
107 control which banners are displayed in which blocks.
108
109 Theme
110 -----
111
112 Insert a the following PHP code in your template to display banners:
113
114 <?php print banner_display(1, 3) ?>
115
116 The code above will try to display three different banners from the banner
117 group with term ID 1. Each banner will only be shown once for each call to
118 banner_display().
119
120 To show one banner from banner group 1 and one banner from banner group 4,
121 you can use the following PHP code:
122
123 <?php print banner_display(1, 1); print banner_display(4, 1) ?>
124
125 See also online documentation at http://drupal.org/node/51721.
126
127
128 $Id: INSTALL.txt,v 1.7 2006/09/15 11:35:42 wulff Exp $

  ViewVC Help
Powered by ViewVC 1.1.2