Help16

Difference between revisions of "Components Banners Banners"

From Joomla! Documentation
m (removing categories, shutting down namespace)
 
(16 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
==How to Access==
 
==How to Access==
−
* Select '''Components → Banner → Banners''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''. You can also select the 'Banners' menu link from the [[Help16:Components_Banners_Categories|Banner Categories Manager]], [[Help16:Components_Banners_Clients|Banner Clients Manager]] or the [[Help16:Components_Banners_Tracks|Banner Tracks Manager]].
+
* Select '''Components → Banners → Banners''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''. You can also select the 'Banners' menu link from the [[Help16:Components_Banners_Categories|Banner Categories Manager]], [[Help16:Components_Banners_Clients|Banner Clients Manager]] or the [[Help16:Components_Banners_Tracks|Banner Tracks Manager]].
  
 
==Description==
 
==Description==
−
The Banner Manager is where you can edit existing Banners and create new ones. You can also easily enable or disable banners from this screen. You can also navigate to the [[Help16:Components_Banners_Categories|Banner Categories Manager]], [[Help16:Components_Banners_Clients|Banner Clients Manager]] and the [[Help16:Components_Banners_Tracks|Banner Tracks Manager]].
+
The Banner Manager is where you can edit existing Banners and create new ones. You can also easily enable or disable banners from this screen. From this screen you can navigate to the [[Help16:Components_Banners_Categories|Banner Categories Manager]], [[Help16:Components_Banners_Clients|Banner Clients Manager]] and the [[Help16:Components_Banners_Tracks|Banner Tracks Manager]].
 
You must add at least one Banner Client and Banner Category ''before'' you can add a Banner.
 
You must add at least one Banner Client and Banner Category ''before'' you can add a Banner.
  
Line 14: Line 14:
 
==Column Headers==
 
==Column Headers==
 
Click on the column heading on the banner manager screen to sort the list by that column's value.
 
Click on the column heading on the banner manager screen to sort the list by that column's value.
−
* '''Checkbox.''' Check this box to select one or more items. To select all items, check the box in the column heading. After one or more boxes are checked, click a toolbar button to take an action on the selected item or items. Many toolbar actions, such as Publish and Unpublish, can work with multiple items. Others, such as Edit, only work on one item at a time. If multiple items are checked and you press Edit, the first item will be opened for editing.
+
{{Chunk16:colheader|Checkbox}}
 
* '''Name.''' The name of the Banner. You can click on the name to open the Banner for editing.
 
* '''Name.''' The name of the Banner. You can click on the name to open the Banner for editing.
−
* '''Published.''' Whether the item has been published or not. You can change the Published state by clicking on the icon in this column.
+
{{Chunk16:colheader|Published}}
 
* '''Sticky.''' 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.
 
* '''Sticky.''' 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.
 
* '''Client.''' The Client for this Banner. Clients are entered using the Banner Client Manager.
 
* '''Client.''' The Client for this Banner. Clients are entered using the Banner Client Manager.
−
* '''Category.''' The Category that this Banner belongs to. Clicking on the Category Title opens the Category for editing. See Banner Category Manager - New/Edit. Note that Banner Categories are separate from other Categories, such as those for Articles, Contacts, Newsfeeds, and Web Links.
+
{{Chunk16:colheader|Category}}
−
* '''Ordering.''' The order to display items. You can change the order by entering the sequential order and clicking the 'Save Order' icon in the column heading.
+
{{Chunk16:colheader|Order}}
 
* '''Impressions.''' The Impression count is the number of times the Banner has been displayed on a page. The first number in this column is the actual number of Impressions so far, and the second number is how many Impressions were purchased by the client.
 
* '''Impressions.''' The Impression count is the number of times the Banner has been displayed on a page. The first number in this column is the actual number of Impressions so far, and the second number is how many Impressions were purchased by the client.
 
* '''Clicks.''' The first number is the total number of clicks that have been made on the Banner since the counter was reset. The second number is what percentage of the time user clicked on the banner when it was displayed.
 
* '''Clicks.''' The first number is the total number of clicks that have been made on the Banner since the counter was reset. The second number is what percentage of the time user clicked on the banner when it was displayed.
 
* '''Meta Keywords.''' Optional meta keywords to be used for displaying specific Banners based on the content of the Article being viewed. If the Banner module Parameter 'Search By Tag' is set to 'Yes', Banners whose Tags match the Keywords entered for each Article will display when that Article is being viewed.
 
* '''Meta Keywords.''' Optional meta keywords to be used for displaying specific Banners based on the content of the Article being viewed. If the Banner module Parameter 'Search By Tag' is set to 'Yes', Banners whose Tags match the Keywords entered for each Article will display when that Article is being viewed.
−
* '''Purchase Type.'''
+
* '''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...
−
* '''Language.'''
+
{{Chunk16:colheader|Language}}
−
* '''ID.''' The ID number. This is a unique identification number for this item assigned automatically by Joomla!. It is used to identify the item internally, for example in internal links. You can not change this number.
+
{{Chunk16:colheader|Id}}
  
 
==List Filters==
 
==List Filters==
−
'''Filter by Partial Title'''
+
====Filter by Partial Title====
  
−
You can filter the list of items by typing part of the title or the ID number. You can also select a combination of Category and Published State.
+
You can filter the list of items by typing part of the banner's name.
 
[[Image:help16-banners-manage-filter-name.png|center]]
 
[[Image:help16-banners-manage-filter-name.png|center]]
  
−
'''Filter by Published State, Client, Category, and Language'''
+
====Filter by Published State, Client, Category, and Language====
−
In the upper right area, above the column headings, there are four drop-down list boxes as shown below:[[Image:help16-banners-manage-filter-attributes.png|center]] The selections may be combined. Only items matching all selections will display in the list.
+
In the upper right area, above the column headings, there are four drop-down list boxes as shown below:
−
*'''Select State.''' Use the drop-down list box to select the published state: Published, Unpublished, Archived, Trashed, or All (any).
+
 
 +
[[Image:help16-banners-manage-filter-attributes.png|center]]
 +
 
 +
The selections may be combined. Only items matching all selections will display in the list.
 +
{{Chunk16:listfiltering|Select State}}
 
*'''Select Client.''' Use the drop-down list box to select only banners configured for the selected client.
 
*'''Select Client.''' Use the drop-down list box to select only banners configured for the selected client.
−
*'''Select Category.''' Use the drop-down list box to select only banners of the selected category.
+
{{Chunk16:listfiltering|Select Category}}
−
*'''Select Language.''' Use the drop-down list box to select only banners of the selected language.
+
{{Chunk16:listfiltering|Select Language}}
  
 
==Toolbar==
 
==Toolbar==
Line 45: Line 49:
  
 
[[Image:help16-banners-manage-toolbar.png]]
 
[[Image:help16-banners-manage-toolbar.png]]
−
* '''New.''' Click on this button to create a new item. You will enter the New page for this item.
+
{{Chunk16:toolbaricon|New}}
−
* '''Edit.''' Select one item and click on this button to open it in edit mode. If you have more than one item selected (where applicable), the first item will be opened. You can also open an item for editing by clicking on its Title or Name
+
{{Chunk16:toolbaricon|Edit}}
−
* '''Publish.''' To publish one or more items, select them and click on this button.
+
{{Chunk16:toolbaricon|Publish}}
−
* '''Unpublish.''' To unpublish one or more items, select them and click on this button.
+
{{Chunk16:toolbaricon|Unpublish}}
−
* '''Archive.'''
+
{{Chunk16:toolbaricon|Archive}}
−
* '''Check In.'''
+
{{Chunk16:toolbaricon|Checkin}}
−
* '''Trash.''' To trash one or more items, select them and click this button. The selected items will be placed in the trash. Note: Only empty items can be trashed.
+
{{Chunk16:toolbaricon|Trash}}
−
*'''Options.''' Click this button to open the Banners Global Configuration window. This window allows you to set default parameters for Banners, as shown below.
+
{{Chunk16:toolbaricon|Options}}
 +
{{Chunk16:toolbaricon|Help}}
 +
 
 +
==Options==
 +
Click the Options button to open the '''Banner Manager Options''' window which lets you configure this component.
  
 
[[Image:help16-banners-manager-options-client.png|center]]
 
[[Image:help16-banners-manager-options-client.png|center]]
−
:*'''Save.''' Saves your settings.
 
−
:*'''Cancel.''' Cancels your changes.
 
−
:*'''Purchase Type.'''
 
−
:*'''Track Impressions.''' Whether or not to count how many times a Banner is displayed.
 
−
:*'''Track Clicks.''' Whether or not to count how many times a Banner is clicked.
 
−
:*'''Meta Keyword Prefix.''' When matching keywords (for matching Banners to Articles based on Keywords), only search for keywords with this prefix. This can improve performance.
 
  
−
'''Clients and Categories Links'''
+
===Buttons Common to All Tabs===
 +
{{Chunk16:buttons|OptionsSaveClose}}
 +
{{Chunk16:buttons|OptionsSave}}
 +
{{Chunk16:buttons|OptionsCancel}}
 +
 
 +
===Client Options Tab===
 +
*'''Purchase Type.''' 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 count how many times a Banner is displayed.
 +
*'''Track Clicks.''' Whether or not to count how many times a Banner is clicked.
 +
*'''Meta Keyword Prefix.''' When matching keywords (for matching Banners to Articles based on Keywords), only search for keywords with this prefix. This can improve performance.
 +
 
 +
===Permissions Tab===
 +
{{Chunk16:Help_screen_component_options_permissions_intro}}
 +
 
 +
[[Image:Help16-components-banners-options-permissions.png|center]]
  
 +
{{Chunk16:Help_screen_component_options_permissions_columns_intro}}
 +
 +
{{Chunk16:Help_screen_component_options_permissions_columns_admin}}
 +
{{Chunk16:Help_screen_component_options_permissions_columns_manage}}
 +
{{Chunk16:Help_screen_component_options_permissions_columns_create}}
 +
{{Chunk16:Help_screen_component_options_permissions_columns_delete}}
 +
{{Chunk16:Help_screen_component_options_permissions_columns_edit}}
 +
{{Chunk16:Help_screen_component_options_permissions_columns_edit_state}}
 +
 +
{{Chunk16:Help_screen_component_options_permissions_conclusion}}
 +
 +
==Toolbar Links==
 
At the top left, above the Filter, you will see the following four links:
 
At the top left, above the Filter, you will see the following four links:
  
 
[[Image:help16-banners-manage-links.png]]
 
[[Image:help16-banners-manage-links.png]]
−
*'''Banners.''' This link is disabled, since we are already in the Banners page.
+
*'''Banners.''' This link is disabled, since you are already in the Banners page.
 
*'''Categories.''' Click this link to go to the [[Help16:Components_Banners_Categories|Banner Category Manager]] page.
 
*'''Categories.''' Click this link to go to the [[Help16:Components_Banners_Categories|Banner Category Manager]] page.
 
*'''Clients.''' Click this link to go to the [[Help16:Components_Banners_Clients|Banner Client Manager]] page.
 
*'''Clients.''' Click this link to go to the [[Help16:Components_Banners_Clients|Banner Client Manager]] page.
Line 76: Line 104:
  
 
==Related Information==
 
==Related Information==
−
* To create or edit Banners: [[Help16:Components_Banners_Categories|Banner Category Manager - New/Edit]]
+
* To create or edit Banners: [[Help16:Components_Banners_Banners_Edit|Banner - New/Edit]]
 
* To work with Banner Clients: [[Help16:Components_Banners_Clients|Banner Client Manager]]
 
* To work with Banner Clients: [[Help16:Components_Banners_Clients|Banner Client Manager]]
 
* To work with Banner Categories: [[Help16:Components_Banners_Categories|Banner Category Manager]]
 
* To work with Banner Categories: [[Help16:Components_Banners_Categories|Banner Category Manager]]
−
 
−
<noinclude>{{cathelp|1.6|Banner Manager|Components}}</noinclude>
 

Latest revision as of 18:29, 28 April 2013

Overview[edit]

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

How to Access[edit]

Description[edit]

The Banner Manager is where you can edit existing Banners and create new ones. You can also easily enable or disable banners from this screen. From this screen you can navigate to the Banner Categories Manager, Banner Clients Manager and the Banner Tracks Manager. You must add at least one Banner Client and Banner Category before you can add a Banner.

Screenshot[edit]

Help16-banners-manager-screen.png

Column Headers[edit]

Click on the column heading on the banner manager screen to sort the list by that column's value.

  • Checkbox. Check this box to select one or more items. To select all items, check the box in the column heading. After one or more boxes are checked, click a toolbar button to take an action on the selected item or items. Many toolbar actions, such as Publish and Unpublish, can work with multiple items. Others, such as Edit, only work on one item at a time. If multiple items are checked and you press Edit, the first item will be opened for editing.
  • Name. The name of the Banner. You can click on the name to open the Banner for editing.
  • Published. Whether the item has been published or not. You can change the Published state by clicking on the icon in this column.
  • Sticky. 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.
  • Client. The Client for this Banner. Clients are entered using the Banner Client Manager.
  • Category. The Category this item belongs to.
  • Ordering. The order in which to display items. If the list is sorted by this column, you can change the order by clicking the arrows or by entering the sequential order and clicking the 'Save Order' icon.
  • Impressions. The Impression count is the number of times the Banner has been displayed on a page. The first number in this column is the actual number of Impressions so far, and the second number is how many Impressions were purchased by the client.
  • Clicks. The first number is the total number of clicks that have been made on the Banner since the counter was reset. The second number is what percentage of the time user clicked on the banner when it was displayed.
  • Meta Keywords. Optional meta keywords to be used for displaying specific Banners based on the content of the Article being viewed. If the Banner module Parameter 'Search By Tag' is set to 'Yes', Banners whose Tags match the Keywords entered for each Article will display when that Article is being viewed.
  • 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...
  • 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.

List Filters[edit]

Filter by Partial Title[edit]

You can filter the list of items by typing part of the banner's name.

Help16-banners-manage-filter-name.png

Filter by Published State, Client, Category, and Language[edit]

In the upper right area, above the column headings, there are four drop-down list boxes as shown below:

Help16-banners-manage-filter-attributes.png

The selections may be combined. Only items matching all selections will display in the list.

  • Select State. Use the drop-down list box to only show items matching a certain state: Published, Unpublished, Archived, Trash or All (available options may vary depending on item type).
  • Select Client. Use the drop-down list box to select only banners configured for the selected client.
  • Select Category. Use the drop-down list box to select the desired Category. Only items in this Category will be displayed in the list.
  • Select Language. Use the drop-down list box to select the desired Language. Only items for the specified language will be displayed in the list.

Toolbar[edit]

At the top right you will see the toolbar:

Help16-banners-manage-toolbar.png

  • New. Creates a new item and opens the editing screen for this item.
  • Edit. Opens the editing screen for the selected item. If more than one item is selected (where applicable), only the first item will be opened. An item can also be opened for editing by clicking on its Title or Name.
  • Publish. Publishes selected items. Works with one or multiple items selected.
  • Unpublish. Unpublishes selected items. Works with one or multiple items selected.
  • Archive. Archives selected items. Works with one or multiple items selected.
  • Check In. Checks-in selected items. Works with one or multiple items selected.
  • Trash. Sends selected items to the trash. Works with one or multiple items selected.
  • Options. Opens the Options window where settings such as default parameters can be edited. See Options.
  • Help. Opens this Help Screen.

Options[edit]

Click the Options button to open the Banner Manager Options window which lets you configure this component.

Help16-banners-manager-options-client.png

Buttons Common to All Tabs[edit]

  • Save & Close. Saves changes and then closes the Options window.
  • Save. Saves changes and keeps the Options window open.
  • Cancel. Closes the Options window without applying changes.

Client Options Tab[edit]

  • Purchase Type. 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 count how many times a Banner is displayed.
  • Track Clicks. Whether or not to count how many times a Banner is clicked.
  • Meta Keyword Prefix. When matching keywords (for matching Banners to Articles based on Keywords), only search for keywords with this prefix. This can improve performance.

Permissions Tab[edit]

The "Permissions" tab, shown below, lets you specify who can perform each type of action on this component:

Help16-components-banners-options-permissions.png

The tree on the left shows the hierarchy of user groups that are available on your Joomla! site. To view or modify permissions, click on a group in the tree.

The table on the right side of the window contains 3 columns:

  • Actions. The various actions for which you can specify permissions for the currently selected user group.
  • Component Settings. The permission option set at the component level, which can be changed with the dropdown control. Options are:
    • Inherited. The permission for this group/action is inherited from the site's Global Configuration.
    • Allowed. Allows this action for this user group and for child groups.
    • Locked. Denies this action for this users group and for child groups.
  • Calculated Settings. The effective permission, based on current options in the site's Global Configuration. Note: After making changes, Save options and open them again to view updated Calculated Settings.

Actions available in this component are:

  • Configure. Grants users the right to edit this component's Options.
  • Access Component. Grants users the right to open this component's main screen ("Manager" screen).
  • Create. Grants users the right to create new objects (for example: users, menu items, articles, weblinks, and so on).
  • Delete. Grants users the right to delete existing objects.
  • Edit. Grants users the right to edit existing objects.
  • Edit State. Grants users the right to change existing objects state (Publish, Unpublish, Archive, Check In and Trash).

For more information, please refer to:

Toolbar Links[edit]

At the top left, above the Filter, you will see the following four links:

Help16-banners-manage-links.png

Quick Tips[edit]

  • You must add at least one Banner Client and Banner Category before you can add a Banner.

Related Information[edit]

Retrieved from "https://docs.joomla.org/index.php?title=Help16:Components_Banners_Banners&oldid=85539"