This page contains a list of the keywords used in AddOn .toc files. Each keyword should be prefixed with "## " and be on its own line.
AddOn Keyword Localization
First, a short note on localization (which means providing people which do not have the innate grasp of English that all Americans are born with something which they can understand).
Each keyword that can be localized will have a note to that effect in its description. If it can be localized, then you can simply add the keyword to the file but add -lnLN to it. Example:
## Title: Makes you see smurfs all over the place
## Title-frFR: Des marques vous voyez des smurfs partout
This would translate the title of the AddOn into French where appropriate. Note that currently, WoW does not use ANY of the keywords.
Localization combinations
Officially used combinations
- koKR
- Korean
- esES
- Spanish
Extrapolated combinations
- enUS
- American English
Theoretical combinations
- frFR
- French
- deDE
- German
- seSE
- Swedish ?
- sweSWE
- Swedish ?
Interface
Mandatory
Requires a parameter which is at least as high as the current interface number for the AddOn to load. Used to prevent old AddOns to mess up new UIs.
Title
Localizable
Should contain the title of the AddOn. Version numbers are OK, I guess.
Author
Localizable? unknown at this time
Should contain the name (email addresses?) of the author(s) of the AddOn.
Notes
Localizable
Should contain a description of the AddOn.
Dependencies
You can also use RequiredDeps.
If present, should contain a list of the AddOns that is required for the AddOn to work. The names used should be the directory names of the AddOns. The list is comma seperated. Example:
## Dependencies: Cosmos, SmurfModule
OptionalDeps
If present, should contain a list of the AddOns that the AddOn wants to have loaded prior to itself. For example, if your AddOn works with or without Cosmos, it should be optionally dependent on Cosmos to make it easier to register your AddOn with Cosmos (since you can do it in the OnLoad part). Example:
## OptionalDeps: Cosmos
SaveVariables
Currently unused until the next patch (after December 8, 2004)
If present, should contain a list of variables to be saved between sessions. The list is comma seperated. Example:
## SaveVariables: myModVar1, myModVar2