搜索starcitizentools / short-description
添加所需的魔法词和API来模仿维基媒体项目上Wikibase提供的简短描述
Requires
- composer/installers: >=1.0.1
Requires (Dev)
This package is auto-updated.
Last update: 2024-09-09 17:56:22 UTC
README
ShortDescription
ShortDescription 扩展允许维基向wikitext页面添加简短描述，类似于维基百科和Wikibase上的实现。此外，它还用简短描述替换了页面的站点标语。
MediaWiki上的ShortDescription扩展.
功能
- 在页面中使用魔法词
{{SHORTDESC}}定义简短描述，与维基百科上的实现相同 - 使用魔法词
{{GETSHORTDESC}}在任何维基页面上检索简短描述 - 如果皮肤支持站点标语（
#siteSub），则在大多数皮肤中在页面标题下方添加简短描述- 请注意，简短描述将替换有简短描述的页面上的默认站点标语信息
- 不适用于 Skin:Citizen 和 Skin:Minerva Neue，因为它们有本地支持
- 允许通过Action API访问简短描述
- 向REST API搜索端点提供描述
- 将简短描述添加到页面信息（
&action=info） - 为MobileFrontend、RelatedArticles等扩展提供描述
要求
- MediaWiki 1.35或更高版本
安装
您可以通过Git获取扩展（指定ShortDescription作为目标目录）
git clone https://github.com/StarCitizenTools/mediawiki-extensions-ShortDescription.git ShortDescription
或者 下载zip存档。
在任一情况下，“ShortDescription”扩展应位于您的MediaWiki安装的“extensions”目录中。如果您获得了zip存档，您需要将其放入名为ShortDescription的目录中。
配置
该扩展默认情况下无需配置即可工作。 配置标志允许对扩展中的特定功能进行更多定制。
使用方法
添加简短描述
要将“Bacon ipsum dolor amet turkey”添加为简短描述，只需在页面上添加{{SHORTDESC:Bacon ipsum dolor amet turkey}}即可。
在维基页面上检索简短描述
要检索页面 Bacon 上的简短描述，只需在页面上添加{{GETSHORTDESC:Bacon}}即可。如果您正在检索同一页面上的简短描述（例如，获取Bacon页面上Bacon的简短描述），只需添加{{GETSHORTDESC:}}即可。
通过Action API检索简短描述
简短描述可以通过Action API中的query操作的description属性进行调用（例如api.php?action=query&prop=description）。它也可以通过pageprops内的shortdesc属性访问。