Bmansurov has uploaded a new change for review. https://gerrit.wikimedia.org/r/254840
Change subject: Add documentation ...................................................................... Add documentation Bug: T118855 Change-Id: I0cf8bd2215996a514c14e32b6bb8797f898ff6e0 --- A README.md 1 file changed, 50 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/RelatedArticles refs/changes/40/254840/1 diff --git a/README.md b/README.md new file mode 100644 index 0000000..7960d1e --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +RelatedArticles Extension +======================== + +The RelatedArticles extension adds a parser function to your wikitext that +allows to associate related articles to your article. It can be configured +to show the associated related articles as a list of links in a sidebar on +desktop, or as a list of articles and their descriptions at the bottom of a +page on desktop and mobile. The extension is also smart enough to get the +list of related articles using the +[https://www.mediawiki.org/wiki/Help:CirrusSearch#morelike:](morelike feature of CirrusSearch). + +Installation +------------ +* RelatedArticles depends on the [https://www.mediawiki.org/wiki/Extension:Cards](Cards extension). + Install and configure it before installing RelatedArticles. +* [https://www.mediawiki.org/wiki/Special:ExtensionDistributor/RelatedArticles](Download) + and place the file(s) in a directory called RelatedArticles in your + extensions/ folder. +* Add the following code at the bottom of your LocalSettings.php: + ```php + wfLoadExtension( 'RelatedArticles' ); + ``` + +Usage +------------ +```markdown +{{#related:Test with read more}} +{{#related:Another test page}} +``` + +Configuration +------------ +* Set the event logging sampling rate `$wgRelatedArticlesLoggingSamplingRate` + using a number between 0 and 1. +* Show related articles at the bottom of the page by setting + `$wgRelatedArticlesShowReadMore` to `true`. +* Use [Help:CirrusSearch#morelike:](morelike feature of CirrusSearch) by + setting `$wgRelatedArticlesUseCirrusSearch` to `true`. If CirrusSearch is not + available fallback to using the related articles marked in wikitext. +* Use only CirrusSearch's morelike feature by setting + `$wgRelatedArticlesOnlyUseCirrusSearch` to `true` ignoring the related + articles marked in wikitext. + +Read More +------------ +The [https://www.mediawiki.org/wiki/Reading/Web/Projects/Read_more](Read More) +feature is implemented in this extension. More info about its development can +be found on [https://phabricator.wikimedia.org/T94906](phabricator). + + -- To view, visit https://gerrit.wikimedia.org/r/254840 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I0cf8bd2215996a514c14e32b6bb8797f898ff6e0 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/RelatedArticles Gerrit-Branch: dev Gerrit-Owner: Bmansurov <bmansu...@wikimedia.org> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
