Editing AddOn Studio Wiki:How to edit API pages (section)

== WoW API page ==
Adding and editing function links:

* Do not place a function under several headings unless you ''really'' feel it belongs there. See previous point.
* Basic link syntax: <code><nowiki>[[API DisableAddOn|DisableAddOn]](index or "addonname")</nowiki></code> &nbsp; → &nbsp; [[wo:API DisableAddOn|DisableAddOn]](index or "addonname")
** <small>See [[wo:API Notation and Conventions]] for a more thorough explanation</small>
* Don't just say "NEW!" or "REMOVED!". ''Say in which version!'' It may be obvious to you when you write it, since it's the current one, but the page has to make sense three months from now, too. And more.

=== Regular API function pages ===
<small>Global, honest-to-god APIs, e.g. &#x5b;[[wo:API UnitName|UnitName]]&#x5d;, &#x5b;[[wo:API AcceptDuel|AcceptDuel]]&#x5d;, &#x5b;[[wo:API GetAddOnDependencies|GetAddOnDependencies]]&#x5d;</small>

* Name the page <tt style="border-bottom: 1px dotted;">API ''FunctionName''</tt>.
* Use [[Help:API Function articles]] as a basis for the page.
* Place {{t|wowapi}} at the top of the page (the boilerplate already has it). Places the page in [[:Category:World of Warcraft API]].

=== Learning about undocumented functions ===
So when you can't find a reference to learn how a WoW API works, what to do?

* [[wo:Viewing Blizzard's WoW user interface code|Look in FrameXML]] to learn how Blizzard themselves uses the API.

* Ask yourself if the examples really cover everything you need to know:
** What happens on failure? Does the function return nil or false?
** That logical test you see, is the function returning 1 or true? It might make a difference to others.
** Which parameters can be left as nil?

* TEST your questions. Either by experimenting with the API in an AddOn of yours, or, perhaps easier, use an in-game Lua editor like [[myDebug]]!
* Please help the rest of us and type your findings into the wiki :-)

Someone else might have done the hard work without sharing already; if you have a bunch of AddOns installed, try searching in ''them'' to see if they use the API. It might tell you more.