Difference between revisions of "Template:Extension/doc"
>Uzume (TemplateData: expand number of documented hooks supported from 48 to 90) |
>Pppery (Drop parameters that aren't supported from the TemplateData) |
||
(23 intermediate revisions by 11 users not shown) | |||
Line 1: | Line 1: | ||
< | <noinclude>{{Documentation subpage}} | ||
==TemplateData== | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | ||
</noinclude>== TemplateData == | |||
{{collapse top|title=TemplateData}} | |||
{{TemplateData header|editlinks=1|docpage=Extension/doc}} | |||
<templatedata> | <templatedata> | ||
{ | { | ||
Line 10: | Line 12: | ||
"default": "unknown", | "default": "unknown", | ||
"label": "Status", | "label": "Status", | ||
"type": "string" | "type": "string", | ||
"example": "stable", | |||
"suggested": true | |||
}, | }, | ||
"name": { | "name": { | ||
"description": " | "description": "Name of the extension", | ||
"label": "Name", | "label": "Name", | ||
"type": "string" | "type": "string", | ||
"default": "Current page name", | |||
"suggested": true | |||
}, | }, | ||
"license": { | "license": { | ||
"description": "Extension's license.", | "description": "Extension's license.", | ||
"label": "License", | "label": "License", | ||
"type": "string" | "type": "string", | ||
"suggested": true | |||
}, | }, | ||
"templatemode": { | "templatemode": { | ||
Line 28: | Line 35: | ||
"image": { | "image": { | ||
"description": "Screenshot or logo of extension. It should be provided without namespace and without [[]]s.", | "description": "Screenshot or logo of extension. It should be provided without namespace and without [[]]s.", | ||
"label": "Screenshot or logo" | "label": "Screenshot or logo", | ||
"example": "Example.jpg", | |||
"type": "wiki-file-name", | |||
"suggested": true | |||
}, | }, | ||
"imagesize": { | "imagesize": { | ||
"description": " | "description": "Optional size of the image", | ||
"label": "Image size", | |||
"default": "220" | |||
}, | }, | ||
"type": { | "type": { | ||
"description": "Implementation type. | "description": "Implementation type. If more that one type is required, use \"Primary type\", \"Secondary type\", ... instead", | ||
"label": " | "label": "Type", | ||
"type": "string", | |||
"suggested": true | |||
}, | }, | ||
"type1": { | "type1": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Primary type", | ||
"type": "string" | |||
}, | }, | ||
"type2": { | "type2": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Secondary type" | ||
}, | }, | ||
"type3": { | "type3": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Third type", | ||
"type": "string" | |||
}, | }, | ||
"type4": { | "type4": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Fourth type", | ||
"type": "string" | |||
}, | }, | ||
"type5": { | "type5": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Fifth type", | ||
"type": "string" | |||
}, | }, | ||
"type6": { | "type6": { | ||
"description": "Implementation type. See detailed doc.", | "description": "Implementation type. See detailed doc.", | ||
"label": " | "label": "Sixth type", | ||
"type": "string" | |||
}, | }, | ||
"description": { | "description": { | ||
"description": "Short description | "description": "Short description", | ||
"label": "Description", | |||
"suggested": true | |||
}, | }, | ||
"author": { | "author": { | ||
"description": "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)." | "description": "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).", | ||
"label": "Author", | |||
"suggested": true | |||
}, | }, | ||
"username": { | "username": { | ||
"description": "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. | "description": "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.", | ||
"label": "Username" | |||
" | |||
}, | }, | ||
"mediawiki": { | "mediawiki": { | ||
"description": "Required | "description": "Required versions of MediaWiki. Not needed if this information is in extension.json.", | ||
"label": "MediaWiki version", | |||
"example": ">= 1.35", | |||
"type": "string", | |||
"deprecated": "This value will be read from extension.json where possible." | |||
}, | }, | ||
"php": { | "php": { | ||
"description": "Required version of PHP" | "description": "Required version of PHP", | ||
"label": "PHP version", | |||
"example": "5.4+", | |||
"type": "string" | |||
}, | }, | ||
"needs-updatephp": { | "needs-updatephp": { | ||
"description": "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." | "description": "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.", | ||
"label": "Needs update.php", | |||
"type": "boolean" | |||
}, | }, | ||
"composer": { | "composer": { | ||
"description": "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." | "description": "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.", | ||
"label": "Composer package name", | |||
"example": "mediawiki/semantic-media-wiki", | |||
"type": "string" | |||
}, | }, | ||
"phabricator": { | "phabricator": { | ||
"example": "MediaWiki-extensions-Babel", | "example": "MediaWiki-extensions-Babel", | ||
"type": "string", | "type": "string", | ||
"suggested": true | "suggested": true, | ||
"label": "Phabricator project name" | |||
}, | }, | ||
"table1": { | "table1": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 1", | |||
"type": "string" | |||
}, | }, | ||
"table2": { | "table2": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 2", | |||
"type": "string" | |||
}, | }, | ||
"table3": { | "table3": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 3", | |||
"type": "string" | |||
}, | }, | ||
"table4": { | "table4": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 4", | |||
"type": "string" | |||
}, | }, | ||
"table5": { | "table5": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 5", | |||
"type": "string" | |||
}, | }, | ||
"table6": { | "table6": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 6", | |||
"type": "string" | |||
}, | }, | ||
"table7": { | "table7": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 7", | |||
"type": "string" | |||
}, | }, | ||
"table8": { | "table8": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 8", | |||
"type": "string" | |||
}, | }, | ||
"table9": { | "table9": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 9", | |||
"type": "string" | |||
}, | }, | ||
"table10": { | "table10": { | ||
"description": "Name of a non-core table used by the extension." | "description": "Name of a non-core table used by the extension.", | ||
"label": "Non-core table 10", | |||
"type": "string" | |||
}, | }, | ||
"download": { | "download": { | ||
"description": " | "description": "External link to download", | ||
"label": "Download link", | |||
"type": "url" | |||
}, | }, | ||
"readme": { | "readme": { | ||
"description": " | "description": "External link to the readme file", | ||
"label": "README link", | |||
"type": "url" | |||
}, | }, | ||
"changelog": { | "changelog": { | ||
"description": " | "description": "External link to the changelog file", | ||
"label": "Changelog link", | |||
"type": "url" | |||
}, | }, | ||
"example": { | "example": { | ||
"description": " | "description": "Example, website or screenshot of working extension", | ||
"label": "Example" | |||
}, | }, | ||
"namespace": { | "namespace": { | ||
"description": " | "description": "Namespace in which this extension is used", | ||
"label": "Namespace" | |||
}, | }, | ||
"parameters": { | "parameters": { | ||
"description": " | "description": "Available parameters for LocalSettings.php", | ||
"label": "Parameters" | |||
}, | }, | ||
"tags": { | "tags": { | ||
"description": " | "description": "Any tags the extension uses", | ||
"label": "Tags" | |||
}, | }, | ||
"rights": { | "rights": { | ||
"description": " | "description": "User rights added by the extension.", | ||
"label": "Rights" | |||
}, | }, | ||
"hook1": { | "hook1": { | ||
Line 698: | Line 750: | ||
}, | }, | ||
"compatibility": { | "compatibility": { | ||
" | "label": "Compatibility chart", | ||
"example": "{{Extension Testing | ... }}" | |||
}, | }, | ||
"translate": { | "translate": { | ||
"description": "Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled." | "description": "Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled.", | ||
"label": "TranslateWiki group", | |||
"example": "ext-discussiontools", | |||
"type": "string" | |||
}, | }, | ||
"bugzilla": { | "bugzilla": { | ||
" | "deprecated": true, | ||
" | "label": "Bugzilla component name", | ||
"type": "string" | |||
}, | }, | ||
"vagrant-role": { | "vagrant-role": { | ||
"label": "Vagrant role", | "label": "Vagrant role", | ||
"description": "A MediaWiki-Vagrant role that lets you use this extension | "description": "A MediaWiki-Vagrant role that lets you use this extension", | ||
"type": "string" | "type": "string", | ||
"example": "visualeditor" | |||
}, | |||
"CheckUsageNameOverride": { | |||
"label": "Check usage link", | |||
"description": "Override the page name used for the check usage link." | |||
}, | }, | ||
"compatibility policy": { | "compatibility policy": { | ||
"description": "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", | "description": "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", | ||
"type": "string", | "type": "string", | ||
"suggested": true, | |||
"label": "Compatibility policy" | |||
}, | |||
"latest release date": { | |||
"aliases": [ | |||
"update", | |||
"latest_release_date" | |||
], | |||
"label": "Latest version release date", | |||
"suggested": true | |||
}, | |||
"latest preview version": { | |||
"aliases": [ | |||
"version preview", | |||
"latest_preview_version", | |||
"version_preview" | |||
], | |||
"label": "Latest preview version" | |||
}, | |||
"latest release version": { | |||
"aliases": [ | |||
"version", | |||
"latest_release_version" | |||
], | |||
"label": "Latest version", | |||
"suggested": true | "suggested": true | ||
}, | |||
"latest preview date": { | |||
"aliases": [ | |||
"update preview", | |||
"latest_preview_date", | |||
"update_preview" | |||
], | |||
"label": "Latest preview version update date" | |||
}, | |||
"maintainer": { | |||
"label": "Maintainer", | |||
"description": "Username or other information about who maintains this extension.", | |||
"type": "string" | |||
} | } | ||
}, | }, | ||
"paramOrder": [ | "paramOrder": [ | ||
"name", | |||
"status", | "status", | ||
"license", | "license", | ||
"templatemode", | "templatemode", | ||
Line 744: | Line 835: | ||
"author", | "author", | ||
"username", | "username", | ||
"version", | "maintainer", | ||
" | "latest release version", | ||
"version | "latest release date", | ||
" | "latest preview version", | ||
"latest preview date", | |||
"compatibility policy", | "compatibility policy", | ||
"mediawiki", | "mediawiki", | ||
Line 954: | Line 1,046: | ||
"compatibility", | "compatibility", | ||
"translate", | "translate", | ||
"vagrant-role", | "vagrant-role", | ||
" | "CheckUsageNameOverride", | ||
"bugzilla" | |||
" | |||
] | ] | ||
} | }</templatedata> | ||
</ | {{collapse bottom}} | ||
<includeonly>{{Sandbox other|| | |||
<!-- Categories below this line; interwikis at Wikidata --> | |||
[[Category:Info templates{{#translation:}}]] | |||
[[Category:Extension creation{{#translation:}}]] | |||
[[Category:Categorizing templates{{#translation:}}]] | |||
[[Category:Extension templates{{#translation:}}]] | |||
}}</includeonly> |
Latest revision as of 23:55, 20 October 2021
Template:Documentation subpage
TemplateData
TemplateData | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the TemplateData documentation for this template used by VisualEditor and other tools. Extension An infobox for a MediaWiki extension.
|