Template:Infobox command/doc: Difference between revisions
No edit summary |
+nav |
||
| (14 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
{{documentation header}} | {{documentation header}} | ||
This template provides a uniform design for the infobox on the [[commands]] page. | This template provides a uniform design for the infobox on the [[commands]] page. | ||
| Line 18: | Line 17: | ||
| <code>oplevel</code> | | <code>oplevel</code> | ||
| The permission level. | | The permission level. | ||
|- | |- | ||
| <code>cheat</code> | | <code>cheat</code> | ||
| Line 35: | Line 31: | ||
|} | |} | ||
=== Examples === | |||
==== Empty ==== | |||
{{Infobox command}} | |||
<pre> | |||
{{Infobox command}} | |||
</pre> | |||
==== Some ==== | |||
{{Infobox command | |||
| name = msg | |||
| alias = {{cmd|tell|link=none}} | |||
| oplevel = 0 | |||
}} | |||
<pre> | |||
{{Infobox command | |||
| name = msg | |||
| alias = {{cmd|tell|link=none}} | |||
| oplevel = 0 | |||
}} | |||
</pre> | |||
==== Everything ==== | |||
{{Infobox command | |||
| name = Example name | |||
| alias = Example alias | |||
| oplevel = 1 | |||
| cheat = 1 | |||
| serveronly = 1 | |||
| singleplayer = 1 | |||
| hidden = 1 | |||
| others = Example | |||
}} | |||
<pre> | |||
{{Infobox command | |||
| name = Example name | |||
| alias = Example alias | |||
| oplevel = 1 | |||
| cheat = 1 | |||
| serveronly = 1 | |||
| singleplayer = 1 | |||
| hidden = 1 | |||
| others = Example | |||
}} | |||
</pre> | |||
<templatedata> | |||
{ | |||
"description": "Shows an infobox for a command.", | |||
"format": "block", | |||
"params": { | |||
"name": { | |||
"label": "Name", | |||
"type": "string", | |||
"description": "Name of the command, if it differs from the title.", | |||
"suggested": true | |||
}, | |||
"alias": { | |||
"label": "Aliases", | |||
"type": "string", | |||
"description": "Aliases for this command." | |||
}, | |||
"oplevel": { | |||
"label": "Permission level", | |||
"type": "number", | |||
"description": "Permission level required to execute this command.", | |||
"suggested": true | |||
}, | |||
"cheats": { | |||
"label": "Restricted to cheats", | |||
"description": "If set, mentions that this command is only available to players with cheats." | |||
}, | |||
"serveronly": { | |||
"label": "Restricted to servers", | |||
"description": "If set, mentions that this command is only available on multiplayer servers." | |||
}, | |||
"singleplayer": { | |||
"label": "Restricted to singleplayer", | |||
"description": "If set, mentions that this command is only available in singleplayer." | |||
}, | |||
"hidden": { | |||
"label": "Hidden", | |||
"description": "If set, mentions the command is hidden." | |||
}, | |||
"others": { | |||
"label": "Other restrictions", | |||
"type": "string", | |||
"description": "Any other restrictions to this command." | |||
} | |||
} | |||
} | |||
</templatedata> | |||
==See also== | |||
{{infobox see also}} | |||
<includeonly> | <includeonly> | ||
<!-- Template categories/interwiki here --> | <!-- Template categories/interwiki here --> | ||
[[Category:Infobox templates]] | [[Category:Infobox templates|Command]] | ||
[[ja:テンプレート:Infobox command]] | [[ja:テンプレート:Infobox command]] | ||
[[ko:명령어/infobox]] | [[ko:명령어/infobox]] | ||
[[pt:Comandos/infobox]] | [[pt:Comandos/infobox]] | ||
[[uk:Шаблон:Картка/Команда]] | |||
[[zh:Template:Infobox command]] | [[zh:Template:Infobox command]] | ||
</includeonly> | </includeonly> | ||
| Line 50: | Line 145: | ||
[[ko:틀:Infobox command/doc]] | [[ko:틀:Infobox command/doc]] | ||
[[pt:Comandos/infobox/doc]] | [[pt:Comandos/infobox/doc]] | ||
[[uk:Шаблон:Картка/Команда/док]] | |||
[[zh:Template:Infobox command/doc]] | [[zh:Template:Infobox command/doc]] | ||
</noinclude> | </noinclude> | ||
Latest revision as of 18:44, 24 February 2024
This template provides a uniform design for the infobox on the commands page.
| Parameter | Function |
|---|---|
name
|
The commands name, defaults to the subpage name. |
alias
|
Aliases for the commands. |
hidden
|
Set to 0 for visible, or 1 for hidden |
oplevel
|
The permission level. |
cheat
|
If set, adds the "Cheat only" restriction. |
singleplayer
|
If set, adds the "Singleplayer only" restriction. |
serveronly
|
If set, adds the "Dedicated server only" restriction. |
others
|
Others restriction. |
Examples
Empty
/doc| Permission level required |
Unknown |
|---|---|
| Restrictions |
None |
{
"title": "<code>/doc</code>",
"rows": [
{
"field": "Unknown",
"label": "(link to Permission level article, displayed as Permission level<br>required)"
},
{
"field": "None",
"label": "(link to Commands#Restrictions article, displayed as Restrictions)"
}
],
"invimages": [],
"images": []
}
{{Infobox command}}
Some
/msg| Aliases |
|
|---|---|
| Permission level required |
0 |
| Restrictions |
None |
{
"title": "<code>/msg</code>",
"rows": [
{
"field": "<!-- Command --><code ><span>/tell</span></code><!-- /Command -->",
"label": "Aliases"
},
{
"field": "0",
"label": "(link to Permission level article, displayed as Permission level<br>required)"
},
{
"field": "None",
"label": "(link to Commands#Restrictions article, displayed as Restrictions)"
}
],
"invimages": [],
"images": []
}
{{Infobox command
| name = msg
| alias = {{cmd|tell|link=none}}
| oplevel = 0
}}
Everything
/Example name| Aliases |
Example alias |
|---|---|
| Visibility |
Hidden |
| Permission level required |
1 |
| Restrictions |
Cheat only |
{
"title": "<code>/Example name</code>",
"rows": [
{
"field": "Example alias",
"label": "Aliases"
},
{
"field": "Hidden",
"label": "Visibility"
},
{
"field": "1",
"label": "(link to Permission level article, displayed as Permission level<br>required)"
},
{
"field": "(link to Option article, displayed as Cheat) only<br>Dedicated server only<br>(link to Singleplayer article, displayed as Singleplayer) only<br>Example",
"label": "(link to Commands#Restrictions article, displayed as Restrictions)"
}
],
"invimages": [],
"images": []
}
{{Infobox command
| name = Example name
| alias = Example alias
| oplevel = 1
| cheat = 1
| serveronly = 1
| singleplayer = 1
| hidden = 1
| others = Example
}}
Shows an infobox for a command.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | name | Name of the command, if it differs from the title. | String | suggested |
| Aliases | alias | Aliases for this command. | String | optional |
| Permission level | oplevel | Permission level required to execute this command. | Number | suggested |
| Restricted to cheats | cheats | If set, mentions that this command is only available to players with cheats. | Unknown | optional |
| Restricted to servers | serveronly | If set, mentions that this command is only available on multiplayer servers. | Unknown | optional |
| Restricted to singleplayer | singleplayer | If set, mentions that this command is only available in singleplayer. | Unknown | optional |
| Hidden | hidden | If set, mentions the command is hidden. | Unknown | optional |
| Other restrictions | others | Any other restrictions to this command. | String | optional |
See also
- Minecraft
{{Infobox biome}}{{Infobox block}}{{Infobox command}}{{Infobox development phase}}{{Infobox enchantment}}{{Infobox effect}}{{Infobox entity}}{{Infobox fluid}}{{Infobox item}}{{Infobox item entity}}{{Infobox structure}}
- Minecraft Earth
- Minecraft Dungeons
{{Infobox Dungeons cosmetic}}{{Infobox Dungeons enchantment}}{{Infobox Dungeons entity}}{{Infobox Dungeons item}}{{Infobox Dungeons mission}}
- Minecraft Legends
{{Infobox Legends biome}}{{Infobox Legends entity}}{{Infobox Legends resource}}{{Infobox Legends mode}}{{Infobox Legends skin}}{{Infobox Legends structure}}
- Minecraft Story Mode
{{Infobox episode}}
- Other
{{Infobox album}}{{Infobox book}}{{Infobox board game}}{{Infobox company}}{{Fallback infobox}}{{Infobox guide}}{{Infobox mash-up}}{{Infobox music}}{{Infobox person}}{{Infobox profile}}{{Infobox program}}{{Infobox screen effect}}{{Infobox server}}{{Infobox skin pack}}{{Infobox theme}}{{Infobox version}}{{Infobox video}}{{Infobox website}}{{Infobox world}}
- Meta
{{Infobox}}{{Infobox row}}{{Infobox header}}- Module:Infobox
ja:テンプレート:Infobox command/doc ko:틀:Infobox command/doc pt:Comandos/infobox/doc uk:Шаблон:Картка/Команда/док zh:Template:Infobox command/doc