changeset 7:9a37bd40eb5e

Some help docs on history
author Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date Wed, 15 Jun 2011 23:35:07 +0000
parents df3e27edbd60
children 30ba1f35e164
files gui.lua verbage.lua
diffstat 2 files changed, 52 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/gui.lua	Wed Jun 15 03:59:13 2011 +0000
+++ b/gui.lua	Wed Jun 15 23:35:07 2011 +0000
@@ -1192,7 +1192,7 @@
 			b:SetFullWidth(true)
 			b:SetCallback("OnClick", function (_b)
 				reset_current_realm(addon.history.realm)
-				addon:Print("Stimpy, you idiot!  You've pushed the history erase button!")
+				addon:Print("Stimpy, you eeediot, you've pushed the history erase button!")
 				return addon:redisplay()
 			end)
 			specials:AddChild(b)
@@ -1203,7 +1203,7 @@
 			b:SetCallback("OnClick", function (_b)
 				addon.history_all = {}
 				reset_current_realm()
-				addon:Print("Stimpy, you idiot!  You've pushed the history erase button!")
+				addon:Print("Stimpy, you eeediot, you've pushed the history erase button!")
 				return addon:redisplay()
 			end)
 			specials:AddChild(b)
--- a/verbage.lua	Wed Jun 15 03:59:13 2011 +0000
+++ b/verbage.lua	Wed Jun 15 23:35:07 2011 +0000
@@ -71,6 +71,10 @@
 		},
 	},
 	{
+		value = "history",
+		text = "History Tab",
+	},
+	{
 		value = "tips",
 		text = "Handy Tips",
 		children = {
@@ -347,6 +351,52 @@
 This also means you cannot +Regenerate> the texts.
 ]]
 
+T.history = [[
+The <History> tab maintains a list of all loot.  It is intended to help answer
+questions such as "When was the last time PlayerX won something?" and "How much stuff
+has PlayerY gotten lately?"  The history tab is, by design, not as configurable
+as the main <Loot> tab; entries cannot be edited, individually deleted, and so forth.
+
+Loot history is the only "live" data tab which persists across a +Clear> command.
+For this reason, very little information is stored:  only the recipient, the item,
+and a textual timestamp.  Boss names, offspecs and other notes, are not preserved.
+
+The default history window shows the most recent item received by each person.  It
+is sorted with the most recent loot at the top, towards older loot at the bottom.
+You can click the column headers to rearrange the rows, but doing so repeatedly can
+lead to odd display issues.
+
+Left-clicking a row will change the window to display all recorded loot for that
+player.  On that display, right-clicking any row will return to showing the most
+recent single item for all players.
+
+Histories are maintained per-realm.  This refers to the realm you are on when the
+loot drops, not the realm of the player receiving it (in the case of cross-realm
+groups).  If you play multiple characters on the same realm, history will accumulate
+across all your raids.  To change the displayed realm, use the dropdown menu in
+the lower right corner.
+
+The +Regenerate> button permanently erases the history of the displayed realm, and
+creates fresh entries using whatever loot information is currently on the <Loot> tab.
+Be aware that the <Loot> tab does not track realms, so if you have gathered data
+for players on realm A, but are displaying realm B when you click the Regenerate button,
+then your history for realm B will be... very odd.
+
++Clear Realm History> and +Clear ALL History> are used to periodically wipe the
+slate clean.  They do not generate any new entries from existing loot.
+
++Clear Older> deletes history information for all items not shown in the "most recent
+loot" display.  It is another good periodic maintenance step, but does not discard
+as much data as the other actions.
+
+Note:  the first time you display the histories during a game session, you will
+likely see several items listed as +UNKNOWN>.  This is not a bug; these items are
+simply not in your local game cache.  WoW will automatically retrieve the missing
+data after several seconds, but the display will not update until the next time
+the History tab is shown.  Starting in WoW 4.0, the local game cache is not preserved
+across play sessions, so the +UNKNOWN> entries will pop up from time to time.
+]]
+
 T.tips = [[
 Shift-clicking an item in the <Loot> display will paste it into an open chat editbox.