Actions

Help16

Difference between revisions of "Components Search"

From Joomla! Documentation

(Started to update the "Global Configuration" section + added quick tip about stats being off by default)
(Updated toggle image, centered and framed images)
Line 9: Line 9:
  
 
==Screenshot==
 
==Screenshot==
[[Image:help16-admin-components-search-screen.png]]
+
[[Image:help16-admin-components-search-screen.png|frame|center]]
  
 
==Column Headers==
 
==Column Headers==
Line 18: Line 18:
  
 
==Toolbar==
 
==Toolbar==
[[Image:help16-admin-components-search-toolbar.png]]
+
[[Image:help16-admin-components-search-toolbar.png|frame|center]]
 
*'''Reset.''' Click this button to reset the log to it's initial state. ''Warning: This will erase all prior search statistics information.''
 
*'''Reset.''' Click this button to reset the log to it's initial state. ''Warning: This will erase all prior search statistics information.''
 
{{toolbaricon|Parameters}}
 
{{toolbaricon|Parameters}}
Line 26: Line 26:
 
Click on the Options button to open the Search Manager Options window. In this window, the "Component" tab allows you to set various parameters for Search Statistics, as shown below:
 
Click on the Options button to open the Search Manager Options window. In this window, the "Component" tab allows you to set various parameters for Search Statistics, as shown below:
  
[[Image:help16-admin-components-search-options-component.png]]
+
[[Image:help16-admin-components-search-options-component.png|frame|center]]
  
 
*'''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.
Line 33: Line 33:
 
The "Permissions" tab, shown below, lets you specify who can administer and manage search statistics:
 
The "Permissions" tab, shown below, lets you specify who can administer and manage search statistics:
  
[[Image:help16-admin-components-search-options-permissions.png]]
+
[[Image:help16-admin-components-search-options-permissions.png|frame|center]]
  
 
==List Filters==
 
==List Filters==
Line 42: Line 42:
  
 
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:Search_stats_toggles.png|frame|center]]
+
[[Image:help16-admin-components-search-screen-status_and_results_toggle.png|frame|center]]
 
*'''Enabled / Disabled.''' If the Global Configuration Parameter called "Gather Search Statistics" is set to "Yes", this will display as "Enabled". Otherwise, it will display as "Disabled".
 
*'''Enabled / Disabled.''' If the Global Configuration Parameter called "Gather Search Statistics" is set to "Yes", this will display as "Enabled". Otherwise, it will display as "Disabled".
 
*'''Hide Search Results / Show Search Results.''' Toggle this link to Hide or Show the "Results Returned" column.
 
*'''Hide Search Results / Show Search Results.''' Toggle this link to Hide or Show the "Results Returned" column.

Revision as of 18:48, 21 May 2010

Contents

Overview

The Search Manager: Search Term Analysis back-end screen allows you to view statistics about searches performed by visitors of your site.

How to Access

Select Components → Search from the drop-down menu of the Joomla! Administrator Panel.

Description

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

Help16-admin-components-search-screen.png

Column Headers

  • #. An indexing number automatically assigned by Joomla! for ease of reference.
  • Search Phrase. The search text entered by the user. You can click the column header to sort the list by this value.
  • Hits. The number of times that a search with this search phrase was requested. You can click the column header to sort the list by this value.
  • Results. The number of search results returned to the user for this search text.

Toolbar

Help16-admin-components-search-toolbar.png
  • Reset. Click this button to reset the log to it's initial state. Warning: This will erase all prior search statistics information.
  • Parameters. Click this button to open the Global Configuration window. This window allows you to set default parameters for this type of item. See Global Configuration.
  • Help. Opens this Help Screen.

Global Configuration

Click on the Options button to open the Search Manager Options window. In this window, the "Component" tab allows you to set various parameters for Search Statistics, as shown below:

Help16-admin-components-search-options-component.png
  • 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 Created Date for the Articles when they are displayed in search results.

The "Permissions" tab, shown below, lets you specify who can administer and manage search statistics:

Help16-admin-components-search-options-permissions.png

List Filters

Filter by Partial Title

  • Filter. In the upper left corner just above the column headings is a Filter field and two buttons, as shown below:
    Article manager filter1.png
    If you have a large number of items on the list, you can use this filter to find the desired item(s) quickly. Enter either part of the title and press 'Go' to display the matching items. You can enter in whole words or part of a word. For example, "ooml" will match all titles with the word "Joomla!" in them. You can also search for a specific item id by entering "id:" followed by the id number. For example, "id:123" will find the item with an id of '123'.

Search Logging Indicator and Toggle

In the upper right corner there are more fields, as shown below:

Help16-admin-components-search-screen-status and results toggle.png
  • Enabled / Disabled. If the Global Configuration Parameter called "Gather Search Statistics" is set to "Yes", this will display as "Enabled". Otherwise, it will display as "Disabled".
  • Hide Search Results / Show Search Results. Toggle this link to Hide or Show the "Results Returned" column.

Quick Tips

  • 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 Global Configuration for more information.

Related Information