Actions

Help33

Difference between revisions of "Components Banners Banners Edit"

From Joomla! Documentation

m (How To Access: update to section and use of rarr)
m (Related Information: update to section)
(14 intermediate revisions by one user not shown)
Line 1: Line 1:
 
<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>
 
<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>
==Overview==
 
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==
 
==How to Access==
 
To ''''add'''' a new Banner or ''''edit'''' an existing Banner, navigate to the [[Help30:Components_Banners_Banners|Banner Manager]]:  
 
To ''''add'''' a new Banner or ''''edit'''' an existing Banner, navigate to the [[Help30:Components_Banners_Banners|Banner Manager]]:  
Line 12: Line 9:
  
 
==Description==
 
==Description==
This is where you add a new Banner or edit an existing one. Note that you will need to create at least one [[Help30:Components_Banners_Clients|Banner Client]] and one [[Help30:Components_Banners_Categories|Banner Category]] before you can create your first Banner.
+
Used to add or edit banners which can be displayed on your Joomla! website. Remember to create at least one [[Help30:Components_Banners_Clients|Banner Client]] and one [[Help30:Components_Banners_Categories|Banner Category]] before creating any Banners.
  
 
==Screenshot==
 
==Screenshot==
 
[[Image:Help30-Components-Banners-Banners-Edit-screen.png]]
 
[[Image:Help30-Components-Banners-Banners-Edit-screen.png]]
  
==Details and Options==
+
==Details==
===Details===
+
===Details Sidebar===
*'''Name.''' The name of the Banner. This is the name that will display in the ''Name'' column of the [[Help30:Components_Banners_Banners|Banner Manager]].
+
{{Chunk30:colheader|Status}}
{{Chunk30:colheader|Alias}}
+
{{Chunk30:colheader|Sticky}}
{{Chunk30:colheader|Category}}
+
*'''Type.''' The type of banner to display. Options are an image file or custom HTML code.
+
{{Chunk30:colheader|State}}
+
*'''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 [[Help30:Content_Media_Manager|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.
+
{{Chunk30:colheader|CategoryDescription}}
+
 
{{Chunk30:colheader|Language}}
 
{{Chunk30:colheader|Language}}
{{Chunk30:colheader|Id}}
 
  
===Publishing Options===
+
===Details Tab===
*'''Created.''' The date the banner was created.
+
{{Chunk30:Help screen column header Detail Tab Banner Edit}}
{{Chunk30:PublishingOptions|PublishStart}}
+
{{Chunk30:PublishingOptions|PublishFinish}}
+
*'''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===
+
===Publishing Options Tab===
{{Chunk30:metadata|Keywords}}
+
:[[File:Help30-Components-Banners-Banners-Edit-Publishing-Options-Tab.png]]
*'''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.
+
{{Chunk30:Help screen column header Publishing Options Tab}}
*'''Meta Keyword Prefix.''' When matching meta keywords, only search for meta keywords with these optional prefixes. This improves performance.
+
 
 +
===Banner's Details Tab===
 +
:[[File:Help30-Components-Banners-Banners-Edit-Banners-Details-Tab.png]]
 +
{{Chunk30:Help screen column header Banners Details Tab}}
 +
 
 +
===Metadata Options Tab===
 +
:[[File:Help30-Components-Banners-Banners-Edit-Metadata-Options-Tab.png]]
 +
{{Chunk30:colheader|Metadata Keywords}}
 +
{{Chunk30:colheader|Use Own Prefix}}
 +
{{Chunk30:colheader|Meta Keyword Prefix}}
  
 
==Toolbar==
 
==Toolbar==
At the top left you will see the toolbar:
+
{{Chunk30:EditAndNewToolbars|Components Banners Banners Edit|Components Banners Banners New}}
  
[[Image:Help30-Save-SaveClose-SaveNew-Cancel-Help-toolbar.png]]
 
 
The functions are:
 
{{Chunk30:Help_screen_toolbar_icon_Save|user}}
 
{{Chunk30:Help_screen_toolbar_icon_SaveAndClose|user}}
 
{{Chunk30:Help_screen_toolbar_icon_SaveAndNew|user}}
 
{{Chunk30:Help_screen_toolbar_icon_Cancel}}
 
{{Chunk30:Help_screen_toolbar_icon_Help}}
 
 
==Quick Tips==
 
==Quick Tips==
 
* Banners are placed on specific pages by adding Modules of type 'Banners' using the [[Help30:Extensions_Module_Manager|Module Manager]].
 
* Banners are placed on specific pages by adding Modules of type 'Banners' using the [[Help30:Extensions_Module_Manager|Module Manager]].
Line 72: Line 49:
  
 
==Related Information==
 
==Related Information==
* To work with Banner Clients: [[Help30:Components_Banners_Clients|Banner Client Manager]]
+
'''More Component Banner Help:'''
* To work with Banner Categories: [[Help30:Components_Banners_Categories|Banner Category Manager]]
+
{{relatedhelp|Banners}}
* To place Banners on Pages: [[Help30:Extensions_Module_Manager|Module Manager]]
+
'''To place Banners on Pages:'''
 
+
{{relatedhelp|Module_Manager_Banner}}
 
<noinclude>{{cathelp|3.0|Banner Manager Help Screens|Components Help Screens}}</noinclude>
 
<noinclude>{{cathelp|3.0|Banner Manager Help Screens|Components Help Screens}}</noinclude>

Revision as of 19:58, 7 January 2013

How to Access

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

  • Select Components  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.

Description

Used to add or edit banners which can be displayed on your Joomla! website. Remember to create at least one Banner Client and one Banner Category before creating any Banners.

Screenshot

Help30-Components-Banners-Banners-Edit-screen.png

Details

Details Sidebar

  • Status. (Published/Unpublished/Trashed) The published status of the item.
  • Sticky. (Yes or No) Whether or not the Banner is "sticky". If one or more Banners in a Category are designated "sticky," they will take priority over Banners that are not sticky.
For example, if two Banners in a Category are sticky and a third Banner is not sticky, the third Banner will not display if the Banner display module setting is "Sticky, Randomize" or "Sticky, Order." Only the two sticky Banners will display. If the sticky banners have a fixed number of impressions, once those impressions are used up, the sticky banners will no longer display, and the non-sticky banners will begin displaying automatically.
  • Language. Item language.

Details Tab

  • 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").
  • Type. The type of banner to display. Options are an image file or custom HTML code.
  • Image. (Only used for banner type Image). Image file to display for the banner. 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. Images for Banners have to be in the /images/banners/ directory.
  • Width. (Only used 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 used 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 used for banner type Image). Text to display in place of the banner image in the event the image cannot be displayed.
  • Alternative Text. Alternative text for the Banner's image.
  • Click URL. The URL to navigate to when the User clicks on the Banner.
  • Description. Enter a description for the Banner.

Publishing Options Tab

Help30-Components-Banners-Banners-Edit-Publishing-Options-Tab.png
  • Created Date. Date the item(Article, Category, Weblink, etc.) was created.
  • Created by. Name of the Joomla! User who created this item. This will default to the currently logged-in user. If you want to change this to a different user, click the Select User button to select a different user.
  • Created By Alias. This optional field allows you to enter in an alias for this Author for this Article. This allows you to display a different Author name for this Article.
  • Modified Date. (Informative only) Date of last modification.
  • Modified By. (Informative only) Username who performed the last modification.
  • Revision. (Informative only) Number of revisions to this item.
  • Start Publishing. Date the Banner will publish and be available for website.
Enter the date (time optional) in format year-month-date hrs:min:sec as '2013-01-07 14:10:00' or alternatively, use the modal 'pop up' window and select a date from the calendar.
  • Finish Publishing. Date the Banner will stop being published and will no longer be available for website.
Enter the date (time optional) in format year-month-date hrs:min:sec as '2013-01-07 14:10:00' or alternatively, use the modal 'pop up' window and select a date from the calendar.

Banner's Details Tab

Help30-Components-Banners-Banners-Edit-Banners-Details-Tab.png
  • 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 for this Banner. Clients are entered using the Banner Client Manager. 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.
The following options are: (-Use Client Default-, Unlimited, Yearly, Monthly, Weekly, Daily).
  • 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 Tab

Help30-Components-Banners-Banners-Edit-Metadata-Options-Tab.png
  • 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 Parameter '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.

Toolbar

At the top left you will see the toolbar for a Edit Item or New Item

Components Banners Banners Edit:

Help32-Save-SaveClose-SaveNew-SaveAsCopy-Version-Close-toolbar.png

  • Save. Saves the menu item and stays in the current screen.
  • Save & Close. Saves the menu item and closes the current screen.
  • Save & New. Saves the menu item and keeps the editing screen open and ready to create another menu item.
  • Save as Copy. Saves your changes to a copy of the current menu item. Does not affect the current menu item. This toolbar icon is not shown if you are creating a new menu item.
  • Versions. Opens the Item Version History window to show any prior versions of this item. This allows you to view older versions of this item and, if desired, restore from an older version. See Version History for more information.
  • Cancel/Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.

Help32-Help-toolbar.png

  • Help. Opens this help screen.

Components Banners Banners New:

Help32-Save-SaveClose-SaveNew-Cancel-toolbar.png

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

Help32-Help-toolbar.png

  • Help. Opens this help screen.

Quick Tips

  • 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

More Component Banner Help:

Related Help Screens Description
Components Banners Banners

Used to view a list of existing Banners, edit current and create new Banners. There must be at least one Banner Client and Banner Category before a Banner can be created.

Components Banners Banners Options

Global options (configuration) for Banner Clients.

Components Banners Categories

Used to view a list of existing Banner Categories, edit current and create new Banner Categories. Note that Banner Categories are separate from other Categories, such as for Articles, Contacts, News Feeds, and Web Links. There must be at least one Banner Client and Banner Category before a Banner can be created.

Components Banners Categories Edit

This is where you can add a new Banner Category or edit an existing one. Note that you need to create at least one Banner Category before you can create a Banner. Also, Banner Categories are separate from other types of Categories, such as those for Articles, Contacts, and News Feeds.

Components Banners Clients

The Banner Client Manager is where you can edit existing Banner Clients or create new ones. Note that you must have at least one Banner Client and one Banner Category defined before you can add your first Banner.

Components Banners Clients Edit

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

Components Banners Tracks

Used to view a list of existing Banner Tracking information.

To place Banners on Pages:

Related Help Screens Description
Extensions Module Manager Banners

The Banner Module displays the active Banners from the Component.