Revision history for ActionInfoTemplate
Additions:
{{since align="left"}}
Deletions:
No Differences
Additions:
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.
Deletions:
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.
Revision [758]
Edited on 2008-02-19 21:05:45 by BrianKoontz [added requirement for language category]Additions:
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.).
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.).
Deletions:
Remember to change the category link at the bottom of this page to ##""CategoryDocumentation""## when the new page is ready to be published.
Additions:
You can add a longer description here.
Deletions:
Additions:
==Usage==
==Examples==
You can put one or more examples here.
==Examples==
You can put one or more examples here.
Deletions:
==Example:==
you can put in an example here.
Additions:
HomePage
This is the documentation page for the ##xxxxx## action.
{{since version="1.1.7" 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.
Remember to change the category link at the bottom of this page to ##""CategoryDocumentation""## when the new page is ready to be published.
|?|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||
==Usage:==
##""{{action_name [optional_param="xxx"]}}""##
==Example:==
CategoryTemplate
This is the documentation page for the ##xxxxx## action.
{{since version="1.1.7" 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.
Remember to change the category link at the bottom of this page to ##""CategoryDocumentation""## when the new page is ready to be published.
|?|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||
==Usage:==
##""{{action_name [optional_param="xxx"]}}""##
==Example:==
CategoryTemplate
Deletions:
//Included in Wikka since version X.X.X.X//
>>**See also**
Development: xxxxxAction.>>This is the documentation page for the xxxxx action.::c::
//This page is a **template**. It belongs to CategoryTemplate (which contains more handy templates). To create an **action documentation** page, [[http://wikka.jsnx.com/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.//
__Note__: Please **remove** the "Wikka Documentation" link at the top, the CategoryDocumentation at the bottom and the "included in Wikka" note unless and until the action is part of the official Wikka distribution!
==Parameters==
""<table cellspacing="0" cellpadding="2" border="1">
<thead>
<tr><th scope="col">name</th><th scope="col">type</th><th scope="col">required?</th><th scope="col">default</th><th scope="col">description</th></tr>
</thead>
<tbody>
<tr><td>param1</td><td>string</td><td>optional</td><td>your_default</td><td>This is one of the params, your action uses. If yuopr action uses no params, remove this table</td></tr>
</tbody>
</table>""
Usage:
%%{{action_name [optional_param="xxx"]}}%%
Example:
CategoryDocumentation
