Template:Extension/doc

From mediawiki.org
Jump to navigation Jump to search

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
Stringsuggested
Statusstatus

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

Default
unknown
Example
stable
Stringsuggested
Licenselicense

Extension's license.

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
Example.jpg
Filesuggested
Image sizeimagesize

Optional size of the image

Default
220
Unknownoptional
Typetype

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

Stringsuggested
Primary typetype1

Implementation type. See detailed doc.

Stringoptional
Secondary typetype2

Implementation type. See detailed doc.

Unknownoptional
Third typetype3

Implementation type. See detailed doc.

Stringoptional
Fourth typetype4

Implementation type. See detailed doc.

Stringoptional
Fifth typetype5

Implementation type. See detailed doc.

Stringoptional
Sixth typetype6

Implementation type. See detailed doc.

Stringoptional
Descriptiondescription

Short description

Unknownsuggested
Authorauthor

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

Unknownsuggested
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.

Unknownoptional
Maintainermaintainer

Username or other information about who maintains this extension.

Stringoptional
Latest versionlatest release version version latest_release_version

no description

Unknownsuggested
Latest version release datelatest release date update latest_release_date

no description

Unknownsuggested
Latest preview versionlatest preview version version preview latest_preview_version version_preview

no description

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

no description

Unknownoptional
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

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
5.4+
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.

Booleanoptional
Composer package namecomposer

If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.

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

no description

Example
MediaWiki-extensions-Babel
Stringsuggested
Non-core table 1table1

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

Stringoptional
Non-core table 2table2

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

Stringoptional
Non-core table 3table3

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

Stringoptional
Non-core table 4table4

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

Stringoptional
Non-core table 5table5

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

Stringoptional
Non-core table 6table6

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

Stringoptional
Non-core table 7table7

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

Stringoptional
Non-core table 8table8

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

Stringoptional
Non-core table 9table9

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

Stringoptional
Non-core table 10table10

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

Unknownoptional
Namespacenamespace

Namespace in which this extension is used

Unknownoptional
Parametersparameters

Available parameters for LocalSettings.php

Unknownoptional
Tagstags

Any tags the extension uses

Unknownoptional
Rightsrights

User rights added by the extension.

Unknownoptional
hook1hook1

Name of a hook used by the extension.

Unknownoptional
hook2hook2

Name of a hook used by the extension.

Unknownoptional
hook3hook3

Name of a hook used by the extension.

Unknownoptional
hook4hook4

Name of a hook used by the extension.

Unknownoptional
hook5hook5

Name of a hook used by the extension.

Unknownoptional
hook6hook6

Name of a hook used by the extension.

Unknownoptional
hook7hook7

Name of a hook used by the extension.

Unknownoptional
hook8hook8

Name of a hook used by the extension.

Unknownoptional
hook9hook9

Name of a hook used by the extension.

Unknownoptional
hook10hook10

Name of a hook used by the extension.

Unknownoptional
hook11hook11

Name of a hook used by the extension.

Unknownoptional
hook12hook12

Name of a hook used by the extension.

Unknownoptional
hook13hook13

Name of a hook used by the extension.

Unknownoptional
hook14hook14

Name of a hook used by the extension.

Unknownoptional
hook15hook15

Name of a hook used by the extension.

Unknownoptional
hook16hook16

Name of a hook used by the extension.

Unknownoptional
hook17hook17

Name of a hook used by the extension.

Unknownoptional
hook18hook18

Name of a hook used by the extension.

Unknownoptional
hook19hook19

Name of a hook used by the extension.

Unknownoptional
hook20hook20

Name of a hook used by the extension.

Unknownoptional
hook21hook21

Name of a hook used by the extension.

Unknownoptional
hook22hook22

Name of a hook used by the extension.

Unknownoptional
hook23hook23

Name of a hook used by the extension.

Unknownoptional
hook24hook24

Name of a hook used by the extension.

Unknownoptional
hook25hook25

Name of a hook used by the extension.

Unknownoptional
hook26hook26

Name of a hook used by the extension.

Unknownoptional
hook27hook27

Name of a hook used by the extension.

Unknownoptional
hook28hook28

Name of a hook used by the extension.

Unknownoptional
hook29hook29

Name of a hook used by the extension.

Unknownoptional
hook30hook30

Name of a hook used by the extension.

Unknownoptional
hook31hook31

Name of a hook used by the extension.

Unknownoptional
hook32hook32

Name of a hook used by the extension.

Unknownoptional
hook33hook33

Name of a hook used by the extension.

Unknownoptional
hook34hook34

Name of a hook used by the extension.

Unknownoptional
hook35hook35

Name of a hook used by the extension.

Unknownoptional
hook36hook36

Name of a hook used by the extension.

Unknownoptional
hook37hook37

Name of a hook used by the extension.

Unknownoptional
hook38hook38

Name of a hook used by the extension.

Unknownoptional
hook39hook39

Name of a hook used by the extension.

Unknownoptional
hook40hook40

Name of a hook used by the extension.

Unknownoptional
hook41hook41

Name of a hook used by the extension.

Unknownoptional
hook42hook42

Name of a hook used by the extension.

Unknownoptional
hook43hook43

Name of a hook used by the extension.

Unknownoptional
hook44hook44

Name of a hook used by the extension.

Unknownoptional
hook45hook45

Name of a hook used by the extension.

Unknownoptional
hook46hook46

Name of a hook used by the extension.

Unknownoptional
hook47hook47

Name of a hook used by the extension.

Unknownoptional
hook48hook48

Name of a hook used by the extension.

Unknownoptional
hook49hook49

Name of a hook used by the extension.

Unknownoptional
hook50hook50

Name of a hook used by the extension.

Unknownoptional
hook51hook51

Name of a hook used by the extension.

Unknownoptional
hook52hook52

Name of a hook used by the extension.

Unknownoptional
hook53hook53

Name of a hook used by the extension.

Unknownoptional
hook54hook54

Name of a hook used by the extension.

Unknownoptional
hook55hook55

Name of a hook used by the extension.

Unknownoptional
hook56hook56

Name of a hook used by the extension.

Unknownoptional
hook57hook57

Name of a hook used by the extension.

Unknownoptional
hook58hook58

Name of a hook used by the extension.

Unknownoptional
hook59hook59

Name of a hook used by the extension.

Unknownoptional
hook60hook60

Name of a hook used by the extension.

Unknownoptional
hook61hook61

Name of a hook used by the extension.

Unknownoptional
hook62hook62

Name of a hook used by the extension.

Unknownoptional
hook63hook63

Name of a hook used by the extension.

Unknownoptional
hook64hook64

Name of a hook used by the extension.

Unknownoptional
hook65hook65

Name of a hook used by the extension.

Unknownoptional
hook66hook66

Name of a hook used by the extension.

Unknownoptional
hook67hook67

Name of a hook used by the extension.

Unknownoptional
hook68hook68

Name of a hook used by the extension.

Unknownoptional
hook69hook69

Name of a hook used by the extension.

Unknownoptional
hook70hook70

Name of a hook used by the extension.

Unknownoptional
hook71hook71

Name of a hook used by the extension.

Unknownoptional
hook72hook72

Name of a hook used by the extension.

Unknownoptional
hook73hook73

Name of a hook used by the extension.

Unknownoptional
hook74hook74

Name of a hook used by the extension.

Unknownoptional
hook75hook75

Name of a hook used by the extension.

Unknownoptional
hook76hook76

Name of a hook used by the extension.

Unknownoptional
hook77hook77

Name of a hook used by the extension.

Unknownoptional
hook78hook78

Name of a hook used by the extension.

Unknownoptional
hook79hook79

Name of a hook used by the extension.

Unknownoptional
hook80hook80

Name of a hook used by the extension.

Unknownoptional
hook81hook81

Name of a hook used by the extension.

Unknownoptional
hook82hook82

Name of a hook used by the extension.

Unknownoptional
hook83hook83

Name of a hook used by the extension.

Unknownoptional
hook84hook84

Name of a hook used by the extension.

Unknownoptional
hook85hook85

Name of a hook used by the extension.

Unknownoptional
hook86hook86

Name of a hook used by the extension.

Unknownoptional
hook87hook87

Name of a hook used by the extension.

Unknownoptional
hook88hook88

Name of a hook used by the extension.

Unknownoptional
hook89hook89

Name of a hook used by the extension.

Unknownoptional
hook90hook90

Name of a hook used by the extension.

Unknownoptional
newhook1newhook1

Name of a hook provided by the extension.

Unknownoptional
newhook2newhook2

Name of a hook provided by the extension.

Unknownoptional
newhook3newhook3

Name of a hook provided by the extension.

Unknownoptional
newhook4newhook4

Name of a hook provided by the extension.

Unknownoptional
newhook5newhook5

Name of a hook provided by the extension.

Unknownoptional
newhook6newhook6

Name of a hook provided by the extension.

Unknownoptional
newhook7newhook7

Name of a hook provided by the extension.

Unknownoptional
newhook8newhook8

Name of a hook provided by the extension.

Unknownoptional
newhook9newhook9

Name of a hook provided by the extension.

Unknownoptional
newhook10newhook10

Name of a hook provided by the extension.

Unknownoptional
newhook11newhook11

Name of a hook provided by the extension.

Unknownoptional
newhook12newhook12

Name of a hook provided by the extension.

Unknownoptional
newhook13newhook13

Name of a hook provided by the extension.

Unknownoptional
newhook14newhook14

Name of a hook provided by the extension.

Unknownoptional
newhook15newhook15

Name of a hook provided by the extension.

Unknownoptional
newhook16newhook16

Name of a hook provided by the extension.

Unknownoptional
newhook17newhook17

Name of a hook provided by the extension.

Unknownoptional
newhook18newhook18

Name of a hook provided by the extension.

Unknownoptional
newhook19newhook19

Name of a hook provided by the extension.

Unknownoptional
newhook20newhook20

Name of a hook provided by the extension.

Unknownoptional
newhook21newhook21

Name of a hook provided by the extension.

Unknownoptional
newhook22newhook22

Name of a hook provided by the extension.

Unknownoptional
newhook23newhook23

Name of a hook provided by the extension.

Unknownoptional
newhook24newhook24

Name of a hook provided by the extension.

Unknownoptional
newhook25newhook25

Name of a hook provided by the extension.

Unknownoptional
newhook26newhook26

Name of a hook provided by the extension.

Unknownoptional
newhook27newhook27

Name of a hook provided by the extension.

Unknownoptional
newhook28newhook28

Name of a hook provided by the extension.

Unknownoptional
newhook29newhook29

Name of a hook provided by the extension.

Unknownoptional
newhook30newhook30

Name of a hook provided by the extension.

Unknownoptional
newhook31newhook31

Name of a hook provided by the extension.

Unknownoptional
newhook32newhook32

Name of a hook provided by the extension.

Unknownoptional
newhook33newhook33

Name of a hook provided by the extension.

Unknownoptional
newhook34newhook34

Name of a hook provided by the extension.

Unknownoptional
newhook35newhook35

Name of a hook provided by the extension.

Unknownoptional
newhook36newhook36

Name of a hook provided by the extension.

Unknownoptional
newhook37newhook37

Name of a hook provided by the extension.

Unknownoptional
newhook38newhook38

Name of a hook provided by the extension.

Unknownoptional
newhook39newhook39

Name of a hook provided by the extension.

Unknownoptional
newhook40newhook40

Name of a hook provided by the extension.

Unknownoptional
newhook41newhook41

Name of a hook provided by the extension.

Unknownoptional
newhook42newhook42

Name of a hook provided by the extension.

Unknownoptional
newhook43newhook43

Name of a hook provided by the extension.

Unknownoptional
newhook44newhook44

Name of a hook provided by the extension.

Unknownoptional
newhook45newhook45

Name of a hook provided by the extension.

Unknownoptional
newhook46newhook46

Name of a hook provided by the extension.

Unknownoptional
newhook47newhook47

Name of a hook provided by the extension.

Unknownoptional
newhook48newhook48

Name of a hook provided by the extension.

Unknownoptional
newhook49newhook49

Name of a hook provided by the extension.

Unknownoptional
newhook50newhook50

Name of a hook provided by the extension.

Unknownoptional
newhook51newhook51

Name of a hook provided by the extension.

Unknownoptional
newhook52newhook52

Name of a hook provided by the extension.

Unknownoptional
newhook53newhook53

Name of a hook provided by the extension.

Unknownoptional
newhook54newhook54

Name of a hook provided by the extension.

Unknownoptional
newhook55newhook55

Name of a hook provided by the extension.

Unknownoptional
newhook56newhook56

Name of a hook provided by the extension.

Unknownoptional
newhook57newhook57

Name of a hook provided by the extension.

Unknownoptional
newhook58newhook58

Name of a hook provided by the extension.

Unknownoptional
newhook59newhook59

Name of a hook provided by the extension.

Unknownoptional
newhook60newhook60

Name of a hook provided by the extension.

Unknownoptional
newhook61newhook61

Name of a hook provided by the extension.

Unknownoptional
newhook62newhook62

Name of a hook provided by the extension.

Unknownoptional
newhook63newhook63

Name of a hook provided by the extension.

Unknownoptional
newhook64newhook64

Name of a hook provided by the extension.

Unknownoptional
newhook65newhook65

Name of a hook provided by the extension.

Unknownoptional
newhook66newhook66

Name of a hook provided by the extension.

Unknownoptional
newhook67newhook67

Name of a hook provided by the extension.

Unknownoptional
newhook68newhook68

Name of a hook provided by the extension.

Unknownoptional
newhook69newhook69

Name of a hook provided by the extension.

Unknownoptional
newhook70newhook70

Name of a hook provided by the extension.

Unknownoptional
newhook71newhook71

Name of a hook provided by the extension.

Unknownoptional
newhook72newhook72

Name of a hook provided by the extension.

Unknownoptional
newhook73newhook73

Name of a hook provided by the extension.

Unknownoptional
newhook74newhook74

Name of a hook provided by the extension.

Unknownoptional
newhook75newhook75

Name of a hook provided by the extension.

Unknownoptional
newhook76newhook76

Name of a hook provided by the extension.

Unknownoptional
newhook77newhook77

Name of a hook provided by the extension.

Unknownoptional
newhook78newhook78

Name of a hook provided by the extension.

Unknownoptional
newhook79newhook79

Name of a hook provided by the extension.

Unknownoptional
newhook80newhook80

Name of a hook provided by the extension.

Unknownoptional
newhook81newhook81

Name of a hook provided by the extension.

Unknownoptional
newhook82newhook82

Name of a hook provided by the extension.

Unknownoptional
newhook83newhook83

Name of a hook provided by the extension.

Unknownoptional
newhook84newhook84

Name of a hook provided by the extension.

Unknownoptional
newhook85newhook85

Name of a hook provided by the extension.

Unknownoptional
newhook86newhook86

Name of a hook provided by the extension.

Unknownoptional
newhook87newhook87

Name of a hook provided by the extension.

Unknownoptional
newhook88newhook88

Name of a hook provided by the extension.

Unknownoptional
newhook89newhook89

Name of a hook provided by the extension.

Unknownoptional
newhook90newhook90

Name of a hook provided by the extension.

Unknownoptional
Compatibility chartcompatibility

no description

Example
{{Extension Testing | ... }}
Unknownoptional
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.

Unknownoptional
Bugzilla component namebugzilla

no description

Stringdeprecated