Extension:ShortDescription
{{SHORTDESC:}} parser without the use of this extension, see the Wikibase option.
The ShortDescription extension allows wikis to add short descriptions to wikitext pages, similar to the implementation on Wikipedia and Wikibase. On top of that, it replaces the site tagline with short description on pages with short description.
Installation
Note that the latest version is located in the GitHub repo instead of Gerrit.
- Download and place the file(s) in a directory called
ShortDescriptionin yourextensions/folder. - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'ShortDescription' );
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Features
- Define short description on the page with the magic word
{{SHORTDESC}}, same as the implementation on Wikipedia - Retrieve short description on any wiki pages with the magic word
{{GETSHORTDESC}} - Add short description underneath the page title on most skins, if the skin supports site tagline (
#siteSub)- Note that the short description will replace the default site tagline message on pages with short description
- Does not apply to Skin:Citizen and Skin:Minerva Neue, as they have native support
- Allow short description to be accessed through the Action API
- Provide description to the REST API search endpoint
- Add short description to page information (
&action=info) - Provide description for extensions such as MobileFrontend, RelatedArticles
Configurations
The extension works out of the box without any configurations. The config flags allow more customization on the specific features in the extension.
| Name | Description | Values | Default |
|---|---|---|---|
$wgShortDescriptionEnableTagline |
Enables short description in site tagline | true - enable; false - disable |
true |
$wgShortDescriptionExtendOpenSearchXml |
Provide short description to the Opensearch API module | true - enable; false - disable |
false |
Usage
Add short description
To add Bacon ipsum dolor amet turkey as short description, simply add {{SHORTDESC:Bacon ipsum dolor amet turkey}} on the page.
Retrive short description on wikipage
To retrive the short description on the page Bacon, simply add {{GETSHORTDESC:Bacon}} on the page. If you are retrieving the short description on the same page (e.g. getting the short description of Bacon on the Bacon page), simply add {{GETSHORTDESC:}}.
Retrieve short description through Action API
The short description can be called through the description property in query action in the Action API (e.g.api.php?action=query&prop=description). It is also accessible through the shortdesc property inside pageprops.
Retrieve short description through REST API
The short description can be accessed through the description property in the search endpoint in the REST API.
Screenshots
ShortDescription on Skin:Citizen
ShortDescription on Skin:Minerva
ShortDescription on Skin:Monobook
ShortDescription on Skin:Timeless
ShortDescription on Skin:Vector
See also
- T184000 - Magic word on English WP to override display of Wikidata short description
- Extension:Wikibase Client - provide the description functionality on Wikimedia projects
- Extension:RelatedArticles - Use the description from this extension under wikidata mode
- Extension:Description2 - An extension that adds a description meta tag generated automatically from the first paragraph of the page, or manually overridden.
 | This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |