Template:Elinks-api

From Wowpedia
Jump to: navigation, search

Links to external archives of Blizzard API documentation and useful API analysis tools at Townlong-Yak and Offline /api Addon. Use this as follows:

Optional parameters

name 
Used in lieu of {{PAGENAME}}. Format just like a pagename to auto-detect the type (ie, functions start with API ) or use the t= 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 {{PAGENAME}})
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 |nodoc=| to supress links to Blizzard API documents
nogit 
Assign anything such as |nogit=| to supress links to GitHub
Same as {{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
== External links ==
{{subst:el}}
{{Elinks-api}}
Events
== External links ==
{{subst:el}}
{{Elinks-api|system=C_AchievementInfo}}

Advanced Usage

Function mode (t=a or auto-detected) results in:

  • Blizzard API Documents archived in two locations, unless supressed nodoc=1 or the function is not of the form C_System.Function
  • List of where this function is used at Globe, Foxlit

Event mode (t=e or auto-detected) results in:

  • Blizzard API Documents archived in two locations, unless supressed nodoc=1
  • List of where this function is used at Globe, Foxlit

Examples

{{Elinks-api|name=API UnitName}}
{{Elinks-api|name=API UnitClass|system=Unit|wowprog=}}
{{Elinks-api|name=API C ChatBubbles.GetAllChatBubbles}}
{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo}}
{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo|patch=8.0.1}}
{{Elinks-api|name=ACHIEVEMENT EARNED|namespace=C_AchievementInfo|nodoc=1}}
{{Elinks-api|name=Button|t=o|wowprog=}}
{{Elinks-api|name=UIOBJECT NotARealWidgetToTestCustomLink|wowprog=https://wow.gamepedia.com/Wowpedia}}
{{Elinks-api|name=API UIObject GetName|wowprog=}}
{{Elinks-api|t=NotARealType}}

Error: unknown or undetected type.

See also