comparison verbage.lua @ 103:dc8a23a47b03

- Add 'chatprefix' function for building loot line jump links, and a 'PCFPrint' method which displays them. - Make use of them for local and remote notifications, boss kills, and manual insertions. - Document the additional slash commands and args feature from previous release. Oops. (Text mostly copied from webpage announcement.)
author Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date Sun, 05 Aug 2012 07:26:06 +0000
parents a57133ee3c9b
children 35b55c6f5551
comparison
equal deleted inserted replaced
102:fe04f5c4114a 103:dc8a23a47b03
117 comments, and suggestions are welcome at the project page: 117 comments, and suggestions are welcome at the project page:
118 118
119 <www.curse.com/addons/wow/ouroloot> 119 <www.curse.com/addons/wow/ouroloot>
120 120
121 121
122 or send them to <farmbuyer@gmail.com>. 122 or send them to <farmbuyer@gmail.com> in non-HTML format.
123 ]] 123 ]]
124 124
125 T.basic = [[ 125 T.basic = [[
126 The </ouroloot> command opens this display. The buttons 126 The </ouroloot> command opens this display. The buttons
127 on the right side control operation and are mostly self-explanatory. Hovering over 127 on the right side control operation and are mostly self-explanatory. Hovering over
139 list. Read those first before expanding the categories or you'll miss stuff. 139 list. Read those first before expanding the categories or you'll miss stuff.
140 ]] 140 ]]
141 141
142 T.basic_loot = [[ 142 T.basic_loot = [[
143 A "loot row" in the first tab has three columns: the item, the recipient, and any 143 A "loot row" in the first tab has three columns: the item, the recipient, and any
144 extra notes. The recipient's class icon is displayed by their names, if class 144 extra notes.
145 information is available at the time.
146 145
147 <Mouse Hover> 146 <Mouse Hover>
148 147
149 Hovering the mouse over the first column will display the item in a tooltip. 148 Hovering the mouse over the first column will display the item tooltip.
150 149
151 Hovering over the second column will display a tooltip with the loot that person 150 Hovering over the second column will display a tooltip with the loot that person
152 has received. If they've won more than 10 items, the list is cut off with '...' 151 has received. If they've won more than 10 items, the list is cut off with '...'
153 at the end; to see the full list, use the right-click +Show only this player> option 152 at the end; to see the full list, use the right-click +Show only this player> option
154 instead. 153 instead.
156 <Right-Click> 155 <Right-Click>
157 156
158 Right-clicking a loot row shows a dropdown menu. 157 Right-clicking a loot row shows a dropdown menu.
159 158
160 Right-clicking in the first or third columns will display options for special 159 Right-clicking in the first or third columns will display options for special
161 treatment of that loot entry (marking as offspec, etcetera). Using any of those 160 treatment of that loot entry (e.g., marking as offspec). Using any of those
162 options will change the text in the third column (which will then affect the text 161 options will change the text in the third column, which will then affect the
163 in the generated tabs, such as forum markup). 162 text in the generated tabs, such as forum markup.
164 163
165 Right-clicking in the second column allows you to temporarily remove all other 164 Right-clicking in the second column allows you to temporarily remove all other
166 players from the loot display. Use the reset button in the lower-right corner to 165 players from the loot display. Use the reset button in the lower-right corner to
167 restore the display to normal. The menu also allows you to +reassign> loot from 166 restore the display to normal. The menu also allows you to +reassign> loot from
168 one player to another; if the new recipient is not in the raid group at the time, 167 one player to another; if the new recipient is not in the raid group at the time,
402 401
403 +Clear Older> deletes history information older than a certain threshold (by 402 +Clear Older> deletes history information older than a certain threshold (by
404 default, 5 loot events). It is another good periodic maintenance step, but 403 default, 5 loot events). It is another good periodic maintenance step, but
405 does not discard as much data as the other actions. 404 does not discard as much data as the other actions.
406 405
407 Using +Reassign to...> will also move the item between player histories. The timestamp 406 From the right-click menu on the main tab, using +Reassign to...> will also
408 will not be changed; it will "always have been" received by the new recipient. 407 move the item between player histories. The timestamp will not be changed;
409 408 it will "always have been" received by the new recipient. Using
410 Using +Mark as disenchanted> or +Mark as guild vault> will remove the item from 409 +Mark as disenchanted> or +Mark as guild vault> will remove the item from
411 history altogether. Remarking such an item as +normal> or +offspec> will replace 410 history altogether. Remarking such an item as +normal> or +offspec> will
412 the item back into the player's history. 411 replace the item back into the player's history.
413 412
414 Note: the first time you display the histories during a game session, you will 413 Note: the first time you display the histories during a game session, you will
415 likely see several items listed as +UNKNOWN>. This is not a bug; these items are 414 likely see several items listed as +UNKNOWN>. This is not a bug; these items are
416 simply not in your local game cache. WoW will automatically retrieve the missing 415 simply not in your local game cache. WoW will automatically retrieve the missing
417 data after several seconds, but the display will not update until the next time 416 data after several seconds, but the display will not update until the next time
419 across play sessions, so the +UNKNOWN> entries will pop up from time to time. 418 across play sessions, so the +UNKNOWN> entries will pop up from time to time.
420 ]] 419 ]]
421 420
422 T.tips = [[ 421 T.tips = [[
423 The |cffff8000[Ouro Loot]|r "legendary item" displayed at the start of all 422 The |cffff8000[Ouro Loot]|r "legendary item" displayed at the start of all
424 chat messages is a clickable link. Clicking opens the main display. An option 423 chat messages is a clickable link. Clicking opens the main display, and if
425 on the <Options> tab will cause a message (and thus, the clickable link) to be 424 possible will jump to and/or highlight the relevent data which caused the
426 printed after a boss kill, 425 associated chat message to be printed in the first place.
427 mostly for lazy loot trackers who don't like typing slash commands to open windows. 426 The "Be chatty" options on the <Options> tab will cause a chat message to be
427 printed after various events, thus providing a way to quickly view them.
428 428
429 If you are broadcasting to somebody else who is tracking, you should probably be 429 If you are broadcasting to somebody else who is tracking, you should probably be
430 using the same threshold. If yours is lower, then some of the loot you broadcast 430 using the same threshold. If yours is lower, then some of the loot you broadcast
431 to him will be ignored. If yours is higher, then you will not be sending information 431 to him will be ignored. If yours is higher, then you will not be sending information
432 that he would have recorded. The "correct" setting depends on what your guild wants 432 that he would have recorded. The "correct" setting depends on what your guild wants
450 default used to be </loot> until that became a builtin command in MoP. 450 default used to be </loot> until that became a builtin command in MoP.
451 451
452 If you give an unrecognized argument to a slash command, it will 452 If you give an unrecognized argument to a slash command, it will
453 search the tab titles left to right for a title beginning with the same letters as 453 search the tab titles left to right for a title beginning with the same letters as
454 the argument, and open the display to that tab. For example, <"/ol a"> would 454 the argument, and open the display to that tab. For example, <"/ol a"> would
455 open the <Attendance> tab, and <"/ol ad"> would open the <Advanced> tab. If 455 open the <Attendance> tab, and <"/ol o"> would open the <Options> tab. If
456 you had added a theoretical <EQDKP> tab, then <"/ol eq"> would be the fastest 456 you had added a theoretical <EQDKP> tab, then <"/ol eq"> would be the fastest
457 way to see it. 457 way to see it. Only enough text to be unambiguous is required, and all of it
458 is case-insensitive.
459
460 Some tabs will accept additional text after the tab title, and try to Do The
461 Right Thing. For example, <"/ol history blah"> will search for a player named
462 "blah", and if found, will act as if you had clicked on that row, switching
463 the display to every loot received by that player. The same unambiguous prefix
464 searching is used for names as for tab titles, so <"/ol hi farm"> is enough to
465 trigger Farmbuyer's history display (as long as nobody named Farmville joins
466 the raid), and so forth.
458 467
459 The </ouroloot> command can take arguments to do things without going through 468 The </ouroloot> command can take arguments to do things without going through
460 the UI. Parts given in *(angle brackets)* are required, parts in [square brackets] 469 the UI. Parts given in *(angle brackets)* are required, parts in [square brackets]
461 are optional: 470 are optional:
462 471
472 +help>: opens the UI to the help tab|r
473
463 +broadcast>/+bcast>: turns on rebroadcasting|r 474 +broadcast>/+bcast>: turns on rebroadcasting|r
464 475
465 +on [T]>: turns on full tracking, optionally setting threshold to T|r 476 +on [T]>: turns on full tracking, optionally setting threshold to T|r
466 477
467 +off>: turns off everything|r 478 +off>: turns off everything|r
468 479
469 +thre[shold] T>: sets tracking threshold to T|r 480 +thre[shold] T>: sets tracking threshold to T|r
470 481
482 +ping>: same as clicking "Ping!" on the Options tab|r
483
471 +list>: prints saved text names and numbers|r 484 +list>: prints saved text names and numbers|r
472 485
473 +save *(your set name)*>: saves texts as "your set name"|r 486 +save *(your set name)*>: saves texts as "your set name"|r
474 487
475 +restore *(N)*>: restores set number N|r 488 +restore *(N)*>: restores set number N|r
476 489
477 +delete *(N)*>: deletes set number N|r 490 +delete *(N)*>: deletes set number N|r
478 491
479 +help>: opens the UI to the help tab|r
480
481 +toggle>: opens or closes the UI (used mostly in automated wrappers)|r 492 +toggle>: opens or closes the UI (used mostly in automated wrappers)|r
493
494 +fix ?>: lists the available automated data integrity fixes|r
482 495
483 496
484 If you use the slash commands to enable tracking or set loot thresholds, you can 497 If you use the slash commands to enable tracking or set loot thresholds, you can
485 give numbers or common names for the threshold. For example, "0", "poor", "trash", 498 give numbers or common names for the threshold. For example, "0", "poor", "trash",
486 "gray"/"grey" are all the same, "4", "epic", "purple" are the same, and so on. 499 "gray"/"grey" are all the same, "4", "epic", "purple" are the same, and so on.
640 else 653 else
641 left:SelectByValue("basic") 654 left:SelectByValue("basic")
642 end 655 end
643 end 656 end
644 657
645 local noob = [[ 658 addon:register_tab_control_AT_END ("help", [[Help]],
659 [[Instructions, reminders, and tips for non-obvious features]],
660 tabs_OGS, [[
646 Every tab across the top also gets its own special buttons here in the lower 661 Every tab across the top also gets its own special buttons here in the lower
647 right, under the same name as the tab. Some controls do not become visible 662 right, under the same name as the tab. Some controls do not become visible
648 until that tab has data to work with.]] 663 until that tab has data to work with.]])
649 664
650 addon:register_tab_control_AT_END ("help", [[Help]],
651 [[Instructions, reminders, and tips for non-obvious features]],
652 tabs_OGS, --[[opt_noobtip=]]noob)
653 end 665 end
654 666
655 -- vim:noet 667 -- vim:noet