diff --git a/.docmeta b/.docmeta index dcfb9e4..b9d94f4 100644 --- a/.docmeta +++ b/.docmeta @@ -4,8 +4,12 @@ output-page: "Database Documentation" - type: wiki + input-file: Docs/In-game.txt + output-page: "In-game Documenation" +- + type: wiki input-file: Docs/Feedback.txt - output-page: "Feedback" + output-page: "Feedback and Bug Reporting" - type: wiki input-file: Docs/Main.txt diff --git a/Docs/Feedback.txt b/Docs/Feedback.txt index 2b246f5..262a4ad 100644 --- a/Docs/Feedback.txt +++ b/Docs/Feedback.txt @@ -24,4 +24,4 @@ Don't include your list of addons when pasting error logs. If there's an addon c * Has the bug already been fixed? '''Read the changelog''' of the latest alpha release [http://www.wowace.com/projects/arl/files/ here] * If you choose to use an alpha revision, make sure you're using the latest revision and pay attention to the changelog -Remember that alpha versions are development-only releases, primarily for the author's benefit. Beta versions are specifically put out their for testing purposes for willing users and, as such, are not guaranteed to be stable for normal use. +Remember that alpha versions are development-only releases, primarily for the author's benefit. Beta versions are specifically put out their for testing purposes for willing users and, as such, are not guaranteed to be stable for normal use. \ No newline at end of file diff --git a/Docs/In-game.txt b/Docs/In-game.txt new file mode 100644 index 0000000..dbbec44 --- /dev/null +++ b/Docs/In-game.txt @@ -0,0 +1,22 @@ +==ARL In-game Documentation== +I developed some documentation which is in-game. I am also providing it here. + +===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. + +===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/]. +# Make sure there is not a bug report filed for your issue already. You can check these at [http://www.wowace.com/projects/arl/tickets/]. +# 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. + +===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 glpyhs 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 diff --git a/Docs/Main.txt b/Docs/Main.txt index b4bb115..99bf745 100644 --- a/Docs/Main.txt +++ b/Docs/Main.txt @@ -1,6 +1,11 @@ ==What it does== Ackis Recipe List is an addon which will scan your trade skill recipes and print out a list of which recipes you are currently missing. It will work for all tradeskills including Runeforging. +==Do this first== +Read the documentation located at these locations: +* Bug Reporting and Feature Requestiing - [http://www.wowace.com/projects/arl/pages/feedback/] +* In-game Documentation - [http://www.wowace.com/projects/arl/pages/ingame/] + ==Comments== I have disabled comments on Curse.com for multiple reasons. The main one being people posting comments such as "this is broken" without providing any other information. Please see the in-game documentation or the Bug Reports section on how to contact me. diff --git a/Locals/ARLLocals-enUS.lua b/Locals/ARLLocals-enUS.lua index f783959..385a6e8 100644 --- a/Locals/ARLLocals-enUS.lua +++ b/Locals/ARLLocals-enUS.lua @@ -70,9 +70,10 @@ L["Reporting Bugs"] = true L["REPORTING_BUGS_DESC"] = [["When reporting a bug, please make sure you do the following: 1) Download the latest version, available from http://www.wowace.com/projects/arl/files/ 2) Make sure there is not a bug report filed for your issue already. You can check these at http://www.wowace.com/projects/arl/tickets/ -2a) Disable addons such as Skillet or ATSW. -3) If your problem is not listed and you are using the latest version verify your addon settings. Verify filters, profiles, etc. -4) 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. +3) Disable addons such as Skillet or ATSW. +4) Read the bug reporting documentation at http://www.wowace.com/projects/arl/pages/feedback/ +5) If your problem is not listed and you are using the latest version verify your addon settings. Verify filters, profiles, etc. +6) 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."]] L["Common Issues"] = true L["COMMON_ISSUES_DESC"] = [["Please refer to these common issues before submitting a bug report.