Difference between revisions of "Template:Command/doc"
m |
(Adding one line version.) |
||
| Line 12: | Line 12: | ||
| disabled || Sometimes commands are disabled for security reasons. If so, this parameter should be used. | | disabled || Sometimes commands are disabled for security reasons. If so, this parameter should be used. | ||
|} | |} | ||
| + | __NOTOC__ | ||
| + | == Examples == | ||
| − | == | + | === Normal command === |
<pre><nowiki>{{Command | <pre><nowiki>{{Command | ||
| Line 19: | Line 21: | ||
|parameters=<text> | |parameters=<text> | ||
|desc=Outputs <text> to channel without formatting. | |desc=Outputs <text> to channel without formatting. | ||
| + | }}</nowiki></pre> | ||
| + | |||
| + | Shows as: | ||
| + | |||
| + | {{Command | ||
| + | |name=says | ||
| + | |parameters=<text> | ||
| + | |desc=Outputs <text> to channel without formatting. | ||
| + | }} | ||
| + | |||
| + | === Disabled, One-Liner === | ||
| + | |||
| + | <pre><nowiki>{{Command | ||
| + | |name=evil | ||
| + | |parameters=<user> <password> | ||
| + | |disabled=true | ||
}}</nowiki></pre> | }}</nowiki></pre> | ||
Revision as of 00:15, 9 December 2010
| 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. |
Examples
Normal command
{{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}}} | }}
Disabled, One-Liner
{{Command
|name=evil
|parameters=<user> <password>
|disabled=true
}}
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}}} | }}
