9 Manual:Extension/BlueSpiceConfigManager and Manual:Extension/BlueSpiceExtendedSearch: Difference between pages

(Difference between pages)
No edit summary
 
No edit summary
Tag: 2017 source edit
 
Line 1: Line 1:
<bookshelf src="Book:Admin manual" />
<bookshelf src="Book:User manual" />
{{DISPLAYTITLE:Config manager}}
{{DISPLAYTITLE:Extended search}}
__TOC__


With the Config manager, a wiki user with ''sysop'' rights can manage BlueSpice wiki-wide settings in one place. In the [[BlueSpice Layout|navigation]], it is located under ''Global navigations > Management > Config manager''.This link loads the page ''Special:ConfigManager.''
'''ExtendedSearch''' replaces the default MediaWiki search engine. It is based on 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. Pages and files are indexed immediately and available for searching in real-time.  


==Layout==
==Usage==
<div class="training"><section begin="training" />
Extended search offers two ways of searching for content:


===Filter options===
#'''Title search''' using the quick search
All settings can be accessed through the following filter options:
#'''Fulltext search''' using the search center


*'''Feature:''' group by type of functionality the setting belongs to (search, administration...)
By default, the search indexes:
*'''Extension:''' group by extension name
*'''Package:''' group by BlueSpice edition and services (BlueSpice free, BlueSpice pro, Matomo)<br />
[[File:Manual:ConfigManager2a.png|alt=config manager filters|center|thumb|401x401px|config manager filter]]


*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 PDFs, this includes content and metadata
*external files: files from arbitrary locations from accessible storage paths (e.g., mounted drives)
*social entities: entities (pages) created by the [[Manual:Extension/BlueSpiceSocial|BlueSpiceSocial]] extension, like blog posts and user profiles
<section end="training" /></div>
==Autocomplete==
The search box in the main toolbar offers with autocomplete functionality is available from any page on the wiki. Autocomplete matches only page and file titles, but does not provide a full-text search.


All settings are available in any type of grouping. Changing the grouping type does not add or remove setting options. It just groups them differently. After settings are adjusted, they can be saved by clicking ''Save'', or cancelled by clicking ''Reset''.
After typing in the search bar, an autocomplete popup appears:
[[File:Manual:Autocomplete.png|alt=|center|thumb|366x366px|Autocomplete popup]]


{{Messagebox|boxtype=note|Note text=If a server administrator has configured a setting to no longer be writable, it will be shown as greyed-out in the config manager. You will have to talk to your server administrator about changing such a setting.}}


===Searching for settings===
This popup is divided in two columns.
A search bar is located above the list of settings. Type in a keyword such as "logo" to find the corresponding setting. The search returns settings regardless of the currently selected group. {{Messagebox|boxtype=note|Note text=The search field has to be empty if you want to see the filter menu instead of the search.}}<br />
[[File:Manual:configmanager-search.png|alt=Config manager search box|center|thumb|400x400px|Config manager search box]]


==Settings by extension==
'''Left column:'''


=== EventBus ===
*'''Primary results:''' These are the results that are direct matches for the search term. The exact matches are shown in bold letters.
Eventbus sends notifications to external urls in case something happens in the wiki. For example, if a page is created, an external service could then be started and create a pdf of that page. See the extension's page on [[mediawikiwiki:Extension:EventBus|mediawiki.org]].
*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


===BlueSpiceFoundation===
'''Right column:'''


====Updating logo and favicon====
*T'''ools and secondary results:''' Tools are displayed in the top portion of the right column and contain:
{{Messagebox|boxtype=note|icon=|Note text=Since BlueSpice 4.2, the logo and favicon can also be managed via the page Special:Flexiskin together with further skin customizations.|bgcolor=}}
**a button to create the page with the current search term as the title (only if user has permission to create new pages)
*'''Logo path:''' The logo image should be stored in the /images folder of your installation. If you store it in the /skins folder of your BlueSpice installation, it could be overwritten with an upgrade.
**a button to execute full-text search for the current term. Selecting this option leads to the Search Center.


'''To upload the logo directly in the wiki:'''
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 show up only in certain contexts:


#'''Upload''' the logo on the page ''Extended file list'' (''Special:ExtendedFilelist''). This is a link under the ''Global actions'' navigation.
*If there are significantly more matches for a similar term than the term actually searched for (in a situation of a typo for example)
#'''Search''' for the logo name in the extended file list.
*If the namespace or subpage pill is present (see next section). In this case, secondary results will show direct matches in other namespaces/pages.
#'''Click''' on the thumbnail image of the logo. This opens the logo on a separate page.<br />[[File:Manual:config-logo1.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:config-logo1.png|alt=logo thumbnail image|center|thumb|280x280px|logo thumbnail image]]
#'''Copy''' the relative logo path from the address bar.In a typical Wiki configuration, this path starts with ''/w/....'' .<br />[[File:Manual:config-logo2.png|alt=relative image path|center|thumb|450x450px|relative image path]]
#'''Paste''' the logo path into the text field for the logo.<br />[[File:Manual:config-logo3.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:config-logo3.png|alt=logo path|center|thumb|450x450px|logo path]]
#'''Click''' ''Save''.
#'''Refresh''' the page (Strg+F5). <br />If the uploaded logo is too large, you can add the following code snippet to the page ''MediaWiki:Common.css''. This automatically adjusts the image to the height of the main toolbar:<syntaxhighlight lang="css">
.bs-logo a {background-size: contain;}
</syntaxhighlight>


*'''Favicon path:''' The favicon image should be stored in the ''/images'' folder of your installation. If you store it in the /skins folder of your BlueSpice installation, it could be overwritten with an upgrade. [https://de.wikipedia.org/wiki/Favicon Favicon images] have the file extension ''.ico''.
===Namespace and subpage "pills"===
Autocomplete search bar supports pills for namespaces and subpages. [[File:extendedsearch-pilleEN.png|thumb|Namespace "pill"|center|link=Special:FilePath/extendedsearch-pilleEN.png]]
If a user types <code>Manual:</code>, a pill for the namespace "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 after that is 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".


====System====
===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 ''Extension > BlueSpiceExtendedSearch > Use simple autocomplete''.


*'''Allowed file extensions:''' For security reasons, the types of files that users can upload are restricted. Here, you can allow additional file formats. If a file format is blacklisted in the server configuration, adding this file extension here will not allow this file type to be uploaded. See [https://mediawiki.org/wiki/Manual:Page_title mediawiki.org/wiki/Manual:Page_title] for more info.
===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:Manual:extendedsearch-datum1.png
File:Manual:extendedsearch-datum2.png
</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 offers the full functionality of the search. The search in the Search Center is carried out using the same search bar that is also used for autocomplete.  
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:Manual:extendedsearch-searchcenter.png|link=link=Special:FilePath/ExtendedSearch2.png|alt=|center|thumb|402x402px|Search Center]]


*'''Allowed image extensions:''' The standard web image types are listed here. In general, you want to restrict image uploads to web images. See [https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types] for more on browser-supported image types.
===Search operators ===
{{Messagebox|boxtype=Important|icon=|Note text=Search operators only work in the search center (fulltext search). You cannot use search operators in the title search.|bgcolor=}}
Search operators have to be written in '''all-caps'''.
====AND====
*<code>admin AND docu</code>: Returns pages that contain the '''exact term''' <code>admin</code> '''as well as the exact term''' <code>docu</code>
*<code>admin* AND docu</code>: If the term  <code>administration</code>  should be found, you need to provide a wildcard asterisk (<code>*</code>).
'''Compare''': The search <code>admin docu</code>  automatically is a wildcard search. It returns pages that contain '''both''' <code>admin*</code> '''and''' <code>docu*</code> . This search normally finds more results than the serach  <code>admin* AND docu</code> (because in the second case, the exact term <code>docu</code> is returned).
====<code>"</code> (apostrophes)====
Apostrophes around a search term triggers an <code>AND</code> search for '''all terms''' in the query:
*<code>"admin" docu</code>: same result as <code>admin AND docu</code> (i.e., also the precise term  <code>docu</code>  will be searched).
====NOT====
*<code>admin* NOT docu*</code>: Returns pages that contain words that start with  <code>admin</code> , but that don't contain words that start with <code>docu</code> .
====OR====
*<code>admin OR docu</code>: Returns pages that contain '''either the exact term''' <code>admin</code> '''or the exact term''' <code>docu</code>.
====<code>*</code> (wildcard)====
*<code>'''admin*'''</code>: Returns pages that contain words that begin with <code>admin</code> .


===BlueSpiceArticleInfo===
===Elements===
''BlueSpiceArticleInfo'', together with ''[[Manual:Extension/BlueSpiceAuthors|BlueSpiceAuthors]], [[Manual:Extension/BlueSpiceReaders|BlueSpiceReaders]], and [[Manual:Extension/BlueSpiceExtendedSearch|BlueSpiceExtendedSearch]]'' is part of the ''Page information'' in the quality management tools.


*'''Update interval in seconds:''' Sets the refresh rate for the "Last edit" value. By default, this date is updated every 10 seconds via JavaScript.
*'''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 adequate permissions event if it matches the search term.
[[File:Manual:ArticleInfo.png|link=link=Special:FilePath/ArticleInfo3.jpg|alt=|center|thumb|374x374px|article info]]
*'''Tools''' - these are located in the top right as a set of buttons:
**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 users can select the type of filter to apply to the search.<br />[[File:Manual:extendedsearch3.png|link=link=https://en.wiki.bluespice.com/wiki/File:ExtendedSearch3.png|alt=|center|thumb|341x341px|Adding filters]]
**Search options - represented by a "gear" icon - opens a dialog where users can change settings for the current search. It provides options like the number of results per page, sorting field and order.<br />[[File:Manual:extendedsearch4.png|link=link=Special:FilePath/ExtendedSearch5.png|alt=|center|thumb|Options dialog]]
**Export search - represented by the "export" icon - opens a dialog to export current search results to a dedicated page (only visible to authorized users, by default admin users).


===BlueSpiceAuthors===
*'''Filter:''' Filters are displayed in form of pills below the results counter. Each filter pill represents a different attribute. 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 in each pill.<br />[[File:Manual:extendedsearch2.png|link=link=Special:FilePath/ExtendedSearch4.png|alt=|center|thumb|Editing filter]]
''BlueSpiceAuthors,'' together with ''[[Manual:Extension/BlueSpiceArticleInfo|BlueSpiceArticleInfo]]'' and ''BlueSpiceReaders'', is part of the ''Page information'' in the quality management tools.
*'''Results:''' If current search criteria field any results, a list of results 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 information
**Original name (for wikipages, if the page display title is different than the actual page title)
**Secondary information like 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)


*'''Display authors:''' Show or hide authors on the page information page.
In case there is an exact match for a given search term, the result that matches exactly is displayed as a "featured" result. Such a result displays a preview image of the page and always displays the content snippet, regardless of whether there are matches in the content or not.
[[File:Manual:PageInformation Authors.png|alt=|center|page=authors in page information|thumb|332x332px|Authors of page]]
====Results relevance====
All logged-in users can mark certain results as "favorites" by clicking on the star symbol in the right corner of each result.
Files marked as "favorite" 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. Results can be unmarked as "favorite" by clicking on the "star" symbol again.


===BlueSpiceAvatars===
====Exporting search results====
[[File:Manual:configmanager-instantavatar.png|thumb|101x101px|InstantAvatar|link=Special:FilePath/Manual:configmanager-instantavatar.png]]
After executing the search, administrators can export (save) the results to a specific page using the "Export" command from the "Tools" menu. The list is exported to ''MediaWiki:PageCollection/LISTENNAME.''
An avatar image is automatically generated if the user does not upload a profile picture or if the user decides to create an avatar image in the preferences.


*'''Generator'''
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.''
**'''InstantAvatar:''' Generates an avatar image based on using the initials of the Real name or the Username
[[File:Manual:ExtendedSearch5.png|link=link=Special:FilePath/ExtendedSearch6.png|alt=|center|thumb|Export search]]
**'''[[wikipedia:Identicon|Identicon:]]''' Generates an avatar image based on parts of the user's IP address.<br />[[File:Manual:configmanager-identicon.png|alt=Identicon|center|thumb|500x500px|Identicon]]


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


*'''Show book chapter pager after content:''' Displays previous/next book page navigation at the end of each book page. (1)
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceExtendedSearch}}
*'''Show book chapter pager before content:'''  Displays previous/next book page navigation at the beginning of each book page. (2) <br />[[File:Manual:book-pagenav.png|alt=Book navigation|center|thumb|450x450px|Book navigation ]]<br />
*'''Use the display title from book source on article:''' Shows the title from the book navigation as page title instead of the page name. <br />
[[File:Manual:bookdisplaytitle.png|alt=book display title|center|thumb|450x450px|book display title]]
{{Messagebox|boxtype=note|Note text=If the page additionally contains a <nowiki>{{DISPLAYTITLE}}</nowiki> tag, the display title of the page is shown instead of the book title.}}


*'''Prepend article table of contents and headlines with book numberation:''' The page TOC does not start with the main heading 1, but with the actual number from the book chapter (see screenshot). If users have activated in their [[Manual:Preferences#Advanced options|user preferences]] to "auto-number headings", the numbering system is matched accordingly. [[File:prepand TOC with book chapter.png|alt=Prepended chapter numbers|center|thumb|650x650px|Prepended chapter numbers]]
==SearchAdmin==
*'''Supress namespace prefix of book articles in output:''' The namespace prefix of an article is not shown in PDFs.
''Special:SearchAdmin'' is a special page for wiki admins. This page provides stats on documents indexed in the search.{{Box Links-en|Topic1=[[Reference:BlueSpiceExtendedSearch]]}}


===BlueSpiceChecklist===
{{Translation}}
__FORCETOC__


*'''Mark checklist changes as minor edit:''' If this setting is active, changes to a checklist (for example, checking a checkbox) in view mode are logged as minor edits. If this setting is inactive, a change to the checklist is  recorded as a regular version in the page history.<br />[[File:Manual:configmanager-checklistminoredit.png|alt=minor edit|center|thumb|550x550px|minor edit]]
[[Category:Search]]
 
===BlueSpiceExtendedSearch===
 
*'''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: S''torage 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''.
 
 
{| class="wikitable" style="width:100%;"
|+Examples for external file paths
!Example file
!Phys. Path
!URL Prefix
!Link in results list
|-
| rowspan="3" |S:\Sales\Info\glossaryy.pdf
| rowspan="3" |S:\
|<nowiki>file:///S:/</nowiki>
|<nowiki>file:///S:/Sales/Info/glossary.pdf</nowiki>
|-
|<span class="mw-lingo-term" data-lingo-term-id="5e056c500a1c4b6a7110b50d807bade5" data-hasqtip="8">https</span>://sharepoint/Sales/
documents/
|<span class="mw-lingo-term" data-lingo-term-id="5e056c500a1c4b6a7110b50d807bade5" data-hasqtip="9">https</span>://sharepoint/Sales/
documents/Sales/Info/glossary.pdf
|-
|<span class="mw-lingo-term" data-lingo-term-id="5e056c500a1c4b6a7110b50d807bade5" data-hasqtip="10">https</span>://intranet/showdocs
inline.aspx?path=
|<span class="mw-lingo-term" data-lingo-term-id="5e056c500a1c4b6a7110b50d807bade5" data-hasqtip="11">https</span>://intranet/showdocsinline.aspx?
path=/Sales/Info/glossary.pdf
|-
|/var/www/bluespice/w/mounted_
share/Sales/Info/glossary.pdf
|/var/www/bluespice/w/
mounted_share/
|
|<span class="mw-lingo-term" data-lingo-term-id="5e056c500a1c4b6a7110b50d807bade5" data-hasqtip="12">https</span>://wiki.company.local/w/mounted_
share/Sales/Info/glossary.pdf
|}
[[File:Manual:configmanager-addfilepath.png|alt=Add an external file path|center|thumb|650x650px|Add an external file path: (1) confirm the checkmark and  (2) save the settings.]]
<br />
 
*'''Use simple autocomplete:''' forces a more compact autocomplete (1-column Sales thumbnail preview).<br />[[File:Manual:configuration-autocomplete-simple.1575886540740.png|alt=compact autocomplete|center|thumb|450x450px|compact autocomplete]][[File:Manual:configuration-autocomplete-regular.1575886496796.png|alt=regular autocomplete|center|thumb|450x450px|Salesautocompletey]]<br />
*'''Automatically set language filter''': This setting applies to multi-languageSalesIt returns seyarch results for a user only in the user's language. Users can set their language in their [[Manual:Preferences|preferences]].
*'''Exclude patterns:''' Files at external file locations can be exluded from search based on regular expression patterns.
 
===BlueSpiceExtendedStatistics===
 
*'''Exclude these users:''' Some user groups, like WikiSysop can skew the statistics, for example the statistics for search queries or because they complete automated maintenance tasks. These types of user groups can be excluded from the statistical results.
*'''Maximum number of interval steps:''' Sets the size of the x-axis for the results. For a few days, select the interval ''Day'' or ''Calendar Week'', for periods over one year, select ''Year'' or ''Month''. If you do not get any results for your query, try to adjust the interval accordingly.
 
===BlueSpiceInsertCategory===
 
*Insert category with its parent categories
*Preset categories of a page in the upload dialog
 
===BlueSpicensertLink===
 
*'''<span class="col-red">Allow unmapped links</span>'''
*'''<span class="col-red">Allowed locations for external files</span>'''
**<span class="col-red">Filesystem prefix</span>
**<span class="col-red">Web accessible prefix:</span>
 
===BlueSpicePageTemplates===
 
*'''Force target namespace:''' The page is always created in the target namespace that is associated with the template, even if the user provided a different namespace prefix. In the screenshot below, the user wants to create the page "NewPage" and then selects a template for the QM namespace. The page is, therefore, created as "QM:NewPage" if this setting is activated. [[File:force namespace from template.png|alt=force the namespace of the template|center|thumb|650x650px|force the namespace of the template]]
 
*'''Hide default templates:''' Hides the default ''Empty page'' template.
*'''Hide template if the page is not to be created in the target namespace:''' Depending on the namespace prefix of the page to be created, templates that are associated with other namespaces will not be shown to the user for selection.
 
===BlueSpicePermissionManager===
 
*'''Backup limit:''' Sets the number of backups for the permissions manager. Each time the page ''Special:PermissionManager'' is saved, a backup is created. If the backup limit is set to 5, the last five versions of the permissions configuration are saved as backups.
 
===BlueSpiceRSSFeeder===
 
*'''URL whitelist:''' RSS feeds need to be whitelisted here by an administrator before they can be displayed in a wiki page.
*'''Maximum number of allowed redirects:''' If there are URL redirects for any of the whitelisted URLs, the number of redirects needs to be adjusted (usually to 1 or 2).
 
[[File:Manual:configmanager-RSS.png|alt=RSS Feed settings|center|thumb|450x450px|RSS Feed settings]]
<br />
===BlueSpiceReaders ===
 
*'''Number of readers to display:''' Sets the number of readers that are displayed on the Page information in the Quality management tools. <br />[[File:Manual:PageInformation Reader.png|link=link=Special:FilePath/Manual:configmanager-readers.png|alt=displays readers of the page|center|page=readers|thumb|displays readers of the page]]<br />
 
=== BlueSpiceSaferEdit===
 
*'''Interval for lookup for concurrent editings:''' Sets the time in seconds for checking if another person is editing the page.
*'''Show name of current editor:''' Shows or hides the name of the user who is currently editing the page.
 
===BlueSpiceUEModuleBookPDF===
 
* Table of Contents
**''Only article titles (indent by grade):'' Only shows the article titles in the main contents table of the PDF.<br />[[File:Manual:configmanager-toc-simple.png|alt=PDF table of contents without article TOCs|center|thumb|450x450px|PDF table of contents without article TOCs]]<br />
**''Embed article TOCs (No indent of article titles):'' Shows the table of contents for each article in the main contents table of the PDF.[[File:Manual:configmanager-toc-embed.png|alt=Embed article TOCs|center|thumb|450x450px|Embed article TOCs]]
 
===BlueSpiceUEModuleHTML===
 
*'''Hide namespace prefix in HTML:''' If activated, the namespace is shown in the HTML main heading.
{{Messagebox|boxtype=note|Note text=If the page contains a "displaytitle" tag in the page source, the page display title is shown and this setting has no effect.}}
 
===BlueSpiceUEModulePDF===
 
*'''Hide namespace prefix in PDF:''' If activated, the namespace is shown in the PDF main heading for a page.
 
[[File:Manual:configmanager-pdfhidenamespace.png|alt=namespace in heading|center|thumb|450x450px|namespace in heading]]
{{Messagebox|boxtype=note|Note text=If the page contains a "displaytitle" tag in the page source, the page display title is shown and this setting has no effect.}}
 
===BlueSpiceUniversalExport===
 
*<span class="oo-ui-fieldLayout-header">'''Metadata (standard, JSON):'''</span>  Additional data to be passed to the rendering template in JSON format. This data can be used in the export template. The template itself is maintened server-side.
*'''Metadata (override, JSON)''': Allows overriding standard data sent to the rendering template in JSON format. Values that are set by default can be overriden with this option.
 
===BlueSpiceVisualEditorConnector===
 
*'''<span class="col-red">Enable VisualEditor for BlueSpice extensions</span>'''
*'''<span class="oo-ui-fieldLayout-header">Configuration variable to use a simplified save process</span>'''
*'''Upload type'''
**Original (Here a confirmation of the rights of use/upload is obtained, file name and namespace of the file can be changed, a category can be assigned and a description of the file <span class="col-red">MUST</span> be given).
**Simple (No confirmation of required rights is obtained here, the name and namespace of the file can be changed, a description and a category can be assigned, but does not have to be specified)
**One click (No confirmation about required rights is obtained here, the image cannot be renamed and no category can be assigned. Only the namespace can, but does not have to be adjusted before uploading)  <!-- verify what one-click means, since the next screens appear. --><br />
 
===BlueSpiceWhoIsOnline===
 
*<span class="oo-ui-fieldLayout-header">'''Time in seconds until a user is marked as offline:'''</span> The system checks every ''x'' seconds if a user logged out and no longer displayed as online. This can  be less frequent than the update inteval for newly logged-in users.
*<span class="oo-ui-fieldLayout-header">'''Update interval in seconds:'''</span> The system checks every ''x'' seconds for users.
 
===BlueSpiceExpiry===
 
*'''<span class="oo-ui-fieldLayout-header">Show watermark for expired pages in PDF</span>:'''  Shows the watermark for expired pages in PDFs.
*<span class="oo-ui-fieldLayout-header">'''Show watermark for expired pages in print version:''' Shows the watermark for expired pages when a page is printed.</span>
*<span class="oo-ui-fieldLayout-header">'''Show watermark for expired pages'''</span>: Shows a watermark on the page itself.<br />[[File:Manual:configmanager-watermark.png|alt=watermark|center|thumb|250x250px|watermark]]
 
===BlueSpiceFlaggedRevsConnector===
'''Export'''
 
The export settings affect how the pages of a book are generated in the PDF export.
 
*'''<span class="oo-ui-fieldLayout-header">Bookshelf: List approved revisions log</span>:''' Shows a log of stable page versions of pages in the PDF and when these pages were put into accepted status. If editors did not provide a comment when accepting the page, the ''Stable comment'' field for a revision is empty. <br />[[File:Manual:configmanager-bookshelf-revisionslog.png|alt=accepted revisions log|center|thumb|450x450px|accepted revisions log]]<br />
*'''Bookshelf: List pages without stable revision:''' Displays a list of PDF pages at the beginning of the PDF that only exist as a first draft and have no released version.[[File:configmanager-book-nichtfreigegebeneseiten-EN.png|center|thumb|300x300px|Pages without acceptance feature|link=Special:FilePath/configmanager-book-nichtfreigegebeneseiten-EN.png]]<br />
*'''Bookshelf: List pages without FlaggedRevs:''' Displays a list of PDF pages that do not have a release mechanism at the beginning of the PDF.
 
<br />
[[File:Manual:configmanager-book-listnoflaggedrev.png|alt=Pages with no FlaggedRevs feature.|center|thumb|260x260px|Pages with no FlaggedRevs feature.]]
<br />
 
*<span class="oo-ui-fieldLayout-header">'''UEModulePDF: Show FlaggedRevs info below main heading'''</span>: Prints the latest revision dates (last acceptance and last edit date) below the heading. <br />[[File:Manual:configmanager-bookshelf-flaggedrevsinfo.png|alt=FlaggedRevs info below heading|center|thumb|350x350px|FlaggedRevs info below heading]]
 
'''Quality assurance'''
 
*Include handling: If resources are embedded in a page and those resources are located in namespaces with approval mechanism, then the following settings can be selected. For example: If an approved page contains a template that has been changed after the page itself has been approved, the page will not get another draft version, but instad on of two configuration applies:
**Current versions: Always show the latest version of the embedded resource.
**Stable versions: Always show the stable (=approved) version of a resource.
 
*<span class="oo-ui-fieldLayout-header">'''Show unstable pages for following groups:'''</span> If the group ''user'' is removed from the ''BlueSpiceFlaggedRevs'' configuration, users in this group will not be able to see draft versions when they are added as reviewers in a review process. When the group user is removed, only ''sysop'' and ''reviewer'' users can access drafts. If you want other groups, for example ''editor'', to see draft versions, you need to add them to the configuration. If no user groups are specified in the configuration field, not even reviewers and sysops users will see a visual status indication of a page. They will have access to drafts through the revision history for the page instead.
 
'''Searching and Navigation'''
 
*<span class="oo-ui-fieldLayout-header">'''Indexing only stable versions:''' Draft versions are excluded from the search results. If a page does not have a stable version, it is not shown as a search result.</span><span class="oo-ui-fieldLayout-field"><span id="bsgFlaggedRevsConnectorUEModulePDFShowFRTag" class="oo-ui-widget oo-ui-widget-enabled oo-ui-inputWidget oo-ui-checkboxInputWidget" aria-disabled="false" data-ooui><span class="oo-ui-checkboxInputWidget-checkIcon oo-ui-widget oo-ui-widget-enabled oo-ui-iconElement oo-ui-iconElement-icon oo-ui-icon-check oo-ui-iconWidget oo-ui-image-invert" aria-disabled="false"></span></span></span><span class="oo-ui-fieldLayout-field"><span id="bsgFlaggedRevsConnectorUEModulePDFShowFRTag" class="oo-ui-widget oo-ui-widget-enabled oo-ui-inputWidget oo-ui-checkboxInputWidget" aria-disabled="false" data-ooui><span class="oo-ui-checkboxInputWidget-checkIcon oo-ui-widget oo-ui-widget-enabled oo-ui-iconElement oo-ui-iconElement-icon oo-ui-icon-check oo-ui-iconWidget oo-ui-image-invert" aria-disabled="false"></span></span></span>
 
=== BlueSpiceSocial ===
 
* '''Show entrypoint "Timeline":''' Shows a link to the page ''Special:Timeline'' in the main navigation.
 
===BlueSpiceSocialBlog===
 
*'''Use teaser text for blog entries in the timeline:''' When you create a blog entry, you can create a teaser text for it by clicking the cogwheel symbol in the blog entry form. If this setting is active, the teaser text will be shown on the page ''Special:Timeline'' instead of the first part of the content.
 
<br />[[File:Manual:configmanager-blogteaser.png|center|thumb|380x380px|blog teaser text|link=Special:FilePath/Manual:configmanager-blogteaser.png]]
 
* '''Show entrypoint "Blog":''' Shows a link to the page ''Special:Blog'' in the main navigation.
 
===BlueSpiceSocialTopics===
 
*'''Automatically create all discussion pages.''' If a user creates the first discussion topic for a page using the link in the page footer of a wiki page, the needed discussion page is automatically created first.  <br />[[File:Manual:configmanager-socialtopics-create.png|alt=create discussion topic|center|thumb|350x350px|create discussion topic]]<br />A message "This discussion page was created automatically" is inserted on the discussion page.  <br />[[File:Manual:configmanager-socialtopics.png|alt=automatically created discussion page|center|thumb|350x350px|automatically created discussion page]]<br />
 
If this setting is deactivated, the user is directed to the "Create page" default page first
<br />
 
== BlueSpiceDiscovery ==
 
* Allows to activate or deactivated some links in the main navigation of the wiki.[[File:discovery-entrypoint links.png|alt=Entrypoint links for Discovery skin|center|thumb|650x650px|Entrypoint links for Discovery skin]]
 
 
[[de:Handbuch:Erweiterung/{{SUBPAGENAME}}]]
[[en:Manual:Extension/{{SUBPAGENAME}}]]
[[Category:Administration]]

Revision as of 11:34, 24 February 2023


ExtendedSearch 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. Pages and files are indexed immediately and available for searching in real-time.

Usage

Extended search offers two ways of searching for content:

  1. Title search using the quick search
  2. 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 PDFs, this includes content and metadata
  • external files: files from arbitrary locations from accessible storage paths (e.g., mounted drives)
  • social entities: entities (pages) created by the BlueSpiceSocial extension, like blog posts and user profiles

Autocomplete

The search box in the main toolbar offers with autocomplete functionality is available from any page on the wiki. Autocomplete matches only page and file titles, but does not provide a full-text search.

After typing in the search bar, an autocomplete popup appears:

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. 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:

  • Tools and secondary results: Tools are displayed in the top portion of the right column and contain:
    • a button to create the page with the current search term as the title (only if user has permission to create new pages)
    • a button to execute full-text search for the current term. Selecting this option leads to the Search 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 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.

Namespace and subpage "pills"

Autocomplete search bar supports pills for namespaces and subpages.

Namespace "pill"

If a user types Manual:, a pill for the namespace "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 PageName/, any term after that is 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. This setting is available from BlueSpiceConfigManager, under Extension > BlueSpiceExtendedSearch > Use simple autocomplete.

Dates as search terms

The search recognizes certain date formats. In the search center, these date formats are treated with surrounding quotation marks.


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 offers the full functionality of the search. The search in the Search Center is carried out using the same search bar that is also used for autocomplete. 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.

Search Center

Search operators

Search operators only work in the search center (fulltext search). You cannot use search operators in the title search.

Search operators have to be written in all-caps.

AND

  • admin AND docu: Returns pages that contain the exact term admin as well as the exact term docu
  • admin* AND docu: If the term administration should be found, you need to provide a wildcard asterisk (*).

Compare: The search admin docu automatically is a wildcard search. It returns pages that contain both admin* and docu* . This search normally finds more results than the serach admin* AND docu (because in the second case, the exact term docu is returned).

" (apostrophes)

Apostrophes around a search term triggers an AND search for all terms in the query:

  • "admin" docu: same result as admin AND docu (i.e., also the precise term docu will be searched).

NOT

  • admin* NOT docu*: Returns pages that contain words that start with admin , but that don't contain words that start with docu .

OR

  • admin OR docu: Returns pages that contain either the exact term admin or the exact term docu.

* (wildcard)

  • admin*: Returns pages that contain words that begin with admin .

Elements

  • 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 adequate permissions event if it matches the search term.
  • Tools - these are located in the top right as a set of buttons:
    • 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 users can select the type of filter to apply to the search.
      Adding filters
    • Search options - represented by a "gear" icon - opens a dialog where users can change settings for the current search. It provides options like the number of results per page, sorting field and order.
      Options dialog
    • Export search - represented by the "export" icon - opens a dialog to export current search results to a dedicated page (only visible to authorized users, by default admin users).
  • Filter: Filters are displayed in form of pills below the results counter. Each filter pill represents a different attribute. 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 in each pill.
    Editing filter
  • Results: If current search criteria field any results, a list of results 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 information
    • Original name (for wikipages, if the page display title is different than the actual page title)
    • Secondary information like 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 is displayed as a "featured" result. Such a result displays a preview image of the page and always displays the content snippet, regardless of whether 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 the right corner of each result. Files marked as "favorite" 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. Results can be unmarked as "favorite" by clicking on the "star" symbol again.

Exporting search results

After executing the search, administrators can 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.

Export search

Configuration

In the BlueSpiceConfigManager, under settings for the extension BlueSpiceExtendedSearch, 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: 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.


Examples for external file paths
Example file Phys. Path URL Prefix Link in results list
S:\Sales\Info\glossaryy.pdf S:\ file:///S:/ file:///S:/Sales/Info/glossary.pdf
https://sharepoint/Sales/

documents/

https://sharepoint/Sales/

documents/Sales/Info/glossary.pdf

https://intranet/showdocs

inline.aspx?path=

https://intranet/showdocsinline.aspx?

path=/Sales/Info/glossary.pdf

/var/www/bluespice/w/mounted_

share/Sales/Info/glossary.pdf

/var/www/bluespice/w/

mounted_share/

https://wiki.company.local/w/mounted_

share/Sales/Info/glossary.pdf

Add an external file path
Add an external file path: (1) confirm the checkmark and (2) save the settings.


  • Use simple autocomplete: forces a more compact autocomplete (1-column Sales thumbnail preview).
    compact autocomplete
    compact autocomplete
    regular autocomplete
    Salesautocompletey

  • Automatically set language filter: The search only returns pages whose language (PageLanguage) is identical to the user language (Language). Users can set their language in their preferences. By default, the language of content pages is the same as the installation language (ContentLanguage) of the wiki. Some extensions can set the language of individual pages independently of the content language of the wiki.. (See: https://www.mediawiki.org/wiki/Manual:Language#Page_content_language). In many wikis, activating this filter has little effect.
  • Exclude patterns: Files at external file locations can be exluded from search based on regular expression patterns.


SearchAdmin

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

Related info



To submit feedback about this documentation, visit our community forum.

Discussions