Difference between revisions of "Manual:Extension/BlueSpiceInterwikiSearch"

<bs:bookshelf src="Book:User manual" />
        
        
        
        __TOC__
        
        
        
        ==What is BlueSpiceInterwikiSearch?==
        
        '''BlueSpiceInterwikiSearch''' alows simultaneously searching other BlueSpice3 wikis when performing a search on the wiki.
        
        
        
        ==Usage==
        
        [[File:InterwikiSearch1a.png|thumb]]
        
        If BlueSpiceInterwikiSearch is enabled and configured on the wiki, every time user performs a search using the <code>Special:SearchCenter</code>, results from other wikis will be shown as well. Results from other wikis will be shown at the top of the page, below the filters, in form of Wiki name (number of results) buttons.
        
        {{Clear}}
        
        
        
        ===Viewing results from other wikis===
        
        [[File:InterwikiSearch2.PNG|thumb|Results from other wiki in a dialog]]
        
        Clicking on a particular wiki's button will open a dialog containg the first page of the results, in order to enable quick and easy way of visualizing the results. If the desired document is not listed on this page, user can redirect to the target wiki and perform a full search on that wiki, by clicking on "Open full search" button at the top right corner of the dialog. This will open the <code>Special:SearchCenter</code> on the target wiki, with current search term already inserted.
        
        {{Clear}}
        
        
        
        ===Configuring BlueSpiceInterwikiSearch===
        
        In order to set up this service, wiki administrator must add following settings into LocalSettings.php:
        
        
        <pre>
        
        $GLOBALS['bsgBlueSpiceInterwikiSearch']['Wiki_name'] = [
        
           "name" => "Wiki name", // Will be displayed as the wiki name in the results
        
           "api-endpoint" => "http://other.wiki.com/api.com",
        
           "search-on-wiki-url" => "http://other.wiki.com/Special:SearchCenter" // URL to the SearchCenter SpecialPage on target wiki
        
        ];
        
        
        </pre>
        
        '''Note: This does not apply to [[Manual:Extension/BlueSpiceWikiFarm|BlueSpiceWikiFarm]] users, BlueSpiceInterwikiSearch within a WikiFarm is handled separately.'''
        
        
        
        ==See also==
        
        [[Manual:Extension/BlueSpiceExtendedSearch|BlueSpiceExtendedSearch]] extension.
        
        [[Reference:BlueSpiceInterwikiSearch|Reference page]] for this extension.
        
        
        
        {{Translation}}