Actions

Help16

Difference between revisions of "Components Search"

From Joomla! Documentation

(Updated toggle image, centered and framed images)
(Various edits + Removed image frames + reorganized sections/subsections a bit)
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 are disabled after installing Joomla! -- refer to [[#Global Configuration|Global Configuration]] for information on enabling statistics.
  
 
==How to Access==
 
==How to Access==
Line 9: Line 11:
  
 
==Screenshot==
 
==Screenshot==
[[Image:help16-admin-components-search-screen.png|frame|center]]
+
[[Image:help16-admin-components-search-screen.png|center]]
  
==Column Headers==
+
===Column Headers===
 
{{colheader|Number}}
 
{{colheader|Number}}
 
*'''Search Phrase'''. The search text entered by the user. You can click the column header to sort the list by this value.
 
*'''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.
 
*'''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.
 
*'''Results'''. The number of search results returned to the user for this search text.
 +
 +
===List Settings===
 +
====Filtering by Partial Search Phrase====
 +
{{colheader|List Filter}}
 +
 +
====Showing/Hiding Results Counts====
 +
In the upper right corner there are more fields, as shown below:
 +
[[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 [[#Global Configuration|Global Configuration]] for information on enabling and disabling statistics.
 +
*'''Show Search Results / Hide Search Results'''. Toggle this link to show or hide the "Results" column values.
  
 
==Toolbar==
 
==Toolbar==
[[Image:help16-admin-components-search-toolbar.png|frame|center]]
+
[[Image:help16-admin-components-search-toolbar.png|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, empty state. ''Warning: This will erase all prior search statistics information.''
 
{{toolbaricon|Parameters}}
 
{{toolbaricon|Parameters}}
 
{{toolbaricon|Help}}
 
{{toolbaricon|Help}}
  
 
==Global Configuration==
 
==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:
+
In the toolbar, click on the '''Options''' button to open the Search Manager Options window.
  
[[Image:help16-admin-components-search-options-component.png|frame|center]]
+
===Component Tab===
 +
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|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.
*'''Creation Date'''. Whether or not to show the Created Date for the Articles when they are displayed in search results.
+
*'''Creation Date'''. Whether or not to show the Creation Date for items that are displayed in search results in the front-end.
  
 +
===Permissions Tab===
 
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|frame|center]]
+
[[Image:help16-admin-components-search-options-permissions.png|center]]
  
==List Filters==
+
===Save / Cancel===
'''Filter by Partial Title'''
+
Buttons at the top of the Options window let you save the changes you made to the various parameters, or cancel these changes. In both cases the Options window will close.
{{colheader|List Filter}}
+
 
+
'''Search Logging Indicator and Toggle'''
+
 
+
In the upper right corner there are more fields, as shown below:
+
[[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".
+
*'''Hide Search Results / Show Search Results.''' Toggle this link to Hide or Show the "Results Returned" column.
+
  
 
==Quick Tips==
 
==Quick Tips==
Line 51: Line 59:
  
 
==Related Information==
 
==Related Information==
*To add a Search Menu Item: [[screen.menus.edit.15#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]]
  
<noinclude>{{cathelp|1.5|Search Statistics|Components}}</noinclude>
+
<noinclude>{{cathelp|1.6|Search Statistics|Components}}</noinclude>

Revision as of 06:39, 22 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.

Note: By default, statistics are disabled after installing Joomla! -- refer to Global Configuration for information on enabling statistics.

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.

List Settings

Filtering by Partial Search Phrase

  • 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'.

Showing/Hiding Results Counts

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

Help16-admin-components-search-screen-status and results toggle.png
  • 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 Global Configuration for information on enabling and disabling statistics.
  • Show Search Results / Hide Search Results. Toggle this link to show or hide the "Results" column values.

Toolbar

Help16-admin-components-search-toolbar.png
  • Reset. Click this button to reset the log to it's initial, empty 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

In the toolbar, click on the Options button to open the Search Manager Options window.

Component Tab

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 Creation Date for items that are displayed in search results in the front-end.

Permissions Tab

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

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

Save / Cancel

Buttons at the top of the Options window let you save the changes you made to the various parameters, or cancel these changes. In both cases the Options window will close.

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