Bear at 03:38, 13 February 2021

2021-02-13T03:38:55Z

← Older revision		Revision as of 03:38, 13 February 2021
Line 1:		Line 1:
	Creates a link to a specific API ~~function, method, object, event page, etc..~~. ~~See {{t\|~~widget}}, ~~{{t\|~~wowapi}}, ~~{{t\|~~attrtype}}. See ~~also {{t\|~~apif}}.		Creates a link to a specific API element. Mark API actual pages with [[Template:widget]], [[Template:wowapi]], [[Template:attrtype]]. See shorthand templates [[Template:apif]], [[Template:apiwidget]], [[Template:xml]], [[Template:xmlattr]]. See [[Template:id]] for list links that need a page #section reference.

	;Usage		;Usage
	:<code><nowiki>{{api\|Quit}}</nowiki></code> : {{api\|Quit}}		* 1 - name of the api
	:<code><nowiki>{{api\|Quit\|t=f}}</nowiki></code> : {{api\|Quit\|t=f}} - ~~function~~		* 2 - alternate link display text. Default is same as name of the api
	:<code><nowiki>{{api\|PLAYER_LOGIN\|t=e}}</nowiki></code> : {{api\|PLAYER_LOGIN\|t=e}} ~~- event~~		* 3 - parameter list. Default is not displaying parameters.
	:<code><nowiki>{{api\|farclip\|t=c}}</nowiki></code> : {{api\|farclip\|t=c}} ~~- cvar~~		* t - type of api. Default is 'api'. Options:
	:<code><nowiki>{{api\|Texture\|t=w}}</nowiki></code> : {{api\|Texture\|t=w}} - UIObject / Lua side widget		** a\|api - API function, other WoW API well-known global, member, or method
	:<code><nowiki>{{api\|Texture:SetTexture\|t=w}}</nowiki></code> : {{api\|Texture:SetTexture\|t=w}} - ~~widget~~ method		**: Function -> API Function\|Function
	:<code><nowiki>{{api\|~~AuctionFrameAuctions.duration~~\|t=w}}</nowiki></code> : {{api\|~~AuctionFrameAuctions.duration~~\|t=w}} ~~- widget member~~		**: Name.member -> API Global member\|Global.member
	:<code><nowiki>{{api\|~~string~~\|t=t}}</nowiki></code> : {{api\|~~string~~\|t=t}} - api ~~type~~		**: Name:Method -> API Global Method\|Global:Method
	:<code><nowiki>{{api\|~~wargame~~\|t=m}}</nowiki></code> : {{api\|~~wargame~~\|t=m}} ~~- macro~~		** f\|func - API function but showing ellipses and parameters
			** t\|type - API TYPE
			** e\|event - Event
			** c\|cvar - CVAR
			** w\|widget - UIOBJECT widget or widget method or other member
			**: Widget -> UIObject Widget\|Widget
			**: Widget.member -> API Widget member\|Widget.member
			**: Widget:Method -> API Widget Method\|Widget:Method
			** m\|macro - MACRO
			** x\|xml - XML
			** xa\|xmlattr - XML attributes

			;Examples
			API
			* <code><nowiki>{{api\|Quit}}</nowiki></code> : {{api\|Quit}}
			* <code><nowiki>{{api\|Quit\|t=f}}</nowiki></code> : {{api\|Quit\|t=f}} - params
			* <code><nowiki>{{api\|AuctionFrameAuctions.duration}}</nowiki></code> : {{api\|AuctionFrameAuctions.duration}} - global member
			* <code><nowiki>{{api\|C_EquipmentSet.UseEquipmentSet}}</nowiki></code> : {{api\|C_EquipmentSet.UseEquipmentSet}}
			* <code><nowiki>{{api\|C_EquipmentSet.UseEquipmentSet\|\|equipmentSetID\|t=f}}</nowiki></code> : <br/> {{api\|C_EquipmentSet.UseEquipmentSet\|\|equipmentSetID\|t=f}}
			Event
			* <code><nowiki>{{api\|PLAYER_LOGIN\|t=e}}</nowiki></code> : {{api\|PLAYER_LOGIN\|t=e}}
			CVar
			* <code><nowiki>{{api\|farclip\|t=c}}</nowiki></code> : {{api\|farclip\|t=c}}
			Widget
			* <code><nowiki>{{api\|Texture\|t=w}}</nowiki></code> : {{api\|Texture\|t=w}} - UIObject / Lua side widget
			* <code><nowiki>{{api\|Texture:SetTexture\|t=w}}</nowiki></code> : {{api\|Texture:SetTexture\|t=w}} - method
			Type
			* <code><nowiki>{{api\|string\|t=t}}</nowiki></code> : {{api\|string\|t=t}}
			Macro
			* <code><nowiki>{{api\|wargame\|t=m}}</nowiki></code> : {{api\|wargame\|t=m}}
			XML
			* <code><nowiki>{{api\|LayoutFrame\|t=x}}</nowiki></code> : {{api\|LayoutFrame\|t=x}}
			* <code><nowiki>{{api\|name\|t=xa}}</nowiki></code> : {{api\|name\|t=xa}}


Line 16:		Line 48:
	----		----
	;Template		;Template
	<onlyinclude><includeonly>{{#~~switch~~:{{{t\|~~api~~}}}		<onlyinclude><includeonly><!--
	\|a\|~~api=[[API~~ {{{1\|}}}\|{{{2\|~~{{{1\|~~}}}}}}]]
	~~\|f\|func=[[API~~ {{{~~1\|}}}\|~~{{{2\|{{{1\|}}}}}}~~]]({{{3\|~~}}})		-->{{#vardefine:tN\|{{#ifeq:{{{2\|}}}\|\|{{{1\|}}}\|{{{2\|}}}}}}}<!-- name
	\|~~e\|event=[[Events/~~{{#~~sub~~:{{{1\|}}}\|~~0\|1}}#~~{{~~{1\|}~~}}\|~~{{{2~~\|~~{{{~~1\|}}}}~~}}]]~~		-->{{#vardefine:tP\|{{#replace:{{#replace:{{{1\|}}}\|:\|_}}\|.\|_}}}}<!-- page
	\|c\|~~cvar~~=[[~~CVar~~ {{{1\|}}}\|{{{2\|{{{1\|}}}~~}}}]]~~		-->{{#vardefine:tM\|{{#ifeq:{{{1\|}}}\|{{#var:tP}}\|\|1}}}}<!-- is method or member
	\|w\|~~wm\|widgetmethod~~={{#if:{{#~~pos~~:~~{{{1\|}~~}}\|:}}{{#~~pos~~:{{{1\|}}}\|~~.}}~~\|[[~~API~~ {{#~~replace:{{#replace~~:{{{1\|}}}\|:\|_}}\|~~.\|_~~}}\|{{{2\|{{{1\|}}}}}}]]\|[[~~UIOBJECT~~ {{{2\|{~~{{1\|~~}}}}}}\|{{~~{1\|}~~}}]]}}
	\|t\|type=[[API TYPE {{{1\|}}}\|{{~~{2\|{{{1\|}}}}~~}}]]		\|a\|api=[[API {{{1\|}}}\|{{#var:tN}}]]
	\|m\|macro=[[MACRO {{{1\|}}}\|{{{2\|{{~~{1\|~~}}}}}}]]		-->{{#switch:{{{t\|api}}}
	}}</includeonly></onlyinclude>		\|a\|api=[[API {{#var:tP}}\|{{#var:tN}}]]
			\|f\|func=[[API {{#var:tP}}\|{{#var:tN}}]]({{{3\|}}})
			\|e\|event=[[Events/{{#sub:{{{1\|}}}\|0\|1}}#{{{1\|}}}\|{{#var:tN}}]]
			\|c\|cvar=[[CVar {{{1\|}}}\|{{#var:tN}}]]
			\|w\|widget=[[{{#if:{{#var:tM}}\|API\|UIOBJECT}} {{#var:tP}}\|{{#var:tN}}]]
			\|t\|type=[[API TYPE {{{1\|}}}\|{{#var:tN}}]]
			\|m\|macro=[[MACRO {{{1\|}}}\|{{#var:tN}}]]
			\|x\|xml=[[XML/{{#var:tP}}\|{{#var:tN}}]]
			\|xa\|xmlattr=[[XML attributes#{{#var:tP}}\|{{#var:tN}}]]
			}}<!--

			--></includeonly></onlyinclude>

Authors on WoWWiki: This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

2015-02-14T21:46:44Z

This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

← Older revision	Revision as of 21:46, 14 February 2015
Line 1:	Line 1:
		Creates a link to a specific API function, method, object, event page, etc... See {{t\|widget}}, {{t\|wowapi}}, {{t\|attrtype}}. See also {{t\|apif}}.

		;Usage
		:<code><nowiki>{{api\|Quit}}</nowiki></code> : {{api\|Quit}}
		:<code><nowiki>{{api\|Quit\|t=f}}</nowiki></code> : {{api\|Quit\|t=f}} - function
		:<code><nowiki>{{api\|PLAYER_LOGIN\|t=e}}</nowiki></code> : {{api\|PLAYER_LOGIN\|t=e}} - event
		:<code><nowiki>{{api\|farclip\|t=c}}</nowiki></code> : {{api\|farclip\|t=c}} - cvar
		:<code><nowiki>{{api\|Texture\|t=w}}</nowiki></code> : {{api\|Texture\|t=w}} - UIObject / Lua side widget
		:<code><nowiki>{{api\|Texture:SetTexture\|t=w}}</nowiki></code> : {{api\|Texture:SetTexture\|t=w}} - widget method
		:<code><nowiki>{{api\|AuctionFrameAuctions.duration\|t=w}}</nowiki></code> : {{api\|AuctionFrameAuctions.duration\|t=w}} - widget member
		:<code><nowiki>{{api\|string\|t=t}}</nowiki></code> : {{api\|string\|t=t}} - api type
		:<code><nowiki>{{api\|wargame\|t=m}}</nowiki></code> : {{api\|wargame\|t=m}} - macro


		[[Category:General wiki templates]][[Category:Interface customization templates]]
		----
		;Template
		<onlyinclude><includeonly>{{#switch:{{{t\|api}}}
		\|a\|api=[[API {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|f\|func=[[API {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]({{{3\|}}})
		\|e\|event=[[Events/{{#sub:{{{1\|}}}\|0\|1}}#{{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|c\|cvar=[[CVar {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|w\|wm\|widgetmethod={{#if:{{#pos:{{{1\|}}}\|:}}{{#pos:{{{1\|}}}\|.}}\|[[API {{#replace:{{#replace:{{{1\|}}}\|:\|_}}\|.\|_}}\|{{{2\|{{{1\|}}}}}}]]\|[[UIOBJECT {{{2\|{{{1\|}}}}}}\|{{{1\|}}}]]}}
		\|t\|type=[[API TYPE {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|m\|macro=[[MACRO {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		}}</includeonly></onlyinclude>

Bear at 21:46, 14 February 2015

2015-02-14T21:46:43Z

← Older revision

Revision as of 21:46, 14 February 2015

WoWWiki>Fandyllic at 17:22, 22 July 2012

2012-07-22T17:22:21Z

← Older revision

Revision as of 17:22, 22 July 2012

WoWWiki>Starlightblunder: + widget method demo

2010-03-29T08:44:24Z

+ widget method demo

← Older revision

Revision as of 08:44, 29 March 2010

WoWWiki>Starlightblunder: API linking shorthand

2009-05-24T21:46:27Z

API linking shorthand

New page

← Older revision		Revision as of 03:38, 13 February 2021
Line 1:		Line 1:
	Creates a link to a specific API ~~function, method, object, event page, etc..~~. ~~See {{t\|~~widget}}, ~~{{t\|~~wowapi}}, ~~{{t\|~~attrtype}}. See ~~also {{t\|~~apif}}.		Creates a link to a specific API element. Mark API actual pages with [[Template:widget]], [[Template:wowapi]], [[Template:attrtype]]. See shorthand templates [[Template:apif]], [[Template:apiwidget]], [[Template:xml]], [[Template:xmlattr]]. See [[Template:id]] for list links that need a page #section reference.

	;Usage		;Usage
	:<code><nowiki>{{api\|Quit}}</nowiki></code> : {{api\|Quit}}		* 1 - name of the api
	:<code><nowiki>{{api\|Quit\|t=f}}</nowiki></code> : {{api\|Quit\|t=f}} - ~~function~~		* 2 - alternate link display text. Default is same as name of the api
	:<code><nowiki>{{api\|PLAYER_LOGIN\|t=e}}</nowiki></code> : {{api\|PLAYER_LOGIN\|t=e}} ~~- event~~		* 3 - parameter list. Default is not displaying parameters.
	:<code><nowiki>{{api\|farclip\|t=c}}</nowiki></code> : {{api\|farclip\|t=c}} ~~- cvar~~		* t - type of api. Default is 'api'. Options:
	:<code><nowiki>{{api\|Texture\|t=w}}</nowiki></code> : {{api\|Texture\|t=w}} - UIObject / Lua side widget		** a\|api - API function, other WoW API well-known global, member, or method
	:<code><nowiki>{{api\|Texture:SetTexture\|t=w}}</nowiki></code> : {{api\|Texture:SetTexture\|t=w}} - ~~widget~~ method		**: Function -> API Function\|Function
	:<code><nowiki>{{api\|~~AuctionFrameAuctions.duration~~\|t=w}}</nowiki></code> : {{api\|~~AuctionFrameAuctions.duration~~\|t=w}} ~~- widget member~~		**: Name.member -> API Global member\|Global.member
	:<code><nowiki>{{api\|~~string~~\|t=t}}</nowiki></code> : {{api\|~~string~~\|t=t}} - api ~~type~~		**: Name:Method -> API Global Method\|Global:Method
	:<code><nowiki>{{api\|~~wargame~~\|t=m}}</nowiki></code> : {{api\|~~wargame~~\|t=m}} ~~- macro~~		** f\|func - API function but showing ellipses and parameters
			** t\|type - API TYPE
			** e\|event - Event
			** c\|cvar - CVAR
			** w\|widget - UIOBJECT widget or widget method or other member
			**: Widget -> UIObject Widget\|Widget
			**: Widget.member -> API Widget member\|Widget.member
			**: Widget:Method -> API Widget Method\|Widget:Method
			** m\|macro - MACRO
			** x\|xml - XML
			** xa\|xmlattr - XML attributes

			;Examples
			API
			* <code><nowiki>{{api\|Quit}}</nowiki></code> : {{api\|Quit}}
			* <code><nowiki>{{api\|Quit\|t=f}}</nowiki></code> : {{api\|Quit\|t=f}} - params
			* <code><nowiki>{{api\|AuctionFrameAuctions.duration}}</nowiki></code> : {{api\|AuctionFrameAuctions.duration}} - global member
			* <code><nowiki>{{api\|C_EquipmentSet.UseEquipmentSet}}</nowiki></code> : {{api\|C_EquipmentSet.UseEquipmentSet}}
			* <code><nowiki>{{api\|C_EquipmentSet.UseEquipmentSet\|\|equipmentSetID\|t=f}}</nowiki></code> : <br/> {{api\|C_EquipmentSet.UseEquipmentSet\|\|equipmentSetID\|t=f}}
			Event
			* <code><nowiki>{{api\|PLAYER_LOGIN\|t=e}}</nowiki></code> : {{api\|PLAYER_LOGIN\|t=e}}
			CVar
			* <code><nowiki>{{api\|farclip\|t=c}}</nowiki></code> : {{api\|farclip\|t=c}}
			Widget
			* <code><nowiki>{{api\|Texture\|t=w}}</nowiki></code> : {{api\|Texture\|t=w}} - UIObject / Lua side widget
			* <code><nowiki>{{api\|Texture:SetTexture\|t=w}}</nowiki></code> : {{api\|Texture:SetTexture\|t=w}} - method
			Type
			* <code><nowiki>{{api\|string\|t=t}}</nowiki></code> : {{api\|string\|t=t}}
			Macro
			* <code><nowiki>{{api\|wargame\|t=m}}</nowiki></code> : {{api\|wargame\|t=m}}
			XML
			* <code><nowiki>{{api\|LayoutFrame\|t=x}}</nowiki></code> : {{api\|LayoutFrame\|t=x}}
			* <code><nowiki>{{api\|name\|t=xa}}</nowiki></code> : {{api\|name\|t=xa}}


Line 16:		Line 48:
	----		----
	;Template		;Template
	<onlyinclude><includeonly>{{#~~switch~~:{{{t\|~~api~~}}}		<onlyinclude><includeonly><!--
	\|a\|~~api=[[API~~ {{{1\|}}}\|{{{2\|~~{{{1\|~~}}}}}}]]
	~~\|f\|func=[[API~~ {{{~~1\|}}}\|~~{{{2\|{{{1\|}}}}}}~~]]({{{3\|~~}}})		-->{{#vardefine:tN\|{{#ifeq:{{{2\|}}}\|\|{{{1\|}}}\|{{{2\|}}}}}}}<!-- name
	\|~~e\|event=[[Events/~~{{#~~sub~~:{{{1\|}}}\|~~0\|1}}#~~{{~~{1\|}~~}}\|~~{{{2~~\|~~{{{~~1\|}}}}~~}}]]~~		-->{{#vardefine:tP\|{{#replace:{{#replace:{{{1\|}}}\|:\|_}}\|.\|_}}}}<!-- page
	\|c\|~~cvar~~=[[~~CVar~~ {{{1\|}}}\|{{{2\|{{{1\|}}}~~}}}]]~~		-->{{#vardefine:tM\|{{#ifeq:{{{1\|}}}\|{{#var:tP}}\|\|1}}}}<!-- is method or member
	\|w\|~~wm\|widgetmethod~~={{#if:{{#~~pos~~:~~{{{1\|}~~}}\|:}}{{#~~pos~~:{{{1\|}}}\|~~.}}~~\|[[~~API~~ {{#~~replace:{{#replace~~:{{{1\|}}}\|:\|_}}\|~~.\|_~~}}\|{{{2\|{{{1\|}}}}}}]]\|[[~~UIOBJECT~~ {{{2\|{~~{{1\|~~}}}}}}\|{{~~{1\|}~~}}]]}}
	\|t\|type=[[API TYPE {{{1\|}}}\|{{~~{2\|{{{1\|}}}}~~}}]]		\|a\|api=[[API {{{1\|}}}\|{{#var:tN}}]]
	\|m\|macro=[[MACRO {{{1\|}}}\|{{{2\|{{~~{1\|~~}}}}}}]]		-->{{#switch:{{{t\|api}}}
	}}</includeonly></onlyinclude>		\|a\|api=[[API {{#var:tP}}\|{{#var:tN}}]]
			\|f\|func=[[API {{#var:tP}}\|{{#var:tN}}]]({{{3\|}}})
			\|e\|event=[[Events/{{#sub:{{{1\|}}}\|0\|1}}#{{{1\|}}}\|{{#var:tN}}]]
			\|c\|cvar=[[CVar {{{1\|}}}\|{{#var:tN}}]]
			\|w\|widget=[[{{#if:{{#var:tM}}\|API\|UIOBJECT}} {{#var:tP}}\|{{#var:tN}}]]
			\|t\|type=[[API TYPE {{{1\|}}}\|{{#var:tN}}]]
			\|m\|macro=[[MACRO {{{1\|}}}\|{{#var:tN}}]]
			\|x\|xml=[[XML/{{#var:tP}}\|{{#var:tN}}]]
			\|xa\|xmlattr=[[XML attributes#{{#var:tP}}\|{{#var:tN}}]]
			}}<!--

			--></includeonly></onlyinclude>

← Older revision	Revision as of 21:46, 14 February 2015
Line 1:	Line 1:
		Creates a link to a specific API function, method, object, event page, etc... See {{t\|widget}}, {{t\|wowapi}}, {{t\|attrtype}}. See also {{t\|apif}}.

		;Usage
		:<code><nowiki>{{api\|Quit}}</nowiki></code> : {{api\|Quit}}
		:<code><nowiki>{{api\|Quit\|t=f}}</nowiki></code> : {{api\|Quit\|t=f}} - function
		:<code><nowiki>{{api\|PLAYER_LOGIN\|t=e}}</nowiki></code> : {{api\|PLAYER_LOGIN\|t=e}} - event
		:<code><nowiki>{{api\|farclip\|t=c}}</nowiki></code> : {{api\|farclip\|t=c}} - cvar
		:<code><nowiki>{{api\|Texture\|t=w}}</nowiki></code> : {{api\|Texture\|t=w}} - UIObject / Lua side widget
		:<code><nowiki>{{api\|Texture:SetTexture\|t=w}}</nowiki></code> : {{api\|Texture:SetTexture\|t=w}} - widget method
		:<code><nowiki>{{api\|AuctionFrameAuctions.duration\|t=w}}</nowiki></code> : {{api\|AuctionFrameAuctions.duration\|t=w}} - widget member
		:<code><nowiki>{{api\|string\|t=t}}</nowiki></code> : {{api\|string\|t=t}} - api type
		:<code><nowiki>{{api\|wargame\|t=m}}</nowiki></code> : {{api\|wargame\|t=m}} - macro


		[[Category:General wiki templates]][[Category:Interface customization templates]]
		----
		;Template
		<onlyinclude><includeonly>{{#switch:{{{t\|api}}}
		\|a\|api=[[API {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|f\|func=[[API {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]({{{3\|}}})
		\|e\|event=[[Events/{{#sub:{{{1\|}}}\|0\|1}}#{{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|c\|cvar=[[CVar {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|w\|wm\|widgetmethod={{#if:{{#pos:{{{1\|}}}\|:}}{{#pos:{{{1\|}}}\|.}}\|[[API {{#replace:{{#replace:{{{1\|}}}\|:\|_}}\|.\|_}}\|{{{2\|{{{1\|}}}}}}]]\|[[UIOBJECT {{{2\|{{{1\|}}}}}}\|{{{1\|}}}]]}}
		\|t\|type=[[API TYPE {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		\|m\|macro=[[MACRO {{{1\|}}}\|{{{2\|{{{1\|}}}}}}]]
		}}</includeonly></onlyinclude>

Template:Api - Revision history

Bear at 03:38, 13 February 2021

Authors on WoWWiki: This revision and previous are available under: CC BY-SA 3.0. See list of authors in previous history below.

Bear at 21:46, 14 February 2015

WoWWiki>Fandyllic at 17:22, 22 July 2012

WoWWiki>Starlightblunder: + widget method demo

WoWWiki>Starlightblunder: API linking shorthand