Discussion

Difference between revisions of "Manual:Extension/BlueSpiceInterwikiSearch"

[unchecked revision][unchecked revision]
m (Text replacement - "<bs:bookshelf src="Book:User manual" />" to "")
(Tag: 2017 source edit)

What is BlueSpiceInterwikiSearch?[edit | edit source]

BlueSpiceInterwikiSearch alows simultaneously searching other BlueSpice3 wikis when performing a search on the wiki.

Usage[edit | edit source]

InterwikiSearch1a.png
Screenshot

If BlueSpiceInterwikiSearch is enabled and configured on the wiki, every time user performs a search using the Special:SearchCenter, 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.


Viewing results from other wikis[edit | edit source]

Results from other wiki in a dialog
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 Special:SearchCenter on the target wiki, with current search term already inserted.


Configuring BlueSpiceInterwikiSearch[edit | edit source]

In order to set up this service, wiki administrator must add following settings into LocalSettings.php: 

$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
];

Note: This does not apply to BlueSpiceWikiFarm users, BlueSpiceInterwikiSearch within a WikiFarm is handled separately.

See also[edit | edit source]

BlueSpiceExtendedSearch extension. Reference page for this extension.

Related info 


        
        
            
            
        __TOC__
        
        
        
        ==What is BlueSpiceInterwikiSearch?==
        
        '''BlueSpiceInterwikiSearch''' alows simultaneously searching other BlueSpice3 wikis when performing a search on the wiki.
        
        
        
        ==Usage==
        
        [[File:InterwikiSearch1a.png|thumbalt=Screenshot|border|center|650x650px]]
        
        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|alt=Results from other wiki in a dialog|border|center|650x650px]]
        
        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==
            
            
        {{Box Links-en|Topic1=[[Manual:Extension/BlueSpiceExtendedSearch|BlueSpiceExtendedSearch]] extension.
            
            [[Reference:BlueSpiceInterwikiSearch|Reference page]] for this extension.
            
            
            
            
        ]]|Topic2=[[Reference:BlueSpiceInterwikiSearch]]}}
            
            
            
            
        {{Translation}}
Line 1: Line 1:
−
 
  
 
__TOC__
 
__TOC__
Line 7: Line 6:
  
 
==Usage==
 
==Usage==
−
[[File:InterwikiSearch1a.png|thumb]]
+
[[File:InterwikiSearch1a.png|alt=Screenshot|border|center|650x650px]]
 
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.
 
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}}
 
{{Clear}}
  
 
===Viewing results from other wikis===
 
===Viewing results from other wikis===
−
[[File:InterwikiSearch2.PNG|thumb|Results from other wiki in a dialog]]
+
[[File:InterwikiSearch2.PNG|Results from other wiki in a dialog|alt=Results from other wiki in a dialog|border|center|650x650px]]
 
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.
 
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}}
 
{{Clear}}
Line 27: Line 26:
 
'''Note: This does not apply to [[Manual:Extension/BlueSpiceWikiFarm|BlueSpiceWikiFarm]] users, BlueSpiceInterwikiSearch within a WikiFarm is handled separately.'''
 
'''Note: This does not apply to [[Manual:Extension/BlueSpiceWikiFarm|BlueSpiceWikiFarm]] users, BlueSpiceInterwikiSearch within a WikiFarm is handled separately.'''
  
−
==See also==
+
{{Box Links-en|Topic1=[[Manual:Extension/BlueSpiceExtendedSearch]]|Topic2=[[Reference:BlueSpiceInterwikiSearch]]}}
−
[[Manual:Extension/BlueSpiceExtendedSearch|BlueSpiceExtendedSearch]] extension.
 
−
[[Reference:BlueSpiceInterwikiSearch|Reference page]] for this extension.
 
  
 
{{Translation}}
 
{{Translation}}
Retrieved from "https://bs3-en.wiki.bluespice.com/w/index.php?title=Manual:Extension/BlueSpiceInterwikiSearch&oldid=18427"

Attachments

Discussions