Template:Infobox command/doc

[refresh]

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

/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	/tell
Permission level required	Unknown
Restrictions	None

{
    "title": "<code>/msg</code>",
    "rows": [
        {
            "field": "<!-- Command --><code ><span>/tell</span></code><!-- /Command -->",
            "label": "Aliases"
        },
        {
            "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
| name = msg
| alias = {{cmd|tell|link=none}}
| permission = 0
}}

Everything

/{{{name}}}

Aliases	{{{alias}}}
Visibility	Hidden
Permission level required	1
Restrictions	Cheat only Dedicated server only Singleplayer only {{{others}}}

{
    "title": "<code>/{{{name}}}</code>",
    "rows": [
        {
            "field": "{{{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>{{{others}}}",
            "label": "(link to Commands#Restrictions article, displayed as Restrictions)"
        }
    ],
    "invimages": [],
    "images": []
}

{{Infobox command
| name = {{{name}}}
| alias = {{{alias}}}
| oplevel = 1
| cheat = 1
| serveronly = 1
| singleplayer = 1
| hidden = 1
| others = {{{others}}}
}}

ja:テンプレート:Infobox command/doc ko:틀:Infobox command/doc pt:Comandos/infobox/doc zh:Template:Infobox command/doc

Shows an infobox for a command.

Template parameters

This template prefers block formatting of parameters.

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