wikibase/wikibase

Structured data repository for MediaWiki

Installs: 9 471

Dependents: 2

Suggesters: 0

Security: 0

Stars: 64

Watchers: 32

Forks: 43

Type:mediawiki-extension

dev-master 2020-07-09 18:19 UTC

README

Build Status Scrutinizer Code Quality

The Wikibase.git package is part of the Wikibase software and consists of multiple MediaWiki extensions and other components.

The package allows for the creation, maintenance, dissemination, and usage of structured data in MediaWiki.

High level documentation can be found on wikiba.se and mediawiki.org. Lower level documentation can be found on doc.wikimedia.org here.

Install

Wikibase depends on various composer libraries.

Once you have Wikibase in your MediaWiki extensions directory, add the composer.json of Wikibase to composer.local.json at the root of your MediaWiki folder, as documented in MediaWiki's Composer documentation.

It should now look similar to:

{
  "extra": {
    "merge-plugin": {
       "include": [
         "extensions/Wikibase/composer.json"
       ]
    }
  }
}

Then, in the root of your MediaWiki folder, run:

composer install

If you already ran composer install during the installation of MediaWiki, run instead:

composer update

When using ways to combine MediaWiki with the extension folders (e.g. symlinks or docker volumes) please make sure that the folders are available to composer in the same structure they are available to the webserver, too.

This will install both Wikibase Client and Repo together on the same wiki.

If you want to only have one or the other, then set $wgEnableWikibaseRepo = false or $wgEnableWikibaseClient to false for the one you don't want to enable.

Wikibase also depends on several JavaScript libraries. They are included in this repository as submodules. To fetch files of these libraries, you might need to run, in the Wikibase extension folder, the following command:

git submodule update --init

Development

Wikibase uses tools to ensure the quality of software developed. To invoke these tools, inside the Wikibase folder, run

composer install
composer run-script test

As this uses development dependencies and custom configuration, executing it from the MediaWiki root folder (via composer run-script test extensions/Wikibase) will not work satisfactorily

JavaScript

Wikibase makes use of frontend software from various eras - resulting in a heterogenous technological landscape.

Some notable (not a comprehensive list) mentions are

Updating vue

Wikibase exposes vue as a ResourceLoader module so it can be shared between applications. As ResourceLoader in the production environment does not have access to files only acquired through a Javascript package manager (npm), we keep a copy of its source in our repository.

To update that copy you can run the following command and commit the changes to git.

npm update vue
{
  printf '%s\n' '(function(){'
  cat node_modules/vue/dist/vue.common.prod.js
  printf '\n%s\n' '})();'
} >| view/resources/vendor/vue2.common.prod.js
git add -f view/resources/vendor/vue2.common.prod.js

(The surrounding IIFE is necessary to avoid Vue breaking the page in ResourceLoader’s debug mode, see T229390.)