jenkins-bot has submitted this change and it was merged. Change subject: Add a README for ArticlePlaceholder ......................................................................
Add a README for ArticlePlaceholder Bug: T135175 Change-Id: Id0bf1f072d54c042c1e01d5f2495a823146e8d6f --- A README.md 1 file changed, 32 insertions(+), 0 deletions(-) Approvals: Thiemo Mättig (WMDE): Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md new file mode 100644 index 0000000..b04ea91 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +- - - +Introduction to ArticlePlaceholder +==================== + +The ArticlePlaceholder is a MediaWiki extension. Read the detailed documentation at https://www.mediawiki.org/wiki/Extension:ArticlePlaceholder + +ArticlePlaceholder enables placeholder pages on Wikibase Client installations using data of the repository. + +## Installation + +### Dependencies +ArticlePlaceholder requires +* MediaWiki +* Wikibase Client, connected to a Wikibase Repo +* Scribunto for the display of the content +* Cite for the display of the references on a placeholder page + +### Configuration +``` +wfLoadExtension( 'ArticlePlaceholder' ); +``` + +needs to be set in the LocalSettings.php of your MediaWiki Installation. + +There are multiple settings for the ArticlePlaceholder, which can be configured, a list can be found on [the MediaWiki page of the extension](https://www.mediawiki.org/wiki/Extension:ArticlePlaceholder#Configuration). + +### Set-up +In order to be able to actually use the functionalities of the special page and the Lua module, it is necessary to import (via Special:Import or the importDump.php maintenance script) the Template and Module AboutTopic. +These are located in the extension folder in includes/Template. + +Optionally to enable the ordering of properties on the ArticlePlaceholder pages, your wiki needs a page with a list of sorted properties. +This page needs to be called MediaWiki:Wikibase-SortedProperties. -- To view, visit https://gerrit.wikimedia.org/r/290473 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Id0bf1f072d54c042c1e01d5f2495a823146e8d6f Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/extensions/ArticlePlaceholder Gerrit-Branch: master Gerrit-Owner: Lucie Kaffee <[email protected]> Gerrit-Reviewer: Aude <[email protected]> Gerrit-Reviewer: Daniel Kinzler <[email protected]> Gerrit-Reviewer: Lucie Kaffee <[email protected]> Gerrit-Reviewer: Thiemo Mättig (WMDE) <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
