Template:Infobox command/doc: Difference between revisions

← Older edit

@@ Line 1: / Line 1: @@
 {{documentation header}}
-{{Infobox command}}
 This template provides a uniform design for the infobox on the [[commands]] page.
@@ Line 17: / Line 16: @@
 |-
 | <code>oplevel</code>
-| The op level as defined by server.properties. Can be 1-4 for bypass spawn protection, cheats enabled, operator and administrator respectively.
+| The permission level.
-If the op level is set to 3 or 4, adds the "No command blocks by default" restriction.
+|-
+| <code>cheat</code>
+| If set, adds the "Cheat only" restriction.
 |-
 | <code>singleplayer</code>
 | If set, adds the "Singleplayer only" restriction.
 |-
-| <code>multiplayer</code>
+| <code>serveronly</code>
-| If set, adds the "Multiplayer only" restriction.
+| If set, adds the "Dedicated server only" restriction.
+|-
+| <code>others</code>
+| 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>
 <!-- Template categories/interwiki here -->
+[[Category:Infobox templates|Command]]
+[[ja:テンプレート:Infobox command]]
 [[ko:명령어/infobox]]
 [[pt:Comandos/infobox]]
+[[uk:Шаблон:Картка/Команда]]
+[[zh:Template:Infobox command]]
 </includeonly>
 <noinclude>
 <!-- Documentation categories/interwiki here -->
+[[ja:テンプレート:Infobox command/doc]]
 [[ko:틀:Infobox command/doc]]
 [[pt:Comandos/infobox/doc]]
+[[uk:Шаблон:Картка/Команда/док]]
+[[zh:Template:Infobox command/doc]]
 </noinclude>