Quantcast

Clean up the docs a bit

pompachomp [03-06-10 - 00:19]
Clean up the docs a bit
Filename
Docs/Documentation.txt
Docs/In-game.txt
Docs/Main.txt
diff --git a/Docs/Documentation.txt b/Docs/Documentation.txt
index e355607..2ce694d 100644
--- a/Docs/Documentation.txt
+++ b/Docs/Documentation.txt
@@ -27,9 +27,9 @@ All the graphical interface functions are located in '''Frame.lua'''. This file
 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
-	AddRecipe(2329,1,2454,1,V.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)
+	AddRecipe(2329, 1, 2454, Q.COMMON, V.ORIG, 1, 55, 75, 95)
+	self:addTradeFlags(RecipeDB, 2329, F.ALLIANCE, F.HORDE, F.TRAINER, F.IBOE, F.RBOP, F.DPS)
+	self:addTradeAcquire(RecipeDB, 2329, A.CUSTOM, 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.

@@ -269,9 +269,9 @@ Defined below is the specification for the arguments passed back into addTradeAc
 :53428 Runeforging

 ==Game IDs==
-:0 - Original WoW
-:1 - Burning Crusade
-:2 - Wrath of the Lich King
+:1 - Original WoW
+:2 - Burning Crusade
+:3 - Wrath of the Lich King

 ==Table Structures==

diff --git a/Docs/In-game.txt b/Docs/In-game.txt
index a4de619..6701000 100644
--- a/Docs/In-game.txt
+++ b/Docs/In-game.txt
@@ -1,5 +1,5 @@
 ==ARL In-game Documentation
-I developed some documentation which is in-game.  I am also providing it here.
+We have developed some In-game documentation.


 {{arl:25}}
@@ -73,11 +73,11 @@ When reporting a bug, please make sure you do the following:
 # Disable addons such as Skillet or ATSW.
 # Read the bug reporting documentation at [[http://www.wowace.com/projects/arl/pages/feedback/]]
 # If your problem is not listed and you are using the latest version verify your addon settings.  Verify filters, profiles, etc.
-# You have found a bug that no one has reported before.  Create a new ticket at [[http://www.wowace.com/projects/arl/tickets/]] with a descriptive heading about the problem.  In the ticket make sure you include the error message that you received (just the error message, I don't need a listing of the addons you use), the recipe/profession you were working with, and any other info that you think may help.
-When posting a bug report, do NOT include all of the addons from swatter.  This just makes it difficult to read.  If you want a good error reporting mod, get BugSack.  Do not post errors/missing recipes in the comments, or send them to me via a PM.  Post them as a ticket which I can address and track easily.
+# You have found a bug that no one has reported before.  Create a new ticket at [[http://www.wowace.com/projects/arl/tickets/]] with a descriptive heading about the problem.  In the ticket make sure you include the error message that you received (just the error message, we don't need a listing of the addons you use), the recipe/profession you were working with, and any other info that you think may help.
+When posting a bug report, do NOT include all of the addons that any error catcher may list.  This just makes it difficult to read.  If you want a good error reporting mod, get BugSack.  Do not post errors/missing recipes in the comments, or send them to an author via a PM.  Post them as a ticket which we can address and track easily.

 ===Common Issues
 Please refer to these common issues before submitting a bug report.
 # Recipe X does not show up! - Check your filter settings to make sure that the recipe is not being filtered.
-# Inscription is missing so many glyphs! Why aren't they listed?  Turn off your 'classes' filter.  By default (and due to popular request) ARL will only show recipes which your class can use and most glyphs are not usable by your class.
-# I don't want to see opposite faction recipes! Turn on the factions filter.  This will set it up to only display your factions obtainable recipes.  If something still shows up and it shouldn't, please submit a bug report.
\ No newline at end of file
+# Inscription is missing so many glyphs! Why aren't they listed?  Turn off your 'classes' filter.
+# I don't want to see opposite faction recipes! Turn off the factions filter.  This will set it up to only display your factions obtainable recipes.  If something still shows up and it shouldn't, please submit a bug report.
\ No newline at end of file
diff --git a/Docs/Main.txt b/Docs/Main.txt
index b570048..153ef92 100644
--- a/Docs/Main.txt
+++ b/Docs/Main.txt
@@ -27,7 +27,7 @@ YouTube video of ARL in action:
 <<youtube jZR5DLkRJBY>>

 ==Donations
-Ackis has setup a donation site via [[http://www.pledgie.com/campaigns/3462|Pledgie]].  Feel free to donate if you like this AddOn - we have put countless hours of time and effort into it along with many people who have helped us.  We did not write this AddOn with the intent to make any money from it.  It was written help us (and others) with some needs that we saw in-game, and with our goal to make it filled with information it's become a massive project.
+Ackis has setup a donation site via [[https://www.paypal.com/cgi-bin/webscr?cancel_return=http%3A%2F%2Fwow.curse.com%2Fdownloads%2Fwow-addons%2Fdetails%2Farl.aspx&return=http%3A%2F%2Fwow.curse.com%2Fdownloads%2Fwow-addons%2Fdetails%2Farl.aspx&cn=Add+special+instructions+to+the+addon+author%28s%29&business=jpasula%40shaw.ca&item_name=Ackis+Recipe+List+%28from+Curse.com%29&bn=PP-DonationsBF%3Abtn_donateCC_LG.gif%3ANonHosted&cmd=_donations&rm=1&no_shipping=1&currency_code=USD&lc=US|Paypal]].  Feel free to donate if you like this AddOn - we have put countless hours of time and effort into it along with many people who have helped us.  We did not write this AddOn with the intent to make any money from it.  It was written to help us (and others) with some needs that we saw in-game, and with our goal to make it filled with information it's become a massive project.

 If you don't wish to donate money feel free to consider one of the following methods which may be more suitable:
 * Volunteer time at your local animal shelter such as the [[http://www.aspca.org/|Society for Prevention of Cruelty for Animals (SPCA)]] or a [[http://www.edmontonhumanesociety.com/|local humane shelter]] or drop a few bucks off for them.  If you do this, please let [[http://www.wowace.com/home/send-private-message/|Ackis]] know.