Help16

Difference between revisions of "Components Banners Banners Edit"

From Joomla! Documentation

m (→‎Related Information: category reorganizing)
(17 intermediate revisions by one other user not shown)
Line 11: Line 11:
 
[[Image:Help16-banners-manager-edit.png]]
 
[[Image:Help16-banners-manager-edit.png]]
  
==Details==
+
==Details and Options==
 +
===Details===
 
*'''Name.''' The name of the Banner. This is the name that will display in the ''Name'' column of the [[Help16:Components_Banners_Banners|Banner Manager]].
 
*'''Name.''' The name of the Banner. This is the name that will display in the ''Name'' column of the [[Help16:Components_Banners_Banners|Banner Manager]].
*'''Alias.''' The internal name of the item. 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. The Alias will be used in the URL when SEF is activated.
+
{{Chunk16:colheader|Alias}}
*'''Category.''' The Category that this Banner belongs to. Select one from the drop-down list box of existing Banner Categories. Note that Banner Categories are separate from other Categories, such as those for Articles, Contacts, Newsfeeds, and Web Links.
+
{{Chunk16:colheader|Category}}
 
*'''Type.''' The type of banner to display. Options are an image file or custom HTML code.
 
*'''Type.''' The type of banner to display. Options are an image file or custom HTML code.
*'''State.''' The state of the banner. Options are ''Published'', ''Unpublished'', ''Archived'' and ''Trash''.
+
{{Chunk16:colheader|State}}
 
*'''Custom Code (Only displayed for banner type ''Custom'')'''. The HTML code to insert in the place of a banner image file.
 
*'''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 [[Help16:Content_Media_Manager|Media Manager]] to upload Banner image files to your site.
 
*'''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 [[Help16:Content_Media_Manager|Media Manager]] to upload Banner image files to your site.
Line 23: Line 24:
 
*'''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.
 
*'''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.
 
*'''Click URL.''' The URL to navigate to when the User clicks on the Banner.
*'''Description.''' Optional field where you can type a description or some notes about the Banner. This is for your use and does not display on your website front-end pages.
+
{{Chunk16:colheader|CategoryDescription}}
*'''Language.'''
+
{{Chunk16:colheader|Language}}
*'''ID.''' The internal Joomla! ID number for the banner. This is not configurable.
+
{{Chunk16:colheader|Id}}
Publishing Options
+
 
 +
===Publishing Options===
 
*'''Created.''' The date the banner was created.
 
*'''Created.''' The date the banner was created.
*'''Start Publishing.''' An optional date to automatically put the banner into a ''Published'' state.
+
{{Chunk16:PublishingOptions|PublishStart}}
*'''Finish Publishing.''' An optional date to automatically put the banner into an ''Unpublished'' state.
+
{{Chunk16:PublishingOptions|PublishFinish}}
*'''Sticky.''' Whether or not the banner is 'sticky''.
+
*'''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.
 
*'''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 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.
Line 38: Line 40:
 
*'''Track Impressions.''' Whether or not to track the number of times the banner is displayed to web site visitors.
 
*'''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.
 
*'''Track Clicks.''' Whether or not to track the number of times the banner is clicked by web site visitors.
Metadata Options
+
 
*'''Meta Keywords.''' Optional keywords to be used for displaying specific banners based on the content of the article being viewed. If the banner module parameter 'Search By Keyword' is set to 'Yes', banners whose keywords match the keywords entered for each article will display when that article is being viewed.
+
===Metadata Options===
*'''Use Own Prefix.'''
+
{{Chunk16:metadata|Keywords}}
 +
*'''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.
 
*'''Meta Keyword Prefix.''' When matching meta keywords, only search for meta keywords with these optional prefixes. This improves performance.
  
Line 46: Line 49:
 
At the top right you will see the toolbar. Whether you selected to create a new banner or edit an existing one will determine what toolbar buttons will be available.
 
At the top right you will see the toolbar. Whether you selected to create a new banner or edit an existing one will determine what toolbar buttons will be available.
  
New banner toolbar:
+
: New banner toolbar:
  
 
[[Image:Help16-banners-manager-new-toolbar.png]]
 
[[Image:Help16-banners-manager-new-toolbar.png]]
  
Edit banner toolbar:
+
: Edit banner toolbar:
  
 
[[Image:Help16-banners-manager-edit-toolbar.png]]
 
[[Image:Help16-banners-manager-edit-toolbar.png]]
*'''Save.''' Save your changes and return to editing the banner details.
+
{{Chunk16:toolbaricon|Save}}
*'''Save & Close.''' Save your changes and return to the banner manager screen.
+
{{Chunk16:toolbaricon|SaveAndClose}}
*'''Save & New.''' Save your changes and create a new banner.
+
{{Chunk16:toolbaricon|SaveAndNew}}
*'''Save as Copy (Only available in the banner edit screen).''' Save your changes to a copy of the current banner.
+
{{Chunk16:toolbaricon|SaveAsCopy}}
*'''Apply.''' Save your changes but stay in the same screen. If you have been working on a screen for a long time and don't want to risk losing your work, pressing Apply saves your work and lets you continue working. If, for example, you lost your Internet connection, your work will be saved up this point.
+
{{Chunk16:toolbaricon|Cancel}}
*'''Cancel (Only available in the new banner screen).''' Go back to the main screen of the banner manager, without saving the modifications you made.
+
{{Chunk16:toolbaricon|Close}}
*'''Close (Only available in the banner edit screen).''' Return to the banner manager screen without saving any changes you have made.
+
{{Chunk16:toolbaricon|Help}}
*'''Help.''' Opens this help screen.
 
  
 
==Quick Tips==
 
==Quick Tips==
* Banners are placed on specific pages by adding Modules of type 'mod_banners' using the [[screen.modules.15|Module Manager]].
+
* Banners are placed on specific pages by adding Modules of type 'Banners' using the [[Help16:Extensions_Module_Manager|Module Manager]].
* If you have a series of Banners that you would like to display on one more more pages in random order:
+
* If you have a series of Banners that you would like to display on one or more pages in random order:
 
*# Create the Banners you wish to include, making sure they have the same Client and Category.
 
*# Create the Banners you wish to include, making sure they have the same Client and Category.
 
*# Create a Banner Module for this Client and Category, and in the Menu Assignment pick the Menu Selections for the module to display on.  
 
*# Create a Banner Module for this Client and Category, and in the Menu Assignment pick the Menu Selections for the module to display on.  
Line 71: Line 73:
  
 
==Related Information==
 
==Related Information==
*To add or edit Banner Clients: [[screen.banners.client.15|Banner Client Manager]]
+
* To work with Banner Clients: [[Help16:Components_Banners_Clients|Banner Client Manager]]
*To add or edit Banner Categories: [[screen.bannercategories.15|Banner Category Manager]]
+
* To work with Banner Categories: [[Help16:Components_Banners_Categories|Banner Category Manager]]
*To find and edit existing Banners: [[screen.banners.15|Banner Manager]]
+
* To place Banners on Pages: [[Help16:Extensions_Module_Manager|Module Manager]]
*To place Banners on Pages: [[screen.modules.15|Module Manager]]
 
  
  
<noinclude>{{cathelp|1.6|Banner Manager|Components}}</noinclude>
+
<noinclude>{{cathelp|1.6|Banner Manager Help Screens|Components Help Screens}}</noinclude>

Revision as of 22:25, 4 August 2012

Overview[edit]

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]

Navigate to the Banner Manager. To add a new Banner, click on the New icon in the toolbar. To edit an existing Banner, click on the Banner's Name or check the Banner's checkbox and press the Edit icon in the toolbar.

Description[edit]

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.

Screenshot[edit]

Help16-banners-manager-edit.png

Details and Options[edit]

Details[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. Note: If the title consists of non-Latin characters, the Alias will default to the current date and time, for example "2009-02-11-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. Description of this category, which can optionally be displayed in the front-end.
  • 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. The date the banner was created.
  • Start Publishing. An optional start date to publish the item. Click the calendar icon to modify this date, or type in a date and time.
  • Finish Publishing. An optional end date for the item. Click the calendar icon to modify this date, or type in a date and time.
  • 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 comma-separated list that will be added to the HTML keywords output.
  • 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[edit]

At the top right you will see the toolbar. Whether you selected to create a new banner or edit an existing one will determine what toolbar buttons will be available.

New banner toolbar:

Help16-banners-manager-new-toolbar.png

Edit banner toolbar:

Help16-banners-manager-edit-toolbar.png

  • Save. Saves the item and stays in the edit screen.
  • Save & Close. Saves the item and closes the edit screen.
  • Save & New. Saves the item and keeps the editing screen open and ready to create another item.
  • Save as Copy. Saves this item under a new name, keeping the original item unmodified. This button is available only when editing an existing item, not when creating a new one.
  • Cancel. Returns to the previous screen without saving your work. If you press Cancel while adding a new item, this new item will not be created. If you were modifying an existing item, the modifications will not be saved.
  • Close. Returns to the previous screen without saving your work. If you press Close while adding a new item, this new item will not be created. If you were modifying an existing item, the modifications will not be saved.
  • 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]