Help:Configuration parameter "$smwgBrowseByApi"

From semantic-mediawiki.org
Jump to: navigation, search
edit with form


Title $smwgBrowseByApi
Description Sets whether the display of special page "Browse" will be generated using an API request
Default setting
true
(Other) available settings
false

Allows to disable the browse display to be generated using an API request (legacy setting)

Software Semantic MediaWiki
First version supported
Last version supported still available
Configuration Facts display · Interface settings
Keyword browse · special page

$smwgBrowseByApi is a configuration parameter that sets whether display of information on special page "Browse"Shows all properties and their values annotated to a page is to be generated using an API modules request. This increases responsiveness substantially for pages with large fact sets, i.e. a high number of annotations. The configuration parameter was introduced in Semantic MediaWiki 2.5.0Released on 14 March 2017 and compatible with MW 1.23.0 - 1.29.x.1 and deprecated with Semantic MediaWiki 3.0.0Released on an unknown date and compatible with MW 1.27.0 - 1.30.x.2.

This configuration parameter was deprecated with Semantic MediaWiki 3.0.0Released on an unknown date and compatible with MW 1.27.0 - 1.30.x. in favour of option SMW_BROWSE_USE_API to configuration parameter $smwgBrowseFeaturesSets the behaviour of the features provided by several Browsing interfaces streamlining the overall configuration of Semantic MediaWiki.2 Thus you are advised to migrate your settings in "LocalSettings.php" to the new configuration parameter since this one will be removed with the release of Semantic MediaWiki 3.1.0Released on an unknown date and compatible with unknown versions of MediaWiki. in late 2018.

Default setting

$smwgBrowseByApi = true;

This means that the display of special page "Browse"Shows all properties and their values annotated to a page will be generated using an API request.

Changing the default setting

To modify this configuration setting, add one of the following lines to your "LocalSettings.php" file after the enableSemantics() call:

Disable the display of incoming links
$smwgBrowseByApi = false;

This means that the display of special page "Browse"Shows all properties and their values annotated to a page will not be generated using an API request but with synchronous database queries. Alternatively one may use the "lecacy" option to the "output" parameter of "index.php" (?output=legacy).

See also

References

  1. ^  Semantic MediaWiki: GitHub pull request gh:smw:1756
  2. a b  Semantic MediaWiki: GitHub pull request gh:smw:2799