Template:Widget

From AddOn Studio
Revision as of 23:48, 14 August 2023 by Bear (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Use this at the top of all WoW widget API pages. This template mostly just floats {{apinav}} table to the right and adds categories.

Any pages with this template will be added to Category:Widgets. See Widget API. See also Template:Widgetmethod, Template:Widgethandler, Template:Wowapi.

Usage
  • 1 - API context type, like 'Glue'. Default is regular game play UI context. Affects wiki categories and page parent folder. Used by 'Glue' environment API.
  • t - [member, method] - identifier type for page, like if page subject is an general topic, object, method, or regular member.
  • removed - patch number removed in. See also Template:WoW/removedapi
  • replace - text explaining what to use if removed, replaced or deprecated.
  • toc - [0,1] - Force TOC enabled or disabled. Default depends on type.
  • tocright [1,0] - disables or enables toc going right side. Default is '1'.
Examples
  • {{widget}} - Used for main page, widget topics, and widget api objects
  • {{widget|t=method}} - 'API Frame SetText' displays as 'Frame:SetText'.
  • {{widget|t=member}} - 'API Frame parent' displays as 'Frame.parent'.
  • {{widget|t=handler}} - 'UIHANDLER OnClick' displays as 'OnClick'.

Template