Quantcast

Update docs

ackis [01-23-09 - 17:58]
Update docs
Filename
AckisRecipeList.lua
Docs/Localization.txt
Docs/Main.txt
diff --git a/AckisRecipeList.lua b/AckisRecipeList.lua
index 2f5dcee..5f6cfe3 100644
--- a/AckisRecipeList.lua
+++ b/AckisRecipeList.lua
@@ -1352,6 +1352,8 @@ function addon:ChatCommand(input)
 		InterfaceOptionsFrame_OpenToCategory(self.optionsFrame["Profiles"])
 	elseif (input == tolower(L["Filter"])) then
 		InterfaceOptionsFrame_OpenToCategory(self.optionsFrame["Filters"])
+	elseif (input == tolower(L["Documentation"])) then
+		InterfaceOptionsFrame_OpenToCategory(self.optionsFrame["Documentation"])
 	elseif (input == tolower(L["Scan"])) then
 		self:AckisRecipeList_Command(false)
 	elseif (input == tolower("minedata")) then
diff --git a/Docs/Localization.txt b/Docs/Localization.txt
index 2e62bab..71ab4a3 100644
--- a/Docs/Localization.txt
+++ b/Docs/Localization.txt
@@ -1,4 +1,6 @@
-==Locale schema==
+All localization entries must be added to the WoW Ace localization application.  When the addon is packaged, the localization strings are taken from the application and added to the code.
+
+==Localization Schema==
 * single and double words are just fine, anything longer should have a tag
 * tag name rules:
 ** tags should be ALL_CAPITAL_LETTERS with words separated with _'s
diff --git a/Docs/Main.txt b/Docs/Main.txt
index 6a26650..164e5b4 100644
--- a/Docs/Main.txt
+++ b/Docs/Main.txt
@@ -10,18 +10,41 @@ Ackis Recipe List is an addon which will scan your trade skill recipes and print
 You open up a trade skill window (ie: enchanting) and click on the Scan button which is attached to the trade skill window.  Results will be printed out to the chat frame, or into a separate window depending on preference.

 ===Commands===
-Ackis Recipe List has recently changed to use a GUI for change parameters.  Type <code>/arl</code> to open up the GUI.
+Ackis Recipe List has recently changed to use a GUI for change parameters.  Type <code>/arl</code> to open up the GUI.  Acceptable commands include:
+* <code>/arl about</code>
+** Opens up the about panel, listing information about the mod.
+* <code>/arl sort</code>
+** Opens up the sorting options.
+* <code>/arl sorting</code>
+** Opens up the sorting options.
+* <code>/arl documentation</code>
+** Opens up in-game documentation regarding ARL.
+* <code>/arl display</code>
+** Opens up display options.
+* <code>/arl profile</code>
+** Opens up profile options.
+* <code>/arl filter</code>
+** Opens up filtering options.
+* <code>/arl scan</code>
+** Performs a scan for missing recipes.  This is in place for those times when you cannot access the scan button.

 ==Known Issues==
-All known issues will be kept at the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker.
+* When gaining a reputation level recipes for that faction will still appear in red when doing a scan.
+* If you have a cooking or first aid book/quest complete, but aren't past the skill level, it'll show the book/quest as unknown (ie: I have read the first aid skill book for skill level 150, however my skill in first aid is only 140, it'll show the book as unknown still).
+* Recipe acquire information is slightly inaccurate.  I'm updating recipes daily as information is identified.  If you find something inaccurate or wrong, submit a ticket [http://www.wowace.com/projects/arl/create-ticket/ here] and I will get it updated.

-Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to file bug reports.
+==Bug Reports==
+Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to file bug reports.  Posting bugs in the comments is not the place to do it.

 ==Wish List==
 Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to add suggestions and feature requests.

 ==Integration==
-Ackis Recipe List strives to integrate with existing trade skill mods out there.  If you have a request for integration, please submit a feature request at [http://www.wowace.com/projects/arl/tickets/ WoW Ace].  There is a limted API documented at [http://www.wowace.com/projects/arl/pages/API/] to interface with the ARL database.  If you are a developer and would like more functions, please contact me on IRC.
+Ackis Recipe List strives to integrate with existing trade skill mods out there.  If you have a request for integration, please submit a feature request at [http://www.wowace.com/projects/arl/tickets/ WoW Ace].  There is a limited API documented at [http://www.wowace.com/projects/arl/pages/API/] to interface with the ARL database.  If you are a developer and would like more functions, please contact me on IRC.
+Currently, the mod works with:
+* Advanced Trade Skill Window
+* Skillet
+* Manufac

 ==Bug Reporting==
 Please use the [http://www.wowace.com/projects/arl/tickets/ WoW Ace] tracker to file bug reports.