Mercurial > defr > drupal > ad
diff documentation/README.txt @ 1:948362c2a207 ad
update advertisement
author | pierre |
---|---|
date | Thu, 02 Apr 2009 15:28:21 +0000 |
parents | d8a3998dac8e |
children | 416ea999ed76 |
line wrap: on
line diff
--- a/documentation/README.txt Fri Feb 20 14:04:09 2009 +0000 +++ b/documentation/README.txt Thu Apr 02 15:28:21 2009 +0000 @@ -1,20 +1,20 @@ --------- Overview: --------- -The ad module is a powerful advertising system for Drupal-powered websites. It +The ad module is a powerful advertising system for Drupal-powered websites. It supports the random display and tracking of graphical (banner), text and raw -html ads. Ads can easily be displayed in themes, blocks, or embedded in site -content. The module records comprehensive statistics about when and how often +html ads. Ads can easily be displayed in themes, blocks, or embedded in site +content. The module records comprehensive statistics about when and how often ads are viewed and clicked, including a plug-in module for generating graphical -time-based reports. Ads can be assigned to multiple owners, each of which can +time-based reports. Ads can be assigned to multiple owners, each of which can be assigned their own set of permissions. Installation is simple by design. An -API is provided allowing the development of additional functionality and +API is provided allowing the development of additional functionality and integration with other Drupal modules. Features: * auto-generated ad blocks supporting a configurable number of ads * automatically or manually embed ads into site content - * collection of comprehensive statistics allowing time-based reporting and + * collection of comprehensive statistics allowing time-based reporting and analysis * tracking of when and where ads are clicked, by which user and which IP * advertisements can have multiple owners @@ -23,7 +23,7 @@ * an ad_image plug-in for image (aka banner) ads * an ad_text plug-in for simple text ads * an ad_html plug-in for raw html ads - * an externally maintained ad_geoip plug-in provides support for + * an externally maintained ad_geoip plug-in provides support for geotargeting ads * an ad_report plug-in for basic graphical reports * an ad_notify plug-in for scheduling automatic email notifications @@ -83,11 +83,11 @@ Ad groups: ---------- Ads can be organized into groups. For example, you may have a group called - "Text Ads" and another group called "Image Ads." You could then assign your - text ads to the "Text Ads" group, and your image ads to your "Image Ads" - groups. (This is not required, it is perfectly valid to include both image - ads and text ads in the same group.) When displaying ads, you typically tell - the ad module to display ads from a certain group and then the ad module + "Text Ads" and another group called "Image Ads." You could then assign your + text ads to the "Text Ads" group, and your image ads to your "Image Ads" + groups. (This is not required, it is perfectly valid to include both image + ads and text ads in the same group.) When displaying ads, you typically tell + the ad module to display ads from a certain group and then the ad module randomly selects an active ad from the specified group. Each ad can be a member of any number of groups. @@ -97,11 +97,11 @@ is one that has recently been uploaded and is waiting to be approved by a privileged user. An ad in the Approved state is one that has been approved by a privileged user but is not actively being displayed, the ad could be - waiting on an autoactivation event. An ad in the Active state is being - actively displayed. An ad in the Offline state is approved but is currently - not being displayed. An ad in the Unpublished state means that the ad node - was unpublished so the ad is not any longer being displayed. An ad in the - Expired state is no longer being displayed. An ad in the Denied state means + waiting on an autoactivation event. An ad in the Active state is being + actively displayed. An ad in the Offline state is approved but is currently + not being displayed. An ad in the Unpublished state means that the ad node + was unpublished so the ad is not any longer being displayed. An ad in the + Expired state is no longer being displayed. An ad in the Denied state means it was not approved by the site administrator. Scheduling: @@ -118,7 +118,6 @@ If you enter a number into the Maximum Clicks field, the ad will be automatically expired once it has been clicked this number of times. - --------------- Displaying ads: @@ -126,15 +125,15 @@ There are many ways to display ads with the ad module. The simplest way is to enable one of the automatically generated ad blocks. It is also possible to use the ad_embed module to automatically embed ads within your site content. -And you can even display ads from within the PHP of your theme or another +And you can even display ads from within the PHP of your theme or another module. ---------- Ad blocks: ---------- The ad module automatically generates on ad block for every ad group that you - create. For example, if you visit "Administer >> Site building >> Blocks" - you will find a block named "ad group: default". If you enable this block, + create. For example, if you visit "Administer >> Site building >> Blocks" + you will find a block named "ad group: default". If you enable this block, it will display a random ad from all active ads in the default group. You can optionally configure the block to display more than one ad at a time @@ -145,13 +144,13 @@ ------------- If you enabled the ad_embed module, it is possible to embed ads into your site content. To configure the ad_embed module go to "Administer >> Content - Management >> Ads >> Settings >> Embedded ads". + Management >> Ads >> Settings >> Embedded ads". - If you wish to manually embed ads in your content, check the box next to - "Replace ad bracket tags" or "Replace ad comment tags". This will cause the - ad_embed module to replace embedded [[add]] or <!--ad--> tags respectively. + If you wish to manually embed ads in your content, check the box next to + "Replace ad bracket tags" or "Replace ad comment tags". This will cause the + ad_embed module to replace embedded [[add]] or <!--ad--> tags respectively. Instructions on how to specify specific ad groups or even specific ads and - how many ads to display at a time can be found by visiting "Administer >> + how many ads to display at a time can be found by visiting "Administer >> Help >> Embed". If you wish to automatically embed ads in your content, configure this on a @@ -164,7 +163,7 @@ To display an ad from within PHP code, make a call to the ad() function. You can optionally specify an ad group, the number of ads to display, and several other options. For example, to display one random ad from all ads - that have not been assigned to any group you don't have to pass in any + that have not been assigned to any group you don't have to pass in any parameters: <?php print ad(); ?> @@ -177,7 +176,7 @@ assigned to any group. The second parameter specifies the number of ads to display at one time.) - To randomly display an ad from a specific group of nids, for example with + To randomly display an ad from a specific group of nids, for example with the node ID 69 or 76, you would pass in the following parameters: <?php print ad(NULL, 1, array('nids' => '69,76')); ?> @@ -229,11 +228,11 @@ .advertisement:before { content: "Advertisement:"; } - + CSS Example 2: -------------- Here is more sample code that could be added to your theme's custom - style.css. It will cause multiple image ads to be displayed horizontally + style.css. It will cause multiple image ads to be displayed horizontally one beside the other (space permitting), rather than vertically one below the other. The ads are aligned to the left side of the screen, if you'd prefer them to be aligned to the right side of the screen change @@ -265,9 +264,9 @@ in INSTALL.txt to properly install the ad module. In the General section you can specify what happens when an advertisement is - clicked. For example, you can choose to have the resulting Destination URL + clicked. For example, you can choose to have the resulting Destination URL opened in the same browser window, or in a new browser window. You can also - enable the "nofollow" check box causing ads served by the ad module to + enable the "nofollow" check box causing ads served by the ad module to include rel="nofollow" in automatically generated links. You can select to display advertisements using JavaScript, jQuery, IFrames, or Raw HTML. Finally, you can disable URL validation, and enable advertisement filtering. @@ -295,14 +294,14 @@ ---------- Image ads: ---------- - The ad_image module allows you to specify some image constraints on a - per-group basis at "Administer >> Content management >> Ads >> Settings >> + The ad_image module allows you to specify some image constraints on a + per-group basis at "Administer >> Content management >> Ads >> Settings >> Image ads". ------------- Embedded ads: ------------- - Manually and automatically embedded ads can be configured at "Administer >> + Manually and automatically embedded ads can be configured at "Administer >> Content management >> Ads >> Settings >> Embedded ads". @@ -313,6 +312,6 @@ are tracked to an hourly granularity. When an advertisement is first enabled, the statistics for 'This hour', 'Today', -'Last seven days', 'This month', 'This year' and 'All time' will all be the +'Last seven days', 'This month', 'This year' and 'All time' will all be the same. When available, statistics will also include 'Last hour', 'Yesterday', 'Last month', and 'Last year'.