Difference between revisions of "Template:Usage"

Latest revision as of 00:18, 9 June 2013

{{usage|[returns=returntype|][object=objecttype|]func=functionname[|params=parameters]}}

Use this template to demonstrate Sphere API. Template parameters include:

returns (optional) - The return type of the function
object (optional) - The Sphere object this function is a member of, if any; try to be exact, as this will also link to that object's article
func - The name of the function
params (optional) - A comma-separated list of function parameters, if any

For example, {{Usage|object=sound|func=play|params=repeat}} will result in:

sound.play(repeat);

And {{Usage|returns=WindowStyle|func=LoadWindowStyle|params=filename}} will result in:

WindowStyle LoadWindowStyle(filename);

@@ Line 1: / Line 1: @@
-<includeonly><div class="sph-usage">{{#if: {{{object}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''(''{{{params|}}}'');</div></includeonly>
+<includeonly><div class="sph-usage">{{#if: {{{returns|}}} | ''{{{returns}}}'' &#32; |  }}{{#if: {{{object|}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''({{#if: {{{params|}}} | ''{{{params}}}'' | }});</div></includeonly>
-<noinclude>Use this template to demonstrate Sphere API. Template parameters include:
+<noinclude>{{Usage/doc}}</noinclude>
-*	'''object''' ''(optional)'' - The Sphere object this function is a member of, if any
-*	'''func''' - The name of the function
-*	'''params''' ''(optional)'' - A comma-separated list of function parameters, if any
-For example, <tt><nowiki>{{Usage|object=sound|func=play|params=repeat}}</nowiki></tt> will result in:
-{{Usage|object=sound|func=play|params=repeat}}
-</noinclude>