imported>Eithris at 04:49, 23 June 2022

2022-06-23T04:49:08Z

New page

{{ambox|icon=Icon-template.svg|border=blue|type=This template is ''partially'' depreciated.|info=
* Most API functions are now automated via [[Module:API info/elink]].
* However, this template remains in use for the [[Widget API]] and some [[FrameXML]] functions.}}
Links to external archives of Blizzard API documentation and useful API analysis tools at [https://www.townlong-yak.com Townlong-Yak] and [https://mrbuds.github.io/wow-api-web/ Offline /api Addon]. Use this as follows:

== Optional parameters ==

; name : Used in lieu of <code><nowiki>{{PAGENAME}}</nowiki></code>. Format just like a pagename to auto-detect the type (ie, functions start with <code>API </code>) or use the <code>t=</code> switch to manually indicate the type.
; namespace: Used to indicate the namespace (ie, C_AchievementInfo) that something is part of (default: if possible, inferred from the <code><nowiki>{{PAGENAME}}</nowiki></code>)
; system : Used to indicate the system (ie, AchievementInfo) that something is part of (default: if possible, inferred from the namespace omitting C_)
; nodoc : Assign anything such as <code>|nodoc=|</code> to supress links to Blizzard API documents
; nogit : Assign anything such as <code>|nogit=|</code> to supress links to GitHub
; t : Same as {{t2|api|t}} (default: inferred from the pagename)
; patch : Hyperlinks to an older version of FrameXML (only recommended for depreciated API)
; wowprog : Adds a link to wowprogramming.com; using a custom url if supplied.

== Typical Usage ==

;Functions
<nowiki>== External links ==
{{subst:el}}
{{Elinks-api}}</nowiki>

;Events
<nowiki>== External links ==
{{subst:el}}
{{Elinks-api|system=C_AchievementInfo}}</nowiki>

== Advanced Usage ==

Function mode (<code>t=a</code> or auto-detected) results in:
* Blizzard API Documents archived in two locations, unless supressed <code>nodoc=1</code> or the function is not of the form <code>C_System.Function</code>
** [https://www.townlong-yak.com/framexml Townlong-Yak], Foxlit
** [https://mrbuds.github.io/wow-api-web/ Offline /api Addon], Mr Buds
* List of where this function is used at [https://www.townlong-yak.com/framexml Globe], Foxlit

Event mode (<code>t=e</code> or auto-detected) results in:
* Blizzard API Documents archived in two locations, unless supressed <code>nodoc=1</code>
** [https://www.townlong-yak.com/framexml Townlong-Yak], Foxlit
** [https://mrbuds.github.io/wow-api-web/ Offline /api Addon], Mr Buds (requires ''system='' and not available with ''patch='' or ''version='')
* List of where this function is used at [https://www.townlong-yak.com/framexml Globe], Foxlit

== Examples ==
<nowiki>{{Elinks-api|name=API UnitName}}</nowiki>
{{Elinks-api|name=API UnitName}}

<nowiki>{{Elinks-api|name=API UnitClass|system=Unit|wowprog=}}</nowiki>
{{Elinks-api|name=API UnitClass|system=Unit|wowprog=}}

<nowiki>{{Elinks-api|name=API C ChatBubbles.GetAllChatBubbles}}</nowiki>
{{Elinks-api|name=API C ChatBubbles.GetAllChatBubbles}}

<nowiki>{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo}}</nowiki>
{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo}}

<nowiki>{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo|patch=8.0.1}}</nowiki>
{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo|patch=8.0.1}}

<nowiki>{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo|nodoc=1}}</nowiki>
{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo|nodoc=1}}

<nowiki>{{Elinks-api|name=Button|t=o|wowprog=}}</nowiki>
{{Elinks-api|name=Button|t=o|wowprog=}}

<nowiki>{{Elinks-api|name=UIOBJECT NotARealWidgetToTestCustomLink|wowprog=https://wow.gamepedia.com/Wowpedia}}</nowiki>
{{Elinks-api|name=UIOBJECT NotARealWidgetToTestCustomLink|wowprog=https://wow.gamepedia.com/Wowpedia}}

<nowiki>{{Elinks-api|name=API UIObject GetName|wowprog=}}</nowiki>
{{Elinks-api|name=API UIObject GetName|wowprog=}}

<nowiki>{{Elinks-api|t=NotARealType}}</nowiki>
{{Elinks-api|t=NotARealType}}

== See also ==
* [[Module:Elinks-api]]

<includeonly>
[[Category:External link templates|api]]
[[Category:Interface customization templates]]
</includeonly>

<noinclude>[[Category:Template documentation|API]]</noinclude>

Template:Elinks-api/doc - Revision history

imported>Eithris at 04:49, 23 June 2022