Template:Infobox command/doc: Difference between revisions

From Modded Wiki
Jump to navigation Jump to search
No edit summary
+nav
 
(23 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Cleanup|This template is a mess. First of all, parameters should be named.}}
{{documentation header}}
{{documentation header}}
{{:Commands/infobox}}
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.
{{pipe escape|
 
{| class{{=}}"wikitable"
{| class="wikitable"
! Parameter
! Parameter
! Function
! Function
! Default value
|-
|-
| <code>1</code>
| <code>name</code>
| The commands name
| The commands name, defaults to the subpage name.
| ''Subpage name''
|-
|-
| <code>alias</code>
| <code>alias</code>
| Aliases for the commands.
| Aliases for the commands.
|
|-
|-
| <code>hidden</code>
| <code>hidden</code>
| Set to 0 for visible, or 1 for hidden
| Set to 0 for visible, or 1 for hidden
|
|-
| <code>2</code>
| Restrictions on who can use the command. Can be <code>op</code> (operator), <code>admin</code> (administrator), <code>mp</code> (multiplayer and operator), or <code>host</code>
|
|-
|-
| <code>3</code>
| <code>oplevel</code>
| First version that it was seen in (e.g. Alpha 1.0.17, classic 0.0.23a).
| The permission level.
|
|-
|-
| <code>4</code>
| <code>cheat</code>
| First development snapshot it was seen in, requires <code>3</code>.
| If set, adds the "Cheat only" restriction.
|
|-
|-
| <code>cmdblock</code>
| <code>singleplayer</code>
| Set to 0 for no command block, or 1 for command blocks when using <code>MP</code>
| If set, adds the "Singleplayer only" restriction.
| Based on <code>2</code>
|-
|-
| <code>upcoming</code>
| <code>serveronly</code>
| Sets the command to upcoming, adding the upcoming footer.
| If set, adds the "Dedicated server only" restriction.
|
|-
|-
| <code>removed</code>
| <code>others</code>
| Sets the version the command was removed. If set to ? or unknown, it will display an unlinked ?
| Others restriction.
|
|}
|}
=== 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|Command]]
[[ja:テンプレート:Infobox command]]
[[ko:명령어/infobox]]
[[pt:Comandos/infobox]]
[[pt:Comandos/infobox]]
[[uk:Шаблон:Картка/Команда]]
[[zh:Template:Infobox command]]
</includeonly>
</includeonly>
<noinclude>
<noinclude>
<!-- Documentation categories/interwiki here -->
<!-- Documentation categories/interwiki here -->
[[ja:テンプレート:Infobox command/doc]]
[[ko:틀:Infobox command/doc]]
[[pt:Comandos/infobox/doc]]
[[pt:Comandos/infobox/doc]]
[[uk:Шаблон:Картка/Команда/док]]
[[zh:Template:Infobox command/doc]]
</noinclude>
</noinclude>

Latest revision as of 18:44, 24 February 2024

This is the documentation page. It should be transcluded into Template:Infobox command. See Template:Documentation for more information.

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

{{Infobox command}}

Some

/msg
Aliases

/tell

Permission level
required

0

Restrictions

None

{{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
Dedicated server only
Singleplayer only
Example

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

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Name of the command, if it differs from the title.

Stringsuggested
Aliasesalias

Aliases for this command.

Stringoptional
Permission leveloplevel

Permission level required to execute this command.

Numbersuggested
Restricted to cheatscheats

If set, mentions that this command is only available to players with cheats.

Unknownoptional
Restricted to serversserveronly

If set, mentions that this command is only available on multiplayer servers.

Unknownoptional
Restricted to singleplayersingleplayer

If set, mentions that this command is only available in singleplayer.

Unknownoptional
Hiddenhidden

If set, mentions the command is hidden.

Unknownoptional
Other restrictionsothers

Any other restrictions to this command.

Stringoptional

See also

Minecraft
Minecraft Earth
Minecraft Dungeons
Minecraft Legends
Minecraft Story Mode
Other
Meta


ja:テンプレート:Infobox command/doc ko:틀:Infobox command/doc pt:Comandos/infobox/doc uk:Шаблон:Картка/Команда/док zh:Template:Infobox command/doc