Template:Usage - Revision history

Apollolux: split out doc

2013-06-09T00:18:06Z

split out doc

2013-05-21T17:45:41Z

fix 'params'

2013-05-20T19:26:59Z

Cleanup

2013-05-20T19:26:04Z

Cleanup

2013-05-20T19:25:17Z

Doc

2013-05-20T19:21:57Z

Added 'return'

2013-05-20T19:00:25Z

Doc

2013-05-20T18:54:44Z

HTML

2013-05-20T18:49:13Z

created

New page

{{#if: {{{object}}} | ''{{{object}}}''. | }}'''{{{func}}}'''(''{{{params}}}'');

← Older revision		Revision as of 00:18, 9 June 2013
Line 1:		Line 1:
	<includeonly><div class="sph-usage">{{#if: {{{returns\|}}} \| ''{{{returns}}}'' \| }}{{#if: {{{object\|}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''({{#if: {{{params\|}}} \| ''{{{params}}}'' \| }});</div></includeonly>		<includeonly><div class="sph-usage">{{#if: {{{returns\|}}} \| ''{{{returns}}}'' \| }}{{#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>
−
−	* '''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, <tt><nowiki~~>{{Usage~~\|object=sound\|func=play\|params=repeat}}</nowiki></tt> will result in:~~
−
−	~~{{Usage\|object=sound\|func=play\|params=repeat}}~~
−
−	~~And <tt><nowiki>{{Usage\|returns=WindowStyle\|func=LoadWindowStyle\|params=filename}}<~~/~~nowiki></tt> will result in:~~
−
−	~~{{Usage\|returns=WindowStyle\|func=LoadWindowStyle\|params=filename~~}}
−	</noinclude>

@@ Line 1: / Line 1: @@
-<includeonly><div class="sph-usage">{{#if: {{{returns|}}} | ''{{{returns}}}'' &#32; |  }}{{#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:
 *	'''returns''' ''(optional)'' - The return type of the function
-*	'''object''' ''(optional)'' - The Sphere object this function is a member of, if any
+*	'''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

← Older revision		Revision as of 19:26, 20 May 2013
Line 1:		Line 1:
−	<includeonly><div class="sph-usage">{{#if: {{{returns\|}}} \| ''{{{returns}}}'' \| }}{{#if: {{{object\|}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''(''{{{params\|}}}'');</div></includeonly>	+	<includeonly><div class="sph-usage">{{#if: {{{returns\|}}} \| ''{{{returns}}}'' \| }}{{#if: {{{object\|}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''(''{{{params\|}}}'');</div></includeonly>

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

← Older revision		Revision as of 19:26, 20 May 2013
Line 1:		Line 1:
−	<includeonly><div class="sph-usage">{{#if: {{{returns\|}}} \| '''{{{returns}}} ''' \| }}{{#if: {{{object\|}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''(''{{{params\|}}}'');</div></includeonly>	+	<includeonly><div class="sph-usage">{{#if: {{{returns\|}}} \| ''{{{returns}}}'' \| }}{{#if: {{{object\|}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''(''{{{params\|}}}'');</div></includeonly>

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

@@ Line 1: / Line 1: @@
-<includeonly><div class="sph-usage">{{#ifeq: {{{return|}}} | '''{{{return}}} ''' | }}{{#ifeq: {{{object|}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''(''{{{params|}}}'');</div></includeonly>
+<includeonly><div class="sph-usage">{{#if: {{{returns|}}} | '''{{{returns}}} ''' |  }}{{#if: {{{object|}}} | [[API:{{{object}}}|{{{object}}}]]. | }}'''{{{func}}}'''(''{{{params|}}}'');</div></includeonly>
 <noinclude>Use this template to demonstrate Sphere API. Template parameters include:
-*	'''return''' ''(optional)'' - The return type of the function
+*	'''returns''' ''(optional)'' - The return type of the function
 *	'''object''' ''(optional)'' - The Sphere object this function is a member of, if any
 *	'''func''' - The name of the function
@@ Line 11: / Line 11: @@
 {{Usage|object=sound|func=play|params=repeat}}
 </noinclude>

← Older revision		Revision as of 19:00, 20 May 2013
Line 1:		Line 1:
−	<div class="sph-usage">{{#if: {{{object}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''(''{{{params}}}'');</div>	+	<includeonly><div class="sph-usage">{{#if: {{{object}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''(''{{{params\|}}}'');</div></includeonly>
		+
		+	<noinclude>Use this template to demonstrate Sphere API. Template parameters include:
		+
		+	* '''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>

← Older revision		Revision as of 18:54, 20 May 2013
Line 1:		Line 1:
−	{{#if: {{{object}}} \| ''{{{object}}}''. \| }}'''{{{func}}}'''(''{{{params}}}'');	+	<div class="sph-usage">{{#if: {{{object}}} \| [[API:{{{object}}}\|{{{object}}}]]. \| }}'''{{{func}}}'''(''{{{params}}}'');</div>