Editing WoW:TOC format (section)

== Official Tags ==

There are a number of "official" (either used by the client or explicitly allowed access to via {{api|GetAddOnMetadata}}) .toc tags. Below is a list of official tag names and descriptions of how their values are used:

=== Common AddOn Tags ===
; Interface
: Specifies which client interface version the addon was made for. If the value of this tag does not match the client interface version, the addon is loaded only if the "Load out of date addons" option is enabled. There are a number of ways [[Getting the current interface number|to determine the current interface version]].
 ## Interface: {{API LatestInterface}}

; Title
: The value of this tag is displayed in the AddOns list. Localized versions can be included by appending a hyphen followed by the client locale name; the client automatically chooses a localized version if one is available. The value may also contain [[UI escape sequences]], such as for example colors.
 ## Title: Waiting for Godot
 ## Title-frFR: En attendant Godot

; Author
: The AddOn author's name

; Version
: The AddOn version. Some automatic updating tools may prefer that this string begins with a numeric version number.

; Notes
: Addon description that appears when the user hovers over the addon entry in the addons list. Like Title, this tag can be localized by appending a hyphen followed by locale name, and contain [[UI escape sequences]].<pre>## Notes: "Nothing to be done"</pre>

; SavedVariables
: A comma-separated list of variable names in the global environment that will be saved to disk when the client exits, and placed back into the global environment when your addon is loaded; the variables are not available before the {{api|t=e|ADDON_LOADED}} event fires for your addon. See [[Saving variables between game sessions]].<pre>## SavedVariables: foo, bar</pre>

; SavedVariablesPerCharacter
: A comma-separated list of variable names in the global environment that will be saved to disk when the client exits, and placed back into the global environment when your addon is loaded for a particular character. Note that PerCharacter saved variables are only loaded for the character for which they were saved.<pre>## SavedVariablesPerCharacter: somePercharVariable</pre>

=== Other Tags ===
; AllowLoad
: A "UI Realm" name. Restricts loading of this TOC for the current UI mode. Missing, empty or 'Both' is unrestricted. Not generally used with user AddOns. Values: Both, Game, Glue.<pre> ## AllowLoad: Game</pre>

; AllowLoadGameType
: Restricts loading of this TOC to a set of particular editions, classic games, or categories. For a user AddOn this can be the same as setting the TOC file name to restrict which TOC file will be used. This setting uses the exact same type monikers as the file prefixes. The main difference is that the TOC file name version is used when the engine searches for the correct TOC for an AddOn, and the version here in TOC settings is primarily used to ignore inappropriate dependencies that were already listed explicitly by another AddOn TOC file. Not generally used with user AddOns. Values: See [[#Edition_names]].<pre>## AllowLoadGameType: Mainline, Cata</pre>

; RequiredDeps, Dependencies, or any word beginning with "Dep"
: A comma-separated list of addon (directory) names that must be loaded before this addon can be loaded.<pre> ## Dependencies: someAddOn, someOtherAddOn</pre>

; OptionalDeps
: A comma-separated list of addon (directory) names that should be loaded before this addon if they ''can'' be loaded.<pre>## OptionalDeps: someAddOn, someOtherAddOn</pre>

; LoadOnDemand
: If the value of this tag is "1", the addon is not loaded when the user first logs in, but can be loaded by another addon at a later point. This can be used to avoid loading situational addons.<pre>## LoadOnDemand: 1</pre>

; LoadWith
: A comma-separated list of addon (directory) names that, when loaded, will cause the client to load this LoadOnDemand addon as well. Added in Patch 1.9<pre>## LoadWith: someAddOn, someOtherAddOn</pre>

; LoadManagers
: A comma-separated list of addon (directory) names; if no addons on this list are loaded, the client will load your addon when the user logs in; if at least one addon on this list is loaded, your addon is treated as LoadOnDemand. Introduced in patch 2.1; an example of a LoadManager is [http://www.wowace.com/addons/addon-loader/ AddonLoader].

; DefaultState
: Determines whether the addon is enabled by default when first installed. If the value of this tag is "disabled", the user must explicitly enable the addon in the addons list before it is loaded.<pre>## DefaultState: enabled</pre>

; Secure
: If the value of this tag is 1, and the addon is digitally signed by Blizzard, its code is considered secure (as opposed to tainted, which is what all 3rd-party addons are). Introduced in Patch 1.11.