Difference between revisions of "Components Search"
From Joomla! Documentation
(Use new Chunk16:Help_screen_list_Filter) |
m (→Related Information: removing categories, shutting down namespace) |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
==Overview== | ==Overview== | ||
The '''Search Manager: Search Term Analysis''' back-end screen allows you to view statistics about searches performed by visitors of your site. | The '''Search Manager: Search Term Analysis''' back-end screen allows you to view statistics about searches performed by visitors of your site. | ||
| − | '''Note''': By default, statistics | + | '''Note''': By default, statistics functionality is disabled after installing Joomla! -- refer to [[#Options|Options]] for information on enabling statistics. |
==How to Access== | ==How to Access== | ||
| Line 17: | Line 15: | ||
===Column Headers=== | ===Column Headers=== | ||
{{Chunk16:colheader|Number}} | {{Chunk16:colheader|Number}} | ||
| − | *'''Search Phrase'''. The search text entered by the user. | + | *'''Search Phrase'''. The search text entered by the user. |
| − | + | *'''Hits'''. The number of times users searched for this phrase. | |
*'''Results'''. The number of search results returned to the user for this search text. | *'''Results'''. The number of search results returned to the user for this search text. | ||
| + | |||
| + | You can click the 'Search Phrase' or 'Hits' column headers to sort the list by these values. Click again to sort in the reverse order. | ||
| + | |||
===List Settings=== | ===List Settings=== | ||
====Filtering by Partial Search Phrase==== | ====Filtering by Partial Search Phrase==== | ||
| − | {{Chunk16: | + | {{Chunk16:listfiltering|Filter}} |
| − | ====Showing/Hiding Results | + | ====Statistics Status, Showing/Hiding Results Count==== |
In the upper right corner there are more fields, as shown below: | In the upper right corner there are more fields, as shown below: | ||
[[Image:help16-admin-components-search-screen-status_and_results_toggle.png|center]] | [[Image:help16-admin-components-search-screen-status_and_results_toggle.png|center]] | ||
| − | *'''Gathering statistics enabled / Gathering statistics disabled'''. If the options parameter called "Gather Search Statistics" is set to "Yes", this will display as "Enabled". Otherwise, it will display as "Disabled". See [[# | + | *'''Gathering statistics enabled / Gathering statistics disabled'''. If the options parameter called "Gather Search Statistics" is set to "Yes", this will display as "Enabled". Otherwise, it will display as "Disabled". See [[#Options|Options]] for information on enabling and disabling statistics. |
*'''Show Search Results / Hide Search Results'''. Toggle this link to show or hide the "Results" column values. | *'''Show Search Results / Hide Search Results'''. Toggle this link to show or hide the "Results" column values. | ||
| Line 37: | Line 38: | ||
==Toolbar== | ==Toolbar== | ||
[[Image:help16-admin-components-search-toolbar.png|center]] | [[Image:help16-admin-components-search-toolbar.png|center]] | ||
| − | *'''Reset.''' | + | *'''Reset.''' Resets the search log to it's initial, empty state. ''Warning: This will erase all prior search statistics information.'' |
{{Chunk16:toolbaricon|Options}} | {{Chunk16:toolbaricon|Options}} | ||
{{Chunk16:toolbaricon|Help}} | {{Chunk16:toolbaricon|Help}} | ||
| Line 54: | Line 55: | ||
*'''Gather Search Statistics'''. Whether or not to gather search statistics for the web site. If set to "No", no information will be collected from users searches. This means that no information will be displayed in the Search Statistics screen. This is set to "No" by default. | *'''Gather Search Statistics'''. Whether or not to gather search statistics for the web site. If set to "No", no information will be collected from users searches. This means that no information will be displayed in the Search Statistics screen. This is set to "No" by default. | ||
| − | *'''Creation Date'''. Whether or not to show the Creation Date for items that are displayed in search results in the front-end. | + | *'''Use Search Areas'''. Whether or not to show the search areas checkboxes in the front-end search options, so user can choose what kind of items to search. This is set to "Yes" by default. Can be overridden in the [[Help16:Menus_Menu_Item_Search_Results|List Search Results]] menu item. |
| + | *'''Creation Date'''. Whether or not to show the Creation Date for items that are displayed in search results in the front-end. This is set to "Show" by default. Can be overridden in the [[Help16:Menus_Menu_Item_Search_Results|List Search Results]] menu item. | ||
===Permissions Tab=== | ===Permissions Tab=== | ||
| Line 63: | Line 65: | ||
{{Chunk16:Help_screen_component_options_permissions_columns_intro}} | {{Chunk16:Help_screen_component_options_permissions_columns_intro}} | ||
| − | |||
{{Chunk16:Help_screen_component_options_permissions_columns_admin}} | {{Chunk16:Help_screen_component_options_permissions_columns_admin}} | ||
{{Chunk16:Help_screen_component_options_permissions_columns_manage}} | {{Chunk16:Help_screen_component_options_permissions_columns_manage}} | ||
| − | |||
| − | |||
{{Chunk16:Help_screen_component_options_permissions_conclusion}} | {{Chunk16:Help_screen_component_options_permissions_conclusion}} | ||
==Quick Tips== | ==Quick Tips== | ||
| − | *This screen does not enable or disable searching of the web site. Searching is enabled either by adding an | + | *This screen does not enable or disable searching of the web site. Searching is enabled either by adding an [[Help16:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Search|Internal Link - Search Menu Item]] or by adding a [[Help16:Extensions_Module_Manager_Site_New#Search|Search Module]]. |
| − | *Search statistics are disabled by default. If you're interested in knowing what your visitors search for and what they find, you'll need to enable search statistics. Refer to [[# | + | *Search statistics are disabled by default. If you're interested in knowing what your visitors search for and what they find, you'll need to enable search statistics. Refer to [[#Options|Options]] for more information. |
==Related Information== | ==Related Information== | ||
*To add a Search Menu Item: [[Help16:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Search|Menu Item Manager - New/Edit - Internal Link - Search]] | *To add a Search Menu Item: [[Help16:Menus_Menu_Item_Manager_Edit#Internal_Link_-_Search|Menu Item Manager - New/Edit - Internal Link - Search]] | ||
*To add a Search Module: [[Screen.modulessite.edit.15#Search|Modules Site - Search]] | *To add a Search Module: [[Screen.modulessite.edit.15#Search|Modules Site - Search]] | ||
| − | |||
| − | |||
Latest revision as of 18:39, 28 April 2013
Overview[edit]
The Search Manager: Search Term Analysis back-end screen allows you to view statistics about searches performed by visitors of your site.
Note: By default, statistics functionality is disabled after installing Joomla! -- refer to Options for information on enabling statistics.
How to Access[edit]
Select Components → Search from the drop-down menu of the Joomla! Administrator Panel.
Description[edit]
The Search Statistics screen allows you to see how many searches were done for each keyword combination and how many results were returned for each search.
Screenshot[edit]
Column Headers[edit]
- #. An indexing number automatically assigned by Joomla! for ease of reference.
- Search Phrase. The search text entered by the user.
- Hits. The number of times users searched for this phrase.
- Results. The number of search results returned to the user for this search text.
You can click the 'Search Phrase' or 'Hits' column headers to sort the list by these values. Click again to sort in the reverse order.
List Settings[edit]
Filtering by Partial Search Phrase[edit]
Filter. In the upper left corner just above the column headings are a Filter field and two buttons, as shown below:
If you have a large number of items in the list, you can use this filter to find the desired item(s) quickly. Enter either part of the title or an ID number and press 'Search' to display the matching items. You can type in whole words or part of a word. For example, "ooml" will match all titles with the word "Joomla!" in them. Click 'Clear' to reset filtering.
Statistics Status, Showing/Hiding Results Count[edit]
In the upper right corner there are more fields, as shown below:
- Gathering statistics enabled / Gathering statistics disabled. If the options parameter called "Gather Search Statistics" is set to "Yes", this will display as "Enabled". Otherwise, it will display as "Disabled". See Options for information on enabling and disabling statistics.
- Show Search Results / Hide Search Results. Toggle this link to show or hide the "Results" column values.
Number of Items to Display[edit]
Below the list you'll find:
- Display #. The number of items to display on one page. If there are more items than this number, you can use the page navigation buttons (Start, Prev, Next, End, and page numbers) to navigate between pages. Note that if you have a large number of items, it may be helpful to use the Filter options, located above the column headings, to limit which items display (where applicable).
Toolbar[edit]
- Reset. Resets the search log to it's initial, empty state. Warning: This will erase all prior search statistics information.
- Options. Opens the Options window where settings such as default parameters can be edited. See Options.
- Help. Opens this Help Screen.
Options[edit]
In the toolbar, click on the Options button to open the Search Manager Options window.
Save / Cancel[edit]
- Save. Saves changes and keeps the Options window open.
- Cancel. Closes the Options window without applying changes.
Component Tab[edit]
In this window, the "Component" tab allows you to set various parameters for Search Statistics, as shown below:
- Gather Search Statistics. Whether or not to gather search statistics for the web site. If set to "No", no information will be collected from users searches. This means that no information will be displayed in the Search Statistics screen. This is set to "No" by default.
- Use Search Areas. Whether or not to show the search areas checkboxes in the front-end search options, so user can choose what kind of items to search. This is set to "Yes" by default. Can be overridden in the List Search Results menu item.
- Creation Date. Whether or not to show the Creation Date for items that are displayed in search results in the front-end. This is set to "Show" by default. Can be overridden in the List Search Results menu item.
Permissions Tab[edit]
The "Permissions" tab, shown below, lets you specify who can perform each type of action on this component:
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).
For more information, please refer to:
Quick Tips[edit]
- This screen does not enable or disable searching of the web site. Searching is enabled either by adding an Internal Link - Search Menu Item or by adding a Search Module.
- Search statistics are disabled by default. If you're interested in knowing what your visitors search for and what they find, you'll need to enable search statistics. Refer to Options for more information.
Related Information[edit]
- To add a Search Menu Item: Menu Item Manager - New/Edit - Internal Link - Search
- To add a Search Module: Modules Site - Search