PHPackages starcitizentools/short-description - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. starcitizentools/short-description ActiveMediawiki-extension[Utility & Helpers](/categories/utility) starcitizentools/short-description ================================== Adds the required magic word and API to mimic the short description provided by Wikibase on Wikimedia projects 9366↓33.3%4PHPCI passing Since Apr 7Pushed 1mo ago1 watchersCompare [ Source](https://github.com/StarCitizenTools/mediawiki-extensions-ShortDescription)[ Packagist](https://packagist.org/packages/starcitizentools/short-description)[ RSS](/packages/starcitizentools-short-description/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (12)Used By (0)Security (1) [![](https://camo.githubusercontent.com/83223283685bf4674cccd6b7b0ddfb70f97b7f11184a5c95273deebbe8ced677/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f302f30382f53686f72746465736372697074696f6e2d69636f6e2d6c74722e737667)](https://camo.githubusercontent.com/83223283685bf4674cccd6b7b0ddfb70f97b7f11184a5c95273deebbe8ced677/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f302f30382f53686f72746465736372697074696f6e2d69636f6e2d6c74722e737667) ShortDescription ================ [](#shortdescription) [![](https://github.com/StarCitizenTools/mediawiki-extensions-ShortDescription/workflows/MediaWiki%20CI/badge.svg)](https://github.com/StarCitizenTools/mediawiki-extensions-ShortDescription/workflows/MediaWiki%20CI/badge.svg) The ShortDescription extension allows wikis to add short descriptions to wikitext pages, simliar to the implementation on [Wikipedia](https://en.wikipedia.org/wiki/Wikipedia:Short_description) and Wikibase. On top of that, it replaces the site tagline with short description on pages with short description. [Extension:ShortDescription on MediaWiki](https://www.mediawiki.org/wiki/Extension:ShortDescription). Features -------- [](#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 with replace the default site tagline message on pages with short description - Does not apply to [Skin:Citizen](https://www.mediawiki.org/wiki/Skin:Citizen) and [Skin:Minerva Neue](https://www.mediawiki.org/wiki/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 Requirements ------------ [](#requirements) - [MediaWiki](https://www.mediawiki.org) 1.43 or later Installation ------------ [](#installation) You can get the extension via Git (specifying ShortDescription as the destination directory): ``` git clone https://github.com/StarCitizenTools/mediawiki-extensions-ShortDescription.git ShortDescription ``` Or [download it as zip archive](https://github.com/StarCitizenTools/mediawiki-extensions-ShortDescription/archive/master.zip). In either case, the "ShortDescription" extension should end up in the "extensions" directory of your MediaWiki installation. If you got the zip archive, you will need to put it into a directory called ShortDescription. Configurations -------------- [](#configurations) **The extension works out of the box without any configurations.**The config flags allow more customization on the specific features in the extension. NameDescriptionValuesDefault`$wgShortDescriptionEnableTagline`Enables short descritption in site tagline`true` - enable; `false` - disable`true``$wgShortDescriptionExtendOpenSearchXml`Provide short description to the Opensearch API module`true` - enable; `false` - disable`false`Usage ----- [](#usage) ### Add short description [](#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 [](#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 [](#retrieve-short-description-through-action-api) The short description can be called through the `description` property in `query` action in the [Action API](https://www.mediawiki.org/wiki/API:Main_page) (e.g.`api.php?action=query&prop=description`). It is also accessible through the `shortdesc` property inside `pageprops`. ### Retrieve short description through REST API [](#retrieve-short-description-through-rest-api) The short description can be accessed through the `description` property in the [search endpoint](https://www.mediawiki.org/wiki/API:REST_API/Reference) in the [REST API](https://www.mediawiki.org/wiki/API:REST_API). ### Health Score 32 — LowBetter than 72% of packages Maintenance60 Regular maintenance activity Popularity23 Limited adoption so far Community17 Small or concentrated contributor base Maturity24 Early-stage or recently created project Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/421898af9788651cc8fe6c06069092f102e093e32e6f0e6437178aa8a180d328?d=identicon)[alistair3149](/maintainers/alistair3149) --- Top Contributors [![alistair3149](https://avatars.githubusercontent.com/u/9260542?v=4)](https://github.com/alistair3149 "alistair3149 (82 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (79 commits)")[![translatewiki](https://avatars.githubusercontent.com/u/24829418?v=4)](https://github.com/translatewiki "translatewiki (53 commits)")[![umherirrender](https://avatars.githubusercontent.com/u/1174884?v=4)](https://github.com/umherirrender "umherirrender (2 commits)")[![Universal-Omega](https://avatars.githubusercontent.com/u/54654040?v=4)](https://github.com/Universal-Omega "Universal-Omega (2 commits)")[![paladox](https://avatars.githubusercontent.com/u/5727000?v=4)](https://github.com/paladox "paladox (2 commits)")[![SomeMWDev](https://avatars.githubusercontent.com/u/186634068?v=4)](https://github.com/SomeMWDev "SomeMWDev (2 commits)")[![BlankEclair](https://avatars.githubusercontent.com/u/170076830?v=4)](https://github.com/BlankEclair "BlankEclair (1 commits)") --- Tags mediawiki-apimediawiki-extension ### Embed Badge ![Health badge](/badges/starcitizentools-short-description/health.svg) ``` [![Health](https://phpackages.com/badges/starcitizentools-short-description/health.svg)](https://phpackages.com/packages/starcitizentools-short-description) ``` ### Alternatives [livewire/flux The official UI component library for Livewire. 9385.0M86](/packages/livewire-flux)[tecnocen/yii2-bootstrap-year-calendar Yii2 widget for bootstrap-year-calendar plugin 1317.7k](/packages/tecnocen-yii2-bootstrap-year-calendar)[rspeekenbrink/laravel-menu Simple menu generation in Laravel 164.3k](/packages/rspeekenbrink-laravel-menu) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)