User Documentation

When you have enabled Banners feature from the Admin (Admin home) -> Features you will see a link to admin banners in the admin menu (Admin -> Banners). This will take you to the banner administration screen.

insert graphic

If you have permission to admin banners this screen will show you all the banners in the system with options to edit/remove/view each one. If you are a regular use this screen will display your banners with an option to view the banner stats for each one.

Note: There s no link in the main menu to the banner listing, you may want to provide your banner clients with a link to the banner listing screen by email or other method. (May be we should add a link in the main menu if the user is a client and has some active banner in a next version)

Since we won t have any banners initially let s click in the create banner link at below Banners to create a new banner.

Creating and editing banners

insert graphic

This is the form to create or edit banners, it s quite big so we are going to examine each section in detail to explain how to create different banners:
insert graphic

In the first panel you have to indicate the URL where the banner will link, you have to select a client for the banner and you have to indicate the maximum number of impressions for the banner and the zone where the banner will be used. If you have no zones you can create a zone using the create zone field and button on the right side.

What are zones?

Zones are sections of your site where banners will be displayed, for example we may want to set-up 3 different banners in our site, a normal 480x60 banner at the top of the screen, a text add in a user-module box and some button-like banner at the footer. Since we don t want a 480x60 banner being displayed in the textadd box we should set-up three different banner zones. You can name zones as yoou want, if you will only use normal/regular 480x60 banners at the top create a zone with any name and assign all your banners to that zone.

Later when displaying a banner in a Tiki template the syntax will make us indicate which zone will be used in that position.

For example create a zone textadd that will be used to put some textadds on the right side bar. After creating the zone you will be able to select the zone in the drop down.

Let's examine the next panel

insert graphic

This box can be used to limit the banner lifetime to certain dates, you should enter when the banner will start to be active and when it will stop and check the use dates checkbox in the panel. If use dates is not checked the banner will be active until it has run out of impressions (using the maximum number of impressions in the previous box). If use dates is acti ve the banner will stop if it runs out of impressions or if the current date is not between the dates in this box. This panel is useful, for example to create a special banner for the holidays or a special date.

insert graphic

In this box you should select the hours when the banner will be active, for example you may want a banner to be displayed only at night or a banner to be displayed between 3pm and 4pm to announce a sports event. This box can limit the weekdays where the banner will be displayed. You may have a banner for Fridays, special banners for the weekends, etc.

insert graphic

And finally here s where you actually indicate the banner. You have four different banner types and you must select only one to create the banner data. The options are:

  • HTML banner
  • Image banner
  • Fixed URL banner
  • Text banner

Each option will be explained as follows:

HTML banners

HTML banners use a snippet of HTML code, this is very common for banner exchange sites where they will send you (show you) a portion of HTML code that you have to display in order to proceed with the banner exchange. Just paste/enter the HTML code in the text area and make sure the radio button is selecting HTML code to use HTML banners.

Counting clicks with HTML banners If you want to count clicks to the banner link in a HTML banner, you can link to the target link http://promo.example.com like this
<a href="banner_click.php?id=X&url=http://promo.example.com">Promo.Example.com</a>
where X is the numeric banner ID found in the banner list or in the address field of the "Edit or create banners" page.

Image banner

An image banner is just an image displayed as a banner linking to the URL you indicated. You should upload the image to be used for the banner. Use the upload box to upload the banner and make sure the radio button is pointing at the Use image option.

Fixed URL banner

A fixed URL banner is a banner that will be retrieved from a URL, this is typical for dynamic chaning banners, for example http://bannerserver/mybanner?id=foo or something like that. For this option you should enter the banner URL, each time tha banner is selected to be displayed the content will be retrieved from the URL and displayed.

Text banner

A text banner is just a snippet of text, this is known as text adds which are very common in sites such as Google or Kuro5hin.

For the example enter a couple of textadd banners in the textadd zone.

Displaying banners

Once you have created your banners you want to display them, you can display a Tiki banner in any Tiki template including user modules system. You have to use the following syntax to include a banner in any template:

{banner zone=foo}

Where zone is the zone to be used. In our example let s create a user module from the user modules screen to display our textadds:

insert graphic

Once created assign the banner to some sidebar:

insert graphic

Now you should have a user module displaying the text add banners at the right side bar, refresh the screen to see how the banners are rotated (if you created more than one add). You now have textadds in your Tiki site just as Google or Kuro5hin!

Viewing stats

Once banners are running you or your clients (friends) will want to check how they banners are doing in the Tiki system, from the banner listing you will see a link to stats .

insert graphic

Clicking on stats will display the banner stats:

insert graphic

The banner information screen displays the statistics for the selected banner.

Future versions of Tiki will enhance the banner systems even more, new constraints will be added to the banner creation form (max impressions per week, restriction by group, etc) and new stats and graphics will be added to the stats page. New versions will be compatible with this version so you can start using the banners right now. Please let us know what would you add to the banners system to make it usable and we ll be happy to include ou suggestions in a new version.

Try it out

please link to the live Feature on tiki.org


This page is for the latest released stable version or release candidate(not stuff in CVS).

Knowledgebase / tutorial / FAQ / How-to

For more information


Page last modified on Friday 20 September 2019 17:42:09 GMT-0000

Upcoming Events

No records to display