Actions

Help16

Difference between revisions of "Components Search"

From Joomla! Documentation

(Added information in the Permissions Tab section (inline for now, will create chunks once the Chunk16 namespace is available))
(Now using colheader template for Save and Cancel)
Line 71: Line 71:
  
 
===Save / Cancel===
 
===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.
+
{{colheader|Save}}
 +
{{colheader|Cancel}}
  
 
==Quick Tips==
 
==Quick Tips==

Revision as of 17:38, 2 June 2010

Template:Future

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.

Number of Items to Display

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

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

The Permissions table contains various columns:

  • User Groups. Lists the user groups that are available on your Joomla! site. You can specify permissions for each of these groups by using the dropdown controls in the other columns, which represents actions that can be performed by users.
  • Admin. Grants users the right to edit this component's Options.
  • Manage. Grants users the right to open this component's main screen ("Manager" screen).

For each user group / action, possible permission options are:

  • .... Represents the "Inherit" option, which means that the permission for this group/action is inherited from the site's Global Configuration.
  • Deny. Denies this action for this users group.
  • Allow. Allows this action for this users group and for child groups.

For more information, please refer to the ACL Tutorial for Joomla 1.6.

Save / Cancel

  • Save. Press Save to save your settings.
  • Cancel. Press Cancel to cancel your changes.

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