Components Banners Banners Edit

From Joomla! Documentation

This screen is accessed from the back-end Joomla! administrator panel. It is used to add or edit banners which can be displayed on your Joomla! website.

How to Access[edit]

To 'add' a new Banner or 'edit' an existing Banner, navigate to the Banner Manager:

  • Select Components  Banners  Banners

Click the 'New' button to create a new Banner.

To 'Edit' an existing Banner, in Banner Manager click on an Banner's Title or click the Banner's check box and then click the Edit button in the Toolbar.


This is where you add a new Banner or edit an existing one. Note that you will need to create at least one Banner Client and one Banner Category before you can create your first Banner.



Details and Options[edit]



  • Name. The name of the Banner. This is the name that will display in the Name column of the Banner Manager.
  • Alias. The internal name of the item, also used in the URL when SEF is activated. Normally, you can leave this blank and Joomla! will fill in a default value. The default value is the Title or Name in lower case and with dashes instead of spaces. You may enter the Alias manually. The Alias should consist of lowercase letters and hyphens (-). No blank spaces or underscores are allowed. Non-Latin characters can be allowed in the alias if you set the Unicode Aliases option to Yes in Global Configuration. If this option is set to No and the title includes non-Latin characters, the Alias will default to the current date and time (for example "2012-12-31-17-54-38").
  • Category. The Category this item belongs to.
  • Type. The type of banner to display. Options are an image file or custom HTML code.
  • State: State of the item. Possible values are:
    • Published: The item is published. This is the only state that will allow regular website users to view this item.
    • Unpublished: The item is unpublished.
    • Archived: The item has been archived.
    • Trashed: The item has been sent to the Trash.
  • Custom Code (Only displayed for banner type Custom). The HTML code to insert in the place of a banner image file.
  • Image (Only displayed for banner type Image). Image file to display for the banner. Specify the relative path to the banner image to use or click the Select button to browse and select the image file to use. Use the Media Manager to upload Banner image files to your site.
  • Width (Only displayed for banner type Image). The fixed width to resize the banner image to. Leave this blank if you want to use the actual width of the banner image file.
  • Height (Only displayed for banner type Image). The fixed height to resize the banner image to. Leave this blank if you want to use the actual height of the banner image file.
  • Alternative Text (Only displayed for banner type Image). Text to display in place of the banner image in the event the image cannot be displayed.
  • Click URL. The URL to navigate to when the User clicks on the Banner.
  • Description. Enter a description for the Banner.
  • Language. Item language.
  • ID. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, and you cannot change this number. When creating a new item, this field displays 0 until you save the new entry, at which point a new ID is assigned to it.

Publishing Options[edit]


  • Created Date. This field defaults to the current time when the Article was created. You can enter in a different date and time or click on the calendar icon to find the desired date.
  • Start Publishing. Date and time to start publishing. Use this field if you want to enter content ahead of time and then have it published automatically at a future time.
  • Finish Publishing. Date and time to finish publishing. Use this field if you want to have content automatically changed to Unpublished state at a future time (for example, when it is no longer applicable).
  • Sticky. Whether or not the banner is 'sticky'.
  • Max. Impressions. The number of Impressions purchased for this Banner. Impressions are the number of times a Banner will be displayed on a page. Check the 'Unlimited' checkbox if an unlimited number of Impressions is allowed.
  • Total Impressions. The number of times this Banner has been displayed on a web page to a user. No entry is allowed. You can reset this number to 0 by pressing the 'Reset impressions' button.
  • Total Clicks. The number of times this Banner has been clicked. No entry is allowed. You can reset this number to 0 by pressing the 'Reset clicks' button.
  • Client. The Client Name for this Banner. Select one from the drop-down list box of existing Clients.
  • Purchase Type. The purchase type of the banner. This is used to indicate how the banner client purchased the display time for the banner - monthly, yearly, etc...
  • Track Impressions. Whether or not to track the number of times the banner is displayed to web site visitors.
  • Track Clicks. Whether or not to track the number of times the banner is clicked by web site visitors.

Metadata Options[edit]


  • Meta Keywords. Optional entry for keywords. Must be entered separated by commas (for example, "cats, dogs, pets") and may be entered in upper or lower case. (For example, "CATS" will match "cats" or "Cats"). Keywords can be used in several ways:
  1. To help Search Engines and other systems classify the content of the Article.
  2. In combination with Banner tags, to display specific Banners based on the Article content. For example, say you have one Banner with an ad for dog products and another Banner for cat products. You can have your dog Banner display when a User is viewing a dog-related Article and your cat Banner display for a cat-related Article. To do this, you would:
    1. Add the keywords 'dog' and 'cat' to the appropriate Articles.
    2. Add the Tags 'dog' and 'cat' to the appropriate Banners in the Banner Manager New/Edit screen.
    3. Set the Banner module Form Field 'Search By Tags' to 'Yes in the Banner Module Edit screen.
  3. For articles only, in combination with the Related Articles module, to display Articles that share at least one keyword in common. For example, if the current Article displayed has the keywords "cats, dogs, monkeys", any other Articles with at least one of these keywords will show in the Related Articles module.
  • Use Own Prefix. Whether or not to use the banner's prefix or that of the client. Select No if you want to use the prefix of the banner client.
  • Meta Keyword Prefix. When matching meta keywords, only search for meta keywords with these optional prefixes. This improves performance.


At the top right you will see the toolbar:


The functions are:

  • Save. Saves the banner and stays in the current screen.
  • Save & Close. Saves the banner and closes the current screen.
  • Save & New. Saves the banner and keeps the editing screen open and ready to create another banner.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.
  • Help. Opens this help screen.

Quick Tips[edit]

  • Banners are placed on specific pages by adding Modules of type 'Banners' using the Module Manager.
  • If you have a series of Banners that you would like to display on one or more pages in random order:
    1. Create the Banners you wish to include, making sure they have the same Client and Category.
    2. Create a Banner Module for this Client and Category, and in the Menu Assignment pick the Menu Selections for the module to display on.
    3. In the Banner Module, set the 'Randomise' value to 'Sticky, Randomise'.
With these settings, the different Banners for that Client and Category will display on the selected pages in random order.

Related Information[edit]