Quantcast

Add some in-game datamining documentation.

ackis [04-14-09 - 19:19]
Add some in-game datamining documentation.
Filename
.docmeta
AckisRecipeList.lua
Docs/Datamine.txt
diff --git a/.docmeta b/.docmeta
index a2918ce..307d7fc 100644
--- a/.docmeta
+++ b/.docmeta
@@ -4,6 +4,10 @@
  output-page: "Database Documentation"
 -
  type: wiki
+ input-file: Docs/Datamine.txt
+ output-page: "In-game Datamining"
+-
+ type: wiki
  input-file: Docs/In-game.txt
  output-page: "In-game Documentation"
 -
diff --git a/AckisRecipeList.lua b/AckisRecipeList.lua
index fb4495c..7daae22 100644
--- a/AckisRecipeList.lua
+++ b/AckisRecipeList.lua
@@ -2385,6 +2385,9 @@ end
 -- Input: None
 -- Output: Text in chat window

+--- API for external addons to get recipe database from ARL
+-- @name AckisRecipeList:ScanSkillLevelData
+-- @return Does a comparison of the information in your internal ARL database, and those items which are availible on the trainer.  Compares the skill levels between the two.
 function addon:ScanSkillLevelData()

 	if (IsTradeskillTrainer()) then
diff --git a/Docs/Datamine.txt b/Docs/Datamine.txt
new file mode 100644
index 0000000..0ef2b37
--- /dev/null
+++ b/Docs/Datamine.txt
@@ -0,0 +1,14 @@
+==ARL In-game Datamining==
+
+===Reasoning===
+There are over 100 different flags on which recipes may be filtered, and there are over 1000 different recipes in World of Warcraft right now.  Updating all of these by hand is extremely difficult and takes a long time to complete.  As a result, there are certain datamining functions in-game which will assist with ensuring that ARL has the most complete information possible.
+
+====History====
+The ARL database has been rewritten approximentally 5 times.  The first four times were pre-WotLK and involved me doing the entire database by hand.  The fifth time I wrote a dataminer script in Ruby, however due to database issues, the data was not 100%.  As a result, I decided the best method of obtaining information is to datamine it from in-game itself.
+
+===Commands===
+Right now there is no special GUI for datamining.  You must run the command with the <code>/script</code> command.
+
+====Trainer Skill Levels====
+Does a comparison of the information in your internal ARL database, and those items which are availible on the trainer.  Compares the skill levels between the two.
+ /script AckisRecipeList:ScanSkillLevelData()
\ No newline at end of file