WPRDC Wiki

Difference between revisions of "Template:Extension/doc"

Template:Extension/doc (view source)

Revision as of 23:55, 20 October 2021

26,317 bytes added ,  23:55, 20 October 2021
Drop parameters that aren't supported from the TemplateData
>Jose8a
(Replaced content with "<clear> BEFORE YOU EDIT THIS: span ids on each parameter are used by the code in Template:Extension. They enable each label in the info box to link its document...")
>Pppery
(Drop parameters that aren't supported from the TemplateData)
 
(48 intermediate revisions by 24 users not shown)
Line 1: Line 1:
<clear>
<noinclude>{{Documentation subpage}}
BEFORE YOU EDIT THIS:
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
    span ids on each parameter are used by the code in Template:Extension.
</noinclude>== TemplateData ==
    They enable each label in the info box to link its documentation.
{{collapse top|title=TemplateData}}
    If you change an id, please update the code in Template:Extension accordon:
{{TemplateData header|editlinks=1|docpage=Extension/doc}}
<templatedata>
{
"description": "An infobox for a MediaWiki extension.",
"params": {
"status": {
"description": "Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.",
"default": "unknown",
"label": "Status",
"type": "string",
"example": "stable",
"suggested": true
},
"name": {
"description": "Name of the extension",
"label": "Name",
"type": "string",
"default": "Current page name",
"suggested": true
},
"license": {
"description": "Extension's license.",
"label": "License",
"type": "string",
"suggested": true
},
"templatemode": {
"description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.",
"label": "Mode"
},
"image": {
"description": "Screenshot or logo of extension. It should be provided without namespace and without [[]]s.",
"label": "Screenshot or logo",
"example": "Example.jpg",
"type": "wiki-file-name",
"suggested": true
},
"imagesize": {
"description": "Optional size of the image",
"label": "Image size",
"default": "220"
},
"type": {
"description": "Implementation type. If more that one type is required, use \"Primary type\", \"Secondary type\", ... instead",
"label": "Type",
"type": "string",
"suggested": true
},
"type1": {
"description": "Implementation type. See detailed doc.",
"label": "Primary type",
"type": "string"
},
"type2": {
"description": "Implementation type. See detailed doc.",
"label": "Secondary type"
},
"type3": {
"description": "Implementation type. See detailed doc.",
"label": "Third type",
"type": "string"
},
"type4": {
"description": "Implementation type. See detailed doc.",
"label": "Fourth type",
"type": "string"
},
"type5": {
"description": "Implementation type. See detailed doc.",
"label": "Fifth type",
"type": "string"
},
"type6": {
"description": "Implementation type. See detailed doc.",
"label": "Sixth type",
"type": "string"
},
"description": {
"description": "Short description",
"label": "Description",
"suggested": true
},
"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).",
"label": "Author",
"suggested": true
},
"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.",
"label": "Username"
},
"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": {
"description": "Required version of PHP",
"label": "PHP version",
"example": "5.4+",
"type": "string"
},
"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.",
"label": "Needs update.php",
"type": "boolean"
},
"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.",
"label": "Composer package name",
"example": "mediawiki/semantic-media-wiki",
"type": "string"
},
"phabricator": {
"example": "MediaWiki-extensions-Babel",
"type": "string",
"suggested": true,
"label": "Phabricator project name"
},
"table1": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 1",
"type": "string"
},
"table2": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 2",
"type": "string"
},
"table3": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 3",
"type": "string"
},
"table4": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 4",
"type": "string"
},
"table5": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 5",
"type": "string"
},
"table6": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 6",
"type": "string"
},
"table7": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 7",
"type": "string"
},
"table8": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 8",
"type": "string"
},
"table9": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 9",
"type": "string"
},
"table10": {
"description": "Name of a non-core table used by the extension.",
"label": "Non-core table 10",
"type": "string"
},
"download": {
"description": "External link to download",
"label": "Download link",
"type": "url"
},
"readme": {
"description": "External link to the readme file",
"label": "README link",
"type": "url"
},
"changelog": {
"description": "External link to the changelog file",
"label": "Changelog link",
"type": "url"
},
"example": {
"description": "Example, website or screenshot of working extension",
"label": "Example"
},
"namespace": {
"description": "Namespace in which this extension is used",
"label": "Namespace"
},
"parameters": {
"description": "Available parameters for LocalSettings.php",
"label": "Parameters"
},
"tags": {
"description": "Any tags the extension uses",
"label": "Tags"
},
"rights": {
"description": "User rights added by the extension.",
"label": "Rights"
},
"hook1": {
"description": "Name of a hook used by the extension."
},
"hook2": {
"description": "Name of a hook used by the extension."
},
"hook3": {
"description": "Name of a hook used by the extension."
},
"hook4": {
"description": "Name of a hook used by the extension."
},
"hook5": {
"description": "Name of a hook used by the extension."
},
"hook6": {
"description": "Name of a hook used by the extension."
},
"hook7": {
"description": "Name of a hook used by the extension."
},
"hook8": {
"description": "Name of a hook used by the extension."
},
"hook9": {
"description": "Name of a hook used by the extension."
},
"hook10": {
"description": "Name of a hook used by the extension."
},
"hook11": {
"description": "Name of a hook used by the extension."
},
"hook12": {
"description": "Name of a hook used by the extension."
},
"hook13": {
"description": "Name of a hook used by the extension."
},
"hook14": {
"description": "Name of a hook used by the extension."
},
"hook15": {
"description": "Name of a hook used by the extension."
},
"hook16": {
"description": "Name of a hook used by the extension."
},
"hook17": {
"description": "Name of a hook used by the extension."
},
"hook18": {
"description": "Name of a hook used by the extension."
},
"hook19": {
"description": "Name of a hook used by the extension."
},
"hook20": {
"description": "Name of a hook used by the extension."
},
"hook21": {
"description": "Name of a hook used by the extension."
},
"hook22": {
"description": "Name of a hook used by the extension."
},
"hook23": {
"description": "Name of a hook used by the extension."
},
"hook24": {
"description": "Name of a hook used by the extension."
},
"hook25": {
"description": "Name of a hook used by the extension."
},
"hook26": {
"description": "Name of a hook used by the extension."
},
"hook27": {
"description": "Name of a hook used by the extension."
},
"hook28": {
"description": "Name of a hook used by the extension."
},
"hook29": {
"description": "Name of a hook used by the extension."
},
"hook30": {
"description": "Name of a hook used by the extension."
},
"hook31": {
"description": "Name of a hook used by the extension."
},
"hook32": {
"description": "Name of a hook used by the extension."
},
"hook33": {
"description": "Name of a hook used by the extension."
},
"hook34": {
"description": "Name of a hook used by the extension."
},
"hook35": {
"description": "Name of a hook used by the extension."
},
"hook36": {
"description": "Name of a hook used by the extension."
},
"hook37": {
"description": "Name of a hook used by the extension."
},
"hook38": {
"description": "Name of a hook used by the extension."
},
"hook39": {
"description": "Name of a hook used by the extension."
},
"hook40": {
"description": "Name of a hook used by the extension."
},
"hook41": {
"description": "Name of a hook used by the extension."
},
"hook42": {
"description": "Name of a hook used by the extension."
},
"hook43": {
"description": "Name of a hook used by the extension."
},
"hook44": {
"description": "Name of a hook used by the extension."
},
"hook45": {
"description": "Name of a hook used by the extension."
},
"hook46": {
"description": "Name of a hook used by the extension."
},
"hook47": {
"description": "Name of a hook used by the extension."
},
"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."
},
"newhook1": {
"description": "Name of a hook provided by the extension."
},
"newhook2": {
"description": "Name of a hook provided by the extension."
},
"newhook3": {
"description": "Name of a hook provided by the extension."
},
"newhook4": {
"description": "Name of a hook provided by the extension."
},
"newhook5": {
"description": "Name of a hook provided by the extension."
},
"newhook6": {
"description": "Name of a hook provided by the extension."
},
"newhook7": {
"description": "Name of a hook provided by the extension."
},
"newhook8": {
"description": "Name of a hook provided by the extension."
},
"newhook9": {
"description": "Name of a hook provided by the extension."
},
"newhook10": {
"description": "Name of a hook provided by the extension."
},
"newhook11": {
"description": "Name of a hook provided by the extension."
},
"newhook12": {
"description": "Name of a hook provided by the extension."
},
"newhook13": {
"description": "Name of a hook provided by the extension."
},
"newhook14": {
"description": "Name of a hook provided by the extension."
},
"newhook15": {
"description": "Name of a hook provided by the extension."
},
"newhook16": {
"description": "Name of a hook provided by the extension."
},
"newhook17": {
"description": "Name of a hook provided by the extension."
},
"newhook18": {
"description": "Name of a hook provided by the extension."
},
"newhook19": {
"description": "Name of a hook provided by the extension."
},
"newhook20": {
"description": "Name of a hook provided by the extension."
},
"newhook21": {
"description": "Name of a hook provided by the extension."
},
"newhook22": {
"description": "Name of a hook provided by the extension."
},
"newhook23": {
"description": "Name of a hook provided by the extension."
},
"newhook24": {
"description": "Name of a hook provided by the extension."
},
"newhook25": {
"description": "Name of a hook provided by the extension."
},
"newhook26": {
"description": "Name of a hook provided by the extension."
},
"newhook27": {
"description": "Name of a hook provided by the extension."
},
"newhook28": {
"description": "Name of a hook provided by the extension."
},
"newhook29": {
"description": "Name of a hook provided by the extension."
},
"newhook30": {
"description": "Name of a hook provided by the extension."
},
"newhook31": {
"description": "Name of a hook provided by the extension."
},
"newhook32": {
"description": "Name of a hook provided by the extension."
},
"newhook33": {
"description": "Name of a hook provided by the extension."
},
"newhook34": {
"description": "Name of a hook provided by the extension."
},
"newhook35": {
"description": "Name of a hook provided by the extension."
},
"newhook36": {
"description": "Name of a hook provided by the extension."
},
"newhook37": {
"description": "Name of a hook provided by the extension."
},
"newhook38": {
"description": "Name of a hook provided by the extension."
},
"newhook39": {
"description": "Name of a hook provided by the extension."
},
"newhook40": {
"description": "Name of a hook provided by the extension."
},
"newhook41": {
"description": "Name of a hook provided by the extension."
},
"newhook42": {
"description": "Name of a hook provided by the extension."
},
"newhook43": {
"description": "Name of a hook provided by the extension."
},
"newhook44": {
"description": "Name of a hook provided by the extension."
},
"newhook45": {
"description": "Name of a hook provided by the extension."
},
"newhook46": {
"description": "Name of a hook provided by the extension."
},
"newhook47": {
"description": "Name of a hook provided by the extension."
},
"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."
},
"compatibility": {
"label": "Compatibility chart",
"example": "{{Extension Testing | ... }}"
},
"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.",
"label": "TranslateWiki group",
"example": "ext-discussiontools",
"type": "string"
},
"bugzilla": {
"deprecated": true,
"label": "Bugzilla component name",
"type": "string"
},
"vagrant-role": {
"label": "Vagrant role",
"description": "A MediaWiki-Vagrant role that lets you use this extension",
"type": "string",
"example": "visualeditor"
},
"CheckUsageNameOverride": {
"label": "Check usage link",
"description": "Override the page name used for the check usage link."
},
"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, ltsrel",
"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
},
"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": [
"name",
"status",
"license",
"templatemode",
"image",
"imagesize",
"type",
"type1",
"type2",
"type3",
"type4",
"type5",
"type6",
"description",
"author",
"username",
"maintainer",
"latest release version",
"latest release date",
"latest preview version",
"latest preview date",
"compatibility policy",
"mediawiki",
"php",
"needs-updatephp",
"composer",
"phabricator",
"table1",
"table2",
"table3",
"table4",
"table5",
"table6",
"table7",
"table8",
"table9",
"table10",
"download",
"readme",
"changelog",
"example",
"namespace",
"parameters",
"tags",
"rights",
"hook1",
"hook2",
"hook3",
"hook4",
"hook5",
"hook6",
"hook7",
"hook8",
"hook9",
"hook10",
"hook11",
"hook12",
"hook13",
"hook14",
"hook15",
"hook16",
"hook17",
"hook18",
"hook19",
"hook20",
"hook21",
"hook22",
"hook23",
"hook24",
"hook25",
"hook26",
"hook27",
"hook28",
"hook29",
"hook30",
"hook31",
"hook32",
"hook33",
"hook34",
"hook35",
"hook36",
"hook37",
"hook38",
"hook39",
"hook40",
"hook41",
"hook42",
"hook43",
"hook44",
"hook45",
"hook46",
"hook47",
"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",
"newhook2",
"newhook3",
"newhook4",
"newhook5",
"newhook6",
"newhook7",
"newhook8",
"newhook9",
"newhook10",
"newhook11",
"newhook12",
"newhook13",
"newhook14",
"newhook15",
"newhook16",
"newhook17",
"newhook18",
"newhook19",
"newhook20",
"newhook21",
"newhook22",
"newhook23",
"newhook24",
"newhook25",
"newhook26",
"newhook27",
"newhook28",
"newhook29",
"newhook30",
"newhook31",
"newhook32",
"newhook33",
"newhook34",
"newhook35",
"newhook36",
"newhook37",
"newhook38",
"newhook39",
"newhook40",
"newhook41",
"newhook42",
"newhook43",
"newhook44",
"newhook45",
"newhook46",
"newhook47",
"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",
"translate",
"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>
Anonymous user
Retrieved from "https://wiki.tessercat.net/wiki/Special:MobileDiff/11686...11735"