Extension:Wikibase Client

From MediaWiki.org
Jump to: navigation, search


shortcut: WBC
MediaWiki extensions manual
Crystal Clear action run.png
Wikibase Client

Release status: beta

Description Client for structured data repository
Author(s) The Wikidata team
(contributors list)
Latest version 0.5 alpha (2013-08-30)
MediaWiki master
PHP 5.3 or above
Database changes Yes
License GNU GPL v2+
Download
readme
release notes

Translate the Wikibase Client extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Issues:

Open tasks · Report a bug

Wikibase Client is an extension that acts as a client to the Wikibase extension. Its development is part of the Wikidata project.

The Wikibase Client obtains interlanguage links from a Wikibase repository via a shared changes database table and polling maintenance script, and displays them on the client wiki. Links are sorted by the client's preferred sorting. It is in plan to also be able to edit the links on the repository from a client wiki, fetch other kinds of data besides links, manage updating of articles and have other related functionality.

Usage[edit | edit source]

After the extension is installed, interlanguage links will automatically be obtained from the repo and be added to client wiki pages, as long as the polling script is running. The extension will then sort the links (sorting defined per-wiki), and display them, and save them to the database, just as if they are defined on the page. The extension is robust and will keep the existing links in case the central wiki is down.

By default the extension only works in the main namespace, but it is possible to change this with the namespaces configuration option.

Mixing Wikidata and local interlanguage links[edit | edit source]

The extension doesn't interfere with usual working of interlanguage links. They may continue to be used in parallel to the extension. There are several use cases:

  • Links on pages in namespaces which are not configured to use the extension continue to work exactly as without the extension.
  • If you want to add links in addition to the links stored in Wikidata, simply add new links in the wikitext, they will be added to the links from Wikidata, and all the links will be displayed together.
  • If you want to not show some of the links from Wikidata you can use the noexternallanglinks parser function with the desired language(s). Other links will continue to work normally.
  • If you want to overwrite some links from Wikidata, you can likewise use the noexternallanglinks parser function and add the new links in the wikitext.
  • If you want to turn off Wikidata links completely, you can use the noexternallanglinks magic word. In this case the links won't even be sorted, but will continue to work exactly as without the extension.

noexternallanglinks[edit | edit source]

noexternallanglinks is a magic word and a parser function which can turn this extension off for a specific page, or suppress some of the interlanguage links produced by the extension.

If used on its own, as {{noexternallanglinks}}, it will turn this extension off on the page. Only the interlanguage links that are present in the wikitext will be used. Sorting of the links will also be turned off, unless the alwaysSort option is turned on. The same effect is achieved if it is used as a function, with an asterisk: {{noexternallanglinks:*}} (the asterisk "matches" all the languages).

If used as a function, with parameters, only the links to the languages given as parameters will be removed. For example, {{noexternallanglinks:fr|id}} will remove the links to French and Indonesian languages. The same effect can be achieved by invoking the function repeatedly: {{noexternallanglinks:fr}} {{noexternallanglinks:id}}. Note that the remaining links will now be sorted, which means that wikitext links will be sorted even if French and Indonesian links were the only ones existing. It is safe to remove the link of a non-existing language.

Data transclusion[edit | edit source]

WikibaseClient allows for data inclusion from the Wikibase repo, via the {{#property}} parser function and Lua.

Lua
Parser function
  • Supports lookup by property id (e.g. p2), to include data from a connected (via sitelink) Wikibase item. For example, {{#property:p2}}.
  • Lookup by property label. For example, {{#property:country}}.

Other projects sidebar[edit | edit source]

See also m:Requests for comment/Interproject links interface for the current situation on Wikimedia projects.

The option otherProjectsLinks allows to display an "Other projects" sidebar section with links to some other projects gotten from the item linked to the current page. It currently supports only one link per project and does not allows yet to override links from Wikitext with a nice parser function (but current JavaScript hacks may be easily adapted).

Configuration sample (the links will be displayed in the same order):

$wgWBClientSettings['otherProjectsLinks'] => array( 'frwiki', 'frwikiquote', 'commonswiki', 'frwikivoyage' );

The id of the sidebar is "wikibase-otherprojects". it may be used in order to customize the section position in the sidebar using MediaWiki:Sidebar.

Each link uses as label the i18n messages "wikibase-otherprojects-ID" with ID the id of the linked site group (like "wikipedia", "wikisource" or "commons").

Sample page: s:fr:Appel du 18 juin.

Requirements[edit | edit source]

The Wikibase Client requires:

And one of the following:

Download[edit | edit source]

Wikibase Client (and Lib)[edit | edit source]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/Wikibase/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Wikibase.git

The client extension will be available in Wikibase/client directory. Clone it to your MediaWiki extensions folder. You will also need the WikibaseLib extension which is in the Wikibase/lib directory.

Installation[edit | edit source]

Basic installation instructions can be found here. For more experienced configuration see the following chapter.

Configuration[edit | edit source]

Configuration of Wikibase Client is done by assigning to members of $wgWBClientSettings array in your LocalSettings.php file. The options are listed below and their default is set in the Wikibase Client settings file. You should NOT modify the settings file, but can have a look at it to get an idea of how to use the settings, in case the below descriptions do not suffice.

The extension use the variable name $wgWBClientSettings, note the initial prefix $wg, while configuration of other extensions might use the initial prefix $eg. The difference is important and the configuration will fail if the latter is used.

An example of how to change the settings:

Required settings[edit | edit source]

repoUrl optionally, can be protocol relative such as '//wikidata.org'; this setting defaults to "//wikidata.org")"

$wgWBClientSettings['repoUrl'] = 'http://wikidata-test-repo.wikimedia.de';

repoScriptPath same as $wgScriptPath in your repo

$wgWBClientSettings['repoScriptPath'] = '/w';

repoArticlePath same as $wgArticlePath setting, in your repo, and if not set, then it will either be "$wgScriptPath/index.php/$1" (whatever you have for $wgScriptPath in your repo) or '$wgScriptPath?title=$1'

$wgWBClientSettings['repoArticlePath'] = '/wiki/$1';
$wgWBClientSettings['siteGlobalID'] = 'enwiki';
$wgWBClientSettings['repoDatabase'] = 'wikidatawiki';
$wgWBClientSettings['changesDatabase'] = 'wikidatawiki';

Optional settings[edit | edit source]

$wgWBClientSettings['repoNamespaces'] = array(
	'wikibase-item' => 'Item', //leave empty if items are in the main namespace
	'wikibase-property' => 'Property'
);
$wgWBClientSettings['siteGroup'] = 'wikipedia'; //you probably don't need this one, but do if your siteGroup is different from 'wikipedia'
$wgWBClientSettings['sort'] = 'code'; //optional
$wgWBClientSettings['sortPrepend'] = array(
        'en'
);

Overview of available settings[edit | edit source]

Maintenance scripts[edit | edit source]

This extension has some maintenance scripts in the maintenance subdirectory. They assume that the extension is installed in the extensions directory of the MediaWiki software (i.e. files are in the extensions/Wikibase directory), if this is not the case, you can set the MW_INSTALL_PATH environment variable to the path of your MediaWiki installation and the scripts will use it.

An usual way to set the environment for scripts run by cron jobs is to do something like

env 'MW_INSTALL_PATH=/var/www/client' php …

This should then run whatever php-script you want to append after the php interpreter.

rebuildAllData.php[edit | edit source]

This script should rebuild all the Wikidata data in secondary storage from articles in Data namespace. You may use it to rebuild data after testing.

(Clearify what this script is doing when called from the client)

deleteAllData.php[edit | edit source]

This script should delete all the Wikidata data in secondary storage and articles in Data namespace. You may use it to delete the data after testing.

(Clearify what this script is doing when called from the client)

Poll for changes[edit | edit source]

You need to run the Wikibase Lib maintenance script, pollForChanges.php from the client wiki installation, in order to update the cache of local items on the client wiki:

php extensions/Wikibase/lib/maintenance/dispatchChanges.php

Note that this script does the synchronization. The repo and the client will only be in sync as long as this script is running.

Available settings[edit | edit source]

repoUrl[edit | edit source]

Link to the Wikibase repository. Example is 'http://wikidata-test-repo.wikimedia.de '.

repoScriptPath[edit | edit source]

Should be same as your $wgScriptPath setting in your repo, for example '/w'

repoArticlePath[edit | edit source]

Should be same as your $wgArticlePath setting in your repo, for example '/wiki/$1'. If you don't have $wgArticlePath set in your repo, then it should be either "$wgScriptPath/index.php/$1" (whatever you have for $wgScriptPath in your repo) or '$wgScriptPath?title=$1' which are MediaWiki defaults.

siteGlobalID[edit | edit source]

Global ID for the site tells the polling script to cache and display interwiki links from the repository that are pointing to the client. Default is 'enwiki' for "en" (language code) and "wiki" for the site group, but this could be set to something else;

siteGroup[edit | edit source]

Default siteGroup setting is 'wikipedia' (for Wikipedia).

namespaces[edit | edit source]

Array. An array of namespaces in which the extension will work.

Default: the extension will work only in the main namespace.

sort[edit | edit source]

String. Selects the sort method you want to use for the interlanguage links. Currently, it recognizes four sort methods:

Default: 'code' sort mode.

sortPrepend[edit | edit source]

Array. Modifies the sort method so that it sorts certain languages at the top of the list of languages, regardless of their general sort order. It should be set to an array that has values set to desired language codes, in desired order. For example, to put English and then Simple English at the top of the list of languages, set it to array( 'en', 'simple' ). It is even possible to make an entire custom sort array with all the languages, that will completely override any of the sorting methods.

Default: the sort will be used unmodified.

Version[edit | edit source]

This is a copy of the release notes file on Git, which might be more up to date than this page.

Internationalization[edit | edit source]

Wikibase Client is fully internationalized. Translation of Wikibase Client messages is done through translatewiki.net. The translation for this extension can be found here. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

See also[edit | edit source]

External links[edit | edit source]