Quantcast

Clean up the Documentation.txt doc a bit.

pompachomp [12-11-09 - 19:41]
Clean up the Documentation.txt doc a bit.
Filename
Docs/Documentation.txt
diff --git a/Docs/Documentation.txt b/Docs/Documentation.txt
index 8c5d3e2..8fd6acb 100644
--- a/Docs/Documentation.txt
+++ b/Docs/Documentation.txt
@@ -7,29 +7,29 @@ Please see this [http://www.wowace.com/projects/arl/pages/localization/ page] fo
 ==File Breakdown==
 :'''AckisRecipeList.lua'''
 ::Main code for getting the database, adding entries to it, filtering, etc.
-:'''ARLColour.lua'''
+:'''Colour.lua'''
 ::Code for making output colourized.
-:'''ARLConfig.lua'''
+:'''Config.lua'''
 ::All the configuration options for ARL
-:'''ARLFrame.lua'''
+:'''Frame.lua'''
 ::All the GUI code
 :''Locals''
 ::All the localization files
 :''RecipeDB''
 ::All the recipe database files
-:'''ARLDataminer.rb'''
-::Dataminer which was used to initially populate the ARL database.
+:'''Dataminer.lua'''
+::Dataminer which is used to compare the recipes in ARL and what is in game.

 ===Graphical Interface===
-All the graphical interface functions are located in '''ARLFrame.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.
+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===
 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
- self:addTradeSkill(RecipeDB,2329,1,2454,1,2259,0,1,55,75,95)
- self:addTradeFlags(RecipeDB,2329,1,2,3,21,22,23,24,25,26,27,28,29,30,36,41,51,52)
- self:addTradeAcquire(RecipeDB,2329,8,8)
+	-- Elixir of Lion's Strength -- 2329
+	AddRecipe(2329,1,2454,1,GAME_ORIG,1,55,75,95)
+	self:addTradeFlags(RecipeDB,2329, F_ALLIANCE, F_HORDE, F_TRAINER, F_IBOE, 41, F_DPS)
+	self:addTradeAcquire(RecipeDB,2329,8,8)

 The first line is a human readable comment, which states the recipe name, with the [http://www.wowwiki.com/SpellLink spell ID] of the recipe.

@@ -206,6 +206,7 @@ These flags are defined as:
 *125 = Wrath Common Factions(Explorer's League/Valiance Expedition)
 *126 = Wrath Common Factions (The Frostborn/The Taunka)
 *127 = Wrath Common Factions (Alliance Vanguard/Horde Expedition)
+*128 = Ashen Verdict

 ==Acquire Flags==

@@ -559,6 +560,8 @@ This identifies the overall database structure for the saved variables.  Italics
 *****''true''
 ****wrathcommon1
 *****''true''
+****ashenverdict
+*****''true''
 ***classes
 ****deathknight
 *****''true''