Difference between revisions of "Manual:Extension/BlueSpiceExtendedSearch"

<bs:bookshelf src="Book:User manual" />
            
            
            
            __TOC__
            
            
            
            ==What is BlueSpiceExtendedSearch?==
            
            '''BlueSpiceExtendedSearch''' replaces {{DISPLAYTITLE:Extended search}}
            
            
            
            '''ExtendedSearch''' replaces the default MediaWiki search engine. It is based on ElasticSearch engine,the [[Setup:Installation Guide/System Preparation/Linux/Elasticsearch|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?==
            
            By default BlueSpiceExtendedSearch indexes:
            
            
            
            *wikipages - all content pages on wiki - except for MediaWiki namespace
            
            *specialpages - all SpecialPages on wiki
            
            *repofiles - files uploaded to wiki - for textualPages and files are indexed immediately and available for searching in real-time. 
            
            
            
            ==Usage==
            
            
            <div class="training"><section begin="training" />
            
            Extended search offers two ways of searching for content:
            
            
            
            #'''Title search''' using the quick search 
            
            #'''Fulltext search''' using the search center
            
            
            
            By default, the search indexes:
            
            
            
            *wiki pages: all content pages, except for pages in the MediaWiki namespace
            
            *special pages: all pages in the namespace ''Special''
            
            *repo files: files uploaded to the wiki - for text files like Word documents and PDF, including thePDFs, this includes content and metadata
        
        *extenalfiles -external files: files from arbitrary locations from wiki accessible storage paths, eg. mounted drives.
            
            *socialentities - entities created by  (e.g., mounted drives)
            
            *social entities: entities (pages) 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|thumb|Autocomplete popup with namespace pill set]]
            
            Autocomplete search 
            
            
            <section end="training" /></div>
            
            ==Autocomplete==
            
            The search box in the main toolbar offers with autocomplete functionality 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, but does not the content of the page.
            
            
        provide a full-text serach. 
            
            
            
            
        After typing in the search bar, an autocomplete popup will appear below it. appears: 
            
             
            
            [[File:Manual:extendedsearch-autocompleteEN.png|alt=Autocomplete popup|center|thumb|550x550px|Autocomplete popup]]
            
            
            
            
            
            
        This popup is divided in two columns.
        
        
        
        
        *Primary results - these '''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.
            
            
            
            *Tools and secondary results - tools The exact matches are shown in bold letters.
            
            *When looking for the term "quality management", it is also possible to type in "qual man" and the search starts looking for matches
            
            *The best match is often shown with a thumbnail preview as a top search result
            
            
            
            '''Right column:'''
            
            
            
            *T'''ools and secondary results:''' Tools are displayed in the top portion of the right column and contain:
        
        **Button a button to create the page with the current search term as the title (only if user has permission to create new pages)
        
        **Button a button to execute full-text search for the current term. Selecting this option will lead leads to the SearchCenter pageSearch Center.
        
        
        
        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 the namespace or subpage pill is present (see next section). In this case, secondary results will show direct matches in other namespaces/pages.
        
        
        
        ====Autocomplete pills====Namespace and subpage "pills"===
        
        Autocomplete search bar supports pills for namespacenamespaces and subpages. This means that if a user types "Help:"[[File:Manual:extendedsearch-pilleEN.png|alt=Namespace "pill"|thumb|Namespace "pill"|center]]
            
            If a user types <code>Manual:</code>, a pill for the namespace "Help" will be created and any term typed-in after will be only searched in namespace "Help"Manual" appears and the search for the following term is limited to this namespace. .
        
        Subpage pills work in the same way. If the user types in "<code>PageName/"</code>, any term given afterwards will be after that is 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 ''.
            
            
            
            ===Search operators===
            
            Since the autocomplete search only searches for titles, search operators such as AND or OR are not supported. However, they are supported using the Search Center.
            
            
            
            ===Dates as search terms===
            
            The search recognizes certain date formats. In the search center, these date formats are treated with surrounding quotation marks.  <gallery widths="400" heights="200">
            
            File:extendedsearch-datum1.png|alt=Date format 1|Date format 1
            
            File:extendedsearch-datum2.png|alt=Date format 2|Date format 2
            
            
            </gallery><br />
            
            ==Search Center (extended search)==
            
            As soon as you trigger the full-search with the magnifying glass symbol or the ''Enter'' key, the wiki switches to the Search Center. This is a special page that provides offers the full functionality of the search. Searching The search in SearchCenter is done over the Search Center is carried out using the same search bar that is also used for autocomplete. SearchCenter consists of several parts.
            
            
            
            *Hit count
            
            Here, the search engine carries out a full text search, which also includes the metadata of documents. It does not index the wikitext of a wiki page, but rather the rendered content, that is the output by the browser.<br />[[File:ExtendedSearch2.png|thumb|Search Center|alt=SearchCenter|center|650x650px]]
            
            
            
            ===Search operators===
            
            To use search operators in the full-text search, the following syntax can be used:
            
            
            
            *Sandbox '''AND'''  Widgets - returns pages that contain both the term sandbox and the term widgets
            
            *Sandbox '''OR''' Widgets - returns pages that contain either the term sandbox or the term widgets.
            
            *(Sandbox) '''NOT''' (Widgets) - returns pages that contain the term sandbox but not the term widgets..<br />
            
            
            
            The search operators have to be written in uppercase letters.
            
            
            
            ===Elements===
            
            
            
            *'''Hit count''' - shows how many matches a search has returned. It may be exact ofor 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 onin the top right and represent as 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)
        
        **Add filters - represented by a "funnel" icon - opens a dialog where userusers can select the type of filter to apply to the search.
            
            
        <br />[[File:ExtendedSearch3.png|thumb|Adding filters|link=https://en.wiki.bluespice.com/wiki/File:ExtendedSearch3.png|center|650x650px]]
            
            
        **Search options - represented by a "gear" icon - opens a dialog where userusers can change settings for the current search. It provides options like the number of results per page, sorting field and order...
            
            
        <br />[[File:ExtendedSearch5.png|thumb|Options dialog|center|650x650px]]
            
            
        **Export search - represented by the "export" icon - opens a dialog to export current search results to a dedicated page.
            
            
            
            *Filters. (only visible to authorized users, by default admin users).
            
            
            
            *'''Filter:''' Filters are displayed in form of pills underneatbelow the hit countresults counter. Each filter pill representrepresents a different attribute search results can be filtered by. Filter values can be changed by clicking on the filter pill and selecting the desired options from the popup that will open. Filter can be removed by clicking on  the "x" button on the right of each pill.
            
            *Results.in each pill.<br />[[File:ExtendedSearch4.png|thumb|Editing filter|alt=Editing filter|center|650x650px]]
            
            *'''Results:''' If current search criteria yieldsyield any results, a list of results will appear below the filters. Information available in the result are (depending of is displayed. The information available in the results is depending on the 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)
            
            
        information
            
            
        **Original name (for wikipages, if the page display title is different than the actual page title)
        
        **Secondary information like, for wikipages, category page belongs to page categories, modification and creation date, author..., etc.
        
        **Snippet of the matches in the content of the page (if there are matches in the page content),
        
        **Sections with matches in the content (for wikipages)
        
        
        
        In case there is an exact match for a given search term, the result that matches exactly will be is displayed as a "featured" result. Such a result will displaydisplays a preview image of the page, and will always display displays the content snippet, regardless of whehterwhether 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 topthe right corner of each result.
        
        Files marked as "favouritefavorite" will score higher in future searches - this is not visible immediately, however, but happens over time.
        
        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 "favouritefavorite" by clicking on the "star" iconsymbol again.
        
        
        
        ====Exporting search results====
        
        After runningexecuting the search, resultsadministrators can be exported (saved) to a dedicated page by using the "Export" from the tools menu.
            
            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.
            
            
            
            Only valid wikipages will be exported.
            
            
            
            
            
            ==Configuations==
            
            In export (save) the results to a specific page using the "Export" command from the "Tools" menu. The list is exported to ''MediaWiki:PageCollection/LISTENNAME.''
            
            
            
            Only valid wikipages are exported. The pages contained in a list can be included in a book in the book function via ''Mass add> Source: Page collection.''[[File:ExtendedSearch6.png|thumb|Export search|alt=Export search|center|650x650px]]
            
            ==Configuration==
            
            In the [[Manual:Extension/BlueSpiceConfigManager‏‎‏‎|BlueSpiceConfigManager]], under settings for the extension ''BlueSpiceExtendedSearch, following configuation'', the following configuration 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==
            
            SearchAdmin<br />
            
            
            
            {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}
            
            
            
            ==SearchAdmin==
            
            ''Special:SearchAdmin'' is a special page, meant  for wiki admins. This page providerprovides stats on documents indexed in the search.
            
            
            
            
            
            ==See also==
            
            
            
            [[Reference:ExtendedSearch|Eeference page]] for this extension.{{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedSearch]]}}
            
            
            
            {{Translation}}
            
            __FORCETOC__
            
            
            
            [[Category:Search]]