imported>Ddcorkum: A more sensible example

2021-08-11T23:43:48Z

A more sensible example

New page

Creates a link to a specific API function or event page with the appropriate label.

;t
: One of the following:
:* <code>t=a</code> Global '''A'''PI function
:* <code>t=c</code> '''C'''Var
:* <code>t=e</code> '''E'''vent
:* <code>t=t</code> API '''T'''ype
:* <code>t=o</code> Widget (or UI'''O'''bject)
:* <code>t=w</code> '''W'''idget method (or <code>t=wm</code>)
:* <code>t=wh</code> '''W'''idget scripts (or '''h'''andler)
:* <code>t=x</code> '''X'''ML element
:* <code>t=m</code> '''M'''acro command
:* Other advanced combinations exist using <code>?</code> and <code>/</code> in certain ways... see the examples below.
; First unnamed parameter
: A properly formatted name such as UnitAura, or UIObject:GetName or PLAYER_LOGIN plus optionally the following:
:* For function/method arguments, arguments as <code>(arg [, optArg])</code>
:* For widget scripts other than events, arguments as <code>(self, ...)</code>
:* For event payloads, payload as <code>: payload1 payload2 payload3</code> with a colon at the start and space before each one
:* For XML attributes, <code> attr1. attr2. attr3.val3</code> using a single space before each attribute and decimal after, and optionally specifying a value right after the decimal
; Second unnamed parameter
: Text to appear in lieu of the actual function/event/object name (but any parameters will still appear if they were defined)

== Runtime API ==
{{seealso|API|Widget API}}

;Functions (a or default)
:Truncates <code>API</code> from the title, colours arguments
:<code><nowiki>{{api|UnitAura(unit, index [, filter])}}</nowiki></code>
:{{api|UnitAura(unit, index [, filter])}}

;Events (e)
:Colours the payload
:<code><nowiki>{{api|PLAYER_ENTERING_WORLD: isInitialLogin, isReloadingUi|t=e}}</nowiki></code>
:{{api|PLAYER_ENTERING_WORLD: isInitialLogin, isReloadingUi|t=e}}

;CVars (c)
:Links to the CVar page
:<code><nowiki>{{api|farclip|t=c}}</nowiki></code>
:{{api|farclip|t=c}}

;Widgets (o or o?)
:Links to the UIOBJECT page
:<code><nowiki>{{api|Frame|t=o}}</nowiki></code>
:{{api|Frame|t=o}}

;Widget methods (w or wm)
:Truncates <code>API</code> from the title, reformats <code>:</code>, colours arguments
:<code><nowiki>{{api|Texture:SetTexture("filename" or fileID[, "horizWrap"[, "vertWrap"[, "filterMode"]]])|t=w}}</nowiki></code>
:{{api|Texture:SetTexture("filename" or fileID[, "horizWrap"[, "vertWrap"[, "filterMode"]]])|t=w}}

;Widget handlers (wh)
:Links to the UIHANDLER page
:<code><nowiki>{{api|OnClick(self, button, down)|t=wh}}, {{api|OnShow|t=wh}}</nowiki></code>
:{{api|OnClick(self, button, down)|t=wh}}, {{api|OnShow|t=wh}}

== XML elements ==
{{seealso|XML}}

;Start tag (x)
:Wraps the tag with <code>< ></code>
:<code><nowiki>{{api|Frame hidden.true frameStrata.LOW|t=x}}</nowiki></code>
:{{api|Frame hidden.true frameStrata.LOW|t=x}}

;End tag (/x)
:Wraps the tag with <code></ ></code>
:<code><nowiki>{{api|EditBox|t=/x}}</nowiki></code>
:{{api|EditBox|t=/x}}

;No children (x/)
:Wraps the tag with <code>< /></code>
:<code><nowiki>{{api|Button name.$parentButton text.|t=x/}}</nowiki></code>
:{{api|Button name.$parentButton text.|t=x/}}

== API Types ==
{{seealso|API types|Template:Expand/API}}

;Basic types (t or t?)
:Coloured orange, but ''not'' a hyperlink, and use t? to add optional/nilable question mark and tooltip
:<code><nowiki>{{api|nil|t=t}}, {{api|Boolean|t=t}}, {{api|numBER|t=t}}, {{api|STRING|t=t}}, etc.</nowiki></code>
:{{api|nil|t=t}}, {{api|Boolean|t=t}}, {{api|numBER|t=t?}}, {{api|STRING|t=t?}}, etc.

;Complex types (t or t?)
:Shortens the name for Constants, Enumerations and Structs, but otherwise makes an ordinary blue or red hyperlink to the page
:<code><nowiki>{{api|Enum Club.ClubType|t=t}}, {{api|itemLink|t=t?}}</nowiki></code>
:{{api|Enum Club.ClubType|t=t}}, {{api|itemLink|t=t?}}

; Inline Complex Type (i and i?)
: Alternate to a link, when an API type is defined 'inline' on the same page. (Such as an enum or struct used only by a single function.)
: <code><nowiki>{{api|Enum QuestSession.QuestSessionPlayerDetails|t=i?|nil=Returns nil if there is no pending request from another party member.}}</nowiki></code>
: {{api|Enum QuestSession.QuestSessionPlayerDetails|t=i?|nil=Returns nil if there is no pending request from another party member.}}

; Optional/Nilable (t?, o? and i?)
: Adds a customizable tooltip to indicate the parameter could be nil. Use nil= to customize the default message. All instances of 'nil' will be shaded automatically in the tooltip.
: <code><nowiki>{{api|boolean|t=t?|nil=Returns nil if the player does not exist.}}</nowiki></code>
: {{api|boolean|t=t?|nil=Returns nil if the player does not exist.}}

== Macros API ==

;Macro command (m)
: Turns a slash command into an appropriate link
: <code><nowiki>{{api|t=m|/dump}}</nowiki></code>
: {{api|t=m|/dump}}

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Template:Api/doc - Revision history

imported>Ddcorkum: A more sensible example