Jump to content

Template:Extension/doc

From mediawiki.org

TemplateData

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Extension

An infobox for a MediaWiki extension.

Template parameters

ParameterDescriptionTypeStatus
Namename

Name of the extension

Default
Current page name
Example
BlueSpice
Stringsuggested
Statusstatus

Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.

Suggested values
experimental beta stable unmaintained unknown unstable
Default
unknown
Example
stable
Stringsuggested
Licenselicense

Extension's license.

Example
GPL-3.0
Stringsuggested
Modetemplatemode

Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.

Unknownoptional
Screenshot or logoimage

Screenshot or logo of extension. It should be provided without namespace and without [[]]s.

Example
BlueSpice _Logo_v2020.png
Filesuggested
Image sizeimagesize

Optional size of the image in pixels (without unit)

Default
300
Example
180
Numberoptional
Typetype

Implementation type. If more that one type is required leave empty and use "Primary type", "Secondary type", ... instead

Stringsuggested
Primary typetype1

Implementation type. See detailed doc.

Example
mywiki
Stringoptional
Secondary typetype2

Implementation type. See detailed doc.

Example
notify
Stringoptional
Third typetype3

Implementation type. See detailed doc.

Example
page action
Stringoptional
Fourth typetype4

Implementation type. See detailed doc.

Example
skin
Stringoptional
Fifth typetype5

Implementation type. See detailed doc.

Example
ajax
Stringoptional
Sixth typetype6

Implementation type. See detailed doc.

Stringoptional
Descriptiondescription

Short description

Stringsuggested
Authorauthor

The extension author's name, if different from their MediaWiki.org username. Free text, URL. If omitted then the 'username' field will be used (if present).

Stringsuggested
Usernameusername

The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.

Stringoptional
Maintainermaintainer

Username or other information about who maintains this extension.

Stringoptional
Latest versionlatest release version version latest_release_version

version of the last release

Example
4.4.2
Stringsuggested
Latest version release datelatest release date update latest_release_date

date of the last release

Example
2024/03/18
Stringsuggested
Latest preview versionlatest preview version version preview latest_preview_version version_preview

version of the last preview

Stringoptional
Latest preview version update datelatest preview date update preview latest_preview_date update_preview

date of the last preview

Example
ltsrel
Stringoptional
Compatibility policycompatibility policy

For older versions of MediaWiki, should one use the extension's master branch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel, ltsrel

Suggested values
master rel ltsrel
Example
1.39.x only
Stringsuggested
MediaWiki versionmediawiki

Required versions of MediaWiki. Not needed if this information is in extension.json.

Example
>= 1.35
Stringdeprecated
PHP versionphp

Required version of PHP

Example
8.0.x
Stringoptional
Needs update.phpneeds-updatephp

"Yes" : indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. "No" : should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty.

Example
Yes
Booleanoptional
Composer package namecomposer

If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, to point people directly to packagist.org, which serves as the package archive.

Example
mediawiki/semantic-media-wiki
Stringoptional
Phabricator project namephabricator

name of the project in Phabricator

Example
MediaWiki-extensions-Babel
Stringsuggested
Virtual domainvirtual domain

$wgVirtualDomainsMapping key

Stringoptional
Non-core table 1table1

Name of a non-core table used by the extension.

Example
cn_notices
Stringoptional
Non-core table 2table2

Name of a non-core table used by the extension.

Example
cn_assignments
Stringoptional
Non-core table 3table3

Name of a non-core table used by the extension.

Example
cn_templates
Stringoptional
Non-core table 4table4

Name of a non-core table used by the extension.

Example
cn_notice_languages
Stringoptional
Non-core table 5table5

Name of a non-core table used by the extension.

Example
cn_notice_projects
Stringoptional
Non-core table 6table6

Name of a non-core table used by the extension.

Example
cn_notice_countries
Stringoptional
Non-core table 7table7

Name of a non-core table used by the extension.

Example
cn_notice_regions
Stringoptional
Non-core table 8table8

Name of a non-core table used by the extension.

Example
cn_template_mixins
Stringoptional
Non-core table 9table9

Name of a non-core table used by the extension.

Example
cn_notice_mixins
Stringoptional
Non-core table 10table10

Name of a non-core table used by the extension.

Example
cn_notice_mixin_params
Stringoptional
Non-core table 11table11

Name of a non-core table used by the extension.

Example
cn_known_devices
Stringoptional
Non-core table 12table12

Name of a non-core table used by the extension.

Example
cn_template_devices
Stringoptional
Non-core table 13table13

Name of a non-core table used by the extension.

Example
cn_known_mobile_carriers
Stringoptional
Non-core table 14table14

Name of a non-core table used by the extension.

Example
cn_notice_mobile_carriers
Stringoptional
Non-core table 15table15

Name of a non-core table used by the extension.

Example
cn_notice_log
Stringoptional
Non-core table 16table16

Name of a non-core table used by the extension.

Example
cn_template_log
Stringoptional
Non-core table 17table17

Name of a non-core table used by the extension.

Stringoptional
Non-core table 18table18

Name of a non-core table used by the extension.

Stringoptional
Non-core table 19table19

Name of a non-core table used by the extension.

Stringoptional
Non-core table 20table20

Name of a non-core table used by the extension.

Stringoptional
Download linkdownload

External link to download

URLoptional
README linkreadme

External link to the readme file

URLoptional
Changelog linkchangelog

External link to the changelog file

URLoptional
Exampleexample

Example, website or screenshot of working extension

Stringoptional
Namespacenamespace

Namespace in which this extension is used

Stringoptional
Parametersparameters

Available parameters for LocalSettings.php

Example
* $wgInterwikiViewOnly * InterwikiCentralDB
Stringoptional
Tagstags

Any tags the extension uses

Stringoptional
Rightsrights

User rights added by the extension.

Stringoptional
hook1hook1

Name of a hook provided by the extension.

Example
ParserAfterTidy
Stringoptional
hook2hook2

Name of a hook provided by the extension.

Example
InitializeArticleMaybeRedirect
Stringoptional
hook3hook3

Name of a hook provided by the extension.

Example
SkinTemplateOutputPageBeforeExec
Stringoptional
hook4hook4

Name of a hook provided by the extension.

Stringoptional
hook5hook5

Name of a hook provided by the extension.

Stringoptional
hook6hook6

Name of a hook provided by the extension.

Stringoptional
hook7hook7

Name of a hook provided by the extension.

Stringoptional
hook8hook8

Name of a hook provided by the extension.

Stringoptional
hook9hook9

Name of a hook provided by the extension.

Stringoptional
hook10hook10

Name of a hook provided by the extension.

Stringoptional
hook11hook11

Name of a hook provided by the extension.

Stringoptional
hook12hook12

Name of a hook provided by the extension.

Stringoptional
hook13hook13

Name of a hook provided by the extension.

Stringoptional
hook14hook14

Name of a hook provided by the extension.

Stringoptional
hook15hook15

Name of a hook provided by the extension.

Stringoptional
hook16hook16

Name of a hook provided by the extension.

Stringoptional
hook17hook17

Name of a hook provided by the extension.

Stringoptional
hook18hook18

Name of a hook provided by the extension.

Stringoptional
hook19hook19

Name of a hook provided by the extension.

Stringoptional
hook20hook20

Name of a hook provided by the extension.

Stringoptional
hook21hook21

Name of a hook provided by the extension.

Stringoptional
hook22hook22

Name of a hook provided by the extension.

Stringoptional
hook23hook23

Name of a hook provided by the extension.

Stringoptional
hook24hook24

Name of a hook provided by the extension.

Stringoptional
hook25hook25

Name of a hook provided by the extension.

Stringoptional
hook26hook26

Name of a hook provided by the extension.

Stringoptional
hook27hook27

Name of a hook provided by the extension.

Stringoptional
hook28hook28

Name of a hook provided by the extension.

Stringoptional
hook29hook29

Name of a hook provided by the extension.

Stringoptional
hook30hook30

Name of a hook provided by the extension.

Stringoptional
hook31hook31

Name of a hook provided by the extension.

Stringoptional
hook32hook32

Name of a hook provided by the extension.

Stringoptional
hook33hook33

Name of a hook provided by the extension.

Stringoptional
hook34hook34

Name of a hook provided by the extension.

Stringoptional
hook35hook35

Name of a hook provided by the extension.

Stringoptional
hook36hook36

Name of a hook provided by the extension.

Stringoptional
hook37hook37

Name of a hook provided by the extension.

Stringoptional
hook38hook38

Name of a hook provided by the extension.

Stringoptional
hook39hook39

Name of a hook provided by the extension.

Stringoptional
hook40hook40

Name of a hook provided by the extension.

Stringoptional
hook41hook41

Name of a hook provided by the extension.

Stringoptional
hook42hook42

Name of a hook provided by the extension.

Stringoptional
hook43hook43

Name of a hook provided by the extension.

Stringoptional
hook44hook44

Name of a hook provided by the extension.

Stringoptional
hook45hook45

Name of a hook provided by the extension.

Stringoptional
hook46hook46

Name of a hook provided by the extension.

Stringoptional
hook47hook47

Name of a hook provided by the extension.

Stringoptional
hook48hook48

Name of a hook provided by the extension.

Stringoptional
hook49hook49

Name of a hook provided by the extension.

Stringoptional
hook50hook50

Name of a hook provided by the extension.

Stringoptional
hook51hook51

Name of a hook provided by the extension.

Stringoptional
hook52hook52

Name of a hook provided by the extension.

Stringoptional
hook53hook53

Name of a hook provided by the extension.

Stringoptional
hook54hook54

Name of a hook provided by the extension.

Stringoptional
hook55hook55

Name of a hook provided by the extension.

Stringoptional
hook56hook56

Name of a hook provided by the extension.

Stringoptional
hook57hook57

Name of a hook provided by the extension.

Stringoptional
hook58hook58

Name of a hook provided by the extension.

Stringoptional
hook59hook59

Name of a hook provided by the extension.

Stringoptional
hook60hook60

Name of a hook provided by the extension.

Stringoptional
hook61hook61

Name of a hook provided by the extension.

Stringoptional
hook62hook62

Name of a hook provided by the extension.

Stringoptional
hook63hook63

Name of a hook provided by the extension.

Stringoptional
hook64hook64

Name of a hook provided by the extension.

Stringoptional
hook65hook65

Name of a hook provided by the extension.

Stringoptional
hook66hook66

Name of a hook provided by the extension.

Stringoptional
hook67hook67

Name of a hook provided by the extension.

Stringoptional
hook68hook68

Name of a hook provided by the extension.

Stringoptional
hook69hook69

Name of a hook provided by the extension.

Stringoptional
hook70hook70

Name of a hook provided by the extension.

Stringoptional
hook71hook71

Name of a hook provided by the extension.

Stringoptional
hook72hook72

Name of a hook provided by the extension.

Stringoptional
hook73hook73

Name of a hook provided by the extension.

Stringoptional
hook74hook74

Name of a hook provided by the extension.

Stringoptional
hook75hook75

Name of a hook provided by the extension.

Stringoptional
hook76hook76

Name of a hook provided by the extension.

Stringoptional
hook77hook77

Name of a hook provided by the extension.

Stringoptional
hook78hook78

Name of a hook provided by the extension.

Stringoptional
hook79hook79

Name of a hook provided by the extension.

Stringoptional
hook80hook80

Name of a hook provided by the extension.

Stringoptional
hook81hook81

Name of a hook provided by the extension.

Stringoptional
hook82hook82

Name of a hook provided by the extension.

Stringoptional
hook83hook83

Name of a hook provided by the extension.

Stringoptional
hook84hook84

Name of a hook provided by the extension.

Stringoptional
hook85hook85

Name of a hook provided by the extension.

Stringoptional
hook86hook86

Name of a hook provided by the extension.

Stringoptional
hook87hook87

Name of a hook provided by the extension.

Stringoptional
hook88hook88

Name of a hook provided by the extension.

Stringoptional
hook89hook89

Name of a hook provided by the extension.

Stringoptional
hook90hook90

Name of a hook used by the extension.

Stringoptional
newhook1newhook1

Name of a hook provided by the extension.

Example
CentralNoticeCampaignChange
Stringoptional
newhook2newhook2

Name of a hook provided by the extension.

Stringoptional
newhook3newhook3

Name of a hook provided by the extension.

Stringoptional
newhook4newhook4

Name of a hook provided by the extension.

Stringoptional
newhook5newhook5

Name of a hook provided by the extension.

Stringoptional
newhook6newhook6

Name of a hook provided by the extension.

Stringoptional
newhook7newhook7

Name of a hook provided by the extension.

Stringoptional
newhook8newhook8

Name of a hook provided by the extension.

Stringoptional
newhook9newhook9

Name of a hook provided by the extension.

Stringoptional
newhook10newhook10

Name of a hook provided by the extension.

Stringoptional
newhook11newhook11

Name of a hook provided by the extension.

Stringoptional
newhook12newhook12

Name of a hook provided by the extension.

Stringoptional
newhook13newhook13

Name of a hook provided by the extension.

Stringoptional
newhook14newhook14

Name of a hook provided by the extension.

Stringoptional
newhook15newhook15

Name of a hook provided by the extension.

Stringoptional
newhook16newhook16

Name of a hook provided by the extension.

Stringoptional
newhook17newhook17

Name of a hook provided by the extension.

Stringoptional
newhook18newhook18

Name of a hook provided by the extension.

Stringoptional
newhook19newhook19

Name of a hook provided by the extension.

Stringoptional
newhook20newhook20

Name of a hook provided by the extension.

Stringoptional
newhook21newhook21

Name of a hook provided by the extension.

Stringoptional
newhook22newhook22

Name of a hook provided by the extension.

Stringoptional
newhook23newhook23

Name of a hook provided by the extension.

Stringoptional
newhook24newhook24

Name of a hook provided by the extension.

Stringoptional
newhook25newhook25

Name of a hook provided by the extension.

Stringoptional
newhook26newhook26

Name of a hook provided by the extension.

Stringoptional
newhook27newhook27

Name of a hook provided by the extension.

Stringoptional
newhook28newhook28

Name of a hook provided by the extension.

Stringoptional
newhook29newhook29

Name of a hook provided by the extension.

Stringoptional
newhook30newhook30

Name of a hook provided by the extension.

Stringoptional
newhook31newhook31

Name of a hook provided by the extension.

Stringoptional
newhook32newhook32

Name of a hook provided by the extension.

Stringoptional
newhook33newhook33

Name of a hook provided by the extension.

Stringoptional
newhook34newhook34

Name of a hook provided by the extension.

Stringoptional
newhook35newhook35

Name of a hook provided by the extension.

Stringoptional
newhook36newhook36

Name of a hook provided by the extension.

Stringoptional
newhook37newhook37

Name of a hook provided by the extension.

Stringoptional
newhook38newhook38

Name of a hook provided by the extension.

Stringoptional
newhook39newhook39

Name of a hook provided by the extension.

Stringoptional
newhook40newhook40

Name of a hook provided by the extension.

Stringoptional
newhook41newhook41

Name of a hook provided by the extension.

Stringoptional
newhook42newhook42

Name of a hook provided by the extension.

Stringoptional
newhook43newhook43

Name of a hook provided by the extension.

Stringoptional
newhook44newhook44

Name of a hook provided by the extension.

Stringoptional
newhook45newhook45

Name of a hook provided by the extension.

Stringoptional
newhook46newhook46

Name of a hook provided by the extension.

Stringoptional
newhook47newhook47

Name of a hook provided by the extension.

Stringoptional
newhook48newhook48

Name of a hook provided by the extension.

Stringoptional
newhook49newhook49

Name of a hook provided by the extension.

Stringoptional
newhook50newhook50

Name of a hook provided by the extension.

Stringoptional
newhook51newhook51

Name of a hook provided by the extension.

Stringoptional
newhook52newhook52

Name of a hook provided by the extension.

Stringoptional
newhook53newhook53

Name of a hook provided by the extension.

Stringoptional
newhook54newhook54

Name of a hook provided by the extension.

Stringoptional
newhook55newhook55

Name of a hook provided by the extension.

Stringoptional
newhook56newhook56

Name of a hook provided by the extension.

Stringoptional
newhook57newhook57

Name of a hook provided by the extension.

Stringoptional
newhook58newhook58

Name of a hook provided by the extension.

Stringoptional
newhook59newhook59

Name of a hook provided by the extension.

Stringoptional
newhook60newhook60

Name of a hook provided by the extension.

Stringoptional
newhook61newhook61

Name of a hook provided by the extension.

Stringoptional
newhook62newhook62

Name of a hook provided by the extension.

Stringoptional
newhook63newhook63

Name of a hook provided by the extension.

Stringoptional
newhook64newhook64

Name of a hook provided by the extension.

Stringoptional
newhook65newhook65

Name of a hook provided by the extension.

Stringoptional
newhook66newhook66

Name of a hook provided by the extension.

Stringoptional
newhook67newhook67

Name of a hook provided by the extension.

Stringoptional
newhook68newhook68

Name of a hook provided by the extension.

Stringoptional
newhook69newhook69

Name of a hook provided by the extension.

Stringoptional
newhook70newhook70

Name of a hook provided by the extension.

Stringoptional
newhook71newhook71

Name of a hook provided by the extension.

Stringoptional
newhook72newhook72

Name of a hook provided by the extension.

Stringoptional
newhook73newhook73

Name of a hook provided by the extension.

Stringoptional
newhook74newhook74

Name of a hook provided by the extension.

Stringoptional
newhook75newhook75

Name of a hook provided by the extension.

Stringoptional
newhook76newhook76

Name of a hook provided by the extension.

Stringoptional
newhook77newhook77

Name of a hook provided by the extension.

Stringoptional
newhook78newhook78

Name of a hook provided by the extension.

Stringoptional
newhook79newhook79

Name of a hook provided by the extension.

Stringoptional
newhook80newhook80

Name of a hook provided by the extension.

Stringoptional
newhook81newhook81

Name of a hook provided by the extension.

Stringoptional
newhook82newhook82

Name of a hook provided by the extension.

Stringoptional
newhook83newhook83

Name of a hook provided by the extension.

Stringoptional
newhook84newhook84

Name of a hook provided by the extension.

Stringoptional
newhook85newhook85

Name of a hook provided by the extension.

Stringoptional
newhook86newhook86

Name of a hook provided by the extension.

Stringoptional
newhook87newhook87

Name of a hook provided by the extension.

Stringoptional
newhook88newhook88

Name of a hook provided by the extension.

Stringoptional
newhook89newhook89

Name of a hook provided by the extension.

Stringoptional
newhook90newhook90

Name of a hook provided by the extension.

Stringoptional
Compatibility chartcompatibility

no description

Example
{{Extension Testing | ... }}
Stringoptional
TranslateWiki grouptranslate

Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled.

Example
ext-discussiontools
Stringoptional
Vagrant rolevagrant-role

A MediaWiki-Vagrant role that lets you use this extension

Example
visualeditor
Stringoptional
Check usage linkCheckUsageNameOverride

Override the page name used for the check usage link.

Stringoptional
Bugzilla component namebugzilla

name of the Bugzilla component

Stringdeprecated