Wiki source for ActionInfoTemplate


Show raw source

=====xxxxx Action Documentation=====
This is the documentation page for the ##xxxxx## action.
{{since align="left"}}
>>==See also==
~-Related links
~-Must be added here>>
This page is a **template**. It belongs to CategoryTemplate (which contains more handy documentation templates). To create an **action documentation** page, [[http://docs.wikkawiki.org/ActionInfoTemplate/clone | clone this page]] to a page called **xxxxxActionInfo** (where ##xxxxx## is the (capitalized) name of the action), replace all occurrences of ##xxxxx## with the name of the action and replace this paragraph with the actual content.

When the new page is ready to be published, remember to change the category link at the bottom of this page to ##""Category<Lang>""##, replacing ##""<Lang>""## with the appropriate two-letter language code (such as ##""CategoryEN""##, ##""CategoryDE""##, etc.).

===Documentation===

==Short description==
Describe your action in one sentence.

==Usage==
##""{{action_name [optional_param="xxx"]}}""##

|?|Parameters||
|[|
|=|name|=|type|=|required?|=|default|=|description||
|#|
|=|param1||int||mandatory||value||This is one of the params, your action uses. Add as many rows as action parameters.||
|=|param2||string||optional||value||If your action uses no params, please remove this table||

==Long description==
You can add a longer description here.

==Examples==
You can put one or more examples here.

==Author==
The name(s) of the person(s) who wrote this action.

----
CategoryTemplate
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki