Merge pull request #1 from spiralofhope/master

Documentation tweaks

Additional things and stuff are to be figured out.

CHANGELOG.markdown

@@ -0,0 +1,242 @@
+# Changelog
+
+`git log` is another good way to peer into the innards of this repository.
+
+*Note that this document uses*
+
+* "SDM" to mean "Super Duper Macro"
+* "WoW" to mean "World of Warcraft"
+
+
+
+## 7.3 series
+
+### 7.3.0.3
+
+- Fixed issue #3 - Fix child window scaling
+
+
+### 7.3.0.2
+
+- Corrected the TOC
+
+
+### 7.3.0.1
+
+- Commented-out PlaySound(), because it will now only accept soundkit IDs.
+  -  It will be updated later.
+
+
+# Old notes
+
+
+### 2016-04-21 - 6.2.4-21463
+
+spiralofhope's fork - https://github.com/spiralofhope/SuperDuperMacro
+
+- **Note that no Lua code has been changed!**
+- Added tagging to the git repository, for all previous releases mentioned with `git log`.
+  -  This allows a user to visit the git repository to easily view any of those tagged versions.
+- Documentation update.
+- Changing SDM's version numbering scheme to show what version of WoW it's been most recently tested-against.
+
+
+### 2014-10-16 - 2.6.1
+
+* Fixes "Different name on button" and "Expand/collapse all folders".
+
+
+### 2014-10-16 - 2.6
+
+* Fixes character-specific macros, which broke when WoW 6 (Warlords of Draenor) gave us more global macros.
+
+
+### 2012-02-20 - 2.4.6
+
+* Fixed a bug where the interface sometimes inappropriately prevented you from making new macros.
+
+
+### 2012-01-17 - 2.4.5
+
+* Fixed a bug that caused the `Change Name/Icon` window to sometimes be unresponsive.
+* Now `Change Name/Icon` always deselects the icon when it opens so that you don't accidentally change the icon of one of your macros.
+
+
+### 2011-12-17 - 2.4.4
+
+* Fixed a bug where the button on the macro frame that opens SDM would sometimes appear in the wrong place.
+
+
+### 2011-11-30 - 2.4.3
+
+* Re-enabled the text that shows how many more button macros you can create.
+
+
+### 2011-11-30 - 2.4.2
+
+* Fixed a minor error that occurs when running SDM for the first time
+* When attempting to pick up a macro during combat, you will get an error message created by SDM instead of Blizzard's `Interface action failed due to an addon`.
+
+
+### 2011-11-30 - 2.4.1
+
+* Updated for WoW 4.0 (Cataclysm)
+  *  You will lose any custom icons for your macros.  Sorry!
+
+
+### 2011-11-20 - 2.4
+
+* Fixed the Send/Receive feature; now you can share macros with your friends again, as long as you are both using the latest version.
+* Fixed a bug where buttons on the SDM frame would sometimes stretch away.
+* Many UI Improvements.
+
+
+### 2011-11-16 - 2.3
+
+* The SDM frame now hides when you press `escape`.
+* Added more tooltips.
+
+
+### 2011-11-15 - 2.2.1
+
+* Fixed a bug where the macro list sometimes became unclickable.
+
+
+### 2011-11-04 - 2.2
+
+* Upgraded macros will now appropriately change their icons based on the macro code (unless an icon other than the Question Mark icon was selected).
+  *  If you upgraded a macro with version 2.1, you will need to manually change the icon to the Question Mark icon.
+* Added a `Downgrade` button that converts a SDM macro into a standard macro.
+* Added a `Claim`/`Disown` button that allows you to have a single character-specific macro or script that applies to multiple characters.
+* Added a `Save As...` button that allows you to save an existing macro as a different type or character.
+  *  For example, you can save a button macro as a floating macro if you want to free up a macro slot.
+* Several UI improvements.
+
+
+### 2011-10-19 - 2.1
+
+* Added an `Upgrade` button to the standard macro frame, allowing you to convert a standard macro into a SDM macro.
+* Removed an overbearing version-checking system.
+
+
+### 2011-10-16 - 2.0
+
+* Incorporated compatibility updates by survivorx and ambro.
+
+
+### 2009-02-26 - 1.8.3
+
+* Changing the name of a macro will now properly update the title text above the edit box.
+* Improved the `/sdm test` function.  Please re-test it and submit your results!
+
+
+### 2009-02-26 - 1.8.2
+
+* Fixed a bug that caused the image on button macros to show as a question mark more often than necessary.
+* Added a command `/sdm test` that does nothing but check some nyi code.  Please run this command and report the results at wowinterface.com.
+
+
+### 2009-02-21 - 1.8.1
+
+* SDM no longer conflicts with LayMacroTooltip or with other addons that modify the macro frame.
+
+
+### 2009-02-20 - 1.8
+
+* Added the option of creating folders to organize your macros.
+* Numerous minor UI improvements.
+
+
+### 2009-02-08 - 1.7
+
+* Made the macro list better:
+  *  Color-coded the different macro types.
+  *  Created a slider below the menu to adjust the size of the icons.
+  *  Added drop-down menus to filter the list by type and character.
+* Changed the storage of macros in preparation for a future version that will include a sortable macro list with user-defined folders.
+* Fixed the save confirmation dialog box now shows while dead.
+* Fixed a typo in the `Usage...` text for scripts.
+
+
+### 2009-01-27 - 1.6.1
+
+* Fixed a serious bug that happened upon login after leaving "different name on button" blank.
+  *  You may now safely leave it blank if you wish to show no text on the button.
+
+
+### 2009-01-19 - 1.6
+
+* Changed the slash command to run a floating macro.
+  *  Click the `Usage...` button for details.
+* Added a command to run button macros.
+  *  Click the `Usage...` button for details.
+* Added an interface for changing the name and icon of a macro within the SDM window.
+* Button macro names now conflict with each other (unless they are specific to different characters).
+* Disallowed some characters in macro/script names because they were causing problems.
+  *  You may find that some of these problematic characters still work on button macros, for which you can select a different name in the `Change Name/Icon` frame.
+* Changed the appearance of button macros when viewed in the default macro frame.
+* Added a clickable, scrolling menu of macros.  This will be further improved later.
+* Several efficiency improvements.  As a consequence, your SDM-created button macros will be removed from action bars and lose thieir icons.  Sorry!
+
+
+### 2009-01-12 - 1.5.1
+
+* Minor bug fixes.
+
+
+### 2009-01-12 - 1.5
+
+* Added the ability to share macros with other players (The new `Send/Receive` button).
+* Fixed a bug where the Save button was sometimes inappropriately disabled.
+
+
+### 2009-01-09 - 1.4.1
+
+* Fixed a minor bug that sometimes occurred while loading.
+
+
+### 2009-01-08 - 1.4
+
+* Added an option to show/hide the text on macro buttons.
+* Fixed `>` to be more accurate.
+* SDM will no longer attempt to create, delete, or modify macros during combat.  You can still do these things, but the changes will not take effect until after combat.
+* Deleting floating macros will now actually disable them.
+* Greatly increased the efficiency of operations like saving and deleting.
+* Increased the limit on the length of each line to 1023, and made the number of lines limitless (actually, the maximum length of any string is 2^24 characters, so the limit is somewhere below that, but that's the length of about 20 average novels and it will probably crash your client).
+* Changed the structure of the macro frames to eliminate the chance of a recently-discovered "C stack overflow" error on very long macros.
+
+
+### 2008-12-16 - 1.3.1
+
+* Fixed an occasional bug with the `Get Link` and `Delete` buttons.
+* Blocked the user from attempting to make more button macros than the standard macro interface can hold.
+
+
+### 2008-12-15 - 1.3
+
+* You can now use the addon to store long scripts and call them via a function or slash command.
+* SDM now keeps track of the button macros it creates, and deletes orphaned ones upon login. If you are upgrading from a previous version, you can delete the old button macros that SDM created (the text of the new ones all start with `#sdm` ).
+* Because of this, SDM will no longer ever replace your macros, and their names do not need to be unique at all.  Floating macros and Scripts still have some restrictions on naming, you will get a warning it you try to violate them.
+* Added many UI improvements to make working with the addon more intuitive:
+  *  Pressing `tab` will now add four spaces.
+  *  Pressing `enter` will now be equivalent to the appropriate button click.
+  *  Moved some buttons around to more appropriate places.
+  *  Added buttons that link between the regular macro window and the SDM window.
+  *  Buttons will now "gray out" when appropriate.
+  *  The SDM window will now become unresponsive during confirmation dialogs.
+
+
+### 2008-12-13 - 1.2
+
+* Fixed a bug that caused major problems when there were no macros in the list.
+
+
+### 2008-12-12 - 1.1
+
+* More UI improvements.
+  *  Some UI elements are still placeholders.
+
+
+### 2008-11-13 - 1.0
+
+* Making it ready for 3.0 (Wrath of the Lich King).

README.markdown

@@ -0,0 +1,92 @@
+# Super Duper Macro
+
+A 
+[World of Warcraft](http://blog.spiralofhope.com/?p=2987) 
+[addon](http://blog.spiralofhope.com/?p=17845).
+
+Enables the creation of incredibly long macros.
+
+A fork of 
+[hypehuman](http://www.wowinterface.com/forums/member.php?action=getinfo&userid=52682)
+'s 
+[Super Duper Macro](http://www.wowinterface.com/downloads/info10496)
+.
+
+[source code](https://github.com/spiralofhope/SuperDuperMacro)
+ · [home page](http://blog.spiralofhope.com/?p=18050)
+ · [releases](https://github.com/spiralofhope/SuperDuperMacro/releases)
+ · [latest beta](https://github.com/spiralofhope/SuperDuperMacro/archive/master.zip)
+
+
+
+# Notes
+
+- This addon is largely unchanged from hypehuman's efforts!
+- I am a documentation guy, not a programmer.  It is unlikely I can make any real changes.
+  -  If you are a developer, I am happy to:
+     -  Accept GitHub pull requests.
+     -  Add you as a contributor on GitHub.
+     -  Hand this project over!
+
+
+
+# Installation
+
+Since it's a regular addon, it's manually installed the same as every other addon would be.
+
+1) [Download Super Duper Macro](https://github.com/spiralofhope/SuperDuperMacro/releases) 
+
+2) Extract it to your `Interface\AddOns` folder.
+
+Perhaps your game is installed to one of:
+
+  `C:\Program Files\World of Warcraft` <br />
+  `C:\Program Files\World of Warcraft (x86)` 
+
+.. and so you would extract the contents of your downloaded archive to something like:
+
+  `C:\Program Files\World of Warcraft\Interface\AddOns` 
+
+.. and so you would end up with the folder 
+
+  `C:\Program Files\World of Warcraft\Interface\AddOns\SuperDuperMacro`
+
+.. and inside it would have `SuperDuperMacro.toc` and all the other files.
+
+
+- [Curse blog entry on manually installing AddOns](https://support.curse.com/hc/en-us/articles/204270005)
+- [Curse FAQ on manually installing AddOns](https://mods.curse.com/faqs/wow-addons#manual)
+
+
+# Configuration / Usage
+
+Open the interface by typing `/sdm`
+
+- Create macros beyond the 255-character limit, and even beyond the 1023-character macrotext limit.
+  -  However, no individual line in a macro may be more than 1023 characters long (you will get a warning).
+  -  The number of lines is unlimited.
+- Share macros in-game.
+- Button macros
+  -  36 global and 18 character-specific for each character.
+* Floating macros accessed by `/click`
+  -  You can make as many of these as you want.
+* Lua scripts of unlimited length
+  -  `/sdm run <name>`
+  -  `sdm_RunScript("name")`
+
+
+# Issues and suggestions
+
+([issues list](https://github.com/spiralofhope/SuperDuperMacro/issues))
+
+- If you seen an error, disable all addons but this one and re-test before creating an issue.
+  -  If you have multiple addons installed, errors you think are for one addon may actually be for another.  No really, disable everything else.
+- Search for your issue before creating an issue.
+- Always report errors.
+  -  There are several helpful addons to catch errors.  Try something like [TekErr](http://www.wowinterface.com/downloads/info6681).
+
+
+# Special thanks
+
+- The **SuperMacro** AddOn, which inspired the idea for this addon.
+- All the regulars on the UI & Macro forums, who have been guiding me through this process.

SuperDuperMacro.toc

@@ -0,0 +1,23 @@
+# SuperDuperMacro has most recently been tested against:
+#   Version 7.3.0 (24931) (Release x64)
+#   Aug 29 2017
+
+# The interface number can be learned with:
+#   /dump select( 4, GetBuildInfo() )
+## Interface:       70300
+## Author:          spiralofhope, hypehuman
+## Title:           Super Super Macro
+## Notes:           Enables the creation of incredibly long macros.
+## Version:         7.3.0.3
+## SavedVariables:  sdm_version, sdm_listFilters, sdm_iconSize, sdm_mainContents, sdm_macros
+## DefaultState:    enabled
+
+## X-Date:          2017-09-03
+## X-Website:       https://github.com/spiralofhope/SuperDuperMacro/
+## X-Feedback:      https://github.com/spiralofhope/SuperDuperMacro/issues/new
+
+SuperDuperMacro_Core.lua
+SuperDuperMacro_Interface.lua
+SuperDuperMacro_Sharing.lua
+SuperDuperMacro_Frames.lua
+SuperDuperMacro_MacroInterpreter.lua