MediaWiki

Extension:SearchVue

MediaWiki extensions manual
SearchVue
Release status: beta
Implementation Special page , Search
Description Vue.js augmentations and improvements to Special:Search
Author(s) Structured Data team
Latest version Continuous updates
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki master
License GNU General Public License 2.0 or later
Download
Download extension
Git [?]:
Parameters
  • $wgQuickViewSearchFilterForQID
  • $wgQuickViewMediaRepositoryUri
  • $wgQuickViewDataRepositoryApiBaseUri
  • $wgQuickViewMediaRepositorySearchUri
  • $wgQuickViewMediaRepositoryApiBaseUri
Hooks used
Quarterly downloads 5 (Ranked 131st)
Translate the SearchVue extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

SearchVue provides improvements to the Special:Search page, including a "quickview" panel.

Requirements

edit

The following extension must be installed for SearchVue to work:

The following extensions are not required, but are strongly recommended in order to enhance the media search experience:

If you have a Wikibase repository and a local image store, the following extensions are additionally recommended in order to allow more data to be used to enhance multimedia search results:

Installation

edit

After the extensions listed above are set up properly, enable the extension by adding wfLoadExtension( 'SearchVue' ); along with the required config variables to LocalSettings.php.

You might need to run composer install in the extension directory, or in the root directory of your MediaWiki installation if you are using a setup that merges all extension's dependencies into MediaWiki's vendor directory.

Configuration

edit

The following configuration settings can be added to LocalSettings.php:

  • $wgQuickViewMediaRepositoryApiBaseUri - URL of the API of the Commons repository used to fetch images for the selected page. If not set, the 'related images' section will not appear (default: https://commons.wikimedia.org/w/api.php
  • $wgQuickViewDataRepositoryApiBaseUri - URL of the API of the Wikidata repository used to links for the selected page. If not set, the 'interwiki links' section will not appear (default: https://www.wikidata.org/w/api.php
  • $wgQuickViewMediaRepositorySearchUri - URL of the Commons search page (default: https://commons.wikimedia.org/wiki/Special:MediaSearch?search=%s
  • $wgQuickViewMediaRepositoryUri - URL of the Commons home page (default: https://commons.wikimedia.org
  • $wgQuickViewSearchFilterForQID - the search parameter used to link the current page with a QID to improve relevancy of search results (default: custommatch:depicts_or_linked_from=%s)

Coding conventions

edit

JavaScript/Vue

edit

As much as possible, SearchVue defaults to the Vue Style Guide.

For now, the extension does not use full single-file components because it needs to be able to compile Less separately so it can be included immediately before the app loads to style the PHP UI.

CSS/Less

edit

Since Wikimedia UI base variables aren't in core, they are required as a package dependency; the extension then uses a shell script to copy them to the lib directory. To update the base variables, require the new version in package.json and install it, then run npm run build-lib to copy the updated file into lib. Commit the updated files.

The base variables are included in the extensions's own variables file, resources/mediasearch-variables.less. To use them in other files, include mediasearch-variables.less rather than directly including the base file itself.

The CSS class name prefix sdvs should be used for extension-level components.

See also

edit
Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:SearchVue&oldid=6368649"