Difference between revisions of "Template:Command"

From Mibbit Wiki
Jump to: navigation, search
m (client property using SMW.)
m ( )
Line 1: Line 1:
<includeonly>'''/{{{name}}}''' ''{{{parameters}}}''{{#if: {{{disabled|}}}|<nowiki>[</nowiki><span style="color:red; font-weight:bold;">{{{disabled}}}</span><nowiki>]</nowiki>|}}{{#if: {{{desc|}}}|
+
<includeonly>'''/{{{name}}}''' ''{{{parameters}}}''{{#if: {{{disabled|}}}|&nbsp;<nowiki>[</nowiki><span style="color:red; font-weight:bold;">{{{disabled}}}</span><nowiki>]</nowiki>|}}{{#if: {{{desc|}}}|
  
 
{{{desc}}}|}}{{SMW Client|{{{client|mw}}}}}</includeonly><noinclude>{{Documentation}}</noinclude>
 
{{{desc}}}|}}{{SMW Client|{{{client|mw}}}}}</includeonly><noinclude>{{Documentation}}</noinclude>

Revision as of 23:32, 3 February 2011

Template documentation (for the above template, sometimes hidden or invisible)

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.
client Which clients are allowed to use this command. "m", "w", or "mw"

Examples

Normal command

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

Shows as:

{{#switch: w |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=}}/evil {{#if:<user> <password>|<user> <password>|}}{{#if: true| [true]|}}{{#if: |:{{{desc}}}|}}{{#if:

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

Visit Template:Command/doc to edit this text! (How does this work?)