WPRDC Wiki

Difference between revisions of "Template:Extension/doc"

Template:Extension/doc (view source)

Revision as of 23:55, 20 October 2021

10,604 bytes added ,  23:55, 20 October 2021
Drop parameters that aren't supported from the TemplateData
>Shirayuki
(migrate)
>Pppery
(Drop parameters that aren't supported from the TemplateData)
 
(28 intermediate revisions by 13 users not shown)
Line 1: Line 1:
==TemplateData==
<noinclude>{{Documentation subpage}}
 
<!-- 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 9: Line 12:
"default": "unknown",
"default": "unknown",
"label": "Status",
"label": "Status",
"type": "string"
"type": "string",
"example": "stable",
"suggested": true
},
},
"name": {
"name": {
"description": "name of the extension",
"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 27: 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": "Facultative, size of the image (default size is 220px)"
"description": "Optional size of the image",
"label": "Image size",
"default": "220"
},
},
"type": {
"type": {
"description": "Implementation type. See detailed doc.",
"description": "Implementation type. If more that one type is required, use \"Primary type\", \"Secondary type\", ... instead",
"label": "Primary type"
"label": "Type",
"type": "string",
"suggested": true
},
},
"type1": {
"type1": {
"description": "Implementation type. See detailed doc.",
"description": "Implementation type. See detailed doc.",
"label": "Secondary type"
"label": "Primary type",
"type": "string"
},
},
"type2": {
"type2": {
"description": "Implementation type. See detailed doc.",
"description": "Implementation type. See detailed doc.",
"label": "Tertiary type"
"label": "Secondary type"
},
},
"type3": {
"type3": {
"description": "Implementation type. See detailed doc.",
"description": "Implementation type. See detailed doc.",
"label": "Quaternary type"
"label": "Third type",
"type": "string"
},
},
"type4": {
"type4": {
"description": "Implementation type. See detailed doc.",
"description": "Implementation type. See detailed doc.",
"label": "Quaternary type"
"label": "Fourth type",
"type": "string"
},
},
"type5": {
"type5": {
"description": "Implementation type. See detailed doc.",
"description": "Implementation type. See detailed doc.",
"label": "Quinary type"
"label": "Fifth type",
"type": "string"
},
},
"type6": {
"type6": {
"description": "Implementation type. See detailed doc.",
"description": "Implementation type. See detailed doc.",
"label": "Senary type"
"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"
"version": {
"aliases": [
"latest release version",
"latest_release_version"
]
},
"update": {
"description": "date of the last update"
},
"version preview": {
"description": "version preview"
},
"update preview": {
"description": "version preview"
},
},
"mediawiki": {
"mediawiki": {
"description": "Required version of MediaWiki"
"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": {
"description": "Phabricator project name",
"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": "Link to the download."
"description": "External link to download",
"label": "Download link",
"type": "url"
},
},
"readme": {
"readme": {
"description": "external link to the readme file"
"description": "External link to the readme file",
"label": "README link",
"type": "url"
},
},
"changelog": {
"changelog": {
"description": "external link to the changelog file"
"description": "External link to the changelog file",
"label": "Changelog link",
"type": "url"
},
},
"example": {
"example": {
"description": "example, website or screenshot of working extension"
"description": "Example, website or screenshot of working extension",
"label": "Example"
},
},
"namespace": {
"namespace": {
"description": "namespace in which this extension is used"
"description": "Namespace in which this extension is used",
"label": "Namespace"
},
},
"parameters": {
"parameters": {
"description": "available parameters for LocalSettings.php"
"description": "Available parameters for LocalSettings.php",
"label": "Parameters"
},
},
"tags": {
"tags": {
"description": "any tags your extension uses"
"description": "Any tags the extension uses",
"label": "Tags"
},
},
"rights": {
"rights": {
"description": "Rights added by the extension. Not to be confused with the license!"
"description": "User rights added by the extension.",
"label": "Rights"
},
},
"hook1": {
"hook1": {
Line 298: Line 351:
},
},
"hook48": {
"hook48": {
"description": "Name of a hook used by the extension."
},
"hook49": {
"description": "Name of a hook used by the extension."
},
"hook50": {
"description": "Name of a hook used by the extension."
},
"hook51": {
"description": "Name of a hook used by the extension."
},
"hook52": {
"description": "Name of a hook used by the extension."
},
"hook53": {
"description": "Name of a hook used by the extension."
},
"hook54": {
"description": "Name of a hook used by the extension."
},
"hook55": {
"description": "Name of a hook used by the extension."
},
"hook56": {
"description": "Name of a hook used by the extension."
},
"hook57": {
"description": "Name of a hook used by the extension."
},
"hook58": {
"description": "Name of a hook used by the extension."
},
"hook59": {
"description": "Name of a hook used by the extension."
},
"hook60": {
"description": "Name of a hook used by the extension."
},
"hook61": {
"description": "Name of a hook used by the extension."
},
"hook62": {
"description": "Name of a hook used by the extension."
},
"hook63": {
"description": "Name of a hook used by the extension."
},
"hook64": {
"description": "Name of a hook used by the extension."
},
"hook65": {
"description": "Name of a hook used by the extension."
},
"hook66": {
"description": "Name of a hook used by the extension."
},
"hook67": {
"description": "Name of a hook used by the extension."
},
"hook68": {
"description": "Name of a hook used by the extension."
},
"hook69": {
"description": "Name of a hook used by the extension."
},
"hook70": {
"description": "Name of a hook used by the extension."
},
"hook71": {
"description": "Name of a hook used by the extension."
},
"hook72": {
"description": "Name of a hook used by the extension."
},
"hook73": {
"description": "Name of a hook used by the extension."
},
"hook74": {
"description": "Name of a hook used by the extension."
},
"hook75": {
"description": "Name of a hook used by the extension."
},
"hook76": {
"description": "Name of a hook used by the extension."
},
"hook77": {
"description": "Name of a hook used by the extension."
},
"hook78": {
"description": "Name of a hook used by the extension."
},
"hook79": {
"description": "Name of a hook used by the extension."
},
"hook80": {
"description": "Name of a hook used by the extension."
},
"hook81": {
"description": "Name of a hook used by the extension."
},
"hook82": {
"description": "Name of a hook used by the extension."
},
"hook83": {
"description": "Name of a hook used by the extension."
},
"hook84": {
"description": "Name of a hook used by the extension."
},
"hook85": {
"description": "Name of a hook used by the extension."
},
"hook86": {
"description": "Name of a hook used by the extension."
},
"hook87": {
"description": "Name of a hook used by the extension."
},
"hook88": {
"description": "Name of a hook used by the extension."
},
"hook89": {
"description": "Name of a hook used by the extension."
},
"hook90": {
"description": "Name of a hook used by the extension."
"description": "Name of a hook used by the extension."
},
},
Line 442: Line 621:
},
},
"newhook48": {
"newhook48": {
"description": "Name of a hook provided by the extension."
},
"newhook49": {
"description": "Name of a hook provided by the extension."
},
"newhook50": {
"description": "Name of a hook provided by the extension."
},
"newhook51": {
"description": "Name of a hook provided by the extension."
},
"newhook52": {
"description": "Name of a hook provided by the extension."
},
"newhook53": {
"description": "Name of a hook provided by the extension."
},
"newhook54": {
"description": "Name of a hook provided by the extension."
},
"newhook55": {
"description": "Name of a hook provided by the extension."
},
"newhook56": {
"description": "Name of a hook provided by the extension."
},
"newhook57": {
"description": "Name of a hook provided by the extension."
},
"newhook58": {
"description": "Name of a hook provided by the extension."
},
"newhook59": {
"description": "Name of a hook provided by the extension."
},
"newhook60": {
"description": "Name of a hook provided by the extension."
},
"newhook61": {
"description": "Name of a hook provided by the extension."
},
"newhook62": {
"description": "Name of a hook provided by the extension."
},
"newhook63": {
"description": "Name of a hook provided by the extension."
},
"newhook64": {
"description": "Name of a hook provided by the extension."
},
"newhook65": {
"description": "Name of a hook provided by the extension."
},
"newhook66": {
"description": "Name of a hook provided by the extension."
},
"newhook67": {
"description": "Name of a hook provided by the extension."
},
"newhook68": {
"description": "Name of a hook provided by the extension."
},
"newhook69": {
"description": "Name of a hook provided by the extension."
},
"newhook70": {
"description": "Name of a hook provided by the extension."
},
"newhook71": {
"description": "Name of a hook provided by the extension."
},
"newhook72": {
"description": "Name of a hook provided by the extension."
},
"newhook73": {
"description": "Name of a hook provided by the extension."
},
"newhook74": {
"description": "Name of a hook provided by the extension."
},
"newhook75": {
"description": "Name of a hook provided by the extension."
},
"newhook76": {
"description": "Name of a hook provided by the extension."
},
"newhook77": {
"description": "Name of a hook provided by the extension."
},
"newhook78": {
"description": "Name of a hook provided by the extension."
},
"newhook79": {
"description": "Name of a hook provided by the extension."
},
"newhook80": {
"description": "Name of a hook provided by the extension."
},
"newhook81": {
"description": "Name of a hook provided by the extension."
},
"newhook82": {
"description": "Name of a hook provided by the extension."
},
"newhook83": {
"description": "Name of a hook provided by the extension."
},
"newhook84": {
"description": "Name of a hook provided by the extension."
},
"newhook85": {
"description": "Name of a hook provided by the extension."
},
"newhook86": {
"description": "Name of a hook provided by the extension."
},
"newhook87": {
"description": "Name of a hook provided by the extension."
},
"newhook88": {
"description": "Name of a hook provided by the extension."
},
"newhook89": {
"description": "Name of a hook provided by the extension."
},
"newhook90": {
"description": "Name of a hook provided by the extension."
"description": "Name of a hook provided by the extension."
},
},
"compatibility": {
"compatibility": {
"description": "Compatibility chart, e.g. Template:Extension Testing."
"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": {
"description": "Bugzilla MediaWiki extension component name",
"deprecated": true,
"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, if present",
"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."
},
},
"latest release date": {},
"latest_release_date": {},
"latest preview version": {},
"latest_peview_version": {},
"version_preview": {},
"latest_preview_version": {},
"update_preview": {},
"nousage": {},
"CheckUsageNameOverride": {},
"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
"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
},
"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"
}
}
},
},
"format": "block",
"paramOrder": [
"paramOrder": [
"name",
"status",
"status",
"name",
"license",
"license",
"templatemode",
"templatemode",
Line 492: Line 835:
"author",
"author",
"username",
"username",
"version",
"maintainer",
"update",
"latest release version",
"version preview",
"latest release date",
"update preview",
"latest preview version",
"latest preview date",
"compatibility policy",
"compatibility policy",
"mediawiki",
"mediawiki",
Line 568: Line 912:
"hook47",
"hook47",
"hook48",
"hook48",
"hook49",
"hook50",
"hook51",
"hook52",
"hook53",
"hook54",
"hook55",
"hook56",
"hook57",
"hook58",
"hook59",
"hook60",
"hook61",
"hook62",
"hook63",
"hook64",
"hook65",
"hook66",
"hook67",
"hook68",
"hook69",
"hook70",
"hook71",
"hook72",
"hook73",
"hook74",
"hook75",
"hook76",
"hook77",
"hook78",
"hook79",
"hook80",
"hook81",
"hook82",
"hook83",
"hook84",
"hook85",
"hook86",
"hook87",
"hook88",
"hook89",
"hook90",
"newhook1",
"newhook1",
"newhook2",
"newhook2",
Line 616: Line 1,002:
"newhook47",
"newhook47",
"newhook48",
"newhook48",
"newhook49",
"newhook50",
"newhook51",
"newhook52",
"newhook53",
"newhook54",
"newhook55",
"newhook56",
"newhook57",
"newhook58",
"newhook59",
"newhook60",
"newhook61",
"newhook62",
"newhook63",
"newhook64",
"newhook65",
"newhook66",
"newhook67",
"newhook68",
"newhook69",
"newhook70",
"newhook71",
"newhook72",
"newhook73",
"newhook74",
"newhook75",
"newhook76",
"newhook77",
"newhook78",
"newhook79",
"newhook80",
"newhook81",
"newhook82",
"newhook83",
"newhook84",
"newhook85",
"newhook86",
"newhook87",
"newhook88",
"newhook89",
"newhook90",
"compatibility",
"compatibility",
"translate",
"translate",
"bugzilla",
"vagrant-role",
"vagrant-role",
"latest release date",
"CheckUsageNameOverride",
"latest_release_date",
"bugzilla"
"latest preview version",
"latest_peview_version",
"version_preview",
"latest_preview_version",
"update_preview",
"nousage",
"CheckUsageNameOverride"
]
]
}
}</templatedata>
</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>
Anonymous user
Retrieved from "https://wiki.tessercat.net/wiki/Special:MobileDiff/11706...11735"