Template:Extension/doc

From MediaWiki.org
Jump to navigation Jump to search

TemplateData

An infobox for a MediaWiki extension.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Statusstatus

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

Default
unknown
Stringoptional
Namename

name of the extension

Stringoptional
Licenselicense

Extension's license.

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

Unknownoptional
Imagesizeimagesize

Facultative, size of the image (default size is 220px)

Unknownoptional
Primary typetype

Implementation type. See detailed doc.

Unknownoptional
Secondary typetype1

Implementation type. See detailed doc.

Unknownoptional
Tertiary typetype2

Implementation type. See detailed doc.

Unknownoptional
Quaternary typetype3

Implementation type. See detailed doc.

Unknownoptional
Quaternary typetype4

Implementation type. See detailed doc.

Unknownoptional
Quinary typetype5

Implementation type. See detailed doc.

Unknownoptional
Senary typetype6

Implementation type. See detailed doc.

Unknownoptional
Descriptiondescription

Short description.

Unknownoptional
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).

Unknownoptional
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
Versionversionlatest release versionlatest_release_version

no description

Unknownoptional
Updateupdate

date of the last update

Unknownoptional
Version previewversion preview

version preview

Unknownoptional
Update previewupdate preview

version preview

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

Stringsuggested
Mediawikimediawiki

Required version of MediaWiki

Unknownoptional
Phpphp

Required version of PHP

Unknownoptional
Needs-updatephpneeds-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.

Unknownoptional
Composercomposer

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.

Unknownoptional
Phabricatorphabricator

Phabricator project name

Example
MediaWiki-extensions-Babel
Stringsuggested
Table1table1

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

Unknownoptional
Table2table2

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

Unknownoptional
Table3table3

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

Unknownoptional
Table4table4

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

Unknownoptional
Table5table5

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

Unknownoptional
Table6table6

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

Unknownoptional
Table7table7

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

Unknownoptional
Table8table8

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

Unknownoptional
Table9table9

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

Unknownoptional
Table10table10

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

Unknownoptional
Downloaddownload

Link to the download.

Unknownoptional
Readmereadme

external link to the readme file

Unknownoptional
Changelogchangelog

external link to the changelog file

Unknownoptional
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 your extension uses

Unknownoptional
Rightsrights

Rights added by the extension. Not to be confused with the license!

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
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
Compatibilitycompatibility

Compatibility chart, e.g. Template:Extension Testing.

Unknownoptional
Translatetranslate

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

Unknownoptional
Bugzillabugzilla

Bugzilla MediaWiki extension component name

Unknowndeprecated
Vagrant rolevagrant-role

A MediaWiki-Vagrant role that lets you use this extension, if present

Stringoptional
Latest release datelatest release date

no description

Unknownoptional
Latest_release_datelatest_release_date

no description

Unknownoptional
Latest preview versionlatest preview version

no description

Unknownoptional
Latest_peview_versionlatest_peview_version

no description

Unknownoptional
Version_previewversion_preview

no description

Unknownoptional
Latest_preview_versionlatest_preview_version

no description

Unknownoptional
Update_previewupdate_preview

no description

Unknownoptional
Nousagenousage

no description

Unknownoptional
CheckUsageNameOverrideCheckUsageNameOverride

no description

Unknownoptional