扩展:RelatedArticles
此扩展由Web团队所维护。 |
RelatedArticles 发行状态: 稳定版 |
|
---|---|
实现 | 解析器函数 , API |
描述 | Adds a link to related pages on the footer |
作者 | Reading Web Team |
最新版本 | 3.1.0 (SemVer) (Continuous updates) |
MediaWiki | 1.25+ |
PHP | 5.4+ |
数据库更改 | 否 |
许可协议 | GNU通用公眾授權條款2.0或更新版本 |
下載 | CHANGELOG |
帮助 | Help:Extension:RelatedArticles/zh |
|
|
季度下載量 | 51 (Ranked 89th) |
前往translatewiki.net翻譯RelatedArticles扩展 | |
問題 | 开启的任务 · 报告错误 |
The RelatedArticles extension adds a parser function to your wikitext that allows associating related articles with your article. It shows related pages 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 morelike feature of CirrusSearch .
安装
- 下载文件,并将解压后的
RelatedArticles
文件夹移动到extensions/
目录中。
开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/RelatedArticles - 将下列代码放置在您的LocalSettings.php 的底部:
wfLoadExtension( 'RelatedArticles' );
- 完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。
If you use something other than w/api.php for your API, and related pages is not showing, check for any bad requests in your browser network tab.
If necessary, the API used to obtain related articles is configurable with $wgRelatedArticlesUseCirrusSearchApiUrl
额外部署请求
RelatedArticles can optionally provide additional features if the extensions below are installed:
- If PageImages is installed, Related Articles will include the page's selected image (if any). Otherwise, a placeholder image will be used instead.
- If EventLogging is installed, the RelatedPages feature can be configured to log events. See below for configuration manual.
- Depending on the configuration of
$wgRelatedArticlesDescriptionSource
, a small description of each page can be fetched. See the configuration manual below for required extensions. Descriptions won't be provided if the specified extension isn't installed.
用法
Once installed, related articles will be determined algorithmically based on CirrusSearch if available with no additional steps. Alternatively, you can disable this functionality ($wgRelatedArticlesUseCirrusSearch) and manually add related articles like so:
{{#related:Test with read more}}
{{#related:Another test page}}
Configuration
- Related articles will be shown at the bottom of the skin. Note that the page must be in the Main namespace, and being
view
ed (as opposed toedit
ed for example), and not be a disambiguation or a diff page, and the skin name (e.g.minerva
) that's being used is in the array$wgRelatedArticlesFooterAllowedSkins
(see below).
The following configuration options apply:
- If EventLogging is installed, set the event logging sampling rate
$wgRelatedArticlesLoggingSamplingRate
using a number between 0 and 1. The schema used for logging is RelatedArticles . - Use morelike feature of CirrusSearch by setting
$wgRelatedArticlesUseCirrusSearch
totrue
. If CirrusSearch is not available fallback to using the related articles marked in wikitext. - Use only CirrusSearch's morelike feature by setting
$wgRelatedArticlesOnlyUseCirrusSearch
totrue
ignoring the related articles marked in wikitext. $wgRelatedArticlesFooterAllowedSkins
List of skin names (e.g. 'minerva', 'vector') where related articles will be shown in the footer. For example, on a wiki with MonoBook, Vector and Minerva installed,$wgRelatedArticlesFooterAllowedSkins = ['vector']
will result in the widget showing on Vector only. The skin names have to all be in lowercase, e.g. 'vector' not 'Vector', even if the skin directory is 'Vector'. In versions prior to 1.37.0-wmf.3, this is named$wgRelatedArticlesFooterWhitelistedSkins
.- A small description of the page will be displayed below the title of the page, depending on the value of
$wgRelatedArticlesDescriptionSource
:wikidata
: Requires Wikibase Client, from the central wikibase repository or Extension:ShortDescription.textextracts
: Requires Extension:TextExtracts, fetched from the prop=extracts api.pagedescription
: Requires Extension:Description2 (or any other extension that sets thedescription
page property).
For development
For development the following configuration is recommended:
$wgRelatedArticlesUseCirrusSearchApiUrl = 'https://en.wikipedia.org/w/api.php';
$wgRelatedArticlesUseCirrusSearch = true;
$wgRelatedArticlesFooterAllowedSkins = [ 'vector-2022', 'vector', 'minerva', 'timeless' ];
$wgRelatedArticlesDescriptionSource = 'wikidata';
RelatedPages
The Related Pages feature is implemented in this extension. More info about its development can be found on phabricator.
On Wikimedia Projects
Related pages is enabled on:
Feedback
- Create a task in Wikimedia's issue tracker under the "RelatedArticles" project.
- Check the list of existing RelatedArticles tasks
Help
此扩展用于一个或多个维基媒体项目。 这可能意味着扩展足够稳定、运作足够良好,可以用在这样的高流量的网站上。 请在维基媒体的CommonSettings.php和InitialiseSettings.php配置文件中查找此扩展的名称以查看哪些网站安装了该扩展。 特定wiki上的已安装的扩展的完整列表位于Special:Version页面。 |
此扩展在以下wiki农场/托管网站和/或软件包中提供: 這不是一份權威名單。 即使某些wiki农场/托管网站和/或软件包未在这里列出,它们也可能提供此扩展。 请检查你的wiki农场/托管网站或软件包以确认提供情况。 |