Difference between revisions of "Manual:Extension/BlueSpiceExtendedSearch"

[unchecked revision][quality revision]
(Tag: 2017 source edit)
 

What is BlueSpiceExtendedSearch?[edit | edit source]

BlueSpiceExtendedSearch replaces the default MediaWiki search engine. It is based on the Elasticsearch engine and provides many improvements over standard MediaWiki search both in terms of quality of indexed content and user interface.

What is indexed in BlueSpiceExtendedSearch?[edit | edit source]

It offers two ways of searching for content:

  • Autocomplete
  • SearchCenter

By default, BlueSpiceExtendedSearch indexes:

  • wiki pages - all content pages on wiki - except for MediaWiki namespace
  • special pages - all SpecialPages on wiki
  • repo files - files uploaded to wiki - for text files like Word documents and PDF, including the content and metadata
  • extenal files - files from arbitrary locations from wiki accessible storage paths (e.g., mounted drives).
  • social entities - entities created by the BlueSpiceSocial extension, like blog posts and user profiles.

Using BlueSpiceExtendedSearch[edit | edit source]

BlueSpiceExtendedSearch offers two ways of searching for content - Autocomplete

Autocomplete

and SearchCenter.

[edit | edit source]

Autocomplete popup with namespace pill set

Autocomplete search is available from any page on the wiki, and can be accessed through the search bar in the top line of the wiki. Autocomplete matches only page and file titles, not the content of the page. After typing in the search bar, an autocomplete popup will appear below it.

Autocomplete popup
Autocomplete popup


This popup is divided in two columns.

Left column:

  • Primary results - these are the results that are direct matches for the search term. These result are displayed in left column of the autocomplete popup. An exact match will be highlighted and contain additional information.

Right column:

  • Tools and secondary results - tools are displayed in the top portion of the right column and contain:
    • Button to create the page with the current search term as the title (only if user has permission to create new pages)
    • Button to execute full-text search for the current term. Selecting this option will lead to the SearchCenter page.

In the bottom portion of the right column, secondary results are displayed. Secondary results are matches that do not directly match the given term, but might be relevant for the user. These will show up only in certain contexts:

  • If there are significantly more matches for a similar term than the term actually searched for (in a situation of a typo for example)
  • If namespace or subpage pill is present. In this case secondary results will show direct matches in other namespaces/pages.

Autocomplete pills[edit | edit source]

Namespace "pill"
Namespace "pill"

Autocomplete search bar supports pills for namespace and subpages.

This means that if a user types "HelpManual:" a pill for the namespace "HelpManual" will be created and any term typed-in after will be only searched in namespace "HelpManual". Subpage pills work in the same way. If the user types in "PageName/", any term given afterwards will be matched in the context of that page, eg. searching If you search for "TestPage/Te", for example, the search will match only subpages of "TestPage" that contain "Te" in the title, like "TestPage/Test" and "TestPage/TestSubpage".

Autocomplete configuration

Configuration[edit | edit source]

Previously explained is the full version of the autocomplete popup. Wiki admins can also choose to use "Simple autocomplete", which contains only one column with primary results and tools, without secondary results. This type of autocomplete is also more compact. This setting is available from BlueSpiceConfigManager, under settings for extension BlueSpiceExtendedSearch - Extension > BlueSpiceExtendedSearch > Use simple autocomplete.

SearchCenter (extended search)[edit | edit source]

SearchCenter Adding filters Editing filter Options dialog Export search

SearchCenter As soon as you trigger the search with the magnifying glass symbol or the Enter key, you switch to the SearchCenter. This is a special page that provides offers the full functionality of the search. Searching The search in the SearchCenter is done over carried out using the same search bar that is also used for autocompleteautomatic completion. SearchCenter consists of several parts.


SearchCenter
SearchCenter
Adding filters
Areas:
  • Hit count - shows how many matches a search has returned. It may be exact or approximate. Approximation is due to dynamic check for permissions to view each page in the results, some results may not be shown to the user with no adequeate permissions event if it matches the search term.
  • Tools - these are located on the top right and represent a set of buttons for managing the search results.
    Editing filter
    • Create a page - represented by a "plus" button - will create a page with current search term as a title (only visible if user has permission to create pages)
    • Add filters - represented by a "funnel" icon - opens a dialog where user can select the type of filter to apply to the search.
    • Search options - represented by a "gear" icon - opens a dialog where user can change settings for the current search. It provides options like number of results per page, sorting field and order...
    • Export search - represented by "export" icon - opens a dialog to export current search results to a dedicated page.
    Filters. Filters
Options dialog
  • Filter: Filters are displayed in form of pills underneat the hit count. Each filter pill represent a different attribute search results can be filtered by. Filter values can be changed by clicking on the filter pill and selecting desired options from the popup that will open. Filter can be removed by clicking on "x" button on the right of each pill.
  • Results. : If current search criteria yields any results, list of results will appear below the filters. Information available in the result are (depending of result type):
    • Main title of the result (page title, file name...)
    • Result type
    • Size and extension (for files)
    • Thumb image (for images) or file type icon (for other file types)
    • Redirect infomartion (for wikipages, if page is a redirect to another page, or another page redirects to it)
    • Original name (for wikipages, if page display title is different than actual page title)
    • Secondary information like, for wikipages, category page belongs to, modification and creation date, author...
    • Snippet of the matches in the content of the page (if there are matches in the page content),
    • Sections with matches in content (for wikipages)

In case there is an exact match for given search term, result that matches exactly will be displayed as "featured" result. Such result will display preview image of the page, and will always display content snippet, regardless of whehter there are matches in the content or not.

Result Results relevance[edit | edit source]

All logged in users can mark certain results as "favouritesfavorites" by clicking on "the star " button symbol in top right corner of each result. Files marked as "favouritefavorite" will score higher in future searches. One user's relevance settings won't affect other user's searches, meaning that if one . If a user marks a result as "favouritefavorite", it will score higher only for that user, not for any of the other usersuser. Results can be unmarked as "favouritefavorite" by clicking on the "star" icon symbol again.

Exporting search results[edit | edit source]

Export search
After running executing the search, results you can be exported export (savedsave) the results to a dedicated specific page by using the "Export" command from the tools "Tools" menu. In the export dialog, user you can enter the name for the list, choose select the format and select specify whether to overwrite eventual the existing list , should be overwritten or append appended to itthe list.

Also, user can uncheck pages not to exportYou can also deselect the pages that should not be exported.

After clicking on you click "Done", the list will be exported to MediaWiki:PageCollection/LISTNAME. LISTENNAME

Only valid wikipages will be are exported.

Configuations

The pages contained in a list can be included in a book in the book function via Mass add> Source: Page collection.

Configuration[edit | edit source]

In BlueSpiceConfigManager, under settings for extension BlueSpiceExtendedSearch, the following configuation options are available:



  • External file paths - External locations to scan for and index files from. These locations are entered in key/value pairs of Physical path and URL prefix. Physical path refers to storage path, eg. for mounted drives X: \Documents
  • URL prefix is what all the files indexed from given location will be prefixed with when accessing files in search results. It should be used if files are available from web server. By default URL prefix will be set to the same value as Physical path.
  • Use simple autocomplete - as described above, checking this option will force usage of simpler, more compact autocomplete
  • Automatically set language filter - this settings is relevant in multi-language wikis. If turned on, it will automatically detect user language and set language filter of searched in SearchCenter, meaning that the user will only receive results in their own language.

SearchAdmin[edit | edit source]

SearchAdmin is a special page, meant for wiki admins. This page provides stats on documents indexed in the search.

  • External file paths: External locations to scan for and index files from. These locations are entered in key/value pairs of Physical path and URL prefix.
    • Physical path: Storage path. For mounted drives, for example: X:\Documents
    • URL prefix: All files indexed from the indexed physical location are prefixed in the search results. It should be used if files are available from a web server. By default, the URL prefix is set to the same value as Physical path.
  • Use simple autocomplete: forces a more compact autocomplete (1-column layout, no thumbnail preview).
    compact autocomplete
    compact autocomplete
    regular autocomplete
    regular autocomplete

  • Automatically set language filter: This setting applies to multi-language wikis. It returns search results for a user only in the user's language. Users can set their language in their preferences.
  • Exclude patterns: Files at external file locations can be exluded from search based on regular expression patterns.


SearchAdmin[edit | edit source]

Special:SearchAdmin is a special page for wiki admins. This page provides stats on documents indexed in the search.

Related info

        __TOC__
        

        ==What is BlueSpiceExtendedSearch?==
        
        '''BlueSpiceExtendedSearch''' replaces the default MediaWiki search engine. It is based on the Elasticsearch engine and provides many improvements over standard MediaWiki search both in terms of quality of indexed content and user interface. 
            
            ==What is indexed in BlueSpiceExtendedSearch?==
            It offers two ways of searching for content:
            

            * Autocomplete
            
            * SearchCenter
            
By default, BlueSpiceExtendedSearch indexes:
        

        *wiki pages - all content pages on wiki - except for MediaWiki namespace
        
        *special pages - all SpecialPages on wiki
        
        *repo files - files uploaded to wiki - for text files like Word documents and PDF, including the content and metadata
        
        *extenal files - files from arbitrary locations from wiki accessible storage paths (e.g., mounted drives).
        
        *social entities - entities created by the [[Manual:Extension/BlueSpiceSocial|BlueSpiceSocial]] extension, like blog posts and user profiles.
        

            
            ==Using BlueSpiceExtendedSearch==
            
            BlueSpiceExtendedSearch offers two ways of searching for content - Autocomplete and SearchCenter.
            
            ===Autocomplete===
            
            [[File:ExtendedSearch1.png|Autocomplete popup with namespace pill set|alt=Autocomplete popup with namespace pill set|border|center|800x800px]]
            
            Autocomplete ==Autocomplete==
            
            Autocomplete search is available from any page on the wiki, and can be accessed through the search bar in the top line of the wiki.
        
        Autocomplete matches only page and file titles, not the content of the page.
        
        After typing in the search bar, an autocomplete popup will appear below it. 
            
            [[File:Manual:extendedsearch-autocompleteEN.png|alt=Autocomplete popup|center|thumb|550x550px|Autocomplete popup]]
            
This popup is divided in two columns.
        
'''Left column:'''
            
*Primary results - these are the results that are direct matches for the search term. These result are displayed in left column of the autocomplete popup. An exact match will be highlighted and contain additional information.
        
'''Right column:'''
            
*Tools and secondary results - tools are displayed in the top portion of the right column and contain:
        
        **Button to create the page with the current search term as the title (only if user has permission to create new pages)
        
        **Button to execute full-text search for the current term. Selecting this option will lead to the SearchCenter page.
        

        In the bottom portion of the right column, secondary results are displayed. Secondary results are matches that do not directly match the given term, but might be relevant for the user. These will show up only in certain contexts:
        

        **If there are significantly more matches for a similar term than the term actually searched for (in a situation of a typo for example)
        
        **If namespace or subpage pill is present. In this case secondary results will show direct matches in other namespaces/pages.
        

        ====Autocomplete pills====
            
            
            [[File:Manual:extendedsearch-pilleEN.png|alt=Namespace "pill"|thumb|Namespace "pill"]]
            Autocomplete search bar supports pills for namespace and subpages.
        
            This means that if a user types "HelpManual:" a pill for the namespace "HelpManual" will be created and any term typed-in after will be only searched in namespace "HelpManual".
        
        Subpage pills work in the same way. If the user types in "PageName/", any term given afterwards will be matched in the context of that page, eg. searching . If you search for "TestPage/Te" , for example, the search will match only subpages of "TestPage" that contain "Te" in the title, like "TestPage/Test" and "TestPage/TestSubpage".
        

        ====Autocomplete configuration====Configuration===
        
        Previously explained is the full version of the autocomplete popup. Wiki admins can also choose to use "Simple autocomplete", which contains only one column with primary results and tools, without secondary results. This type of autocomplete is also more compact.
        
        This setting is available from [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]], under settings for extension BlueSpiceExtendedSearch -''Extension > BlueSpiceExtendedSearch > Use simple autocomplete.
            

            ===SearchCenter===
            
            [[File:ExtendedSearch2.png|thumb|SearchCenter]]
            

            [[File:ExtendedSearch3.png|thumb|Adding filters]]
            
            [[File:ExtendedSearch4.png|thumb|Editing filter]]
            
            [[File:ExtendedSearch5.png|thumb|Options dialog]]
            
            [[File:ExtendedSearch6.png|thumb|Export search]]
            

            SearchCenter ''.
            

            ==SearchCenter (extended search)==
            
            As soon as you trigger the search with the magnifying glass symbol or the ''Enter'' key, you switch to the SearchCenter. This is a special page that provides offers the full functionality of the search. Searching The search in the SearchCenter is done over carried out using the same search bar used for autocomplete. SearchCenter consists of several parts.
            

            *Hit countthat is also used for automatic completion.
            <br />[[File:ExtendedSearch2.png|thumb|SearchCenter|alt=SearchCenter|center|550x550px]][[File:ExtendedSearch3.png|thumb|Adding filters|link=https://en.wiki.bluespice.com/wiki/File:ExtendedSearch3.png]]Areas:
            

            *'''Hit count''' - shows how many matches a search has returned. It may be exact or approximate. Approximation is due to dynamic check for permissions to view each page in the results, some results may not be shown to the user with no adequeate permissions event if it matches the search term.
        
        *'''Tools''' - these are located on the top right and represent a set of buttons for managing the search results.
            [[File:ExtendedSearch4.png|thumb|Editing filter]]
            **Create a page - represented by a "plus" button - will create a page with current search term as a title (only visible if user has permission to  create pages)
        
        **Add filters - represented by a "funnel" icon - opens a dialog where user can select the type of filter to apply to the search.
        
        **Search options - represented by a "gear" icon - opens a dialog where user can change settings for the current search. It provides options like number of results per page, sorting field and order...
        
        **Export search - represented by "export" icon - opens a dialog to export current search results to a dedicated page.
        
*Filters. [[File:ExtendedSearch5.png|thumb|Options dialog]]
            

            * '''Filter:''' Filters are displayed in form of pills underneat the hit count. Each filter pill represent a different attribute search results can be filtered by. Filter values can be changed by clicking on the filter pill and selecting desired options from the popup that will open. Filter can be removed by clicking on "x" button on the right of each pill.
        
        * '''Results.:''' If current search criteria yields any results, list of results will appear below the filters. Information available in the result are (depending of result type):
        
        **Main title of the result (page title, file name...)
        
        **Result type
        
        **Size and extension (for files)
        
        **Thumb image (for images) or file type icon (for other file types)
        
        **Redirect infomartion (for wikipages, if page is a redirect to another page, or another page redirects to it)
        
        **Original name (for wikipages, if page display title is different than actual page title)
        
        **Secondary information like, for wikipages, category page belongs to, modification and creation date, author...
        
        **Snippet of the matches in the content of the page (if there are matches in the page content),
        
        **Sections with matches in content (for wikipages)
        
            In case there is an exact match for given search term, result that matches exactly will be displayed as "featured" result. Such result will display preview image of the page, and will always display content snippet, regardless of whehter there are matches in the content or not.
        
            

            ====Result====Results relevance====
        
        All logged in users can mark certain results as "favouritesfavorites" by clicking on "the star" button symbol in top right corner of each result.
        
        Files marked as "favouritefavorite" will score higher in future searches.
        
        One user's relevance settings won't affect other user's searches, meaning that if one user marks result as "favourite. If a user marks a result as "favorite", it will score higher only for that user, not for any of the other usersuser.
        
        Results can be unmarked as "favouritefavorite" by clicking on the "star" iconsymbol again.
        

        ====Exporting search results====
        After running the search, results can be exported (saved) to a dedicated page by using the "Export" from the tools[[File:ExtendedSearch6.png|thumb|Export search]]After executing the search, you can export (save) the results to a specific page using the "Export" command from the "Tools" menu. In the export dialog, useryou can enter the name for the list, choose select the format and selectspecify whether to overwrite eventual existing list, or append to it.
            

            Also, user can uncheck pages not to export.
            

            After clicking on "Done", the existing list should be overwritten or appended to the list.
            

            You can also deselect the pages that should not be exported.
            

            After you click "Done", the list will be exported to MediaWiki:PageCollection/LISTNAME.LISTENNAME
        

        Only valid wikipages will be are exported.
        

            
            ==Configuations==
            
            In [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]] under settings for extension BlueSpiceExtendedSearch, following configuation options are available:
            

            *External file paths - External locations to scan for and index files from. These locations are entered in key/value pairs of Physical path and URL prefix. 
            
            **Physical path refers to storage path, eg. for mounted drives X:\Documents
            
            **URL prefix is what all the files indexed from given location will be prefixed with when accessing files in search results. It should be used if files are available from web server. By default URL prefix will be set to the same value as Physical path.
            
            *Use simple autocomplete - as described above, checking this option will force usage of simpler, more compact autocomplete
            
            *Automatically set language filter - this settings is relevant in multi-language wikis. If turned on, it will automatically detect user language and set language filter of searched in SearchCenter, meaning that the user will only receive results in their own language.
            

            ==SearchAdmin==
            
            SearchAdminThe pages contained in a list can be included in a book in the book function via ''Mass add> Source: Page collection.''
            

            ==Configuration==
            
            In [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]], under settings for extension BlueSpiceExtendedSearch, the following configuation options are available:
            
<br />
            

            {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}
            

            ==SearchAdmin==
            <code>Special:SearchAdmin</code> is a special page, meant  for wiki admins. This page provides stats on documents indexed in the search.
            

            {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}
            

            {{{{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedSearch]]}}
        

        {{Translation}}
Line 3: Line 3:
  
 
==What is BlueSpiceExtendedSearch?==
 
==What is BlueSpiceExtendedSearch?==
'''BlueSpiceExtendedSearch''' replaces the default MediaWiki search engine. It is based on the Elasticsearch engine and provides many improvements over standard MediaWiki search both in terms of quality of indexed content and user interface.
+
'''BlueSpiceExtendedSearch''' replaces the default MediaWiki search engine. It is based on the Elasticsearch engine and provides many improvements over standard MediaWiki search both in terms of quality of indexed content and user interface. It offers two ways of searching for content:
 +
 
 +
* Autocomplete
 +
* SearchCenter
  
==What is indexed in BlueSpiceExtendedSearch?==
 
 
By default, BlueSpiceExtendedSearch indexes:
 
By default, BlueSpiceExtendedSearch indexes:
  
Line 14: Line 16:
 
*social entities - entities created by the [[Manual:Extension/BlueSpiceSocial|BlueSpiceSocial]] extension, like blog posts and user profiles.
 
*social entities - entities created by the [[Manual:Extension/BlueSpiceSocial|BlueSpiceSocial]] extension, like blog posts and user profiles.
  
 
+
==Autocomplete==
==Using BlueSpiceExtendedSearch==
 
BlueSpiceExtendedSearch offers two ways of searching for content - Autocomplete and SearchCenter.
 
===Autocomplete===
 
[[File:ExtendedSearch1.png|Autocomplete popup with namespace pill set|alt=Autocomplete popup with namespace pill set|border|center|800x800px]]
 
 
Autocomplete search is available from any page on the wiki, and can be accessed through the search bar in the top line of the wiki.
 
Autocomplete search is available from any page on the wiki, and can be accessed through the search bar in the top line of the wiki.
 
Autocomplete matches only page and file titles, not the content of the page.
 
Autocomplete matches only page and file titles, not the content of the page.
After typing in the search bar, an autocomplete popup will appear below it. This popup is divided in two columns.
+
After typing in the search bar, an autocomplete popup will appear below it.  
 +
[[File:Manual:extendedsearch-autocompleteEN.png|alt=Autocomplete popup|center|thumb|550x550px|Autocomplete popup]]
 +
 
 +
 
 +
This popup is divided in two columns.
 +
 
 +
'''Left column:'''
  
 
*Primary results - these are the results that are direct matches for the search term. These result are displayed in left column of the autocomplete popup. An exact match will be highlighted and contain additional information.
 
*Primary results - these are the results that are direct matches for the search term. These result are displayed in left column of the autocomplete popup. An exact match will be highlighted and contain additional information.
 +
 +
'''Right column:'''
  
 
*Tools and secondary results - tools are displayed in the top portion of the right column and contain:
 
*Tools and secondary results - tools are displayed in the top portion of the right column and contain:
Line 31: Line 37:
 
In the bottom portion of the right column, secondary results are displayed. Secondary results are matches that do not directly match the given term, but might be relevant for the user. These will show up only in certain contexts:
 
In the bottom portion of the right column, secondary results are displayed. Secondary results are matches that do not directly match the given term, but might be relevant for the user. These will show up only in certain contexts:
  
**If there are significantly more matches for a similar term than the term actually searched for (in a situation of a typo for example)
+
*If there are significantly more matches for a similar term than the term actually searched for (in a situation of a typo for example)
**If namespace or subpage pill is present. In this case secondary results will show direct matches in other namespaces/pages.
+
*If namespace or subpage pill is present. In this case secondary results will show direct matches in other namespaces/pages.
  
====Autocomplete pills====
+
===Autocomplete pills===
 +
[[File:Manual:extendedsearch-pilleEN.png|alt=Namespace "pill"|thumb|Namespace "pill"]]
 
Autocomplete search bar supports pills for namespace and subpages.
 
Autocomplete search bar supports pills for namespace and subpages.
This means that if a user types "Help:" a pill for the namespace "Help" will be created and any term typed-in after will be only searched in namespace "Help".
 
Subpage pills work in the same way. If the user types in "PageName/", any term given afterwards will be matched in the context of that page, eg. searching for "TestPage/Te" will match only subpages of "TestPage" that contain "Te" in the title, like "TestPage/Test" and "TestPage/TestSubpage".
 
  
====Autocomplete configuration====
+
This means that if a user types "Manual:" a pill for the namespace "Manual" will be created and any term typed-in after will be only searched in namespace "Manual".
 +
Subpage pills work in the same way. If the user types in "PageName/", any term given afterwards will be matched in the context of that page. If you search for "TestPage/Te", for example, the search will match only subpages of "TestPage" that contain "Te" in the title, like "TestPage/Test" and "TestPage/TestSubpage".
 +
 
 +
===Configuration===
 
Previously explained is the full version of the autocomplete popup. Wiki admins can also choose to use "Simple autocomplete", which contains only one column with primary results and tools, without secondary results. This type of autocomplete is also more compact.
 
Previously explained is the full version of the autocomplete popup. Wiki admins can also choose to use "Simple autocomplete", which contains only one column with primary results and tools, without secondary results. This type of autocomplete is also more compact.
This setting is available from [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]], under settings for extension BlueSpiceExtendedSearch - Use simple autocomplete.
+
This setting is available from [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]], under ''Extension > BlueSpiceExtendedSearch > Use simple autocomplete''.
 
 
===SearchCenter===
 
[[File:ExtendedSearch2.png|thumb|SearchCenter]]
 
  
[[File:ExtendedSearch3.png|thumb|Adding filters]]
+
==SearchCenter (extended search)==
[[File:ExtendedSearch4.png|thumb|Editing filter]]
+
As soon as you trigger the search with the magnifying glass symbol or the ''Enter'' key, you switch to the SearchCenter. This is a special page that offers the full functionality of the search. The search in the SearchCenter is carried out using the same search bar that is also used for automatic completion.
[[File:ExtendedSearch5.png|thumb|Options dialog]]
+
<br />[[File:ExtendedSearch2.png|thumb|SearchCenter|alt=SearchCenter|center|550x550px]][[File:ExtendedSearch3.png|thumb|Adding filters|link=https://en.wiki.bluespice.com/wiki/File:ExtendedSearch3.png]]Areas:
[[File:ExtendedSearch6.png|thumb|Export search]]
 
  
SearchCenter is a special page that provides full functionality of the search.
+
*'''Hit count''' - shows how many matches a search has returned. It may be exact or approximate. Approximation is due to dynamic check for permissions to view each page in the results, some results may not be shown to the user with no adequeate permissions event if it matches the search term.
Searching in SearchCenter is done over the same search bar used for autocomplete. SearchCenter consists of several parts.
+
*'''Tools''' - these are located on the top right and represent a set of buttons for managing the search results.[[File:ExtendedSearch4.png|thumb|Editing filter]]
 
 
*Hit count - shows how many matches a search has returned. It may be exact or approximate. Approximation is due to dynamic check for permissions to view each page in the results, some results may not be shown to the user with no adequeate permissions event if it matches the search term.
 
*Tools - these are located on the top right and represent a set of buttons for managing the search results.
 
 
**Create a page - represented by a "plus" button - will create a page with current search term as a title (only visible if user has permission to  create pages)
 
**Create a page - represented by a "plus" button - will create a page with current search term as a title (only visible if user has permission to  create pages)
 
**Add filters - represented by a "funnel" icon - opens a dialog where user can select the type of filter to apply to the search.
 
**Add filters - represented by a "funnel" icon - opens a dialog where user can select the type of filter to apply to the search.
Line 61: Line 62:
 
**Export search - represented by "export" icon - opens a dialog to export current search results to a dedicated page.
 
**Export search - represented by "export" icon - opens a dialog to export current search results to a dedicated page.
  
*Filters. Filters are displayed in form of pills underneat the hit count. Each filter pill represent a different attribute search results can be filtered by. Filter values can be changed by clicking on the filter pill and selecting desired options from the popup that will open. Filter can be removed by clicking on "x" button on the right of each pill.
+
[[File:ExtendedSearch5.png|thumb|Options dialog]]
*Results. If current search criteria yields any results, list of results will appear below the filters. Information available in the result are (depending of result type):
+
 
 +
* '''Filter:''' Filters are displayed in form of pills underneat the hit count. Each filter pill represent a different attribute search results can be filtered by. Filter values can be changed by clicking on the filter pill and selecting desired options from the popup that will open. Filter can be removed by clicking on "x" button on the right of each pill.
 +
* '''Results:''' If current search criteria yields any results, list of results will appear below the filters. Information available in the result are (depending of result type):
 
**Main title of the result (page title, file name...)
 
**Main title of the result (page title, file name...)
 
**Result type
 
**Result type
Line 72: Line 75:
 
**Snippet of the matches in the content of the page (if there are matches in the page content),
 
**Snippet of the matches in the content of the page (if there are matches in the page content),
 
**Sections with matches in content (for wikipages)
 
**Sections with matches in content (for wikipages)
 
+
In case there is an exact match for given search term, result that matches exactly will be displayed as "featured" result. Such result will display preview image of the page, and will always display content snippet, regardless of whehter there are matches in the content or not.
In case there is an exact match for given search term, result that matches exactly will be displayed as "featured" result. Such result will display preview image of the page, and will always display content snippet, regardless of whehter there are matches in the content or not.  
+
====Results relevance====
 
+
All logged in users can mark certain results as "favorites" by clicking on the star symbol in top right corner of each result.
====Result relevance====
+
Files marked as "favorite" will score higher in future searches.
All logged in users can mark certain results as "favourites" by clicking on "star" button in top right corner of each result.
+
One user's relevance settings won't affect other user's searches. If a user marks a result as "favorite", it will score higher only for that user, not for any other user.
Files marked as "favourite" will score higher in future searches.
+
Results can be unmarked as "favorite" by clicking on the "star" symbol again.
One user's relevance settings won't affect other user's searches, meaning that if one user marks result as "favourite", it will score higher only for that user, not for any of the other users.
 
Results can be unmarked as "favourite" by clicking on "star" icon again.
 
  
 
====Exporting search results====
 
====Exporting search results====
After running the search, results can be exported (saved) to a dedicated page by using the "Export" from the tools menu.
+
[[File:ExtendedSearch6.png|thumb|Export search]]After executing the search, you can export (save) the results to a specific page using the "Export" command from the "Tools" menu. In the export dialog, you can enter the name for the list, select the format and specify whether the existing list should be overwritten or appended to the list.
In the export dialog, user can enter the name for the list, choose format and select whether to overwrite eventual existing list, or append to it.
 
 
 
Also, user can uncheck pages not to export.
 
  
After clicking on "Done", list will be exported to MediaWiki:PageCollection/LISTNAME.
+
You can also deselect the pages that should not be exported.
  
Only valid wikipages will be exported.
+
After you click "Done", the list will be exported to MediaWiki:PageCollection/LISTENNAME
  
 +
Only valid wikipages are exported.
  
==Configuations==
+
The pages contained in a list can be included in a book in the book function via ''Mass add> Source: Page collection.''
In [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]] under settings for extension BlueSpiceExtendedSearch, following configuation options are available:
 
  
*External file paths - External locations to scan for and index files from. These locations are entered in key/value pairs of Physical path and URL prefix.
+
==Configuration==
**Physical path refers to storage path, eg. for mounted drives X:\Documents
+
In [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]], under settings for extension BlueSpiceExtendedSearch, the following configuation options are available:
**URL prefix is what all the files indexed from given location will be prefixed with when accessing files in search results. It should be used if files are available from web server. By default URL prefix will be set to the same value as Physical path.
 
*Use simple autocomplete - as described above, checking this option will force usage of simpler, more compact autocomplete
 
*Automatically set language filter - this settings is relevant in multi-language wikis. If turned on, it will automatically detect user language and set language filter of searched in SearchCenter, meaning that the user will only receive results in their own language.
 
  
==SearchAdmin==
+
<br />
SearchAdmin is a special page, meant for wiki admins.
 
This page provides stats on documents indexed in the search.
 
  
 
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}
 
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}
  
{{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedSearch]]}}
+
==SearchAdmin==
 +
<code>Special:SearchAdmin</code> is a special page for wiki admins. This page provides stats on documents indexed in the search.{{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedSearch]]}}
  
 
{{Translation}}
 
{{Translation}}

Attachments

Discussions