Cirk's Notebook (Continued)

This version of this mod is no longer in development, please see the original author for all future updates.
http://www.wowinterface.com/list.php?skinnerid=25987

As of October 24, 2006 Cirk of Doomhammer has decided to leave WoW for more pressing real life commitments. The BFE raid team on Doomhammer was sad to see him go but wish him luck in all his endeavors. I am working to maintain some of Cirk's addons.

Cirk's original and last version can be found here. http://www.wowinterface.com/downloa...nfo.php?id=4535

Truth be known I am new at LUA development and will be using this opportunity to become proficient. I hope I can do half as well as Cirk has done.

Please be patient with me and I encourage any and all suggestions/solutions you may have.

Taken from Cirk's last version:
---------------------------------------------------------------------------
Notebook is an Addon for recording text notes in-game, and for optionally sharing or sending these Notes with other players via whisper, raid, party, guild, or chat channel. Notes are each assigned a unique title (up to 60 characters long) and may contain up to 2048 characters of description, with the number of Notes you can have limited only by memory (and your patience)!

Notebook will even recognize Notes sent by other players and will automatically add these as entries under a Recent tab, where you will be able to read the Note at your leisure, or add it to your own list, or update your list if you already have the Note.

Because Notebook allows you to send large pieces of text easily, it is important to point out that the responsibility for not spamming other players (and maybe even getting yourself banned by doing so) still rests on YOU!

Notebook itself only imposes a very minimal limit on when you can send Notes (using a 5 second "cooldown" between sendings) because of legitimate reasons why you might need to send multiple Notes quickly.


Using Notebook
The first time you use Notebook, it will generate a Welcome to Notebook! Note for you automatically, with a brief description of what Notebook does. Feel free to delete this Note - you can retrieve it again at anytime using the /notebook welcome slash command.

Creating a new Note is simply a matter of clicking on the New button in the top-right corner, enter a new Note title, and starting typing. Editing an existing Note just requires you to click in the text area of the Note and start making changes. Pressing the Save button will save your changes, while Cancel will cancel them and revert the Note to its last saved contents.

You can edit multiple Notes at once with Notebook - an asterix will appear next to the Note title to show that you have unsaved changes. Remember, any changes you have made that you haven't saved will be lost when you logout!

Notes are kept in your Notebook in alphabetical order of Note title, so if you want to group Notes together, give them all a similarly starting title (e.g., start the title of all your Molten Core raiding instruction Notes with "MC - ").


Sending Notes
In order to send a Note, you first need to make sure that the Can be sent option is selected for that Note. By default, Can be sent is not selected for Notes you yourself create, but is selected for Notes that you receive.

To send the Note, right-click the Note title in the title window, and select the Send menu option, and then select where you want to send the Note to. If you are in a raid, you can only send a Note to the raid if you are the raid leader, or a raid assistant, so if the Raid option is greyed out, you'll know why.

If you select sending to a Player, you will then see a dialog box prompting you for the player name (with the last player sent to being the default name). When opting to send to a Channel, selecting a server channel will cause Notebook to prompt you for confirmation (to avoid accidental embarassment), while selecting a private channel will send the Note to that channel immediately.

The Send menu option will be greyed out if Can be sent is not selected; if you are currently editing the Note and have unsaved changes; or if you have recently sent a Note and Notebook is in its "cooldown" state.


Receiving Notes
When a Note is sent by another player to you (via raid, party, guild, whisper, or chat channel), Notebook will automatically recognize this and add the Note to the notes shown under the Recent tab at the top of the Notebook window. Notes shown in the Recent tab are either Notes you already have saved and have sent or received this session (these appear in yellow text and are editable), or Notes you have received and either do not have saved, or are an update to a Note you already have (these will appear in grey text and cannot be edited, although you can change their titles).

For received Notes shown in grey text, you will see one of two options on the buttons on the bottom-left of the Notebook window - Add (for new Notes) or Update (for Notes with the same title as one you already have, but different description text). Also, if you use the right-click menu to Remove a Note shown in grey text, you will not be prompted for confirmation like you will for Notes that you have saved.


Note details
Also under the right-click menu is a Detals option, which will show you details about the Note, including who sent it or edited it last, when it was last received or saved, when it was last sent (if it was), and its size.


Notebook slash commands
Notebook supports the following commands:

/notebook help shows these options.
/notebook show displays the Notebook window.
/notebook hide hides the Notebook window.
/notebook toggles the display of the Notebook window.
/notebook list outputs all the titles of your Notes to your default chat window.
/notebook welcome restores the initial welcome Note that comes with Notebook.

You can also use /note instead of /notebook.
---------------------------------------------------------------------------
Changelog:

v2.11
- Updated TOC to patch 2.0.3
- Global notes enabled but not functioning

Release 2.01
- Fixed positioning of right-click menus
- Updated to release version

2.0 beta.1
- Updated TOC for 2.0 BTS support
- Fixed immediate LUA 5.1 changes