Aude has uploaded a new change for review. https://gerrit.wikimedia.org/r/124058
Change subject: Improve and update Wikibase README.md ...................................................................... Improve and update Wikibase README.md Change-Id: I2fc11af0626c257d6fde3d5e560478fd638a9101 --- M README.md 1 file changed, 27 insertions(+), 14 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Wikibase refs/changes/58/124058/1 diff --git a/README.md b/README.md index 9728b59..df93be4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,21 @@ +# Wikibase The Wikibase package consists of three interconnected extensions: * Wikibase Repository (in the directory repo) * Wikibase Client (in the directory client) * WikibaseLib (in the directory lib) + +These extensions allow for the creation, maintenance, dissemination, and usage of structured data in MediaWiki. + +The repo is the extension for the repository. It allows the creation and maintenance of structured data. This is +being used on [wikidata.org](https://www.wikidata.org) . + +The client is the extension for the client. It allows several MediaWiki instances to use data provided by a Wikidata +instance. Usually, you would not use them in a single wiki. This is being used on the Wikipedias. + +The lib bundles common code that is used by both the client and the repo. + +Note that in each of the directories you will also find README.md notes for each of the extensions. ##Install @@ -12,29 +25,29 @@ * WikibaseLib (in the subdirectory lib) * Wikibase Client (in the subdirectory client) -In order to enable experimental features for the extensions, put the below line before -the inclusion of the extensions in your LocalSettings.php file: +In order to enable experimental features for the extensions, put the below line beforethe inclusion of the extensions in your LocalSettings.php file: +``` define( 'WB_EXPERIMENTAL_FEATURES', true ); +``` -##About +Wikibase depends on various libraries such as [DataValues](https://github.com/DataValues/) components, and uses [Composer] (http://getcomposer.org/) to make it easy to install and manage those. -These extensions allow for the creation, maintenance, dissemination, -and usage of structured data in MediaWiki. +Once you have Wikibase in your MediaWiki extensions directory, then run: -The repo is the extension for the repository. It allows the creation and maintenance of structured data. This is -being used on wikidata.org. +``` + composer install +``` -The client is the extension for the client. It allows several MediaWiki instances to use data provided by a Wikidata -instance. Usually, you would not use them in a single wiki. This is being used on the Wikipedias. +This will install both Wikibase Client and Repo together on the same wiki. -The lib bundles common code that is used by both the client and the repo. - -Note that in each of the directories you will also find README.md notes for each of the extensions. +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. ##Wikidata -These extensions where created by the Wikidata team for the Wikidata project. -More information on this project can be found at https://meta.wikimedia.org/wiki/Wikidata +These extensions where created by the Wikidata team for the Wikidata project. More information on this project can be found at https://meta.wikimedia.org/wiki/Wikidata The Wikidata project uses the Wikibase extensions at https://www.wikidata.org + +##Links +* https://www.mediawiki.org/wiki/Wikibase/Contribution_workflow -- To view, visit https://gerrit.wikimedia.org/r/124058 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I2fc11af0626c257d6fde3d5e560478fd638a9101 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/Wikibase Gerrit-Branch: master Gerrit-Owner: Aude <aude.w...@gmail.com> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
