Template:Infobox command/doc: Difference between revisions

From Modded Wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
mNo edit summary
date&version are previously deprectaed from infoboxes onwiki
Line 11: Line 11:
| <code>alias</code>
| <code>alias</code>
| Aliases for the commands.
| Aliases for the commands.
|-
| <code>addedVersion</code> || Version added
|-
| <code>addedDate</code> || Date added
|-
| <code>removedVersion</code> || Version removed
|-
| <code>removedDate</code> || Date removed
|-
|-
| <code>hidden</code>
| <code>hidden</code>
Line 71: Line 63:
| name = {{{name}}}
| name = {{{name}}}
| alias = {{{alias}}}
| alias = {{{alias}}}
| addedVersion = {{{addedVersion}}}
| addedDate = {{{addedDate}}}
| removedVersion = {{{removedVersion}}}
| removedDate = {{{removedDate}}}
| editions = {{{editions}}}
| editions = {{{editions}}}
| oplevel = 1
| oplevel = 1
Line 89: Line 77:
| name = {{{name}}}
| name = {{{name}}}
| alias = {{{alias}}}
| alias = {{{alias}}}
| addedVersion = {{{addedVersion}}}
| addedDate = {{{addedDate}}}
| removedVersion = {{{removedVersion}}}
| removedDate = {{{removedDate}}}
| editions = {{{editions}}}
| editions = {{{editions}}}
| oplevel = 1
| oplevel = 1
Line 139: Line 123:
"aliases"
"aliases"
]
]
},
"addedVersion": {
"label": "Version added",
"type": "string",
"description": "Version this command was added.",
"example": "{{Verlink|1.5}}",
"aliases": [
"added"
]
},
"addedDate": {
"label": "Date added",
"type": "date",
"description": "The date the command was added.",
"example": "{{Start date|2012|2|15}}"
},
"removedVersion": {
"label": "Version removed",
"type": "string",
"description": "Version this command was removed.",
"example": "{{Verlink|1.9}}",
"aliases": [
"removed"
]
},
"removedDate": {
"label": "Date removed",
"type": "date",
"description": "The date the command was removed.",
"example": "{{End date|2016|5|31}}"
},
},
"oplevel": {
"oplevel": {

Revision as of 23:08, 10 July 2021

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.
nocmdblock If set, adds the "No command blocks" restriction.
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": "/tell",
            "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 = /tell
| 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}}}
| editions = {{{editions}}}
| oplevel = 1
| nocmdblock = 1
| cheat = 1
| serveronly = 1
| singleplayer = 1
| hidden = 1
| others = {{{others}}}
| related = {{{related}}}
}}



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.

ParameterDescriptionTypeStatus
Namename

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

Stringoptional
Aliasesalias aliases

Aliases for this command.

Stringoptional
Permission leveloplevel op permission

Permission level required to execute this command.

Numbersuggested
Restricted to command blocksnocmdblock cmdblock noCommandBlock

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

Auto value
1
Unknownoptional
Restricted to cheatscheats cheat

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

Auto value
1
Unknownoptional
Restricted to serversserveronly serverOnly server

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

Auto value
1
Unknownoptional
Restricted to singleplayersingleplayer cmdblock noCommandBlock

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

Auto value
1
Unknownoptional
Hiddenhidden disabled

If set, mentions the command is hidden.

Auto value
1
Unknownoptional
Other restrictionsothers restrictions

Any other restrictions to this command.

Stringoptional
Related commandsrelated

Related commands.

Stringoptional
Retrieved from "https://modded.wiki/index.php?title=Template:Infobox_command/doc&oldid=10128"