diff --git a/ARLConfig.lua b/ARLConfig.lua index c2adbfc..49b634f 100644 --- a/ARLConfig.lua +++ b/ARLConfig.lua @@ -1305,6 +1305,36 @@ local function giveDocs() type = "description", name = L["REPORTING_BUGS_DESC"], }, + header5 = { + order = 9, + type = "header", + name = L["Exclusion Issues"], + }, + desc5 = { + order = 10, + type = "description", + name = L["EXCLUSION_ISSUES_DESC"], + }, + header6 = { + order = 11, + type = "header", + name = L["Map Issues"], + }, + desc6 = { + order = 12, + type = "description", + name = L["MAP_ISSUES_DESC"], + }, + header7 = { + order = 13, + type = "header", + name = L["Game Commands"], + }, + desc7 = { + order = 14, + type = "description", + name = L["GAME_COMMANDS_DESC"], + }, }, } diff --git a/Docs/In-game.txt b/Docs/In-game.txt index dbbec44..a05ef2f 100644 --- a/Docs/In-game.txt +++ b/Docs/In-game.txt @@ -1,10 +1,62 @@ ==ARL In-game Documentation== I developed some documentation which is in-game. I am also providing it here. +===Command Line=== +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> or <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. + +===Clicking=== +Ackis Recipe List will behave differently depending on which modifying keys you use to click. + +====Scan Button==== +This is the functionality that occurs when you are clicking the scan button. + +*Normal Click +**Performs a scan of the current tradeskill displaying recipes in a new window. +*Shift Click +**Generates a text dumping of the current tradeskill in CSV format. +*Alt Click +**Removes all waypoints on the World Map and Mini-map generated by ARL. + +====Recipe==== +This is the functionality that occurs when you click on a recipe. + +*Normal Click +**Expands or contracts the recipe acquire information. +*Shift Click +**Generates an item link of the item that the recipe will make into your default chat box. +*Ctrl Click +**Genereates a spell link for the recipe you clicked. +*Alt Click +**Adds or removes a recipe from the exclusion list. +*Ctrl-Shift Click +**Adds the specific recipe acquire methods to the World Map and Mini-map. + +===Map Integration=== +ARL relies on [http://www.wowinterface.com/downloads/info7032-TomTom.html TomTom] to add icons and waypoints to the World Map and the Mini-map. You can customize these by going to the ARL configuration menu and scrolling to the display options. If you do not have [http://www.wowinterface.com/downloads/info7032-TomTom.html TomTom] installed, nothing will be added. Auto-adding icons is disabled by default. + +If you wish to add a single recipe's acquire methods to the maps, you can Ctrl-Shift click on the recipe. + ===Using Filters=== Filters may be toggled on or off. There are two types of filters: one which will prevent the recipe from showing up at all, and one which will prevent a specific type of acquire information from showing up. With the first type of filter, these match the proprieties of the recipe (ie: binding). If you toggle ARL to not show BoP recipes, no recipes that are BoP will show up in the scan. The second type of filter deals with acquire information. If a recipe is available as a mob drop, or from a vendor and you toggle to not show vendor recipes, the recipe will still show up but vendor information will be hidden for it. The reason is that there is still another way to acquire this recipe (mob drop) so it should still be included in the scan. +===Exclusion List=== +To add a recipe to the exclusion (ignore) list, just alt-click on it from the recipe window. To get this recipe back, open up the ARL options and set the toggle of "Show Excluded Recipes" to be on. This will show all the recipes you've excluded in your scan during your next scan. Once you have done this, Alt Click on the recipe again to remove it from the exclusion list. + ===Reporting Bugs=== When reporting a bug, please make sure you do the following: # Download the latest version, available from [http://www.wowace.com/projects/arl/files/]. diff --git a/Locals/ARLLocals-enUS.lua b/Locals/ARLLocals-enUS.lua index 9595b88..cfc28c7 100644 --- a/Locals/ARLLocals-enUS.lua +++ b/Locals/ARLLocals-enUS.lua @@ -84,6 +84,54 @@ L["COMMON_ISSUES_DESC"] = [["Please refer to these common issues before submitt 1) Recipe X does not show up! - Check your filter settings to make sure that the recipe is not being filtered. 2) 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 glpyhs are not usable by your class. 3) 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."]] +L["Exclusion Issues"] = true +L["EXCLUSION_ISSUES_DESC"] = "To add a recipe to the exclusion (ignore) list, just alt-click on it from the recipe window. To get this recipe back, open up the ARL options and set the toggle of \"Show Excluded Recipes\" to be on. This will show all the recipes you've excluded in your scan during your next scan. Once you have done this, Alt Click on the recipe again to remove it from the exclusion list." +L["Map Issues"] = true +L["MAP_ISSUES_DESC"] = "ARL relies on TomTom to add icons and waypoints to the World Map and the Mini-map. You can customize these by going to the ARL configuration menu and scrolling to the display options. If you do not have TomTom installed, nothing will be added. Auto-adding icons is disabled by default." +L["Game Commands"] = true +L["GAME_COMMANDS_DESC"] = [["===Command Line=== +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> or <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. + +===Clicking=== +Ackis Recipe List will behave differently depending on which modifying keys you use to click. + +====Scan Button==== +This is the functionality that occurs when you are clicking the scan button. + +*Normal Click +**Performs a scan of the current tradeskill displaying recipes in a new window. +*Shift Click +**Generates a text dumping of the current tradeskill in CSV format. +*Alt Click +**Removes all waypoints on the World Map and Mini-map generated by ARL. + +====Recipe==== +This is the functionality that occurs when you click on a recipe. + +*Normal Click +**Expands or contracts the recipe acquire information. +*Shift Click +**Generates an item link of the item that the recipe will make into your default chat box. +*Ctrl Click +**Genereates a spell link for the recipe you clicked. +*Alt Click +**Adds or removes a recipe from the exclusion list. +*Ctrl-Shift Click +**Adds the specific recipe acquire methods to the World Map and Mini-map."]] -- Config UI Elements and their associated descriptions L["Include Filtered"] = true