WoWInterface SVN Notes

[/] [branches/] [WotLK/] [Notes/] [readme.txt] - Blame information for rev 2

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 VincentSDSH-33016
Notes
2 VincentSDSH-33016
Author:  Vincent, Silver Hand
3 VincentSDSH-33016
Full and due credit to the original author: Andersen, Silvermoon
4 VincentSDSH-33016
 
5 VincentSDSH-33016
Versions beyond 1.4a:
6 VincentSDSH-33016
Notes is a fantastic mod that fills a needed niche.  Since the original author seems to have abandoned the project and since it is too lovely a rose to let wither, I've taken over "keep alive" support for the mod.  No new features are currently planned and any that may find their way into it will be on an 'as time allows' basis as this is not the only mod I maintain.
7 VincentSDSH-33016
 
8 VincentSDSH-33016
 
9 VincentSDSH-33016
Summary:
10 VincentSDSH-33016
Notes keeps track of notes in an easy-to-use GUI. Raid leaders and raid assistants can print notes to raid chat.  Notes marked as "sync" will  synchronize notes that are printed by someone else using the notes mod who set their note to 'sync'.
11 VincentSDSH-33016
 
12 VincentSDSH-33016
Furthermore, any note can be executed as a LUA script and called via a macro.  The macro script necessary to execute the Notes script is easily visible.  This
13 VincentSDSH-33016
essentially makes a nearly unlimited macro length.  Notes can also hook into the OnUpdate and OnEvent calls that WoW makes while playing for easy Add-On Development.
14 VincentSDSH-33016
 
15 VincentSDSH-33016
Thanks to Salamengel and Merphle (Author of LuaPad)  for inspiration. Thanks to Sumul and Shinsplitter for suggestions.
16 VincentSDSH-33016
 
17 VincentSDSH-33016
use /notes to show the GUI
18 VincentSDSH-33016
 
19 VincentSDSH-33016
Features:
20 VincentSDSH-33016
* Multiple notes and easy navigation
21 VincentSDSH-33016
* Lock notes
22 VincentSDSH-33016
* Revert changes to last time the GUI was shown
23 VincentSDSH-33016
* Fully functional LUA mode/macro editor
24 VincentSDSH-33016
* Note synchronization
25 VincentSDSH-33016
 
26 VincentSDSH-33016
---
27 VincentSDSH-33016
 
28 VincentSDSH-33016
Note: Printing a note will stagger the information printed so raiders have a time to read the entire note as you print it.  If you type a message while a note is being printed, syncing will not work.
29 VincentSDSH-33016
 
30 VincentSDSH-33016
Note: Notes will not sync via whispers or channels between versions 1.1x and 1.2+
31 VincentSDSH-33016
 
32 VincentSDSH-33016
---
33 VincentSDSH-33016
 
34 VincentSDSH-33016
Change Log:
35 VincentSDSH-33016
v1.4a (9/30/08)
36 VincentSDSH-33016
        * Updated for Wrath of the Lich King
37 VincentSDSH-33016
 
38 VincentSDSH-33016
v1.4 (12/11/06)
39 VincentSDSH-33016
        * Remaining bugs with syncing through channels should be sorted out
40 VincentSDSH-33016
        * Added version number to minimap tooltip
41 VincentSDSH-33016
        * Increased the delay times at all max delay settings by a small amount
42 VincentSDSH-33016
 
43 VincentSDSH-33016
v1.3a (11/17/06)
44 VincentSDSH-33016
        * Added slider to adjust auto delay amount for printing
45 VincentSDSH-33016
        * Increased default delay for long message chunks
46 VincentSDSH-33016
        * Success message printed when a Note has completed printing
47 VincentSDSH-33016
        * Integrated ChatThrottleLib for support when printing with
48 VincentSDSH-33016
                auto delay off
49 VincentSDSH-33016
 
50 VincentSDSH-33016
v1.3 (9/27/06)
51 VincentSDSH-33016
        * Changed the "Go to" page button to link back to the table
52 VincentSDSH-33016
                of contents page if you are currently looking at a page
53 VincentSDSH-33016
                > Pressing enter after manually typing in a page will
54 VincentSDSH-33016
                  still navigate to that page
55 VincentSDSH-33016
        * The Table of Contents page is a scrollable list of page links,
56 VincentSDSH-33016
                which should make book navigation much better
57 VincentSDSH-33016
        * Fixed sync errors with channels
58 VincentSDSH-33016
        * Raid syncing will no longer report an error to people in your
59 VincentSDSH-33016
                guild who are in different raids
60 VincentSDSH-33016
        * GUI updates will no longer execute when the GUI is not visible.
61 VincentSDSH-33016
 
62 VincentSDSH-33016
v1.2 (9/5/06)
63 VincentSDSH-33016
        * Removed the checkbox to show or hide the minimap icon
64 VincentSDSH-33016
        * Added /notesicon command to toggle the minimap button
65 VincentSDSH-33016
        * Added /printnote and /stop commands
66 VincentSDSH-33016
        * Added a /printnote macro selection box
67 VincentSDSH-33016
        * Added bindings to toggle the Notes UI and minimap button
68 VincentSDSH-33016
        * Added support for importing/exporting of mods via files
69 VincentSDSH-33016
                (email your notes)
70 VincentSDSH-33016
        * Pages of books that are set to "sync" will sync, even if
71 VincentSDSH-33016
                the page itself is not set to sync
72 VincentSDSH-33016
        * Pressing esc will lose focus from the frame.  Pressing esc
73 VincentSDSH-33016
                when no field has focus will hide the UI
74 VincentSDSH-33016
        * Notes errors will be less annoying
75 VincentSDSH-33016
        * Notes should be syncable from the raid leader again
76 VincentSDSH-33016
 
77 VincentSDSH-33016
v1.1b (8/23/06)
78 VincentSDSH-33016
        * Removed bogus debugging print functions
79 VincentSDSH-33016
 
80 VincentSDSH-33016
v1.1a (8/23/06)
81 VincentSDSH-33016
        * Added custom note import capability
82 VincentSDSH-33016
 
83 VincentSDSH-33016
v1.1 (8/22/06)
84 VincentSDSH-33016
        * Added a minimap icon
85 VincentSDSH-33016
        * Added "Notebooks" (Compilations of notes)
86 VincentSDSH-33016
        * Added multi-select for delete/copy/compile
87 VincentSDSH-33016
        * Added communications panel to send notes to
88 VincentSDSH-33016
                other places. Syncing messages only hidden
89 VincentSDSH-33016
                when notes are synced through raid chat
90 VincentSDSH-33016
        * Added stop printing button
91 VincentSDSH-33016
        * Added /runnote command
92 VincentSDSH-33016
        * Changed the "important" label to "sync"
93 VincentSDSH-33016
                Any previously "important" notes will
94 VincentSDSH-33016
                be considered normal after installing
95 VincentSDSH-33016
                this version
96 VincentSDSH-33016
        * Notes that exist must be flagged as sync to
97 VincentSDSH-33016
                overwrite it with new data.  Notes that are
98 VincentSDSH-33016
                not marked sync will not be overwritten
99 VincentSDSH-33016
        * Able to sync multiple notes simultaneously now
100 VincentSDSH-33016
                (Still only one note can be synchronized at
101 VincentSDSH-33016
                at a time per person)
102 VincentSDSH-33016
        * Fixed undo functionality
103 VincentSDSH-33016
        * Sync notes uses the new CHAT_MSG_ADDON channel
104 VincentSDSH-33016
        * The LUA - Setup note is now executed on start up
105 VincentSDSH-33016
                This means don't type ReloadUI() in this note
106 VincentSDSH-33016
 
107 VincentSDSH-33016
v1.0a (8/12/06):
108 VincentSDSH-33016
        * Bug fix for notes synchronization
109 VincentSDSH-33016
 
110 VincentSDSH-33016
v1.0 (8/10/06):
111 VincentSDSH-33016
        * Initial revision