Wikibase/Installation/Advanced configuration

From MediaWiki.org
Jump to: navigation, search

Wikibase Repository[edit]

Advanced Configuration[edit]

Setting up items in the main namespace[edit]

If you want to set up your items in the main namespace:

$baseNs = 100;

Define the namespace indexes
define( 'WB_NS_PROPERTY', $baseNs + 2 );
define( 'WB_NS_PROPERTY_TALK', $baseNs + 3 );

Define the namespaces
$wgExtraNamespaces[WB_NS_PROPERTY] = 'Property';
$wgExtraNamespaces[WB_NS_PROPERTY_TALK] = 'Property_talk';

Assigning the correct entity types to the namespaces
$wgWBRepoSettings['entityNamespaces']['item'] = NS_MAIN; 
$wgWBRepoSettings['entityNamespaces']['property'] = WB_NS_PROPERTY;

Note that if the "Main Page" is still in the Main namespace there will be thrown an exception, at least when you try to access that page. If you see this exception comment out the content model for the Main namespace, and then move the "Main Page" out of Main space without leaving an redirect. Usually the page will be moved to "Project:Main Page". If so the system message Mediawiki:Mainpage should be updated, or a similar message if Mediawiki:Sidebar is changed. Also check if there are other pages in the Main namespace by using Special:Allpages. After the Main namespace is cleansed for other pages you can reenable the content model for Main namespace.

Items in a dedicated item namespace[edit]

If you want to set up your items in a namespace of its own, here called Item, set up and use a WB_NS_ITEM constant and optionally set $wgNamespacesToBeSearchedDefaultManual:$wgNamespacesToBeSearchedDefault:

$baseNs = 120;

Define the namespace indexes
define( 'WB_NS_ITEM', $baseNs );
define( 'WB_NS_ITEM_TALK', $baseNs + 1 );
define( 'WB_NS_PROPERTY', $baseNs + 2 );
define( 'WB_NS_PROPERTY_TALK', $baseNs + 3 );

Define the namespaces
$wgExtraNamespaces[WB_NS_ITEM] = 'Item';
$wgExtraNamespaces[WB_NS_ITEM_TALK] = 'Item_talk';
$wgExtraNamespaces[WB_NS_PROPERTY] = 'Property';
$wgExtraNamespaces[WB_NS_PROPERTY_TALK] = 'Property_talk';

Assigning the correct entity types to the namespaces
$wgWBRepoSettings['entityNamespaces']['item'] = WB_NS_ITEM;
$wgWBRepoSettings['entityNamespaces']['property'] = WB_NS_PROPERTY;

Making the namespaces searched by default
$wgNamespacesToBeSearchedDefault[WB_NS_ITEM] = true;
$wgNamespacesToBeSearchedDefault[WB_NS_PROPERTY] = true;

HTML5[edit]

The extension uses HTML5 specific attributes, and because of this the $wgHtml5Manual:$wgHtml5 must be set to true in pre MW 1.22. In MW 1.22 and later versions this configurable feature is removed and the returned code is always HTML5.

Configuration[edit]

  • Basic Settings with changesDatabase,siteLinkGroups,localClientDatabases (with examples)
  • Insert with SQL in the table sites the site_global_key ? database repo and client ?
  • relations between siteLinkGroups of repo and siteGlobalID of client ?
  • example configs with a repo and a wiki family (fr,en)

Configuration of Wikibase/Installation/Advanced configuration is done by assigning to $wgWBRepoSettings in your LocalSettings.phpManual:LocalSettings.php file. The options are listed below and their default is set in the Wikibase/Installation/Advanced configuration 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 $wgWBRepoSettings, 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.

Example of how to change a setting:

$wgWBRepoSettings['serializationFormat'] = 'application/json';

Available settings:

Maintenance scripts[edit]

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/repo' php …

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

rebuildAllData.php[edit]

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.

deleteAllData.php[edit]

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.

populateSitesTable.php[edit]

This script will load the wiki matrix from meta.wikimedia.org and use that information to populate the local sites table. This provides Wikibase with the information it needs to connect to other wikis, e.g. to suggest or normalize the titles of pages when creating site links.

extractInterlang.sql[edit]

This is an SQL query that extracts interlanguage links from a wiki in a format readable by importInterlang.php. You may use it in a database of a wiki that has interlanguage links, so that you can later import them for testings.

importInterlang.php[edit]

This script imports interlanguage links from a file into a wiki, also creating labels in the process. The file is a tab-separated CSV file, in the following format:

page_title     ll_lang   ll_title
-архив        cs        Seznam forem vlády
-архив        de        Liste der Staatsformen und Regierungssysteme
-архив        en        Government#Forms of government
-архив        eo        Listo de formoj de registaro
-архив        es        Anexo:Formas de gobierno
-архив        fr        Liste de formes de gouvernements
-архив        jv        Daftar wangun pamaréntahan
-архив        ku        Lîsteya pergalên siyasî
-архив        mk        Список на општествени уредувања
-графика       de        -graphie
-графика       en        -graphy
-графика       id        -grafi
-графика       ka        ...გრაფია
-графика       sv        -grafi

The first row of the file is ignored.

  • The first column contains article titles of articles on the base wiki (the wiki the links are linked from).
  • The second column contains language codes of the links.
  • The third column contains article titles of the linked articles.

Script options:

  • --verbose: if set, the script will print API requests, responses, and other information.
  • --ignore-errors: if set, the script will ignore API errors and continue importing even if it encounters an error.
  • <lang>: This should be the language code of the base wiki, the wiki you have extracted interlanguage links from.
  • <filename>: The file with interlanguage links, presumably generated by extractInterlang.sql.
  • <api>: Base API url of the wiki you are importing the link into. For example, http://localhost/wiki/w/api.php

Example command line:

php importInterlang.php --verbose --ignore-errors sr sr_interwiki.csv http://localhost/wiki/w/api.php

To import the test items from extensions/Wikibase/repo/maintenance run

php importInterlang.php --verbose --ignore-errors simple simple-elements.csv

pruneChanges.php[edit]

This script is located in Wikibase/repo/maintenance/pruneChanges.php. It allows to prune the Wikibase changes table. If you run it without any parameters, it will delete all changes older than 7 days. To delete all changes older than 1 day run

php pruneChanges.php --number-of-days 1
11:07:46 pruning entries older than 2012-12-11T11:07:46Z
11:07:47 151 rows pruned
11:07:47 done, exiting

createBlacklistedItems.php[edit]

This script creates blacklisted items in Wikidata Data namespace, typically to create easter eggs and similar. The actual data is hardcoded in the script. You may use it before the item ids reaches the first blacklisted items.

importProperties.php[edit]

Maintenance script for importing properties in Wikidata. Usually this will use the example file in en-elements-properties.csv as source while building the example entries. You may also use it to create other entries for testing.

To import the test properties from extensions/Wikibase/repo/maintenance run

php importProperties.php --verbose en en-elements-properties.csv

rebuildEntityPerPage.php[edit]

Maintenance script for rebuilding the items_per_page table.

rebuildTermsSearchKey.php[edit]

Maintenance script for rebuilding the search key of the TermSQLCache. The search key is an additional column in the wb_terms table. This column is optional in the table and is used for caseless searches.

searchEntityArtefacts.php[edit]

This is a maintenance script that queries the database for entity artifacts. During use the database accumulates failed entries and this script tries to find them and print them.

Wikibase Client[edit]

Configuration[edit]

Configuration of Wikibase/Installation/Advanced configuration 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/Installation/Advanced configuration 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]

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]

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

Maintenance scripts[edit]

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]

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]

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]

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]

repoUrl[edit]

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

repoScriptPath[edit]

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

repoArticlePath[edit]

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]

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]

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

namespaces[edit]

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

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

sort[edit]

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]

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.

Features & Usage[edit]

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]

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]

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]

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

Lua
Parser functions
  • Supports lookup by property ID (e.g. P2), to include data from a connected (via sitelink) Wikibase item. For example, {{#statements:P2}}.
  • Lookup by property label. For example, {{#statements:country}}.
  • With arbitrary access enabled it can be used on any item. For example, {{#statements:P31|from=Q460679}}.
  • In addition to {{#statements:…}}, which outputs linked wikitext, there is also {{#property:…}}, which outputs unlinked labels.

Other projects sidebar[edit]

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