Professional Documents
Culture Documents
Pws WP Ad Manager Manual
Pws WP Ad Manager Manual
License:
Provided you have purchased a copy of this plugin from me, you have the right to use this plugin on
any and all web sites run by you, whether they be clients web sites or your own. You can sell web sites
that you create and use it on. The main thing that you have no right to do is to sell copies of this plugin,
give copies of it away, and/or present it as something that you have created.
Limitations:
If you use this plugin on clients web sites without their buying copies and/or use it on web sites that
you resell without removing the plugin, those who buy sites from you or have them maintained by you
will not get support or updates from me. Nor will they have access to the owners forum. If they want to
be able to get updates directly from me and/or have access to the owners forum and new versions of
this plugin they should buy their own copy.
Thank you!
I hope that you find good value for your money in this plugin. There is a lot that it can do, provided one
takes the time to set things up properly. Without your support, this project would not continue to
improve.
If you are using this plugin and have not picked up a copy, please consider doing so.
Table of Contents
Introduction:...............................................................................................................................................1
Installation:.................................................................................................................................................1
Configuration:............................................................................................................................................3
Setting up Filter Usage..........................................................................................................................3
The Use Header Filter option:......................................................................................................3
The Use Content Filter option:....................................................................................................3
The use Filter On Multi Pages Option:........................................................................................4
Setting up the Coin Types......................................................................................................................4
User Description..........................................................................................................................4
Wrap this Coin Type in a Link.....................................................................................................4
Method for Displaying Coins.......................................................................................................5
Order for Displaying Coins..........................................................................................................5
Method for Limiting Coins..........................................................................................................5
Exclude Current Post or Page from Coin Results........................................................................6
Visual Display Method................................................................................................................6
Text Above Coin List...................................................................................................................6
Text Below Coin List...................................................................................................................6
Style the Coin Lists and Items.....................................................................................................6
Custom Non-Post, Non-Page Coin Options.................................................................................7
Setting up Container Styles...................................................................................................................8
Creating Ads and Content Areas:...............................................................................................................8
Post and Page Related Content and Ads................................................................................................8
Custom Content and Ads.......................................................................................................................9
Placing Ads and Content Areas:.................................................................................................................9
Placement with the Privateer Theme.....................................................................................................9
Placement with other Themes.............................................................................................................10
Using Content Filters for Post and Page Coin Placement..............................................................10
Placing Coins outside of Posts and Pages.......................................................................................10
Using Short Codes to Place Ad and Content Blocks................................................................................11
Basic Short Codes for Default Displays..............................................................................................11
Advanced Short Codes to Override Defaults......................................................................................11
Bugs, Feature Requests, Help, and More.................................................................................................13
Check The Manual.....................................................................................................................13
Check The Forums.....................................................................................................................13
Contact Me.................................................................................................................................13
PWS WP Ad Manager version 1.0 page 1
Introduction:
This plugin is designed to allow one to place content of different types in various places on a
WordPress web site.
By default, there are four different types of content, called “coin types”, which you can use for
whatever type of content you want, provided that the content is processed by the client. ( e.g. you can
place text, html, and javascript, but php and asp will not work properly as of this version ).
When placing content, you can set up the defaults for each content type and then override the
defaults as needed when placing particular content blocks.
A content block consists of one or more pieces of content, presented in a row or column ( or with
rows and columns if you are showing more items than you have set to be allowed in a single row or
column ).
Because I do not define your content types for you, you will need to know a little html and css in
order to make good use of this plugin, but the included copy of my simple html and css manual should
show you everything you need quickly to get excellent results.
Installation:
In order to install this plugin, you will need to first extract the zip archive that it is contained
within...which you have likely done if you are reading this manual. However, in case you are reading
this online or have been sent a copy.
In Windows, you can extract the zip archive by right-clicking on it and selecting one of the
displayed extrac methods.
For the Macintosh, try dragging the zip archive to the suffit expander.
For Linux users...shame on you if you don't know how to open a zip archive! But you should be able
to use the command line unzip utility to do so.
Once extracted, you should see the following files and directories:
• Directory / Folder : pws-wp-ad-manager
• This is the plugin directory that you should upload to the /wp-content/plugins/ folder on
your web server. Alternately, you can zip it up and upload it through the built in plugin
installer in wordpress.
• Zip Archive: pws-wp-ad-manager-widget
• This is a plugin that adds a sidebar widget which can be used to place coin spots in your
side bars or widgetized areas. To use it, extract it and upload the contents to your /wp-
content/plugins directory.
• File: simple-html-and-css.pdf
• A quick guide to the basic html and css knowledge one needs to make reasonably decent
looking web pages. Useful for creating content for use with this plugin.
• File: readme.txt
• Basic information about this plugin
• File: short-codes-info.txt
• A quick reference for short code options and usage
• File: pws-wp-ad-manager.pdf
• This manual.
• File: pwsPageRender.class.php
• If you are using version 1.6 of the Privateer theme, you can upload this to your
/privateer/classes/ folder and overwrite the existing copy of this file to give the theme
native short code support without using any filters.
• Do not use this file with any version of the Privateer theme higher or lower than 1.6!
• File: header.php
• If you are using version 1.6 of the Privateer theme, you can upload this to your
/privateer/ folder and overwrite the existing copy of this file to give the theme native css
support for this plugin.
• Do not use this file with any version of the Privateer theme higher or lower than 1.6!
• File: footer.php
• If you are using version 1.6 of the Privateer theme, you can upload this to your
/privateer/ folder and overwrite the existing copy of this file to give the theme native
shortcode support for this plugin.
To install the plugin, upload the /pws-wp-ad-manager folder to your /wp-content/plugins/ directory
on your server.
Once installed, go to the Plugins – Installed option in your WordPress admin menu and locate the
newly installed plugin. If it does not show up then chances are good that you uploaded the plugin
directory to the wrong location.
Select Activate to turn the plugin on. Doing so will set up the default options for the plugin and
create a new custom table in your wordpress database for use in creating custom content items that are
not associated with particular posts and pages on your site.
Once activated successfully, you should see five new menu items under the normal WordPress Tools
menu in your admin panel:
• AdMan General – Some basic info along with filtering and table cell styling options
• AdMan Coin 1 – Default options setup panel for coin type 1
• AdMan Coin 2 – Default options setup panel for coin type 2
Configuration:
With the plugin installed and activated, it is a good idea to configure it before you start making use
of it. Basic configuration consists of choosing whether or not to use filters and setting up at least one
coin type to show content the way that you want.
User Description
This option is simply to provide those who are creating wordpress posts and pages ( or adding
custom ad spots ) information about what should be placed into this coin type.
It is best to note what kind of item should be placed in this coin type as well as any dimensions that
should be used if you are placing items with widths and heights such as images or banners.
That way, people adding coins can easily see what they should be entering for each coin type.
For horizontal displays, each coin is placed into a single table cell.
You can style the Container Table and Coin Div by using the options in this section. To style the
cells themselves, use the Tools – AdMan General menu.
Note that you use normal css syntax in these options. For example:
• width: 100%; float: right; text-align: center;
• border: 2px solid #880000; padding: 5px;
Coin List Container Style:
• Set styling for the table directly. This is done via css.
Coin List Container Class:
• Set css clases to be used for the table here. You can use multiple class names by placing a space
between them.
Coin Item Style:
• Set styling for the individial divs which contain each coin here.
Coin Item Class:
• Set css classes to be used for each coin item here.
Coin Item Above Text Style
• Set css styles for any text shown above individual content areas.
Coin Item Above Link Style
• Set css styles for links within any text shown above individual content areas.
Coin Item Above Link Hover Style
• Set css styles for the hover state of links within any text shown above individual content areas.
Coin Item Below Text Style
• Set css styles for any text shown below individual content areas.
Coin Item Below Link Style
• Set css styles for links within any text shown below individual content areas.
Coin Item Below Link Hover Style
• Set css styles for the hover state of links within any text shown below individual content areas.
two. You can also set a list of custom coin ids to choose from or tags, categories, and authors to choose
from when picking custom coins.
The Sidebars:
• Inside of any of the Above or Below content areas for each side bar
• Inside of any sidebar, provided you have installed and activated the pws-wp-ad-manager-widget
plugin that is included with this plugin.
The Templates:
• Inside of the Page Kicker, Title, Byline, Above Postlist Area, Below Postlist Area, or Footer
Posts:
• Inside of the body copy area, though not when shown on multi-page templates ( they will
currently be stripped out of individual posts on the home page, search results, and archive
templates )
If you want to be able to place short codes into other areas and own the theme and the plugin, just let
me know and I should be able to make it so.
To display coin type 3, but force it to be displayed vertically with 3 options per column:
• echo pwswpam_getcoin(3, 'dir=vertical|maxperline=3);
If you would rather save the coin block to do place it later, assign the function call to a variable
instead:
• $myCoinBlock = pwswpam_getcoin(1, '');
• order: can be date or random. The order to show coins in once picked.
• limit: how to limit coins. must be idlist (use an id list) or cta ( use category, tag, and author
limiters )
• ids: comma separated list of id values to choose coins from. needed if limit is set to idlist
• cats: comma separated list of category names to choose from. optional and used if limit is cta
• tags: comma separated list of tag slugs to choose from. optional and use if limit is cta
• author: a single author to limit posts to. optional. used if limit is cta
• dir: direction to display lists of coins in. valid values are horizontal and vertical.
• maxperline: maximum number of coins per row or column. exceeding this number causes the
plugin to start a new row or column of plugins
• bstyle: css styling attributes to override or add styling to the table containing the coin list
• bclass: the name of a css class to use
• istyle: css styling attributes to override or add styling to the div containing a coin
• iclass: the name of a css class to use for the div containing each coin
• iabove: css styling attributes to override or add styling to text placed above individual coins
• ibelow: css styling attributes to override or add styling to text placed below individual coins
• above: text or html to be shown above a coin list
• below: text or html to be shown below a coin list
• nocurrent: specify whether to exclude items for the current post or page. Valid values are Yes
( exclude ), No ( include ), and Only ( show only ).
• cuse: whether to use custom coins or not. Valid values are postpage ( don't use custom ), custom
( use only custom ), or both ( use both types of coins )
• cids: a comma separated list of custom coin ids to choose from when showing custom coins.
• ctags: tags to choose from when showing custom coins. Note that these are not wordpress tags,
but simply text entries called tags.
• ccats: categories to choose from when showing custom coins. Note that these are not wordpress
categories, but simply text entries called categories
• cauth: an author to choose form when showing cusotm coins. Note that these are not wordpress
author names, but simply text entries.
• ignore: specify this option with a value of 1 ( ignore=1 ) to include what is found whether or not
it has already been shown and avoid having the items it finds added to the list of items to be
ignored by further content areas.
Contact Me
Provided you have picked up a paid copy of this plugin from me, I'll be happy to help you with
problems that you run into with it. You should have received my email address as part of the package.
Of course, I'm a rather busy guy so please be sure to check the manual and forums before emailing
me about something directly...unless you have just picked up the plugin and are running into technical
problems with it.