diff --git a/.docmeta b/.docmeta
index 2156ab0..e09de62 100644
--- a/.docmeta
+++ b/.docmeta
@@ -31,10 +31,14 @@
input-file: Docs/Localization.txt
output-page: "API/Localization"
-
+ type: creole
+ input-file: Docs/API.txt
+ output-page: "API"
+-
type: luadoc
input-file: core.lua
- output-page: API
+ output-page: API/Core
-
type: luadoc
input-file: Scanner.lua
- output-page: API/In-game Datamining
\ No newline at end of file
+ output-page: API/Scanner
\ No newline at end of file
diff --git a/Docs/API.txt b/Docs/API.txt
new file mode 100644
index 0000000..bf6946e
--- /dev/null
+++ b/Docs/API.txt
@@ -0,0 +1 @@
+This page has moved to [[API/Core]].
\ No newline at end of file
diff --git a/Docs/Documentation.txt b/Docs/Documentation.txt
index 86af4dd..3ce8ec8 100644
--- a/Docs/Documentation.txt
+++ b/Docs/Documentation.txt
@@ -1,16 +1,18 @@
-'''Database and code documentation for Ackis Recipe List.'''
+**Database and code documentation for Ackis Recipe List.**
-==Localization==
-Please see this [http://www.wowace.com/addons/arl/pages/api/localization/ page] for information on localization within the addon.
+The data on this page is most likely out of date.
-==File Breakdown==
-:'''AckisRecipeList.lua'''
+==Localization
+Please see this [[http://www.wowace.com/addons/arl/pages/api/localization/ | page]] for information on localization within the addon.
+
+==File Breakdown
+:**AckisRecipeList.lua**
::Main code for getting the database, adding entries to it, filtering, etc.
-:'''Colour.lua'''
+:**Colour.lua**
::Code for making output colourized.
-:'''Config.lua'''
+:**Config.lua**
::All the configuration options for ARL
-:'''Frame.lua'''
+:**Frame.lua**
::All the GUI code
:''Locals''
::All the localization files
@@ -19,10 +21,10 @@ Please see this [http://www.wowace.com/addons/arl/pages/api/localization/ page]
:'''Dataminer.lua'''
::Dataminer which is used to compare the recipes in ARL and what is in game
-===Graphical Interface===
+===Graphical Interface
All the graphical interface functions are located in '''Frame.lua'''. This file contains all the functions needed for the GUI. If you have enhancements, know how to fix an issue, etc please feel free to contribute. Just leave a detailed commit note. If it's a new feature please run it by me first before adding anything.
-===Database Functions===
+===Database Functions
In the RecipeDB is a single file for each profession. Each recipe is inserted into the database via 3 functions. For example:
-- Elixir of Lion's Strength -- 2329
@@ -34,7 +36,7 @@ The first line is a human readable comment, which states the recipe name, with t
Please see the [API] page for detailed documentation on the database methods.
-==Filter Method==
+==Filter Method
Filters can be divided into two general categories:
:'''Exclusive''': if ''ANY'' of these are flagged to "FALSE", the recipe will not display
@@ -54,7 +56,7 @@ Finally, return retval.
I believe this will get through the flags in the shortest possible route, short circuiting the looping when any condition warrants it
-===List of Exclusive filters===
+===List of Exclusive filters
This filters will prevent the recipe from showing up regardless of any other filters. For example, if one of them is false, the recipe is hidden.
@@ -72,7 +74,7 @@ This filters will prevent the recipe from showing up regardless of any other fil
::weapon
::armor
-===List of Non-exclusive filters===
+===List of Non-exclusive filters
*If false, this will only exclude the display of cross-faction vendors/trainers/etc:
**faction
@@ -94,11 +96,11 @@ This filters will prevent the recipe from showing up regardless of any other fil
Note that if NO acquire methods remain unfiltered, the recipe will not be displayed.
-===Filter Flags===
+===Filter Flags
A recipe can be flagged with many (or even all) of the below flags. They are defined as follows:
-====Obtain====
+====Obtain
*1 = Alliance faction
*2 = Horde faction
*3 = Trainer
@@ -112,7 +114,7 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
*11 = Mob drop
*12 = Discovery
*13-20 = Reserved for future use
-====Class====
+====Class
These flags are defined as:
# Can this class use this recipe? (ie: Rage potions, glyphs, etc)
# Can this class learn this recipe? (ie: Thistle tea)
@@ -127,7 +129,7 @@ These flags are defined as:
*29 = Warlock
*30 = Warrior
*31-35 = Reserved for future use
-====Crafted Properties====
+====Crafted Properties
*36 = Item BoE
*37 = Item BoP
*38 = Item BoA
@@ -135,13 +137,13 @@ These flags are defined as:
*41 = Recipe BoP
*42 = Recipe BoA
*43-50 = Reserved for future use
-====Item Type====
+====Item Type
*51 = Physical DPS (melee/hunters)
*52 = Tanking
*53 = Healing
*54 = Caster DPS
*55 = Reserved for future use
-=====Armor Type=====
+=====Armor Type
*56 = Cloth
*57 = Leather
*58 = Mail
@@ -152,7 +154,7 @@ These flags are defined as:
*63 = Necklace
*64 = Shield
*65 = Reserved for future use
-=====Weapon Type=====
+=====Weapon Type
*66 = 1H/Offhand
*67 = 2H
*68 = Axe
@@ -169,14 +171,14 @@ These flags are defined as:
*79 = Fist
*80 = Gun
*81-95 = Reserved for future use
-====Reputation====
-=====Original=====
+====Reputation
+=====Original
*96 = Argent Dawn
*97 = Cenarion Circle
*98 = Thorium Brotherhood
*99 = Timbermaw Hold
*100 = Zandalar Tribe
-=====Burning Crusade=====
+=====Burning Crusade
*101 = The Aldor
*102 = Ashtongue Deathsworn
*103 = Cenarion Expedition
@@ -191,7 +193,7 @@ These flags are defined as:
*112 = Shattered Sun
*113 = Sporeggar
*114 = Violeteye
-=====Wrath of the Lich King=====
+=====Wrath of the Lich King
*115 = Argent Crusade
*116 = Frenzyheart Tribe
*117 = Knights of the Ebon Blade
@@ -207,7 +209,7 @@ These flags are defined as:
*127 = Wrath Common Factions (Alliance Vanguard/Horde Expedition)
*128 = Ashen Verdict
-==Acquire Flags==
+==Acquire Flags
Defined below is the specification for the arguments passed back into addTradeAcquire. Each Acquire Type passes in different parameters depending on how the recipe is acquired:
@@ -232,19 +234,19 @@ Defined below is the specification for the arguments passed back into addTradeAc
ID - Custom string
</nowiki></pre>
-== Reputation ID==
+== Reputation ID
:0 = Neutral
:1 = Friendly
:2 = Honored
:3 = Revered
:4 = Exalted
-==Faction ID==
+==Faction ID
:0 - Neutral
:1 - Alliance
:2 - Horde
-==Rarity colours==
+==Rarity colours
:0 - poor #919191
:1 - common #ffffff
:2 - uncommon #00A900
@@ -253,7 +255,7 @@ Defined below is the specification for the arguments passed back into addTradeAc
:5 - legendary #FA9900
:6 - artifact #e5cc80
-==Profession IDs==
+==Profession IDs
:2259 Alchemy
:2018 Blacksmithing
:2550 Cooking
@@ -267,14 +269,14 @@ Defined below is the specification for the arguments passed back into addTradeAc
:45357 Inscription
:53428 Runeforging
-==Game IDs==
+==Game IDs
:1 - Original WoW
:2 - Burning Crusade
:3 - Wrath of the Lich King
-==Table Structures==
+==Table Structures
-===Recipe Array Structure===
+===Recipe Array Structure
:SpellID =
::Level - Skill level at which you can learn the recipe
::ItemID - ID of the item created by the recipe (if it exists)
@@ -292,7 +294,7 @@ Defined below is the specification for the arguments passed back into addTradeAc
::Green - Skill level when recipe is green.
::Grey - Skill level when recipe is grey.
-===Mob DB===
+===Mob DB
self:addLookupList(MobDB, 590, L["Defias Looter"], BZONE["Westfall"], 38.52, 55.94)
:MobList
::ID =
@@ -301,7 +303,7 @@ Defined below is the specification for the arguments passed back into addTradeAc
:::Coordx - X coordinate
:::Coordy - Y coordinate
-===Quest DB===
+===Quest DB
self:addLookupList(QuestDB, 2859, L["Wild Leather Leggings"], BZONE["Feralas"], 47.97, 67.15, 2)
:QuestList
::ID =
@@ -311,19 +313,19 @@ Defined below is the specification for the arguments passed back into addTradeAc
:::Coordy - Y Coordinate of quest start
:::Faction - Faction **
-===Reputation DB===
+===Reputation DB
self:addLookupList(RepDB, 54, BFAC["Gnomeregan Exiles"]) -- Acquire Flag:
:ReputationList
::ID =
:::Name -- translated faction
-===Seasonal DB===
+===Seasonal DB
self:addLookupList(SeasonDB, 3, L["Darkmoon Faire"])
:SeasonList
::ID =
:::Name -- Translated Seasonal Event name
-===Trainer DB===
+===Trainer DB
self:addLookupList(TrainerDB, 16583, L["Rohok"], BZONE["Hellfire Peninsula"], 54.62, 40.62, 2)
:TrainerList
::ID
@@ -333,7 +335,7 @@ Defined below is the specification for the arguments passed back into addTradeAc
:::Coordy -- Trainer Y coordinate
:::Faction -- Faction ID **
-===Vendor DB===
+===Vendor DB
self:addLookupList(VendorDB, 13433, L["Wulmort Jinglepocket"], BZONE[""], 0, 0, 0)
:VendorList
::ID =
@@ -343,7 +345,7 @@ Defined below is the specification for the arguments passed back into addTradeAc
:::Coordy -- Vendor Y coordinate
:::Faction -- Vendor Faction ID **
-==SavedVariable Structure==
+==SavedVariable Structure
This identifies the overall database structure for the saved variables. Italics are the default options.
*addon.db.profile