Help310

Difference between revisions of "Components Finder Manage Indexed Content"

From Joomla! Documentation

m (→‎Related information: updating Help screens relevant versions)
(Marked this version for translation)
 
(70 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<noinclude>{{Help screen navbox|3.0|Components Help Screens}}</noinclude>==How to access==
+
<noinclude><languages /></noinclude>
From the administrator area, select '''Components &rarr; Smart Search''' from the drop-down menu of the Administration screen.
+
{{Chunk30:Help_screen_Description_Header/<translate><!--T:64--> en</translate>}}
 +
{{Chunk30:Help_screen_Description_Indexed_Content/<translate><!--T:106--> en</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_Header/<translate><!--T:66--> en</translate>}}
 +
{{Chunk30:Help_screen_How_To_Access_By_Menu/<translate><!--T:67--> en</translate>|<translate><!--T:68--> Components,Smart Search</translate>}}.
 +
{{Chunk30:Help_screen_Screenshot_Header/<translate><!--T:69--> en</translate>}}
 +
:[[File:Help35-Components-Finder-Manage-Indexed-Content-screen-<translate><!--T:17--> en</translate>.png|800px|border|none]]
 +
{{Chunk30:Help_screen_Column_Header/<translate><!--T:70--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Header_Description/<translate><!--T:83--> en</translate>|<translate><!--T:84--> indexed content</translate>}}
 +
:[[File:Help31-Components-Smart-Search-Manager-columns-<translate><!--T:20--> en</translate>.png|600px|border|none]]
 +
{{Chunk30:Help_screen_Column_Header_Checkbox/<translate><!--T:85--> en</translate>|<translate><!--T:86--> indexed content</translate>}}
 +
{{Chunk30:Help_screen_Column_Header_Smart_Search_Status/<translate><!--T:22--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Header_Name/<translate><!--T:103--> en</translate>|<translate><!--T:104--> content item</translate>|2=<translate><!--T:105--> Title</translate>}}
  
==Quick Tips==
+
<translate>
* Smart Search was introduced in Joomla 3.0 but is not enabled by default in that version.
+
<!--T:24-->
* If you are new to Smart Search then you should read the [[Smart Search quickstart guide]].
+
*'''Type'''. The type of the content item.
* If you run the indexer and get an "undefined null" error, then check the permissions on the Joomla <tt>/logs</tt> directory.  The web server needs to have write permission to that directory for the indexer to work.
+
</translate>
  
==Description==
+
<translate>
This screen shows a list of all the content items that have been indexed in Smart Search.
+
<!--T:25-->
 +
*'''Last Updated'''.  The date on which the content item was last re-indexed.  Any change to the indexable fields of a content item will automatically cause that content item to be re-indexed.
 +
</translate>
  
If the list is empty then
+
<translate>
* Make sure that the Smart Search plug-in has been enabled.
+
<!--T:26-->
** To check if the Smart Search plug-in has been enabled:
+
*'''Details'''. The details of the content item (''Published Start'', ''Published End'', ''Content Start'', ''Content End'').
*** Go to the '''Extensions &rarr; Plug-ins Manager'''.
+
</translate>
*** Select "content" from the drop-down headed "Select type".
 
*** Find "Smart Search" in the list of plug-ins shown.
 
*** If there is a green tick in the Enabled column for Smart Search then the Smart Search plug-in has been enabled.  If there is red circle then the Smart Search plug-in is currently disabled.
 
** To enable the Smart Search plug-in:
 
*** Click on the red circle.  This should change to a green tick indicating that the Smart Search plug-in is now enabled.
 
* Click on the Index toolbar icon.  This will open a window to show the progress of the indexing operation.  The indexing operation may take some time depending on the number of content items on your site and the number of search words and phrases contained in each content item.  A progress bar will indicate how much of the indexing process has been completed so far.  Do not close this window until indexing has been completed.  On sites with a large amount of content this may take a long time (tens of minutes).
 
  
==Screenshot==
+
<translate>
[[Image:Help30-Components-Finder-Manage-Indexed-Content-screen.png]]
+
<!--T:27-->
 +
*'''Raw URL'''.  The non-SEF URL that will be used to retrieve the content item in search results.
 +
</translate>
 +
{{Chunk30:Help_screen_Column_Filtering_Header/<translate><!--T:71--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Sort_Number/<translate><!--T:72--> en</translate>|<translate><!--T:73--> Title ascending</translate>}}
 +
:[[File:Help30-colheader-Column-filter-finder-indexed-content-number-<translate><!--T:74--> en</translate>.png|right]]
 +
{{Chunk30:Help_screen_Column_Filtering_Sort_Number_Description/<translate><!--T:75--> en</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Order/<translate><!--T:76--> en</translate>|<translate><!--T:87--> Title ascending</translate>}}
 +
{{Chunk30:Help_screen_Column_Filtering_Number/<translate><!--T:77--> en</translate>|<translate><!--T:88--> indexed content</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Header/<translate><!--T:78--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Description/<translate><!--T:89--> en</translate>|<translate><!--T:90--> indexed content</translate>}}
 +
{{Chunk30:Help_screen_List_Filters/<translate><!--T:91--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Search_Tools/<translate><!--T:96--> en</translate>}}
 +
{{Chunk30:Help_screen_List_Filters_Search_Tools_Boxes/<translate><!--T:97--> en</translate>|3}}
 +
:[[File:Help30-list-filters-status-typeofcontent-contentmap-en.png|600px|none]]
 +
{{Chunk30:Help_screen_Smart_Search_Select_Status/<translate><!--T:63--> en</translate>}}
 +
{{-}}
 +
<translate>
 +
<!--T:34-->
 +
'''Filter by Type of Content'''
 +
</translate>
  
==Toolbar==
+
<translate><!--T:92--> Select the content item type from the dropdown list.</translate>
At the top left you will see the toolbar:
+
:[[File:Help30-colheader-select-typeofcontent-<translate><!--T:33--> en</translate>.png|right]]
 +
{{-}}
 +
<translate><!--T:93--> '''Filter by Content Maps'''</translate>
  
[[Image:Help30-Index-Publish-Unpublish-Delete-Purge-Options-Statistics-Help-toolbar.png]]
+
<translate><!--T:94--> Select the content map from the dropdown list.</translate>
 +
:[[File:Help30-colheader-select-contentmap-<translate><!--T:37--> en</translate>.png|right]]
 +
{{-}}
 +
{{Chunk30:Help_screen_Automatic_Pagination_Header/<translate><!--T:79--> en</translate>}}
 +
{{Chunk30:Help_screen_Page_Controls/<translate><!--T:80--> en</translate>|<translate><!--T:95--> indexed content</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Header/<translate><!--T:81--> en</translate>}}
 +
{{Chunk30:Help_screen_Toolbar_Position/<translate><!--T:98--> en</translate>}}
 +
:[[File:Help35-Index-Publish-Unpublish-Statistics-Delete-ClearIndex-Help-Options-toolbar-<translate><!--T:41--> en</translate>.png|800px|none]]
 +
{{Chunk30:Help_screen_Toolbar_Function/<translate><!--T:99--> en</translate>}}
 +
<translate>
 +
<!--T:43-->
 +
*'''Index'''.  Runs the Smart Search indexer.  A small popup window will appear with a progress bar which advances as the indexing process works through the content on your site.  Do not close this popup window until the process is finished.</translate>  <translate><!--T:44--> On sites with a large amount of content this may take a long time (tens of minutes).  You should run the indexer after new content has been introduced to your website that the Smart Search function is not automatically aware of. </translate><translate><!--T:45--> For example, batch importing new content where the importer does not automatically trigger Smart Search to index each new content item.</translate> <translate><!--T:46-->
 +
''Note:'' The Smart Search indexer can also be run from the command-line interface (CLI) if required. See [[S:MyLanguage/Setting up automatic Smart Search indexing|Setting up automatic Smart Search indexing]].
 +
</translate>
 +
{{Chunk30:Help_screen_toolbar_icon_Publish/<translate><!--T:47--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Unpublish/<translate><!--T:48--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Statistics/<translate><!--T:49--> en</translate>|<translate><!--T:50--> Smart Search</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Delete/<translate><!--T:51--> en</translate>|<translate><!--T:52--> content items</translate>}} <translate><!--T:53--> Deleting a content item from Smart Search only deletes it from the index and does not affect the content item itself.</translate>
 +
<translate>
 +
<!--T:54-->
 +
*'''Clear Index'''. Purges the Smart Search index by emptying all index tables.  To continue using Smart Search you must click on the Index toolbar icon after purging.</translate>{{-}}<translate><!--T:55--> ''Warning:'' Purging the index also empties the content filters.  You must manually re-enter the content filter settings after a Purge-Index cycle.</translate>
 +
{{Chunk30:Help_screen_toolbar_icon_Help/<translate><!--T:56--> en</translate>}}
 +
{{Chunk30:Help_screen_toolbar_icon_Options/<translate><!--T:57--> en</translate>}}
 +
{{Chunk30:Help_screen_Quick_Tips_Header/<translate><!--T:82--> en</translate>}}
 +
<translate>
 +
<!--T:6-->
 +
*If the list is empty then make sure that the Smart Search plugin has been enabled:</translate>
 +
<translate>
 +
<!--T:8-->
 +
** Go to '''Extensions → Plugins'''.</translate>
 +
<translate>
 +
<!--T:9-->
 +
** Select ''content'' from the dropdown headed ''Select type''.</translate>
 +
<translate>
 +
<!--T:10-->
 +
** Find ''finder'' in the list of plugins shown.</translate>
 +
<translate>
 +
<!--T:11-->
 +
** If there is a green tick [[File:Help30-Article-status-featured-published-feature-manager-en.png]] in the Status column for Smart Search then the Smart Search plugin has been enabled. If there is red circle [[File:Help30-Article-status-not-published-feature-manager-en.png]] then the Smart Search plugin is currently disabled.
 +
</translate>
  
The functions are:
+
<translate>
*'''Index'''.  Runs the Smart Search indexer.  A small popup window will appear with a progress bar which advances as the indexing process works through the content on your site.  Do not close this popup window until the process is finished.  On sites with a large amount of content this may take a long time (tens of minutes).  You should run the indexer after new content has been introduced to your website that the Smart Search function is not automatically aware of.  For example, batch importing new content where the importer does not automatically trigger Smart Search to index each new content item.  NOTE: The Smart Search indexer can also be run from the command-line interface (CLI) if required.  See [[Setting up automatic Smart Search indexing]].
+
<!--T:12-->
{{Chunk30:Help_screen_toolbar_icon_Publish}}
+
* To enable the Smart Search plugin:</translate>
{{Chunk30:Help_screen_toolbar_icon_Unpublish}}
+
<translate>
{{Chunk30:Help_screen_toolbar_icon_Delete|content items}} Deleting a content item from Smart Search only deletes it from the index and does not affect the content item itself.
+
<!--T:13-->
*'''Purge'''. Purges the Smart Search index by emptying all index tables.  To continue using Smart Search you must click on the Index toolbar icon after purging.  WARNING: Purging the index also empties the content filters.  You must manually re-enter the content filter settings after a Purge-Index cycle.
+
** Click on the red circle [[File:Help30-Article-status-not-published-feature-manager-en.png]]. This should change to a green tick [[File:Help30-Article-status-featured-published-feature-manager-en.png]] indicating that the Smart Search plugin is now enabled.</translate>
{{Chunk30:Help_screen_toolbar_icon_SmartSearchOptions}}
+
<translate>
{{Chunk30:Help_screen_toolbar_icon_Statistics|Smart Search}}
+
<!--T:14-->
{{Chunk30:Help_screen_toolbar_icon_Help}}
+
** Click on the Index toolbar icon. This will open a window to show the progress of the indexing operation. The indexing operation may take some time depending on the number of content items on your site and the number of search words and phrases contained in each content item.</translate> <translate><!--T:15--> A progress bar will indicate how much of the indexing process has been completed so far. Do not close this window until indexing has been completed. On sites with a large amount of content this may take a long time (tens of minutes).</translate>
 
 
==List Filters==
 
*'''Search Content'''. In the upper left is a text field and two buttons, as shown below.
 
 
 
[[Image:Help30-Components-Finder-Manage-Indexed-Content-filter-subscreen.png]]
 
 
 
Enter part of the title of a content item and press the Search button to find matching content items. Press Reset to clear the search field and restore the list of content items.
 
 
 
*'''Filter by content type'''.  Select the content item type from the drop-down list.
 
*'''Filter by published state'''. Choose whether to show only published or unpublished content items by selecting the appropriate item from the drop-down list. The published state of the items in Smart Search is independent of their published state elsewhere.
 
 
 
==Column Headers==
 
In the table containing the indexed content for your Joomla! site you will see different columns. Here you can read what they mean and what is displayed in each column.
 
*'''Title'''. The title of the content item.
 
*'''Status'''. The status of the content item within Smart Search. Published items are shown with a green tick; unpublished items by a red circle.  You can change the status of an item by clicking on the icon. Changing the status on this screen only affects whether the content item is available in search results and does not affect the content item itself.
 
*'''Type'''. The type of the content item.
 
*'''Raw URL'''.  The raw (non-SEF) URL that will be used to retrieve the content item in search results.
 
*'''Last Updated'''.  The date on which the content item was last re-indexed.  Any change to the indexable fields of a content item will automatically cause that content item to be re-indexed.
 
  
==Related information==
+
<translate>
* [[Setting up automatic Smart Search indexing]]
+
<!--T:59-->
 +
* Smart Search is not enabled by default. If you are new to Smart Search then you should read the [[S:MyLanguage/Smart Search quickstart guide|Smart Search quickstart guide]].
 +
</translate>
  
<noinclude>{{cathelp|3.0,3.1|Smart Search|Components Help Screens}}</noinclude>
+
<translate>
 +
<!--T:61-->
 +
* If you run the indexer and get an "undefined null" error, then check the permissions on the Joomla <tt>/logs</tt> directory. The web server needs to have write permission to that directory for the indexer to work.</translate>
 +
{{Chunk30:Help_screen_Related_Information_Header/<translate><!--T:100--> en</translate>}}
 +
{{Chunk30:Help_screens_Header/<translate><!--T:107--> en</translate>}}
 +
{{Chunk30:Help_screen_Smart_Search_Related/<translate><!--T:101--> en</translate>|1=<translate><!--T:102--> Indexed Content (this screen)</translate>}}
 +
{{cathelp|3.0,3.1,3.2,3.3,3.4,3.5,3.6,3.7,3.8,3.9,3.10|Smart Search|Components Help Screens}}

Latest revision as of 05:35, 11 April 2022

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎français

Description[edit]

Provides an overview of the content items that have been indexed on a Joomla site.

How to Access[edit]

  • Select Components  Smart Search from the dropdown menu of the Administrator Panel.

Screenshot[edit]

Help35-Components-Finder-Manage-Indexed-Content-screen-en.png

Column Headers[edit]

In the table containing indexed content these are the different columns as shown below. Click on the column heading to sort the list by that column's value.

Help31-Components-Smart-Search-Manager-columns-en.png
  • Checkbox. Check this box to select one or more indexed content. To select all indexed content, check the box in the column heading.
    Note: Many toolbar actions can work with multiple indexed content.
  • Status. The status of the content item within Smart Search. Published items are shown with a green tick Help30-Article-status-featured-published-feature-manager-en.png; unpublished items by a red circle Help30-Article-status-not-published-feature-manager-en.png. You can change the status of an item by clicking on the icon.
    Note: Changing the status on this screen only affects whether the content item is available in search results and does not affect the content item itself.
  • Title. The name of the content item.
  • Type. The type of the content item.
  • Last Updated. The date on which the content item was last re-indexed. Any change to the indexable fields of a content item will automatically cause that content item to be re-indexed.
  • Details. The details of the content item (Published Start, Published End, Content Start, Content End).
  • Raw URL. The non-SEF URL that will be used to retrieve the content item in search results.

Column Filters[edit]

Above the column headers on the right, there are 2 dropdown input fields, Sort Table By: (preset to 'Title ascending') and a number (preset to '20') to display.

Help30-colheader-Column-filter-finder-indexed-content-number-en.png

These column sorting input fields shows the current method of sorting applied to the table. Use the dropdown field choices and click the column heading name. Alternatively, click on the column heading to sort the list by that column's value.

This will also change the value in the drop field to correspond with the column header name. The list will then be sorted in order by that column and a sort icon (up or down arrow) will show next to the column name. Click a second time to reverse the sort, which will change the corresponding drop field.

  • Title ascending (default). Shows ordering of selected column, ascending or descending.
  • Number of indexed content to display. Shows the number of indexed content to display on one page, default is 20 indexed content. If there are more indexed content than this number, you can use the page navigation buttons to navigate between pages.

List Filters[edit]

The List Filters are a series of controls that let you limit what indexed content show in the screen. More than one filter may be entered. In this case, only indexed content that meet all of the filter conditions will show on the list.

Filter by Partial Title or ID

In the upper left is a search field and 2 buttons.

Help30-colheader-filter-field-en.png
  • To filter by partial title, enter part of the title and click 'Search' Help30-Search-Button.png
  • To filter by ID number, enter "id:xx", where "xx" is the ID number (for example, "id:29").
  • Click 'Clear' to clear the Filter field and restore the list to its unfiltered state.

Search Tools[edit]

Above the column headings, there are 3 dropdown list boxes.

Help30-list-filters-status-typeofcontent-contentmap-en.png

Filter by Status Choose whether to show only published or unpublished maps by selecting the appropriate state from the dropdown list.

Help30-colheader-select-smartsearch-status-en.png

The published state of the maps in Smart Search is independent of their published state elsewhere.

Filter by Type of Content

Select the content item type from the dropdown list.

Help30-colheader-select-typeofcontent-en.png

Filter by Content Maps

Select the content map from the dropdown list.

Help30-colheader-select-contentmap-en.png

Automatic Pagination[edit]

Page Controls. When the number of indexed content is more than one page, you will see a page control bar as shown below. The current page number being viewed is shaded.

Help30-colheader-pagination-en.png
  • Start: Click to go to the first page.
  • Prev: Click to go to the previous page.
  • Page numbers: Click to go to the desired page.
  • Next: Click to go to the next page.
  • End: Click to go to the last page.

Toolbar[edit]

At the top left you will see the toolbar.

Help35-Index-Publish-Unpublish-Statistics-Delete-ClearIndex-Help-Options-toolbar-en.png

The functions are:

  • Index. Runs the Smart Search indexer. A small popup window will appear with a progress bar which advances as the indexing process works through the content on your site. Do not close this popup window until the process is finished. On sites with a large amount of content this may take a long time (tens of minutes). You should run the indexer after new content has been introduced to your website that the Smart Search function is not automatically aware of. For example, batch importing new content where the importer does not automatically trigger Smart Search to index each new content item. Note: The Smart Search indexer can also be run from the command-line interface (CLI) if required. See Setting up automatic Smart Search indexing.
  • Publish. Makes the selected items available to visitors to your website.
  • Unpublish. Makes the selected items unavailable to visitors to your website.
  • Statistics. Shows some basic statistics on Smart Search.
  • Delete. Deletes the selected content items. Works with one or multiple content items selected. Deleting a content item from Smart Search only deletes it from the index and does not affect the content item itself.
  • Clear Index. Purges the Smart Search index by emptying all index tables. To continue using Smart Search you must click on the Index toolbar icon after purging.
    Warning: Purging the index also empties the content filters. You must manually re-enter the content filter settings after a Purge-Index cycle.
  • Help. Opens this help screen.
  • Options. Opens the Options window where settings such as default parameters can be edited.

Quick Tips[edit]

  • If the list is empty then make sure that the Smart Search plugin has been enabled:
    • Go to Extensions → Plugins.
    • Select content from the dropdown headed Select type.
    • Find finder in the list of plugins shown.
    • If there is a green tick Help30-Article-status-featured-published-feature-manager-en.png in the Status column for Smart Search then the Smart Search plugin has been enabled. If there is red circle Help30-Article-status-not-published-feature-manager-en.png then the Smart Search plugin is currently disabled.
  • To enable the Smart Search plugin:
    • Click on the red circle Help30-Article-status-not-published-feature-manager-en.png. This should change to a green tick Help30-Article-status-featured-published-feature-manager-en.png indicating that the Smart Search plugin is now enabled.
    • Click on the Index toolbar icon. This will open a window to show the progress of the indexing operation. The indexing operation may take some time depending on the number of content items on your site and the number of search words and phrases contained in each content item. A progress bar will indicate how much of the indexing process has been completed so far. Do not close this window until indexing has been completed. On sites with a large amount of content this may take a long time (tens of minutes).
  • If you run the indexer and get an "undefined null" error, then check the permissions on the Joomla /logs directory. The web server needs to have write permission to that directory for the indexer to work.

Related Information[edit]

Help Screens[edit]

Component Description
Indexed Content (this screen)

Provides an overview of the content items that have been indexed on a Joomla site.

Content Maps

Provides an overview of the content maps currently in the Smart Search index.

Search Filters

Provides an overview of the static search filters currently available for use in Smart Search.

Search Filters Edit

This is where you can

  • Add a new Search Filter.
  • Edit an existing Search Filter.
Options

Smart Search Options configuration allows setting of parameters used globally for Smart Search.

Menu Item Description
Search

Used to create a page for Smart Search Results, which can be used in conjunction with a Smart Search module to control Search Results Page's layout.


Module Description
Smart Search

Smart Search is an enhanced site search.