Difference between revisions of "Template:Api"

From Neocron Wiki
Jump to: navigation, search
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
== API Template ==
+
__TOC__
 
+
<div class="api-documentation">
== Tag <{{{tag}}}> -  Command {{{command}}} ==
+
== {{PAGENAME}} ==
 
+
{{ #ifeq:{{{thn_only}}}|yes|* THN Only command: Yes }}
{{ #if:{({tag|)}} | * Item DB Tag: '''<{{{tag}}}>'''  }}
+
{{ #if:{{{tag|}}} | * Item DB Tag: '''<{{{tag}}}>'''  }}
{{ #if:{({command|})} | * Web service function: '''{{{command}}}''' }}
+
{{ #if:{{{command|}}} | * Web service function: '''{{{command}}}''' }}
* Usage: {{ #if:{{usage|}}|{{{usage}}}|No information}}
+
* Usage: {{ #if:{{{usage|}}}|{{{usage}}}|No information}}
 
 
 
=== Required parameters ===
 
=== Required parameters ===
 
+
{{#ifeq:{{{param_items}}}|yes| {{THNapi:Parameter - Items}}}}<!-- WS
 +
-->{{#ifeq:{{{param_faction}}}|yes| {{THNapi:Parameter - Faction}}}}<!-- WS
 +
-->{{#ifeq:{{{param_format}}}|yes| {{THNapi:Parameter - Format}}}}<!-- WS
 +
-->{{#ifeq:{{{param_group}}}|yes| {{THNapi:Parameter - Group}}}}<!-- WS
 +
-->{{#ifeq:{{{param_level}}}|yes| {{THNapi:Parameter - Level}}}}<!-- WS
 +
-->{{#ifeq:{{{param_order}}}|yes| {{THNapi:Parameter - Order}}}}<!-- WS
 +
-->{{#ifeq:{{{param_page}}}|yes| {{THNapi:Parameter - Page}}}}<!-- WS
 +
-->{{#ifeq:{{{param_plural}}}|yes| {{THNapi:Parameter - Plural}}}}<!-- WS
 +
-->{{#ifeq:{{{param_position}}}|yes| {{THNapi:Parameter - Position}}}}<!-- WS
 +
-->{{#ifeq:{{{param_qty}}}|yes| {{THNapi:Parameter - Qty}}}}<!-- WS
 +
-->{{#ifeq:{{{param_size}}}|yes| {{THNapi:Parameter - Size}}}}<!-- WS
 +
-->{{#ifeq:{{{param_style}}}|yes| {{THNapi:Parameter - Style}}}}<!-- WS
 +
-->{{#ifeq:{{{param_viewname}}}|yes| {{THNapi:Parameter - Viewname}}}}<!-- WS
 +
-->{{#ifeq:{{{param_viewoption}}}|yes| {{THNapi:Parameter - Viewoption}}}}<!-- WS
 +
-->{{#ifeq:{{{param_tag}}}|yes| {{THNapi:Parameter - Tag}}}}<!-- WS
 +
-->{{#ifeq:{{{param_cols}}}|yes| {{THNapi:Parameter - Cols}}}}<!-- WS
 +
-->{{#ifeq:{{{param_class}}}|yes| {{THNapi:Parameter - Class}}}}<!-- WS
 +
-->{{#ifeq:{{{param_index}}}|yes| {{THNapi:Parameter - Index}}}}
 
=== Optional parameters ===
 
=== Optional parameters ===
 
+
{{#ifeq:{{{param_items}}}|opt|{{THNapi:Parameter - Items}}}}<!-- WS
 
+
-->{{#ifeq:{{{param_faction}}}|opt|{{THNapi:Parameter - Faction}}}}<!-- WS
[[Category:Wiki Item DB tags|{{{tag}}}]]
+
-->{{#ifeq:{{{param_format}}}|opt|{{THNapi:Parameter - Format}}}}<!-- WS
[[Category:THN API commands|{{{command}}}]]
+
-->{{#ifeq:{{{param_group}}}|opt|{{THNapi:Parameter - Group}}}}<!-- WS
 +
-->{{#ifeq:{{{param_level}}}|opt|{{THNapi:Parameter - Level}}}}<!-- WS
 +
-->{{#ifeq:{{{param_order}}}|opt|{{THNapi:Parameter - Order}}}}<!-- WS
 +
-->{{#ifeq:{{{param_page}}}|opt|{{THNapi:Parameter - Page}}}}<!-- WS
 +
-->{{#ifeq:{{{param_plural}}}|opt|{{THNapi:Parameter - Plural}}}}<!-- WS
 +
-->{{#ifeq:{{{param_position}}}|opt|{{THNapi:Parameter - Position}}}}<!-- WS
 +
-->{{#ifeq:{{{param_qty}}}|opt|{{THNapi:Parameter - Qty}}}}<!-- WS
 +
-->{{#ifeq:{{{param_size}}}|opt|{{THNapi:Parameter - Size}}}}<!-- WS
 +
-->{{#ifeq:{{{param_style}}}|opt|{{THNapi:Parameter - Style}}}}<!-- WS
 +
-->{{#ifeq:{{{param_viewname}}}|opt|{{THNapi:Parameter - Viewname}}}}<!-- WS
 +
-->{{#ifeq:{{{param_viewoption}}}|opt| {{THNapi:Parameter - Viewoption}}}}<!-- WS
 +
-->{{#ifeq:{{{param_tag}}}|opt| {{THNapi:Parameter - Tag}}}}<!-- WS
 +
-->{{#ifeq:{{{param_cols}}}|opt{{THNapi:Parameter - Cols}}}}<!-- WS
 +
-->{{#ifeq:{{{param_class}}}|opt| {{THNapi:Parameter - Class}}}}<!-- WS
 +
-->{{#ifeq:{{{param_index}}}|opt| {{THNapi:Parameter - Index}}}}
 +
</div>
 +
{{ #if:{{{tag|}}} |[[Category:Wiki Item DB tags|{{{tag}}}]]}}
 +
{{ #if:{{{command|}}} |[[Category:THN API commands|{{{command}}}]]}}
 +
<noinclude>
 +
{{Documentation}}
 +
</noinclude>

Latest revision as of 12:52, 14 July 2008

Api

  • Usage: No information

Required parameters

Optional parameters


Template-info.pngTemplate Documentation[edit]

This documentation is transcluded from Template:Api/doc. (edit | history)

{{api
 | tag = tag:name
 | command = comand_name
 | usage = What it does
 | thn_only = no
 | param_items = yes/no/opt
 | param_faction = yes/no/opt
 | param_format = yes/no/opt
 | param_group = yes/no/opt
 | param_level = yes/no/opt
 | param_order = yes/no/opt
 | param_page = yes/no/opt
 | param_plural = yes/no/opt
 | param_position = yes/no/opt
 | param_qty = yes/no/opt
 | param_size = yes/no/opt
 | param_style = yes/no/opt
 | param_viewname = yes/no/opt
 | param_viewoption = yes/no/opt
 | param_tag = yes/no/opt
 | param_cols = yes/no/opt
 | param_class = yes/no/opt
 | param_index = yes/no/opt
}}