Difference between revisions of "Template:Command/doc"

From Mibbit Wiki
Jump to: navigation, search
m
m
Line 1: Line 1:
 +
{| ! border = 1
 +
|+ Parameters
 +
|-
 +
! Name !! Description
 +
|-
 +
| name || Name of command, without the beginning slash.
 +
|-
 +
| parameters || Parameters of the command.
 +
|-
 +
| desc || Description of the command.  Optional.  Only one line if it doesn't exist, good for [[:Category:Commands]]
 +
|-
 +
| disabled || Sometimes commands are disabled for security reasons.  If so, this parameter should be used.
 +
|}
 +
 +
== Example ==
 +
 
<pre><nowiki>{{Command
 
<pre><nowiki>{{Command
 
|name=says
 
|name=says

Revision as of 20:30, 8 December 2010

Parameters
Name Description
name Name of command, without the beginning slash.
parameters Parameters of the command.
desc Description of the command. Optional. Only one line if it doesn't exist, good for Category:Commands
disabled Sometimes commands are disabled for security reasons. If so, this parameter should be used.

Example

{{Command
|name=says
|parameters=<text>
|desc=Outputs <text> to channel without formatting.
}}

Shows as:

{{#switch: mw |m={{#set:Client=Main}} |w={{#set:Client=Widget}} |mw={{#set:Client=Main}} {{#set:Client=Widget}} }}{{#set:Type=}}/says {{#if:<text>|<text>|}}{{#if: | [{{{disabled}}}]|}}{{#if: Outputs <text> to channel without formatting.|:Outputs <text> to channel without formatting.|}}{{#if:

| :Output:  {{{output}}} | }}