diff documentation/README.txt @ 7:6aeff3329e01 ad

maj module ad 2.1rc1
author piotre
date Mon, 20 Jul 2009 13:54:40 +0000
parents 416ea999ed76
children 32c1a7d9e1fa
line wrap: on
line diff
--- a/documentation/README.txt	Thu May 28 14:53:07 2009 +0000
+++ b/documentation/README.txt	Mon Jul 20 13:54:40 2009 +0000
@@ -52,7 +52,7 @@
 advertisements by visiting 'create content' on your website and choosing
 'advertisement' as the content type.  If you have enabled multiple ad type
 modules, you can select one of them from the resulting menu, such as 'image
-advertiesment' or 'text advertisement'.
+advertisement' or 'text advertisement'.
 
   Text ads:
   ---------
@@ -261,31 +261,45 @@
   least one time as the ad module will perform a series of sanity tests when
   you visit this page, alerting you to any installation problems.
 
-  This page begins by displaying the path to serve.php.  If you see an error
-  here, then the ad module is not properly installed.  Review the directions
-  in INSTALL.txt to properly install the ad module.
+  This page is divided into sections.  The "Status" section validates that the 
+  module can find the necessary scripts for serving advertisements.  If 
+  everything is properly installed, it will show you the automatically detected
+  paths to serve.ph and adserve.inc.  If you instead see errors in this section,
+  review the directions in INSTALL.txt to get the ad module properly installed.
 
-  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
-  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
-  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.
+  In the "General" section you can configure what happens when an advertisement
+  is clicked by setting the 'Click-through target'.  You can also enable the
+  'nofollow' option to add 'rel="nofollow"' to all links generated by the ad
+  module.  The 'Display type' allows you to alter how advertisements are 
+  displayed, using JavaScript, jQuery, IFrames, or simply embedding raw HTML
+  into your page.  Regardless of the 'Display type' the ad module will
+  accurately track how many times each advertisement is displayed and clicked.
+  Finally, the 'Validate URLs' option tells the module whether or not it
+  should use Drupal's built in URL validation logic to ensure that the
+  Destination URL for new advertisements is a valid URL.
 
-  Checking 'Filter ads' allows you to apply Drupal's standard input filters
-  to your advertisements.  If you enable this option, be sure to apply a
-  compatible filter that doesn't strip away the <div> and other tags used by
-  the various advertisement types.
+  In the "Search" section there are two options which are enabled by default.
+  The first causes advertisements to be removed from local searches when using
+  Drupal's built in search module.  The second causes advertisements to be
+  removed from remote search engines by adding the "noindex" meta tag to all
+  pages where node ads are displayed.  If you publish advertisement nodes to
+  the front page mixed in with other content types, you should probably
+  disable the "Remove ads from remote search engines" option as otherwise
+  you may find that your entire website is removed from all search engines.
+  (Note that displaying ads on the front page is not the same as displaying
+  an ad node on the front page. The 'noindex' tag is not added when ads are
+  displayed via blocks, direct calls to ad(), using views, or when embedded
+  with the ad_embed module.)
 
-  The next section allows you to configure IFrames, if you are using them to
-  display advertisements.
+  The "IFrame" section allows you to configure the size of IFrames and other
+  related settings.
 
-  For better performance, you can also enable a cache.  At this time there is
-  only a file cache available.  When the file cache is enabled, ads are quickly
-  displayed from a cache file without bootstrapping Drupal.  On very busy
-  websites you may need to increase the number of cache files to prevent
-  cache file contention.
+  The "Cache" section provides access to the configuration options for any
+  enabled ad caching modules.  By default the ad module comes with the
+  file cache which allows advertisements to be quickly and efficiently displayed
+  from a cache file without bootstrapping Drupal.  If your website utilizes
+  multiple web servers, you should instead download the ad_memcache module
+  which allows you to serve advertisements from a shared memcache instance.
 
   ---------
   Text ads: